From 9fd3dac3418999644404ff6f4fa2c4375c6a0063 Mon Sep 17 00:00:00 2001 From: Logon Date: Wed, 1 May 2024 22:21:37 +0200 Subject: [PATCH 01/18] feat: add tblCount function to count key-value pairs in tables This function enhances the utility of DumpFunctions by providing a method to count the key-value pairs in a given table, which is useful for debugging and data handling scenarios. --- Corrections/DumpFunctions.lua | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Corrections/DumpFunctions.lua b/Corrections/DumpFunctions.lua index 2fe5d4d9..8c395a2b 100644 --- a/Corrections/DumpFunctions.lua +++ b/Corrections/DumpFunctions.lua @@ -29,6 +29,9 @@ end local tblMaxIndex = DumpFunctions.tblMaxIndex +---Counts the number of key-value pairs in the given table. +---@param tbl table The table to count the number of pairs in. +---@return number count The number of key-value pairs in the table. function DumpFunctions.tblCount(tbl) local count = 0 for _ in pairs(tbl) do From 1e8500d670504c32c686693facc0796787b18a7d Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 24 May 2024 20:53:22 +0200 Subject: [PATCH 02/18] Made the list prettier --- Database/Database.lua | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/Database/Database.lua b/Database/Database.lua index 8c280c7f..9410e697 100644 --- a/Database/Database.lua +++ b/Database/Database.lua @@ -51,12 +51,13 @@ local frameType = "SimpleHTML" local strsplittable = strsplittable local tConcat = table.concat -local tonumber = tonumber -local loadstring = loadstring -local gMatch = string.gmatch -local tInsert = table.insert -local sFind = string.find -local format = string.format +local tonumber = tonumber +local tostring = tostring +local loadstring = loadstring +local gMatch = string.gmatch +local tInsert = table.insert +local sFind = string.find +local format = string.format local type = type local pairs = pairs From 95c67fc0d1aa601f98acaa00374c26fe01e2127d Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 24 May 2024 20:53:59 +0200 Subject: [PATCH 03/18] Made the list prettier --- Database/Database.lua | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Database/Database.lua b/Database/Database.lua index 9410e697..87e98d92 100644 --- a/Database/Database.lua +++ b/Database/Database.lua @@ -46,10 +46,11 @@ local _nil = Database._nil ---- Local Functions ---- --* For performance reasons we check Is_CLI here, Database.CreateFrame supports both CLI and WOW -local CreateFrame = Is_CLI and Database.CreateFrame or CreateFrame -local frameType = "SimpleHTML" +local CreateFrame = Is_CLI and Database.CreateFrame or CreateFrame +local frameType = "SimpleHTML" local strsplittable = strsplittable -local tConcat = table.concat +local tConcat = table.concat +local wipe = wipe local tonumber = tonumber local tostring = tostring @@ -58,10 +59,11 @@ local gMatch = string.gmatch local tInsert = table.insert local sFind = string.find local format = string.format +local f = string.format -local type = type -local pairs = pairs -local assert = assert +local type = type +local pairs = pairs +local assert = assert function Database.Init() local startTotal = 0 From 3c31b7b37d850571a2df722f28e53775c263b9b0 Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 24 May 2024 21:09:04 +0200 Subject: [PATCH 04/18] refactor: change AllIdStrings from table to string Change AllIdStrings from a table of strings to a single concatenated string. This simplifies the handling of ID strings and improves performance by reducing the number of table operations. Update the GetNewIds function to use a hash set for existing IDs, improving the efficiency of ID lookups and ensuring new IDs are correctly identified. Remove unnecessary debug prints and comments for cleaner code. --- Database/Base/Base.lua | 22 ++++++++++++------ Database/Database.lua | 52 +++++++++++++++++++++++++----------------- 2 files changed, 46 insertions(+), 28 deletions(-) diff --git a/Database/Base/Base.lua b/Database/Base/Base.lua index c829e432..d16576bc 100644 --- a/Database/Base/Base.lua +++ b/Database/Base/Base.lua @@ -53,8 +53,10 @@ function LibQuestieDB.CreateDatabaseInTable(refTable, databaseType, databaseType ---@type table> local override = {} - ---- Contains the id strings ---- - local AllIdStrings = {} + ---- Contains the id string ---- + ---- Use GetAllIds function to get the ids + ---@type string + local AllIdStrings = "" ---- Add entity type to the database ---- Database.entityTypes[captializedType] = true @@ -197,10 +199,15 @@ function LibQuestieDB.CreateDatabaseInTable(refTable, databaseType, databaseType -- If there are new IDs, concatenate them into a string and add to `AllIdStrings` for tracking. if #newIds ~= 0 then - tInsert(AllIdStrings, tConcat(newIds, ",")) + -- To get the right length we just print this message before adding the old string if Database.debugPrintEnabled then LibQuestieDB.ColorizePrint("lightBlue", f(" # New %s IDs", captializedType), #newIds) end + -- Add the old ID string to the new list of ids + -- e.g { "1", "2", "3", "4,5,6" } -> "1,2,3,4,5,6" + ---@diagnostic disable-next-line: assign-type-mismatch + newIds[#newIds + 1] = AllIdStrings + AllIdStrings = tConcat(newIds, ",") end -- Apply the override data to the database and return the number of overrides applied. @@ -212,10 +219,11 @@ function LibQuestieDB.CreateDatabaseInTable(refTable, databaseType, databaseType -- It will however still initialize during the CLI testing phase. if Is_Create_Static then return end - wipe(AllIdStrings) + -- Reset the `AllIdStrings` variable to an empty string. + AllIdStrings = "" local func, idString = Database.GetAllEntityIdsFunction(captializedType) -- TODO: Maybe we should sort this list? - tInsert(AllIdStrings, idString) + AllIdStrings = idString if Database.debugPrintEnabled then assert(#func() == #DB.GetAllIds(), f("%s ids are not the same", captializedType)) end @@ -241,12 +249,12 @@ function LibQuestieDB.CreateDatabaseInTable(refTable, databaseType, databaseType function DB.GetAllIds(hashmap) if hashmap == true then -- Substitute all numbers in the concatenated ID strings with Lua table format [number]=true - local dat = gsub(tConcat(AllIdStrings, ","), "(%d+)", "[%1]=true") + local dat = gsub(AllIdStrings, "(%d+)", "[%1]=true") -- Execute the string as Lua code to create and return the hashmap return loadstring(f("return {%s}", dat))() else -- If hashmap is not requested, simply return a list of IDs - return loadstring(f("return {%s}", tConcat(AllIdStrings, ",")))() + return loadstring(f("return {%s}", AllIdStrings))() end end diff --git a/Database/Database.lua b/Database/Database.lua index 87e98d92..662aef97 100644 --- a/Database/Database.lua +++ b/Database/Database.lua @@ -217,30 +217,40 @@ function Database.Override(overrideData, overrideTable, keys) end ---Used to add new Ids into the master list of ids for that type ----@param AllIdStrings string[] @A list of strings containing the ids in the database, will be concatinated into one string ----@param dataOverride table @The data to check for new ids ----@return QuestId[]|NpcId[]|ObjectId[]|ItemId[] @Returns a list of new ids -function Database.GetNewIds(AllIdStrings, dataOverride) - -- We add , to the start and end of the string so we can search for ,id, in the string - local allIds = "," .. tConcat(AllIdStrings, ",") .. "," - - -- Table to store the new ids - local newIds = {} - - -- Add all the ids to the allIds table - for id in pairs(dataOverride) do - -- Search in the idString if ,id, is found - -- local found, e, d = allIds:find("(,*" .. id .. ",*)") - local found = sFind(allIds, "," .. id .. ",") - if not found then - -- Print what we found - if not Database.debugLoadStaticEnabled and Database.debugPrintEnabled and Database.debugEnabled then - LibQuestieDB.ColorizePrint("reputationBlue", " Adding new ID", id) +do + -- Table used to store the ids for the current call + local allIdsSet = {} + ---Used to add new Ids into the master list of ids for that type + ---@param AllIdStrings string @A list of strings containing the ids in the database, will be concatinated into one string + ---@param dataOverride table @The data to check for new ids + ---@return QuestId[]|NpcId[]|ObjectId[]|ItemId[] @Returns a list of new ids + function Database.GetNewIds(AllIdStrings, dataOverride) + -- Split the string into a table of strings + local allIds = strsplittable(",", AllIdStrings) + + -- Create a hash set for all existing IDs + for i = 1, #allIds do + allIdsSet[allIds[i]] = true + end + + -- Table to store the new ids + local newIds = {} + -- Add all the ids to the allIds table + for id in pairs(dataOverride) do + if not allIdsSet[tostring(id)] then + -- Print what we found + -- if not Database.debugLoadStaticEnabled and Database.debugPrintEnabled and Database.debugEnabled then + -- LibQuestieDB.ColorizePrint("reputationBlue", " Adding new ID", id) + -- end + tInsert(newIds, id) end - tInsert(newIds, id) end + + -- Wipe it for the next call + -- Do it at the end so when it is called the last time it is wiped. + wipe(allIdsSet) + return newIds end - return newIds end --*------------------------------------------- From 30d3f9d203d3ce7c9ee0895708b241943d423bae Mon Sep 17 00:00:00 2001 From: Logon Date: Mon, 3 Jun 2024 23:26:57 +0200 Subject: [PATCH 05/18] Added all Wiki Information --- wiki-information/events/ACHIEVEMENT_EARNED.md | 13 + .../events/ACHIEVEMENT_PLAYER_NAME.md | 11 + .../events/ACHIEVEMENT_SEARCH_UPDATED.md | 10 + wiki-information/events/ACTIONBAR_HIDEGRID.md | 10 + .../events/ACTIONBAR_PAGE_CHANGED.md | 10 + wiki-information/events/ACTIONBAR_SHOWGRID.md | 10 + .../events/ACTIONBAR_SHOW_BOTTOMLEFT.md | 27 +++ .../events/ACTIONBAR_SLOT_CHANGED.md | 14 ++ .../events/ACTIONBAR_UPDATE_COOLDOWN.md | 10 + .../events/ACTIONBAR_UPDATE_STATE.md | 10 + .../events/ACTIONBAR_UPDATE_USABLE.md | 10 + .../events/ACTION_WILL_BIND_ITEM.md | 10 + wiki-information/events/ACTIVATE_GLYPH.md | 11 + .../events/ACTIVE_TALENT_GROUP_CHANGED.md | 13 + .../events/ADAPTER_LIST_CHANGED.md | 10 + wiki-information/events/ADDONS_UNLOADING.md | 11 + .../events/ADDON_ACTION_BLOCKED.md | 13 + .../events/ADDON_ACTION_FORBIDDEN.md | 13 + wiki-information/events/ADDON_LOADED.md | 17 ++ .../events/ADVENTURE_MAP_CLOSE.md | 10 + wiki-information/events/ADVENTURE_MAP_OPEN.md | 11 + .../events/ADVENTURE_MAP_QUEST_UPDATE.md | 11 + .../events/ADVENTURE_MAP_UPDATE_INSETS.md | 10 + .../events/ADVENTURE_MAP_UPDATE_POIS.md | 10 + wiki-information/events/AJ_DUNGEON_ACTION.md | 11 + wiki-information/events/AJ_OPEN.md | 10 + wiki-information/events/AJ_PVE_LFG_ACTION.md | 10 + wiki-information/events/AJ_PVP_ACTION.md | 11 + wiki-information/events/AJ_PVP_LFG_ACTION.md | 10 + wiki-information/events/AJ_PVP_RBG_ACTION.md | 10 + .../events/AJ_PVP_SKIRMISH_ACTION.md | 10 + wiki-information/events/AJ_QUEST_LOG_OPEN.md | 13 + wiki-information/events/AJ_RAID_ACTION.md | 11 + wiki-information/events/AJ_REFRESH_DISPLAY.md | 11 + .../events/AJ_REWARD_DATA_RECEIVED.md | 10 + .../events/ALERT_REGIONAL_CHAT_DISABLED.md | 10 + .../ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md | 10 + wiki-information/events/AREA_POIS_UPDATED.md | 10 + .../events/AREA_SPIRIT_HEALER_IN_RANGE.md | 10 + .../events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md | 10 + .../events/ARENA_COOLDOWNS_UPDATE.md | 11 + .../ARENA_CROWD_CONTROL_SPELL_UPDATE.md | 13 + .../events/ARENA_OPPONENT_UPDATE.md | 13 + .../events/ARENA_SEASON_WORLD_STATE.md | 10 + .../events/ARENA_TEAM_ROSTER_UPDATE.md | 11 + wiki-information/events/ARENA_TEAM_UPDATE.md | 10 + .../events/AUCTION_BIDDER_LIST_UPDATE.md | 10 + .../events/AUCTION_HOUSE_CLOSED.md | 13 + .../events/AUCTION_HOUSE_DISABLED.md | 10 + .../events/AUCTION_HOUSE_POST_ERROR.md | 10 + .../events/AUCTION_HOUSE_POST_WARNING.md | 10 + .../events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md | 10 + wiki-information/events/AUCTION_HOUSE_SHOW.md | 10 + .../events/AUCTION_ITEM_LIST_UPDATE.md | 13 + .../events/AUCTION_MULTISELL_FAILURE.md | 10 + .../events/AUCTION_MULTISELL_START.md | 11 + .../events/AUCTION_MULTISELL_UPDATE.md | 13 + .../events/AUCTION_OWNED_LIST_UPDATE.md | 14 ++ wiki-information/events/AUTOFOLLOW_BEGIN.md | 11 + wiki-information/events/AUTOFOLLOW_END.md | 10 + .../events/AVATAR_LIST_UPDATED.md | 17 ++ ..._EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md | 11 + .../events/AZERITE_EMPOWERED_ITEM_LOOTED.md | 11 + ...ZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md | 11 + .../events/AZERITE_ESSENCE_ACTIVATED.md | 21 ++ .../AZERITE_ESSENCE_ACTIVATION_FAILED.md | 21 ++ .../events/AZERITE_ESSENCE_CHANGED.md | 13 + .../events/AZERITE_ESSENCE_FORGE_CLOSE.md | 10 + .../events/AZERITE_ESSENCE_FORGE_OPEN.md | 10 + .../AZERITE_ESSENCE_MILESTONE_UNLOCKED.md | 11 + .../events/AZERITE_ESSENCE_UPDATE.md | 11 + .../AZERITE_ITEM_ENABLED_STATE_CHANGED.md | 11 + .../events/AZERITE_ITEM_EXPERIENCE_CHANGED.md | 15 ++ .../AZERITE_ITEM_POWER_LEVEL_CHANGED.md | 26 ++ wiki-information/events/BAG_CLOSED.md | 11 + .../events/BAG_NEW_ITEMS_UPDATED.md | 10 + wiki-information/events/BAG_OPEN.md | 11 + .../BAG_OVERFLOW_WITH_FULL_INVENTORY.md | 10 + .../events/BAG_SLOT_FLAGS_UPDATED.md | 11 + wiki-information/events/BAG_UPDATE.md | 14 ++ .../events/BAG_UPDATE_COOLDOWN.md | 10 + wiki-information/events/BAG_UPDATE_DELAYED.md | 10 + wiki-information/events/BANKFRAME_CLOSED.md | 13 + wiki-information/events/BANKFRAME_OPENED.md | 10 + .../events/BANK_BAG_SLOT_FLAGS_UPDATED.md | 11 + .../events/BARBER_SHOP_APPEARANCE_APPLIED.md | 10 + .../BARBER_SHOP_CAMERA_VALUES_UPDATED.md | 10 + wiki-information/events/BARBER_SHOP_CLOSE.md | 10 + .../events/BARBER_SHOP_COST_UPDATE.md | 10 + ...BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md | 10 + wiki-information/events/BARBER_SHOP_OPEN.md | 10 + wiki-information/events/BARBER_SHOP_RESULT.md | 11 + .../events/BATTLEFIELDS_CLOSED.md | 10 + wiki-information/events/BATTLEFIELDS_SHOW.md | 13 + .../events/BATTLEFIELD_AUTO_QUEUE.md | 10 + .../events/BATTLEFIELD_AUTO_QUEUE_EJECT.md | 10 + .../events/BATTLEFIELD_QUEUE_TIMEOUT.md | 10 + .../events/BATTLEGROUND_OBJECTIVES_UPDATE.md | 10 + .../events/BATTLEGROUND_POINTS_UPDATE.md | 10 + .../events/BATTLETAG_INVITE_SHOW.md | 11 + .../events/BATTLE_PET_CURSOR_CLEAR.md | 14 ++ .../events/BEHAVIORAL_NOTIFICATION.md | 13 + wiki-information/events/BIND_ENCHANT.md | 10 + .../events/BLACK_MARKET_BID_RESULT.md | 13 + wiki-information/events/BLACK_MARKET_CLOSE.md | 10 + .../events/BLACK_MARKET_ITEM_UPDATE.md | 10 + wiki-information/events/BLACK_MARKET_OPEN.md | 10 + .../events/BLACK_MARKET_OUTBID.md | 13 + .../events/BLACK_MARKET_UNAVAILABLE.md | 10 + wiki-information/events/BLACK_MARKET_WON.md | 13 + .../events/BN_BLOCK_FAILED_TOO_MANY.md | 11 + .../events/BN_BLOCK_LIST_UPDATED.md | 10 + wiki-information/events/BN_CHAT_MSG_ADDON.md | 17 ++ .../events/BN_CHAT_WHISPER_UNDELIVERABLE.md | 11 + wiki-information/events/BN_CONNECTED.md | 11 + .../events/BN_CUSTOM_MESSAGE_CHANGED.md | 11 + .../events/BN_CUSTOM_MESSAGE_LOADED.md | 10 + wiki-information/events/BN_DISCONNECTED.md | 13 + .../events/BN_FRIEND_ACCOUNT_OFFLINE.md | 13 + .../events/BN_FRIEND_ACCOUNT_ONLINE.md | 13 + .../events/BN_FRIEND_INFO_CHANGED.md | 11 + .../events/BN_FRIEND_INVITE_ADDED.md | 11 + .../BN_FRIEND_INVITE_LIST_INITIALIZED.md | 11 + .../events/BN_FRIEND_INVITE_REMOVED.md | 10 + .../events/BN_FRIEND_LIST_SIZE_CHANGED.md | 11 + wiki-information/events/BN_INFO_CHANGED.md | 10 + .../events/BN_REQUEST_FOF_SUCCEEDED.md | 10 + wiki-information/events/BOSS_KILL.md | 13 + .../events/CALENDAR_ACTION_PENDING.md | 11 + .../events/CALENDAR_CLOSE_EVENT.md | 10 + .../events/CALENDAR_EVENT_ALARM.md | 15 ++ wiki-information/events/CALENDAR_NEW_EVENT.md | 11 + .../events/CALENDAR_OPEN_EVENT.md | 26 ++ .../events/CALENDAR_UPDATE_ERROR.md | 11 + .../CALENDAR_UPDATE_ERROR_WITH_COUNT.md | 13 + .../CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md | 13 + .../events/CALENDAR_UPDATE_EVENT.md | 10 + .../events/CALENDAR_UPDATE_EVENT_LIST.md | 10 + .../events/CALENDAR_UPDATE_GUILD_EVENTS.md | 10 + .../events/CALENDAR_UPDATE_INVITE_LIST.md | 11 + .../events/CALENDAR_UPDATE_PENDING_INVITES.md | 10 + wiki-information/events/CANCEL_GLYPH_CAST.md | 14 ++ wiki-information/events/CANCEL_LOOT_ROLL.md | 11 + wiki-information/events/CANCEL_SUMMON.md | 10 + .../events/CAPTUREFRAMES_FAILED.md | 10 + .../events/CAPTUREFRAMES_SUCCEEDED.md | 10 + .../events/CEMETERY_PREFERENCE_UPDATED.md | 10 + .../events/CHANNEL_COUNT_UPDATE.md | 13 + .../events/CHANNEL_FLAGS_UPDATED.md | 11 + .../events/CHANNEL_INVITE_REQUEST.md | 13 + wiki-information/events/CHANNEL_LEFT.md | 13 + .../events/CHANNEL_PASSWORD_REQUEST.md | 11 + .../events/CHANNEL_ROSTER_UPDATE.md | 13 + wiki-information/events/CHANNEL_UI_UPDATE.md | 10 + .../CHARACTER_ITEM_FIXUP_NOTIFICATION.md | 11 + .../events/CHARACTER_POINTS_CHANGED.md | 13 + .../CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md | 43 ++++ .../events/CHAT_DISABLED_CHANGED.md | 11 + .../events/CHAT_DISABLED_CHANGE_FAILED.md | 11 + .../events/CHAT_MSG_ACHIEVEMENT.md | 43 ++++ wiki-information/events/CHAT_MSG_ADDON.md | 33 +++ .../events/CHAT_MSG_ADDON_LOGGED.md | 27 +++ wiki-information/events/CHAT_MSG_AFK.md | 43 ++++ .../events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md | 43 ++++ .../events/CHAT_MSG_BG_SYSTEM_HORDE.md | 43 ++++ .../events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md | 43 ++++ wiki-information/events/CHAT_MSG_BN.md | 43 ++++ .../events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md | 43 ++++ .../CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md | 43 ++++ ...AT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md | 43 ++++ .../CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md | 43 ++++ .../events/CHAT_MSG_BN_WHISPER.md | 43 ++++ .../events/CHAT_MSG_BN_WHISPER_INFORM.md | 43 ++++ .../CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md | 43 ++++ wiki-information/events/CHAT_MSG_CHANNEL.md | 43 ++++ .../events/CHAT_MSG_CHANNEL_JOIN.md | 43 ++++ .../events/CHAT_MSG_CHANNEL_LEAVE.md | 43 ++++ .../events/CHAT_MSG_CHANNEL_LIST.md | 43 ++++ .../events/CHAT_MSG_CHANNEL_NOTICE.md | 43 ++++ .../events/CHAT_MSG_CHANNEL_NOTICE_USER.md | 43 ++++ .../events/CHAT_MSG_COMBAT_FACTION_CHANGE.md | 43 ++++ .../events/CHAT_MSG_COMBAT_HONOR_GAIN.md | 43 ++++ .../events/CHAT_MSG_COMBAT_MISC_INFO.md | 43 ++++ .../events/CHAT_MSG_COMBAT_XP_GAIN.md | 43 ++++ .../events/CHAT_MSG_COMMUNITIES_CHANNEL.md | 43 ++++ wiki-information/events/CHAT_MSG_CURRENCY.md | 43 ++++ wiki-information/events/CHAT_MSG_DND.md | 43 ++++ wiki-information/events/CHAT_MSG_EMOTE.md | 51 ++++ wiki-information/events/CHAT_MSG_FILTERED.md | 43 ++++ wiki-information/events/CHAT_MSG_GUILD.md | 43 ++++ .../events/CHAT_MSG_GUILD_ACHIEVEMENT.md | 43 ++++ .../events/CHAT_MSG_GUILD_ITEM_LOOTED.md | 43 ++++ wiki-information/events/CHAT_MSG_IGNORED.md | 43 ++++ .../events/CHAT_MSG_INSTANCE_CHAT.md | 43 ++++ .../events/CHAT_MSG_INSTANCE_CHAT_LEADER.md | 43 ++++ wiki-information/events/CHAT_MSG_LOOT.md | 46 ++++ wiki-information/events/CHAT_MSG_MONEY.md | 43 ++++ .../events/CHAT_MSG_MONSTER_EMOTE.md | 49 ++++ .../events/CHAT_MSG_MONSTER_PARTY.md | 49 ++++ .../events/CHAT_MSG_MONSTER_SAY.md | 49 ++++ .../events/CHAT_MSG_MONSTER_WHISPER.md | 49 ++++ .../events/CHAT_MSG_MONSTER_YELL.md | 49 ++++ wiki-information/events/CHAT_MSG_OFFICER.md | 43 ++++ wiki-information/events/CHAT_MSG_OPENING.md | 43 ++++ wiki-information/events/CHAT_MSG_PARTY.md | 51 ++++ .../events/CHAT_MSG_PARTY_LEADER.md | 43 ++++ .../events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md | 43 ++++ .../events/CHAT_MSG_PET_BATTLE_INFO.md | 43 ++++ wiki-information/events/CHAT_MSG_PET_INFO.md | 43 ++++ wiki-information/events/CHAT_MSG_RAID.md | 50 ++++ .../events/CHAT_MSG_RAID_BOSS_EMOTE.md | 43 ++++ .../events/CHAT_MSG_RAID_BOSS_WHISPER.md | 43 ++++ .../events/CHAT_MSG_RAID_LEADER.md | 43 ++++ .../events/CHAT_MSG_RAID_WARNING.md | 43 ++++ .../events/CHAT_MSG_RESTRICTED.md | 43 ++++ wiki-information/events/CHAT_MSG_SAY.md | 51 ++++ wiki-information/events/CHAT_MSG_SKILL.md | 45 ++++ wiki-information/events/CHAT_MSG_SYSTEM.md | 48 ++++ .../events/CHAT_MSG_TARGETICONS.md | 44 ++++ .../events/CHAT_MSG_TEXT_EMOTE.md | 43 ++++ .../events/CHAT_MSG_TRADESKILLS.md | 43 ++++ .../events/CHAT_MSG_VOICE_TEXT.md | 43 ++++ wiki-information/events/CHAT_MSG_WHISPER.md | 51 ++++ .../events/CHAT_MSG_WHISPER_INFORM.md | 43 ++++ wiki-information/events/CHAT_MSG_YELL.md | 51 ++++ .../events/CHAT_SERVER_DISCONNECTED.md | 11 + .../events/CHAT_SERVER_RECONNECTED.md | 10 + wiki-information/events/CINEMATIC_START.md | 15 ++ wiki-information/events/CINEMATIC_STOP.md | 13 + .../events/CLASS_TRIAL_TIMER_START.md | 10 + .../events/CLASS_TRIAL_UPGRADE_COMPLETE.md | 10 + wiki-information/events/CLEAR_BOSS_EMOTES.md | 10 + .../events/CLIENT_SCENE_CLOSED.md | 10 + .../events/CLIENT_SCENE_OPENED.md | 18 ++ wiki-information/events/CLOSE_INBOX_ITEM.md | 11 + wiki-information/events/CLOSE_TABARD_FRAME.md | 10 + wiki-information/events/CLUB_ADDED.md | 11 + wiki-information/events/CLUB_ERROR.md | 98 ++++++++ .../CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md | 11 + .../events/CLUB_INVITATION_ADDED_FOR_SELF.md | 172 +++++++++++++ .../CLUB_INVITATION_REMOVED_FOR_SELF.md | 11 + wiki-information/events/CLUB_MEMBER_ADDED.md | 13 + .../events/CLUB_MEMBER_PRESENCE_UPDATED.md | 31 +++ .../events/CLUB_MEMBER_REMOVED.md | 13 + .../events/CLUB_MEMBER_ROLE_UPDATED.md | 15 ++ .../events/CLUB_MEMBER_UPDATED.md | 13 + wiki-information/events/CLUB_MESSAGE_ADDED.md | 23 ++ .../events/CLUB_MESSAGE_HISTORY_RECEIVED.md | 34 +++ .../events/CLUB_MESSAGE_UPDATED.md | 23 ++ wiki-information/events/CLUB_REMOVED.md | 11 + .../events/CLUB_REMOVED_MESSAGE.md | 24 ++ .../events/CLUB_SELF_MEMBER_ROLE_UPDATED.md | 13 + .../events/CLUB_STREAMS_LOADED.md | 11 + wiki-information/events/CLUB_STREAM_ADDED.md | 13 + .../events/CLUB_STREAM_REMOVED.md | 13 + .../events/CLUB_STREAM_SUBSCRIBED.md | 13 + .../events/CLUB_STREAM_UNSUBSCRIBED.md | 13 + .../events/CLUB_STREAM_UPDATED.md | 13 + .../events/CLUB_TICKETS_RECEIVED.md | 11 + .../events/CLUB_TICKET_CREATED.md | 140 +++++++++++ .../events/CLUB_TICKET_RECEIVED.md | 11 + wiki-information/events/CLUB_UPDATED.md | 11 + wiki-information/events/COMBAT_LOG_EVENT.md | 220 +++++++++++++++++ .../events/COMBAT_LOG_EVENT_UNFILTERED.md | 228 ++++++++++++++++++ .../events/COMBAT_RATING_UPDATE.md | 10 + wiki-information/events/COMBAT_TEXT_UPDATE.md | 37 +++ .../events/COMMENTATOR_ENTER_WORLD.md | 10 + .../events/COMMENTATOR_HISTORY_FLUSHED.md | 10 + .../COMMENTATOR_IMMEDIATE_FOV_UPDATE.md | 11 + .../events/COMMENTATOR_MAP_UPDATE.md | 10 + ...COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md | 13 + .../events/COMMENTATOR_PLAYER_UPDATE.md | 10 + .../events/COMMENTATOR_RESET_SETTINGS.md | 10 + .../events/COMMENTATOR_TEAMS_SWAPPED.md | 11 + .../events/COMMENTATOR_TEAM_NAME_UPDATE.md | 11 + .../events/COMMUNITIES_STREAM_CURSOR_CLEAR.md | 10 + .../COMPACT_UNIT_FRAME_PROFILES_LOADED.md | 10 + wiki-information/events/COMPANION_LEARNED.md | 10 + .../events/COMPANION_UNLEARNED.md | 10 + wiki-information/events/COMPANION_UPDATE.md | 20 ++ wiki-information/events/CONFIRM_BEFORE_USE.md | 10 + wiki-information/events/CONFIRM_BINDER.md | 11 + wiki-information/events/CONFIRM_LOOT_ROLL.md | 18 ++ .../events/CONFIRM_PET_UNLEARN.md | 11 + wiki-information/events/CONFIRM_SUMMON.md | 13 + .../events/CONFIRM_TALENT_WIPE.md | 13 + wiki-information/events/CONFIRM_XP_LOSS.md | 16 ++ wiki-information/events/CONSOLE_CLEAR.md | 10 + .../events/CONSOLE_COLORS_CHANGED.md | 10 + .../events/CONSOLE_FONT_SIZE_CHANGED.md | 10 + wiki-information/events/CONSOLE_LOG.md | 11 + wiki-information/events/CONSOLE_MESSAGE.md | 13 + wiki-information/events/CORPSE_IN_INSTANCE.md | 10 + wiki-information/events/CORPSE_IN_RANGE.md | 10 + .../events/CORPSE_OUT_OF_RANGE.md | 10 + wiki-information/events/CRAFT_CLOSE.md | 10 + wiki-information/events/CRAFT_SHOW.md | 10 + wiki-information/events/CRAFT_UPDATE.md | 10 + wiki-information/events/CRITERIA_COMPLETE.md | 11 + wiki-information/events/CRITERIA_EARNED.md | 13 + wiki-information/events/CRITERIA_UPDATE.md | 13 + .../events/CURRENCY_DISPLAY_UPDATE.md | 19 ++ .../events/CURRENT_SPELL_CAST_CHANGED.md | 11 + wiki-information/events/CURSOR_CHANGED.md | 40 +++ wiki-information/events/CURSOR_UPDATE.md | 10 + wiki-information/events/CVAR_UPDATE.md | 13 + .../events/DELETE_ITEM_CONFIRM.md | 17 ++ .../events/DISABLE_DECLINE_GUILD_INVITE.md | 10 + .../events/DISABLE_LOW_LEVEL_RAID.md | 10 + .../events/DISABLE_TAXI_BENCHMARK.md | 10 + wiki-information/events/DISABLE_XP_GAIN.md | 10 + .../events/DISPLAY_SIZE_CHANGED.md | 10 + wiki-information/events/DUEL_FINISHED.md | 10 + wiki-information/events/DUEL_INBOUNDS.md | 10 + wiki-information/events/DUEL_OUTOFBOUNDS.md | 10 + wiki-information/events/DUEL_REQUESTED.md | 11 + .../events/DYNAMIC_GOSSIP_POI_UPDATED.md | 19 ++ .../events/ENABLE_DECLINE_GUILD_INVITE.md | 10 + .../events/ENABLE_LOW_LEVEL_RAID.md | 10 + .../events/ENABLE_TAXI_BENCHMARK.md | 10 + wiki-information/events/ENABLE_XP_GAIN.md | 10 + wiki-information/events/ENCOUNTER_END.md | 19 ++ wiki-information/events/ENCOUNTER_START.md | 17 ++ .../events/END_BOUND_TRADEABLE.md | 11 + .../ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md | 10 + .../events/ENTITLEMENT_DELIVERED.md | 33 +++ .../events/EQUIPMENT_SETS_CHANGED.md | 10 + .../events/EQUIPMENT_SWAP_FINISHED.md | 13 + .../events/EQUIPMENT_SWAP_PENDING.md | 10 + wiki-information/events/EQUIP_BIND_CONFIRM.md | 11 + .../events/EQUIP_BIND_REFUNDABLE_CONFIRM.md | 11 + .../events/EQUIP_BIND_TRADEABLE_CONFIRM.md | 11 + wiki-information/events/EXECUTE_CHAT_LINE.md | 11 + .../events/FIRST_FRAME_RENDERED.md | 10 + .../events/FORBIDDEN_NAME_PLATE_CREATED.md | 11 + .../events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md | 11 + .../FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md | 11 + wiki-information/events/FRIENDLIST_UPDATE.md | 21 ++ .../events/GAME_PAD_ACTIVE_CHANGED.md | 11 + .../events/GAME_PAD_CONFIGS_CHANGED.md | 10 + wiki-information/events/GAME_PAD_CONNECTED.md | 10 + .../events/GAME_PAD_DISCONNECTED.md | 10 + .../events/GAME_PAD_POWER_CHANGED.md | 20 ++ wiki-information/events/GDF_SIM_COMPLETE.md | 10 + wiki-information/events/GENERIC_ERROR.md | 11 + .../events/GET_ITEM_INFO_RECEIVED.md | 15 ++ wiki-information/events/GLOBAL_MOUSE_DOWN.md | 11 + wiki-information/events/GLOBAL_MOUSE_UP.md | 11 + wiki-information/events/GLUE_CONSOLE_LOG.md | 11 + .../events/GLUE_SCREENSHOT_FAILED.md | 10 + wiki-information/events/GM_PLAYER_INFO.md | 13 + wiki-information/events/GOSSIP_CLOSED.md | 10 + wiki-information/events/GOSSIP_CONFIRM.md | 15 ++ .../events/GOSSIP_CONFIRM_CANCEL.md | 10 + wiki-information/events/GOSSIP_ENTER_CODE.md | 11 + wiki-information/events/GOSSIP_SHOW.md | 14 ++ wiki-information/events/GROUP_FORMED.md | 13 + .../events/GROUP_INVITE_CONFIRMATION.md | 10 + wiki-information/events/GROUP_JOINED.md | 13 + wiki-information/events/GROUP_LEFT.md | 13 + .../events/GROUP_ROSTER_UPDATE.md | 10 + .../events/GUILDBANKBAGSLOTS_CHANGED.md | 10 + .../events/GUILDBANKFRAME_CLOSED.md | 10 + .../events/GUILDBANKFRAME_OPENED.md | 10 + .../events/GUILDBANKLOG_UPDATE.md | 10 + .../events/GUILDBANK_ITEM_LOCK_CHANGED.md | 10 + .../events/GUILDBANK_TEXT_CHANGED.md | 11 + .../events/GUILDBANK_UPDATE_MONEY.md | 10 + .../events/GUILDBANK_UPDATE_TABS.md | 10 + .../events/GUILDBANK_UPDATE_TEXT.md | 11 + .../events/GUILDBANK_UPDATE_WITHDRAWMONEY.md | 10 + wiki-information/events/GUILDTABARD_UPDATE.md | 10 + .../events/GUILD_EVENT_LOG_UPDATE.md | 10 + .../events/GUILD_INVITE_CANCEL.md | 10 + .../events/GUILD_INVITE_REQUEST.md | 35 +++ wiki-information/events/GUILD_MOTD.md | 11 + .../events/GUILD_PARTY_STATE_UPDATED.md | 11 + wiki-information/events/GUILD_RANKS_UPDATE.md | 10 + .../events/GUILD_REGISTRAR_CLOSED.md | 10 + .../events/GUILD_REGISTRAR_SHOW.md | 10 + .../events/GUILD_RENAME_REQUIRED.md | 11 + .../events/GUILD_ROSTER_UPDATE.md | 15 ++ wiki-information/events/GX_RESTARTED.md | 10 + wiki-information/events/HEARTHSTONE_BOUND.md | 10 + wiki-information/events/HEIRLOOMS_UPDATED.md | 15 ++ .../HEIRLOOM_UPGRADE_TARGETING_CHANGED.md | 11 + wiki-information/events/HIDE_SUBTITLE.md | 10 + wiki-information/events/IGNORELIST_UPDATE.md | 10 + .../events/INCOMING_RESURRECT_CHANGED.md | 11 + .../events/INITIAL_CLUBS_LOADED.md | 10 + .../events/INITIAL_HOTFIXES_APPLIED.md | 10 + .../events/INSPECT_ACHIEVEMENT_READY.md | 15 ++ .../events/INSPECT_HONOR_UPDATE.md | 10 + wiki-information/events/INSPECT_READY.md | 14 ++ .../events/INSTANCE_BOOT_START.md | 10 + wiki-information/events/INSTANCE_BOOT_STOP.md | 10 + .../events/INSTANCE_ENCOUNTER_ADD_TIMER.md | 11 + .../events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md | 10 + .../INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md | 11 + .../INSTANCE_ENCOUNTER_OBJECTIVE_START.md | 13 + .../INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md | 13 + .../events/INSTANCE_GROUP_SIZE_CHANGED.md | 10 + .../events/INSTANCE_LOCK_START.md | 10 + wiki-information/events/INSTANCE_LOCK_STOP.md | 10 + .../events/INSTANCE_LOCK_WARNING.md | 10 + .../events/INVENTORY_SEARCH_UPDATE.md | 10 + wiki-information/events/ISLAND_COMPLETED.md | 13 + .../events/ITEM_DATA_LOAD_RESULT.md | 13 + wiki-information/events/ITEM_LOCKED.md | 13 + wiki-information/events/ITEM_LOCK_CHANGED.md | 19 ++ wiki-information/events/ITEM_PUSH.md | 13 + .../events/ITEM_RESTORATION_BUTTON_STATUS.md | 10 + wiki-information/events/ITEM_TEXT_BEGIN.md | 10 + wiki-information/events/ITEM_TEXT_CLOSED.md | 10 + wiki-information/events/ITEM_TEXT_READY.md | 10 + .../events/ITEM_TEXT_TRANSLATION.md | 11 + wiki-information/events/ITEM_UNLOCKED.md | 13 + .../events/ITEM_UPGRADE_FAILED.md | 10 + .../events/ITEM_UPGRADE_MASTER_CLOSED.md | 13 + .../events/ITEM_UPGRADE_MASTER_OPENED.md | 10 + .../events/ITEM_UPGRADE_MASTER_SET_ITEM.md | 14 ++ .../KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md | 10 + .../KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md | 13 + .../KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md | 10 + .../KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md | 10 + .../events/KNOWLEDGE_BASE_SERVER_MESSAGE.md | 13 + .../KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md | 10 + .../KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md | 10 + .../KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md | 10 + .../events/LANGUAGE_LIST_CHANGED.md | 10 + .../events/LEARNED_SPELL_IN_TAB.md | 15 ++ .../events/LFG_BOOT_PROPOSAL_UPDATE.md | 10 + .../events/LFG_COMPLETION_REWARD.md | 10 + .../LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md | 13 + .../events/LFG_INVALID_ERROR_MESSAGE.md | 15 ++ .../events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md | 11 + .../events/LFG_LIST_AVAILABILITY_UPDATE.md | 10 + .../events/LFG_LIST_ENTRY_CREATION_FAILED.md | 10 + .../events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md | 10 + ...LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md | 10 + .../events/LFG_LIST_SEARCH_FAILED.md | 11 + .../LFG_LIST_SEARCH_RESULTS_RECEIVED.md | 10 + .../events/LFG_LIST_SEARCH_RESULT_UPDATED.md | 11 + .../events/LFG_LOCK_INFO_RECEIVED.md | 13 + wiki-information/events/LFG_OFFER_CONTINUE.md | 15 ++ .../events/LFG_OPEN_FROM_GOSSIP.md | 11 + wiki-information/events/LFG_PROPOSAL_DONE.md | 10 + .../events/LFG_PROPOSAL_FAILED.md | 10 + wiki-information/events/LFG_PROPOSAL_SHOW.md | 10 + .../events/LFG_PROPOSAL_SUCCEEDED.md | 10 + .../events/LFG_PROPOSAL_UPDATE.md | 10 + .../events/LFG_QUEUE_STATUS_UPDATE.md | 10 + .../events/LFG_READY_CHECK_DECLINED.md | 11 + .../events/LFG_READY_CHECK_HIDE.md | 10 + .../events/LFG_READY_CHECK_PLAYER_IS_READY.md | 11 + .../events/LFG_READY_CHECK_SHOW.md | 11 + .../events/LFG_READY_CHECK_UPDATE.md | 10 + .../events/LFG_ROLE_CHECK_DECLINED.md | 10 + .../events/LFG_ROLE_CHECK_HIDE.md | 10 + .../events/LFG_ROLE_CHECK_ROLE_CHOSEN.md | 17 ++ .../events/LFG_ROLE_CHECK_SHOW.md | 11 + .../events/LFG_ROLE_CHECK_UPDATE.md | 10 + wiki-information/events/LFG_ROLE_UPDATE.md | 10 + wiki-information/events/LFG_UPDATE.md | 13 + .../events/LFG_UPDATE_RANDOM_INFO.md | 10 + .../events/LOADING_SCREEN_DISABLED.md | 10 + .../events/LOADING_SCREEN_ENABLED.md | 10 + .../events/LOCALPLAYER_PET_RENAMED.md | 10 + wiki-information/events/LOC_RESULT.md | 11 + wiki-information/events/LOGOUT_CANCEL.md | 10 + wiki-information/events/LOOT_BIND_CONFIRM.md | 11 + wiki-information/events/LOOT_CLOSED.md | 14 ++ .../events/LOOT_HISTORY_AUTO_SHOW.md | 13 + .../events/LOOT_HISTORY_FULL_UPDATE.md | 10 + .../events/LOOT_HISTORY_ROLL_CHANGED.md | 13 + .../events/LOOT_HISTORY_ROLL_COMPLETE.md | 10 + .../events/LOOT_ITEM_AVAILABLE.md | 13 + wiki-information/events/LOOT_ITEM_ROLL_WON.md | 19 ++ wiki-information/events/LOOT_OPENED.md | 13 + wiki-information/events/LOOT_READY.md | 15 ++ .../events/LOOT_ROLLS_COMPLETE.md | 11 + wiki-information/events/LOOT_SLOT_CHANGED.md | 11 + wiki-information/events/LOOT_SLOT_CLEARED.md | 11 + .../events/LOSS_OF_CONTROL_ADDED.md | 11 + .../LOSS_OF_CONTROL_COMMENTATOR_ADDED.md | 13 + .../LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md | 11 + .../events/LOSS_OF_CONTROL_UPDATE.md | 10 + wiki-information/events/LUA_WARNING.md | 13 + .../events/MACRO_ACTION_BLOCKED.md | 11 + .../events/MACRO_ACTION_FORBIDDEN.md | 11 + wiki-information/events/MAIL_CLOSED.md | 10 + wiki-information/events/MAIL_FAILED.md | 11 + wiki-information/events/MAIL_INBOX_UPDATE.md | 15 ++ .../events/MAIL_LOCK_SEND_ITEMS.md | 13 + .../events/MAIL_SEND_INFO_UPDATE.md | 10 + wiki-information/events/MAIL_SEND_SUCCESS.md | 10 + wiki-information/events/MAIL_SHOW.md | 10 + wiki-information/events/MAIL_SUCCESS.md | 11 + .../events/MAIL_UNLOCK_SEND_ITEMS.md | 10 + .../events/MAP_EXPLORATION_UPDATED.md | 10 + .../events/MAX_EXPANSION_LEVEL_UPDATED.md | 10 + ...MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md | 11 + wiki-information/events/MERCHANT_CLOSED.md | 10 + .../MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md | 11 + .../events/MERCHANT_FILTER_ITEM_UPDATE.md | 11 + wiki-information/events/MERCHANT_SHOW.md | 10 + wiki-information/events/MERCHANT_UPDATE.md | 10 + wiki-information/events/MINIMAP_PING.md | 15 ++ .../events/MINIMAP_UPDATE_TRACKING.md | 10 + .../events/MINIMAP_UPDATE_ZOOM.md | 13 + .../events/MIN_EXPANSION_LEVEL_UPDATED.md | 10 + wiki-information/events/MIRROR_TIMER_PAUSE.md | 13 + wiki-information/events/MIRROR_TIMER_START.md | 21 ++ wiki-information/events/MIRROR_TIMER_STOP.md | 11 + .../events/MODIFIER_STATE_CHANGED.md | 30 +++ wiki-information/events/MOUNT_CURSOR_CLEAR.md | 13 + wiki-information/events/MUTELIST_UPDATE.md | 10 + wiki-information/events/NAME_PLATE_CREATED.md | 38 +++ .../events/NAME_PLATE_UNIT_ADDED.md | 11 + .../events/NAME_PLATE_UNIT_REMOVED.md | 11 + wiki-information/events/NEW_AUCTION_UPDATE.md | 13 + wiki-information/events/NEW_RECIPE_LEARNED.md | 15 ++ wiki-information/events/NEW_TOY_ADDED.md | 15 ++ wiki-information/events/NEW_WMO_CHUNK.md | 10 + .../events/NOTCHED_DISPLAY_MODE_CHANGED.md | 10 + .../events/NOTIFY_CHAT_SUPPRESSED.md | 10 + .../events/NOTIFY_PVP_AFK_RESULT.md | 15 ++ wiki-information/events/OBJECT_ENTERED_AOI.md | 11 + wiki-information/events/OBJECT_LEFT_AOI.md | 11 + .../events/OBLITERUM_FORGE_CLOSE.md | 10 + .../OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md | 10 + .../events/OBLITERUM_FORGE_SHOW.md | 10 + .../events/OPEN_MASTER_LOOT_LIST.md | 10 + wiki-information/events/OPEN_REPORT_PLAYER.md | 35 +++ wiki-information/events/OPEN_TABARD_FRAME.md | 10 + .../events/PARTY_INVITE_CANCEL.md | 10 + .../events/PARTY_INVITE_REQUEST.md | 25 ++ .../events/PARTY_LEADER_CHANGED.md | 10 + .../events/PARTY_LOOT_METHOD_CHANGED.md | 10 + .../events/PARTY_MEMBER_DISABLE.md | 11 + .../events/PARTY_MEMBER_ENABLE.md | 11 + .../events/PENDING_AZERITE_ESSENCE_CHANGED.md | 11 + wiki-information/events/PETITION_CLOSED.md | 10 + wiki-information/events/PETITION_SHOW.md | 10 + wiki-information/events/PET_ATTACK_START.md | 10 + wiki-information/events/PET_ATTACK_STOP.md | 10 + wiki-information/events/PET_BAR_HIDEGRID.md | 10 + wiki-information/events/PET_BAR_SHOWGRID.md | 10 + wiki-information/events/PET_BAR_UPDATE.md | 19 ++ .../events/PET_BAR_UPDATE_COOLDOWN.md | 10 + .../events/PET_BAR_UPDATE_USABLE.md | 10 + .../events/PET_BATTLE_ABILITY_CHANGED.md | 15 ++ .../events/PET_BATTLE_ACTION_SELECTED.md | 10 + .../events/PET_BATTLE_AURA_APPLIED.md | 15 ++ .../events/PET_BATTLE_AURA_CANCELED.md | 15 ++ .../events/PET_BATTLE_AURA_CHANGED.md | 15 ++ .../events/PET_BATTLE_CAPTURED.md | 16 ++ wiki-information/events/PET_BATTLE_CLOSE.md | 14 ++ .../events/PET_BATTLE_FINAL_ROUND.md | 14 ++ .../events/PET_BATTLE_HEALTH_CHANGED.md | 15 ++ .../events/PET_BATTLE_LEVEL_CHANGED.md | 15 ++ .../events/PET_BATTLE_MAX_HEALTH_CHANGED.md | 15 ++ .../events/PET_BATTLE_OPENING_DONE.md | 13 + .../events/PET_BATTLE_OPENING_START.md | 13 + wiki-information/events/PET_BATTLE_OVER.md | 13 + .../events/PET_BATTLE_OVERRIDE_ABILITY.md | 11 + .../events/PET_BATTLE_PET_CHANGED.md | 14 ++ .../PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md | 11 + .../events/PET_BATTLE_PET_ROUND_RESULTS.md | 11 + .../events/PET_BATTLE_PET_TYPE_CHANGED.md | 15 ++ .../events/PET_BATTLE_PVP_DUEL_REQUESTED.md | 11 + .../PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md | 10 + .../PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md | 10 + .../PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md | 10 + .../events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md | 10 + .../events/PET_BATTLE_QUEUE_STATUS.md | 10 + .../events/PET_BATTLE_XP_CHANGED.md | 18 ++ wiki-information/events/PET_DISMISS_START.md | 11 + .../events/PET_FORCE_NAME_DECLENSION.md | 21 ++ .../events/PET_SPELL_POWER_UPDATE.md | 10 + wiki-information/events/PET_STABLE_CLOSED.md | 10 + wiki-information/events/PET_STABLE_SHOW.md | 10 + wiki-information/events/PET_STABLE_UPDATE.md | 10 + .../events/PET_STABLE_UPDATE_PAPERDOLL.md | 10 + wiki-information/events/PET_UI_CLOSE.md | 10 + wiki-information/events/PET_UI_UPDATE.md | 10 + .../events/PLAYERBANKBAGSLOTS_CHANGED.md | 10 + .../events/PLAYERBANKSLOTS_CHANGED.md | 11 + wiki-information/events/PLAYER_ALIVE.md | 13 + .../events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md | 19 ++ wiki-information/events/PLAYER_CAMPING.md | 10 + .../events/PLAYER_CONTROL_GAINED.md | 10 + .../events/PLAYER_CONTROL_LOST.md | 10 + .../events/PLAYER_DAMAGE_DONE_MODS.md | 11 + wiki-information/events/PLAYER_DEAD.md | 10 + .../events/PLAYER_DIFFICULTY_CHANGED.md | 10 + .../events/PLAYER_ENTERING_BATTLEGROUND.md | 10 + .../events/PLAYER_ENTERING_WORLD.md | 30 +++ .../events/PLAYER_ENTER_COMBAT.md | 14 ++ .../events/PLAYER_EQUIPMENT_CHANGED.md | 18 ++ .../events/PLAYER_FARSIGHT_FOCUS_CHANGED.md | 10 + .../events/PLAYER_FLAGS_CHANGED.md | 14 ++ .../events/PLAYER_FOCUS_CHANGED.md | 10 + .../events/PLAYER_GAINS_VEHICLE_DATA.md | 13 + .../events/PLAYER_GUILD_UPDATE.md | 11 + .../events/PLAYER_LEAVE_COMBAT.md | 10 + .../events/PLAYER_LEAVING_WORLD.md | 10 + .../events/PLAYER_LEVEL_CHANGED.md | 15 ++ wiki-information/events/PLAYER_LEVEL_UP.md | 27 +++ wiki-information/events/PLAYER_LOGIN.md | 17 ++ wiki-information/events/PLAYER_LOGOUT.md | 14 ++ .../events/PLAYER_LOSES_VEHICLE_DATA.md | 11 + wiki-information/events/PLAYER_MONEY.md | 16 ++ .../events/PLAYER_MOUNT_DISPLAY_CHANGED.md | 10 + .../events/PLAYER_PVP_KILLS_CHANGED.md | 11 + .../events/PLAYER_PVP_RANK_CHANGED.md | 11 + wiki-information/events/PLAYER_QUITING.md | 14 ++ .../events/PLAYER_REGEN_DISABLED.md | 14 ++ .../events/PLAYER_REGEN_ENABLED.md | 14 ++ .../events/PLAYER_REPORT_SUBMITTED.md | 11 + .../events/PLAYER_ROLES_ASSIGNED.md | 10 + wiki-information/events/PLAYER_SKINNED.md | 11 + .../events/PLAYER_STARTED_LOOKING.md | 10 + .../events/PLAYER_STARTED_MOVING.md | 10 + .../events/PLAYER_STARTED_TURNING.md | 10 + .../events/PLAYER_STOPPED_LOOKING.md | 10 + .../events/PLAYER_STOPPED_MOVING.md | 10 + .../events/PLAYER_STOPPED_TURNING.md | 10 + .../events/PLAYER_TALENT_UPDATE.md | 13 + .../events/PLAYER_TARGET_CHANGED.md | 10 + .../events/PLAYER_TARGET_SET_ATTACKING.md | 16 ++ .../events/PLAYER_TOTEM_UPDATE.md | 11 + wiki-information/events/PLAYER_TRADE_MONEY.md | 10 + .../events/PLAYER_TRIAL_XP_UPDATE.md | 11 + wiki-information/events/PLAYER_UNGHOST.md | 18 ++ .../events/PLAYER_UPDATE_RESTING.md | 10 + wiki-information/events/PLAYER_XP_UPDATE.md | 11 + wiki-information/events/PLAY_MOVIE.md | 14 ++ wiki-information/events/PORTRAITS_UPDATED.md | 10 + .../events/PVP_RATED_STATS_UPDATE.md | 10 + wiki-information/events/PVP_TIMER_UPDATE.md | 11 + .../events/PVP_WORLDSTATE_UPDATE.md | 10 + wiki-information/events/QUEST_ACCEPTED.md | 13 + .../events/QUEST_ACCEPT_CONFIRM.md | 13 + wiki-information/events/QUEST_AUTOCOMPLETE.md | 15 ++ wiki-information/events/QUEST_BOSS_EMOTE.md | 17 ++ wiki-information/events/QUEST_COMPLETE.md | 10 + wiki-information/events/QUEST_DETAIL.md | 15 ++ wiki-information/events/QUEST_FINISHED.md | 10 + wiki-information/events/QUEST_GREETING.md | 10 + wiki-information/events/QUEST_ITEM_UPDATE.md | 10 + wiki-information/events/QUEST_LOG_UPDATE.md | 19 ++ wiki-information/events/QUEST_PROGRESS.md | 10 + wiki-information/events/QUEST_REMOVED.md | 13 + .../events/QUEST_SESSION_CREATED.md | 10 + .../events/QUEST_SESSION_DESTROYED.md | 10 + .../QUEST_SESSION_ENABLED_STATE_CHANGED.md | 11 + .../events/QUEST_SESSION_JOINED.md | 14 ++ wiki-information/events/QUEST_SESSION_LEFT.md | 14 ++ .../events/QUEST_SESSION_MEMBER_CONFIRM.md | 10 + .../QUEST_SESSION_MEMBER_START_RESPONSE.md | 13 + .../events/QUEST_SESSION_NOTIFICATION.md | 124 ++++++++++ wiki-information/events/QUEST_TURNED_IN.md | 15 ++ .../events/QUEST_WATCH_LIST_CHANGED.md | 13 + wiki-information/events/QUEST_WATCH_UPDATE.md | 14 ++ .../events/QUICK_TICKET_SYSTEM_STATUS.md | 10 + .../events/QUICK_TICKET_THROTTLE_CHANGED.md | 10 + .../events/RAF_ENTITLEMENT_DELIVERED.md | 41 ++++ wiki-information/events/RAID_BOSS_EMOTE.md | 17 ++ wiki-information/events/RAID_BOSS_WHISPER.md | 17 ++ .../events/RAID_INSTANCE_WELCOME.md | 17 ++ wiki-information/events/RAID_ROSTER_UPDATE.md | 10 + wiki-information/events/RAID_TARGET_UPDATE.md | 15 ++ wiki-information/events/RAISED_AS_GHOUL.md | 10 + wiki-information/events/READY_CHECK.md | 13 + .../events/READY_CHECK_CONFIRM.md | 13 + .../events/READY_CHECK_FINISHED.md | 11 + .../events/RECEIVED_ACHIEVEMENT_LIST.md | 10 + .../RECEIVED_ACHIEVEMENT_MEMBER_LIST.md | 11 + wiki-information/events/REPLACE_ENCHANT.md | 13 + .../events/REPORT_PLAYER_RESULT.md | 50 ++++ .../events/REQUEST_CEMETERY_LIST_RESPONSE.md | 11 + .../events/REQUIRED_GUILD_RENAME_RESULT.md | 11 + .../RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md | 10 + .../RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md | 10 + wiki-information/events/RESURRECT_REQUEST.md | 11 + .../events/ROLE_CHANGED_INFORM.md | 17 ++ wiki-information/events/ROLE_POLL_BEGIN.md | 11 + wiki-information/events/RUNE_POWER_UPDATE.md | 13 + wiki-information/events/RUNE_TYPE_UPDATE.md | 11 + .../events/SAVED_VARIABLES_TOO_LARGE.md | 19 ++ wiki-information/events/SCREENSHOT_FAILED.md | 10 + wiki-information/events/SCREENSHOT_STARTED.md | 10 + .../events/SCREENSHOT_SUCCEEDED.md | 10 + wiki-information/events/SEARCH_DB_LOADED.md | 10 + .../events/SECURE_TRANSFER_CANCEL.md | 14 ++ .../SECURE_TRANSFER_CONFIRM_SEND_MAIL.md | 21 ++ .../SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md | 21 ++ .../events/SELF_RES_SPELL_CHANGED.md | 10 + .../events/SEND_MAIL_COD_CHANGED.md | 10 + .../events/SEND_MAIL_MONEY_CHANGED.md | 10 + .../events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md | 10 + .../SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md | 11 + .../events/SHOW_LOOT_TOAST_UPGRADE.md | 23 ++ .../events/SHOW_PVP_FACTION_LOOT_TOAST.md | 23 ++ .../events/SHOW_RATED_PVP_REWARD_TOAST.md | 23 ++ .../events/SIMPLE_BROWSER_WEB_ERROR.md | 11 + .../events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md | 10 + .../events/SIMPLE_CHECKOUT_CLOSED.md | 10 + .../events/SKILL_LINES_CHANGED.md | 13 + .../events/SOCIAL_ITEM_RECEIVED.md | 10 + wiki-information/events/SOCKET_INFO_ACCEPT.md | 10 + wiki-information/events/SOCKET_INFO_CLOSE.md | 10 + .../events/SOCKET_INFO_FAILURE.md | 10 + .../events/SOCKET_INFO_REFUNDABLE_CONFIRM.md | 10 + .../events/SOCKET_INFO_SUCCESS.md | 10 + wiki-information/events/SOCKET_INFO_UPDATE.md | 10 + wiki-information/events/SOUNDKIT_FINISHED.md | 11 + .../events/SOUND_DEVICE_UPDATE.md | 7 + wiki-information/events/SPELLS_CHANGED.md | 16 ++ .../SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md | 11 + .../SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md | 11 + .../events/SPELL_ACTIVATION_OVERLAY_HIDE.md | 11 + .../events/SPELL_ACTIVATION_OVERLAY_SHOW.md | 23 ++ .../events/SPELL_CONFIRMATION_PROMPT.md | 26 ++ .../events/SPELL_CONFIRMATION_TIMEOUT.md | 13 + .../events/SPELL_DATA_LOAD_RESULT.md | 16 ++ .../events/SPELL_POWER_CHANGED.md | 13 + wiki-information/events/SPELL_TEXT_UPDATE.md | 11 + .../events/SPELL_UPDATE_CHARGES.md | 10 + .../events/SPELL_UPDATE_COOLDOWN.md | 23 ++ wiki-information/events/SPELL_UPDATE_ICON.md | 13 + .../events/SPELL_UPDATE_USABLE.md | 20 ++ .../events/START_AUTOREPEAT_SPELL.md | 10 + wiki-information/events/START_LOOT_ROLL.md | 15 ++ wiki-information/events/START_TIMER.md | 15 ++ .../events/STOP_AUTOREPEAT_SPELL.md | 10 + wiki-information/events/STOP_MOVIE.md | 10 + wiki-information/events/STREAMING_ICON.md | 15 ++ .../events/STREAM_VIEW_MARKER_UPDATED.md | 15 ++ .../events/SUPER_TRACKED_QUEST_CHANGED.md | 11 + wiki-information/events/SYSMSG.md | 17 ++ .../events/TABARD_CANSAVE_CHANGED.md | 10 + .../events/TABARD_SAVE_PENDING.md | 10 + .../events/TALENTS_INVOLUNTARILY_RESET.md | 11 + .../events/TASK_PROGRESS_UPDATE.md | 10 + wiki-information/events/TAXIMAP_CLOSED.md | 10 + wiki-information/events/TAXIMAP_OPENED.md | 21 ++ wiki-information/events/TIME_PLAYED_MSG.md | 13 + wiki-information/events/TOGGLE_CONSOLE.md | 11 + wiki-information/events/TOKEN_AUCTION_SOLD.md | 10 + .../events/TOKEN_BUY_CONFIRM_REQUIRED.md | 10 + wiki-information/events/TOKEN_BUY_RESULT.md | 11 + .../events/TOKEN_CAN_VETERAN_BUY_UPDATE.md | 11 + .../events/TOKEN_DISTRIBUTIONS_UPDATED.md | 11 + .../events/TOKEN_MARKET_PRICE_UPDATED.md | 11 + .../events/TOKEN_REDEEM_BALANCE_UPDATED.md | 10 + .../events/TOKEN_REDEEM_CONFIRM_REQUIRED.md | 11 + .../events/TOKEN_REDEEM_FRAME_SHOW.md | 10 + .../events/TOKEN_REDEEM_GAME_TIME_UPDATED.md | 10 + .../events/TOKEN_REDEEM_RESULT.md | 13 + .../events/TOKEN_SELL_CONFIRM_REQUIRED.md | 10 + wiki-information/events/TOKEN_SELL_RESULT.md | 11 + .../events/TOKEN_STATUS_CHANGED.md | 10 + wiki-information/events/TOYS_UPDATED.md | 15 ++ .../TRACKED_ACHIEVEMENT_LIST_CHANGED.md | 13 + .../events/TRACKED_ACHIEVEMENT_UPDATE.md | 17 ++ .../events/TRADE_ACCEPT_UPDATE.md | 16 ++ wiki-information/events/TRADE_CLOSED.md | 10 + .../events/TRADE_MONEY_CHANGED.md | 10 + .../events/TRADE_PLAYER_ITEM_CHANGED.md | 14 ++ .../events/TRADE_POTENTIAL_BIND_ENCHANT.md | 11 + .../events/TRADE_REPLACE_ENCHANT.md | 13 + wiki-information/events/TRADE_REQUEST.md | 11 + .../events/TRADE_REQUEST_CANCEL.md | 13 + wiki-information/events/TRADE_SHOW.md | 10 + wiki-information/events/TRADE_SKILL_CLOSE.md | 10 + .../events/TRADE_SKILL_DATA_SOURCE_CHANGED.md | 10 + .../TRADE_SKILL_DATA_SOURCE_CHANGING.md | 10 + .../events/TRADE_SKILL_DETAILS_UPDATE.md | 10 + .../events/TRADE_SKILL_LIST_UPDATE.md | 10 + .../events/TRADE_SKILL_NAME_UPDATE.md | 10 + wiki-information/events/TRADE_SKILL_SHOW.md | 10 + wiki-information/events/TRADE_SKILL_UPDATE.md | 10 + .../events/TRADE_TARGET_ITEM_CHANGED.md | 11 + wiki-information/events/TRADE_UPDATE.md | 10 + wiki-information/events/TRAINER_CLOSED.md | 10 + .../events/TRAINER_DESCRIPTION_UPDATE.md | 10 + .../TRAINER_SERVICE_INFO_NAME_UPDATE.md | 10 + wiki-information/events/TRAINER_SHOW.md | 10 + wiki-information/events/TRAINER_UPDATE.md | 10 + .../events/TRANSMOG_OUTFITS_CHANGED.md | 10 + .../events/TRIAL_CAP_REACHED_MONEY.md | 10 + wiki-information/events/TUTORIAL_TRIGGER.md | 13 + .../events/TWITTER_LINK_RESULT.md | 15 ++ .../events/TWITTER_POST_RESULT.md | 11 + .../events/TWITTER_STATUS_UPDATE.md | 15 ++ .../events/UI_MODEL_SCENE_INFO_UPDATED.md | 10 + wiki-information/events/UI_SCALE_CHANGED.md | 10 + wiki-information/events/UNIT_ATTACK.md | 11 + wiki-information/events/UNIT_ATTACK_POWER.md | 11 + wiki-information/events/UNIT_ATTACK_SPEED.md | 11 + wiki-information/events/UNIT_AURA.md | 135 +++++++++++ .../events/UNIT_CHEAT_TOGGLE_EVENT.md | 10 + .../events/UNIT_CLASSIFICATION_CHANGED.md | 11 + wiki-information/events/UNIT_COMBAT.md | 19 ++ wiki-information/events/UNIT_CONNECTION.md | 13 + wiki-information/events/UNIT_DAMAGE.md | 14 ++ wiki-information/events/UNIT_DEFENSE.md | 11 + wiki-information/events/UNIT_DISPLAYPOWER.md | 11 + .../events/UNIT_ENTERED_VEHICLE.md | 23 ++ .../events/UNIT_ENTERING_VEHICLE.md | 23 ++ .../events/UNIT_EXITED_VEHICLE.md | 11 + .../events/UNIT_EXITING_VEHICLE.md | 11 + wiki-information/events/UNIT_FACTION.md | 11 + wiki-information/events/UNIT_FLAGS.md | 11 + wiki-information/events/UNIT_HAPPINESS.md | 11 + wiki-information/events/UNIT_HEALTH.md | 15 ++ .../events/UNIT_HEALTH_FREQUENT.md | 15 ++ .../events/UNIT_HEAL_PREDICTION.md | 11 + .../events/UNIT_INVENTORY_CHANGED.md | 20 ++ wiki-information/events/UNIT_LEVEL.md | 11 + wiki-information/events/UNIT_MANA.md | 11 + wiki-information/events/UNIT_MAXHEALTH.md | 15 ++ wiki-information/events/UNIT_MAXPOWER.md | 13 + wiki-information/events/UNIT_MODEL_CHANGED.md | 11 + wiki-information/events/UNIT_NAME_UPDATE.md | 11 + .../events/UNIT_OTHER_PARTY_CHANGED.md | 13 + wiki-information/events/UNIT_PET.md | 11 + .../events/UNIT_PET_EXPERIENCE.md | 11 + .../events/UNIT_PET_TRAINING_POINTS.md | 11 + wiki-information/events/UNIT_PHASE.md | 14 ++ .../events/UNIT_PORTRAIT_UPDATE.md | 11 + .../events/UNIT_POWER_BAR_HIDE.md | 11 + .../events/UNIT_POWER_BAR_SHOW.md | 11 + .../events/UNIT_POWER_BAR_TIMER_UPDATE.md | 11 + .../events/UNIT_POWER_FREQUENT.md | 20 ++ wiki-information/events/UNIT_POWER_UPDATE.md | 25 ++ .../events/UNIT_QUEST_LOG_CHANGED.md | 11 + wiki-information/events/UNIT_RANGEDDAMAGE.md | 11 + .../events/UNIT_RANGED_ATTACK_POWER.md | 11 + wiki-information/events/UNIT_RESISTANCES.md | 11 + .../events/UNIT_SPELLCAST_CHANNEL_START.md | 15 ++ .../events/UNIT_SPELLCAST_CHANNEL_STOP.md | 15 ++ .../events/UNIT_SPELLCAST_CHANNEL_UPDATE.md | 15 ++ .../events/UNIT_SPELLCAST_DELAYED.md | 15 ++ .../events/UNIT_SPELLCAST_FAILED.md | 15 ++ .../events/UNIT_SPELLCAST_FAILED_QUIET.md | 15 ++ .../events/UNIT_SPELLCAST_INTERRUPTED.md | 15 ++ .../events/UNIT_SPELLCAST_SENT.md | 20 ++ .../events/UNIT_SPELLCAST_START.md | 15 ++ .../events/UNIT_SPELLCAST_STOP.md | 15 ++ .../events/UNIT_SPELLCAST_SUCCEEDED.md | 15 ++ wiki-information/events/UNIT_SPELL_HASTE.md | 11 + wiki-information/events/UNIT_STATS.md | 11 + wiki-information/events/UNIT_TARGET.md | 14 ++ .../events/UNIT_TARGETABLE_CHANGED.md | 11 + .../events/UNIT_THREAT_LIST_UPDATE.md | 14 ++ .../events/UNIT_THREAT_SITUATION_UPDATE.md | 11 + .../events/UPDATE_ACTIVE_BATTLEFIELD.md | 10 + .../events/UPDATE_ALL_UI_WIDGETS.md | 10 + .../events/UPDATE_BATTLEFIELD_SCORE.md | 10 + .../events/UPDATE_BATTLEFIELD_STATUS.md | 11 + wiki-information/events/UPDATE_BINDINGS.md | 10 + .../events/UPDATE_BONUS_ACTIONBAR.md | 10 + wiki-information/events/UPDATE_CHAT_COLOR.md | 17 ++ .../events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md | 13 + .../events/UPDATE_CHAT_WINDOWS.md | 10 + wiki-information/events/UPDATE_EXHAUSTION.md | 10 + wiki-information/events/UPDATE_FACTION.md | 10 + .../events/UPDATE_FLOATING_CHAT_WINDOWS.md | 10 + .../events/UPDATE_INSTANCE_INFO.md | 10 + .../events/UPDATE_INVENTORY_ALERTS.md | 10 + .../events/UPDATE_INVENTORY_DURABILITY.md | 10 + wiki-information/events/UPDATE_LFG_LIST.md | 13 + wiki-information/events/UPDATE_MACROS.md | 10 + .../events/UPDATE_MASTER_LOOT_LIST.md | 10 + .../events/UPDATE_MOUSEOVER_UNIT.md | 14 ++ .../events/UPDATE_MULTI_CAST_ACTIONBAR.md | 10 + .../events/UPDATE_OVERRIDE_ACTIONBAR.md | 10 + .../events/UPDATE_PENDING_MAIL.md | 16 ++ wiki-information/events/UPDATE_POSSESS_BAR.md | 10 + .../events/UPDATE_SHAPESHIFT_COOLDOWN.md | 10 + .../events/UPDATE_SHAPESHIFT_FORM.md | 10 + .../events/UPDATE_SHAPESHIFT_FORMS.md | 10 + .../events/UPDATE_SHAPESHIFT_USABLE.md | 10 + wiki-information/events/UPDATE_STEALTH.md | 13 + .../events/UPDATE_TRADESKILL_RECAST.md | 10 + wiki-information/events/UPDATE_UI_WIDGET.md | 149 ++++++++++++ .../events/UPDATE_VEHICLE_ACTIONBAR.md | 10 + wiki-information/events/UPDATE_WEB_TICKET.md | 21 ++ wiki-information/events/USE_BIND_CONFIRM.md | 10 + wiki-information/events/USE_GLYPH.md | 11 + .../events/USE_NO_REFUND_CONFIRM.md | 10 + wiki-information/events/VARIABLES_LOADED.md | 18 ++ wiki-information/events/VEHICLE_ANGLE_SHOW.md | 11 + .../events/VEHICLE_ANGLE_UPDATE.md | 13 + .../events/VEHICLE_PASSENGERS_CHANGED.md | 10 + wiki-information/events/VEHICLE_POWER_SHOW.md | 11 + wiki-information/events/VEHICLE_UPDATE.md | 10 + .../VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md | 10 + ...VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md | 10 + .../events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md | 13 + .../VOICE_CHAT_AUDIO_CAPTURE_STARTED.md | 10 + .../VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md | 10 + .../events/VOICE_CHAT_CHANNEL_ACTIVATED.md | 11 + .../events/VOICE_CHAT_CHANNEL_DEACTIVATED.md | 11 + ...VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md | 13 + .../events/VOICE_CHAT_CHANNEL_JOINED.md | 91 +++++++ ...HAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md | 15 ++ .../events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md | 13 + ...OICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md | 15 ++ .../VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md | 13 + ...HAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md | 15 ++ ...CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md | 15 ++ .../VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md | 13 + ...CE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md | 15 ++ ...T_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md | 15 ++ .../VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md | 17 ++ ...OICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md | 15 ++ .../VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md | 13 + .../events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md | 13 + .../events/VOICE_CHAT_CHANNEL_REMOVED.md | 11 + ...VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md | 13 + .../VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md | 13 + .../VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md | 13 + .../VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md | 19 ++ .../events/VOICE_CHAT_CONNECTION_SUCCESS.md | 10 + .../events/VOICE_CHAT_DEAFENED_CHANGED.md | 11 + wiki-information/events/VOICE_CHAT_ERROR.md | 44 ++++ .../VOICE_CHAT_INPUT_DEVICES_UPDATED.md | 10 + wiki-information/events/VOICE_CHAT_LOGIN.md | 42 ++++ wiki-information/events/VOICE_CHAT_LOGOUT.md | 42 ++++ .../events/VOICE_CHAT_MUTED_CHANGED.md | 11 + .../VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md | 10 + .../VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md | 33 +++ ...E_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md | 11 + .../events/VOICE_CHAT_SILENCED_CHANGED.md | 11 + ...CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md | 10 + ...HAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md | 10 + .../events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md | 63 +++++ .../VOICE_CHAT_TTS_PLAYBACK_FINISHED.md | 24 ++ .../events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md | 26 ++ .../VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md | 30 +++ .../events/VOICE_CHAT_TTS_VOICES_UPDATE.md | 10 + .../events/VOID_DEPOSIT_WARNING.md | 13 + wiki-information/events/VOID_STORAGE_CLOSE.md | 10 + .../events/VOID_STORAGE_CONTENTS_UPDATE.md | 10 + .../events/VOID_STORAGE_DEPOSIT_UPDATE.md | 11 + wiki-information/events/VOID_STORAGE_OPEN.md | 10 + .../events/VOID_STORAGE_UPDATE.md | 10 + wiki-information/events/VOID_TRANSFER_DONE.md | 10 + .../events/VOID_TRANSFER_SUCCESS.md | 10 + wiki-information/events/WARFRONT_COMPLETED.md | 13 + wiki-information/events/WARGAME_REQUESTED.md | 17 ++ wiki-information/events/WEAR_EQUIPMENT_SET.md | 11 + wiki-information/events/WHO_LIST_UPDATE.md | 13 + wiki-information/events/WORLD_PVP_QUEUE.md | 10 + .../events/WORLD_STATE_TIMER_START.md | 11 + .../events/WORLD_STATE_TIMER_STOP.md | 11 + .../events/WOW_MOUSE_NOT_FOUND.md | 10 + wiki-information/events/ZONE_CHANGED.md | 31 +++ .../events/ZONE_CHANGED_INDOORS.md | 30 +++ .../events/ZONE_CHANGED_NEW_AREA.md | 33 +++ wiki-information/functions/AbandonQuest.md | 8 + wiki-information/functions/AbandonSkill.md | 20 ++ wiki-information/functions/AcceptArenaTeam.md | 15 ++ .../functions/AcceptBattlefieldPort.md | 11 + wiki-information/functions/AcceptDuel.md | 9 + wiki-information/functions/AcceptGroup.md | 22 ++ wiki-information/functions/AcceptGuild.md | 11 + wiki-information/functions/AcceptProposal.md | 15 ++ wiki-information/functions/AcceptQuest.md | 12 + wiki-information/functions/AcceptResurrect.md | 19 ++ wiki-information/functions/AcceptSockets.md | 18 ++ .../AcceptSpellConfirmationPrompt.md | 17 ++ wiki-information/functions/AcceptTrade.md | 20 ++ wiki-information/functions/AcceptXPLoss.md | 12 + wiki-information/functions/ActionHasRange.md | 16 ++ .../functions/AddChatWindowChannel.md | 21 ++ .../functions/AddChatWindowMessages.md | 16 ++ wiki-information/functions/AddQuestWatch.md | 14 ++ .../functions/AddTrackedAchievement.md | 20 ++ wiki-information/functions/AddTradeMoney.md | 9 + wiki-information/functions/Ambiguate.md | 50 ++++ .../functions/AreDangerousScriptsAllowed.md | 9 + .../functions/ArenaTeamDisband.md | 16 ++ .../functions/ArenaTeamInviteByName.md | 11 + wiki-information/functions/ArenaTeamLeave.md | 9 + wiki-information/functions/ArenaTeamRoster.md | 13 + .../functions/ArenaTeamSetLeaderByName.md | 11 + .../functions/ArenaTeamUninviteByName.md | 11 + wiki-information/functions/AscendStop.md | 20 ++ wiki-information/functions/AssistUnit.md | 23 ++ wiki-information/functions/AttackTarget.md | 11 + .../functions/AutoEquipCursorItem.md | 17 ++ .../functions/AutoStoreGuildBankItem.md | 11 + wiki-information/functions/BNConnected.md | 9 + wiki-information/functions/BNGetFOFInfo.md | 21 ++ .../functions/BNGetFriendGameAccountInfo.md | 77 ++++++ .../functions/BNGetFriendIndex.md | 13 + wiki-information/functions/BNGetFriendInfo.md | 76 ++++++ .../functions/BNGetFriendInfoByID.md | 77 ++++++ .../functions/BNGetFriendInviteInfo.md | 21 ++ .../functions/BNGetGameAccountInfo.md | 70 ++++++ .../functions/BNGetGameAccountInfoByGUID.md | 106 ++++++++ wiki-information/functions/BNGetInfo.md | 21 ++ .../functions/BNGetNumFriendGameAccounts.md | 16 ++ wiki-information/functions/BNGetNumFriends.md | 21 ++ wiki-information/functions/BNSendGameData.md | 22 ++ wiki-information/functions/BNSendWhisper.md | 13 + wiki-information/functions/BNSetAFK.md | 13 + .../functions/BNSetCustomMessage.md | 24 ++ wiki-information/functions/BNSetDND.md | 13 + wiki-information/functions/BNSetFriendNote.md | 11 + .../functions/BankButtonIDToInvSlotID.md | 15 ++ wiki-information/functions/BeginTrade.md | 10 + .../functions/BreakUpLargeNumbers.md | 30 +++ wiki-information/functions/BuyGuildCharter.md | 24 ++ wiki-information/functions/BuyMerchantItem.md | 31 +++ wiki-information/functions/BuyStableSlot.md | 11 + .../functions/BuyTrainerService.md | 24 ++ wiki-information/functions/BuybackItem.md | 29 +++ ...countInfo.GetIDFromBattleNetAccountGUID.md | 13 + ..._AccountInfo.IsGUIDBattleNetAccountType.md | 13 + ...AccountInfo.IsGUIDRelatedToLocalAccount.md | 30 +++ .../C_AchievementInfo.GetRewardItemID.md | 13 + ...ievementInfo.GetSupercedingAchievements.md | 20 ++ .../C_AchievementInfo.IsValidAchievement.md | 19 ++ .../C_AchievementInfo.SetPortraitTexture.md | 9 + .../C_ActionBar.FindPetActionButtons.md | 26 ++ .../C_ActionBar.FindSpellActionButtons.md | 13 + .../C_ActionBar.GetPetActionPetBarIndices.md | 19 ++ .../C_ActionBar.HasPetActionButtons.md | 13 + .../C_ActionBar.HasPetActionPetBarIndices.md | 13 + .../C_ActionBar.HasSpellActionButtons.md | 13 + .../C_ActionBar.IsAutoCastPetAction.md | 13 + .../C_ActionBar.IsEnabledAutoCastPetAction.md | 13 + .../functions/C_ActionBar.IsHarmfulAction.md | 21 ++ .../functions/C_ActionBar.IsHelpfulAction.md | 21 ++ .../C_ActionBar.IsOnBarOrSpecialBar.md | 19 ++ ...ctionBar.ShouldOverrideBarShowHealthBar.md | 9 + ..._ActionBar.ShouldOverrideBarShowManaBar.md | 9 + .../C_ActionBar.ToggleAutoCastPetAction.md | 9 + .../functions/C_AddOns.DisableAddOn.md | 25 ++ .../functions/C_AddOns.DisableAllAddOns.md | 24 ++ .../functions/C_AddOns.DoesAddOnExist.md | 28 +++ .../functions/C_AddOns.EnableAddOn.md | 25 ++ .../functions/C_AddOns.EnableAllAddOns.md | 9 + .../C_AddOns.GetAddOnDependencies.md | 13 + .../functions/C_AddOns.GetAddOnEnableState.md | 39 +++ .../functions/C_AddOns.GetAddOnInfo.md | 57 +++++ .../functions/C_AddOns.GetAddOnMetadata.md | 18 ++ .../C_AddOns.GetAddOnOptionalDependencies.md | 13 + .../functions/C_AddOns.GetNumAddOns.md | 9 + .../functions/C_AddOns.IsAddOnLoadOnDemand.md | 26 ++ .../functions/C_AddOns.IsAddOnLoadable.md | 19 ++ .../functions/C_AddOns.IsAddOnLoaded.md | 15 ++ .../C_AddOns.IsAddonVersionCheckEnabled.md | 9 + .../functions/C_AddOns.LoadAddOn.md | 18 ++ .../C_AddOns.SetAddonVersionCheck.md | 9 + .../C_AreaPoiInfo.GetAreaPOIForMap.md | 13 + .../functions/C_AreaPoiInfo.GetAreaPOIInfo.md | 53 ++++ .../C_AreaPoiInfo.GetAreaPOITimeLeft.md | 13 + .../functions/C_AreaPoiInfo.IsAreaPOITimed.md | 18 ++ .../C_AzeriteEmpoweredItem.CanSelectPower.md | 18 ++ ...redItem.CloseAzeriteEmpoweredItemRespec.md | 17 ++ ...dItem.ConfirmAzeriteEmpoweredItemRespec.md | 9 + .../C_AzeriteEmpoweredItem.GetAllTierInfo.md | 37 +++ ...iteEmpoweredItem.GetAllTierInfoByItemID.md | 31 +++ ...dItem.GetAzeriteEmpoweredItemRespecCost.md | 9 + .../C_AzeriteEmpoweredItem.GetPowerInfo.md | 20 ++ .../C_AzeriteEmpoweredItem.GetPowerText.md | 33 +++ ...C_AzeriteEmpoweredItem.GetSpecsForPower.md | 20 ++ ...iteEmpoweredItem.HasAnyUnselectedPowers.md | 19 ++ .../C_AzeriteEmpoweredItem.HasBeenViewed.md | 19 ++ ...iteEmpoweredItem.IsAzeriteEmpoweredItem.md | 25 ++ ...mpoweredItem.IsAzeriteEmpoweredItemByID.md | 25 ++ ...dItem.IsAzeritePreviewSourceDisplayable.md | 15 ++ ...eEmpoweredItem.IsHeartOfAzerothEquipped.md | 15 ++ ...teEmpoweredItem.IsPowerAvailableForSpec.md | 15 ++ .../C_AzeriteEmpoweredItem.IsPowerSelected.md | 15 ++ .../C_AzeriteEmpoweredItem.SelectPower.md | 21 ++ ...C_AzeriteEmpoweredItem.SetHasBeenViewed.md | 9 + .../C_AzeriteEssence.ActivateEssence.md | 11 + .../C_AzeriteEssence.CanActivateEssence.md | 21 ++ .../C_AzeriteEssence.CanDeactivateEssence.md | 19 ++ .../functions/C_AzeriteEssence.CanOpenUI.md | 9 + ...teEssence.ClearPendingActivationEssence.md | 17 ++ .../functions/C_AzeriteEssence.CloseForge.md | 11 + .../C_AzeriteEssence.GetEssenceHyperlink.md | 15 ++ .../C_AzeriteEssence.GetEssenceInfo.md | 29 +++ .../functions/C_AzeriteEssence.GetEssences.md | 31 +++ .../C_AzeriteEssence.GetMilestoneEssence.md | 19 ++ .../C_AzeriteEssence.GetMilestoneInfo.md | 41 ++++ .../C_AzeriteEssence.GetMilestoneSpell.md | 13 + .../C_AzeriteEssence.GetMilestones.md | 37 +++ ...C_AzeriteEssence.GetNumUnlockedEssences.md | 9 + .../C_AzeriteEssence.GetNumUsableEssences.md | 9 + ...riteEssence.GetPendingActivationEssence.md | 9 + ...iteEssence.HasNeverActivatedAnyEssences.md | 9 + ...riteEssence.HasPendingActivationEssence.md | 9 + .../functions/C_AzeriteEssence.IsAtForge.md | 9 + ...riteEssence.SetPendingActivationEssence.md | 9 + .../C_AzeriteEssence.UnlockMilestone.md | 9 + .../C_AzeriteItem.FindActiveAzeriteItem.md | 9 + .../C_AzeriteItem.GetAzeriteItemXPInfo.md | 15 ++ .../functions/C_AzeriteItem.GetPowerLevel.md | 27 +++ .../C_AzeriteItem.GetUnlimitedPowerLevel.md | 19 ++ .../C_AzeriteItem.HasActiveAzeriteItem.md | 9 + .../functions/C_AzeriteItem.IsAzeriteItem.md | 20 ++ .../C_AzeriteItem.IsAzeriteItemAtMaxLevel.md | 9 + .../C_AzeriteItem.IsAzeriteItemByID.md | 20 ++ .../C_AzeriteItem.IsAzeriteItemEnabled.md | 13 + ...AzeriteItem.IsUnlimitedLevelingUnlocked.md | 9 + .../C_BarberShop.ApplyCustomizationChoices.md | 9 + .../functions/C_BarberShop.Cancel.md | 11 + .../C_BarberShop.ClearPreviewChoices.md | 9 + ...C_BarberShop.GetAvailableCustomizations.md | 95 ++++++++ .../C_BarberShop.GetCurrentCameraZoom.md | 9 + .../C_BarberShop.GetCurrentCharacterData.md | 50 ++++ .../functions/C_BarberShop.GetCurrentCost.md | 9 + .../C_BarberShop.GetViewingChrModel.md | 9 + .../functions/C_BarberShop.HasAnyChanges.md | 9 + .../C_BarberShop.IsViewingAlteredForm.md | 9 + .../C_BarberShop.IsViewingNativeSex.md | 9 + .../C_BarberShop.IsViewingVisibleSex.md | 13 + ...C_BarberShop.PreviewCustomizationChoice.md | 17 ++ ...arberShop.RandomizeCustomizationChoices.md | 11 + .../C_BarberShop.ResetCameraRotation.md | 11 + .../C_BarberShop.ResetCustomizationChoices.md | 11 + .../functions/C_BarberShop.RotateCamera.md | 9 + .../C_BarberShop.SetCameraDistanceOffset.md | 9 + .../C_BarberShop.SetCameraZoomLevel.md | 17 ++ .../C_BarberShop.SetCustomizationChoice.md | 17 ++ .../C_BarberShop.SetModelDressState.md | 9 + .../functions/C_BarberShop.SetSelectedSex.md | 9 + .../C_BarberShop.SetViewingAlteredForm.md | 9 + .../C_BarberShop.SetViewingChrModel.md | 9 + .../C_BarberShop.SetViewingShapeshiftForm.md | 9 + .../functions/C_BarberShop.ZoomCamera.md | 9 + .../C_BattleNet.GetAccountInfoByGUID.md | 142 +++++++++++ .../C_BattleNet.GetAccountInfoByID.md | 129 ++++++++++ .../C_BattleNet.GetFriendAccountInfo.md | 130 ++++++++++ .../C_BattleNet.GetFriendGameAccountInfo.md | 111 +++++++++ .../C_BattleNet.GetFriendNumGameAccounts.md | 16 ++ .../C_BattleNet.GetGameAccountInfoByGUID.md | 98 ++++++++ .../C_BattleNet.GetGameAccountInfoByID.md | 109 +++++++++ ...vioralMessaging.SendNotificationReceipt.md | 13 + wiki-information/functions/C_CVar.GetCVar.md | 17 ++ .../functions/C_CVar.GetCVarBitfield.md | 19 ++ .../functions/C_CVar.GetCVarBool.md | 14 ++ .../functions/C_CVar.GetCVarDefault.md | 14 ++ .../functions/C_CVar.GetCVarInfo.md | 25 ++ .../functions/C_CVar.RegisterCVar.md | 14 ++ .../functions/C_CVar.ResetTestCVars.md | 20 ++ wiki-information/functions/C_CVar.SetCVar.md | 21 ++ .../functions/C_CVar.SetCVarBitfield.md | 21 ++ .../functions/C_Calendar.AddEvent.md | 21 ++ .../functions/C_Calendar.AreNamesReady.md | 9 + .../functions/C_Calendar.CanAddEvent.md | 9 + .../functions/C_Calendar.CanSendInvite.md | 9 + .../functions/C_Calendar.CloseEvent.md | 11 + .../C_Calendar.ContextMenuEventCanComplain.md | 17 ++ .../C_Calendar.ContextMenuEventCanEdit.md | 17 ++ .../C_Calendar.ContextMenuEventCanRemove.md | 17 ++ .../C_Calendar.ContextMenuEventClipboard.md | 9 + .../C_Calendar.ContextMenuEventComplain.md | 11 + .../C_Calendar.ContextMenuEventCopy.md | 11 + ...alendar.ContextMenuEventGetCalendarType.md | 9 + .../C_Calendar.ContextMenuEventPaste.md | 11 + .../C_Calendar.ContextMenuEventRemove.md | 5 + .../C_Calendar.ContextMenuEventSignUp.md | 14 ++ .../C_Calendar.ContextMenuGetEventIndex.md | 19 ++ .../C_Calendar.ContextMenuInviteAvailable.md | 8 + .../C_Calendar.ContextMenuInviteDecline.md | 5 + .../C_Calendar.ContextMenuInviteRemove.md | 11 + .../C_Calendar.ContextMenuInviteTentative.md | 5 + .../C_Calendar.ContextMenuSelectEvent.md | 13 + .../C_Calendar.CreateCommunitySignUpEvent.md | 5 + ...C_Calendar.CreateGuildAnnouncementEvent.md | 17 ++ .../C_Calendar.CreateGuildSignUpEvent.md | 5 + .../functions/C_Calendar.CreatePlayerEvent.md | 8 + .../functions/C_Calendar.EventAvailable.md | 11 + .../functions/C_Calendar.EventCanEdit.md | 9 + .../C_Calendar.EventClearAutoApprove.md | 5 + .../functions/C_Calendar.EventClearLocked.md | 5 + .../C_Calendar.EventClearModerator.md | 9 + .../functions/C_Calendar.EventDecline.md | 11 + .../C_Calendar.EventGetCalendarType.md | 9 + .../functions/C_Calendar.EventGetClubId.md | 9 + .../functions/C_Calendar.EventGetInvite.md | 70 ++++++ .../C_Calendar.EventGetInviteResponseTime.md | 29 +++ .../C_Calendar.EventGetInviteSortCriterion.md | 11 + .../C_Calendar.EventGetSelectedInvite.md | 25 ++ .../C_Calendar.EventGetStatusOptions.md | 42 ++++ .../functions/C_Calendar.EventGetTextures.md | 44 ++++ .../functions/C_Calendar.EventGetTypes.md | 9 + .../C_Calendar.EventGetTypesDisplayOrdered.md | 32 +++ .../C_Calendar.EventHasPendingInvite.md | 9 + .../C_Calendar.EventHaveSettingsChanged.md | 9 + .../functions/C_Calendar.EventInvite.md | 14 ++ .../functions/C_Calendar.EventRemoveInvite.md | 16 ++ .../C_Calendar.EventRemoveInviteByGuid.md | 15 ++ .../functions/C_Calendar.EventSelectInvite.md | 9 + .../C_Calendar.EventSetAutoApprove.md | 5 + .../functions/C_Calendar.EventSetClubId.md | 9 + .../functions/C_Calendar.EventSetDate.md | 17 ++ .../C_Calendar.EventSetDescription.md | 9 + .../C_Calendar.EventSetInviteStatus.md | 32 +++ .../functions/C_Calendar.EventSetLocked.md | 14 ++ .../functions/C_Calendar.EventSetModerator.md | 9 + .../functions/C_Calendar.EventSetTextureID.md | 9 + .../functions/C_Calendar.EventSetTime.md | 15 ++ .../functions/C_Calendar.EventSetTitle.md | 13 + .../functions/C_Calendar.EventSetType.md | 30 +++ .../functions/C_Calendar.EventSignUp.md | 17 ++ .../functions/C_Calendar.EventSortInvites.md | 11 + .../functions/C_Calendar.EventTentative.md | 5 + .../C_Calendar.GetClubCalendarEvents.md | 107 ++++++++ .../functions/C_Calendar.GetDayEvent.md | 145 +++++++++++ .../C_Calendar.GetDefaultGuildFilter.md | 18 ++ .../functions/C_Calendar.GetEventIndex.md | 19 ++ .../functions/C_Calendar.GetEventIndexInfo.md | 27 +++ .../functions/C_Calendar.GetEventInfo.md | 140 +++++++++++ .../C_Calendar.GetFirstPendingInvite.md | 15 ++ .../functions/C_Calendar.GetGuildEventInfo.md | 59 +++++ .../C_Calendar.GetGuildEventSelectionInfo.md | 23 ++ .../functions/C_Calendar.GetHolidayInfo.md | 46 ++++ .../functions/C_Calendar.GetMaxCreateDate.md | 28 +++ .../functions/C_Calendar.GetMinDate.md | 28 +++ .../functions/C_Calendar.GetMonthInfo.md | 27 +++ .../functions/C_Calendar.GetNextClubId.md | 9 + .../functions/C_Calendar.GetNumDayEvents.md | 15 ++ .../functions/C_Calendar.GetNumGuildEvents.md | 9 + .../functions/C_Calendar.GetNumInvites.md | 9 + .../C_Calendar.GetNumPendingInvites.md | 9 + .../functions/C_Calendar.GetRaidInfo.md | 49 ++++ .../functions/C_Calendar.IsActionPending.md | 9 + .../functions/C_Calendar.IsEventOpen.md | 9 + .../C_Calendar.MassInviteCommunity.md | 15 ++ .../functions/C_Calendar.MassInviteGuild.md | 22 ++ .../functions/C_Calendar.OpenCalendar.md | 9 + .../functions/C_Calendar.OpenEvent.md | 17 ++ .../functions/C_Calendar.RemoveEvent.md | 11 + .../functions/C_Calendar.SetAbsMonth.md | 11 + .../functions/C_Calendar.SetMonth.md | 9 + .../functions/C_Calendar.SetNextClubId.md | 9 + .../functions/C_Calendar.UpdateEvent.md | 8 + .../C_CameraDefaults.GetCameraFOVDefaults.md | 19 ++ .../C_ChatBubbles.GetAllChatBubbles.md | 16 ++ .../functions/C_ChatInfo.CanReportPlayer.md | 13 + ...C_ChatInfo.GetChannelInfoFromIdentifier.md | 40 +++ .../C_ChatInfo.GetChannelRosterInfo.md | 21 ++ .../C_ChatInfo.GetChannelShortcut.md | 18 ++ ...ChatInfo.GetChannelShortcutForChannelID.md | 18 ++ .../C_ChatInfo.GetChatLineSenderGUID.md | 13 + .../C_ChatInfo.GetChatLineSenderName.md | 13 + .../functions/C_ChatInfo.GetChatLineText.md | 13 + .../functions/C_ChatInfo.GetChatTypeName.md | 19 ++ .../C_ChatInfo.GetNumActiveChannels.md | 9 + ...tInfo.GetRegisteredAddonMessagePrefixes.md | 19 ++ ...ChatInfo.IsAddonMessagePrefixRegistered.md | 23 ++ .../C_ChatInfo.IsChatLineCensored.md | 13 + .../C_ChatInfo.IsPartyChannelType.md | 29 +++ .../functions/C_ChatInfo.IsValidChatLine.md | 13 + .../C_ChatInfo.RegisterAddonMessagePrefix.md | 28 +++ .../functions/C_ChatInfo.ReportPlayer.md | 44 ++++ .../functions/C_ChatInfo.SendAddonMessage.md | 153 ++++++++++++ .../C_ChatInfo.SendAddonMessageLogged.md | 153 ++++++++++++ ...ChatInfo.SwapChatChannelsByChannelIndex.md | 11 + .../functions/C_ChatInfo.UncensorChatLine.md | 9 + .../functions/C_Club.AcceptInvitation.md | 9 + .../C_Club.AddClubStreamChatChannel.md | 17 ++ .../C_Club.AdvanceStreamViewMarker.md | 11 + .../functions/C_Club.AssignMemberRole.md | 25 ++ ...esolvePlayerLocationFromClubMessageData.md | 19 ++ ...C_Club.ClearAutoAdvanceStreamViewMarker.md | 5 + .../C_Club.ClearClubPresenceSubscription.md | 5 + .../C_Club.CompareBattleNetDisplayName.md | 17 ++ .../functions/C_Club.CreateClub.md | 30 +++ .../functions/C_Club.CreateStream.md | 18 ++ .../functions/C_Club.CreateTicket.md | 20 ++ .../functions/C_Club.DeclineInvitation.md | 9 + .../functions/C_Club.DestroyClub.md | 12 + .../functions/C_Club.DestroyMessage.md | 21 ++ .../functions/C_Club.DestroyStream.md | 14 ++ .../functions/C_Club.DestroyTicket.md | 14 ++ ...Club.DoesAnyCommunityHaveUnreadMessages.md | 9 + wiki-information/functions/C_Club.EditClub.md | 24 ++ .../functions/C_Club.EditMessage.md | 22 ++ .../functions/C_Club.EditStream.md | 20 ++ wiki-information/functions/C_Club.Flush.md | 5 + .../functions/C_Club.FocusCommunityStreams.md | 5 + .../functions/C_Club.FocusStream.md | 21 ++ .../functions/C_Club.GetAssignableRoles.md | 27 +++ .../functions/C_Club.GetAvatarIdList.md | 24 ++ .../functions/C_Club.GetClubInfo.md | 55 +++++ .../functions/C_Club.GetClubMembers.md | 29 +++ .../functions/C_Club.GetClubPrivileges.md | 103 ++++++++ ..._Club.GetClubStreamNotificationSettings.md | 31 +++ .../C_Club.GetCommunityNameResultText.md | 55 +++++ ...C_Club.GetInfoFromLastCommunityChatLine.md | 149 ++++++++++++ .../C_Club.GetInvitationCandidates.md | 43 ++++ .../functions/C_Club.GetInvitationInfo.md | 183 ++++++++++++++ .../functions/C_Club.GetInvitationsForClub.md | 132 ++++++++++ .../functions/C_Club.GetInvitationsForSelf.md | 179 ++++++++++++++ .../functions/C_Club.GetMemberInfo.md | 122 ++++++++++ .../functions/C_Club.GetMemberInfoForSelf.md | 123 ++++++++++ .../functions/C_Club.GetMessageInfo.md | 163 +++++++++++++ .../functions/C_Club.GetMessageRanges.md | 34 +++ .../functions/C_Club.GetMessagesBefore.md | 165 +++++++++++++ .../functions/C_Club.GetMessagesInRange.md | 159 ++++++++++++ .../functions/C_Club.GetStreamInfo.md | 44 ++++ .../functions/C_Club.GetStreamViewMarker.md | 15 ++ .../functions/C_Club.GetStreams.md | 68 ++++++ .../functions/C_Club.GetSubscribedClubs.md | 52 ++++ .../functions/C_Club.GetTickets.md | 141 +++++++++++ .../functions/C_Club.IsAccountMuted.md | 13 + .../functions/C_Club.IsBeginningOfStream.md | 28 +++ .../functions/C_Club.IsEnabled.md | 9 + .../functions/C_Club.IsRestricted.md | 16 ++ .../functions/C_Club.IsSubscribedToStream.md | 21 ++ .../functions/C_Club.KickMember.md | 14 ++ .../functions/C_Club.LeaveClub.md | 9 + .../functions/C_Club.RedeemTicket.md | 9 + .../C_Club.RequestInvitationsForClub.md | 12 + .../C_Club.RequestMoreMessagesBefore.md | 30 +++ .../functions/C_Club.RequestTicket.md | 9 + .../functions/C_Club.RequestTickets.md | 12 + .../functions/C_Club.RevokeInvitation.md | 14 ++ .../C_Club.SendBattleTagFriendRequest.md | 17 ++ .../functions/C_Club.SendInvitation.md | 14 ++ .../functions/C_Club.SendMessage.md | 13 + .../C_Club.SetAutoAdvanceStreamViewMarker.md | 14 ++ .../functions/C_Club.SetAvatarTexture.md | 25 ++ .../functions/C_Club.SetClubMemberNote.md | 16 ++ .../C_Club.SetClubPresenceSubscription.md | 12 + ..._Club.SetClubStreamNotificationSettings.md | 17 ++ .../functions/C_Club.SetCommunityID.md | 9 + .../functions/C_Club.SetFavorite.md | 11 + .../C_Club.SetSocialQueueingEnabled.md | 25 ++ .../functions/C_Club.ShouldAllowClubType.md | 20 ++ .../functions/C_Club.UnfocusAllStreams.md | 9 + .../functions/C_Club.UnfocusStream.md | 27 +++ .../functions/C_Club.ValidateText.md | 58 +++++ .../C_Commentator.AddPlayerOverrideName.md | 11 + .../C_Commentator.AddTrackedDefensiveAuras.md | 9 + .../C_Commentator.AddTrackedOffensiveAuras.md | 9 + .../C_Commentator.AreTeamsSwapped.md | 9 + .../C_Commentator.AssignPlayerToTeam.md | 11 + .../C_Commentator.AssignPlayersToTeam.md | 11 + ...or.AssignPlayersToTeamInCurrentInstance.md | 11 + .../C_Commentator.CanUseCommentatorCheats.md | 9 + .../C_Commentator.ClearCameraTarget.md | 8 + .../C_Commentator.ClearFollowTarget.md | 5 + .../C_Commentator.ClearLookAtTarget.md | 9 + .../functions/C_Commentator.EnterInstance.md | 6 + .../functions/C_Commentator.ExitInstance.md | 11 + .../C_Commentator.FindSpectatedUnit.md | 17 ++ ...mmentator.FindTeamNameInCurrentInstance.md | 13 + .../C_Commentator.FindTeamNameInDirectory.md | 19 ++ .../C_Commentator.FlushCommentatorHistory.md | 5 + .../functions/C_Commentator.FollowPlayer.md | 19 ++ .../functions/C_Commentator.FollowUnit.md | 9 + .../C_Commentator.ForceFollowTransition.md | 6 + ...C_Commentator.GetAdditionalCameraWeight.md | 11 + ...ntator.GetAdditionalCameraWeightByToken.md | 19 ++ ...C_Commentator.GetAllPlayerOverrideNames.md | 16 ++ .../functions/C_Commentator.GetCamera.md | 21 ++ .../C_Commentator.GetCameraCollision.md | 9 + .../C_Commentator.GetCameraPosition.md | 13 + .../C_Commentator.GetCommentatorHistory.md | 52 ++++ .../C_Commentator.GetCurrentMapID.md | 9 + .../C_Commentator.GetDampeningPercent.md | 9 + ...stanceBeforeForcedHorizontalConvergence.md | 9 + ...GetDurationToForceHorizontalConvergence.md | 9 + .../C_Commentator.GetExcludeDistance.md | 9 + .../C_Commentator.GetHardlockWeight.md | 9 + ...tor.GetHorizontalAngleThresholdToSmooth.md | 9 + .../C_Commentator.GetIndirectSpellID.md | 13 + .../C_Commentator.GetInstanceInfo.md | 23 ++ .../C_Commentator.GetLookAtLerpAmount.md | 9 + .../functions/C_Commentator.GetMapInfo.md | 19 ++ .../C_Commentator.GetMatchDuration.md | 9 + .../C_Commentator.GetMaxNumPlayersPerTeam.md | 9 + .../functions/C_Commentator.GetMaxNumTeams.md | 9 + .../functions/C_Commentator.GetMode.md | 9 + ...ntator.GetMsToHoldForHorizontalMovement.md | 9 + ...mentator.GetMsToHoldForVerticalMovement.md | 9 + ...mmentator.GetMsToSmoothHorizontalChange.md | 9 + ...Commentator.GetMsToSmoothVerticalChange.md | 9 + .../functions/C_Commentator.GetNumMaps.md | 9 + .../functions/C_Commentator.GetNumPlayers.md | 13 + .../C_Commentator.GetOrCreateSeries.md | 28 +++ .../C_Commentator.GetPlayerAuraInfo.md | 21 ++ .../C_Commentator.GetPlayerAuraInfoByUnit.md | 19 ++ .../C_Commentator.GetPlayerCooldownInfo.md | 30 +++ ...Commentator.GetPlayerCooldownInfoByUnit.md | 19 ++ ...C_Commentator.GetPlayerCrowdControlInfo.md | 19 ++ ...entator.GetPlayerCrowdControlInfoByUnit.md | 17 ++ .../functions/C_Commentator.GetPlayerData.md | 42 ++++ .../C_Commentator.GetPlayerFlagInfo.md | 24 ++ .../C_Commentator.GetPlayerFlagInfoByUnit.md | 22 ++ .../C_Commentator.GetPlayerOverrideName.md | 13 + .../C_Commentator.GetPlayerSpellCharges.md | 23 ++ ...Commentator.GetPlayerSpellChargesByUnit.md | 21 ++ .../C_Commentator.GetPositionLerpAmount.md | 9 + ...ommentator.GetSmoothFollowTransitioning.md | 9 + .../C_Commentator.GetSoftlockWeight.md | 9 + .../functions/C_Commentator.GetSpeedFactor.md | 12 + .../C_Commentator.GetStartLocation.md | 13 + .../functions/C_Commentator.GetTeamColor.md | 19 ++ .../C_Commentator.GetTeamColorByUnit.md | 20 ++ .../C_Commentator.GetTimeLeftInMatch.md | 9 + .../C_Commentator.GetTrackedSpellID.md | 13 + .../C_Commentator.GetTrackedSpells.md | 26 ++ .../C_Commentator.GetTrackedSpellsByUnit.md | 29 +++ .../functions/C_Commentator.GetUnitData.md | 38 +++ .../functions/C_Commentator.GetWargameInfo.md | 19 ++ .../C_Commentator.HasTrackedAuras.md | 15 ++ .../C_Commentator.IsSmartCameraLocked.md | 9 + .../functions/C_Commentator.IsSpectating.md | 9 + .../C_Commentator.IsTrackedDefensiveAura.md | 13 + .../C_Commentator.IsTrackedOffensiveAura.md | 13 + .../functions/C_Commentator.IsTrackedSpell.md | 34 +++ .../C_Commentator.IsTrackedSpellByUnit.md | 31 +++ .../C_Commentator.IsUsingSmartCamera.md | 9 + .../functions/C_Commentator.LookAtPlayer.md | 13 + .../C_Commentator.RemoveAllOverrideNames.md | 19 ++ .../C_Commentator.RemovePlayerOverrideName.md | 9 + ...C_Commentator.RequestPlayerCooldownInfo.md | 11 + .../functions/C_Commentator.ResetFoVTarget.md | 5 + .../C_Commentator.ResetSeriesScores.md | 11 + .../functions/C_Commentator.ResetSettings.md | 5 + .../C_Commentator.ResetTrackedAuras.md | 6 + ...C_Commentator.SetAdditionalCameraWeight.md | 13 + ...ntator.SetAdditionalCameraWeightByToken.md | 20 ++ .../C_Commentator.SetBlocklistedAuras.md | 9 + .../C_Commentator.SetBlocklistedCooldowns.md | 25 ++ .../functions/C_Commentator.SetCamera.md | 21 ++ .../C_Commentator.SetCameraCollision.md | 9 + .../C_Commentator.SetCameraPosition.md | 15 ++ .../C_Commentator.SetCheatsEnabled.md | 9 + .../C_Commentator.SetCommentatorHistory.md | 52 ++++ ...stanceBeforeForcedHorizontalConvergence.md | 9 + ...SetDurationToForceHorizontalConvergence.md | 9 + .../C_Commentator.SetExcludeDistance.md | 9 + .../C_Commentator.SetFollowCameraSpeeds.md | 11 + .../C_Commentator.SetHardlockWeight.md | 9 + ...tor.SetHorizontalAngleThresholdToSmooth.md | 9 + .../C_Commentator.SetLookAtLerpAmount.md | 9 + .../C_Commentator.SetMapAndInstanceIndex.md | 11 + .../C_Commentator.SetMouseDisabled.md | 9 + .../functions/C_Commentator.SetMoveSpeed.md | 9 + ...ntator.SetMsToHoldForHorizontalMovement.md | 9 + ...mentator.SetMsToHoldForVerticalMovement.md | 9 + ...mmentator.SetMsToSmoothHorizontalChange.md | 9 + ...Commentator.SetMsToSmoothVerticalChange.md | 9 + .../C_Commentator.SetPositionLerpAmount.md | 9 + ...Commentator.SetRequestedDebuffCooldowns.md | 12 + ...mentator.SetRequestedDefensiveCooldowns.md | 11 + ...mentator.SetRequestedOffensiveCooldowns.md | 11 + .../functions/C_Commentator.SetSeriesScore.md | 21 ++ .../C_Commentator.SetSeriesScores.md | 15 ++ .../C_Commentator.SetSmartCameraLocked.md | 9 + ...ommentator.SetSmoothFollowTransitioning.md | 9 + .../C_Commentator.SetSoftlockWeight.md | 9 + .../functions/C_Commentator.SetSpeedFactor.md | 9 + .../C_Commentator.SetTargetHeightOffset.md | 9 + .../C_Commentator.SetUseSmartCamera.md | 9 + .../C_Commentator.SnapCameraLookAtPoint.md | 14 ++ .../functions/C_Commentator.StartWargame.md | 17 ++ .../functions/C_Commentator.SwapTeamSides.md | 21 ++ .../functions/C_Commentator.ToggleCheats.md | 5 + .../functions/C_Commentator.UpdateMapInfo.md | 9 + .../C_Commentator.UpdatePlayerInfo.md | 5 + .../functions/C_Commentator.ZoomIn.md | 5 + .../functions/C_Commentator.ZoomOut.md | 5 + .../functions/C_Console.GetAllCommands.md | 76 ++++++ .../functions/C_Console.GetColorFromType.md | 28 +++ .../functions/C_Console.GetFontHeight.md | 9 + .../C_Console.PrintAllMatchingCommands.md | 15 ++ .../functions/C_Console.SetFontHeight.md | 9 + ...eScriptCollection.GetCollectionDataByID.md | 20 ++ ...ScriptCollection.GetCollectionDataByTag.md | 20 ++ .../C_ConsoleScriptCollection.GetElements.md | 20 ++ ...C_ConsoleScriptCollection.GetScriptData.md | 28 +++ .../C_Container.ContainerIDToInventoryID.md | 34 +++ ...C_Container.ContainerRefundItemPurchase.md | 13 + .../functions/C_Container.GetBagName.md | 13 + .../functions/C_Container.GetBagSlotFlag.md | 26 ++ .../C_Container.GetContainerFreeSlots.md | 19 ++ .../C_Container.GetContainerItemCooldown.md | 25 ++ .../C_Container.GetContainerItemDurability.md | 17 ++ .../C_Container.GetContainerItemID.md | 25 ++ .../C_Container.GetContainerItemInfo.md | 46 ++++ .../C_Container.GetContainerItemLink.md | 25 ++ ...tainer.GetContainerItemPurchaseCurrency.md | 28 +++ ..._Container.GetContainerItemPurchaseInfo.md | 30 +++ ..._Container.GetContainerItemPurchaseItem.md | 28 +++ .../C_Container.GetContainerItemQuestInfo.md | 24 ++ .../C_Container.GetContainerNumFreeSlots.md | 18 ++ .../C_Container.GetContainerNumSlots.md | 26 ++ .../C_Container.GetInsertItemsLeftToRight.md | 9 + .../functions/C_Container.GetItemCooldown.md | 17 ++ .../C_Container.IsContainerFiltered.md | 19 ++ .../C_Container.PickupContainerItem.md | 11 + .../C_Container.SetBagPortraitTexture.md | 11 + .../functions/C_Container.SetBagSlotFlag.md | 32 +++ .../C_Container.SetInsertItemsLeftToRight.md | 9 + .../functions/C_Container.SetItemSearch.md | 9 + .../C_Container.ShowContainerSellCursor.md | 11 + .../C_Container.SocketContainerItem.md | 21 ++ .../C_Container.SplitContainerItem.md | 13 + .../functions/C_Container.UseContainerItem.md | 15 ++ .../functions/C_CreatureInfo.GetClassInfo.md | 70 ++++++ .../C_CreatureInfo.GetFactionInfo.md | 20 ++ .../functions/C_CreatureInfo.GetRaceInfo.md | 28 +++ .../C_CurrencyInfo.GetBasicCurrencyInfo.md | 31 +++ ...C_CurrencyInfo.GetCurrencyContainerInfo.md | 30 +++ .../C_CurrencyInfo.GetCurrencyInfo.md | 67 +++++ .../C_CurrencyInfo.GetCurrencyInfoFromLink.md | 61 +++++ .../C_CurrencyInfo.GetCurrencyListLink.md | 13 + .../C_CurrencyInfo.IsCurrencyContainer.md | 15 ++ .../C_Cursor.DropCursorCommunitiesStream.md | 5 + .../C_Cursor.GetCursorCommunitiesStream.md | 11 + .../functions/C_Cursor.GetCursorItem.md | 12 + .../C_Cursor.SetCursorCommunitiesStream.md | 11 + .../C_DateAndTime.AdjustTimeByDays.md | 37 +++ .../C_DateAndTime.AdjustTimeByMinutes.md | 37 +++ .../C_DateAndTime.CompareCalendarTime.md | 32 +++ .../C_DateAndTime.GetCalendarTimeFromEpoch.md | 35 +++ .../C_DateAndTime.GetCurrentCalendarTime.md | 47 ++++ ...C_DateAndTime.GetSecondsUntilDailyReset.md | 9 + ..._DateAndTime.GetSecondsUntilWeeklyReset.md | 9 + .../C_DateAndTime.GetServerTimeLocal.md | 23 ++ .../C_DeathInfo.GetCorpseMapPosition.md | 19 ++ .../C_DeathInfo.GetDeathReleasePosition.md | 13 + .../C_DeathInfo.GetGraveyardsForMap.md | 28 +++ .../C_DeathInfo.GetSelfResurrectOptions.md | 33 +++ .../C_DeathInfo.UseSelfResurrectOption.md | 20 ++ .../C_Engraving.AddCategoryFilter.md | 9 + .../C_Engraving.AddExclusiveCategoryFilter.md | 9 + .../functions/C_Engraving.CastRune.md | 9 + .../C_Engraving.ClearCategoryFilter.md | 9 + .../C_Engraving.EnableEquippedFilter.md | 9 + .../C_Engraving.GetCurrentRuneCast.md | 26 ++ .../C_Engraving.GetEngravingModeEnabled.md | 9 + .../C_Engraving.GetExclusiveCategoryFilter.md | 9 + .../functions/C_Engraving.GetNumRunesKnown.md | 15 ++ .../C_Engraving.GetRuneCategories.md | 16 ++ .../C_Engraving.GetRuneForEquipmentSlot.md | 30 +++ .../C_Engraving.GetRuneForInventorySlot.md | 32 +++ .../C_Engraving.GetRunesForCategory.md | 32 +++ .../C_Engraving.HasCategoryFilter.md | 13 + .../C_Engraving.IsEngravingEnabled.md | 9 + .../C_Engraving.IsEquipmentSlotEngravable.md | 13 + .../C_Engraving.IsEquippedFilterEnabled.md | 9 + .../C_Engraving.IsInventorySlotEngravable.md | 15 ++ ...nventorySlotEngravableByCurrentRuneCast.md | 15 ++ .../functions/C_Engraving.IsKnownRuneSpell.md | 13 + .../functions/C_Engraving.IsRuneEquipped.md | 13 + .../C_Engraving.SetEngravingModeEnabled.md | 9 + .../functions/C_Engraving.SetSearchFilter.md | 9 + ...C_EquipmentSet.AssignSpecToEquipmentSet.md | 17 ++ .../C_EquipmentSet.CanUseEquipmentSets.md | 9 + .../C_EquipmentSet.CreateEquipmentSet.md | 23 ++ .../C_EquipmentSet.DeleteEquipmentSet.md | 9 + ...mentSet.EquipmentSetContainsLockedItems.md | 13 + ...quipmentSet.GetEquipmentSetAssignedSpec.md | 13 + .../C_EquipmentSet.GetEquipmentSetForSpec.md | 13 + .../C_EquipmentSet.GetEquipmentSetID.md | 13 + .../C_EquipmentSet.GetEquipmentSetIDs.md | 9 + .../C_EquipmentSet.GetEquipmentSetInfo.md | 32 +++ .../C_EquipmentSet.GetIgnoredSlots.md | 13 + .../functions/C_EquipmentSet.GetItemIDs.md | 31 +++ .../C_EquipmentSet.GetItemLocations.md | 23 ++ .../C_EquipmentSet.GetNumEquipmentSets.md | 9 + .../C_EquipmentSet.IgnoreSlotForSave.md | 9 + .../C_EquipmentSet.IsSlotIgnoredForSave.md | 19 ++ .../C_EquipmentSet.ModifyEquipmentSet.md | 13 + .../C_EquipmentSet.PickupEquipmentSet.md | 9 + .../C_EquipmentSet.SaveEquipmentSet.md | 14 ++ ...C_EquipmentSet.UnassignEquipmentSetSpec.md | 9 + .../C_EquipmentSet.UnignoreSlotForSave.md | 9 + .../C_EquipmentSet.UseEquipmentSet.md | 17 ++ .../functions/C_EventUtils.IsEventValid.md | 13 + .../C_EventUtils.NotifySettingsLoaded.md | 9 + .../functions/C_FriendList.AddFriend.md | 15 ++ .../functions/C_FriendList.AddIgnore.md | 18 ++ .../functions/C_FriendList.AddOrDelIgnore.md | 9 + .../C_FriendList.AddOrRemoveFriend.md | 14 ++ .../functions/C_FriendList.DelIgnore.md | 13 + .../C_FriendList.DelIgnoreByIndex.md | 9 + .../functions/C_FriendList.GetFriendInfo.md | 69 ++++++ .../C_FriendList.GetFriendInfoByIndex.md | 69 ++++++ .../functions/C_FriendList.GetIgnoreName.md | 13 + .../functions/C_FriendList.GetNumFriends.md | 9 + .../functions/C_FriendList.GetNumIgnores.md | 9 + .../C_FriendList.GetNumOnlineFriends.md | 9 + .../C_FriendList.GetNumWhoResults.md | 15 ++ .../C_FriendList.GetSelectedFriend.md | 12 + .../C_FriendList.GetSelectedIgnore.md | 9 + .../functions/C_FriendList.GetWhoInfo.md | 43 ++++ .../functions/C_FriendList.IsFriend.md | 13 + .../functions/C_FriendList.IsIgnored.md | 13 + .../functions/C_FriendList.IsIgnoredByGuid.md | 13 + .../functions/C_FriendList.IsOnIgnoredList.md | 13 + .../functions/C_FriendList.RemoveFriend.md | 13 + .../C_FriendList.RemoveFriendByIndex.md | 9 + .../functions/C_FriendList.SendWho.md | 46 ++++ .../functions/C_FriendList.SetFriendNotes.md | 15 ++ .../C_FriendList.SetFriendNotesByIndex.md | 11 + .../C_FriendList.SetSelectedFriend.md | 12 + .../C_FriendList.SetSelectedIgnore.md | 9 + .../functions/C_FriendList.SetWhoToUi.md | 14 ++ .../functions/C_FriendList.ShowFriends.md | 11 + .../functions/C_FriendList.SortWho.md | 24 ++ .../C_FunctionContainers.CreateCallback.md | 37 +++ .../functions/C_GamePad.AddSDLMapping.md | 20 ++ .../functions/C_GamePad.ApplyConfigs.md | 5 + .../C_GamePad.AxisIndexToConfigName.md | 19 ++ .../C_GamePad.ButtonBindingToIndex.md | 19 ++ .../C_GamePad.ButtonIndexToBinding.md | 19 ++ .../C_GamePad.ButtonIndexToConfigName.md | 13 + .../functions/C_GamePad.ClearLedColor.md | 6 + .../functions/C_GamePad.DeleteConfig.md | 16 ++ .../functions/C_GamePad.GetActiveDeviceID.md | 9 + .../functions/C_GamePad.GetAllConfigIDs.md | 16 ++ .../functions/C_GamePad.GetAllDeviceIDs.md | 9 + .../C_GamePad.GetCombinedDeviceID.md | 9 + .../functions/C_GamePad.GetConfig.md | 109 +++++++++ .../C_GamePad.GetDeviceMappedState.md | 41 ++++ .../functions/C_GamePad.GetDeviceRawState.md | 30 +++ .../functions/C_GamePad.GetLedColor.md | 9 + .../functions/C_GamePad.GetPowerLevel.md | 28 +++ .../functions/C_GamePad.IsEnabled.md | 15 ++ .../functions/C_GamePad.SetConfig.md | 103 ++++++++ .../functions/C_GamePad.SetLedColor.md | 9 + .../functions/C_GamePad.SetVibration.md | 19 ++ .../C_GamePad.StickIndexToConfigName.md | 13 + .../functions/C_GamePad.StopVibration.md | 19 ++ .../C_GameRules.IsSelfFoundAllowed.md | 9 + .../functions/C_GossipInfo.CloseGossip.md | 11 + .../functions/C_GossipInfo.ForceGossip.md | 12 + .../functions/C_GossipInfo.GetActiveQuests.md | 30 +++ .../C_GossipInfo.GetAvailableQuests.md | 34 +++ ...nfo.GetCompletedOptionDescriptionString.md | 9 + ...ipInfo.GetCustomGossipDescriptionString.md | 9 + .../C_GossipInfo.GetFriendshipReputation.md | 38 +++ ...GossipInfo.GetFriendshipReputationRanks.md | 20 ++ .../C_GossipInfo.GetNumActiveQuests.md | 12 + .../C_GossipInfo.GetNumAvailableQuests.md | 15 ++ .../functions/C_GossipInfo.GetOptions.md | 94 ++++++++ .../C_GossipInfo.GetPoiForUiMapID.md | 13 + .../functions/C_GossipInfo.GetPoiInfo.md | 26 ++ .../functions/C_GossipInfo.GetText.md | 12 + .../C_GossipInfo.SelectActiveQuest.md | 15 ++ .../C_GossipInfo.SelectAvailableQuest.md | 15 ++ .../functions/C_GossipInfo.SelectOption.md | 35 +++ .../C_GossipInfo.SelectOptionByIndex.md | 19 ++ .../C_GuildInfo.CanEditOfficerNote.md | 15 ++ .../C_GuildInfo.CanSpeakInGuildChat.md | 15 ++ .../C_GuildInfo.CanViewOfficerNote.md | 9 + .../C_GuildInfo.GetGuildRankOrder.md | 13 + .../C_GuildInfo.GetGuildTabardInfo.md | 33 +++ .../C_GuildInfo.GuildControlGetRankFlags.md | 83 +++++++ .../functions/C_GuildInfo.GuildRoster.md | 12 + .../functions/C_GuildInfo.IsGuildOfficer.md | 9 + ..._GuildInfo.IsGuildRankAssignmentAllowed.md | 15 ++ .../C_GuildInfo.MemberExistsByName.md | 13 + .../C_GuildInfo.QueryGuildMembersForRecipe.md | 17 ++ .../functions/C_GuildInfo.RemoveFromGuild.md | 18 ++ .../C_GuildInfo.SetGuildRankOrder.md | 11 + .../functions/C_GuildInfo.SetNote.md | 16 ++ ..._Heirloom.CanHeirloomUpgradeFromPending.md | 18 ++ .../functions/C_Heirloom.GetHeirloomInfo.md | 37 +++ .../C_Heirloom.GetHeirloomItemIDs.md | 9 + ...erfaceFileManifest.GetInterfaceArtFiles.md | 12 + .../functions/C_Item.DoesItemExist.md | 27 +++ .../functions/C_Item.DoesItemExistByID.md | 19 ++ .../functions/C_Item.GetCurrentItemLevel.md | 20 ++ .../functions/C_Item.GetItemGUID.md | 13 + .../functions/C_Item.GetItemID.md | 19 ++ .../functions/C_Item.GetItemIDForItemInfo.md | 25 ++ .../functions/C_Item.GetItemIcon.md | 31 +++ .../functions/C_Item.GetItemIconByID.md | 31 +++ .../functions/C_Item.GetItemInventoryType.md | 163 +++++++++++++ .../C_Item.GetItemInventoryTypeByID.md | 163 +++++++++++++ .../functions/C_Item.GetItemLink.md | 13 + .../functions/C_Item.GetItemMaxStackSize.md | 19 ++ .../C_Item.GetItemMaxStackSizeByID.md | 19 ++ .../functions/C_Item.GetItemName.md | 28 +++ .../functions/C_Item.GetItemNameByID.md | 37 +++ .../functions/C_Item.GetItemQuality.md | 52 ++++ .../functions/C_Item.GetItemQualityByID.md | 62 +++++ .../functions/C_Item.GetStackCount.md | 19 ++ wiki-information/functions/C_Item.IsBound.md | 13 + .../functions/C_Item.IsItemDataCached.md | 19 ++ .../functions/C_Item.IsItemDataCachedByID.md | 19 ++ wiki-information/functions/C_Item.IsLocked.md | 19 ++ wiki-information/functions/C_Item.LockItem.md | 16 ++ .../functions/C_Item.LockItemByGUID.md | 16 ++ .../functions/C_Item.RequestLoadItemData.md | 17 ++ .../C_Item.RequestLoadItemDataByID.md | 17 ++ .../functions/C_Item.UnlockItem.md | 16 ++ .../functions/C_Item.UnlockItemByGUID.md | 16 ++ .../C_ItemSocketInfo.CompleteSocketing.md | 11 + .../C_ItemUpgrade.GetItemHyperlink.md | 9 + .../C_KeyBindings.GetBindingIndex.md | 13 + .../C_KeyBindings.GetCustomBindingType.md | 18 ++ .../C_LFGInfo.CanPlayerUseGroupFinder.md | 11 + .../functions/C_LFGInfo.CanPlayerUseLFD.md | 11 + .../functions/C_LFGInfo.CanPlayerUseLFR.md | 11 + .../functions/C_LFGInfo.CanPlayerUsePVP.md | 11 + .../C_LFGInfo.CanPlayerUsePremadeGroup.md | 11 + .../C_LFGInfo.ConfirmLfgExpandSearch.md | 14 ++ .../C_LFGInfo.GetAllEntriesForCategory.md | 30 +++ .../functions/C_LFGInfo.GetLFDLockStates.md | 24 ++ ...C_LFGInfo.GetRoleCheckDifficultyDetails.md | 11 + .../functions/C_LFGInfo.HideNameFromUI.md | 40 +++ .../C_LFGInfo.IsGroupFinderEnabled.md | 9 + .../C_LFGInfo.IsInLFGFollowerDungeon.md | 9 + .../functions/C_LFGInfo.IsLFDEnabled.md | 9 + .../C_LFGInfo.IsLFGFollowerDungeon.md | 13 + .../functions/C_LFGInfo.IsLFREnabled.md | 9 + .../C_LFGInfo.IsPremadeGroupEnabled.md | 9 + .../functions/C_LFGList.ApplyToGroup.md | 21 ++ .../C_LFGList.CanActiveEntryUseAutoAccept.md | 9 + .../C_LFGList.CanCreateQuestGroup.md | 19 ++ .../C_LFGList.ClearApplicationTextFields.md | 5 + .../C_LFGList.ClearCreationTextFields.md | 17 ++ .../functions/C_LFGList.ClearSearchResults.md | 5 + .../C_LFGList.ClearSearchTextFields.md | 6 + ...ist.CopyActiveEntryInfoToCreationFields.md | 14 ++ .../functions/C_LFGList.CreateListing.md | 29 +++ ...FGList.DoesEntryTitleMatchPrebuiltTitle.md | 28 +++ .../functions/C_LFGList.GetActiveEntryInfo.md | 52 ++++ .../C_LFGList.GetActivityFullName.md | 17 ++ .../C_LFGList.GetActivityGroupInfo.md | 21 ++ .../functions/C_LFGList.GetActivityInfo.md | 70 ++++++ .../C_LFGList.GetActivityInfoExpensive.md | 13 + .../C_LFGList.GetActivityInfoTable.md | 78 ++++++ ...List.GetApplicantDungeonScoreForListing.md | 28 +++ .../functions/C_LFGList.GetApplicantInfo.md | 48 ++++ .../C_LFGList.GetApplicantMemberInfo.md | 46 ++++ .../C_LFGList.GetApplicantMemberStats.md | 37 +++ ...ist.GetApplicantPvpRatingInfoForListing.md | 28 +++ .../functions/C_LFGList.GetApplicants.md | 23 ++ .../C_LFGList.GetAvailableActivities.md | 17 ++ .../C_LFGList.GetAvailableActivityGroups.md | 15 ++ .../C_LFGList.GetAvailableCategories.md | 13 + .../functions/C_LFGList.GetCategoryInfo.md | 19 ++ .../C_LFGList.GetFilteredSearchResults.md | 11 + .../C_LFGList.GetKeystoneForActivity.md | 19 ++ .../functions/C_LFGList.GetLfgCategoryInfo.md | 32 +++ .../functions/C_LFGList.GetRoles.md | 17 ++ .../C_LFGList.GetSearchResultInfo.md | 109 +++++++++ .../functions/C_LFGList.GetSearchResults.md | 11 + .../functions/C_LFGList.HasActiveEntryInfo.md | 9 + .../C_LFGList.HasSearchResultInfo.md | 13 + .../functions/C_LFGList.InviteApplicant.md | 12 + .../C_LFGList.IsPlayerAuthenticatedForLFG.md | 19 ++ .../functions/C_LFGList.RemoveListing.md | 14 ++ .../C_LFGList.RequestAvailableActivities.md | 11 + .../functions/C_LFGList.SetRoles.md | 21 ++ .../functions/C_LFGList.SetSearchToQuestID.md | 9 + .../functions/C_LFGList.UpdateListing.md | 41 ++++ .../C_LFGList.ValidateRequiredDungeonScore.md | 19 ++ ...st.ValidateRequiredPvpRatingForActivity.md | 21 ++ .../C_Loot.IsLegacyLootModeEnabled.md | 9 + .../functions/C_LootHistory.GetItem.md | 23 ++ .../functions/C_LootHistory.GetPlayerInfo.md | 23 ++ ...ossOfControl.GetActiveLossOfControlData.md | 51 ++++ ...ontrol.GetActiveLossOfControlDataByUnit.md | 52 ++++ ...Control.GetActiveLossOfControlDataCount.md | 18 ++ ...l.GetActiveLossOfControlDataCountByUnit.md | 20 ++ .../functions/C_Mail.HasInboxMoney.md | 19 ++ .../functions/C_Mail.IsCommandPending.md | 9 + .../functions/C_Map.GetAreaInfo.md | 16 ++ .../functions/C_Map.GetBestMapForUnit.md | 29 +++ .../functions/C_Map.GetBountySetIDForMap.md | 13 + .../functions/C_Map.GetFallbackWorldMapID.md | 10 + .../C_Map.GetMapArtBackgroundAtlas.md | 23 ++ .../C_Map.GetMapArtHelpTextPosition.md | 26 ++ .../functions/C_Map.GetMapArtID.md | 19 ++ .../functions/C_Map.GetMapArtLayerTextures.md | 32 +++ .../functions/C_Map.GetMapArtLayers.md | 30 +++ .../functions/C_Map.GetMapBannersForMap.md | 24 ++ .../functions/C_Map.GetMapChildrenInfo.md | 109 +++++++++ .../functions/C_Map.GetMapDisplayInfo.md | 19 ++ .../functions/C_Map.GetMapGroupID.md | 19 ++ .../functions/C_Map.GetMapGroupMembersInfo.md | 22 ++ .../C_Map.GetMapHighlightInfoAtPosition.md | 31 +++ .../functions/C_Map.GetMapInfo.md | 100 ++++++++ .../functions/C_Map.GetMapInfoAtPosition.md | 99 ++++++++ .../functions/C_Map.GetMapLevels.md | 19 ++ .../functions/C_Map.GetMapLinksForMap.md | 26 ++ .../functions/C_Map.GetMapPosFromWorldPos.md | 19 ++ .../functions/C_Map.GetMapRectOnMap.md | 21 ++ .../functions/C_Map.GetPlayerMapPosition.md | 32 +++ .../functions/C_Map.GetWorldPosFromMapPos.md | 29 +++ wiki-information/functions/C_Map.MapHasArt.md | 19 ++ .../functions/C_Map.RequestPreloadMap.md | 9 + ...rationInfo.GetExploredAreaIDsAtPosition.md | 15 ++ ...pExplorationInfo.GetExploredMapTextures.md | 47 ++++ .../C_MerchantFrame.GetBuybackItemID.md | 13 + .../C_Minimap.GetNumTrackingTypes.md | 9 + .../C_Minimap.GetObjectIconTextureCoords.md | 19 ++ .../C_Minimap.GetPOITextureCoords.md | 19 ++ .../functions/C_Minimap.GetTrackingInfo.md | 23 ++ .../functions/C_Minimap.SetTracking.md | 11 + .../C_ModelInfo.AddActiveModelScene.md | 14 ++ .../C_ModelInfo.AddActiveModelSceneActor.md | 14 ++ .../C_ModelInfo.ClearActiveModelScene.md | 12 + .../C_ModelInfo.ClearActiveModelSceneActor.md | 12 + ...lInfo.GetModelSceneActorDisplayInfoByID.md | 30 +++ .../C_ModelInfo.GetModelSceneActorInfoByID.md | 38 +++ ...C_ModelInfo.GetModelSceneCameraInfoByID.md | 52 ++++ .../C_ModelInfo.GetModelSceneInfoByID.md | 42 ++++ .../functions/C_MountJournal.ClearFanfare.md | 9 + .../C_MountJournal.ClearRecentFanfares.md | 5 + .../functions/C_MountJournal.Dismiss.md | 12 + ...rnal.GetAllCreatureDisplayIDsForMountID.md | 13 + ...tJournal.GetCollectedDragonridingMounts.md | 23 ++ ..._MountJournal.GetCollectedFilterSetting.md | 20 ++ ...GetDisplayedMountAllCreatureDisplayInfo.md | 126 ++++++++++ .../C_MountJournal.GetDisplayedMountID.md | 26 ++ .../C_MountJournal.GetDisplayedMountInfo.md | 63 +++++ ...MountJournal.GetDisplayedMountInfoExtra.md | 62 +++++ .../functions/C_MountJournal.GetIsFavorite.md | 15 ++ ...rnal.GetMountAllCreatureDisplayInfoByID.md | 64 +++++ .../C_MountJournal.GetMountFromItem.md | 19 ++ .../C_MountJournal.GetMountFromSpell.md | 19 ++ .../functions/C_MountJournal.GetMountIDs.md | 9 + .../C_MountJournal.GetMountInfoByID.md | 63 +++++ .../C_MountJournal.GetMountInfoExtraByID.md | 62 +++++ .../functions/C_MountJournal.GetMountLink.md | 19 ++ .../C_MountJournal.GetMountUsabilityByID.md | 23 ++ .../C_MountJournal.GetNumDisplayedMounts.md | 12 + .../functions/C_MountJournal.GetNumMounts.md | 15 ++ ...MountJournal.GetNumMountsNeedingFanfare.md | 9 + .../C_MountJournal.IsSourceChecked.md | 19 ++ .../functions/C_MountJournal.IsTypeChecked.md | 19 ++ .../C_MountJournal.IsUsingDefaultFilters.md | 9 + .../C_MountJournal.IsValidSourceFilter.md | 19 ++ .../C_MountJournal.IsValidTypeFilter.md | 19 ++ .../functions/C_MountJournal.NeedsFanfare.md | 13 + .../functions/C_MountJournal.Pickup.md | 27 +++ .../C_MountJournal.SetAllSourceFilters.md | 9 + .../C_MountJournal.SetAllTypeFilters.md | 9 + ..._MountJournal.SetCollectedFilterSetting.md | 23 ++ .../C_MountJournal.SetDefaultFilters.md | 17 ++ .../functions/C_MountJournal.SetIsFavorite.md | 14 ++ .../functions/C_MountJournal.SetSearch.md | 9 + .../C_MountJournal.SetSourceFilter.md | 26 ++ .../functions/C_MountJournal.SetTypeFilter.md | 11 + .../functions/C_MountJournal.SummonByID.md | 20 ++ .../C_NamePlate.GetNamePlateForUnit.md | 47 ++++ .../functions/C_NamePlate.GetNamePlates.md | 46 ++++ ...NamePlate.SetNamePlateEnemyClickThrough.md | 9 + ...e.SetNamePlateEnemyPreferredClickInsets.md | 15 ++ .../C_NamePlate.SetNamePlateEnemySize.md | 11 + ...ePlate.SetNamePlateFriendlyClickThrough.md | 9 + ...etNamePlateFriendlyPreferredClickInsets.md | 15 ++ .../C_NamePlate.SetNamePlateFriendlySize.md | 17 ++ ..._NamePlate.SetNamePlateSelfClickThrough.md | 9 + ...te.SetNamePlateSelfPreferredClickInsets.md | 15 ++ .../C_NamePlate.SetNamePlateSelfSize.md | 22 ++ .../C_NamePlate.SetTargetClampingInsets.md | 11 + .../functions/C_NewItems.ClearAll.md | 9 + .../functions/C_NewItems.IsNewItem.md | 19 ++ .../functions/C_NewItems.RemoveNewItem.md | 14 ++ .../C_PaperDollInfo.GetArmorEffectiveness.md | 21 ++ ...Info.GetArmorEffectivenessAgainstTarget.md | 13 + .../C_PaperDollInfo.GetMinItemLevel.md | 15 ++ .../C_PaperDollInfo.OffhandHasShield.md | 9 + .../C_PaperDollInfo.OffhandHasWeapon.md | 9 + .../C_PartyInfo.ConfirmLeaveParty.md | 9 + .../C_PartyInfo.GetActiveCategories.md | 9 + ...Info.GetInviteConfirmationInvalidQueues.md | 13 + .../C_PartyInfo.IsCrossFactionParty.md | 19 ++ .../functions/C_PartyInfo.IsPartyFull.md | 29 +++ .../C_PetJournal.ClearSearchFilter.md | 14 ++ .../functions/C_PetJournal.FindPetIDByName.md | 15 ++ .../C_PetJournal.GetNumCollectedInfo.md | 15 ++ .../C_PetJournal.GetNumPetSources.md | 14 ++ .../functions/C_PetJournal.GetNumPetTypes.md | 14 ++ .../functions/C_PetJournal.GetNumPets.md | 11 + .../C_PetJournal.GetNumPetsInJournal.md | 15 ++ .../C_PetJournal.GetOwnedBattlePetString.md | 13 + .../C_PetJournal.GetPetCooldownByGUID.md | 20 ++ .../C_PetJournal.GetPetInfoByIndex.md | 72 ++++++ .../C_PetJournal.GetPetInfoByPetID.md | 38 +++ .../C_PetJournal.GetPetInfoBySpeciesID.md | 28 +++ .../C_PetJournal.GetPetLoadOutInfo.md | 25 ++ .../C_PetJournal.GetPetSortParameter.md | 12 + .../C_PetJournal.GetPetSummonInfo.md | 27 +++ .../C_PetJournal.GetSummonedPetGUID.md | 15 ++ .../functions/C_PetJournal.IsFilterChecked.md | 18 ++ .../C_PetJournal.IsPetSourceChecked.md | 18 ++ .../C_PetJournal.IsPetTypeChecked.md | 18 ++ .../functions/C_PetJournal.PetIsFavorite.md | 13 + .../functions/C_PetJournal.PetIsRevoked.md | 17 ++ .../functions/C_PetJournal.PetIsSummonable.md | 13 + .../functions/C_PetJournal.PickupPet.md | 17 ++ .../C_PetJournal.SetAllPetSourcesChecked.md | 14 ++ .../C_PetJournal.SetAllPetTypesChecked.md | 14 ++ .../functions/C_PetJournal.SetFavorite.md | 13 + .../C_PetJournal.SetFilterChecked.md | 16 ++ .../C_PetJournal.SetPetLoadOutInfo.md | 24 ++ .../C_PetJournal.SetPetSortParameter.md | 25 ++ .../C_PetJournal.SetPetSourceChecked.md | 16 ++ .../C_PetJournal.SetPetTypeFilter.md | 16 ++ .../functions/C_PetJournal.SetSearchFilter.md | 12 + .../functions/C_PetJournal.SummonPetByGUID.md | 29 +++ .../functions/C_PlayerInfo.CanUseItem.md | 19 ++ .../functions/C_PlayerInfo.GUIDIsPlayer.md | 16 ++ .../C_PlayerInfo.GetAlternateFormInfo.md | 11 + .../functions/C_PlayerInfo.GetClass.md | 17 ++ .../functions/C_PlayerInfo.GetDisplayID.md | 9 + .../functions/C_PlayerInfo.GetName.md | 27 +++ .../C_PlayerInfo.GetNativeDisplayID.md | 9 + ...rInfo.GetPetStableCreatureDisplayInfoID.md | 13 + .../C_PlayerInfo.GetPlayerCharacterData.md | 50 ++++ .../functions/C_PlayerInfo.GetRace.md | 27 +++ .../functions/C_PlayerInfo.GetSex.md | 35 +++ .../C_PlayerInfo.HasVisibleInvSlot.md | 19 ++ .../functions/C_PlayerInfo.IsConnected.md | 22 ++ .../C_PlayerInfo.IsDisplayRaceNative.md | 9 + .../functions/C_PlayerInfo.IsMirrorImage.md | 9 + .../C_PlayerInfo.IsPlayerNPERestricted.md | 9 + .../C_PlayerInfo.IsSelfFoundActive.md | 9 + .../C_PlayerInfo.UnitIsSameServer.md | 22 ++ ...ayerInteractionManager.ClearInteraction.md | 77 ++++++ ...eractionManager.ConfirmationInteraction.md | 77 ++++++ ...C_PlayerInteractionManager.InteractUnit.md | 23 ++ ...ctionManager.IsInteractingWithNpcOfType.md | 81 +++++++ ...layerInteractionManager.IsReplacingUnit.md | 9 + ...nteractionManager.IsValidNPCInteraction.md | 81 +++++++ .../C_PvP.GetArenaCrowdControlInfo.md | 23 ++ .../C_PvP.GetBattlefieldVehicleInfo.md | 40 +++ .../functions/C_PvP.GetBattlefieldVehicles.md | 38 +++ .../functions/C_PvP.GetRandomBGRewards.md | 33 +++ wiki-information/functions/C_PvP.IsInBrawl.md | 9 + wiki-information/functions/C_PvP.IsPVPMap.md | 9 + .../functions/C_PvP.IsRatedMap.md | 15 ++ .../C_PvP.RequestCrowdControlSpell.md | 9 + ...QuestInfoSystem.GetQuestRewardSpellInfo.md | 56 +++++ .../C_QuestInfoSystem.GetQuestRewardSpells.md | 13 + ...nfoSystem.GetQuestShouldToastCompletion.md | 19 ++ .../C_QuestInfoSystem.HasQuestRewardSpells.md | 13 + .../C_QuestLog.GetMapForQuestPOIs.md | 9 + .../functions/C_QuestLog.GetMaxNumQuests.md | 9 + .../C_QuestLog.GetMaxNumQuestsCanAccept.md | 9 + .../functions/C_QuestLog.GetQuestInfo.md | 20 ++ .../C_QuestLog.GetQuestObjectives.md | 31 +++ .../functions/C_QuestLog.GetQuestsOnMap.md | 32 +++ .../functions/C_QuestLog.IsOnQuest.md | 13 + .../C_QuestLog.IsQuestFlaggedCompleted.md | 20 ++ .../C_QuestLog.SetMapForQuestPOIs.md | 9 + .../C_QuestLog.ShouldShowQuestRewards.md | 19 ++ .../functions/C_QuestSession.CanStart.md | 13 + .../functions/C_QuestSession.CanStop.md | 13 + .../functions/C_QuestSession.Exists.md | 12 + ...QuestSession.GetAvailableSessionCommand.md | 23 ++ .../C_QuestSession.GetPendingCommand.md | 23 ++ ...stSession.GetProposedMaxLevelForSession.md | 9 + .../C_QuestSession.GetSessionBeginDetails.md | 22 ++ .../C_QuestSession.GetSuperTrackedQuest.md | 12 + .../functions/C_QuestSession.HasJoined.md | 12 + .../C_QuestSession.HasPendingCommand.md | 12 + .../C_QuestSession.RequestSessionStart.md | 9 + .../C_QuestSession.RequestSessionStop.md | 9 + ...C_QuestSession.SendSessionBeginResponse.md | 15 ++ .../C_QuestSession.SetQuestIsSuperTracked.md | 17 ++ .../C_RaidLocks.IsEncounterComplete.md | 23 ++ .../C_ReportSystem.CanReportPlayer.md | 13 + ...ReportSystem.CanReportPlayerForLanguage.md | 19 ++ ...tSystem.GetMajorCategoriesForReportType.md | 39 +++ .../C_ReportSystem.GetMajorCategoryString.md | 20 ++ ...CategoriesForReportTypeAndMajorCategory.md | 59 +++++ .../C_ReportSystem.GetMinorCategoryString.md | 46 ++++ .../C_ReportSystem.InitiateReportPlayer.md | 33 +++ .../C_ReportSystem.OpenReportPlayerDialog.md | 35 +++ .../C_ReportSystem.ReportServerLag.md | 17 ++ .../C_ReportSystem.ReportStuckInCombat.md | 18 ++ .../functions/C_ReportSystem.SendReport.md | 11 + .../C_ReportSystem.SendReportPlayer.md | 11 + ..._ReportSystem.SetPendingReportPetTarget.md | 13 + .../C_ReportSystem.SetPendingReportTarget.md | 20 ++ ...portSystem.SetPendingReportTargetByGuid.md | 20 ++ .../C_Reputation.GetFactionParagonInfo.md | 36 +++ .../C_Reputation.IsFactionParagon.md | 18 ++ ....RequestFactionParagonPreloadRewardData.md | 9 + .../C_Reputation.SetWatchedFaction.md | 9 + ...imations.GetAllScriptedAnimationEffects.md | 102 ++++++++ .../functions/C_Seasons.GetActiveSeason.md | 23 ++ .../functions/C_Seasons.HasActiveSeason.md | 12 + .../functions/C_Social.GetLastItem.md | 19 ++ .../functions/C_Social.GetLastScreenshot.md | 9 + .../C_Social.GetNumCharactersPerMedia.md | 9 + .../C_Social.GetScreenshotByIndex.md | 24 ++ .../functions/C_Social.GetTweetLength.md | 13 + .../functions/C_Social.IsSocialEnabled.md | 9 + .../functions/C_Social.TwitterCheckStatus.md | 5 + .../functions/C_Social.TwitterConnect.md | 5 + .../functions/C_Social.TwitterDisconnect.md | 5 + .../C_Social.TwitterGetMSTillCanPost.md | 9 + .../functions/C_Social.TwitterPostMessage.md | 12 + ...ictions.AcknowledgeRegionalChatDisabled.md | 5 + .../C_SocialRestrictions.IsChatDisabled.md | 9 + .../functions/C_SocialRestrictions.IsMuted.md | 9 + .../C_SocialRestrictions.IsSilenced.md | 9 + .../C_SocialRestrictions.IsSquelched.md | 9 + .../C_SocialRestrictions.SetChatDisabled.md | 9 + .../functions/C_Sound.GetSoundScaledVolume.md | 13 + .../functions/C_Sound.IsPlaying.md | 19 ++ .../functions/C_Sound.PlayItemSound.md | 22 ++ .../functions/C_Spell.DoesSpellExist.md | 16 ++ .../functions/C_Spell.IsSpellDataCached.md | 29 +++ .../functions/C_Spell.RequestLoadSpellData.md | 12 + .../C_SpellBook.GetSpellLinkFromSpellID.md | 21 ++ .../C_StableInfo.GetNumActivePets.md | 12 + .../C_StableInfo.GetNumStablePets.md | 12 + ...ublic.DoesGroupHavePurchaseableProducts.md | 13 + .../C_StorePublic.HasPurchaseableProducts.md | 9 + ...torePublic.IsDisabledByParentalControls.md | 9 + .../functions/C_StorePublic.IsEnabled.md | 9 + .../functions/C_SummonInfo.CancelSummon.md | 11 + .../functions/C_SummonInfo.ConfirmSummon.md | 11 + .../C_SummonInfo.GetSummonConfirmAreaName.md | 9 + .../C_SummonInfo.GetSummonConfirmSummoner.md | 12 + .../C_SummonInfo.GetSummonConfirmTimeLeft.md | 9 + .../functions/C_SummonInfo.GetSummonReason.md | 9 + ...monInfo.IsSummonSkippingStartExperience.md | 9 + .../functions/C_System.GetFrameStack.md | 9 + ...SystemVisibilityManager.IsSystemVisible.md | 18 ++ .../C_TTSSettings.GetChannelEnabled.md | 40 +++ ...C_TTSSettings.GetCharacterSettingsSaved.md | 9 + .../C_TTSSettings.GetChatTypeEnabled.md | 13 + .../functions/C_TTSSettings.GetSetting.md | 21 ++ .../functions/C_TTSSettings.GetSpeechRate.md | 9 + .../C_TTSSettings.GetSpeechVolume.md | 9 + .../C_TTSSettings.GetVoiceOptionID.md | 20 ++ .../C_TTSSettings.GetVoiceOptionName.md | 20 ++ ..._TTSSettings.MarkCharacterSettingsSaved.md | 6 + .../C_TTSSettings.SetChannelEnabled.md | 38 +++ .../C_TTSSettings.SetChannelKeyEnabled.md | 11 + .../C_TTSSettings.SetChatTypeEnabled.md | 11 + .../C_TTSSettings.SetDefaultSettings.md | 6 + .../functions/C_TTSSettings.SetSetting.md | 19 ++ .../functions/C_TTSSettings.SetSpeechRate.md | 9 + .../C_TTSSettings.SetSpeechVolume.md | 9 + .../functions/C_TTSSettings.SetVoiceOption.md | 17 ++ .../C_TTSSettings.SetVoiceOptionName.md | 33 +++ .../C_TTSSettings.ShouldOverrideMessage.md | 15 ++ ...askQuest.DoesMapShowTaskQuestObjectives.md | 13 + .../C_TaskQuest.GetQuestInfoByQuestID.md | 25 ++ .../functions/C_TaskQuest.GetQuestLocation.md | 17 ++ .../C_TaskQuest.GetQuestProgressBarInfo.md | 27 +++ .../C_TaskQuest.GetQuestTimeLeftMinutes.md | 21 ++ .../C_TaskQuest.GetQuestTimeLeftSeconds.md | 21 ++ .../functions/C_TaskQuest.GetQuestZoneID.md | 13 + .../C_TaskQuest.GetQuestsForPlayerByMapID.md | 39 +++ .../functions/C_TaskQuest.GetThreatQuests.md | 23 ++ ...C_TaskQuest.GetUIWidgetSetIDFromQuestID.md | 13 + .../functions/C_TaskQuest.IsActive.md | 19 ++ .../C_TaskQuest.RequestPreloadRewardData.md | 9 + .../functions/C_TaxiMap.GetAllTaxiNodes.md | 45 ++++ .../functions/C_TaxiMap.GetTaxiNodesForMap.md | 38 +++ .../C_Texture.ClearTitleIconTexture.md | 9 + .../functions/C_Texture.GetAtlasElementID.md | 19 ++ .../functions/C_Texture.GetAtlasID.md | 19 ++ .../functions/C_Texture.GetAtlasInfo.md | 71 ++++++ .../C_Texture.GetFilenameFromFileDataID.md | 16 ++ .../C_Texture.GetTitleIconTexture.md | 31 +++ .../C_Texture.IsTitleIconTextureReady.md | 24 ++ .../C_Texture.SetTitleIconTexture.md | 22 ++ wiki-information/functions/C_Timer.After.md | 32 +++ .../functions/C_Timer.NewTicker.md | 50 ++++ .../functions/C_Timer.NewTimer.md | 50 ++++ .../functions/C_ToyBox.GetNumToys.md | 9 + .../functions/C_ToyBox.GetToyFromIndex.md | 13 + .../functions/C_ToyBox.GetToyInfo.md | 23 ++ .../functions/C_ToyBox.GetToyLink.md | 20 ++ .../functions/C_ToyBoxInfo.ClearFanfare.md | 9 + .../functions/C_ToyBoxInfo.NeedsFanfare.md | 13 + .../functions/C_Traits.CanPurchaseRank.md | 21 ++ .../functions/C_Traits.CanRefundRank.md | 15 ++ .../C_Traits.CascadeRepurchaseRanks.md | 16 ++ .../C_Traits.ClearCascadeRepurchaseHistory.md | 9 + .../functions/C_Traits.CommitConfig.md | 16 ++ .../C_Traits.ConfigHasStagedChanges.md | 13 + .../C_Traits.GenerateImportString.md | 62 +++++ .../C_Traits.GenerateInspectImportString.md | 19 ++ .../functions/C_Traits.GetConditionInfo.md | 70 ++++++ .../C_Traits.GetConfigIDBySystemID.md | 19 ++ .../functions/C_Traits.GetConfigIDByTreeID.md | 13 + .../functions/C_Traits.GetConfigInfo.md | 42 ++++ .../functions/C_Traits.GetConfigsByType.md | 20 ++ .../functions/C_Traits.GetDefinitionInfo.md | 44 ++++ .../functions/C_Traits.GetEntryInfo.md | 52 ++++ ...C_Traits.GetLoadoutSerializationVersion.md | 13 + .../functions/C_Traits.GetNodeCost.md | 22 ++ .../functions/C_Traits.GetNodeInfo.md | 121 ++++++++++ .../C_Traits.GetStagedChangesCost.md | 20 ++ .../functions/C_Traits.GetStagedPurchases.md | 13 + .../C_Traits.GetTraitCurrencyInfo.md | 52 ++++ .../functions/C_Traits.GetTraitDescription.md | 15 ++ .../functions/C_Traits.GetTraitSystemFlags.md | 26 ++ .../C_Traits.GetTraitSystemWidgetSetID.md | 13 + .../functions/C_Traits.GetTreeCurrencyInfo.md | 28 +++ .../functions/C_Traits.GetTreeHash.md | 18 ++ .../functions/C_Traits.GetTreeInfo.md | 33 +++ .../functions/C_Traits.GetTreeNodes.md | 19 ++ .../functions/C_Traits.HasValidInspectData.md | 9 + .../functions/C_Traits.IsReadyForCommit.md | 9 + .../functions/C_Traits.PurchaseRank.md | 18 ++ .../functions/C_Traits.RefundAllRanks.md | 34 +++ .../functions/C_Traits.RefundRank.md | 23 ++ .../functions/C_Traits.ResetTree.md | 35 +++ .../functions/C_Traits.ResetTreeByCurrency.md | 20 ++ .../functions/C_Traits.RollbackConfig.md | 13 + .../functions/C_Traits.SetSelection.md | 23 ++ .../functions/C_Traits.StageConfig.md | 30 +++ .../functions/C_UI.DoesAnyDisplayHaveNotch.md | 9 + .../C_UI.GetTopLeftNotchSafeRegion.md | 15 ++ .../C_UI.GetTopRightNotchSafeRegion.md | 15 ++ wiki-information/functions/C_UI.Reload.md | 15 ++ .../C_UI.ShouldUIParentAvoidNotch.md | 9 + .../functions/C_UIColor.GetColors.md | 19 ++ .../C_UIWidgetManager.GetAllWidgetsBySetID.md | 78 ++++++ ...idgetManager.GetBelowMinimapWidgetSetID.md | 19 ++ ...etBulletTextListWidgetVisualizationInfo.md | 86 +++++++ ...er.GetCaptureBarWidgetVisualizationInfo.md | 162 +++++++++++++ ...oubleIconAndTextWidgetVisualizationInfo.md | 135 +++++++++++ ...tDoubleStatusBarWidgetVisualizationInfo.md | 171 +++++++++++++ ...zontalCurrenciesWidgetVisualizationInfo.md | 145 +++++++++++ ...r.GetIconAndTextWidgetVisualizationInfo.md | 138 +++++++++++ ...extAndBackgroundWidgetVisualizationInfo.md | 105 ++++++++ ...extAndCurrenciesWidgetVisualizationInfo.md | 171 +++++++++++++ ...iesAndBackgroundWidgetVisualizationInfo.md | 119 +++++++++ ...dResourceTrackerWidgetVisualizationInfo.md | 145 +++++++++++ ...ger.GetStatusBarWidgetVisualizationInfo.md | 214 ++++++++++++++++ ...GetTextWithStateWidgetVisualizationInfo.md | 203 ++++++++++++++++ ...er.GetTextureWithStateVisualizationInfo.md | 41 ++++ ...UIWidgetManager.GetTopCenterWidgetSetID.md | 33 +++ .../C_UnitAuras.AddPrivateAuraAnchor.md | 58 +++++ .../C_UnitAuras.AddPrivateAuraAppliedSound.md | 26 ++ .../functions/C_UnitAuras.AuraIsPrivate.md | 19 ++ ...C_UnitAuras.GetAuraDataByAuraInstanceID.md | 65 +++++ .../C_UnitAuras.GetAuraDataByIndex.md | 81 +++++++ .../C_UnitAuras.GetAuraDataBySlot.md | 64 +++++ .../C_UnitAuras.GetAuraDataBySpellName.md | 89 +++++++ .../functions/C_UnitAuras.GetAuraSlots.md | 43 ++++ .../C_UnitAuras.GetBuffDataByIndex.md | 87 +++++++ .../C_UnitAuras.GetCooldownAuraBySpellID.md | 16 ++ .../C_UnitAuras.GetDebuffDataByIndex.md | 90 +++++++ .../C_UnitAuras.GetPlayerAuraBySpellID.md | 66 +++++ ...UnitAuras.IsAuraFilteredOutByInstanceID.md | 28 +++ .../C_UnitAuras.RemovePrivateAuraAnchor.md | 9 + ...UnitAuras.RemovePrivateAuraAppliedSound.md | 9 + ...C_UnitAuras.SetPrivateWarningTextAnchor.md | 24 ++ .../functions/C_UnitAuras.WantsAlteredForm.md | 13 + .../functions/C_UserFeedback.SubmitBug.md | 32 +++ .../C_UserFeedback.SubmitSuggestion.md | 30 +++ ...C_VideoOptions.GetCurrentGameWindowSize.md | 9 + ...C_VideoOptions.GetDefaultGameWindowSize.md | 13 + .../C_VideoOptions.GetGameWindowSizes.md | 15 ++ .../C_VideoOptions.GetGxAdapterInfo.md | 18 ++ .../C_VideoOptions.SetGameWindowSize.md | 11 + .../functions/C_VoiceChat.ActivateChannel.md | 9 + ..._VoiceChat.ActivateChannelTranscription.md | 9 + .../C_VoiceChat.BeginLocalCapture.md | 21 ++ .../C_VoiceChat.CanPlayerUseVoiceChat.md | 9 + .../functions/C_VoiceChat.CreateChannel.md | 42 ++++ .../C_VoiceChat.DeactivateChannel.md | 9 + ...oiceChat.DeactivateChannelTranscription.md | 9 + .../functions/C_VoiceChat.EndLocalCapture.md | 18 ++ .../C_VoiceChat.GetActiveChannelID.md | 9 + .../C_VoiceChat.GetActiveChannelType.md | 9 + .../C_VoiceChat.GetAvailableInputDevices.md | 25 ++ .../C_VoiceChat.GetAvailableOutputDevices.md | 26 ++ .../functions/C_VoiceChat.GetChannel.md | 71 ++++++ .../C_VoiceChat.GetChannelForChannelType.md | 56 +++++ ..._VoiceChat.GetChannelForCommunityStream.md | 75 ++++++ .../C_VoiceChat.GetCommunicationMode.md | 17 ++ ...GetCurrentVoiceChatConnectionStatusCode.md | 62 +++++ .../functions/C_VoiceChat.GetInputVolume.md | 9 + ...t.GetLocalPlayerActiveChannelMemberInfo.md | 25 ++ .../C_VoiceChat.GetLocalPlayerMemberID.md | 13 + .../C_VoiceChat.GetMasterVolumeScale.md | 9 + .../functions/C_VoiceChat.GetMemberGUID.md | 15 ++ .../functions/C_VoiceChat.GetMemberID.md | 15 ++ .../functions/C_VoiceChat.GetMemberInfo.md | 31 +++ .../functions/C_VoiceChat.GetMemberName.md | 24 ++ .../functions/C_VoiceChat.GetMemberVolume.md | 27 +++ .../functions/C_VoiceChat.GetOutputVolume.md | 9 + .../C_VoiceChat.GetPTTButtonPressedState.md | 9 + .../functions/C_VoiceChat.GetProcesses.md | 78 ++++++ .../C_VoiceChat.GetPushToTalkBinding.md | 9 + .../C_VoiceChat.GetRemoteTtsVoices.md | 16 ++ .../functions/C_VoiceChat.GetTtsVoices.md | 16 ++ .../C_VoiceChat.GetVADSensitivity.md | 9 + .../C_VoiceChat.IsChannelJoinPending.md | 31 +++ .../functions/C_VoiceChat.IsDeafened.md | 9 + .../functions/C_VoiceChat.IsEnabled.md | 9 + .../functions/C_VoiceChat.IsLoggedIn.md | 9 + .../C_VoiceChat.IsMemberLocalPlayer.md | 15 ++ .../functions/C_VoiceChat.IsMemberMuted.md | 27 +++ .../C_VoiceChat.IsMemberMutedForAll.md | 16 ++ .../functions/C_VoiceChat.IsMemberSilenced.md | 15 ++ .../functions/C_VoiceChat.IsMuted.md | 9 + .../C_VoiceChat.IsParentalDisabled.md | 9 + .../functions/C_VoiceChat.IsParentalMuted.md | 9 + .../C_VoiceChat.IsPlayerUsingVoice.md | 13 + .../functions/C_VoiceChat.IsSilenced.md | 9 + .../C_VoiceChat.IsSpeakForMeActive.md | 9 + .../C_VoiceChat.IsSpeakForMeAllowed.md | 9 + .../functions/C_VoiceChat.IsTranscribing.md | 9 + .../C_VoiceChat.IsTranscriptionAllowed.md | 9 + .../C_VoiceChat.IsVoiceChatConnected.md | 9 + .../functions/C_VoiceChat.LeaveChannel.md | 9 + .../functions/C_VoiceChat.Login.md | 38 +++ .../functions/C_VoiceChat.Logout.md | 63 +++++ .../C_VoiceChat.MarkChannelsDiscovered.md | 8 + ...stJoinAndActivateCommunityStreamChannel.md | 11 + ...iceChat.RequestJoinChannelByChannelType.md | 37 +++ .../C_VoiceChat.SetCommunicationMode.md | 17 ++ .../functions/C_VoiceChat.SetDeafened.md | 9 + .../functions/C_VoiceChat.SetInputDevice.md | 9 + .../functions/C_VoiceChat.SetInputVolume.md | 9 + .../C_VoiceChat.SetMasterVolumeScale.md | 9 + .../functions/C_VoiceChat.SetMemberMuted.md | 19 ++ .../functions/C_VoiceChat.SetMemberVolume.md | 14 ++ .../functions/C_VoiceChat.SetMuted.md | 9 + .../functions/C_VoiceChat.SetOutputDevice.md | 9 + .../functions/C_VoiceChat.SetOutputVolume.md | 9 + .../C_VoiceChat.SetPortraitTexture.md | 19 ++ .../C_VoiceChat.SetPushToTalkBinding.md | 9 + .../C_VoiceChat.SetVADSensitivity.md | 9 + .../C_VoiceChat.ShouldDiscoverChannels.md | 12 + .../C_VoiceChat.SpeakRemoteTextSample.md | 9 + .../functions/C_VoiceChat.SpeakText.md | 41 ++++ .../functions/C_VoiceChat.StopSpeakingText.md | 5 + .../functions/C_VoiceChat.ToggleDeafened.md | 5 + .../C_VoiceChat.ToggleMemberMuted.md | 9 + .../functions/C_VoiceChat.ToggleMuted.md | 5 + .../functions/C_XMLUtil.GetTemplateInfo.md | 38 +++ .../functions/C_XMLUtil.GetTemplates.md | 24 ++ .../functions/CalculateStringEditDistance.md | 30 +++ wiki-information/functions/CallCompanion.md | 28 +++ .../functions/CameraOrSelectOrMoveStart.md | 10 + .../functions/CameraOrSelectOrMoveStop.md | 14 ++ wiki-information/functions/CameraZoomIn.md | 13 + wiki-information/functions/CanAbandonQuest.md | 16 ++ wiki-information/functions/CanBeRaidTarget.md | 22 ++ .../functions/CanChangePlayerDifficulty.md | 11 + wiki-information/functions/CanDualWield.md | 73 ++++++ wiki-information/functions/CanEditMOTD.md | 9 + .../functions/CanEjectPassengerFromSeat.md | 13 + wiki-information/functions/CanGrantLevel.md | 24 ++ wiki-information/functions/CanGuildDemote.md | 15 ++ wiki-information/functions/CanGuildInvite.md | 9 + wiki-information/functions/CanGuildPromote.md | 22 ++ wiki-information/functions/CanInspect.md | 21 ++ .../functions/CanJoinBattlefieldAsGroup.md | 21 ++ wiki-information/functions/CanLootUnit.md | 15 ++ .../functions/CanMerchantRepair.md | 9 + .../functions/CanReplaceGuildMaster.md | 13 + .../functions/CanSendAuctionQuery.md | 15 ++ .../functions/CanShowAchievementUI.md | 14 ++ .../functions/CanShowResetInstances.md | 9 + wiki-information/functions/CanSummonFriend.md | 23 ++ .../functions/CanSwitchVehicleSeat.md | 9 + .../functions/CanUpgradeExpansion.md | 9 + wiki-information/functions/CancelDuel.md | 18 ++ .../functions/CancelItemTempEnchantment.md | 15 ++ wiki-information/functions/CancelLogout.md | 8 + .../functions/CancelPendingEquip.md | 12 + .../functions/CancelPreloadingMovie.md | 9 + .../functions/CancelShapeshiftForm.md | 9 + .../functions/CancelTrackingBuff.md | 11 + wiki-information/functions/CancelTrade.md | 11 + wiki-information/functions/CancelUnitBuff.md | 16 ++ .../functions/CaseAccentInsensitiveParse.md | 35 +++ wiki-information/functions/CastPetAction.md | 11 + .../functions/CastShapeshiftForm.md | 21 ++ wiki-information/functions/CastSpell.md | 31 +++ wiki-information/functions/CastSpellByName.md | 14 ++ wiki-information/functions/CastingInfo.md | 34 +++ .../functions/ChangeActionBarPage.md | 13 + wiki-information/functions/ChangeChatColor.md | 24 ++ wiki-information/functions/ChannelBan.md | 14 ++ wiki-information/functions/ChannelInfo.md | 26 ++ wiki-information/functions/ChannelInvite.md | 14 ++ wiki-information/functions/ChannelKick.md | 14 ++ wiki-information/functions/CheckInbox.md | 9 + .../functions/CheckInteractDistance.md | 38 +++ .../functions/CheckTalentMasterDist.md | 9 + .../functions/ClassicExpansionAtLeast.md | 13 + wiki-information/functions/ClearCursor.md | 22 ++ .../functions/ClearOverrideBindings.md | 12 + wiki-information/functions/ClearSendMail.md | 20 ++ wiki-information/functions/ClearTarget.md | 9 + .../functions/ClickSendMailItemButton.md | 11 + wiki-information/functions/ClickStablePet.md | 18 ++ wiki-information/functions/CloseItemText.md | 8 + wiki-information/functions/CloseLoot.md | 15 ++ wiki-information/functions/ClosePetition.md | 8 + wiki-information/functions/CloseSocketInfo.md | 8 + .../functions/ClosestUnitPosition.md | 17 ++ .../functions/CollapseFactionHeader.md | 12 + .../functions/CollapseQuestHeader.md | 31 +++ .../functions/CollapseSkillHeader.md | 12 + .../functions/CollapseTrainerSkillLine.md | 25 ++ .../functions/CombatLogAdvanceEntry.md | 40 +++ .../functions/CombatLogGetCurrentEntry.md | 10 + .../functions/CombatLogGetCurrentEventInfo.md | 47 ++++ .../functions/CombatLogSetCurrentEntry.md | 47 ++++ .../functions/CombatLog_Object_IsA.md | 64 +++++ .../functions/CombatTextSetActiveUnit.md | 17 ++ wiki-information/functions/CompleteQuest.md | 10 + .../functions/ConfirmAcceptQuest.md | 8 + wiki-information/functions/ConfirmLootRoll.md | 30 +++ wiki-information/functions/ConfirmLootSlot.md | 12 + .../functions/ConfirmPetUnlearn.md | 9 + .../functions/ConfirmReadyCheck.md | 12 + .../functions/ConsoleAddMessage.md | 9 + wiki-information/functions/ConsoleExec.md | 12 + .../functions/ConsoleGetAllCommands.md | 64 +++++ .../functions/ConsoleGetColorFromType.md | 28 +++ .../functions/ConsoleGetFontHeight.md | 9 + .../ConsolePrintAllMatchingCommands.md | 9 + .../functions/ConsoleSetFontHeight.md | 9 + .../functions/ContainerIDToInventoryID.md | 37 +++ wiki-information/functions/ConvertToParty.md | 8 + wiki-information/functions/ConvertToRaid.md | 8 + wiki-information/functions/CopyToClipboard.md | 28 +++ wiki-information/functions/CreateFont.md | 28 +++ wiki-information/functions/CreateFrame.md | 105 ++++++++ wiki-information/functions/CreateMacro.md | 36 +++ wiki-information/functions/CreateWindow.md | 16 ++ .../functions/CursorCanGoInSlot.md | 13 + wiki-information/functions/CursorHasItem.md | 12 + wiki-information/functions/CursorHasMacro.md | 9 + wiki-information/functions/CursorHasMoney.md | 15 ++ wiki-information/functions/CursorHasSpell.md | 9 + .../functions/DeathRecap_GetEvents.md | 51 ++++ .../functions/DeathRecap_HasEvents.md | 13 + .../functions/DeclineArenaTeam.md | 15 ++ .../functions/DeclineChannelInvite.md | 13 + wiki-information/functions/DeclineGroup.md | 22 ++ wiki-information/functions/DeclineGuild.md | 11 + wiki-information/functions/DeclineName.md | 37 +++ wiki-information/functions/DeclineQuest.md | 11 + .../functions/DeclineResurrect.md | 11 + .../DeclineSpellConfirmationPrompt.md | 22 ++ .../functions/DeleteCursorItem.md | 8 + wiki-information/functions/DeleteInboxItem.md | 16 ++ wiki-information/functions/DeleteMacro.md | 38 +++ wiki-information/functions/DescendStop.md | 11 + wiki-information/functions/DestroyTotem.md | 12 + wiki-information/functions/DisableAddOn.md | 42 ++++ .../functions/DismissCompanion.md | 9 + wiki-information/functions/Dismount.md | 18 ++ .../functions/DisplayChannelOwner.md | 9 + wiki-information/functions/DoReadyCheck.md | 24 ++ wiki-information/functions/DoTradeSkill.md | 23 ++ .../DoesCurrentLocaleSellExpansionLevels.md | 9 + wiki-information/functions/DoesSpellExist.md | 16 ++ wiki-information/functions/DropItemOnUnit.md | 20 ++ wiki-information/functions/EditMacro.md | 33 +++ .../functions/EjectPassengerFromSeat.md | 9 + wiki-information/functions/EnableAddOn.md | 41 ++++ wiki-information/functions/EnumerateFrames.md | 33 +++ .../functions/EnumerateServerChannels.md | 9 + wiki-information/functions/EquipCursorItem.md | 19 ++ wiki-information/functions/EquipItemByName.md | 19 ++ .../functions/EquipPendingItem.md | 12 + .../functions/ExpandCurrencyList.md | 15 ++ .../functions/ExpandFactionHeader.md | 22 ++ .../functions/ExpandQuestHeader.md | 31 +++ .../functions/ExpandSkillHeader.md | 25 ++ .../functions/ExpandTradeSkillSubClass.md | 29 +++ .../functions/ExpandTrainerSkillLine.md | 26 ++ .../functions/FactionToggleAtWar.md | 12 + .../functions/FillLocalizedClassList.md | 63 +++++ .../functions/FindBaseSpellByID.md | 16 ++ .../functions/FindSpellOverrideByID.md | 16 ++ wiki-information/functions/FlashClientIcon.md | 15 ++ wiki-information/functions/FlipCameraYaw.md | 12 + wiki-information/functions/FocusUnit.md | 9 + wiki-information/functions/FollowUnit.md | 14 ++ wiki-information/functions/ForceGossip.md | 9 + wiki-information/functions/ForceQuit.md | 11 + wiki-information/functions/FrameXML_Debug.md | 16 ++ .../functions/GMRequestPlayerInfo.md | 13 + wiki-information/functions/GMSubmitBug.md | 15 ++ .../functions/GMSubmitSuggestion.md | 19 ++ .../functions/GetAbandonQuestItems.md | 9 + .../functions/GetAbandonQuestName.md | 16 ++ .../functions/GetAccountExpansionLevel.md | 55 +++++ .../functions/GetAchievementCategory.md | 24 ++ .../functions/GetAchievementComparisonInfo.md | 28 +++ .../functions/GetAchievementCriteriaInfo.md | 210 ++++++++++++++++ .../GetAchievementCriteriaInfoByID.md | 117 +++++++++ .../functions/GetAchievementLink.md | 13 + .../functions/GetAchievementNumCriteria.md | 16 ++ .../functions/GetActionBarPage.md | 15 ++ .../functions/GetActionBarToggles.md | 15 ++ .../functions/GetActionCharges.md | 28 +++ .../functions/GetActionCooldown.md | 32 +++ wiki-information/functions/GetActionCount.md | 42 ++++ wiki-information/functions/GetActionInfo.md | 31 +++ .../GetActionLossOfControlCooldown.md | 20 ++ wiki-information/functions/GetActionText.md | 14 ++ .../functions/GetActionTexture.md | 14 ++ .../functions/GetActiveTalentGroup.md | 15 ++ .../functions/GetAddOnCPUUsage.md | 36 +++ .../functions/GetAddOnDependencies.md | 13 + .../functions/GetAddOnEnableState.md | 21 ++ wiki-information/functions/GetAddOnInfo.md | 44 ++++ .../functions/GetAddOnMemoryUsage.md | 32 +++ .../functions/GetAddOnMetadata.md | 18 ++ .../functions/GetAllowLowLevelRaid.md | 9 + .../functions/GetArenaTeamIndexBySize.md | 17 ++ .../functions/GetArenaTeamRosterInfo.md | 33 +++ .../functions/GetArmorPenetration.md | 9 + wiki-information/functions/GetAtlasInfo.md | 71 ++++++ .../functions/GetAttackPowerForStat.md | 20 ++ .../functions/GetAuctionItemBattlePetInfo.md | 27 +++ .../functions/GetAuctionItemInfo.md | 76 ++++++ .../functions/GetAuctionItemLink.md | 19 ++ .../functions/GetAuctionItemSubClasses.md | 39 +++ .../functions/GetAutoCompleteRealms.md | 18 ++ .../functions/GetAutoCompleteResults.md | 48 ++++ .../functions/GetAutoDeclineGuildInvites.md | 12 + .../functions/GetAvailableBandwidth.md | 9 + .../functions/GetAvailableLocales.md | 19 ++ .../functions/GetAverageItemLevel.md | 35 +++ .../functions/GetBackgroundLoadingStatus.md | 9 + .../functions/GetBackpackCurrencyInfo.md | 19 ++ wiki-information/functions/GetBankSlotCost.md | 25 ++ .../GetBattlefieldEstimatedWaitTime.md | 9 + .../functions/GetBattlefieldFlagPosition.md | 18 ++ .../GetBattlefieldInstanceExpiration.md | 9 + .../functions/GetBattlefieldInstanceInfo.md | 13 + .../GetBattlefieldInstanceRunTime.md | 9 + .../functions/GetBattlefieldPortExpiration.md | 13 + .../functions/GetBattlefieldScore.md | 64 +++++ .../functions/GetBattlefieldStatInfo.md | 45 ++++ .../functions/GetBattlefieldStatus.md | 48 ++++ .../functions/GetBattlefieldTimeWaited.md | 21 ++ .../functions/GetBattlefieldWinner.md | 17 ++ .../functions/GetBattlegroundInfo.md | 37 +++ .../functions/GetBattlegroundPoints.md | 19 ++ .../functions/GetBestFlexRaidChoice.md | 14 ++ wiki-information/functions/GetBestRFChoice.md | 24 ++ .../functions/GetBillingTimeRested.md | 30 +++ wiki-information/functions/GetBindLocation.md | 20 ++ wiki-information/functions/GetBinding.md | 39 +++ .../functions/GetBindingAction.md | 27 +++ wiki-information/functions/GetBindingByKey.md | 20 ++ wiki-information/functions/GetBindingKey.md | 36 +++ wiki-information/functions/GetBindingText.md | 23 ++ wiki-information/functions/GetBlockChance.md | 16 ++ .../functions/GetBonusBarOffset.md | 42 ++++ wiki-information/functions/GetBuildInfo.md | 54 +++++ .../functions/GetButtonMetatable.md | 12 + .../functions/GetBuybackItemInfo.md | 26 ++ wiki-information/functions/GetCVarInfo.md | 25 ++ wiki-information/functions/GetCameraZoom.md | 12 + wiki-information/functions/GetCategoryList.md | 13 + .../functions/GetCategoryNumAchievements.md | 32 +++ .../functions/GetCemeteryPreference.md | 9 + wiki-information/functions/GetChannelList.md | 24 ++ wiki-information/functions/GetChannelName.md | 22 ++ .../functions/GetChatWindowInfo.md | 40 +++ .../functions/GetChatWindowMessages.md | 17 ++ wiki-information/functions/GetClassInfo.md | 68 ++++++ .../functions/GetClassicExpansionLevel.md | 9 + wiki-information/functions/GetClickFrame.md | 18 ++ .../GetClientDisplayExpansionLevel.md | 50 ++++ wiki-information/functions/GetCoinIcon.md | 21 ++ wiki-information/functions/GetCoinText.md | 51 ++++ .../functions/GetCoinTextureString.md | 51 ++++ wiki-information/functions/GetCombatRating.md | 89 +++++++ .../functions/GetCombatRatingBonus.md | 87 +++++++ wiki-information/functions/GetComboPoints.md | 35 +++ .../functions/GetCompanionCooldown.md | 19 ++ .../functions/GetCompanionInfo.md | 39 +++ .../functions/GetComparisonStatistic.md | 13 + .../functions/GetContainerFreeSlots.md | 21 ++ .../functions/GetContainerItemCooldown.md | 21 ++ .../functions/GetContainerItemDurability.md | 26 ++ .../functions/GetContainerItemID.md | 15 ++ .../functions/GetContainerItemInfo.md | 46 ++++ .../functions/GetContainerItemLink.md | 24 ++ .../functions/GetContainerNumFreeSlots.md | 18 ++ .../functions/GetContainerNumSlots.md | 17 ++ .../functions/GetCorpseRecoveryDelay.md | 9 + .../functions/GetCraftDescription.md | 23 ++ .../functions/GetCraftDisplaySkillLine.md | 19 ++ wiki-information/functions/GetCraftInfo.md | 23 ++ .../functions/GetCraftItemLink.md | 18 ++ wiki-information/functions/GetCraftName.md | 9 + .../functions/GetCraftNumReagents.md | 13 + .../functions/GetCraftReagentInfo.md | 21 ++ .../functions/GetCraftReagentItemLink.md | 19 ++ .../functions/GetCraftRecipeLink.md | 17 ++ .../functions/GetCraftSkillLine.md | 16 ++ .../functions/GetCraftSpellFocus.md | 13 + wiki-information/functions/GetCritChance.md | 16 ++ wiki-information/functions/GetCurrencyInfo.md | 35 +++ wiki-information/functions/GetCurrencyLink.md | 18 ++ .../functions/GetCurrencyListInfo.md | 41 ++++ .../functions/GetCurrencyListSize.md | 13 + .../functions/GetCurrentBindingSet.md | 16 ++ .../GetCurrentCombatTextEventInfo.md | 11 + .../functions/GetCurrentEventID.md | 9 + .../functions/GetCurrentGraphicsAPI.md | 12 + .../functions/GetCurrentRegion.md | 38 +++ .../functions/GetCurrentRegionName.md | 15 ++ .../functions/GetCurrentResolution.md | 21 ++ wiki-information/functions/GetCurrentTitle.md | 9 + wiki-information/functions/GetCursorDelta.md | 15 ++ wiki-information/functions/GetCursorInfo.md | 49 ++++ wiki-information/functions/GetCursorMoney.md | 9 + .../functions/GetCursorPosition.md | 29 +++ .../functions/GetDeathRecapLink.md | 17 ++ .../functions/GetDefaultLanguage.md | 15 ++ wiki-information/functions/GetDefaultScale.md | 18 ++ .../functions/GetDetailedItemLevelInfo.md | 30 +++ .../functions/GetDifficultyInfo.md | 37 +++ wiki-information/functions/GetDodgeChance.md | 16 ++ .../functions/GetDodgeChanceFromAttribute.md | 9 + .../functions/GetDownloadedPercentage.md | 9 + .../functions/GetDungeonDifficultyID.md | 15 ++ .../functions/GetEditBoxMetatable.md | 12 + wiki-information/functions/GetEventTime.md | 19 ++ .../functions/GetExpansionDisplayInfo.md | 64 +++++ .../functions/GetExpansionLevel.md | 53 ++++ .../functions/GetExpansionTrialInfo.md | 11 + wiki-information/functions/GetExpertise.md | 19 ++ .../functions/GetExpertisePercent.md | 14 ++ wiki-information/functions/GetFactionInfo.md | 104 ++++++++ .../functions/GetFactionInfoByID.md | 103 ++++++++ .../functions/GetFileIDFromPath.md | 27 +++ .../functions/GetFileStreamingStatus.md | 9 + .../functions/GetFirstBagBankSlotIndex.md | 12 + .../functions/GetFirstTradeSkill.md | 12 + wiki-information/functions/GetFontInfo.md | 52 ++++ .../functions/GetFontStringMetatable.md | 12 + wiki-information/functions/GetFonts.md | 16 ++ .../functions/GetFrameCPUUsage.md | 24 ++ .../functions/GetFrameMetatable.md | 12 + wiki-information/functions/GetFramerate.md | 20 ++ .../functions/GetFramesRegisteredForEvent.md | 35 +++ .../functions/GetFunctionCPUUsage.md | 20 ++ wiki-information/functions/GetGameTime.md | 44 ++++ wiki-information/functions/GetGlyphLink.md | 31 +++ .../functions/GetGlyphSocketInfo.md | 23 ++ .../functions/GetGossipActiveQuests.md | 30 +++ .../functions/GetGossipAvailableQuests.md | 33 +++ .../functions/GetGossipOptions.md | 14 ++ wiki-information/functions/GetGossipText.md | 18 ++ wiki-information/functions/GetGraphicsAPIs.md | 24 ++ .../functions/GetGuildBankItemInfo.md | 23 ++ .../functions/GetGuildBankItemLink.md | 15 ++ .../functions/GetGuildBankMoney.md | 21 ++ .../functions/GetGuildBankTabInfo.md | 28 +++ .../functions/GetGuildBankTabPermissions.md | 37 +++ .../functions/GetGuildBankTransaction.md | 33 +++ .../GetGuildBankWithdrawGoldLimit.md | 33 +++ .../functions/GetGuildBankWithdrawMoney.md | 12 + wiki-information/functions/GetGuildInfo.md | 36 +++ .../functions/GetGuildRosterInfo.md | 58 +++++ .../functions/GetGuildRosterLastOnline.md | 39 +++ .../functions/GetGuildRosterMOTD.md | 9 + .../functions/GetGuildRosterShowOffline.md | 9 + .../functions/GetGuildTabardFiles.md | 19 ++ wiki-information/functions/GetHaste.md | 17 ++ wiki-information/functions/GetHitModifier.md | 18 ++ .../functions/GetHomePartyInfo.md | 13 + .../functions/GetInboxHeaderInfo.md | 41 ++++ .../functions/GetInboxInvoiceInfo.md | 28 +++ wiki-information/functions/GetInboxItem.md | 54 +++++ .../functions/GetInboxItemLink.md | 36 +++ .../functions/GetInboxNumItems.md | 17 ++ .../functions/GetInspectArenaData.md | 25 ++ .../functions/GetInspectHonorData.md | 22 ++ .../functions/GetInspectPVPRankProgress.md | 13 + .../functions/GetInstanceBootTimeRemaining.md | 9 + wiki-information/functions/GetInstanceInfo.md | 30 +++ .../functions/GetInstanceLockTimeRemaining.md | 23 ++ .../GetInstanceLockTimeRemainingEncounter.md | 21 ++ .../functions/GetInventoryAlertStatus.md | 27 +++ .../functions/GetInventoryItemBroken.md | 15 ++ .../functions/GetInventoryItemCooldown.md | 19 ++ .../functions/GetInventoryItemCount.md | 30 +++ .../functions/GetInventoryItemDurability.md | 19 ++ .../functions/GetInventoryItemGems.md | 13 + .../functions/GetInventoryItemID.md | 29 +++ .../functions/GetInventoryItemLink.md | 24 ++ .../functions/GetInventoryItemQuality.md | 15 ++ .../functions/GetInventoryItemTexture.md | 15 ++ .../functions/GetInventoryItemsForSlot.md | 72 ++++++ .../functions/GetInventorySlotInfo.md | 31 +++ .../functions/GetInviteConfirmationInfo.md | 38 +++ .../functions/GetInviteReferralInfo.md | 36 +++ .../functions/GetItemClassInfo.md | 29 +++ wiki-information/functions/GetItemCooldown.md | 54 +++++ wiki-information/functions/GetItemCount.md | 36 +++ wiki-information/functions/GetItemFamily.md | 90 +++++++ wiki-information/functions/GetItemGem.md | 27 +++ wiki-information/functions/GetItemIcon.md | 16 ++ wiki-information/functions/GetItemInfo.md | 86 +++++++ .../functions/GetItemInfoInstant.md | 45 ++++ .../functions/GetItemQualityColor.md | 49 ++++ wiki-information/functions/GetItemSpecInfo.md | 23 ++ wiki-information/functions/GetItemSpell.md | 25 ++ wiki-information/functions/GetItemStats.md | 43 ++++ .../functions/GetItemSubClassInfo.md | 50 ++++ .../functions/GetLFGBootProposal.md | 32 +++ .../functions/GetLFGDeserterExpiration.md | 27 +++ .../functions/GetLFGDungeonEncounterInfo.md | 31 +++ .../functions/GetLFGDungeonInfo.md | 63 +++++ .../functions/GetLFGDungeonNumEncounters.md | 20 ++ .../GetLFGDungeonRewardCapBarInfo.md | 32 +++ wiki-information/functions/GetLFGRoles.md | 15 ++ .../functions/GetLanguageByIndex.md | 74 ++++++ .../functions/GetLatestThreeSenders.md | 9 + wiki-information/functions/GetLocale.md | 35 +++ wiki-information/functions/GetLootInfo.md | 30 +++ wiki-information/functions/GetLootMethod.md | 13 + .../functions/GetLootRollItemInfo.md | 48 ++++ .../functions/GetLootRollItemLink.md | 19 ++ wiki-information/functions/GetLootSlotInfo.md | 38 +++ wiki-information/functions/GetLootSlotLink.md | 29 +++ wiki-information/functions/GetLootSlotType.md | 34 +++ .../functions/GetLootSourceInfo.md | 37 +++ .../functions/GetLootThreshold.md | 15 ++ wiki-information/functions/GetMacroBody.md | 25 ++ .../functions/GetMacroIndexByName.md | 19 ++ wiki-information/functions/GetMacroInfo.md | 17 ++ wiki-information/functions/GetMacroSpell.md | 33 +++ wiki-information/functions/GetManaRegen.md | 14 ++ .../functions/GetMasterLootCandidate.md | 22 ++ .../functions/GetMaxBattlefieldID.md | 12 + .../functions/GetMaxLevelForExpansionLevel.md | 44 ++++ .../functions/GetMaximumExpansionLevel.md | 35 +++ wiki-information/functions/GetMeleeHaste.md | 17 ++ .../functions/GetMerchantItemCostInfo.md | 20 ++ .../functions/GetMerchantItemCostItem.md | 24 ++ .../functions/GetMerchantItemID.md | 19 ++ .../functions/GetMerchantItemInfo.md | 46 ++++ .../functions/GetMerchantItemLink.md | 19 ++ .../functions/GetMerchantItemMaxStack.md | 13 + .../functions/GetMerchantNumItems.md | 12 + .../functions/GetMinimapZoneText.md | 16 ++ .../functions/GetMinimumExpansionLevel.md | 50 ++++ .../functions/GetMirrorTimerInfo.md | 32 +++ .../functions/GetMirrorTimerProgress.md | 16 ++ .../functions/GetModifiedClick.md | 35 +++ wiki-information/functions/GetMoney.md | 50 ++++ .../functions/GetMouseButtonClicked.md | 13 + wiki-information/functions/GetMouseFocus.md | 18 ++ .../functions/GetMultiCastTotemSpells.md | 50 ++++ wiki-information/functions/GetNetStats.md | 26 ++ .../functions/GetNextAchievement.md | 13 + .../functions/GetNextStableSlotCost.md | 9 + .../functions/GetNormalizedRealmName.md | 37 +++ .../functions/GetNumActiveQuests.md | 15 ++ wiki-information/functions/GetNumAddOns.md | 23 ++ .../functions/GetNumAuctionItems.md | 32 +++ .../functions/GetNumAvailableQuests.md | 15 ++ wiki-information/functions/GetNumBankSlots.md | 14 ++ .../functions/GetNumBattlefieldStats.md | 9 + .../functions/GetNumBattlefields.md | 15 ++ .../functions/GetNumBattlegroundTypes.md | 12 + wiki-information/functions/GetNumBindings.md | 9 + .../functions/GetNumBuybackItems.md | 12 + wiki-information/functions/GetNumClasses.md | 12 + .../functions/GetNumCompanions.md | 20 ++ .../GetNumComparisonCompletedAchievements.md | 25 ++ .../functions/GetNumCompletedAchievements.md | 18 ++ wiki-information/functions/GetNumCrafts.md | 18 ++ .../functions/GetNumDeclensionSets.md | 20 ++ .../functions/GetNumExpansions.md | 9 + wiki-information/functions/GetNumFactions.md | 9 + .../functions/GetNumFlexRaidDungeons.md | 15 ++ wiki-information/functions/GetNumFrames.md | 12 + .../functions/GetNumGlyphSockets.md | 13 + .../functions/GetNumGossipActiveQuests.md | 16 ++ .../functions/GetNumGossipAvailableQuests.md | 16 ++ .../functions/GetNumGossipOptions.md | 16 ++ .../functions/GetNumGroupMembers.md | 26 ++ .../functions/GetNumGuildMembers.md | 40 +++ wiki-information/functions/GetNumLanguages.md | 20 ++ wiki-information/functions/GetNumLootItems.md | 9 + wiki-information/functions/GetNumMacros.md | 11 + .../functions/GetNumPetitionNames.md | 9 + .../functions/GetNumQuestChoices.md | 14 ++ .../functions/GetNumQuestItems.md | 9 + .../functions/GetNumQuestLeaderBoards.md | 16 ++ .../functions/GetNumQuestLogChoices.md | 15 ++ .../functions/GetNumQuestLogEntries.md | 24 ++ .../functions/GetNumQuestLogRewards.md | 12 + .../functions/GetNumQuestRewards.md | 14 ++ .../functions/GetNumQuestWatches.md | 9 + .../functions/GetNumRewardCurrencies.md | 15 ++ .../functions/GetNumSavedInstances.md | 18 ++ .../functions/GetNumSkillLines.md | 28 +++ wiki-information/functions/GetNumSockets.md | 22 ++ wiki-information/functions/GetNumSpellTabs.md | 12 + .../functions/GetNumStableSlots.md | 9 + .../functions/GetNumSubgroupMembers.md | 26 ++ .../functions/GetNumTalentGroups.md | 19 ++ .../functions/GetNumTalentTabs.md | 13 + wiki-information/functions/GetNumTalents.md | 17 ++ wiki-information/functions/GetNumTitles.md | 9 + .../functions/GetNumTrackedAchievements.md | 20 ++ .../functions/GetNumTradeSkills.md | 15 ++ wiki-information/functions/GetOSLocale.md | 25 ++ .../functions/GetObjectIconTextureCoords.md | 22 ++ wiki-information/functions/GetOptOutOfLoot.md | 12 + .../functions/GetOwnerAuctionItems.md | 12 + wiki-information/functions/GetPVPDesired.md | 9 + .../functions/GetPVPLastWeekStats.md | 15 ++ .../functions/GetPVPLifetimeStats.md | 19 ++ wiki-information/functions/GetPVPRankInfo.md | 41 ++++ .../functions/GetPVPRankProgress.md | 9 + wiki-information/functions/GetPVPRoles.md | 17 ++ .../functions/GetPVPSessionStats.md | 21 ++ .../functions/GetPVPThisWeekStats.md | 11 + wiki-information/functions/GetPVPTimer.md | 29 +++ .../functions/GetPVPYesterdayStats.md | 11 + wiki-information/functions/GetParryChance.md | 16 ++ .../functions/GetParryChanceFromAttribute.md | 9 + .../functions/GetPartyAssignment.md | 31 +++ .../functions/GetPersonalRatedInfo.md | 36 +++ .../functions/GetPetActionCooldown.md | 32 +++ .../functions/GetPetActionInfo.md | 32 +++ .../functions/GetPetActionSlotUsable.md | 13 + .../functions/GetPetExperience.md | 21 ++ wiki-information/functions/GetPetFoodTypes.md | 29 +++ wiki-information/functions/GetPetHappiness.md | 33 +++ wiki-information/functions/GetPetLoyalty.md | 9 + .../functions/GetPetSpellBonusDamage.md | 9 + .../functions/GetPetTrainingPoints.md | 11 + wiki-information/functions/GetPetitionInfo.md | 24 ++ .../functions/GetPhysicalScreenSize.md | 11 + wiki-information/functions/GetPlayerFacing.md | 12 + .../functions/GetPlayerInfoByGUID.md | 36 +++ wiki-information/functions/GetPossessInfo.md | 24 ++ .../functions/GetPreviousAchievement.md | 13 + .../functions/GetProfessionInfo.md | 34 +++ .../functions/GetQuestBackgroundMaterial.md | 12 + .../functions/GetQuestCurrencyInfo.md | 48 ++++ .../functions/GetQuestFactionGroup.md | 20 ++ .../functions/GetQuestGreenRange.md | 13 + wiki-information/functions/GetQuestID.md | 16 ++ .../functions/GetQuestIndexForTimer.md | 13 + .../functions/GetQuestIndexForWatch.md | 16 ++ .../functions/GetQuestItemInfo.md | 45 ++++ .../functions/GetQuestItemLink.md | 29 +++ wiki-information/functions/GetQuestLink.md | 14 ++ .../functions/GetQuestLogGroupNum.md | 9 + .../functions/GetQuestLogIndexByID.md | 21 ++ .../functions/GetQuestLogItemLink.md | 23 ++ .../functions/GetQuestLogLeaderBoard.md | 39 +++ .../functions/GetQuestLogPushable.md | 32 +++ .../functions/GetQuestLogQuestText.md | 15 ++ .../functions/GetQuestLogRequiredMoney.md | 19 ++ .../GetQuestLogRewardCurrencyInfo.md | 53 ++++ .../functions/GetQuestLogRewardInfo.md | 31 +++ .../functions/GetQuestLogRewardMoney.md | 17 ++ .../functions/GetQuestLogRewardSpell.md | 34 +++ .../GetQuestLogSpecialItemCooldown.md | 17 ++ .../functions/GetQuestLogSpecialItemInfo.md | 19 ++ .../functions/GetQuestLogTimeLeft.md | 9 + .../functions/GetQuestLogTitle.md | 61 +++++ .../functions/GetQuestResetTime.md | 30 +++ wiki-information/functions/GetQuestReward.md | 12 + .../functions/GetQuestSortIndex.md | 17 ++ wiki-information/functions/GetQuestTagInfo.md | 52 ++++ wiki-information/functions/GetQuestTimers.md | 37 +++ .../functions/GetQuestsCompleted.md | 63 +++++ .../functions/GetRFDungeonInfo.md | 70 ++++++ .../functions/GetRaidDifficultyID.md | 16 ++ .../functions/GetRaidRosterInfo.md | 40 +++ .../functions/GetRaidTargetIndex.md | 42 ++++ .../functions/GetRangedCritChance.md | 12 + wiki-information/functions/GetRangedHaste.md | 16 ++ wiki-information/functions/GetRealZoneText.md | 29 +++ wiki-information/functions/GetRealmID.md | 15 ++ wiki-information/functions/GetRealmName.md | 37 +++ .../functions/GetRepairAllCost.md | 16 ++ wiki-information/functions/GetRestState.md | 31 +++ .../functions/GetRestrictedAccountData.md | 16 ++ wiki-information/functions/GetRewardSpell.md | 15 ++ wiki-information/functions/GetRewardXP.md | 16 ++ wiki-information/functions/GetRuneCooldown.md | 30 +++ wiki-information/functions/GetRuneType.md | 19 ++ .../functions/GetSavedInstanceChatLink.md | 34 +++ .../GetSavedInstanceEncounterInfo.md | 32 +++ .../functions/GetSavedInstanceInfo.md | 47 ++++ .../functions/GetScenariosChoiceOrder.md | 17 ++ wiki-information/functions/GetSchoolString.md | 13 + .../functions/GetScreenDPIScale.md | 9 + wiki-information/functions/GetScreenHeight.md | 21 ++ .../functions/GetScreenResolutions.md | 41 ++++ wiki-information/functions/GetScreenWidth.md | 15 ++ .../GetSecondsUntilParentalControlsKick.md | 9 + .../functions/GetSelectedBattlefield.md | 9 + .../functions/GetSelectedSkill.md | 9 + .../functions/GetSelectedStablePet.md | 9 + wiki-information/functions/GetSendMailCOD.md | 12 + wiki-information/functions/GetSendMailItem.md | 43 ++++ .../functions/GetSendMailItemLink.md | 32 +++ .../functions/GetSendMailPrice.md | 9 + .../functions/GetServerExpansionLevel.md | 55 +++++ wiki-information/functions/GetServerTime.md | 31 +++ wiki-information/functions/GetSessionTime.md | 17 ++ .../functions/GetShapeshiftForm.md | 37 +++ .../functions/GetShapeshiftFormCooldown.md | 28 +++ .../functions/GetShapeshiftFormID.md | 38 +++ .../functions/GetShapeshiftFormInfo.md | 22 ++ wiki-information/functions/GetSheathState.md | 20 ++ wiki-information/functions/GetShieldBlock.md | 21 ++ .../functions/GetSkillLineInfo.md | 45 ++++ .../functions/GetSocketItemBoundTradeable.md | 16 ++ .../functions/GetSocketItemInfo.md | 29 +++ .../functions/GetSocketItemRefundable.md | 16 ++ wiki-information/functions/GetSocketTypes.md | 28 +++ .../functions/GetSoundEntryCount.md | 16 ++ .../functions/GetSpellAutocast.md | 33 +++ .../functions/GetSpellBaseCooldown.md | 21 ++ .../functions/GetSpellBonusDamage.md | 20 ++ .../functions/GetSpellBonusHealing.md | 9 + .../functions/GetSpellBookItemInfo.md | 65 +++++ .../functions/GetSpellBookItemName.md | 85 +++++++ .../functions/GetSpellBookItemTexture.md | 31 +++ wiki-information/functions/GetSpellCharges.md | 44 ++++ .../functions/GetSpellCooldown.md | 61 +++++ wiki-information/functions/GetSpellCount.md | 27 +++ .../functions/GetSpellCritChance.md | 40 +++ .../functions/GetSpellDescription.md | 25 ++ .../functions/GetSpellHitModifier.md | 16 ++ wiki-information/functions/GetSpellInfo.md | 64 +++++ wiki-information/functions/GetSpellLink.md | 45 ++++ .../GetSpellLossOfControlCooldown.md | 29 +++ .../functions/GetSpellPenetration.md | 9 + .../functions/GetSpellPowerCost.md | 58 +++++ wiki-information/functions/GetSpellTabInfo.md | 74 ++++++ wiki-information/functions/GetSpellTexture.md | 31 +++ .../functions/GetStablePetFoodTypes.md | 22 ++ .../functions/GetStablePetInfo.md | 21 ++ wiki-information/functions/GetStatistic.md | 42 ++++ .../functions/GetStatisticsCategoryList.md | 19 ++ wiki-information/functions/GetSubZoneText.md | 19 ++ .../functions/GetSuggestedGroupNum.md | 13 + .../functions/GetSummonFriendCooldown.md | 19 ++ .../functions/GetSuperTrackedQuestID.md | 9 + .../functions/GetTalentGroupRole.md | 19 ++ wiki-information/functions/GetTalentInfo.md | 72 ++++++ .../functions/GetTalentPrereqs.md | 29 +++ .../functions/GetTalentTabInfo.md | 31 +++ .../functions/GetTaxiBenchmarkMode.md | 9 + wiki-information/functions/GetTaxiMapID.md | 9 + wiki-information/functions/GetText.md | 30 +++ .../functions/GetThreatStatusColor.md | 50 ++++ wiki-information/functions/GetTickTime.md | 13 + wiki-information/functions/GetTime.md | 19 ++ .../functions/GetTimePreciseSec.md | 28 +++ wiki-information/functions/GetTitleName.md | 26 ++ wiki-information/functions/GetTitleText.md | 12 + .../functions/GetTotalAchievementPoints.md | 9 + .../functions/GetTotemCannotDismiss.md | 13 + .../functions/GetTotemTimeLeft.md | 24 ++ .../functions/GetTrackedAchievements.md | 17 ++ wiki-information/functions/GetTrackingInfo.md | 40 +++ .../functions/GetTrackingTexture.md | 9 + .../functions/GetTradePlayerItemInfo.md | 23 ++ .../functions/GetTradeSkillDescription.md | 13 + .../functions/GetTradeSkillInfo.md | 49 ++++ .../functions/GetTradeSkillInvSlotFilter.md | 11 + .../functions/GetTradeSkillItemLink.md | 27 +++ .../functions/GetTradeSkillItemStats.md | 47 ++++ .../functions/GetTradeSkillLine.md | 19 ++ .../functions/GetTradeSkillListLink.md | 9 + .../functions/GetTradeSkillNumMade.md | 15 ++ .../functions/GetTradeSkillNumReagents.md | 31 +++ .../functions/GetTradeSkillReagentInfo.md | 35 +++ .../functions/GetTradeSkillReagentItemLink.md | 18 ++ .../functions/GetTradeSkillRecipeLink.md | 28 +++ .../functions/GetTradeSkillSelectionIndex.md | 20 ++ .../functions/GetTradeSkillSubClassFilter.md | 11 + .../functions/GetTradeTargetItemInfo.md | 29 +++ .../functions/GetTradeskillRepeatCount.md | 12 + .../functions/GetTrainerServiceAbilityReq.md | 17 ++ .../functions/GetTrainerServiceDescription.md | 20 ++ .../functions/GetTrainerServiceItemLink.md | 16 ++ .../functions/GetTrainerServiceLevelReq.md | 13 + .../functions/GetTrainerServiceSkillLine.md | 13 + .../functions/GetTrainerServiceSkillReq.md | 31 +++ .../functions/GetTrainerServiceTypeFilter.md | 16 ++ wiki-information/functions/GetUICameraInfo.md | 31 +++ .../functions/GetUnitHealthModifier.md | 19 ++ .../functions/GetUnitMaxHealthModifier.md | 26 ++ .../functions/GetUnitPowerModifier.md | 19 ++ wiki-information/functions/GetUnitSpeed.md | 29 +++ .../functions/GetUnspentTalentPoints.md | 27 +++ .../functions/GetVehicleUIIndicator.md | 24 ++ .../functions/GetVehicleUIIndicatorSeat.md | 19 ++ .../functions/GetWatchedFactionInfo.md | 19 ++ .../functions/GetWeaponEnchantInfo.md | 34 +++ wiki-information/functions/GetWebTicket.md | 8 + wiki-information/functions/GetXPExhaustion.md | 12 + wiki-information/functions/GetZonePVPInfo.md | 39 +++ wiki-information/functions/GetZoneText.md | 25 ++ .../functions/GuildControlDelRank.md | 16 ++ .../functions/GuildControlGetRankFlags.md | 59 +++++ .../functions/GuildControlGetRankName.md | 16 ++ .../functions/GuildControlSaveRank.md | 13 + .../functions/GuildControlSetRank.md | 12 + .../functions/GuildControlSetRankFlag.md | 86 +++++++ wiki-information/functions/GuildDemote.md | 9 + wiki-information/functions/GuildDisband.md | 9 + wiki-information/functions/GuildInvite.md | 9 + wiki-information/functions/GuildPromote.md | 9 + .../functions/GuildRosterSetOfficerNote.md | 28 +++ .../functions/GuildRosterSetPublicNote.md | 22 ++ wiki-information/functions/GuildSetLeader.md | 12 + wiki-information/functions/GuildSetMOTD.md | 17 ++ wiki-information/functions/GuildUninvite.md | 9 + wiki-information/functions/HasAction.md | 15 ++ .../functions/HasDualWieldPenalty.md | 9 + wiki-information/functions/HasFullControl.md | 9 + .../functions/HasIgnoreDualWieldWeapon.md | 9 + .../functions/HasInspectHonorData.md | 9 + wiki-information/functions/HasKey.md | 9 + .../functions/HasLFGRestrictions.md | 13 + .../functions/HasNoReleaseAura.md | 13 + wiki-information/functions/HasPetSpells.md | 14 ++ wiki-information/functions/HasPetUI.md | 29 +++ wiki-information/functions/HasWandEquipped.md | 8 + .../functions/InActiveBattlefield.md | 13 + wiki-information/functions/InCinematic.md | 25 ++ .../functions/InCombatLockdown.md | 27 +++ wiki-information/functions/InRepairMode.md | 9 + .../functions/InboxItemCanDelete.md | 18 ++ .../functions/InitiateRolePoll.md | 23 ++ wiki-information/functions/InitiateTrade.md | 28 +++ wiki-information/functions/InviteUnit.md | 16 ++ wiki-information/functions/Is64BitClient.md | 24 ++ .../functions/IsAccountSecured.md | 12 + .../functions/IsAchievementEligible.md | 16 ++ wiki-information/functions/IsActionInRange.md | 25 ++ .../functions/IsActiveBattlefieldArena.md | 14 ++ .../functions/IsAddOnLoadOnDemand.md | 23 ++ wiki-information/functions/IsAddOnLoaded.md | 15 ++ .../functions/IsAllowedToUserTeleport.md | 15 ++ wiki-information/functions/IsAltKeyDown.md | 30 +++ wiki-information/functions/IsAttackAction.md | 13 + wiki-information/functions/IsAttackSpell.md | 13 + .../functions/IsAutoRepeatAction.md | 22 ++ wiki-information/functions/IsBattlePayItem.md | 15 ++ .../functions/IsCemeterySelectionAvailable.md | 9 + .../functions/IsConsumableAction.md | 20 ++ .../functions/IsConsumableItem.md | 13 + .../functions/IsControlKeyDown.md | 31 +++ wiki-information/functions/IsCurrentAction.md | 19 ++ wiki-information/functions/IsCurrentSpell.md | 14 ++ wiki-information/functions/IsDebugBuild.md | 9 + wiki-information/functions/IsDualWielding.md | 9 + .../functions/IsEquippableItem.md | 36 +++ .../functions/IsEquippedAction.md | 13 + wiki-information/functions/IsEquippedItem.md | 15 ++ .../functions/IsEquippedItemType.md | 22 ++ .../functions/IsEuropeanNumbers.md | 9 + .../functions/IsExpansionTrial.md | 15 ++ .../functions/IsFactionInactive.md | 17 ++ wiki-information/functions/IsFalling.md | 13 + wiki-information/functions/IsFishingLoot.md | 20 ++ wiki-information/functions/IsFlyableArea.md | 16 ++ wiki-information/functions/IsFlying.md | 13 + wiki-information/functions/IsGMClient.md | 9 + wiki-information/functions/IsGUIDInGroup.md | 28 +++ wiki-information/functions/IsGuildLeader.md | 9 + .../functions/IsInCinematicScene.md | 25 ++ wiki-information/functions/IsInGroup.md | 24 ++ wiki-information/functions/IsInGuild.md | 22 ++ wiki-information/functions/IsInGuildGroup.md | 12 + wiki-information/functions/IsInInstance.md | 20 ++ wiki-information/functions/IsInLFGDungeon.md | 9 + wiki-information/functions/IsInRaid.md | 18 ++ wiki-information/functions/IsIndoors.md | 15 ++ wiki-information/functions/IsItemInRange.md | 22 ++ .../functions/IsLeftAltKeyDown.md | 36 +++ .../functions/IsLeftControlKeyDown.md | 45 ++++ .../functions/IsLeftShiftKeyDown.md | 30 +++ wiki-information/functions/IsMacClient.md | 9 + wiki-information/functions/IsMetaKeyDown.md | 9 + wiki-information/functions/IsModifiedClick.md | 36 +++ .../functions/IsModifierKeyDown.md | 36 +++ wiki-information/functions/IsMounted.md | 9 + .../functions/IsMouseButtonDown.md | 14 ++ wiki-information/functions/IsMouselooking.md | 12 + wiki-information/functions/IsMovieLocal.md | 13 + wiki-information/functions/IsMoviePlayable.md | 26 ++ wiki-information/functions/IsOnGlueScreen.md | 12 + .../functions/IsOnTournamentRealm.md | 9 + wiki-information/functions/IsOutOfBounds.md | 12 + wiki-information/functions/IsOutdoors.md | 15 ++ .../functions/IsPVPTimerRunning.md | 9 + wiki-information/functions/IsPassiveSpell.md | 27 +++ .../functions/IsPetAttackActive.md | 9 + .../functions/IsPlayerAttacking.md | 19 ++ .../functions/IsPlayerInGuildFromGUID.md | 13 + wiki-information/functions/IsPlayerInWorld.md | 9 + wiki-information/functions/IsPlayerMoving.md | 9 + wiki-information/functions/IsPlayerSpell.md | 32 +++ wiki-information/functions/IsPublicBuild.md | 9 + .../functions/IsQuestCompletable.md | 15 ++ wiki-information/functions/IsQuestComplete.md | 21 ++ .../functions/IsQuestHardWatched.md | 20 ++ wiki-information/functions/IsQuestWatched.md | 20 ++ wiki-information/functions/IsRangedWeapon.md | 9 + .../functions/IsRecognizedName.md | 51 ++++ .../functions/IsReferAFriendLinked.md | 39 +++ wiki-information/functions/IsResting.md | 17 ++ .../functions/IsRestrictedAccount.md | 9 + .../functions/IsRightAltKeyDown.md | 45 ++++ .../functions/IsRightControlKeyDown.md | 39 +++ .../functions/IsRightMetaKeyDown.md | 9 + .../functions/IsRightShiftKeyDown.md | 45 ++++ wiki-information/functions/IsShiftKeyDown.md | 37 +++ wiki-information/functions/IsSpellInRange.md | 46 ++++ wiki-information/functions/IsSpellKnown.md | 23 ++ wiki-information/functions/IsStealthed.md | 16 ++ wiki-information/functions/IsSubmerged.md | 17 ++ wiki-information/functions/IsSwimming.md | 18 ++ wiki-information/functions/IsTargetLoose.md | 9 + .../functions/IsThreatWarningEnabled.md | 15 ++ wiki-information/functions/IsTitleKnown.md | 13 + .../functions/IsTrackedAchievement.md | 13 + .../functions/IsTradeskillTrainer.md | 21 ++ .../functions/IsTrainerServiceLearnSpell.md | 18 ++ wiki-information/functions/IsTrialAccount.md | 9 + .../functions/IsUnitOnQuestByQuestID.md | 21 ++ wiki-information/functions/IsUsableAction.md | 15 ++ wiki-information/functions/IsUsableSpell.md | 53 ++++ .../functions/IsUsingFixedTimeStep.md | 9 + wiki-information/functions/IsUsingGamepad.md | 9 + wiki-information/functions/IsUsingMouse.md | 9 + .../functions/IsVeteranTrialAccount.md | 9 + wiki-information/functions/IsWargame.md | 9 + .../functions/IsXPUserDisabled.md | 9 + .../functions/ItemTextGetCreator.md | 12 + wiki-information/functions/ItemTextGetItem.md | 12 + .../functions/ItemTextGetMaterial.md | 13 + wiki-information/functions/ItemTextGetPage.md | 13 + wiki-information/functions/ItemTextGetText.md | 12 + .../functions/ItemTextHasNextPage.md | 12 + .../functions/ItemTextNextPage.md | 10 + .../functions/ItemTextPrevPage.md | 10 + wiki-information/functions/JoinBattlefield.md | 42 ++++ .../functions/JoinChannelByName.md | 32 +++ .../functions/JoinPermanentChannel.md | 33 +++ wiki-information/functions/JoinSkirmish.md | 16 ++ .../functions/JoinTemporaryChannel.md | 33 +++ .../functions/JumpOrAscendStart.md | 8 + .../functions/KBArticle_BeginLoading.md | 31 +++ .../functions/KBArticle_GetData.md | 27 +++ .../functions/KBArticle_IsLoaded.md | 12 + .../functions/KBSetup_BeginLoading.md | 26 ++ .../KBSetup_GetArticleHeaderCount.md | 23 ++ .../functions/KBSetup_GetArticleHeaderData.md | 30 +++ .../functions/KBSetup_GetCategoryCount.md | 15 ++ .../functions/KBSetup_GetCategoryData.md | 18 ++ .../functions/KBSetup_GetLanguageCount.md | 16 ++ .../functions/KBSetup_GetLanguageData.md | 18 ++ .../functions/KBSetup_GetSubCategoryCount.md | 16 ++ .../functions/KBSetup_GetSubCategoryData.md | 22 ++ .../functions/KBSetup_GetTotalArticleCount.md | 23 ++ .../functions/KBSetup_IsLoaded.md | 23 ++ .../functions/KBSystem_GetMOTD.md | 12 + .../functions/KBSystem_GetServerNotice.md | 12 + .../functions/KBSystem_GetServerStatus.md | 15 ++ .../functions/KeyRingButtonIDToInvSlotID.md | 13 + wiki-information/functions/LFGTeleport.md | 18 ++ wiki-information/functions/LearnTalent.md | 22 ++ .../functions/LeaveChannelByName.md | 20 ++ .../functions/ListChannelByName.md | 9 + wiki-information/functions/LoadAddOn.md | 81 +++++++ wiki-information/functions/LoadBindings.md | 18 ++ wiki-information/functions/LoadURLIndex.md | 11 + wiki-information/functions/LoggingChat.md | 30 +++ wiki-information/functions/LoggingCombat.md | 42 ++++ wiki-information/functions/Logout.md | 10 + wiki-information/functions/LootSlot.md | 25 ++ wiki-information/functions/LootSlotHasItem.md | 37 +++ wiki-information/functions/MouselookStart.md | 9 + wiki-information/functions/MouselookStop.md | 9 + .../functions/MoveBackwardStart.md | 12 + .../functions/MoveBackwardStop.md | 12 + .../functions/MoveForwardStart.md | 12 + wiki-information/functions/MoveForwardStop.md | 12 + .../functions/MoveViewDownStart.md | 24 ++ .../functions/MoveViewDownStop.md | 8 + wiki-information/functions/MoveViewInStart.md | 24 ++ wiki-information/functions/MoveViewInStop.md | 8 + .../functions/MoveViewLeftStart.md | 24 ++ .../functions/MoveViewLeftStop.md | 8 + .../functions/MoveViewOutStart.md | 24 ++ wiki-information/functions/MoveViewOutStop.md | 8 + .../functions/MoveViewRightStart.md | 24 ++ .../functions/MoveViewRightStop.md | 14 ++ wiki-information/functions/MoveViewUpStart.md | 24 ++ wiki-information/functions/MoveViewUpStop.md | 14 ++ wiki-information/functions/MuteSoundFile.md | 53 ++++ wiki-information/functions/NoPlayTime.md | 26 ++ .../functions/NotWhileDeadError.md | 8 + wiki-information/functions/NotifyInspect.md | 17 ++ wiki-information/functions/NumTaxiNodes.md | 17 ++ wiki-information/functions/OfferPetition.md | 19 ++ wiki-information/functions/PartialPlayTime.md | 32 +++ wiki-information/functions/PetAbandon.md | 9 + .../functions/PetAggressiveMode.md | 11 + wiki-information/functions/PetAttack.md | 5 + .../functions/PetCanBeAbandoned.md | 22 ++ wiki-information/functions/PetCanBeRenamed.md | 16 ++ .../functions/PetDefensiveMode.md | 17 ++ wiki-information/functions/PetFollow.md | 11 + wiki-information/functions/PetPassiveMode.md | 11 + wiki-information/functions/PetRename.md | 13 + wiki-information/functions/PetStopAttack.md | 11 + wiki-information/functions/PetWait.md | 14 ++ wiki-information/functions/PickupAction.md | 16 ++ .../functions/PickupBagFromSlot.md | 13 + wiki-information/functions/PickupCompanion.md | 19 ++ .../functions/PickupContainerItem.md | 67 +++++ wiki-information/functions/PickupCurrency.md | 9 + .../functions/PickupInventoryItem.md | 22 ++ wiki-information/functions/PickupItem.md | 32 +++ wiki-information/functions/PickupMacro.md | 21 ++ .../functions/PickupMerchantItem.md | 17 ++ wiki-information/functions/PickupPetAction.md | 12 + wiki-information/functions/PickupPetSpell.md | 21 ++ .../functions/PickupPlayerMoney.md | 13 + wiki-information/functions/PickupSpell.md | 36 +++ .../functions/PickupSpellBookItem.md | 37 +++ wiki-information/functions/PickupStablePet.md | 9 + .../functions/PickupTradeMoney.md | 14 ++ wiki-information/functions/PlaceAction.md | 16 ++ wiki-information/functions/PlayMusic.md | 28 +++ wiki-information/functions/PlaySound.md | 76 ++++++ wiki-information/functions/PlaySoundFile.md | 72 ++++++ .../functions/PlayerCanTeleport.md | 9 + .../functions/PlayerEffectiveAttackPower.md | 13 + wiki-information/functions/PlayerHasToy.md | 26 ++ .../functions/PlayerIsPVPInactive.md | 19 ++ wiki-information/functions/PostAuction.md | 26 ++ wiki-information/functions/PreloadMovie.md | 9 + .../functions/ProcessExceptionClient.md | 13 + wiki-information/functions/PromoteToLeader.md | 24 ++ .../functions/PutItemInBackpack.md | 14 ++ wiki-information/functions/PutItemInBag.md | 22 ++ .../functions/QueryAuctionItems.md | 52 ++++ .../functions/QuestChooseRewardError.md | 8 + wiki-information/functions/QuestIsDaily.md | 18 ++ .../functions/QuestLogPushQuest.md | 42 ++++ .../functions/QuestPOIGetIconInfo.md | 35 +++ wiki-information/functions/Quit.md | 12 + wiki-information/functions/RandomRoll.md | 21 ++ wiki-information/functions/RejectProposal.md | 9 + .../functions/RemoveChatWindowChannel.md | 20 ++ .../functions/RemoveChatWindowMessages.md | 15 ++ .../functions/RemoveQuestWatch.md | 9 + .../functions/RemoveTrackedAchievement.md | 20 ++ wiki-information/functions/RenamePetition.md | 9 + wiki-information/functions/RepairAllItems.md | 31 +++ wiki-information/functions/ReplaceEnchant.md | 8 + .../functions/ReplaceGuildMaster.md | 9 + .../functions/ReplaceTradeEnchant.md | 11 + wiki-information/functions/RepopMe.md | 8 + wiki-information/functions/ReportBug.md | 9 + .../functions/ReportPlayerIsPVPAFK.md | 9 + .../functions/ReportSuggestion.md | 9 + .../functions/RequestBattlefieldScoreData.md | 8 + .../RequestBattlegroundInstanceInfo.md | 18 ++ .../functions/RequestInspectHonorData.md | 18 ++ .../functions/RequestInviteFromUnit.md | 9 + wiki-information/functions/RequestRaidInfo.md | 15 ++ .../functions/RequestRatedInfo.md | 9 + .../functions/RequestTimePlayed.md | 8 + wiki-information/functions/ResetCursor.md | 14 ++ wiki-information/functions/ResetTutorials.md | 14 ++ .../functions/ResistancePercent.md | 21 ++ .../functions/RespondInstanceLock.md | 9 + .../functions/ResurrectGetOfferer.md | 9 + .../functions/ResurrectHasSickness.md | 9 + .../functions/ResurrectHasTimer.md | 9 + wiki-information/functions/RetrieveCorpse.md | 9 + wiki-information/functions/RollOnLoot.md | 30 +++ wiki-information/functions/RunBinding.md | 22 ++ wiki-information/functions/RunMacro.md | 12 + wiki-information/functions/RunMacroText.md | 30 +++ wiki-information/functions/RunScript.md | 31 +++ wiki-information/functions/SaveBindings.md | 34 +++ wiki-information/functions/SaveView.md | 19 ++ wiki-information/functions/Screenshot.md | 19 ++ .../functions/SearchLFGGetNumResults.md | 16 ++ wiki-information/functions/SearchLFGJoin.md | 21 ++ .../functions/SecureCmdOptionParse.md | 23 ++ .../functions/SelectGossipActiveQuest.md | 12 + .../functions/SelectGossipAvailableQuest.md | 12 + .../functions/SelectGossipOption.md | 9 + .../functions/SelectQuestLogEntry.md | 13 + .../functions/SelectTrainerService.md | 12 + .../functions/SelectedRealmName.md | 12 + wiki-information/functions/SendChatMessage.md | 102 ++++++++ wiki-information/functions/SendMail.md | 22 ++ .../functions/SendSystemMessage.md | 9 + wiki-information/functions/SetAbandonQuest.md | 27 +++ .../functions/SetAchievementComparisonUnit.md | 21 ++ .../functions/SetActionBarToggles.md | 20 ++ .../functions/SetActiveTalentGroup.md | 24 ++ .../functions/SetAllowDangerousScripts.md | 9 + .../functions/SetAllowLowLevelRaid.md | 9 + .../functions/SetAutoDeclineGuildInvites.md | 19 ++ .../functions/SetBattlefieldScoreFaction.md | 9 + wiki-information/functions/SetBinding.md | 46 ++++ wiki-information/functions/SetBindingClick.md | 38 +++ wiki-information/functions/SetBindingItem.md | 24 ++ wiki-information/functions/SetBindingMacro.md | 42 ++++ wiki-information/functions/SetBindingSpell.md | 39 +++ .../functions/SetCemeteryPreference.md | 9 + .../functions/SetChannelPassword.md | 22 ++ wiki-information/functions/SetConsoleKey.md | 15 ++ .../functions/SetCurrencyBackpack.md | 15 ++ .../functions/SetCurrencyUnused.md | 15 ++ wiki-information/functions/SetCurrentTitle.md | 24 ++ wiki-information/functions/SetCursor.md | 18 ++ .../functions/SetDungeonDifficultyID.md | 20 ++ .../functions/SetFactionActive.md | 13 + .../functions/SetFactionInactive.md | 13 + .../functions/SetGuildBankTabInfo.md | 16 ++ .../functions/SetGuildBankTabPermissions.md | 20 ++ .../functions/SetGuildBankText.md | 22 ++ .../SetGuildBankWithdrawGoldLimit.md | 12 + .../functions/SetGuildInfoText.md | 9 + .../functions/SetGuildRosterShowOffline.md | 33 +++ .../functions/SetInWorldUIVisibility.md | 12 + wiki-information/functions/SetLFGComment.md | 12 + .../functions/SetLegacyRaidDifficultyID.md | 11 + .../functions/SetLootThreshold.md | 34 +++ wiki-information/functions/SetMacroSpell.md | 23 ++ .../functions/SetModifiedClick.md | 21 ++ wiki-information/functions/SetMoveEnabled.md | 5 + .../functions/SetMultiCastSpell.md | 38 +++ wiki-information/functions/SetOptOutOfLoot.md | 18 ++ .../functions/SetOverrideBinding.md | 34 +++ .../functions/SetOverrideBindingClick.md | 38 +++ .../functions/SetOverrideBindingItem.md | 27 +++ .../functions/SetOverrideBindingMacro.md | 27 +++ .../functions/SetOverrideBindingSpell.md | 27 +++ wiki-information/functions/SetPVP.md | 13 + wiki-information/functions/SetPVPRoles.md | 18 ++ .../functions/SetPendingReportPetTarget.md | 13 + .../functions/SetPendingReportTarget.md | 20 ++ .../functions/SetPetStablePaperdoll.md | 15 ++ .../functions/SetPortraitTexture.md | 26 ++ ...SetPortraitTextureFromCreatureDisplayID.md | 11 + .../functions/SetPortraitToTexture.md | 28 +++ .../functions/SetRaidDifficultyID.md | 24 ++ wiki-information/functions/SetRaidTarget.md | 48 ++++ .../functions/SetScreenResolution.md | 27 +++ .../functions/SetSelectedBattlefield.md | 9 + .../functions/SetSelectedSkill.md | 9 + .../functions/SetSuperTrackedQuestID.md | 9 + .../functions/SetTalentGroupRole.md | 23 ++ wiki-information/functions/SetTaxiMap.md | 12 + wiki-information/functions/SetTracking.md | 23 ++ wiki-information/functions/SetTradeMoney.md | 19 ++ .../functions/SetTradeSkillItemLevelFilter.md | 42 ++++ .../functions/SetTradeSkillSubClassFilter.md | 23 ++ .../functions/SetTrainerServiceTypeFilter.md | 30 +++ wiki-information/functions/SetTurnEnabled.md | 5 + wiki-information/functions/SetUIVisibility.md | 9 + .../functions/SetUnitCursorTexture.md | 26 ++ wiki-information/functions/SetView.md | 14 ++ .../functions/SetWatchedFactionIndex.md | 12 + .../functions/SetupFullscreenScale.md | 9 + .../functions/ShiftQuestWatches.md | 12 + .../ShowBossFrameWhenUninteractable.md | 19 ++ wiki-information/functions/ShowCloak.md | 18 ++ wiki-information/functions/ShowHelm.md | 18 ++ .../functions/ShowQuestComplete.md | 15 ++ .../functions/ShowRepairCursor.md | 17 ++ wiki-information/functions/ShowingCloak.md | 18 ++ wiki-information/functions/ShowingHelm.md | 18 ++ .../functions/SitStandOrDescendStart.md | 8 + .../functions/SortAuctionSetSort.md | 24 ++ .../functions/SortQuestWatches.md | 9 + .../functions/SpellCanTargetUnit.md | 16 ++ .../functions/SpellGetVisibilityInfo.md | 22 ++ .../functions/SpellIsTargeting.md | 9 + .../functions/SpellStopCasting.md | 27 +++ .../functions/SpellStopTargeting.md | 8 + wiki-information/functions/SpellTargetUnit.md | 21 ++ .../functions/SplitContainerItem.md | 17 ++ wiki-information/functions/StablePet.md | 11 + wiki-information/functions/StartAuction.md | 30 +++ wiki-information/functions/StartDuel.md | 21 ++ wiki-information/functions/StopMusic.md | 9 + wiki-information/functions/StopSound.md | 11 + .../functions/StopTradeSkillRepeat.md | 8 + wiki-information/functions/StrafeLeftStart.md | 12 + wiki-information/functions/StrafeLeftStop.md | 12 + .../functions/StrafeRightStart.md | 12 + wiki-information/functions/StrafeRightStop.md | 12 + wiki-information/functions/StripHyperlinks.md | 24 ++ wiki-information/functions/Stuck.md | 9 + wiki-information/functions/SummonFriend.md | 19 ++ .../functions/SupportsClipCursor.md | 9 + .../functions/SwapRaidSubgroup.md | 21 ++ wiki-information/functions/TakeInboxItem.md | 20 ++ wiki-information/functions/TakeInboxMoney.md | 22 ++ wiki-information/functions/TakeTaxiNode.md | 9 + .../functions/TargetDirectionEnemy.md | 11 + .../functions/TargetDirectionFriend.md | 11 + wiki-information/functions/TargetLastEnemy.md | 5 + .../functions/TargetLastTarget.md | 8 + wiki-information/functions/TargetNearest.md | 9 + .../functions/TargetNearestEnemy.md | 13 + .../functions/TargetNearestEnemyPlayer.md | 9 + .../functions/TargetNearestFriend.md | 25 ++ .../functions/TargetNearestFriendPlayer.md | 9 + .../functions/TargetNearestPartyMember.md | 9 + .../functions/TargetNearestRaidMember.md | 9 + .../functions/TargetPriorityHighlightStart.md | 9 + wiki-information/functions/TargetTotem.md | 9 + wiki-information/functions/TargetUnit.md | 11 + wiki-information/functions/TaxiGetDestX.md | 16 ++ wiki-information/functions/TaxiGetDestY.md | 15 ++ wiki-information/functions/TaxiGetSrcX.md | 16 ++ wiki-information/functions/TaxiGetSrcY.md | 16 ++ wiki-information/functions/TaxiNodeCost.md | 33 +++ wiki-information/functions/TaxiNodeGetType.md | 19 ++ wiki-information/functions/TaxiNodeName.md | 16 ++ .../functions/TimeoutResurrect.md | 12 + wiki-information/functions/ToggleAutoRun.md | 11 + wiki-information/functions/TogglePVP.md | 9 + wiki-information/functions/ToggleRun.md | 9 + .../functions/ToggleSelfHighlight.md | 9 + wiki-information/functions/ToggleSheath.md | 9 + wiki-information/functions/TurnLeftStart.md | 12 + wiki-information/functions/TurnLeftStop.md | 12 + .../functions/TurnOrActionStart.md | 11 + .../functions/TurnOrActionStop.md | 10 + wiki-information/functions/TurnRightStart.md | 12 + wiki-information/functions/TurnRightStop.md | 12 + wiki-information/functions/UninviteUnit.md | 14 ++ .../functions/UnitAffectingCombat.md | 22 ++ wiki-information/functions/UnitArmor.md | 38 +++ .../functions/UnitAttackBothHands.md | 19 ++ wiki-information/functions/UnitAttackPower.md | 25 ++ wiki-information/functions/UnitAttackSpeed.md | 15 ++ wiki-information/functions/UnitAura.md | 184 ++++++++++++++ wiki-information/functions/UnitBuff.md | 185 ++++++++++++++ wiki-information/functions/UnitCanAssist.md | 31 +++ wiki-information/functions/UnitCanAttack.md | 32 +++ .../functions/UnitCanCooperate.md | 15 ++ wiki-information/functions/UnitCastingInfo.md | 51 ++++ wiki-information/functions/UnitChannelInfo.md | 52 ++++ .../functions/UnitCharacterPoints.md | 13 + wiki-information/functions/UnitClass.md | 43 ++++ wiki-information/functions/UnitClassBase.md | 43 ++++ .../functions/UnitClassification.md | 26 ++ .../functions/UnitControllingVehicle.md | 19 ++ .../functions/UnitCreatureFamily.md | 111 +++++++++ .../functions/UnitCreatureType.md | 49 ++++ wiki-information/functions/UnitDamage.md | 28 +++ wiki-information/functions/UnitDebuff.md | 184 ++++++++++++++ .../functions/UnitDetailedThreatSituation.md | 75 ++++++ .../functions/UnitDistanceSquared.md | 22 ++ .../functions/UnitEffectiveLevel.md | 19 ++ wiki-information/functions/UnitExists.md | 23 ++ .../functions/UnitFactionGroup.md | 31 +++ wiki-information/functions/UnitFullName.md | 63 +++++ wiki-information/functions/UnitGUID.md | 42 ++++ .../functions/UnitGetAvailableRoles.md | 20 ++ .../functions/UnitGetIncomingHeals.md | 26 ++ .../functions/UnitGroupRolesAssigned.md | 13 + .../functions/UnitHPPerStamina.md | 19 ++ .../functions/UnitHasIncomingResurrection.md | 16 ++ .../functions/UnitHasLFGDeserter.md | 13 + .../functions/UnitHasLFGRandomCooldown.md | 16 ++ .../functions/UnitHasRelicSlot.md | 19 ++ .../functions/UnitHasVehiclePlayerFrameUI.md | 29 +++ .../functions/UnitHasVehicleUI.md | 19 ++ wiki-information/functions/UnitHealth.md | 25 ++ wiki-information/functions/UnitHealthMax.md | 30 +++ wiki-information/functions/UnitInAnyGroup.md | 13 + .../functions/UnitInBattleground.md | 32 +++ wiki-information/functions/UnitInParty.md | 33 +++ wiki-information/functions/UnitInPartyIsAI.md | 19 ++ wiki-information/functions/UnitInPhase.md | 16 ++ wiki-information/functions/UnitInRaid.md | 34 +++ wiki-information/functions/UnitInRange.md | 18 ++ wiki-information/functions/UnitInSubgroup.md | 22 ++ wiki-information/functions/UnitInVehicle.md | 19 ++ .../functions/UnitInVehicleControlSeat.md | 30 +++ .../functions/UnitInVehicleHidesPetFrame.md | 13 + wiki-information/functions/UnitIsAFK.md | 28 +++ wiki-information/functions/UnitIsCharmed.md | 13 + wiki-information/functions/UnitIsCivilian.md | 13 + wiki-information/functions/UnitIsConnected.md | 19 ++ .../functions/UnitIsControlling.md | 19 ++ wiki-information/functions/UnitIsCorpse.md | 19 ++ wiki-information/functions/UnitIsDND.md | 21 ++ wiki-information/functions/UnitIsDead.md | 20 ++ .../functions/UnitIsDeadOrGhost.md | 22 ++ wiki-information/functions/UnitIsEnemy.md | 21 ++ .../functions/UnitIsFeignDeath.md | 18 ++ wiki-information/functions/UnitIsFriend.md | 21 ++ .../functions/UnitIsGameObject.md | 19 ++ wiki-information/functions/UnitIsGhost.md | 20 ++ .../functions/UnitIsGroupAssistant.md | 21 ++ .../functions/UnitIsGroupLeader.md | 22 ++ wiki-information/functions/UnitIsInMyGuild.md | 13 + .../functions/UnitIsInteractable.md | 19 ++ .../functions/UnitIsOtherPlayersPet.md | 29 +++ .../UnitIsOwnerOrControllerOfUnit.md | 15 ++ .../functions/UnitIsPVPFreeForAll.md | 13 + .../functions/UnitIsPVPSanctuary.md | 13 + wiki-information/functions/UnitIsPlayer.md | 19 ++ wiki-information/functions/UnitIsPossessed.md | 13 + .../functions/UnitIsRaidOfficer.md | 29 +++ .../functions/UnitIsSameServer.md | 16 ++ wiki-information/functions/UnitIsTapDenied.md | 38 +++ wiki-information/functions/UnitIsTrivial.md | 17 ++ .../functions/UnitIsUnconscious.md | 19 ++ wiki-information/functions/UnitIsUnit.md | 26 ++ wiki-information/functions/UnitLevel.md | 34 +++ wiki-information/functions/UnitName.md | 63 +++++ .../functions/UnitNameUnmodified.md | 63 +++++ wiki-information/functions/UnitOnTaxi.md | 13 + wiki-information/functions/UnitPVPName.md | 17 ++ wiki-information/functions/UnitPVPRank.md | 48 ++++ .../functions/UnitPlayerControlled.md | 28 +++ .../functions/UnitPlayerOrPetInParty.md | 16 ++ .../functions/UnitPlayerOrPetInRaid.md | 27 +++ wiki-information/functions/UnitPosition.md | 30 +++ wiki-information/functions/UnitPower.md | 69 ++++++ .../functions/UnitPowerDisplayMod.md | 100 ++++++++ wiki-information/functions/UnitPowerMax.md | 116 +++++++++ wiki-information/functions/UnitPowerType.md | 70 ++++++ wiki-information/functions/UnitRace.md | 73 ++++++ .../functions/UnitRangedAttack.md | 26 ++ .../functions/UnitRangedAttackPower.md | 25 ++ .../functions/UnitRangedDamage.md | 37 +++ wiki-information/functions/UnitReaction.md | 32 +++ .../functions/UnitRealmRelationship.md | 19 ++ wiki-information/functions/UnitResistance.md | 40 +++ .../functions/UnitSelectionColor.md | 30 +++ wiki-information/functions/UnitSetRole.md | 18 ++ wiki-information/functions/UnitSex.md | 32 +++ .../functions/UnitShouldDisplayName.md | 19 ++ wiki-information/functions/UnitStat.md | 40 +++ .../functions/UnitSwitchToVehicleSeat.md | 17 ++ .../functions/UnitTargetsVehicleInRaidUI.md | 19 ++ .../functions/UnitThreatPercentageOfLead.md | 25 ++ .../functions/UnitThreatSituation.md | 70 ++++++ .../functions/UnitTrialBankedLevels.md | 17 ++ wiki-information/functions/UnitTrialXP.md | 26 ++ .../functions/UnitUsingVehicle.md | 13 + .../functions/UnitVehicleSeatCount.md | 19 ++ .../functions/UnitVehicleSeatInfo.md | 23 ++ wiki-information/functions/UnitVehicleSkin.md | 13 + wiki-information/functions/UnitXP.md | 35 +++ wiki-information/functions/UnitXPMax.md | 26 ++ wiki-information/functions/UnmuteSoundFile.md | 23 ++ wiki-information/functions/UnstablePet.md | 9 + wiki-information/functions/UpdateWindow.md | 11 + wiki-information/functions/UseAction.md | 31 +++ .../functions/UseContainerItem.md | 36 +++ .../functions/UseInventoryItem.md | 22 ++ wiki-information/functions/UseItemByName.md | 27 +++ wiki-information/functions/UseToy.md | 19 ++ wiki-information/functions/UseToyByName.md | 19 ++ wiki-information/functions/addframetext.md | 13 + wiki-information/functions/debuglocals.md | 62 +++++ .../functions/debugprofilestart.md | 11 + .../functions/debugprofilestop.md | 32 +++ wiki-information/functions/debugstack.md | 76 ++++++ wiki-information/functions/forceinsecure.md | 14 ++ wiki-information/functions/geterrorhandler.md | 21 ++ wiki-information/functions/hooksecurefunc.md | 38 +++ wiki-information/functions/issecure.md | 13 + .../functions/issecurevariable.md | 22 ++ wiki-information/functions/pcallwithenv.md | 28 +++ wiki-information/functions/scrub.md | 13 + wiki-information/functions/securecall.md | 23 ++ .../functions/securecallfunction.md | 21 ++ .../functions/secureexecuterange.md | 51 ++++ wiki-information/functions/seterrorhandler.md | 21 ++ 3512 files changed, 74971 insertions(+) create mode 100644 wiki-information/events/ACHIEVEMENT_EARNED.md create mode 100644 wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md create mode 100644 wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md create mode 100644 wiki-information/events/ACTIONBAR_HIDEGRID.md create mode 100644 wiki-information/events/ACTIONBAR_PAGE_CHANGED.md create mode 100644 wiki-information/events/ACTIONBAR_SHOWGRID.md create mode 100644 wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md create mode 100644 wiki-information/events/ACTIONBAR_SLOT_CHANGED.md create mode 100644 wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md create mode 100644 wiki-information/events/ACTIONBAR_UPDATE_STATE.md create mode 100644 wiki-information/events/ACTIONBAR_UPDATE_USABLE.md create mode 100644 wiki-information/events/ACTION_WILL_BIND_ITEM.md create mode 100644 wiki-information/events/ACTIVATE_GLYPH.md create mode 100644 wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md create mode 100644 wiki-information/events/ADAPTER_LIST_CHANGED.md create mode 100644 wiki-information/events/ADDONS_UNLOADING.md create mode 100644 wiki-information/events/ADDON_ACTION_BLOCKED.md create mode 100644 wiki-information/events/ADDON_ACTION_FORBIDDEN.md create mode 100644 wiki-information/events/ADDON_LOADED.md create mode 100644 wiki-information/events/ADVENTURE_MAP_CLOSE.md create mode 100644 wiki-information/events/ADVENTURE_MAP_OPEN.md create mode 100644 wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md create mode 100644 wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md create mode 100644 wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md create mode 100644 wiki-information/events/AJ_DUNGEON_ACTION.md create mode 100644 wiki-information/events/AJ_OPEN.md create mode 100644 wiki-information/events/AJ_PVE_LFG_ACTION.md create mode 100644 wiki-information/events/AJ_PVP_ACTION.md create mode 100644 wiki-information/events/AJ_PVP_LFG_ACTION.md create mode 100644 wiki-information/events/AJ_PVP_RBG_ACTION.md create mode 100644 wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md create mode 100644 wiki-information/events/AJ_QUEST_LOG_OPEN.md create mode 100644 wiki-information/events/AJ_RAID_ACTION.md create mode 100644 wiki-information/events/AJ_REFRESH_DISPLAY.md create mode 100644 wiki-information/events/AJ_REWARD_DATA_RECEIVED.md create mode 100644 wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md create mode 100644 wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md create mode 100644 wiki-information/events/AREA_POIS_UPDATED.md create mode 100644 wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md create mode 100644 wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md create mode 100644 wiki-information/events/ARENA_COOLDOWNS_UPDATE.md create mode 100644 wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md create mode 100644 wiki-information/events/ARENA_OPPONENT_UPDATE.md create mode 100644 wiki-information/events/ARENA_SEASON_WORLD_STATE.md create mode 100644 wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md create mode 100644 wiki-information/events/ARENA_TEAM_UPDATE.md create mode 100644 wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md create mode 100644 wiki-information/events/AUCTION_HOUSE_CLOSED.md create mode 100644 wiki-information/events/AUCTION_HOUSE_DISABLED.md create mode 100644 wiki-information/events/AUCTION_HOUSE_POST_ERROR.md create mode 100644 wiki-information/events/AUCTION_HOUSE_POST_WARNING.md create mode 100644 wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md create mode 100644 wiki-information/events/AUCTION_HOUSE_SHOW.md create mode 100644 wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md create mode 100644 wiki-information/events/AUCTION_MULTISELL_FAILURE.md create mode 100644 wiki-information/events/AUCTION_MULTISELL_START.md create mode 100644 wiki-information/events/AUCTION_MULTISELL_UPDATE.md create mode 100644 wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md create mode 100644 wiki-information/events/AUTOFOLLOW_BEGIN.md create mode 100644 wiki-information/events/AUTOFOLLOW_END.md create mode 100644 wiki-information/events/AVATAR_LIST_UPDATED.md create mode 100644 wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md create mode 100644 wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md create mode 100644 wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md create mode 100644 wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md create mode 100644 wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md create mode 100644 wiki-information/events/AZERITE_ESSENCE_CHANGED.md create mode 100644 wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md create mode 100644 wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md create mode 100644 wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md create mode 100644 wiki-information/events/AZERITE_ESSENCE_UPDATE.md create mode 100644 wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md create mode 100644 wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md create mode 100644 wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md create mode 100644 wiki-information/events/BAG_CLOSED.md create mode 100644 wiki-information/events/BAG_NEW_ITEMS_UPDATED.md create mode 100644 wiki-information/events/BAG_OPEN.md create mode 100644 wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md create mode 100644 wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md create mode 100644 wiki-information/events/BAG_UPDATE.md create mode 100644 wiki-information/events/BAG_UPDATE_COOLDOWN.md create mode 100644 wiki-information/events/BAG_UPDATE_DELAYED.md create mode 100644 wiki-information/events/BANKFRAME_CLOSED.md create mode 100644 wiki-information/events/BANKFRAME_OPENED.md create mode 100644 wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md create mode 100644 wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md create mode 100644 wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md create mode 100644 wiki-information/events/BARBER_SHOP_CLOSE.md create mode 100644 wiki-information/events/BARBER_SHOP_COST_UPDATE.md create mode 100644 wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md create mode 100644 wiki-information/events/BARBER_SHOP_OPEN.md create mode 100644 wiki-information/events/BARBER_SHOP_RESULT.md create mode 100644 wiki-information/events/BATTLEFIELDS_CLOSED.md create mode 100644 wiki-information/events/BATTLEFIELDS_SHOW.md create mode 100644 wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md create mode 100644 wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md create mode 100644 wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md create mode 100644 wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md create mode 100644 wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md create mode 100644 wiki-information/events/BATTLETAG_INVITE_SHOW.md create mode 100644 wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md create mode 100644 wiki-information/events/BEHAVIORAL_NOTIFICATION.md create mode 100644 wiki-information/events/BIND_ENCHANT.md create mode 100644 wiki-information/events/BLACK_MARKET_BID_RESULT.md create mode 100644 wiki-information/events/BLACK_MARKET_CLOSE.md create mode 100644 wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md create mode 100644 wiki-information/events/BLACK_MARKET_OPEN.md create mode 100644 wiki-information/events/BLACK_MARKET_OUTBID.md create mode 100644 wiki-information/events/BLACK_MARKET_UNAVAILABLE.md create mode 100644 wiki-information/events/BLACK_MARKET_WON.md create mode 100644 wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md create mode 100644 wiki-information/events/BN_BLOCK_LIST_UPDATED.md create mode 100644 wiki-information/events/BN_CHAT_MSG_ADDON.md create mode 100644 wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md create mode 100644 wiki-information/events/BN_CONNECTED.md create mode 100644 wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md create mode 100644 wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md create mode 100644 wiki-information/events/BN_DISCONNECTED.md create mode 100644 wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md create mode 100644 wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md create mode 100644 wiki-information/events/BN_FRIEND_INFO_CHANGED.md create mode 100644 wiki-information/events/BN_FRIEND_INVITE_ADDED.md create mode 100644 wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md create mode 100644 wiki-information/events/BN_FRIEND_INVITE_REMOVED.md create mode 100644 wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md create mode 100644 wiki-information/events/BN_INFO_CHANGED.md create mode 100644 wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md create mode 100644 wiki-information/events/BOSS_KILL.md create mode 100644 wiki-information/events/CALENDAR_ACTION_PENDING.md create mode 100644 wiki-information/events/CALENDAR_CLOSE_EVENT.md create mode 100644 wiki-information/events/CALENDAR_EVENT_ALARM.md create mode 100644 wiki-information/events/CALENDAR_NEW_EVENT.md create mode 100644 wiki-information/events/CALENDAR_OPEN_EVENT.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_ERROR.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_EVENT.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md create mode 100644 wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md create mode 100644 wiki-information/events/CANCEL_GLYPH_CAST.md create mode 100644 wiki-information/events/CANCEL_LOOT_ROLL.md create mode 100644 wiki-information/events/CANCEL_SUMMON.md create mode 100644 wiki-information/events/CAPTUREFRAMES_FAILED.md create mode 100644 wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md create mode 100644 wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md create mode 100644 wiki-information/events/CHANNEL_COUNT_UPDATE.md create mode 100644 wiki-information/events/CHANNEL_FLAGS_UPDATED.md create mode 100644 wiki-information/events/CHANNEL_INVITE_REQUEST.md create mode 100644 wiki-information/events/CHANNEL_LEFT.md create mode 100644 wiki-information/events/CHANNEL_PASSWORD_REQUEST.md create mode 100644 wiki-information/events/CHANNEL_ROSTER_UPDATE.md create mode 100644 wiki-information/events/CHANNEL_UI_UPDATE.md create mode 100644 wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md create mode 100644 wiki-information/events/CHARACTER_POINTS_CHANGED.md create mode 100644 wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md create mode 100644 wiki-information/events/CHAT_DISABLED_CHANGED.md create mode 100644 wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md create mode 100644 wiki-information/events/CHAT_MSG_ACHIEVEMENT.md create mode 100644 wiki-information/events/CHAT_MSG_ADDON.md create mode 100644 wiki-information/events/CHAT_MSG_ADDON_LOGGED.md create mode 100644 wiki-information/events/CHAT_MSG_AFK.md create mode 100644 wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md create mode 100644 wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md create mode 100644 wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md create mode 100644 wiki-information/events/CHAT_MSG_BN.md create mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md create mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md create mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md create mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md create mode 100644 wiki-information/events/CHAT_MSG_BN_WHISPER.md create mode 100644 wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md create mode 100644 wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md create mode 100644 wiki-information/events/CHAT_MSG_CHANNEL.md create mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md create mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md create mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_LIST.md create mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md create mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md create mode 100644 wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md create mode 100644 wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md create mode 100644 wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md create mode 100644 wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md create mode 100644 wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md create mode 100644 wiki-information/events/CHAT_MSG_CURRENCY.md create mode 100644 wiki-information/events/CHAT_MSG_DND.md create mode 100644 wiki-information/events/CHAT_MSG_EMOTE.md create mode 100644 wiki-information/events/CHAT_MSG_FILTERED.md create mode 100644 wiki-information/events/CHAT_MSG_GUILD.md create mode 100644 wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md create mode 100644 wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md create mode 100644 wiki-information/events/CHAT_MSG_IGNORED.md create mode 100644 wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md create mode 100644 wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md create mode 100644 wiki-information/events/CHAT_MSG_LOOT.md create mode 100644 wiki-information/events/CHAT_MSG_MONEY.md create mode 100644 wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md create mode 100644 wiki-information/events/CHAT_MSG_MONSTER_PARTY.md create mode 100644 wiki-information/events/CHAT_MSG_MONSTER_SAY.md create mode 100644 wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md create mode 100644 wiki-information/events/CHAT_MSG_MONSTER_YELL.md create mode 100644 wiki-information/events/CHAT_MSG_OFFICER.md create mode 100644 wiki-information/events/CHAT_MSG_OPENING.md create mode 100644 wiki-information/events/CHAT_MSG_PARTY.md create mode 100644 wiki-information/events/CHAT_MSG_PARTY_LEADER.md create mode 100644 wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md create mode 100644 wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md create mode 100644 wiki-information/events/CHAT_MSG_PET_INFO.md create mode 100644 wiki-information/events/CHAT_MSG_RAID.md create mode 100644 wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md create mode 100644 wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md create mode 100644 wiki-information/events/CHAT_MSG_RAID_LEADER.md create mode 100644 wiki-information/events/CHAT_MSG_RAID_WARNING.md create mode 100644 wiki-information/events/CHAT_MSG_RESTRICTED.md create mode 100644 wiki-information/events/CHAT_MSG_SAY.md create mode 100644 wiki-information/events/CHAT_MSG_SKILL.md create mode 100644 wiki-information/events/CHAT_MSG_SYSTEM.md create mode 100644 wiki-information/events/CHAT_MSG_TARGETICONS.md create mode 100644 wiki-information/events/CHAT_MSG_TEXT_EMOTE.md create mode 100644 wiki-information/events/CHAT_MSG_TRADESKILLS.md create mode 100644 wiki-information/events/CHAT_MSG_VOICE_TEXT.md create mode 100644 wiki-information/events/CHAT_MSG_WHISPER.md create mode 100644 wiki-information/events/CHAT_MSG_WHISPER_INFORM.md create mode 100644 wiki-information/events/CHAT_MSG_YELL.md create mode 100644 wiki-information/events/CHAT_SERVER_DISCONNECTED.md create mode 100644 wiki-information/events/CHAT_SERVER_RECONNECTED.md create mode 100644 wiki-information/events/CINEMATIC_START.md create mode 100644 wiki-information/events/CINEMATIC_STOP.md create mode 100644 wiki-information/events/CLASS_TRIAL_TIMER_START.md create mode 100644 wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md create mode 100644 wiki-information/events/CLEAR_BOSS_EMOTES.md create mode 100644 wiki-information/events/CLIENT_SCENE_CLOSED.md create mode 100644 wiki-information/events/CLIENT_SCENE_OPENED.md create mode 100644 wiki-information/events/CLOSE_INBOX_ITEM.md create mode 100644 wiki-information/events/CLOSE_TABARD_FRAME.md create mode 100644 wiki-information/events/CLUB_ADDED.md create mode 100644 wiki-information/events/CLUB_ERROR.md create mode 100644 wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md create mode 100644 wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md create mode 100644 wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md create mode 100644 wiki-information/events/CLUB_MEMBER_ADDED.md create mode 100644 wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md create mode 100644 wiki-information/events/CLUB_MEMBER_REMOVED.md create mode 100644 wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md create mode 100644 wiki-information/events/CLUB_MEMBER_UPDATED.md create mode 100644 wiki-information/events/CLUB_MESSAGE_ADDED.md create mode 100644 wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md create mode 100644 wiki-information/events/CLUB_MESSAGE_UPDATED.md create mode 100644 wiki-information/events/CLUB_REMOVED.md create mode 100644 wiki-information/events/CLUB_REMOVED_MESSAGE.md create mode 100644 wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md create mode 100644 wiki-information/events/CLUB_STREAMS_LOADED.md create mode 100644 wiki-information/events/CLUB_STREAM_ADDED.md create mode 100644 wiki-information/events/CLUB_STREAM_REMOVED.md create mode 100644 wiki-information/events/CLUB_STREAM_SUBSCRIBED.md create mode 100644 wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md create mode 100644 wiki-information/events/CLUB_STREAM_UPDATED.md create mode 100644 wiki-information/events/CLUB_TICKETS_RECEIVED.md create mode 100644 wiki-information/events/CLUB_TICKET_CREATED.md create mode 100644 wiki-information/events/CLUB_TICKET_RECEIVED.md create mode 100644 wiki-information/events/CLUB_UPDATED.md create mode 100644 wiki-information/events/COMBAT_LOG_EVENT.md create mode 100644 wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md create mode 100644 wiki-information/events/COMBAT_RATING_UPDATE.md create mode 100644 wiki-information/events/COMBAT_TEXT_UPDATE.md create mode 100644 wiki-information/events/COMMENTATOR_ENTER_WORLD.md create mode 100644 wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md create mode 100644 wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md create mode 100644 wiki-information/events/COMMENTATOR_MAP_UPDATE.md create mode 100644 wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md create mode 100644 wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md create mode 100644 wiki-information/events/COMMENTATOR_RESET_SETTINGS.md create mode 100644 wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md create mode 100644 wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md create mode 100644 wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md create mode 100644 wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md create mode 100644 wiki-information/events/COMPANION_LEARNED.md create mode 100644 wiki-information/events/COMPANION_UNLEARNED.md create mode 100644 wiki-information/events/COMPANION_UPDATE.md create mode 100644 wiki-information/events/CONFIRM_BEFORE_USE.md create mode 100644 wiki-information/events/CONFIRM_BINDER.md create mode 100644 wiki-information/events/CONFIRM_LOOT_ROLL.md create mode 100644 wiki-information/events/CONFIRM_PET_UNLEARN.md create mode 100644 wiki-information/events/CONFIRM_SUMMON.md create mode 100644 wiki-information/events/CONFIRM_TALENT_WIPE.md create mode 100644 wiki-information/events/CONFIRM_XP_LOSS.md create mode 100644 wiki-information/events/CONSOLE_CLEAR.md create mode 100644 wiki-information/events/CONSOLE_COLORS_CHANGED.md create mode 100644 wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md create mode 100644 wiki-information/events/CONSOLE_LOG.md create mode 100644 wiki-information/events/CONSOLE_MESSAGE.md create mode 100644 wiki-information/events/CORPSE_IN_INSTANCE.md create mode 100644 wiki-information/events/CORPSE_IN_RANGE.md create mode 100644 wiki-information/events/CORPSE_OUT_OF_RANGE.md create mode 100644 wiki-information/events/CRAFT_CLOSE.md create mode 100644 wiki-information/events/CRAFT_SHOW.md create mode 100644 wiki-information/events/CRAFT_UPDATE.md create mode 100644 wiki-information/events/CRITERIA_COMPLETE.md create mode 100644 wiki-information/events/CRITERIA_EARNED.md create mode 100644 wiki-information/events/CRITERIA_UPDATE.md create mode 100644 wiki-information/events/CURRENCY_DISPLAY_UPDATE.md create mode 100644 wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md create mode 100644 wiki-information/events/CURSOR_CHANGED.md create mode 100644 wiki-information/events/CURSOR_UPDATE.md create mode 100644 wiki-information/events/CVAR_UPDATE.md create mode 100644 wiki-information/events/DELETE_ITEM_CONFIRM.md create mode 100644 wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md create mode 100644 wiki-information/events/DISABLE_LOW_LEVEL_RAID.md create mode 100644 wiki-information/events/DISABLE_TAXI_BENCHMARK.md create mode 100644 wiki-information/events/DISABLE_XP_GAIN.md create mode 100644 wiki-information/events/DISPLAY_SIZE_CHANGED.md create mode 100644 wiki-information/events/DUEL_FINISHED.md create mode 100644 wiki-information/events/DUEL_INBOUNDS.md create mode 100644 wiki-information/events/DUEL_OUTOFBOUNDS.md create mode 100644 wiki-information/events/DUEL_REQUESTED.md create mode 100644 wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md create mode 100644 wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md create mode 100644 wiki-information/events/ENABLE_LOW_LEVEL_RAID.md create mode 100644 wiki-information/events/ENABLE_TAXI_BENCHMARK.md create mode 100644 wiki-information/events/ENABLE_XP_GAIN.md create mode 100644 wiki-information/events/ENCOUNTER_END.md create mode 100644 wiki-information/events/ENCOUNTER_START.md create mode 100644 wiki-information/events/END_BOUND_TRADEABLE.md create mode 100644 wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md create mode 100644 wiki-information/events/ENTITLEMENT_DELIVERED.md create mode 100644 wiki-information/events/EQUIPMENT_SETS_CHANGED.md create mode 100644 wiki-information/events/EQUIPMENT_SWAP_FINISHED.md create mode 100644 wiki-information/events/EQUIPMENT_SWAP_PENDING.md create mode 100644 wiki-information/events/EQUIP_BIND_CONFIRM.md create mode 100644 wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md create mode 100644 wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md create mode 100644 wiki-information/events/EXECUTE_CHAT_LINE.md create mode 100644 wiki-information/events/FIRST_FRAME_RENDERED.md create mode 100644 wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md create mode 100644 wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md create mode 100644 wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md create mode 100644 wiki-information/events/FRIENDLIST_UPDATE.md create mode 100644 wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md create mode 100644 wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md create mode 100644 wiki-information/events/GAME_PAD_CONNECTED.md create mode 100644 wiki-information/events/GAME_PAD_DISCONNECTED.md create mode 100644 wiki-information/events/GAME_PAD_POWER_CHANGED.md create mode 100644 wiki-information/events/GDF_SIM_COMPLETE.md create mode 100644 wiki-information/events/GENERIC_ERROR.md create mode 100644 wiki-information/events/GET_ITEM_INFO_RECEIVED.md create mode 100644 wiki-information/events/GLOBAL_MOUSE_DOWN.md create mode 100644 wiki-information/events/GLOBAL_MOUSE_UP.md create mode 100644 wiki-information/events/GLUE_CONSOLE_LOG.md create mode 100644 wiki-information/events/GLUE_SCREENSHOT_FAILED.md create mode 100644 wiki-information/events/GM_PLAYER_INFO.md create mode 100644 wiki-information/events/GOSSIP_CLOSED.md create mode 100644 wiki-information/events/GOSSIP_CONFIRM.md create mode 100644 wiki-information/events/GOSSIP_CONFIRM_CANCEL.md create mode 100644 wiki-information/events/GOSSIP_ENTER_CODE.md create mode 100644 wiki-information/events/GOSSIP_SHOW.md create mode 100644 wiki-information/events/GROUP_FORMED.md create mode 100644 wiki-information/events/GROUP_INVITE_CONFIRMATION.md create mode 100644 wiki-information/events/GROUP_JOINED.md create mode 100644 wiki-information/events/GROUP_LEFT.md create mode 100644 wiki-information/events/GROUP_ROSTER_UPDATE.md create mode 100644 wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md create mode 100644 wiki-information/events/GUILDBANKFRAME_CLOSED.md create mode 100644 wiki-information/events/GUILDBANKFRAME_OPENED.md create mode 100644 wiki-information/events/GUILDBANKLOG_UPDATE.md create mode 100644 wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md create mode 100644 wiki-information/events/GUILDBANK_TEXT_CHANGED.md create mode 100644 wiki-information/events/GUILDBANK_UPDATE_MONEY.md create mode 100644 wiki-information/events/GUILDBANK_UPDATE_TABS.md create mode 100644 wiki-information/events/GUILDBANK_UPDATE_TEXT.md create mode 100644 wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md create mode 100644 wiki-information/events/GUILDTABARD_UPDATE.md create mode 100644 wiki-information/events/GUILD_EVENT_LOG_UPDATE.md create mode 100644 wiki-information/events/GUILD_INVITE_CANCEL.md create mode 100644 wiki-information/events/GUILD_INVITE_REQUEST.md create mode 100644 wiki-information/events/GUILD_MOTD.md create mode 100644 wiki-information/events/GUILD_PARTY_STATE_UPDATED.md create mode 100644 wiki-information/events/GUILD_RANKS_UPDATE.md create mode 100644 wiki-information/events/GUILD_REGISTRAR_CLOSED.md create mode 100644 wiki-information/events/GUILD_REGISTRAR_SHOW.md create mode 100644 wiki-information/events/GUILD_RENAME_REQUIRED.md create mode 100644 wiki-information/events/GUILD_ROSTER_UPDATE.md create mode 100644 wiki-information/events/GX_RESTARTED.md create mode 100644 wiki-information/events/HEARTHSTONE_BOUND.md create mode 100644 wiki-information/events/HEIRLOOMS_UPDATED.md create mode 100644 wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md create mode 100644 wiki-information/events/HIDE_SUBTITLE.md create mode 100644 wiki-information/events/IGNORELIST_UPDATE.md create mode 100644 wiki-information/events/INCOMING_RESURRECT_CHANGED.md create mode 100644 wiki-information/events/INITIAL_CLUBS_LOADED.md create mode 100644 wiki-information/events/INITIAL_HOTFIXES_APPLIED.md create mode 100644 wiki-information/events/INSPECT_ACHIEVEMENT_READY.md create mode 100644 wiki-information/events/INSPECT_HONOR_UPDATE.md create mode 100644 wiki-information/events/INSPECT_READY.md create mode 100644 wiki-information/events/INSTANCE_BOOT_START.md create mode 100644 wiki-information/events/INSTANCE_BOOT_STOP.md create mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md create mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md create mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md create mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md create mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md create mode 100644 wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md create mode 100644 wiki-information/events/INSTANCE_LOCK_START.md create mode 100644 wiki-information/events/INSTANCE_LOCK_STOP.md create mode 100644 wiki-information/events/INSTANCE_LOCK_WARNING.md create mode 100644 wiki-information/events/INVENTORY_SEARCH_UPDATE.md create mode 100644 wiki-information/events/ISLAND_COMPLETED.md create mode 100644 wiki-information/events/ITEM_DATA_LOAD_RESULT.md create mode 100644 wiki-information/events/ITEM_LOCKED.md create mode 100644 wiki-information/events/ITEM_LOCK_CHANGED.md create mode 100644 wiki-information/events/ITEM_PUSH.md create mode 100644 wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md create mode 100644 wiki-information/events/ITEM_TEXT_BEGIN.md create mode 100644 wiki-information/events/ITEM_TEXT_CLOSED.md create mode 100644 wiki-information/events/ITEM_TEXT_READY.md create mode 100644 wiki-information/events/ITEM_TEXT_TRANSLATION.md create mode 100644 wiki-information/events/ITEM_UNLOCKED.md create mode 100644 wiki-information/events/ITEM_UPGRADE_FAILED.md create mode 100644 wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md create mode 100644 wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md create mode 100644 wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md create mode 100644 wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md create mode 100644 wiki-information/events/LANGUAGE_LIST_CHANGED.md create mode 100644 wiki-information/events/LEARNED_SPELL_IN_TAB.md create mode 100644 wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md create mode 100644 wiki-information/events/LFG_COMPLETION_REWARD.md create mode 100644 wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md create mode 100644 wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md create mode 100644 wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md create mode 100644 wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md create mode 100644 wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md create mode 100644 wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md create mode 100644 wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md create mode 100644 wiki-information/events/LFG_LIST_SEARCH_FAILED.md create mode 100644 wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md create mode 100644 wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md create mode 100644 wiki-information/events/LFG_LOCK_INFO_RECEIVED.md create mode 100644 wiki-information/events/LFG_OFFER_CONTINUE.md create mode 100644 wiki-information/events/LFG_OPEN_FROM_GOSSIP.md create mode 100644 wiki-information/events/LFG_PROPOSAL_DONE.md create mode 100644 wiki-information/events/LFG_PROPOSAL_FAILED.md create mode 100644 wiki-information/events/LFG_PROPOSAL_SHOW.md create mode 100644 wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md create mode 100644 wiki-information/events/LFG_PROPOSAL_UPDATE.md create mode 100644 wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md create mode 100644 wiki-information/events/LFG_READY_CHECK_DECLINED.md create mode 100644 wiki-information/events/LFG_READY_CHECK_HIDE.md create mode 100644 wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md create mode 100644 wiki-information/events/LFG_READY_CHECK_SHOW.md create mode 100644 wiki-information/events/LFG_READY_CHECK_UPDATE.md create mode 100644 wiki-information/events/LFG_ROLE_CHECK_DECLINED.md create mode 100644 wiki-information/events/LFG_ROLE_CHECK_HIDE.md create mode 100644 wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md create mode 100644 wiki-information/events/LFG_ROLE_CHECK_SHOW.md create mode 100644 wiki-information/events/LFG_ROLE_CHECK_UPDATE.md create mode 100644 wiki-information/events/LFG_ROLE_UPDATE.md create mode 100644 wiki-information/events/LFG_UPDATE.md create mode 100644 wiki-information/events/LFG_UPDATE_RANDOM_INFO.md create mode 100644 wiki-information/events/LOADING_SCREEN_DISABLED.md create mode 100644 wiki-information/events/LOADING_SCREEN_ENABLED.md create mode 100644 wiki-information/events/LOCALPLAYER_PET_RENAMED.md create mode 100644 wiki-information/events/LOC_RESULT.md create mode 100644 wiki-information/events/LOGOUT_CANCEL.md create mode 100644 wiki-information/events/LOOT_BIND_CONFIRM.md create mode 100644 wiki-information/events/LOOT_CLOSED.md create mode 100644 wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md create mode 100644 wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md create mode 100644 wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md create mode 100644 wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md create mode 100644 wiki-information/events/LOOT_ITEM_AVAILABLE.md create mode 100644 wiki-information/events/LOOT_ITEM_ROLL_WON.md create mode 100644 wiki-information/events/LOOT_OPENED.md create mode 100644 wiki-information/events/LOOT_READY.md create mode 100644 wiki-information/events/LOOT_ROLLS_COMPLETE.md create mode 100644 wiki-information/events/LOOT_SLOT_CHANGED.md create mode 100644 wiki-information/events/LOOT_SLOT_CLEARED.md create mode 100644 wiki-information/events/LOSS_OF_CONTROL_ADDED.md create mode 100644 wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md create mode 100644 wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md create mode 100644 wiki-information/events/LOSS_OF_CONTROL_UPDATE.md create mode 100644 wiki-information/events/LUA_WARNING.md create mode 100644 wiki-information/events/MACRO_ACTION_BLOCKED.md create mode 100644 wiki-information/events/MACRO_ACTION_FORBIDDEN.md create mode 100644 wiki-information/events/MAIL_CLOSED.md create mode 100644 wiki-information/events/MAIL_FAILED.md create mode 100644 wiki-information/events/MAIL_INBOX_UPDATE.md create mode 100644 wiki-information/events/MAIL_LOCK_SEND_ITEMS.md create mode 100644 wiki-information/events/MAIL_SEND_INFO_UPDATE.md create mode 100644 wiki-information/events/MAIL_SEND_SUCCESS.md create mode 100644 wiki-information/events/MAIL_SHOW.md create mode 100644 wiki-information/events/MAIL_SUCCESS.md create mode 100644 wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md create mode 100644 wiki-information/events/MAP_EXPLORATION_UPDATED.md create mode 100644 wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md create mode 100644 wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md create mode 100644 wiki-information/events/MERCHANT_CLOSED.md create mode 100644 wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md create mode 100644 wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md create mode 100644 wiki-information/events/MERCHANT_SHOW.md create mode 100644 wiki-information/events/MERCHANT_UPDATE.md create mode 100644 wiki-information/events/MINIMAP_PING.md create mode 100644 wiki-information/events/MINIMAP_UPDATE_TRACKING.md create mode 100644 wiki-information/events/MINIMAP_UPDATE_ZOOM.md create mode 100644 wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md create mode 100644 wiki-information/events/MIRROR_TIMER_PAUSE.md create mode 100644 wiki-information/events/MIRROR_TIMER_START.md create mode 100644 wiki-information/events/MIRROR_TIMER_STOP.md create mode 100644 wiki-information/events/MODIFIER_STATE_CHANGED.md create mode 100644 wiki-information/events/MOUNT_CURSOR_CLEAR.md create mode 100644 wiki-information/events/MUTELIST_UPDATE.md create mode 100644 wiki-information/events/NAME_PLATE_CREATED.md create mode 100644 wiki-information/events/NAME_PLATE_UNIT_ADDED.md create mode 100644 wiki-information/events/NAME_PLATE_UNIT_REMOVED.md create mode 100644 wiki-information/events/NEW_AUCTION_UPDATE.md create mode 100644 wiki-information/events/NEW_RECIPE_LEARNED.md create mode 100644 wiki-information/events/NEW_TOY_ADDED.md create mode 100644 wiki-information/events/NEW_WMO_CHUNK.md create mode 100644 wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md create mode 100644 wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md create mode 100644 wiki-information/events/NOTIFY_PVP_AFK_RESULT.md create mode 100644 wiki-information/events/OBJECT_ENTERED_AOI.md create mode 100644 wiki-information/events/OBJECT_LEFT_AOI.md create mode 100644 wiki-information/events/OBLITERUM_FORGE_CLOSE.md create mode 100644 wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md create mode 100644 wiki-information/events/OBLITERUM_FORGE_SHOW.md create mode 100644 wiki-information/events/OPEN_MASTER_LOOT_LIST.md create mode 100644 wiki-information/events/OPEN_REPORT_PLAYER.md create mode 100644 wiki-information/events/OPEN_TABARD_FRAME.md create mode 100644 wiki-information/events/PARTY_INVITE_CANCEL.md create mode 100644 wiki-information/events/PARTY_INVITE_REQUEST.md create mode 100644 wiki-information/events/PARTY_LEADER_CHANGED.md create mode 100644 wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md create mode 100644 wiki-information/events/PARTY_MEMBER_DISABLE.md create mode 100644 wiki-information/events/PARTY_MEMBER_ENABLE.md create mode 100644 wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md create mode 100644 wiki-information/events/PETITION_CLOSED.md create mode 100644 wiki-information/events/PETITION_SHOW.md create mode 100644 wiki-information/events/PET_ATTACK_START.md create mode 100644 wiki-information/events/PET_ATTACK_STOP.md create mode 100644 wiki-information/events/PET_BAR_HIDEGRID.md create mode 100644 wiki-information/events/PET_BAR_SHOWGRID.md create mode 100644 wiki-information/events/PET_BAR_UPDATE.md create mode 100644 wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md create mode 100644 wiki-information/events/PET_BAR_UPDATE_USABLE.md create mode 100644 wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md create mode 100644 wiki-information/events/PET_BATTLE_ACTION_SELECTED.md create mode 100644 wiki-information/events/PET_BATTLE_AURA_APPLIED.md create mode 100644 wiki-information/events/PET_BATTLE_AURA_CANCELED.md create mode 100644 wiki-information/events/PET_BATTLE_AURA_CHANGED.md create mode 100644 wiki-information/events/PET_BATTLE_CAPTURED.md create mode 100644 wiki-information/events/PET_BATTLE_CLOSE.md create mode 100644 wiki-information/events/PET_BATTLE_FINAL_ROUND.md create mode 100644 wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md create mode 100644 wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md create mode 100644 wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md create mode 100644 wiki-information/events/PET_BATTLE_OPENING_DONE.md create mode 100644 wiki-information/events/PET_BATTLE_OPENING_START.md create mode 100644 wiki-information/events/PET_BATTLE_OVER.md create mode 100644 wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md create mode 100644 wiki-information/events/PET_BATTLE_PET_CHANGED.md create mode 100644 wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md create mode 100644 wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md create mode 100644 wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md create mode 100644 wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md create mode 100644 wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md create mode 100644 wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md create mode 100644 wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md create mode 100644 wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md create mode 100644 wiki-information/events/PET_BATTLE_QUEUE_STATUS.md create mode 100644 wiki-information/events/PET_BATTLE_XP_CHANGED.md create mode 100644 wiki-information/events/PET_DISMISS_START.md create mode 100644 wiki-information/events/PET_FORCE_NAME_DECLENSION.md create mode 100644 wiki-information/events/PET_SPELL_POWER_UPDATE.md create mode 100644 wiki-information/events/PET_STABLE_CLOSED.md create mode 100644 wiki-information/events/PET_STABLE_SHOW.md create mode 100644 wiki-information/events/PET_STABLE_UPDATE.md create mode 100644 wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md create mode 100644 wiki-information/events/PET_UI_CLOSE.md create mode 100644 wiki-information/events/PET_UI_UPDATE.md create mode 100644 wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md create mode 100644 wiki-information/events/PLAYERBANKSLOTS_CHANGED.md create mode 100644 wiki-information/events/PLAYER_ALIVE.md create mode 100644 wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md create mode 100644 wiki-information/events/PLAYER_CAMPING.md create mode 100644 wiki-information/events/PLAYER_CONTROL_GAINED.md create mode 100644 wiki-information/events/PLAYER_CONTROL_LOST.md create mode 100644 wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md create mode 100644 wiki-information/events/PLAYER_DEAD.md create mode 100644 wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md create mode 100644 wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md create mode 100644 wiki-information/events/PLAYER_ENTERING_WORLD.md create mode 100644 wiki-information/events/PLAYER_ENTER_COMBAT.md create mode 100644 wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md create mode 100644 wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md create mode 100644 wiki-information/events/PLAYER_FLAGS_CHANGED.md create mode 100644 wiki-information/events/PLAYER_FOCUS_CHANGED.md create mode 100644 wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md create mode 100644 wiki-information/events/PLAYER_GUILD_UPDATE.md create mode 100644 wiki-information/events/PLAYER_LEAVE_COMBAT.md create mode 100644 wiki-information/events/PLAYER_LEAVING_WORLD.md create mode 100644 wiki-information/events/PLAYER_LEVEL_CHANGED.md create mode 100644 wiki-information/events/PLAYER_LEVEL_UP.md create mode 100644 wiki-information/events/PLAYER_LOGIN.md create mode 100644 wiki-information/events/PLAYER_LOGOUT.md create mode 100644 wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md create mode 100644 wiki-information/events/PLAYER_MONEY.md create mode 100644 wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md create mode 100644 wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md create mode 100644 wiki-information/events/PLAYER_PVP_RANK_CHANGED.md create mode 100644 wiki-information/events/PLAYER_QUITING.md create mode 100644 wiki-information/events/PLAYER_REGEN_DISABLED.md create mode 100644 wiki-information/events/PLAYER_REGEN_ENABLED.md create mode 100644 wiki-information/events/PLAYER_REPORT_SUBMITTED.md create mode 100644 wiki-information/events/PLAYER_ROLES_ASSIGNED.md create mode 100644 wiki-information/events/PLAYER_SKINNED.md create mode 100644 wiki-information/events/PLAYER_STARTED_LOOKING.md create mode 100644 wiki-information/events/PLAYER_STARTED_MOVING.md create mode 100644 wiki-information/events/PLAYER_STARTED_TURNING.md create mode 100644 wiki-information/events/PLAYER_STOPPED_LOOKING.md create mode 100644 wiki-information/events/PLAYER_STOPPED_MOVING.md create mode 100644 wiki-information/events/PLAYER_STOPPED_TURNING.md create mode 100644 wiki-information/events/PLAYER_TALENT_UPDATE.md create mode 100644 wiki-information/events/PLAYER_TARGET_CHANGED.md create mode 100644 wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md create mode 100644 wiki-information/events/PLAYER_TOTEM_UPDATE.md create mode 100644 wiki-information/events/PLAYER_TRADE_MONEY.md create mode 100644 wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md create mode 100644 wiki-information/events/PLAYER_UNGHOST.md create mode 100644 wiki-information/events/PLAYER_UPDATE_RESTING.md create mode 100644 wiki-information/events/PLAYER_XP_UPDATE.md create mode 100644 wiki-information/events/PLAY_MOVIE.md create mode 100644 wiki-information/events/PORTRAITS_UPDATED.md create mode 100644 wiki-information/events/PVP_RATED_STATS_UPDATE.md create mode 100644 wiki-information/events/PVP_TIMER_UPDATE.md create mode 100644 wiki-information/events/PVP_WORLDSTATE_UPDATE.md create mode 100644 wiki-information/events/QUEST_ACCEPTED.md create mode 100644 wiki-information/events/QUEST_ACCEPT_CONFIRM.md create mode 100644 wiki-information/events/QUEST_AUTOCOMPLETE.md create mode 100644 wiki-information/events/QUEST_BOSS_EMOTE.md create mode 100644 wiki-information/events/QUEST_COMPLETE.md create mode 100644 wiki-information/events/QUEST_DETAIL.md create mode 100644 wiki-information/events/QUEST_FINISHED.md create mode 100644 wiki-information/events/QUEST_GREETING.md create mode 100644 wiki-information/events/QUEST_ITEM_UPDATE.md create mode 100644 wiki-information/events/QUEST_LOG_UPDATE.md create mode 100644 wiki-information/events/QUEST_PROGRESS.md create mode 100644 wiki-information/events/QUEST_REMOVED.md create mode 100644 wiki-information/events/QUEST_SESSION_CREATED.md create mode 100644 wiki-information/events/QUEST_SESSION_DESTROYED.md create mode 100644 wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md create mode 100644 wiki-information/events/QUEST_SESSION_JOINED.md create mode 100644 wiki-information/events/QUEST_SESSION_LEFT.md create mode 100644 wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md create mode 100644 wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md create mode 100644 wiki-information/events/QUEST_SESSION_NOTIFICATION.md create mode 100644 wiki-information/events/QUEST_TURNED_IN.md create mode 100644 wiki-information/events/QUEST_WATCH_LIST_CHANGED.md create mode 100644 wiki-information/events/QUEST_WATCH_UPDATE.md create mode 100644 wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md create mode 100644 wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md create mode 100644 wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md create mode 100644 wiki-information/events/RAID_BOSS_EMOTE.md create mode 100644 wiki-information/events/RAID_BOSS_WHISPER.md create mode 100644 wiki-information/events/RAID_INSTANCE_WELCOME.md create mode 100644 wiki-information/events/RAID_ROSTER_UPDATE.md create mode 100644 wiki-information/events/RAID_TARGET_UPDATE.md create mode 100644 wiki-information/events/RAISED_AS_GHOUL.md create mode 100644 wiki-information/events/READY_CHECK.md create mode 100644 wiki-information/events/READY_CHECK_CONFIRM.md create mode 100644 wiki-information/events/READY_CHECK_FINISHED.md create mode 100644 wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md create mode 100644 wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md create mode 100644 wiki-information/events/REPLACE_ENCHANT.md create mode 100644 wiki-information/events/REPORT_PLAYER_RESULT.md create mode 100644 wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md create mode 100644 wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md create mode 100644 wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md create mode 100644 wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md create mode 100644 wiki-information/events/RESURRECT_REQUEST.md create mode 100644 wiki-information/events/ROLE_CHANGED_INFORM.md create mode 100644 wiki-information/events/ROLE_POLL_BEGIN.md create mode 100644 wiki-information/events/RUNE_POWER_UPDATE.md create mode 100644 wiki-information/events/RUNE_TYPE_UPDATE.md create mode 100644 wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md create mode 100644 wiki-information/events/SCREENSHOT_FAILED.md create mode 100644 wiki-information/events/SCREENSHOT_STARTED.md create mode 100644 wiki-information/events/SCREENSHOT_SUCCEEDED.md create mode 100644 wiki-information/events/SEARCH_DB_LOADED.md create mode 100644 wiki-information/events/SECURE_TRANSFER_CANCEL.md create mode 100644 wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md create mode 100644 wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md create mode 100644 wiki-information/events/SELF_RES_SPELL_CHANGED.md create mode 100644 wiki-information/events/SEND_MAIL_COD_CHANGED.md create mode 100644 wiki-information/events/SEND_MAIL_MONEY_CHANGED.md create mode 100644 wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md create mode 100644 wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md create mode 100644 wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md create mode 100644 wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md create mode 100644 wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md create mode 100644 wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md create mode 100644 wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md create mode 100644 wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md create mode 100644 wiki-information/events/SKILL_LINES_CHANGED.md create mode 100644 wiki-information/events/SOCIAL_ITEM_RECEIVED.md create mode 100644 wiki-information/events/SOCKET_INFO_ACCEPT.md create mode 100644 wiki-information/events/SOCKET_INFO_CLOSE.md create mode 100644 wiki-information/events/SOCKET_INFO_FAILURE.md create mode 100644 wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md create mode 100644 wiki-information/events/SOCKET_INFO_SUCCESS.md create mode 100644 wiki-information/events/SOCKET_INFO_UPDATE.md create mode 100644 wiki-information/events/SOUNDKIT_FINISHED.md create mode 100644 wiki-information/events/SOUND_DEVICE_UPDATE.md create mode 100644 wiki-information/events/SPELLS_CHANGED.md create mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md create mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md create mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md create mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md create mode 100644 wiki-information/events/SPELL_CONFIRMATION_PROMPT.md create mode 100644 wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md create mode 100644 wiki-information/events/SPELL_DATA_LOAD_RESULT.md create mode 100644 wiki-information/events/SPELL_POWER_CHANGED.md create mode 100644 wiki-information/events/SPELL_TEXT_UPDATE.md create mode 100644 wiki-information/events/SPELL_UPDATE_CHARGES.md create mode 100644 wiki-information/events/SPELL_UPDATE_COOLDOWN.md create mode 100644 wiki-information/events/SPELL_UPDATE_ICON.md create mode 100644 wiki-information/events/SPELL_UPDATE_USABLE.md create mode 100644 wiki-information/events/START_AUTOREPEAT_SPELL.md create mode 100644 wiki-information/events/START_LOOT_ROLL.md create mode 100644 wiki-information/events/START_TIMER.md create mode 100644 wiki-information/events/STOP_AUTOREPEAT_SPELL.md create mode 100644 wiki-information/events/STOP_MOVIE.md create mode 100644 wiki-information/events/STREAMING_ICON.md create mode 100644 wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md create mode 100644 wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md create mode 100644 wiki-information/events/SYSMSG.md create mode 100644 wiki-information/events/TABARD_CANSAVE_CHANGED.md create mode 100644 wiki-information/events/TABARD_SAVE_PENDING.md create mode 100644 wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md create mode 100644 wiki-information/events/TASK_PROGRESS_UPDATE.md create mode 100644 wiki-information/events/TAXIMAP_CLOSED.md create mode 100644 wiki-information/events/TAXIMAP_OPENED.md create mode 100644 wiki-information/events/TIME_PLAYED_MSG.md create mode 100644 wiki-information/events/TOGGLE_CONSOLE.md create mode 100644 wiki-information/events/TOKEN_AUCTION_SOLD.md create mode 100644 wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md create mode 100644 wiki-information/events/TOKEN_BUY_RESULT.md create mode 100644 wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md create mode 100644 wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md create mode 100644 wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md create mode 100644 wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md create mode 100644 wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md create mode 100644 wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md create mode 100644 wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md create mode 100644 wiki-information/events/TOKEN_REDEEM_RESULT.md create mode 100644 wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md create mode 100644 wiki-information/events/TOKEN_SELL_RESULT.md create mode 100644 wiki-information/events/TOKEN_STATUS_CHANGED.md create mode 100644 wiki-information/events/TOYS_UPDATED.md create mode 100644 wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md create mode 100644 wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md create mode 100644 wiki-information/events/TRADE_ACCEPT_UPDATE.md create mode 100644 wiki-information/events/TRADE_CLOSED.md create mode 100644 wiki-information/events/TRADE_MONEY_CHANGED.md create mode 100644 wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md create mode 100644 wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md create mode 100644 wiki-information/events/TRADE_REPLACE_ENCHANT.md create mode 100644 wiki-information/events/TRADE_REQUEST.md create mode 100644 wiki-information/events/TRADE_REQUEST_CANCEL.md create mode 100644 wiki-information/events/TRADE_SHOW.md create mode 100644 wiki-information/events/TRADE_SKILL_CLOSE.md create mode 100644 wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md create mode 100644 wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md create mode 100644 wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md create mode 100644 wiki-information/events/TRADE_SKILL_LIST_UPDATE.md create mode 100644 wiki-information/events/TRADE_SKILL_NAME_UPDATE.md create mode 100644 wiki-information/events/TRADE_SKILL_SHOW.md create mode 100644 wiki-information/events/TRADE_SKILL_UPDATE.md create mode 100644 wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md create mode 100644 wiki-information/events/TRADE_UPDATE.md create mode 100644 wiki-information/events/TRAINER_CLOSED.md create mode 100644 wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md create mode 100644 wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md create mode 100644 wiki-information/events/TRAINER_SHOW.md create mode 100644 wiki-information/events/TRAINER_UPDATE.md create mode 100644 wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md create mode 100644 wiki-information/events/TRIAL_CAP_REACHED_MONEY.md create mode 100644 wiki-information/events/TUTORIAL_TRIGGER.md create mode 100644 wiki-information/events/TWITTER_LINK_RESULT.md create mode 100644 wiki-information/events/TWITTER_POST_RESULT.md create mode 100644 wiki-information/events/TWITTER_STATUS_UPDATE.md create mode 100644 wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md create mode 100644 wiki-information/events/UI_SCALE_CHANGED.md create mode 100644 wiki-information/events/UNIT_ATTACK.md create mode 100644 wiki-information/events/UNIT_ATTACK_POWER.md create mode 100644 wiki-information/events/UNIT_ATTACK_SPEED.md create mode 100644 wiki-information/events/UNIT_AURA.md create mode 100644 wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md create mode 100644 wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md create mode 100644 wiki-information/events/UNIT_COMBAT.md create mode 100644 wiki-information/events/UNIT_CONNECTION.md create mode 100644 wiki-information/events/UNIT_DAMAGE.md create mode 100644 wiki-information/events/UNIT_DEFENSE.md create mode 100644 wiki-information/events/UNIT_DISPLAYPOWER.md create mode 100644 wiki-information/events/UNIT_ENTERED_VEHICLE.md create mode 100644 wiki-information/events/UNIT_ENTERING_VEHICLE.md create mode 100644 wiki-information/events/UNIT_EXITED_VEHICLE.md create mode 100644 wiki-information/events/UNIT_EXITING_VEHICLE.md create mode 100644 wiki-information/events/UNIT_FACTION.md create mode 100644 wiki-information/events/UNIT_FLAGS.md create mode 100644 wiki-information/events/UNIT_HAPPINESS.md create mode 100644 wiki-information/events/UNIT_HEALTH.md create mode 100644 wiki-information/events/UNIT_HEALTH_FREQUENT.md create mode 100644 wiki-information/events/UNIT_HEAL_PREDICTION.md create mode 100644 wiki-information/events/UNIT_INVENTORY_CHANGED.md create mode 100644 wiki-information/events/UNIT_LEVEL.md create mode 100644 wiki-information/events/UNIT_MANA.md create mode 100644 wiki-information/events/UNIT_MAXHEALTH.md create mode 100644 wiki-information/events/UNIT_MAXPOWER.md create mode 100644 wiki-information/events/UNIT_MODEL_CHANGED.md create mode 100644 wiki-information/events/UNIT_NAME_UPDATE.md create mode 100644 wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md create mode 100644 wiki-information/events/UNIT_PET.md create mode 100644 wiki-information/events/UNIT_PET_EXPERIENCE.md create mode 100644 wiki-information/events/UNIT_PET_TRAINING_POINTS.md create mode 100644 wiki-information/events/UNIT_PHASE.md create mode 100644 wiki-information/events/UNIT_PORTRAIT_UPDATE.md create mode 100644 wiki-information/events/UNIT_POWER_BAR_HIDE.md create mode 100644 wiki-information/events/UNIT_POWER_BAR_SHOW.md create mode 100644 wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md create mode 100644 wiki-information/events/UNIT_POWER_FREQUENT.md create mode 100644 wiki-information/events/UNIT_POWER_UPDATE.md create mode 100644 wiki-information/events/UNIT_QUEST_LOG_CHANGED.md create mode 100644 wiki-information/events/UNIT_RANGEDDAMAGE.md create mode 100644 wiki-information/events/UNIT_RANGED_ATTACK_POWER.md create mode 100644 wiki-information/events/UNIT_RESISTANCES.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_DELAYED.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_FAILED.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_SENT.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_START.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_STOP.md create mode 100644 wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md create mode 100644 wiki-information/events/UNIT_SPELL_HASTE.md create mode 100644 wiki-information/events/UNIT_STATS.md create mode 100644 wiki-information/events/UNIT_TARGET.md create mode 100644 wiki-information/events/UNIT_TARGETABLE_CHANGED.md create mode 100644 wiki-information/events/UNIT_THREAT_LIST_UPDATE.md create mode 100644 wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md create mode 100644 wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md create mode 100644 wiki-information/events/UPDATE_ALL_UI_WIDGETS.md create mode 100644 wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md create mode 100644 wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md create mode 100644 wiki-information/events/UPDATE_BINDINGS.md create mode 100644 wiki-information/events/UPDATE_BONUS_ACTIONBAR.md create mode 100644 wiki-information/events/UPDATE_CHAT_COLOR.md create mode 100644 wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md create mode 100644 wiki-information/events/UPDATE_CHAT_WINDOWS.md create mode 100644 wiki-information/events/UPDATE_EXHAUSTION.md create mode 100644 wiki-information/events/UPDATE_FACTION.md create mode 100644 wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md create mode 100644 wiki-information/events/UPDATE_INSTANCE_INFO.md create mode 100644 wiki-information/events/UPDATE_INVENTORY_ALERTS.md create mode 100644 wiki-information/events/UPDATE_INVENTORY_DURABILITY.md create mode 100644 wiki-information/events/UPDATE_LFG_LIST.md create mode 100644 wiki-information/events/UPDATE_MACROS.md create mode 100644 wiki-information/events/UPDATE_MASTER_LOOT_LIST.md create mode 100644 wiki-information/events/UPDATE_MOUSEOVER_UNIT.md create mode 100644 wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md create mode 100644 wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md create mode 100644 wiki-information/events/UPDATE_PENDING_MAIL.md create mode 100644 wiki-information/events/UPDATE_POSSESS_BAR.md create mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md create mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_FORM.md create mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md create mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md create mode 100644 wiki-information/events/UPDATE_STEALTH.md create mode 100644 wiki-information/events/UPDATE_TRADESKILL_RECAST.md create mode 100644 wiki-information/events/UPDATE_UI_WIDGET.md create mode 100644 wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md create mode 100644 wiki-information/events/UPDATE_WEB_TICKET.md create mode 100644 wiki-information/events/USE_BIND_CONFIRM.md create mode 100644 wiki-information/events/USE_GLYPH.md create mode 100644 wiki-information/events/USE_NO_REFUND_CONFIRM.md create mode 100644 wiki-information/events/VARIABLES_LOADED.md create mode 100644 wiki-information/events/VEHICLE_ANGLE_SHOW.md create mode 100644 wiki-information/events/VEHICLE_ANGLE_UPDATE.md create mode 100644 wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md create mode 100644 wiki-information/events/VEHICLE_POWER_SHOW.md create mode 100644 wiki-information/events/VEHICLE_UPDATE.md create mode 100644 wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md create mode 100644 wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md create mode 100644 wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md create mode 100644 wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md create mode 100644 wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md create mode 100644 wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_ERROR.md create mode 100644 wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md create mode 100644 wiki-information/events/VOICE_CHAT_LOGIN.md create mode 100644 wiki-information/events/VOICE_CHAT_LOGOUT.md create mode 100644 wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md create mode 100644 wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md create mode 100644 wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md create mode 100644 wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md create mode 100644 wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md create mode 100644 wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md create mode 100644 wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md create mode 100644 wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md create mode 100644 wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md create mode 100644 wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md create mode 100644 wiki-information/events/VOID_DEPOSIT_WARNING.md create mode 100644 wiki-information/events/VOID_STORAGE_CLOSE.md create mode 100644 wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md create mode 100644 wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md create mode 100644 wiki-information/events/VOID_STORAGE_OPEN.md create mode 100644 wiki-information/events/VOID_STORAGE_UPDATE.md create mode 100644 wiki-information/events/VOID_TRANSFER_DONE.md create mode 100644 wiki-information/events/VOID_TRANSFER_SUCCESS.md create mode 100644 wiki-information/events/WARFRONT_COMPLETED.md create mode 100644 wiki-information/events/WARGAME_REQUESTED.md create mode 100644 wiki-information/events/WEAR_EQUIPMENT_SET.md create mode 100644 wiki-information/events/WHO_LIST_UPDATE.md create mode 100644 wiki-information/events/WORLD_PVP_QUEUE.md create mode 100644 wiki-information/events/WORLD_STATE_TIMER_START.md create mode 100644 wiki-information/events/WORLD_STATE_TIMER_STOP.md create mode 100644 wiki-information/events/WOW_MOUSE_NOT_FOUND.md create mode 100644 wiki-information/events/ZONE_CHANGED.md create mode 100644 wiki-information/events/ZONE_CHANGED_INDOORS.md create mode 100644 wiki-information/events/ZONE_CHANGED_NEW_AREA.md create mode 100644 wiki-information/functions/AbandonQuest.md create mode 100644 wiki-information/functions/AbandonSkill.md create mode 100644 wiki-information/functions/AcceptArenaTeam.md create mode 100644 wiki-information/functions/AcceptBattlefieldPort.md create mode 100644 wiki-information/functions/AcceptDuel.md create mode 100644 wiki-information/functions/AcceptGroup.md create mode 100644 wiki-information/functions/AcceptGuild.md create mode 100644 wiki-information/functions/AcceptProposal.md create mode 100644 wiki-information/functions/AcceptQuest.md create mode 100644 wiki-information/functions/AcceptResurrect.md create mode 100644 wiki-information/functions/AcceptSockets.md create mode 100644 wiki-information/functions/AcceptSpellConfirmationPrompt.md create mode 100644 wiki-information/functions/AcceptTrade.md create mode 100644 wiki-information/functions/AcceptXPLoss.md create mode 100644 wiki-information/functions/ActionHasRange.md create mode 100644 wiki-information/functions/AddChatWindowChannel.md create mode 100644 wiki-information/functions/AddChatWindowMessages.md create mode 100644 wiki-information/functions/AddQuestWatch.md create mode 100644 wiki-information/functions/AddTrackedAchievement.md create mode 100644 wiki-information/functions/AddTradeMoney.md create mode 100644 wiki-information/functions/Ambiguate.md create mode 100644 wiki-information/functions/AreDangerousScriptsAllowed.md create mode 100644 wiki-information/functions/ArenaTeamDisband.md create mode 100644 wiki-information/functions/ArenaTeamInviteByName.md create mode 100644 wiki-information/functions/ArenaTeamLeave.md create mode 100644 wiki-information/functions/ArenaTeamRoster.md create mode 100644 wiki-information/functions/ArenaTeamSetLeaderByName.md create mode 100644 wiki-information/functions/ArenaTeamUninviteByName.md create mode 100644 wiki-information/functions/AscendStop.md create mode 100644 wiki-information/functions/AssistUnit.md create mode 100644 wiki-information/functions/AttackTarget.md create mode 100644 wiki-information/functions/AutoEquipCursorItem.md create mode 100644 wiki-information/functions/AutoStoreGuildBankItem.md create mode 100644 wiki-information/functions/BNConnected.md create mode 100644 wiki-information/functions/BNGetFOFInfo.md create mode 100644 wiki-information/functions/BNGetFriendGameAccountInfo.md create mode 100644 wiki-information/functions/BNGetFriendIndex.md create mode 100644 wiki-information/functions/BNGetFriendInfo.md create mode 100644 wiki-information/functions/BNGetFriendInfoByID.md create mode 100644 wiki-information/functions/BNGetFriendInviteInfo.md create mode 100644 wiki-information/functions/BNGetGameAccountInfo.md create mode 100644 wiki-information/functions/BNGetGameAccountInfoByGUID.md create mode 100644 wiki-information/functions/BNGetInfo.md create mode 100644 wiki-information/functions/BNGetNumFriendGameAccounts.md create mode 100644 wiki-information/functions/BNGetNumFriends.md create mode 100644 wiki-information/functions/BNSendGameData.md create mode 100644 wiki-information/functions/BNSendWhisper.md create mode 100644 wiki-information/functions/BNSetAFK.md create mode 100644 wiki-information/functions/BNSetCustomMessage.md create mode 100644 wiki-information/functions/BNSetDND.md create mode 100644 wiki-information/functions/BNSetFriendNote.md create mode 100644 wiki-information/functions/BankButtonIDToInvSlotID.md create mode 100644 wiki-information/functions/BeginTrade.md create mode 100644 wiki-information/functions/BreakUpLargeNumbers.md create mode 100644 wiki-information/functions/BuyGuildCharter.md create mode 100644 wiki-information/functions/BuyMerchantItem.md create mode 100644 wiki-information/functions/BuyStableSlot.md create mode 100644 wiki-information/functions/BuyTrainerService.md create mode 100644 wiki-information/functions/BuybackItem.md create mode 100644 wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md create mode 100644 wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md create mode 100644 wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md create mode 100644 wiki-information/functions/C_AchievementInfo.GetRewardItemID.md create mode 100644 wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md create mode 100644 wiki-information/functions/C_AchievementInfo.IsValidAchievement.md create mode 100644 wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md create mode 100644 wiki-information/functions/C_ActionBar.FindPetActionButtons.md create mode 100644 wiki-information/functions/C_ActionBar.FindSpellActionButtons.md create mode 100644 wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md create mode 100644 wiki-information/functions/C_ActionBar.HasPetActionButtons.md create mode 100644 wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md create mode 100644 wiki-information/functions/C_ActionBar.HasSpellActionButtons.md create mode 100644 wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md create mode 100644 wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md create mode 100644 wiki-information/functions/C_ActionBar.IsHarmfulAction.md create mode 100644 wiki-information/functions/C_ActionBar.IsHelpfulAction.md create mode 100644 wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md create mode 100644 wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md create mode 100644 wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md create mode 100644 wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md create mode 100644 wiki-information/functions/C_AddOns.DisableAddOn.md create mode 100644 wiki-information/functions/C_AddOns.DisableAllAddOns.md create mode 100644 wiki-information/functions/C_AddOns.DoesAddOnExist.md create mode 100644 wiki-information/functions/C_AddOns.EnableAddOn.md create mode 100644 wiki-information/functions/C_AddOns.EnableAllAddOns.md create mode 100644 wiki-information/functions/C_AddOns.GetAddOnDependencies.md create mode 100644 wiki-information/functions/C_AddOns.GetAddOnEnableState.md create mode 100644 wiki-information/functions/C_AddOns.GetAddOnInfo.md create mode 100644 wiki-information/functions/C_AddOns.GetAddOnMetadata.md create mode 100644 wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md create mode 100644 wiki-information/functions/C_AddOns.GetNumAddOns.md create mode 100644 wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md create mode 100644 wiki-information/functions/C_AddOns.IsAddOnLoadable.md create mode 100644 wiki-information/functions/C_AddOns.IsAddOnLoaded.md create mode 100644 wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md create mode 100644 wiki-information/functions/C_AddOns.LoadAddOn.md create mode 100644 wiki-information/functions/C_AddOns.SetAddonVersionCheck.md create mode 100644 wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md create mode 100644 wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md create mode 100644 wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md create mode 100644 wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md create mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md create mode 100644 wiki-information/functions/C_AzeriteEssence.ActivateEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.CanOpenUI.md create mode 100644 wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.CloseForge.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetEssences.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestones.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md create mode 100644 wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md create mode 100644 wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.IsAtForge.md create mode 100644 wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md create mode 100644 wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md create mode 100644 wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md create mode 100644 wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md create mode 100644 wiki-information/functions/C_AzeriteItem.GetPowerLevel.md create mode 100644 wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md create mode 100644 wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md create mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md create mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md create mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md create mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md create mode 100644 wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md create mode 100644 wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md create mode 100644 wiki-information/functions/C_BarberShop.Cancel.md create mode 100644 wiki-information/functions/C_BarberShop.ClearPreviewChoices.md create mode 100644 wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md create mode 100644 wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md create mode 100644 wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md create mode 100644 wiki-information/functions/C_BarberShop.GetCurrentCost.md create mode 100644 wiki-information/functions/C_BarberShop.GetViewingChrModel.md create mode 100644 wiki-information/functions/C_BarberShop.HasAnyChanges.md create mode 100644 wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md create mode 100644 wiki-information/functions/C_BarberShop.IsViewingNativeSex.md create mode 100644 wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md create mode 100644 wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md create mode 100644 wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md create mode 100644 wiki-information/functions/C_BarberShop.ResetCameraRotation.md create mode 100644 wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md create mode 100644 wiki-information/functions/C_BarberShop.RotateCamera.md create mode 100644 wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md create mode 100644 wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md create mode 100644 wiki-information/functions/C_BarberShop.SetCustomizationChoice.md create mode 100644 wiki-information/functions/C_BarberShop.SetModelDressState.md create mode 100644 wiki-information/functions/C_BarberShop.SetSelectedSex.md create mode 100644 wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md create mode 100644 wiki-information/functions/C_BarberShop.SetViewingChrModel.md create mode 100644 wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md create mode 100644 wiki-information/functions/C_BarberShop.ZoomCamera.md create mode 100644 wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md create mode 100644 wiki-information/functions/C_BattleNet.GetAccountInfoByID.md create mode 100644 wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md create mode 100644 wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md create mode 100644 wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md create mode 100644 wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md create mode 100644 wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md create mode 100644 wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md create mode 100644 wiki-information/functions/C_CVar.GetCVar.md create mode 100644 wiki-information/functions/C_CVar.GetCVarBitfield.md create mode 100644 wiki-information/functions/C_CVar.GetCVarBool.md create mode 100644 wiki-information/functions/C_CVar.GetCVarDefault.md create mode 100644 wiki-information/functions/C_CVar.GetCVarInfo.md create mode 100644 wiki-information/functions/C_CVar.RegisterCVar.md create mode 100644 wiki-information/functions/C_CVar.ResetTestCVars.md create mode 100644 wiki-information/functions/C_CVar.SetCVar.md create mode 100644 wiki-information/functions/C_CVar.SetCVarBitfield.md create mode 100644 wiki-information/functions/C_Calendar.AddEvent.md create mode 100644 wiki-information/functions/C_Calendar.AreNamesReady.md create mode 100644 wiki-information/functions/C_Calendar.CanAddEvent.md create mode 100644 wiki-information/functions/C_Calendar.CanSendInvite.md create mode 100644 wiki-information/functions/C_Calendar.CloseEvent.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventComplain.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCopy.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventPaste.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventRemove.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md create mode 100644 wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md create mode 100644 wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md create mode 100644 wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md create mode 100644 wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md create mode 100644 wiki-information/functions/C_Calendar.CreatePlayerEvent.md create mode 100644 wiki-information/functions/C_Calendar.EventAvailable.md create mode 100644 wiki-information/functions/C_Calendar.EventCanEdit.md create mode 100644 wiki-information/functions/C_Calendar.EventClearAutoApprove.md create mode 100644 wiki-information/functions/C_Calendar.EventClearLocked.md create mode 100644 wiki-information/functions/C_Calendar.EventClearModerator.md create mode 100644 wiki-information/functions/C_Calendar.EventDecline.md create mode 100644 wiki-information/functions/C_Calendar.EventGetCalendarType.md create mode 100644 wiki-information/functions/C_Calendar.EventGetClubId.md create mode 100644 wiki-information/functions/C_Calendar.EventGetInvite.md create mode 100644 wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md create mode 100644 wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md create mode 100644 wiki-information/functions/C_Calendar.EventGetSelectedInvite.md create mode 100644 wiki-information/functions/C_Calendar.EventGetStatusOptions.md create mode 100644 wiki-information/functions/C_Calendar.EventGetTextures.md create mode 100644 wiki-information/functions/C_Calendar.EventGetTypes.md create mode 100644 wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md create mode 100644 wiki-information/functions/C_Calendar.EventHasPendingInvite.md create mode 100644 wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md create mode 100644 wiki-information/functions/C_Calendar.EventInvite.md create mode 100644 wiki-information/functions/C_Calendar.EventRemoveInvite.md create mode 100644 wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md create mode 100644 wiki-information/functions/C_Calendar.EventSelectInvite.md create mode 100644 wiki-information/functions/C_Calendar.EventSetAutoApprove.md create mode 100644 wiki-information/functions/C_Calendar.EventSetClubId.md create mode 100644 wiki-information/functions/C_Calendar.EventSetDate.md create mode 100644 wiki-information/functions/C_Calendar.EventSetDescription.md create mode 100644 wiki-information/functions/C_Calendar.EventSetInviteStatus.md create mode 100644 wiki-information/functions/C_Calendar.EventSetLocked.md create mode 100644 wiki-information/functions/C_Calendar.EventSetModerator.md create mode 100644 wiki-information/functions/C_Calendar.EventSetTextureID.md create mode 100644 wiki-information/functions/C_Calendar.EventSetTime.md create mode 100644 wiki-information/functions/C_Calendar.EventSetTitle.md create mode 100644 wiki-information/functions/C_Calendar.EventSetType.md create mode 100644 wiki-information/functions/C_Calendar.EventSignUp.md create mode 100644 wiki-information/functions/C_Calendar.EventSortInvites.md create mode 100644 wiki-information/functions/C_Calendar.EventTentative.md create mode 100644 wiki-information/functions/C_Calendar.GetClubCalendarEvents.md create mode 100644 wiki-information/functions/C_Calendar.GetDayEvent.md create mode 100644 wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md create mode 100644 wiki-information/functions/C_Calendar.GetEventIndex.md create mode 100644 wiki-information/functions/C_Calendar.GetEventIndexInfo.md create mode 100644 wiki-information/functions/C_Calendar.GetEventInfo.md create mode 100644 wiki-information/functions/C_Calendar.GetFirstPendingInvite.md create mode 100644 wiki-information/functions/C_Calendar.GetGuildEventInfo.md create mode 100644 wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md create mode 100644 wiki-information/functions/C_Calendar.GetHolidayInfo.md create mode 100644 wiki-information/functions/C_Calendar.GetMaxCreateDate.md create mode 100644 wiki-information/functions/C_Calendar.GetMinDate.md create mode 100644 wiki-information/functions/C_Calendar.GetMonthInfo.md create mode 100644 wiki-information/functions/C_Calendar.GetNextClubId.md create mode 100644 wiki-information/functions/C_Calendar.GetNumDayEvents.md create mode 100644 wiki-information/functions/C_Calendar.GetNumGuildEvents.md create mode 100644 wiki-information/functions/C_Calendar.GetNumInvites.md create mode 100644 wiki-information/functions/C_Calendar.GetNumPendingInvites.md create mode 100644 wiki-information/functions/C_Calendar.GetRaidInfo.md create mode 100644 wiki-information/functions/C_Calendar.IsActionPending.md create mode 100644 wiki-information/functions/C_Calendar.IsEventOpen.md create mode 100644 wiki-information/functions/C_Calendar.MassInviteCommunity.md create mode 100644 wiki-information/functions/C_Calendar.MassInviteGuild.md create mode 100644 wiki-information/functions/C_Calendar.OpenCalendar.md create mode 100644 wiki-information/functions/C_Calendar.OpenEvent.md create mode 100644 wiki-information/functions/C_Calendar.RemoveEvent.md create mode 100644 wiki-information/functions/C_Calendar.SetAbsMonth.md create mode 100644 wiki-information/functions/C_Calendar.SetMonth.md create mode 100644 wiki-information/functions/C_Calendar.SetNextClubId.md create mode 100644 wiki-information/functions/C_Calendar.UpdateEvent.md create mode 100644 wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md create mode 100644 wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md create mode 100644 wiki-information/functions/C_ChatInfo.CanReportPlayer.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChannelShortcut.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChatLineText.md create mode 100644 wiki-information/functions/C_ChatInfo.GetChatTypeName.md create mode 100644 wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md create mode 100644 wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md create mode 100644 wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md create mode 100644 wiki-information/functions/C_ChatInfo.IsChatLineCensored.md create mode 100644 wiki-information/functions/C_ChatInfo.IsPartyChannelType.md create mode 100644 wiki-information/functions/C_ChatInfo.IsValidChatLine.md create mode 100644 wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md create mode 100644 wiki-information/functions/C_ChatInfo.ReportPlayer.md create mode 100644 wiki-information/functions/C_ChatInfo.SendAddonMessage.md create mode 100644 wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md create mode 100644 wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md create mode 100644 wiki-information/functions/C_ChatInfo.UncensorChatLine.md create mode 100644 wiki-information/functions/C_Club.AcceptInvitation.md create mode 100644 wiki-information/functions/C_Club.AddClubStreamChatChannel.md create mode 100644 wiki-information/functions/C_Club.AdvanceStreamViewMarker.md create mode 100644 wiki-information/functions/C_Club.AssignMemberRole.md create mode 100644 wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md create mode 100644 wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md create mode 100644 wiki-information/functions/C_Club.ClearClubPresenceSubscription.md create mode 100644 wiki-information/functions/C_Club.CompareBattleNetDisplayName.md create mode 100644 wiki-information/functions/C_Club.CreateClub.md create mode 100644 wiki-information/functions/C_Club.CreateStream.md create mode 100644 wiki-information/functions/C_Club.CreateTicket.md create mode 100644 wiki-information/functions/C_Club.DeclineInvitation.md create mode 100644 wiki-information/functions/C_Club.DestroyClub.md create mode 100644 wiki-information/functions/C_Club.DestroyMessage.md create mode 100644 wiki-information/functions/C_Club.DestroyStream.md create mode 100644 wiki-information/functions/C_Club.DestroyTicket.md create mode 100644 wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md create mode 100644 wiki-information/functions/C_Club.EditClub.md create mode 100644 wiki-information/functions/C_Club.EditMessage.md create mode 100644 wiki-information/functions/C_Club.EditStream.md create mode 100644 wiki-information/functions/C_Club.Flush.md create mode 100644 wiki-information/functions/C_Club.FocusCommunityStreams.md create mode 100644 wiki-information/functions/C_Club.FocusStream.md create mode 100644 wiki-information/functions/C_Club.GetAssignableRoles.md create mode 100644 wiki-information/functions/C_Club.GetAvatarIdList.md create mode 100644 wiki-information/functions/C_Club.GetClubInfo.md create mode 100644 wiki-information/functions/C_Club.GetClubMembers.md create mode 100644 wiki-information/functions/C_Club.GetClubPrivileges.md create mode 100644 wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md create mode 100644 wiki-information/functions/C_Club.GetCommunityNameResultText.md create mode 100644 wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md create mode 100644 wiki-information/functions/C_Club.GetInvitationCandidates.md create mode 100644 wiki-information/functions/C_Club.GetInvitationInfo.md create mode 100644 wiki-information/functions/C_Club.GetInvitationsForClub.md create mode 100644 wiki-information/functions/C_Club.GetInvitationsForSelf.md create mode 100644 wiki-information/functions/C_Club.GetMemberInfo.md create mode 100644 wiki-information/functions/C_Club.GetMemberInfoForSelf.md create mode 100644 wiki-information/functions/C_Club.GetMessageInfo.md create mode 100644 wiki-information/functions/C_Club.GetMessageRanges.md create mode 100644 wiki-information/functions/C_Club.GetMessagesBefore.md create mode 100644 wiki-information/functions/C_Club.GetMessagesInRange.md create mode 100644 wiki-information/functions/C_Club.GetStreamInfo.md create mode 100644 wiki-information/functions/C_Club.GetStreamViewMarker.md create mode 100644 wiki-information/functions/C_Club.GetStreams.md create mode 100644 wiki-information/functions/C_Club.GetSubscribedClubs.md create mode 100644 wiki-information/functions/C_Club.GetTickets.md create mode 100644 wiki-information/functions/C_Club.IsAccountMuted.md create mode 100644 wiki-information/functions/C_Club.IsBeginningOfStream.md create mode 100644 wiki-information/functions/C_Club.IsEnabled.md create mode 100644 wiki-information/functions/C_Club.IsRestricted.md create mode 100644 wiki-information/functions/C_Club.IsSubscribedToStream.md create mode 100644 wiki-information/functions/C_Club.KickMember.md create mode 100644 wiki-information/functions/C_Club.LeaveClub.md create mode 100644 wiki-information/functions/C_Club.RedeemTicket.md create mode 100644 wiki-information/functions/C_Club.RequestInvitationsForClub.md create mode 100644 wiki-information/functions/C_Club.RequestMoreMessagesBefore.md create mode 100644 wiki-information/functions/C_Club.RequestTicket.md create mode 100644 wiki-information/functions/C_Club.RequestTickets.md create mode 100644 wiki-information/functions/C_Club.RevokeInvitation.md create mode 100644 wiki-information/functions/C_Club.SendBattleTagFriendRequest.md create mode 100644 wiki-information/functions/C_Club.SendInvitation.md create mode 100644 wiki-information/functions/C_Club.SendMessage.md create mode 100644 wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md create mode 100644 wiki-information/functions/C_Club.SetAvatarTexture.md create mode 100644 wiki-information/functions/C_Club.SetClubMemberNote.md create mode 100644 wiki-information/functions/C_Club.SetClubPresenceSubscription.md create mode 100644 wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md create mode 100644 wiki-information/functions/C_Club.SetCommunityID.md create mode 100644 wiki-information/functions/C_Club.SetFavorite.md create mode 100644 wiki-information/functions/C_Club.SetSocialQueueingEnabled.md create mode 100644 wiki-information/functions/C_Club.ShouldAllowClubType.md create mode 100644 wiki-information/functions/C_Club.UnfocusAllStreams.md create mode 100644 wiki-information/functions/C_Club.UnfocusStream.md create mode 100644 wiki-information/functions/C_Club.ValidateText.md create mode 100644 wiki-information/functions/C_Commentator.AddPlayerOverrideName.md create mode 100644 wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md create mode 100644 wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md create mode 100644 wiki-information/functions/C_Commentator.AreTeamsSwapped.md create mode 100644 wiki-information/functions/C_Commentator.AssignPlayerToTeam.md create mode 100644 wiki-information/functions/C_Commentator.AssignPlayersToTeam.md create mode 100644 wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md create mode 100644 wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md create mode 100644 wiki-information/functions/C_Commentator.ClearCameraTarget.md create mode 100644 wiki-information/functions/C_Commentator.ClearFollowTarget.md create mode 100644 wiki-information/functions/C_Commentator.ClearLookAtTarget.md create mode 100644 wiki-information/functions/C_Commentator.EnterInstance.md create mode 100644 wiki-information/functions/C_Commentator.ExitInstance.md create mode 100644 wiki-information/functions/C_Commentator.FindSpectatedUnit.md create mode 100644 wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md create mode 100644 wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md create mode 100644 wiki-information/functions/C_Commentator.FlushCommentatorHistory.md create mode 100644 wiki-information/functions/C_Commentator.FollowPlayer.md create mode 100644 wiki-information/functions/C_Commentator.FollowUnit.md create mode 100644 wiki-information/functions/C_Commentator.ForceFollowTransition.md create mode 100644 wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md create mode 100644 wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md create mode 100644 wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md create mode 100644 wiki-information/functions/C_Commentator.GetCamera.md create mode 100644 wiki-information/functions/C_Commentator.GetCameraCollision.md create mode 100644 wiki-information/functions/C_Commentator.GetCameraPosition.md create mode 100644 wiki-information/functions/C_Commentator.GetCommentatorHistory.md create mode 100644 wiki-information/functions/C_Commentator.GetCurrentMapID.md create mode 100644 wiki-information/functions/C_Commentator.GetDampeningPercent.md create mode 100644 wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md create mode 100644 wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md create mode 100644 wiki-information/functions/C_Commentator.GetExcludeDistance.md create mode 100644 wiki-information/functions/C_Commentator.GetHardlockWeight.md create mode 100644 wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md create mode 100644 wiki-information/functions/C_Commentator.GetIndirectSpellID.md create mode 100644 wiki-information/functions/C_Commentator.GetInstanceInfo.md create mode 100644 wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md create mode 100644 wiki-information/functions/C_Commentator.GetMapInfo.md create mode 100644 wiki-information/functions/C_Commentator.GetMatchDuration.md create mode 100644 wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md create mode 100644 wiki-information/functions/C_Commentator.GetMaxNumTeams.md create mode 100644 wiki-information/functions/C_Commentator.GetMode.md create mode 100644 wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md create mode 100644 wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md create mode 100644 wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md create mode 100644 wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md create mode 100644 wiki-information/functions/C_Commentator.GetNumMaps.md create mode 100644 wiki-information/functions/C_Commentator.GetNumPlayers.md create mode 100644 wiki-information/functions/C_Commentator.GetOrCreateSeries.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerData.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerOverrideName.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md create mode 100644 wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md create mode 100644 wiki-information/functions/C_Commentator.GetPositionLerpAmount.md create mode 100644 wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md create mode 100644 wiki-information/functions/C_Commentator.GetSoftlockWeight.md create mode 100644 wiki-information/functions/C_Commentator.GetSpeedFactor.md create mode 100644 wiki-information/functions/C_Commentator.GetStartLocation.md create mode 100644 wiki-information/functions/C_Commentator.GetTeamColor.md create mode 100644 wiki-information/functions/C_Commentator.GetTeamColorByUnit.md create mode 100644 wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md create mode 100644 wiki-information/functions/C_Commentator.GetTrackedSpellID.md create mode 100644 wiki-information/functions/C_Commentator.GetTrackedSpells.md create mode 100644 wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md create mode 100644 wiki-information/functions/C_Commentator.GetUnitData.md create mode 100644 wiki-information/functions/C_Commentator.GetWargameInfo.md create mode 100644 wiki-information/functions/C_Commentator.HasTrackedAuras.md create mode 100644 wiki-information/functions/C_Commentator.IsSmartCameraLocked.md create mode 100644 wiki-information/functions/C_Commentator.IsSpectating.md create mode 100644 wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md create mode 100644 wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md create mode 100644 wiki-information/functions/C_Commentator.IsTrackedSpell.md create mode 100644 wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md create mode 100644 wiki-information/functions/C_Commentator.IsUsingSmartCamera.md create mode 100644 wiki-information/functions/C_Commentator.LookAtPlayer.md create mode 100644 wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md create mode 100644 wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md create mode 100644 wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md create mode 100644 wiki-information/functions/C_Commentator.ResetFoVTarget.md create mode 100644 wiki-information/functions/C_Commentator.ResetSeriesScores.md create mode 100644 wiki-information/functions/C_Commentator.ResetSettings.md create mode 100644 wiki-information/functions/C_Commentator.ResetTrackedAuras.md create mode 100644 wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md create mode 100644 wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md create mode 100644 wiki-information/functions/C_Commentator.SetBlocklistedAuras.md create mode 100644 wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md create mode 100644 wiki-information/functions/C_Commentator.SetCamera.md create mode 100644 wiki-information/functions/C_Commentator.SetCameraCollision.md create mode 100644 wiki-information/functions/C_Commentator.SetCameraPosition.md create mode 100644 wiki-information/functions/C_Commentator.SetCheatsEnabled.md create mode 100644 wiki-information/functions/C_Commentator.SetCommentatorHistory.md create mode 100644 wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md create mode 100644 wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md create mode 100644 wiki-information/functions/C_Commentator.SetExcludeDistance.md create mode 100644 wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md create mode 100644 wiki-information/functions/C_Commentator.SetHardlockWeight.md create mode 100644 wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md create mode 100644 wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md create mode 100644 wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md create mode 100644 wiki-information/functions/C_Commentator.SetMouseDisabled.md create mode 100644 wiki-information/functions/C_Commentator.SetMoveSpeed.md create mode 100644 wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md create mode 100644 wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md create mode 100644 wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md create mode 100644 wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md create mode 100644 wiki-information/functions/C_Commentator.SetPositionLerpAmount.md create mode 100644 wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md create mode 100644 wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md create mode 100644 wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md create mode 100644 wiki-information/functions/C_Commentator.SetSeriesScore.md create mode 100644 wiki-information/functions/C_Commentator.SetSeriesScores.md create mode 100644 wiki-information/functions/C_Commentator.SetSmartCameraLocked.md create mode 100644 wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md create mode 100644 wiki-information/functions/C_Commentator.SetSoftlockWeight.md create mode 100644 wiki-information/functions/C_Commentator.SetSpeedFactor.md create mode 100644 wiki-information/functions/C_Commentator.SetTargetHeightOffset.md create mode 100644 wiki-information/functions/C_Commentator.SetUseSmartCamera.md create mode 100644 wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md create mode 100644 wiki-information/functions/C_Commentator.StartWargame.md create mode 100644 wiki-information/functions/C_Commentator.SwapTeamSides.md create mode 100644 wiki-information/functions/C_Commentator.ToggleCheats.md create mode 100644 wiki-information/functions/C_Commentator.UpdateMapInfo.md create mode 100644 wiki-information/functions/C_Commentator.UpdatePlayerInfo.md create mode 100644 wiki-information/functions/C_Commentator.ZoomIn.md create mode 100644 wiki-information/functions/C_Commentator.ZoomOut.md create mode 100644 wiki-information/functions/C_Console.GetAllCommands.md create mode 100644 wiki-information/functions/C_Console.GetColorFromType.md create mode 100644 wiki-information/functions/C_Console.GetFontHeight.md create mode 100644 wiki-information/functions/C_Console.PrintAllMatchingCommands.md create mode 100644 wiki-information/functions/C_Console.SetFontHeight.md create mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md create mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md create mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetElements.md create mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md create mode 100644 wiki-information/functions/C_Container.ContainerIDToInventoryID.md create mode 100644 wiki-information/functions/C_Container.ContainerRefundItemPurchase.md create mode 100644 wiki-information/functions/C_Container.GetBagName.md create mode 100644 wiki-information/functions/C_Container.GetBagSlotFlag.md create mode 100644 wiki-information/functions/C_Container.GetContainerFreeSlots.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemCooldown.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemDurability.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemID.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemInfo.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemLink.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md create mode 100644 wiki-information/functions/C_Container.GetContainerItemQuestInfo.md create mode 100644 wiki-information/functions/C_Container.GetContainerNumFreeSlots.md create mode 100644 wiki-information/functions/C_Container.GetContainerNumSlots.md create mode 100644 wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md create mode 100644 wiki-information/functions/C_Container.GetItemCooldown.md create mode 100644 wiki-information/functions/C_Container.IsContainerFiltered.md create mode 100644 wiki-information/functions/C_Container.PickupContainerItem.md create mode 100644 wiki-information/functions/C_Container.SetBagPortraitTexture.md create mode 100644 wiki-information/functions/C_Container.SetBagSlotFlag.md create mode 100644 wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md create mode 100644 wiki-information/functions/C_Container.SetItemSearch.md create mode 100644 wiki-information/functions/C_Container.ShowContainerSellCursor.md create mode 100644 wiki-information/functions/C_Container.SocketContainerItem.md create mode 100644 wiki-information/functions/C_Container.SplitContainerItem.md create mode 100644 wiki-information/functions/C_Container.UseContainerItem.md create mode 100644 wiki-information/functions/C_CreatureInfo.GetClassInfo.md create mode 100644 wiki-information/functions/C_CreatureInfo.GetFactionInfo.md create mode 100644 wiki-information/functions/C_CreatureInfo.GetRaceInfo.md create mode 100644 wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md create mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md create mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md create mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md create mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md create mode 100644 wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md create mode 100644 wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md create mode 100644 wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md create mode 100644 wiki-information/functions/C_Cursor.GetCursorItem.md create mode 100644 wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md create mode 100644 wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md create mode 100644 wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md create mode 100644 wiki-information/functions/C_DateAndTime.CompareCalendarTime.md create mode 100644 wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md create mode 100644 wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md create mode 100644 wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md create mode 100644 wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md create mode 100644 wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md create mode 100644 wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md create mode 100644 wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md create mode 100644 wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md create mode 100644 wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md create mode 100644 wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md create mode 100644 wiki-information/functions/C_Engraving.AddCategoryFilter.md create mode 100644 wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md create mode 100644 wiki-information/functions/C_Engraving.CastRune.md create mode 100644 wiki-information/functions/C_Engraving.ClearCategoryFilter.md create mode 100644 wiki-information/functions/C_Engraving.EnableEquippedFilter.md create mode 100644 wiki-information/functions/C_Engraving.GetCurrentRuneCast.md create mode 100644 wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md create mode 100644 wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md create mode 100644 wiki-information/functions/C_Engraving.GetNumRunesKnown.md create mode 100644 wiki-information/functions/C_Engraving.GetRuneCategories.md create mode 100644 wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md create mode 100644 wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md create mode 100644 wiki-information/functions/C_Engraving.GetRunesForCategory.md create mode 100644 wiki-information/functions/C_Engraving.HasCategoryFilter.md create mode 100644 wiki-information/functions/C_Engraving.IsEngravingEnabled.md create mode 100644 wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md create mode 100644 wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md create mode 100644 wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md create mode 100644 wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md create mode 100644 wiki-information/functions/C_Engraving.IsKnownRuneSpell.md create mode 100644 wiki-information/functions/C_Engraving.IsRuneEquipped.md create mode 100644 wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md create mode 100644 wiki-information/functions/C_Engraving.SetSearchFilter.md create mode 100644 wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md create mode 100644 wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md create mode 100644 wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md create mode 100644 wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md create mode 100644 wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetItemIDs.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetItemLocations.md create mode 100644 wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md create mode 100644 wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md create mode 100644 wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md create mode 100644 wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md create mode 100644 wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md create mode 100644 wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md create mode 100644 wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md create mode 100644 wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md create mode 100644 wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md create mode 100644 wiki-information/functions/C_EventUtils.IsEventValid.md create mode 100644 wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md create mode 100644 wiki-information/functions/C_FriendList.AddFriend.md create mode 100644 wiki-information/functions/C_FriendList.AddIgnore.md create mode 100644 wiki-information/functions/C_FriendList.AddOrDelIgnore.md create mode 100644 wiki-information/functions/C_FriendList.AddOrRemoveFriend.md create mode 100644 wiki-information/functions/C_FriendList.DelIgnore.md create mode 100644 wiki-information/functions/C_FriendList.DelIgnoreByIndex.md create mode 100644 wiki-information/functions/C_FriendList.GetFriendInfo.md create mode 100644 wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md create mode 100644 wiki-information/functions/C_FriendList.GetIgnoreName.md create mode 100644 wiki-information/functions/C_FriendList.GetNumFriends.md create mode 100644 wiki-information/functions/C_FriendList.GetNumIgnores.md create mode 100644 wiki-information/functions/C_FriendList.GetNumOnlineFriends.md create mode 100644 wiki-information/functions/C_FriendList.GetNumWhoResults.md create mode 100644 wiki-information/functions/C_FriendList.GetSelectedFriend.md create mode 100644 wiki-information/functions/C_FriendList.GetSelectedIgnore.md create mode 100644 wiki-information/functions/C_FriendList.GetWhoInfo.md create mode 100644 wiki-information/functions/C_FriendList.IsFriend.md create mode 100644 wiki-information/functions/C_FriendList.IsIgnored.md create mode 100644 wiki-information/functions/C_FriendList.IsIgnoredByGuid.md create mode 100644 wiki-information/functions/C_FriendList.IsOnIgnoredList.md create mode 100644 wiki-information/functions/C_FriendList.RemoveFriend.md create mode 100644 wiki-information/functions/C_FriendList.RemoveFriendByIndex.md create mode 100644 wiki-information/functions/C_FriendList.SendWho.md create mode 100644 wiki-information/functions/C_FriendList.SetFriendNotes.md create mode 100644 wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md create mode 100644 wiki-information/functions/C_FriendList.SetSelectedFriend.md create mode 100644 wiki-information/functions/C_FriendList.SetSelectedIgnore.md create mode 100644 wiki-information/functions/C_FriendList.SetWhoToUi.md create mode 100644 wiki-information/functions/C_FriendList.ShowFriends.md create mode 100644 wiki-information/functions/C_FriendList.SortWho.md create mode 100644 wiki-information/functions/C_FunctionContainers.CreateCallback.md create mode 100644 wiki-information/functions/C_GamePad.AddSDLMapping.md create mode 100644 wiki-information/functions/C_GamePad.ApplyConfigs.md create mode 100644 wiki-information/functions/C_GamePad.AxisIndexToConfigName.md create mode 100644 wiki-information/functions/C_GamePad.ButtonBindingToIndex.md create mode 100644 wiki-information/functions/C_GamePad.ButtonIndexToBinding.md create mode 100644 wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md create mode 100644 wiki-information/functions/C_GamePad.ClearLedColor.md create mode 100644 wiki-information/functions/C_GamePad.DeleteConfig.md create mode 100644 wiki-information/functions/C_GamePad.GetActiveDeviceID.md create mode 100644 wiki-information/functions/C_GamePad.GetAllConfigIDs.md create mode 100644 wiki-information/functions/C_GamePad.GetAllDeviceIDs.md create mode 100644 wiki-information/functions/C_GamePad.GetCombinedDeviceID.md create mode 100644 wiki-information/functions/C_GamePad.GetConfig.md create mode 100644 wiki-information/functions/C_GamePad.GetDeviceMappedState.md create mode 100644 wiki-information/functions/C_GamePad.GetDeviceRawState.md create mode 100644 wiki-information/functions/C_GamePad.GetLedColor.md create mode 100644 wiki-information/functions/C_GamePad.GetPowerLevel.md create mode 100644 wiki-information/functions/C_GamePad.IsEnabled.md create mode 100644 wiki-information/functions/C_GamePad.SetConfig.md create mode 100644 wiki-information/functions/C_GamePad.SetLedColor.md create mode 100644 wiki-information/functions/C_GamePad.SetVibration.md create mode 100644 wiki-information/functions/C_GamePad.StickIndexToConfigName.md create mode 100644 wiki-information/functions/C_GamePad.StopVibration.md create mode 100644 wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md create mode 100644 wiki-information/functions/C_GossipInfo.CloseGossip.md create mode 100644 wiki-information/functions/C_GossipInfo.ForceGossip.md create mode 100644 wiki-information/functions/C_GossipInfo.GetActiveQuests.md create mode 100644 wiki-information/functions/C_GossipInfo.GetAvailableQuests.md create mode 100644 wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md create mode 100644 wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md create mode 100644 wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md create mode 100644 wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md create mode 100644 wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md create mode 100644 wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md create mode 100644 wiki-information/functions/C_GossipInfo.GetOptions.md create mode 100644 wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md create mode 100644 wiki-information/functions/C_GossipInfo.GetPoiInfo.md create mode 100644 wiki-information/functions/C_GossipInfo.GetText.md create mode 100644 wiki-information/functions/C_GossipInfo.SelectActiveQuest.md create mode 100644 wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md create mode 100644 wiki-information/functions/C_GossipInfo.SelectOption.md create mode 100644 wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md create mode 100644 wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md create mode 100644 wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md create mode 100644 wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md create mode 100644 wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md create mode 100644 wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md create mode 100644 wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md create mode 100644 wiki-information/functions/C_GuildInfo.GuildRoster.md create mode 100644 wiki-information/functions/C_GuildInfo.IsGuildOfficer.md create mode 100644 wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md create mode 100644 wiki-information/functions/C_GuildInfo.MemberExistsByName.md create mode 100644 wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md create mode 100644 wiki-information/functions/C_GuildInfo.RemoveFromGuild.md create mode 100644 wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md create mode 100644 wiki-information/functions/C_GuildInfo.SetNote.md create mode 100644 wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md create mode 100644 wiki-information/functions/C_Heirloom.GetHeirloomInfo.md create mode 100644 wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md create mode 100644 wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md create mode 100644 wiki-information/functions/C_Item.DoesItemExist.md create mode 100644 wiki-information/functions/C_Item.DoesItemExistByID.md create mode 100644 wiki-information/functions/C_Item.GetCurrentItemLevel.md create mode 100644 wiki-information/functions/C_Item.GetItemGUID.md create mode 100644 wiki-information/functions/C_Item.GetItemID.md create mode 100644 wiki-information/functions/C_Item.GetItemIDForItemInfo.md create mode 100644 wiki-information/functions/C_Item.GetItemIcon.md create mode 100644 wiki-information/functions/C_Item.GetItemIconByID.md create mode 100644 wiki-information/functions/C_Item.GetItemInventoryType.md create mode 100644 wiki-information/functions/C_Item.GetItemInventoryTypeByID.md create mode 100644 wiki-information/functions/C_Item.GetItemLink.md create mode 100644 wiki-information/functions/C_Item.GetItemMaxStackSize.md create mode 100644 wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md create mode 100644 wiki-information/functions/C_Item.GetItemName.md create mode 100644 wiki-information/functions/C_Item.GetItemNameByID.md create mode 100644 wiki-information/functions/C_Item.GetItemQuality.md create mode 100644 wiki-information/functions/C_Item.GetItemQualityByID.md create mode 100644 wiki-information/functions/C_Item.GetStackCount.md create mode 100644 wiki-information/functions/C_Item.IsBound.md create mode 100644 wiki-information/functions/C_Item.IsItemDataCached.md create mode 100644 wiki-information/functions/C_Item.IsItemDataCachedByID.md create mode 100644 wiki-information/functions/C_Item.IsLocked.md create mode 100644 wiki-information/functions/C_Item.LockItem.md create mode 100644 wiki-information/functions/C_Item.LockItemByGUID.md create mode 100644 wiki-information/functions/C_Item.RequestLoadItemData.md create mode 100644 wiki-information/functions/C_Item.RequestLoadItemDataByID.md create mode 100644 wiki-information/functions/C_Item.UnlockItem.md create mode 100644 wiki-information/functions/C_Item.UnlockItemByGUID.md create mode 100644 wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md create mode 100644 wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md create mode 100644 wiki-information/functions/C_KeyBindings.GetBindingIndex.md create mode 100644 wiki-information/functions/C_KeyBindings.GetCustomBindingType.md create mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md create mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md create mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md create mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md create mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md create mode 100644 wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md create mode 100644 wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md create mode 100644 wiki-information/functions/C_LFGInfo.GetLFDLockStates.md create mode 100644 wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md create mode 100644 wiki-information/functions/C_LFGInfo.HideNameFromUI.md create mode 100644 wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md create mode 100644 wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md create mode 100644 wiki-information/functions/C_LFGInfo.IsLFDEnabled.md create mode 100644 wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md create mode 100644 wiki-information/functions/C_LFGInfo.IsLFREnabled.md create mode 100644 wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md create mode 100644 wiki-information/functions/C_LFGList.ApplyToGroup.md create mode 100644 wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md create mode 100644 wiki-information/functions/C_LFGList.CanCreateQuestGroup.md create mode 100644 wiki-information/functions/C_LFGList.ClearApplicationTextFields.md create mode 100644 wiki-information/functions/C_LFGList.ClearCreationTextFields.md create mode 100644 wiki-information/functions/C_LFGList.ClearSearchResults.md create mode 100644 wiki-information/functions/C_LFGList.ClearSearchTextFields.md create mode 100644 wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md create mode 100644 wiki-information/functions/C_LFGList.CreateListing.md create mode 100644 wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md create mode 100644 wiki-information/functions/C_LFGList.GetActiveEntryInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetActivityFullName.md create mode 100644 wiki-information/functions/C_LFGList.GetActivityGroupInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetActivityInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md create mode 100644 wiki-information/functions/C_LFGList.GetActivityInfoTable.md create mode 100644 wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md create mode 100644 wiki-information/functions/C_LFGList.GetApplicantInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetApplicantMemberStats.md create mode 100644 wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md create mode 100644 wiki-information/functions/C_LFGList.GetApplicants.md create mode 100644 wiki-information/functions/C_LFGList.GetAvailableActivities.md create mode 100644 wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md create mode 100644 wiki-information/functions/C_LFGList.GetAvailableCategories.md create mode 100644 wiki-information/functions/C_LFGList.GetCategoryInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetFilteredSearchResults.md create mode 100644 wiki-information/functions/C_LFGList.GetKeystoneForActivity.md create mode 100644 wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetRoles.md create mode 100644 wiki-information/functions/C_LFGList.GetSearchResultInfo.md create mode 100644 wiki-information/functions/C_LFGList.GetSearchResults.md create mode 100644 wiki-information/functions/C_LFGList.HasActiveEntryInfo.md create mode 100644 wiki-information/functions/C_LFGList.HasSearchResultInfo.md create mode 100644 wiki-information/functions/C_LFGList.InviteApplicant.md create mode 100644 wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md create mode 100644 wiki-information/functions/C_LFGList.RemoveListing.md create mode 100644 wiki-information/functions/C_LFGList.RequestAvailableActivities.md create mode 100644 wiki-information/functions/C_LFGList.SetRoles.md create mode 100644 wiki-information/functions/C_LFGList.SetSearchToQuestID.md create mode 100644 wiki-information/functions/C_LFGList.UpdateListing.md create mode 100644 wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md create mode 100644 wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md create mode 100644 wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md create mode 100644 wiki-information/functions/C_LootHistory.GetItem.md create mode 100644 wiki-information/functions/C_LootHistory.GetPlayerInfo.md create mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md create mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md create mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md create mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md create mode 100644 wiki-information/functions/C_Mail.HasInboxMoney.md create mode 100644 wiki-information/functions/C_Mail.IsCommandPending.md create mode 100644 wiki-information/functions/C_Map.GetAreaInfo.md create mode 100644 wiki-information/functions/C_Map.GetBestMapForUnit.md create mode 100644 wiki-information/functions/C_Map.GetBountySetIDForMap.md create mode 100644 wiki-information/functions/C_Map.GetFallbackWorldMapID.md create mode 100644 wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md create mode 100644 wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md create mode 100644 wiki-information/functions/C_Map.GetMapArtID.md create mode 100644 wiki-information/functions/C_Map.GetMapArtLayerTextures.md create mode 100644 wiki-information/functions/C_Map.GetMapArtLayers.md create mode 100644 wiki-information/functions/C_Map.GetMapBannersForMap.md create mode 100644 wiki-information/functions/C_Map.GetMapChildrenInfo.md create mode 100644 wiki-information/functions/C_Map.GetMapDisplayInfo.md create mode 100644 wiki-information/functions/C_Map.GetMapGroupID.md create mode 100644 wiki-information/functions/C_Map.GetMapGroupMembersInfo.md create mode 100644 wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md create mode 100644 wiki-information/functions/C_Map.GetMapInfo.md create mode 100644 wiki-information/functions/C_Map.GetMapInfoAtPosition.md create mode 100644 wiki-information/functions/C_Map.GetMapLevels.md create mode 100644 wiki-information/functions/C_Map.GetMapLinksForMap.md create mode 100644 wiki-information/functions/C_Map.GetMapPosFromWorldPos.md create mode 100644 wiki-information/functions/C_Map.GetMapRectOnMap.md create mode 100644 wiki-information/functions/C_Map.GetPlayerMapPosition.md create mode 100644 wiki-information/functions/C_Map.GetWorldPosFromMapPos.md create mode 100644 wiki-information/functions/C_Map.MapHasArt.md create mode 100644 wiki-information/functions/C_Map.RequestPreloadMap.md create mode 100644 wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md create mode 100644 wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md create mode 100644 wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md create mode 100644 wiki-information/functions/C_Minimap.GetNumTrackingTypes.md create mode 100644 wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md create mode 100644 wiki-information/functions/C_Minimap.GetPOITextureCoords.md create mode 100644 wiki-information/functions/C_Minimap.GetTrackingInfo.md create mode 100644 wiki-information/functions/C_Minimap.SetTracking.md create mode 100644 wiki-information/functions/C_ModelInfo.AddActiveModelScene.md create mode 100644 wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md create mode 100644 wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md create mode 100644 wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md create mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md create mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md create mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md create mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md create mode 100644 wiki-information/functions/C_MountJournal.ClearFanfare.md create mode 100644 wiki-information/functions/C_MountJournal.ClearRecentFanfares.md create mode 100644 wiki-information/functions/C_MountJournal.Dismiss.md create mode 100644 wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md create mode 100644 wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md create mode 100644 wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md create mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md create mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountID.md create mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md create mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md create mode 100644 wiki-information/functions/C_MountJournal.GetIsFavorite.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountFromItem.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountFromSpell.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountIDs.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountInfoByID.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountLink.md create mode 100644 wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md create mode 100644 wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md create mode 100644 wiki-information/functions/C_MountJournal.GetNumMounts.md create mode 100644 wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md create mode 100644 wiki-information/functions/C_MountJournal.IsSourceChecked.md create mode 100644 wiki-information/functions/C_MountJournal.IsTypeChecked.md create mode 100644 wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md create mode 100644 wiki-information/functions/C_MountJournal.IsValidSourceFilter.md create mode 100644 wiki-information/functions/C_MountJournal.IsValidTypeFilter.md create mode 100644 wiki-information/functions/C_MountJournal.NeedsFanfare.md create mode 100644 wiki-information/functions/C_MountJournal.Pickup.md create mode 100644 wiki-information/functions/C_MountJournal.SetAllSourceFilters.md create mode 100644 wiki-information/functions/C_MountJournal.SetAllTypeFilters.md create mode 100644 wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md create mode 100644 wiki-information/functions/C_MountJournal.SetDefaultFilters.md create mode 100644 wiki-information/functions/C_MountJournal.SetIsFavorite.md create mode 100644 wiki-information/functions/C_MountJournal.SetSearch.md create mode 100644 wiki-information/functions/C_MountJournal.SetSourceFilter.md create mode 100644 wiki-information/functions/C_MountJournal.SetTypeFilter.md create mode 100644 wiki-information/functions/C_MountJournal.SummonByID.md create mode 100644 wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md create mode 100644 wiki-information/functions/C_NamePlate.GetNamePlates.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md create mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md create mode 100644 wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md create mode 100644 wiki-information/functions/C_NewItems.ClearAll.md create mode 100644 wiki-information/functions/C_NewItems.IsNewItem.md create mode 100644 wiki-information/functions/C_NewItems.RemoveNewItem.md create mode 100644 wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md create mode 100644 wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md create mode 100644 wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md create mode 100644 wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md create mode 100644 wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md create mode 100644 wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md create mode 100644 wiki-information/functions/C_PartyInfo.GetActiveCategories.md create mode 100644 wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md create mode 100644 wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md create mode 100644 wiki-information/functions/C_PartyInfo.IsPartyFull.md create mode 100644 wiki-information/functions/C_PetJournal.ClearSearchFilter.md create mode 100644 wiki-information/functions/C_PetJournal.FindPetIDByName.md create mode 100644 wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md create mode 100644 wiki-information/functions/C_PetJournal.GetNumPetSources.md create mode 100644 wiki-information/functions/C_PetJournal.GetNumPetTypes.md create mode 100644 wiki-information/functions/C_PetJournal.GetNumPets.md create mode 100644 wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md create mode 100644 wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md create mode 100644 wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md create mode 100644 wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md create mode 100644 wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md create mode 100644 wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md create mode 100644 wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md create mode 100644 wiki-information/functions/C_PetJournal.GetPetSortParameter.md create mode 100644 wiki-information/functions/C_PetJournal.GetPetSummonInfo.md create mode 100644 wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md create mode 100644 wiki-information/functions/C_PetJournal.IsFilterChecked.md create mode 100644 wiki-information/functions/C_PetJournal.IsPetSourceChecked.md create mode 100644 wiki-information/functions/C_PetJournal.IsPetTypeChecked.md create mode 100644 wiki-information/functions/C_PetJournal.PetIsFavorite.md create mode 100644 wiki-information/functions/C_PetJournal.PetIsRevoked.md create mode 100644 wiki-information/functions/C_PetJournal.PetIsSummonable.md create mode 100644 wiki-information/functions/C_PetJournal.PickupPet.md create mode 100644 wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md create mode 100644 wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md create mode 100644 wiki-information/functions/C_PetJournal.SetFavorite.md create mode 100644 wiki-information/functions/C_PetJournal.SetFilterChecked.md create mode 100644 wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md create mode 100644 wiki-information/functions/C_PetJournal.SetPetSortParameter.md create mode 100644 wiki-information/functions/C_PetJournal.SetPetSourceChecked.md create mode 100644 wiki-information/functions/C_PetJournal.SetPetTypeFilter.md create mode 100644 wiki-information/functions/C_PetJournal.SetSearchFilter.md create mode 100644 wiki-information/functions/C_PetJournal.SummonPetByGUID.md create mode 100644 wiki-information/functions/C_PlayerInfo.CanUseItem.md create mode 100644 wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetClass.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetDisplayID.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetName.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetRace.md create mode 100644 wiki-information/functions/C_PlayerInfo.GetSex.md create mode 100644 wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md create mode 100644 wiki-information/functions/C_PlayerInfo.IsConnected.md create mode 100644 wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md create mode 100644 wiki-information/functions/C_PlayerInfo.IsMirrorImage.md create mode 100644 wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md create mode 100644 wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md create mode 100644 wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md create mode 100644 wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md create mode 100644 wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md create mode 100644 wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md create mode 100644 wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md create mode 100644 wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md create mode 100644 wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md create mode 100644 wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md create mode 100644 wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md create mode 100644 wiki-information/functions/C_PvP.GetBattlefieldVehicles.md create mode 100644 wiki-information/functions/C_PvP.GetRandomBGRewards.md create mode 100644 wiki-information/functions/C_PvP.IsInBrawl.md create mode 100644 wiki-information/functions/C_PvP.IsPVPMap.md create mode 100644 wiki-information/functions/C_PvP.IsRatedMap.md create mode 100644 wiki-information/functions/C_PvP.RequestCrowdControlSpell.md create mode 100644 wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md create mode 100644 wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md create mode 100644 wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md create mode 100644 wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md create mode 100644 wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md create mode 100644 wiki-information/functions/C_QuestLog.GetMaxNumQuests.md create mode 100644 wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md create mode 100644 wiki-information/functions/C_QuestLog.GetQuestInfo.md create mode 100644 wiki-information/functions/C_QuestLog.GetQuestObjectives.md create mode 100644 wiki-information/functions/C_QuestLog.GetQuestsOnMap.md create mode 100644 wiki-information/functions/C_QuestLog.IsOnQuest.md create mode 100644 wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md create mode 100644 wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md create mode 100644 wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md create mode 100644 wiki-information/functions/C_QuestSession.CanStart.md create mode 100644 wiki-information/functions/C_QuestSession.CanStop.md create mode 100644 wiki-information/functions/C_QuestSession.Exists.md create mode 100644 wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md create mode 100644 wiki-information/functions/C_QuestSession.GetPendingCommand.md create mode 100644 wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md create mode 100644 wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md create mode 100644 wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md create mode 100644 wiki-information/functions/C_QuestSession.HasJoined.md create mode 100644 wiki-information/functions/C_QuestSession.HasPendingCommand.md create mode 100644 wiki-information/functions/C_QuestSession.RequestSessionStart.md create mode 100644 wiki-information/functions/C_QuestSession.RequestSessionStop.md create mode 100644 wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md create mode 100644 wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md create mode 100644 wiki-information/functions/C_RaidLocks.IsEncounterComplete.md create mode 100644 wiki-information/functions/C_ReportSystem.CanReportPlayer.md create mode 100644 wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md create mode 100644 wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md create mode 100644 wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md create mode 100644 wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md create mode 100644 wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md create mode 100644 wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md create mode 100644 wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md create mode 100644 wiki-information/functions/C_ReportSystem.ReportServerLag.md create mode 100644 wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md create mode 100644 wiki-information/functions/C_ReportSystem.SendReport.md create mode 100644 wiki-information/functions/C_ReportSystem.SendReportPlayer.md create mode 100644 wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md create mode 100644 wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md create mode 100644 wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md create mode 100644 wiki-information/functions/C_Reputation.GetFactionParagonInfo.md create mode 100644 wiki-information/functions/C_Reputation.IsFactionParagon.md create mode 100644 wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md create mode 100644 wiki-information/functions/C_Reputation.SetWatchedFaction.md create mode 100644 wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md create mode 100644 wiki-information/functions/C_Seasons.GetActiveSeason.md create mode 100644 wiki-information/functions/C_Seasons.HasActiveSeason.md create mode 100644 wiki-information/functions/C_Social.GetLastItem.md create mode 100644 wiki-information/functions/C_Social.GetLastScreenshot.md create mode 100644 wiki-information/functions/C_Social.GetNumCharactersPerMedia.md create mode 100644 wiki-information/functions/C_Social.GetScreenshotByIndex.md create mode 100644 wiki-information/functions/C_Social.GetTweetLength.md create mode 100644 wiki-information/functions/C_Social.IsSocialEnabled.md create mode 100644 wiki-information/functions/C_Social.TwitterCheckStatus.md create mode 100644 wiki-information/functions/C_Social.TwitterConnect.md create mode 100644 wiki-information/functions/C_Social.TwitterDisconnect.md create mode 100644 wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md create mode 100644 wiki-information/functions/C_Social.TwitterPostMessage.md create mode 100644 wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md create mode 100644 wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md create mode 100644 wiki-information/functions/C_SocialRestrictions.IsMuted.md create mode 100644 wiki-information/functions/C_SocialRestrictions.IsSilenced.md create mode 100644 wiki-information/functions/C_SocialRestrictions.IsSquelched.md create mode 100644 wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md create mode 100644 wiki-information/functions/C_Sound.GetSoundScaledVolume.md create mode 100644 wiki-information/functions/C_Sound.IsPlaying.md create mode 100644 wiki-information/functions/C_Sound.PlayItemSound.md create mode 100644 wiki-information/functions/C_Spell.DoesSpellExist.md create mode 100644 wiki-information/functions/C_Spell.IsSpellDataCached.md create mode 100644 wiki-information/functions/C_Spell.RequestLoadSpellData.md create mode 100644 wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md create mode 100644 wiki-information/functions/C_StableInfo.GetNumActivePets.md create mode 100644 wiki-information/functions/C_StableInfo.GetNumStablePets.md create mode 100644 wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md create mode 100644 wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md create mode 100644 wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md create mode 100644 wiki-information/functions/C_StorePublic.IsEnabled.md create mode 100644 wiki-information/functions/C_SummonInfo.CancelSummon.md create mode 100644 wiki-information/functions/C_SummonInfo.ConfirmSummon.md create mode 100644 wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md create mode 100644 wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md create mode 100644 wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md create mode 100644 wiki-information/functions/C_SummonInfo.GetSummonReason.md create mode 100644 wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md create mode 100644 wiki-information/functions/C_System.GetFrameStack.md create mode 100644 wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md create mode 100644 wiki-information/functions/C_TTSSettings.GetChannelEnabled.md create mode 100644 wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md create mode 100644 wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md create mode 100644 wiki-information/functions/C_TTSSettings.GetSetting.md create mode 100644 wiki-information/functions/C_TTSSettings.GetSpeechRate.md create mode 100644 wiki-information/functions/C_TTSSettings.GetSpeechVolume.md create mode 100644 wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md create mode 100644 wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md create mode 100644 wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md create mode 100644 wiki-information/functions/C_TTSSettings.SetChannelEnabled.md create mode 100644 wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md create mode 100644 wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md create mode 100644 wiki-information/functions/C_TTSSettings.SetDefaultSettings.md create mode 100644 wiki-information/functions/C_TTSSettings.SetSetting.md create mode 100644 wiki-information/functions/C_TTSSettings.SetSpeechRate.md create mode 100644 wiki-information/functions/C_TTSSettings.SetSpeechVolume.md create mode 100644 wiki-information/functions/C_TTSSettings.SetVoiceOption.md create mode 100644 wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md create mode 100644 wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md create mode 100644 wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md create mode 100644 wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md create mode 100644 wiki-information/functions/C_TaskQuest.GetQuestLocation.md create mode 100644 wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md create mode 100644 wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md create mode 100644 wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md create mode 100644 wiki-information/functions/C_TaskQuest.GetQuestZoneID.md create mode 100644 wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md create mode 100644 wiki-information/functions/C_TaskQuest.GetThreatQuests.md create mode 100644 wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md create mode 100644 wiki-information/functions/C_TaskQuest.IsActive.md create mode 100644 wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md create mode 100644 wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md create mode 100644 wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md create mode 100644 wiki-information/functions/C_Texture.ClearTitleIconTexture.md create mode 100644 wiki-information/functions/C_Texture.GetAtlasElementID.md create mode 100644 wiki-information/functions/C_Texture.GetAtlasID.md create mode 100644 wiki-information/functions/C_Texture.GetAtlasInfo.md create mode 100644 wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md create mode 100644 wiki-information/functions/C_Texture.GetTitleIconTexture.md create mode 100644 wiki-information/functions/C_Texture.IsTitleIconTextureReady.md create mode 100644 wiki-information/functions/C_Texture.SetTitleIconTexture.md create mode 100644 wiki-information/functions/C_Timer.After.md create mode 100644 wiki-information/functions/C_Timer.NewTicker.md create mode 100644 wiki-information/functions/C_Timer.NewTimer.md create mode 100644 wiki-information/functions/C_ToyBox.GetNumToys.md create mode 100644 wiki-information/functions/C_ToyBox.GetToyFromIndex.md create mode 100644 wiki-information/functions/C_ToyBox.GetToyInfo.md create mode 100644 wiki-information/functions/C_ToyBox.GetToyLink.md create mode 100644 wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md create mode 100644 wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md create mode 100644 wiki-information/functions/C_Traits.CanPurchaseRank.md create mode 100644 wiki-information/functions/C_Traits.CanRefundRank.md create mode 100644 wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md create mode 100644 wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md create mode 100644 wiki-information/functions/C_Traits.CommitConfig.md create mode 100644 wiki-information/functions/C_Traits.ConfigHasStagedChanges.md create mode 100644 wiki-information/functions/C_Traits.GenerateImportString.md create mode 100644 wiki-information/functions/C_Traits.GenerateInspectImportString.md create mode 100644 wiki-information/functions/C_Traits.GetConditionInfo.md create mode 100644 wiki-information/functions/C_Traits.GetConfigIDBySystemID.md create mode 100644 wiki-information/functions/C_Traits.GetConfigIDByTreeID.md create mode 100644 wiki-information/functions/C_Traits.GetConfigInfo.md create mode 100644 wiki-information/functions/C_Traits.GetConfigsByType.md create mode 100644 wiki-information/functions/C_Traits.GetDefinitionInfo.md create mode 100644 wiki-information/functions/C_Traits.GetEntryInfo.md create mode 100644 wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md create mode 100644 wiki-information/functions/C_Traits.GetNodeCost.md create mode 100644 wiki-information/functions/C_Traits.GetNodeInfo.md create mode 100644 wiki-information/functions/C_Traits.GetStagedChangesCost.md create mode 100644 wiki-information/functions/C_Traits.GetStagedPurchases.md create mode 100644 wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md create mode 100644 wiki-information/functions/C_Traits.GetTraitDescription.md create mode 100644 wiki-information/functions/C_Traits.GetTraitSystemFlags.md create mode 100644 wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md create mode 100644 wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md create mode 100644 wiki-information/functions/C_Traits.GetTreeHash.md create mode 100644 wiki-information/functions/C_Traits.GetTreeInfo.md create mode 100644 wiki-information/functions/C_Traits.GetTreeNodes.md create mode 100644 wiki-information/functions/C_Traits.HasValidInspectData.md create mode 100644 wiki-information/functions/C_Traits.IsReadyForCommit.md create mode 100644 wiki-information/functions/C_Traits.PurchaseRank.md create mode 100644 wiki-information/functions/C_Traits.RefundAllRanks.md create mode 100644 wiki-information/functions/C_Traits.RefundRank.md create mode 100644 wiki-information/functions/C_Traits.ResetTree.md create mode 100644 wiki-information/functions/C_Traits.ResetTreeByCurrency.md create mode 100644 wiki-information/functions/C_Traits.RollbackConfig.md create mode 100644 wiki-information/functions/C_Traits.SetSelection.md create mode 100644 wiki-information/functions/C_Traits.StageConfig.md create mode 100644 wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md create mode 100644 wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md create mode 100644 wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md create mode 100644 wiki-information/functions/C_UI.Reload.md create mode 100644 wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md create mode 100644 wiki-information/functions/C_UIColor.GetColors.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md create mode 100644 wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md create mode 100644 wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md create mode 100644 wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md create mode 100644 wiki-information/functions/C_UnitAuras.AuraIsPrivate.md create mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md create mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md create mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md create mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md create mode 100644 wiki-information/functions/C_UnitAuras.GetAuraSlots.md create mode 100644 wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md create mode 100644 wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md create mode 100644 wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md create mode 100644 wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md create mode 100644 wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md create mode 100644 wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md create mode 100644 wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md create mode 100644 wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md create mode 100644 wiki-information/functions/C_UnitAuras.WantsAlteredForm.md create mode 100644 wiki-information/functions/C_UserFeedback.SubmitBug.md create mode 100644 wiki-information/functions/C_UserFeedback.SubmitSuggestion.md create mode 100644 wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md create mode 100644 wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md create mode 100644 wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md create mode 100644 wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md create mode 100644 wiki-information/functions/C_VideoOptions.SetGameWindowSize.md create mode 100644 wiki-information/functions/C_VoiceChat.ActivateChannel.md create mode 100644 wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md create mode 100644 wiki-information/functions/C_VoiceChat.BeginLocalCapture.md create mode 100644 wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md create mode 100644 wiki-information/functions/C_VoiceChat.CreateChannel.md create mode 100644 wiki-information/functions/C_VoiceChat.DeactivateChannel.md create mode 100644 wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md create mode 100644 wiki-information/functions/C_VoiceChat.EndLocalCapture.md create mode 100644 wiki-information/functions/C_VoiceChat.GetActiveChannelID.md create mode 100644 wiki-information/functions/C_VoiceChat.GetActiveChannelType.md create mode 100644 wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md create mode 100644 wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md create mode 100644 wiki-information/functions/C_VoiceChat.GetChannel.md create mode 100644 wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md create mode 100644 wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md create mode 100644 wiki-information/functions/C_VoiceChat.GetCommunicationMode.md create mode 100644 wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md create mode 100644 wiki-information/functions/C_VoiceChat.GetInputVolume.md create mode 100644 wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md create mode 100644 wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md create mode 100644 wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md create mode 100644 wiki-information/functions/C_VoiceChat.GetMemberGUID.md create mode 100644 wiki-information/functions/C_VoiceChat.GetMemberID.md create mode 100644 wiki-information/functions/C_VoiceChat.GetMemberInfo.md create mode 100644 wiki-information/functions/C_VoiceChat.GetMemberName.md create mode 100644 wiki-information/functions/C_VoiceChat.GetMemberVolume.md create mode 100644 wiki-information/functions/C_VoiceChat.GetOutputVolume.md create mode 100644 wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md create mode 100644 wiki-information/functions/C_VoiceChat.GetProcesses.md create mode 100644 wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md create mode 100644 wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md create mode 100644 wiki-information/functions/C_VoiceChat.GetTtsVoices.md create mode 100644 wiki-information/functions/C_VoiceChat.GetVADSensitivity.md create mode 100644 wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md create mode 100644 wiki-information/functions/C_VoiceChat.IsDeafened.md create mode 100644 wiki-information/functions/C_VoiceChat.IsEnabled.md create mode 100644 wiki-information/functions/C_VoiceChat.IsLoggedIn.md create mode 100644 wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md create mode 100644 wiki-information/functions/C_VoiceChat.IsMemberMuted.md create mode 100644 wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md create mode 100644 wiki-information/functions/C_VoiceChat.IsMemberSilenced.md create mode 100644 wiki-information/functions/C_VoiceChat.IsMuted.md create mode 100644 wiki-information/functions/C_VoiceChat.IsParentalDisabled.md create mode 100644 wiki-information/functions/C_VoiceChat.IsParentalMuted.md create mode 100644 wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md create mode 100644 wiki-information/functions/C_VoiceChat.IsSilenced.md create mode 100644 wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md create mode 100644 wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md create mode 100644 wiki-information/functions/C_VoiceChat.IsTranscribing.md create mode 100644 wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md create mode 100644 wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md create mode 100644 wiki-information/functions/C_VoiceChat.LeaveChannel.md create mode 100644 wiki-information/functions/C_VoiceChat.Login.md create mode 100644 wiki-information/functions/C_VoiceChat.Logout.md create mode 100644 wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md create mode 100644 wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md create mode 100644 wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md create mode 100644 wiki-information/functions/C_VoiceChat.SetCommunicationMode.md create mode 100644 wiki-information/functions/C_VoiceChat.SetDeafened.md create mode 100644 wiki-information/functions/C_VoiceChat.SetInputDevice.md create mode 100644 wiki-information/functions/C_VoiceChat.SetInputVolume.md create mode 100644 wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md create mode 100644 wiki-information/functions/C_VoiceChat.SetMemberMuted.md create mode 100644 wiki-information/functions/C_VoiceChat.SetMemberVolume.md create mode 100644 wiki-information/functions/C_VoiceChat.SetMuted.md create mode 100644 wiki-information/functions/C_VoiceChat.SetOutputDevice.md create mode 100644 wiki-information/functions/C_VoiceChat.SetOutputVolume.md create mode 100644 wiki-information/functions/C_VoiceChat.SetPortraitTexture.md create mode 100644 wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md create mode 100644 wiki-information/functions/C_VoiceChat.SetVADSensitivity.md create mode 100644 wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md create mode 100644 wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md create mode 100644 wiki-information/functions/C_VoiceChat.SpeakText.md create mode 100644 wiki-information/functions/C_VoiceChat.StopSpeakingText.md create mode 100644 wiki-information/functions/C_VoiceChat.ToggleDeafened.md create mode 100644 wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md create mode 100644 wiki-information/functions/C_VoiceChat.ToggleMuted.md create mode 100644 wiki-information/functions/C_XMLUtil.GetTemplateInfo.md create mode 100644 wiki-information/functions/C_XMLUtil.GetTemplates.md create mode 100644 wiki-information/functions/CalculateStringEditDistance.md create mode 100644 wiki-information/functions/CallCompanion.md create mode 100644 wiki-information/functions/CameraOrSelectOrMoveStart.md create mode 100644 wiki-information/functions/CameraOrSelectOrMoveStop.md create mode 100644 wiki-information/functions/CameraZoomIn.md create mode 100644 wiki-information/functions/CanAbandonQuest.md create mode 100644 wiki-information/functions/CanBeRaidTarget.md create mode 100644 wiki-information/functions/CanChangePlayerDifficulty.md create mode 100644 wiki-information/functions/CanDualWield.md create mode 100644 wiki-information/functions/CanEditMOTD.md create mode 100644 wiki-information/functions/CanEjectPassengerFromSeat.md create mode 100644 wiki-information/functions/CanGrantLevel.md create mode 100644 wiki-information/functions/CanGuildDemote.md create mode 100644 wiki-information/functions/CanGuildInvite.md create mode 100644 wiki-information/functions/CanGuildPromote.md create mode 100644 wiki-information/functions/CanInspect.md create mode 100644 wiki-information/functions/CanJoinBattlefieldAsGroup.md create mode 100644 wiki-information/functions/CanLootUnit.md create mode 100644 wiki-information/functions/CanMerchantRepair.md create mode 100644 wiki-information/functions/CanReplaceGuildMaster.md create mode 100644 wiki-information/functions/CanSendAuctionQuery.md create mode 100644 wiki-information/functions/CanShowAchievementUI.md create mode 100644 wiki-information/functions/CanShowResetInstances.md create mode 100644 wiki-information/functions/CanSummonFriend.md create mode 100644 wiki-information/functions/CanSwitchVehicleSeat.md create mode 100644 wiki-information/functions/CanUpgradeExpansion.md create mode 100644 wiki-information/functions/CancelDuel.md create mode 100644 wiki-information/functions/CancelItemTempEnchantment.md create mode 100644 wiki-information/functions/CancelLogout.md create mode 100644 wiki-information/functions/CancelPendingEquip.md create mode 100644 wiki-information/functions/CancelPreloadingMovie.md create mode 100644 wiki-information/functions/CancelShapeshiftForm.md create mode 100644 wiki-information/functions/CancelTrackingBuff.md create mode 100644 wiki-information/functions/CancelTrade.md create mode 100644 wiki-information/functions/CancelUnitBuff.md create mode 100644 wiki-information/functions/CaseAccentInsensitiveParse.md create mode 100644 wiki-information/functions/CastPetAction.md create mode 100644 wiki-information/functions/CastShapeshiftForm.md create mode 100644 wiki-information/functions/CastSpell.md create mode 100644 wiki-information/functions/CastSpellByName.md create mode 100644 wiki-information/functions/CastingInfo.md create mode 100644 wiki-information/functions/ChangeActionBarPage.md create mode 100644 wiki-information/functions/ChangeChatColor.md create mode 100644 wiki-information/functions/ChannelBan.md create mode 100644 wiki-information/functions/ChannelInfo.md create mode 100644 wiki-information/functions/ChannelInvite.md create mode 100644 wiki-information/functions/ChannelKick.md create mode 100644 wiki-information/functions/CheckInbox.md create mode 100644 wiki-information/functions/CheckInteractDistance.md create mode 100644 wiki-information/functions/CheckTalentMasterDist.md create mode 100644 wiki-information/functions/ClassicExpansionAtLeast.md create mode 100644 wiki-information/functions/ClearCursor.md create mode 100644 wiki-information/functions/ClearOverrideBindings.md create mode 100644 wiki-information/functions/ClearSendMail.md create mode 100644 wiki-information/functions/ClearTarget.md create mode 100644 wiki-information/functions/ClickSendMailItemButton.md create mode 100644 wiki-information/functions/ClickStablePet.md create mode 100644 wiki-information/functions/CloseItemText.md create mode 100644 wiki-information/functions/CloseLoot.md create mode 100644 wiki-information/functions/ClosePetition.md create mode 100644 wiki-information/functions/CloseSocketInfo.md create mode 100644 wiki-information/functions/ClosestUnitPosition.md create mode 100644 wiki-information/functions/CollapseFactionHeader.md create mode 100644 wiki-information/functions/CollapseQuestHeader.md create mode 100644 wiki-information/functions/CollapseSkillHeader.md create mode 100644 wiki-information/functions/CollapseTrainerSkillLine.md create mode 100644 wiki-information/functions/CombatLogAdvanceEntry.md create mode 100644 wiki-information/functions/CombatLogGetCurrentEntry.md create mode 100644 wiki-information/functions/CombatLogGetCurrentEventInfo.md create mode 100644 wiki-information/functions/CombatLogSetCurrentEntry.md create mode 100644 wiki-information/functions/CombatLog_Object_IsA.md create mode 100644 wiki-information/functions/CombatTextSetActiveUnit.md create mode 100644 wiki-information/functions/CompleteQuest.md create mode 100644 wiki-information/functions/ConfirmAcceptQuest.md create mode 100644 wiki-information/functions/ConfirmLootRoll.md create mode 100644 wiki-information/functions/ConfirmLootSlot.md create mode 100644 wiki-information/functions/ConfirmPetUnlearn.md create mode 100644 wiki-information/functions/ConfirmReadyCheck.md create mode 100644 wiki-information/functions/ConsoleAddMessage.md create mode 100644 wiki-information/functions/ConsoleExec.md create mode 100644 wiki-information/functions/ConsoleGetAllCommands.md create mode 100644 wiki-information/functions/ConsoleGetColorFromType.md create mode 100644 wiki-information/functions/ConsoleGetFontHeight.md create mode 100644 wiki-information/functions/ConsolePrintAllMatchingCommands.md create mode 100644 wiki-information/functions/ConsoleSetFontHeight.md create mode 100644 wiki-information/functions/ContainerIDToInventoryID.md create mode 100644 wiki-information/functions/ConvertToParty.md create mode 100644 wiki-information/functions/ConvertToRaid.md create mode 100644 wiki-information/functions/CopyToClipboard.md create mode 100644 wiki-information/functions/CreateFont.md create mode 100644 wiki-information/functions/CreateFrame.md create mode 100644 wiki-information/functions/CreateMacro.md create mode 100644 wiki-information/functions/CreateWindow.md create mode 100644 wiki-information/functions/CursorCanGoInSlot.md create mode 100644 wiki-information/functions/CursorHasItem.md create mode 100644 wiki-information/functions/CursorHasMacro.md create mode 100644 wiki-information/functions/CursorHasMoney.md create mode 100644 wiki-information/functions/CursorHasSpell.md create mode 100644 wiki-information/functions/DeathRecap_GetEvents.md create mode 100644 wiki-information/functions/DeathRecap_HasEvents.md create mode 100644 wiki-information/functions/DeclineArenaTeam.md create mode 100644 wiki-information/functions/DeclineChannelInvite.md create mode 100644 wiki-information/functions/DeclineGroup.md create mode 100644 wiki-information/functions/DeclineGuild.md create mode 100644 wiki-information/functions/DeclineName.md create mode 100644 wiki-information/functions/DeclineQuest.md create mode 100644 wiki-information/functions/DeclineResurrect.md create mode 100644 wiki-information/functions/DeclineSpellConfirmationPrompt.md create mode 100644 wiki-information/functions/DeleteCursorItem.md create mode 100644 wiki-information/functions/DeleteInboxItem.md create mode 100644 wiki-information/functions/DeleteMacro.md create mode 100644 wiki-information/functions/DescendStop.md create mode 100644 wiki-information/functions/DestroyTotem.md create mode 100644 wiki-information/functions/DisableAddOn.md create mode 100644 wiki-information/functions/DismissCompanion.md create mode 100644 wiki-information/functions/Dismount.md create mode 100644 wiki-information/functions/DisplayChannelOwner.md create mode 100644 wiki-information/functions/DoReadyCheck.md create mode 100644 wiki-information/functions/DoTradeSkill.md create mode 100644 wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md create mode 100644 wiki-information/functions/DoesSpellExist.md create mode 100644 wiki-information/functions/DropItemOnUnit.md create mode 100644 wiki-information/functions/EditMacro.md create mode 100644 wiki-information/functions/EjectPassengerFromSeat.md create mode 100644 wiki-information/functions/EnableAddOn.md create mode 100644 wiki-information/functions/EnumerateFrames.md create mode 100644 wiki-information/functions/EnumerateServerChannels.md create mode 100644 wiki-information/functions/EquipCursorItem.md create mode 100644 wiki-information/functions/EquipItemByName.md create mode 100644 wiki-information/functions/EquipPendingItem.md create mode 100644 wiki-information/functions/ExpandCurrencyList.md create mode 100644 wiki-information/functions/ExpandFactionHeader.md create mode 100644 wiki-information/functions/ExpandQuestHeader.md create mode 100644 wiki-information/functions/ExpandSkillHeader.md create mode 100644 wiki-information/functions/ExpandTradeSkillSubClass.md create mode 100644 wiki-information/functions/ExpandTrainerSkillLine.md create mode 100644 wiki-information/functions/FactionToggleAtWar.md create mode 100644 wiki-information/functions/FillLocalizedClassList.md create mode 100644 wiki-information/functions/FindBaseSpellByID.md create mode 100644 wiki-information/functions/FindSpellOverrideByID.md create mode 100644 wiki-information/functions/FlashClientIcon.md create mode 100644 wiki-information/functions/FlipCameraYaw.md create mode 100644 wiki-information/functions/FocusUnit.md create mode 100644 wiki-information/functions/FollowUnit.md create mode 100644 wiki-information/functions/ForceGossip.md create mode 100644 wiki-information/functions/ForceQuit.md create mode 100644 wiki-information/functions/FrameXML_Debug.md create mode 100644 wiki-information/functions/GMRequestPlayerInfo.md create mode 100644 wiki-information/functions/GMSubmitBug.md create mode 100644 wiki-information/functions/GMSubmitSuggestion.md create mode 100644 wiki-information/functions/GetAbandonQuestItems.md create mode 100644 wiki-information/functions/GetAbandonQuestName.md create mode 100644 wiki-information/functions/GetAccountExpansionLevel.md create mode 100644 wiki-information/functions/GetAchievementCategory.md create mode 100644 wiki-information/functions/GetAchievementComparisonInfo.md create mode 100644 wiki-information/functions/GetAchievementCriteriaInfo.md create mode 100644 wiki-information/functions/GetAchievementCriteriaInfoByID.md create mode 100644 wiki-information/functions/GetAchievementLink.md create mode 100644 wiki-information/functions/GetAchievementNumCriteria.md create mode 100644 wiki-information/functions/GetActionBarPage.md create mode 100644 wiki-information/functions/GetActionBarToggles.md create mode 100644 wiki-information/functions/GetActionCharges.md create mode 100644 wiki-information/functions/GetActionCooldown.md create mode 100644 wiki-information/functions/GetActionCount.md create mode 100644 wiki-information/functions/GetActionInfo.md create mode 100644 wiki-information/functions/GetActionLossOfControlCooldown.md create mode 100644 wiki-information/functions/GetActionText.md create mode 100644 wiki-information/functions/GetActionTexture.md create mode 100644 wiki-information/functions/GetActiveTalentGroup.md create mode 100644 wiki-information/functions/GetAddOnCPUUsage.md create mode 100644 wiki-information/functions/GetAddOnDependencies.md create mode 100644 wiki-information/functions/GetAddOnEnableState.md create mode 100644 wiki-information/functions/GetAddOnInfo.md create mode 100644 wiki-information/functions/GetAddOnMemoryUsage.md create mode 100644 wiki-information/functions/GetAddOnMetadata.md create mode 100644 wiki-information/functions/GetAllowLowLevelRaid.md create mode 100644 wiki-information/functions/GetArenaTeamIndexBySize.md create mode 100644 wiki-information/functions/GetArenaTeamRosterInfo.md create mode 100644 wiki-information/functions/GetArmorPenetration.md create mode 100644 wiki-information/functions/GetAtlasInfo.md create mode 100644 wiki-information/functions/GetAttackPowerForStat.md create mode 100644 wiki-information/functions/GetAuctionItemBattlePetInfo.md create mode 100644 wiki-information/functions/GetAuctionItemInfo.md create mode 100644 wiki-information/functions/GetAuctionItemLink.md create mode 100644 wiki-information/functions/GetAuctionItemSubClasses.md create mode 100644 wiki-information/functions/GetAutoCompleteRealms.md create mode 100644 wiki-information/functions/GetAutoCompleteResults.md create mode 100644 wiki-information/functions/GetAutoDeclineGuildInvites.md create mode 100644 wiki-information/functions/GetAvailableBandwidth.md create mode 100644 wiki-information/functions/GetAvailableLocales.md create mode 100644 wiki-information/functions/GetAverageItemLevel.md create mode 100644 wiki-information/functions/GetBackgroundLoadingStatus.md create mode 100644 wiki-information/functions/GetBackpackCurrencyInfo.md create mode 100644 wiki-information/functions/GetBankSlotCost.md create mode 100644 wiki-information/functions/GetBattlefieldEstimatedWaitTime.md create mode 100644 wiki-information/functions/GetBattlefieldFlagPosition.md create mode 100644 wiki-information/functions/GetBattlefieldInstanceExpiration.md create mode 100644 wiki-information/functions/GetBattlefieldInstanceInfo.md create mode 100644 wiki-information/functions/GetBattlefieldInstanceRunTime.md create mode 100644 wiki-information/functions/GetBattlefieldPortExpiration.md create mode 100644 wiki-information/functions/GetBattlefieldScore.md create mode 100644 wiki-information/functions/GetBattlefieldStatInfo.md create mode 100644 wiki-information/functions/GetBattlefieldStatus.md create mode 100644 wiki-information/functions/GetBattlefieldTimeWaited.md create mode 100644 wiki-information/functions/GetBattlefieldWinner.md create mode 100644 wiki-information/functions/GetBattlegroundInfo.md create mode 100644 wiki-information/functions/GetBattlegroundPoints.md create mode 100644 wiki-information/functions/GetBestFlexRaidChoice.md create mode 100644 wiki-information/functions/GetBestRFChoice.md create mode 100644 wiki-information/functions/GetBillingTimeRested.md create mode 100644 wiki-information/functions/GetBindLocation.md create mode 100644 wiki-information/functions/GetBinding.md create mode 100644 wiki-information/functions/GetBindingAction.md create mode 100644 wiki-information/functions/GetBindingByKey.md create mode 100644 wiki-information/functions/GetBindingKey.md create mode 100644 wiki-information/functions/GetBindingText.md create mode 100644 wiki-information/functions/GetBlockChance.md create mode 100644 wiki-information/functions/GetBonusBarOffset.md create mode 100644 wiki-information/functions/GetBuildInfo.md create mode 100644 wiki-information/functions/GetButtonMetatable.md create mode 100644 wiki-information/functions/GetBuybackItemInfo.md create mode 100644 wiki-information/functions/GetCVarInfo.md create mode 100644 wiki-information/functions/GetCameraZoom.md create mode 100644 wiki-information/functions/GetCategoryList.md create mode 100644 wiki-information/functions/GetCategoryNumAchievements.md create mode 100644 wiki-information/functions/GetCemeteryPreference.md create mode 100644 wiki-information/functions/GetChannelList.md create mode 100644 wiki-information/functions/GetChannelName.md create mode 100644 wiki-information/functions/GetChatWindowInfo.md create mode 100644 wiki-information/functions/GetChatWindowMessages.md create mode 100644 wiki-information/functions/GetClassInfo.md create mode 100644 wiki-information/functions/GetClassicExpansionLevel.md create mode 100644 wiki-information/functions/GetClickFrame.md create mode 100644 wiki-information/functions/GetClientDisplayExpansionLevel.md create mode 100644 wiki-information/functions/GetCoinIcon.md create mode 100644 wiki-information/functions/GetCoinText.md create mode 100644 wiki-information/functions/GetCoinTextureString.md create mode 100644 wiki-information/functions/GetCombatRating.md create mode 100644 wiki-information/functions/GetCombatRatingBonus.md create mode 100644 wiki-information/functions/GetComboPoints.md create mode 100644 wiki-information/functions/GetCompanionCooldown.md create mode 100644 wiki-information/functions/GetCompanionInfo.md create mode 100644 wiki-information/functions/GetComparisonStatistic.md create mode 100644 wiki-information/functions/GetContainerFreeSlots.md create mode 100644 wiki-information/functions/GetContainerItemCooldown.md create mode 100644 wiki-information/functions/GetContainerItemDurability.md create mode 100644 wiki-information/functions/GetContainerItemID.md create mode 100644 wiki-information/functions/GetContainerItemInfo.md create mode 100644 wiki-information/functions/GetContainerItemLink.md create mode 100644 wiki-information/functions/GetContainerNumFreeSlots.md create mode 100644 wiki-information/functions/GetContainerNumSlots.md create mode 100644 wiki-information/functions/GetCorpseRecoveryDelay.md create mode 100644 wiki-information/functions/GetCraftDescription.md create mode 100644 wiki-information/functions/GetCraftDisplaySkillLine.md create mode 100644 wiki-information/functions/GetCraftInfo.md create mode 100644 wiki-information/functions/GetCraftItemLink.md create mode 100644 wiki-information/functions/GetCraftName.md create mode 100644 wiki-information/functions/GetCraftNumReagents.md create mode 100644 wiki-information/functions/GetCraftReagentInfo.md create mode 100644 wiki-information/functions/GetCraftReagentItemLink.md create mode 100644 wiki-information/functions/GetCraftRecipeLink.md create mode 100644 wiki-information/functions/GetCraftSkillLine.md create mode 100644 wiki-information/functions/GetCraftSpellFocus.md create mode 100644 wiki-information/functions/GetCritChance.md create mode 100644 wiki-information/functions/GetCurrencyInfo.md create mode 100644 wiki-information/functions/GetCurrencyLink.md create mode 100644 wiki-information/functions/GetCurrencyListInfo.md create mode 100644 wiki-information/functions/GetCurrencyListSize.md create mode 100644 wiki-information/functions/GetCurrentBindingSet.md create mode 100644 wiki-information/functions/GetCurrentCombatTextEventInfo.md create mode 100644 wiki-information/functions/GetCurrentEventID.md create mode 100644 wiki-information/functions/GetCurrentGraphicsAPI.md create mode 100644 wiki-information/functions/GetCurrentRegion.md create mode 100644 wiki-information/functions/GetCurrentRegionName.md create mode 100644 wiki-information/functions/GetCurrentResolution.md create mode 100644 wiki-information/functions/GetCurrentTitle.md create mode 100644 wiki-information/functions/GetCursorDelta.md create mode 100644 wiki-information/functions/GetCursorInfo.md create mode 100644 wiki-information/functions/GetCursorMoney.md create mode 100644 wiki-information/functions/GetCursorPosition.md create mode 100644 wiki-information/functions/GetDeathRecapLink.md create mode 100644 wiki-information/functions/GetDefaultLanguage.md create mode 100644 wiki-information/functions/GetDefaultScale.md create mode 100644 wiki-information/functions/GetDetailedItemLevelInfo.md create mode 100644 wiki-information/functions/GetDifficultyInfo.md create mode 100644 wiki-information/functions/GetDodgeChance.md create mode 100644 wiki-information/functions/GetDodgeChanceFromAttribute.md create mode 100644 wiki-information/functions/GetDownloadedPercentage.md create mode 100644 wiki-information/functions/GetDungeonDifficultyID.md create mode 100644 wiki-information/functions/GetEditBoxMetatable.md create mode 100644 wiki-information/functions/GetEventTime.md create mode 100644 wiki-information/functions/GetExpansionDisplayInfo.md create mode 100644 wiki-information/functions/GetExpansionLevel.md create mode 100644 wiki-information/functions/GetExpansionTrialInfo.md create mode 100644 wiki-information/functions/GetExpertise.md create mode 100644 wiki-information/functions/GetExpertisePercent.md create mode 100644 wiki-information/functions/GetFactionInfo.md create mode 100644 wiki-information/functions/GetFactionInfoByID.md create mode 100644 wiki-information/functions/GetFileIDFromPath.md create mode 100644 wiki-information/functions/GetFileStreamingStatus.md create mode 100644 wiki-information/functions/GetFirstBagBankSlotIndex.md create mode 100644 wiki-information/functions/GetFirstTradeSkill.md create mode 100644 wiki-information/functions/GetFontInfo.md create mode 100644 wiki-information/functions/GetFontStringMetatable.md create mode 100644 wiki-information/functions/GetFonts.md create mode 100644 wiki-information/functions/GetFrameCPUUsage.md create mode 100644 wiki-information/functions/GetFrameMetatable.md create mode 100644 wiki-information/functions/GetFramerate.md create mode 100644 wiki-information/functions/GetFramesRegisteredForEvent.md create mode 100644 wiki-information/functions/GetFunctionCPUUsage.md create mode 100644 wiki-information/functions/GetGameTime.md create mode 100644 wiki-information/functions/GetGlyphLink.md create mode 100644 wiki-information/functions/GetGlyphSocketInfo.md create mode 100644 wiki-information/functions/GetGossipActiveQuests.md create mode 100644 wiki-information/functions/GetGossipAvailableQuests.md create mode 100644 wiki-information/functions/GetGossipOptions.md create mode 100644 wiki-information/functions/GetGossipText.md create mode 100644 wiki-information/functions/GetGraphicsAPIs.md create mode 100644 wiki-information/functions/GetGuildBankItemInfo.md create mode 100644 wiki-information/functions/GetGuildBankItemLink.md create mode 100644 wiki-information/functions/GetGuildBankMoney.md create mode 100644 wiki-information/functions/GetGuildBankTabInfo.md create mode 100644 wiki-information/functions/GetGuildBankTabPermissions.md create mode 100644 wiki-information/functions/GetGuildBankTransaction.md create mode 100644 wiki-information/functions/GetGuildBankWithdrawGoldLimit.md create mode 100644 wiki-information/functions/GetGuildBankWithdrawMoney.md create mode 100644 wiki-information/functions/GetGuildInfo.md create mode 100644 wiki-information/functions/GetGuildRosterInfo.md create mode 100644 wiki-information/functions/GetGuildRosterLastOnline.md create mode 100644 wiki-information/functions/GetGuildRosterMOTD.md create mode 100644 wiki-information/functions/GetGuildRosterShowOffline.md create mode 100644 wiki-information/functions/GetGuildTabardFiles.md create mode 100644 wiki-information/functions/GetHaste.md create mode 100644 wiki-information/functions/GetHitModifier.md create mode 100644 wiki-information/functions/GetHomePartyInfo.md create mode 100644 wiki-information/functions/GetInboxHeaderInfo.md create mode 100644 wiki-information/functions/GetInboxInvoiceInfo.md create mode 100644 wiki-information/functions/GetInboxItem.md create mode 100644 wiki-information/functions/GetInboxItemLink.md create mode 100644 wiki-information/functions/GetInboxNumItems.md create mode 100644 wiki-information/functions/GetInspectArenaData.md create mode 100644 wiki-information/functions/GetInspectHonorData.md create mode 100644 wiki-information/functions/GetInspectPVPRankProgress.md create mode 100644 wiki-information/functions/GetInstanceBootTimeRemaining.md create mode 100644 wiki-information/functions/GetInstanceInfo.md create mode 100644 wiki-information/functions/GetInstanceLockTimeRemaining.md create mode 100644 wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md create mode 100644 wiki-information/functions/GetInventoryAlertStatus.md create mode 100644 wiki-information/functions/GetInventoryItemBroken.md create mode 100644 wiki-information/functions/GetInventoryItemCooldown.md create mode 100644 wiki-information/functions/GetInventoryItemCount.md create mode 100644 wiki-information/functions/GetInventoryItemDurability.md create mode 100644 wiki-information/functions/GetInventoryItemGems.md create mode 100644 wiki-information/functions/GetInventoryItemID.md create mode 100644 wiki-information/functions/GetInventoryItemLink.md create mode 100644 wiki-information/functions/GetInventoryItemQuality.md create mode 100644 wiki-information/functions/GetInventoryItemTexture.md create mode 100644 wiki-information/functions/GetInventoryItemsForSlot.md create mode 100644 wiki-information/functions/GetInventorySlotInfo.md create mode 100644 wiki-information/functions/GetInviteConfirmationInfo.md create mode 100644 wiki-information/functions/GetInviteReferralInfo.md create mode 100644 wiki-information/functions/GetItemClassInfo.md create mode 100644 wiki-information/functions/GetItemCooldown.md create mode 100644 wiki-information/functions/GetItemCount.md create mode 100644 wiki-information/functions/GetItemFamily.md create mode 100644 wiki-information/functions/GetItemGem.md create mode 100644 wiki-information/functions/GetItemIcon.md create mode 100644 wiki-information/functions/GetItemInfo.md create mode 100644 wiki-information/functions/GetItemInfoInstant.md create mode 100644 wiki-information/functions/GetItemQualityColor.md create mode 100644 wiki-information/functions/GetItemSpecInfo.md create mode 100644 wiki-information/functions/GetItemSpell.md create mode 100644 wiki-information/functions/GetItemStats.md create mode 100644 wiki-information/functions/GetItemSubClassInfo.md create mode 100644 wiki-information/functions/GetLFGBootProposal.md create mode 100644 wiki-information/functions/GetLFGDeserterExpiration.md create mode 100644 wiki-information/functions/GetLFGDungeonEncounterInfo.md create mode 100644 wiki-information/functions/GetLFGDungeonInfo.md create mode 100644 wiki-information/functions/GetLFGDungeonNumEncounters.md create mode 100644 wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md create mode 100644 wiki-information/functions/GetLFGRoles.md create mode 100644 wiki-information/functions/GetLanguageByIndex.md create mode 100644 wiki-information/functions/GetLatestThreeSenders.md create mode 100644 wiki-information/functions/GetLocale.md create mode 100644 wiki-information/functions/GetLootInfo.md create mode 100644 wiki-information/functions/GetLootMethod.md create mode 100644 wiki-information/functions/GetLootRollItemInfo.md create mode 100644 wiki-information/functions/GetLootRollItemLink.md create mode 100644 wiki-information/functions/GetLootSlotInfo.md create mode 100644 wiki-information/functions/GetLootSlotLink.md create mode 100644 wiki-information/functions/GetLootSlotType.md create mode 100644 wiki-information/functions/GetLootSourceInfo.md create mode 100644 wiki-information/functions/GetLootThreshold.md create mode 100644 wiki-information/functions/GetMacroBody.md create mode 100644 wiki-information/functions/GetMacroIndexByName.md create mode 100644 wiki-information/functions/GetMacroInfo.md create mode 100644 wiki-information/functions/GetMacroSpell.md create mode 100644 wiki-information/functions/GetManaRegen.md create mode 100644 wiki-information/functions/GetMasterLootCandidate.md create mode 100644 wiki-information/functions/GetMaxBattlefieldID.md create mode 100644 wiki-information/functions/GetMaxLevelForExpansionLevel.md create mode 100644 wiki-information/functions/GetMaximumExpansionLevel.md create mode 100644 wiki-information/functions/GetMeleeHaste.md create mode 100644 wiki-information/functions/GetMerchantItemCostInfo.md create mode 100644 wiki-information/functions/GetMerchantItemCostItem.md create mode 100644 wiki-information/functions/GetMerchantItemID.md create mode 100644 wiki-information/functions/GetMerchantItemInfo.md create mode 100644 wiki-information/functions/GetMerchantItemLink.md create mode 100644 wiki-information/functions/GetMerchantItemMaxStack.md create mode 100644 wiki-information/functions/GetMerchantNumItems.md create mode 100644 wiki-information/functions/GetMinimapZoneText.md create mode 100644 wiki-information/functions/GetMinimumExpansionLevel.md create mode 100644 wiki-information/functions/GetMirrorTimerInfo.md create mode 100644 wiki-information/functions/GetMirrorTimerProgress.md create mode 100644 wiki-information/functions/GetModifiedClick.md create mode 100644 wiki-information/functions/GetMoney.md create mode 100644 wiki-information/functions/GetMouseButtonClicked.md create mode 100644 wiki-information/functions/GetMouseFocus.md create mode 100644 wiki-information/functions/GetMultiCastTotemSpells.md create mode 100644 wiki-information/functions/GetNetStats.md create mode 100644 wiki-information/functions/GetNextAchievement.md create mode 100644 wiki-information/functions/GetNextStableSlotCost.md create mode 100644 wiki-information/functions/GetNormalizedRealmName.md create mode 100644 wiki-information/functions/GetNumActiveQuests.md create mode 100644 wiki-information/functions/GetNumAddOns.md create mode 100644 wiki-information/functions/GetNumAuctionItems.md create mode 100644 wiki-information/functions/GetNumAvailableQuests.md create mode 100644 wiki-information/functions/GetNumBankSlots.md create mode 100644 wiki-information/functions/GetNumBattlefieldStats.md create mode 100644 wiki-information/functions/GetNumBattlefields.md create mode 100644 wiki-information/functions/GetNumBattlegroundTypes.md create mode 100644 wiki-information/functions/GetNumBindings.md create mode 100644 wiki-information/functions/GetNumBuybackItems.md create mode 100644 wiki-information/functions/GetNumClasses.md create mode 100644 wiki-information/functions/GetNumCompanions.md create mode 100644 wiki-information/functions/GetNumComparisonCompletedAchievements.md create mode 100644 wiki-information/functions/GetNumCompletedAchievements.md create mode 100644 wiki-information/functions/GetNumCrafts.md create mode 100644 wiki-information/functions/GetNumDeclensionSets.md create mode 100644 wiki-information/functions/GetNumExpansions.md create mode 100644 wiki-information/functions/GetNumFactions.md create mode 100644 wiki-information/functions/GetNumFlexRaidDungeons.md create mode 100644 wiki-information/functions/GetNumFrames.md create mode 100644 wiki-information/functions/GetNumGlyphSockets.md create mode 100644 wiki-information/functions/GetNumGossipActiveQuests.md create mode 100644 wiki-information/functions/GetNumGossipAvailableQuests.md create mode 100644 wiki-information/functions/GetNumGossipOptions.md create mode 100644 wiki-information/functions/GetNumGroupMembers.md create mode 100644 wiki-information/functions/GetNumGuildMembers.md create mode 100644 wiki-information/functions/GetNumLanguages.md create mode 100644 wiki-information/functions/GetNumLootItems.md create mode 100644 wiki-information/functions/GetNumMacros.md create mode 100644 wiki-information/functions/GetNumPetitionNames.md create mode 100644 wiki-information/functions/GetNumQuestChoices.md create mode 100644 wiki-information/functions/GetNumQuestItems.md create mode 100644 wiki-information/functions/GetNumQuestLeaderBoards.md create mode 100644 wiki-information/functions/GetNumQuestLogChoices.md create mode 100644 wiki-information/functions/GetNumQuestLogEntries.md create mode 100644 wiki-information/functions/GetNumQuestLogRewards.md create mode 100644 wiki-information/functions/GetNumQuestRewards.md create mode 100644 wiki-information/functions/GetNumQuestWatches.md create mode 100644 wiki-information/functions/GetNumRewardCurrencies.md create mode 100644 wiki-information/functions/GetNumSavedInstances.md create mode 100644 wiki-information/functions/GetNumSkillLines.md create mode 100644 wiki-information/functions/GetNumSockets.md create mode 100644 wiki-information/functions/GetNumSpellTabs.md create mode 100644 wiki-information/functions/GetNumStableSlots.md create mode 100644 wiki-information/functions/GetNumSubgroupMembers.md create mode 100644 wiki-information/functions/GetNumTalentGroups.md create mode 100644 wiki-information/functions/GetNumTalentTabs.md create mode 100644 wiki-information/functions/GetNumTalents.md create mode 100644 wiki-information/functions/GetNumTitles.md create mode 100644 wiki-information/functions/GetNumTrackedAchievements.md create mode 100644 wiki-information/functions/GetNumTradeSkills.md create mode 100644 wiki-information/functions/GetOSLocale.md create mode 100644 wiki-information/functions/GetObjectIconTextureCoords.md create mode 100644 wiki-information/functions/GetOptOutOfLoot.md create mode 100644 wiki-information/functions/GetOwnerAuctionItems.md create mode 100644 wiki-information/functions/GetPVPDesired.md create mode 100644 wiki-information/functions/GetPVPLastWeekStats.md create mode 100644 wiki-information/functions/GetPVPLifetimeStats.md create mode 100644 wiki-information/functions/GetPVPRankInfo.md create mode 100644 wiki-information/functions/GetPVPRankProgress.md create mode 100644 wiki-information/functions/GetPVPRoles.md create mode 100644 wiki-information/functions/GetPVPSessionStats.md create mode 100644 wiki-information/functions/GetPVPThisWeekStats.md create mode 100644 wiki-information/functions/GetPVPTimer.md create mode 100644 wiki-information/functions/GetPVPYesterdayStats.md create mode 100644 wiki-information/functions/GetParryChance.md create mode 100644 wiki-information/functions/GetParryChanceFromAttribute.md create mode 100644 wiki-information/functions/GetPartyAssignment.md create mode 100644 wiki-information/functions/GetPersonalRatedInfo.md create mode 100644 wiki-information/functions/GetPetActionCooldown.md create mode 100644 wiki-information/functions/GetPetActionInfo.md create mode 100644 wiki-information/functions/GetPetActionSlotUsable.md create mode 100644 wiki-information/functions/GetPetExperience.md create mode 100644 wiki-information/functions/GetPetFoodTypes.md create mode 100644 wiki-information/functions/GetPetHappiness.md create mode 100644 wiki-information/functions/GetPetLoyalty.md create mode 100644 wiki-information/functions/GetPetSpellBonusDamage.md create mode 100644 wiki-information/functions/GetPetTrainingPoints.md create mode 100644 wiki-information/functions/GetPetitionInfo.md create mode 100644 wiki-information/functions/GetPhysicalScreenSize.md create mode 100644 wiki-information/functions/GetPlayerFacing.md create mode 100644 wiki-information/functions/GetPlayerInfoByGUID.md create mode 100644 wiki-information/functions/GetPossessInfo.md create mode 100644 wiki-information/functions/GetPreviousAchievement.md create mode 100644 wiki-information/functions/GetProfessionInfo.md create mode 100644 wiki-information/functions/GetQuestBackgroundMaterial.md create mode 100644 wiki-information/functions/GetQuestCurrencyInfo.md create mode 100644 wiki-information/functions/GetQuestFactionGroup.md create mode 100644 wiki-information/functions/GetQuestGreenRange.md create mode 100644 wiki-information/functions/GetQuestID.md create mode 100644 wiki-information/functions/GetQuestIndexForTimer.md create mode 100644 wiki-information/functions/GetQuestIndexForWatch.md create mode 100644 wiki-information/functions/GetQuestItemInfo.md create mode 100644 wiki-information/functions/GetQuestItemLink.md create mode 100644 wiki-information/functions/GetQuestLink.md create mode 100644 wiki-information/functions/GetQuestLogGroupNum.md create mode 100644 wiki-information/functions/GetQuestLogIndexByID.md create mode 100644 wiki-information/functions/GetQuestLogItemLink.md create mode 100644 wiki-information/functions/GetQuestLogLeaderBoard.md create mode 100644 wiki-information/functions/GetQuestLogPushable.md create mode 100644 wiki-information/functions/GetQuestLogQuestText.md create mode 100644 wiki-information/functions/GetQuestLogRequiredMoney.md create mode 100644 wiki-information/functions/GetQuestLogRewardCurrencyInfo.md create mode 100644 wiki-information/functions/GetQuestLogRewardInfo.md create mode 100644 wiki-information/functions/GetQuestLogRewardMoney.md create mode 100644 wiki-information/functions/GetQuestLogRewardSpell.md create mode 100644 wiki-information/functions/GetQuestLogSpecialItemCooldown.md create mode 100644 wiki-information/functions/GetQuestLogSpecialItemInfo.md create mode 100644 wiki-information/functions/GetQuestLogTimeLeft.md create mode 100644 wiki-information/functions/GetQuestLogTitle.md create mode 100644 wiki-information/functions/GetQuestResetTime.md create mode 100644 wiki-information/functions/GetQuestReward.md create mode 100644 wiki-information/functions/GetQuestSortIndex.md create mode 100644 wiki-information/functions/GetQuestTagInfo.md create mode 100644 wiki-information/functions/GetQuestTimers.md create mode 100644 wiki-information/functions/GetQuestsCompleted.md create mode 100644 wiki-information/functions/GetRFDungeonInfo.md create mode 100644 wiki-information/functions/GetRaidDifficultyID.md create mode 100644 wiki-information/functions/GetRaidRosterInfo.md create mode 100644 wiki-information/functions/GetRaidTargetIndex.md create mode 100644 wiki-information/functions/GetRangedCritChance.md create mode 100644 wiki-information/functions/GetRangedHaste.md create mode 100644 wiki-information/functions/GetRealZoneText.md create mode 100644 wiki-information/functions/GetRealmID.md create mode 100644 wiki-information/functions/GetRealmName.md create mode 100644 wiki-information/functions/GetRepairAllCost.md create mode 100644 wiki-information/functions/GetRestState.md create mode 100644 wiki-information/functions/GetRestrictedAccountData.md create mode 100644 wiki-information/functions/GetRewardSpell.md create mode 100644 wiki-information/functions/GetRewardXP.md create mode 100644 wiki-information/functions/GetRuneCooldown.md create mode 100644 wiki-information/functions/GetRuneType.md create mode 100644 wiki-information/functions/GetSavedInstanceChatLink.md create mode 100644 wiki-information/functions/GetSavedInstanceEncounterInfo.md create mode 100644 wiki-information/functions/GetSavedInstanceInfo.md create mode 100644 wiki-information/functions/GetScenariosChoiceOrder.md create mode 100644 wiki-information/functions/GetSchoolString.md create mode 100644 wiki-information/functions/GetScreenDPIScale.md create mode 100644 wiki-information/functions/GetScreenHeight.md create mode 100644 wiki-information/functions/GetScreenResolutions.md create mode 100644 wiki-information/functions/GetScreenWidth.md create mode 100644 wiki-information/functions/GetSecondsUntilParentalControlsKick.md create mode 100644 wiki-information/functions/GetSelectedBattlefield.md create mode 100644 wiki-information/functions/GetSelectedSkill.md create mode 100644 wiki-information/functions/GetSelectedStablePet.md create mode 100644 wiki-information/functions/GetSendMailCOD.md create mode 100644 wiki-information/functions/GetSendMailItem.md create mode 100644 wiki-information/functions/GetSendMailItemLink.md create mode 100644 wiki-information/functions/GetSendMailPrice.md create mode 100644 wiki-information/functions/GetServerExpansionLevel.md create mode 100644 wiki-information/functions/GetServerTime.md create mode 100644 wiki-information/functions/GetSessionTime.md create mode 100644 wiki-information/functions/GetShapeshiftForm.md create mode 100644 wiki-information/functions/GetShapeshiftFormCooldown.md create mode 100644 wiki-information/functions/GetShapeshiftFormID.md create mode 100644 wiki-information/functions/GetShapeshiftFormInfo.md create mode 100644 wiki-information/functions/GetSheathState.md create mode 100644 wiki-information/functions/GetShieldBlock.md create mode 100644 wiki-information/functions/GetSkillLineInfo.md create mode 100644 wiki-information/functions/GetSocketItemBoundTradeable.md create mode 100644 wiki-information/functions/GetSocketItemInfo.md create mode 100644 wiki-information/functions/GetSocketItemRefundable.md create mode 100644 wiki-information/functions/GetSocketTypes.md create mode 100644 wiki-information/functions/GetSoundEntryCount.md create mode 100644 wiki-information/functions/GetSpellAutocast.md create mode 100644 wiki-information/functions/GetSpellBaseCooldown.md create mode 100644 wiki-information/functions/GetSpellBonusDamage.md create mode 100644 wiki-information/functions/GetSpellBonusHealing.md create mode 100644 wiki-information/functions/GetSpellBookItemInfo.md create mode 100644 wiki-information/functions/GetSpellBookItemName.md create mode 100644 wiki-information/functions/GetSpellBookItemTexture.md create mode 100644 wiki-information/functions/GetSpellCharges.md create mode 100644 wiki-information/functions/GetSpellCooldown.md create mode 100644 wiki-information/functions/GetSpellCount.md create mode 100644 wiki-information/functions/GetSpellCritChance.md create mode 100644 wiki-information/functions/GetSpellDescription.md create mode 100644 wiki-information/functions/GetSpellHitModifier.md create mode 100644 wiki-information/functions/GetSpellInfo.md create mode 100644 wiki-information/functions/GetSpellLink.md create mode 100644 wiki-information/functions/GetSpellLossOfControlCooldown.md create mode 100644 wiki-information/functions/GetSpellPenetration.md create mode 100644 wiki-information/functions/GetSpellPowerCost.md create mode 100644 wiki-information/functions/GetSpellTabInfo.md create mode 100644 wiki-information/functions/GetSpellTexture.md create mode 100644 wiki-information/functions/GetStablePetFoodTypes.md create mode 100644 wiki-information/functions/GetStablePetInfo.md create mode 100644 wiki-information/functions/GetStatistic.md create mode 100644 wiki-information/functions/GetStatisticsCategoryList.md create mode 100644 wiki-information/functions/GetSubZoneText.md create mode 100644 wiki-information/functions/GetSuggestedGroupNum.md create mode 100644 wiki-information/functions/GetSummonFriendCooldown.md create mode 100644 wiki-information/functions/GetSuperTrackedQuestID.md create mode 100644 wiki-information/functions/GetTalentGroupRole.md create mode 100644 wiki-information/functions/GetTalentInfo.md create mode 100644 wiki-information/functions/GetTalentPrereqs.md create mode 100644 wiki-information/functions/GetTalentTabInfo.md create mode 100644 wiki-information/functions/GetTaxiBenchmarkMode.md create mode 100644 wiki-information/functions/GetTaxiMapID.md create mode 100644 wiki-information/functions/GetText.md create mode 100644 wiki-information/functions/GetThreatStatusColor.md create mode 100644 wiki-information/functions/GetTickTime.md create mode 100644 wiki-information/functions/GetTime.md create mode 100644 wiki-information/functions/GetTimePreciseSec.md create mode 100644 wiki-information/functions/GetTitleName.md create mode 100644 wiki-information/functions/GetTitleText.md create mode 100644 wiki-information/functions/GetTotalAchievementPoints.md create mode 100644 wiki-information/functions/GetTotemCannotDismiss.md create mode 100644 wiki-information/functions/GetTotemTimeLeft.md create mode 100644 wiki-information/functions/GetTrackedAchievements.md create mode 100644 wiki-information/functions/GetTrackingInfo.md create mode 100644 wiki-information/functions/GetTrackingTexture.md create mode 100644 wiki-information/functions/GetTradePlayerItemInfo.md create mode 100644 wiki-information/functions/GetTradeSkillDescription.md create mode 100644 wiki-information/functions/GetTradeSkillInfo.md create mode 100644 wiki-information/functions/GetTradeSkillInvSlotFilter.md create mode 100644 wiki-information/functions/GetTradeSkillItemLink.md create mode 100644 wiki-information/functions/GetTradeSkillItemStats.md create mode 100644 wiki-information/functions/GetTradeSkillLine.md create mode 100644 wiki-information/functions/GetTradeSkillListLink.md create mode 100644 wiki-information/functions/GetTradeSkillNumMade.md create mode 100644 wiki-information/functions/GetTradeSkillNumReagents.md create mode 100644 wiki-information/functions/GetTradeSkillReagentInfo.md create mode 100644 wiki-information/functions/GetTradeSkillReagentItemLink.md create mode 100644 wiki-information/functions/GetTradeSkillRecipeLink.md create mode 100644 wiki-information/functions/GetTradeSkillSelectionIndex.md create mode 100644 wiki-information/functions/GetTradeSkillSubClassFilter.md create mode 100644 wiki-information/functions/GetTradeTargetItemInfo.md create mode 100644 wiki-information/functions/GetTradeskillRepeatCount.md create mode 100644 wiki-information/functions/GetTrainerServiceAbilityReq.md create mode 100644 wiki-information/functions/GetTrainerServiceDescription.md create mode 100644 wiki-information/functions/GetTrainerServiceItemLink.md create mode 100644 wiki-information/functions/GetTrainerServiceLevelReq.md create mode 100644 wiki-information/functions/GetTrainerServiceSkillLine.md create mode 100644 wiki-information/functions/GetTrainerServiceSkillReq.md create mode 100644 wiki-information/functions/GetTrainerServiceTypeFilter.md create mode 100644 wiki-information/functions/GetUICameraInfo.md create mode 100644 wiki-information/functions/GetUnitHealthModifier.md create mode 100644 wiki-information/functions/GetUnitMaxHealthModifier.md create mode 100644 wiki-information/functions/GetUnitPowerModifier.md create mode 100644 wiki-information/functions/GetUnitSpeed.md create mode 100644 wiki-information/functions/GetUnspentTalentPoints.md create mode 100644 wiki-information/functions/GetVehicleUIIndicator.md create mode 100644 wiki-information/functions/GetVehicleUIIndicatorSeat.md create mode 100644 wiki-information/functions/GetWatchedFactionInfo.md create mode 100644 wiki-information/functions/GetWeaponEnchantInfo.md create mode 100644 wiki-information/functions/GetWebTicket.md create mode 100644 wiki-information/functions/GetXPExhaustion.md create mode 100644 wiki-information/functions/GetZonePVPInfo.md create mode 100644 wiki-information/functions/GetZoneText.md create mode 100644 wiki-information/functions/GuildControlDelRank.md create mode 100644 wiki-information/functions/GuildControlGetRankFlags.md create mode 100644 wiki-information/functions/GuildControlGetRankName.md create mode 100644 wiki-information/functions/GuildControlSaveRank.md create mode 100644 wiki-information/functions/GuildControlSetRank.md create mode 100644 wiki-information/functions/GuildControlSetRankFlag.md create mode 100644 wiki-information/functions/GuildDemote.md create mode 100644 wiki-information/functions/GuildDisband.md create mode 100644 wiki-information/functions/GuildInvite.md create mode 100644 wiki-information/functions/GuildPromote.md create mode 100644 wiki-information/functions/GuildRosterSetOfficerNote.md create mode 100644 wiki-information/functions/GuildRosterSetPublicNote.md create mode 100644 wiki-information/functions/GuildSetLeader.md create mode 100644 wiki-information/functions/GuildSetMOTD.md create mode 100644 wiki-information/functions/GuildUninvite.md create mode 100644 wiki-information/functions/HasAction.md create mode 100644 wiki-information/functions/HasDualWieldPenalty.md create mode 100644 wiki-information/functions/HasFullControl.md create mode 100644 wiki-information/functions/HasIgnoreDualWieldWeapon.md create mode 100644 wiki-information/functions/HasInspectHonorData.md create mode 100644 wiki-information/functions/HasKey.md create mode 100644 wiki-information/functions/HasLFGRestrictions.md create mode 100644 wiki-information/functions/HasNoReleaseAura.md create mode 100644 wiki-information/functions/HasPetSpells.md create mode 100644 wiki-information/functions/HasPetUI.md create mode 100644 wiki-information/functions/HasWandEquipped.md create mode 100644 wiki-information/functions/InActiveBattlefield.md create mode 100644 wiki-information/functions/InCinematic.md create mode 100644 wiki-information/functions/InCombatLockdown.md create mode 100644 wiki-information/functions/InRepairMode.md create mode 100644 wiki-information/functions/InboxItemCanDelete.md create mode 100644 wiki-information/functions/InitiateRolePoll.md create mode 100644 wiki-information/functions/InitiateTrade.md create mode 100644 wiki-information/functions/InviteUnit.md create mode 100644 wiki-information/functions/Is64BitClient.md create mode 100644 wiki-information/functions/IsAccountSecured.md create mode 100644 wiki-information/functions/IsAchievementEligible.md create mode 100644 wiki-information/functions/IsActionInRange.md create mode 100644 wiki-information/functions/IsActiveBattlefieldArena.md create mode 100644 wiki-information/functions/IsAddOnLoadOnDemand.md create mode 100644 wiki-information/functions/IsAddOnLoaded.md create mode 100644 wiki-information/functions/IsAllowedToUserTeleport.md create mode 100644 wiki-information/functions/IsAltKeyDown.md create mode 100644 wiki-information/functions/IsAttackAction.md create mode 100644 wiki-information/functions/IsAttackSpell.md create mode 100644 wiki-information/functions/IsAutoRepeatAction.md create mode 100644 wiki-information/functions/IsBattlePayItem.md create mode 100644 wiki-information/functions/IsCemeterySelectionAvailable.md create mode 100644 wiki-information/functions/IsConsumableAction.md create mode 100644 wiki-information/functions/IsConsumableItem.md create mode 100644 wiki-information/functions/IsControlKeyDown.md create mode 100644 wiki-information/functions/IsCurrentAction.md create mode 100644 wiki-information/functions/IsCurrentSpell.md create mode 100644 wiki-information/functions/IsDebugBuild.md create mode 100644 wiki-information/functions/IsDualWielding.md create mode 100644 wiki-information/functions/IsEquippableItem.md create mode 100644 wiki-information/functions/IsEquippedAction.md create mode 100644 wiki-information/functions/IsEquippedItem.md create mode 100644 wiki-information/functions/IsEquippedItemType.md create mode 100644 wiki-information/functions/IsEuropeanNumbers.md create mode 100644 wiki-information/functions/IsExpansionTrial.md create mode 100644 wiki-information/functions/IsFactionInactive.md create mode 100644 wiki-information/functions/IsFalling.md create mode 100644 wiki-information/functions/IsFishingLoot.md create mode 100644 wiki-information/functions/IsFlyableArea.md create mode 100644 wiki-information/functions/IsFlying.md create mode 100644 wiki-information/functions/IsGMClient.md create mode 100644 wiki-information/functions/IsGUIDInGroup.md create mode 100644 wiki-information/functions/IsGuildLeader.md create mode 100644 wiki-information/functions/IsInCinematicScene.md create mode 100644 wiki-information/functions/IsInGroup.md create mode 100644 wiki-information/functions/IsInGuild.md create mode 100644 wiki-information/functions/IsInGuildGroup.md create mode 100644 wiki-information/functions/IsInInstance.md create mode 100644 wiki-information/functions/IsInLFGDungeon.md create mode 100644 wiki-information/functions/IsInRaid.md create mode 100644 wiki-information/functions/IsIndoors.md create mode 100644 wiki-information/functions/IsItemInRange.md create mode 100644 wiki-information/functions/IsLeftAltKeyDown.md create mode 100644 wiki-information/functions/IsLeftControlKeyDown.md create mode 100644 wiki-information/functions/IsLeftShiftKeyDown.md create mode 100644 wiki-information/functions/IsMacClient.md create mode 100644 wiki-information/functions/IsMetaKeyDown.md create mode 100644 wiki-information/functions/IsModifiedClick.md create mode 100644 wiki-information/functions/IsModifierKeyDown.md create mode 100644 wiki-information/functions/IsMounted.md create mode 100644 wiki-information/functions/IsMouseButtonDown.md create mode 100644 wiki-information/functions/IsMouselooking.md create mode 100644 wiki-information/functions/IsMovieLocal.md create mode 100644 wiki-information/functions/IsMoviePlayable.md create mode 100644 wiki-information/functions/IsOnGlueScreen.md create mode 100644 wiki-information/functions/IsOnTournamentRealm.md create mode 100644 wiki-information/functions/IsOutOfBounds.md create mode 100644 wiki-information/functions/IsOutdoors.md create mode 100644 wiki-information/functions/IsPVPTimerRunning.md create mode 100644 wiki-information/functions/IsPassiveSpell.md create mode 100644 wiki-information/functions/IsPetAttackActive.md create mode 100644 wiki-information/functions/IsPlayerAttacking.md create mode 100644 wiki-information/functions/IsPlayerInGuildFromGUID.md create mode 100644 wiki-information/functions/IsPlayerInWorld.md create mode 100644 wiki-information/functions/IsPlayerMoving.md create mode 100644 wiki-information/functions/IsPlayerSpell.md create mode 100644 wiki-information/functions/IsPublicBuild.md create mode 100644 wiki-information/functions/IsQuestCompletable.md create mode 100644 wiki-information/functions/IsQuestComplete.md create mode 100644 wiki-information/functions/IsQuestHardWatched.md create mode 100644 wiki-information/functions/IsQuestWatched.md create mode 100644 wiki-information/functions/IsRangedWeapon.md create mode 100644 wiki-information/functions/IsRecognizedName.md create mode 100644 wiki-information/functions/IsReferAFriendLinked.md create mode 100644 wiki-information/functions/IsResting.md create mode 100644 wiki-information/functions/IsRestrictedAccount.md create mode 100644 wiki-information/functions/IsRightAltKeyDown.md create mode 100644 wiki-information/functions/IsRightControlKeyDown.md create mode 100644 wiki-information/functions/IsRightMetaKeyDown.md create mode 100644 wiki-information/functions/IsRightShiftKeyDown.md create mode 100644 wiki-information/functions/IsShiftKeyDown.md create mode 100644 wiki-information/functions/IsSpellInRange.md create mode 100644 wiki-information/functions/IsSpellKnown.md create mode 100644 wiki-information/functions/IsStealthed.md create mode 100644 wiki-information/functions/IsSubmerged.md create mode 100644 wiki-information/functions/IsSwimming.md create mode 100644 wiki-information/functions/IsTargetLoose.md create mode 100644 wiki-information/functions/IsThreatWarningEnabled.md create mode 100644 wiki-information/functions/IsTitleKnown.md create mode 100644 wiki-information/functions/IsTrackedAchievement.md create mode 100644 wiki-information/functions/IsTradeskillTrainer.md create mode 100644 wiki-information/functions/IsTrainerServiceLearnSpell.md create mode 100644 wiki-information/functions/IsTrialAccount.md create mode 100644 wiki-information/functions/IsUnitOnQuestByQuestID.md create mode 100644 wiki-information/functions/IsUsableAction.md create mode 100644 wiki-information/functions/IsUsableSpell.md create mode 100644 wiki-information/functions/IsUsingFixedTimeStep.md create mode 100644 wiki-information/functions/IsUsingGamepad.md create mode 100644 wiki-information/functions/IsUsingMouse.md create mode 100644 wiki-information/functions/IsVeteranTrialAccount.md create mode 100644 wiki-information/functions/IsWargame.md create mode 100644 wiki-information/functions/IsXPUserDisabled.md create mode 100644 wiki-information/functions/ItemTextGetCreator.md create mode 100644 wiki-information/functions/ItemTextGetItem.md create mode 100644 wiki-information/functions/ItemTextGetMaterial.md create mode 100644 wiki-information/functions/ItemTextGetPage.md create mode 100644 wiki-information/functions/ItemTextGetText.md create mode 100644 wiki-information/functions/ItemTextHasNextPage.md create mode 100644 wiki-information/functions/ItemTextNextPage.md create mode 100644 wiki-information/functions/ItemTextPrevPage.md create mode 100644 wiki-information/functions/JoinBattlefield.md create mode 100644 wiki-information/functions/JoinChannelByName.md create mode 100644 wiki-information/functions/JoinPermanentChannel.md create mode 100644 wiki-information/functions/JoinSkirmish.md create mode 100644 wiki-information/functions/JoinTemporaryChannel.md create mode 100644 wiki-information/functions/JumpOrAscendStart.md create mode 100644 wiki-information/functions/KBArticle_BeginLoading.md create mode 100644 wiki-information/functions/KBArticle_GetData.md create mode 100644 wiki-information/functions/KBArticle_IsLoaded.md create mode 100644 wiki-information/functions/KBSetup_BeginLoading.md create mode 100644 wiki-information/functions/KBSetup_GetArticleHeaderCount.md create mode 100644 wiki-information/functions/KBSetup_GetArticleHeaderData.md create mode 100644 wiki-information/functions/KBSetup_GetCategoryCount.md create mode 100644 wiki-information/functions/KBSetup_GetCategoryData.md create mode 100644 wiki-information/functions/KBSetup_GetLanguageCount.md create mode 100644 wiki-information/functions/KBSetup_GetLanguageData.md create mode 100644 wiki-information/functions/KBSetup_GetSubCategoryCount.md create mode 100644 wiki-information/functions/KBSetup_GetSubCategoryData.md create mode 100644 wiki-information/functions/KBSetup_GetTotalArticleCount.md create mode 100644 wiki-information/functions/KBSetup_IsLoaded.md create mode 100644 wiki-information/functions/KBSystem_GetMOTD.md create mode 100644 wiki-information/functions/KBSystem_GetServerNotice.md create mode 100644 wiki-information/functions/KBSystem_GetServerStatus.md create mode 100644 wiki-information/functions/KeyRingButtonIDToInvSlotID.md create mode 100644 wiki-information/functions/LFGTeleport.md create mode 100644 wiki-information/functions/LearnTalent.md create mode 100644 wiki-information/functions/LeaveChannelByName.md create mode 100644 wiki-information/functions/ListChannelByName.md create mode 100644 wiki-information/functions/LoadAddOn.md create mode 100644 wiki-information/functions/LoadBindings.md create mode 100644 wiki-information/functions/LoadURLIndex.md create mode 100644 wiki-information/functions/LoggingChat.md create mode 100644 wiki-information/functions/LoggingCombat.md create mode 100644 wiki-information/functions/Logout.md create mode 100644 wiki-information/functions/LootSlot.md create mode 100644 wiki-information/functions/LootSlotHasItem.md create mode 100644 wiki-information/functions/MouselookStart.md create mode 100644 wiki-information/functions/MouselookStop.md create mode 100644 wiki-information/functions/MoveBackwardStart.md create mode 100644 wiki-information/functions/MoveBackwardStop.md create mode 100644 wiki-information/functions/MoveForwardStart.md create mode 100644 wiki-information/functions/MoveForwardStop.md create mode 100644 wiki-information/functions/MoveViewDownStart.md create mode 100644 wiki-information/functions/MoveViewDownStop.md create mode 100644 wiki-information/functions/MoveViewInStart.md create mode 100644 wiki-information/functions/MoveViewInStop.md create mode 100644 wiki-information/functions/MoveViewLeftStart.md create mode 100644 wiki-information/functions/MoveViewLeftStop.md create mode 100644 wiki-information/functions/MoveViewOutStart.md create mode 100644 wiki-information/functions/MoveViewOutStop.md create mode 100644 wiki-information/functions/MoveViewRightStart.md create mode 100644 wiki-information/functions/MoveViewRightStop.md create mode 100644 wiki-information/functions/MoveViewUpStart.md create mode 100644 wiki-information/functions/MoveViewUpStop.md create mode 100644 wiki-information/functions/MuteSoundFile.md create mode 100644 wiki-information/functions/NoPlayTime.md create mode 100644 wiki-information/functions/NotWhileDeadError.md create mode 100644 wiki-information/functions/NotifyInspect.md create mode 100644 wiki-information/functions/NumTaxiNodes.md create mode 100644 wiki-information/functions/OfferPetition.md create mode 100644 wiki-information/functions/PartialPlayTime.md create mode 100644 wiki-information/functions/PetAbandon.md create mode 100644 wiki-information/functions/PetAggressiveMode.md create mode 100644 wiki-information/functions/PetAttack.md create mode 100644 wiki-information/functions/PetCanBeAbandoned.md create mode 100644 wiki-information/functions/PetCanBeRenamed.md create mode 100644 wiki-information/functions/PetDefensiveMode.md create mode 100644 wiki-information/functions/PetFollow.md create mode 100644 wiki-information/functions/PetPassiveMode.md create mode 100644 wiki-information/functions/PetRename.md create mode 100644 wiki-information/functions/PetStopAttack.md create mode 100644 wiki-information/functions/PetWait.md create mode 100644 wiki-information/functions/PickupAction.md create mode 100644 wiki-information/functions/PickupBagFromSlot.md create mode 100644 wiki-information/functions/PickupCompanion.md create mode 100644 wiki-information/functions/PickupContainerItem.md create mode 100644 wiki-information/functions/PickupCurrency.md create mode 100644 wiki-information/functions/PickupInventoryItem.md create mode 100644 wiki-information/functions/PickupItem.md create mode 100644 wiki-information/functions/PickupMacro.md create mode 100644 wiki-information/functions/PickupMerchantItem.md create mode 100644 wiki-information/functions/PickupPetAction.md create mode 100644 wiki-information/functions/PickupPetSpell.md create mode 100644 wiki-information/functions/PickupPlayerMoney.md create mode 100644 wiki-information/functions/PickupSpell.md create mode 100644 wiki-information/functions/PickupSpellBookItem.md create mode 100644 wiki-information/functions/PickupStablePet.md create mode 100644 wiki-information/functions/PickupTradeMoney.md create mode 100644 wiki-information/functions/PlaceAction.md create mode 100644 wiki-information/functions/PlayMusic.md create mode 100644 wiki-information/functions/PlaySound.md create mode 100644 wiki-information/functions/PlaySoundFile.md create mode 100644 wiki-information/functions/PlayerCanTeleport.md create mode 100644 wiki-information/functions/PlayerEffectiveAttackPower.md create mode 100644 wiki-information/functions/PlayerHasToy.md create mode 100644 wiki-information/functions/PlayerIsPVPInactive.md create mode 100644 wiki-information/functions/PostAuction.md create mode 100644 wiki-information/functions/PreloadMovie.md create mode 100644 wiki-information/functions/ProcessExceptionClient.md create mode 100644 wiki-information/functions/PromoteToLeader.md create mode 100644 wiki-information/functions/PutItemInBackpack.md create mode 100644 wiki-information/functions/PutItemInBag.md create mode 100644 wiki-information/functions/QueryAuctionItems.md create mode 100644 wiki-information/functions/QuestChooseRewardError.md create mode 100644 wiki-information/functions/QuestIsDaily.md create mode 100644 wiki-information/functions/QuestLogPushQuest.md create mode 100644 wiki-information/functions/QuestPOIGetIconInfo.md create mode 100644 wiki-information/functions/Quit.md create mode 100644 wiki-information/functions/RandomRoll.md create mode 100644 wiki-information/functions/RejectProposal.md create mode 100644 wiki-information/functions/RemoveChatWindowChannel.md create mode 100644 wiki-information/functions/RemoveChatWindowMessages.md create mode 100644 wiki-information/functions/RemoveQuestWatch.md create mode 100644 wiki-information/functions/RemoveTrackedAchievement.md create mode 100644 wiki-information/functions/RenamePetition.md create mode 100644 wiki-information/functions/RepairAllItems.md create mode 100644 wiki-information/functions/ReplaceEnchant.md create mode 100644 wiki-information/functions/ReplaceGuildMaster.md create mode 100644 wiki-information/functions/ReplaceTradeEnchant.md create mode 100644 wiki-information/functions/RepopMe.md create mode 100644 wiki-information/functions/ReportBug.md create mode 100644 wiki-information/functions/ReportPlayerIsPVPAFK.md create mode 100644 wiki-information/functions/ReportSuggestion.md create mode 100644 wiki-information/functions/RequestBattlefieldScoreData.md create mode 100644 wiki-information/functions/RequestBattlegroundInstanceInfo.md create mode 100644 wiki-information/functions/RequestInspectHonorData.md create mode 100644 wiki-information/functions/RequestInviteFromUnit.md create mode 100644 wiki-information/functions/RequestRaidInfo.md create mode 100644 wiki-information/functions/RequestRatedInfo.md create mode 100644 wiki-information/functions/RequestTimePlayed.md create mode 100644 wiki-information/functions/ResetCursor.md create mode 100644 wiki-information/functions/ResetTutorials.md create mode 100644 wiki-information/functions/ResistancePercent.md create mode 100644 wiki-information/functions/RespondInstanceLock.md create mode 100644 wiki-information/functions/ResurrectGetOfferer.md create mode 100644 wiki-information/functions/ResurrectHasSickness.md create mode 100644 wiki-information/functions/ResurrectHasTimer.md create mode 100644 wiki-information/functions/RetrieveCorpse.md create mode 100644 wiki-information/functions/RollOnLoot.md create mode 100644 wiki-information/functions/RunBinding.md create mode 100644 wiki-information/functions/RunMacro.md create mode 100644 wiki-information/functions/RunMacroText.md create mode 100644 wiki-information/functions/RunScript.md create mode 100644 wiki-information/functions/SaveBindings.md create mode 100644 wiki-information/functions/SaveView.md create mode 100644 wiki-information/functions/Screenshot.md create mode 100644 wiki-information/functions/SearchLFGGetNumResults.md create mode 100644 wiki-information/functions/SearchLFGJoin.md create mode 100644 wiki-information/functions/SecureCmdOptionParse.md create mode 100644 wiki-information/functions/SelectGossipActiveQuest.md create mode 100644 wiki-information/functions/SelectGossipAvailableQuest.md create mode 100644 wiki-information/functions/SelectGossipOption.md create mode 100644 wiki-information/functions/SelectQuestLogEntry.md create mode 100644 wiki-information/functions/SelectTrainerService.md create mode 100644 wiki-information/functions/SelectedRealmName.md create mode 100644 wiki-information/functions/SendChatMessage.md create mode 100644 wiki-information/functions/SendMail.md create mode 100644 wiki-information/functions/SendSystemMessage.md create mode 100644 wiki-information/functions/SetAbandonQuest.md create mode 100644 wiki-information/functions/SetAchievementComparisonUnit.md create mode 100644 wiki-information/functions/SetActionBarToggles.md create mode 100644 wiki-information/functions/SetActiveTalentGroup.md create mode 100644 wiki-information/functions/SetAllowDangerousScripts.md create mode 100644 wiki-information/functions/SetAllowLowLevelRaid.md create mode 100644 wiki-information/functions/SetAutoDeclineGuildInvites.md create mode 100644 wiki-information/functions/SetBattlefieldScoreFaction.md create mode 100644 wiki-information/functions/SetBinding.md create mode 100644 wiki-information/functions/SetBindingClick.md create mode 100644 wiki-information/functions/SetBindingItem.md create mode 100644 wiki-information/functions/SetBindingMacro.md create mode 100644 wiki-information/functions/SetBindingSpell.md create mode 100644 wiki-information/functions/SetCemeteryPreference.md create mode 100644 wiki-information/functions/SetChannelPassword.md create mode 100644 wiki-information/functions/SetConsoleKey.md create mode 100644 wiki-information/functions/SetCurrencyBackpack.md create mode 100644 wiki-information/functions/SetCurrencyUnused.md create mode 100644 wiki-information/functions/SetCurrentTitle.md create mode 100644 wiki-information/functions/SetCursor.md create mode 100644 wiki-information/functions/SetDungeonDifficultyID.md create mode 100644 wiki-information/functions/SetFactionActive.md create mode 100644 wiki-information/functions/SetFactionInactive.md create mode 100644 wiki-information/functions/SetGuildBankTabInfo.md create mode 100644 wiki-information/functions/SetGuildBankTabPermissions.md create mode 100644 wiki-information/functions/SetGuildBankText.md create mode 100644 wiki-information/functions/SetGuildBankWithdrawGoldLimit.md create mode 100644 wiki-information/functions/SetGuildInfoText.md create mode 100644 wiki-information/functions/SetGuildRosterShowOffline.md create mode 100644 wiki-information/functions/SetInWorldUIVisibility.md create mode 100644 wiki-information/functions/SetLFGComment.md create mode 100644 wiki-information/functions/SetLegacyRaidDifficultyID.md create mode 100644 wiki-information/functions/SetLootThreshold.md create mode 100644 wiki-information/functions/SetMacroSpell.md create mode 100644 wiki-information/functions/SetModifiedClick.md create mode 100644 wiki-information/functions/SetMoveEnabled.md create mode 100644 wiki-information/functions/SetMultiCastSpell.md create mode 100644 wiki-information/functions/SetOptOutOfLoot.md create mode 100644 wiki-information/functions/SetOverrideBinding.md create mode 100644 wiki-information/functions/SetOverrideBindingClick.md create mode 100644 wiki-information/functions/SetOverrideBindingItem.md create mode 100644 wiki-information/functions/SetOverrideBindingMacro.md create mode 100644 wiki-information/functions/SetOverrideBindingSpell.md create mode 100644 wiki-information/functions/SetPVP.md create mode 100644 wiki-information/functions/SetPVPRoles.md create mode 100644 wiki-information/functions/SetPendingReportPetTarget.md create mode 100644 wiki-information/functions/SetPendingReportTarget.md create mode 100644 wiki-information/functions/SetPetStablePaperdoll.md create mode 100644 wiki-information/functions/SetPortraitTexture.md create mode 100644 wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md create mode 100644 wiki-information/functions/SetPortraitToTexture.md create mode 100644 wiki-information/functions/SetRaidDifficultyID.md create mode 100644 wiki-information/functions/SetRaidTarget.md create mode 100644 wiki-information/functions/SetScreenResolution.md create mode 100644 wiki-information/functions/SetSelectedBattlefield.md create mode 100644 wiki-information/functions/SetSelectedSkill.md create mode 100644 wiki-information/functions/SetSuperTrackedQuestID.md create mode 100644 wiki-information/functions/SetTalentGroupRole.md create mode 100644 wiki-information/functions/SetTaxiMap.md create mode 100644 wiki-information/functions/SetTracking.md create mode 100644 wiki-information/functions/SetTradeMoney.md create mode 100644 wiki-information/functions/SetTradeSkillItemLevelFilter.md create mode 100644 wiki-information/functions/SetTradeSkillSubClassFilter.md create mode 100644 wiki-information/functions/SetTrainerServiceTypeFilter.md create mode 100644 wiki-information/functions/SetTurnEnabled.md create mode 100644 wiki-information/functions/SetUIVisibility.md create mode 100644 wiki-information/functions/SetUnitCursorTexture.md create mode 100644 wiki-information/functions/SetView.md create mode 100644 wiki-information/functions/SetWatchedFactionIndex.md create mode 100644 wiki-information/functions/SetupFullscreenScale.md create mode 100644 wiki-information/functions/ShiftQuestWatches.md create mode 100644 wiki-information/functions/ShowBossFrameWhenUninteractable.md create mode 100644 wiki-information/functions/ShowCloak.md create mode 100644 wiki-information/functions/ShowHelm.md create mode 100644 wiki-information/functions/ShowQuestComplete.md create mode 100644 wiki-information/functions/ShowRepairCursor.md create mode 100644 wiki-information/functions/ShowingCloak.md create mode 100644 wiki-information/functions/ShowingHelm.md create mode 100644 wiki-information/functions/SitStandOrDescendStart.md create mode 100644 wiki-information/functions/SortAuctionSetSort.md create mode 100644 wiki-information/functions/SortQuestWatches.md create mode 100644 wiki-information/functions/SpellCanTargetUnit.md create mode 100644 wiki-information/functions/SpellGetVisibilityInfo.md create mode 100644 wiki-information/functions/SpellIsTargeting.md create mode 100644 wiki-information/functions/SpellStopCasting.md create mode 100644 wiki-information/functions/SpellStopTargeting.md create mode 100644 wiki-information/functions/SpellTargetUnit.md create mode 100644 wiki-information/functions/SplitContainerItem.md create mode 100644 wiki-information/functions/StablePet.md create mode 100644 wiki-information/functions/StartAuction.md create mode 100644 wiki-information/functions/StartDuel.md create mode 100644 wiki-information/functions/StopMusic.md create mode 100644 wiki-information/functions/StopSound.md create mode 100644 wiki-information/functions/StopTradeSkillRepeat.md create mode 100644 wiki-information/functions/StrafeLeftStart.md create mode 100644 wiki-information/functions/StrafeLeftStop.md create mode 100644 wiki-information/functions/StrafeRightStart.md create mode 100644 wiki-information/functions/StrafeRightStop.md create mode 100644 wiki-information/functions/StripHyperlinks.md create mode 100644 wiki-information/functions/Stuck.md create mode 100644 wiki-information/functions/SummonFriend.md create mode 100644 wiki-information/functions/SupportsClipCursor.md create mode 100644 wiki-information/functions/SwapRaidSubgroup.md create mode 100644 wiki-information/functions/TakeInboxItem.md create mode 100644 wiki-information/functions/TakeInboxMoney.md create mode 100644 wiki-information/functions/TakeTaxiNode.md create mode 100644 wiki-information/functions/TargetDirectionEnemy.md create mode 100644 wiki-information/functions/TargetDirectionFriend.md create mode 100644 wiki-information/functions/TargetLastEnemy.md create mode 100644 wiki-information/functions/TargetLastTarget.md create mode 100644 wiki-information/functions/TargetNearest.md create mode 100644 wiki-information/functions/TargetNearestEnemy.md create mode 100644 wiki-information/functions/TargetNearestEnemyPlayer.md create mode 100644 wiki-information/functions/TargetNearestFriend.md create mode 100644 wiki-information/functions/TargetNearestFriendPlayer.md create mode 100644 wiki-information/functions/TargetNearestPartyMember.md create mode 100644 wiki-information/functions/TargetNearestRaidMember.md create mode 100644 wiki-information/functions/TargetPriorityHighlightStart.md create mode 100644 wiki-information/functions/TargetTotem.md create mode 100644 wiki-information/functions/TargetUnit.md create mode 100644 wiki-information/functions/TaxiGetDestX.md create mode 100644 wiki-information/functions/TaxiGetDestY.md create mode 100644 wiki-information/functions/TaxiGetSrcX.md create mode 100644 wiki-information/functions/TaxiGetSrcY.md create mode 100644 wiki-information/functions/TaxiNodeCost.md create mode 100644 wiki-information/functions/TaxiNodeGetType.md create mode 100644 wiki-information/functions/TaxiNodeName.md create mode 100644 wiki-information/functions/TimeoutResurrect.md create mode 100644 wiki-information/functions/ToggleAutoRun.md create mode 100644 wiki-information/functions/TogglePVP.md create mode 100644 wiki-information/functions/ToggleRun.md create mode 100644 wiki-information/functions/ToggleSelfHighlight.md create mode 100644 wiki-information/functions/ToggleSheath.md create mode 100644 wiki-information/functions/TurnLeftStart.md create mode 100644 wiki-information/functions/TurnLeftStop.md create mode 100644 wiki-information/functions/TurnOrActionStart.md create mode 100644 wiki-information/functions/TurnOrActionStop.md create mode 100644 wiki-information/functions/TurnRightStart.md create mode 100644 wiki-information/functions/TurnRightStop.md create mode 100644 wiki-information/functions/UninviteUnit.md create mode 100644 wiki-information/functions/UnitAffectingCombat.md create mode 100644 wiki-information/functions/UnitArmor.md create mode 100644 wiki-information/functions/UnitAttackBothHands.md create mode 100644 wiki-information/functions/UnitAttackPower.md create mode 100644 wiki-information/functions/UnitAttackSpeed.md create mode 100644 wiki-information/functions/UnitAura.md create mode 100644 wiki-information/functions/UnitBuff.md create mode 100644 wiki-information/functions/UnitCanAssist.md create mode 100644 wiki-information/functions/UnitCanAttack.md create mode 100644 wiki-information/functions/UnitCanCooperate.md create mode 100644 wiki-information/functions/UnitCastingInfo.md create mode 100644 wiki-information/functions/UnitChannelInfo.md create mode 100644 wiki-information/functions/UnitCharacterPoints.md create mode 100644 wiki-information/functions/UnitClass.md create mode 100644 wiki-information/functions/UnitClassBase.md create mode 100644 wiki-information/functions/UnitClassification.md create mode 100644 wiki-information/functions/UnitControllingVehicle.md create mode 100644 wiki-information/functions/UnitCreatureFamily.md create mode 100644 wiki-information/functions/UnitCreatureType.md create mode 100644 wiki-information/functions/UnitDamage.md create mode 100644 wiki-information/functions/UnitDebuff.md create mode 100644 wiki-information/functions/UnitDetailedThreatSituation.md create mode 100644 wiki-information/functions/UnitDistanceSquared.md create mode 100644 wiki-information/functions/UnitEffectiveLevel.md create mode 100644 wiki-information/functions/UnitExists.md create mode 100644 wiki-information/functions/UnitFactionGroup.md create mode 100644 wiki-information/functions/UnitFullName.md create mode 100644 wiki-information/functions/UnitGUID.md create mode 100644 wiki-information/functions/UnitGetAvailableRoles.md create mode 100644 wiki-information/functions/UnitGetIncomingHeals.md create mode 100644 wiki-information/functions/UnitGroupRolesAssigned.md create mode 100644 wiki-information/functions/UnitHPPerStamina.md create mode 100644 wiki-information/functions/UnitHasIncomingResurrection.md create mode 100644 wiki-information/functions/UnitHasLFGDeserter.md create mode 100644 wiki-information/functions/UnitHasLFGRandomCooldown.md create mode 100644 wiki-information/functions/UnitHasRelicSlot.md create mode 100644 wiki-information/functions/UnitHasVehiclePlayerFrameUI.md create mode 100644 wiki-information/functions/UnitHasVehicleUI.md create mode 100644 wiki-information/functions/UnitHealth.md create mode 100644 wiki-information/functions/UnitHealthMax.md create mode 100644 wiki-information/functions/UnitInAnyGroup.md create mode 100644 wiki-information/functions/UnitInBattleground.md create mode 100644 wiki-information/functions/UnitInParty.md create mode 100644 wiki-information/functions/UnitInPartyIsAI.md create mode 100644 wiki-information/functions/UnitInPhase.md create mode 100644 wiki-information/functions/UnitInRaid.md create mode 100644 wiki-information/functions/UnitInRange.md create mode 100644 wiki-information/functions/UnitInSubgroup.md create mode 100644 wiki-information/functions/UnitInVehicle.md create mode 100644 wiki-information/functions/UnitInVehicleControlSeat.md create mode 100644 wiki-information/functions/UnitInVehicleHidesPetFrame.md create mode 100644 wiki-information/functions/UnitIsAFK.md create mode 100644 wiki-information/functions/UnitIsCharmed.md create mode 100644 wiki-information/functions/UnitIsCivilian.md create mode 100644 wiki-information/functions/UnitIsConnected.md create mode 100644 wiki-information/functions/UnitIsControlling.md create mode 100644 wiki-information/functions/UnitIsCorpse.md create mode 100644 wiki-information/functions/UnitIsDND.md create mode 100644 wiki-information/functions/UnitIsDead.md create mode 100644 wiki-information/functions/UnitIsDeadOrGhost.md create mode 100644 wiki-information/functions/UnitIsEnemy.md create mode 100644 wiki-information/functions/UnitIsFeignDeath.md create mode 100644 wiki-information/functions/UnitIsFriend.md create mode 100644 wiki-information/functions/UnitIsGameObject.md create mode 100644 wiki-information/functions/UnitIsGhost.md create mode 100644 wiki-information/functions/UnitIsGroupAssistant.md create mode 100644 wiki-information/functions/UnitIsGroupLeader.md create mode 100644 wiki-information/functions/UnitIsInMyGuild.md create mode 100644 wiki-information/functions/UnitIsInteractable.md create mode 100644 wiki-information/functions/UnitIsOtherPlayersPet.md create mode 100644 wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md create mode 100644 wiki-information/functions/UnitIsPVPFreeForAll.md create mode 100644 wiki-information/functions/UnitIsPVPSanctuary.md create mode 100644 wiki-information/functions/UnitIsPlayer.md create mode 100644 wiki-information/functions/UnitIsPossessed.md create mode 100644 wiki-information/functions/UnitIsRaidOfficer.md create mode 100644 wiki-information/functions/UnitIsSameServer.md create mode 100644 wiki-information/functions/UnitIsTapDenied.md create mode 100644 wiki-information/functions/UnitIsTrivial.md create mode 100644 wiki-information/functions/UnitIsUnconscious.md create mode 100644 wiki-information/functions/UnitIsUnit.md create mode 100644 wiki-information/functions/UnitLevel.md create mode 100644 wiki-information/functions/UnitName.md create mode 100644 wiki-information/functions/UnitNameUnmodified.md create mode 100644 wiki-information/functions/UnitOnTaxi.md create mode 100644 wiki-information/functions/UnitPVPName.md create mode 100644 wiki-information/functions/UnitPVPRank.md create mode 100644 wiki-information/functions/UnitPlayerControlled.md create mode 100644 wiki-information/functions/UnitPlayerOrPetInParty.md create mode 100644 wiki-information/functions/UnitPlayerOrPetInRaid.md create mode 100644 wiki-information/functions/UnitPosition.md create mode 100644 wiki-information/functions/UnitPower.md create mode 100644 wiki-information/functions/UnitPowerDisplayMod.md create mode 100644 wiki-information/functions/UnitPowerMax.md create mode 100644 wiki-information/functions/UnitPowerType.md create mode 100644 wiki-information/functions/UnitRace.md create mode 100644 wiki-information/functions/UnitRangedAttack.md create mode 100644 wiki-information/functions/UnitRangedAttackPower.md create mode 100644 wiki-information/functions/UnitRangedDamage.md create mode 100644 wiki-information/functions/UnitReaction.md create mode 100644 wiki-information/functions/UnitRealmRelationship.md create mode 100644 wiki-information/functions/UnitResistance.md create mode 100644 wiki-information/functions/UnitSelectionColor.md create mode 100644 wiki-information/functions/UnitSetRole.md create mode 100644 wiki-information/functions/UnitSex.md create mode 100644 wiki-information/functions/UnitShouldDisplayName.md create mode 100644 wiki-information/functions/UnitStat.md create mode 100644 wiki-information/functions/UnitSwitchToVehicleSeat.md create mode 100644 wiki-information/functions/UnitTargetsVehicleInRaidUI.md create mode 100644 wiki-information/functions/UnitThreatPercentageOfLead.md create mode 100644 wiki-information/functions/UnitThreatSituation.md create mode 100644 wiki-information/functions/UnitTrialBankedLevels.md create mode 100644 wiki-information/functions/UnitTrialXP.md create mode 100644 wiki-information/functions/UnitUsingVehicle.md create mode 100644 wiki-information/functions/UnitVehicleSeatCount.md create mode 100644 wiki-information/functions/UnitVehicleSeatInfo.md create mode 100644 wiki-information/functions/UnitVehicleSkin.md create mode 100644 wiki-information/functions/UnitXP.md create mode 100644 wiki-information/functions/UnitXPMax.md create mode 100644 wiki-information/functions/UnmuteSoundFile.md create mode 100644 wiki-information/functions/UnstablePet.md create mode 100644 wiki-information/functions/UpdateWindow.md create mode 100644 wiki-information/functions/UseAction.md create mode 100644 wiki-information/functions/UseContainerItem.md create mode 100644 wiki-information/functions/UseInventoryItem.md create mode 100644 wiki-information/functions/UseItemByName.md create mode 100644 wiki-information/functions/UseToy.md create mode 100644 wiki-information/functions/UseToyByName.md create mode 100644 wiki-information/functions/addframetext.md create mode 100644 wiki-information/functions/debuglocals.md create mode 100644 wiki-information/functions/debugprofilestart.md create mode 100644 wiki-information/functions/debugprofilestop.md create mode 100644 wiki-information/functions/debugstack.md create mode 100644 wiki-information/functions/forceinsecure.md create mode 100644 wiki-information/functions/geterrorhandler.md create mode 100644 wiki-information/functions/hooksecurefunc.md create mode 100644 wiki-information/functions/issecure.md create mode 100644 wiki-information/functions/issecurevariable.md create mode 100644 wiki-information/functions/pcallwithenv.md create mode 100644 wiki-information/functions/scrub.md create mode 100644 wiki-information/functions/securecall.md create mode 100644 wiki-information/functions/securecallfunction.md create mode 100644 wiki-information/functions/secureexecuterange.md create mode 100644 wiki-information/functions/seterrorhandler.md diff --git a/wiki-information/events/ACHIEVEMENT_EARNED.md b/wiki-information/events/ACHIEVEMENT_EARNED.md new file mode 100644 index 00000000..2bdc96a9 --- /dev/null +++ b/wiki-information/events/ACHIEVEMENT_EARNED.md @@ -0,0 +1,13 @@ +## Event: ACHIEVEMENT_EARNED + +**Title:** ACHIEVEMENT EARNED + +**Content:** +Fired when an achievement is gained. +`ACHIEVEMENT_EARNED: achievementID, alreadyEarned` + +**Payload:** +- `achievementID` + - *number* - The id of the achievement gained. +- `alreadyEarned` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md b/wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md new file mode 100644 index 00000000..af7083c5 --- /dev/null +++ b/wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md @@ -0,0 +1,11 @@ +## Event: ACHIEVEMENT_PLAYER_NAME + +**Title:** ACHIEVEMENT PLAYER NAME + +**Content:** +Needs summary. +`ACHIEVEMENT_PLAYER_NAME: achievementID` + +**Payload:** +- `achievementID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md b/wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md new file mode 100644 index 00000000..63a9d38d --- /dev/null +++ b/wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md @@ -0,0 +1,10 @@ +## Event: ACHIEVEMENT_SEARCH_UPDATED + +**Title:** ACHIEVEMENT SEARCH UPDATED + +**Content:** +Needs summary. +`ACHIEVEMENT_SEARCH_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_HIDEGRID.md b/wiki-information/events/ACTIONBAR_HIDEGRID.md new file mode 100644 index 00000000..860cbd27 --- /dev/null +++ b/wiki-information/events/ACTIONBAR_HIDEGRID.md @@ -0,0 +1,10 @@ +## Event: ACTIONBAR_HIDEGRID + +**Title:** ACTIONBAR HIDEGRID + +**Content:** +Fired when the actionbar numbers disappear, typically when you finish dragging something to the actionbar. +`ACTIONBAR_HIDEGRID` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_PAGE_CHANGED.md b/wiki-information/events/ACTIONBAR_PAGE_CHANGED.md new file mode 100644 index 00000000..fe16a9d5 --- /dev/null +++ b/wiki-information/events/ACTIONBAR_PAGE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: ACTIONBAR_PAGE_CHANGED + +**Title:** ACTIONBAR PAGE CHANGED + +**Content:** +Fired when the actionbar page changes, typically when you press the pageup or pagedown button. +`ACTIONBAR_PAGE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_SHOWGRID.md b/wiki-information/events/ACTIONBAR_SHOWGRID.md new file mode 100644 index 00000000..d6e8d0c5 --- /dev/null +++ b/wiki-information/events/ACTIONBAR_SHOWGRID.md @@ -0,0 +1,10 @@ +## Event: ACTIONBAR_SHOWGRID + +**Title:** ACTIONBAR SHOWGRID + +**Content:** +Fired when the actionbar numbers appear, typically when you drag a spell to the actionbar. +`ACTIONBAR_SHOWGRID` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md b/wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md new file mode 100644 index 00000000..8f3e2bbe --- /dev/null +++ b/wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md @@ -0,0 +1,27 @@ +## Event: ACTIONBAR_SHOW_BOTTOMLEFT + +**Title:** ACTIONBAR SHOW BOTTOMLEFT + +**Content:** +Fires if the bottom-left multi-action bar must appear to hold a new ability. +`ACTIONBAR_SHOW_BOTTOMLEFT` + +**Payload:** +- `None` + +**Content Details:** +The first return value from GetActionBarToggles() changes from false to true before this event fires. +This event fires (if necessary) before SPELL_PUSHED_TO_ACTIONBAR. + +**Usage:** +```lua +-- prevent the MultiBarBottomLeft from appearing when the event fires +ActionBarController:UnregisterEvent("ACTIONBAR_SHOW_BOTTOMLEFT") +-- return the options to their previous state, for the next /reload +local frame = CreateFrame("Frame") +frame:RegisterEvent("ACTIONBAR_SHOW_BOTTOMLEFT") +frame:SetScript("OnEvent", function() + local __, bottomRight, sideRight, sideLeft = GetActionBarToggles() + SetActionBarToggles(false, bottomRight, sideRight, sideLeft) +end) +``` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_SLOT_CHANGED.md b/wiki-information/events/ACTIONBAR_SLOT_CHANGED.md new file mode 100644 index 00000000..d0f9672e --- /dev/null +++ b/wiki-information/events/ACTIONBAR_SLOT_CHANGED.md @@ -0,0 +1,14 @@ +## Event: ACTIONBAR_SLOT_CHANGED + +**Title:** ACTIONBAR SLOT CHANGED + +**Content:** +Fired when any actionbar slot's contents change; typically the picking up and dropping of buttons. +`ACTIONBAR_SLOT_CHANGED: slot` + +**Payload:** +- `slot` + - *number* + +**Content Details:** +On 4/24/2006, Slouken stated "ACTIONBAR_SLOT_CHANGED is also sent whenever something changes whether or not the button should be dimmed. The first argument is the slot which changed." This means actions that affect the internal fields of action bar buttons also generate this event for the affected button(s). Examples include the Start and End of casting channeled spells, casting a new buff on yourself, and the cancellation or expiration of a buff on yourself. \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md b/wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md new file mode 100644 index 00000000..5fba2342 --- /dev/null +++ b/wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md @@ -0,0 +1,10 @@ +## Event: ACTIONBAR_UPDATE_COOLDOWN + +**Title:** ACTIONBAR UPDATE COOLDOWN + +**Content:** +Fired when the cooldown for an actionbar or inventory slot starts or stops. Also fires when you log into a new area. +`ACTIONBAR_UPDATE_COOLDOWN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_UPDATE_STATE.md b/wiki-information/events/ACTIONBAR_UPDATE_STATE.md new file mode 100644 index 00000000..17fbe9ec --- /dev/null +++ b/wiki-information/events/ACTIONBAR_UPDATE_STATE.md @@ -0,0 +1,10 @@ +## Event: ACTIONBAR_UPDATE_STATE + +**Title:** ACTIONBAR UPDATE STATE + +**Content:** +Fired when the state of anything on the actionbar changes. This includes cooldown and disabling. +`ACTIONBAR_UPDATE_STATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_UPDATE_USABLE.md b/wiki-information/events/ACTIONBAR_UPDATE_USABLE.md new file mode 100644 index 00000000..1678fcae --- /dev/null +++ b/wiki-information/events/ACTIONBAR_UPDATE_USABLE.md @@ -0,0 +1,10 @@ +## Event: ACTIONBAR_UPDATE_USABLE + +**Title:** ACTIONBAR UPDATE USABLE + +**Content:** +Fired when something in the actionbar or your inventory becomes usable (after eating or drinking a potion, or entering/leaving stealth; for example). This is affected by rage/mana/energy available, but not by range. +`ACTIONBAR_UPDATE_USABLE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTION_WILL_BIND_ITEM.md b/wiki-information/events/ACTION_WILL_BIND_ITEM.md new file mode 100644 index 00000000..97e7f33f --- /dev/null +++ b/wiki-information/events/ACTION_WILL_BIND_ITEM.md @@ -0,0 +1,10 @@ +## Event: ACTION_WILL_BIND_ITEM + +**Title:** ACTION WILL BIND ITEM + +**Content:** +Needs summary. +`ACTION_WILL_BIND_ITEM` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIVATE_GLYPH.md b/wiki-information/events/ACTIVATE_GLYPH.md new file mode 100644 index 00000000..ead178c2 --- /dev/null +++ b/wiki-information/events/ACTIVATE_GLYPH.md @@ -0,0 +1,11 @@ +## Event: ACTIVATE_GLYPH + +**Title:** ACTIVATE GLYPH + +**Content:** +Fires after successfully applying a new glyph to an ability in the spell book. +`ACTIVATE_GLYPH: spellID` + +**Payload:** +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md b/wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md new file mode 100644 index 00000000..42f3ef66 --- /dev/null +++ b/wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md @@ -0,0 +1,13 @@ +## Event: ACTIVE_TALENT_GROUP_CHANGED + +**Title:** ACTIVE TALENT GROUP CHANGED + +**Content:** +Fired when a player switches changes which talent group (dual specialization) is active. +`ACTIVE_TALENT_GROUP_CHANGED: curr, prev` + +**Payload:** +- `curr` + - *number* - Index of the talent group that is now active. +- `prev` + - *number* - Index of the talent group that was active before changing. \ No newline at end of file diff --git a/wiki-information/events/ADAPTER_LIST_CHANGED.md b/wiki-information/events/ADAPTER_LIST_CHANGED.md new file mode 100644 index 00000000..b0b7010d --- /dev/null +++ b/wiki-information/events/ADAPTER_LIST_CHANGED.md @@ -0,0 +1,10 @@ +## Event: ADAPTER_LIST_CHANGED + +**Title:** ADAPTER LIST CHANGED + +**Content:** +Needs summary. +`ADAPTER_LIST_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ADDONS_UNLOADING.md b/wiki-information/events/ADDONS_UNLOADING.md new file mode 100644 index 00000000..7ce8e0a2 --- /dev/null +++ b/wiki-information/events/ADDONS_UNLOADING.md @@ -0,0 +1,11 @@ +## Event: ADDONS_UNLOADING + +**Title:** ADDONS UNLOADING + +**Content:** +Needs summary. +`ADDONS_UNLOADING: closingClient` + +**Payload:** +- `closingClient` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/ADDON_ACTION_BLOCKED.md b/wiki-information/events/ADDON_ACTION_BLOCKED.md new file mode 100644 index 00000000..d26d3164 --- /dev/null +++ b/wiki-information/events/ADDON_ACTION_BLOCKED.md @@ -0,0 +1,13 @@ +## Event: ADDON_ACTION_BLOCKED + +**Title:** ADDON ACTION BLOCKED + +**Content:** +Fires when a protected function is being called from tainted code, e.g. taint from an addon. +`ADDON_ACTION_BLOCKED: isTainted, function` + +**Payload:** +- `isTainted` + - *string* +- `function` + - *string* \ No newline at end of file diff --git a/wiki-information/events/ADDON_ACTION_FORBIDDEN.md b/wiki-information/events/ADDON_ACTION_FORBIDDEN.md new file mode 100644 index 00000000..cbc46736 --- /dev/null +++ b/wiki-information/events/ADDON_ACTION_FORBIDDEN.md @@ -0,0 +1,13 @@ +## Event: ADDON_ACTION_FORBIDDEN + +**Title:** ADDON ACTION FORBIDDEN + +**Content:** +Fires when an AddOn tries use actions that are always forbidden (movement, targeting, etc.). +`ADDON_ACTION_FORBIDDEN: isTainted, function` + +**Payload:** +- `isTainted` + - *string* - Name of the AddOn that was last involved in the execution path. It's very possible that the name will not be the name of the addon that tried to call the protected function. +- `function` + - *string* - The protected function that was called. \ No newline at end of file diff --git a/wiki-information/events/ADDON_LOADED.md b/wiki-information/events/ADDON_LOADED.md new file mode 100644 index 00000000..40427955 --- /dev/null +++ b/wiki-information/events/ADDON_LOADED.md @@ -0,0 +1,17 @@ +## Event: ADDON_LOADED + +**Title:** ADDON LOADED + +**Content:** +Fires after an AddOn has been loaded. +`ADDON_LOADED: addOnName, containsBindings` + +**Payload:** +- `addOnName` + - *string* - The name of the addon. +- `containsBindings` + - *boolean* + +**Content Details:** +An addon is loaded after all .lua files have been run and SavedVariables have loaded. +If there was an out-of-memory error, this event fires before SAVED_VARIABLES_TOO_LARGE. Otherwise, when saving variables between game sessions, this is the first time an AddOn can access its saved variables. \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_CLOSE.md b/wiki-information/events/ADVENTURE_MAP_CLOSE.md new file mode 100644 index 00000000..58f52307 --- /dev/null +++ b/wiki-information/events/ADVENTURE_MAP_CLOSE.md @@ -0,0 +1,10 @@ +## Event: ADVENTURE_MAP_CLOSE + +**Title:** ADVENTURE MAP CLOSE + +**Content:** +Needs summary. +`ADVENTURE_MAP_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_OPEN.md b/wiki-information/events/ADVENTURE_MAP_OPEN.md new file mode 100644 index 00000000..dd55bf79 --- /dev/null +++ b/wiki-information/events/ADVENTURE_MAP_OPEN.md @@ -0,0 +1,11 @@ +## Event: ADVENTURE_MAP_OPEN + +**Title:** ADVENTURE MAP OPEN + +**Content:** +Needs summary. +`ADVENTURE_MAP_OPEN: followerTypeID` + +**Payload:** +- `followerTypeID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md b/wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md new file mode 100644 index 00000000..783a33eb --- /dev/null +++ b/wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md @@ -0,0 +1,11 @@ +## Event: ADVENTURE_MAP_QUEST_UPDATE + +**Title:** ADVENTURE MAP QUEST UPDATE + +**Content:** +Needs summary. +`ADVENTURE_MAP_QUEST_UPDATE: questID` + +**Payload:** +- `questID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md b/wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md new file mode 100644 index 00000000..dea07151 --- /dev/null +++ b/wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md @@ -0,0 +1,10 @@ +## Event: ADVENTURE_MAP_UPDATE_INSETS + +**Title:** ADVENTURE MAP UPDATE INSETS + +**Content:** +Needs summary. +`ADVENTURE_MAP_UPDATE_INSETS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md b/wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md new file mode 100644 index 00000000..d3dd62d6 --- /dev/null +++ b/wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md @@ -0,0 +1,10 @@ +## Event: ADVENTURE_MAP_UPDATE_POIS + +**Title:** ADVENTURE MAP UPDATE POIS + +**Content:** +Needs summary. +`ADVENTURE_MAP_UPDATE_POIS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_DUNGEON_ACTION.md b/wiki-information/events/AJ_DUNGEON_ACTION.md new file mode 100644 index 00000000..c7b190ec --- /dev/null +++ b/wiki-information/events/AJ_DUNGEON_ACTION.md @@ -0,0 +1,11 @@ +## Event: AJ_DUNGEON_ACTION + +**Title:** AJ DUNGEON ACTION + +**Content:** +Needs summary. +`AJ_DUNGEON_ACTION: lfgDungeonID` + +**Payload:** +- `lfgDungeonID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_OPEN.md b/wiki-information/events/AJ_OPEN.md new file mode 100644 index 00000000..e2100fbe --- /dev/null +++ b/wiki-information/events/AJ_OPEN.md @@ -0,0 +1,10 @@ +## Event: AJ_OPEN + +**Title:** AJ OPEN + +**Content:** +Needs summary. +`AJ_OPEN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVE_LFG_ACTION.md b/wiki-information/events/AJ_PVE_LFG_ACTION.md new file mode 100644 index 00000000..2ea43c59 --- /dev/null +++ b/wiki-information/events/AJ_PVE_LFG_ACTION.md @@ -0,0 +1,10 @@ +## Event: AJ_PVE_LFG_ACTION + +**Title:** AJ PVE LFG ACTION + +**Content:** +Needs summary. +`AJ_PVE_LFG_ACTION` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_ACTION.md b/wiki-information/events/AJ_PVP_ACTION.md new file mode 100644 index 00000000..75fa821b --- /dev/null +++ b/wiki-information/events/AJ_PVP_ACTION.md @@ -0,0 +1,11 @@ +## Event: AJ_PVP_ACTION + +**Title:** AJ PVP ACTION + +**Content:** +Needs summary. +`AJ_PVP_ACTION: battleMasterListID` + +**Payload:** +- `battleMasterListID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_LFG_ACTION.md b/wiki-information/events/AJ_PVP_LFG_ACTION.md new file mode 100644 index 00000000..bbbcffc0 --- /dev/null +++ b/wiki-information/events/AJ_PVP_LFG_ACTION.md @@ -0,0 +1,10 @@ +## Event: AJ_PVP_LFG_ACTION + +**Title:** AJ PVP LFG ACTION + +**Content:** +Needs summary. +`AJ_PVP_LFG_ACTION` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_RBG_ACTION.md b/wiki-information/events/AJ_PVP_RBG_ACTION.md new file mode 100644 index 00000000..eb54ed74 --- /dev/null +++ b/wiki-information/events/AJ_PVP_RBG_ACTION.md @@ -0,0 +1,10 @@ +## Event: AJ_PVP_RBG_ACTION + +**Title:** AJ PVP RBG ACTION + +**Content:** +Needs summary. +`AJ_PVP_RBG_ACTION` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md b/wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md new file mode 100644 index 00000000..f4a4b90e --- /dev/null +++ b/wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md @@ -0,0 +1,10 @@ +## Event: AJ_PVP_SKIRMISH_ACTION + +**Title:** AJ PVP SKIRMISH ACTION + +**Content:** +Needs summary. +`AJ_PVP_SKIRMISH_ACTION` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_QUEST_LOG_OPEN.md b/wiki-information/events/AJ_QUEST_LOG_OPEN.md new file mode 100644 index 00000000..e099b586 --- /dev/null +++ b/wiki-information/events/AJ_QUEST_LOG_OPEN.md @@ -0,0 +1,13 @@ +## Event: AJ_QUEST_LOG_OPEN + +**Title:** AJ QUEST LOG OPEN + +**Content:** +Needs summary. +`AJ_QUEST_LOG_OPEN: questID, uiMapID` + +**Payload:** +- `questID` + - *number* +- `uiMapID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_RAID_ACTION.md b/wiki-information/events/AJ_RAID_ACTION.md new file mode 100644 index 00000000..6eb2ff63 --- /dev/null +++ b/wiki-information/events/AJ_RAID_ACTION.md @@ -0,0 +1,11 @@ +## Event: AJ_RAID_ACTION + +**Title:** AJ RAID ACTION + +**Content:** +Needs summary. +`AJ_RAID_ACTION: lfgDungeonID` + +**Payload:** +- `lfgDungeonID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_REFRESH_DISPLAY.md b/wiki-information/events/AJ_REFRESH_DISPLAY.md new file mode 100644 index 00000000..0a0db8f2 --- /dev/null +++ b/wiki-information/events/AJ_REFRESH_DISPLAY.md @@ -0,0 +1,11 @@ +## Event: AJ_REFRESH_DISPLAY + +**Title:** AJ REFRESH DISPLAY + +**Content:** +Needs summary. +`AJ_REFRESH_DISPLAY: newAdventureNotice` + +**Payload:** +- `newAdventureNotice` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/AJ_REWARD_DATA_RECEIVED.md b/wiki-information/events/AJ_REWARD_DATA_RECEIVED.md new file mode 100644 index 00000000..9db375d3 --- /dev/null +++ b/wiki-information/events/AJ_REWARD_DATA_RECEIVED.md @@ -0,0 +1,10 @@ +## Event: AJ_REWARD_DATA_RECEIVED + +**Title:** AJ REWARD DATA RECEIVED + +**Content:** +Needs summary. +`AJ_REWARD_DATA_RECEIVED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md b/wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md new file mode 100644 index 00000000..13afb1fc --- /dev/null +++ b/wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md @@ -0,0 +1,10 @@ +## Event: ALERT_REGIONAL_CHAT_DISABLED + +**Title:** ALERT REGIONAL CHAT DISABLED + +**Content:** +Needs summary. +`ALERT_REGIONAL_CHAT_DISABLED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md b/wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md new file mode 100644 index 00000000..5b868655 --- /dev/null +++ b/wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED + +**Title:** ALTERNATIVE DEFAULT LANGUAGE CHANGED + +**Content:** +Needs summary. +`ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AREA_POIS_UPDATED.md b/wiki-information/events/AREA_POIS_UPDATED.md new file mode 100644 index 00000000..0b401288 --- /dev/null +++ b/wiki-information/events/AREA_POIS_UPDATED.md @@ -0,0 +1,10 @@ +## Event: AREA_POIS_UPDATED + +**Title:** AREA POIS UPDATED + +**Content:** +Needs summary. +`AREA_POIS_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md b/wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md new file mode 100644 index 00000000..cff28d49 --- /dev/null +++ b/wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md @@ -0,0 +1,10 @@ +## Event: AREA_SPIRIT_HEALER_IN_RANGE + +**Title:** AREA SPIRIT HEALER IN RANGE + +**Content:** +Needs summary. +`AREA_SPIRIT_HEALER_IN_RANGE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md b/wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md new file mode 100644 index 00000000..cd66b029 --- /dev/null +++ b/wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md @@ -0,0 +1,10 @@ +## Event: AREA_SPIRIT_HEALER_OUT_OF_RANGE + +**Title:** AREA SPIRIT HEALER OUT OF RANGE + +**Content:** +Needs summary. +`AREA_SPIRIT_HEALER_OUT_OF_RANGE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ARENA_COOLDOWNS_UPDATE.md b/wiki-information/events/ARENA_COOLDOWNS_UPDATE.md new file mode 100644 index 00000000..c672c2ad --- /dev/null +++ b/wiki-information/events/ARENA_COOLDOWNS_UPDATE.md @@ -0,0 +1,11 @@ +## Event: ARENA_COOLDOWNS_UPDATE + +**Title:** ARENA COOLDOWNS UPDATE + +**Content:** +Needs summary. +`ARENA_COOLDOWNS_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md b/wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md new file mode 100644 index 00000000..2aaccd97 --- /dev/null +++ b/wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md @@ -0,0 +1,13 @@ +## Event: ARENA_CROWD_CONTROL_SPELL_UPDATE + +**Title:** ARENA CROWD CONTROL SPELL UPDATE + +**Content:** +Needs summary. +`ARENA_CROWD_CONTROL_SPELL_UPDATE: unitTarget, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/ARENA_OPPONENT_UPDATE.md b/wiki-information/events/ARENA_OPPONENT_UPDATE.md new file mode 100644 index 00000000..091753e5 --- /dev/null +++ b/wiki-information/events/ARENA_OPPONENT_UPDATE.md @@ -0,0 +1,13 @@ +## Event: ARENA_OPPONENT_UPDATE + +**Title:** ARENA OPPONENT UPDATE + +**Content:** +Needs summary. +`ARENA_OPPONENT_UPDATE: unitToken, updateReason` + +**Payload:** +- `unitToken` + - *string* : UnitId +- `updateReason` + - *string* \ No newline at end of file diff --git a/wiki-information/events/ARENA_SEASON_WORLD_STATE.md b/wiki-information/events/ARENA_SEASON_WORLD_STATE.md new file mode 100644 index 00000000..78212859 --- /dev/null +++ b/wiki-information/events/ARENA_SEASON_WORLD_STATE.md @@ -0,0 +1,10 @@ +## Event: ARENA_SEASON_WORLD_STATE + +**Title:** ARENA SEASON WORLD STATE + +**Content:** +Needs summary. +`ARENA_SEASON_WORLD_STATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md b/wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md new file mode 100644 index 00000000..1c62d101 --- /dev/null +++ b/wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md @@ -0,0 +1,11 @@ +## Event: ARENA_TEAM_ROSTER_UPDATE + +**Title:** ARENA TEAM ROSTER UPDATE + +**Content:** +This event fires whenever an arena team is opened in the character sheet. It also fires (3 times) when an arena member leaves, joins, or gets kicked. It does NOT fire when an arena team member logs in or out. +`ARENA_TEAM_ROSTER_UPDATE: allowQuery` + +**Payload:** +- `allowQuery` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/ARENA_TEAM_UPDATE.md b/wiki-information/events/ARENA_TEAM_UPDATE.md new file mode 100644 index 00000000..c64c0755 --- /dev/null +++ b/wiki-information/events/ARENA_TEAM_UPDATE.md @@ -0,0 +1,10 @@ +## Event: ARENA_TEAM_UPDATE + +**Title:** ARENA TEAM UPDATE + +**Content:** +This events fires when a friendly player joins or leaves an arena match. This does NOT fire when an arena member joins the team, leaves, gets kicked, logs in/out. +`ARENA_TEAM_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md b/wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md new file mode 100644 index 00000000..f440f499 --- /dev/null +++ b/wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md @@ -0,0 +1,10 @@ +## Event: AUCTION_BIDDER_LIST_UPDATE + +**Title:** AUCTION BIDDER LIST UPDATE + +**Content:** +Fires when information becomes available or changes for the list of auctions bid on by the player. +`AUCTION_BIDDER_LIST_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_CLOSED.md b/wiki-information/events/AUCTION_HOUSE_CLOSED.md new file mode 100644 index 00000000..9cfdb1ed --- /dev/null +++ b/wiki-information/events/AUCTION_HOUSE_CLOSED.md @@ -0,0 +1,13 @@ +## Event: AUCTION_HOUSE_CLOSED + +**Title:** AUCTION HOUSE CLOSED + +**Content:** +This event is fired when the auction interface is closed. +`AUCTION_HOUSE_CLOSED` + +**Payload:** +- `None` + +**Content Details:** +It appears to fire twice, but the reason is unknown. \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_DISABLED.md b/wiki-information/events/AUCTION_HOUSE_DISABLED.md new file mode 100644 index 00000000..6b10fa2a --- /dev/null +++ b/wiki-information/events/AUCTION_HOUSE_DISABLED.md @@ -0,0 +1,10 @@ +## Event: AUCTION_HOUSE_DISABLED + +**Title:** AUCTION HOUSE DISABLED + +**Content:** +Fired when the auction house is not operational. +`AUCTION_HOUSE_DISABLED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_POST_ERROR.md b/wiki-information/events/AUCTION_HOUSE_POST_ERROR.md new file mode 100644 index 00000000..330435b1 --- /dev/null +++ b/wiki-information/events/AUCTION_HOUSE_POST_ERROR.md @@ -0,0 +1,10 @@ +## Event: AUCTION_HOUSE_POST_ERROR + +**Title:** AUCTION HOUSE POST ERROR + +**Content:** +Needs summary. +`AUCTION_HOUSE_POST_ERROR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_POST_WARNING.md b/wiki-information/events/AUCTION_HOUSE_POST_WARNING.md new file mode 100644 index 00000000..01943c34 --- /dev/null +++ b/wiki-information/events/AUCTION_HOUSE_POST_WARNING.md @@ -0,0 +1,10 @@ +## Event: AUCTION_HOUSE_POST_WARNING + +**Title:** AUCTION HOUSE POST WARNING + +**Content:** +Needs summary. +`AUCTION_HOUSE_POST_WARNING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md b/wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md new file mode 100644 index 00000000..624a7d23 --- /dev/null +++ b/wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md @@ -0,0 +1,10 @@ +## Event: AUCTION_HOUSE_SCRIPT_DEPRECATED + +**Title:** AUCTION HOUSE SCRIPT DEPRECATED + +**Content:** +Needs summary. +`AUCTION_HOUSE_SCRIPT_DEPRECATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_SHOW.md b/wiki-information/events/AUCTION_HOUSE_SHOW.md new file mode 100644 index 00000000..27162bae --- /dev/null +++ b/wiki-information/events/AUCTION_HOUSE_SHOW.md @@ -0,0 +1,10 @@ +## Event: AUCTION_HOUSE_SHOW + +**Title:** AUCTION HOUSE SHOW + +**Content:** +This event is fired when the auction interface is first displayed. This is generally done by right-clicking an auctioneer in a major city. +`AUCTION_HOUSE_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md b/wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md new file mode 100644 index 00000000..677a08bb --- /dev/null +++ b/wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md @@ -0,0 +1,13 @@ +## Event: AUCTION_ITEM_LIST_UPDATE + +**Title:** AUCTION ITEM LIST UPDATE + +**Content:** +This event is fired when the Auction list is updated. +`AUCTION_ITEM_LIST_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +Note that this is not only the case, if the list is completely changed but also if it is sorted (i.e. SortAuctionItems() is called). \ No newline at end of file diff --git a/wiki-information/events/AUCTION_MULTISELL_FAILURE.md b/wiki-information/events/AUCTION_MULTISELL_FAILURE.md new file mode 100644 index 00000000..5d6b049e --- /dev/null +++ b/wiki-information/events/AUCTION_MULTISELL_FAILURE.md @@ -0,0 +1,10 @@ +## Event: AUCTION_MULTISELL_FAILURE + +**Title:** AUCTION MULTISELL FAILURE + +**Content:** +Fired when listing of multiple stacks fails (or is aborted?). +`AUCTION_MULTISELL_FAILURE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_MULTISELL_START.md b/wiki-information/events/AUCTION_MULTISELL_START.md new file mode 100644 index 00000000..f47ba6e3 --- /dev/null +++ b/wiki-information/events/AUCTION_MULTISELL_START.md @@ -0,0 +1,11 @@ +## Event: AUCTION_MULTISELL_START + +**Title:** AUCTION MULTISELL START + +**Content:** +Fired when the client begins listing of multiple stacks. +`AUCTION_MULTISELL_START: numRepetitions` + +**Payload:** +- `numRepetitions` + - *number* - total number of stacks the client has to list. \ No newline at end of file diff --git a/wiki-information/events/AUCTION_MULTISELL_UPDATE.md b/wiki-information/events/AUCTION_MULTISELL_UPDATE.md new file mode 100644 index 00000000..69e8610f --- /dev/null +++ b/wiki-information/events/AUCTION_MULTISELL_UPDATE.md @@ -0,0 +1,13 @@ +## Event: AUCTION_MULTISELL_UPDATE + +**Title:** AUCTION MULTISELL UPDATE + +**Content:** +Fired when the client lists a stack as part of listing multiple stacks. +`AUCTION_MULTISELL_UPDATE: createdCount, totalToCreate` + +**Payload:** +- `createdCount` + - *number* - number of stacks listed so far. +- `totalToCreate` + - *number* - total number of stacks in the current mass-listing operation. \ No newline at end of file diff --git a/wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md b/wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md new file mode 100644 index 00000000..d9eb5e20 --- /dev/null +++ b/wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md @@ -0,0 +1,14 @@ +## Event: AUCTION_OWNED_LIST_UPDATE + +**Title:** AUCTION OWNED LIST UPDATE + +**Content:** +Fired whenever new information about auctions posted by the current character is received. Often used to update the auction house auctions view after an auction is canceled or posted. +`AUCTION_OWNED_LIST_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +If the auctions you are looking for are not loaded automatically it is necessary to reopen the Auction House to trigger them being loaded. +So long as an event handler is registered for this event the owned auctions list should update automatically. \ No newline at end of file diff --git a/wiki-information/events/AUTOFOLLOW_BEGIN.md b/wiki-information/events/AUTOFOLLOW_BEGIN.md new file mode 100644 index 00000000..1fa873b9 --- /dev/null +++ b/wiki-information/events/AUTOFOLLOW_BEGIN.md @@ -0,0 +1,11 @@ +## Event: AUTOFOLLOW_BEGIN + +**Title:** AUTOFOLLOW BEGIN + +**Content:** +Fired when you begin automatically following an ally +`AUTOFOLLOW_BEGIN: name` + +**Payload:** +- `name` + - *string* - The unit you are following. Not necessarily your target (in case of right-clicking a group member's portrait or using the "/follow" command). \ No newline at end of file diff --git a/wiki-information/events/AUTOFOLLOW_END.md b/wiki-information/events/AUTOFOLLOW_END.md new file mode 100644 index 00000000..2eb9e8c9 --- /dev/null +++ b/wiki-information/events/AUTOFOLLOW_END.md @@ -0,0 +1,10 @@ +## Event: AUTOFOLLOW_END + +**Title:** AUTOFOLLOW END + +**Content:** +Fired when the player ceases following an ally +`AUTOFOLLOW_END` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AVATAR_LIST_UPDATED.md b/wiki-information/events/AVATAR_LIST_UPDATED.md new file mode 100644 index 00000000..0454baaa --- /dev/null +++ b/wiki-information/events/AVATAR_LIST_UPDATED.md @@ -0,0 +1,17 @@ +## Event: AVATAR_LIST_UPDATED + +**Title:** AVATAR LIST UPDATED + +**Content:** +Needs summary. +`AVATAR_LIST_UPDATED: clubType` + +**Payload:** +- `clubType` + - *number* - Enum.ClubType + - *Enum.ClubType* + - *Value* - Field - Description + - 0 - BattleNet + - 1 - Character + - 2 - Guild + - 3 - Other \ No newline at end of file diff --git a/wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md b/wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md new file mode 100644 index 00000000..0c9c84b9 --- /dev/null +++ b/wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md @@ -0,0 +1,11 @@ +## Event: AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED + +**Title:** AZERITE EMPOWERED ITEM EQUIPPED STATUS CHANGED + +**Content:** +Needs summary. +`AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED: isHeartEquipped` + +**Payload:** +- `isHeartEquipped` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md b/wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md new file mode 100644 index 00000000..34fa2c50 --- /dev/null +++ b/wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md @@ -0,0 +1,11 @@ +## Event: AZERITE_EMPOWERED_ITEM_LOOTED + +**Title:** AZERITE EMPOWERED ITEM LOOTED + +**Content:** +Needs summary. +`AZERITE_EMPOWERED_ITEM_LOOTED: "itemLink"` + +**Payload:** +- `itemLink` + - *string* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md b/wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md new file mode 100644 index 00000000..d971b086 --- /dev/null +++ b/wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md @@ -0,0 +1,11 @@ +## Event: AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED + +**Title:** AZERITE EMPOWERED ITEM SELECTION UPDATED + +**Content:** +Needs summary. +`AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED: azeriteEmpoweredItemLocation` + +**Payload:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin*🔗 \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md b/wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md new file mode 100644 index 00000000..3e73a82d --- /dev/null +++ b/wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md @@ -0,0 +1,21 @@ +## Event: AZERITE_ESSENCE_ACTIVATED + +**Title:** AZERITE ESSENCE ACTIVATED + +**Content:** +Fires when the player drops an ability onto the Heart of Azeroth window. +`AZERITE_ESSENCE_ACTIVATED: slot, essenceID` + +**Payload:** +- `slot` + - *Enum.AzeriteEssenceSlot* + - *Value* + - *Field* + - *Description* + - 0 - MainSlot + - 1 - PassiveOneSlot + - 2 - PassiveTwoSlot + - 3 - PassiveThreeSlot + - Added in 8.3.0 +- `essenceID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md b/wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md new file mode 100644 index 00000000..ecad1a35 --- /dev/null +++ b/wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md @@ -0,0 +1,21 @@ +## Event: AZERITE_ESSENCE_ACTIVATION_FAILED + +**Title:** AZERITE ESSENCE ACTIVATION FAILED + +**Content:** +Fires when the player cannot drop an ability onto the Heart of Azeroth window. +`AZERITE_ESSENCE_ACTIVATION_FAILED: slot, essenceID` + +**Payload:** +- `slot` + - *Enum.AzeriteEssenceSlot* + - *Value* + - *Field* + - *Description* + - 0 - MainSlot + - 1 - PassiveOneSlot + - 2 - PassiveTwoSlot + - 3 - PassiveThreeSlot + - Added in 8.3.0 +- `essenceID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_CHANGED.md b/wiki-information/events/AZERITE_ESSENCE_CHANGED.md new file mode 100644 index 00000000..4853982d --- /dev/null +++ b/wiki-information/events/AZERITE_ESSENCE_CHANGED.md @@ -0,0 +1,13 @@ +## Event: AZERITE_ESSENCE_CHANGED + +**Title:** AZERITE ESSENCE CHANGED + +**Content:** +Sent to the add on when the player adds a new ability to the list of abilities in the Heart of Azeroth window. The player must already be located at the Heart Forge and then right-click the new ability item in inventory. +`AZERITE_ESSENCE_CHANGED: essenceID, newRank` + +**Payload:** +- `essenceID` + - *number* +- `newRank` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md b/wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md new file mode 100644 index 00000000..28142edf --- /dev/null +++ b/wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md @@ -0,0 +1,10 @@ +## Event: AZERITE_ESSENCE_FORGE_CLOSE + +**Title:** AZERITE ESSENCE FORGE CLOSE + +**Content:** +Sent to the add on when player closes the Heart Forge window while in the Chamber of Heart. Does not trigger when the Heart of Azeroth window is closed out in the world. +`AZERITE_ESSENCE_FORGE_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md b/wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md new file mode 100644 index 00000000..15b06d08 --- /dev/null +++ b/wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md @@ -0,0 +1,10 @@ +## Event: AZERITE_ESSENCE_FORGE_OPEN + +**Title:** AZERITE ESSENCE FORGE OPEN + +**Content:** +Sent to the add on when player right-clicks on the Heart Forge to open it in the Chamber of Heart. Does not trigger when the Heart of Azeroth window is opened out in the world by shift-clicking the necklace. +`AZERITE_ESSENCE_FORGE_OPEN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md b/wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md new file mode 100644 index 00000000..dd13ca0e --- /dev/null +++ b/wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md @@ -0,0 +1,11 @@ +## Event: AZERITE_ESSENCE_MILESTONE_UNLOCKED + +**Title:** AZERITE ESSENCE MILESTONE UNLOCKED + +**Content:** +Needs summary. +`AZERITE_ESSENCE_MILESTONE_UNLOCKED: milestoneID` + +**Payload:** +- `milestoneID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_UPDATE.md b/wiki-information/events/AZERITE_ESSENCE_UPDATE.md new file mode 100644 index 00000000..c9a333fd --- /dev/null +++ b/wiki-information/events/AZERITE_ESSENCE_UPDATE.md @@ -0,0 +1,11 @@ +## Event: AZERITE_ESSENCE_UPDATE + +**Title:** AZERITE ESSENCE UPDATE + +**Content:** +Sent to the add on upon changing character spec, if both specs have a power configured in the Heart of Azeroth. +If the necklace does not have a power assigned when the spec is activated, or when the necklace is first unlocked, this event will be sent following one or more AZERITE_ESSENCE_ACTIVATED messages. +`AZERITE_ESSENCE_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md b/wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md new file mode 100644 index 00000000..e74dedde --- /dev/null +++ b/wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: AZERITE_ITEM_ENABLED_STATE_CHANGED + +**Title:** AZERITE ITEM ENABLED STATE CHANGED + +**Content:** +Needs summary. +`AZERITE_ITEM_ENABLED_STATE_CHANGED: enabled` + +**Payload:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md b/wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md new file mode 100644 index 00000000..65397764 --- /dev/null +++ b/wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md @@ -0,0 +1,15 @@ +## Event: AZERITE_ITEM_EXPERIENCE_CHANGED + +**Title:** AZERITE ITEM EXPERIENCE CHANGED + +**Content:** +Sent to the add on each time the Azerite progress bar moves, in other words, every time the player gains Azerite. +`AZERITE_ITEM_EXPERIENCE_CHANGED: azeriteItemLocation, oldExperienceAmount, newExperienceAmount` + +**Payload:** +- `azeriteItemLocation` + - *ItemLocationMixin*🔗 +- `oldExperienceAmount` + - *number* +- `newExperienceAmount` + - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md b/wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md new file mode 100644 index 00000000..a587d4ac --- /dev/null +++ b/wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md @@ -0,0 +1,26 @@ +## Event: AZERITE_ITEM_POWER_LEVEL_CHANGED + +**Title:** AZERITE ITEM POWER LEVEL CHANGED + +**Content:** +Sent to the add on each time the player's Heart of Azeroth gains a level. +`AZERITE_ITEM_POWER_LEVEL_CHANGED: azeriteItemLocation, oldPowerLevel, newPowerLevel, unlockedEmpoweredItemsInfo, azeriteItemID` + +**Payload:** +- `azeriteItemLocation` + - AzeriteItemLocation🔗 +- `oldPowerLevel` + - *number* +- `newPowerLevel` + - *number* +- `unlockedEmpoweredItemsInfo` + - UnlockedAzeriteEmpoweredItems + - Field + - Type + - Description + - unlockedItem + - AzeriteEmpoweredItemLocation🔗 + - tierIndex + - *number* + - azeriteItemID + - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_CLOSED.md b/wiki-information/events/BAG_CLOSED.md new file mode 100644 index 00000000..fb379029 --- /dev/null +++ b/wiki-information/events/BAG_CLOSED.md @@ -0,0 +1,11 @@ +## Event: BAG_CLOSED + +**Title:** BAG CLOSED + +**Content:** +Fired when a bag is (re)moved from its bagslot. Fires both for player bags and bank bags. +`BAG_CLOSED: bagID` + +**Payload:** +- `bagID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_NEW_ITEMS_UPDATED.md b/wiki-information/events/BAG_NEW_ITEMS_UPDATED.md new file mode 100644 index 00000000..ed7f08e0 --- /dev/null +++ b/wiki-information/events/BAG_NEW_ITEMS_UPDATED.md @@ -0,0 +1,10 @@ +## Event: BAG_NEW_ITEMS_UPDATED + +**Title:** BAG NEW ITEMS UPDATED + +**Content:** +Needs summary. +`BAG_NEW_ITEMS_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BAG_OPEN.md b/wiki-information/events/BAG_OPEN.md new file mode 100644 index 00000000..d374c7d3 --- /dev/null +++ b/wiki-information/events/BAG_OPEN.md @@ -0,0 +1,11 @@ +## Event: BAG_OPEN + +**Title:** BAG OPEN + +**Content:** +Fired when a lootable container (not an equipped bag) is opened. +`BAG_OPEN: bagID` + +**Payload:** +- `bagID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md b/wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md new file mode 100644 index 00000000..7ed03630 --- /dev/null +++ b/wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md @@ -0,0 +1,10 @@ +## Event: BAG_OVERFLOW_WITH_FULL_INVENTORY + +**Title:** BAG OVERFLOW WITH FULL INVENTORY + +**Content:** +Needs summary. +`BAG_OVERFLOW_WITH_FULL_INVENTORY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md b/wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md new file mode 100644 index 00000000..352910e7 --- /dev/null +++ b/wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md @@ -0,0 +1,11 @@ +## Event: BAG_SLOT_FLAGS_UPDATED + +**Title:** BAG SLOT FLAGS UPDATED + +**Content:** +Needs summary. +`BAG_SLOT_FLAGS_UPDATED: slot` + +**Payload:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_UPDATE.md b/wiki-information/events/BAG_UPDATE.md new file mode 100644 index 00000000..cbc5ebaa --- /dev/null +++ b/wiki-information/events/BAG_UPDATE.md @@ -0,0 +1,14 @@ +## Event: BAG_UPDATE + +**Title:** BAG UPDATE + +**Content:** +Fired when a bags inventory changes. +`BAG_UPDATE: bagID` + +**Payload:** +- `bagID` + - *number* + +**Content Details:** +Bag zero, the sixteen slot default backpack, may not fire on login. Upon login (or reloading the console) this event fires even for bank bags. When moving an item in your inventory, this fires multiple times: once each for the source and destination bag. If the bag involved is the default backpack, this event will also fire with a container ID of "-2" (twice if you are moving the item inside the same bag). \ No newline at end of file diff --git a/wiki-information/events/BAG_UPDATE_COOLDOWN.md b/wiki-information/events/BAG_UPDATE_COOLDOWN.md new file mode 100644 index 00000000..57246ab1 --- /dev/null +++ b/wiki-information/events/BAG_UPDATE_COOLDOWN.md @@ -0,0 +1,10 @@ +## Event: BAG_UPDATE_COOLDOWN + +**Title:** BAG UPDATE COOLDOWN + +**Content:** +Fired when a cooldown update call is sent to a bag +`BAG_UPDATE_COOLDOWN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BAG_UPDATE_DELAYED.md b/wiki-information/events/BAG_UPDATE_DELAYED.md new file mode 100644 index 00000000..13d86cff --- /dev/null +++ b/wiki-information/events/BAG_UPDATE_DELAYED.md @@ -0,0 +1,10 @@ +## Event: BAG_UPDATE_DELAYED + +**Title:** BAG UPDATE DELAYED + +**Content:** +Fired after all applicable BAG_UPDATE events for a specific action have been fired. +`BAG_UPDATE_DELAYED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BANKFRAME_CLOSED.md b/wiki-information/events/BANKFRAME_CLOSED.md new file mode 100644 index 00000000..3637cf6d --- /dev/null +++ b/wiki-information/events/BANKFRAME_CLOSED.md @@ -0,0 +1,13 @@ +## Event: BANKFRAME_CLOSED + +**Title:** BANKFRAME CLOSED + +**Content:** +Fired twice when the bank window is closed. +`BANKFRAME_CLOSED` + +**Payload:** +- `None` + +**Content Details:** +Only at the first one of them the bank data is still available (GetNumBankSlots(), GetContainerItemLink(), . \ No newline at end of file diff --git a/wiki-information/events/BANKFRAME_OPENED.md b/wiki-information/events/BANKFRAME_OPENED.md new file mode 100644 index 00000000..ad64a992 --- /dev/null +++ b/wiki-information/events/BANKFRAME_OPENED.md @@ -0,0 +1,10 @@ +## Event: BANKFRAME_OPENED + +**Title:** BANKFRAME OPENED + +**Content:** +Fired when the bank frame is opened +`BANKFRAME_OPENED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md b/wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md new file mode 100644 index 00000000..c4072886 --- /dev/null +++ b/wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md @@ -0,0 +1,11 @@ +## Event: BANK_BAG_SLOT_FLAGS_UPDATED + +**Title:** BANK BAG SLOT FLAGS UPDATED + +**Content:** +Needs summary. +`BANK_BAG_SLOT_FLAGS_UPDATED: slot` + +**Payload:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md b/wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md new file mode 100644 index 00000000..b0d1d833 --- /dev/null +++ b/wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md @@ -0,0 +1,10 @@ +## Event: BARBER_SHOP_APPEARANCE_APPLIED + +**Title:** BARBER SHOP APPEARANCE APPLIED + +**Content:** +Needs summary. +`BARBER_SHOP_APPEARANCE_APPLIED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md b/wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md new file mode 100644 index 00000000..d6fe73c8 --- /dev/null +++ b/wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md @@ -0,0 +1,10 @@ +## Event: BARBER_SHOP_CAMERA_VALUES_UPDATED + +**Title:** BARBER SHOP CAMERA VALUES UPDATED + +**Content:** +Needs summary. +`BARBER_SHOP_CAMERA_VALUES_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_CLOSE.md b/wiki-information/events/BARBER_SHOP_CLOSE.md new file mode 100644 index 00000000..5e48c8ef --- /dev/null +++ b/wiki-information/events/BARBER_SHOP_CLOSE.md @@ -0,0 +1,10 @@ +## Event: BARBER_SHOP_CLOSE + +**Title:** BARBER SHOP CLOSE + +**Content:** +Needs summary. +`BARBER_SHOP_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_COST_UPDATE.md b/wiki-information/events/BARBER_SHOP_COST_UPDATE.md new file mode 100644 index 00000000..772077be --- /dev/null +++ b/wiki-information/events/BARBER_SHOP_COST_UPDATE.md @@ -0,0 +1,10 @@ +## Event: BARBER_SHOP_COST_UPDATE + +**Title:** BARBER SHOP COST UPDATE + +**Content:** +Needs summary. +`BARBER_SHOP_COST_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md b/wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md new file mode 100644 index 00000000..f5d6230b --- /dev/null +++ b/wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE + +**Title:** BARBER SHOP FORCE CUSTOMIZATIONS UPDATE + +**Content:** +Fired when the available customizations or any data about them has changed. +`BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_OPEN.md b/wiki-information/events/BARBER_SHOP_OPEN.md new file mode 100644 index 00000000..62bce471 --- /dev/null +++ b/wiki-information/events/BARBER_SHOP_OPEN.md @@ -0,0 +1,10 @@ +## Event: BARBER_SHOP_OPEN + +**Title:** BARBER SHOP OPEN + +**Content:** +Needs summary. +`BARBER_SHOP_OPEN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_RESULT.md b/wiki-information/events/BARBER_SHOP_RESULT.md new file mode 100644 index 00000000..9ecb2f33 --- /dev/null +++ b/wiki-information/events/BARBER_SHOP_RESULT.md @@ -0,0 +1,11 @@ +## Event: BARBER_SHOP_RESULT + +**Title:** BARBER SHOP RESULT + +**Content:** +Fires when the barber gave your toon a dashing new hairstyle (or failed the gender reassignment surgery). +`BARBER_SHOP_RESULT: success` + +**Payload:** +- `success` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELDS_CLOSED.md b/wiki-information/events/BATTLEFIELDS_CLOSED.md new file mode 100644 index 00000000..8073eaca --- /dev/null +++ b/wiki-information/events/BATTLEFIELDS_CLOSED.md @@ -0,0 +1,10 @@ +## Event: BATTLEFIELDS_CLOSED + +**Title:** BATTLEFIELDS CLOSED + +**Content:** +Fired when the battlegrounds signup window is closed. +`BATTLEFIELDS_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELDS_SHOW.md b/wiki-information/events/BATTLEFIELDS_SHOW.md new file mode 100644 index 00000000..a3ca3526 --- /dev/null +++ b/wiki-information/events/BATTLEFIELDS_SHOW.md @@ -0,0 +1,13 @@ +## Event: BATTLEFIELDS_SHOW + +**Title:** BATTLEFIELDS SHOW + +**Content:** +Fired when the battlegrounds signup window is opened. +`BATTLEFIELDS_SHOW: isArena, battleMasterListID` + +**Payload:** +- `isArena` + - *boolean?* +- `battleMasterListID` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md b/wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md new file mode 100644 index 00000000..a6a152b4 --- /dev/null +++ b/wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md @@ -0,0 +1,10 @@ +## Event: BATTLEFIELD_AUTO_QUEUE + +**Title:** BATTLEFIELD AUTO QUEUE + +**Content:** +Needs summary. +`BATTLEFIELD_AUTO_QUEUE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md b/wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md new file mode 100644 index 00000000..9e9bb58e --- /dev/null +++ b/wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md @@ -0,0 +1,10 @@ +## Event: BATTLEFIELD_AUTO_QUEUE_EJECT + +**Title:** BATTLEFIELD AUTO QUEUE EJECT + +**Content:** +Needs summary. +`BATTLEFIELD_AUTO_QUEUE_EJECT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md b/wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md new file mode 100644 index 00000000..ff7a393e --- /dev/null +++ b/wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md @@ -0,0 +1,10 @@ +## Event: BATTLEFIELD_QUEUE_TIMEOUT + +**Title:** BATTLEFIELD QUEUE TIMEOUT + +**Content:** +Fired when a War Game request times out without a response. +`BATTLEFIELD_QUEUE_TIMEOUT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md b/wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md new file mode 100644 index 00000000..4d2fe840 --- /dev/null +++ b/wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md @@ -0,0 +1,10 @@ +## Event: BATTLEGROUND_OBJECTIVES_UPDATE + +**Title:** BATTLEGROUND OBJECTIVES UPDATE + +**Content:** +Needs summary. +`BATTLEGROUND_OBJECTIVES_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md b/wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md new file mode 100644 index 00000000..bec428c0 --- /dev/null +++ b/wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: BATTLEGROUND_POINTS_UPDATE + +**Title:** BATTLEGROUND POINTS UPDATE + +**Content:** +Needs summary. +`BATTLEGROUND_POINTS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLETAG_INVITE_SHOW.md b/wiki-information/events/BATTLETAG_INVITE_SHOW.md new file mode 100644 index 00000000..0bdb2a6b --- /dev/null +++ b/wiki-information/events/BATTLETAG_INVITE_SHOW.md @@ -0,0 +1,11 @@ +## Event: BATTLETAG_INVITE_SHOW + +**Title:** BATTLETAG INVITE SHOW + +**Content:** +Needs summary. +`BATTLETAG_INVITE_SHOW: name` + +**Payload:** +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md b/wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md new file mode 100644 index 00000000..8fff30c7 --- /dev/null +++ b/wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md @@ -0,0 +1,14 @@ +## Event: BATTLE_PET_CURSOR_CLEAR + +**Title:** BATTLE PET CURSOR CLEAR + +**Content:** +Fires after the player is no longer dragging a battle pet ability. +`BATTLE_PET_CURSOR_CLEAR` + +**Payload:** +- `None` + +**Content Details:** +The ability might now be assigned to an action bar, unless the player cancelled the drag by right-clicking. +This refers to the icon of the pet itself for summoning it; not an ability during pet battles. \ No newline at end of file diff --git a/wiki-information/events/BEHAVIORAL_NOTIFICATION.md b/wiki-information/events/BEHAVIORAL_NOTIFICATION.md new file mode 100644 index 00000000..bd1feabd --- /dev/null +++ b/wiki-information/events/BEHAVIORAL_NOTIFICATION.md @@ -0,0 +1,13 @@ +## Event: BEHAVIORAL_NOTIFICATION + +**Title:** BEHAVIORAL NOTIFICATION + +**Content:** +Needs summary. +`BEHAVIORAL_NOTIFICATION: notificationType, dbId` + +**Payload:** +- `notificationType` + - *string* +- `dbId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/BIND_ENCHANT.md b/wiki-information/events/BIND_ENCHANT.md new file mode 100644 index 00000000..d3d01cdf --- /dev/null +++ b/wiki-information/events/BIND_ENCHANT.md @@ -0,0 +1,10 @@ +## Event: BIND_ENCHANT + +**Title:** BIND ENCHANT + +**Content:** +Fired when Enchanting an unbound item. +`BIND_ENCHANT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_BID_RESULT.md b/wiki-information/events/BLACK_MARKET_BID_RESULT.md new file mode 100644 index 00000000..c115f4cc --- /dev/null +++ b/wiki-information/events/BLACK_MARKET_BID_RESULT.md @@ -0,0 +1,13 @@ +## Event: BLACK_MARKET_BID_RESULT + +**Title:** BLACK MARKET BID RESULT + +**Content:** +Needs summary. +`BLACK_MARKET_BID_RESULT: marketID, resultCode` + +**Payload:** +- `marketID` + - *number* +- `resultCode` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_CLOSE.md b/wiki-information/events/BLACK_MARKET_CLOSE.md new file mode 100644 index 00000000..3030e49d --- /dev/null +++ b/wiki-information/events/BLACK_MARKET_CLOSE.md @@ -0,0 +1,10 @@ +## Event: BLACK_MARKET_CLOSE + +**Title:** BLACK MARKET CLOSE + +**Content:** +Needs summary. +`BLACK_MARKET_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md b/wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md new file mode 100644 index 00000000..2f1ee801 --- /dev/null +++ b/wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md @@ -0,0 +1,10 @@ +## Event: BLACK_MARKET_ITEM_UPDATE + +**Title:** BLACK MARKET ITEM UPDATE + +**Content:** +Needs summary. +`BLACK_MARKET_ITEM_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_OPEN.md b/wiki-information/events/BLACK_MARKET_OPEN.md new file mode 100644 index 00000000..df385fe4 --- /dev/null +++ b/wiki-information/events/BLACK_MARKET_OPEN.md @@ -0,0 +1,10 @@ +## Event: BLACK_MARKET_OPEN + +**Title:** BLACK MARKET OPEN + +**Content:** +Needs summary. +`BLACK_MARKET_OPEN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_OUTBID.md b/wiki-information/events/BLACK_MARKET_OUTBID.md new file mode 100644 index 00000000..3a9c786d --- /dev/null +++ b/wiki-information/events/BLACK_MARKET_OUTBID.md @@ -0,0 +1,13 @@ +## Event: BLACK_MARKET_OUTBID + +**Title:** BLACK MARKET OUTBID + +**Content:** +Needs summary. +`BLACK_MARKET_OUTBID: marketID, itemID` + +**Payload:** +- `marketID` + - *number* +- `itemID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_UNAVAILABLE.md b/wiki-information/events/BLACK_MARKET_UNAVAILABLE.md new file mode 100644 index 00000000..c7ea759e --- /dev/null +++ b/wiki-information/events/BLACK_MARKET_UNAVAILABLE.md @@ -0,0 +1,10 @@ +## Event: BLACK_MARKET_UNAVAILABLE + +**Title:** BLACK MARKET UNAVAILABLE + +**Content:** +Needs summary. +`BLACK_MARKET_UNAVAILABLE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_WON.md b/wiki-information/events/BLACK_MARKET_WON.md new file mode 100644 index 00000000..6b6c5e86 --- /dev/null +++ b/wiki-information/events/BLACK_MARKET_WON.md @@ -0,0 +1,13 @@ +## Event: BLACK_MARKET_WON + +**Title:** BLACK MARKET WON + +**Content:** +Needs summary. +`BLACK_MARKET_WON: marketID, itemID` + +**Payload:** +- `marketID` + - *number* +- `itemID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md b/wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md new file mode 100644 index 00000000..4036a391 --- /dev/null +++ b/wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md @@ -0,0 +1,11 @@ +## Event: BN_BLOCK_FAILED_TOO_MANY + +**Title:** BN BLOCK FAILED TOO MANY + +**Content:** +Needs summary. +`BN_BLOCK_FAILED_TOO_MANY: blockType` + +**Payload:** +- `blockType` + - *string* \ No newline at end of file diff --git a/wiki-information/events/BN_BLOCK_LIST_UPDATED.md b/wiki-information/events/BN_BLOCK_LIST_UPDATED.md new file mode 100644 index 00000000..d4733667 --- /dev/null +++ b/wiki-information/events/BN_BLOCK_LIST_UPDATED.md @@ -0,0 +1,10 @@ +## Event: BN_BLOCK_LIST_UPDATED + +**Title:** BN BLOCK LIST UPDATED + +**Content:** +Needs summary. +`BN_BLOCK_LIST_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_CHAT_MSG_ADDON.md b/wiki-information/events/BN_CHAT_MSG_ADDON.md new file mode 100644 index 00000000..6a7f5740 --- /dev/null +++ b/wiki-information/events/BN_CHAT_MSG_ADDON.md @@ -0,0 +1,17 @@ +## Event: BN_CHAT_MSG_ADDON + +**Title:** BN CHAT MSG ADDON + +**Content:** +Needs summary. +`BN_CHAT_MSG_ADDON: prefix, text, channel, senderID` + +**Payload:** +- `prefix` + - *string* +- `text` + - *string* +- `channel` + - *string* +- `senderID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md b/wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md new file mode 100644 index 00000000..03eea2ff --- /dev/null +++ b/wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md @@ -0,0 +1,11 @@ +## Event: BN_CHAT_WHISPER_UNDELIVERABLE + +**Title:** BN CHAT WHISPER UNDELIVERABLE + +**Content:** +Needs summary. +`BN_CHAT_WHISPER_UNDELIVERABLE: senderID` + +**Payload:** +- `senderID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_CONNECTED.md b/wiki-information/events/BN_CONNECTED.md new file mode 100644 index 00000000..10de5248 --- /dev/null +++ b/wiki-information/events/BN_CONNECTED.md @@ -0,0 +1,11 @@ +## Event: BN_CONNECTED + +**Title:** BN CONNECTED + +**Content:** +Needs summary. +`BN_CONNECTED: suppressNotification` + +**Payload:** +- `suppressNotification` + - *boolean?* - false \ No newline at end of file diff --git a/wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md b/wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md new file mode 100644 index 00000000..1e3052f7 --- /dev/null +++ b/wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: BN_CUSTOM_MESSAGE_CHANGED + +**Title:** BN CUSTOM MESSAGE CHANGED + +**Content:** +Needs summary. +`BN_CUSTOM_MESSAGE_CHANGED: id` + +**Payload:** +- `id` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md b/wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md new file mode 100644 index 00000000..8065de97 --- /dev/null +++ b/wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md @@ -0,0 +1,10 @@ +## Event: BN_CUSTOM_MESSAGE_LOADED + +**Title:** BN CUSTOM MESSAGE LOADED + +**Content:** +Needs summary. +`BN_CUSTOM_MESSAGE_LOADED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_DISCONNECTED.md b/wiki-information/events/BN_DISCONNECTED.md new file mode 100644 index 00000000..8816f3d9 --- /dev/null +++ b/wiki-information/events/BN_DISCONNECTED.md @@ -0,0 +1,13 @@ +## Event: BN_DISCONNECTED + +**Title:** BN DISCONNECTED + +**Content:** +Needs summary. +`BN_DISCONNECTED: result, suppressNotification` + +**Payload:** +- `result` + - *boolean* +- `suppressNotification` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md b/wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md new file mode 100644 index 00000000..da366da8 --- /dev/null +++ b/wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md @@ -0,0 +1,13 @@ +## Event: BN_FRIEND_ACCOUNT_OFFLINE + +**Title:** BN FRIEND ACCOUNT OFFLINE + +**Content:** +Needs summary. +`BN_FRIEND_ACCOUNT_OFFLINE: friendId, isCompanionApp` + +**Payload:** +- `friendId` + - *number* +- `isCompanionApp` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md b/wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md new file mode 100644 index 00000000..0caf77e6 --- /dev/null +++ b/wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md @@ -0,0 +1,13 @@ +## Event: BN_FRIEND_ACCOUNT_ONLINE + +**Title:** BN FRIEND ACCOUNT ONLINE + +**Content:** +Needs summary. +`BN_FRIEND_ACCOUNT_ONLINE: friendId, isCompanionApp` + +**Payload:** +- `friendId` + - *number* +- `isCompanionApp` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INFO_CHANGED.md b/wiki-information/events/BN_FRIEND_INFO_CHANGED.md new file mode 100644 index 00000000..9797d985 --- /dev/null +++ b/wiki-information/events/BN_FRIEND_INFO_CHANGED.md @@ -0,0 +1,11 @@ +## Event: BN_FRIEND_INFO_CHANGED + +**Title:** BN FRIEND INFO CHANGED + +**Content:** +Needs summary. +`BN_FRIEND_INFO_CHANGED: friendIndex` + +**Payload:** +- `friendIndex` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INVITE_ADDED.md b/wiki-information/events/BN_FRIEND_INVITE_ADDED.md new file mode 100644 index 00000000..89209f7d --- /dev/null +++ b/wiki-information/events/BN_FRIEND_INVITE_ADDED.md @@ -0,0 +1,11 @@ +## Event: BN_FRIEND_INVITE_ADDED + +**Title:** BN FRIEND INVITE ADDED + +**Content:** +Needs summary. +`BN_FRIEND_INVITE_ADDED: accountID` + +**Payload:** +- `accountID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md b/wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md new file mode 100644 index 00000000..1b14b022 --- /dev/null +++ b/wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md @@ -0,0 +1,11 @@ +## Event: BN_FRIEND_INVITE_LIST_INITIALIZED + +**Title:** BN FRIEND INVITE LIST INITIALIZED + +**Content:** +Needs summary. +`BN_FRIEND_INVITE_LIST_INITIALIZED: listSize` + +**Payload:** +- `listSize` + - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INVITE_REMOVED.md b/wiki-information/events/BN_FRIEND_INVITE_REMOVED.md new file mode 100644 index 00000000..2891efaf --- /dev/null +++ b/wiki-information/events/BN_FRIEND_INVITE_REMOVED.md @@ -0,0 +1,10 @@ +## Event: BN_FRIEND_INVITE_REMOVED + +**Title:** BN FRIEND INVITE REMOVED + +**Content:** +Needs summary. +`BN_FRIEND_INVITE_REMOVED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md b/wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md new file mode 100644 index 00000000..95a22fbe --- /dev/null +++ b/wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: BN_FRIEND_LIST_SIZE_CHANGED + +**Title:** BN FRIEND LIST SIZE CHANGED + +**Content:** +Needs summary. +`BN_FRIEND_LIST_SIZE_CHANGED: accountID` + +**Payload:** +- `accountID` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/BN_INFO_CHANGED.md b/wiki-information/events/BN_INFO_CHANGED.md new file mode 100644 index 00000000..e2504f75 --- /dev/null +++ b/wiki-information/events/BN_INFO_CHANGED.md @@ -0,0 +1,10 @@ +## Event: BN_INFO_CHANGED + +**Title:** BN INFO CHANGED + +**Content:** +Needs summary. +`BN_INFO_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md b/wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md new file mode 100644 index 00000000..f6a3ea47 --- /dev/null +++ b/wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md @@ -0,0 +1,10 @@ +## Event: BN_REQUEST_FOF_SUCCEEDED + +**Title:** BN REQUEST FOF SUCCEEDED + +**Content:** +Needs summary. +`BN_REQUEST_FOF_SUCCEEDED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/BOSS_KILL.md b/wiki-information/events/BOSS_KILL.md new file mode 100644 index 00000000..8b0dec79 --- /dev/null +++ b/wiki-information/events/BOSS_KILL.md @@ -0,0 +1,13 @@ +## Event: BOSS_KILL + +**Title:** BOSS KILL + +**Content:** +Fired when a (raid) boss has been killed. +`BOSS_KILL: encounterID, encounterName` + +**Payload:** +- `encounterID` + - *number* +- `encounterName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_ACTION_PENDING.md b/wiki-information/events/CALENDAR_ACTION_PENDING.md new file mode 100644 index 00000000..1a09ed76 --- /dev/null +++ b/wiki-information/events/CALENDAR_ACTION_PENDING.md @@ -0,0 +1,11 @@ +## Event: CALENDAR_ACTION_PENDING + +**Title:** CALENDAR ACTION PENDING + +**Content:** +Fired when the calendar API is busy or free +`CALENDAR_ACTION_PENDING: pending` + +**Payload:** +- `pending` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_CLOSE_EVENT.md b/wiki-information/events/CALENDAR_CLOSE_EVENT.md new file mode 100644 index 00000000..e12fcec6 --- /dev/null +++ b/wiki-information/events/CALENDAR_CLOSE_EVENT.md @@ -0,0 +1,10 @@ +## Event: CALENDAR_CLOSE_EVENT + +**Title:** CALENDAR CLOSE EVENT + +**Content:** +Needs summary. +`CALENDAR_CLOSE_EVENT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_EVENT_ALARM.md b/wiki-information/events/CALENDAR_EVENT_ALARM.md new file mode 100644 index 00000000..5d96e876 --- /dev/null +++ b/wiki-information/events/CALENDAR_EVENT_ALARM.md @@ -0,0 +1,15 @@ +## Event: CALENDAR_EVENT_ALARM + +**Title:** CALENDAR EVENT ALARM + +**Content:** +Needs summary. +`CALENDAR_EVENT_ALARM: title, hour, minute` + +**Payload:** +- `title` + - *string* +- `hour` + - *number* +- `minute` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_NEW_EVENT.md b/wiki-information/events/CALENDAR_NEW_EVENT.md new file mode 100644 index 00000000..9a31d6be --- /dev/null +++ b/wiki-information/events/CALENDAR_NEW_EVENT.md @@ -0,0 +1,11 @@ +## Event: CALENDAR_NEW_EVENT + +**Title:** CALENDAR NEW EVENT + +**Content:** +Needs summary. +`CALENDAR_NEW_EVENT: isCopy` + +**Payload:** +- `isCopy` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_OPEN_EVENT.md b/wiki-information/events/CALENDAR_OPEN_EVENT.md new file mode 100644 index 00000000..92f357a3 --- /dev/null +++ b/wiki-information/events/CALENDAR_OPEN_EVENT.md @@ -0,0 +1,26 @@ +## Event: CALENDAR_OPEN_EVENT + +**Title:** CALENDAR OPEN EVENT + +**Content:** +Fired after calling CalendarOpenEvent once the event data has been retrieved from the server +`CALENDAR_OPEN_EVENT: calendarType` + +**Payload:** +- `calendarType` + - *string* - CALENDARTYPE + - Value + - Description + - "PLAYER" + - Player-created event or invitation + - "GUILD_ANNOUNCEMENT" + - Guild announcement + - "GUILD_EVENT" + - Guild event + - "COMMUNITY_EVENT" + - "SYSTEM" + - Other server-provided event + - "HOLIDAY" + - Seasonal/holiday events + - "RAID_LOCKOUT" + - Instance lockouts \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_ERROR.md b/wiki-information/events/CALENDAR_UPDATE_ERROR.md new file mode 100644 index 00000000..dced85ef --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_ERROR.md @@ -0,0 +1,11 @@ +## Event: CALENDAR_UPDATE_ERROR + +**Title:** CALENDAR UPDATE ERROR + +**Content:** +Needs summary. +`CALENDAR_UPDATE_ERROR: errorReason` + +**Payload:** +- `errorReason` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md b/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md new file mode 100644 index 00000000..bc05eb08 --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md @@ -0,0 +1,13 @@ +## Event: CALENDAR_UPDATE_ERROR_WITH_COUNT + +**Title:** CALENDAR UPDATE ERROR WITH COUNT + +**Content:** +Needs summary. +`CALENDAR_UPDATE_ERROR_WITH_COUNT: errorReason, count` + +**Payload:** +- `errorReason` + - *string* +- `count` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md b/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md new file mode 100644 index 00000000..eeed07d2 --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md @@ -0,0 +1,13 @@ +## Event: CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME + +**Title:** CALENDAR UPDATE ERROR WITH PLAYER NAME + +**Content:** +Needs summary. +`CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME: errorReason, playerName` + +**Payload:** +- `errorReason` + - *string* +- `playerName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_EVENT.md b/wiki-information/events/CALENDAR_UPDATE_EVENT.md new file mode 100644 index 00000000..75c0c036 --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_EVENT.md @@ -0,0 +1,10 @@ +## Event: CALENDAR_UPDATE_EVENT + +**Title:** CALENDAR UPDATE EVENT + +**Content:** +Needs summary. +`CALENDAR_UPDATE_EVENT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md b/wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md new file mode 100644 index 00000000..fdd38719 --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md @@ -0,0 +1,10 @@ +## Event: CALENDAR_UPDATE_EVENT_LIST + +**Title:** CALENDAR UPDATE EVENT LIST + +**Content:** +Needs summary. +`CALENDAR_UPDATE_EVENT_LIST` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md b/wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md new file mode 100644 index 00000000..b09d3588 --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md @@ -0,0 +1,10 @@ +## Event: CALENDAR_UPDATE_GUILD_EVENTS + +**Title:** CALENDAR UPDATE GUILD EVENTS + +**Content:** +Needs summary. +`CALENDAR_UPDATE_GUILD_EVENTS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md b/wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md new file mode 100644 index 00000000..93b5ac97 --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md @@ -0,0 +1,11 @@ +## Event: CALENDAR_UPDATE_INVITE_LIST + +**Title:** CALENDAR UPDATE INVITE LIST + +**Content:** +Fired after CalendarEventSortInvites once the invite list has been sorted. +`CALENDAR_UPDATE_INVITE_LIST: hasCompleteList` + +**Payload:** +- `hasCompleteList` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md b/wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md new file mode 100644 index 00000000..18bcf388 --- /dev/null +++ b/wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md @@ -0,0 +1,10 @@ +## Event: CALENDAR_UPDATE_PENDING_INVITES + +**Title:** CALENDAR UPDATE PENDING INVITES + +**Content:** +Needs summary. +`CALENDAR_UPDATE_PENDING_INVITES` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CANCEL_GLYPH_CAST.md b/wiki-information/events/CANCEL_GLYPH_CAST.md new file mode 100644 index 00000000..704cb1e6 --- /dev/null +++ b/wiki-information/events/CANCEL_GLYPH_CAST.md @@ -0,0 +1,14 @@ +## Event: CANCEL_GLYPH_CAST + +**Title:** CANCEL GLYPH CAST + +**Content:** +Fires after interrupting a new glyph from applying to an ability in the spell book. +`CANCEL_GLYPH_CAST` + +**Payload:** +- `None` + +**Related Information:** +- USE_GLYPH - Fires if the user attempts to apply a new glyph +- ACTIVATE_GLYPH - Fires if the user did not interrupt the new glyph \ No newline at end of file diff --git a/wiki-information/events/CANCEL_LOOT_ROLL.md b/wiki-information/events/CANCEL_LOOT_ROLL.md new file mode 100644 index 00000000..f6771153 --- /dev/null +++ b/wiki-information/events/CANCEL_LOOT_ROLL.md @@ -0,0 +1,11 @@ +## Event: CANCEL_LOOT_ROLL + +**Title:** CANCEL LOOT ROLL + +**Content:** +Fired when a player cancels a roll on an item. +`CANCEL_LOOT_ROLL: rollID` + +**Payload:** +- `rollID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CANCEL_SUMMON.md b/wiki-information/events/CANCEL_SUMMON.md new file mode 100644 index 00000000..4f3ae0fb --- /dev/null +++ b/wiki-information/events/CANCEL_SUMMON.md @@ -0,0 +1,10 @@ +## Event: CANCEL_SUMMON + +**Title:** CANCEL SUMMON + +**Content:** +Needs summary. +`CANCEL_SUMMON` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CAPTUREFRAMES_FAILED.md b/wiki-information/events/CAPTUREFRAMES_FAILED.md new file mode 100644 index 00000000..211ad010 --- /dev/null +++ b/wiki-information/events/CAPTUREFRAMES_FAILED.md @@ -0,0 +1,10 @@ +## Event: CAPTUREFRAMES_FAILED + +**Title:** CAPTUREFRAMES FAILED + +**Content:** +Needs summary. +`CAPTUREFRAMES_FAILED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md b/wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md new file mode 100644 index 00000000..9bbdd900 --- /dev/null +++ b/wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md @@ -0,0 +1,10 @@ +## Event: CAPTUREFRAMES_SUCCEEDED + +**Title:** CAPTUREFRAMES SUCCEEDED + +**Content:** +Needs summary. +`CAPTUREFRAMES_SUCCEEDED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md b/wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md new file mode 100644 index 00000000..618ed016 --- /dev/null +++ b/wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md @@ -0,0 +1,10 @@ +## Event: CEMETERY_PREFERENCE_UPDATED + +**Title:** CEMETERY PREFERENCE UPDATED + +**Content:** +Needs summary. +`CEMETERY_PREFERENCE_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_COUNT_UPDATE.md b/wiki-information/events/CHANNEL_COUNT_UPDATE.md new file mode 100644 index 00000000..025e49f3 --- /dev/null +++ b/wiki-information/events/CHANNEL_COUNT_UPDATE.md @@ -0,0 +1,13 @@ +## Event: CHANNEL_COUNT_UPDATE + +**Title:** CHANNEL COUNT UPDATE + +**Content:** +Fired when number of players in a channel changes but only if this channel is visible in ChannelFrame (it mustn't be hidden by a collapsed category header). +`CHANNEL_COUNT_UPDATE: displayIndex, count` + +**Payload:** +- `displayIndex` + - *number* - channel id (item number in Blizzards ChannelFrame. See also `GetChannelDisplayInfo` +- `count` + - *number* - number of players in channel \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_FLAGS_UPDATED.md b/wiki-information/events/CHANNEL_FLAGS_UPDATED.md new file mode 100644 index 00000000..995ca714 --- /dev/null +++ b/wiki-information/events/CHANNEL_FLAGS_UPDATED.md @@ -0,0 +1,11 @@ +## Event: CHANNEL_FLAGS_UPDATED + +**Title:** CHANNEL FLAGS UPDATED + +**Content:** +Fired when user changes selected channel in Blizzards ChannelFrame +`CHANNEL_FLAGS_UPDATED: displayIndex` + +**Payload:** +- `displayIndex` + - *number* - channel id (item number in Blizzards ChannelFrame. See also `GetChannelDisplayInfo` \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_INVITE_REQUEST.md b/wiki-information/events/CHANNEL_INVITE_REQUEST.md new file mode 100644 index 00000000..4d5fcfc0 --- /dev/null +++ b/wiki-information/events/CHANNEL_INVITE_REQUEST.md @@ -0,0 +1,13 @@ +## Event: CHANNEL_INVITE_REQUEST + +**Title:** CHANNEL INVITE REQUEST + +**Content:** +Needs summary. +`CHANNEL_INVITE_REQUEST: channelID, name` + +**Payload:** +- `channelID` + - *string* +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_LEFT.md b/wiki-information/events/CHANNEL_LEFT.md new file mode 100644 index 00000000..c55b76ea --- /dev/null +++ b/wiki-information/events/CHANNEL_LEFT.md @@ -0,0 +1,13 @@ +## Event: CHANNEL_LEFT + +**Title:** CHANNEL LEFT + +**Content:** +Needs summary. +`CHANNEL_LEFT: chatChannelID, name` + +**Payload:** +- `chatChannelID` + - *number* +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_PASSWORD_REQUEST.md b/wiki-information/events/CHANNEL_PASSWORD_REQUEST.md new file mode 100644 index 00000000..0b21bc4f --- /dev/null +++ b/wiki-information/events/CHANNEL_PASSWORD_REQUEST.md @@ -0,0 +1,11 @@ +## Event: CHANNEL_PASSWORD_REQUEST + +**Title:** CHANNEL PASSWORD REQUEST + +**Content:** +Fired when user is asked for a password (normally after trying to join a channel without a password or with a wrong one) +`CHANNEL_PASSWORD_REQUEST: channelID` + +**Payload:** +- `channelID` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_ROSTER_UPDATE.md b/wiki-information/events/CHANNEL_ROSTER_UPDATE.md new file mode 100644 index 00000000..0f99ac14 --- /dev/null +++ b/wiki-information/events/CHANNEL_ROSTER_UPDATE.md @@ -0,0 +1,13 @@ +## Event: CHANNEL_ROSTER_UPDATE + +**Title:** CHANNEL ROSTER UPDATE + +**Content:** +Fired when user changes selected channel in Blizzards ChannelFrame or number of players in currently selected channel changes +`CHANNEL_ROSTER_UPDATE: displayIndex, count` + +**Payload:** +- `displayIndex` + - *number* +- `count` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_UI_UPDATE.md b/wiki-information/events/CHANNEL_UI_UPDATE.md new file mode 100644 index 00000000..52f3f750 --- /dev/null +++ b/wiki-information/events/CHANNEL_UI_UPDATE.md @@ -0,0 +1,10 @@ +## Event: CHANNEL_UI_UPDATE + +**Title:** CHANNEL UI UPDATE + +**Content:** +Fired when Channel UI should change (e.g. joining / leaving a channel causes this event to fire) +`CHANNEL_UI_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md b/wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md new file mode 100644 index 00000000..8a89e30f --- /dev/null +++ b/wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md @@ -0,0 +1,11 @@ +## Event: CHARACTER_ITEM_FIXUP_NOTIFICATION + +**Title:** CHARACTER ITEM FIXUP NOTIFICATION + +**Content:** +Needs summary. +`CHARACTER_ITEM_FIXUP_NOTIFICATION: fixupVersion` + +**Payload:** +- `fixupVersion` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CHARACTER_POINTS_CHANGED.md b/wiki-information/events/CHARACTER_POINTS_CHANGED.md new file mode 100644 index 00000000..a968b964 --- /dev/null +++ b/wiki-information/events/CHARACTER_POINTS_CHANGED.md @@ -0,0 +1,13 @@ +## Event: CHARACTER_POINTS_CHANGED + +**Title:** CHARACTER POINTS CHANGED + +**Content:** +Fired when the player's available talent points change. +`CHARACTER_POINTS_CHANGED: change` + +**Payload:** +- `change` + - *number* - indicates number of talent points changed. + - -1 indicates one used (learning a talent) + - 1 indicates one gained (leveling) \ No newline at end of file diff --git a/wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md b/wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md new file mode 100644 index 00000000..02a7d2fa --- /dev/null +++ b/wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md @@ -0,0 +1,43 @@ +## Event: CHAT_COMBAT_MSG_ARENA_POINTS_GAIN + +**Title:** CHAT COMBAT MSG ARENA POINTS GAIN + +**Content:** +Needs summary. +`CHAT_COMBAT_MSG_ARENA_POINTS_GAIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_DISABLED_CHANGED.md b/wiki-information/events/CHAT_DISABLED_CHANGED.md new file mode 100644 index 00000000..7c27dc8f --- /dev/null +++ b/wiki-information/events/CHAT_DISABLED_CHANGED.md @@ -0,0 +1,11 @@ +## Event: CHAT_DISABLED_CHANGED + +**Title:** CHAT DISABLED CHANGED + +**Content:** +Needs summary. +`CHAT_DISABLED_CHANGED: disabled` + +**Payload:** +- `disabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md b/wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md new file mode 100644 index 00000000..ee259940 --- /dev/null +++ b/wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md @@ -0,0 +1,11 @@ +## Event: CHAT_DISABLED_CHANGE_FAILED + +**Title:** CHAT DISABLED CHANGE FAILED + +**Content:** +Needs summary. +`CHAT_DISABLED_CHANGE_FAILED: disabled` + +**Payload:** +- `disabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_ACHIEVEMENT.md b/wiki-information/events/CHAT_MSG_ACHIEVEMENT.md new file mode 100644 index 00000000..01f853d8 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_ACHIEVEMENT.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_ACHIEVEMENT + +**Title:** CHAT MSG ACHIEVEMENT + +**Content:** +Fired when a player in your vicinity completes an achievement. +`CHAT_MSG_ACHIEVEMENT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The body of the achievement broadcast, e.g. "%s has earned the achievement |cffffff00|Hachievement:964:Player-969-00225901:1:7:13:20:4294967295:4294967295:4294967295:4294967295|h|h|r!" +2. `playerName` + - *string* - Player who completed the achievement. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - Same as playerName +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - GUID of the player who completed the achievement. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_ADDON.md b/wiki-information/events/CHAT_MSG_ADDON.md new file mode 100644 index 00000000..1f8c8010 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_ADDON.md @@ -0,0 +1,33 @@ +## Event: CHAT_MSG_ADDON + +**Title:** CHAT MSG ADDON + +**Content:** +Fires when the client receives an addon message. +`CHAT_MSG_ADDON: prefix, text, channel, sender, target, zoneChannelID, localID, name, instanceID` + +**Payload:** +- `prefix` + - *string* - The registered prefix as used in `C_ChatInfo.RegisterAddonMessagePrefix()` +- `text` + - *string* - The message body +- `channel` + - *string* - The addon channel's chat type, e.g. "PARTY" +- `sender` + - *string* - Player who initiated the message +- `target` + - *string* - The channel index and name, e.g. "4. test"; or for the "WHISPER" chat type, same as sender +- `zoneChannelID` + - *number* - Seems to be always 0 +- `localID` + - *number* - The channel index or 0 if not applicable. +- `name` + - *string* - The channel name or an empty string if not applicable. +- `instanceID` + - *number* - Seems to be always 0 + +**Content Details:** +Related API +C_ChatInfo.SendAddonMessage +Related Events +CHAT_MSG_ADDON_LOGGED \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_ADDON_LOGGED.md b/wiki-information/events/CHAT_MSG_ADDON_LOGGED.md new file mode 100644 index 00000000..d1d18107 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_ADDON_LOGGED.md @@ -0,0 +1,27 @@ +## Event: CHAT_MSG_ADDON_LOGGED + +**Title:** CHAT MSG ADDON LOGGED + +**Content:** +Fired when the client receives a message from C_ChatInfo.SendAddonMessageLogged() +`CHAT_MSG_ADDON_LOGGED: prefix, text, channel, sender, target, zoneChannelID, localID, name, instanceID` + +**Payload:** +- `prefix` + - *string* - The registered prefix as used in C_ChatInfo.RegisterAddonMessagePrefix() +- `text` + - *string* - The message body +- `channel` + - *string* - The addon channel's chat type, e.g. "PARTY" +- `sender` + - *string* - Player who initiated the message +- `target` + - *string* - The channel index and name, e.g. "4. test"; or for the "WHISPER" chat type, same as sender +- `zoneChannelID` + - *number* - Seems to be always 0 +- `localID` + - *number* - The channel index or 0 if not applicable. +- `name` + - *string* - The channel name or an empty string if not applicable. +- `instanceID` + - *number* - Seems to be always 0 \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_AFK.md b/wiki-information/events/CHAT_MSG_AFK.md new file mode 100644 index 00000000..4bc84373 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_AFK.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_AFK + +**Title:** CHAT MSG AFK + +**Content:** +Fired when the client receives an AFK auto-response. +`CHAT_MSG_AFK: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The AFK auto-response message, or "AFK" if not set. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md b/wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md new file mode 100644 index 00000000..f7ed44e8 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BG_SYSTEM_ALLIANCE + +**Title:** CHAT MSG BG SYSTEM ALLIANCE + +**Content:** +Fired for battleground-event messages that are in blue by default because they are about Alliance actions, e.g. assaulting a graveyard or capture point, or picking up a flag. +`CHAT_MSG_BG_SYSTEM_ALLIANCE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - e.g. "The Alliance has taken the Blacksmith!" +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md b/wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md new file mode 100644 index 00000000..1878d715 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BG_SYSTEM_HORDE + +**Title:** CHAT MSG BG SYSTEM HORDE + +**Content:** +Fired for battleground-event messages that are in red by default because they are about Horde actions. +`CHAT_MSG_BG_SYSTEM_HORDE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - e.g. "The Horde has taken the Blacksmith!" +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md b/wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md new file mode 100644 index 00000000..d00e6af9 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BG_SYSTEM_NEUTRAL + +**Title:** CHAT MSG BG SYSTEM NEUTRAL + +**Content:** +Fired for battleground-event messages that are displayed in a faction-neutral color by default. +`CHAT_MSG_BG_SYSTEM_NEUTRAL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - e.g. "Let the battle for Warsong Gulch begin." +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN.md b/wiki-information/events/CHAT_MSG_BN.md new file mode 100644 index 00000000..d9887c66 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN + +**Title:** CHAT MSG BN + +**Content:** +Needs summary. +`CHAT_MSG_BN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md new file mode 100644 index 00000000..40340a84 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN_INLINE_TOAST_ALERT + +**Title:** CHAT MSG BN INLINE TOAST ALERT + +**Content:** +Fires when a battle.net friend comes online / goes offline or a friend request is received/pending. +`CHAT_MSG_BN_INLINE_TOAST_ALERT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - e.g. "FRIEND_ONLINE" +2. `playerName` + - *string* - The (protected) string of the target player, e.g. "|Kq2|k" +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md new file mode 100644 index 00000000..30a9a40d --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN_INLINE_TOAST_BROADCAST + +**Title:** CHAT MSG BN INLINE TOAST BROADCAST + +**Content:** +Needs summary. +`CHAT_MSG_BN_INLINE_TOAST_BROADCAST: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md new file mode 100644 index 00000000..ed899363 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM + +**Title:** CHAT MSG BN INLINE TOAST BROADCAST INFORM + +**Content:** +Fired when the Bnet Real ID Broadcast Message is changed or from BNSetCustomMessage. +`CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md new file mode 100644 index 00000000..84bf36b3 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN_INLINE_TOAST_CONVERSATION + +**Title:** CHAT MSG BN INLINE TOAST CONVERSATION + +**Content:** +This event seems to be deprecated. +`CHAT_MSG_BN_INLINE_TOAST_CONVERSATION: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_WHISPER.md b/wiki-information/events/CHAT_MSG_BN_WHISPER.md new file mode 100644 index 00000000..bd057a20 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN_WHISPER.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN_WHISPER + +**Title:** CHAT MSG BN WHISPER + +**Content:** +Fires when a battle.net friend whispers you. +`CHAT_MSG_BN_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - The protected string of the player whispering you, e.g. "|Kq2|k" +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - Empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md b/wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md new file mode 100644 index 00000000..7a3574c3 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN_WHISPER_INFORM + +**Title:** CHAT MSG BN WHISPER INFORM + +**Content:** +Fires when you whisper a battle.net friend. +`CHAT_MSG_BN_WHISPER_INFORM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - The (protected) string of the target player, e.g. "|Kq2|k" +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - Empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md b/wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md new file mode 100644 index 00000000..dbd7f94e --- /dev/null +++ b/wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE + +**Title:** CHAT MSG BN WHISPER PLAYER OFFLINE + +**Content:** +Needs summary. +`CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL.md b/wiki-information/events/CHAT_MSG_CHANNEL.md new file mode 100644 index 00000000..15165e4f --- /dev/null +++ b/wiki-information/events/CHAT_MSG_CHANNEL.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_CHANNEL + +**Title:** CHAT MSG CHANNEL + +**Content:** +Fired when the client receives a channel message. +`CHAT_MSG_CHANNEL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - e.g. "Hello world!" +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md b/wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md new file mode 100644 index 00000000..c3cd0ff5 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_CHANNEL_JOIN + +**Title:** CHAT MSG CHANNEL JOIN + +**Content:** +Fired when someone joins a chat channel you are in. +`CHAT_MSG_CHANNEL_JOIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - Empty string. +- `playerName` + - *string* - Name of the player who just joined the channel. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - Empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md b/wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md new file mode 100644 index 00000000..dae6f784 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_CHANNEL_LEAVE + +**Title:** CHAT MSG CHANNEL LEAVE + +**Content:** +Fired when a player leaves a channel that you are currently inside. +`CHAT_MSG_CHANNEL_LEAVE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - Empty string. +- `playerName` + - *string* - Name of the player who just left the channel. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - Empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_LIST.md b/wiki-information/events/CHAT_MSG_CHANNEL_LIST.md new file mode 100644 index 00000000..ae4e641f --- /dev/null +++ b/wiki-information/events/CHAT_MSG_CHANNEL_LIST.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_CHANNEL_LIST + +**Title:** CHAT MSG CHANNEL LIST + +**Content:** +Fired when ListChannels (with /chatlist) or ListChannelByName is called, and the message is displayed in the chat frame. +`CHAT_MSG_CHANNEL_LIST: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The list of channels, e.g. " " +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md b/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md new file mode 100644 index 00000000..ae87d8c4 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_CHANNEL_NOTICE + +**Title:** CHAT MSG CHANNEL NOTICE + +**Content:** +Fired when you enter or leave a chat channel (or a channel was recently throttled). +`CHAT_MSG_CHANNEL_NOTICE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - "YOU_CHANGED" if you joined a channel, or "YOU_LEFT" if you left, or "THROTTLED" if channel was throttled. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md b/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md new file mode 100644 index 00000000..64a4954f --- /dev/null +++ b/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_CHANNEL_NOTICE_USER + +**Title:** CHAT MSG CHANNEL NOTICE USER + +**Content:** +Fired when something changes in the channel like moderation enabled, user is kicked, announcements changed and so on. CHAT_*_NOTICE in GlobalStrings.lua has a full list of available types. +`CHAT_MSG_CHANNEL_NOTICE_USER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - "ANNOUNCEMENTS_OFF", "ANNOUNCEMENTS_ON", "BANNED", "OWNER_CHANGED", "INVALID_NAME", "INVITE", "MODERATION_OFF", "MODERATION_ON", "MUTED", "NOT_MEMBER", "NOT_MODERATED", "SET_MODERATOR", "UNSET_MODERATOR" +- `playerName` + - *string* - If arg5 has a value then this is the user affected (e.g. "Player Foo has been kicked by Bar"), if arg5 has no value then it's the person who caused the event (e.g. "Channel Moderation has been enabled by Bar") +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - Player that caused the event (e.g. "Player Foo has been kicked by Bar") +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md b/wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md new file mode 100644 index 00000000..2ce11917 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_COMBAT_FACTION_CHANGE + +**Title:** CHAT MSG COMBAT FACTION CHANGE + +**Content:** +Fires when you gain reputation with a faction. +`CHAT_MSG_COMBAT_FACTION_CHANGE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - e.g. "Your reputation with Timbermaw Hold has very slightly increased." +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md b/wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md new file mode 100644 index 00000000..d1a86a19 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_COMBAT_HONOR_GAIN + +**Title:** CHAT MSG COMBAT HONOR GAIN + +**Content:** +Fires when the player gains any amount of honor, anything from an honorable kill to bonus honor awarded. +`CHAT_MSG_COMBAT_HONOR_GAIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - format: "%s dies, honorable kill Rank: %s (Estimated Honor Points: %d)" or "You have been awarded %d honor." +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md b/wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md new file mode 100644 index 00000000..aabf2d10 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_COMBAT_MISC_INFO + +**Title:** CHAT MSG COMBAT MISC INFO + +**Content:** +Fires when your equipment takes durability loss from death, and likely other situations as well. +`CHAT_MSG_COMBAT_MISC_INFO: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md b/wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md new file mode 100644 index 00000000..2b63a772 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_COMBAT_XP_GAIN + +**Title:** CHAT MSG COMBAT XP GAIN + +**Content:** +Fires when you gain XP from killing a creature or finishing a quest. Does not fire if you gain no XP from killing a creature. +`CHAT_MSG_COMBAT_XP_GAIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - e.g. "Rockjaw Invader dies, you gain 44 experience." +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md b/wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md new file mode 100644 index 00000000..8cc739a9 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_COMMUNITIES_CHANNEL + +**Title:** CHAT MSG COMMUNITIES CHANNEL + +**Content:** +Needs summary. +`CHAT_MSG_COMMUNITIES_CHANNEL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - Protected string. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CURRENCY.md b/wiki-information/events/CHAT_MSG_CURRENCY.md new file mode 100644 index 00000000..65e562bc --- /dev/null +++ b/wiki-information/events/CHAT_MSG_CURRENCY.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_CURRENCY + +**Title:** CHAT MSG CURRENCY + +**Content:** +Fires when you gain currency other than money (for example Chef's Awards or Champion's Seals). +`CHAT_MSG_CURRENCY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - e.g. "You receive currency: Chef's Award x1." +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_DND.md b/wiki-information/events/CHAT_MSG_DND.md new file mode 100644 index 00000000..10b00156 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_DND.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_DND + +**Title:** CHAT MSG DND + +**Content:** +Fired when the client receives a Do-Not-Disturb auto-response. +`CHAT_MSG_DND: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The DND auto-response message, or "DND" if not set. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_EMOTE.md b/wiki-information/events/CHAT_MSG_EMOTE.md new file mode 100644 index 00000000..8a8a9b5c --- /dev/null +++ b/wiki-information/events/CHAT_MSG_EMOTE.md @@ -0,0 +1,51 @@ +## Event: CHAT_MSG_EMOTE + +**Title:** CHAT MSG EMOTE + +**Content:** +Fires when a player uses a custom /emote. +`CHAT_MSG_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The custom emote text, e.g. "pickpockets you for 39 silver." +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_PARTY +- CHAT_MSG_RAID +- CHAT_MSG_SAY +- CHAT_MSG_YELL +- CHAT_MSG_WHISPER +- CHAT_MSG_MONSTER_EMOTE \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_FILTERED.md b/wiki-information/events/CHAT_MSG_FILTERED.md new file mode 100644 index 00000000..9fdbf319 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_FILTERED.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_FILTERED + +**Title:** CHAT MSG FILTERED + +**Content:** +Needs summary. +`CHAT_MSG_FILTERED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_GUILD.md b/wiki-information/events/CHAT_MSG_GUILD.md new file mode 100644 index 00000000..1faa27e8 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_GUILD.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_GUILD + +**Title:** CHAT MSG GUILD + +**Content:** +Fired when a message is sent or received in the Guild channel. +`CHAT_MSG_GUILD: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - e.g. "good morning :)" +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md b/wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md new file mode 100644 index 00000000..ffdb017d --- /dev/null +++ b/wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_GUILD_ACHIEVEMENT + +**Title:** CHAT MSG GUILD ACHIEVEMENT + +**Content:** +Fired when a guild member completes an achievement. +`CHAT_MSG_GUILD_ACHIEVEMENT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The full body of the achievement broadcast message. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md b/wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md new file mode 100644 index 00000000..fcb398f0 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_GUILD_ITEM_LOOTED + +**Title:** CHAT MSG GUILD ITEM LOOTED + +**Content:** +Needs summary. +`CHAT_MSG_GUILD_ITEM_LOOTED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_IGNORED.md b/wiki-information/events/CHAT_MSG_IGNORED.md new file mode 100644 index 00000000..2cdf5637 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_IGNORED.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_IGNORED + +**Title:** CHAT MSG IGNORED + +**Content:** +Fired when you whisper a player that is ignoring you. +`CHAT_MSG_IGNORED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - Returns "ChatIgnoredHandler" +- `playerName` + - *string* - Character name of who you tried to message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md b/wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md new file mode 100644 index 00000000..89ea06fc --- /dev/null +++ b/wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_INSTANCE_CHAT + +**Title:** CHAT MSG INSTANCE CHAT + +**Content:** +Fires for chat messages from groups formed by the dungeon finder, like in instances, raids, arenas and battlegrounds. +`CHAT_MSG_INSTANCE_CHAT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md b/wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md new file mode 100644 index 00000000..a29fd87b --- /dev/null +++ b/wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_INSTANCE_CHAT_LEADER + +**Title:** CHAT MSG INSTANCE CHAT LEADER + +**Content:** +Fires for group leader messages from groups formed by the dungeon finder, like in instances, raids, arenas and battlegrounds. +`CHAT_MSG_INSTANCE_CHAT_LEADER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_LOOT.md b/wiki-information/events/CHAT_MSG_LOOT.md new file mode 100644 index 00000000..d7874c23 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_LOOT.md @@ -0,0 +1,46 @@ +## Event: CHAT_MSG_LOOT + +**Title:** CHAT MSG LOOT + +**Content:** +Fires when you or a group member loots an item or when someone selects need/greed/pass on an item. +`CHAT_MSG_LOOT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - e.g. "You receive loot: |cffffffff|Hitem:2589::::::::20:257::::::|h|h|rx2." +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Content Details:** +This also fires messages like "Person creates " via tradeskills, and "Person receives " via a trade window. See also CHAT_MSG_MONEY and CHAT_MSG_CURRENCY. \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONEY.md b/wiki-information/events/CHAT_MSG_MONEY.md new file mode 100644 index 00000000..dfaca299 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_MONEY.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_MONEY + +**Title:** CHAT MSG MONEY + +**Content:** +Fired when a unit loots money. +`CHAT_MSG_MONEY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - e.g. "You loot 4 Copper" +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md b/wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md new file mode 100644 index 00000000..79e3dbfe --- /dev/null +++ b/wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md @@ -0,0 +1,49 @@ +## Event: CHAT_MSG_MONSTER_EMOTE + +**Title:** CHAT MSG MONSTER EMOTE + +**Content:** +Fires when an NPC emotes. +`CHAT_MSG_MONSTER_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message body, such as "%s attempts to run away in fear!" +2. `playerName` + - *string* - Name of the NPC. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - If applicable, the player triggering the NPC emote. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_MONSTER_SAY +- CHAT_MSG_MONSTER_PARTY +- CHAT_MSG_MONSTER_YELL +- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_PARTY.md b/wiki-information/events/CHAT_MSG_MONSTER_PARTY.md new file mode 100644 index 00000000..17d6d7c0 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_MONSTER_PARTY.md @@ -0,0 +1,49 @@ +## Event: CHAT_MSG_MONSTER_PARTY + +**Title:** CHAT MSG MONSTER PARTY + +**Content:** +Fires when a party member NPC speaks. +`CHAT_MSG_MONSTER_PARTY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the NPC. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - If applicable, the player triggering the NPC message. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_MONSTER_EMOTE +- CHAT_MSG_MONSTER_SAY +- CHAT_MSG_MONSTER_YELL +- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_SAY.md b/wiki-information/events/CHAT_MSG_MONSTER_SAY.md new file mode 100644 index 00000000..1213bfac --- /dev/null +++ b/wiki-information/events/CHAT_MSG_MONSTER_SAY.md @@ -0,0 +1,49 @@ +## Event: CHAT_MSG_MONSTER_SAY + +**Title:** CHAT MSG MONSTER SAY + +**Content:** +Fires when a NPC speaks. +`CHAT_MSG_MONSTER_SAY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the NPC. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - If applicable, the player triggering the NPC message. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_MONSTER_EMOTE +- CHAT_MSG_MONSTER_PARTY +- CHAT_MSG_MONSTER_YELL +- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md b/wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md new file mode 100644 index 00000000..2402aa8d --- /dev/null +++ b/wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md @@ -0,0 +1,49 @@ +## Event: CHAT_MSG_MONSTER_WHISPER + +**Title:** CHAT MSG MONSTER WHISPER + +**Content:** +Fires when a NPC whispers an individual player. +`CHAT_MSG_MONSTER_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the NPC. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - Target of the whisper. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_MONSTER_EMOTE +- CHAT_MSG_MONSTER_SAY +- CHAT_MSG_MONSTER_PARTY +- CHAT_MSG_MONSTER_YELL \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_YELL.md b/wiki-information/events/CHAT_MSG_MONSTER_YELL.md new file mode 100644 index 00000000..bb1d958a --- /dev/null +++ b/wiki-information/events/CHAT_MSG_MONSTER_YELL.md @@ -0,0 +1,49 @@ +## Event: CHAT_MSG_MONSTER_YELL + +**Title:** CHAT MSG MONSTER YELL + +**Content:** +Fires when an NPC yells, such as a raid boss or in Alterac Valley. +`CHAT_MSG_MONSTER_YELL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the NPC. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - If applicable, the player triggering the NPC message. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_MONSTER_EMOTE +- CHAT_MSG_MONSTER_SAY +- CHAT_MSG_MONSTER_PARTY +- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_OFFICER.md b/wiki-information/events/CHAT_MSG_OFFICER.md new file mode 100644 index 00000000..bdd1c065 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_OFFICER.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_OFFICER + +**Title:** CHAT MSG OFFICER + +**Content:** +Fired when a message is sent or received in the Guild Officer channel. +`CHAT_MSG_OFFICER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_OPENING.md b/wiki-information/events/CHAT_MSG_OPENING.md new file mode 100644 index 00000000..e0b93a75 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_OPENING.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_OPENING + +**Title:** CHAT MSG OPENING + +**Content:** +Needs summary. +`CHAT_MSG_OPENING: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PARTY.md b/wiki-information/events/CHAT_MSG_PARTY.md new file mode 100644 index 00000000..1f6d84af --- /dev/null +++ b/wiki-information/events/CHAT_MSG_PARTY.md @@ -0,0 +1,51 @@ +## Event: CHAT_MSG_PARTY + +**Title:** CHAT MSG PARTY + +**Content:** +Fires when a player speaks in /party chat. +`CHAT_MSG_PARTY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_EMOTE +- CHAT_MSG_RAID +- CHAT_MSG_SAY +- CHAT_MSG_YELL +- CHAT_MSG_WHISPER +- CHAT_MSG_MONSTER_PARTY \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PARTY_LEADER.md b/wiki-information/events/CHAT_MSG_PARTY_LEADER.md new file mode 100644 index 00000000..83089624 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_PARTY_LEADER.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_PARTY_LEADER + +**Title:** CHAT MSG PARTY LEADER + +**Content:** +Fired when a message is sent or received by the party leader. +`CHAT_MSG_PARTY_LEADER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md b/wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md new file mode 100644 index 00000000..d33e7c1c --- /dev/null +++ b/wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_PET_BATTLE_COMBAT_LOG + +**Title:** CHAT MSG PET BATTLE COMBAT LOG + +**Content:** +Needs summary. +`CHAT_MSG_PET_BATTLE_COMBAT_LOG: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md b/wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md new file mode 100644 index 00000000..1fe2e0b9 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_PET_BATTLE_INFO + +**Title:** CHAT MSG PET BATTLE INFO + +**Content:** +Needs summary. +`CHAT_MSG_PET_BATTLE_INFO: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PET_INFO.md b/wiki-information/events/CHAT_MSG_PET_INFO.md new file mode 100644 index 00000000..9fedc9c7 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_PET_INFO.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_PET_INFO + +**Title:** CHAT MSG PET INFO + +**Content:** +Needs summary. +`CHAT_MSG_PET_INFO: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID.md b/wiki-information/events/CHAT_MSG_RAID.md new file mode 100644 index 00000000..4db27356 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_RAID.md @@ -0,0 +1,50 @@ +## Event: CHAT_MSG_RAID + +**Title:** CHAT MSG RAID + +**Content:** +Fires when a player speaks in /raid chat. +`CHAT_MSG_RAID: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_EMOTE +- CHAT_MSG_PARTY +- CHAT_MSG_SAY +- CHAT_MSG_YELL +- CHAT_MSG_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md b/wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md new file mode 100644 index 00000000..9b89bed5 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_RAID_BOSS_EMOTE + +**Title:** CHAT MSG RAID BOSS EMOTE + +**Content:** +Needs summary. +`CHAT_MSG_RAID_BOSS_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the boss. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - Name of the targeted player. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md b/wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md new file mode 100644 index 00000000..55d4b5ab --- /dev/null +++ b/wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_RAID_BOSS_WHISPER + +**Title:** CHAT MSG RAID BOSS WHISPER + +**Content:** +Needs summary. +`CHAT_MSG_RAID_BOSS_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_LEADER.md b/wiki-information/events/CHAT_MSG_RAID_LEADER.md new file mode 100644 index 00000000..d57044fb --- /dev/null +++ b/wiki-information/events/CHAT_MSG_RAID_LEADER.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_RAID_LEADER + +**Title:** CHAT MSG RAID LEADER + +**Content:** +Fired when a message is sent or received from the raid leader. +`CHAT_MSG_RAID_LEADER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_WARNING.md b/wiki-information/events/CHAT_MSG_RAID_WARNING.md new file mode 100644 index 00000000..0f903e58 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_RAID_WARNING.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_RAID_WARNING + +**Title:** CHAT MSG RAID WARNING + +**Content:** +Fired when a warning message is sent or received from the raid leader. +`CHAT_MSG_RAID_WARNING: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RESTRICTED.md b/wiki-information/events/CHAT_MSG_RESTRICTED.md new file mode 100644 index 00000000..ac42a6a2 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_RESTRICTED.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_RESTRICTED + +**Title:** CHAT MSG RESTRICTED + +**Content:** +Needs summary. +`CHAT_MSG_RESTRICTED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_SAY.md b/wiki-information/events/CHAT_MSG_SAY.md new file mode 100644 index 00000000..7d62a935 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_SAY.md @@ -0,0 +1,51 @@ +## Event: CHAT_MSG_SAY + +**Title:** CHAT MSG SAY + +**Content:** +Fires when a player sends a chat message with /say. +`CHAT_MSG_SAY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_EMOTE +- CHAT_MSG_PARTY +- CHAT_MSG_RAID +- CHAT_MSG_YELL +- CHAT_MSG_WHISPER +- CHAT_MSG_MONSTER_SAY \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_SKILL.md b/wiki-information/events/CHAT_MSG_SKILL.md new file mode 100644 index 00000000..2d4410d9 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_SKILL.md @@ -0,0 +1,45 @@ +## Event: CHAT_MSG_SKILL + +**Title:** CHAT MSG SKILL + +**Content:** +Fired when some chat messages about skills are displayed. +`CHAT_MSG_SKILL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - Some possible GlobalStrings: + - ERR_SKILL_GAINED_S (e.g. "You have gained the Blacksmithing skill.") + - ERR_SKILL_UP_SI (e.g. "Your skill in Cooking has increased to 221.") +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_SYSTEM.md b/wiki-information/events/CHAT_MSG_SYSTEM.md new file mode 100644 index 00000000..5350687f --- /dev/null +++ b/wiki-information/events/CHAT_MSG_SYSTEM.md @@ -0,0 +1,48 @@ +## Event: CHAT_MSG_SYSTEM + +**Title:** CHAT MSG SYSTEM + +**Content:** +Fired when a system chat message (they are displayed in yellow) is received. +`CHAT_MSG_SYSTEM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - Some possible GlobalStrings: + - ERR_LEARN_RECIPE_S (e.g. "You have learned how to create a new item: Bristle Whisker Catfish.") + - MARKED_AFK_MESSAGE (e.g. "You are now AFK: Away from Keyboard") +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Content Details:** +Be very careful with assuming when the event is actually sent. For example, "Quest accepted: Quest Title" is sent before the quest log updates, so at the time of the event the player's quest log does not yet contain the quest. Similarly, "Quest Title completed." is sent before the quest is removed from the quest log, so at the time of the event the player's quest log still contains the quest. \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_TARGETICONS.md b/wiki-information/events/CHAT_MSG_TARGETICONS.md new file mode 100644 index 00000000..ddc535da --- /dev/null +++ b/wiki-information/events/CHAT_MSG_TARGETICONS.md @@ -0,0 +1,44 @@ +## Event: CHAT_MSG_TARGETICONS + +**Title:** CHAT MSG TARGETICONS + +**Content:** +Fired when a raid target icon is set. This is used by the chat filter, if the player is watching raid icons in chat output (in the Filters right-click menu, under Other, look for Target Icons). +`CHAT_MSG_TARGETICONS: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The formatted message to be displayed in the chat window. + - Formatted from the TARGET_ICON_SET globalstring: "|Hplayer:%s|h|h sets |TInterface\\TargetingFrame\\UI-RaidTargetingIcon_%d:0|t on %s." +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to PlayerLocation:CreateFromChatLineID() +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with C_ChatInfo.ReplaceIconAndGroupExpressions() \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_TEXT_EMOTE.md b/wiki-information/events/CHAT_MSG_TEXT_EMOTE.md new file mode 100644 index 00000000..f0ea820c --- /dev/null +++ b/wiki-information/events/CHAT_MSG_TEXT_EMOTE.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_TEXT_EMOTE + +**Title:** CHAT MSG TEXT EMOTE + +**Content:** +Fired for emotes with an emote token. /dance, /healme, etc. +`CHAT_MSG_TEXT_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - e.g. "You threaten Rabbit with the wrath of doom." +- `playerName` + - *string* - Name of the person who emoted. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_TRADESKILLS.md b/wiki-information/events/CHAT_MSG_TRADESKILLS.md new file mode 100644 index 00000000..cfd6e252 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_TRADESKILLS.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_TRADESKILLS + +**Title:** CHAT MSG TRADESKILLS + +**Content:** +Needs summary. +`CHAT_MSG_TRADESKILLS: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_VOICE_TEXT.md b/wiki-information/events/CHAT_MSG_VOICE_TEXT.md new file mode 100644 index 00000000..922d5374 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_VOICE_TEXT.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_VOICE_TEXT + +**Title:** CHAT MSG VOICE TEXT + +**Content:** +Needs summary. +`CHAT_MSG_VOICE_TEXT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the user that initiated the chat message. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_WHISPER.md b/wiki-information/events/CHAT_MSG_WHISPER.md new file mode 100644 index 00000000..6956cdb3 --- /dev/null +++ b/wiki-information/events/CHAT_MSG_WHISPER.md @@ -0,0 +1,51 @@ +## Event: CHAT_MSG_WHISPER + +**Title:** CHAT MSG WHISPER + +**Content:** +Fired when a whisper is received from another player. +`CHAT_MSG_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the player sending a whisper, e.g. "Arthas-Silvermoon" +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_EMOTE +- CHAT_MSG_PARTY +- CHAT_MSG_RAID +- CHAT_MSG_SAY +- CHAT_MSG_YELL +- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_WHISPER_INFORM.md b/wiki-information/events/CHAT_MSG_WHISPER_INFORM.md new file mode 100644 index 00000000..36552e8f --- /dev/null +++ b/wiki-information/events/CHAT_MSG_WHISPER_INFORM.md @@ -0,0 +1,43 @@ +## Event: CHAT_MSG_WHISPER_INFORM + +**Title:** CHAT MSG WHISPER INFORM + +**Content:** +Fires when you send a whisper. +`CHAT_MSG_WHISPER_INFORM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +- `text` + - *string* - The chat message payload. +- `playerName` + - *string* - Name of the player who was sent the whisper. +- `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +- `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +- `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +- `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +- `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +- `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +- `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +- `languageID` + - *number* - LanguageID +- `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +- `guid` + - *string* - Sender's Unit GUID. +- `bnSenderID` + - *number* - ID of the Battle.net friend. +- `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +- `isSubtitle` + - *boolean* +- `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +- `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_YELL.md b/wiki-information/events/CHAT_MSG_YELL.md new file mode 100644 index 00000000..83c1a03d --- /dev/null +++ b/wiki-information/events/CHAT_MSG_YELL.md @@ -0,0 +1,51 @@ +## Event: CHAT_MSG_YELL + +**Title:** CHAT MSG YELL + +**Content:** +Fires when a player /yells. +`CHAT_MSG_YELL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` + +**Payload:** +1. `text` + - *string* - The chat message payload. +2. `playerName` + - *string* - Name of the user that initiated the chat message. +3. `languageName` + - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" +4. `channelName` + - *string* - Channel name with channelIndex, e.g. "2. Trade - City" +5. `playerName2` + - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. +6. `specialFlags` + - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" +7. `zoneChannelID` + - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. +8. `channelIndex` + - *number* - Channel index, this usually is related to the order in which you joined each channel. +9. `channelBaseName` + - *string* - Channel name without the number, e.g. "Trade - City" +10. `languageID` + - *number* - LanguageID +11. `lineID` + - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` +12. `guid` + - *string* - Sender's Unit GUID. +13. `bnSenderID` + - *number* - ID of the Battle.net friend. +14. `isMobile` + - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. +15. `isSubtitle` + - *boolean* +16. `hideSenderInLetterbox` + - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. +17. `supressRaidIcons` + - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` + +**Related Information:** +- CHAT_MSG_EMOTE +- CHAT_MSG_PARTY +- CHAT_MSG_RAID +- CHAT_MSG_SAY +- CHAT_MSG_WHISPER +- CHAT_MSG_MONSTER_YELL \ No newline at end of file diff --git a/wiki-information/events/CHAT_SERVER_DISCONNECTED.md b/wiki-information/events/CHAT_SERVER_DISCONNECTED.md new file mode 100644 index 00000000..9f0af8a9 --- /dev/null +++ b/wiki-information/events/CHAT_SERVER_DISCONNECTED.md @@ -0,0 +1,11 @@ +## Event: CHAT_SERVER_DISCONNECTED + +**Title:** CHAT SERVER DISCONNECTED + +**Content:** +Needs summary. +`CHAT_SERVER_DISCONNECTED: isInitialMessage` + +**Payload:** +- `isInitialMessage` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/CHAT_SERVER_RECONNECTED.md b/wiki-information/events/CHAT_SERVER_RECONNECTED.md new file mode 100644 index 00000000..25eaa22e --- /dev/null +++ b/wiki-information/events/CHAT_SERVER_RECONNECTED.md @@ -0,0 +1,10 @@ +## Event: CHAT_SERVER_RECONNECTED + +**Title:** CHAT SERVER RECONNECTED + +**Content:** +Needs summary. +`CHAT_SERVER_RECONNECTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CINEMATIC_START.md b/wiki-information/events/CINEMATIC_START.md new file mode 100644 index 00000000..bf3a2dc1 --- /dev/null +++ b/wiki-information/events/CINEMATIC_START.md @@ -0,0 +1,15 @@ +## Event: CINEMATIC_START + +**Title:** CINEMATIC START + +**Content:** +Fires for an in-game cinematic/cutscene. +`CINEMATIC_START: canBeCancelled` + +**Payload:** +- `canBeCancelled` + - *boolean* - This unintuitively indicates whether it's a "real" cinematic, otherwise it's a vehicle cinematic which requires canceling in a different way. + +**Related Information:** +CINEMATIC_STOP +InCinematic(), IsInCinematicScene() \ No newline at end of file diff --git a/wiki-information/events/CINEMATIC_STOP.md b/wiki-information/events/CINEMATIC_STOP.md new file mode 100644 index 00000000..3b1aab9a --- /dev/null +++ b/wiki-information/events/CINEMATIC_STOP.md @@ -0,0 +1,13 @@ +## Event: CINEMATIC_STOP + +**Title:** CINEMATIC STOP + +**Content:** +Fires after an in-game cinematic/cutscene. +`CINEMATIC_STOP` + +**Payload:** +- `None` + +**Related Information:** +CINEMATIC_START \ No newline at end of file diff --git a/wiki-information/events/CLASS_TRIAL_TIMER_START.md b/wiki-information/events/CLASS_TRIAL_TIMER_START.md new file mode 100644 index 00000000..2a2b7adb --- /dev/null +++ b/wiki-information/events/CLASS_TRIAL_TIMER_START.md @@ -0,0 +1,10 @@ +## Event: CLASS_TRIAL_TIMER_START + +**Title:** CLASS TRIAL TIMER START + +**Content:** +Needs summary. +`CLASS_TRIAL_TIMER_START` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md b/wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md new file mode 100644 index 00000000..dddbdca1 --- /dev/null +++ b/wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md @@ -0,0 +1,10 @@ +## Event: CLASS_TRIAL_UPGRADE_COMPLETE + +**Title:** CLASS TRIAL UPGRADE COMPLETE + +**Content:** +Needs summary. +`CLASS_TRIAL_UPGRADE_COMPLETE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CLEAR_BOSS_EMOTES.md b/wiki-information/events/CLEAR_BOSS_EMOTES.md new file mode 100644 index 00000000..00b72e03 --- /dev/null +++ b/wiki-information/events/CLEAR_BOSS_EMOTES.md @@ -0,0 +1,10 @@ +## Event: CLEAR_BOSS_EMOTES + +**Title:** CLEAR BOSS EMOTES + +**Content:** +Needs summary. +`CLEAR_BOSS_EMOTES` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CLIENT_SCENE_CLOSED.md b/wiki-information/events/CLIENT_SCENE_CLOSED.md new file mode 100644 index 00000000..335f8044 --- /dev/null +++ b/wiki-information/events/CLIENT_SCENE_CLOSED.md @@ -0,0 +1,10 @@ +## Event: CLIENT_SCENE_CLOSED + +**Title:** CLIENT SCENE CLOSED + +**Content:** +Needs summary. +`CLIENT_SCENE_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CLIENT_SCENE_OPENED.md b/wiki-information/events/CLIENT_SCENE_OPENED.md new file mode 100644 index 00000000..a0c8e48e --- /dev/null +++ b/wiki-information/events/CLIENT_SCENE_OPENED.md @@ -0,0 +1,18 @@ +## Event: CLIENT_SCENE_OPENED + +**Title:** CLIENT SCENE OPENED + +**Content:** +Needs summary. +`CLIENT_SCENE_OPENED: sceneType` + +**Payload:** +- `sceneType` + - *Enum.ClientSceneType* + - *Value* + - *Field* + - *Description* + - 0 + - DefaultSceneType + - 1 + - MinigameSceneType \ No newline at end of file diff --git a/wiki-information/events/CLOSE_INBOX_ITEM.md b/wiki-information/events/CLOSE_INBOX_ITEM.md new file mode 100644 index 00000000..2e14ec7f --- /dev/null +++ b/wiki-information/events/CLOSE_INBOX_ITEM.md @@ -0,0 +1,11 @@ +## Event: CLOSE_INBOX_ITEM + +**Title:** CLOSE INBOX ITEM + +**Content:** +Needs summary. +`CLOSE_INBOX_ITEM: mailIndex` + +**Payload:** +- `mailIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CLOSE_TABARD_FRAME.md b/wiki-information/events/CLOSE_TABARD_FRAME.md new file mode 100644 index 00000000..9779a624 --- /dev/null +++ b/wiki-information/events/CLOSE_TABARD_FRAME.md @@ -0,0 +1,10 @@ +## Event: CLOSE_TABARD_FRAME + +**Title:** CLOSE TABARD FRAME + +**Content:** +Fired when the guild dress frame is closed. +`CLOSE_TABARD_FRAME` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CLUB_ADDED.md b/wiki-information/events/CLUB_ADDED.md new file mode 100644 index 00000000..f5fbd3aa --- /dev/null +++ b/wiki-information/events/CLUB_ADDED.md @@ -0,0 +1,11 @@ +## Event: CLUB_ADDED + +**Title:** CLUB ADDED + +**Content:** +Needs summary. +`CLUB_ADDED: clubId` + +**Payload:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_ERROR.md b/wiki-information/events/CLUB_ERROR.md new file mode 100644 index 00000000..8640d7da --- /dev/null +++ b/wiki-information/events/CLUB_ERROR.md @@ -0,0 +1,98 @@ +## Event: CLUB_ERROR + +**Title:** CLUB ERROR + +**Content:** +Needs summary. +`CLUB_ERROR: action, error, clubType` + +**Payload:** +- `action` + - *number* - Enum.ClubActionType +- `error` + - *number* - Enum.ClubErrorType +- `clubType` + - *number* - Enum.ClubType + - *Enum.ClubActionType* + - Value + - Field + - Description + - 0 + - ErrorClubActionSubscribe + - 1 + - ErrorClubActionCreate + - 2 + - ErrorClubActionEdit + - 3 + - ErrorClubActionDestroy + - 4 + - ErrorClubActionLeave + - 5 + - ErrorClubActionCreateTicket + - 6 + - ErrorClubActionDestroyTicket + - 7 + - ErrorClubActionRedeemTicket + - 8 + - ErrorClubActionGetTicket + - 9 + - ErrorClubActionGetTickets + - 10 + - ErrorClubActionGetBans + - 11 + - ErrorClubActionGetInvitations + - 12 + - ErrorClubActionRevokeInvitation + - 13 + - ErrorClubActionAcceptInvitation + - 14 + - ErrorClubActionDeclineInvitation + - 15 + - ErrorClubActionCreateStream + - 16 + - ErrorClubActionEditStream + - 17 + - ErrorClubActionDestroyStream + - 18 + - ErrorClubActionInviteMember + - 19 + - ErrorClubActionEditMember + - 20 + - ErrorClubActionEditMemberNote + - 21 + - ErrorClubActionKickMember + - 22 + - ErrorClubActionAddBan + - 23 + - ErrorClubActionRemoveBan + - 24 + - ErrorClubActionCreateMessage + - 25 + - ErrorClubActionEditMessage + - 26 + - ErrorClubActionDestroyMessage + - *Enum.ClubErrorType* + - Value + - Field + - Description + - 0 + - ErrorCommunitiesNone + - 1 + - ErrorCommunitiesUnknown + - 2 + - ErrorCommunitiesNeutralFaction + - 3 + - ErrorCommunitiesUnknownRealm + - ... + - *Enum.ClubType* + - Value + - Field + - Description + - 0 + - BattleNet + - 1 + - Character + - 2 + - Guild + - 3 + - Other \ No newline at end of file diff --git a/wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md b/wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md new file mode 100644 index 00000000..45915687 --- /dev/null +++ b/wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md @@ -0,0 +1,11 @@ +## Event: CLUB_INVITATIONS_RECEIVED_FOR_CLUB + +**Title:** CLUB INVITATIONS RECEIVED FOR CLUB + +**Content:** +Needs summary. +`CLUB_INVITATIONS_RECEIVED_FOR_CLUB: clubId` + +**Payload:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md b/wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md new file mode 100644 index 00000000..4901bfb4 --- /dev/null +++ b/wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md @@ -0,0 +1,172 @@ +## Event: CLUB_INVITATION_ADDED_FOR_SELF + +**Title:** CLUB INVITATION ADDED FOR SELF + +**Content:** +Needs summary. +`CLUB_INVITATION_ADDED_FOR_SELF: invitation` + +**Payload:** +- `invitation` + - *structure* - ClubSelfInvitationInfo + - `ClubSelfInvitationInfo` + - Field + - Type + - Description + - invitationId + - string + - club + - ClubInfo + - inviter + - ClubMemberInfo + - leaders + - ClubMemberInfo + - ClubInfo + - Field + - Type + - Description + - clubId + - string + - name + - string + - shortName + - string? + - description + - string + - broadcast + - string + - clubType + - Enum.ClubType + - avatarId + - number + - memberCount + - number? + - favoriteTimeStamp + - number? + - joinTime + - number? + - UNIX timestamp measured in microsecond precision. + - socialQueueingEnabled + - boolean? + - crossFaction + - boolean? + - Added in 9.2.5 + - Enum.ClubType + - Value + - Field + - Description + - 0 + - BattleNet + - 1 + - Character + - 2 + - Guild + - 3 + - Other + - ClubMemberInfo + - Field + - Type + - Description + - isSelf + - boolean + - memberId + - number + - name + - string? + - name may be encoded as a Kstring + - role + - Enum.ClubRoleIdentifier? + - presence + - Enum.ClubMemberPresence + - clubType + - Enum.ClubType? + - guid + - string? + - bnetAccountId + - number? + - memberNote + - string? + - officerNote + - string? + - classID + - number? + - race + - number? + - level + - number? + - zone + - string? + - achievementPoints + - number? + - profession1ID + - number? + - profession1Rank + - number? + - profession1Name + - string? + - profession2ID + - number? + - profession2Rank + - number? + - profession2Name + - string? + - lastOnlineYear + - number? + - lastOnlineMonth + - number? + - lastOnlineDay + - number? + - lastOnlineHour + - number? + - guildRank + - string? + - guildRankOrder + - number? + - isRemoteChat + - boolean? + - overallDungeonScore + - number? + - Added in 9.1.0 + - faction + - Enum.PvPFaction? + - Added in 9.2.5 + - Enum.ClubRoleIdentifier + - Value + - Field + - Description + - 1 + - Owner + - 2 + - Leader + - 3 + - Moderator + - 4 + - Member + - Enum.ClubMemberPresence + - Value + - Field + - Description + - 0 + - Unknown + - 1 + - Online + - 2 + - OnlineMobile + - 3 + - Offline + - 4 + - Away + - 5 + - Busy + - Enum.ClubType + - Value + - Field + - Description + - 0 + - BattleNet + - 1 + - Character + - 2 + - Guild + - 3 + - Other \ No newline at end of file diff --git a/wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md b/wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md new file mode 100644 index 00000000..595d1446 --- /dev/null +++ b/wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md @@ -0,0 +1,11 @@ +## Event: CLUB_INVITATION_REMOVED_FOR_SELF + +**Title:** CLUB INVITATION REMOVED FOR SELF + +**Content:** +Needs summary. +`CLUB_INVITATION_REMOVED_FOR_SELF: invitationId` + +**Payload:** +- `invitationId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_ADDED.md b/wiki-information/events/CLUB_MEMBER_ADDED.md new file mode 100644 index 00000000..c4a4d407 --- /dev/null +++ b/wiki-information/events/CLUB_MEMBER_ADDED.md @@ -0,0 +1,13 @@ +## Event: CLUB_MEMBER_ADDED + +**Title:** CLUB MEMBER ADDED + +**Content:** +Needs summary. +`CLUB_MEMBER_ADDED: clubId, memberId` + +**Payload:** +- `clubId` + - *string* +- `memberId` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md b/wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md new file mode 100644 index 00000000..3f416d89 --- /dev/null +++ b/wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md @@ -0,0 +1,31 @@ +## Event: CLUB_MEMBER_PRESENCE_UPDATED + +**Title:** CLUB MEMBER PRESENCE UPDATED + +**Content:** +Needs summary. +`CLUB_MEMBER_PRESENCE_UPDATED: clubId, memberId, presence` + +**Payload:** +- `clubId` + - *string* +- `memberId` + - *number* +- `presence` + - *number* - Enum.ClubMemberPresence + - Enum.ClubMemberPresence + - Value + - Field + - Description + - 0 + - Unknown + - 1 + - Online + - 2 + - OnlineMobile + - 3 + - Offline + - 4 + - Away + - 5 + - Busy \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_REMOVED.md b/wiki-information/events/CLUB_MEMBER_REMOVED.md new file mode 100644 index 00000000..acb07e2e --- /dev/null +++ b/wiki-information/events/CLUB_MEMBER_REMOVED.md @@ -0,0 +1,13 @@ +## Event: CLUB_MEMBER_REMOVED + +**Title:** CLUB MEMBER REMOVED + +**Content:** +Needs summary. +`CLUB_MEMBER_REMOVED: clubId, memberId` + +**Payload:** +- `clubId` + - *string* +- `memberId` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md b/wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md new file mode 100644 index 00000000..ebef9464 --- /dev/null +++ b/wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md @@ -0,0 +1,15 @@ +## Event: CLUB_MEMBER_ROLE_UPDATED + +**Title:** CLUB MEMBER ROLE UPDATED + +**Content:** +Needs summary. +`CLUB_MEMBER_ROLE_UPDATED: clubId, memberId, roleId` + +**Payload:** +- `clubId` + - *string* +- `memberId` + - *number* +- `roleId` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_UPDATED.md b/wiki-information/events/CLUB_MEMBER_UPDATED.md new file mode 100644 index 00000000..4fd1ab40 --- /dev/null +++ b/wiki-information/events/CLUB_MEMBER_UPDATED.md @@ -0,0 +1,13 @@ +## Event: CLUB_MEMBER_UPDATED + +**Title:** CLUB MEMBER UPDATED + +**Content:** +Needs summary. +`CLUB_MEMBER_UPDATED: clubId, memberId` + +**Payload:** +- `clubId` + - *string* +- `memberId` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MESSAGE_ADDED.md b/wiki-information/events/CLUB_MESSAGE_ADDED.md new file mode 100644 index 00000000..77f800af --- /dev/null +++ b/wiki-information/events/CLUB_MESSAGE_ADDED.md @@ -0,0 +1,23 @@ +## Event: CLUB_MESSAGE_ADDED + +**Title:** CLUB MESSAGE ADDED + +**Content:** +Needs summary. +`CLUB_MESSAGE_ADDED: clubId, streamId, messageId` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* +- `messageId` + - *structure* - ClubMessageIdentifier + - ClubMessageIdentifier + - Field + - Type + - Description + - epoch + - *number* - number of microseconds since the UNIX epoch + - position + - *number* - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md b/wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md new file mode 100644 index 00000000..30ce3cab --- /dev/null +++ b/wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md @@ -0,0 +1,34 @@ +## Event: CLUB_MESSAGE_HISTORY_RECEIVED + +**Title:** CLUB MESSAGE HISTORY RECEIVED + +**Content:** +Needs summary. +`CLUB_MESSAGE_HISTORY_RECEIVED: clubId, streamId, downloadedRange, contiguousRange` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* +- `downloadedRange` + - ClubMessageRange - Range of history messages received. +- `contiguousRange` + - ClubMessageRange - Range of contiguous messages that the received messages are in. +- Field + - Type + - Description + - oldestMessageId + - ClubMessageIdentifier + - newestMessageId + - ClubMessageIdentifier + - ClubMessageIdentifier + - Field + - Type + - Description + - epoch + - number + - number of microseconds since the UNIX epoch + - position + - number + - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/events/CLUB_MESSAGE_UPDATED.md b/wiki-information/events/CLUB_MESSAGE_UPDATED.md new file mode 100644 index 00000000..8b894fa7 --- /dev/null +++ b/wiki-information/events/CLUB_MESSAGE_UPDATED.md @@ -0,0 +1,23 @@ +## Event: CLUB_MESSAGE_UPDATED + +**Title:** CLUB MESSAGE UPDATED + +**Content:** +Needs summary. +`CLUB_MESSAGE_UPDATED: clubId, streamId, messageId` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* +- `messageId` + - *structure* - ClubMessageIdentifier + - ClubMessageIdentifier + - Field + - Type + - Description + - epoch + - *number* - number of microseconds since the UNIX epoch + - position + - *number* - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/events/CLUB_REMOVED.md b/wiki-information/events/CLUB_REMOVED.md new file mode 100644 index 00000000..9d6439a3 --- /dev/null +++ b/wiki-information/events/CLUB_REMOVED.md @@ -0,0 +1,11 @@ +## Event: CLUB_REMOVED + +**Title:** CLUB REMOVED + +**Content:** +Needs summary. +`CLUB_REMOVED: clubId` + +**Payload:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_REMOVED_MESSAGE.md b/wiki-information/events/CLUB_REMOVED_MESSAGE.md new file mode 100644 index 00000000..84b1173b --- /dev/null +++ b/wiki-information/events/CLUB_REMOVED_MESSAGE.md @@ -0,0 +1,24 @@ +## Event: CLUB_REMOVED_MESSAGE + +**Title:** CLUB REMOVED MESSAGE + +**Content:** +Needs summary. +`CLUB_REMOVED_MESSAGE: clubName, clubRemovedReason` + +**Payload:** +- `clubName` + - *string* +- `clubRemovedReason` + - *number* - Enum.ClubRemovedReason + - Value + - Field + - Description + - 0 + - None + - 1 + - Banned + - 2 + - Removed + - 3 + - ClubDestroyed \ No newline at end of file diff --git a/wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md b/wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md new file mode 100644 index 00000000..01725bc2 --- /dev/null +++ b/wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md @@ -0,0 +1,13 @@ +## Event: CLUB_SELF_MEMBER_ROLE_UPDATED + +**Title:** CLUB SELF MEMBER ROLE UPDATED + +**Content:** +Needs summary. +`CLUB_SELF_MEMBER_ROLE_UPDATED: clubId, roleId` + +**Payload:** +- `clubId` + - *string* +- `roleId` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAMS_LOADED.md b/wiki-information/events/CLUB_STREAMS_LOADED.md new file mode 100644 index 00000000..5b06a9ee --- /dev/null +++ b/wiki-information/events/CLUB_STREAMS_LOADED.md @@ -0,0 +1,11 @@ +## Event: CLUB_STREAMS_LOADED + +**Title:** CLUB STREAMS LOADED + +**Content:** +Needs summary. +`CLUB_STREAMS_LOADED: clubId` + +**Payload:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_ADDED.md b/wiki-information/events/CLUB_STREAM_ADDED.md new file mode 100644 index 00000000..19b953e0 --- /dev/null +++ b/wiki-information/events/CLUB_STREAM_ADDED.md @@ -0,0 +1,13 @@ +## Event: CLUB_STREAM_ADDED + +**Title:** CLUB STREAM ADDED + +**Content:** +Needs summary. +`CLUB_STREAM_ADDED: clubId, streamId` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_REMOVED.md b/wiki-information/events/CLUB_STREAM_REMOVED.md new file mode 100644 index 00000000..c8662efa --- /dev/null +++ b/wiki-information/events/CLUB_STREAM_REMOVED.md @@ -0,0 +1,13 @@ +## Event: CLUB_STREAM_REMOVED + +**Title:** CLUB STREAM REMOVED + +**Content:** +Needs summary. +`CLUB_STREAM_REMOVED: clubId, streamId` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_SUBSCRIBED.md b/wiki-information/events/CLUB_STREAM_SUBSCRIBED.md new file mode 100644 index 00000000..b7983cb8 --- /dev/null +++ b/wiki-information/events/CLUB_STREAM_SUBSCRIBED.md @@ -0,0 +1,13 @@ +## Event: CLUB_STREAM_SUBSCRIBED + +**Title:** CLUB STREAM SUBSCRIBED + +**Content:** +Needs summary. +`CLUB_STREAM_SUBSCRIBED: clubId, streamId` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md b/wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md new file mode 100644 index 00000000..6bfc78db --- /dev/null +++ b/wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md @@ -0,0 +1,13 @@ +## Event: CLUB_STREAM_UNSUBSCRIBED + +**Title:** CLUB STREAM UNSUBSCRIBED + +**Content:** +Needs summary. +`CLUB_STREAM_UNSUBSCRIBED: clubId, streamId` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_UPDATED.md b/wiki-information/events/CLUB_STREAM_UPDATED.md new file mode 100644 index 00000000..fb85b0e9 --- /dev/null +++ b/wiki-information/events/CLUB_STREAM_UPDATED.md @@ -0,0 +1,13 @@ +## Event: CLUB_STREAM_UPDATED + +**Title:** CLUB STREAM UPDATED + +**Content:** +Needs summary. +`CLUB_STREAM_UPDATED: clubId, streamId` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_TICKETS_RECEIVED.md b/wiki-information/events/CLUB_TICKETS_RECEIVED.md new file mode 100644 index 00000000..e7b18a45 --- /dev/null +++ b/wiki-information/events/CLUB_TICKETS_RECEIVED.md @@ -0,0 +1,11 @@ +## Event: CLUB_TICKETS_RECEIVED + +**Title:** CLUB TICKETS RECEIVED + +**Content:** +Needs summary. +`CLUB_TICKETS_RECEIVED: clubId` + +**Payload:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_TICKET_CREATED.md b/wiki-information/events/CLUB_TICKET_CREATED.md new file mode 100644 index 00000000..54594989 --- /dev/null +++ b/wiki-information/events/CLUB_TICKET_CREATED.md @@ -0,0 +1,140 @@ +## Event: CLUB_TICKET_CREATED + +**Title:** CLUB TICKET CREATED + +**Content:** +Needs summary. +`CLUB_TICKET_CREATED: clubId, ticketInfo` + +**Payload:** +- `clubId` + - *string* +- `ticketInfo` + - *structure - ClubTicketInfo* + - *ClubTicketInfo* + - *Field* + - *Type* + - *Description* + - `ticketId` + - *string* + - `allowedRedeemCount` + - *number* + - `currentRedeemCount` + - *number* + - `creationTime` + - *number* + - *Creation time in microseconds since the UNIX epoch* + - `expirationTime` + - *number* + - *Expiration time in microseconds since the UNIX epoch* + - `defaultStreamId` + - *string?* + - `creator` + - *ClubMemberInfo* + - *ClubMemberInfo* + - *Field* + - *Type* + - *Description* + - `isSelf` + - *boolean* + - `memberId` + - *number* + - `name` + - *string?* + - *name may be encoded as a Kstring* + - `role` + - *Enum.ClubRoleIdentifier?* + - `presence` + - *Enum.ClubMemberPresence* + - `clubType` + - *Enum.ClubType?* + - `guid` + - *string?* + - `bnetAccountId` + - *number?* + - `memberNote` + - *string?* + - `officerNote` + - *string?* + - `classID` + - *number?* + - `race` + - *number?* + - `level` + - *number?* + - `zone` + - *string?* + - `achievementPoints` + - *number?* + - `profession1ID` + - *number?* + - `profession1Rank` + - *number?* + - `profession1Name` + - *string?* + - `profession2ID` + - *number?* + - `profession2Rank` + - *number?* + - `profession2Name` + - *string?* + - `lastOnlineYear` + - *number?* + - `lastOnlineMonth` + - *number?* + - `lastOnlineDay` + - *number?* + - `lastOnlineHour` + - *number?* + - `guildRank` + - *string?* + - `guildRankOrder` + - *number?* + - `isRemoteChat` + - *boolean?* + - `overallDungeonScore` + - *number?* + - *Added in 9.1.0* + - `faction` + - *Enum.PvPFaction?* + - *Added in 9.2.5* + - *Enum.ClubRoleIdentifier* + - *Value* + - *Field* + - *Description* + - `1` + - *Owner* + - `2` + - *Leader* + - `3` + - *Moderator* + - `4` + - *Member* + - *Enum.ClubMemberPresence* + - *Value* + - *Field* + - *Description* + - `0` + - *Unknown* + - `1` + - *Online* + - `2` + - *OnlineMobile* + - `3` + - *Offline* + - `4` + - *Away* + - `5` + - *Busy* + - *Enum.ClubType* + - *Value* + - *Field* + - *Description* + - `0` + - *BattleNet* + - `1` + - *Character* + - `2` + - *Guild* + - `3` + - *Other* \ No newline at end of file diff --git a/wiki-information/events/CLUB_TICKET_RECEIVED.md b/wiki-information/events/CLUB_TICKET_RECEIVED.md new file mode 100644 index 00000000..af475989 --- /dev/null +++ b/wiki-information/events/CLUB_TICKET_RECEIVED.md @@ -0,0 +1,11 @@ +## Event: CLUB_TICKET_RECEIVED + +**Title:** CLUB TICKET RECEIVED + +**Content:** +Needs summary. +`CLUB_TICKET_RECEIVED: ticket` + +**Payload:** +- `ticket` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_UPDATED.md b/wiki-information/events/CLUB_UPDATED.md new file mode 100644 index 00000000..445b762d --- /dev/null +++ b/wiki-information/events/CLUB_UPDATED.md @@ -0,0 +1,11 @@ +## Event: CLUB_UPDATED + +**Title:** CLUB UPDATED + +**Content:** +Needs summary. +`CLUB_UPDATED: clubId` + +**Payload:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/events/COMBAT_LOG_EVENT.md b/wiki-information/events/COMBAT_LOG_EVENT.md new file mode 100644 index 00000000..57077829 --- /dev/null +++ b/wiki-information/events/COMBAT_LOG_EVENT.md @@ -0,0 +1,220 @@ +## Event: COMBAT_LOG_EVENT + +**Title:** COMBAT LOG EVENT + +**Content:** +Fires for Combat Log events such as a player casting a spell or an NPC taking damage. +COMBAT_LOG_EVENT only reflects the filtered events in the combat log window +COMBAT_LOG_EVENT_UNFILTERED (CLEU) is unfiltered, making it preferred for use by addons. +Both events have identical parameters. The event payload is returned from CombatLogGetCurrentEventInfo(), or from CombatLogGetCurrentEntry() if selected using CombatLogSetCurrentEntry(). + +**Parameters & Values:** +- `1st Param` + - *timestamp* - Unix Time in seconds with milliseconds precision, for example 1555749627.861. Similar to time() and can be passed as the second argument of date(). +- `2nd Param` + - *subevent* - The combat log event, for example SPELL_DAMAGE. +- `3rd Param` + - *hideCaster* - boolean - Returns true if the source unit is hidden (an empty string). +- `4th Param` + - *sourceGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". +- `5th Param` + - *sourceName* - string - Name of the unit. +- `6th Param` + - *sourceFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. +- `7th Param` + - *sourceRaidFlags* - number - Contains the raid flag bits for a unit's raid target icon. For example 64 (0x40): Unit is marked with . +- `8th Param` + - *destGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". +- `9th Param` + - *destName* - string - Name of the unit. +- `10th Param` + - *destFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. + +**Payload:** +- This comparison illustrates the difference between swing and spell events, e.g. the amount suffix parameter is on arg12 for SWING_DAMAGE and arg15 for SPELL_DAMAGE. +- `1617986084.18, "SWING_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 3, -1, 1, nil, nil, nil, true, false, false, false` +- `1617986113.264, "SPELL_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 585, "Smite", 2, 47, 19, 2, nil, nil, nil, false, false, false, false` +- `SWING_DAMAGE` + - *Idx* + - *Param* + - *Value* + - *self* + - ** + - *event* + - *"COMBAT_LOG_EVENT_UNFILTERED"* + - *1* + - *timestamp* + - *1617986084.18* + - *2* + - *subevent* + - *"SWING_DAMAGE"* + - *3* + - *hideCaster* + - *false* + - *4* + - *sourceGUID* + - *"Player-1096-06DF65C1"* + - *5* + - *sourceName* + - *"Xiaohuli"* + - *6* + - *sourceFlags* + - *1297* + - *7* + - *sourceRaidFlags* + - *0* + - *8* + - *destGUID* + - *"Creature-0-4253-0-160-94-000070569B"* + - *9* + - *destName* + - *"Cutpurse"* + - *10* + - *destFlags* + - *68168* + - *11* + - *destRaidFlags* + - *0* + - *12* + - *amount* + - *3* + - *13* + *overkill* + - *-1* + - *14* + - *school* + - *1* + - *15* + *resisted* + - *nil* + - *16* + *blocked* + - *nil* + - *17* + *absorbed* + - *nil* + - *18* + *critical* + - *true* + - *19* + *glancing* + - *false* + - *20* + *crushing* + - *false* + - *21* + *isOffHand* + - *false* +- `SPELL_DAMAGE` + - *Idx* + - *Param* + - *Value* + - *self* + - ** + - *event* + - *"COMBAT_LOG_EVENT_UNFILTERED"* + - *1* + - *timestamp* + - *1617986113.264* + - *2* + - *subevent* + - *"SPELL_DAMAGE"* + - *3* + - *hideCaster* + - *false* + - *4* + - *sourceGUID* + - *"Player-1096-06DF65C1"* + - *5* + - *sourceName* + - *"Xiaohuli"* + - *6* + - *sourceFlags* + - *1297* + - *7* + - *sourceRaidFlags* + - *0* + - *8* + - *destGUID* + - *"Creature-0-4253-0-160-94-000070569B"* + - *9* + - *destName* + - *"Cutpurse"* + - *10* + - *destFlags* + - *68168* + - *11* + - *destRaidFlags* + - *0* + - *12* + - *spellId* + - *585* + - *13* + *spellName* + - *"Smite"* + - *14* + *spellSchool* + - *2* + - *15* + *amount* + - *47* + - *16* + *overkill* + - *19* + - *17* + *school* + - *2* + - *18* + *resisted* + - *nil* + - *19* + *blocked* + - *nil* + - *20* + *absorbed* + - *nil* + - *21* + *critical* + - *false* + - *22* + *glancing* + - *false* + - *23* + *crushing* + - *false* + - *24* + *isOffHand* + - *false* + +**Usage:** +- Script: + - Prints all CLEU parameters. + ```lua + local function OnEvent(self, event) + print(CombatLogGetCurrentEventInfo()) + end + local f = CreateFrame("Frame") + f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") + f:SetScript("OnEvent", OnEvent) + ``` + - Displays your spell or melee critical hits. + ```lua + local playerGUID = UnitGUID("player") + local MSG_CRITICAL_HIT = "Your %s critically hit %s for %d damage!" + local f = CreateFrame("Frame") + f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") + f:SetScript("OnEvent", function(self, event) + local _, subevent, _, sourceGUID, _, _, _, _, destName = CombatLogGetCurrentEventInfo() + local spellId, amount, critical + if subevent == "SWING_DAMAGE" then + amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) + elseif subevent == "SPELL_DAMAGE" then + spellId, _, _, amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) + end + if critical and sourceGUID == playerGUID then + -- get the link of the spell or the MELEE globalstring + local action = spellId and GetSpellLink(spellId) or MELEE + print(MSG_CRITICAL_HIT:format(action, destName, amount)) + end + }) + ``` \ No newline at end of file diff --git a/wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md b/wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md new file mode 100644 index 00000000..47a675c9 --- /dev/null +++ b/wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md @@ -0,0 +1,228 @@ +## Event: COMBAT_LOG_EVENT + +**Title:** COMBAT LOG EVENT + +**Content:** +Fires for Combat Log events such as a player casting a spell or an NPC taking damage. +COMBAT_LOG_EVENT only reflects the filtered events in the combat log window +COMBAT_LOG_EVENT_UNFILTERED (CLEU) is unfiltered, making it preferred for use by addons. +Both events have identical parameters. The event payload is returned from CombatLogGetCurrentEventInfo(), or from CombatLogGetCurrentEntry() if selected using CombatLogSetCurrentEntry(). + +**Parameters & Values:** +- `1st Param` + - *timestamp* - Unix Time in seconds with milliseconds precision, for example 1555749627.861. Similar to time() and can be passed as the second argument of date(). +- `2nd Param` + - *subevent* - The combat log event, for example SPELL_DAMAGE. +- `3rd Param` + - *hideCaster* - boolean - Returns true if the source unit is hidden (an empty string). +- `4th Param` + - *sourceGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". +- `5th Param` + - *sourceName* - string - Name of the unit. +- `6th Param` + - *sourceFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. +- `7th Param` + - *sourceRaidFlags* - number - Contains the raid flag bits for a unit's raid target icon. For example 64 (0x40): Unit is marked with . +- `8th Param` + - *destGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". +- `9th Param` + - *destName* - string - Name of the unit. +- `10th Param` + - *destFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. +- `11th Param` + - *destRaidFlags* - number - Contains the raid flag bits for a unit's raid target icon. For example 64 (0x40): Unit is marked with . + +**Payload:** +This comparison illustrates the difference between swing and spell events, e.g. the amount suffix parameter is on arg12 for SWING_DAMAGE and arg15 for SPELL_DAMAGE. +```lua +1617986084.18, "SWING_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 3, -1, 1, nil, nil, nil, true, false, false, false +1617986113.264, "SPELL_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 585, "Smite", 2, 47, 19, 2, nil, nil, nil, false, false, false, false +``` +- **SWING_DAMAGE** + - *Idx* - Param + - *Param* - Value + - *self* - + - *event* - "COMBAT_LOG_EVENT_UNFILTERED" + - *1* - *timestamp* - 1617986084.18 + - *2* - *subevent* - "SWING_DAMAGE" + - *3* - *hideCaster* - false + - *4* - *sourceGUID* - "Player-1096-06DF65C1" + - *5* - *sourceName* - "Xiaohuli" + - *6* - *sourceFlags* - 1297 + - *7* - *sourceRaidFlags* - 0 + - *8* - *destGUID* - "Creature-0-4253-0-160-94-000070569B" + - *9* - *destName* - "Cutpurse" + - *10* - *destFlags* - 68168 + - *11* - *destRaidFlags* - 0 + - *12* - *amount* - 3 + - *13* - *overkill* - -1 + - *14* - *school* - 1 + - *15* - *resisted* - nil + - *16* - *blocked* - nil + - *17* - *absorbed* - nil + - *18* - *critical* - true + - *19* - *glancing* - false + - *20* - *crushing* - false + - *21* - *isOffHand* - false + +- **SPELL_DAMAGE** + - *Idx* - Param + - *Param* - Value + - *self* - + - *event* - "COMBAT_LOG_EVENT_UNFILTERED" + - *1* - *timestamp* - 1617986113.264 + - *2* - *subevent* - "SPELL_DAMAGE" + - *3* - *hideCaster* - false + - *4* - *sourceGUID* - "Player-1096-06DF65C1" + - *5* - *sourceName* - "Xiaohuli" + - *6* - *sourceFlags* - 1297 + - *7* - *sourceRaidFlags* - 0 + - *8* - *destGUID* - "Creature-0-4253-0-160-94-000070569B" + - *9* - *destName* - "Cutpurse" + - *10* - *destFlags* - 68168 + - *11* - *destRaidFlags* - 0 + - *12* - *spellId* - 585 + - *13* - *spellName* - "Smite" + - *14* - *spellSchool* - 2 + - *15* - *amount* - 47 + - *16* - *overkill* - 19 + - *17* - *school* - 2 + - *18* - *resisted* - nil + - *19* - *blocked* - nil + - *20* - *absorbed* - nil + - *21* - *critical* - false + - *22* - *glancing* - false + - *23* - *crushing* - false + - *24* - *isOffHand* - false + +**Usage:** +Script: +Prints all CLEU parameters. +```lua +local function OnEvent(self, event) + print(CombatLogGetCurrentEventInfo()) +end +local f = CreateFrame("Frame") +f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") +f:SetScript("OnEvent", OnEvent) +``` +Displays your spell or melee critical hits. +```lua +local playerGUID = UnitGUID("player") +local MSG_CRITICAL_HIT = "Your %s critically hit %s for %d damage!" +local f = CreateFrame("Frame") +f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") +f:SetScript("OnEvent", function(self, event) + local _, subevent, _, sourceGUID, _, _, _, _, destName = CombatLogGetCurrentEventInfo() + local spellId, amount, critical + if subevent == "SWING_DAMAGE" then + amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) + elseif subevent == "SPELL_DAMAGE" then + spellId, _, _, amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) + end + if critical and sourceGUID == playerGUID then + -- get the link of the spell or the MELEE globalstring + local action = spellId and GetSpellLink(spellId) or MELEE + print(MSG_CRITICAL_HIT:format(action, destName, amount)) + end +end) +``` + +**Content Details:** +Event Trace: +For the new event trace tool added in Patch 9.1.0 the following script can be loaded. +```lua +local function LogEvent(self, event, ...) + if event == "COMBAT_LOG_EVENT_UNFILTERED" or event == "COMBAT_LOG_EVENT" then + self:LogEvent_Original(event, CombatLogGetCurrentEventInfo()) + elseif event == "COMBAT_TEXT_UPDATE" then + self:LogEvent_Original(event, (...), GetCurrentCombatTextEventInfo()) + else + self:LogEvent_Original(event, ...) + end +end +local function OnEventTraceLoaded() + EventTrace.LogEvent_Original = EventTrace.LogEvent + EventTrace.LogEvent = LogEvent +end +if EventTrace then + OnEventTraceLoaded() +else + local frame = CreateFrame("Frame") + frame:RegisterEvent("ADDON_LOADED") + frame:SetScript("OnEvent", function(self, event, ...) + if event == "ADDON_LOADED" and (...) == "Blizzard_EventTrace" then + OnEventTraceLoaded() + self:UnregisterAllEvents() + end + end) +end +``` +SPELL_ABSORBED: +This relatively new subevent fires in addition to SWING_MISSED / SPELL_MISSED which already have the "ABSORB" missType and same amount. It optionally includes the spell payload if triggered from what would be SPELL_DAMAGE. +```lua +timestamp, subevent, hideCaster, sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags, , casterGUID, casterName, casterFlags, casterRaidFlags, absorbSpellId, absorbSpellName, absorbSpellSchool, amount, critical +``` +-- swing +```lua +1620562047.156, "SWING_MISSED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, "ABSORB", false, 13, false +1620562047.156, "SPELL_ABSORBED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 17, "Power Word: Shield", 2, 13, false +-- spell +1620561974.121, "SPELL_MISSED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 83669, "Water Bolt", 16, "ABSORB", false, 15, false +1620561974.121, "SPELL_ABSORBED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 83669, "Water Bolt", 16, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 17, "Power Word: Shield", 2, 15, false +``` +SWING_DAMAGE +Idx +Param +Value +self + +event +"COMBAT_LOG_EVENT_UNFILTERED" +1 +timestamp +1617986084.18 +2 +subevent +"SWING_DAMAGE" +3 +hideCaster +false +4 +sourceGUID +"Player-1096-06DF65C1" +5 +sourceName +"Xiaohuli" +6 +sourceFlags +1297 +7 +sourceRaidFlags +0 +8 +destGUID +"Creature-0-4253-0-160-94-00006FB363" +9 +destName +"Cutpurse" +10 +destFlags +68168 +11 +destRaidFlags +0 +12 +amount +3 +13 +overkill +-1 +14 +school +1 +15 +resisted +nil +16 +blocked \ No newline at end of file diff --git a/wiki-information/events/COMBAT_RATING_UPDATE.md b/wiki-information/events/COMBAT_RATING_UPDATE.md new file mode 100644 index 00000000..11e74db7 --- /dev/null +++ b/wiki-information/events/COMBAT_RATING_UPDATE.md @@ -0,0 +1,10 @@ +## Event: COMBAT_RATING_UPDATE + +**Title:** COMBAT RATING UPDATE + +**Content:** +Needs summary. +`COMBAT_RATING_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMBAT_TEXT_UPDATE.md b/wiki-information/events/COMBAT_TEXT_UPDATE.md new file mode 100644 index 00000000..67721b37 --- /dev/null +++ b/wiki-information/events/COMBAT_TEXT_UPDATE.md @@ -0,0 +1,37 @@ +## Event: COMBAT_TEXT_UPDATE + +**Title:** COMBAT TEXT UPDATE + +**Content:** +Fired when the currently watched entity (as set by the CombatTextSetActiveUnit function) takes or avoids damage, receives heals, gains mana/energy/rage, etc. This event is used by Blizzard's floating combat text addon. +`COMBAT_TEXT_UPDATE: combatTextType` + +**Payload:** +- `combatTextType` + - *string* - Combat message type. Known values include + - "DAMAGE" + - "SPELL_DAMAGE" + - "DAMAGE_CRIT" + - "HEAL" + - "PERIODIC_HEAL" + - "HEAL_CRIT" + - "MISS" + - "DODGE" + - "PARRY" + - "BLOCK" + - "RESIST" + - "SPELL_RESISTED" + - "ABSORB" + - "SPELL_ABSORBED" + - "MANA" + - "ENERGY" + - "RAGE" + - "FOCUS" + - "SPELL_ACTIVE" + - "COMBO_POINTS" + - "AURA_START" + - "AURA_END" + - "AURA_START_HARMFUL" + - "AURA_END_HARMFUL" + - "HONOR_GAINED" + - "FACTION" \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_ENTER_WORLD.md b/wiki-information/events/COMMENTATOR_ENTER_WORLD.md new file mode 100644 index 00000000..b6762af5 --- /dev/null +++ b/wiki-information/events/COMMENTATOR_ENTER_WORLD.md @@ -0,0 +1,10 @@ +## Event: COMMENTATOR_ENTER_WORLD + +**Title:** COMMENTATOR ENTER WORLD + +**Content:** +Fired when the character logs in and the server sends the greeting text. (e.g. "Scammers are trying harder than ever to phish for your account information!..."). This is not fired when reloading the UI. +`COMMENTATOR_ENTER_WORLD` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md b/wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md new file mode 100644 index 00000000..5c28bc08 --- /dev/null +++ b/wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md @@ -0,0 +1,10 @@ +## Event: COMMENTATOR_HISTORY_FLUSHED + +**Title:** COMMENTATOR HISTORY FLUSHED + +**Content:** +Needs summary. +`COMMENTATOR_HISTORY_FLUSHED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md b/wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md new file mode 100644 index 00000000..531cc736 --- /dev/null +++ b/wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md @@ -0,0 +1,11 @@ +## Event: COMMENTATOR_IMMEDIATE_FOV_UPDATE + +**Title:** COMMENTATOR IMMEDIATE FOV UPDATE + +**Content:** +Needs summary. +`COMMENTATOR_IMMEDIATE_FOV_UPDATE: fov` + +**Payload:** +- `fov` + - *number* \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_MAP_UPDATE.md b/wiki-information/events/COMMENTATOR_MAP_UPDATE.md new file mode 100644 index 00000000..4b74d474 --- /dev/null +++ b/wiki-information/events/COMMENTATOR_MAP_UPDATE.md @@ -0,0 +1,10 @@ +## Event: COMMENTATOR_MAP_UPDATE + +**Title:** COMMENTATOR MAP UPDATE + +**Content:** +Needs summary. +`COMMENTATOR_MAP_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md b/wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md new file mode 100644 index 00000000..2909d43d --- /dev/null +++ b/wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md @@ -0,0 +1,13 @@ +## Event: COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE + +**Title:** COMMENTATOR PLAYER NAME OVERRIDE UPDATE + +**Content:** +Needs summary. +`COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE: nameToOverride, overrideName` + +**Payload:** +- `nameToOverride` + - *string* +- `overrideName` + - *string?* \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md b/wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md new file mode 100644 index 00000000..ae0316ff --- /dev/null +++ b/wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md @@ -0,0 +1,10 @@ +## Event: COMMENTATOR_PLAYER_UPDATE + +**Title:** COMMENTATOR PLAYER UPDATE + +**Content:** +Needs summary. +`COMMENTATOR_PLAYER_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_RESET_SETTINGS.md b/wiki-information/events/COMMENTATOR_RESET_SETTINGS.md new file mode 100644 index 00000000..a9351b8a --- /dev/null +++ b/wiki-information/events/COMMENTATOR_RESET_SETTINGS.md @@ -0,0 +1,10 @@ +## Event: COMMENTATOR_RESET_SETTINGS + +**Title:** COMMENTATOR RESET SETTINGS + +**Content:** +Needs summary. +`COMMENTATOR_RESET_SETTINGS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md b/wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md new file mode 100644 index 00000000..db8fe7be --- /dev/null +++ b/wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md @@ -0,0 +1,11 @@ +## Event: COMMENTATOR_TEAMS_SWAPPED + +**Title:** COMMENTATOR TEAMS SWAPPED + +**Content:** +Needs summary. +`COMMENTATOR_TEAMS_SWAPPED: swapped` + +**Payload:** +- `swapped` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md b/wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md new file mode 100644 index 00000000..24aeb060 --- /dev/null +++ b/wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md @@ -0,0 +1,11 @@ +## Event: COMMENTATOR_TEAM_NAME_UPDATE + +**Title:** COMMENTATOR TEAM NAME UPDATE + +**Content:** +Needs summary. +`COMMENTATOR_TEAM_NAME_UPDATE: teamName` + +**Payload:** +- `teamName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md b/wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md new file mode 100644 index 00000000..4646ef2e --- /dev/null +++ b/wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md @@ -0,0 +1,10 @@ +## Event: COMMUNITIES_STREAM_CURSOR_CLEAR + +**Title:** COMMUNITIES STREAM CURSOR CLEAR + +**Content:** +Needs summary. +`COMMUNITIES_STREAM_CURSOR_CLEAR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md b/wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md new file mode 100644 index 00000000..e09e908e --- /dev/null +++ b/wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md @@ -0,0 +1,10 @@ +## Event: COMPACT_UNIT_FRAME_PROFILES_LOADED + +**Title:** COMPACT UNIT FRAME PROFILES LOADED + +**Content:** +Needs summary. +`COMPACT_UNIT_FRAME_PROFILES_LOADED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPANION_LEARNED.md b/wiki-information/events/COMPANION_LEARNED.md new file mode 100644 index 00000000..dee57f18 --- /dev/null +++ b/wiki-information/events/COMPANION_LEARNED.md @@ -0,0 +1,10 @@ +## Event: COMPANION_LEARNED + +**Title:** COMPANION LEARNED + +**Content:** +Needs summary. +`COMPANION_LEARNED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPANION_UNLEARNED.md b/wiki-information/events/COMPANION_UNLEARNED.md new file mode 100644 index 00000000..570691bd --- /dev/null +++ b/wiki-information/events/COMPANION_UNLEARNED.md @@ -0,0 +1,10 @@ +## Event: COMPANION_UNLEARNED + +**Title:** COMPANION UNLEARNED + +**Content:** +Needs summary. +`COMPANION_UNLEARNED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPANION_UPDATE.md b/wiki-information/events/COMPANION_UPDATE.md new file mode 100644 index 00000000..6f7a6ece --- /dev/null +++ b/wiki-information/events/COMPANION_UPDATE.md @@ -0,0 +1,20 @@ +## Event: COMPANION_UPDATE + +**Title:** COMPANION UPDATE + +**Content:** +Fired when companion info updates. +`COMPANION_UPDATE: companionType` + +**Payload:** +- `companionType` + - *string?* + +**Content Details:** +If the type is nil, the UI should update if it's visible, regardless of which type it's managing. If the type is non-nil, then it will be either "CRITTER" or "MOUNT" and that signifies that the active companion has changed and the UI should update if it's currently showing that type. +"Range" appears to be at least 40 yards. If you are in a major city, expect this event to fire constantly. +This event fires when any of the following conditions occur: +- You, or anyone within range, summons or dismisses a critter +- You, or anyone within range, mounts or dismounts +- Someone enters range with a critter summoned +- Someone enters range while mounted \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_BEFORE_USE.md b/wiki-information/events/CONFIRM_BEFORE_USE.md new file mode 100644 index 00000000..7c9b2930 --- /dev/null +++ b/wiki-information/events/CONFIRM_BEFORE_USE.md @@ -0,0 +1,10 @@ +## Event: CONFIRM_BEFORE_USE + +**Title:** CONFIRM BEFORE USE + +**Content:** +Needs summary. +`CONFIRM_BEFORE_USE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_BINDER.md b/wiki-information/events/CONFIRM_BINDER.md new file mode 100644 index 00000000..2d5da455 --- /dev/null +++ b/wiki-information/events/CONFIRM_BINDER.md @@ -0,0 +1,11 @@ +## Event: CONFIRM_BINDER + +**Title:** CONFIRM BINDER + +**Content:** +Needs summary. +`CONFIRM_BINDER: areaName` + +**Payload:** +- `areaName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_LOOT_ROLL.md b/wiki-information/events/CONFIRM_LOOT_ROLL.md new file mode 100644 index 00000000..e59d9780 --- /dev/null +++ b/wiki-information/events/CONFIRM_LOOT_ROLL.md @@ -0,0 +1,18 @@ +## Event: CONFIRM_LOOT_ROLL + +**Title:** CONFIRM LOOT ROLL + +**Content:** +Fires when you try to roll "need" or "greed" for and item which Binds on Pickup. +`CONFIRM_LOOT_ROLL: rollID, rollType, confirmReason` + +**Payload:** +- `rollID` + - *number* +- `rollType` + - *number* - 1=Need, 2=Greed, 3=Disenchant +- `confirmReason` + - *string* + +**Related Information:** +RollOnLoot() \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_PET_UNLEARN.md b/wiki-information/events/CONFIRM_PET_UNLEARN.md new file mode 100644 index 00000000..b9774733 --- /dev/null +++ b/wiki-information/events/CONFIRM_PET_UNLEARN.md @@ -0,0 +1,11 @@ +## Event: CONFIRM_PET_UNLEARN + +**Title:** CONFIRM PET UNLEARN + +**Content:** +Needs summary. +`CONFIRM_PET_UNLEARN: cost` + +**Payload:** +- `cost` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_SUMMON.md b/wiki-information/events/CONFIRM_SUMMON.md new file mode 100644 index 00000000..e040008c --- /dev/null +++ b/wiki-information/events/CONFIRM_SUMMON.md @@ -0,0 +1,13 @@ +## Event: CONFIRM_SUMMON + +**Title:** CONFIRM SUMMON + +**Content:** +Needs summary. +`CONFIRM_SUMMON: summonReason, skippingStartExperience` + +**Payload:** +- `summonReason` + - *number* +- `skippingStartExperience` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_TALENT_WIPE.md b/wiki-information/events/CONFIRM_TALENT_WIPE.md new file mode 100644 index 00000000..990dd84b --- /dev/null +++ b/wiki-information/events/CONFIRM_TALENT_WIPE.md @@ -0,0 +1,13 @@ +## Event: CONFIRM_TALENT_WIPE + +**Title:** CONFIRM TALENT WIPE + +**Content:** +Fires when the user selects the "Yes, I do." confirmation prompt after speaking to a class trainer and choosing to unlearn their talents. +`CONFIRM_TALENT_WIPE: cost, respecType` + +**Payload:** +- `cost` + - *number* - Cost in copper. +- `respecType` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_XP_LOSS.md b/wiki-information/events/CONFIRM_XP_LOSS.md new file mode 100644 index 00000000..705ad4b5 --- /dev/null +++ b/wiki-information/events/CONFIRM_XP_LOSS.md @@ -0,0 +1,16 @@ +## Event: CONFIRM_XP_LOSS + +**Title:** CONFIRM XP LOSS + +**Content:** +Fired when the player wants to revive at the spirit healer. A durability loss will be taken in exchange for resurrecting. +`CONFIRM_XP_LOSS` + +**Payload:** +- `None` + +**Content Details:** +History: Way back before WoW was released, you lost experience rather than durability when you resurrected at a spirit healer. + +**Related Information:** +AcceptXPLoss() \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_CLEAR.md b/wiki-information/events/CONSOLE_CLEAR.md new file mode 100644 index 00000000..675c08e6 --- /dev/null +++ b/wiki-information/events/CONSOLE_CLEAR.md @@ -0,0 +1,10 @@ +## Event: CONSOLE_CLEAR + +**Title:** CONSOLE CLEAR + +**Content:** +Needs summary. +`CONSOLE_CLEAR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_COLORS_CHANGED.md b/wiki-information/events/CONSOLE_COLORS_CHANGED.md new file mode 100644 index 00000000..02385e50 --- /dev/null +++ b/wiki-information/events/CONSOLE_COLORS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: CONSOLE_COLORS_CHANGED + +**Title:** CONSOLE COLORS CHANGED + +**Content:** +Needs summary. +`CONSOLE_COLORS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md b/wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md new file mode 100644 index 00000000..f0b75c90 --- /dev/null +++ b/wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: CONSOLE_FONT_SIZE_CHANGED + +**Title:** CONSOLE FONT SIZE CHANGED + +**Content:** +Needs summary. +`CONSOLE_FONT_SIZE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_LOG.md b/wiki-information/events/CONSOLE_LOG.md new file mode 100644 index 00000000..0ca4f537 --- /dev/null +++ b/wiki-information/events/CONSOLE_LOG.md @@ -0,0 +1,11 @@ +## Event: CONSOLE_LOG + +**Title:** CONSOLE LOG + +**Content:** +Needs summary. +`CONSOLE_LOG: message` + +**Payload:** +- `message` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_MESSAGE.md b/wiki-information/events/CONSOLE_MESSAGE.md new file mode 100644 index 00000000..7fa6bad5 --- /dev/null +++ b/wiki-information/events/CONSOLE_MESSAGE.md @@ -0,0 +1,13 @@ +## Event: CONSOLE_MESSAGE + +**Title:** CONSOLE MESSAGE + +**Content:** +Needs summary. +`CONSOLE_MESSAGE: message, colorType` + +**Payload:** +- `message` + - *string* +- `colorType` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CORPSE_IN_INSTANCE.md b/wiki-information/events/CORPSE_IN_INSTANCE.md new file mode 100644 index 00000000..86117d2d --- /dev/null +++ b/wiki-information/events/CORPSE_IN_INSTANCE.md @@ -0,0 +1,10 @@ +## Event: CORPSE_IN_INSTANCE + +**Title:** CORPSE IN INSTANCE + +**Content:** +Needs summary. +`CORPSE_IN_INSTANCE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CORPSE_IN_RANGE.md b/wiki-information/events/CORPSE_IN_RANGE.md new file mode 100644 index 00000000..aab693d6 --- /dev/null +++ b/wiki-information/events/CORPSE_IN_RANGE.md @@ -0,0 +1,10 @@ +## Event: CORPSE_IN_RANGE + +**Title:** CORPSE IN RANGE + +**Content:** +Fired when the player is in range of his body. +`CORPSE_IN_RANGE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CORPSE_OUT_OF_RANGE.md b/wiki-information/events/CORPSE_OUT_OF_RANGE.md new file mode 100644 index 00000000..e81c227e --- /dev/null +++ b/wiki-information/events/CORPSE_OUT_OF_RANGE.md @@ -0,0 +1,10 @@ +## Event: CORPSE_OUT_OF_RANGE + +**Title:** CORPSE OUT OF RANGE + +**Content:** +Fired when the player is out of range of his body. +`CORPSE_OUT_OF_RANGE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CRAFT_CLOSE.md b/wiki-information/events/CRAFT_CLOSE.md new file mode 100644 index 00000000..d83e3a40 --- /dev/null +++ b/wiki-information/events/CRAFT_CLOSE.md @@ -0,0 +1,10 @@ +## Event: CRAFT_CLOSE + +**Title:** CRAFT CLOSE + +**Content:** +Fired when a crafting skill window closes. +`CRAFT_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CRAFT_SHOW.md b/wiki-information/events/CRAFT_SHOW.md new file mode 100644 index 00000000..26b7c952 --- /dev/null +++ b/wiki-information/events/CRAFT_SHOW.md @@ -0,0 +1,10 @@ +## Event: CRAFT_SHOW + +**Title:** CRAFT SHOW + +**Content:** +Fired when a crafting skill window opens. +`CRAFT_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CRAFT_UPDATE.md b/wiki-information/events/CRAFT_UPDATE.md new file mode 100644 index 00000000..57a9edff --- /dev/null +++ b/wiki-information/events/CRAFT_UPDATE.md @@ -0,0 +1,10 @@ +## Event: CRAFT_UPDATE + +**Title:** CRAFT UPDATE + +**Content:** +Fired when a crafting event is updating. +`CRAFT_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CRITERIA_COMPLETE.md b/wiki-information/events/CRITERIA_COMPLETE.md new file mode 100644 index 00000000..812e3a49 --- /dev/null +++ b/wiki-information/events/CRITERIA_COMPLETE.md @@ -0,0 +1,11 @@ +## Event: CRITERIA_COMPLETE + +**Title:** CRITERIA COMPLETE + +**Content:** +Needs summary. +`CRITERIA_COMPLETE: criteriaID` + +**Payload:** +- `criteriaID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CRITERIA_EARNED.md b/wiki-information/events/CRITERIA_EARNED.md new file mode 100644 index 00000000..c55de994 --- /dev/null +++ b/wiki-information/events/CRITERIA_EARNED.md @@ -0,0 +1,13 @@ +## Event: CRITERIA_EARNED + +**Title:** CRITERIA EARNED + +**Content:** +Needs summary. +`CRITERIA_EARNED: achievementID, description` + +**Payload:** +- `achievementID` + - *number* +- `description` + - *string* \ No newline at end of file diff --git a/wiki-information/events/CRITERIA_UPDATE.md b/wiki-information/events/CRITERIA_UPDATE.md new file mode 100644 index 00000000..c432f406 --- /dev/null +++ b/wiki-information/events/CRITERIA_UPDATE.md @@ -0,0 +1,13 @@ +## Event: CRITERIA_UPDATE + +**Title:** CRITERIA UPDATE + +**Content:** +Fired when the criteria for an achievement has changed. +`CRITERIA_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +Fires several times at once, presumably for different levels of achievements and yet-unknown feats of strength, but this has yet to be confirmed and there may be another use for this event. \ No newline at end of file diff --git a/wiki-information/events/CURRENCY_DISPLAY_UPDATE.md b/wiki-information/events/CURRENCY_DISPLAY_UPDATE.md new file mode 100644 index 00000000..2a342adc --- /dev/null +++ b/wiki-information/events/CURRENCY_DISPLAY_UPDATE.md @@ -0,0 +1,19 @@ +## Event: CURRENCY_DISPLAY_UPDATE + +**Title:** CURRENCY DISPLAY UPDATE + +**Content:** +Needs summary. +`CURRENCY_DISPLAY_UPDATE: currencyType, quantity, quantityChange, quantityGainSource, quantityLostSource` + +**Payload:** +- `currencyType` + - *number?* +- `quantity` + - *number?* +- `quantityChange` + - *number?* +- `quantityGainSource` + - *number?* +- `quantityLostSource` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md b/wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md new file mode 100644 index 00000000..7f7efa92 --- /dev/null +++ b/wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md @@ -0,0 +1,11 @@ +## Event: CURRENT_SPELL_CAST_CHANGED + +**Title:** CURRENT SPELL CAST CHANGED + +**Content:** +Fired when the spell being cast is changed. +`CURRENT_SPELL_CAST_CHANGED: cancelledCast` + +**Payload:** +- `cancelledCast` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CURSOR_CHANGED.md b/wiki-information/events/CURSOR_CHANGED.md new file mode 100644 index 00000000..2ba8f1ee --- /dev/null +++ b/wiki-information/events/CURSOR_CHANGED.md @@ -0,0 +1,40 @@ +## Event: CURSOR_CHANGED + +**Title:** CURSOR CHANGED + +**Content:** +Fires when the cursor changes. Includes information on the previous and new cursor type (e.g. item, money, spells). +`CURSOR_CHANGED: isDefault, newCursorType, oldCursorType, oldCursorVirtualID` + +**Payload:** +- `isDefault` + - *boolean* +- `newCursorType` + - *Enum.UICursorType* +- `oldCursorType` + - *Enum.UICursorType* + - *Value* - *Field* - *Description* + - 0 - Default + - 1 - Item + - 2 - Money + - 3 - Spell + - 4 - PetAction + - 5 - Merchant + - 6 - ActionBar + - 7 - Macro + - 9 - AmmoObsolete + - 10 - Pet + - 11 - GuildBank + - 12 - GuildBankMoney + - 13 - EquipmentSet + - 14 - Currency + - 15 - Flyout + - 16 - VoidItem + - 17 - BattlePet + - 18 - Mount + - 19 - Toy + - 20 - ConduitCollectionItem + - 21 - PerksProgramVendorItem + - Added in 10.0.5 +- `oldCursorVirtualID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/CURSOR_UPDATE.md b/wiki-information/events/CURSOR_UPDATE.md new file mode 100644 index 00000000..8eb7c1b4 --- /dev/null +++ b/wiki-information/events/CURSOR_UPDATE.md @@ -0,0 +1,10 @@ +## Event: CURSOR_UPDATE + +**Title:** CURSOR UPDATE + +**Content:** +Fired when the player right-clicks terrain, and on mouseover before UPDATE_MOUSEOVER_UNIT and on mouseout after UPDATE_MOUSEOVER_UNIT. This excludes doodads, player characters, and NPCs that lack interaction. +`CURSOR_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/CVAR_UPDATE.md b/wiki-information/events/CVAR_UPDATE.md new file mode 100644 index 00000000..3dd99ee1 --- /dev/null +++ b/wiki-information/events/CVAR_UPDATE.md @@ -0,0 +1,13 @@ +## Event: CVAR_UPDATE + +**Title:** CVAR UPDATE + +**Content:** +Fires when changing console variables with an optional argument to C_CVar.SetCVar(). +`CVAR_UPDATE: eventName, value` + +**Payload:** +- `eventName` + - *string* - The optional argument used with C_CVar.SetCVar(). +- `value` + - *string* - The new value of the console variable. \ No newline at end of file diff --git a/wiki-information/events/DELETE_ITEM_CONFIRM.md b/wiki-information/events/DELETE_ITEM_CONFIRM.md new file mode 100644 index 00000000..f446c3f8 --- /dev/null +++ b/wiki-information/events/DELETE_ITEM_CONFIRM.md @@ -0,0 +1,17 @@ +## Event: DELETE_ITEM_CONFIRM + +**Title:** DELETE ITEM CONFIRM + +**Content:** +Fired when the player attempts to destroy an item. +`DELETE_ITEM_CONFIRM: itemName, qualityID, bonding, questWarn` + +**Payload:** +- `itemName` + - *string* +- `qualityID` + - *number* +- `bonding` + - *number* +- `questWarn` + - *number* \ No newline at end of file diff --git a/wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md b/wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md new file mode 100644 index 00000000..bd6ba453 --- /dev/null +++ b/wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md @@ -0,0 +1,10 @@ +## Event: DISABLE_DECLINE_GUILD_INVITE + +**Title:** DISABLE DECLINE GUILD INVITE + +**Content:** +Needs summary. +`DISABLE_DECLINE_GUILD_INVITE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DISABLE_LOW_LEVEL_RAID.md b/wiki-information/events/DISABLE_LOW_LEVEL_RAID.md new file mode 100644 index 00000000..32e3fa64 --- /dev/null +++ b/wiki-information/events/DISABLE_LOW_LEVEL_RAID.md @@ -0,0 +1,10 @@ +## Event: DISABLE_LOW_LEVEL_RAID + +**Title:** DISABLE LOW LEVEL RAID + +**Content:** +Fired when SetAllowLowLevelRaid is used to disable low-level raids on the character. +`DISABLE_LOW_LEVEL_RAID` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DISABLE_TAXI_BENCHMARK.md b/wiki-information/events/DISABLE_TAXI_BENCHMARK.md new file mode 100644 index 00000000..10fb6424 --- /dev/null +++ b/wiki-information/events/DISABLE_TAXI_BENCHMARK.md @@ -0,0 +1,10 @@ +## Event: DISABLE_TAXI_BENCHMARK + +**Title:** DISABLE TAXI BENCHMARK + +**Content:** +Needs summary. +`DISABLE_TAXI_BENCHMARK` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DISABLE_XP_GAIN.md b/wiki-information/events/DISABLE_XP_GAIN.md new file mode 100644 index 00000000..96b467a7 --- /dev/null +++ b/wiki-information/events/DISABLE_XP_GAIN.md @@ -0,0 +1,10 @@ +## Event: DISABLE_XP_GAIN + +**Title:** DISABLE XP GAIN + +**Content:** +Needs summary. +`DISABLE_XP_GAIN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DISPLAY_SIZE_CHANGED.md b/wiki-information/events/DISPLAY_SIZE_CHANGED.md new file mode 100644 index 00000000..53acbcb3 --- /dev/null +++ b/wiki-information/events/DISPLAY_SIZE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: DISPLAY_SIZE_CHANGED + +**Title:** DISPLAY SIZE CHANGED + +**Content:** +Needs summary. +`DISPLAY_SIZE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_FINISHED.md b/wiki-information/events/DUEL_FINISHED.md new file mode 100644 index 00000000..947f0fad --- /dev/null +++ b/wiki-information/events/DUEL_FINISHED.md @@ -0,0 +1,10 @@ +## Event: DUEL_FINISHED + +**Title:** DUEL FINISHED + +**Content:** +Fired when a duel is finished. +`DUEL_FINISHED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_INBOUNDS.md b/wiki-information/events/DUEL_INBOUNDS.md new file mode 100644 index 00000000..f3a71e91 --- /dev/null +++ b/wiki-information/events/DUEL_INBOUNDS.md @@ -0,0 +1,10 @@ +## Event: DUEL_INBOUNDS + +**Title:** DUEL INBOUNDS + +**Content:** +Fired when the player returns in bounds after being out of bounds during a duel. +`DUEL_INBOUNDS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_OUTOFBOUNDS.md b/wiki-information/events/DUEL_OUTOFBOUNDS.md new file mode 100644 index 00000000..1f9943ec --- /dev/null +++ b/wiki-information/events/DUEL_OUTOFBOUNDS.md @@ -0,0 +1,10 @@ +## Event: DUEL_OUTOFBOUNDS + +**Title:** DUEL OUTOFBOUNDS + +**Content:** +Fired when the player leaves the bounds of the duel +`DUEL_OUTOFBOUNDS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_REQUESTED.md b/wiki-information/events/DUEL_REQUESTED.md new file mode 100644 index 00000000..8d533256 --- /dev/null +++ b/wiki-information/events/DUEL_REQUESTED.md @@ -0,0 +1,11 @@ +## Event: DUEL_REQUESTED + +**Title:** DUEL REQUESTED + +**Content:** +Fired when the player is challenged to a duel. +`DUEL_REQUESTED: playerName` + +**Payload:** +- `playerName` + - *string* - opponent name \ No newline at end of file diff --git a/wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md b/wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md new file mode 100644 index 00000000..83554bab --- /dev/null +++ b/wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md @@ -0,0 +1,19 @@ +## Event: DYNAMIC_GOSSIP_POI_UPDATED + +**Title:** DYNAMIC GOSSIP POI UPDATED + +**Content:** +Fired after asking guards in major cities for directions to a point of interest, causing the small red flag to be positioned on the world map and minimap (or to disappear when no longer needed). +`DYNAMIC_GOSSIP_POI_UPDATED` + +**Payload:** +- `None` + +**Content Details:** +Maps do not normally need to track this event if they have already acquired the GossipDataProvider or an equivalent +Custom replacements for GossipDataProvider could use this event to trigger RefreshAllData() + +**Related Information:** +- GossipDataProvider.lua where this event is used to update the world map, archived at townlong-yak. +- C_GossipInfo.GetGossipPoiForUiMapID - provides a pointer that may be passed to GetGossipPoiInfo() for a given uiMapID +- C_GossipInfo.GetGossipPoiInfo - provides information about where a given gossip pin (usually a red flag) should appear on the given uiMapID \ No newline at end of file diff --git a/wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md b/wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md new file mode 100644 index 00000000..9f59e857 --- /dev/null +++ b/wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md @@ -0,0 +1,10 @@ +## Event: ENABLE_DECLINE_GUILD_INVITE + +**Title:** ENABLE DECLINE GUILD INVITE + +**Content:** +Needs summary. +`ENABLE_DECLINE_GUILD_INVITE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ENABLE_LOW_LEVEL_RAID.md b/wiki-information/events/ENABLE_LOW_LEVEL_RAID.md new file mode 100644 index 00000000..c8ece994 --- /dev/null +++ b/wiki-information/events/ENABLE_LOW_LEVEL_RAID.md @@ -0,0 +1,10 @@ +## Event: ENABLE_LOW_LEVEL_RAID + +**Title:** ENABLE LOW LEVEL RAID + +**Content:** +Fired when SetAllowLowLevelRaid is used to enable low-level raids on the character. +`ENABLE_LOW_LEVEL_RAID` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ENABLE_TAXI_BENCHMARK.md b/wiki-information/events/ENABLE_TAXI_BENCHMARK.md new file mode 100644 index 00000000..ff948905 --- /dev/null +++ b/wiki-information/events/ENABLE_TAXI_BENCHMARK.md @@ -0,0 +1,10 @@ +## Event: ENABLE_TAXI_BENCHMARK + +**Title:** ENABLE TAXI BENCHMARK + +**Content:** +Needs summary. +`ENABLE_TAXI_BENCHMARK` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ENABLE_XP_GAIN.md b/wiki-information/events/ENABLE_XP_GAIN.md new file mode 100644 index 00000000..c149eaf6 --- /dev/null +++ b/wiki-information/events/ENABLE_XP_GAIN.md @@ -0,0 +1,10 @@ +## Event: ENABLE_XP_GAIN + +**Title:** ENABLE XP GAIN + +**Content:** +Needs summary. +`ENABLE_XP_GAIN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ENCOUNTER_END.md b/wiki-information/events/ENCOUNTER_END.md new file mode 100644 index 00000000..2d35f3a1 --- /dev/null +++ b/wiki-information/events/ENCOUNTER_END.md @@ -0,0 +1,19 @@ +## Event: ENCOUNTER_END + +**Title:** ENCOUNTER END + +**Content:** +Fires at the end of an instanced encounter. +`ENCOUNTER_END: encounterID, encounterName, difficultyID, groupSize, success` + +**Payload:** +- `encounterID` + - *number* - ID for the specific encounter that ended. (Does not match the encounterIDs used in the Encounter Journal) +- `encounterName` + - *string* - Name of the encounter that ended +- `difficultyID` + - *number* - ID representing the difficulty of the encounter +- `groupSize` + - *number* - Group size for the encounter. For example, 5 for a Dungeon encounter, 20 for a Mythic raid. The number of raiders participating is reflected in "flex" raids. +- `success` + - *number* - 1 for a successful kill. 0 for a wipe \ No newline at end of file diff --git a/wiki-information/events/ENCOUNTER_START.md b/wiki-information/events/ENCOUNTER_START.md new file mode 100644 index 00000000..9e8abbff --- /dev/null +++ b/wiki-information/events/ENCOUNTER_START.md @@ -0,0 +1,17 @@ +## Event: ENCOUNTER_START + +**Title:** ENCOUNTER START + +**Content:** +Fires at the start of an instanced encounter. +`ENCOUNTER_START: encounterID, encounterName, difficultyID, groupSize` + +**Payload:** +- `encounterID` + - *number* - ID for the specific encounter started. +- `encounterName` + - *string* - Name of the encounter started +- `difficultyID` + - *number* - ID representing the difficulty of the encounter +- `groupSize` + - *number* - Group size for the encounter. For example, 5 for a Dungeon encounter, 20 for a Mythic raid. The number of raiders participating is reflected in "flex" raids. \ No newline at end of file diff --git a/wiki-information/events/END_BOUND_TRADEABLE.md b/wiki-information/events/END_BOUND_TRADEABLE.md new file mode 100644 index 00000000..d9ba53a7 --- /dev/null +++ b/wiki-information/events/END_BOUND_TRADEABLE.md @@ -0,0 +1,11 @@ +## Event: END_BOUND_TRADEABLE + +**Title:** END BOUND TRADEABLE + +**Content:** +Needs summary. +`END_BOUND_TRADEABLE: reason` + +**Payload:** +- `reason` + - *string* \ No newline at end of file diff --git a/wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md b/wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md new file mode 100644 index 00000000..fa1c8170 --- /dev/null +++ b/wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md @@ -0,0 +1,10 @@ +## Event: ENTERED_DIFFERENT_INSTANCE_FROM_PARTY + +**Title:** ENTERED DIFFERENT INSTANCE FROM PARTY + +**Content:** +Needs summary. +`ENTERED_DIFFERENT_INSTANCE_FROM_PARTY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ENTITLEMENT_DELIVERED.md b/wiki-information/events/ENTITLEMENT_DELIVERED.md new file mode 100644 index 00000000..695f0587 --- /dev/null +++ b/wiki-information/events/ENTITLEMENT_DELIVERED.md @@ -0,0 +1,33 @@ +## Event: ENTITLEMENT_DELIVERED + +**Title:** ENTITLEMENT DELIVERED + +**Content:** +Needs summary. +`ENTITLEMENT_DELIVERED: entitlementType, textureID, name, payloadID, showFancyToast` + +**Payload:** +- `entitlementType` + - *number* - Enum.WoWEntitlementType +- `textureID` + - *number* +- `name` + - *string* +- `payloadID` + - *number?* +- `showFancyToast` + - *boolean* + + Enum.WoWEntitlementType + | Value | Field | Description | + |-------|-------------|--------------| + | 0 | Item | | + | 1 | Mount | | + | 2 | Battlepet | | + | 3 | Toy | | + | 4 | Appearance | | + | 5 | AppearanceSet| | + | 6 | GameTime | | + | 7 | Title | | + | 8 | Illusion | | + | 9 | Invalid | | \ No newline at end of file diff --git a/wiki-information/events/EQUIPMENT_SETS_CHANGED.md b/wiki-information/events/EQUIPMENT_SETS_CHANGED.md new file mode 100644 index 00000000..5a961dda --- /dev/null +++ b/wiki-information/events/EQUIPMENT_SETS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: EQUIPMENT_SETS_CHANGED + +**Title:** EQUIPMENT SETS CHANGED + +**Content:** +Fired when a new equipment set is created, an equipment set is deleted or an equipment set has changed. +`EQUIPMENT_SETS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/EQUIPMENT_SWAP_FINISHED.md b/wiki-information/events/EQUIPMENT_SWAP_FINISHED.md new file mode 100644 index 00000000..c6859fae --- /dev/null +++ b/wiki-information/events/EQUIPMENT_SWAP_FINISHED.md @@ -0,0 +1,13 @@ +## Event: EQUIPMENT_SWAP_FINISHED + +**Title:** EQUIPMENT SWAP FINISHED + +**Content:** +Fired when an equipment set has finished equipping. +`EQUIPMENT_SWAP_FINISHED: result, setID` + +**Payload:** +- `result` + - *boolean* - True if the set change was successful +- `setID` + - *number?* - The ID of the set that was changed. \ No newline at end of file diff --git a/wiki-information/events/EQUIPMENT_SWAP_PENDING.md b/wiki-information/events/EQUIPMENT_SWAP_PENDING.md new file mode 100644 index 00000000..cf36cfd1 --- /dev/null +++ b/wiki-information/events/EQUIPMENT_SWAP_PENDING.md @@ -0,0 +1,10 @@ +## Event: EQUIPMENT_SWAP_PENDING + +**Title:** EQUIPMENT SWAP PENDING + +**Content:** +Needs summary. +`EQUIPMENT_SWAP_PENDING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/EQUIP_BIND_CONFIRM.md b/wiki-information/events/EQUIP_BIND_CONFIRM.md new file mode 100644 index 00000000..e8bf090a --- /dev/null +++ b/wiki-information/events/EQUIP_BIND_CONFIRM.md @@ -0,0 +1,11 @@ +## Event: EQUIP_BIND_CONFIRM + +**Title:** EQUIP BIND CONFIRM + +**Content:** +Fired when the player attempts to equip bind on equip loot. +`EQUIP_BIND_CONFIRM: slot` + +**Payload:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md b/wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md new file mode 100644 index 00000000..e999fdbf --- /dev/null +++ b/wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md @@ -0,0 +1,11 @@ +## Event: EQUIP_BIND_REFUNDABLE_CONFIRM + +**Title:** EQUIP BIND REFUNDABLE CONFIRM + +**Content:** +Needs summary. +`EQUIP_BIND_REFUNDABLE_CONFIRM: slot` + +**Payload:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md b/wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md new file mode 100644 index 00000000..9661b749 --- /dev/null +++ b/wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md @@ -0,0 +1,11 @@ +## Event: EQUIP_BIND_TRADEABLE_CONFIRM + +**Title:** EQUIP BIND TRADEABLE CONFIRM + +**Content:** +Needs summary. +`EQUIP_BIND_TRADEABLE_CONFIRM: slot` + +**Payload:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/EXECUTE_CHAT_LINE.md b/wiki-information/events/EXECUTE_CHAT_LINE.md new file mode 100644 index 00000000..d7eec219 --- /dev/null +++ b/wiki-information/events/EXECUTE_CHAT_LINE.md @@ -0,0 +1,11 @@ +## Event: EXECUTE_CHAT_LINE + +**Title:** EXECUTE CHAT LINE + +**Content:** +Fired to execute macro commands. +`EXECUTE_CHAT_LINE: chatLine` + +**Payload:** +- `chatLine` + - *string* - The macro text body to execute. \ No newline at end of file diff --git a/wiki-information/events/FIRST_FRAME_RENDERED.md b/wiki-information/events/FIRST_FRAME_RENDERED.md new file mode 100644 index 00000000..092a18be --- /dev/null +++ b/wiki-information/events/FIRST_FRAME_RENDERED.md @@ -0,0 +1,10 @@ +## Event: FIRST_FRAME_RENDERED + +**Title:** FIRST FRAME RENDERED + +**Content:** +Needs summary. +`FIRST_FRAME_RENDERED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md b/wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md new file mode 100644 index 00000000..f67c5e56 --- /dev/null +++ b/wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md @@ -0,0 +1,11 @@ +## Event: FORBIDDEN_NAME_PLATE_CREATED + +**Title:** FORBIDDEN NAME PLATE CREATED + +**Content:** +Needs summary. +`FORBIDDEN_NAME_PLATE_CREATED: namePlateFrame` + +**Payload:** +- `namePlateFrame` + - *table* \ No newline at end of file diff --git a/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md b/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md new file mode 100644 index 00000000..464ca705 --- /dev/null +++ b/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md @@ -0,0 +1,11 @@ +## Event: FORBIDDEN_NAME_PLATE_UNIT_ADDED + +**Title:** FORBIDDEN NAME PLATE UNIT ADDED + +**Content:** +Needs summary. +`FORBIDDEN_NAME_PLATE_UNIT_ADDED: unitToken` + +**Payload:** +- `unitToken` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md b/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md new file mode 100644 index 00000000..7898b059 --- /dev/null +++ b/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md @@ -0,0 +1,11 @@ +## Event: FORBIDDEN_NAME_PLATE_UNIT_REMOVED + +**Title:** FORBIDDEN NAME PLATE UNIT REMOVED + +**Content:** +Needs summary. +`FORBIDDEN_NAME_PLATE_UNIT_REMOVED: unitToken` + +**Payload:** +- `unitToken` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/FRIENDLIST_UPDATE.md b/wiki-information/events/FRIENDLIST_UPDATE.md new file mode 100644 index 00000000..5e6cac97 --- /dev/null +++ b/wiki-information/events/FRIENDLIST_UPDATE.md @@ -0,0 +1,21 @@ +## Event: FRIENDLIST_UPDATE + +**Title:** FRIENDLIST UPDATE + +**Content:** +Needs summary. +`FRIENDLIST_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +Fired when... +- You log in +- Open the friends window (twice) +- Switch from the ignore list to the friend's list +- Switch from the guild, raid, or who tab back to the friends tab (twice) +- Add a friend +- Remove a friend +- Friend comes online +- Friend goes offline \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md b/wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md new file mode 100644 index 00000000..9d111e72 --- /dev/null +++ b/wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: GAME_PAD_ACTIVE_CHANGED + +**Title:** GAME PAD ACTIVE CHANGED + +**Content:** +Needs summary. +`GAME_PAD_ACTIVE_CHANGED: isActive` + +**Payload:** +- `isActive` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md b/wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md new file mode 100644 index 00000000..ba62b206 --- /dev/null +++ b/wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: GAME_PAD_CONFIGS_CHANGED + +**Title:** GAME PAD CONFIGS CHANGED + +**Content:** +Fired when the stored configurations for gamepads are changed. +`GAME_PAD_CONFIGS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_CONNECTED.md b/wiki-information/events/GAME_PAD_CONNECTED.md new file mode 100644 index 00000000..5f864e88 --- /dev/null +++ b/wiki-information/events/GAME_PAD_CONNECTED.md @@ -0,0 +1,10 @@ +## Event: GAME_PAD_CONNECTED + +**Title:** GAME PAD CONNECTED + +**Content:** +Fired when a gamepad is initially connected to the host system. +`GAME_PAD_CONNECTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_DISCONNECTED.md b/wiki-information/events/GAME_PAD_DISCONNECTED.md new file mode 100644 index 00000000..3814c6e6 --- /dev/null +++ b/wiki-information/events/GAME_PAD_DISCONNECTED.md @@ -0,0 +1,10 @@ +## Event: GAME_PAD_DISCONNECTED + +**Title:** GAME PAD DISCONNECTED + +**Content:** +Fired when a gamepad is disconnected from the host system. +`GAME_PAD_DISCONNECTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_POWER_CHANGED.md b/wiki-information/events/GAME_PAD_POWER_CHANGED.md new file mode 100644 index 00000000..59a3ba4a --- /dev/null +++ b/wiki-information/events/GAME_PAD_POWER_CHANGED.md @@ -0,0 +1,20 @@ +## Event: GAME_PAD_POWER_CHANGED + +**Title:** GAME PAD POWER CHANGED + +**Content:** +Needs summary. +`GAME_PAD_POWER_CHANGED: powerLevel` + +**Payload:** +- `powerLevel` + - *GamePadPowerLevel* + - *Value* + - *Field* + - *Description* + - 0 - Critical + - 1 - Low + - 2 - Medium + - 3 - High + - 4 - Wired + - 5 - Unknown \ No newline at end of file diff --git a/wiki-information/events/GDF_SIM_COMPLETE.md b/wiki-information/events/GDF_SIM_COMPLETE.md new file mode 100644 index 00000000..36671e2e --- /dev/null +++ b/wiki-information/events/GDF_SIM_COMPLETE.md @@ -0,0 +1,10 @@ +## Event: GDF_SIM_COMPLETE + +**Title:** GDF SIM COMPLETE + +**Content:** +Needs summary. +`GDF_SIM_COMPLETE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GENERIC_ERROR.md b/wiki-information/events/GENERIC_ERROR.md new file mode 100644 index 00000000..03c85b0d --- /dev/null +++ b/wiki-information/events/GENERIC_ERROR.md @@ -0,0 +1,11 @@ +## Event: GENERIC_ERROR + +**Title:** GENERIC ERROR + +**Content:** +Needs summary. +`GENERIC_ERROR: errorMessage` + +**Payload:** +- `errorMessage` + - *string* \ No newline at end of file diff --git a/wiki-information/events/GET_ITEM_INFO_RECEIVED.md b/wiki-information/events/GET_ITEM_INFO_RECEIVED.md new file mode 100644 index 00000000..4dc9aedf --- /dev/null +++ b/wiki-information/events/GET_ITEM_INFO_RECEIVED.md @@ -0,0 +1,15 @@ +## Event: GET_ITEM_INFO_RECEIVED + +**Title:** GET ITEM INFO RECEIVED + +**Content:** +Fired when GetItemInfo queries the server for an uncached item and the response has arrived. +`GET_ITEM_INFO_RECEIVED: itemID, success` + +**Payload:** +- `itemID` + - *number* - The Item ID of the received item info. +- `success` + - *boolean* - Returns true if the item was successfully queried from the server. + - Returns false if the item can't be queried from the server. + - Returns nil if the item doesn't exist. \ No newline at end of file diff --git a/wiki-information/events/GLOBAL_MOUSE_DOWN.md b/wiki-information/events/GLOBAL_MOUSE_DOWN.md new file mode 100644 index 00000000..b095ac99 --- /dev/null +++ b/wiki-information/events/GLOBAL_MOUSE_DOWN.md @@ -0,0 +1,11 @@ +## Event: GLOBAL_MOUSE_DOWN + +**Title:** GLOBAL MOUSE DOWN + +**Content:** +Fires whenever you press a mouse button. +`GLOBAL_MOUSE_DOWN: button` + +**Payload:** +- `button` + - *string* : LeftButton, RightButton, MiddleButton, Button4, Button5 \ No newline at end of file diff --git a/wiki-information/events/GLOBAL_MOUSE_UP.md b/wiki-information/events/GLOBAL_MOUSE_UP.md new file mode 100644 index 00000000..91066da0 --- /dev/null +++ b/wiki-information/events/GLOBAL_MOUSE_UP.md @@ -0,0 +1,11 @@ +## Event: GLOBAL_MOUSE_UP + +**Title:** GLOBAL MOUSE UP + +**Content:** +Fires whenever a mouse button gets released. +`GLOBAL_MOUSE_UP: button` + +**Payload:** +- `button` + - *string* - LeftButton, RightButton, MiddleButton, Button4, Button5 \ No newline at end of file diff --git a/wiki-information/events/GLUE_CONSOLE_LOG.md b/wiki-information/events/GLUE_CONSOLE_LOG.md new file mode 100644 index 00000000..cadb21ea --- /dev/null +++ b/wiki-information/events/GLUE_CONSOLE_LOG.md @@ -0,0 +1,11 @@ +## Event: GLUE_CONSOLE_LOG + +**Title:** GLUE CONSOLE LOG + +**Content:** +Needs summary. +`GLUE_CONSOLE_LOG: message` + +**Payload:** +- `message` + - *string* \ No newline at end of file diff --git a/wiki-information/events/GLUE_SCREENSHOT_FAILED.md b/wiki-information/events/GLUE_SCREENSHOT_FAILED.md new file mode 100644 index 00000000..52333b75 --- /dev/null +++ b/wiki-information/events/GLUE_SCREENSHOT_FAILED.md @@ -0,0 +1,10 @@ +## Event: GLUE_SCREENSHOT_FAILED + +**Title:** GLUE SCREENSHOT FAILED + +**Content:** +Needs summary. +`GLUE_SCREENSHOT_FAILED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GM_PLAYER_INFO.md b/wiki-information/events/GM_PLAYER_INFO.md new file mode 100644 index 00000000..de26a41c --- /dev/null +++ b/wiki-information/events/GM_PLAYER_INFO.md @@ -0,0 +1,13 @@ +## Event: GM_PLAYER_INFO + +**Title:** GM PLAYER INFO + +**Content:** +Needs summary. +`GM_PLAYER_INFO: name, info` + +**Payload:** +- `name` + - *string* +- `info` + - *string* \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_CLOSED.md b/wiki-information/events/GOSSIP_CLOSED.md new file mode 100644 index 00000000..58aebe02 --- /dev/null +++ b/wiki-information/events/GOSSIP_CLOSED.md @@ -0,0 +1,10 @@ +## Event: GOSSIP_CLOSED + +**Title:** GOSSIP CLOSED + +**Content:** +Fired when you close the talk window for an npc. (Seems to be called twice) +`GOSSIP_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_CONFIRM.md b/wiki-information/events/GOSSIP_CONFIRM.md new file mode 100644 index 00000000..8cd6163d --- /dev/null +++ b/wiki-information/events/GOSSIP_CONFIRM.md @@ -0,0 +1,15 @@ +## Event: GOSSIP_CONFIRM + +**Title:** GOSSIP CONFIRM + +**Content:** +Needs summary. +`GOSSIP_CONFIRM: gossipID, text, cost` + +**Payload:** +- `gossipID` + - *number* +- `text` + - *string* +- `cost` + - *number* \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_CONFIRM_CANCEL.md b/wiki-information/events/GOSSIP_CONFIRM_CANCEL.md new file mode 100644 index 00000000..0c3cee91 --- /dev/null +++ b/wiki-information/events/GOSSIP_CONFIRM_CANCEL.md @@ -0,0 +1,10 @@ +## Event: GOSSIP_CONFIRM_CANCEL + +**Title:** GOSSIP CONFIRM CANCEL + +**Content:** +Needs summary. +`GOSSIP_CONFIRM_CANCEL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_ENTER_CODE.md b/wiki-information/events/GOSSIP_ENTER_CODE.md new file mode 100644 index 00000000..be0b1b1d --- /dev/null +++ b/wiki-information/events/GOSSIP_ENTER_CODE.md @@ -0,0 +1,11 @@ +## Event: GOSSIP_ENTER_CODE + +**Title:** GOSSIP ENTER CODE + +**Content:** +Needs summary. +`GOSSIP_ENTER_CODE: gossipID` + +**Payload:** +- `gossipID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_SHOW.md b/wiki-information/events/GOSSIP_SHOW.md new file mode 100644 index 00000000..5e7eca52 --- /dev/null +++ b/wiki-information/events/GOSSIP_SHOW.md @@ -0,0 +1,14 @@ +## Event: GOSSIP_SHOW + +**Title:** GOSSIP SHOW + +**Content:** +Fires when you talk to an npc. +`GOSSIP_SHOW: uiTextureKit` + +**Payload:** +- `uiTextureKit` + - *string?* + +**Content Details:** +This event typicaly fires when you are given several choices, including choosing to sell item, select available and active quests, just talk about something, or bind to a location. Even when the the only available choices are quests, this event is often used instead of QUEST_GREETING. \ No newline at end of file diff --git a/wiki-information/events/GROUP_FORMED.md b/wiki-information/events/GROUP_FORMED.md new file mode 100644 index 00000000..ab98ab67 --- /dev/null +++ b/wiki-information/events/GROUP_FORMED.md @@ -0,0 +1,13 @@ +## Event: GROUP_FORMED + +**Title:** GROUP FORMED + +**Content:** +Needs summary. +`GROUP_FORMED: category, partyGUID` + +**Payload:** +- `category` + - *number* +- `partyGUID` + - *string* \ No newline at end of file diff --git a/wiki-information/events/GROUP_INVITE_CONFIRMATION.md b/wiki-information/events/GROUP_INVITE_CONFIRMATION.md new file mode 100644 index 00000000..7cd1586a --- /dev/null +++ b/wiki-information/events/GROUP_INVITE_CONFIRMATION.md @@ -0,0 +1,10 @@ +## Event: GROUP_INVITE_CONFIRMATION + +**Title:** GROUP INVITE CONFIRMATION + +**Content:** +Needs summary. +`GROUP_INVITE_CONFIRMATION` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GROUP_JOINED.md b/wiki-information/events/GROUP_JOINED.md new file mode 100644 index 00000000..a947a978 --- /dev/null +++ b/wiki-information/events/GROUP_JOINED.md @@ -0,0 +1,13 @@ +## Event: GROUP_JOINED + +**Title:** GROUP JOINED + +**Content:** +Fired when the player enters a group. +`GROUP_JOINED: category, partyGUID` + +**Payload:** +- `category` + - *number* +- `partyGUID` + - *string* \ No newline at end of file diff --git a/wiki-information/events/GROUP_LEFT.md b/wiki-information/events/GROUP_LEFT.md new file mode 100644 index 00000000..6a2279df --- /dev/null +++ b/wiki-information/events/GROUP_LEFT.md @@ -0,0 +1,13 @@ +## Event: GROUP_LEFT + +**Title:** GROUP LEFT + +**Content:** +Needs summary. +`GROUP_LEFT: category, partyGUID` + +**Payload:** +- `category` + - *number* +- `partyGUID` + - *string* \ No newline at end of file diff --git a/wiki-information/events/GROUP_ROSTER_UPDATE.md b/wiki-information/events/GROUP_ROSTER_UPDATE.md new file mode 100644 index 00000000..228bffad --- /dev/null +++ b/wiki-information/events/GROUP_ROSTER_UPDATE.md @@ -0,0 +1,10 @@ +## Event: GROUP_ROSTER_UPDATE + +**Title:** GROUP ROSTER UPDATE + +**Content:** +Fired whenever a group or raid is formed or disbanded, players are leaving or joining the group or raid. +`GROUP_ROSTER_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md b/wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md new file mode 100644 index 00000000..8d834f81 --- /dev/null +++ b/wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: GUILDBANKBAGSLOTS_CHANGED + +**Title:** GUILDBANKBAGSLOTS CHANGED + +**Content:** +Fired when the guild-bank contents change. +`GUILDBANKBAGSLOTS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKFRAME_CLOSED.md b/wiki-information/events/GUILDBANKFRAME_CLOSED.md new file mode 100644 index 00000000..2dc38b04 --- /dev/null +++ b/wiki-information/events/GUILDBANKFRAME_CLOSED.md @@ -0,0 +1,10 @@ +## Event: GUILDBANKFRAME_CLOSED + +**Title:** GUILDBANKFRAME CLOSED + +**Content:** +Fired when the guild-bank frame is closed. +`GUILDBANKFRAME_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKFRAME_OPENED.md b/wiki-information/events/GUILDBANKFRAME_OPENED.md new file mode 100644 index 00000000..9628110d --- /dev/null +++ b/wiki-information/events/GUILDBANKFRAME_OPENED.md @@ -0,0 +1,10 @@ +## Event: GUILDBANKFRAME_OPENED + +**Title:** GUILDBANKFRAME OPENED + +**Content:** +Fired when the guild-bank frame is opened. +`GUILDBANKFRAME_OPENED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKLOG_UPDATE.md b/wiki-information/events/GUILDBANKLOG_UPDATE.md new file mode 100644 index 00000000..86919409 --- /dev/null +++ b/wiki-information/events/GUILDBANKLOG_UPDATE.md @@ -0,0 +1,10 @@ +## Event: GUILDBANKLOG_UPDATE + +**Title:** GUILDBANKLOG UPDATE + +**Content:** +Fired when the guild-bank log is updated. +`GUILDBANKLOG_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md b/wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md new file mode 100644 index 00000000..8d4d4577 --- /dev/null +++ b/wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md @@ -0,0 +1,10 @@ +## Event: GUILDBANK_ITEM_LOCK_CHANGED + +**Title:** GUILDBANK ITEM LOCK CHANGED + +**Content:** +Needs summary. +`GUILDBANK_ITEM_LOCK_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_TEXT_CHANGED.md b/wiki-information/events/GUILDBANK_TEXT_CHANGED.md new file mode 100644 index 00000000..7534af02 --- /dev/null +++ b/wiki-information/events/GUILDBANK_TEXT_CHANGED.md @@ -0,0 +1,11 @@ +## Event: GUILDBANK_TEXT_CHANGED + +**Title:** GUILDBANK TEXT CHANGED + +**Content:** +Needs summary. +`GUILDBANK_TEXT_CHANGED: guildBankTab` + +**Payload:** +- `guildBankTab` + - *number* \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_MONEY.md b/wiki-information/events/GUILDBANK_UPDATE_MONEY.md new file mode 100644 index 00000000..5c235133 --- /dev/null +++ b/wiki-information/events/GUILDBANK_UPDATE_MONEY.md @@ -0,0 +1,10 @@ +## Event: GUILDBANK_UPDATE_MONEY + +**Title:** GUILDBANK UPDATE MONEY + +**Content:** +Needs summary. +`GUILDBANK_UPDATE_MONEY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_TABS.md b/wiki-information/events/GUILDBANK_UPDATE_TABS.md new file mode 100644 index 00000000..098ee965 --- /dev/null +++ b/wiki-information/events/GUILDBANK_UPDATE_TABS.md @@ -0,0 +1,10 @@ +## Event: GUILDBANK_UPDATE_TABS + +**Title:** GUILDBANK UPDATE TABS + +**Content:** +Needs summary. +`GUILDBANK_UPDATE_TABS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_TEXT.md b/wiki-information/events/GUILDBANK_UPDATE_TEXT.md new file mode 100644 index 00000000..371d87c3 --- /dev/null +++ b/wiki-information/events/GUILDBANK_UPDATE_TEXT.md @@ -0,0 +1,11 @@ +## Event: GUILDBANK_UPDATE_TEXT + +**Title:** GUILDBANK UPDATE TEXT + +**Content:** +Needs summary. +`GUILDBANK_UPDATE_TEXT: guildBankTab` + +**Payload:** +- `guildBankTab` + - *number* \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md b/wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md new file mode 100644 index 00000000..d45b4fd9 --- /dev/null +++ b/wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md @@ -0,0 +1,10 @@ +## Event: GUILDBANK_UPDATE_WITHDRAWMONEY + +**Title:** GUILDBANK UPDATE WITHDRAWMONEY + +**Content:** +Needs summary. +`GUILDBANK_UPDATE_WITHDRAWMONEY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDTABARD_UPDATE.md b/wiki-information/events/GUILDTABARD_UPDATE.md new file mode 100644 index 00000000..593a4195 --- /dev/null +++ b/wiki-information/events/GUILDTABARD_UPDATE.md @@ -0,0 +1,10 @@ +## Event: GUILDTABARD_UPDATE + +**Title:** GUILDTABARD UPDATE + +**Content:** +Needs summary. +`GUILDTABARD_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_EVENT_LOG_UPDATE.md b/wiki-information/events/GUILD_EVENT_LOG_UPDATE.md new file mode 100644 index 00000000..69d85100 --- /dev/null +++ b/wiki-information/events/GUILD_EVENT_LOG_UPDATE.md @@ -0,0 +1,10 @@ +## Event: GUILD_EVENT_LOG_UPDATE + +**Title:** GUILD EVENT LOG UPDATE + +**Content:** +Needs summary. +`GUILD_EVENT_LOG_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_INVITE_CANCEL.md b/wiki-information/events/GUILD_INVITE_CANCEL.md new file mode 100644 index 00000000..1175ecf7 --- /dev/null +++ b/wiki-information/events/GUILD_INVITE_CANCEL.md @@ -0,0 +1,10 @@ +## Event: GUILD_INVITE_CANCEL + +**Title:** GUILD INVITE CANCEL + +**Content:** +Fired when the guild invitation is declined. +`GUILD_INVITE_CANCEL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_INVITE_REQUEST.md b/wiki-information/events/GUILD_INVITE_REQUEST.md new file mode 100644 index 00000000..5aacd83b --- /dev/null +++ b/wiki-information/events/GUILD_INVITE_REQUEST.md @@ -0,0 +1,35 @@ +## Event: GUILD_INVITE_REQUEST + +**Title:** GUILD INVITE REQUEST + +**Content:** +Fires when you are invited to join a guild. +`GUILD_INVITE_REQUEST: inviter, guildName, guildAchievementPoints, oldGuildName, isNewGuild, tabardInfo` + +**Payload:** +- `inviter` + - *string* +- `guildName` + - *string* +- `guildAchievementPoints` + - *number* +- `oldGuildName` + - *string* +- `isNewGuild` + - *boolean?* +- `tabardInfo` + - *GuildTabardInfo* + - Field + - Type + - Description + - `backgroundColor` + - *ColorMixin* 📗 + - `borderColor` + - *ColorMixin* 📗 + - `emblemColor` + - *ColorMixin* 📗 + - `emblemFileID` + - *number* + - GuildEmblem.db2 + - `emblemStyle` + - *number* \ No newline at end of file diff --git a/wiki-information/events/GUILD_MOTD.md b/wiki-information/events/GUILD_MOTD.md new file mode 100644 index 00000000..32b76c2d --- /dev/null +++ b/wiki-information/events/GUILD_MOTD.md @@ -0,0 +1,11 @@ +## Event: GUILD_MOTD + +**Title:** GUILD MOTD + +**Content:** +Fired when the guild messages of the day is shown. +`GUILD_MOTD: motdText` + +**Payload:** +- `motdText` + - *string* \ No newline at end of file diff --git a/wiki-information/events/GUILD_PARTY_STATE_UPDATED.md b/wiki-information/events/GUILD_PARTY_STATE_UPDATED.md new file mode 100644 index 00000000..2f57c74a --- /dev/null +++ b/wiki-information/events/GUILD_PARTY_STATE_UPDATED.md @@ -0,0 +1,11 @@ +## Event: GUILD_PARTY_STATE_UPDATED + +**Title:** GUILD PARTY STATE UPDATED + +**Content:** +Needs summary. +`GUILD_PARTY_STATE_UPDATED: inGuildParty` + +**Payload:** +- `inGuildParty` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/GUILD_RANKS_UPDATE.md b/wiki-information/events/GUILD_RANKS_UPDATE.md new file mode 100644 index 00000000..ca613d90 --- /dev/null +++ b/wiki-information/events/GUILD_RANKS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: GUILD_RANKS_UPDATE + +**Title:** GUILD RANKS UPDATE + +**Content:** +Fired when any changes are made to ranks or rank permission flags. +`GUILD_RANKS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_REGISTRAR_CLOSED.md b/wiki-information/events/GUILD_REGISTRAR_CLOSED.md new file mode 100644 index 00000000..24cc6bb6 --- /dev/null +++ b/wiki-information/events/GUILD_REGISTRAR_CLOSED.md @@ -0,0 +1,10 @@ +## Event: GUILD_REGISTRAR_CLOSED + +**Title:** GUILD REGISTRAR CLOSED + +**Content:** +Needs summary. +`GUILD_REGISTRAR_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_REGISTRAR_SHOW.md b/wiki-information/events/GUILD_REGISTRAR_SHOW.md new file mode 100644 index 00000000..fc66a9ff --- /dev/null +++ b/wiki-information/events/GUILD_REGISTRAR_SHOW.md @@ -0,0 +1,10 @@ +## Event: GUILD_REGISTRAR_SHOW + +**Title:** GUILD REGISTRAR SHOW + +**Content:** +Needs summary. +`GUILD_REGISTRAR_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_RENAME_REQUIRED.md b/wiki-information/events/GUILD_RENAME_REQUIRED.md new file mode 100644 index 00000000..cb983150 --- /dev/null +++ b/wiki-information/events/GUILD_RENAME_REQUIRED.md @@ -0,0 +1,11 @@ +## Event: GUILD_RENAME_REQUIRED + +**Title:** GUILD RENAME REQUIRED + +**Content:** +Needs summary. +`GUILD_RENAME_REQUIRED: flagSet` + +**Payload:** +- `flagSet` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/GUILD_ROSTER_UPDATE.md b/wiki-information/events/GUILD_ROSTER_UPDATE.md new file mode 100644 index 00000000..1281faf0 --- /dev/null +++ b/wiki-information/events/GUILD_ROSTER_UPDATE.md @@ -0,0 +1,15 @@ +## Event: GUILD_ROSTER_UPDATE + +**Title:** GUILD ROSTER UPDATE + +**Content:** +Fired when the client's guild info cache has been updated after a call to GuildRoster or after any data change in any of the guild's data, excluding the Guild Information window. +`GUILD_ROSTER_UPDATE: canRequestRosterUpdate` + +**Payload:** +- `canRequestRosterUpdate` + - *boolean* + +**Content Details:** +Related API +C_GuildInfo.GuildRoster • GetGuildRosterInfo \ No newline at end of file diff --git a/wiki-information/events/GX_RESTARTED.md b/wiki-information/events/GX_RESTARTED.md new file mode 100644 index 00000000..043ad616 --- /dev/null +++ b/wiki-information/events/GX_RESTARTED.md @@ -0,0 +1,10 @@ +## Event: GX_RESTARTED + +**Title:** GX RESTARTED + +**Content:** +Needs summary. +`GX_RESTARTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/HEARTHSTONE_BOUND.md b/wiki-information/events/HEARTHSTONE_BOUND.md new file mode 100644 index 00000000..1540ba44 --- /dev/null +++ b/wiki-information/events/HEARTHSTONE_BOUND.md @@ -0,0 +1,10 @@ +## Event: HEARTHSTONE_BOUND + +**Title:** HEARTHSTONE BOUND + +**Content:** +Needs summary. +`HEARTHSTONE_BOUND` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/HEIRLOOMS_UPDATED.md b/wiki-information/events/HEIRLOOMS_UPDATED.md new file mode 100644 index 00000000..af2658f4 --- /dev/null +++ b/wiki-information/events/HEIRLOOMS_UPDATED.md @@ -0,0 +1,15 @@ +## Event: HEIRLOOMS_UPDATED + +**Title:** HEIRLOOMS UPDATED + +**Content:** +Needs summary. +`HEIRLOOMS_UPDATED: itemID, updateReason, hideUntilLearned` + +**Payload:** +- `itemID` + - *number?* +- `updateReason` + - *string?* +- `hideUntilLearned` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md b/wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md new file mode 100644 index 00000000..9516d85f --- /dev/null +++ b/wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md @@ -0,0 +1,11 @@ +## Event: HEIRLOOM_UPGRADE_TARGETING_CHANGED + +**Title:** HEIRLOOM UPGRADE TARGETING CHANGED + +**Content:** +Fires when heirloom buttons in the Heirloom Journal are clicked. +`HEIRLOOM_UPGRADE_TARGETING_CHANGED: pendingHeirloomUpgradeSpellcast` + +**Payload:** +- `pendingHeirloomUpgradeSpellcast` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/HIDE_SUBTITLE.md b/wiki-information/events/HIDE_SUBTITLE.md new file mode 100644 index 00000000..1aca0623 --- /dev/null +++ b/wiki-information/events/HIDE_SUBTITLE.md @@ -0,0 +1,10 @@ +## Event: HIDE_SUBTITLE + +**Title:** HIDE SUBTITLE + +**Content:** +Needs summary. +`HIDE_SUBTITLE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/IGNORELIST_UPDATE.md b/wiki-information/events/IGNORELIST_UPDATE.md new file mode 100644 index 00000000..838491dd --- /dev/null +++ b/wiki-information/events/IGNORELIST_UPDATE.md @@ -0,0 +1,10 @@ +## Event: IGNORELIST_UPDATE + +**Title:** IGNORELIST UPDATE + +**Content:** +Fires twice when a player is added or removed from the ignore list. +`IGNORELIST_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INCOMING_RESURRECT_CHANGED.md b/wiki-information/events/INCOMING_RESURRECT_CHANGED.md new file mode 100644 index 00000000..bcc100cf --- /dev/null +++ b/wiki-information/events/INCOMING_RESURRECT_CHANGED.md @@ -0,0 +1,11 @@ +## Event: INCOMING_RESURRECT_CHANGED + +**Title:** INCOMING RESURRECT CHANGED + +**Content:** +Needs summary. +`INCOMING_RESURRECT_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/INITIAL_CLUBS_LOADED.md b/wiki-information/events/INITIAL_CLUBS_LOADED.md new file mode 100644 index 00000000..d25c47a1 --- /dev/null +++ b/wiki-information/events/INITIAL_CLUBS_LOADED.md @@ -0,0 +1,10 @@ +## Event: INITIAL_CLUBS_LOADED + +**Title:** INITIAL CLUBS LOADED + +**Content:** +Needs summary. +`INITIAL_CLUBS_LOADED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INITIAL_HOTFIXES_APPLIED.md b/wiki-information/events/INITIAL_HOTFIXES_APPLIED.md new file mode 100644 index 00000000..3025426a --- /dev/null +++ b/wiki-information/events/INITIAL_HOTFIXES_APPLIED.md @@ -0,0 +1,10 @@ +## Event: INITIAL_HOTFIXES_APPLIED + +**Title:** INITIAL HOTFIXES APPLIED + +**Content:** +Needs summary. +`INITIAL_HOTFIXES_APPLIED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSPECT_ACHIEVEMENT_READY.md b/wiki-information/events/INSPECT_ACHIEVEMENT_READY.md new file mode 100644 index 00000000..b7f98b26 --- /dev/null +++ b/wiki-information/events/INSPECT_ACHIEVEMENT_READY.md @@ -0,0 +1,15 @@ +## Event: INSPECT_ACHIEVEMENT_READY + +**Title:** INSPECT ACHIEVEMENT READY + +**Content:** +Information about the comparison unit has been downloaded and may now be acessed using GetAchievementComparisonInfo(). +`INSPECT_ACHIEVEMENT_READY: guid` + +**Payload:** +- `guid` + - *string* - Reference to the player character for whom achievement info is now ready + +**Related Information:** +- SetAchievementComparisonUnit +- GetNumComparisonCompletedAchievements \ No newline at end of file diff --git a/wiki-information/events/INSPECT_HONOR_UPDATE.md b/wiki-information/events/INSPECT_HONOR_UPDATE.md new file mode 100644 index 00000000..311be4b7 --- /dev/null +++ b/wiki-information/events/INSPECT_HONOR_UPDATE.md @@ -0,0 +1,10 @@ +## Event: INSPECT_HONOR_UPDATE + +**Title:** INSPECT HONOR UPDATE + +**Content:** +Needs summary. +`INSPECT_HONOR_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSPECT_READY.md b/wiki-information/events/INSPECT_READY.md new file mode 100644 index 00000000..5356e6bf --- /dev/null +++ b/wiki-information/events/INSPECT_READY.md @@ -0,0 +1,14 @@ +## Event: INSPECT_READY + +**Title:** INSPECT READY + +**Content:** +Indicates inspect info is now ready. +`INSPECT_READY: inspecteeGUID` + +**Payload:** +- `inspecteeGUID` + - *string* - GUID of the unit being inspected. + +**Content Details:** +Follows NotifyInspect() once details are asynchronously downloaded. \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_BOOT_START.md b/wiki-information/events/INSTANCE_BOOT_START.md new file mode 100644 index 00000000..9492a665 --- /dev/null +++ b/wiki-information/events/INSTANCE_BOOT_START.md @@ -0,0 +1,10 @@ +## Event: INSTANCE_BOOT_START + +**Title:** INSTANCE BOOT START + +**Content:** +Fired when the countdown to boot a player from an instance starts. +`INSTANCE_BOOT_START` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_BOOT_STOP.md b/wiki-information/events/INSTANCE_BOOT_STOP.md new file mode 100644 index 00000000..18f101f1 --- /dev/null +++ b/wiki-information/events/INSTANCE_BOOT_STOP.md @@ -0,0 +1,10 @@ +## Event: INSTANCE_BOOT_STOP + +**Title:** INSTANCE BOOT STOP + +**Content:** +Fired when the countdown to boot a player from an instance stops. +`INSTANCE_BOOT_STOP` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md b/wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md new file mode 100644 index 00000000..47c0d65e --- /dev/null +++ b/wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md @@ -0,0 +1,11 @@ +## Event: INSTANCE_ENCOUNTER_ADD_TIMER + +**Title:** INSTANCE ENCOUNTER ADD TIMER + +**Content:** +Needs summary. +`INSTANCE_ENCOUNTER_ADD_TIMER: timeRemaining` + +**Payload:** +- `timeRemaining` + - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md b/wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md new file mode 100644 index 00000000..d4ac00b8 --- /dev/null +++ b/wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md @@ -0,0 +1,10 @@ +## Event: INSTANCE_ENCOUNTER_ENGAGE_UNIT + +**Title:** INSTANCE ENCOUNTER ENGAGE UNIT + +**Content:** +Needs summary. +`INSTANCE_ENCOUNTER_ENGAGE_UNIT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md new file mode 100644 index 00000000..195b1fdb --- /dev/null +++ b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md @@ -0,0 +1,11 @@ +## Event: INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE + +**Title:** INSTANCE ENCOUNTER OBJECTIVE COMPLETE + +**Content:** +Needs summary. +`INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE: objectiveID` + +**Payload:** +- `objectiveID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md new file mode 100644 index 00000000..a251d81c --- /dev/null +++ b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md @@ -0,0 +1,13 @@ +## Event: INSTANCE_ENCOUNTER_OBJECTIVE_START + +**Title:** INSTANCE ENCOUNTER OBJECTIVE START + +**Content:** +Needs summary. +`INSTANCE_ENCOUNTER_OBJECTIVE_START: objectiveID, objectiveProgress` + +**Payload:** +- `objectiveID` + - *number* +- `objectiveProgress` + - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md new file mode 100644 index 00000000..d8d4fc14 --- /dev/null +++ b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md @@ -0,0 +1,13 @@ +## Event: INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE + +**Title:** INSTANCE ENCOUNTER OBJECTIVE UPDATE + +**Content:** +Needs summary. +`INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE: objectiveID, objectiveProgress` + +**Payload:** +- `objectiveID` + - *number* +- `objectiveProgress` + - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md b/wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md new file mode 100644 index 00000000..b8be954d --- /dev/null +++ b/wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: INSTANCE_GROUP_SIZE_CHANGED + +**Title:** INSTANCE GROUP SIZE CHANGED + +**Content:** +Needs summary. +`INSTANCE_GROUP_SIZE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_LOCK_START.md b/wiki-information/events/INSTANCE_LOCK_START.md new file mode 100644 index 00000000..fb68a456 --- /dev/null +++ b/wiki-information/events/INSTANCE_LOCK_START.md @@ -0,0 +1,10 @@ +## Event: INSTANCE_LOCK_START + +**Title:** INSTANCE LOCK START + +**Content:** +Needs summary. +`INSTANCE_LOCK_START` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_LOCK_STOP.md b/wiki-information/events/INSTANCE_LOCK_STOP.md new file mode 100644 index 00000000..d2692fcb --- /dev/null +++ b/wiki-information/events/INSTANCE_LOCK_STOP.md @@ -0,0 +1,10 @@ +## Event: INSTANCE_LOCK_STOP + +**Title:** INSTANCE LOCK STOP + +**Content:** +Fired when quitting the game. +`INSTANCE_LOCK_STOP` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_LOCK_WARNING.md b/wiki-information/events/INSTANCE_LOCK_WARNING.md new file mode 100644 index 00000000..c2897bf0 --- /dev/null +++ b/wiki-information/events/INSTANCE_LOCK_WARNING.md @@ -0,0 +1,10 @@ +## Event: INSTANCE_LOCK_WARNING + +**Title:** INSTANCE LOCK WARNING + +**Content:** +Needs summary. +`INSTANCE_LOCK_WARNING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/INVENTORY_SEARCH_UPDATE.md b/wiki-information/events/INVENTORY_SEARCH_UPDATE.md new file mode 100644 index 00000000..d637fafd --- /dev/null +++ b/wiki-information/events/INVENTORY_SEARCH_UPDATE.md @@ -0,0 +1,10 @@ +## Event: INVENTORY_SEARCH_UPDATE + +**Title:** INVENTORY SEARCH UPDATE + +**Content:** +Fired when the Inventory Search Box is updated. +`INVENTORY_SEARCH_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ISLAND_COMPLETED.md b/wiki-information/events/ISLAND_COMPLETED.md new file mode 100644 index 00000000..7250bb1b --- /dev/null +++ b/wiki-information/events/ISLAND_COMPLETED.md @@ -0,0 +1,13 @@ +## Event: ISLAND_COMPLETED + +**Title:** ISLAND COMPLETED + +**Content:** +Needs summary. +`ISLAND_COMPLETED: mapID, winner` + +**Payload:** +- `mapID` + - *number* +- `winner` + - *number* \ No newline at end of file diff --git a/wiki-information/events/ITEM_DATA_LOAD_RESULT.md b/wiki-information/events/ITEM_DATA_LOAD_RESULT.md new file mode 100644 index 00000000..f72c5bb8 --- /dev/null +++ b/wiki-information/events/ITEM_DATA_LOAD_RESULT.md @@ -0,0 +1,13 @@ +## Event: ITEM_DATA_LOAD_RESULT + +**Title:** ITEM DATA LOAD RESULT + +**Content:** +Fires when data is available in response to C_Item.RequestLoadItemData. +`ITEM_DATA_LOAD_RESULT: itemID, success` + +**Payload:** +- `itemID` + - *number* +- `success` + - *boolean* - True if the item was successfully queried from the server. \ No newline at end of file diff --git a/wiki-information/events/ITEM_LOCKED.md b/wiki-information/events/ITEM_LOCKED.md new file mode 100644 index 00000000..32dc553b --- /dev/null +++ b/wiki-information/events/ITEM_LOCKED.md @@ -0,0 +1,13 @@ +## Event: ITEM_LOCKED + +**Title:** ITEM LOCKED + +**Content:** +Fires when an item gets "locked" in the inventory or a container. +`ITEM_LOCKED: bagOrSlotIndex, slotIndex` + +**Payload:** +- `bagOrSlotIndex` + - *number* +- `slotIndex` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/ITEM_LOCK_CHANGED.md b/wiki-information/events/ITEM_LOCK_CHANGED.md new file mode 100644 index 00000000..b47f08de --- /dev/null +++ b/wiki-information/events/ITEM_LOCK_CHANGED.md @@ -0,0 +1,19 @@ +## Event: ITEM_LOCK_CHANGED + +**Title:** ITEM LOCK CHANGED + +**Content:** +Fires when the "locked" status on a container or inventory item changes, usually from but not limited to Pickup functions to move items. +`ITEM_LOCK_CHANGED: bagOrSlotIndex, slotIndex` + +**Payload:** +- `bagOrSlotIndex` + - *number* - If slotIndex is nil: Equipment slot of item; otherwise bag of updated item. +- `slotIndex` + - *number?* - Slot of updated item. + +**Content Details:** +Usually fires in pairs when an item is swapping with another. +Empty slots do not lock. +GetContainerItemInfo and IsInventoryItemLocked can be used to query lock status. +This does NOT fire on ammo pickups. \ No newline at end of file diff --git a/wiki-information/events/ITEM_PUSH.md b/wiki-information/events/ITEM_PUSH.md new file mode 100644 index 00000000..dae9d4c5 --- /dev/null +++ b/wiki-information/events/ITEM_PUSH.md @@ -0,0 +1,13 @@ +## Event: ITEM_PUSH + +**Title:** ITEM PUSH + +**Content:** +Fired when an item is pushed onto the "inventory-stack". For instance when you manufacture something with your trade skills or pick something up. +`ITEM_PUSH: bagSlot, iconFileID` + +**Payload:** +- `bagSlot` + - *number* - the bag that has received the new item +- `iconFileID` + - *number* - the FileID of the item's icon \ No newline at end of file diff --git a/wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md b/wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md new file mode 100644 index 00000000..e44f3647 --- /dev/null +++ b/wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md @@ -0,0 +1,10 @@ +## Event: ITEM_RESTORATION_BUTTON_STATUS + +**Title:** ITEM RESTORATION BUTTON STATUS + +**Content:** +Needs summary. +`ITEM_RESTORATION_BUTTON_STATUS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_BEGIN.md b/wiki-information/events/ITEM_TEXT_BEGIN.md new file mode 100644 index 00000000..20b7a63c --- /dev/null +++ b/wiki-information/events/ITEM_TEXT_BEGIN.md @@ -0,0 +1,10 @@ +## Event: ITEM_TEXT_BEGIN + +**Title:** ITEM TEXT BEGIN + +**Content:** +Fired when an items text begins displaying +`ITEM_TEXT_BEGIN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_CLOSED.md b/wiki-information/events/ITEM_TEXT_CLOSED.md new file mode 100644 index 00000000..d1baef60 --- /dev/null +++ b/wiki-information/events/ITEM_TEXT_CLOSED.md @@ -0,0 +1,10 @@ +## Event: ITEM_TEXT_CLOSED + +**Title:** ITEM TEXT CLOSED + +**Content:** +Fired when the items text has completed its viewing and is done. +`ITEM_TEXT_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_READY.md b/wiki-information/events/ITEM_TEXT_READY.md new file mode 100644 index 00000000..23304ad9 --- /dev/null +++ b/wiki-information/events/ITEM_TEXT_READY.md @@ -0,0 +1,10 @@ +## Event: ITEM_TEXT_READY + +**Title:** ITEM TEXT READY + +**Content:** +Fired when the item's text can continue and is ready to be scrolled. +`ITEM_TEXT_READY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_TRANSLATION.md b/wiki-information/events/ITEM_TEXT_TRANSLATION.md new file mode 100644 index 00000000..3327a08a --- /dev/null +++ b/wiki-information/events/ITEM_TEXT_TRANSLATION.md @@ -0,0 +1,11 @@ +## Event: ITEM_TEXT_TRANSLATION + +**Title:** ITEM TEXT TRANSLATION + +**Content:** +Fired when an item is in the process of being translated. +`ITEM_TEXT_TRANSLATION: delay` + +**Payload:** +- `delay` + - *number* \ No newline at end of file diff --git a/wiki-information/events/ITEM_UNLOCKED.md b/wiki-information/events/ITEM_UNLOCKED.md new file mode 100644 index 00000000..7818df84 --- /dev/null +++ b/wiki-information/events/ITEM_UNLOCKED.md @@ -0,0 +1,13 @@ +## Event: ITEM_UNLOCKED + +**Title:** ITEM UNLOCKED + +**Content:** +Needs summary. +`ITEM_UNLOCKED: bagOrSlotIndex, slotIndex` + +**Payload:** +- `bagOrSlotIndex` + - *number* +- `slotIndex` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_FAILED.md b/wiki-information/events/ITEM_UPGRADE_FAILED.md new file mode 100644 index 00000000..bf801828 --- /dev/null +++ b/wiki-information/events/ITEM_UPGRADE_FAILED.md @@ -0,0 +1,10 @@ +## Event: ITEM_UPGRADE_FAILED + +**Title:** ITEM UPGRADE FAILED + +**Content:** +Needs summary. +`ITEM_UPGRADE_FAILED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md b/wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md new file mode 100644 index 00000000..ff205f70 --- /dev/null +++ b/wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md @@ -0,0 +1,13 @@ +## Event: ITEM_UPGRADE_MASTER_CLOSED + +**Title:** ITEM UPGRADE MASTER CLOSED + +**Content:** +Fires when closing the ItemUpgradeFrame. +`ITEM_UPGRADE_MASTER_CLOSED` + +**Payload:** +- `None` + +**Content Details:** +ITEM_UPGRADE_MASTER_SET_ITEM may also fire simultaneously, presumably as the slot is forced to clear \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md b/wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md new file mode 100644 index 00000000..0c561234 --- /dev/null +++ b/wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md @@ -0,0 +1,10 @@ +## Event: ITEM_UPGRADE_MASTER_OPENED + +**Title:** ITEM UPGRADE MASTER OPENED + +**Content:** +Fires when opening the ItemUpgradeFrame. +`ITEM_UPGRADE_MASTER_OPENED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md b/wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md new file mode 100644 index 00000000..dcf85a55 --- /dev/null +++ b/wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md @@ -0,0 +1,14 @@ +## Event: ITEM_UPGRADE_MASTER_SET_ITEM + +**Title:** ITEM UPGRADE MASTER SET ITEM + +**Content:** +Fires after adding or removing items in the ItemUpgradeFrame used for item upgrading. +`ITEM_UPGRADE_MASTER_SET_ITEM` + +**Payload:** +- `None` + +**Content Details:** +Fires up to twice when the ItemUpgradeFrame closes; presumably forcing the slot clear. +Causes the frame to update its appearance using information provided in GetItemUpgradeItemInfo() \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md b/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md new file mode 100644 index 00000000..90cc1a55 --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md @@ -0,0 +1,10 @@ +## Event: KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE + +**Title:** KNOWLEDGE BASE ARTICLE LOAD FAILURE + +**Content:** +Needs summary. +`KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md b/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md new file mode 100644 index 00000000..e2913cb8 --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md @@ -0,0 +1,13 @@ +## Event: KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS + +**Title:** KNOWLEDGE BASE ARTICLE LOAD SUCCESS + +**Content:** +Needs summary. +`KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS` + +**Payload:** +- `None` + +**Related Information:** +KBArticle_IsLoaded() \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md b/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md new file mode 100644 index 00000000..119143a8 --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md @@ -0,0 +1,10 @@ +## Event: KNOWLEDGE_BASE_QUERY_LOAD_FAILURE + +**Title:** KNOWLEDGE BASE QUERY LOAD FAILURE + +**Content:** +Needs summary. +`KNOWLEDGE_BASE_QUERY_LOAD_FAILURE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md b/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md new file mode 100644 index 00000000..8e694fac --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md @@ -0,0 +1,10 @@ +## Event: KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS + +**Title:** KNOWLEDGE BASE QUERY LOAD SUCCESS + +**Content:** +Needs summary. +`KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md b/wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md new file mode 100644 index 00000000..12d8b031 --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md @@ -0,0 +1,13 @@ +## Event: KNOWLEDGE_BASE_SERVER_MESSAGE + +**Title:** KNOWLEDGE BASE SERVER MESSAGE + +**Content:** +Indicates the server message has changed. +`KNOWLEDGE_BASE_SERVER_MESSAGE` + +**Payload:** +- `None` + +**Related Information:** +KBSystem GetServerNotice() \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md b/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md new file mode 100644 index 00000000..3cb17c6b --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md @@ -0,0 +1,10 @@ +## Event: KNOWLEDGE_BASE_SETUP_LOAD_FAILURE + +**Title:** KNOWLEDGE BASE SETUP LOAD FAILURE + +**Content:** +Needs summary. +`KNOWLEDGE_BASE_SETUP_LOAD_FAILURE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md b/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md new file mode 100644 index 00000000..adeb57bd --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md @@ -0,0 +1,10 @@ +## Event: KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS + +**Title:** KNOWLEDGE BASE SETUP LOAD SUCCESS + +**Content:** +Needs summary. +`KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md b/wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md new file mode 100644 index 00000000..1987218c --- /dev/null +++ b/wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md @@ -0,0 +1,10 @@ +## Event: KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED + +**Title:** KNOWLEDGE BASE SYSTEM MOTD UPDATED + +**Content:** +Needs summary. +`KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LANGUAGE_LIST_CHANGED.md b/wiki-information/events/LANGUAGE_LIST_CHANGED.md new file mode 100644 index 00000000..10d8a10d --- /dev/null +++ b/wiki-information/events/LANGUAGE_LIST_CHANGED.md @@ -0,0 +1,10 @@ +## Event: LANGUAGE_LIST_CHANGED + +**Title:** LANGUAGE LIST CHANGED + +**Content:** +Needs summary. +`LANGUAGE_LIST_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LEARNED_SPELL_IN_TAB.md b/wiki-information/events/LEARNED_SPELL_IN_TAB.md new file mode 100644 index 00000000..de9ba290 --- /dev/null +++ b/wiki-information/events/LEARNED_SPELL_IN_TAB.md @@ -0,0 +1,15 @@ +## Event: LEARNED_SPELL_IN_TAB + +**Title:** LEARNED SPELL IN TAB + +**Content:** +Fired when a new spell/ability is added to the spellbook. e.g. When training a new or a higher level spell/ability. +`LEARNED_SPELL_IN_TAB: spellID, skillInfoIndex, isGuildPerkSpell` + +**Payload:** +- `spellID` + - *number* +- `skillInfoIndex` + - *number* - Number of the tab which the spell/ability is added to. +- `isGuildPerkSpell` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md b/wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md new file mode 100644 index 00000000..8623626a --- /dev/null +++ b/wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LFG_BOOT_PROPOSAL_UPDATE + +**Title:** LFG BOOT PROPOSAL UPDATE + +**Content:** +Needs summary. +`LFG_BOOT_PROPOSAL_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_COMPLETION_REWARD.md b/wiki-information/events/LFG_COMPLETION_REWARD.md new file mode 100644 index 00000000..3a283979 --- /dev/null +++ b/wiki-information/events/LFG_COMPLETION_REWARD.md @@ -0,0 +1,10 @@ +## Event: LFG_COMPLETION_REWARD + +**Title:** LFG COMPLETION REWARD + +**Content:** +Fired when a random dungeon (picked by the Dungeon Finder) is completed. This event causes a window similar to the achievement alert to appear, with the details of your Dungeon Finder rewards. +`LFG_COMPLETION_REWARD` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md b/wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md new file mode 100644 index 00000000..7e5401c8 --- /dev/null +++ b/wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md @@ -0,0 +1,13 @@ +## Event: LFG_GROUP_DELISTED_LEADERSHIP_CHANGE + +**Title:** LFG GROUP DELISTED LEADERSHIP CHANGE + +**Content:** +Needs summary. +`LFG_GROUP_DELISTED_LEADERSHIP_CHANGE: listingName, automaticDelistTimeRemaining` + +**Payload:** +- `listingName` + - *string* +- `automaticDelistTimeRemaining` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md b/wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md new file mode 100644 index 00000000..63c7eb92 --- /dev/null +++ b/wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md @@ -0,0 +1,15 @@ +## Event: LFG_INVALID_ERROR_MESSAGE + +**Title:** LFG INVALID ERROR MESSAGE + +**Content:** +Needs summary. +`LFG_INVALID_ERROR_MESSAGE: reason, subReason1, subReason2` + +**Payload:** +- `reason` + - *number* +- `subReason1` + - *number* +- `subReason2` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md b/wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md new file mode 100644 index 00000000..666643f3 --- /dev/null +++ b/wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md @@ -0,0 +1,11 @@ +## Event: LFG_LIST_ACTIVE_ENTRY_UPDATE + +**Title:** LFG LIST ACTIVE ENTRY UPDATE + +**Content:** +Needs summary. +`LFG_LIST_ACTIVE_ENTRY_UPDATE: created` + +**Payload:** +- `created` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md b/wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md new file mode 100644 index 00000000..e3a9dc75 --- /dev/null +++ b/wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LFG_LIST_AVAILABILITY_UPDATE + +**Title:** LFG LIST AVAILABILITY UPDATE + +**Content:** +Fires when opening the LFG frame to the Premade Groups window. +`LFG_LIST_AVAILABILITY_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md b/wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md new file mode 100644 index 00000000..b65f6264 --- /dev/null +++ b/wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md @@ -0,0 +1,10 @@ +## Event: LFG_LIST_ENTRY_CREATION_FAILED + +**Title:** LFG LIST ENTRY CREATION FAILED + +**Content:** +Needs summary. +`LFG_LIST_ENTRY_CREATION_FAILED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md b/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md new file mode 100644 index 00000000..5f5c9bea --- /dev/null +++ b/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md @@ -0,0 +1,10 @@ +## Event: LFG_LIST_ENTRY_EXPIRED_TIMEOUT + +**Title:** LFG LIST ENTRY EXPIRED TIMEOUT + +**Content:** +Needs summary. +`LFG_LIST_ENTRY_EXPIRED_TIMEOUT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md b/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md new file mode 100644 index 00000000..03b3b71e --- /dev/null +++ b/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md @@ -0,0 +1,10 @@ +## Event: LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS + +**Title:** LFG LIST ENTRY EXPIRED TOO MANY PLAYERS + +**Content:** +Needs summary. +`LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_SEARCH_FAILED.md b/wiki-information/events/LFG_LIST_SEARCH_FAILED.md new file mode 100644 index 00000000..174f1e10 --- /dev/null +++ b/wiki-information/events/LFG_LIST_SEARCH_FAILED.md @@ -0,0 +1,11 @@ +## Event: LFG_LIST_SEARCH_FAILED + +**Title:** LFG LIST SEARCH FAILED + +**Content:** +Needs summary. +`LFG_LIST_SEARCH_FAILED: reason` + +**Payload:** +- `reason` + - *string?* \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md b/wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md new file mode 100644 index 00000000..5bf19cfb --- /dev/null +++ b/wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md @@ -0,0 +1,10 @@ +## Event: LFG_LIST_SEARCH_RESULTS_RECEIVED + +**Title:** LFG LIST SEARCH RESULTS RECEIVED + +**Content:** +Needs summary. +`LFG_LIST_SEARCH_RESULTS_RECEIVED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md b/wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md new file mode 100644 index 00000000..5d65a9c0 --- /dev/null +++ b/wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md @@ -0,0 +1,11 @@ +## Event: LFG_LIST_SEARCH_RESULT_UPDATED + +**Title:** LFG LIST SEARCH RESULT UPDATED + +**Content:** +Needs summary. +`LFG_LIST_SEARCH_RESULT_UPDATED: searchResultID` + +**Payload:** +- `searchResultID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_LOCK_INFO_RECEIVED.md b/wiki-information/events/LFG_LOCK_INFO_RECEIVED.md new file mode 100644 index 00000000..d8ef9d88 --- /dev/null +++ b/wiki-information/events/LFG_LOCK_INFO_RECEIVED.md @@ -0,0 +1,13 @@ +## Event: LFG_LOCK_INFO_RECEIVED + +**Title:** LFG LOCK INFO RECEIVED + +**Content:** +Fires when opening the LFG frame to the Raid Finder window. +`LFG_LOCK_INFO_RECEIVED` + +**Payload:** +- `None` + +**Related Information:** +GetLFDChoiceLockedState() \ No newline at end of file diff --git a/wiki-information/events/LFG_OFFER_CONTINUE.md b/wiki-information/events/LFG_OFFER_CONTINUE.md new file mode 100644 index 00000000..71bdc009 --- /dev/null +++ b/wiki-information/events/LFG_OFFER_CONTINUE.md @@ -0,0 +1,15 @@ +## Event: LFG_OFFER_CONTINUE + +**Title:** LFG OFFER CONTINUE + +**Content:** +Needs summary. +`LFG_OFFER_CONTINUE: name, lfgDungeonsID, typeID` + +**Payload:** +- `name` + - *string* +- `lfgDungeonsID` + - *number* +- `typeID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_OPEN_FROM_GOSSIP.md b/wiki-information/events/LFG_OPEN_FROM_GOSSIP.md new file mode 100644 index 00000000..3c000c9a --- /dev/null +++ b/wiki-information/events/LFG_OPEN_FROM_GOSSIP.md @@ -0,0 +1,11 @@ +## Event: LFG_OPEN_FROM_GOSSIP + +**Title:** LFG OPEN FROM GOSSIP + +**Content:** +Fired when a gossip option is used to initiate a Looking-for-Dungeon interaction. +`LFG_OPEN_FROM_GOSSIP: dungeonID` + +**Payload:** +- `dungeonID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_DONE.md b/wiki-information/events/LFG_PROPOSAL_DONE.md new file mode 100644 index 00000000..6272fd3d --- /dev/null +++ b/wiki-information/events/LFG_PROPOSAL_DONE.md @@ -0,0 +1,10 @@ +## Event: LFG_PROPOSAL_DONE + +**Title:** LFG PROPOSAL DONE + +**Content:** +Needs summary. +`LFG_PROPOSAL_DONE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_FAILED.md b/wiki-information/events/LFG_PROPOSAL_FAILED.md new file mode 100644 index 00000000..6569f177 --- /dev/null +++ b/wiki-information/events/LFG_PROPOSAL_FAILED.md @@ -0,0 +1,10 @@ +## Event: LFG_PROPOSAL_FAILED + +**Title:** LFG PROPOSAL FAILED + +**Content:** +Fired when someone decline or don't make a choice within time in the dungeon queue invite +`LFG_PROPOSAL_FAILED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_SHOW.md b/wiki-information/events/LFG_PROPOSAL_SHOW.md new file mode 100644 index 00000000..fcdbbb6c --- /dev/null +++ b/wiki-information/events/LFG_PROPOSAL_SHOW.md @@ -0,0 +1,10 @@ +## Event: LFG_PROPOSAL_SHOW + +**Title:** LFG PROPOSAL SHOW + +**Content:** +Fired when a dungeon group was found and the dialog to accept or decline it appears. +`LFG_PROPOSAL_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md b/wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md new file mode 100644 index 00000000..526f7b7c --- /dev/null +++ b/wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md @@ -0,0 +1,10 @@ +## Event: LFG_PROPOSAL_SUCCEEDED + +**Title:** LFG PROPOSAL SUCCEEDED + +**Content:** +Fired when everyone in the dungeon queue accepted the invite. +`LFG_PROPOSAL_SUCCEEDED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_UPDATE.md b/wiki-information/events/LFG_PROPOSAL_UPDATE.md new file mode 100644 index 00000000..1ec9765a --- /dev/null +++ b/wiki-information/events/LFG_PROPOSAL_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LFG_PROPOSAL_UPDATE + +**Title:** LFG PROPOSAL UPDATE + +**Content:** +Fired when someone either accepts or decline the dungeon queue invite. +`LFG_PROPOSAL_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md b/wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md new file mode 100644 index 00000000..d7e58c1d --- /dev/null +++ b/wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LFG_QUEUE_STATUS_UPDATE + +**Title:** LFG QUEUE STATUS UPDATE + +**Content:** +Needs summary. +`LFG_QUEUE_STATUS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_DECLINED.md b/wiki-information/events/LFG_READY_CHECK_DECLINED.md new file mode 100644 index 00000000..44633606 --- /dev/null +++ b/wiki-information/events/LFG_READY_CHECK_DECLINED.md @@ -0,0 +1,11 @@ +## Event: LFG_READY_CHECK_DECLINED + +**Title:** LFG READY CHECK DECLINED + +**Content:** +Needs summary. +`LFG_READY_CHECK_DECLINED: name` + +**Payload:** +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_HIDE.md b/wiki-information/events/LFG_READY_CHECK_HIDE.md new file mode 100644 index 00000000..eeb4e88a --- /dev/null +++ b/wiki-information/events/LFG_READY_CHECK_HIDE.md @@ -0,0 +1,10 @@ +## Event: LFG_READY_CHECK_HIDE + +**Title:** LFG READY CHECK HIDE + +**Content:** +Needs summary. +`LFG_READY_CHECK_HIDE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md b/wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md new file mode 100644 index 00000000..0a63f8dd --- /dev/null +++ b/wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md @@ -0,0 +1,11 @@ +## Event: LFG_READY_CHECK_PLAYER_IS_READY + +**Title:** LFG READY CHECK PLAYER IS READY + +**Content:** +Needs summary. +`LFG_READY_CHECK_PLAYER_IS_READY: name` + +**Payload:** +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_SHOW.md b/wiki-information/events/LFG_READY_CHECK_SHOW.md new file mode 100644 index 00000000..d3dfcfad --- /dev/null +++ b/wiki-information/events/LFG_READY_CHECK_SHOW.md @@ -0,0 +1,11 @@ +## Event: LFG_READY_CHECK_SHOW + +**Title:** LFG READY CHECK SHOW + +**Content:** +Needs summary. +`LFG_READY_CHECK_SHOW: isRequeue` + +**Payload:** +- `isRequeue` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_UPDATE.md b/wiki-information/events/LFG_READY_CHECK_UPDATE.md new file mode 100644 index 00000000..9cd03ab9 --- /dev/null +++ b/wiki-information/events/LFG_READY_CHECK_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LFG_READY_CHECK_UPDATE + +**Title:** LFG READY CHECK UPDATE + +**Content:** +Needs summary. +`LFG_READY_CHECK_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_DECLINED.md b/wiki-information/events/LFG_ROLE_CHECK_DECLINED.md new file mode 100644 index 00000000..7d537826 --- /dev/null +++ b/wiki-information/events/LFG_ROLE_CHECK_DECLINED.md @@ -0,0 +1,10 @@ +## Event: LFG_ROLE_CHECK_DECLINED + +**Title:** LFG ROLE CHECK DECLINED + +**Content:** +Needs summary. +`LFG_ROLE_CHECK_DECLINED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_HIDE.md b/wiki-information/events/LFG_ROLE_CHECK_HIDE.md new file mode 100644 index 00000000..59f2f0c0 --- /dev/null +++ b/wiki-information/events/LFG_ROLE_CHECK_HIDE.md @@ -0,0 +1,10 @@ +## Event: LFG_ROLE_CHECK_HIDE + +**Title:** LFG ROLE CHECK HIDE + +**Content:** +Needs summary. +`LFG_ROLE_CHECK_HIDE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md b/wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md new file mode 100644 index 00000000..b7692e01 --- /dev/null +++ b/wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md @@ -0,0 +1,17 @@ +## Event: LFG_ROLE_CHECK_ROLE_CHOSEN + +**Title:** LFG ROLE CHECK ROLE CHOSEN + +**Content:** +Needs summary. +`LFG_ROLE_CHECK_ROLE_CHOSEN: name, isTank, isHealer, isDamage` + +**Payload:** +- `name` + - *string* +- `isTank` + - *boolean* +- `isHealer` + - *boolean* +- `isDamage` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_SHOW.md b/wiki-information/events/LFG_ROLE_CHECK_SHOW.md new file mode 100644 index 00000000..e617ed5d --- /dev/null +++ b/wiki-information/events/LFG_ROLE_CHECK_SHOW.md @@ -0,0 +1,11 @@ +## Event: LFG_ROLE_CHECK_SHOW + +**Title:** LFG ROLE CHECK SHOW + +**Content:** +Needs summary. +`LFG_ROLE_CHECK_SHOW: isRequeue` + +**Payload:** +- `isRequeue` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_UPDATE.md b/wiki-information/events/LFG_ROLE_CHECK_UPDATE.md new file mode 100644 index 00000000..ec01c422 --- /dev/null +++ b/wiki-information/events/LFG_ROLE_CHECK_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LFG_ROLE_CHECK_UPDATE + +**Title:** LFG ROLE CHECK UPDATE + +**Content:** +Needs summary. +`LFG_ROLE_CHECK_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_UPDATE.md b/wiki-information/events/LFG_ROLE_UPDATE.md new file mode 100644 index 00000000..6542433d --- /dev/null +++ b/wiki-information/events/LFG_ROLE_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LFG_ROLE_UPDATE + +**Title:** LFG ROLE UPDATE + +**Content:** +Needs summary. +`LFG_ROLE_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_UPDATE.md b/wiki-information/events/LFG_UPDATE.md new file mode 100644 index 00000000..fe36c938 --- /dev/null +++ b/wiki-information/events/LFG_UPDATE.md @@ -0,0 +1,13 @@ +## Event: LFG_UPDATE + +**Title:** LFG UPDATE + +**Content:** +When fired prompts the LFG UI to update the list of available LFG categories and objectives (i.e. new quests, zones, instances available to LFG). +`LFG_UPDATE` + +**Payload:** +- `None` + +**Related Information:** +GetLFGTypes() \ No newline at end of file diff --git a/wiki-information/events/LFG_UPDATE_RANDOM_INFO.md b/wiki-information/events/LFG_UPDATE_RANDOM_INFO.md new file mode 100644 index 00000000..5ec5132d --- /dev/null +++ b/wiki-information/events/LFG_UPDATE_RANDOM_INFO.md @@ -0,0 +1,10 @@ +## Event: LFG_UPDATE_RANDOM_INFO + +**Title:** LFG UPDATE RANDOM INFO + +**Content:** +Fires when opening the LFG frame to the Dungeon Finder window. This fires when opening the LFG tool for the first time in a play session. +`LFG_UPDATE_RANDOM_INFO` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LOADING_SCREEN_DISABLED.md b/wiki-information/events/LOADING_SCREEN_DISABLED.md new file mode 100644 index 00000000..b845ae3b --- /dev/null +++ b/wiki-information/events/LOADING_SCREEN_DISABLED.md @@ -0,0 +1,10 @@ +## Event: LOADING_SCREEN_DISABLED + +**Title:** LOADING SCREEN DISABLED + +**Content:** +Fired when loading screen disappears; when player is finished loading the new zone. +`LOADING_SCREEN_DISABLED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LOADING_SCREEN_ENABLED.md b/wiki-information/events/LOADING_SCREEN_ENABLED.md new file mode 100644 index 00000000..23599942 --- /dev/null +++ b/wiki-information/events/LOADING_SCREEN_ENABLED.md @@ -0,0 +1,10 @@ +## Event: LOADING_SCREEN_ENABLED + +**Title:** LOADING SCREEN ENABLED + +**Content:** +Fired when loading screen appears; when player is loading new zone. +`LOADING_SCREEN_ENABLED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LOCALPLAYER_PET_RENAMED.md b/wiki-information/events/LOCALPLAYER_PET_RENAMED.md new file mode 100644 index 00000000..56ae68ac --- /dev/null +++ b/wiki-information/events/LOCALPLAYER_PET_RENAMED.md @@ -0,0 +1,10 @@ +## Event: LOCALPLAYER_PET_RENAMED + +**Title:** LOCALPLAYER PET RENAMED + +**Content:** +Needs summary. +`LOCALPLAYER_PET_RENAMED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LOC_RESULT.md b/wiki-information/events/LOC_RESULT.md new file mode 100644 index 00000000..82172d60 --- /dev/null +++ b/wiki-information/events/LOC_RESULT.md @@ -0,0 +1,11 @@ +## Event: LOC_RESULT + +**Title:** LOC RESULT + +**Content:** +Needs summary. +`LOC_RESULT: result` + +**Payload:** +- `result` + - *string* \ No newline at end of file diff --git a/wiki-information/events/LOGOUT_CANCEL.md b/wiki-information/events/LOGOUT_CANCEL.md new file mode 100644 index 00000000..18938932 --- /dev/null +++ b/wiki-information/events/LOGOUT_CANCEL.md @@ -0,0 +1,10 @@ +## Event: LOGOUT_CANCEL + +**Title:** LOGOUT CANCEL + +**Content:** +Needs summary. +`LOGOUT_CANCEL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LOOT_BIND_CONFIRM.md b/wiki-information/events/LOOT_BIND_CONFIRM.md new file mode 100644 index 00000000..d392d104 --- /dev/null +++ b/wiki-information/events/LOOT_BIND_CONFIRM.md @@ -0,0 +1,11 @@ +## Event: LOOT_BIND_CONFIRM + +**Title:** LOOT BIND CONFIRM + +**Content:** +Fired when the player attempts to take 'bind-on-pickup' loot +`LOOT_BIND_CONFIRM: lootSlot` + +**Payload:** +- `lootSlot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_CLOSED.md b/wiki-information/events/LOOT_CLOSED.md new file mode 100644 index 00000000..1dc5aeb0 --- /dev/null +++ b/wiki-information/events/LOOT_CLOSED.md @@ -0,0 +1,14 @@ +## Event: LOOT_CLOSED + +**Title:** LOOT CLOSED + +**Content:** +Fired when a player ceases looting a corpse. Note that this will fire before the last CHAT_MSG_LOOT event for that loot. +`LOOT_CLOSED` + +**Payload:** +- `None` + +**Related Information:** +- `LOOT_OPENED` +- `LOOT_READY` \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md b/wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md new file mode 100644 index 00000000..dbff4556 --- /dev/null +++ b/wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md @@ -0,0 +1,13 @@ +## Event: LOOT_HISTORY_AUTO_SHOW + +**Title:** LOOT HISTORY AUTO SHOW + +**Content:** +Needs summary. +`LOOT_HISTORY_AUTO_SHOW: rollID, isMasterLoot` + +**Payload:** +- `rollID` + - *number* +- `isMasterLoot` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md b/wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md new file mode 100644 index 00000000..a773d89e --- /dev/null +++ b/wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LOOT_HISTORY_FULL_UPDATE + +**Title:** LOOT HISTORY FULL UPDATE + +**Content:** +Needs summary. +`LOOT_HISTORY_FULL_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md b/wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md new file mode 100644 index 00000000..d6311791 --- /dev/null +++ b/wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md @@ -0,0 +1,13 @@ +## Event: LOOT_HISTORY_ROLL_CHANGED + +**Title:** LOOT HISTORY ROLL CHANGED + +**Content:** +Needs summary. +`LOOT_HISTORY_ROLL_CHANGED: historyIndex, playerIndex` + +**Payload:** +- `historyIndex` + - *number* +- `playerIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md b/wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md new file mode 100644 index 00000000..a3bb1387 --- /dev/null +++ b/wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md @@ -0,0 +1,10 @@ +## Event: LOOT_HISTORY_ROLL_COMPLETE + +**Title:** LOOT HISTORY ROLL COMPLETE + +**Content:** +Needs summary. +`LOOT_HISTORY_ROLL_COMPLETE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LOOT_ITEM_AVAILABLE.md b/wiki-information/events/LOOT_ITEM_AVAILABLE.md new file mode 100644 index 00000000..44341993 --- /dev/null +++ b/wiki-information/events/LOOT_ITEM_AVAILABLE.md @@ -0,0 +1,13 @@ +## Event: LOOT_ITEM_AVAILABLE + +**Title:** LOOT ITEM AVAILABLE + +**Content:** +Needs summary. +`LOOT_ITEM_AVAILABLE: itemTooltip, lootHandle` + +**Payload:** +- `itemTooltip` + - *string* +- `lootHandle` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_ITEM_ROLL_WON.md b/wiki-information/events/LOOT_ITEM_ROLL_WON.md new file mode 100644 index 00000000..f0c6cde1 --- /dev/null +++ b/wiki-information/events/LOOT_ITEM_ROLL_WON.md @@ -0,0 +1,19 @@ +## Event: LOOT_ITEM_ROLL_WON + +**Title:** LOOT ITEM ROLL WON + +**Content:** +Needs summary. +`LOOT_ITEM_ROLL_WON: itemLink, rollQuantity, rollType, roll, upgraded` + +**Payload:** +- `itemLink` + - *string* +- `rollQuantity` + - *number* +- `rollType` + - *number* +- `roll` + - *number* +- `upgraded` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LOOT_OPENED.md b/wiki-information/events/LOOT_OPENED.md new file mode 100644 index 00000000..1af1e469 --- /dev/null +++ b/wiki-information/events/LOOT_OPENED.md @@ -0,0 +1,13 @@ +## Event: LOOT_OPENED + +**Title:** LOOT OPENED + +**Content:** +Fires when a corpse is looted, after LOOT_READY. +`LOOT_OPENED: autoLoot, isFromItem` + +**Payload:** +- `autoLoot` + - *boolean* - Equal to CVar autoLootDefault. +- `isFromItem` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LOOT_READY.md b/wiki-information/events/LOOT_READY.md new file mode 100644 index 00000000..d4cc00a7 --- /dev/null +++ b/wiki-information/events/LOOT_READY.md @@ -0,0 +1,15 @@ +## Event: LOOT_READY + +**Title:** LOOT READY + +**Content:** +This is fired when looting begins, but before the loot window is shown. Loot functions like GetNumLootItems will be available until LOOT_CLOSED is fired. +`LOOT_READY: autoloot` + +**Payload:** +- `autoloot` + - *boolean* - Equal to autoLootDefault. + +**Related Information:** +LOOT_OPENED +LOOT_CLOSED \ No newline at end of file diff --git a/wiki-information/events/LOOT_ROLLS_COMPLETE.md b/wiki-information/events/LOOT_ROLLS_COMPLETE.md new file mode 100644 index 00000000..2119b323 --- /dev/null +++ b/wiki-information/events/LOOT_ROLLS_COMPLETE.md @@ -0,0 +1,11 @@ +## Event: LOOT_ROLLS_COMPLETE + +**Title:** LOOT ROLLS COMPLETE + +**Content:** +Needs summary. +`LOOT_ROLLS_COMPLETE: lootHandle` + +**Payload:** +- `lootHandle` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_SLOT_CHANGED.md b/wiki-information/events/LOOT_SLOT_CHANGED.md new file mode 100644 index 00000000..7d108edc --- /dev/null +++ b/wiki-information/events/LOOT_SLOT_CHANGED.md @@ -0,0 +1,11 @@ +## Event: LOOT_SLOT_CHANGED + +**Title:** LOOT SLOT CHANGED + +**Content:** +Needs summary. +`LOOT_SLOT_CHANGED: lootSlot` + +**Payload:** +- `lootSlot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_SLOT_CLEARED.md b/wiki-information/events/LOOT_SLOT_CLEARED.md new file mode 100644 index 00000000..c5b3a0f5 --- /dev/null +++ b/wiki-information/events/LOOT_SLOT_CLEARED.md @@ -0,0 +1,11 @@ +## Event: LOOT_SLOT_CLEARED + +**Title:** LOOT SLOT CLEARED + +**Content:** +Fired when loot is removed from a corpse. +`LOOT_SLOT_CLEARED: lootSlot` + +**Payload:** +- `lootSlot` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_ADDED.md b/wiki-information/events/LOSS_OF_CONTROL_ADDED.md new file mode 100644 index 00000000..c1c47ecc --- /dev/null +++ b/wiki-information/events/LOSS_OF_CONTROL_ADDED.md @@ -0,0 +1,11 @@ +## Event: LOSS_OF_CONTROL_ADDED + +**Title:** LOSS OF CONTROL ADDED + +**Content:** +Needs summary. +`LOSS_OF_CONTROL_ADDED: effectIndex` + +**Payload:** +- `effectIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md b/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md new file mode 100644 index 00000000..156f8e48 --- /dev/null +++ b/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md @@ -0,0 +1,13 @@ +## Event: LOSS_OF_CONTROL_COMMENTATOR_ADDED + +**Title:** LOSS OF CONTROL COMMENTATOR ADDED + +**Content:** +Fired when a new active loss-of-control effect is added to a player. Only relevant for commentator mode. +`LOSS_OF_CONTROL_COMMENTATOR_ADDED: victim, effectIndex` + +**Payload:** +- `victim` + - *string* +- `effectIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md b/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md new file mode 100644 index 00000000..8c020ddb --- /dev/null +++ b/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md @@ -0,0 +1,11 @@ +## Event: LOSS_OF_CONTROL_COMMENTATOR_UPDATE + +**Title:** LOSS OF CONTROL COMMENTATOR UPDATE + +**Content:** +Fired when the primary active loss-of-control effect is updated. Only relevant for commentator mode. +`LOSS_OF_CONTROL_COMMENTATOR_UPDATE: victim` + +**Payload:** +- `victim` + - *string* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_UPDATE.md b/wiki-information/events/LOSS_OF_CONTROL_UPDATE.md new file mode 100644 index 00000000..689c139d --- /dev/null +++ b/wiki-information/events/LOSS_OF_CONTROL_UPDATE.md @@ -0,0 +1,10 @@ +## Event: LOSS_OF_CONTROL_UPDATE + +**Title:** LOSS OF CONTROL UPDATE + +**Content:** +Needs summary. +`LOSS_OF_CONTROL_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/LUA_WARNING.md b/wiki-information/events/LUA_WARNING.md new file mode 100644 index 00000000..0cdf5735 --- /dev/null +++ b/wiki-information/events/LUA_WARNING.md @@ -0,0 +1,13 @@ +## Event: LUA_WARNING + +**Title:** LUA WARNING + +**Content:** +Needs summary. +`LUA_WARNING: warnType, warningText` + +**Payload:** +- `warnType` + - *number* +- `warningText` + - *string* \ No newline at end of file diff --git a/wiki-information/events/MACRO_ACTION_BLOCKED.md b/wiki-information/events/MACRO_ACTION_BLOCKED.md new file mode 100644 index 00000000..87245c81 --- /dev/null +++ b/wiki-information/events/MACRO_ACTION_BLOCKED.md @@ -0,0 +1,11 @@ +## Event: MACRO_ACTION_BLOCKED + +**Title:** MACRO ACTION BLOCKED + +**Content:** +(this event doesn't seem to be used anymore, use MACRO_ACTION_FORBIDDEN) +`MACRO_ACTION_BLOCKED: function` + +**Payload:** +- `function` + - *string* \ No newline at end of file diff --git a/wiki-information/events/MACRO_ACTION_FORBIDDEN.md b/wiki-information/events/MACRO_ACTION_FORBIDDEN.md new file mode 100644 index 00000000..5f1b492d --- /dev/null +++ b/wiki-information/events/MACRO_ACTION_FORBIDDEN.md @@ -0,0 +1,11 @@ +## Event: MACRO_ACTION_FORBIDDEN + +**Title:** MACRO ACTION FORBIDDEN + +**Content:** +Sent when a macro tries use actions that are always forbidden (movement, targeting, etc.). +`MACRO_ACTION_FORBIDDEN: function` + +**Payload:** +- `function` + - *string* - The name of the forbidden function, e.g. "ToggleRun()" \ No newline at end of file diff --git a/wiki-information/events/MAIL_CLOSED.md b/wiki-information/events/MAIL_CLOSED.md new file mode 100644 index 00000000..9ffd005c --- /dev/null +++ b/wiki-information/events/MAIL_CLOSED.md @@ -0,0 +1,10 @@ +## Event: MAIL_CLOSED + +**Title:** MAIL CLOSED + +**Content:** +Fired when the mailbox window is closed. +`MAIL_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_FAILED.md b/wiki-information/events/MAIL_FAILED.md new file mode 100644 index 00000000..25ca3b4e --- /dev/null +++ b/wiki-information/events/MAIL_FAILED.md @@ -0,0 +1,11 @@ +## Event: MAIL_FAILED + +**Title:** MAIL FAILED + +**Content:** +Needs summary. +`MAIL_FAILED: itemID` + +**Payload:** +- `itemID` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/MAIL_INBOX_UPDATE.md b/wiki-information/events/MAIL_INBOX_UPDATE.md new file mode 100644 index 00000000..5c18a91a --- /dev/null +++ b/wiki-information/events/MAIL_INBOX_UPDATE.md @@ -0,0 +1,15 @@ +## Event: MAIL_INBOX_UPDATE + +**Title:** MAIL INBOX UPDATE + +**Content:** +This event is fired when the inbox changes in any way. +`MAIL_INBOX_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +- Fires when the inbox list is loaded while the frame is open +- Fires when mail item changes from new to read +- Fires when mail item is opened for the first time in a session \ No newline at end of file diff --git a/wiki-information/events/MAIL_LOCK_SEND_ITEMS.md b/wiki-information/events/MAIL_LOCK_SEND_ITEMS.md new file mode 100644 index 00000000..72cb8dab --- /dev/null +++ b/wiki-information/events/MAIL_LOCK_SEND_ITEMS.md @@ -0,0 +1,13 @@ +## Event: MAIL_LOCK_SEND_ITEMS + +**Title:** MAIL LOCK SEND ITEMS + +**Content:** +Fired when you send an item that needs a confirmation (e.g. Heirlooms that are still refundable) +`MAIL_LOCK_SEND_ITEMS: attachSlot, itemLink` + +**Payload:** +- `attachSlot` + - *number* - Mail Slot +- `itemLink` + - *string* \ No newline at end of file diff --git a/wiki-information/events/MAIL_SEND_INFO_UPDATE.md b/wiki-information/events/MAIL_SEND_INFO_UPDATE.md new file mode 100644 index 00000000..0eceba4f --- /dev/null +++ b/wiki-information/events/MAIL_SEND_INFO_UPDATE.md @@ -0,0 +1,10 @@ +## Event: MAIL_SEND_INFO_UPDATE + +**Title:** MAIL SEND INFO UPDATE + +**Content:** +Fired when an item is dragged to or from the Send Item box in an outgoing mail message. +`MAIL_SEND_INFO_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_SEND_SUCCESS.md b/wiki-information/events/MAIL_SEND_SUCCESS.md new file mode 100644 index 00000000..37368a73 --- /dev/null +++ b/wiki-information/events/MAIL_SEND_SUCCESS.md @@ -0,0 +1,10 @@ +## Event: MAIL_SEND_SUCCESS + +**Title:** MAIL SEND SUCCESS + +**Content:** +Fired when a mail has been successfully sent to the mailbox of the recipient. +`MAIL_SEND_SUCCESS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_SHOW.md b/wiki-information/events/MAIL_SHOW.md new file mode 100644 index 00000000..e57ef25f --- /dev/null +++ b/wiki-information/events/MAIL_SHOW.md @@ -0,0 +1,10 @@ +## Event: MAIL_SHOW + +**Title:** MAIL SHOW + +**Content:** +Fired when the mailbox is first opened. +`MAIL_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_SUCCESS.md b/wiki-information/events/MAIL_SUCCESS.md new file mode 100644 index 00000000..17fcc57f --- /dev/null +++ b/wiki-information/events/MAIL_SUCCESS.md @@ -0,0 +1,11 @@ +## Event: MAIL_SUCCESS + +**Title:** MAIL SUCCESS + +**Content:** +Needs summary. +`MAIL_SUCCESS: itemID` + +**Payload:** +- `itemID` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md b/wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md new file mode 100644 index 00000000..9e1eba6f --- /dev/null +++ b/wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md @@ -0,0 +1,10 @@ +## Event: MAIL_UNLOCK_SEND_ITEMS + +**Title:** MAIL UNLOCK SEND ITEMS + +**Content:** +Fires when the mail confirmation is cancelled and the concerned item(s) need to be unlocked. +`MAIL_UNLOCK_SEND_ITEMS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MAP_EXPLORATION_UPDATED.md b/wiki-information/events/MAP_EXPLORATION_UPDATED.md new file mode 100644 index 00000000..6d6d7ac0 --- /dev/null +++ b/wiki-information/events/MAP_EXPLORATION_UPDATED.md @@ -0,0 +1,10 @@ +## Event: MAP_EXPLORATION_UPDATED + +**Title:** MAP EXPLORATION UPDATED + +**Content:** +Needs summary. +`MAP_EXPLORATION_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md b/wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md new file mode 100644 index 00000000..2e89ee02 --- /dev/null +++ b/wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md @@ -0,0 +1,10 @@ +## Event: MAX_EXPANSION_LEVEL_UPDATED + +**Title:** MAX EXPANSION LEVEL UPDATED + +**Content:** +Needs summary. +`MAX_EXPANSION_LEVEL_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md b/wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md new file mode 100644 index 00000000..7d44cdaf --- /dev/null +++ b/wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md @@ -0,0 +1,11 @@ +## Event: MAX_SPELL_START_RECOVERY_OFFSET_CHANGED + +**Title:** MAX SPELL START RECOVERY OFFSET CHANGED + +**Content:** +Needs summary. +`MAX_SPELL_START_RECOVERY_OFFSET_CHANGED: clampedNewQueueWindowMs` + +**Payload:** +- `clampedNewQueueWindowMs` + - *number* \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_CLOSED.md b/wiki-information/events/MERCHANT_CLOSED.md new file mode 100644 index 00000000..b5ae8029 --- /dev/null +++ b/wiki-information/events/MERCHANT_CLOSED.md @@ -0,0 +1,10 @@ +## Event: MERCHANT_CLOSED + +**Title:** MERCHANT CLOSED + +**Content:** +Fired when a merchant frame closes. (Called twice). +`MERCHANT_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md b/wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md new file mode 100644 index 00000000..4afdc809 --- /dev/null +++ b/wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md @@ -0,0 +1,11 @@ +## Event: MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL + +**Title:** MERCHANT CONFIRM TRADE TIMER REMOVAL + +**Content:** +Needs summary. +`MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL: itemLink` + +**Payload:** +- `itemLink` + - *string* \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md b/wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md new file mode 100644 index 00000000..a2709788 --- /dev/null +++ b/wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md @@ -0,0 +1,11 @@ +## Event: MERCHANT_FILTER_ITEM_UPDATE + +**Title:** MERCHANT FILTER ITEM UPDATE + +**Content:** +Needs summary. +`MERCHANT_FILTER_ITEM_UPDATE: itemID` + +**Payload:** +- `itemID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_SHOW.md b/wiki-information/events/MERCHANT_SHOW.md new file mode 100644 index 00000000..37a77d5c --- /dev/null +++ b/wiki-information/events/MERCHANT_SHOW.md @@ -0,0 +1,10 @@ +## Event: MERCHANT_SHOW + +**Title:** MERCHANT SHOW + +**Content:** +Fired when the merchant frame is shown. +`MERCHANT_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_UPDATE.md b/wiki-information/events/MERCHANT_UPDATE.md new file mode 100644 index 00000000..bd0980e0 --- /dev/null +++ b/wiki-information/events/MERCHANT_UPDATE.md @@ -0,0 +1,10 @@ +## Event: MERCHANT_UPDATE + +**Title:** MERCHANT UPDATE + +**Content:** +Fired when a merchant updates. +`MERCHANT_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MINIMAP_PING.md b/wiki-information/events/MINIMAP_PING.md new file mode 100644 index 00000000..214166e9 --- /dev/null +++ b/wiki-information/events/MINIMAP_PING.md @@ -0,0 +1,15 @@ +## Event: MINIMAP_PING + +**Title:** MINIMAP PING + +**Content:** +Fired when the minimap is pinged. +`MINIMAP_PING: unitTarget, y, x` + +**Payload:** +- `unitTarget` + - *string* : UnitId - Unit that created the ping (i.e. "player" or any of the group members) +- `y` + - *number* +- `x` + - *number* \ No newline at end of file diff --git a/wiki-information/events/MINIMAP_UPDATE_TRACKING.md b/wiki-information/events/MINIMAP_UPDATE_TRACKING.md new file mode 100644 index 00000000..a2c046e3 --- /dev/null +++ b/wiki-information/events/MINIMAP_UPDATE_TRACKING.md @@ -0,0 +1,10 @@ +## Event: MINIMAP_UPDATE_TRACKING + +**Title:** MINIMAP UPDATE TRACKING + +**Content:** +Fired when the player selects a different tracking type from the menu attached to the mini map. +`MINIMAP_UPDATE_TRACKING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MINIMAP_UPDATE_ZOOM.md b/wiki-information/events/MINIMAP_UPDATE_ZOOM.md new file mode 100644 index 00000000..7a92bcc0 --- /dev/null +++ b/wiki-information/events/MINIMAP_UPDATE_ZOOM.md @@ -0,0 +1,13 @@ +## Event: MINIMAP_UPDATE_ZOOM + +**Title:** MINIMAP UPDATE ZOOM + +**Content:** +Fired when the minimap scaling factor is changed. This happens, generally, whenever the player moves indoors from outside, or vice versa. To test the player's location, compare the minimapZoom and minimapInsideZoom CVars with the current minimap zoom level (see Minimap:GetZoom). +`MINIMAP_UPDATE_ZOOM` + +**Payload:** +- `None` + +**Content Details:** +This event does not relate to the + and - minimap zoom buttons. \ No newline at end of file diff --git a/wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md b/wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md new file mode 100644 index 00000000..8db6a451 --- /dev/null +++ b/wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md @@ -0,0 +1,10 @@ +## Event: MIN_EXPANSION_LEVEL_UPDATED + +**Title:** MIN EXPANSION LEVEL UPDATED + +**Content:** +Needs summary. +`MIN_EXPANSION_LEVEL_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/MIRROR_TIMER_PAUSE.md b/wiki-information/events/MIRROR_TIMER_PAUSE.md new file mode 100644 index 00000000..f749f746 --- /dev/null +++ b/wiki-information/events/MIRROR_TIMER_PAUSE.md @@ -0,0 +1,13 @@ +## Event: MIRROR_TIMER_PAUSE + +**Title:** MIRROR TIMER PAUSE + +**Content:** +Fired when the mirror timer is paused. +`MIRROR_TIMER_PAUSE: timerName, paused` + +**Payload:** +- `timerName` + - *string* +- `paused` + - *number* - pause duration \ No newline at end of file diff --git a/wiki-information/events/MIRROR_TIMER_START.md b/wiki-information/events/MIRROR_TIMER_START.md new file mode 100644 index 00000000..6787a15f --- /dev/null +++ b/wiki-information/events/MIRROR_TIMER_START.md @@ -0,0 +1,21 @@ +## Event: MIRROR_TIMER_START + +**Title:** MIRROR TIMER START + +**Content:** +Fired when some sort of timer starts. +`MIRROR_TIMER_START: timerName, value, maxValue, scale, paused, timerLabel` + +**Payload:** +- `timerName` + - *string* - e.g. "BREATH" +- `value` + - *number* - start-time in ms, e.g. 180000 +- `maxValue` + - *number* - max-time in ms, e.g. 180000 +- `scale` + - *number* - time added per second in seconds, for e.g. -1 +- `paused` + - *number* +- `timerLabel` + - *string* - e.g. "Breath" \ No newline at end of file diff --git a/wiki-information/events/MIRROR_TIMER_STOP.md b/wiki-information/events/MIRROR_TIMER_STOP.md new file mode 100644 index 00000000..08efd502 --- /dev/null +++ b/wiki-information/events/MIRROR_TIMER_STOP.md @@ -0,0 +1,11 @@ +## Event: MIRROR_TIMER_STOP + +**Title:** MIRROR TIMER STOP + +**Content:** +Fired when a mirror timer is stopped. +`MIRROR_TIMER_STOP: timerName` + +**Payload:** +- `timerName` + - *string* - e.g. "BREATH" \ No newline at end of file diff --git a/wiki-information/events/MODIFIER_STATE_CHANGED.md b/wiki-information/events/MODIFIER_STATE_CHANGED.md new file mode 100644 index 00000000..6b64ab44 --- /dev/null +++ b/wiki-information/events/MODIFIER_STATE_CHANGED.md @@ -0,0 +1,30 @@ +## Event: MODIFIER_STATE_CHANGED + +**Title:** MODIFIER STATE CHANGED + +**Content:** +Fired when shift/ctrl/alt keys are pressed or released. Does not fire when an EditBox has keyboard focus. +`MODIFIER_STATE_CHANGED: key, down` + +**Payload:** +- `key` + - *string* - LCTRL, RCTRL, LSHIFT, RSHIFT, LALT, RALT +- `down` + - *number* - 1 for pressed, 0 for released. + +**Content Details:** +Related API +IsModifierKeyDown + +**Usage:** +Prints when a modifier key is pressed down. +```lua +local function OnEvent(self, event, key, down) + if down == 1 then + print("pressed in", key) + end +end +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/events/MOUNT_CURSOR_CLEAR.md b/wiki-information/events/MOUNT_CURSOR_CLEAR.md new file mode 100644 index 00000000..f50f246f --- /dev/null +++ b/wiki-information/events/MOUNT_CURSOR_CLEAR.md @@ -0,0 +1,13 @@ +## Event: MOUNT_CURSOR_CLEAR + +**Title:** MOUNT CURSOR CLEAR + +**Content:** +Fires after the player is no longer dragging a mount ability. +`MOUNT_CURSOR_CLEAR` + +**Payload:** +- `None` + +**Content Details:** +The ability might now be assigned to an action bar, unless the player cancelled the drag by right-clicking. \ No newline at end of file diff --git a/wiki-information/events/MUTELIST_UPDATE.md b/wiki-information/events/MUTELIST_UPDATE.md new file mode 100644 index 00000000..d180f8fd --- /dev/null +++ b/wiki-information/events/MUTELIST_UPDATE.md @@ -0,0 +1,10 @@ +## Event: MUTELIST_UPDATE + +**Title:** MUTELIST UPDATE + +**Content:** +Needs summary. +`MUTELIST_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/NAME_PLATE_CREATED.md b/wiki-information/events/NAME_PLATE_CREATED.md new file mode 100644 index 00000000..9b53268d --- /dev/null +++ b/wiki-information/events/NAME_PLATE_CREATED.md @@ -0,0 +1,38 @@ +## Event: NAME_PLATE_CREATED + +**Title:** NAME PLATE CREATED + +**Content:** +Needs summary. +`NAME_PLATE_CREATED: namePlateFrame` + +**Payload:** +- `namePlateFrame` + - *table* + - Field + - Type + - Description + - OnAdded + - function + - OnRemoved + - function + - OnOptionsUpdated + - function + - ApplyOffsets + - function + - GetAdditionalInsetPadding + - function + - GetPreferredInsets + - function + - OnSizeChanged + - function + - driverFrame + - NamePlateDriverFrame? + - UnitFrame + - Button? + - namePlateUnitToken + - string? + - e.g. "nameplate1" + - template + - string + - e.g. "NamePlateUnitFrameTemplate" \ No newline at end of file diff --git a/wiki-information/events/NAME_PLATE_UNIT_ADDED.md b/wiki-information/events/NAME_PLATE_UNIT_ADDED.md new file mode 100644 index 00000000..4c79891f --- /dev/null +++ b/wiki-information/events/NAME_PLATE_UNIT_ADDED.md @@ -0,0 +1,11 @@ +## Event: NAME_PLATE_UNIT_ADDED + +**Title:** NAME PLATE UNIT ADDED + +**Content:** +Fires when a nameplate is to be added. The event may sometimes fire before a nameplate is actually added. +`NAME_PLATE_UNIT_ADDED: unitToken` + +**Payload:** +- `unitToken` + - *string* : UnitId - The added unit in nameplateN format. \ No newline at end of file diff --git a/wiki-information/events/NAME_PLATE_UNIT_REMOVED.md b/wiki-information/events/NAME_PLATE_UNIT_REMOVED.md new file mode 100644 index 00000000..c7d622f7 --- /dev/null +++ b/wiki-information/events/NAME_PLATE_UNIT_REMOVED.md @@ -0,0 +1,11 @@ +## Event: NAME_PLATE_UNIT_REMOVED + +**Title:** NAME PLATE UNIT REMOVED + +**Content:** +Fires when a nameplate is to be removed. The event may sometimes fire before a nameplate is actually removed. +`NAME_PLATE_UNIT_REMOVED: unitToken` + +**Payload:** +- `unitToken` + - *string* : UnitId - The removed unit in nameplateN format. \ No newline at end of file diff --git a/wiki-information/events/NEW_AUCTION_UPDATE.md b/wiki-information/events/NEW_AUCTION_UPDATE.md new file mode 100644 index 00000000..0b84e4a0 --- /dev/null +++ b/wiki-information/events/NEW_AUCTION_UPDATE.md @@ -0,0 +1,13 @@ +## Event: NEW_AUCTION_UPDATE + +**Title:** NEW AUCTION UPDATE + +**Content:** +Fired when a user drags an item into the Auction Item box on the Auctions tab of the auction house window. +`NEW_AUCTION_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +You can retrieve information about the item for which an auction is being considered using `GetAuctionSellItemInfo()` \ No newline at end of file diff --git a/wiki-information/events/NEW_RECIPE_LEARNED.md b/wiki-information/events/NEW_RECIPE_LEARNED.md new file mode 100644 index 00000000..10bfe3ac --- /dev/null +++ b/wiki-information/events/NEW_RECIPE_LEARNED.md @@ -0,0 +1,15 @@ +## Event: NEW_RECIPE_LEARNED + +**Title:** NEW RECIPE LEARNED + +**Content:** +Needs summary. +`NEW_RECIPE_LEARNED: recipeID, recipeLevel, baseRecipeID` + +**Payload:** +- `recipeID` + - *number* +- `recipeLevel` + - *number?* +- `baseRecipeID` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/NEW_TOY_ADDED.md b/wiki-information/events/NEW_TOY_ADDED.md new file mode 100644 index 00000000..628d722c --- /dev/null +++ b/wiki-information/events/NEW_TOY_ADDED.md @@ -0,0 +1,15 @@ +## Event: NEW_TOY_ADDED + +**Title:** NEW TOY ADDED + +**Content:** +Fires when adding a new toy to the Toy Box. +`NEW_TOY_ADDED: itemID` + +**Payload:** +- `itemID` + - *number* - All possible values listed at ToyID. + +**Related Information:** +C_ToyBox.GetToyInfo(itemID) +TOYS_UPDATED \ No newline at end of file diff --git a/wiki-information/events/NEW_WMO_CHUNK.md b/wiki-information/events/NEW_WMO_CHUNK.md new file mode 100644 index 00000000..7c45943c --- /dev/null +++ b/wiki-information/events/NEW_WMO_CHUNK.md @@ -0,0 +1,10 @@ +## Event: NEW_WMO_CHUNK + +**Title:** NEW WMO CHUNK + +**Content:** +Needs summary. +`NEW_WMO_CHUNK` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md b/wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md new file mode 100644 index 00000000..2a56543b --- /dev/null +++ b/wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: NOTCHED_DISPLAY_MODE_CHANGED + +**Title:** NOTCHED DISPLAY MODE CHANGED + +**Content:** +Needs summary. +`NOTCHED_DISPLAY_MODE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md b/wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md new file mode 100644 index 00000000..e51937cf --- /dev/null +++ b/wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md @@ -0,0 +1,10 @@ +## Event: NOTIFY_CHAT_SUPPRESSED + +**Title:** NOTIFY CHAT SUPPRESSED + +**Content:** +Needs summary. +`NOTIFY_CHAT_SUPPRESSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/NOTIFY_PVP_AFK_RESULT.md b/wiki-information/events/NOTIFY_PVP_AFK_RESULT.md new file mode 100644 index 00000000..d57edeb8 --- /dev/null +++ b/wiki-information/events/NOTIFY_PVP_AFK_RESULT.md @@ -0,0 +1,15 @@ +## Event: NOTIFY_PVP_AFK_RESULT + +**Title:** NOTIFY PVP AFK RESULT + +**Content:** +Needs summary. +`NOTIFY_PVP_AFK_RESULT: offender, numBlackMarksOnOffender, numPlayersIHaveReported` + +**Payload:** +- `offender` + - *string* +- `numBlackMarksOnOffender` + - *number* +- `numPlayersIHaveReported` + - *number* \ No newline at end of file diff --git a/wiki-information/events/OBJECT_ENTERED_AOI.md b/wiki-information/events/OBJECT_ENTERED_AOI.md new file mode 100644 index 00000000..aa04244f --- /dev/null +++ b/wiki-information/events/OBJECT_ENTERED_AOI.md @@ -0,0 +1,11 @@ +## Event: OBJECT_ENTERED_AOI + +**Title:** OBJECT ENTERED AOI + +**Content:** +Needs summary. +`OBJECT_ENTERED_AOI: guid` + +**Payload:** +- `guid` + - *string* \ No newline at end of file diff --git a/wiki-information/events/OBJECT_LEFT_AOI.md b/wiki-information/events/OBJECT_LEFT_AOI.md new file mode 100644 index 00000000..64666ee0 --- /dev/null +++ b/wiki-information/events/OBJECT_LEFT_AOI.md @@ -0,0 +1,11 @@ +## Event: OBJECT_LEFT_AOI + +**Title:** OBJECT LEFT AOI + +**Content:** +Needs summary. +`OBJECT_LEFT_AOI: guid` + +**Payload:** +- `guid` + - *string* \ No newline at end of file diff --git a/wiki-information/events/OBLITERUM_FORGE_CLOSE.md b/wiki-information/events/OBLITERUM_FORGE_CLOSE.md new file mode 100644 index 00000000..77d01810 --- /dev/null +++ b/wiki-information/events/OBLITERUM_FORGE_CLOSE.md @@ -0,0 +1,10 @@ +## Event: OBLITERUM_FORGE_CLOSE + +**Title:** OBLITERUM FORGE CLOSE + +**Content:** +Needs summary. +`OBLITERUM_FORGE_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md b/wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md new file mode 100644 index 00000000..3af47b06 --- /dev/null +++ b/wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md @@ -0,0 +1,10 @@ +## Event: OBLITERUM_FORGE_PENDING_ITEM_CHANGED + +**Title:** OBLITERUM FORGE PENDING ITEM CHANGED + +**Content:** +Needs summary. +`OBLITERUM_FORGE_PENDING_ITEM_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/OBLITERUM_FORGE_SHOW.md b/wiki-information/events/OBLITERUM_FORGE_SHOW.md new file mode 100644 index 00000000..7b2e9949 --- /dev/null +++ b/wiki-information/events/OBLITERUM_FORGE_SHOW.md @@ -0,0 +1,10 @@ +## Event: OBLITERUM_FORGE_SHOW + +**Title:** OBLITERUM FORGE SHOW + +**Content:** +Needs summary. +`OBLITERUM_FORGE_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/OPEN_MASTER_LOOT_LIST.md b/wiki-information/events/OPEN_MASTER_LOOT_LIST.md new file mode 100644 index 00000000..f4b2aa81 --- /dev/null +++ b/wiki-information/events/OPEN_MASTER_LOOT_LIST.md @@ -0,0 +1,10 @@ +## Event: OPEN_MASTER_LOOT_LIST + +**Title:** OPEN MASTER LOOT LIST + +**Content:** +Needs summary. +`OPEN_MASTER_LOOT_LIST` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/OPEN_REPORT_PLAYER.md b/wiki-information/events/OPEN_REPORT_PLAYER.md new file mode 100644 index 00000000..0abbc166 --- /dev/null +++ b/wiki-information/events/OPEN_REPORT_PLAYER.md @@ -0,0 +1,35 @@ +## Event: OPEN_REPORT_PLAYER + +**Title:** OPEN REPORT PLAYER + +**Content:** +Fired after launching the player reporting window. +`OPEN_REPORT_PLAYER: token, reportType, playerName` + +**Payload:** +- `token` + - *number* - report Id +- `reportType` + - *string* - One of the values in PLAYER_REPORT_TYPE⊞ + - ⊟ + - PLAYER_REPORT_TYPE + - Constant + - Value + - PLAYER_REPORT_TYPE_SPAM + - spam + - PLAYER_REPORT_TYPE_LANGUAGE + - language + - PLAYER_REPORT_TYPE_ABUSE + - abuse + - PLAYER_REPORT_TYPE_BAD_PLAYER_NAME + - badplayername + - PLAYER_REPORT_TYPE_BAD_GUILD_NAME + - badguildname + - PLAYER_REPORT_TYPE_CHEATING + - cheater + - PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME + - badbattlepetname + - PLAYER_REPORT_TYPE_BAD_PET_NAME + - badpetname +- `playerName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/OPEN_TABARD_FRAME.md b/wiki-information/events/OPEN_TABARD_FRAME.md new file mode 100644 index 00000000..1779a1d9 --- /dev/null +++ b/wiki-information/events/OPEN_TABARD_FRAME.md @@ -0,0 +1,10 @@ +## Event: OPEN_TABARD_FRAME + +**Title:** OPEN TABARD FRAME + +**Content:** +Fired when interacting with an NPC allowing guild tabard customization. +`OPEN_TABARD_FRAME` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_INVITE_CANCEL.md b/wiki-information/events/PARTY_INVITE_CANCEL.md new file mode 100644 index 00000000..7ff434b9 --- /dev/null +++ b/wiki-information/events/PARTY_INVITE_CANCEL.md @@ -0,0 +1,10 @@ +## Event: PARTY_INVITE_CANCEL + +**Title:** PARTY INVITE CANCEL + +**Content:** +Fired when you decline a party invite. +`PARTY_INVITE_CANCEL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_INVITE_REQUEST.md b/wiki-information/events/PARTY_INVITE_REQUEST.md new file mode 100644 index 00000000..fb06b8cb --- /dev/null +++ b/wiki-information/events/PARTY_INVITE_REQUEST.md @@ -0,0 +1,25 @@ +## Event: PARTY_INVITE_REQUEST + +**Title:** PARTY INVITE REQUEST + +**Content:** +Fires when a player invite you to party. +`PARTY_INVITE_REQUEST: name, isTank, isHealer, isDamage, isNativeRealm, allowMultipleRoles, inviterGUID, questSessionActive` + +**Payload:** +- `name` + - *string* - The player that invited you. +- `isTank` + - *boolean* +- `isHealer` + - *boolean* +- `isDamage` + - *boolean* +- `isNativeRealm` + - *boolean* - Whether the invite is cross realm +- `allowMultipleRoles` + - *boolean* +- `inviterGUID` + - *string* +- `questSessionActive` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/PARTY_LEADER_CHANGED.md b/wiki-information/events/PARTY_LEADER_CHANGED.md new file mode 100644 index 00000000..ffc7c786 --- /dev/null +++ b/wiki-information/events/PARTY_LEADER_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PARTY_LEADER_CHANGED + +**Title:** PARTY LEADER CHANGED + +**Content:** +Fired when the player's leadership changed. +`PARTY_LEADER_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md b/wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md new file mode 100644 index 00000000..00bb51c3 --- /dev/null +++ b/wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PARTY_LOOT_METHOD_CHANGED + +**Title:** PARTY LOOT METHOD CHANGED + +**Content:** +Fired when the party's loot method changes. +`PARTY_LOOT_METHOD_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_MEMBER_DISABLE.md b/wiki-information/events/PARTY_MEMBER_DISABLE.md new file mode 100644 index 00000000..24b1b83e --- /dev/null +++ b/wiki-information/events/PARTY_MEMBER_DISABLE.md @@ -0,0 +1,11 @@ +## Event: PARTY_MEMBER_DISABLE + +**Title:** PARTY MEMBER DISABLE + +**Content:** +Fired when a specific party member is offline or dead. +`PARTY_MEMBER_DISABLE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PARTY_MEMBER_ENABLE.md b/wiki-information/events/PARTY_MEMBER_ENABLE.md new file mode 100644 index 00000000..7a88dd0d --- /dev/null +++ b/wiki-information/events/PARTY_MEMBER_ENABLE.md @@ -0,0 +1,11 @@ +## Event: PARTY_MEMBER_ENABLE + +**Title:** PARTY MEMBER ENABLE + +**Content:** +Fired when a specific party member is still connected. +`PARTY_MEMBER_ENABLE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md b/wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md new file mode 100644 index 00000000..62b6cd39 --- /dev/null +++ b/wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: PENDING_AZERITE_ESSENCE_CHANGED + +**Title:** PENDING AZERITE ESSENCE CHANGED + +**Content:** +Sent to the add on when the Heart of Azeroth modification window is open and the player left-clicks to "pick up" a Heart ability in the list of abilities to the right. Also sent when an ability is "dropped" by the cursor in any of the following ways - placing the ability in the center of the heart, closing the window, or left-clicking in the window outside the center target zone. +`PENDING_AZERITE_ESSENCE_CHANGED: essenceID` + +**Payload:** +- `essenceID` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/PETITION_CLOSED.md b/wiki-information/events/PETITION_CLOSED.md new file mode 100644 index 00000000..5cba3370 --- /dev/null +++ b/wiki-information/events/PETITION_CLOSED.md @@ -0,0 +1,10 @@ +## Event: PETITION_CLOSED + +**Title:** PETITION CLOSED + +**Content:** +Fired when a petition is closed, e.g. by you signing it. +`PETITION_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PETITION_SHOW.md b/wiki-information/events/PETITION_SHOW.md new file mode 100644 index 00000000..2be8ce09 --- /dev/null +++ b/wiki-information/events/PETITION_SHOW.md @@ -0,0 +1,10 @@ +## Event: PETITION_SHOW + +**Title:** PETITION SHOW + +**Content:** +Fired when you are shown a petition to create a guild or arena team. This can be due to someone offering you to sign it, or because of you clicking your own charter in your inventory. See GetPetitionInfo. +`PETITION_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_ATTACK_START.md b/wiki-information/events/PET_ATTACK_START.md new file mode 100644 index 00000000..9a12b155 --- /dev/null +++ b/wiki-information/events/PET_ATTACK_START.md @@ -0,0 +1,10 @@ +## Event: PET_ATTACK_START + +**Title:** PET ATTACK START + +**Content:** +Fired when the player's pet begins attacking. +`PET_ATTACK_START` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_ATTACK_STOP.md b/wiki-information/events/PET_ATTACK_STOP.md new file mode 100644 index 00000000..d2092415 --- /dev/null +++ b/wiki-information/events/PET_ATTACK_STOP.md @@ -0,0 +1,10 @@ +## Event: PET_ATTACK_STOP + +**Title:** PET ATTACK STOP + +**Content:** +Fired when the player's pet ceases attack. +`PET_ATTACK_STOP` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_HIDEGRID.md b/wiki-information/events/PET_BAR_HIDEGRID.md new file mode 100644 index 00000000..6a036cae --- /dev/null +++ b/wiki-information/events/PET_BAR_HIDEGRID.md @@ -0,0 +1,10 @@ +## Event: PET_BAR_HIDEGRID + +**Title:** PET BAR HIDEGRID + +**Content:** +Fired when pet spells are dropped into the PetActionBar. +`PET_BAR_HIDEGRID` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_SHOWGRID.md b/wiki-information/events/PET_BAR_SHOWGRID.md new file mode 100644 index 00000000..18c3add1 --- /dev/null +++ b/wiki-information/events/PET_BAR_SHOWGRID.md @@ -0,0 +1,10 @@ +## Event: PET_BAR_SHOWGRID + +**Title:** PET BAR SHOWGRID + +**Content:** +Fired when pet spells are dragged from the pet spellbook or the PetActionBar. +`PET_BAR_SHOWGRID` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_UPDATE.md b/wiki-information/events/PET_BAR_UPDATE.md new file mode 100644 index 00000000..6fa64709 --- /dev/null +++ b/wiki-information/events/PET_BAR_UPDATE.md @@ -0,0 +1,19 @@ +## Event: PET_BAR_UPDATE + +**Title:** PET BAR UPDATE + +**Content:** +Fired whenever the pet bar is updated and its GUI needs to be re-rendered/refreshed. +`PET_BAR_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +Examples of actions which trigger this event: +- Losing your pet (causes the pet bar to vanish). +- Gaining a pet (causes the pet bar to appear). +- Triggering the pet "aggressive/defensive/passive" state (whether via the button or via commands like "/petdefensive"). Triggers even if the new state is the same as last time (ie. by re-triggering the same button multiple times in a row). +- Triggering the pet "follow" or "stay" commands (but not the "attack" command since unlike the others, its button never gets highlighted on the bar while the pet is attacking). Just like the aggressiveness state, this also reacts via commands like "/petstay", and will likewise react to repeated re-triggering (through any method). +- Toggling pet skill "autocast" state, regardless of whether you do it via the spellbook, or right-clicking on the bar icon itself, or using commands like "/petautocasttoggle Growl". +- Moving icons on the pet skill bar, such as by dragging icons from the pet spellbook onto the pet bar. (This is not your regular player action bar, which of course can't even contain pet spells even if you attempt to drag them there manually.) \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md b/wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md new file mode 100644 index 00000000..cb500070 --- /dev/null +++ b/wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md @@ -0,0 +1,10 @@ +## Event: PET_BAR_UPDATE_COOLDOWN + +**Title:** PET BAR UPDATE COOLDOWN + +**Content:** +Fired when a pet spell cooldown starts. It is not called when the cooldown ends. +`PET_BAR_UPDATE_COOLDOWN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_UPDATE_USABLE.md b/wiki-information/events/PET_BAR_UPDATE_USABLE.md new file mode 100644 index 00000000..1ff5c4b9 --- /dev/null +++ b/wiki-information/events/PET_BAR_UPDATE_USABLE.md @@ -0,0 +1,10 @@ +## Event: PET_BAR_UPDATE_USABLE + +**Title:** PET BAR UPDATE USABLE + +**Content:** +Needs summary. +`PET_BAR_UPDATE_USABLE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md b/wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md new file mode 100644 index 00000000..86cf36b2 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_ABILITY_CHANGED + +**Title:** PET BATTLE ABILITY CHANGED + +**Content:** +Needs summary. +`PET_BATTLE_ABILITY_CHANGED: owner, petIndex, abilityID` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* +- `abilityID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_ACTION_SELECTED.md b/wiki-information/events/PET_BATTLE_ACTION_SELECTED.md new file mode 100644 index 00000000..2f041365 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_ACTION_SELECTED.md @@ -0,0 +1,10 @@ +## Event: PET_BATTLE_ACTION_SELECTED + +**Title:** PET BATTLE ACTION SELECTED + +**Content:** +Needs summary. +`PET_BATTLE_ACTION_SELECTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_AURA_APPLIED.md b/wiki-information/events/PET_BATTLE_AURA_APPLIED.md new file mode 100644 index 00000000..75013fcf --- /dev/null +++ b/wiki-information/events/PET_BATTLE_AURA_APPLIED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_AURA_APPLIED + +**Title:** PET BATTLE AURA APPLIED + +**Content:** +Needs summary. +`PET_BATTLE_AURA_APPLIED: owner, petIndex, auraInstanceID` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* +- `auraInstanceID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_AURA_CANCELED.md b/wiki-information/events/PET_BATTLE_AURA_CANCELED.md new file mode 100644 index 00000000..26a9c0d4 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_AURA_CANCELED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_AURA_CANCELED + +**Title:** PET BATTLE AURA CANCELED + +**Content:** +Needs summary. +`PET_BATTLE_AURA_CANCELED: owner, petIndex, auraInstanceID` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* +- `auraInstanceID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_AURA_CHANGED.md b/wiki-information/events/PET_BATTLE_AURA_CHANGED.md new file mode 100644 index 00000000..cbd1ab1b --- /dev/null +++ b/wiki-information/events/PET_BATTLE_AURA_CHANGED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_AURA_CHANGED + +**Title:** PET BATTLE AURA CHANGED + +**Content:** +Needs summary. +`PET_BATTLE_AURA_CHANGED: owner, petIndex, auraInstanceID` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* +- `auraInstanceID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_CAPTURED.md b/wiki-information/events/PET_BATTLE_CAPTURED.md new file mode 100644 index 00000000..8859c4cc --- /dev/null +++ b/wiki-information/events/PET_BATTLE_CAPTURED.md @@ -0,0 +1,16 @@ +## Event: PET_BATTLE_CAPTURED + +**Title:** PET BATTLE CAPTURED + +**Content:** +Fired when a pet battle ends, if the player successfully captured a battle pet. +`PET_BATTLE_CAPTURED: owner, petIndex` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* + +**Content Details:** +This event does not fire when a trap successfully snares a pet during a battle. This event is meant to signify when a player snares a pet, wins the battle, and is able to add the pet to their Pet Journal. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_CLOSE.md b/wiki-information/events/PET_BATTLE_CLOSE.md new file mode 100644 index 00000000..4e844807 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_CLOSE.md @@ -0,0 +1,14 @@ +## Event: PET_BATTLE_CLOSE + +**Title:** PET BATTLE CLOSE + +**Content:** +Fired twice when the client exists a Pet Battle. +`PET_BATTLE_CLOSE` + +**Payload:** +- `None` + +**Content Details:** +This event fires twice at the very end of a pet battle, instructing the client to transition back to normal character controls. +The macro conditional evaluates to true during the first firing, and false during the second. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_FINAL_ROUND.md b/wiki-information/events/PET_BATTLE_FINAL_ROUND.md new file mode 100644 index 00000000..e527715d --- /dev/null +++ b/wiki-information/events/PET_BATTLE_FINAL_ROUND.md @@ -0,0 +1,14 @@ +## Event: PET_BATTLE_FINAL_ROUND + +**Title:** PET BATTLE FINAL ROUND + +**Content:** +Fired at the end of the final round of a pet battle. +`PET_BATTLE_FINAL_ROUND: owner` + +**Payload:** +- `owner` + - *number* - Team index of the team that won the pet battle; 1 for the player's team, 2 for the opponent. + +**Content Details:** +This event is followed by HP recovery/XP gain notifications, and eventually PET_BATTLE_OVER and PET_BATTLE_CLOSE. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md b/wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md new file mode 100644 index 00000000..2ef6ab2c --- /dev/null +++ b/wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_HEALTH_CHANGED + +**Title:** PET BATTLE HEALTH CHANGED + +**Content:** +Needs summary. +`PET_BATTLE_HEALTH_CHANGED: owner, petIndex, healthChange` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* +- `healthChange` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md b/wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md new file mode 100644 index 00000000..cd88d3c8 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_LEVEL_CHANGED + +**Title:** PET BATTLE LEVEL CHANGED + +**Content:** +Fired when a battle pet levels. +`PET_BATTLE_LEVEL_CHANGED: owner, petIndex, newLevel` + +**Payload:** +- `owner` + - *number* - Active player the battle pet belongs to +- `petIndex` + - *number* - Active slot the battle pet is in +- `newLevel` + - *number* - New level for the battle pet \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md b/wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md new file mode 100644 index 00000000..b7ea70f9 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_MAX_HEALTH_CHANGED + +**Title:** PET BATTLE MAX HEALTH CHANGED + +**Content:** +Needs summary. +`PET_BATTLE_MAX_HEALTH_CHANGED: owner, petIndex, healthChange` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* +- `healthChange` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OPENING_DONE.md b/wiki-information/events/PET_BATTLE_OPENING_DONE.md new file mode 100644 index 00000000..ba267052 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_OPENING_DONE.md @@ -0,0 +1,13 @@ +## Event: PET_BATTLE_OPENING_DONE + +**Title:** PET BATTLE OPENING DONE + +**Content:** +Event fired at the end of camera transitioning for the pet battle +`PET_BATTLE_OPENING_DONE` + +**Payload:** +- `None` + +**Content Details:** +The transition is started with PET_BATTLE_OPENING_START. After this event the player is able to pet fight. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OPENING_START.md b/wiki-information/events/PET_BATTLE_OPENING_START.md new file mode 100644 index 00000000..46d03768 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_OPENING_START.md @@ -0,0 +1,13 @@ +## Event: PET_BATTLE_OPENING_START + +**Title:** PET BATTLE OPENING START + +**Content:** +Begins the transition between the current UI to the Pet Battle one. +`PET_BATTLE_OPENING_START` + +**Payload:** +- `None` + +**Content Details:** +The payer is able to battle after PET_BATTLE_OPENING_DONE \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OVER.md b/wiki-information/events/PET_BATTLE_OVER.md new file mode 100644 index 00000000..eb3c30c3 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_OVER.md @@ -0,0 +1,13 @@ +## Event: PET_BATTLE_OVER + +**Title:** PET BATTLE OVER + +**Content:** +Fired when the pet battle is over, and all combat actions have been resolved. +`PET_BATTLE_OVER` + +**Payload:** +- `None` + +**Content Details:** +This event follows the post-battle healing and XP gain events after PET_BATTLE_FINAL_ROUND, and precedes PET_BATTLE_CLOSE. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md b/wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md new file mode 100644 index 00000000..1c23696f --- /dev/null +++ b/wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md @@ -0,0 +1,11 @@ +## Event: PET_BATTLE_OVERRIDE_ABILITY + +**Title:** PET BATTLE OVERRIDE ABILITY + +**Content:** +Needs summary. +`PET_BATTLE_OVERRIDE_ABILITY: abilityIndex` + +**Payload:** +- `abilityIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_CHANGED.md b/wiki-information/events/PET_BATTLE_PET_CHANGED.md new file mode 100644 index 00000000..ab6b6d37 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_PET_CHANGED.md @@ -0,0 +1,14 @@ +## Event: PET_BATTLE_PET_CHANGED + +**Title:** PET BATTLE PET CHANGED + +**Content:** +Fired when a team's active battle pet changes. +`PET_BATTLE_PET_CHANGED: owner` + +**Payload:** +- `owner` + - *number* - index of the team the active pet of which has changed. + +**Content Details:** +C_PetBattles.GetActivePet returns the index of the new front-line pet when this event fires. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md b/wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md new file mode 100644 index 00000000..004e9ce8 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md @@ -0,0 +1,11 @@ +## Event: PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE + +**Title:** PET BATTLE PET ROUND PLAYBACK COMPLETE + +**Content:** +Needs summary. +`PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE: roundNumber` + +**Payload:** +- `roundNumber` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md b/wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md new file mode 100644 index 00000000..04a29e54 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md @@ -0,0 +1,11 @@ +## Event: PET_BATTLE_PET_ROUND_RESULTS + +**Title:** PET BATTLE PET ROUND RESULTS + +**Content:** +Needs summary. +`PET_BATTLE_PET_ROUND_RESULTS: roundNumber` + +**Payload:** +- `roundNumber` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md b/wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md new file mode 100644 index 00000000..73bb81a7 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md @@ -0,0 +1,15 @@ +## Event: PET_BATTLE_PET_TYPE_CHANGED + +**Title:** PET BATTLE PET TYPE CHANGED + +**Content:** +Needs summary. +`PET_BATTLE_PET_TYPE_CHANGED: owner, petIndex, stateValue` + +**Payload:** +- `owner` + - *number* +- `petIndex` + - *number* +- `stateValue` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md b/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md new file mode 100644 index 00000000..2021b4e0 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md @@ -0,0 +1,11 @@ +## Event: PET_BATTLE_PVP_DUEL_REQUESTED + +**Title:** PET BATTLE PVP DUEL REQUESTED + +**Content:** +Needs summary. +`PET_BATTLE_PVP_DUEL_REQUESTED: fullName` + +**Payload:** +- `fullName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md b/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md new file mode 100644 index 00000000..c3f2c8a0 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md @@ -0,0 +1,10 @@ +## Event: PET_BATTLE_PVP_DUEL_REQUEST_CANCEL + +**Title:** PET BATTLE PVP DUEL REQUEST CANCEL + +**Content:** +Needs summary. +`PET_BATTLE_PVP_DUEL_REQUEST_CANCEL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md new file mode 100644 index 00000000..25ebaa20 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md @@ -0,0 +1,10 @@ +## Event: PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED + +**Title:** PET BATTLE QUEUE PROPOSAL ACCEPTED + +**Content:** +Needs summary. +`PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md new file mode 100644 index 00000000..725f44c2 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md @@ -0,0 +1,10 @@ +## Event: PET_BATTLE_QUEUE_PROPOSAL_DECLINED + +**Title:** PET BATTLE QUEUE PROPOSAL DECLINED + +**Content:** +Needs summary. +`PET_BATTLE_QUEUE_PROPOSAL_DECLINED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md new file mode 100644 index 00000000..79e75faf --- /dev/null +++ b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md @@ -0,0 +1,10 @@ +## Event: PET_BATTLE_QUEUE_PROPOSE_MATCH + +**Title:** PET BATTLE QUEUE PROPOSE MATCH + +**Content:** +Needs summary. +`PET_BATTLE_QUEUE_PROPOSE_MATCH` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_STATUS.md b/wiki-information/events/PET_BATTLE_QUEUE_STATUS.md new file mode 100644 index 00000000..8a0f2ba7 --- /dev/null +++ b/wiki-information/events/PET_BATTLE_QUEUE_STATUS.md @@ -0,0 +1,10 @@ +## Event: PET_BATTLE_QUEUE_STATUS + +**Title:** PET BATTLE QUEUE STATUS + +**Content:** +Needs summary. +`PET_BATTLE_QUEUE_STATUS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_XP_CHANGED.md b/wiki-information/events/PET_BATTLE_XP_CHANGED.md new file mode 100644 index 00000000..fe9f2d3b --- /dev/null +++ b/wiki-information/events/PET_BATTLE_XP_CHANGED.md @@ -0,0 +1,18 @@ +## Event: PET_BATTLE_XP_CHANGED + +**Title:** PET BATTLE XP CHANGED + +**Content:** +Fired when a battle pet gains experience during a pet battle. +`PET_BATTLE_XP_CHANGED: owner, petIndex, xpChange` + +**Payload:** +- `owner` + - *number* - team to which the pet belongs, 1 for the player's team, 2 for the opponent. +- `petIndex` + - *number* - pet index within the team. +- `xpChange` + - *number* - amount of XP gained. + +**Content Details:** +The PetJournal and PetBattles APIs still return the old level/experience information for the pet when this event fires. \ No newline at end of file diff --git a/wiki-information/events/PET_DISMISS_START.md b/wiki-information/events/PET_DISMISS_START.md new file mode 100644 index 00000000..b9503859 --- /dev/null +++ b/wiki-information/events/PET_DISMISS_START.md @@ -0,0 +1,11 @@ +## Event: PET_DISMISS_START + +**Title:** PET DISMISS START + +**Content:** +Needs summary. +`PET_DISMISS_START: delay` + +**Payload:** +- `delay` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_FORCE_NAME_DECLENSION.md b/wiki-information/events/PET_FORCE_NAME_DECLENSION.md new file mode 100644 index 00000000..098d9372 --- /dev/null +++ b/wiki-information/events/PET_FORCE_NAME_DECLENSION.md @@ -0,0 +1,21 @@ +## Event: PET_FORCE_NAME_DECLENSION + +**Title:** PET FORCE NAME DECLENSION + +**Content:** +Needs summary. +`PET_FORCE_NAME_DECLENSION: name, declinedName1, declinedName2, declinedName3, declinedName4, declinedName5` + +**Payload:** +- `name` + - *string* +- `declinedName1` + - *string?* +- `declinedName2` + - *string?* +- `declinedName3` + - *string?* +- `declinedName4` + - *string?* +- `declinedName5` + - *string?* \ No newline at end of file diff --git a/wiki-information/events/PET_SPELL_POWER_UPDATE.md b/wiki-information/events/PET_SPELL_POWER_UPDATE.md new file mode 100644 index 00000000..b6ce245e --- /dev/null +++ b/wiki-information/events/PET_SPELL_POWER_UPDATE.md @@ -0,0 +1,10 @@ +## Event: PET_SPELL_POWER_UPDATE + +**Title:** PET SPELL POWER UPDATE + +**Content:** +Fires when the pet's spell power bonus changes. Use GetPetSpellBonusDamage() to retrieve the new value. +`PET_SPELL_POWER_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_CLOSED.md b/wiki-information/events/PET_STABLE_CLOSED.md new file mode 100644 index 00000000..6ec4ba56 --- /dev/null +++ b/wiki-information/events/PET_STABLE_CLOSED.md @@ -0,0 +1,10 @@ +## Event: PET_STABLE_CLOSED + +**Title:** PET STABLE CLOSED + +**Content:** +Needs summary. +`PET_STABLE_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_SHOW.md b/wiki-information/events/PET_STABLE_SHOW.md new file mode 100644 index 00000000..b9e72115 --- /dev/null +++ b/wiki-information/events/PET_STABLE_SHOW.md @@ -0,0 +1,10 @@ +## Event: PET_STABLE_SHOW + +**Title:** PET STABLE SHOW + +**Content:** +Needs summary. +`PET_STABLE_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_UPDATE.md b/wiki-information/events/PET_STABLE_UPDATE.md new file mode 100644 index 00000000..78da64dd --- /dev/null +++ b/wiki-information/events/PET_STABLE_UPDATE.md @@ -0,0 +1,10 @@ +## Event: PET_STABLE_UPDATE + +**Title:** PET STABLE UPDATE + +**Content:** +Needs summary. +`PET_STABLE_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md b/wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md new file mode 100644 index 00000000..57eeaf99 --- /dev/null +++ b/wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md @@ -0,0 +1,10 @@ +## Event: PET_STABLE_UPDATE_PAPERDOLL + +**Title:** PET STABLE UPDATE PAPERDOLL + +**Content:** +Needs summary. +`PET_STABLE_UPDATE_PAPERDOLL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_UI_CLOSE.md b/wiki-information/events/PET_UI_CLOSE.md new file mode 100644 index 00000000..a1ba24da --- /dev/null +++ b/wiki-information/events/PET_UI_CLOSE.md @@ -0,0 +1,10 @@ +## Event: PET_UI_CLOSE + +**Title:** PET UI CLOSE + +**Content:** +Needs summary. +`PET_UI_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_UI_UPDATE.md b/wiki-information/events/PET_UI_UPDATE.md new file mode 100644 index 00000000..405bafdc --- /dev/null +++ b/wiki-information/events/PET_UI_UPDATE.md @@ -0,0 +1,10 @@ +## Event: PET_UI_UPDATE + +**Title:** PET UI UPDATE + +**Content:** +Needs summary. +`PET_UI_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md b/wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md new file mode 100644 index 00000000..ff44f736 --- /dev/null +++ b/wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PLAYERBANKBAGSLOTS_CHANGED + +**Title:** PLAYERBANKBAGSLOTS CHANGED + +**Content:** +This event only fires when bank bags slots are purchased. It no longer fires when bags in the slots are changed. Instead, when the bags are changed, PLAYERBANKSLOTS_CHANGED will fire, and arg1 will be NUM_BANKGENERIC_SLOTS + BagIndex. +`PLAYERBANKBAGSLOTS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYERBANKSLOTS_CHANGED.md b/wiki-information/events/PLAYERBANKSLOTS_CHANGED.md new file mode 100644 index 00000000..bb9cd0b2 --- /dev/null +++ b/wiki-information/events/PLAYERBANKSLOTS_CHANGED.md @@ -0,0 +1,11 @@ +## Event: PLAYERBANKSLOTS_CHANGED + +**Title:** PLAYERBANKSLOTS CHANGED + +**Content:** +Fired when the One of the slots in the player's 24 bank slots has changed, or when any of the equipped bank bags have changed. Does not fire when an item is added to or removed from a bank bag. +`PLAYERBANKSLOTS_CHANGED: slot` + +**Payload:** +- `slot` + - *number* - When (slot <= NUM_BANKGENERIC_SLOTS), slot is the index of the generic bank slot that changed. When (slot > NUM_BANKGENERIC_SLOTS), (slot - NUM_BANKGENERIC_SLOTS) is the index of the equipped bank bag that changed. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ALIVE.md b/wiki-information/events/PLAYER_ALIVE.md new file mode 100644 index 00000000..3828b88c --- /dev/null +++ b/wiki-information/events/PLAYER_ALIVE.md @@ -0,0 +1,13 @@ +## Event: PLAYER_ALIVE + +**Title:** PLAYER ALIVE + +**Content:** +Fired when the player releases from death to a graveyard; or accepts a resurrect before releasing their spirit. +`PLAYER_ALIVE` + +**Payload:** +- `None` + +**Content Details:** +Does not fire when the player is alive after being a ghost. PLAYER_UNGHOST is triggered in that case. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md b/wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md new file mode 100644 index 00000000..cfa39227 --- /dev/null +++ b/wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md @@ -0,0 +1,19 @@ +## Event: PLAYER_AVG_ITEM_LEVEL_UPDATE + +**Title:** PLAYER AVG ITEM LEVEL UPDATE + +**Content:** +This event fires when the player's item level changes, and it fires on both maximum item level changes (when you acquire a new piece of soulbound armor of your armor type that has the highest item level in that slot) and equipped item level changes (equipping or removing armor). This event will therefore fire when you gain azerite if it levels up your . +It fires three times in all of these scenarios: +Equipping armor in an empty slot +Removing armor to leave that slot empty +Equipping armor in a slot where it would automatically remove another armor +Using the equipment manager to equip and remove multiple pieces of armor at once. +The following scenarios still need to be tested to see if they cause this event to fire: +The player puts their highest item level armor in the bank or void storage +The player's equipped armor loses all durability +The player's highest item level armor loses all durability while in the player's inventory +`PLAYER_AVG_ITEM_LEVEL_UPDATE` + +**Payload:** +- `None - You'll have to find some other way to get the player's equipped or maximum item level.` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_CAMPING.md b/wiki-information/events/PLAYER_CAMPING.md new file mode 100644 index 00000000..4caef11c --- /dev/null +++ b/wiki-information/events/PLAYER_CAMPING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_CAMPING + +**Title:** PLAYER CAMPING + +**Content:** +Fired when the player is camping (logging out). +`PLAYER_CAMPING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_CONTROL_GAINED.md b/wiki-information/events/PLAYER_CONTROL_GAINED.md new file mode 100644 index 00000000..d03e8140 --- /dev/null +++ b/wiki-information/events/PLAYER_CONTROL_GAINED.md @@ -0,0 +1,10 @@ +## Event: PLAYER_CONTROL_GAINED + +**Title:** PLAYER CONTROL GAINED + +**Content:** +Fires after the PLAYER_CONTROL_LOST event, when control has been restored to the player. +`PLAYER_CONTROL_GAINED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_CONTROL_LOST.md b/wiki-information/events/PLAYER_CONTROL_LOST.md new file mode 100644 index 00000000..a2a2588d --- /dev/null +++ b/wiki-information/events/PLAYER_CONTROL_LOST.md @@ -0,0 +1,10 @@ +## Event: PLAYER_CONTROL_LOST + +**Title:** PLAYER CONTROL LOST + +**Content:** +Fires whenever the player is unable to control the character. Examples are when afflicted by fear, mind controlled, or when using a taxi. +`PLAYER_CONTROL_LOST` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md b/wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md new file mode 100644 index 00000000..07d96ed0 --- /dev/null +++ b/wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md @@ -0,0 +1,11 @@ +## Event: PLAYER_DAMAGE_DONE_MODS + +**Title:** PLAYER DAMAGE DONE MODS + +**Content:** +Needs summary. +`PLAYER_DAMAGE_DONE_MODS: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_DEAD.md b/wiki-information/events/PLAYER_DEAD.md new file mode 100644 index 00000000..76b6b7fa --- /dev/null +++ b/wiki-information/events/PLAYER_DEAD.md @@ -0,0 +1,10 @@ +## Event: PLAYER_DEAD + +**Title:** PLAYER DEAD + +**Content:** +Fired when the player has died. +`PLAYER_DEAD` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md b/wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md new file mode 100644 index 00000000..57217e56 --- /dev/null +++ b/wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PLAYER_DIFFICULTY_CHANGED + +**Title:** PLAYER DIFFICULTY CHANGED + +**Content:** +Needs summary. +`PLAYER_DIFFICULTY_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md b/wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md new file mode 100644 index 00000000..60f1a970 --- /dev/null +++ b/wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md @@ -0,0 +1,10 @@ +## Event: PLAYER_ENTERING_BATTLEGROUND + +**Title:** PLAYER ENTERING BATTLEGROUND + +**Content:** +Needs summary. +`PLAYER_ENTERING_BATTLEGROUND` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ENTERING_WORLD.md b/wiki-information/events/PLAYER_ENTERING_WORLD.md new file mode 100644 index 00000000..4e506c2a --- /dev/null +++ b/wiki-information/events/PLAYER_ENTERING_WORLD.md @@ -0,0 +1,30 @@ +## Event: PLAYER_ENTERING_WORLD + +**Title:** PLAYER ENTERING WORLD + +**Content:** +Fires when the player logs in, /reloads the UI or zones between map instances. Basically whenever the loading screen appears. +`PLAYER_ENTERING_WORLD: isInitialLogin, isReloadingUi` + +**Payload:** +- `isInitialLogin` + - *boolean* - True whenever the character logs in. This includes logging out to character select and then logging in again. +- `isReloadingUi` + - *boolean* + +**Usage:** +```lua +local function OnEvent(self, event, isLogin, isReload) + if isLogin or isReload then + print("loaded the UI") + else + print("zoned between map instances") + end +end +local f = CreateFrame("Frame") +f:RegisterEvent("PLAYER_ENTERING_WORLD") +f:SetScript("OnEvent", OnEvent) +``` + +**Related Information:** +AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ENTER_COMBAT.md b/wiki-information/events/PLAYER_ENTER_COMBAT.md new file mode 100644 index 00000000..69a1c3b1 --- /dev/null +++ b/wiki-information/events/PLAYER_ENTER_COMBAT.md @@ -0,0 +1,14 @@ +## Event: PLAYER_ENTER_COMBAT + +**Title:** PLAYER ENTER COMBAT + +**Content:** +Fired when a player engages auto-attack. Note that firing a gun or a spell, or getting aggro, does NOT trigger this event. +`PLAYER_ENTER_COMBAT` + +**Payload:** +- `None` + +**Content Details:** +PLAYER_ENTER_COMBAT and PLAYER_LEAVE_COMBAT are for *MELEE* combat only. They fire when you initiate autoattack and when you turn it off. However, any spell or ability that does not turn on autoattack does not trigger it. Nor does it trigger when you get aggro. +You probably want PLAYER_REGEN_DISABLED (fires when you get aggro) and PLAYER_REGEN_ENABLED (fires when you lose aggro). \ No newline at end of file diff --git a/wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md b/wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md new file mode 100644 index 00000000..2ac6a8a1 --- /dev/null +++ b/wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md @@ -0,0 +1,18 @@ +## Event: PLAYER_EQUIPMENT_CHANGED + +**Title:** PLAYER EQUIPMENT CHANGED + +**Content:** +This event is fired when the players gear changes. +`PLAYER_EQUIPMENT_CHANGED: equipmentSlot, hasCurrent` + +**Payload:** +- `equipmentSlot` + - *number* - InventorySlotId +- `hasCurrent` + - *boolean* - True when a slot becomes empty, false when filled. + +**Content Details:** +The second payload value was historically documented doing the reverse; true (1) when filled or false (nil) otherwise. +Modern FrameXML code labels the payload hasCurrent but does not actually use this payload, so the developer intent is unclear. +It is unknown if the return values in fact 'flipped' at some point, or if the early documentation was simply wrong. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md b/wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md new file mode 100644 index 00000000..49ab8184 --- /dev/null +++ b/wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PLAYER_FARSIGHT_FOCUS_CHANGED + +**Title:** PLAYER FARSIGHT FOCUS CHANGED + +**Content:** +Needs summary. +`PLAYER_FARSIGHT_FOCUS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_FLAGS_CHANGED.md b/wiki-information/events/PLAYER_FLAGS_CHANGED.md new file mode 100644 index 00000000..4a68282f --- /dev/null +++ b/wiki-information/events/PLAYER_FLAGS_CHANGED.md @@ -0,0 +1,14 @@ +## Event: PLAYER_FLAGS_CHANGED + +**Title:** PLAYER FLAGS CHANGED + +**Content:** +This event fires when a Unit's flags change (e.g. /afk, /dnd). +`PLAYER_FLAGS_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +WoW condenses simultaneous flag changes into a single event. If you are currently AFK and not(DND) but you type /dnd you'll see two Chat Log messages ("You are no longer AFK" and "You are now DND: Do Not Disturb") but you'll only see a single PLAYER_FLAGS_CHANGED event. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_FOCUS_CHANGED.md b/wiki-information/events/PLAYER_FOCUS_CHANGED.md new file mode 100644 index 00000000..7569f018 --- /dev/null +++ b/wiki-information/events/PLAYER_FOCUS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PLAYER_FOCUS_CHANGED + +**Title:** PLAYER FOCUS CHANGED + +**Content:** +This event is fired whenever the player's focus target (/focus) is changed, including when the focus target is lost or cleared. +`PLAYER_FOCUS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md b/wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md new file mode 100644 index 00000000..41d23daa --- /dev/null +++ b/wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md @@ -0,0 +1,13 @@ +## Event: PLAYER_GAINS_VEHICLE_DATA + +**Title:** PLAYER GAINS VEHICLE DATA + +**Content:** +Needs summary. +`PLAYER_GAINS_VEHICLE_DATA: unitTarget, vehicleUIIndicatorID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `vehicleUIIndicatorID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_GUILD_UPDATE.md b/wiki-information/events/PLAYER_GUILD_UPDATE.md new file mode 100644 index 00000000..67e8274c --- /dev/null +++ b/wiki-information/events/PLAYER_GUILD_UPDATE.md @@ -0,0 +1,11 @@ +## Event: PLAYER_GUILD_UPDATE + +**Title:** PLAYER GUILD UPDATE + +**Content:** +This appears to be fired when a player is gkicked, gquits, etc. +`PLAYER_GUILD_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEAVE_COMBAT.md b/wiki-information/events/PLAYER_LEAVE_COMBAT.md new file mode 100644 index 00000000..84d5a67a --- /dev/null +++ b/wiki-information/events/PLAYER_LEAVE_COMBAT.md @@ -0,0 +1,10 @@ +## Event: PLAYER_LEAVE_COMBAT + +**Title:** PLAYER LEAVE COMBAT + +**Content:** +Fired when the player leaves combat through death, defeat of opponents, or an ability. Does not fire if a player flees from combat on foot. +`PLAYER_LEAVE_COMBAT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEAVING_WORLD.md b/wiki-information/events/PLAYER_LEAVING_WORLD.md new file mode 100644 index 00000000..74510d48 --- /dev/null +++ b/wiki-information/events/PLAYER_LEAVING_WORLD.md @@ -0,0 +1,10 @@ +## Event: PLAYER_LEAVING_WORLD + +**Title:** PLAYER LEAVING WORLD + +**Content:** +Fired when a player logs out and possibly at other situations as well. +`PLAYER_LEAVING_WORLD` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEVEL_CHANGED.md b/wiki-information/events/PLAYER_LEVEL_CHANGED.md new file mode 100644 index 00000000..5e34644c --- /dev/null +++ b/wiki-information/events/PLAYER_LEVEL_CHANGED.md @@ -0,0 +1,15 @@ +## Event: PLAYER_LEVEL_CHANGED + +**Title:** PLAYER LEVEL CHANGED + +**Content:** +Needs summary. +`PLAYER_LEVEL_CHANGED: oldLevel, newLevel, real` + +**Payload:** +- `oldLevel` + - *number* +- `newLevel` + - *number* +- `real` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEVEL_UP.md b/wiki-information/events/PLAYER_LEVEL_UP.md new file mode 100644 index 00000000..84edb941 --- /dev/null +++ b/wiki-information/events/PLAYER_LEVEL_UP.md @@ -0,0 +1,27 @@ +## Event: PLAYER_LEVEL_UP + +**Title:** PLAYER LEVEL UP + +**Content:** +Fired when a player levels up. +`PLAYER_LEVEL_UP: level, healthDelta, powerDelta, numNewTalents, numNewPvpTalentSlots, strengthDelta, agilityDelta, staminaDelta, intellectDelta` + +**Payload:** +- `level` + - *number* - New player level. +- `healthDelta` + - *number* - Hit points gained from leveling. +- `powerDelta` + - *number* - Mana points gained from leveling. +- `numNewTalents` + - *number* - Talent points gained from leveling. +- `numNewPvpTalentSlots` + - *number* +- `strengthDelta` + - *number* +- `agilityDelta` + - *number* +- `staminaDelta` + - *number* +- `intellectDelta` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LOGIN.md b/wiki-information/events/PLAYER_LOGIN.md new file mode 100644 index 00000000..9a3687fa --- /dev/null +++ b/wiki-information/events/PLAYER_LOGIN.md @@ -0,0 +1,17 @@ +## Event: PLAYER_LOGIN + +**Title:** PLAYER LOGIN + +**Content:** +Triggered immediately before PLAYER_ENTERING_WORLD on login and UI Reload, but NOT when entering/leaving instances. +`PLAYER_LOGIN` + +**Payload:** +- `None` + +**Content Details:** +Related Events +`PLAYER_LOGOUT` + +**Related Information:** +AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LOGOUT.md b/wiki-information/events/PLAYER_LOGOUT.md new file mode 100644 index 00000000..079db261 --- /dev/null +++ b/wiki-information/events/PLAYER_LOGOUT.md @@ -0,0 +1,14 @@ +## Event: PLAYER_LOGOUT + +**Title:** PLAYER LOGOUT + +**Content:** +Sent when the player logs out or the UI is reloaded, just before SavedVariables are saved. The event fires after PLAYER_LEAVING_WORLD. +`PLAYER_LOGOUT` + +**Payload:** +- `None` + +**Content Details:** +Related Events +- `PLAYER_LOGIN` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md b/wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md new file mode 100644 index 00000000..7b5a7e6f --- /dev/null +++ b/wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md @@ -0,0 +1,11 @@ +## Event: PLAYER_LOSES_VEHICLE_DATA + +**Title:** PLAYER LOSES VEHICLE DATA + +**Content:** +Needs summary. +`PLAYER_LOSES_VEHICLE_DATA: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_MONEY.md b/wiki-information/events/PLAYER_MONEY.md new file mode 100644 index 00000000..f43463ab --- /dev/null +++ b/wiki-information/events/PLAYER_MONEY.md @@ -0,0 +1,16 @@ +## Event: PLAYER_MONEY + +**Title:** PLAYER MONEY + +**Content:** +Fired whenever the player gains or loses money. +`PLAYER_MONEY` + +**Payload:** +- `None` + +**Content Details:** +To get the amount of money earned/lost, you'll need to save the return value from GetMoney from the last time PLAYER_MONEY fired and compare it to the new return value from GetMoney. + +**Usage:** +Egingell:PLAYER_MONEY \ No newline at end of file diff --git a/wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md b/wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md new file mode 100644 index 00000000..dd435a7c --- /dev/null +++ b/wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PLAYER_MOUNT_DISPLAY_CHANGED + +**Title:** PLAYER MOUNT DISPLAY CHANGED + +**Content:** +Needs summary. +`PLAYER_MOUNT_DISPLAY_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md b/wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md new file mode 100644 index 00000000..a12c1da9 --- /dev/null +++ b/wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md @@ -0,0 +1,11 @@ +## Event: PLAYER_PVP_KILLS_CHANGED + +**Title:** PLAYER PVP KILLS CHANGED + +**Content:** +Fired when you get credit for killing an enemy player. Only honorable kills will trigger this event. +`PLAYER_PVP_KILLS_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_PVP_RANK_CHANGED.md b/wiki-information/events/PLAYER_PVP_RANK_CHANGED.md new file mode 100644 index 00000000..90353336 --- /dev/null +++ b/wiki-information/events/PLAYER_PVP_RANK_CHANGED.md @@ -0,0 +1,11 @@ +## Event: PLAYER_PVP_RANK_CHANGED + +**Title:** PLAYER PVP RANK CHANGED + +**Content:** +Needs summary. +`PLAYER_PVP_RANK_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_QUITING.md b/wiki-information/events/PLAYER_QUITING.md new file mode 100644 index 00000000..4e9b6c1e --- /dev/null +++ b/wiki-information/events/PLAYER_QUITING.md @@ -0,0 +1,14 @@ +## Event: PLAYER_QUITING + +**Title:** PLAYER QUITING + +**Content:** +Fired when the player tries to quit, as opposed to logout, while outside an inn. +`PLAYER_QUITING` + +**Payload:** +- `None` + +**Content Details:** +The dialog which appears after this event, has choices of "Exit Now" or "Cancel". +The dialog from PLAYER_CAMPING which appears when you try to logout outside an inn, only has a "Cancel" choice. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_REGEN_DISABLED.md b/wiki-information/events/PLAYER_REGEN_DISABLED.md new file mode 100644 index 00000000..cf23084b --- /dev/null +++ b/wiki-information/events/PLAYER_REGEN_DISABLED.md @@ -0,0 +1,14 @@ +## Event: PLAYER_REGEN_DISABLED + +**Title:** PLAYER REGEN DISABLED + +**Content:** +Fired whenever you enter combat, as normal regen rates are disabled during combat. This means that either you are in the hate list of a NPC or that you've been taking part in a pvp action (either as attacker or victim). +`PLAYER_REGEN_DISABLED` + +**Payload:** +- `None` + +**Content Details:** +Related Events +PLAYER_REGEN_ENABLED \ No newline at end of file diff --git a/wiki-information/events/PLAYER_REGEN_ENABLED.md b/wiki-information/events/PLAYER_REGEN_ENABLED.md new file mode 100644 index 00000000..76d275f8 --- /dev/null +++ b/wiki-information/events/PLAYER_REGEN_ENABLED.md @@ -0,0 +1,14 @@ +## Event: PLAYER_REGEN_ENABLED + +**Title:** PLAYER REGEN ENABLED + +**Content:** +Fired after ending combat, as regen rates return to normal. Useful for determining when a player has left combat. This occurs when you are not on the hate list of any NPC, or a few seconds after the latest pvp attack that you were involved with. +`PLAYER_REGEN_ENABLED` + +**Payload:** +- `None` + +**Content Details:** +Related Events +- `PLAYER_REGEN_DISABLED` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_REPORT_SUBMITTED.md b/wiki-information/events/PLAYER_REPORT_SUBMITTED.md new file mode 100644 index 00000000..73581ac9 --- /dev/null +++ b/wiki-information/events/PLAYER_REPORT_SUBMITTED.md @@ -0,0 +1,11 @@ +## Event: PLAYER_REPORT_SUBMITTED + +**Title:** PLAYER REPORT SUBMITTED + +**Content:** +Needs summary. +`PLAYER_REPORT_SUBMITTED: invitedByGUID` + +**Payload:** +- `invitedByGUID` + - *string* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ROLES_ASSIGNED.md b/wiki-information/events/PLAYER_ROLES_ASSIGNED.md new file mode 100644 index 00000000..50ea750a --- /dev/null +++ b/wiki-information/events/PLAYER_ROLES_ASSIGNED.md @@ -0,0 +1,10 @@ +## Event: PLAYER_ROLES_ASSIGNED + +**Title:** PLAYER ROLES ASSIGNED + +**Content:** +Needs summary. +`PLAYER_ROLES_ASSIGNED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_SKINNED.md b/wiki-information/events/PLAYER_SKINNED.md new file mode 100644 index 00000000..a16b2fb3 --- /dev/null +++ b/wiki-information/events/PLAYER_SKINNED.md @@ -0,0 +1,11 @@ +## Event: PLAYER_SKINNED + +**Title:** PLAYER SKINNED + +**Content:** +Fired when the player's insignia is removed in a Battleground. +`PLAYER_SKINNED: hasFreeRepop` + +**Payload:** +- `hasFreeRepop` + - *number* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STARTED_LOOKING.md b/wiki-information/events/PLAYER_STARTED_LOOKING.md new file mode 100644 index 00000000..52ebab4e --- /dev/null +++ b/wiki-information/events/PLAYER_STARTED_LOOKING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_STARTED_LOOKING + +**Title:** PLAYER STARTED LOOKING + +**Content:** +Fires when the camera starts free looking by clicking the left mouse button in the game world. +`PLAYER_STARTED_LOOKING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STARTED_MOVING.md b/wiki-information/events/PLAYER_STARTED_MOVING.md new file mode 100644 index 00000000..2898c41d --- /dev/null +++ b/wiki-information/events/PLAYER_STARTED_MOVING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_STARTED_MOVING + +**Title:** PLAYER STARTED MOVING + +**Content:** +Needs summary. +`PLAYER_STARTED_MOVING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STARTED_TURNING.md b/wiki-information/events/PLAYER_STARTED_TURNING.md new file mode 100644 index 00000000..9c9cde56 --- /dev/null +++ b/wiki-information/events/PLAYER_STARTED_TURNING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_STARTED_TURNING + +**Title:** PLAYER STARTED TURNING + +**Content:** +Fires when the player starts turning by clicking the right mouse button in the game world. +`PLAYER_STARTED_TURNING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STOPPED_LOOKING.md b/wiki-information/events/PLAYER_STOPPED_LOOKING.md new file mode 100644 index 00000000..4f2168fb --- /dev/null +++ b/wiki-information/events/PLAYER_STOPPED_LOOKING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_STOPPED_LOOKING + +**Title:** PLAYER STOPPED LOOKING + +**Content:** +Fires when the camera stops free looking by releasing the left mouse button. +`PLAYER_STOPPED_LOOKING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STOPPED_MOVING.md b/wiki-information/events/PLAYER_STOPPED_MOVING.md new file mode 100644 index 00000000..ea9d04d3 --- /dev/null +++ b/wiki-information/events/PLAYER_STOPPED_MOVING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_STOPPED_MOVING + +**Title:** PLAYER STOPPED MOVING + +**Content:** +Needs summary. +`PLAYER_STOPPED_MOVING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STOPPED_TURNING.md b/wiki-information/events/PLAYER_STOPPED_TURNING.md new file mode 100644 index 00000000..381e5f25 --- /dev/null +++ b/wiki-information/events/PLAYER_STOPPED_TURNING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_STOPPED_TURNING + +**Title:** PLAYER STOPPED TURNING + +**Content:** +Fires when the player stops turning by releasing the right mouse button. +`PLAYER_STOPPED_TURNING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TALENT_UPDATE.md b/wiki-information/events/PLAYER_TALENT_UPDATE.md new file mode 100644 index 00000000..22a5711e --- /dev/null +++ b/wiki-information/events/PLAYER_TALENT_UPDATE.md @@ -0,0 +1,13 @@ +## Event: PLAYER_TALENT_UPDATE + +**Title:** PLAYER TALENT UPDATE + +**Content:** +Fired when the player changes between dual talent specs, and possibly when learning or unlearning talents and when a player levels up, before PLAYER_LEVEL_UP is fired. +`PLAYER_TALENT_UPDATE` + +**Payload:** +- `None` + +**Related Information:** +CHARACTER_POINTS_CHANGED - For Classic \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TARGET_CHANGED.md b/wiki-information/events/PLAYER_TARGET_CHANGED.md new file mode 100644 index 00000000..3429651c --- /dev/null +++ b/wiki-information/events/PLAYER_TARGET_CHANGED.md @@ -0,0 +1,10 @@ +## Event: PLAYER_TARGET_CHANGED + +**Title:** PLAYER TARGET CHANGED + +**Content:** +This event is fired whenever the player's target is changed, including when the target is lost. +`PLAYER_TARGET_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md b/wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md new file mode 100644 index 00000000..aeec028f --- /dev/null +++ b/wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md @@ -0,0 +1,16 @@ +## Event: PLAYER_TARGET_SET_ATTACKING + +**Title:** PLAYER TARGET SET ATTACKING + +**Content:** +Fired when the player enables autoattack. +`PLAYER_TARGET_SET_ATTACKING: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +This can occur when: +- IsCurrentSpell(6603) (where 6603 is the autoattack spell) changes from false to true +- The player changes target while autoattack is active. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TOTEM_UPDATE.md b/wiki-information/events/PLAYER_TOTEM_UPDATE.md new file mode 100644 index 00000000..5a25fe82 --- /dev/null +++ b/wiki-information/events/PLAYER_TOTEM_UPDATE.md @@ -0,0 +1,11 @@ +## Event: PLAYER_TOTEM_UPDATE + +**Title:** PLAYER TOTEM UPDATE + +**Content:** +This event fires whenever a totem is dropped (cast) or destroyed (either recalled or killed). +`PLAYER_TOTEM_UPDATE: totemSlot` + +**Payload:** +- `totemSlot` + - *number* - The number of the totem slot (1-4) affected by the update. See `GetTotemInfo`. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TRADE_MONEY.md b/wiki-information/events/PLAYER_TRADE_MONEY.md new file mode 100644 index 00000000..e3e2433c --- /dev/null +++ b/wiki-information/events/PLAYER_TRADE_MONEY.md @@ -0,0 +1,10 @@ +## Event: PLAYER_TRADE_MONEY + +**Title:** PLAYER TRADE MONEY + +**Content:** +Fired when the player trades money. +`PLAYER_TRADE_MONEY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md b/wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md new file mode 100644 index 00000000..97803c33 --- /dev/null +++ b/wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md @@ -0,0 +1,11 @@ +## Event: PLAYER_TRIAL_XP_UPDATE + +**Title:** PLAYER TRIAL XP UPDATE + +**Content:** +Needs summary. +`PLAYER_TRIAL_XP_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_UNGHOST.md b/wiki-information/events/PLAYER_UNGHOST.md new file mode 100644 index 00000000..125190db --- /dev/null +++ b/wiki-information/events/PLAYER_UNGHOST.md @@ -0,0 +1,18 @@ +## Event: PLAYER_UNGHOST + +**Title:** PLAYER UNGHOST + +**Content:** +Fired when the player is alive after being a ghost. +`PLAYER_UNGHOST` + +**Payload:** +- `None` + +**Content Details:** +The player is alive when this event happens. Does not fire when the player is resurrected before releasing. PLAYER_ALIVE is triggered in that case. +Fires after one of: +- Performing a successful corpse run and the player accepts the 'Resurrect Now' box. +- Accepting a resurrect from another player after releasing from a death. +- Zoning into an instance where the player is dead. +- When the player accept a resurrect from a Spirit Healer. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_UPDATE_RESTING.md b/wiki-information/events/PLAYER_UPDATE_RESTING.md new file mode 100644 index 00000000..f166fd7d --- /dev/null +++ b/wiki-information/events/PLAYER_UPDATE_RESTING.md @@ -0,0 +1,10 @@ +## Event: PLAYER_UPDATE_RESTING + +**Title:** PLAYER UPDATE RESTING + +**Content:** +Fired when the player starts or stops resting, i.e. when entering/leaving inns/major towns. +`PLAYER_UPDATE_RESTING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_XP_UPDATE.md b/wiki-information/events/PLAYER_XP_UPDATE.md new file mode 100644 index 00000000..7ad8d6ac --- /dev/null +++ b/wiki-information/events/PLAYER_XP_UPDATE.md @@ -0,0 +1,11 @@ +## Event: PLAYER_XP_UPDATE + +**Title:** PLAYER XP UPDATE + +**Content:** +Fired when the player's XP is updated (due quest completion or killing). +`PLAYER_XP_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAY_MOVIE.md b/wiki-information/events/PLAY_MOVIE.md new file mode 100644 index 00000000..8daf6f59 --- /dev/null +++ b/wiki-information/events/PLAY_MOVIE.md @@ -0,0 +1,14 @@ +## Event: PLAY_MOVIE + +**Title:** PLAY MOVIE + +**Content:** +Fires when a pre-rendered movie should be played. +`PLAY_MOVIE: movieID` + +**Payload:** +- `movieID` + - *number* : MovieID + +**Related Information:** +MovieFrame_PlayMovie() \ No newline at end of file diff --git a/wiki-information/events/PORTRAITS_UPDATED.md b/wiki-information/events/PORTRAITS_UPDATED.md new file mode 100644 index 00000000..2ae856fc --- /dev/null +++ b/wiki-information/events/PORTRAITS_UPDATED.md @@ -0,0 +1,10 @@ +## Event: PORTRAITS_UPDATED + +**Title:** PORTRAITS UPDATED + +**Content:** +Needs summary. +`PORTRAITS_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PVP_RATED_STATS_UPDATE.md b/wiki-information/events/PVP_RATED_STATS_UPDATE.md new file mode 100644 index 00000000..fc4b9cb6 --- /dev/null +++ b/wiki-information/events/PVP_RATED_STATS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: PVP_RATED_STATS_UPDATE + +**Title:** PVP RATED STATS UPDATE + +**Content:** +Needs summary. +`PVP_RATED_STATS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/PVP_TIMER_UPDATE.md b/wiki-information/events/PVP_TIMER_UPDATE.md new file mode 100644 index 00000000..95a0a85c --- /dev/null +++ b/wiki-information/events/PVP_TIMER_UPDATE.md @@ -0,0 +1,11 @@ +## Event: PVP_TIMER_UPDATE + +**Title:** PVP TIMER UPDATE + +**Content:** +Needs summary. +`PVP_TIMER_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PVP_WORLDSTATE_UPDATE.md b/wiki-information/events/PVP_WORLDSTATE_UPDATE.md new file mode 100644 index 00000000..6e4dc460 --- /dev/null +++ b/wiki-information/events/PVP_WORLDSTATE_UPDATE.md @@ -0,0 +1,10 @@ +## Event: PVP_WORLDSTATE_UPDATE + +**Title:** PVP WORLDSTATE UPDATE + +**Content:** +Needs summary. +`PVP_WORLDSTATE_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_ACCEPTED.md b/wiki-information/events/QUEST_ACCEPTED.md new file mode 100644 index 00000000..edaede93 --- /dev/null +++ b/wiki-information/events/QUEST_ACCEPTED.md @@ -0,0 +1,13 @@ +## Event: QUEST_ACCEPTED + +**Title:** QUEST ACCEPTED + +**Content:** +Fires whenever the player accepts a quest. +`QUEST_ACCEPTED: questId` + +**Payload:** +- `questLogIndex` + - *number* - Classic only. Index of the quest in the quest log. You may pass this to `GetQuestLogTitle()` for information about the accepted quest. +- `questID` + - *number* - QuestID of the accepted quest. \ No newline at end of file diff --git a/wiki-information/events/QUEST_ACCEPT_CONFIRM.md b/wiki-information/events/QUEST_ACCEPT_CONFIRM.md new file mode 100644 index 00000000..52b12f0c --- /dev/null +++ b/wiki-information/events/QUEST_ACCEPT_CONFIRM.md @@ -0,0 +1,13 @@ +## Event: QUEST_ACCEPT_CONFIRM + +**Title:** QUEST ACCEPT CONFIRM + +**Content:** +This event fires when an escort quest is started by another player. A dialog appears asking if the player also wants to start the quest. +`QUEST_ACCEPT_CONFIRM: name, questTitle` + +**Payload:** +- `name` + - *string* - Name of player who is starting escort quest. +- `questTitle` + - *string* - Title of escort quest. Eg. "Protecting the Shipment" \ No newline at end of file diff --git a/wiki-information/events/QUEST_AUTOCOMPLETE.md b/wiki-information/events/QUEST_AUTOCOMPLETE.md new file mode 100644 index 00000000..fdecfc1b --- /dev/null +++ b/wiki-information/events/QUEST_AUTOCOMPLETE.md @@ -0,0 +1,15 @@ +## Event: QUEST_AUTOCOMPLETE + +**Title:** QUEST AUTOCOMPLETE + +**Content:** +Fires when a quest that can be auto-completed is completed. +`QUEST_AUTOCOMPLETE: questId` + +**Payload:** +- `questId` + - *number* + +**Content Details:** +Quests eligible for auto-completion do not need to be handed in to a specific NPC; instead, the player can complete the quest, receive the rewards, and remove it from their quest log anywhere in the world. +Use `ShowQuestComplete` in conjunction with `GetQuestLogIndexByID` to display the quest completion dialog, allowing use of `GetQuestReward` after `QUEST_COMPLETE` has fired. \ No newline at end of file diff --git a/wiki-information/events/QUEST_BOSS_EMOTE.md b/wiki-information/events/QUEST_BOSS_EMOTE.md new file mode 100644 index 00000000..d2a5621a --- /dev/null +++ b/wiki-information/events/QUEST_BOSS_EMOTE.md @@ -0,0 +1,17 @@ +## Event: QUEST_BOSS_EMOTE + +**Title:** QUEST BOSS EMOTE + +**Content:** +Needs summary. +`QUEST_BOSS_EMOTE: text, playerName, displayTime, enableBossEmoteWarningSound` + +**Payload:** +- `text` + - *string* +- `playerName` + - *string* +- `displayTime` + - *number* +- `enableBossEmoteWarningSound` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_COMPLETE.md b/wiki-information/events/QUEST_COMPLETE.md new file mode 100644 index 00000000..58767447 --- /dev/null +++ b/wiki-information/events/QUEST_COMPLETE.md @@ -0,0 +1,10 @@ +## Event: QUEST_COMPLETE + +**Title:** QUEST COMPLETE + +**Content:** +Fired after the player hits the "Continue" button in the quest-information page, before the "Complete Quest" button. In other words, it fires when you are given the option to complete a quest, but just before you actually complete the quest. +`QUEST_COMPLETE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_DETAIL.md b/wiki-information/events/QUEST_DETAIL.md new file mode 100644 index 00000000..fb8750e8 --- /dev/null +++ b/wiki-information/events/QUEST_DETAIL.md @@ -0,0 +1,15 @@ +## Event: QUEST_DETAIL + +**Title:** QUEST DETAIL + +**Content:** +Fired when the player is given a more detailed view of his quest. +`QUEST_DETAIL: questStartItemID` + +**Payload:** +- `questStartItemID` + - *number?* - The ItemID of the item which begins the quest displayed in the quest detail view. + +**Content Details:** +To get the quest that is currently displayed use (tested with 10.0.5): +`questID = GetQuestID()` \ No newline at end of file diff --git a/wiki-information/events/QUEST_FINISHED.md b/wiki-information/events/QUEST_FINISHED.md new file mode 100644 index 00000000..568e4c25 --- /dev/null +++ b/wiki-information/events/QUEST_FINISHED.md @@ -0,0 +1,10 @@ +## Event: QUEST_FINISHED + +**Title:** QUEST FINISHED + +**Content:** +Fired whenever the quest frame changes (from Detail to Progress to Reward, etc.) or is closed. +`QUEST_FINISHED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_GREETING.md b/wiki-information/events/QUEST_GREETING.md new file mode 100644 index 00000000..7db90f40 --- /dev/null +++ b/wiki-information/events/QUEST_GREETING.md @@ -0,0 +1,10 @@ +## Event: QUEST_GREETING + +**Title:** QUEST GREETING + +**Content:** +Fired when talking to an NPC that offers or accepts more than one quest, i.e. has more than one active or available quest. +`QUEST_GREETING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_ITEM_UPDATE.md b/wiki-information/events/QUEST_ITEM_UPDATE.md new file mode 100644 index 00000000..aa1c1fa0 --- /dev/null +++ b/wiki-information/events/QUEST_ITEM_UPDATE.md @@ -0,0 +1,10 @@ +## Event: QUEST_ITEM_UPDATE + +**Title:** QUEST ITEM UPDATE + +**Content:** +Fired when the quest items are updated. +`QUEST_ITEM_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_LOG_UPDATE.md b/wiki-information/events/QUEST_LOG_UPDATE.md new file mode 100644 index 00000000..d3e97ecd --- /dev/null +++ b/wiki-information/events/QUEST_LOG_UPDATE.md @@ -0,0 +1,19 @@ +## Event: QUEST_LOG_UPDATE + +**Title:** QUEST LOG UPDATE + +**Content:** +Fires when the quest log updates. +`QUEST_LOG_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +Toggle `QuestMapFrame.ignoreQuestLogUpdate` to suppress the normal event handler. +This event fires very often: +- Viewing a quest for the first time in a session +- Changing zones across an instance boundary +- Picking up a non-grey item +- Completing a quest objective +- Expanding or collapsing headers in the quest log. \ No newline at end of file diff --git a/wiki-information/events/QUEST_PROGRESS.md b/wiki-information/events/QUEST_PROGRESS.md new file mode 100644 index 00000000..030b912f --- /dev/null +++ b/wiki-information/events/QUEST_PROGRESS.md @@ -0,0 +1,10 @@ +## Event: QUEST_PROGRESS + +**Title:** QUEST PROGRESS + +**Content:** +Fired when a player is talking to an NPC about the status of a quest and has not yet clicked the complete button. +`QUEST_PROGRESS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_REMOVED.md b/wiki-information/events/QUEST_REMOVED.md new file mode 100644 index 00000000..460ecb23 --- /dev/null +++ b/wiki-information/events/QUEST_REMOVED.md @@ -0,0 +1,13 @@ +## Event: QUEST_REMOVED + +**Title:** QUEST REMOVED + +**Content:** +Needs summary. +`QUEST_REMOVED: questID, wasReplayQuest` + +**Payload:** +- `questID` + - *number* +- `wasReplayQuest` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_CREATED.md b/wiki-information/events/QUEST_SESSION_CREATED.md new file mode 100644 index 00000000..2f279f00 --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_CREATED.md @@ -0,0 +1,10 @@ +## Event: QUEST_SESSION_CREATED + +**Title:** QUEST SESSION CREATED + +**Content:** +Fires upon starting a Party Sync session. +`QUEST_SESSION_CREATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_DESTROYED.md b/wiki-information/events/QUEST_SESSION_DESTROYED.md new file mode 100644 index 00000000..c35e1ad8 --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_DESTROYED.md @@ -0,0 +1,10 @@ +## Event: QUEST_SESSION_DESTROYED + +**Title:** QUEST SESSION DESTROYED + +**Content:** +Fires upon terminating a Party Sync session. +`QUEST_SESSION_CREATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md b/wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md new file mode 100644 index 00000000..fa5f1274 --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: QUEST_SESSION_ENABLED_STATE_CHANGED + +**Title:** QUEST SESSION ENABLED STATE CHANGED + +**Content:** +Needs summary. +`QUEST_SESSION_ENABLED_STATE_CHANGED: enabled` + +**Payload:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_JOINED.md b/wiki-information/events/QUEST_SESSION_JOINED.md new file mode 100644 index 00000000..281c0f7d --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_JOINED.md @@ -0,0 +1,14 @@ +## Event: QUEST_SESSION_JOINED + +**Title:** QUEST SESSION JOINED + +**Content:** +Fires upon joining a Party Sync session. +`QUEST_SESSION_CREATED` + +**Payload:** +- `None` + +**Related Information:** +QUEST_SESSION_LEFT +QUEST_SESSION_CREATED \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_LEFT.md b/wiki-information/events/QUEST_SESSION_LEFT.md new file mode 100644 index 00000000..ed167bcb --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_LEFT.md @@ -0,0 +1,14 @@ +## Event: QUEST_SESSION_LEFT + +**Title:** QUEST SESSION LEFT + +**Content:** +Fires upon leaving a Party Sync session. +`QUEST_SESSION_CREATED` + +**Payload:** +- `None` + +**Related Information:** +QUEST_SESSION_JOINED +QUEST_SESSION_DESTROYED \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md b/wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md new file mode 100644 index 00000000..4cde1cbd --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md @@ -0,0 +1,10 @@ +## Event: QUEST_SESSION_MEMBER_CONFIRM + +**Title:** QUEST SESSION MEMBER CONFIRM + +**Content:** +Needs summary. +`QUEST_SESSION_MEMBER_CONFIRM` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md b/wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md new file mode 100644 index 00000000..4c3b8ad5 --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md @@ -0,0 +1,13 @@ +## Event: QUEST_SESSION_MEMBER_START_RESPONSE + +**Title:** QUEST SESSION MEMBER START RESPONSE + +**Content:** +Needs summary. +`QUEST_SESSION_MEMBER_START_RESPONSE: guid, response` + +**Payload:** +- `guid` + - *string* +- `response` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_NOTIFICATION.md b/wiki-information/events/QUEST_SESSION_NOTIFICATION.md new file mode 100644 index 00000000..6f463cce --- /dev/null +++ b/wiki-information/events/QUEST_SESSION_NOTIFICATION.md @@ -0,0 +1,124 @@ +## Event: QUEST_SESSION_NOTIFICATION + +**Title:** QUEST SESSION NOTIFICATION + +**Content:** +Fires with a Party Sync notification. +`QUEST_SESSION_NOTIFICATION: result, guid` + +**Payload:** +- `result` + - *Enum.QuestSessionResult* +- `guid` + - *string* - The player triggering the notification. + - *Enum.QuestSessionResult* + - **Value** + - **Type** + - **Description** + - 0 + - Ok + - No notification message. + - 1 + - NotInParty + - "You are not in a party." + - 2 + - InvalidOwner + - "%s cannot participate in Party Sync." + - 3 + - AlreadyActive + - "Party sync is already active." + - 4 + - NotActive + - "Party Sync is not active." + - 5 + - InRaid + - "You are in a raid." + - 6 + - OwnerRefused + - "%s declined the Party Sync request." + - 7 + - Timeout + - "The Party Sync request timed out." + - 8 + - Disabled + - "Party Sync is currently disabled." + - 9 + - Started + - "Party Sync activated." + - 10 + - Stopped + - "Party Sync ended." + - 11 + - Joined + - No notification message. + - 12 + - Left + - "You left the Party Sync." + - 13 + - OwnerLeft + - "Party Sync ended." + - 14 + - ReadyCheckFailed + - "A party member declined the Party Sync request." + - 15 + - PartyDestroyed + - "Party Sync ended." + - 16 + - MemberTimeout + - No notification message. + - 17 + - AlreadyMember + - "You are already in Party Sync." + - 18 + - NotOwner + - "You are not the owner of the Party Sync." + - 19 + - AlreadyOwner + - "You are already in Party Sync. + - 20 + - AlreadyJoined + - "You are already in Party Sync." + - 21 + - NotMember + - "You are already in Party Sync." + - 22 + - Busy + - "Party Sync is busy." + - 23 + - JoinRejected + - "Your request to join the Party Sync was denied." + - 24 + - Logout + - No notification message. + - 25 + - Empty + - No notification message. + - 26 + - QuestNotCompleted + - "Party Sync failed to start because a party member has not completed their starting quests." + - 27 + - Resync + - "Quests have been re-synced." + - 28 + - Restricted + - "Party Sync failed to start because a party member is on a Class Trial." + - 29 + - InPetBattle + - "Party Sync failed to start because a party member is in a pet battle." + - 30 + - InvalidPublicParty + - "An unknown error has occurred while attempting to activate Party Sync." + - 31 + - Unknown + - "An unknown error has occurred while attempting to activate Party Sync." + - 32 + - InCombat + - "You cannot start Party Sync because you are in combat." + - 33 + - MemberInCombat + - "You cannot join a Party Sync if a member of the party is in combat." + +**Patch Updates:** +Patch 9.0.5 (2021-03-09): Added MemberInCombat field. +Patch 9.0.1 (2020-10-13): Added InCombat field. +Patch 8.2.5 (2019-09-24): Added. \ No newline at end of file diff --git a/wiki-information/events/QUEST_TURNED_IN.md b/wiki-information/events/QUEST_TURNED_IN.md new file mode 100644 index 00000000..3d36a38d --- /dev/null +++ b/wiki-information/events/QUEST_TURNED_IN.md @@ -0,0 +1,15 @@ +## Event: QUEST_TURNED_IN + +**Title:** QUEST TURNED IN + +**Content:** +This event fires whenever the player turns in a quest, whether automatically with a Task-type quest (Bonus Objectives/World Quests), or by pressing the Complete button in a quest dialog window. +`QUEST_TURNED_IN: questID, xpReward, moneyReward` + +**Payload:** +- `questID` + - *number* - QuestID of the quest accepted. +- `xpReward` + - *number* - Number of Experience point awarded, if any. Zero if character is max level. +- `moneyReward` + - *number* - Amount of Money awarded, if any. Amount in coppers. \ No newline at end of file diff --git a/wiki-information/events/QUEST_WATCH_LIST_CHANGED.md b/wiki-information/events/QUEST_WATCH_LIST_CHANGED.md new file mode 100644 index 00000000..d19bd43d --- /dev/null +++ b/wiki-information/events/QUEST_WATCH_LIST_CHANGED.md @@ -0,0 +1,13 @@ +## Event: QUEST_WATCH_LIST_CHANGED + +**Title:** QUEST WATCH LIST CHANGED + +**Content:** +Needs summary. +`QUEST_WATCH_LIST_CHANGED: questID, added` + +**Payload:** +- `questID` + - *number?* +- `added` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/QUEST_WATCH_UPDATE.md b/wiki-information/events/QUEST_WATCH_UPDATE.md new file mode 100644 index 00000000..4a89ebe4 --- /dev/null +++ b/wiki-information/events/QUEST_WATCH_UPDATE.md @@ -0,0 +1,14 @@ +## Event: QUEST_WATCH_UPDATE + +**Title:** QUEST WATCH UPDATE + +**Content:** +Seems to fire each time the objectives of the quest with the supplied questID update, i.e. whenever a partial objective has been accomplished: killing a mob, looting a quest item etc. +`QUEST_WATCH_UPDATE: questID` + +**Payload:** +- `questID` + - *number* + +**Content Details:** +UNIT_QUEST_LOG_CHANGED and QUEST_LOG_UPDATE both also seem to fire consistently – in that order – after each QUEST_WATCH_UPDATE. \ No newline at end of file diff --git a/wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md b/wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md new file mode 100644 index 00000000..e1f3fc16 --- /dev/null +++ b/wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md @@ -0,0 +1,10 @@ +## Event: QUICK_TICKET_SYSTEM_STATUS + +**Title:** QUICK TICKET SYSTEM STATUS + +**Content:** +Needs summary. +`QUICK_TICKET_SYSTEM_STATUS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md b/wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md new file mode 100644 index 00000000..22bff7d1 --- /dev/null +++ b/wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: QUICK_TICKET_THROTTLE_CHANGED + +**Title:** QUICK TICKET THROTTLE CHANGED + +**Content:** +Needs summary. +`QUICK_TICKET_THROTTLE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md b/wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md new file mode 100644 index 00000000..c0516b9b --- /dev/null +++ b/wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md @@ -0,0 +1,41 @@ +## Event: RAF_ENTITLEMENT_DELIVERED + +**Title:** RAF ENTITLEMENT DELIVERED + +**Content:** +Needs summary. +`RAF_ENTITLEMENT_DELIVERED: entitlementType, textureID, name, payloadID, showFancyToast, rafVersion` + +**Payload:** +- `entitlementType` + - *Enum.WoWEntitlementType* - + - Value + - Field + - Description + - 0 - Item + - 1 - Mount + - 2 - Battlepet + - 3 - Toy + - 4 - Appearance + - 5 - AppearanceSet + - 6 - GameTime + - 7 - Title + - 8 - Illusion + - 9 - Invalid +- `textureID` + - *number* +- `name` + - *string* +- `payloadID` + - *number?* +- `showFancyToast` + - *boolean* +- `rafVersion` + - *Enum.RecruitAFriendRewardsVersion* - + - Value + - Field + - Description + - 0 - InvalidVersion + - 1 - UnusedVersionOne + - 2 - VersionTwo + - 3 - VersionThree \ No newline at end of file diff --git a/wiki-information/events/RAID_BOSS_EMOTE.md b/wiki-information/events/RAID_BOSS_EMOTE.md new file mode 100644 index 00000000..272e7fdb --- /dev/null +++ b/wiki-information/events/RAID_BOSS_EMOTE.md @@ -0,0 +1,17 @@ +## Event: RAID_BOSS_EMOTE + +**Title:** RAID BOSS EMOTE + +**Content:** +Needs summary. +`RAID_BOSS_EMOTE: text, playerName, displayTime, enableBossEmoteWarningSound` + +**Payload:** +- `text` + - *string* +- `playerName` + - *string* +- `displayTime` + - *number* +- `enableBossEmoteWarningSound` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RAID_BOSS_WHISPER.md b/wiki-information/events/RAID_BOSS_WHISPER.md new file mode 100644 index 00000000..56082bfc --- /dev/null +++ b/wiki-information/events/RAID_BOSS_WHISPER.md @@ -0,0 +1,17 @@ +## Event: RAID_BOSS_WHISPER + +**Title:** RAID BOSS WHISPER + +**Content:** +Needs summary. +`RAID_BOSS_WHISPER: text, playerName, displayTime, enableBossEmoteWarningSound` + +**Payload:** +- `text` + - *string* +- `playerName` + - *string* +- `displayTime` + - *number* +- `enableBossEmoteWarningSound` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RAID_INSTANCE_WELCOME.md b/wiki-information/events/RAID_INSTANCE_WELCOME.md new file mode 100644 index 00000000..285b1565 --- /dev/null +++ b/wiki-information/events/RAID_INSTANCE_WELCOME.md @@ -0,0 +1,17 @@ +## Event: RAID_INSTANCE_WELCOME + +**Title:** RAID INSTANCE WELCOME + +**Content:** +Fired when the player enters an instance that saves raid members after a boss is killed. +`RAID_INSTANCE_WELCOME: mapname, timeLeft, locked, extended` + +**Payload:** +- `mapname` + - *string* - instance name +- `timeLeft` + - *number* - seconds until reset +- `locked` + - *number* +- `extended` + - *number* \ No newline at end of file diff --git a/wiki-information/events/RAID_ROSTER_UPDATE.md b/wiki-information/events/RAID_ROSTER_UPDATE.md new file mode 100644 index 00000000..89486769 --- /dev/null +++ b/wiki-information/events/RAID_ROSTER_UPDATE.md @@ -0,0 +1,10 @@ +## Event: RAID_ROSTER_UPDATE + +**Title:** RAID ROSTER UPDATE + +**Content:** +Fired whenever a raid is formed or disbanded, players are leaving or joining a raid, or when looting rules are changed (regardless of being in raid or party). +`RAID_ROSTER_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/RAID_TARGET_UPDATE.md b/wiki-information/events/RAID_TARGET_UPDATE.md new file mode 100644 index 00000000..bc30bd81 --- /dev/null +++ b/wiki-information/events/RAID_TARGET_UPDATE.md @@ -0,0 +1,15 @@ +## Event: RAID_TARGET_UPDATE + +**Title:** RAID TARGET UPDATE + +**Content:** +Fired when a raid target icon is changed or removed. Also fired when player join or leave a party or raid. +`RAID_TARGET_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +Does not get triggered if a mob wearing a raid target icon dies (the icon is removed from that mob, however.) +Related API +GetRaidTargetIndex • SetRaidTarget \ No newline at end of file diff --git a/wiki-information/events/RAISED_AS_GHOUL.md b/wiki-information/events/RAISED_AS_GHOUL.md new file mode 100644 index 00000000..73525141 --- /dev/null +++ b/wiki-information/events/RAISED_AS_GHOUL.md @@ -0,0 +1,10 @@ +## Event: RAISED_AS_GHOUL + +**Title:** RAISED AS GHOUL + +**Content:** +Needs summary. +`RAISED_AS_GHOUL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/READY_CHECK.md b/wiki-information/events/READY_CHECK.md new file mode 100644 index 00000000..12235b28 --- /dev/null +++ b/wiki-information/events/READY_CHECK.md @@ -0,0 +1,13 @@ +## Event: READY_CHECK + +**Title:** READY CHECK + +**Content:** +Fired when a Ready Check is performed by the raid (or party) leader. +`READY_CHECK: initiatorName, readyCheckTimeLeft` + +**Payload:** +- `initiatorName` + - *string* +- `readyCheckTimeLeft` + - *number* - Time before automatic check completion in seconds (usually 30). \ No newline at end of file diff --git a/wiki-information/events/READY_CHECK_CONFIRM.md b/wiki-information/events/READY_CHECK_CONFIRM.md new file mode 100644 index 00000000..428bfd2f --- /dev/null +++ b/wiki-information/events/READY_CHECK_CONFIRM.md @@ -0,0 +1,13 @@ +## Event: READY_CHECK_CONFIRM + +**Title:** READY CHECK CONFIRM + +**Content:** +Fired when a player confirms ready status. +`READY_CHECK_CONFIRM: unitTarget, isReady` + +**Payload:** +- `unitTarget` + - *string* : UnitId - The unit in raidN, partyN format. Fires twice if the confirming player is in your raid sub-group. +- `isReady` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/READY_CHECK_FINISHED.md b/wiki-information/events/READY_CHECK_FINISHED.md new file mode 100644 index 00000000..7bbcbda7 --- /dev/null +++ b/wiki-information/events/READY_CHECK_FINISHED.md @@ -0,0 +1,11 @@ +## Event: READY_CHECK_FINISHED + +**Title:** READY CHECK FINISHED + +**Content:** +Fired when the ready check completes. +`READY_CHECK_FINISHED: preempted` + +**Payload:** +- `preempted` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md b/wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md new file mode 100644 index 00000000..e1ca493b --- /dev/null +++ b/wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md @@ -0,0 +1,10 @@ +## Event: RECEIVED_ACHIEVEMENT_LIST + +**Title:** RECEIVED ACHIEVEMENT LIST + +**Content:** +Needs summary. +`RECEIVED_ACHIEVEMENT_LIST` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md b/wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md new file mode 100644 index 00000000..4ea5ef09 --- /dev/null +++ b/wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md @@ -0,0 +1,11 @@ +## Event: RECEIVED_ACHIEVEMENT_MEMBER_LIST + +**Title:** RECEIVED ACHIEVEMENT MEMBER LIST + +**Content:** +Needs summary. +`RECEIVED_ACHIEVEMENT_MEMBER_LIST: achievementID` + +**Payload:** +- `achievementID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/REPLACE_ENCHANT.md b/wiki-information/events/REPLACE_ENCHANT.md new file mode 100644 index 00000000..22872a52 --- /dev/null +++ b/wiki-information/events/REPLACE_ENCHANT.md @@ -0,0 +1,13 @@ +## Event: REPLACE_ENCHANT + +**Title:** REPLACE ENCHANT + +**Content:** +Fired when the player must confirm an enchantment replacement. +`REPLACE_ENCHANT: existingStr, replacementStr` + +**Payload:** +- `existingStr` + - *string* - enchantment +- `replacementStr` + - *string* - current enchantment \ No newline at end of file diff --git a/wiki-information/events/REPORT_PLAYER_RESULT.md b/wiki-information/events/REPORT_PLAYER_RESULT.md new file mode 100644 index 00000000..f815dc7b --- /dev/null +++ b/wiki-information/events/REPORT_PLAYER_RESULT.md @@ -0,0 +1,50 @@ +## Event: REPORT_PLAYER_RESULT + +**Title:** REPORT PLAYER RESULT + +**Content:** +Fires when attempting to report a player +`REPORT_PLAYER_RESULT: success, reportType` + +**Payload:** +- `success` + - *boolean* +- `reportType` + - *Enum.ReportType* + - *Value* + - *Field* + - *Description* + - 0 + - Chat + - 1 + - InWorld + - 2 + - ClubFinderPosting + - 3 + - ClubFinderApplicant + - 4 + - GroupFinderPosting + - 5 + - GroupFinderApplicant + - 6 + - ClubMember + - 7 + - GroupMember + - 8 + - Friend + - 9 + - Pet + - 10 + - BattlePet + - 11 + - Calendar + - 12 + - Mail + - 13 + - PvP + - 14 + - PvPScoreboard + - Added in 9.2.7 + - 15 + - PvPGroupMember + - Added in 10.0.5 \ No newline at end of file diff --git a/wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md b/wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md new file mode 100644 index 00000000..f0f01739 --- /dev/null +++ b/wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md @@ -0,0 +1,11 @@ +## Event: REQUEST_CEMETERY_LIST_RESPONSE + +**Title:** REQUEST CEMETERY LIST RESPONSE + +**Content:** +Needs summary. +`REQUEST_CEMETERY_LIST_RESPONSE: isGossipTriggered` + +**Payload:** +- `isGossipTriggered` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md b/wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md new file mode 100644 index 00000000..2d8b77d4 --- /dev/null +++ b/wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md @@ -0,0 +1,11 @@ +## Event: REQUIRED_GUILD_RENAME_RESULT + +**Title:** REQUIRED GUILD RENAME RESULT + +**Content:** +Needs summary. +`REQUIRED_GUILD_RENAME_RESULT: success` + +**Payload:** +- `success` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md b/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md new file mode 100644 index 00000000..777eaeb2 --- /dev/null +++ b/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md @@ -0,0 +1,10 @@ +## Event: RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED + +**Title:** RESPEC AZERITE EMPOWERED ITEM CLOSED + +**Content:** +Needs summary. +`RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md b/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md new file mode 100644 index 00000000..e1cddfe5 --- /dev/null +++ b/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md @@ -0,0 +1,10 @@ +## Event: RESPEC_AZERITE_EMPOWERED_ITEM_OPENED + +**Title:** RESPEC AZERITE EMPOWERED ITEM OPENED + +**Content:** +Needs summary. +`RESPEC_AZERITE_EMPOWERED_ITEM_OPENED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/RESURRECT_REQUEST.md b/wiki-information/events/RESURRECT_REQUEST.md new file mode 100644 index 00000000..ea7429d7 --- /dev/null +++ b/wiki-information/events/RESURRECT_REQUEST.md @@ -0,0 +1,11 @@ +## Event: RESURRECT_REQUEST + +**Title:** RESURRECT REQUEST + +**Content:** +Fired when another player resurrects you. +`RESURRECT_REQUEST: inviter` + +**Payload:** +- `inviter` + - *string* - player name \ No newline at end of file diff --git a/wiki-information/events/ROLE_CHANGED_INFORM.md b/wiki-information/events/ROLE_CHANGED_INFORM.md new file mode 100644 index 00000000..d9d60d4c --- /dev/null +++ b/wiki-information/events/ROLE_CHANGED_INFORM.md @@ -0,0 +1,17 @@ +## Event: ROLE_CHANGED_INFORM + +**Title:** ROLE CHANGED INFORM + +**Content:** +Needs summary. +`ROLE_CHANGED_INFORM: changedName, fromName, oldRole, newRole` + +**Payload:** +- `changedName` + - *string* - player name +- `fromName` + - *string* - source of change +- `oldRole` + - *string* - previous role +- `newRole` + - *string* - new role \ No newline at end of file diff --git a/wiki-information/events/ROLE_POLL_BEGIN.md b/wiki-information/events/ROLE_POLL_BEGIN.md new file mode 100644 index 00000000..4900ef8e --- /dev/null +++ b/wiki-information/events/ROLE_POLL_BEGIN.md @@ -0,0 +1,11 @@ +## Event: ROLE_POLL_BEGIN + +**Title:** ROLE POLL BEGIN + +**Content:** +Needs summary. +`ROLE_POLL_BEGIN: fromName` + +**Payload:** +- `fromName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/RUNE_POWER_UPDATE.md b/wiki-information/events/RUNE_POWER_UPDATE.md new file mode 100644 index 00000000..06988db0 --- /dev/null +++ b/wiki-information/events/RUNE_POWER_UPDATE.md @@ -0,0 +1,13 @@ +## Event: RUNE_POWER_UPDATE + +**Title:** RUNE POWER UPDATE + +**Content:** +Fired when a rune's state switches from usable to un-usable or visa-versa. +`RUNE_POWER_UPDATE: runeIndex, added` + +**Payload:** +- `runeIndex` + - *number* +- `added` + - *boolean?* - is the rune usable (if usable, it's not cooling, if not usable it's cooling) \ No newline at end of file diff --git a/wiki-information/events/RUNE_TYPE_UPDATE.md b/wiki-information/events/RUNE_TYPE_UPDATE.md new file mode 100644 index 00000000..4b32f51d --- /dev/null +++ b/wiki-information/events/RUNE_TYPE_UPDATE.md @@ -0,0 +1,11 @@ +## Event: RUNE_TYPE_UPDATE + +**Title:** RUNE TYPE UPDATE + +**Content:** +New in 3.x. Fired when a rune's type is changed / updated. +`"RUNE_TYPE_UPDATE", arg1` + +**Parameters & Values:** +- `arg1` + - the rune that it's referencing to \ No newline at end of file diff --git a/wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md b/wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md new file mode 100644 index 00000000..b5b4762e --- /dev/null +++ b/wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md @@ -0,0 +1,19 @@ +## Event: SAVED_VARIABLES_TOO_LARGE + +**Title:** SAVED VARIABLES TOO LARGE + +**Content:** +Fired when unable to load saved variables due to an out-of-memory error. +`SAVED_VARIABLES_TOO_LARGE: addOnName` + +**Payload:** +- `addOnName` + - *string* - Name of the AddOn. + +**Content Details:** +Fires after ADDON_LOADED. +The error could affect SavedVariables and/or SavedVariablesPerCharacter. +SavedVariables will not save on the next logout. + +**Related Information:** +AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/SCREENSHOT_FAILED.md b/wiki-information/events/SCREENSHOT_FAILED.md new file mode 100644 index 00000000..f001ac73 --- /dev/null +++ b/wiki-information/events/SCREENSHOT_FAILED.md @@ -0,0 +1,10 @@ +## Event: SCREENSHOT_FAILED + +**Title:** SCREENSHOT FAILED + +**Content:** +Fired when a screenshot fails. +`SCREENSHOT_FAILED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SCREENSHOT_STARTED.md b/wiki-information/events/SCREENSHOT_STARTED.md new file mode 100644 index 00000000..4764f29c --- /dev/null +++ b/wiki-information/events/SCREENSHOT_STARTED.md @@ -0,0 +1,10 @@ +## Event: SCREENSHOT_STARTED + +**Title:** SCREENSHOT STARTED + +**Content:** +Needs summary. +`SCREENSHOT_STARTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SCREENSHOT_SUCCEEDED.md b/wiki-information/events/SCREENSHOT_SUCCEEDED.md new file mode 100644 index 00000000..799ef0a0 --- /dev/null +++ b/wiki-information/events/SCREENSHOT_SUCCEEDED.md @@ -0,0 +1,10 @@ +## Event: SCREENSHOT_SUCCEEDED + +**Title:** SCREENSHOT SUCCEEDED + +**Content:** +Fired when a screenshot is successfully taken. +`SCREENSHOT_SUCCEEDED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SEARCH_DB_LOADED.md b/wiki-information/events/SEARCH_DB_LOADED.md new file mode 100644 index 00000000..c7e6cc9e --- /dev/null +++ b/wiki-information/events/SEARCH_DB_LOADED.md @@ -0,0 +1,10 @@ +## Event: SEARCH_DB_LOADED + +**Title:** SEARCH DB LOADED + +**Content:** +Needs summary. +`SEARCH_DB_LOADED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SECURE_TRANSFER_CANCEL.md b/wiki-information/events/SECURE_TRANSFER_CANCEL.md new file mode 100644 index 00000000..a509cd0c --- /dev/null +++ b/wiki-information/events/SECURE_TRANSFER_CANCEL.md @@ -0,0 +1,14 @@ +## Event: SECURE_TRANSFER_CANCEL + +**Title:** SECURE TRANSFER CANCEL + +**Content:** +Fires when the user halts offering money or items to a stranger, after receiving a warning dialog. +`SECURE_TRANSFER_CANCEL` + +**Payload:** +- `None` + +**Related Information:** +SECURE_TRANSFER_CONFIRM_SEND_MAIL +SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT \ No newline at end of file diff --git a/wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md b/wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md new file mode 100644 index 00000000..77fad643 --- /dev/null +++ b/wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md @@ -0,0 +1,21 @@ +## Event: SECURE_TRANSFER_CONFIRM_SEND_MAIL + +**Title:** SECURE TRANSFER CONFIRM SEND MAIL + +**Content:** +Fires when mailing money or items to a stranger. +`SECURE_TRANSFER_CONFIRM_SEND_MAIL` + +**Payload:** +- `None` + +**Content Details:** +Does not fire if the recipient is: +- In the same guild +- On the friends list as a character (ie, not counting BattleTag or Real ID friends) +- An alt of the sender +While an addon could respond to this event, the most important utility is for SecureTransferDialog to securely confirm the user's intention without addon interference. + +**Related Information:** +SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT +SECURE_TRANSFER_CANCEL \ No newline at end of file diff --git a/wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md b/wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md new file mode 100644 index 00000000..b6843e97 --- /dev/null +++ b/wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md @@ -0,0 +1,21 @@ +## Event: SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT + +**Title:** SECURE TRANSFER CONFIRM TRADE ACCEPT + +**Content:** +Fires when trading money or items to a stranger. +`SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT` + +**Payload:** +- `None` + +**Content Details:** +Does not fire if the recipient is: +In the same guild +On the friends list +In the same group or raid +While an addon could respond to this event, the most important utility is for SecureTransferDialog to securely confirm the user's intention without addon interference. + +**Related Information:** +SECURE_TRANSFER_CONFIRM_SEND_MAIL +SECURE_TRANSFER_CANCEL \ No newline at end of file diff --git a/wiki-information/events/SELF_RES_SPELL_CHANGED.md b/wiki-information/events/SELF_RES_SPELL_CHANGED.md new file mode 100644 index 00000000..88a3cb46 --- /dev/null +++ b/wiki-information/events/SELF_RES_SPELL_CHANGED.md @@ -0,0 +1,10 @@ +## Event: SELF_RES_SPELL_CHANGED + +**Title:** SELF RES SPELL CHANGED + +**Content:** +Needs summary. +`SELF_RES_SPELL_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SEND_MAIL_COD_CHANGED.md b/wiki-information/events/SEND_MAIL_COD_CHANGED.md new file mode 100644 index 00000000..40a53e1a --- /dev/null +++ b/wiki-information/events/SEND_MAIL_COD_CHANGED.md @@ -0,0 +1,10 @@ +## Event: SEND_MAIL_COD_CHANGED + +**Title:** SEND MAIL COD CHANGED + +**Content:** +Needs summary. +`SEND_MAIL_COD_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SEND_MAIL_MONEY_CHANGED.md b/wiki-information/events/SEND_MAIL_MONEY_CHANGED.md new file mode 100644 index 00000000..fb4705d0 --- /dev/null +++ b/wiki-information/events/SEND_MAIL_MONEY_CHANGED.md @@ -0,0 +1,10 @@ +## Event: SEND_MAIL_MONEY_CHANGED + +**Title:** SEND MAIL MONEY CHANGED + +**Content:** +Needs summary. +`SEND_MAIL_MONEY_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md b/wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md new file mode 100644 index 00000000..d249cb70 --- /dev/null +++ b/wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md @@ -0,0 +1,10 @@ +## Event: SHOW_LFG_EXPAND_SEARCH_PROMPT + +**Title:** SHOW LFG EXPAND SEARCH PROMPT + +**Content:** +Fires when the player is in Chromie Time, queued for a dungeon, and has been waiting in the queue for enough time to trigger the "expand your search" popup. +`SHOW_LFG_EXPAND_SEARCH_PROMPT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md b/wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md new file mode 100644 index 00000000..425f42e9 --- /dev/null +++ b/wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md @@ -0,0 +1,11 @@ +## Event: SHOW_LOOT_TOAST_LEGENDARY_LOOTED + +**Title:** SHOW LOOT TOAST LEGENDARY LOOTED + +**Content:** +Needs summary. +`SHOW_LOOT_TOAST_LEGENDARY_LOOTED: itemLink` + +**Payload:** +- `itemLink` + - *string* \ No newline at end of file diff --git a/wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md b/wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md new file mode 100644 index 00000000..30421590 --- /dev/null +++ b/wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md @@ -0,0 +1,23 @@ +## Event: SHOW_LOOT_TOAST_UPGRADE + +**Title:** SHOW LOOT TOAST UPGRADE + +**Content:** +Needs summary. +`SHOW_LOOT_TOAST_UPGRADE: itemLink, quantity, specID, sex, baseQuality, personalLootToast, lessAwesome` + +**Payload:** +- `itemLink` + - *string* +- `quantity` + - *number* +- `specID` + - *number* +- `sex` + - *number* +- `baseQuality` + - *number* +- `personalLootToast` + - *boolean* +- `lessAwesome` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md b/wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md new file mode 100644 index 00000000..89a230b8 --- /dev/null +++ b/wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md @@ -0,0 +1,23 @@ +## Event: SHOW_PVP_FACTION_LOOT_TOAST + +**Title:** SHOW PVP FACTION LOOT TOAST + +**Content:** +Needs summary. +`SHOW_PVP_FACTION_LOOT_TOAST: typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, lessAwesome` + +**Payload:** +- `typeIdentifier` + - *string* +- `itemLink` + - *string* +- `quantity` + - *number* +- `specID` + - *number* +- `sex` + - *number* +- `personalLootToast` + - *boolean* +- `lessAwesome` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md b/wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md new file mode 100644 index 00000000..f6217d21 --- /dev/null +++ b/wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md @@ -0,0 +1,23 @@ +## Event: SHOW_RATED_PVP_REWARD_TOAST + +**Title:** SHOW RATED PVP REWARD TOAST + +**Content:** +Needs summary. +`SHOW_RATED_PVP_REWARD_TOAST: typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, lessAwesome` + +**Payload:** +- `typeIdentifier` + - *string* +- `itemLink` + - *string* +- `quantity` + - *number* +- `specID` + - *number* +- `sex` + - *number* +- `personalLootToast` + - *boolean* +- `lessAwesome` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md b/wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md new file mode 100644 index 00000000..77ab81f0 --- /dev/null +++ b/wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md @@ -0,0 +1,11 @@ +## Event: SIMPLE_BROWSER_WEB_ERROR + +**Title:** SIMPLE BROWSER WEB ERROR + +**Content:** +Needs summary. +`SIMPLE_BROWSER_WEB_ERROR: errorCode` + +**Payload:** +- `errorCode` + - *number* \ No newline at end of file diff --git a/wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md b/wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md new file mode 100644 index 00000000..aa68221b --- /dev/null +++ b/wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md @@ -0,0 +1,10 @@ +## Event: SIMPLE_BROWSER_WEB_PROXY_FAILED + +**Title:** SIMPLE BROWSER WEB PROXY FAILED + +**Content:** +Needs summary. +`SIMPLE_BROWSER_WEB_PROXY_FAILED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md b/wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md new file mode 100644 index 00000000..c0d9c2fc --- /dev/null +++ b/wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md @@ -0,0 +1,10 @@ +## Event: SIMPLE_CHECKOUT_CLOSED + +**Title:** SIMPLE CHECKOUT CLOSED + +**Content:** +Needs summary. +`SIMPLE_CHECKOUT_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SKILL_LINES_CHANGED.md b/wiki-information/events/SKILL_LINES_CHANGED.md new file mode 100644 index 00000000..36fbbe91 --- /dev/null +++ b/wiki-information/events/SKILL_LINES_CHANGED.md @@ -0,0 +1,13 @@ +## Event: SKILL_LINES_CHANGED + +**Title:** SKILL LINES CHANGED + +**Content:** +Fired when the content of the player's skill list changes. It only fires for major changes to the list, such as learning or unlearning a skill or raising one's level from Journeyman to Master. It doesn't fire for skill rank increases. +`SKILL_LINES_CHANGED` + +**Payload:** +- `None` + +**Content Details:** +Using Frame:RegisterUnitEvent to register for this event does not appear to work. \ No newline at end of file diff --git a/wiki-information/events/SOCIAL_ITEM_RECEIVED.md b/wiki-information/events/SOCIAL_ITEM_RECEIVED.md new file mode 100644 index 00000000..35e936ca --- /dev/null +++ b/wiki-information/events/SOCIAL_ITEM_RECEIVED.md @@ -0,0 +1,10 @@ +## Event: SOCIAL_ITEM_RECEIVED + +**Title:** SOCIAL ITEM RECEIVED + +**Content:** +Needs summary. +`SOCIAL_ITEM_RECEIVED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_ACCEPT.md b/wiki-information/events/SOCKET_INFO_ACCEPT.md new file mode 100644 index 00000000..378644cd --- /dev/null +++ b/wiki-information/events/SOCKET_INFO_ACCEPT.md @@ -0,0 +1,10 @@ +## Event: SOCKET_INFO_ACCEPT + +**Title:** SOCKET INFO ACCEPT + +**Content:** +Needs summary. +`SOCKET_INFO_ACCEPT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_CLOSE.md b/wiki-information/events/SOCKET_INFO_CLOSE.md new file mode 100644 index 00000000..3cdf5707 --- /dev/null +++ b/wiki-information/events/SOCKET_INFO_CLOSE.md @@ -0,0 +1,10 @@ +## Event: SOCKET_INFO_CLOSE + +**Title:** SOCKET INFO CLOSE + +**Content:** +Needs summary. +`SOCKET_INFO_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_FAILURE.md b/wiki-information/events/SOCKET_INFO_FAILURE.md new file mode 100644 index 00000000..a5f4a785 --- /dev/null +++ b/wiki-information/events/SOCKET_INFO_FAILURE.md @@ -0,0 +1,10 @@ +## Event: SOCKET_INFO_FAILURE + +**Title:** SOCKET INFO FAILURE + +**Content:** +Needs summary. +`SOCKET_INFO_FAILURE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md b/wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md new file mode 100644 index 00000000..66afb5cd --- /dev/null +++ b/wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md @@ -0,0 +1,10 @@ +## Event: SOCKET_INFO_REFUNDABLE_CONFIRM + +**Title:** SOCKET INFO REFUNDABLE CONFIRM + +**Content:** +Needs summary. +`SOCKET_INFO_REFUNDABLE_CONFIRM` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_SUCCESS.md b/wiki-information/events/SOCKET_INFO_SUCCESS.md new file mode 100644 index 00000000..a733ce21 --- /dev/null +++ b/wiki-information/events/SOCKET_INFO_SUCCESS.md @@ -0,0 +1,10 @@ +## Event: SOCKET_INFO_SUCCESS + +**Title:** SOCKET INFO SUCCESS + +**Content:** +Needs summary. +`SOCKET_INFO_SUCCESS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_UPDATE.md b/wiki-information/events/SOCKET_INFO_UPDATE.md new file mode 100644 index 00000000..81942f1c --- /dev/null +++ b/wiki-information/events/SOCKET_INFO_UPDATE.md @@ -0,0 +1,10 @@ +## Event: SOCKET_INFO_UPDATE + +**Title:** SOCKET INFO UPDATE + +**Content:** +Needs summary. +`SOCKET_INFO_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SOUNDKIT_FINISHED.md b/wiki-information/events/SOUNDKIT_FINISHED.md new file mode 100644 index 00000000..ea7c59e4 --- /dev/null +++ b/wiki-information/events/SOUNDKIT_FINISHED.md @@ -0,0 +1,11 @@ +## Event: SOUNDKIT_FINISHED + +**Title:** SOUNDKIT FINISHED + +**Content:** +Indicates a sound has finished playing, but only if the fourth argument in PlaySound(__, __, __, runFinishCallback) was set to true. +`SOUNDKIT_FINISHED: soundHandle` + +**Payload:** +- `soundHandle` + - *number* - The second return value from PlaySound() identifying which sound has finished playing. \ No newline at end of file diff --git a/wiki-information/events/SOUND_DEVICE_UPDATE.md b/wiki-information/events/SOUND_DEVICE_UPDATE.md new file mode 100644 index 00000000..b76366dc --- /dev/null +++ b/wiki-information/events/SOUND_DEVICE_UPDATE.md @@ -0,0 +1,7 @@ +## Event: SOUND_DEVICE_UPDATE + +**Title:** SOUND DEVICE UPDATE + +**Content:** +Information about the player's sound input or output devices has changed or become available. +`SOUND_DEVICE_UPDATE` \ No newline at end of file diff --git a/wiki-information/events/SPELLS_CHANGED.md b/wiki-information/events/SPELLS_CHANGED.md new file mode 100644 index 00000000..49ab0c39 --- /dev/null +++ b/wiki-information/events/SPELLS_CHANGED.md @@ -0,0 +1,16 @@ +## Event: SPELLS_CHANGED + +**Title:** SPELLS CHANGED + +**Content:** +Fires when spells in the spellbook change in any way. Can be trivial (e.g.: icon changes only), or substantial (e.g.: learning or unlearning spells/skills). +`SPELLS_CHANGED` + +**Payload:** +- `None` + +**Content Details:** +In prior game versions, this event also fired every time the player navigated the spellbook (swapped pages/tabs), since that caused UpdateSpells to be called which in turn always triggered a SPELLS_CHANGED event. However, that API has been removed since Patch 4.0.1. + +**Related Information:** +AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md new file mode 100644 index 00000000..c826059d --- /dev/null +++ b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md @@ -0,0 +1,11 @@ +## Event: SPELL_ACTIVATION_OVERLAY_GLOW_HIDE + +**Title:** SPELL ACTIVATION OVERLAY GLOW HIDE + +**Content:** +Needs summary. +`SPELL_ACTIVATION_OVERLAY_GLOW_HIDE: spellID` + +**Payload:** +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md new file mode 100644 index 00000000..3a32b09d --- /dev/null +++ b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md @@ -0,0 +1,11 @@ +## Event: SPELL_ACTIVATION_OVERLAY_GLOW_SHOW + +**Title:** SPELL ACTIVATION OVERLAY GLOW SHOW + +**Content:** +Needs summary. +`SPELL_ACTIVATION_OVERLAY_GLOW_SHOW: spellID` + +**Payload:** +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md new file mode 100644 index 00000000..c933fa3f --- /dev/null +++ b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md @@ -0,0 +1,11 @@ +## Event: SPELL_ACTIVATION_OVERLAY_HIDE + +**Title:** SPELL ACTIVATION OVERLAY HIDE + +**Content:** +Needs summary. +`SPELL_ACTIVATION_OVERLAY_HIDE: spellID` + +**Payload:** +- `spellID` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md new file mode 100644 index 00000000..69db5043 --- /dev/null +++ b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md @@ -0,0 +1,23 @@ +## Event: SPELL_ACTIVATION_OVERLAY_SHOW + +**Title:** SPELL ACTIVATION OVERLAY SHOW + +**Content:** +Fired when the spell overlay is shown. +`SPELL_ACTIVATION_OVERLAY_SHOW: spellID, overlayFileDataID, locationName, scale, r, g, b` + +**Payload:** +- `spellID` + - *number* +- `overlayFileDataID` + - *number* - texture +- `locationName` + - *string* - possible values include simple points such as "CENTER" or "LEFT", or complex positions such as "RIGHT (FLIPPED)" or "TOP + BOTTOM (FLIPPED)", which are defined in a local table in SpellActivationOverlay.lua +- `scale` + - *number* +- `r` + - *number* +- `g` + - *number* +- `b` + - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_CONFIRMATION_PROMPT.md b/wiki-information/events/SPELL_CONFIRMATION_PROMPT.md new file mode 100644 index 00000000..b74ef94b --- /dev/null +++ b/wiki-information/events/SPELL_CONFIRMATION_PROMPT.md @@ -0,0 +1,26 @@ +## Event: SPELL_CONFIRMATION_PROMPT + +**Title:** SPELL CONFIRMATION PROMPT + +**Content:** +Fires when a spell confirmation prompt might be presented to the player. +`SPELL_CONFIRMATION_PROMPT: spellID, effectValue, message, duration, currencyTypesID, currencyCost, currentDifficulty` + +**Payload:** +- `spellID` + - *number* - Spell ID for the Confirmation Prompt Spell. These are very specific spells that only appear during this event. +- `effectValue` + - *number* - The possible values for this are not entirely known, however, 1 does seem to be the confirmType when the prompt triggers a bonus roll. +- `message` + - *string* +- `duration` + - *number* - This number is in seconds. Typically, it is 180 seconds. +- `currencyTypesID` + - *number* - The ID of the currency required if the prompt requires a currency (it does for bonus rolls). +- `currencyCost` + - *number* +- `currentDifficulty` + - *number* + +**Content Details:** +After this event has fired, the client can respond with the functions AcceptSpellConfirmationPrompt and DeclineSpellConfirmationPrompt. Notably, the event does not guarantee that the player can actually cast the spell. \ No newline at end of file diff --git a/wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md b/wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md new file mode 100644 index 00000000..a921be83 --- /dev/null +++ b/wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md @@ -0,0 +1,13 @@ +## Event: SPELL_CONFIRMATION_TIMEOUT + +**Title:** SPELL CONFIRMATION TIMEOUT + +**Content:** +Fires when a spell confirmation prompt was not accepted via AcceptSpellConfirmationPrompt or declined via DeclineSpellConfirmationPrompt within the allotted time (usually 3 minutes). +`SPELL_CONFIRMATION_TIMEOUT: spellID, effectValue` + +**Payload:** +- `spellID` + - *number* +- `effectValue` + - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_DATA_LOAD_RESULT.md b/wiki-information/events/SPELL_DATA_LOAD_RESULT.md new file mode 100644 index 00000000..270d1e7f --- /dev/null +++ b/wiki-information/events/SPELL_DATA_LOAD_RESULT.md @@ -0,0 +1,16 @@ +## Event: SPELL_DATA_LOAD_RESULT + +**Title:** SPELL DATA LOAD RESULT + +**Content:** +Fires when data is available in response to C_Spell.RequestLoadSpellData. +`SPELL_DATA_LOAD_RESULT: spellID, success` + +**Payload:** +- `spellID` + - *number* +- `success` + - *boolean* - True if the spell was successfully queried from the server. Might return false when only partial spell data is available, e.g. everything except the spell description. + +**Related Information:** +SpellMixin \ No newline at end of file diff --git a/wiki-information/events/SPELL_POWER_CHANGED.md b/wiki-information/events/SPELL_POWER_CHANGED.md new file mode 100644 index 00000000..9702bb45 --- /dev/null +++ b/wiki-information/events/SPELL_POWER_CHANGED.md @@ -0,0 +1,13 @@ +## Event: SPELL_POWER_CHANGED + +**Title:** SPELL POWER CHANGED + +**Content:** +Fired when the player's Spell Power changes. +`SPELL_POWER_CHANGED` + +**Payload:** +- `None` + +**Content Details:** +Does not fire when Spell Healing changes. For that use PLAYER_DAMAGE_DONE_MODS. \ No newline at end of file diff --git a/wiki-information/events/SPELL_TEXT_UPDATE.md b/wiki-information/events/SPELL_TEXT_UPDATE.md new file mode 100644 index 00000000..f256b55b --- /dev/null +++ b/wiki-information/events/SPELL_TEXT_UPDATE.md @@ -0,0 +1,11 @@ +## Event: SPELL_TEXT_UPDATE + +**Title:** SPELL TEXT UPDATE + +**Content:** +Needs summary. +`SPELL_TEXT_UPDATE: spellID` + +**Payload:** +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_CHARGES.md b/wiki-information/events/SPELL_UPDATE_CHARGES.md new file mode 100644 index 00000000..64103904 --- /dev/null +++ b/wiki-information/events/SPELL_UPDATE_CHARGES.md @@ -0,0 +1,10 @@ +## Event: SPELL_UPDATE_CHARGES + +**Title:** SPELL UPDATE CHARGES + +**Content:** +Needs summary. +`SPELL_UPDATE_CHARGES` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_COOLDOWN.md b/wiki-information/events/SPELL_UPDATE_COOLDOWN.md new file mode 100644 index 00000000..8f0fe059 --- /dev/null +++ b/wiki-information/events/SPELL_UPDATE_COOLDOWN.md @@ -0,0 +1,23 @@ +## Event: SPELL_UPDATE_COOLDOWN + +**Title:** SPELL UPDATE COOLDOWN + +**Content:** +This event is fired immediately whenever you cast a spell, as well as every second while you channel spells. +`SPELL_UPDATE_COOLDOWN` + +**Payload:** +- `None` + +**Content Details:** +The spell you cast doesn't need to have any explicit "cooldown" of its own, since this event also triggers off of anything that incurs a GCD (global cooldown). In other words, it basically fires whenever you cast any spell or channel any spell. +(It may possibly even trigger from spells that are "off the GCD" and which don't have any cooldown of their own; but there's no way to verify that, since all spells in game that are "off the GCD" are special class "burst" abilities with long cooldowns.) +It's worth noting that this event does NOT fire when spells finish their cooldown! + +**Usage:** +Whenever you cast a spell, this event triggers twice in a row. Most likely to signal that a spell cast has begun, and then to signal that the GCD has been triggered. +When a hunter auto-shoots, they're actually casting the "Auto Shot" spell (which repeatedly auto-casts itself until cancelled, and has a cooldown of its own, but is otherwise completely "off the GCD" and doesn't trigger the GCD at all when it's cast/shooting/aborted). So every time the hunter shoots a projectile, this event will fire to signal that the "Auto Shot" spell has begun its internal cooldown. Note that this behavior is unique to "Auto Shot"; and that the regular melee spell "Attack" (or melee swings) do NOT trigger this event. +Furthermore, any channeled spells will fire this event once per second while the channeling is ongoing. As an example, if you cast Volley, this event first fires once to signal that a spell with a cooldown (Volley) has been cast. Then it immediately fires again to signal that channeling of Volley has begun. And after that, it fires every second while the channeling is ongoing. + +**Related Information:** +GetSpellCooldown \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_ICON.md b/wiki-information/events/SPELL_UPDATE_ICON.md new file mode 100644 index 00000000..82866f58 --- /dev/null +++ b/wiki-information/events/SPELL_UPDATE_ICON.md @@ -0,0 +1,13 @@ +## Event: SPELL_UPDATE_ICON + +**Title:** SPELL UPDATE ICON + +**Content:** +Indicates a spell or ability has a new icon. +`SPELL_UPDATE_ICON` + +**Payload:** +- `None` + +**Content Details:** +Tracks changing spells such as Covenant abilities in Shadowlands. \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_USABLE.md b/wiki-information/events/SPELL_UPDATE_USABLE.md new file mode 100644 index 00000000..3694c32e --- /dev/null +++ b/wiki-information/events/SPELL_UPDATE_USABLE.md @@ -0,0 +1,20 @@ +## Event: SPELL_UPDATE_USABLE + +**Title:** SPELL UPDATE USABLE + +**Content:** +This event is fired when a spell becomes "useable" or "unusable". +`SPELL_UPDATE_USABLE` + +**Payload:** +- `None` + +**Content Details:** +The definition of useable and unusable is somewhat confusing. Firstly, range is not taken into account. Secondly if a spell requires a valid target and doesn't have one it gets marked as useable. If it requires mana or rage and there isn't enough then it gets marked as unusable. This results in the following behaviour: +Start) Feral druid in bear form out of combat, no target selected. +) Target enemy. Event is fired as some spells that require rage become marked as unusable. On the action bar the spell is marked in red as unusable. +) Use Enrage to gain rage. Event is fired as we now have enough rage. On the action bar the spell is marked unusable as out of range. +) Move into range. Event is not fired. On the action bar the spell is marked usable. +) Rage runs out. Event is fired as we no longer have enough rage. +) Remove target. Event is fired and spell is marked as useable on action bar. +It appears that the definition of useable is a little inaccurate and relates more to how it is displayed on the action bar than whether you can use the spell. Also after being attacked the event started firing every two seconds and this continued until well after the attacker was dead. Targetting a fresh enemy seemed to stop it. \ No newline at end of file diff --git a/wiki-information/events/START_AUTOREPEAT_SPELL.md b/wiki-information/events/START_AUTOREPEAT_SPELL.md new file mode 100644 index 00000000..360e3c26 --- /dev/null +++ b/wiki-information/events/START_AUTOREPEAT_SPELL.md @@ -0,0 +1,10 @@ +## Event: START_AUTOREPEAT_SPELL + +**Title:** START AUTOREPEAT SPELL + +**Content:** +Needs summary. +`START_AUTOREPEAT_SPELL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/START_LOOT_ROLL.md b/wiki-information/events/START_LOOT_ROLL.md new file mode 100644 index 00000000..a7ed9510 --- /dev/null +++ b/wiki-information/events/START_LOOT_ROLL.md @@ -0,0 +1,15 @@ +## Event: START_LOOT_ROLL + +**Title:** START LOOT ROLL + +**Content:** +Fired when a group loot item is being rolled on. +`START_LOOT_ROLL: rollID, rollTime, lootHandle` + +**Payload:** +- `rollID` + - *number* +- `rollTime` + - *number* +- `lootHandle` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/START_TIMER.md b/wiki-information/events/START_TIMER.md new file mode 100644 index 00000000..2e3f8ca6 --- /dev/null +++ b/wiki-information/events/START_TIMER.md @@ -0,0 +1,15 @@ +## Event: START_TIMER + +**Title:** START TIMER + +**Content:** +Needs summary. +`START_TIMER: timerType, timeRemaining, totalTime` + +**Payload:** +- `timerType` + - *number* +- `timeRemaining` + - *number* +- `totalTime` + - *number* \ No newline at end of file diff --git a/wiki-information/events/STOP_AUTOREPEAT_SPELL.md b/wiki-information/events/STOP_AUTOREPEAT_SPELL.md new file mode 100644 index 00000000..1e772a31 --- /dev/null +++ b/wiki-information/events/STOP_AUTOREPEAT_SPELL.md @@ -0,0 +1,10 @@ +## Event: STOP_AUTOREPEAT_SPELL + +**Title:** STOP AUTOREPEAT SPELL + +**Content:** +Needs summary. +`STOP_AUTOREPEAT_SPELL` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/STOP_MOVIE.md b/wiki-information/events/STOP_MOVIE.md new file mode 100644 index 00000000..d75a41cd --- /dev/null +++ b/wiki-information/events/STOP_MOVIE.md @@ -0,0 +1,10 @@ +## Event: STOP_MOVIE + +**Title:** STOP MOVIE + +**Content:** +Needs summary. +`STOP_MOVIE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/STREAMING_ICON.md b/wiki-information/events/STREAMING_ICON.md new file mode 100644 index 00000000..db1fc8f7 --- /dev/null +++ b/wiki-information/events/STREAMING_ICON.md @@ -0,0 +1,15 @@ +## Event: STREAMING_ICON + +**Title:** STREAMING ICON + +**Content:** +Fires when the streaming client state is updated. +`STREAMING_ICON: streamingStatus` + +**Payload:** +- `streamingStatus` + - *number* + - 0 - Nothing is currently being downloaded. + - 1 - Game data is currently being downloaded (green) + - 2 - Important game data is currently being downloaded (yellow) + - 3 - Core game data is currently being downloaded (red) \ No newline at end of file diff --git a/wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md b/wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md new file mode 100644 index 00000000..d767f334 --- /dev/null +++ b/wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md @@ -0,0 +1,15 @@ +## Event: STREAM_VIEW_MARKER_UPDATED + +**Title:** STREAM VIEW MARKER UPDATED + +**Content:** +Needs summary. +`STREAM_VIEW_MARKER_UPDATED: clubId, streamId, lastReadTime` + +**Payload:** +- `clubId` + - *string* +- `streamId` + - *string* +- `lastReadTime` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md b/wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md new file mode 100644 index 00000000..ed3c122e --- /dev/null +++ b/wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md @@ -0,0 +1,11 @@ +## Event: SUPER_TRACKED_QUEST_CHANGED + +**Title:** SUPER TRACKED QUEST CHANGED + +**Content:** +Needs summary. +`SUPER_TRACKED_QUEST_CHANGED: superTrackedQuestID` + +**Payload:** +- `superTrackedQuestID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/SYSMSG.md b/wiki-information/events/SYSMSG.md new file mode 100644 index 00000000..317303c0 --- /dev/null +++ b/wiki-information/events/SYSMSG.md @@ -0,0 +1,17 @@ +## Event: SYSMSG + +**Title:** SYSMSG + +**Content:** +Fired when a system message occurs. Gets displayed in the UI error frame (the default red text in the top half of the screen) in the default UI. +`SYSMSG: string, r, g, b` + +**Payload:** +- `string` +- `string` +- `r` + - *number* +- `g` + - *number* +- `b` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TABARD_CANSAVE_CHANGED.md b/wiki-information/events/TABARD_CANSAVE_CHANGED.md new file mode 100644 index 00000000..acc18969 --- /dev/null +++ b/wiki-information/events/TABARD_CANSAVE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: TABARD_CANSAVE_CHANGED + +**Title:** TABARD CANSAVE CHANGED + +**Content:** +Fired when it is possible to save a tabard. +`TABARD_CANSAVE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TABARD_SAVE_PENDING.md b/wiki-information/events/TABARD_SAVE_PENDING.md new file mode 100644 index 00000000..4f9c55b6 --- /dev/null +++ b/wiki-information/events/TABARD_SAVE_PENDING.md @@ -0,0 +1,10 @@ +## Event: TABARD_SAVE_PENDING + +**Title:** TABARD SAVE PENDING + +**Content:** +Needs summary. +`TABARD_SAVE_PENDING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md b/wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md new file mode 100644 index 00000000..46d7bcb4 --- /dev/null +++ b/wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md @@ -0,0 +1,11 @@ +## Event: TALENTS_INVOLUNTARILY_RESET + +**Title:** TALENTS INVOLUNTARILY RESET + +**Content:** +Needs summary. +`TALENTS_INVOLUNTARILY_RESET: isPetTalents` + +**Payload:** +- `isPetTalents` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/TASK_PROGRESS_UPDATE.md b/wiki-information/events/TASK_PROGRESS_UPDATE.md new file mode 100644 index 00000000..9326ed06 --- /dev/null +++ b/wiki-information/events/TASK_PROGRESS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TASK_PROGRESS_UPDATE + +**Title:** TASK PROGRESS UPDATE + +**Content:** +Needs summary. +`TASK_PROGRESS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TAXIMAP_CLOSED.md b/wiki-information/events/TAXIMAP_CLOSED.md new file mode 100644 index 00000000..72a60322 --- /dev/null +++ b/wiki-information/events/TAXIMAP_CLOSED.md @@ -0,0 +1,10 @@ +## Event: TAXIMAP_CLOSED + +**Title:** TAXIMAP CLOSED + +**Content:** +Fired when the taxi frame is closed. +`TAXIMAP_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TAXIMAP_OPENED.md b/wiki-information/events/TAXIMAP_OPENED.md new file mode 100644 index 00000000..45699e25 --- /dev/null +++ b/wiki-information/events/TAXIMAP_OPENED.md @@ -0,0 +1,21 @@ +## Event: TAXIMAP_OPENED + +**Title:** TAXIMAP OPENED + +**Content:** +Fired when the taxi viewer is opened. +`TAXIMAP_OPENED: system` + +**Payload:** +- `system` + - *Enum.UIMapSystem* + - *Value* + - *Field* + - *Description* + - 0 - World + - 1 - Taxi + - 2 - Adventure + - 3 - Minimap + +**Content Details:** +This will fire even if you know no flight paths connected to the one you're at, so the map doesn't actually open. \ No newline at end of file diff --git a/wiki-information/events/TIME_PLAYED_MSG.md b/wiki-information/events/TIME_PLAYED_MSG.md new file mode 100644 index 00000000..50799ebc --- /dev/null +++ b/wiki-information/events/TIME_PLAYED_MSG.md @@ -0,0 +1,13 @@ +## Event: TIME_PLAYED_MSG + +**Title:** TIME PLAYED MSG + +**Content:** +Fired when the client received a time played message. +`TIME_PLAYED_MSG: totalTimePlayed, timePlayedThisLevel` + +**Payload:** +- `totalTimePlayed` + - *number* - Total time played in seconds. +- `timePlayedThisLevel` + - *number* - Time played for the current level in seconds. \ No newline at end of file diff --git a/wiki-information/events/TOGGLE_CONSOLE.md b/wiki-information/events/TOGGLE_CONSOLE.md new file mode 100644 index 00000000..60a46cd3 --- /dev/null +++ b/wiki-information/events/TOGGLE_CONSOLE.md @@ -0,0 +1,11 @@ +## Event: TOGGLE_CONSOLE + +**Title:** TOGGLE CONSOLE + +**Content:** +Needs summary. +`TOGGLE_CONSOLE: showConsole` + +**Payload:** +- `showConsole` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_AUCTION_SOLD.md b/wiki-information/events/TOKEN_AUCTION_SOLD.md new file mode 100644 index 00000000..9cef8c5b --- /dev/null +++ b/wiki-information/events/TOKEN_AUCTION_SOLD.md @@ -0,0 +1,10 @@ +## Event: TOKEN_AUCTION_SOLD + +**Title:** TOKEN AUCTION SOLD + +**Content:** +Needs summary. +`TOKEN_AUCTION_SOLD` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md b/wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md new file mode 100644 index 00000000..930fe039 --- /dev/null +++ b/wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md @@ -0,0 +1,10 @@ +## Event: TOKEN_BUY_CONFIRM_REQUIRED + +**Title:** TOKEN BUY CONFIRM REQUIRED + +**Content:** +Needs summary. +`TOKEN_BUY_CONFIRM_REQUIRED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_BUY_RESULT.md b/wiki-information/events/TOKEN_BUY_RESULT.md new file mode 100644 index 00000000..3a2a5f03 --- /dev/null +++ b/wiki-information/events/TOKEN_BUY_RESULT.md @@ -0,0 +1,11 @@ +## Event: TOKEN_BUY_RESULT + +**Title:** TOKEN BUY RESULT + +**Content:** +Needs summary. +`TOKEN_BUY_RESULT: result` + +**Payload:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md b/wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md new file mode 100644 index 00000000..36849389 --- /dev/null +++ b/wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md @@ -0,0 +1,11 @@ +## Event: TOKEN_CAN_VETERAN_BUY_UPDATE + +**Title:** TOKEN CAN VETERAN BUY UPDATE + +**Content:** +Needs summary. +`TOKEN_CAN_VETERAN_BUY_UPDATE: result` + +**Payload:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md b/wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md new file mode 100644 index 00000000..dab54d12 --- /dev/null +++ b/wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md @@ -0,0 +1,11 @@ +## Event: TOKEN_DISTRIBUTIONS_UPDATED + +**Title:** TOKEN DISTRIBUTIONS UPDATED + +**Content:** +Needs summary. +`TOKEN_DISTRIBUTIONS_UPDATED: result` + +**Payload:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md b/wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md new file mode 100644 index 00000000..59649725 --- /dev/null +++ b/wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md @@ -0,0 +1,11 @@ +## Event: TOKEN_MARKET_PRICE_UPDATED + +**Title:** TOKEN MARKET PRICE UPDATED + +**Content:** +Needs summary. +`TOKEN_MARKET_PRICE_UPDATED: result` + +**Payload:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md b/wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md new file mode 100644 index 00000000..d48eab0d --- /dev/null +++ b/wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md @@ -0,0 +1,10 @@ +## Event: TOKEN_REDEEM_BALANCE_UPDATED + +**Title:** TOKEN REDEEM BALANCE UPDATED + +**Content:** +Needs summary. +`TOKEN_REDEEM_BALANCE_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md b/wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md new file mode 100644 index 00000000..bc935cd9 --- /dev/null +++ b/wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md @@ -0,0 +1,11 @@ +## Event: TOKEN_REDEEM_CONFIRM_REQUIRED + +**Title:** TOKEN REDEEM CONFIRM REQUIRED + +**Content:** +Needs summary. +`TOKEN_REDEEM_CONFIRM_REQUIRED: choiceType` + +**Payload:** +- `choiceType` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md b/wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md new file mode 100644 index 00000000..743d727c --- /dev/null +++ b/wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md @@ -0,0 +1,10 @@ +## Event: TOKEN_REDEEM_FRAME_SHOW + +**Title:** TOKEN REDEEM FRAME SHOW + +**Content:** +Needs summary. +`TOKEN_REDEEM_FRAME_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md b/wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md new file mode 100644 index 00000000..84ed2b32 --- /dev/null +++ b/wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md @@ -0,0 +1,10 @@ +## Event: TOKEN_REDEEM_GAME_TIME_UPDATED + +**Title:** TOKEN REDEEM GAME TIME UPDATED + +**Content:** +Needs summary. +`TOKEN_REDEEM_GAME_TIME_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_RESULT.md b/wiki-information/events/TOKEN_REDEEM_RESULT.md new file mode 100644 index 00000000..71cc9ff5 --- /dev/null +++ b/wiki-information/events/TOKEN_REDEEM_RESULT.md @@ -0,0 +1,13 @@ +## Event: TOKEN_REDEEM_RESULT + +**Title:** TOKEN REDEEM RESULT + +**Content:** +Needs summary. +`TOKEN_REDEEM_RESULT: result, choiceType` + +**Payload:** +- `result` + - *number* +- `choiceType` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md b/wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md new file mode 100644 index 00000000..df5d4ab9 --- /dev/null +++ b/wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md @@ -0,0 +1,10 @@ +## Event: TOKEN_SELL_CONFIRM_REQUIRED + +**Title:** TOKEN SELL CONFIRM REQUIRED + +**Content:** +Needs summary. +`TOKEN_SELL_CONFIRM_REQUIRED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_SELL_RESULT.md b/wiki-information/events/TOKEN_SELL_RESULT.md new file mode 100644 index 00000000..f608277c --- /dev/null +++ b/wiki-information/events/TOKEN_SELL_RESULT.md @@ -0,0 +1,11 @@ +## Event: TOKEN_SELL_RESULT + +**Title:** TOKEN SELL RESULT + +**Content:** +Needs summary. +`TOKEN_SELL_RESULT: result` + +**Payload:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_STATUS_CHANGED.md b/wiki-information/events/TOKEN_STATUS_CHANGED.md new file mode 100644 index 00000000..69c294a4 --- /dev/null +++ b/wiki-information/events/TOKEN_STATUS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: TOKEN_STATUS_CHANGED + +**Title:** TOKEN STATUS CHANGED + +**Content:** +Needs summary. +`TOKEN_STATUS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TOYS_UPDATED.md b/wiki-information/events/TOYS_UPDATED.md new file mode 100644 index 00000000..9f0388bf --- /dev/null +++ b/wiki-information/events/TOYS_UPDATED.md @@ -0,0 +1,15 @@ +## Event: TOYS_UPDATED + +**Title:** TOYS UPDATED + +**Content:** +Needs summary. +`TOYS_UPDATED: itemID, isNew, hasFanfare` + +**Payload:** +- `itemID` + - *number?* : ToyID +- `isNew` + - *boolean?* - Whether the toy has just been added to your collection. +- `hasFanfare` + - *boolean?* - Whether the toy should appear with a "fanfare" glow effect. \ No newline at end of file diff --git a/wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md b/wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md new file mode 100644 index 00000000..570ae712 --- /dev/null +++ b/wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md @@ -0,0 +1,13 @@ +## Event: TRACKED_ACHIEVEMENT_LIST_CHANGED + +**Title:** TRACKED ACHIEVEMENT LIST CHANGED + +**Content:** +Needs summary. +`TRACKED_ACHIEVEMENT_LIST_CHANGED: achievementID, added` + +**Payload:** +- `achievementID` + - *number?* +- `added` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md b/wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md new file mode 100644 index 00000000..8d98dc4d --- /dev/null +++ b/wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md @@ -0,0 +1,17 @@ +## Event: TRACKED_ACHIEVEMENT_UPDATE + +**Title:** TRACKED ACHIEVEMENT UPDATE + +**Content:** +Fired when a timed event for an achievement begins or ends. The achievement does not have to be actively tracked for this to trigger. +`TRACKED_ACHIEVEMENT_UPDATE: achievementID, criteriaID, elapsed, duration` + +**Payload:** +- `achievementID` + - *number* +- `criteriaID` + - *number?* +- `elapsed` + - *number?* - Actual time +- `duration` + - *number?* - Time limit \ No newline at end of file diff --git a/wiki-information/events/TRADE_ACCEPT_UPDATE.md b/wiki-information/events/TRADE_ACCEPT_UPDATE.md new file mode 100644 index 00000000..21468ceb --- /dev/null +++ b/wiki-information/events/TRADE_ACCEPT_UPDATE.md @@ -0,0 +1,16 @@ +## Event: TRADE_ACCEPT_UPDATE + +**Title:** TRADE ACCEPT UPDATE + +**Content:** +Fired when the status of the player and target accept buttons has changed. +`TRADE_ACCEPT_UPDATE: playerAccepted, targetAccepted` + +**Payload:** +- `playerAccepted` + - *number* - Player has agreed to the trade (1) or not (0) +- `targetAccepted` + - *number* - Target has agreed to the trade (1) or not (0) + +**Content Details:** +Target agree status only shown when he has done it first. By this, player and target agree status is only shown together (playerAccepted == 1 and targetAccepted == 1), when player agreed after target. \ No newline at end of file diff --git a/wiki-information/events/TRADE_CLOSED.md b/wiki-information/events/TRADE_CLOSED.md new file mode 100644 index 00000000..9e3a60b4 --- /dev/null +++ b/wiki-information/events/TRADE_CLOSED.md @@ -0,0 +1,10 @@ +## Event: TRADE_CLOSED + +**Title:** TRADE CLOSED + +**Content:** +Fired when the trade window is closed by the trade being accepted, or the player or target closes the window. +`TRADE_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_MONEY_CHANGED.md b/wiki-information/events/TRADE_MONEY_CHANGED.md new file mode 100644 index 00000000..cf70e98a --- /dev/null +++ b/wiki-information/events/TRADE_MONEY_CHANGED.md @@ -0,0 +1,10 @@ +## Event: TRADE_MONEY_CHANGED + +**Title:** TRADE MONEY CHANGED + +**Content:** +Fired when the trade window's money value is changed. +`TRADE_MONEY_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md b/wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md new file mode 100644 index 00000000..55fa4949 --- /dev/null +++ b/wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md @@ -0,0 +1,14 @@ +## Event: TRADE_PLAYER_ITEM_CHANGED + +**Title:** TRADE PLAYER ITEM CHANGED + +**Content:** +Fired when an item in the target's trade window is changed (items added or removed from trade). +`TRADE_PLAYER_ITEM_CHANGED: tradeSlotIndex` + +**Payload:** +- `tradeSlotIndex` + - *number* + +**Content Details:** +Not initially fired when trading is started by dropping an item on target. \ No newline at end of file diff --git a/wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md b/wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md new file mode 100644 index 00000000..837bb896 --- /dev/null +++ b/wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md @@ -0,0 +1,11 @@ +## Event: TRADE_POTENTIAL_BIND_ENCHANT + +**Title:** TRADE POTENTIAL BIND ENCHANT + +**Content:** +Needs summary. +`TRADE_POTENTIAL_BIND_ENCHANT: canBecomeBoundForTrade` + +**Payload:** +- `canBecomeBoundForTrade` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/TRADE_REPLACE_ENCHANT.md b/wiki-information/events/TRADE_REPLACE_ENCHANT.md new file mode 100644 index 00000000..b3ef25d8 --- /dev/null +++ b/wiki-information/events/TRADE_REPLACE_ENCHANT.md @@ -0,0 +1,13 @@ +## Event: TRADE_REPLACE_ENCHANT + +**Title:** TRADE REPLACE ENCHANT + +**Content:** +Fired when the player must confirm an enchantment replacement in the trade window. +`TRADE_REPLACE_ENCHANT: existing, replacement` + +**Payload:** +- `existing` + - *string* - new enchantment +- `replacement` + - *string* - current enchantment \ No newline at end of file diff --git a/wiki-information/events/TRADE_REQUEST.md b/wiki-information/events/TRADE_REQUEST.md new file mode 100644 index 00000000..44dc2921 --- /dev/null +++ b/wiki-information/events/TRADE_REQUEST.md @@ -0,0 +1,11 @@ +## Event: TRADE_REQUEST + +**Title:** TRADE REQUEST + +**Content:** +Fired when another player wishes to trade with you. +`TRADE_REQUEST: name` + +**Payload:** +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/events/TRADE_REQUEST_CANCEL.md b/wiki-information/events/TRADE_REQUEST_CANCEL.md new file mode 100644 index 00000000..61903b80 --- /dev/null +++ b/wiki-information/events/TRADE_REQUEST_CANCEL.md @@ -0,0 +1,13 @@ +## Event: TRADE_REQUEST_CANCEL + +**Title:** TRADE REQUEST CANCEL + +**Content:** +Fired when a trade attempt is cancelled. Fired after TRADE_CLOSED when aborted by player, and before TRADE_CLOSED when done by target. +`TRADE_REQUEST_CANCEL` + +**Payload:** +- `None` + +**Content Details:** +Upon a trade being cancelled (as in, either part clicking the cancel button), TRADE_CLOSED is fired twice, and then TRADE_REQUEST_CANCEL once. \ No newline at end of file diff --git a/wiki-information/events/TRADE_SHOW.md b/wiki-information/events/TRADE_SHOW.md new file mode 100644 index 00000000..2dc26d38 --- /dev/null +++ b/wiki-information/events/TRADE_SHOW.md @@ -0,0 +1,10 @@ +## Event: TRADE_SHOW + +**Title:** TRADE SHOW + +**Content:** +Fired when the Trade window appears after a trade request has been accepted or auto-accepted +`TRADE_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_CLOSE.md b/wiki-information/events/TRADE_SKILL_CLOSE.md new file mode 100644 index 00000000..0a2bb8e6 --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_CLOSE.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_CLOSE + +**Title:** TRADE SKILL CLOSE + +**Content:** +Fired when a trade skill window is closed. +`TRADE_SKILL_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md b/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md new file mode 100644 index 00000000..4484ba09 --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_DATA_SOURCE_CHANGED + +**Title:** TRADE SKILL DATA SOURCE CHANGED + +**Content:** +Needs summary. +`TRADE_SKILL_DATA_SOURCE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md b/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md new file mode 100644 index 00000000..df0806fa --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_DATA_SOURCE_CHANGING + +**Title:** TRADE SKILL DATA SOURCE CHANGING + +**Content:** +Needs summary. +`TRADE_SKILL_DATA_SOURCE_CHANGING` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md b/wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md new file mode 100644 index 00000000..e5998c51 --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_DETAILS_UPDATE + +**Title:** TRADE SKILL DETAILS UPDATE + +**Content:** +Needs summary. +`TRADE_SKILL_DETAILS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_LIST_UPDATE.md b/wiki-information/events/TRADE_SKILL_LIST_UPDATE.md new file mode 100644 index 00000000..548bba1c --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_LIST_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_LIST_UPDATE + +**Title:** TRADE SKILL LIST UPDATE + +**Content:** +Needs summary. +`TRADE_SKILL_LIST_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_NAME_UPDATE.md b/wiki-information/events/TRADE_SKILL_NAME_UPDATE.md new file mode 100644 index 00000000..26fc213c --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_NAME_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_NAME_UPDATE + +**Title:** TRADE SKILL NAME UPDATE + +**Content:** +Needs summary. +`TRADE_SKILL_NAME_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_SHOW.md b/wiki-information/events/TRADE_SKILL_SHOW.md new file mode 100644 index 00000000..766021d1 --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_SHOW.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_SHOW + +**Title:** TRADE SKILL SHOW + +**Content:** +Fired when a trade skill window is opened. +`TRADE_SKILL_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_UPDATE.md b/wiki-information/events/TRADE_SKILL_UPDATE.md new file mode 100644 index 00000000..e73a738b --- /dev/null +++ b/wiki-information/events/TRADE_SKILL_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRADE_SKILL_UPDATE + +**Title:** TRADE SKILL UPDATE + +**Content:** +Fired immediately after TRADE_SKILL_SHOW, after something is created via tradeskill, or anytime the tradeskill window is updated (filtered, tree folded/unfolded, etc.) +`TRADE_SKILL_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md b/wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md new file mode 100644 index 00000000..b2e6fc90 --- /dev/null +++ b/wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md @@ -0,0 +1,11 @@ +## Event: TRADE_TARGET_ITEM_CHANGED + +**Title:** TRADE TARGET ITEM CHANGED + +**Content:** +Fired when an item in the target's trade window is changed (items added or removed from trade). +`TRADE_TARGET_ITEM_CHANGED: tradeSlotIndex` + +**Payload:** +- `tradeSlotIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TRADE_UPDATE.md b/wiki-information/events/TRADE_UPDATE.md new file mode 100644 index 00000000..b49c79d0 --- /dev/null +++ b/wiki-information/events/TRADE_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRADE_UPDATE + +**Title:** TRADE UPDATE + +**Content:** +Fired when the trade window is changed. +`TRADE_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_CLOSED.md b/wiki-information/events/TRAINER_CLOSED.md new file mode 100644 index 00000000..2c49f082 --- /dev/null +++ b/wiki-information/events/TRAINER_CLOSED.md @@ -0,0 +1,10 @@ +## Event: TRAINER_CLOSED + +**Title:** TRAINER CLOSED + +**Content:** +Fired when the trainer is closed. +`TRAINER_CLOSED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md b/wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md new file mode 100644 index 00000000..dadb40c2 --- /dev/null +++ b/wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRAINER_DESCRIPTION_UPDATE + +**Title:** TRAINER DESCRIPTION UPDATE + +**Content:** +Needs summary. +`TRAINER_DESCRIPTION_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md b/wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md new file mode 100644 index 00000000..271ccad0 --- /dev/null +++ b/wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRAINER_SERVICE_INFO_NAME_UPDATE + +**Title:** TRAINER SERVICE INFO NAME UPDATE + +**Content:** +Needs summary. +`TRAINER_SERVICE_INFO_NAME_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_SHOW.md b/wiki-information/events/TRAINER_SHOW.md new file mode 100644 index 00000000..54400b96 --- /dev/null +++ b/wiki-information/events/TRAINER_SHOW.md @@ -0,0 +1,10 @@ +## Event: TRAINER_SHOW + +**Title:** TRAINER SHOW + +**Content:** +Fired when the trainer frame is shown. +`TRAINER_SHOW` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_UPDATE.md b/wiki-information/events/TRAINER_UPDATE.md new file mode 100644 index 00000000..2bf9d2ea --- /dev/null +++ b/wiki-information/events/TRAINER_UPDATE.md @@ -0,0 +1,10 @@ +## Event: TRAINER_UPDATE + +**Title:** TRAINER UPDATE + +**Content:** +Fired when the trainer window needs to update. +`TRAINER_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md b/wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md new file mode 100644 index 00000000..e72b5f54 --- /dev/null +++ b/wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: TRANSMOG_OUTFITS_CHANGED + +**Title:** TRANSMOG OUTFITS CHANGED + +**Content:** +Needs summary. +`TRANSMOG_OUTFITS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TRIAL_CAP_REACHED_MONEY.md b/wiki-information/events/TRIAL_CAP_REACHED_MONEY.md new file mode 100644 index 00000000..779ba780 --- /dev/null +++ b/wiki-information/events/TRIAL_CAP_REACHED_MONEY.md @@ -0,0 +1,10 @@ +## Event: TRIAL_CAP_REACHED_MONEY + +**Title:** TRIAL CAP REACHED MONEY + +**Content:** +This event is triggered whenever a player tries to gain gold at or above the gold limit, while playing on a Subscription-Lapsed or Starter Account. +`TRIAL_CAP_REACHED_MONEY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/TUTORIAL_TRIGGER.md b/wiki-information/events/TUTORIAL_TRIGGER.md new file mode 100644 index 00000000..5606a89d --- /dev/null +++ b/wiki-information/events/TUTORIAL_TRIGGER.md @@ -0,0 +1,13 @@ +## Event: TUTORIAL_TRIGGER + +**Title:** TUTORIAL TRIGGER + +**Content:** +Fired when the tutorial/tips are shown. Will not fire if tutorials are turned off. +`TUTORIAL_TRIGGER: tutorialIndex, forceShow` + +**Payload:** +- `tutorialIndex` + - *number* +- `forceShow` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/TWITTER_LINK_RESULT.md b/wiki-information/events/TWITTER_LINK_RESULT.md new file mode 100644 index 00000000..88d5d6d2 --- /dev/null +++ b/wiki-information/events/TWITTER_LINK_RESULT.md @@ -0,0 +1,15 @@ +## Event: TWITTER_LINK_RESULT + +**Title:** TWITTER LINK RESULT + +**Content:** +Needs summary. +`TWITTER_LINK_RESULT: isLinked, screenName, error` + +**Payload:** +- `isLinked` + - *boolean* +- `screenName` + - *string* +- `error` + - *string* \ No newline at end of file diff --git a/wiki-information/events/TWITTER_POST_RESULT.md b/wiki-information/events/TWITTER_POST_RESULT.md new file mode 100644 index 00000000..69d49eed --- /dev/null +++ b/wiki-information/events/TWITTER_POST_RESULT.md @@ -0,0 +1,11 @@ +## Event: TWITTER_POST_RESULT + +**Title:** TWITTER POST RESULT + +**Content:** +Needs summary. +`TWITTER_POST_RESULT: result` + +**Payload:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/events/TWITTER_STATUS_UPDATE.md b/wiki-information/events/TWITTER_STATUS_UPDATE.md new file mode 100644 index 00000000..a3de3189 --- /dev/null +++ b/wiki-information/events/TWITTER_STATUS_UPDATE.md @@ -0,0 +1,15 @@ +## Event: TWITTER_STATUS_UPDATE + +**Title:** TWITTER STATUS UPDATE + +**Content:** +Needs summary. +`TWITTER_STATUS_UPDATE: isTwitterEnabled, isLinked, screenName` + +**Payload:** +- `isTwitterEnabled` + - *boolean* +- `isLinked` + - *boolean* +- `screenName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md b/wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md new file mode 100644 index 00000000..41e91a1a --- /dev/null +++ b/wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md @@ -0,0 +1,10 @@ +## Event: UI_MODEL_SCENE_INFO_UPDATED + +**Title:** UI MODEL SCENE INFO UPDATED + +**Content:** +Needs summary. +`UI_MODEL_SCENE_INFO_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UI_SCALE_CHANGED.md b/wiki-information/events/UI_SCALE_CHANGED.md new file mode 100644 index 00000000..7f4aa4d8 --- /dev/null +++ b/wiki-information/events/UI_SCALE_CHANGED.md @@ -0,0 +1,10 @@ +## Event: UI_SCALE_CHANGED + +**Title:** UI SCALE CHANGED + +**Content:** +Needs summary. +`UI_SCALE_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UNIT_ATTACK.md b/wiki-information/events/UNIT_ATTACK.md new file mode 100644 index 00000000..2420d3c7 --- /dev/null +++ b/wiki-information/events/UNIT_ATTACK.md @@ -0,0 +1,11 @@ +## Event: UNIT_ATTACK + +**Title:** UNIT ATTACK + +**Content:** +Fired when a units attack is affected (such as the weapon being swung). +`UNIT_ATTACK: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_ATTACK_POWER.md b/wiki-information/events/UNIT_ATTACK_POWER.md new file mode 100644 index 00000000..f607b525 --- /dev/null +++ b/wiki-information/events/UNIT_ATTACK_POWER.md @@ -0,0 +1,11 @@ +## Event: UNIT_ATTACK_POWER + +**Title:** UNIT ATTACK POWER + +**Content:** +Fired when a unit's attack power changes. +`UNIT_ATTACK_POWER: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_ATTACK_SPEED.md b/wiki-information/events/UNIT_ATTACK_SPEED.md new file mode 100644 index 00000000..dc484352 --- /dev/null +++ b/wiki-information/events/UNIT_ATTACK_SPEED.md @@ -0,0 +1,11 @@ +## Event: UNIT_ATTACK_SPEED + +**Title:** UNIT ATTACK SPEED + +**Content:** +Fired when your attack speed is being listed or affected. +`UNIT_ATTACK_SPEED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_AURA.md b/wiki-information/events/UNIT_AURA.md new file mode 100644 index 00000000..c4bebf11 --- /dev/null +++ b/wiki-information/events/UNIT_AURA.md @@ -0,0 +1,135 @@ +## Event: UNIT_AURA + +**Title:** UNIT AURA + +**Content:** +Fires when a buff, debuff, status, or item bonus was gained by or faded from an entity (player, pet, NPC, or mob.) +`UNIT_AURA: unitTarget, updateInfo` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `updateInfo` + - *UnitAuraUpdateInfo?* : Optional table of information about changed auras. + - Field + - Type + - Description + - addedAuras + - AuraData? + - List of auras added to the unit during this update. + - updatedAuraInstanceIDs + - *number?* + - List of existing auras on the unit modified during this update. + - removedAuraInstanceIDs + - *number?* + - List of existing auras removed from the unit during this update. + - isFullUpdate + - *boolean?* = false + - Whether or not a full update of the units' auras should be performed. If this is set, the other fields will likely be nil. + - AuraData + - Field + - Type + - Description + - applications + - *number* + - auraInstanceID + - *number* + - canApplyAura + - *boolean* + - Whether or not the player can apply this aura. + - charges + - *number* + - dispelName + - *string?* + - duration + - *number* + - expirationTime + - *number* + - icon + - *number* + - isBossAura + - *boolean* + - Whether or not this aura was applied by a boss. + - isFromPlayerOrPlayerPet + - *boolean* + - Whether or not this aura was applied by a player or their pet. + - isHarmful + - *boolean* + - Whether or not this aura is a debuff. + - isHelpful + - *boolean* + - Whether or not this aura is a buff. + - isNameplateOnly + - *boolean* + - Whether or not this aura should appear on nameplates. + - isRaid + - *boolean* + - Whether or not this aura meets the conditions of the RAID aura filter. + - isStealable + - *boolean* + - maxCharges + - *number* + - name + - *string* + - The name of the aura. + - nameplateShowAll + - *boolean* + - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - nameplateShowPersonal + - *boolean* + - points + - *array* + - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - sourceUnit + - *string?* + - Token of the unit that applied the aura. + - spellId + - *number* + - The spell ID of the aura. + - timeMod + - *number* + +**Content Details:** +The extended payload can be supplied to the AuraUtil.ShouldSkipAuraUpdate function alongside a predicate function to determine if a consumer of this event may skip further processing of the event as a performance optimization. +Related API +UnitAura + +**Usage:** +The aura InstanceIDs can be used to efficiently process aura updates and is queried with C_UnitAuras.GetAuraDataByAuraInstanceID. + Warning: GetAuraDataByAuraInstanceID doesn't work on removed aura InstanceIDs, so it might be a good idea to cache the information. +```lua +local count = 0 +local function OnEvent(self, event, unit, info) + count = count + 1 + if info.isFullUpdate then + print("full update") + return + end + if info.addedAuras then + local t = {} + for _, v in pairs(info.addedAuras) do + tinsert(t, format("%d(%s)", v.auraInstanceID, v.name)) + end + print(count, unit, "|cnGREEN_FONT_COLOR:added|r", table.concat(t, ", ")) + end + if info.updatedAuraInstanceIDs then + local t = {} + for _, v in pairs(info.updatedAuraInstanceIDs) do + local aura = C_UnitAuras.GetAuraDataByAuraInstanceID(unit, v) + tinsert(t, format("%d(%s)", aura.auraInstanceID, aura.name)) + end + print(count, unit, "|cnYELLOW_FONT_COLOR:updated|r", table.concat(t, ", ")) + end + if info.removedAuraInstanceIDs then + local t = {} + for _, v in pairs(info.removedAuraInstanceIDs) do + tinsert(t, v) + end + print(count, unit, "|cnRED_FONT_COLOR:removed|r", table.concat(t, ", ")) + end +end +local f = CreateFrame("Frame") +f:RegisterEvent("UNIT_AURA") +f:SetScript("OnEvent", OnEvent) +``` +The payload can contain any combination of addedAuras, updatedAuraInstanceIDs and removedAuraInstanceIDs. \ No newline at end of file diff --git a/wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md b/wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md new file mode 100644 index 00000000..50e191cf --- /dev/null +++ b/wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md @@ -0,0 +1,10 @@ +## Event: UNIT_CHEAT_TOGGLE_EVENT + +**Title:** UNIT CHEAT TOGGLE EVENT + +**Content:** +Needs summary. +`UNIT_CHEAT_TOGGLE_EVENT` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md b/wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md new file mode 100644 index 00000000..bba6938d --- /dev/null +++ b/wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md @@ -0,0 +1,11 @@ +## Event: UNIT_CLASSIFICATION_CHANGED + +**Title:** UNIT CLASSIFICATION CHANGED + +**Content:** +Needs summary. +`UNIT_CLASSIFICATION_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_COMBAT.md b/wiki-information/events/UNIT_COMBAT.md new file mode 100644 index 00000000..edd378f4 --- /dev/null +++ b/wiki-information/events/UNIT_COMBAT.md @@ -0,0 +1,19 @@ +## Event: UNIT_COMBAT + +**Title:** UNIT COMBAT + +**Content:** +Fired when an npc or player participates in combat and takes damage +`UNIT_COMBAT: unitTarget, event, flagText, amount, schoolMask` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `event` + - *string* - Action, Damage, etc (e.g. HEAL, DODGE, BLOCK, WOUND, MISS, PARRY, RESIST, ...) +- `flagText` + - *string* - Critical/Glancing indicator (e.g. CRITICAL, CRUSHING, GLANCING) +- `amount` + - *number* - The numeric damage +- `schoolMask` + - *number* - Damage type in numeric value (1 - physical; 2 - holy; 4 - fire; 8 - nature; 16 - frost; 32 - shadow; 64 - arcane) \ No newline at end of file diff --git a/wiki-information/events/UNIT_CONNECTION.md b/wiki-information/events/UNIT_CONNECTION.md new file mode 100644 index 00000000..da314b0d --- /dev/null +++ b/wiki-information/events/UNIT_CONNECTION.md @@ -0,0 +1,13 @@ +## Event: UNIT_CONNECTION + +**Title:** UNIT CONNECTION + +**Content:** +Needs summary. +`UNIT_CONNECTION: unitTarget, isConnected` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `isConnected` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/UNIT_DAMAGE.md b/wiki-information/events/UNIT_DAMAGE.md new file mode 100644 index 00000000..37eb2909 --- /dev/null +++ b/wiki-information/events/UNIT_DAMAGE.md @@ -0,0 +1,14 @@ +## Event: UNIT_DAMAGE + +**Title:** UNIT DAMAGE + +**Content:** +Fired when the units melee damage changes. +`UNIT_DAMAGE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +Be warned that this often gets fired multiple times, for example when you change weapons. \ No newline at end of file diff --git a/wiki-information/events/UNIT_DEFENSE.md b/wiki-information/events/UNIT_DEFENSE.md new file mode 100644 index 00000000..fbcb3214 --- /dev/null +++ b/wiki-information/events/UNIT_DEFENSE.md @@ -0,0 +1,11 @@ +## Event: UNIT_DEFENSE + +**Title:** UNIT DEFENSE + +**Content:** +Fired when a units defense is affected. +`UNIT_DEFENSE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_DISPLAYPOWER.md b/wiki-information/events/UNIT_DISPLAYPOWER.md new file mode 100644 index 00000000..d2ef4646 --- /dev/null +++ b/wiki-information/events/UNIT_DISPLAYPOWER.md @@ -0,0 +1,11 @@ +## Event: UNIT_DISPLAYPOWER + +**Title:** UNIT DISPLAYPOWER + +**Content:** +Fired when the unit's mana stype is changed. Occurs when a druid shapeshifts as well as in certain other cases. +`UNIT_DISPLAYPOWER: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_ENTERED_VEHICLE.md b/wiki-information/events/UNIT_ENTERED_VEHICLE.md new file mode 100644 index 00000000..a08a9138 --- /dev/null +++ b/wiki-information/events/UNIT_ENTERED_VEHICLE.md @@ -0,0 +1,23 @@ +## Event: UNIT_ENTERED_VEHICLE + +**Title:** UNIT ENTERED VEHICLE + +**Content:** +Fired once the unit is considered to be inside a vehicle, as compared to UNIT_ENTERING_VEHICLE which happens beforehand. +`UNIT_ENTERED_VEHICLE: unitTarget, showVehicleFrame, isControlSeat, vehicleUIIndicatorID, vehicleGUID, mayChooseExit, hasPitch` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `showVehicleFrame` + - *boolean* - Vehicle has vehicle UI. +- `isControlSeat` + - *boolean* +- `vehicleUIIndicatorID` + - *number* - VehicleType (possible values are 'Natural' and 'Mechanical' and 'VehicleMount' and 'VehicleMount_Organic' or empty string). +- `vehicleGUID` + - *string* +- `mayChooseExit` + - *boolean* +- `hasPitch` + - *boolean* - Vehicle can aim. \ No newline at end of file diff --git a/wiki-information/events/UNIT_ENTERING_VEHICLE.md b/wiki-information/events/UNIT_ENTERING_VEHICLE.md new file mode 100644 index 00000000..2de36cca --- /dev/null +++ b/wiki-information/events/UNIT_ENTERING_VEHICLE.md @@ -0,0 +1,23 @@ +## Event: UNIT_ENTERING_VEHICLE + +**Title:** UNIT ENTERING VEHICLE + +**Content:** +Fired as a unit is about to enter a vehicle, as compared to UNIT_ENTERED_VEHICLE which happens afterward. +`UNIT_ENTERING_VEHICLE: unitTarget, showVehicleFrame, isControlSeat, vehicleUIIndicatorID, vehicleGUID, mayChooseExit, hasPitch` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `showVehicleFrame` + - *boolean* +- `isControlSeat` + - *boolean* +- `vehicleUIIndicatorID` + - *number* +- `vehicleGUID` + - *string* +- `mayChooseExit` + - *boolean* +- `hasPitch` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/UNIT_EXITED_VEHICLE.md b/wiki-information/events/UNIT_EXITED_VEHICLE.md new file mode 100644 index 00000000..330b890d --- /dev/null +++ b/wiki-information/events/UNIT_EXITED_VEHICLE.md @@ -0,0 +1,11 @@ +## Event: UNIT_EXITED_VEHICLE + +**Title:** UNIT EXITED VEHICLE + +**Content:** +Fired once the unit is considered to have left a vehicle, as compared to UNIT_EXITING_VEHICLE which happens beforehand. +`UNIT_EXITED_VEHICLE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_EXITING_VEHICLE.md b/wiki-information/events/UNIT_EXITING_VEHICLE.md new file mode 100644 index 00000000..51037354 --- /dev/null +++ b/wiki-information/events/UNIT_EXITING_VEHICLE.md @@ -0,0 +1,11 @@ +## Event: UNIT_EXITING_VEHICLE + +**Title:** UNIT EXITING VEHICLE + +**Content:** +Fired as a unit is about to exit a vehicle, as compared to UNIT_EXITED_VEHICLE which happens afterward. +`UNIT_EXITING_VEHICLE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_FACTION.md b/wiki-information/events/UNIT_FACTION.md new file mode 100644 index 00000000..9a73cde6 --- /dev/null +++ b/wiki-information/events/UNIT_FACTION.md @@ -0,0 +1,11 @@ +## Event: UNIT_FACTION + +**Title:** UNIT FACTION + +**Content:** +Fired when a unit's faction is available. +`UNIT_FACTION: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_FLAGS.md b/wiki-information/events/UNIT_FLAGS.md new file mode 100644 index 00000000..3dc53afa --- /dev/null +++ b/wiki-information/events/UNIT_FLAGS.md @@ -0,0 +1,11 @@ +## Event: UNIT_FLAGS + +**Title:** UNIT FLAGS + +**Content:** +Needs summary. +`UNIT_FLAGS: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_HAPPINESS.md b/wiki-information/events/UNIT_HAPPINESS.md new file mode 100644 index 00000000..430a30be --- /dev/null +++ b/wiki-information/events/UNIT_HAPPINESS.md @@ -0,0 +1,11 @@ +## Event: UNIT_HAPPINESS + +**Title:** UNIT HAPPINESS + +**Content:** +Fired when the Pet Happiness changes. +`UNIT_HAPPINESS: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_HEALTH.md b/wiki-information/events/UNIT_HEALTH.md new file mode 100644 index 00000000..fab7029a --- /dev/null +++ b/wiki-information/events/UNIT_HEALTH.md @@ -0,0 +1,15 @@ +## Event: UNIT_HEALTH + +**Title:** UNIT HEALTH + +**Content:** +Fires when the health of a unit changes. +`UNIT_HEALTH: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +Related API +UnitHealth \ No newline at end of file diff --git a/wiki-information/events/UNIT_HEALTH_FREQUENT.md b/wiki-information/events/UNIT_HEALTH_FREQUENT.md new file mode 100644 index 00000000..3e03b23d --- /dev/null +++ b/wiki-information/events/UNIT_HEALTH_FREQUENT.md @@ -0,0 +1,15 @@ +## Event: UNIT_HEALTH_FREQUENT + +**Title:** UNIT HEALTH FREQUENT + +**Content:** +Same event as UNIT_HEALTH but not throttled as aggressively by the client. +`UNIT_HEALTH_FREQUENT: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +Related API +UnitHealth \ No newline at end of file diff --git a/wiki-information/events/UNIT_HEAL_PREDICTION.md b/wiki-information/events/UNIT_HEAL_PREDICTION.md new file mode 100644 index 00000000..3acb2b3f --- /dev/null +++ b/wiki-information/events/UNIT_HEAL_PREDICTION.md @@ -0,0 +1,11 @@ +## Event: UNIT_HEAL_PREDICTION + +**Title:** UNIT HEAL PREDICTION + +**Content:** +Needs summary. +`UNIT_HEAL_PREDICTION: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_INVENTORY_CHANGED.md b/wiki-information/events/UNIT_INVENTORY_CHANGED.md new file mode 100644 index 00000000..61087d11 --- /dev/null +++ b/wiki-information/events/UNIT_INVENTORY_CHANGED.md @@ -0,0 +1,20 @@ +## Event: UNIT_INVENTORY_CHANGED + +**Title:** UNIT INVENTORY CHANGED + +**Content:** +Fired when the player equips or unequips an item. +`UNIT_INVENTORY_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +This event is not triggered when equipping/unequipping rings or trinkets. +This can also be called if your target or party members changes equipment (untested for hostile targets). +This event is also raised when a new item is placed in the player's containers, taking up a new slot. If the new item(s) are placed onto an existing stack or when two stacks already in the containers are merged, the event is not raised. When an item is moved inside the container or to the bank, the event is not raised. The event is raised when an existing stack is split inside the player's containers. +This event is also raised when a temporary enhancement (poison, lure, etc..) is applied to the player's weapon (untested for other units). It will again be raised when that enhancement is removed, including by manual cancellation or buff expiration. +If multiple slots are equipped/unequipped at once it only fires once now. +This event is triggered during initial character login but not during subsequent reloads. +This event is no longer triggered when changing zones. Inventory information is available when PLAYER_ENTERING_WORLD is triggered. \ No newline at end of file diff --git a/wiki-information/events/UNIT_LEVEL.md b/wiki-information/events/UNIT_LEVEL.md new file mode 100644 index 00000000..17ee9c5e --- /dev/null +++ b/wiki-information/events/UNIT_LEVEL.md @@ -0,0 +1,11 @@ +## Event: UNIT_LEVEL + +**Title:** UNIT LEVEL + +**Content:** +Fired whenever the level of a unit is available (e.g. when clicking a unit or someone joins the party). +`UNIT_LEVEL: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_MANA.md b/wiki-information/events/UNIT_MANA.md new file mode 100644 index 00000000..b64a241e --- /dev/null +++ b/wiki-information/events/UNIT_MANA.md @@ -0,0 +1,11 @@ +## Event: UNIT_MANA + +**Title:** UNIT MANA + +**Content:** +Fired whenever a unit's mana changes. +`UNIT_MANA: unitTarget` + +**Payload:** +- `unitTarget` + - *string* - UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_MAXHEALTH.md b/wiki-information/events/UNIT_MAXHEALTH.md new file mode 100644 index 00000000..c73d1e54 --- /dev/null +++ b/wiki-information/events/UNIT_MAXHEALTH.md @@ -0,0 +1,15 @@ +## Event: UNIT_MAXHEALTH + +**Title:** UNIT MAXHEALTH + +**Content:** +Fires when the maximum health of a unit changes. +`UNIT_MAXHEALTH: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +Related API +UnitHealthMax \ No newline at end of file diff --git a/wiki-information/events/UNIT_MAXPOWER.md b/wiki-information/events/UNIT_MAXPOWER.md new file mode 100644 index 00000000..1355cdcb --- /dev/null +++ b/wiki-information/events/UNIT_MAXPOWER.md @@ -0,0 +1,13 @@ +## Event: UNIT_MAXPOWER + +**Title:** UNIT MAXPOWER + +**Content:** +Fired when a unit's maximum power (mana, rage, focus, energy, runic power, ...) changes. +`UNIT_MAXPOWER: unitTarget, powerType` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `powerType` + - *string* - resource whose maximum value changed: "MANA", "RAGE", "ENERGY", "FOCUS", "HAPPINESS", "RUNIC_POWER". \ No newline at end of file diff --git a/wiki-information/events/UNIT_MODEL_CHANGED.md b/wiki-information/events/UNIT_MODEL_CHANGED.md new file mode 100644 index 00000000..a6643bec --- /dev/null +++ b/wiki-information/events/UNIT_MODEL_CHANGED.md @@ -0,0 +1,11 @@ +## Event: UNIT_MODEL_CHANGED + +**Title:** UNIT MODEL CHANGED + +**Content:** +Fired when the unit's 3d model changes. +`UNIT_MODEL_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_NAME_UPDATE.md b/wiki-information/events/UNIT_NAME_UPDATE.md new file mode 100644 index 00000000..442b4003 --- /dev/null +++ b/wiki-information/events/UNIT_NAME_UPDATE.md @@ -0,0 +1,11 @@ +## Event: UNIT_NAME_UPDATE + +**Title:** UNIT NAME UPDATE + +**Content:** +Fired when a unit's name changes. +`UNIT_NAME_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md b/wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md new file mode 100644 index 00000000..f7567283 --- /dev/null +++ b/wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md @@ -0,0 +1,13 @@ +## Event: UNIT_OTHER_PARTY_CHANGED + +**Title:** UNIT OTHER PARTY CHANGED + +**Content:** +Fired when a unit enter or leave an instance group while within a regular group. +Example¹: a unit doing dungeon finder, accepts an invite from a friend outside the instanced group. +Example²: the same unit leaves the instanced group and, is now in fact, inside the friend's group. +`UNIT_OTHER_PARTY_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PET.md b/wiki-information/events/UNIT_PET.md new file mode 100644 index 00000000..1fdb771f --- /dev/null +++ b/wiki-information/events/UNIT_PET.md @@ -0,0 +1,11 @@ +## Event: UNIT_PET + +**Title:** UNIT PET + +**Content:** +Fired when a unit's pet changes. +`UNIT_PET: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PET_EXPERIENCE.md b/wiki-information/events/UNIT_PET_EXPERIENCE.md new file mode 100644 index 00000000..8bf85124 --- /dev/null +++ b/wiki-information/events/UNIT_PET_EXPERIENCE.md @@ -0,0 +1,11 @@ +## Event: UNIT_PET_EXPERIENCE + +**Title:** UNIT PET EXPERIENCE + +**Content:** +Fired when the pet's experience changes. +`UNIT_PET_EXPERIENCE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PET_TRAINING_POINTS.md b/wiki-information/events/UNIT_PET_TRAINING_POINTS.md new file mode 100644 index 00000000..348c61f0 --- /dev/null +++ b/wiki-information/events/UNIT_PET_TRAINING_POINTS.md @@ -0,0 +1,11 @@ +## Event: UNIT_PET_TRAINING_POINTS + +**Title:** UNIT PET TRAINING POINTS + +**Content:** +Needs summary. +`UNIT_PET_TRAINING_POINTS: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PHASE.md b/wiki-information/events/UNIT_PHASE.md new file mode 100644 index 00000000..531f00ab --- /dev/null +++ b/wiki-information/events/UNIT_PHASE.md @@ -0,0 +1,14 @@ +## Event: UNIT_PHASE + +**Title:** UNIT PHASE + +**Content:** +Fires when a unit becomes phased or unphased. +`UNIT_PHASE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Related Information:** +UnitPhaseReason(unit) \ No newline at end of file diff --git a/wiki-information/events/UNIT_PORTRAIT_UPDATE.md b/wiki-information/events/UNIT_PORTRAIT_UPDATE.md new file mode 100644 index 00000000..13c1ecff --- /dev/null +++ b/wiki-information/events/UNIT_PORTRAIT_UPDATE.md @@ -0,0 +1,11 @@ +## Event: UNIT_PORTRAIT_UPDATE + +**Title:** UNIT PORTRAIT UPDATE + +**Content:** +Fired when a units portrait changes. +`UNIT_PORTRAIT_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_BAR_HIDE.md b/wiki-information/events/UNIT_POWER_BAR_HIDE.md new file mode 100644 index 00000000..d61109c9 --- /dev/null +++ b/wiki-information/events/UNIT_POWER_BAR_HIDE.md @@ -0,0 +1,11 @@ +## Event: UNIT_POWER_BAR_HIDE + +**Title:** UNIT POWER BAR HIDE + +**Content:** +Needs summary. +`UNIT_POWER_BAR_HIDE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_BAR_SHOW.md b/wiki-information/events/UNIT_POWER_BAR_SHOW.md new file mode 100644 index 00000000..af4b881e --- /dev/null +++ b/wiki-information/events/UNIT_POWER_BAR_SHOW.md @@ -0,0 +1,11 @@ +## Event: UNIT_POWER_BAR_SHOW + +**Title:** UNIT POWER BAR SHOW + +**Content:** +Needs summary. +`UNIT_POWER_BAR_SHOW: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md b/wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md new file mode 100644 index 00000000..08ba3074 --- /dev/null +++ b/wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md @@ -0,0 +1,11 @@ +## Event: UNIT_POWER_BAR_TIMER_UPDATE + +**Title:** UNIT POWER BAR TIMER UPDATE + +**Content:** +Needs summary. +`UNIT_POWER_BAR_TIMER_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_FREQUENT.md b/wiki-information/events/UNIT_POWER_FREQUENT.md new file mode 100644 index 00000000..fdf60d6b --- /dev/null +++ b/wiki-information/events/UNIT_POWER_FREQUENT.md @@ -0,0 +1,20 @@ +## Event: UNIT_POWER_FREQUENT + +**Title:** UNIT POWER FREQUENT + +**Content:** +Fired when a unit's current power (mana, rage, focus, energy, runic power, holy power, ...) changes. +`UNIT_POWER_FREQUENT: unitTarget, powerType` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `powerType` + - *string* + +**Content Details:** +Unlike UNIT_POWER_UPDATE, this event will fire multiple times per frame while the unit's power is regenerating or decaying quickly. +Related API +UnitPower +Related Events +UNIT_POWER_UPDATE \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_UPDATE.md b/wiki-information/events/UNIT_POWER_UPDATE.md new file mode 100644 index 00000000..b7c66fe0 --- /dev/null +++ b/wiki-information/events/UNIT_POWER_UPDATE.md @@ -0,0 +1,25 @@ +## Event: UNIT_POWER_UPDATE + +**Title:** UNIT POWER UPDATE + +**Content:** +Fired when a unit's current power (mana, rage, focus, energy, runic power, holy power, ...) changes. See below for details. +`UNIT_POWER_UPDATE: unitTarget, powerType` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `powerType` + - *string* - resource whose value changed: "MANA", "RAGE", "ENERGY", "FOCUS", "HAPPINESS", "RUNIC_POWER", "HOLY_POWER". + +**Content Details:** +This event is fired under the following conditions: +- A spell is cast which changes the unit's power. +- The unit reaches full power. +- While the unit's power is naturally regenerating or decaying, this event will only fire once every two seconds. See UNIT_POWER_FREQUENT for a more exact alternative. +Related API +- UnitPower +Related Events +- UNIT_POWER_FREQUENT +Related Enum +- Enum.PowerType \ No newline at end of file diff --git a/wiki-information/events/UNIT_QUEST_LOG_CHANGED.md b/wiki-information/events/UNIT_QUEST_LOG_CHANGED.md new file mode 100644 index 00000000..e85a32be --- /dev/null +++ b/wiki-information/events/UNIT_QUEST_LOG_CHANGED.md @@ -0,0 +1,11 @@ +## Event: UNIT_QUEST_LOG_CHANGED + +**Title:** UNIT QUEST LOG CHANGED + +**Content:** +Fired whenever the quest log changes. (Frequently, but not as frequently as QUEST_LOG_UPDATE) +`UNIT_QUEST_LOG_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_RANGEDDAMAGE.md b/wiki-information/events/UNIT_RANGEDDAMAGE.md new file mode 100644 index 00000000..dcdf2d14 --- /dev/null +++ b/wiki-information/events/UNIT_RANGEDDAMAGE.md @@ -0,0 +1,11 @@ +## Event: UNIT_RANGEDDAMAGE + +**Title:** UNIT RANGEDDAMAGE + +**Content:** +Fired when a unit's ranged damage changes. +`UNIT_RANGEDDAMAGE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_RANGED_ATTACK_POWER.md b/wiki-information/events/UNIT_RANGED_ATTACK_POWER.md new file mode 100644 index 00000000..1686b6f5 --- /dev/null +++ b/wiki-information/events/UNIT_RANGED_ATTACK_POWER.md @@ -0,0 +1,11 @@ +## Event: UNIT_RANGED_ATTACK_POWER + +**Title:** UNIT RANGED ATTACK POWER + +**Content:** +Fired when a unit's ranged attack power changes. +`UNIT_RANGED_ATTACK_POWER: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_RESISTANCES.md b/wiki-information/events/UNIT_RESISTANCES.md new file mode 100644 index 00000000..24f63ef5 --- /dev/null +++ b/wiki-information/events/UNIT_RESISTANCES.md @@ -0,0 +1,11 @@ +## Event: UNIT_RESISTANCES + +**Title:** UNIT RESISTANCES + +**Content:** +Fired when the units resistance changes +`UNIT_RESISTANCES: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md new file mode 100644 index 00000000..5c228b9e --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_CHANNEL_START + +**Title:** UNIT SPELLCAST CHANNEL START + +**Content:** +Fired when a unit begins channeling in the course of casting a spell. Received for party/raid members as well as the player. +`UNIT_SPELLCAST_CHANNEL_START: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md new file mode 100644 index 00000000..528a54e6 --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_CHANNEL_STOP + +**Title:** UNIT SPELLCAST CHANNEL STOP + +**Content:** +Fired when a unit stops channeling. Received for party/raid members as well as the player. +`UNIT_SPELLCAST_CHANNEL_STOP: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md new file mode 100644 index 00000000..a0154716 --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_CHANNEL_UPDATE + +**Title:** UNIT SPELLCAST CHANNEL UPDATE + +**Content:** +Fires while a unit is channeling. Received for party/raid members, as well as the player. +`UNIT_SPELLCAST_CHANNEL_UPDATE: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_DELAYED.md b/wiki-information/events/UNIT_SPELLCAST_DELAYED.md new file mode 100644 index 00000000..9667a1d1 --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_DELAYED.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_DELAYED + +**Title:** UNIT SPELLCAST DELAYED + +**Content:** +Fired when a unit's spellcast is delayed, including party/raid members or the player. +`UNIT_SPELLCAST_DELAYED: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_FAILED.md b/wiki-information/events/UNIT_SPELLCAST_FAILED.md new file mode 100644 index 00000000..f3d62c2a --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_FAILED.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_FAILED + +**Title:** UNIT SPELLCAST FAILED + +**Content:** +Fired when a unit's spellcast fails, including party/raid members or the player. +`UNIT_SPELLCAST_FAILED: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md b/wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md new file mode 100644 index 00000000..a92c432e --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_FAILED_QUIET + +**Title:** UNIT SPELLCAST FAILED QUIET + +**Content:** +Needs summary. +`UNIT_SPELLCAST_FAILED_QUIET: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md b/wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md new file mode 100644 index 00000000..d2a464ce --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_INTERRUPTED + +**Title:** UNIT SPELLCAST INTERRUPTED + +**Content:** +Fired when a unit's spellcast is interrupted, including party/raid members or the player. +`UNIT_SPELLCAST_INTERRUPTED: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_SENT.md b/wiki-information/events/UNIT_SPELLCAST_SENT.md new file mode 100644 index 00000000..b0cef023 --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_SENT.md @@ -0,0 +1,20 @@ +## Event: UNIT_SPELLCAST_SENT + +**Title:** UNIT SPELLCAST SENT + +**Content:** +Fired when a unit attempts to cast a spell regardless of the success of the cast. +`UNIT_SPELLCAST_SENT: unit, target, castGUID, spellID` + +**Payload:** +- `unit` + - *string* : UnitId - Only fires for "player" +- `target` + - *string* : UnitId +- `castGUID` + - *string* : GUID - e.g. for (Spell ID 1543) "Cast-3-3783-1-7-1543-000197DD84" +- `spellID` + - *number* + +**Content Details:** +Fired when a unit tries to cast an instant, non-instant, or channeling spell even if out of range or out of line-of-sight (unless the unit is attempting to cast a non-instant spell while already casting or attempting to cast a spell that is on cooldown). \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_START.md b/wiki-information/events/UNIT_SPELLCAST_START.md new file mode 100644 index 00000000..b0a01ed2 --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_START.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_START + +**Title:** UNIT SPELLCAST START + +**Content:** +Fired when a unit begins casting a non-instant cast spell, including party/raid members or the player. +`UNIT_SPELLCAST_START: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_STOP.md b/wiki-information/events/UNIT_SPELLCAST_STOP.md new file mode 100644 index 00000000..8b6c1216 --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_STOP.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_STOP + +**Title:** UNIT SPELLCAST STOP + +**Content:** +Fired when a unit stops casting, including party/raid members or the player. +`UNIT_SPELLCAST_STOP: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md b/wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md new file mode 100644 index 00000000..da74efec --- /dev/null +++ b/wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md @@ -0,0 +1,15 @@ +## Event: UNIT_SPELLCAST_SUCCEEDED + +**Title:** UNIT SPELLCAST SUCCEEDED + +**Content:** +Fired when a spell is cast successfully. Event is received even if spell is resisted. +`UNIT_SPELLCAST_SUCCEEDED: unitTarget, castGUID, spellID` + +**Payload:** +- `unitTarget` + - *string* : UnitId +- `castGUID` + - *string* +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELL_HASTE.md b/wiki-information/events/UNIT_SPELL_HASTE.md new file mode 100644 index 00000000..ffacee3a --- /dev/null +++ b/wiki-information/events/UNIT_SPELL_HASTE.md @@ -0,0 +1,11 @@ +## Event: UNIT_SPELL_HASTE + +**Title:** UNIT SPELL HASTE + +**Content:** +Needs summary. +`UNIT_SPELL_HASTE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_STATS.md b/wiki-information/events/UNIT_STATS.md new file mode 100644 index 00000000..f52f3d2e --- /dev/null +++ b/wiki-information/events/UNIT_STATS.md @@ -0,0 +1,11 @@ +## Event: UNIT_STATS + +**Title:** UNIT STATS + +**Content:** +Fired when a units stats are available. +`UNIT_STATS: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_TARGET.md b/wiki-information/events/UNIT_TARGET.md new file mode 100644 index 00000000..f6216ab1 --- /dev/null +++ b/wiki-information/events/UNIT_TARGET.md @@ -0,0 +1,14 @@ +## Event: UNIT_TARGET + +**Title:** UNIT TARGET + +**Content:** +Fired when the target of yourself, raid, and party members change +`UNIT_TARGET: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +Should also work for 'pet' and 'focus'. This event only fires when the triggering unit is within the player's visual range. \ No newline at end of file diff --git a/wiki-information/events/UNIT_TARGETABLE_CHANGED.md b/wiki-information/events/UNIT_TARGETABLE_CHANGED.md new file mode 100644 index 00000000..0b920099 --- /dev/null +++ b/wiki-information/events/UNIT_TARGETABLE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: UNIT_TARGETABLE_CHANGED + +**Title:** UNIT TARGETABLE CHANGED + +**Content:** +Needs summary. +`UNIT_TARGETABLE_CHANGED: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_THREAT_LIST_UPDATE.md b/wiki-information/events/UNIT_THREAT_LIST_UPDATE.md new file mode 100644 index 00000000..9bfb765a --- /dev/null +++ b/wiki-information/events/UNIT_THREAT_LIST_UPDATE.md @@ -0,0 +1,14 @@ +## Event: UNIT_THREAT_LIST_UPDATE + +**Title:** UNIT THREAT LIST UPDATE + +**Content:** +Fired when the client receives updated threat information from the server, if an available mob's threat list has changed at all (i.e. anybody in combat with it has done anything). +`UNIT_THREAT_LIST_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId + +**Content Details:** +The unitTarget parameter may be "target" or "nameplateX" (and possibly some other units). However, this event does not fire for "targettarget" or "raidXtarget" (in WoW 1.13.6), even though updated threat values may be available using UnitDetailedThreatSituation. Therefore, threat addons for healers may need to periodically poll UnitDetailedThreatSituation, since enemies may be outside nameplate range (which is very short in Classic) and changing targets is undesired. \ No newline at end of file diff --git a/wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md b/wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md new file mode 100644 index 00000000..192b48de --- /dev/null +++ b/wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md @@ -0,0 +1,11 @@ +## Event: UNIT_THREAT_SITUATION_UPDATE + +**Title:** UNIT THREAT SITUATION UPDATE + +**Content:** +Fired when an available unit on an available mob's threat list moves past another unit on that list. +`UNIT_THREAT_SITUATION_UPDATE: unitTarget` + +**Payload:** +- `unitTarget` + - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md b/wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md new file mode 100644 index 00000000..23ee0b98 --- /dev/null +++ b/wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md @@ -0,0 +1,10 @@ +## Event: UPDATE ACTIVE BATTLEFIELD + +**Title:** UPDATE ACTIVE BATTLEFIELD + +**Content:** +Needs summary. +`UPDATE_ACTIVE_BATTLEFIELD` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_ALL_UI_WIDGETS.md b/wiki-information/events/UPDATE_ALL_UI_WIDGETS.md new file mode 100644 index 00000000..c30f996e --- /dev/null +++ b/wiki-information/events/UPDATE_ALL_UI_WIDGETS.md @@ -0,0 +1,10 @@ +## Event: UPDATE_ALL_UI_WIDGETS + +**Title:** UPDATE ALL UI WIDGETS + +**Content:** +Needs summary. +`UPDATE_ALL_UI_WIDGETS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md b/wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md new file mode 100644 index 00000000..4630f3d7 --- /dev/null +++ b/wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md @@ -0,0 +1,10 @@ +## Event: UPDATE_BATTLEFIELD_SCORE + +**Title:** UPDATE BATTLEFIELD SCORE + +**Content:** +Fired whenever new battlefield score data has been received, this is usually fired after RequestBattlefieldScoreData is called. +`UPDATE_BATTLEFIELD_SCORE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md b/wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md new file mode 100644 index 00000000..0e10ce60 --- /dev/null +++ b/wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md @@ -0,0 +1,11 @@ +## Event: UPDATE_BATTLEFIELD_STATUS + +**Title:** UPDATE BATTLEFIELD STATUS + +**Content:** +Fired whenever joining a queue, leaving a queue, battlefield to join is changed, when you can join a battlefield, or if somebody wins the battleground. +`UPDATE_BATTLEFIELD_STATUS: battleFieldIndex` + +**Payload:** +- `battleFieldIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BINDINGS.md b/wiki-information/events/UPDATE_BINDINGS.md new file mode 100644 index 00000000..da474f1f --- /dev/null +++ b/wiki-information/events/UPDATE_BINDINGS.md @@ -0,0 +1,10 @@ +## Event: UPDATE_BINDINGS + +**Title:** UPDATE BINDINGS + +**Content:** +Fired when the keybindings are changed. Fired after completion of LoadBindings, SaveBindings, and SetBinding (and its derivatives). +`UPDATE_BINDINGS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BONUS_ACTIONBAR.md b/wiki-information/events/UPDATE_BONUS_ACTIONBAR.md new file mode 100644 index 00000000..d5b8907e --- /dev/null +++ b/wiki-information/events/UPDATE_BONUS_ACTIONBAR.md @@ -0,0 +1,10 @@ +## Event: UPDATE_BONUS_ACTIONBAR + +**Title:** UPDATE BONUS ACTIONBAR + +**Content:** +Needs summary. +`UPDATE_BONUS_ACTIONBAR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_CHAT_COLOR.md b/wiki-information/events/UPDATE_CHAT_COLOR.md new file mode 100644 index 00000000..5ee1327e --- /dev/null +++ b/wiki-information/events/UPDATE_CHAT_COLOR.md @@ -0,0 +1,17 @@ +## Event: UPDATE_CHAT_COLOR + +**Title:** UPDATE CHAT COLOR + +**Content:** +Fired when the chat colour needs to be updated. Refer to ChangeChatColor for details on the parameters. +`UPDATE_CHAT_COLOR: name, r, g, b` + +**Payload:** +- `name` + - *string* - Chat type +- `r` + - *number* - red +- `g` + - *number* - green +- `b` + - *number* - blue \ No newline at end of file diff --git a/wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md b/wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md new file mode 100644 index 00000000..a1cf62ec --- /dev/null +++ b/wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md @@ -0,0 +1,13 @@ +## Event: UPDATE_CHAT_COLOR_NAME_BY_CLASS + +**Title:** UPDATE CHAT COLOR NAME BY CLASS + +**Content:** +Needs summary. +`UPDATE_CHAT_COLOR_NAME_BY_CLASS: name, colorNameByClass` + +**Payload:** +- `name` + - *string* +- `colorNameByClass` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/UPDATE_CHAT_WINDOWS.md b/wiki-information/events/UPDATE_CHAT_WINDOWS.md new file mode 100644 index 00000000..5bb85b03 --- /dev/null +++ b/wiki-information/events/UPDATE_CHAT_WINDOWS.md @@ -0,0 +1,10 @@ +## Event: UPDATE_CHAT_WINDOWS + +**Title:** UPDATE CHAT WINDOWS + +**Content:** +Fired on load when chat settings are available for chat windows. +`UPDATE_CHAT_WINDOWS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_EXHAUSTION.md b/wiki-information/events/UPDATE_EXHAUSTION.md new file mode 100644 index 00000000..84824be1 --- /dev/null +++ b/wiki-information/events/UPDATE_EXHAUSTION.md @@ -0,0 +1,10 @@ +## Event: UPDATE_EXHAUSTION + +**Title:** UPDATE EXHAUSTION + +**Content:** +Fired when your character's XP exhaustion (i.e. the amount of your character's rested bonus) changes. Use `GetXPExhaustion` to query the current value. +`UPDATE_EXHAUSTION` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_FACTION.md b/wiki-information/events/UPDATE_FACTION.md new file mode 100644 index 00000000..201fed06 --- /dev/null +++ b/wiki-information/events/UPDATE_FACTION.md @@ -0,0 +1,10 @@ +## Event: UPDATE_FACTION + +**Title:** UPDATE FACTION + +**Content:** +Fired when your character's reputation of some faction has changed. +`UPDATE_FACTION` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md b/wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md new file mode 100644 index 00000000..f82da969 --- /dev/null +++ b/wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md @@ -0,0 +1,10 @@ +## Event: UPDATE_FLOATING_CHAT_WINDOWS + +**Title:** UPDATE FLOATING CHAT WINDOWS + +**Content:** +Fired on load when chat settings are available for a certain chat window. +`UPDATE_FLOATING_CHAT_WINDOWS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_INSTANCE_INFO.md b/wiki-information/events/UPDATE_INSTANCE_INFO.md new file mode 100644 index 00000000..839b7345 --- /dev/null +++ b/wiki-information/events/UPDATE_INSTANCE_INFO.md @@ -0,0 +1,10 @@ +## Event: UPDATE_INSTANCE_INFO + +**Title:** UPDATE INSTANCE INFO + +**Content:** +Fired when data from RequestRaidInfo is available. +`UPDATE_INSTANCE_INFO` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_INVENTORY_ALERTS.md b/wiki-information/events/UPDATE_INVENTORY_ALERTS.md new file mode 100644 index 00000000..81f84c58 --- /dev/null +++ b/wiki-information/events/UPDATE_INVENTORY_ALERTS.md @@ -0,0 +1,10 @@ +## Event: UPDATE_INVENTORY_ALERTS + +**Title:** UPDATE INVENTORY ALERTS + +**Content:** +Fires whenever an item's durability status becomes yellow (low) or red (broken). Signals that the durability frame needs to be updated. May also fire on any durability status change, even if that change doesn't require an update to the durability frame. +`UPDATE_INVENTORY_ALERTS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_INVENTORY_DURABILITY.md b/wiki-information/events/UPDATE_INVENTORY_DURABILITY.md new file mode 100644 index 00000000..293480d1 --- /dev/null +++ b/wiki-information/events/UPDATE_INVENTORY_DURABILITY.md @@ -0,0 +1,10 @@ +## Event: UPDATE_INVENTORY_DURABILITY + +**Title:** UPDATE INVENTORY DURABILITY + +**Content:** +Should fire whenever the durability of an item in the character's possession changes. +`UPDATE_INVENTORY_DURABILITY` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_LFG_LIST.md b/wiki-information/events/UPDATE_LFG_LIST.md new file mode 100644 index 00000000..0a7422c4 --- /dev/null +++ b/wiki-information/events/UPDATE_LFG_LIST.md @@ -0,0 +1,13 @@ +## Event: UPDATE_LFG_LIST + +**Title:** UPDATE LFG LIST + +**Content:** +When fired prompts the LFG UI to update the list of LFG players. Signals LFG query results are available. +`UPDATE_LFG_LIST` + +**Payload:** +- `None` + +**Related Information:** +LFGQuery \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MACROS.md b/wiki-information/events/UPDATE_MACROS.md new file mode 100644 index 00000000..6b769be2 --- /dev/null +++ b/wiki-information/events/UPDATE_MACROS.md @@ -0,0 +1,10 @@ +## Event: UPDATE_MACROS + +**Title:** UPDATE MACROS + +**Content:** +Called after applying or cancelling changes to a macro's content, name and/or icon. +`UPDATE_MACROS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MASTER_LOOT_LIST.md b/wiki-information/events/UPDATE_MASTER_LOOT_LIST.md new file mode 100644 index 00000000..eac89d14 --- /dev/null +++ b/wiki-information/events/UPDATE_MASTER_LOOT_LIST.md @@ -0,0 +1,10 @@ +## Event: UPDATE_MASTER_LOOT_LIST + +**Title:** UPDATE MASTER LOOT LIST + +**Content:** +Needs summary. +`UPDATE_MASTER_LOOT_LIST` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MOUSEOVER_UNIT.md b/wiki-information/events/UPDATE_MOUSEOVER_UNIT.md new file mode 100644 index 00000000..387a75b7 --- /dev/null +++ b/wiki-information/events/UPDATE_MOUSEOVER_UNIT.md @@ -0,0 +1,14 @@ +## Event: UPDATE_MOUSEOVER_UNIT + +**Title:** UPDATE MOUSEOVER UNIT + +**Content:** +Fired when the mouseover object needs to be updated. +`UPDATE_MOUSEOVER_UNIT` + +**Payload:** +- `None` + +**Content Details:** +Fired when the target of the "mouseover" UnitId has changed and is a 3d model. (Does not fire when UnitExists("mouseover") becomes nil, or if you mouse over a unitframe.) +This appears to have been changed at some point, it now fires when mousing over unit frames as well. \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md b/wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md new file mode 100644 index 00000000..dd49e1ea --- /dev/null +++ b/wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md @@ -0,0 +1,10 @@ +## Event: UPDATE_MULTI_CAST_ACTIONBAR + +**Title:** UPDATE MULTI CAST ACTIONBAR + +**Content:** +Fired when the shaman totem multicast bar needs an update. +`UPDATE_MULTI_CAST_ACTIONBAR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md b/wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md new file mode 100644 index 00000000..4c6bbf3d --- /dev/null +++ b/wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md @@ -0,0 +1,10 @@ +## Event: UPDATE_OVERRIDE_ACTIONBAR + +**Title:** UPDATE OVERRIDE ACTIONBAR + +**Content:** +Needs summary. +`UPDATE_OVERRIDE_ACTIONBAR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_PENDING_MAIL.md b/wiki-information/events/UPDATE_PENDING_MAIL.md new file mode 100644 index 00000000..b5932631 --- /dev/null +++ b/wiki-information/events/UPDATE_PENDING_MAIL.md @@ -0,0 +1,16 @@ +## Event: UPDATE_PENDING_MAIL + +**Title:** UPDATE PENDING MAIL + +**Content:** +Fires when there is pending mail. +`UPDATE_PENDING_MAIL` + +**Payload:** +- `None` + +**Content Details:** +Fired when the player enters the world and enters/leaves an instance, if there is mail in the player's mailbox. +Fired when new mail is received. +Fired when mailbox window is closed if the number of mail items in the inbox changed (I.E. you deleted mail) +Does not appear to trigger when auction outbid mail is received... may not in other cases as well \ No newline at end of file diff --git a/wiki-information/events/UPDATE_POSSESS_BAR.md b/wiki-information/events/UPDATE_POSSESS_BAR.md new file mode 100644 index 00000000..bb7d728f --- /dev/null +++ b/wiki-information/events/UPDATE_POSSESS_BAR.md @@ -0,0 +1,10 @@ +## Event: UPDATE_POSSESS_BAR + +**Title:** UPDATE POSSESS BAR + +**Content:** +Needs summary. +`UPDATE_POSSESS_BAR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md b/wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md new file mode 100644 index 00000000..f6edb465 --- /dev/null +++ b/wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md @@ -0,0 +1,10 @@ +## Event: UPDATE_SHAPESHIFT_COOLDOWN + +**Title:** UPDATE SHAPESHIFT COOLDOWN + +**Content:** +Needs summary. +`UPDATE_SHAPESHIFT_COOLDOWN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_FORM.md b/wiki-information/events/UPDATE_SHAPESHIFT_FORM.md new file mode 100644 index 00000000..d97f03d2 --- /dev/null +++ b/wiki-information/events/UPDATE_SHAPESHIFT_FORM.md @@ -0,0 +1,10 @@ +## Event: UPDATE_SHAPESHIFT_FORM + +**Title:** UPDATE SHAPESHIFT FORM + +**Content:** +Fired when the current form changes. +`UPDATE_SHAPESHIFT_FORM` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md b/wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md new file mode 100644 index 00000000..5a9050d0 --- /dev/null +++ b/wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md @@ -0,0 +1,10 @@ +## Event: UPDATE_SHAPESHIFT_FORMS + +**Title:** UPDATE SHAPESHIFT FORMS + +**Content:** +Fired when the available set of forms changes (i.e. on skill gain) +`UPDATE_SHAPESHIFT_FORMS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md b/wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md new file mode 100644 index 00000000..d2dbeb76 --- /dev/null +++ b/wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md @@ -0,0 +1,10 @@ +## Event: UPDATE_SHAPESHIFT_USABLE + +**Title:** UPDATE SHAPESHIFT USABLE + +**Content:** +Needs summary. +`UPDATE_SHAPESHIFT_USABLE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_STEALTH.md b/wiki-information/events/UPDATE_STEALTH.md new file mode 100644 index 00000000..cbbf6d66 --- /dev/null +++ b/wiki-information/events/UPDATE_STEALTH.md @@ -0,0 +1,13 @@ +## Event: UPDATE_STEALTH + +**Title:** UPDATE STEALTH + +**Content:** +Fires when a player enters or leaves stealth. +`UPDATE_STEALTH` + +**Payload:** +- `None` + +**Related Information:** +IsStealthed() \ No newline at end of file diff --git a/wiki-information/events/UPDATE_TRADESKILL_RECAST.md b/wiki-information/events/UPDATE_TRADESKILL_RECAST.md new file mode 100644 index 00000000..cdde4d3f --- /dev/null +++ b/wiki-information/events/UPDATE_TRADESKILL_RECAST.md @@ -0,0 +1,10 @@ +## Event: UPDATE_TRADESKILL_RECAST + +**Title:** UPDATE TRADESKILL RECAST + +**Content:** +Needs summary. +`UPDATE_TRADESKILL_RECAST` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_UI_WIDGET.md b/wiki-information/events/UPDATE_UI_WIDGET.md new file mode 100644 index 00000000..c4cb341c --- /dev/null +++ b/wiki-information/events/UPDATE_UI_WIDGET.md @@ -0,0 +1,149 @@ +## Event: UPDATE_UI_WIDGET + +**Title:** UPDATE UI WIDGET + +**Content:** +Returns updated UI widget information. +`UPDATE_UI_WIDGET: widgetInfo` + +**Payload:** +- `widgetInfo` + - *UIWidgetInfo* + - **Field** + - **Type** + - **Description** + - `widgetID` + - *number* + - UiWidget.db2 + - `widgetSetID` + - *number* + - UiWidgetSetID + - `widgetType` + - *Enum.UIWidgetVisualizationType* + - `unitToken` + - *string?* + - UnitId; Added in 9.0.1 + - *Enum.UIWidgetVisualizationType* + - **Value** + - **Key** + - **Data Function** + - **Description** + - 0 + - IconAndText + - C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo + - 1 + - CaptureBar + - C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo + - 2 + - StatusBar + - C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo + - 3 + - DoubleStatusBar + - C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo + - 4 + - IconTextAndBackground + - C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo + - 5 + - DoubleIconAndText + - C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo + - 6 + - StackedResourceTracker + - C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo + - 7 + - IconTextAndCurrencies + - C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo + - 8 + - TextWithState + - C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo + - 9 + - HorizontalCurrencies + - C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo + - 10 + - BulletTextList + - C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo + - 11 + - ScenarioHeaderCurrenciesAndBackground + - C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo + - 12 + - TextureAndText + - C_UIWidgetManager.GetTextureAndTextVisualizationInfo + - Added in 8.2.0 + - 13 + - SpellDisplay + - C_UIWidgetManager.GetSpellDisplayVisualizationInfo + - Added in 8.1.0 + - 14 + - DoubleStateIconRow + - C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo + - Added in 8.1.5 + - 15 + - TextureAndTextRow + - C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo + - Added in 8.2.0 + - 16 + - ZoneControl + - C_UIWidgetManager.GetZoneControlVisualizationInfo + - Added in 8.2.0 + - 17 + - CaptureZone + - C_UIWidgetManager.GetCaptureZoneVisualizationInfo + - Added in 8.2.5 + - 18 + - TextureWithAnimation + - C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo + - Added in 9.0.1 + - 19 + - DiscreteProgressSteps + - C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo + - Added in 9.0.1 + - 20 + - ScenarioHeaderTimer + - C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo + - Added in 9.0.1 + - 21 + - TextColumnRow + - C_UIWidgetManager.GetTextColumnRowVisualizationInfo + - Added in 9.1.0 + - 22 + - Spacer + - C_UIWidgetManager.GetSpacerVisualizationInfo + - Added in 9.1.0 + - 23 + - UnitPowerBar + - C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo + - Added in 9.2.0 + - 24 + - FillUpFrames + - C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo + - Added in 10.0.0 + - 25 + - TextWithSubtext + - C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo + - Added in 10.0.2 + - 26 + - WorldLootObject + - Added in 10.1.0 + - 27 + - ItemDisplay + - C_UIWidgetManager.GetItemDisplayVisualizationInfo + - Added in 10.1.0 + +**Usage:** +Prints UI widget information when UPDATE_UI_WIDGET fires. +```lua +local function OnEvent(self, event, w) + local typeInfo = UIWidgetManager:GetWidgetTypeInfo(w.widgetType) + local visInfo = typeInfo.visInfoDataFunction(w.widgetID) + print(w.widgetSetID, w.widgetType, w.widgetID, visInfo) +end + +local f = CreateFrame("Frame") +f:RegisterEvent("UPDATE_UI_WIDGET") +f:SetScript("OnEvent", OnEvent) +``` +You can query the information from the specific data function yourself, or use visInfo which does it programmatically. +E.g. for the Arathi Basin PvP objective: +Widget Set ID: 1 - Top center part of the screen +Widget Type: 3 - Enum.UIWidgetVisualizationType.DoubleStatusBar +Widget ID: 1671 - UiWidget.VisID -> UiWidgetVisualization.ID 1200 "PvP - Domination - Double Status Bar" +/dump C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo(1671) \ No newline at end of file diff --git a/wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md b/wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md new file mode 100644 index 00000000..6fd694a5 --- /dev/null +++ b/wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md @@ -0,0 +1,10 @@ +## Event: UPDATE_VEHICLE_ACTIONBAR + +**Title:** UPDATE VEHICLE ACTIONBAR + +**Content:** +Needs summary. +`UPDATE_VEHICLE_ACTIONBAR` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_WEB_TICKET.md b/wiki-information/events/UPDATE_WEB_TICKET.md new file mode 100644 index 00000000..ffc5cf71 --- /dev/null +++ b/wiki-information/events/UPDATE_WEB_TICKET.md @@ -0,0 +1,21 @@ +## Event: UPDATE_WEB_TICKET + +**Title:** UPDATE WEB TICKET + +**Content:** +Needs summary. +`UPDATE_WEB_TICKET: hasTicket, numTickets, ticketStatus, caseIndex, waitTimeMinutes, waitMessage` + +**Payload:** +- `hasTicket` + - *boolean* +- `numTickets` + - *number?* +- `ticketStatus` + - *number?* +- `caseIndex` + - *number?* +- `waitTimeMinutes` + - *number?* +- `waitMessage` + - *string?* \ No newline at end of file diff --git a/wiki-information/events/USE_BIND_CONFIRM.md b/wiki-information/events/USE_BIND_CONFIRM.md new file mode 100644 index 00000000..e41b3a14 --- /dev/null +++ b/wiki-information/events/USE_BIND_CONFIRM.md @@ -0,0 +1,10 @@ +## Event: USE_BIND_CONFIRM + +**Title:** USE BIND CONFIRM + +**Content:** +Needs summary. +`USE_BIND_CONFIRM` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/USE_GLYPH.md b/wiki-information/events/USE_GLYPH.md new file mode 100644 index 00000000..1bb9343b --- /dev/null +++ b/wiki-information/events/USE_GLYPH.md @@ -0,0 +1,11 @@ +## Event: USE_GLYPH + +**Title:** USE GLYPH + +**Content:** +Fires when the player attempts to apply a new glyph to an ability in the spell book. +`USE_GLYPH: spellID` + +**Payload:** +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/USE_NO_REFUND_CONFIRM.md b/wiki-information/events/USE_NO_REFUND_CONFIRM.md new file mode 100644 index 00000000..e1d29fb2 --- /dev/null +++ b/wiki-information/events/USE_NO_REFUND_CONFIRM.md @@ -0,0 +1,10 @@ +## Event: USE_NO_REFUND_CONFIRM + +**Title:** USE NO REFUND CONFIRM + +**Content:** +Needs summary. +`USE_NO_REFUND_CONFIRM` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VARIABLES_LOADED.md b/wiki-information/events/VARIABLES_LOADED.md new file mode 100644 index 00000000..0bd94568 --- /dev/null +++ b/wiki-information/events/VARIABLES_LOADED.md @@ -0,0 +1,18 @@ +## Event: VARIABLES_LOADED + +**Title:** VARIABLES LOADED + +**Content:** +Fired in response to the CVars, Keybindings and other associated "Blizzard" variables being loaded. +`VARIABLES_LOADED` + +**Payload:** +- `None` + +**Content Details:** +Since key bindings and macros in particular may be stored on the server they event may be delayed a bit beyond the original loading sequence. +Previously (prior to 3.0.1) this event was part of the loading sequence. Although it still occurs within the same general timeframe as the other events, it no longer has a guaranteed order that can be relied on. This may be problematic to addons that relied on the order of VARIABLES_LOADED, specifically that it would fire before PLAYER_ENTERING_WORLD. +Addons should not use this event to check if their addon's saved variables have loaded. They can use ADDON_LOADED (testing for arg1 being the name of the addon) or another appropriate event to initialize, ensuring that the addon works when loaded on demand. + +**Related Information:** +AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_ANGLE_SHOW.md b/wiki-information/events/VEHICLE_ANGLE_SHOW.md new file mode 100644 index 00000000..dc878dac --- /dev/null +++ b/wiki-information/events/VEHICLE_ANGLE_SHOW.md @@ -0,0 +1,11 @@ +## Event: VEHICLE_ANGLE_SHOW + +**Title:** VEHICLE ANGLE SHOW + +**Content:** +Needs summary. +`VEHICLE_ANGLE_SHOW: shouldShow` + +**Payload:** +- `shouldShow` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_ANGLE_UPDATE.md b/wiki-information/events/VEHICLE_ANGLE_UPDATE.md new file mode 100644 index 00000000..03a4f79b --- /dev/null +++ b/wiki-information/events/VEHICLE_ANGLE_UPDATE.md @@ -0,0 +1,13 @@ +## Event: VEHICLE_ANGLE_UPDATE + +**Title:** VEHICLE ANGLE UPDATE + +**Content:** +Needs summary. +`VEHICLE_ANGLE_UPDATE: normalizedPitch, radians` + +**Payload:** +- `normalizedPitch` + - *number* +- `radians` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md b/wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md new file mode 100644 index 00000000..6f874099 --- /dev/null +++ b/wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md @@ -0,0 +1,10 @@ +## Event: VEHICLE_PASSENGERS_CHANGED + +**Title:** VEHICLE PASSENGERS CHANGED + +**Content:** +Needs summary. +`VEHICLE_PASSENGERS_CHANGED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_POWER_SHOW.md b/wiki-information/events/VEHICLE_POWER_SHOW.md new file mode 100644 index 00000000..f75e06c4 --- /dev/null +++ b/wiki-information/events/VEHICLE_POWER_SHOW.md @@ -0,0 +1,11 @@ +## Event: VEHICLE_POWER_SHOW + +**Title:** VEHICLE POWER SHOW + +**Content:** +Needs summary. +`VEHICLE_POWER_SHOW: shouldShow` + +**Payload:** +- `shouldShow` + - *number?* \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_UPDATE.md b/wiki-information/events/VEHICLE_UPDATE.md new file mode 100644 index 00000000..5d2a5981 --- /dev/null +++ b/wiki-information/events/VEHICLE_UPDATE.md @@ -0,0 +1,10 @@ +## Event: VEHICLE_UPDATE + +**Title:** VEHICLE UPDATE + +**Content:** +Needs summary. +`VEHICLE_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md b/wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md new file mode 100644 index 00000000..590aca98 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED + +**Title:** VOICE CHAT ACTIVE INPUT DEVICE UPDATED + +**Content:** +Needs summary. +`VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md b/wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md new file mode 100644 index 00000000..20fd096b --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED + +**Title:** VOICE CHAT ACTIVE OUTPUT DEVICE UPDATED + +**Content:** +Needs summary. +`VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md new file mode 100644 index 00000000..834ac4a8 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_AUDIO_CAPTURE_ENERGY + +**Title:** VOICE CHAT AUDIO CAPTURE ENERGY + +**Content:** +Needs summary. +`VOICE_CHAT_AUDIO_CAPTURE_ENERGY: isSpeaking, energy` + +**Payload:** +- `isSpeaking` + - *boolean* +- `energy` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md new file mode 100644 index 00000000..7b4aed36 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_AUDIO_CAPTURE_STARTED + +**Title:** VOICE CHAT AUDIO CAPTURE STARTED + +**Content:** +Needs summary. +`VOICE_CHAT_AUDIO_CAPTURE_STARTED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md new file mode 100644 index 00000000..e9861cf2 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_AUDIO_CAPTURE_STOPPED + +**Title:** VOICE CHAT AUDIO CAPTURE STOPPED + +**Content:** +Needs summary. +`VOICE_CHAT_AUDIO_CAPTURE_STOPPED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md new file mode 100644 index 00000000..eb455997 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md @@ -0,0 +1,11 @@ +## Event: VOICE_CHAT_CHANNEL_ACTIVATED + +**Title:** VOICE CHAT CHANNEL ACTIVATED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_ACTIVATED: channelID` + +**Payload:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md new file mode 100644 index 00000000..2ef1249a --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md @@ -0,0 +1,11 @@ +## Event: VOICE_CHAT_CHANNEL_DEACTIVATED + +**Title:** VOICE CHAT CHANNEL DEACTIVATED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_DEACTIVATED: channelID` + +**Payload:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md new file mode 100644 index 00000000..0690b7dc --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED + +**Title:** VOICE CHAT CHANNEL DISPLAY NAME CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED: channelID, channelDisplayName` + +**Payload:** +- `channelID` + - *number* +- `channelDisplayName` + - *string* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md new file mode 100644 index 00000000..925230d5 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md @@ -0,0 +1,91 @@ +## Event: VOICE_CHAT_CHANNEL_JOINED + +**Title:** VOICE CHAT CHANNEL JOINED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_JOINED: status, channelID, channelType, clubId, streamId` + +**Payload:** +- `status` + - *number* - Enum.VoiceChatStatusCode +- `channelID` + - *number* +- `channelType` + - *number* - Enum.ChatChannelType +- `clubId` + - *string?* +- `streamId` + - *string?* +- Enum.VoiceChatStatusCode + - Value + - Field + - Description + - 0 + - Success + - 1 + - OperationPending + - 2 + - TooManyRequests + - 3 + - LoginProhibited + - 4 + - ClientNotInitialized + - 5 + - ClientNotLoggedIn + - 6 + - ClientAlreadyLoggedIn + - 7 + - ChannelNameTooShort + - 8 + - ChannelNameTooLong + - 9 + - ChannelAlreadyExists + - 10 + - AlreadyInChannel + - 11 + - TargetNotFound + - 12 + - Failure + - 13 + - ServiceLost + - 14 + - UnableToLaunchProxy + - 15 + - ProxyConnectionTimeOut + - 16 + - ProxyConnectionUnableToConnect + - 17 + - ProxyConnectionUnexpectedDisconnect + - 18 + - Disabled + - 19 + - UnsupportedChatChannelType + - 20 + - InvalidCommunityStream + - 21 + - PlayerSilenced + - 22 + - PlayerVoiceChatParentalDisabled + - 23 + - InvalidInputDevice + - Added in 8.2.0 + - 24 + - InvalidOutputDevice + - Added in 8.2.0 +- Enum.ChatChannelType + - Value + - Field + - Description + - 0 + - None + - 1 + - Custom + - 2 + - Private_Party + - Documented as "PrivateParty" + - 3 + - Public_Party + - Documented as "PublicParty" + - 4 + - Communities \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md new file mode 100644 index 00000000..70bfb515 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md @@ -0,0 +1,15 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED + +**Title:** VOICE CHAT CHANNEL MEMBER ACTIVE STATE CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED: memberID, channelID, isActive` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `isActive` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md new file mode 100644 index 00000000..6d7d8d85 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_ADDED + +**Title:** VOICE CHAT CHANNEL MEMBER ADDED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_ADDED: memberID, channelID` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md new file mode 100644 index 00000000..38a71142 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md @@ -0,0 +1,15 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED + +**Title:** VOICE CHAT CHANNEL MEMBER ENERGY CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED: memberID, channelID, speakingEnergy` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `speakingEnergy` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md new file mode 100644 index 00000000..086cc83e --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED + +**Title:** VOICE CHAT CHANNEL MEMBER GUID UPDATED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED: memberID, channelID` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md new file mode 100644 index 00000000..4c8b0f34 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md @@ -0,0 +1,15 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED + +**Title:** VOICE CHAT CHANNEL MEMBER MUTE FOR ALL CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED: memberID, channelID, isMutedForAll` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `isMutedForAll` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md new file mode 100644 index 00000000..4d75fad5 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md @@ -0,0 +1,15 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED + +**Title:** VOICE CHAT CHANNEL MEMBER MUTE FOR ME CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED: memberID, channelID, isMutedForMe` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `isMutedForMe` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md new file mode 100644 index 00000000..23b4e5b3 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_REMOVED + +**Title:** VOICE CHAT CHANNEL MEMBER REMOVED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_REMOVED: memberID, channelID` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md new file mode 100644 index 00000000..057b5d0f --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md @@ -0,0 +1,15 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED + +**Title:** VOICE CHAT CHANNEL MEMBER SILENCED CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED: memberID, channelID, isSilenced` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `isSilenced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md new file mode 100644 index 00000000..cc85e58f --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md @@ -0,0 +1,15 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED + +**Title:** VOICE CHAT CHANNEL MEMBER SPEAKING STATE CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED: memberID, channelID, isSpeaking` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `isSpeaking` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md new file mode 100644 index 00000000..ff94eeaf --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md @@ -0,0 +1,17 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE + +**Title:** VOICE CHAT CHANNEL MEMBER STT MESSAGE + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE: memberID, channelID, message, language` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `message` + - *string* +- `language` + - *string* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md new file mode 100644 index 00000000..d32afc96 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md @@ -0,0 +1,15 @@ +## Event: VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED + +**Title:** VOICE CHAT CHANNEL MEMBER VOLUME CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED: memberID, channelID, volume` + +**Payload:** +- `memberID` + - *number* +- `channelID` + - *number* +- `volume` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md new file mode 100644 index 00000000..86c83abc --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED + +**Title:** VOICE CHAT CHANNEL MUTE STATE CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED: channelID, isMuted` + +**Payload:** +- `channelID` + - *number* +- `isMuted` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md new file mode 100644 index 00000000..72d04158 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_PTT_CHANGED + +**Title:** VOICE CHAT CHANNEL PTT CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_PTT_CHANGED: channelID, pushToTalkSetting` + +**Payload:** +- `channelID` + - *number* +- `pushToTalkSetting` + - *string* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md new file mode 100644 index 00000000..dc8bf475 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md @@ -0,0 +1,11 @@ +## Event: VOICE_CHAT_CHANNEL_REMOVED + +**Title:** VOICE CHAT CHANNEL REMOVED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_REMOVED: channelID` + +**Payload:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md new file mode 100644 index 00000000..40230d40 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED + +**Title:** VOICE CHAT CHANNEL TRANSCRIBING CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED: channelID, isTranscribing` + +**Payload:** +- `channelID` + - *number* +- `isTranscribing` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md new file mode 100644 index 00000000..05bfd24e --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED + +**Title:** VOICE CHAT CHANNEL TRANSMIT CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED: channelID, isTransmitting` + +**Payload:** +- `channelID` + - *number* +- `isTransmitting` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md new file mode 100644 index 00000000..4f8b1311 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md @@ -0,0 +1,13 @@ +## Event: VOICE_CHAT_CHANNEL_VOLUME_CHANGED + +**Title:** VOICE CHAT CHANNEL VOLUME CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_CHANNEL_VOLUME_CHANGED: channelID, volume` + +**Payload:** +- `channelID` + - *number* +- `volume` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md b/wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md new file mode 100644 index 00000000..41d7c266 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md @@ -0,0 +1,19 @@ +## Event: VOICE_CHAT_COMMUNICATION_MODE_CHANGED + +**Title:** VOICE CHAT COMMUNICATION MODE CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_COMMUNICATION_MODE_CHANGED: communicationMode` + +**Payload:** +- `communicationMode` + - *number* - Enum.CommunicationMode + - Enum.CommunicationMode + - Value + - Field + - Description + - 0 + - PushToTalk + - 1 + - OpenMic \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md b/wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md new file mode 100644 index 00000000..d8283cfe --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_CONNECTION_SUCCESS + +**Title:** VOICE CHAT CONNECTION SUCCESS + +**Content:** +Needs summary. +`VOICE_CHAT_CONNECTION_SUCCESS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md b/wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md new file mode 100644 index 00000000..fe687c02 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md @@ -0,0 +1,11 @@ +## Event: VOICE_CHAT_DEAFENED_CHANGED + +**Title:** VOICE CHAT DEAFENED CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_DEAFENED_CHANGED: isDeafened` + +**Payload:** +- `isDeafened` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_ERROR.md b/wiki-information/events/VOICE_CHAT_ERROR.md new file mode 100644 index 00000000..b38bca3f --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_ERROR.md @@ -0,0 +1,44 @@ +## Event: VOICE_CHAT_ERROR + +**Title:** VOICE CHAT ERROR + +**Content:** +Needs summary. +`VOICE_CHAT_ERROR: platformCode, statusCode` + +**Payload:** +- `platformCode` + - *number* +- `statusCode` + - *number* - Enum.VoiceChatStatusCode + - Enum.VoiceChatStatusCode + - Value + - Field + - Description + - 0 - Success + - 1 - OperationPending + - 2 - TooManyRequests + - 3 - LoginProhibited + - 4 - ClientNotInitialized + - 5 - ClientNotLoggedIn + - 6 - ClientAlreadyLoggedIn + - 7 - ChannelNameTooShort + - 8 - ChannelNameTooLong + - 9 - ChannelAlreadyExists + - 10 - AlreadyInChannel + - 11 - TargetNotFound + - 12 - Failure + - 13 - ServiceLost + - 14 - UnableToLaunchProxy + - 15 - ProxyConnectionTimeOut + - 16 - ProxyConnectionUnableToConnect + - 17 - ProxyConnectionUnexpectedDisconnect + - 18 - Disabled + - 19 - UnsupportedChatChannelType + - 20 - InvalidCommunityStream + - 21 - PlayerSilenced + - 22 - PlayerVoiceChatParentalDisabled + - 23 - InvalidInputDevice + - Added in 8.2.0 + - 24 - InvalidOutputDevice + - Added in 8.2.0 \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md b/wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md new file mode 100644 index 00000000..def39441 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_INPUT_DEVICES_UPDATED + +**Title:** VOICE CHAT INPUT DEVICES UPDATED + +**Content:** +Needs summary. +`VOICE_CHAT_INPUT_DEVICES_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_LOGIN.md b/wiki-information/events/VOICE_CHAT_LOGIN.md new file mode 100644 index 00000000..6713e58a --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_LOGIN.md @@ -0,0 +1,42 @@ +## Event: VOICE_CHAT_LOGIN + +**Title:** VOICE CHAT LOGIN + +**Content:** +Needs summary. +`VOICE_CHAT_LOGIN: status` + +**Payload:** +- `status` + - *number* - Enum.VoiceChatStatusCode + - Enum.VoiceChatStatusCode + - Value + - Field + - Description + - 0 - Success + - 1 - OperationPending + - 2 - TooManyRequests + - 3 - LoginProhibited + - 4 - ClientNotInitialized + - 5 - ClientNotLoggedIn + - 6 - ClientAlreadyLoggedIn + - 7 - ChannelNameTooShort + - 8 - ChannelNameTooLong + - 9 - ChannelAlreadyExists + - 10 - AlreadyInChannel + - 11 - TargetNotFound + - 12 - Failure + - 13 - ServiceLost + - 14 - UnableToLaunchProxy + - 15 - ProxyConnectionTimeOut + - 16 - ProxyConnectionUnableToConnect + - 17 - ProxyConnectionUnexpectedDisconnect + - 18 - Disabled + - 19 - UnsupportedChatChannelType + - 20 - InvalidCommunityStream + - 21 - PlayerSilenced + - 22 - PlayerVoiceChatParentalDisabled + - 23 - InvalidInputDevice + - Added in 8.2.0 + - 24 - InvalidOutputDevice + - Added in 8.2.0 \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_LOGOUT.md b/wiki-information/events/VOICE_CHAT_LOGOUT.md new file mode 100644 index 00000000..9862c409 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_LOGOUT.md @@ -0,0 +1,42 @@ +## Event: VOICE_CHAT_LOGOUT + +**Title:** VOICE CHAT LOGOUT + +**Content:** +Needs summary. +`VOICE_CHAT_LOGOUT: status` + +**Payload:** +- `status` + - *number* - Enum.VoiceChatStatusCode + - Enum.VoiceChatStatusCode + - Value + - Field + - Description + - 0 - Success + - 1 - OperationPending + - 2 - TooManyRequests + - 3 - LoginProhibited + - 4 - ClientNotInitialized + - 5 - ClientNotLoggedIn + - 6 - ClientAlreadyLoggedIn + - 7 - ChannelNameTooShort + - 8 - ChannelNameTooLong + - 9 - ChannelAlreadyExists + - 10 - AlreadyInChannel + - 11 - TargetNotFound + - 12 - Failure + - 13 - ServiceLost + - 14 - UnableToLaunchProxy + - 15 - ProxyConnectionTimeOut + - 16 - ProxyConnectionUnableToConnect + - 17 - ProxyConnectionUnexpectedDisconnect + - 18 - Disabled + - 19 - UnsupportedChatChannelType + - 20 - InvalidCommunityStream + - 21 - PlayerSilenced + - 22 - PlayerVoiceChatParentalDisabled + - 23 - InvalidInputDevice + - Added in 8.2.0 + - 24 - InvalidOutputDevice + - Added in 8.2.0 \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md b/wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md new file mode 100644 index 00000000..824d9394 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md @@ -0,0 +1,11 @@ +## Event: VOICE_CHAT_MUTED_CHANGED + +**Title:** VOICE CHAT MUTED CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_MUTED_CHANGED: isMuted` + +**Payload:** +- `isMuted` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md b/wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md new file mode 100644 index 00000000..6f674794 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_OUTPUT_DEVICES_UPDATED + +**Title:** VOICE CHAT OUTPUT DEVICES UPDATED + +**Content:** +Needs summary. +`VOICE_CHAT_OUTPUT_DEVICES_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md b/wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md new file mode 100644 index 00000000..cc5c10de --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md @@ -0,0 +1,33 @@ +## Event: VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE + +**Title:** VOICE CHAT PENDING CHANNEL JOIN STATE + +**Content:** +Needs summary. +`VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE: channelType, clubId, streamId, pendingJoin` + +**Payload:** +- `channelType` + - *number* - Enum.ChatChannelType +- `clubId` + - *string?* +- `streamId` + - *string?* +- `pendingJoin` + - *boolean* +- Enum.ChatChannelType + - Value + - Field + - Description + - 0 + - None + - 1 + - Custom + - 2 + - Private_Party + - Documented as "PrivateParty" + - 3 + - Public_Party + - Documented as "PublicParty" + - 4 + - Communities \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md new file mode 100644 index 00000000..55e8dfad --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md @@ -0,0 +1,11 @@ +## Event: VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED + +**Title:** VOICE CHAT PTT BUTTON PRESSED STATE CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED: isPressed` + +**Payload:** +- `isPressed` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md b/wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md new file mode 100644 index 00000000..2d6633fa --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md @@ -0,0 +1,11 @@ +## Event: VOICE_CHAT_SILENCED_CHANGED + +**Title:** VOICE CHAT SILENCED CHANGED + +**Content:** +Needs summary. +`VOICE_CHAT_SILENCED_CHANGED: isSilenced` + +**Payload:** +- `isSilenced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md b/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md new file mode 100644 index 00000000..361798e0 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED + +**Title:** VOICE CHAT SPEAK FOR ME ACTIVE STATUS UPDATED + +**Content:** +Needs summary. +`VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md b/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md new file mode 100644 index 00000000..83d52dd8 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED + +**Title:** VOICE CHAT SPEAK FOR ME FEATURE STATUS UPDATED + +**Content:** +Needs summary. +`VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md new file mode 100644 index 00000000..329abc8f --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md @@ -0,0 +1,63 @@ +## Event: VOICE_CHAT_TTS_PLAYBACK_FAILED + +**Title:** VOICE CHAT TTS PLAYBACK FAILED + +**Content:** +Needs summary. +`VOICE_CHAT_TTS_PLAYBACK_FAILED: status, utteranceID, destination` + +**Payload:** +- `status` + - *Enum.VoiceTtsStatusCode* + - *Value* + - *Field* + - *Description* + - 0 + - Success + - 1 + - InvalidEngineType + - 2 + - EngineAllocationFailed + - 3 + - NotSupported + - 4 + - MaxCharactersExceeded + - 5 + - UtteranceBelowMinimumDuration + - 6 + - InputTextEnqueued + - 7 + - SdkNotInitialized + - 8 + - DestinationQueueFull + - 9 + - EnqueueNotNecessary + - 10 + - UtteranceNotFound + - 11 + - ManagerNotFound + - 12 + - InvalidArgument + - 13 + - InternalError +- `utteranceID` + - *number* +- `destination` + - *Enum.VoiceTtsDestination* + - *Value* + - *Field* + - *Description* + - 0 + - RemoteTransmission + - 1 + - LocalPlayback + - 2 + - RemoteTransmissionWithLocalPlayback + - 3 + - QueuedRemoteTransmission + - 4 + - QueuedLocalPlayback + - 5 + - QueuedRemoteTransmissionWithLocalPlayback + - 6 + - ScreenReader \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md new file mode 100644 index 00000000..864267ee --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md @@ -0,0 +1,24 @@ +## Event: VOICE_CHAT_TTS_PLAYBACK_FINISHED + +**Title:** VOICE CHAT TTS PLAYBACK FINISHED + +**Content:** +Needs summary. +`VOICE_CHAT_TTS_PLAYBACK_FINISHED: numConsumers, utteranceID, destination` + +**Payload:** +- `numConsumers` + - *number* +- `utteranceID` + - *number* +- `destination` + - *Enum.VoiceTtsDestination* + - *Value* + - *Field* - *Description* + - 0 - RemoteTransmission + - 1 - LocalPlayback + - 2 - RemoteTransmissionWithLocalPlayback + - 3 - QueuedRemoteTransmission + - 4 - QueuedLocalPlayback + - 5 - QueuedRemoteTransmissionWithLocalPlayback + - 6 - ScreenReader \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md new file mode 100644 index 00000000..e6af59d8 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md @@ -0,0 +1,26 @@ +## Event: VOICE_CHAT_TTS_PLAYBACK_STARTED + +**Title:** VOICE CHAT TTS PLAYBACK STARTED + +**Content:** +Needs summary. +`VOICE_CHAT_TTS_PLAYBACK_STARTED: numConsumers, utteranceID, durationMS, destination` + +**Payload:** +- `numConsumers` + - *number* +- `utteranceID` + - *number* +- `durationMS` + - *number* +- `destination` + - *Enum.VoiceTtsDestination* + - *Value* + - *Field* - Description + - 0 - RemoteTransmission + - 1 - LocalPlayback + - 2 - RemoteTransmissionWithLocalPlayback + - 3 - QueuedRemoteTransmission + - 4 - QueuedLocalPlayback + - 5 - QueuedRemoteTransmissionWithLocalPlayback + - 6 - ScreenReader \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md b/wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md new file mode 100644 index 00000000..dd89c73f --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md @@ -0,0 +1,30 @@ +## Event: VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE + +**Title:** VOICE CHAT TTS SPEAK TEXT UPDATE + +**Content:** +Needs summary. +`VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE: status, utteranceID` + +**Payload:** +- `status` + - *Enum.VoiceTtsStatusCode* + - *Value* + - *Field* + - *Description* + - 0 - Success + - 1 - InvalidEngineType + - 2 - EngineAllocationFailed + - 3 - NotSupported + - 4 - MaxCharactersExceeded + - 5 - UtteranceBelowMinimumDuration + - 6 - InputTextEnqueued + - 7 - SdkNotInitialized + - 8 - DestinationQueueFull + - 9 - EnqueueNotNecessary + - 10 - UtteranceNotFound + - 11 - ManagerNotFound + - 12 - InvalidArgument + - 13 - InternalError +- `utteranceID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md b/wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md new file mode 100644 index 00000000..4e312580 --- /dev/null +++ b/wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md @@ -0,0 +1,10 @@ +## Event: VOICE_CHAT_TTS_VOICES_UPDATE + +**Title:** VOICE CHAT TTS VOICES UPDATE + +**Content:** +Needs summary. +`VOICE_CHAT_TTS_VOICES_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_DEPOSIT_WARNING.md b/wiki-information/events/VOID_DEPOSIT_WARNING.md new file mode 100644 index 00000000..6c2f3509 --- /dev/null +++ b/wiki-information/events/VOID_DEPOSIT_WARNING.md @@ -0,0 +1,13 @@ +## Event: VOID_DEPOSIT_WARNING + +**Title:** VOID DEPOSIT WARNING + +**Content:** +Fired when attempting to deposit an item with enchants/gems/reforges/etc into the Void Storage. +`VOID_DEPOSIT_WARNING: slot, link` + +**Payload:** +- `slot` + - *number* - Slot Index for `GetVoidTransferDepositInfo` +- `link` + - *string* - Item Link \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_CLOSE.md b/wiki-information/events/VOID_STORAGE_CLOSE.md new file mode 100644 index 00000000..c1c93cc0 --- /dev/null +++ b/wiki-information/events/VOID_STORAGE_CLOSE.md @@ -0,0 +1,10 @@ +## Event: VOID_STORAGE_CLOSE + +**Title:** VOID STORAGE CLOSE + +**Content:** +Needs summary. +`VOID_STORAGE_CLOSE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md b/wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md new file mode 100644 index 00000000..ac0c67dc --- /dev/null +++ b/wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md @@ -0,0 +1,10 @@ +## Event: VOID_STORAGE_CONTENTS_UPDATE + +**Title:** VOID STORAGE CONTENTS UPDATE + +**Content:** +Fired when one the Void Storage slots is changed. +`VOID_STORAGE_CONTENTS_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md b/wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md new file mode 100644 index 00000000..7613484e --- /dev/null +++ b/wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md @@ -0,0 +1,11 @@ +## Event: VOID_STORAGE_DEPOSIT_UPDATE + +**Title:** VOID STORAGE DEPOSIT UPDATE + +**Content:** +Fired when one the Void Transfer deposit slots is changed. +`VOID_STORAGE_DEPOSIT_UPDATE: slot` + +**Payload:** +- `slot` + - *number* - Slot Index for GetVoidTransferDepositInfo \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_OPEN.md b/wiki-information/events/VOID_STORAGE_OPEN.md new file mode 100644 index 00000000..4905cdc6 --- /dev/null +++ b/wiki-information/events/VOID_STORAGE_OPEN.md @@ -0,0 +1,10 @@ +## Event: VOID_STORAGE_OPEN + +**Title:** VOID STORAGE OPEN + +**Content:** +Needs summary. +`VOID_STORAGE_OPEN` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_UPDATE.md b/wiki-information/events/VOID_STORAGE_UPDATE.md new file mode 100644 index 00000000..89b67559 --- /dev/null +++ b/wiki-information/events/VOID_STORAGE_UPDATE.md @@ -0,0 +1,10 @@ +## Event: VOID_STORAGE_UPDATE + +**Title:** VOID STORAGE UPDATE + +**Content:** +Fired when the Void Storage "tutorial" is progressed, or when the Void Storage hasn't been activated yet. +`VOID_STORAGE_UPDATE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_TRANSFER_DONE.md b/wiki-information/events/VOID_TRANSFER_DONE.md new file mode 100644 index 00000000..d22a4563 --- /dev/null +++ b/wiki-information/events/VOID_TRANSFER_DONE.md @@ -0,0 +1,10 @@ +## Event: VOID_TRANSFER_DONE + +**Title:** VOID TRANSFER DONE + +**Content:** +Fired when an item has been successfully deposited or withdrawn from the Void Storage. +`VOID_TRANSFER_DONE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_TRANSFER_SUCCESS.md b/wiki-information/events/VOID_TRANSFER_SUCCESS.md new file mode 100644 index 00000000..d660aa7a --- /dev/null +++ b/wiki-information/events/VOID_TRANSFER_SUCCESS.md @@ -0,0 +1,10 @@ +## Event: VOID_TRANSFER_SUCCESS + +**Title:** VOID TRANSFER SUCCESS + +**Content:** +Needs summary. +`VOID_TRANSFER_SUCCESS` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/WARFRONT_COMPLETED.md b/wiki-information/events/WARFRONT_COMPLETED.md new file mode 100644 index 00000000..2c54db9f --- /dev/null +++ b/wiki-information/events/WARFRONT_COMPLETED.md @@ -0,0 +1,13 @@ +## Event: WARFRONT_COMPLETED + +**Title:** WARFRONT COMPLETED + +**Content:** +Needs summary. +`WARFRONT_COMPLETED: mapID, winner` + +**Payload:** +- `mapID` + - *number* +- `winner` + - *number* \ No newline at end of file diff --git a/wiki-information/events/WARGAME_REQUESTED.md b/wiki-information/events/WARGAME_REQUESTED.md new file mode 100644 index 00000000..99f969d5 --- /dev/null +++ b/wiki-information/events/WARGAME_REQUESTED.md @@ -0,0 +1,17 @@ +## Event: WARGAME_REQUESTED + +**Title:** WARGAME REQUESTED + +**Content:** +Needs summary. +`WARGAME_REQUESTED: opposingPartyMemberName, battlegroundName, timeoutSeconds, tournamentRules` + +**Payload:** +- `opposingPartyMemberName` + - *string* +- `battlegroundName` + - *string* +- `timeoutSeconds` + - *number* +- `tournamentRules` + - *boolean* \ No newline at end of file diff --git a/wiki-information/events/WEAR_EQUIPMENT_SET.md b/wiki-information/events/WEAR_EQUIPMENT_SET.md new file mode 100644 index 00000000..6e2da1b8 --- /dev/null +++ b/wiki-information/events/WEAR_EQUIPMENT_SET.md @@ -0,0 +1,11 @@ +## Event: WEAR_EQUIPMENT_SET + +**Title:** WEAR EQUIPMENT SET + +**Content:** +Needs summary. +`WEAR_EQUIPMENT_SET: setID` + +**Payload:** +- `setID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/WHO_LIST_UPDATE.md b/wiki-information/events/WHO_LIST_UPDATE.md new file mode 100644 index 00000000..5ef011df --- /dev/null +++ b/wiki-information/events/WHO_LIST_UPDATE.md @@ -0,0 +1,13 @@ +## Event: WHO_LIST_UPDATE + +**Title:** WHO LIST UPDATE + +**Content:** +Fired when the client receives the result of a C_FriendList.SendWho request from the server. +`WHO_LIST_UPDATE` + +**Payload:** +- `None` + +**Content Details:** +Use C_FriendList.SetWhoToUi to manipulate this functionality. This event is only triggered if the Who panel was open at the time the Who data was received (this includes the case where the Blizzard UI opens it automatically because the return data was too big to display in the chat frame). \ No newline at end of file diff --git a/wiki-information/events/WORLD_PVP_QUEUE.md b/wiki-information/events/WORLD_PVP_QUEUE.md new file mode 100644 index 00000000..bebaaca4 --- /dev/null +++ b/wiki-information/events/WORLD_PVP_QUEUE.md @@ -0,0 +1,10 @@ +## Event: WORLD_PVP_QUEUE + +**Title:** WORLD PVP QUEUE + +**Content:** +Needs summary. +`WORLD_PVP_QUEUE` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/WORLD_STATE_TIMER_START.md b/wiki-information/events/WORLD_STATE_TIMER_START.md new file mode 100644 index 00000000..1f5702e4 --- /dev/null +++ b/wiki-information/events/WORLD_STATE_TIMER_START.md @@ -0,0 +1,11 @@ +## Event: WORLD_STATE_TIMER_START + +**Title:** WORLD STATE TIMER START + +**Content:** +Needs summary. +`WORLD_STATE_TIMER_START: timerID` + +**Payload:** +- `timerID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/WORLD_STATE_TIMER_STOP.md b/wiki-information/events/WORLD_STATE_TIMER_STOP.md new file mode 100644 index 00000000..442c3910 --- /dev/null +++ b/wiki-information/events/WORLD_STATE_TIMER_STOP.md @@ -0,0 +1,11 @@ +## Event: WORLD_STATE_TIMER_STOP + +**Title:** WORLD STATE TIMER STOP + +**Content:** +Needs summary. +`WORLD_STATE_TIMER_STOP: timerID` + +**Payload:** +- `timerID` + - *number* \ No newline at end of file diff --git a/wiki-information/events/WOW_MOUSE_NOT_FOUND.md b/wiki-information/events/WOW_MOUSE_NOT_FOUND.md new file mode 100644 index 00000000..c0f58652 --- /dev/null +++ b/wiki-information/events/WOW_MOUSE_NOT_FOUND.md @@ -0,0 +1,10 @@ +## Event: WOW_MOUSE_NOT_FOUND + +**Title:** WOW MOUSE NOT FOUND + +**Content:** +Fired after DetectWowMouse failing. +`WOW_MOUSE_NOT_FOUND` + +**Payload:** +- `None` \ No newline at end of file diff --git a/wiki-information/events/ZONE_CHANGED.md b/wiki-information/events/ZONE_CHANGED.md new file mode 100644 index 00000000..e68f4d9f --- /dev/null +++ b/wiki-information/events/ZONE_CHANGED.md @@ -0,0 +1,31 @@ +## Event: ZONE_CHANGED + +**Title:** ZONE CHANGED + +**Content:** +Fires when the player enters an outdoors subzone. +`ZONE_CHANGED` + +**Payload:** +- `None` + +**Content Details:** +Related API +GetSubZoneText +Related Events +ZONE_CHANGED_NEW +AREAZONE_CHANGED_INDOORS + +**Usage:** +In Stormwind, when moving from Valley of Heroes to Trade District. +```lua +local function OnEvent(self, event, ...) + print(event, GetSubZoneText()) +end + +local f = CreateFrame("Frame") +f:RegisterEvent("ZONE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` +> "ZONE_CHANGED", "Valley of Heroes" +> "ZONE_CHANGED", "Trade District" \ No newline at end of file diff --git a/wiki-information/events/ZONE_CHANGED_INDOORS.md b/wiki-information/events/ZONE_CHANGED_INDOORS.md new file mode 100644 index 00000000..8e4ec6b2 --- /dev/null +++ b/wiki-information/events/ZONE_CHANGED_INDOORS.md @@ -0,0 +1,30 @@ +## Event: ZONE_CHANGED_INDOORS + +**Title:** ZONE CHANGED INDOORS + +**Content:** +Fires when the player enters an indoors subzone. +`ZONE_CHANGED_INDOORS` + +**Payload:** +- `None` + +**Content Details:** +Related API +GetSubZoneText +Related Events +ZONE_CHANGED + +**Usage:** +In Shrine of Seven Stars, when moving from The Emperor's Step to The Golden Lantern. +```lua +local function OnEvent(self, event, ...) + print(event, GetSubZoneText()) +end + +local f = CreateFrame("Frame") +f:RegisterEvent("ZONE_CHANGED_INDOORS") +f:SetScript("OnEvent", OnEvent) +> "ZONE_CHANGED_INDOORS", "The Emperor's Step" +> "ZONE_CHANGED_INDOORS", "The Golden Lantern" +``` \ No newline at end of file diff --git a/wiki-information/events/ZONE_CHANGED_NEW_AREA.md b/wiki-information/events/ZONE_CHANGED_NEW_AREA.md new file mode 100644 index 00000000..821f074d --- /dev/null +++ b/wiki-information/events/ZONE_CHANGED_NEW_AREA.md @@ -0,0 +1,33 @@ +## Event: ZONE_CHANGED_NEW_AREA + +**Title:** ZONE CHANGED NEW AREA + +**Content:** +Fires when the player enters a new zone. +`ZONE_CHANGED_NEW_AREA` + +**Payload:** +- `None` + +**Content Details:** +For example this fires when moving from Duskwood to Stranglethorn Vale or Durotar into Orgrimmar. +In interface terms, this is anytime you get a new set of channels. +Related API +GetChannelListC_Map.GetMapInfoGetZoneText • GetRealZoneText +Related Events +ZONE_CHANGED + +**Usage:** +When moving from Stormwind City to Elwynn Forest. +```lua +local function OnEvent(self, event, ...) + local mapID = C_Map.GetBestMapForUnit("player") + print(event, GetZoneText(), C_Map.GetMapInfo(mapID).name) +end + +local f = CreateFrame("Frame") +f:RegisterEvent("ZONE_CHANGED_NEW_AREA") +f:SetScript("OnEvent", OnEvent) +``` +> "ZONE_CHANGED_NEW_AREA", "Stormwind City", "Stormwind City" +> "ZONE_CHANGED_NEW_AREA", "Elwynn Forest", "Elwynn Forest" \ No newline at end of file diff --git a/wiki-information/functions/AbandonQuest.md b/wiki-information/functions/AbandonQuest.md new file mode 100644 index 00000000..9632cec0 --- /dev/null +++ b/wiki-information/functions/AbandonQuest.md @@ -0,0 +1,8 @@ +## Title: AbandonQuest + +**Content:** +Abandons the quest specified by `SetAbandonQuest()` +`AbandonQuest()` + +**Description:** +Calling `SetAbandonQuest()` triggers a dialog to confirm the user's intention, and the dialog calls `AbandonQuest()` when the user clicks "accept". \ No newline at end of file diff --git a/wiki-information/functions/AbandonSkill.md b/wiki-information/functions/AbandonSkill.md new file mode 100644 index 00000000..b1b8156e --- /dev/null +++ b/wiki-information/functions/AbandonSkill.md @@ -0,0 +1,20 @@ +## Title: AbandonSkill + +**Content:** +The player abandons a skill. +`AbandonSkill(skillLineID)` + +**Parameters:** +- `skillLineID` + - *number* - The Skill Line ID (can be found with API `GetProfessionInfo()`) + +**Usage:** +```lua +local prof1, prof2, archaeology, fishing, cooking, firstAid = GetProfessions(); +local skillLineID = select(7, GetProfessionInfo(prof1)); +AbandonSkill(skillLineID); +``` + +**Miscellaneous:** +The player abandons a skill. +**CAUTION:** There is no confirmation dialog for this action. Use with care. \ No newline at end of file diff --git a/wiki-information/functions/AcceptArenaTeam.md b/wiki-information/functions/AcceptArenaTeam.md new file mode 100644 index 00000000..ccec77ee --- /dev/null +++ b/wiki-information/functions/AcceptArenaTeam.md @@ -0,0 +1,15 @@ +## Title: AcceptArenaTeam + +**Content:** +Accepts a pending arena team invitation. +`AcceptArenaTeam()` + +**Description:** +Only one arena team invitation may be pending at any time. + +**Reference:** +- `ARENA_TEAM_INVITE_REQUEST` +- `ARENA_TEAM_INVITE_CANCEL` + +**See also:** +- `DeclineArenaTeam` \ No newline at end of file diff --git a/wiki-information/functions/AcceptBattlefieldPort.md b/wiki-information/functions/AcceptBattlefieldPort.md new file mode 100644 index 00000000..25086c90 --- /dev/null +++ b/wiki-information/functions/AcceptBattlefieldPort.md @@ -0,0 +1,11 @@ +## Title: AcceptBattlefieldPort + +**Content:** +Enters the Battleground if the queue is ready. +`AcceptBattlefieldPort(index, accept)` + +**Parameters:** +- `index` + - *number* - The battlefield in queue to enter. +- `accept` + - *boolean* - Whether or not to accept entry to the battlefield. \ No newline at end of file diff --git a/wiki-information/functions/AcceptDuel.md b/wiki-information/functions/AcceptDuel.md new file mode 100644 index 00000000..5bcac41d --- /dev/null +++ b/wiki-information/functions/AcceptDuel.md @@ -0,0 +1,9 @@ +## Title: AcceptDuel + +**Content:** +Accepts a duel challenge. +`AcceptDuel()` + +**Reference:** +- `StartDuel` to issue a duel challenge. +- `CancelDuel` to reject a duel challenge. \ No newline at end of file diff --git a/wiki-information/functions/AcceptGroup.md b/wiki-information/functions/AcceptGroup.md new file mode 100644 index 00000000..f504314b --- /dev/null +++ b/wiki-information/functions/AcceptGroup.md @@ -0,0 +1,22 @@ +## Title: AcceptGroup + +**Content:** +Accepts the invitation from a group. +`AcceptGroup()` + +**Usage:** +The following snippet auto-accepts invitations from characters whose names begin with the letter A. +```lua +local frame = CreateFrame("FRAME") +frame:RegisterEvent("PARTY_INVITE_REQUEST") +frame:SetScript("OnEvent", function(self, event, sender) + if sender:sub(1,1) == "A" then + AcceptGroup() + end +end) +``` + +**Description:** +You can use this after receiving the `PARTY_INVITE_REQUEST` event. If there is no invitation to a party, this function doesn't do anything. +Calling this function does NOT cause the "accept/decline dialog" to go away. Use `StaticPopup_Hide("PARTY_INVITE")` to hide the dialog. +Depending on the order events are dispatched in, your event handler may run before UIParent's, and therefore attempt to hide the dialog before it is shown. Delaying the attempt to hide the popup until `PARTY_MEMBERS_CHANGED` resolves this. \ No newline at end of file diff --git a/wiki-information/functions/AcceptGuild.md b/wiki-information/functions/AcceptGuild.md new file mode 100644 index 00000000..bfd69f06 --- /dev/null +++ b/wiki-information/functions/AcceptGuild.md @@ -0,0 +1,11 @@ +## Title: AcceptGuild + +**Content:** +Accepts a guild invite. +`AcceptGuild()` + +**Reference:** +- `GUILD_INVITE_REQUEST` +- `GUILD_INVITE_CANCEL` +- See also: + - `DeclineGuild` \ No newline at end of file diff --git a/wiki-information/functions/AcceptProposal.md b/wiki-information/functions/AcceptProposal.md new file mode 100644 index 00000000..f6e7c174 --- /dev/null +++ b/wiki-information/functions/AcceptProposal.md @@ -0,0 +1,15 @@ +## Title: AcceptProposal + +**Content:** +Enters the Dungeon if the LFG queue is ready. +`AcceptProposal()` + +**Reference:** +- `LFG_PROPOSAL_SHOW` +- `LFG_PROPOSAL_UPDATE` +- `LFG_PROPOSAL_SUCCEEDED` +- `LFG_PROPOSAL_FAILED` + +**See also:** +- `GetLFGProposal` +- `RejectProposal` \ No newline at end of file diff --git a/wiki-information/functions/AcceptQuest.md b/wiki-information/functions/AcceptQuest.md new file mode 100644 index 00000000..74ab68ba --- /dev/null +++ b/wiki-information/functions/AcceptQuest.md @@ -0,0 +1,12 @@ +## Title: AcceptQuest + +**Content:** +Accepts the currently offered quest. +`AcceptQuest()` + +**Description:** +You can call this function once the `QUEST_DETAIL` event fires. + +**Reference:** +- `AcknowledgeAutoAcceptQuest` +- `DeclineQuest` \ No newline at end of file diff --git a/wiki-information/functions/AcceptResurrect.md b/wiki-information/functions/AcceptResurrect.md new file mode 100644 index 00000000..e961cdb3 --- /dev/null +++ b/wiki-information/functions/AcceptResurrect.md @@ -0,0 +1,19 @@ +## Title: AcceptResurrect + +**Content:** +Accepts a resurrection offer. +`AcceptResurrect()` + +**Description:** +Most player-sponsored resurrection offers expire automatically after 60 seconds. + +**Reference:** +- `RESURRECT_REQUEST` +- `PLAYER_UNGHOST` +- `PLAYER_SKINNED` + +**See also:** +- `GetCorpseRecoveryDelay` +- `DeclineResurrect` +- `ResurrectHasSickness` +- `ResurrectHasTimer` \ No newline at end of file diff --git a/wiki-information/functions/AcceptSockets.md b/wiki-information/functions/AcceptSockets.md new file mode 100644 index 00000000..59c5539b --- /dev/null +++ b/wiki-information/functions/AcceptSockets.md @@ -0,0 +1,18 @@ +## Title: AcceptSockets + +**Content:** +Confirms pending gems for socketing. +`AcceptSockets()` + +**Description:** +The socketing API designates a single item (SocketInventoryItem, SocketContainerItem) to be considered for socketing at a time. While an item is being considered for socketing, players may drop new gems into its sockets (ClickSocketButton). If the user wishes to actually perform the socketing, `AcceptSockets()` must be called to confirm. + +There is no dedicated API call to reject a tentative socketing, although you may use `CloseSocketInfo()` to exit socketing without making any changes to the item. You can then select the item for socketing again. + +Replaces existing gems if necessary. + +**Reference:** +- `SocketInventoryItem` +- `SocketContainerItem` +- `ClickSocketButton` +- `CloseSocketInfo` \ No newline at end of file diff --git a/wiki-information/functions/AcceptSpellConfirmationPrompt.md b/wiki-information/functions/AcceptSpellConfirmationPrompt.md new file mode 100644 index 00000000..6f533e01 --- /dev/null +++ b/wiki-information/functions/AcceptSpellConfirmationPrompt.md @@ -0,0 +1,17 @@ +## Title: AcceptSpellConfirmationPrompt + +**Content:** +Confirms a spell confirmation prompt (e.g. bonus loot roll). +`AcceptSpellConfirmationPrompt(spellID)` + +**Parameters:** +- `spellID` + - *number* - spell ID of the prompt to confirm. + +**Description:** +SPELL_CONFIRMATION_PROMPT fires when a spell confirmation prompt might be presented to the player; it provides the spellID and information about the type, text, and duration of the confirmation. Notably, the event does not guarantee that the player can actually cast the spell. +Calling this function accepts the spell prompt, performing the action in question. +SPELL_CONFIRMATION_TIMEOUT fires if the spell is not confirmed within the prompt duration. + +**Reference:** +- [DeclineSpellConfirmationPrompt](#) \ No newline at end of file diff --git a/wiki-information/functions/AcceptTrade.md b/wiki-information/functions/AcceptTrade.md new file mode 100644 index 00000000..37ca90fd --- /dev/null +++ b/wiki-information/functions/AcceptTrade.md @@ -0,0 +1,20 @@ +## Title: AcceptTrade + +**Content:** +Accepts the current trade offer. +`AcceptTrade()` + +**Reference:** +- `TRADE_ACCEPT_UPDATE` +- `TRADE_CLOSED` +- `TRADE_MONEY_CHANGED` +- `TRADE_PLAYER_ITEM_CHANGED` +- `TRADE_REPLACE_ENCHANT` +- `TRADE_REQUEST` +- `TRADE_REQUEST_CANCEL` + +**Example Usage:** +This function can be used in a custom addon to automate the acceptance of trade offers. For instance, if you are developing an addon that facilitates quick trading between players, you can call `AcceptTrade()` to programmatically accept a trade once certain conditions are met. + +**Addons Using This Function:** +Many trading addons, such as TradeSkillMaster, use this function to streamline the trading process by automatically accepting trades that meet predefined criteria. \ No newline at end of file diff --git a/wiki-information/functions/AcceptXPLoss.md b/wiki-information/functions/AcceptXPLoss.md new file mode 100644 index 00000000..5a38fa09 --- /dev/null +++ b/wiki-information/functions/AcceptXPLoss.md @@ -0,0 +1,12 @@ +## Title: AcceptXPLoss + +**Content:** +Confirms the resurrection sickness and durability loss penalty on being resurrected by a spirit healer. +`AcceptXPLoss()` + +**Description:** +The name is misleading, originating from the WoW beta when resurrecting at a spirit healer cost experience. + +**Reference:** +- `CONFIRM_XP_LOSS` - fired upon accepting resurrection sickness and durability loss +- `PLAYER_UNGHOST` - fired upon returning to life by any source, including spirit healers \ No newline at end of file diff --git a/wiki-information/functions/ActionHasRange.md b/wiki-information/functions/ActionHasRange.md new file mode 100644 index 00000000..d85ba640 --- /dev/null +++ b/wiki-information/functions/ActionHasRange.md @@ -0,0 +1,16 @@ +## Title: ActionHasRange + +**Content:** +Returns true if the action has a range requirement. +`hasRange = ActionHasRange(slotID)` + +**Parameters:** +- `slotID` + - *number* - The slot ID to test. + +**Returns:** +- `hasRange` + - *boolean* - True if the specified slot contains an action which has a numeric range requirement. + +**Description:** +This function returns true if the action in the specified slot ID has a numeric range requirement as shown in the action's tooltip, e.g., has a numeric range of 20 yards. For actions like Attack which have no numeric range requirement in their tooltip (even though they only work within a certain range), this function will return false. \ No newline at end of file diff --git a/wiki-information/functions/AddChatWindowChannel.md b/wiki-information/functions/AddChatWindowChannel.md new file mode 100644 index 00000000..bbf50131 --- /dev/null +++ b/wiki-information/functions/AddChatWindowChannel.md @@ -0,0 +1,21 @@ +## Title: AddChatWindowChannel + +**Content:** +Enables messages from a chat channel index for a chat window. +`AddChatWindowChannel(windowId, channelName)` + +**Parameters:** +- `windowId` + - *number* - index of the chat window/frame (ascending from 1) to add the channel to. +- `channelName` + - *string* - name of the chat channel to add to the frame. + +**Description:** +A single channel may be configured to display in multiple chat windows/frames. +Chat output architecture has changed since release; calling this function alone is no longer sufficient to add a channel to a particular frame in the default UI. Use `ChatFrame_AddChannel(chatFrame, "channelName")` instead, like so: +```lua +ChatFrame_AddChannel(ChatWindow1, "Trade"); -- DEFAULT_CHAT_FRAME works well, too +``` + +**Reference:** +- `RemoveChatWindowChannel` \ No newline at end of file diff --git a/wiki-information/functions/AddChatWindowMessages.md b/wiki-information/functions/AddChatWindowMessages.md new file mode 100644 index 00000000..3890882f --- /dev/null +++ b/wiki-information/functions/AddChatWindowMessages.md @@ -0,0 +1,16 @@ +## Title: AddChatWindowMessages + +**Content:** +Enables messages from the chat message type (e.g. "SAY") for a chat window. +`AddChatWindowMessages(index, messageGroup)` + +**Parameters:** +- `index` + - *number* - The chat window index, ascending from 1. +- `messageGroup` + - *string* - Message group to add to the chat window, e.g. "SAY", "EMOTE", "MONSTER_BOSS_EMOTE". + +**Reference:** +- `GetChatWindowMessages` +- `RemoveChatWindowMessages` +- `AddChatWindowChannel` \ No newline at end of file diff --git a/wiki-information/functions/AddQuestWatch.md b/wiki-information/functions/AddQuestWatch.md new file mode 100644 index 00000000..8129f2fd --- /dev/null +++ b/wiki-information/functions/AddQuestWatch.md @@ -0,0 +1,14 @@ +## Title: AddQuestWatch + +**Content:** +Adds a quest to the list of quests being watched with an optional time to watch it. +`AddQuestWatch(questIndex)` + +**Parameters:** +- `questIndex` + - *number* - The index of the quest in the quest log. +- `watchTime` + - *number* - The amount of time to watch the quest in seconds. + +**Returns:** +- None \ No newline at end of file diff --git a/wiki-information/functions/AddTrackedAchievement.md b/wiki-information/functions/AddTrackedAchievement.md new file mode 100644 index 00000000..7e9e82a1 --- /dev/null +++ b/wiki-information/functions/AddTrackedAchievement.md @@ -0,0 +1,20 @@ +## Title: AddTrackedAchievement + +**Content:** +Tracks an achievement. +`AddTrackedAchievement(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - ID of the achievement to add to tracking. + +**Reference:** +- `TRACKED_ACHIEVEMENT_UPDATE` +- See also: + - `RemoveTrackedAchievement` + - `GetTrackedAchievements` + - `GetNumTrackedAchievements` + +**Description:** +A maximum of `WATCHFRAME_MAXACHIEVEMENTS` (10 as of 5.4.8) tracked achievements can be displayed by the WatchFrame at a time. +You may need to manually update the AchievementUI and WatchFrame after calling this function. \ No newline at end of file diff --git a/wiki-information/functions/AddTradeMoney.md b/wiki-information/functions/AddTradeMoney.md new file mode 100644 index 00000000..14740e99 --- /dev/null +++ b/wiki-information/functions/AddTradeMoney.md @@ -0,0 +1,9 @@ +## Title: AddTradeMoney + +**Content:** +Adds money currently held by the cursor to the trade offer. +`AddTradeMoney()` + +**Reference:** +- `PickupPlayerMoney` +- `PickupTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/Ambiguate.md b/wiki-information/functions/Ambiguate.md new file mode 100644 index 00000000..ccea2a88 --- /dev/null +++ b/wiki-information/functions/Ambiguate.md @@ -0,0 +1,50 @@ +## Title: Ambiguate + +**Content:** +Returns a version of a character-realm string suitable for use in a given context. +`name = Ambiguate(fullName, context)` + +**Parameters:** +- `fullName` + - *string* - character-realm for a character, e.g. "Shion-DieAldor" +- `context` + - *string* - context the name will be used in, one of: "all", "guild", "mail", "none", or "short". + +**Returns:** +- `name` + - *string* - character or character-realm name combination that would be equivalent to fullName in the specified context. + - **Context** + - **Same Realm** + - **Different Realm** + - **Same Guild** + - **Other Guild** + - **Same Guild** + - **Other Guild** + - `all` + - character + - character + - character + - character-realm + - `guild` + - character + - character + - character + - character-realm + - `mail` + - character-realm + - character-realm + - character-realm + - character-realm + - `none` + - character + - character + - character-realm + - character-realm + - `short` + - character + - character + - character + - character + +**Description:** +If this is used on a character in the "guild" context, it will return in the character-realm format if there is another character in the same guild with the same name, but on a different realm. \ No newline at end of file diff --git a/wiki-information/functions/AreDangerousScriptsAllowed.md b/wiki-information/functions/AreDangerousScriptsAllowed.md new file mode 100644 index 00000000..d83a8458 --- /dev/null +++ b/wiki-information/functions/AreDangerousScriptsAllowed.md @@ -0,0 +1,9 @@ +## Title: AreDangerousScriptsAllowed + +**Content:** +Needs summary. +`allowed = AreDangerousScriptsAllowed()` + +**Returns:** +- `allowed` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamDisband.md b/wiki-information/functions/ArenaTeamDisband.md new file mode 100644 index 00000000..1395a65f --- /dev/null +++ b/wiki-information/functions/ArenaTeamDisband.md @@ -0,0 +1,16 @@ +## Title: ArenaTeamDisband + +**Content:** +Disbands an Arena Team if the player is the team captain. +`ArenaTeamDisband(index)` + +**Parameters:** +- `index` + - *number* - Index of the arena team to delete, index can be a value of 1 through 3. + +**Usage:** +The following macro disbands the first arena team. +```lua +/run ArenaTeamDisband(1) +``` +It can be used as the last solution to get rid of an arena team if all the other members of it don't come online anymore or if you just want to delete it. So far there is no UI implementation of this. \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamInviteByName.md b/wiki-information/functions/ArenaTeamInviteByName.md new file mode 100644 index 00000000..105e2a2e --- /dev/null +++ b/wiki-information/functions/ArenaTeamInviteByName.md @@ -0,0 +1,11 @@ +## Title: ArenaTeamInviteByName + +**Content:** +Needs summary. +`ArenaTeamInviteByName(index, target)` + +**Parameters:** +- `index` + - *number* +- `target` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamLeave.md b/wiki-information/functions/ArenaTeamLeave.md new file mode 100644 index 00000000..5f4e76b5 --- /dev/null +++ b/wiki-information/functions/ArenaTeamLeave.md @@ -0,0 +1,9 @@ +## Title: ArenaTeamLeave + +**Content:** +Needs summary. +`ArenaTeamLeave(index)` + +**Parameters:** +- `index` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamRoster.md b/wiki-information/functions/ArenaTeamRoster.md new file mode 100644 index 00000000..1aff5e0d --- /dev/null +++ b/wiki-information/functions/ArenaTeamRoster.md @@ -0,0 +1,13 @@ +## Title: ArenaTeamRoster + +**Content:** +Requests the arena team information from the server +`ArenaTeamRoster(index)` + +**Parameters:** +- `index` + - *number* - Index of the arena team to request information from, 1 through 3. + +**Description:** +Because this sends a request to the server, you will not get the data instantly; you must register and watch for the `ARENA_TEAM_ROSTER_UPDATE` event. +It appears that `ARENA_TEAM_ROSTER_UPDATE` will not fire if you requested the same team index last call. \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamSetLeaderByName.md b/wiki-information/functions/ArenaTeamSetLeaderByName.md new file mode 100644 index 00000000..f7accf4b --- /dev/null +++ b/wiki-information/functions/ArenaTeamSetLeaderByName.md @@ -0,0 +1,11 @@ +## Title: ArenaTeamSetLeaderByName + +**Content:** +Needs summary. +`ArenaTeamSetLeaderByName(index, target)` + +**Parameters:** +- `index` + - *number* +- `target` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamUninviteByName.md b/wiki-information/functions/ArenaTeamUninviteByName.md new file mode 100644 index 00000000..53710f99 --- /dev/null +++ b/wiki-information/functions/ArenaTeamUninviteByName.md @@ -0,0 +1,11 @@ +## Title: ArenaTeamUninviteByName + +**Content:** +Needs summary. +`ArenaTeamUninviteByName(index, target)` + +**Parameters:** +- `index` + - *number* +- `target` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/AscendStop.md b/wiki-information/functions/AscendStop.md new file mode 100644 index 00000000..2ce6ecc7 --- /dev/null +++ b/wiki-information/functions/AscendStop.md @@ -0,0 +1,20 @@ +## Title: AscendStop + +**Content:** +Called when the player releases the jump key. +`AscendStop()` + +**Description:** +This doesn't appear to affect the actual jump at all, but may be hooked to monitor when the jump key is released. +Called as the jump key is released, regardless if you are in the middle of the jump or held it down until the jump finished. + +**Usage:** +Prints "Jump Released" when releasing the jump key. +```lua +hooksecurefunc("AscendStop", function() + DEFAULT_CHAT_FRAME:AddMessage("Jump Released") +end) +``` + +**Reference:** +`JumpOrAscendStart` \ No newline at end of file diff --git a/wiki-information/functions/AssistUnit.md b/wiki-information/functions/AssistUnit.md new file mode 100644 index 00000000..c8d69093 --- /dev/null +++ b/wiki-information/functions/AssistUnit.md @@ -0,0 +1,23 @@ +## Title: AssistUnit + +**Content:** +Assists the unit by targeting the same target. +`AssistUnit(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Description:** +If the player's target was changed by a Targeting Function, it is possible to restore the original target by assisting the player. + +**Example Usage:** +```lua +-- Example of using AssistUnit to target the same target as the party leader +local partyLeader = "party1" +AssistUnit(partyLeader) +``` + +**Usage in Addons:** +- **HealBot**: This addon uses `AssistUnit` to allow healers to quickly assist the main tank or other party members, ensuring they can target the same enemy for healing or other actions. +- **Grid**: This raid unit frame addon can use `AssistUnit` to help players quickly switch targets to assist the main assist or tank in a raid environment. \ No newline at end of file diff --git a/wiki-information/functions/AttackTarget.md b/wiki-information/functions/AttackTarget.md new file mode 100644 index 00000000..af3a3b4c --- /dev/null +++ b/wiki-information/functions/AttackTarget.md @@ -0,0 +1,11 @@ +## Title: AttackTarget + +**Content:** +Toggles auto-attacking of the current target. +`AttackTarget()` + +**Description:** +This is actually a toggle. If not currently attacking, it will initiate attack. If currently attacking, it will stop attacking. +You can test your current attack "Action slot" using `IsCurrentAction(actionSlot)` for status (you'll have to find the auto-attack slot, though). +If you need a way to always engage auto-attack, rather than toggle it on or off, one workaround is `AssistUnit("player")` this will always attack if you have "Attack on assist" checked in the Advanced tab of the Interface Options panel. Note that you cannot combine this with `TargetNearestEnemy()` in the same function/macro: the "assist" target isn't updated fast enough. +The macro `/startattack` will always initiate auto-attack (or auto-shot for hunters, if the appropriate interface option is active). \ No newline at end of file diff --git a/wiki-information/functions/AutoEquipCursorItem.md b/wiki-information/functions/AutoEquipCursorItem.md new file mode 100644 index 00000000..9a9f8bdb --- /dev/null +++ b/wiki-information/functions/AutoEquipCursorItem.md @@ -0,0 +1,17 @@ +## Title: AutoEquipCursorItem + +**Content:** +Equips the item currently held by the cursor. +`AutoEquipCursorItem()` + +**Usage:** +```lua +PickupContainerItem(0,1) +AutoEquipCursorItem() +PickupContainerItem(0,1) +AutoEquipCursorItem() +``` + +**Miscellaneous:** +**Result:** +Equips the first item in your backpack to the relevant slot (if it can be equipped). \ No newline at end of file diff --git a/wiki-information/functions/AutoStoreGuildBankItem.md b/wiki-information/functions/AutoStoreGuildBankItem.md new file mode 100644 index 00000000..dd55a898 --- /dev/null +++ b/wiki-information/functions/AutoStoreGuildBankItem.md @@ -0,0 +1,11 @@ +## Title: AutoStoreGuildBankItem + +**Content:** +Withdraws an item from the Guild Bank to the character's inventory. +`AutoStoreGuildBankItem(tab, slot)` + +**Parameters:** +- `tab` + - *number* - The index of the tab in the guild bank +- `slot` + - *number* - The index of the slot in the chosen tab \ No newline at end of file diff --git a/wiki-information/functions/BNConnected.md b/wiki-information/functions/BNConnected.md new file mode 100644 index 00000000..a3904701 --- /dev/null +++ b/wiki-information/functions/BNConnected.md @@ -0,0 +1,9 @@ +## Title: BNConnected + +**Content:** +Returns true if the WoW Client is connected to Battle.net. +`connected = BNConnected()` + +**Returns:** +- `connected` + - *boolean* - true if connected, false if not \ No newline at end of file diff --git a/wiki-information/functions/BNGetFOFInfo.md b/wiki-information/functions/BNGetFOFInfo.md new file mode 100644 index 00000000..5b2828ce --- /dev/null +++ b/wiki-information/functions/BNGetFOFInfo.md @@ -0,0 +1,21 @@ +## Title: BNGetFOFInfo + +**Content:** +Returns info for the specified friend of a Battle.net friend. +`friendID, accountName, isMutual = BNGetFOFInfo(mutual, nonMutual, index)` + +**Parameters:** +- `mutual` + - *boolean* - Should the list include mutual friends (i.e., people who you and the person referenced by presenceID are both friends with). +- `nonMutual` + - *boolean* - Should the list include non-mutual friends. +- `index` + - *number* - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...)). + +**Returns:** +- `friendID` + - *number* - a unique numeric identifier for this friend for this session. +- `accountName` + - *string* - a Kstring representing the friend's name (As of 4.0). +- `isMutual` + - *boolean* - true if this person is a direct friend of yours, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendGameAccountInfo.md b/wiki-information/functions/BNGetFriendGameAccountInfo.md new file mode 100644 index 00000000..3b1bd689 --- /dev/null +++ b/wiki-information/functions/BNGetFriendGameAccountInfo.md @@ -0,0 +1,77 @@ +## Title: BNGetFriendGameAccountInfo + +**Content:** +Returns information about the specified toon of a RealID friend. +``` +hasFocus, characterName, client, realmName, realmID, faction, race, class, guild, zoneName, level, gameText, broadcastText, broadcastTime, canSoR, toonID, bnetIDAccount, isGameAFK, isGameBusy += BNGetFriendGameAccountInfo(friendIndex) += BNGetGameAccountInfo(bnetIDGameAccount) += BNGetGameAccountInfoByGUID(guid) +``` + +**Parameters:** +- **BNGetFriendGameAccountInfo:** + - `friendIndex` + - *number* - Ranging from 1 to BNGetNumFriendGameAccounts() + +- **BNGetGameAccountInfo:** + - `bnetIDGameAccount` + - *number* - A unique numeric identifier for the friend during this session. + +- **BNGetGameAccountInfoByGUID:** + - `guid` + - *string* + +**Returns:** +- `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame. +- `characterName` + - *string* - The name of the logged in toon/character. +- `client` + - *string* - Either "WoW" (BNET_CLIENT_WOW), "S2" (BNET_CLIENT_S2), "WTCG" (BNET_CLIENT_WTCG), "App" (BNET_CLIENT_APP), "Hero" (BNET_CLIENT_HEROES), "Pro" (BNET_CLIENT_OVERWATCH), "CLNT" (BNET_CLIENT_CLNT), or "D3" (BNET_CLIENT_D3) for World of Warcraft, StarCraft 2, Hearthstone, BNet Application, Heroes of the Storm, Overwatch, another client, or Diablo 3. +- `realmName` + - *string* - The name of the logged in realm. +- `realmID` + - *number* - The ID for the logged in realm. +- `faction` + - *string* - The faction name (i.e., "Alliance" or "Horde"). +- `race` + - *string* - The localized race name (e.g., "Blood Elf"). +- `class` + - *string* - The localized class name (e.g., "Death Knight"). +- `guild` + - *string* - Seems to return "" even if the player is in a guild. +- `zoneName` + - *string* - The localized zone name (e.g., "The Undercity"). +- `level` + - *string* - The current level (e.g., "90"). +- `gameText` + - *string* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. +- `broadcastText` + - *string* - The Battle.Net broadcast message. +- `broadcastTime` + - *number* - The number of seconds elapsed since the current broadcast message was sent. +- `canSoR` + - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. +- `toonID` + - *number* - A unique numeric identifier for the friend's character during this session. +- `bnetIDAccount` + - *number* +- `isGameAFK` + - *boolean* +- `isGameBusy` + - *boolean* + +**Usage:** +```lua +local bnetIDGameAccount = select(6, BNGetFriendInfo(1)) -- assuming friend index 1 is me (Grdn) +local _, characterName, _, realmName = BNGetGameAccountInfo(bnetIDGameAccount) +print(toonName .. " plays on " .. realmName) -- Grdn plays on Onyxia +``` + +**Example Use Case:** +This function can be used to display detailed information about a RealID friend's current game status, such as their character name, realm, and current activity. This is particularly useful for addons that enhance the social experience in World of Warcraft by providing more detailed friend information. + +**Addons Using This Function:** +- **ElvUI**: A comprehensive UI replacement addon that uses this function to display detailed information about RealID friends in its enhanced friend list. +- **Prat**: A chat enhancement addon that uses this function to show detailed RealID friend information in the chat window. \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendIndex.md b/wiki-information/functions/BNGetFriendIndex.md new file mode 100644 index 00000000..29bb593c --- /dev/null +++ b/wiki-information/functions/BNGetFriendIndex.md @@ -0,0 +1,13 @@ +## Title: BNGetFriendIndex + +**Content:** +Returns the index in the friend frame of the given Battle.net friend. +`index = BNGetFriendIndex(presenceID)` + +**Parameters:** +- `presenceID` + - *number* - A unique numeric identifier for the friend's Battle.net account during this session. + +**Returns:** +- `index` + - *number* - The Battle.net friend's index on the friends list \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendInfo.md b/wiki-information/functions/BNGetFriendInfo.md new file mode 100644 index 00000000..9baf61ef --- /dev/null +++ b/wiki-information/functions/BNGetFriendInfo.md @@ -0,0 +1,76 @@ +## Title: BNGetFriendInfo + +**Content:** +Returns information about the specified RealID friend. +```lua +bnetAccountID, accountName, battleTag, isBattleTagPresence, characterName, bnetIDGameAccount, client, isOnline, lastOnline, isAFK, isDND, messageText, noteText, isRIDFriend, messageTime, canSoR, isReferAFriend, canSummonFriend = BNGetFriendInfo(friendIndex) +``` +or +```lua +bnetAccountID, accountName, battleTag, isBattleTagPresence, characterName, bnetIDGameAccount, client, isOnline, lastOnline, isAFK, isDND, messageText, noteText, isRIDFriend, messageTime, canSoR, isReferAFriend, canSummonFriend = BNGetFriendInfoByID(bnetAccountID) +``` + +**Parameters:** +- `BNGetFriendInfo:` + - `friendIndex` + - *number* - The index on the friends list for this RealID friend, ranging from 1 to BNGetNumFriends() + +- `BNGetFriendInfoByID:` + - `bnetAccountID` + - *number* - A unique numeric identifier for this friend's battle.net account for the current session + +**Returns:** +- `bnetAccountID` + - *number* - A temporary ID for the friend's battle.net account during this session. +- `accountName` + - *string* - An escape sequence (starting with |K) representing the friend's full name or BattleTag name. +- `battleTag` + - *string* - A nickname and number that when combined, form a unique string that identifies the friend (e.g., "Nickname#0001"). +- `isBattleTagPresence` + - *boolean* - Whether or not the friend is known by their BattleTag. +- `characterName` + - *string* - The name of the logged in character. +- `bnetIDGameAccount` + - *number* - A unique numeric identifier for the friend's game account during this session. +- `client` + - *string* - See BNET_CLIENT +- `isOnline` + - *boolean* - Whether or not the friend is online. +- `lastOnline` + - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. +- `isAFK` + - *boolean* - Whether or not the friend is flagged as Away. +- `isDND` + - *boolean* - Whether or not the friend is flagged as Busy. +- `messageText` + - *string* - The friend's Battle.Net broadcast message. +- `noteText` + - *string* - The contents of the player's note about this friend. +- `isRIDFriend` + - *boolean* - Returns true for RealID friends and false for BattleTag friends. +- `messageTime` + - *number* - The number of seconds elapsed since the current broadcast message was sent. +- `canSoR` + - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. +- `isReferAFriend` + - *boolean* +- `canSummonFriend` + - *boolean* + +**Description:** +- `BNET_CLIENT` + - **Global** + - `Value` + - `Description` + - `BNET_CLIENT_WOW` + - *WoW* - World of Warcraft + - `BNET_CLIENT_APP` + - *App* - Battle.net desktop app + - `BNET_CLIENT_HEROES` + - *Hero* - Heroes of the Storm + - `BNET_CLIENT_CLNT` + - *CLNT* + +**Reference:** +- `BNGetFriendGameAccountInfo` +- `BNGetGameAccountInfo` \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendInfoByID.md b/wiki-information/functions/BNGetFriendInfoByID.md new file mode 100644 index 00000000..6d7c89c0 --- /dev/null +++ b/wiki-information/functions/BNGetFriendInfoByID.md @@ -0,0 +1,77 @@ +## Title: BNGetFriendInfo + +**Content:** +Returns information about the specified RealID friend. +```lua +bnetAccountID, accountName, battleTag, isBattleTagPresence, characterName, bnetIDGameAccount, client, isOnline, lastOnline, isAFK, isDND, messageText, noteText, isRIDFriend, messageTime, canSoR, isReferAFriend, canSummonFriend + = BNGetFriendInfo(friendIndex) + = BNGetFriendInfoByID(bnetAccountID) +``` + +**Parameters:** +- **BNGetFriendInfo:** + - `friendIndex` + - *number* - The index on the friends list for this RealID friend, ranging from 1 to BNGetNumFriends() + +- **BNGetFriendInfoByID:** + - `bnetAccountID` + - *number* - A unique numeric identifier for this friend's battle.net account for the current session + +**Returns:** +- `bnetAccountID` + - *number* - A temporary ID for the friend's battle.net account during this session. +- `accountName` + - *string* - An escape sequence (starting with |K) representing the friend's full name or BattleTag name. +- `battleTag` + - *string* - A nickname and number that when combined, form a unique string that identifies the friend (e.g., "Nickname#0001"). +- `isBattleTagPresence` + - *boolean* - Whether or not the friend is known by their BattleTag. +- `characterName` + - *string* - The name of the logged in character. +- `bnetIDGameAccount` + - *number* - A unique numeric identifier for the friend's game account during this session. +- `client` + - *string* - See BNET_CLIENT +- `isOnline` + - *boolean* - Whether or not the friend is online. +- `lastOnline` + - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. +- `isAFK` + - *boolean* - Whether or not the friend is flagged as Away. +- `isDND` + - *boolean* - Whether or not the friend is flagged as Busy. +- `messageText` + - *string* - The friend's Battle.Net broadcast message. +- `noteText` + - *string* - The contents of the player's note about this friend. +- `isRIDFriend` + - *boolean* - Returns true for RealID friends and false for BattleTag friends. +- `messageTime` + - *number* - The number of seconds elapsed since the current broadcast message was sent. +- `canSoR` + - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. +- `isReferAFriend` + - *boolean* +- `canSummonFriend` + - *boolean* + +**Description:** +BNET_CLIENT +- **Global** + - **Value** + - **Description** + - `BNET_CLIENT_WOW` + - WoW + - World of Warcraft + - `BNET_CLIENT_APP` + - App + - Battle.net desktop app + - `BNET_CLIENT_HEROES` + - Hero + - Heroes of the Storm + - `BNET_CLIENT_CLNT` + - CLNT + +**Reference:** +- `BNGetFriendGameAccountInfo` +- `BNGetGameAccountInfo` \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendInviteInfo.md b/wiki-information/functions/BNGetFriendInviteInfo.md new file mode 100644 index 00000000..c081f79b --- /dev/null +++ b/wiki-information/functions/BNGetFriendInviteInfo.md @@ -0,0 +1,21 @@ +## Title: BNGetFriendInviteInfo + +**Content:** +Returns info for a Battle.net friend invite. +`inviteID, accountName, isBattleTag, message, sentTime = BNGetFriendInviteInfo(inviteIndex)` + +**Parameters:** +- `inviteIndex` + - *number* - Ranging from 1 to BNGetNumFriendInvites() + +**Returns:** +- `inviteID` + - *number* - Also known as the presence id. +- `accountName` + - *number* - Protected string for the friend account name, e.g. "|Kq4|k". +- `isBattleTag` + - *boolean* +- `message` + - *string?* - Appears to be always nil now. +- `sentTime` + - *number* - The unix time when the invite was sent/received. \ No newline at end of file diff --git a/wiki-information/functions/BNGetGameAccountInfo.md b/wiki-information/functions/BNGetGameAccountInfo.md new file mode 100644 index 00000000..8d6c7af8 --- /dev/null +++ b/wiki-information/functions/BNGetGameAccountInfo.md @@ -0,0 +1,70 @@ +## Title: BNGetFriendGameAccountInfo + +**Content:** +Returns information about the specified toon of a RealID friend. +``` +hasFocus, characterName, client, realmName, realmID, faction, race, class, guild, zoneName, level, gameText, broadcastText, broadcastTime, canSoR, toonID, bnetIDAccount, isGameAFK, isGameBusy += BNGetFriendGameAccountInfo(friendIndex) += BNGetGameAccountInfo(bnetIDGameAccount) += BNGetGameAccountInfoByGUID(guid) +``` + +**Parameters:** +- **BNGetFriendGameAccountInfo:** + - `friendIndex` + - *number* - Ranging from 1 to BNGetNumFriendGameAccounts() + +- **BNGetGameAccountInfo:** + - `bnetIDGameAccount` + - *number* - A unique numeric identifier for the friend during this session. + +- **BNGetGameAccountInfoByGUID:** + - `guid` + - *string* + +**Returns:** +- `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame. +- `characterName` + - *string* - The name of the logged in toon/character. +- `client` + - *string* - Either "WoW" (BNET_CLIENT_WOW), "S2" (BNET_CLIENT_S2), "WTCG" (BNET_CLIENT_WTCG), "App" (BNET_CLIENT_APP), "Hero" (BNET_CLIENT_HEROES), "Pro" (BNET_CLIENT_OVERWATCH), "CLNT" (BNET_CLIENT_CLNT), or "D3" (BNET_CLIENT_D3) for World of Warcraft, StarCraft 2, Hearthstone, BNet Application, Heroes of the Storm, Overwatch, another client, or Diablo 3. +- `realmName` + - *string* - The name of the logged in realm. +- `realmID` + - *number* - The ID for the logged in realm. +- `faction` + - *string* - The faction name (i.e., "Alliance" or "Horde"). +- `race` + - *string* - The localized race name (e.g., "Blood Elf"). +- `class` + - *string* - The localized class name (e.g., "Death Knight"). +- `guild` + - *string* - Seems to return "" even if the player is in a guild. +- `zoneName` + - *string* - The localized zone name (e.g., "The Undercity"). +- `level` + - *string* - The current level (e.g., "90"). +- `gameText` + - *string* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. +- `broadcastText` + - *string* - The Battle.Net broadcast message. +- `broadcastTime` + - *number* - The number of seconds elapsed since the current broadcast message was sent. +- `canSoR` + - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. +- `toonID` + - *number* - A unique numeric identifier for the friend's character during this session. +- `bnetIDAccount` + - *number* +- `isGameAFK` + - *boolean* +- `isGameBusy` + - *boolean* + +**Usage:** +```lua +local bnetIDGameAccount = select(6, BNGetFriendInfo(1)) -- assuming friend index 1 is me (Grdn) +local _, characterName, _, realmName = BNGetGameAccountInfo(bnetIDGameAccount) +print(toonName .. " plays on " .. realmName) -- Grdn plays on Onyxia +``` \ No newline at end of file diff --git a/wiki-information/functions/BNGetGameAccountInfoByGUID.md b/wiki-information/functions/BNGetGameAccountInfoByGUID.md new file mode 100644 index 00000000..a6ccffd1 --- /dev/null +++ b/wiki-information/functions/BNGetGameAccountInfoByGUID.md @@ -0,0 +1,106 @@ +## Title: C_BattleNet.GetFriendGameAccountInfo + +**Content:** +Returns information on the game the Battle.net friend is playing. +```lua +gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) +``` + +**Parameters:** + +*GetFriendGameAccountInfo:* +- `friendIndex` + - *number* - Index ranging from 1 to BNGetNumFriends() +- `accountIndex` + - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() + +*GetGameAccountInfoByID:* +- `id` + - *number* - gameAccountInfo.gameAccountID + +*GetGameAccountInfoByGUID:* +- `guid` + - *string* - UnitGUID + +**Returns:** +- `gameAccountInfo` + - *BNetGameAccountInfo?* + - `Field` + - `Type` + - `Description` + - `gameAccountID` + - *number?* - A temporary ID for the friend's battle.net game account during this session. + - `clientProgram` + - *string* - BNET_CLIENT + - `isOnline` + - *boolean* + - `isGameBusy` + - *boolean* + - `isGameAFK` + - *boolean* + - `wowProjectID` + - *number?* + - `characterName` + - *string?* - The name of the logged in toon/character + - `realmName` + - *string?* - The name of the logged in realm + - `realmDisplayName` + - *string?* + - `realmID` + - *number?* - The ID for the logged in realm + - `factionName` + - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") + - `raceName` + - *string?* - The localized race name (e.g., "Blood Elf") + - `className` + - *string?* - The localized class name (e.g., "Death Knight") + - `areaName` + - *string?* - The localized zone name (e.g., "The Undercity") + - `characterLevel` + - *number?* - The current level (e.g., "90") + - `richPresence` + - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. + - `playerGuid` + - *string?* - A unique numeric identifier for the friend's character during this session. + - `isWowMobile` + - *boolean* + - `canSummon` + - *boolean* + - `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame + - `regionID` + - *number* - Added in 9.1.0 + - `isInCurrentRegion` + - *boolean* - Added in 9.1.0 + +**Description:** +Related API: `C_BattleNet.GetFriendAccountInfo` + +**Usage:** +Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. +```lua +for i = 1, BNGetNumFriends() do + for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do + local game = C_BattleNet.GetFriendGameAccountInfo(i, j) + print(game.gameAccountID, game.isOnline, game.clientProgram) + end +end +-- 5, true, "BSAp" + +C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo +for i = 1, BNGetNumFriends() do + local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo + print(game.gameAccountID, game.isOnline, game.clientProgram) +end +-- 5, true, "BSAp" +-- nil, false, "" +``` + +**Example Usage:** +This function can be used to display detailed information about the games your Battle.net friends are currently playing. For instance, you can create an addon that lists all your friends' current activities across different Blizzard games. + +**Addons Using This API:** +- **ElvUI**: This popular UI overhaul addon uses this API to display detailed information about Battle.net friends in its social module. +- **WeakAuras**: This addon can use this API to trigger custom alerts based on the online status or game activity of Battle.net friends. \ No newline at end of file diff --git a/wiki-information/functions/BNGetInfo.md b/wiki-information/functions/BNGetInfo.md new file mode 100644 index 00000000..f50687ee --- /dev/null +++ b/wiki-information/functions/BNGetInfo.md @@ -0,0 +1,21 @@ +## Title: BNGetInfo + +**Content:** +Returns the player's own Battle.net info. +`presenceID, battleTag, toonID, currentBroadcast, bnetAFK, bnetDND, isRIDEnabled = BNGetInfo()` + +**Returns:** +- `presenceID` + - *number?* - Your presenceID - appears to be always nil in 8.1.5 +- `battleTag` + - *string* - A nickname and number that when combined, form a unique string that identifies the friend (e.g., "Nickname#0001") +- `toonID` + - *number* - Your toonID +- `currentBroadcast` + - *string* - the current text in your broadcast box +- `bnetAFK` + - *boolean* - true if you're flagged "Away" +- `bnetDND` + - *boolean* - true if you're flagged "Busy" +- `isRIDEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/BNGetNumFriendGameAccounts.md b/wiki-information/functions/BNGetNumFriendGameAccounts.md new file mode 100644 index 00000000..4c51d161 --- /dev/null +++ b/wiki-information/functions/BNGetNumFriendGameAccounts.md @@ -0,0 +1,16 @@ +## Title: BNGetNumFriendGameAccounts + +**Content:** +Returns the specified Battle.net friend's number of toons. +`numGameAccounts = BNGetNumFriendGameAccounts(friendIndex)` + +**Parameters:** +- `friendIndex` + - *number* - The Battle.net friend's index on the friends list. + +**Returns:** +- `numGameAccounts` + - *number* - The number of accounts or 0 if the friend is not online. + +**Description:** +This function returns the number of ACCOUNTS a player has that are identified with a given BattleTag ID rather than the number of characters on a given account. \ No newline at end of file diff --git a/wiki-information/functions/BNGetNumFriends.md b/wiki-information/functions/BNGetNumFriends.md new file mode 100644 index 00000000..913fd740 --- /dev/null +++ b/wiki-information/functions/BNGetNumFriends.md @@ -0,0 +1,21 @@ +## Title: BNGetNumFriends + +**Content:** +Returns the amount of (online) Battle.net friends. +`numBNetTotal, numBNetOnline, numBNetFavorite, numBNetFavoriteOnline = BNGetNumFriends()` + +**Returns:** +- `numBNetTotal` + - *number* - amount of Battle.net friends on the friends list +- `numBNetOnline` + - *number* - online Battle.net friends +- `numBNetFavorite` + - *number* - favorite battle.net friends +- `numBNetFavoriteOnline` + - *number* - favorite online battle.net friends + +**Usage:** +```lua +local total, online = BNGetNumFriends() +print("You have "..total.." Battle.net friends and "..online.." of them are online!") +``` \ No newline at end of file diff --git a/wiki-information/functions/BNSendGameData.md b/wiki-information/functions/BNSendGameData.md new file mode 100644 index 00000000..873e4dac --- /dev/null +++ b/wiki-information/functions/BNSendGameData.md @@ -0,0 +1,22 @@ +## Title: BNSendGameData + +**Content:** +Sends an addon comm message to a Battle.net friend. +`BNSendGameData(presenceID, addonPrefix, message)` + +**Parameters:** +- `presenceID` + - *number* - A unique numeric identifier for the friend during this session. -- get it with `BNGetFriendInfo()` +- `addonPrefix` + - *string* - <=16 bytes, cannot include a colon +- `message` + - *string* - <=4078 bytes + +On receive, will trigger event `BN_CHAT_MSG_ADDON` with arguments `addonPrefix`, `message`, `"WHISPER"`, `senderPresenceID`. + +**Reference:** +- `BNSendWhisper(presenceID, message)` +- `BN_CHAT_MSG_ADDON` + +**References:** +- [Battle.net Forum](http://us.battle.net/wow/en/forum/topic/11437004031) \ No newline at end of file diff --git a/wiki-information/functions/BNSendWhisper.md b/wiki-information/functions/BNSendWhisper.md new file mode 100644 index 00000000..b83739ad --- /dev/null +++ b/wiki-information/functions/BNSendWhisper.md @@ -0,0 +1,13 @@ +## Title: BNSendWhisper + +**Content:** +Sends a whisper to Battle.net friends. +`BNSendWhisper(bnetAccountID, message)` + +**Parameters:** +- `bnetAccountID` + - *number* - A unique numeric identifier for the friend during this session. You can get `bnetAccountID` from `C_BattleNet.GetFriendAccountInfo()` +- `message` + - *string* - Message text. Must be less than 4096 bytes. + +The recipient will receive a `CHAT_MSG_BN_WHISPER` event, and the sender will also get a mirrored response from the server as `CHAT_MSG_BN_WHISPER_INFORM`. \ No newline at end of file diff --git a/wiki-information/functions/BNSetAFK.md b/wiki-information/functions/BNSetAFK.md new file mode 100644 index 00000000..f181bdd1 --- /dev/null +++ b/wiki-information/functions/BNSetAFK.md @@ -0,0 +1,13 @@ +## Title: BNSetAFK + +**Content:** +Sets the player's online AFK status. +`BNSetAFK(bool)` + +**Parameters:** +- `bool` + - *boolean* - true to set your battle.net status to AFK and false to unset it. + +**Description:** +`BNSetDND(true)` can override AFK status. +`BNSetDND(false)` can't unset AFK status. \ No newline at end of file diff --git a/wiki-information/functions/BNSetCustomMessage.md b/wiki-information/functions/BNSetCustomMessage.md new file mode 100644 index 00000000..9a32cb08 --- /dev/null +++ b/wiki-information/functions/BNSetCustomMessage.md @@ -0,0 +1,24 @@ +## Title: BNSetCustomMessage + +**Content:** +Sends a broadcast message to your Real ID friends. +`BNSetCustomMessage(text)` + +**Parameters:** +- `text` + - *string* - message to be broadcasted (max 127 chars) + +**Description:** +Triggers `CHAT_MSG_BN_INLINE_TOAST_BROADCAST` (receiver) +Triggers `CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM` (sender) "Your broadcast has been sent." +See `BNGetInfo()` for the current broadcast message. + +**Usage:** +Sets your broadcast message. +```lua +BNSetCustomMessage("Hello friends!") +``` +Clears your broadcast message. +```lua +BNSetCustomMessage("") +``` \ No newline at end of file diff --git a/wiki-information/functions/BNSetDND.md b/wiki-information/functions/BNSetDND.md new file mode 100644 index 00000000..2d4f2e41 --- /dev/null +++ b/wiki-information/functions/BNSetDND.md @@ -0,0 +1,13 @@ +## Title: BNSetDND + +**Content:** +Sets the player's online DND status. +`BNSetDND(bool)` + +**Parameters:** +- `bool` + - *boolean* - true to set your battle.net status to DND and false to unset it. + +**Description:** +`BNSetAFK(true)` can override DND status. +`BNSetAFK(false)` can't unset DND status. \ No newline at end of file diff --git a/wiki-information/functions/BNSetFriendNote.md b/wiki-information/functions/BNSetFriendNote.md new file mode 100644 index 00000000..28692c37 --- /dev/null +++ b/wiki-information/functions/BNSetFriendNote.md @@ -0,0 +1,11 @@ +## Title: BNSetFriendNote + +**Content:** +Sets the Friend Note for a specific Battle.Net friend. +`BNSetFriendNote(bnetIDAccount, noteText)` + +**Parameters:** +- `bnetIDAccount` + - *number* - A unique numeric identifier for the friend's battle.net account during this session. +- `noteText` + - *string* - The text you wish to set as the battle.net friend's new note. \ No newline at end of file diff --git a/wiki-information/functions/BankButtonIDToInvSlotID.md b/wiki-information/functions/BankButtonIDToInvSlotID.md new file mode 100644 index 00000000..c93925a0 --- /dev/null +++ b/wiki-information/functions/BankButtonIDToInvSlotID.md @@ -0,0 +1,15 @@ +## Title: BankButtonIDToInvSlotID + +**Content:** +Maps a BankButtonID to InventorySlotID. +`invSlot = BankButtonIDToInvSlotID(buttonID, isBag)` + +**Parameters:** +- `buttonID` + - *number* - bank item/bag ID. +- `isBag` + - *number* - 1 if buttonID is a bag, nil otherwise. Same result as ContainerIDToInventoryID, except this one only works for bank bags and is more awkward to use. + +**Returns:** +- `invSlot` + - An inventory slot ID that can be used in other inventory functions. \ No newline at end of file diff --git a/wiki-information/functions/BeginTrade.md b/wiki-information/functions/BeginTrade.md new file mode 100644 index 00000000..e28d111d --- /dev/null +++ b/wiki-information/functions/BeginTrade.md @@ -0,0 +1,10 @@ +## Title: BeginTrade + +**Content:** +Accepts an offer to start trading with another player. +`BeginTrade()` + +**Description:** +`TRADE_REQUEST` notifies you of a pending request to trade; the name of the initiating player is provided as the first argument in the event. +You may accept a trade request using this function, or reject it using `CancelTrade`. +`TRADE_REQUEST_CANCEL` fires if the offering player rescinds the invitation to trade (or moves out of range). \ No newline at end of file diff --git a/wiki-information/functions/BreakUpLargeNumbers.md b/wiki-information/functions/BreakUpLargeNumbers.md new file mode 100644 index 00000000..ecbe820d --- /dev/null +++ b/wiki-information/functions/BreakUpLargeNumbers.md @@ -0,0 +1,30 @@ +## Title: BreakUpLargeNumbers + +**Content:** +Divides digits into groups using a localized delimiter character. +`valueString = BreakUpLargeNumbers(value)` + +**Parameters:** +- `value` + - *number* - The number to convert into a localized string + +**Returns:** +- `valueString` + - *string* - The whole-number portion converted into a string if greater than 1000, or truncated to two decimals if less than 1000. + +**Description:** +Large numbers are grouped into thousands and millions with a `LARGE_NUMBER_SEPARATOR`, but no further grouping happens for even larger numbers (billions). +Small numbers with a decimal portion are separated with a `DECIMAL_SEPARATOR` and truncated to two decimal places. +Not intended for use with negative numbers. + +**Usage:** +```lua +BreakUpLargeNumbers(123.456789) -- 123.45 +BreakUpLargeNumbers(1234567.89) -- 1,234,567 +BreakUpLargeNumbers(1234567890) -- 1,234,567,890 +``` + +**Reference:** +- `GetLocale` +- `FillLocalizedClassList` +- `FormatLargeNumber` \ No newline at end of file diff --git a/wiki-information/functions/BuyGuildCharter.md b/wiki-information/functions/BuyGuildCharter.md new file mode 100644 index 00000000..8c3ab60d --- /dev/null +++ b/wiki-information/functions/BuyGuildCharter.md @@ -0,0 +1,24 @@ +## Title: BuyGuildCharter + +**Content:** +Purchases a guild charter. +`BuyGuildCharter(guildName)` + +**Parameters:** +- `guildName` + - *string* - Name of the guild you wish to purchase a guild charter for. + +**Usage:** +The following purchases a guild charter for "MC Raiders": +```lua +BuyGuildCharter("MC Raiders"); +``` + +**Description:** +There are two preconditions to using BuyGuildCharter: +- Must be talking to a Guild Master NPC. +- Must be on the Purchase a Guild Charter screen. + +**Reference:** +- `OfferPetition` +- `TurnInGuildCharter` \ No newline at end of file diff --git a/wiki-information/functions/BuyMerchantItem.md b/wiki-information/functions/BuyMerchantItem.md new file mode 100644 index 00000000..2cd71622 --- /dev/null +++ b/wiki-information/functions/BuyMerchantItem.md @@ -0,0 +1,31 @@ +## Title: BuyMerchantItem + +**Content:** +Buys an item from a merchant. +`BuyMerchantItem(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the merchant's inventory +- `quantity` + - *number?* - Quantity to buy. + +**Description:** +If the item is sold in stacks, the quantity specifies how many stacks will be bought. +As of 4.1, the quantity argument behavior is different: +- If you do not specify quantity and the item is sold in stacks it will buy a stack. +- If you specify quantity it will buy the specified amount, sold in stacks or not. +- The only limitation is the maximum stack allowed to buy from the merchant at one time, you can check this with the `GetMerchantItemMaxStack` function. + +**Example Usage:** +```lua +-- Buy the first item in the merchant's inventory +BuyMerchantItem(1) + +-- Buy 5 stacks of the second item in the merchant's inventory +BuyMerchantItem(2, 5) +``` + +**Addons Using This Function:** +- **Auctioneer**: Uses `BuyMerchantItem` to automate the purchase of items from merchants for resale or crafting. +- **TradeSkillMaster**: Utilizes this function to streamline the process of buying materials from vendors for crafting operations. \ No newline at end of file diff --git a/wiki-information/functions/BuyStableSlot.md b/wiki-information/functions/BuyStableSlot.md new file mode 100644 index 00000000..0e76d519 --- /dev/null +++ b/wiki-information/functions/BuyStableSlot.md @@ -0,0 +1,11 @@ +## Title: BuyStableSlot + +**Content:** +Buys the next stable slot if the stable window is open and you can afford it. +`BuyStableSlot()` + +**Example Usage:** +This function can be used in macros or addons to automate the process of purchasing stable slots for hunters. For instance, a hunter might use this function in a custom addon to ensure they always have enough stable slots available for new pets. + +**Addons:** +Large addons like "PetTracker" might use this function to manage stable slots automatically, ensuring that players have a seamless experience when capturing and managing pets. \ No newline at end of file diff --git a/wiki-information/functions/BuyTrainerService.md b/wiki-information/functions/BuyTrainerService.md new file mode 100644 index 00000000..e7e3bf84 --- /dev/null +++ b/wiki-information/functions/BuyTrainerService.md @@ -0,0 +1,24 @@ +## Title: BuyTrainerService + +**Content:** +Buys a trainer service (e.g. class skills and profession recipes). +`BuyTrainerService(index)` + +**Parameters:** +- `index` + - *number* - The index of the service to train. + +**Returns:** +- `nil` + +**Example Usage:** +```lua +-- Assuming you are at a trainer and want to buy the first service available +BuyTrainerService(1) +``` + +**Description:** +This function is used to purchase a service from a trainer, such as learning a new class skill or profession recipe. The `index` parameter corresponds to the position of the service in the trainer's list. + +**Usage in Addons:** +Many addons that automate or enhance the training process, such as profession leveling addons, use this function to programmatically purchase skills or recipes from trainers. For example, an addon like "TradeSkillMaster" might use this function to help users quickly buy all available profession recipes. \ No newline at end of file diff --git a/wiki-information/functions/BuybackItem.md b/wiki-information/functions/BuybackItem.md new file mode 100644 index 00000000..86624b4c --- /dev/null +++ b/wiki-information/functions/BuybackItem.md @@ -0,0 +1,29 @@ +## Title: BuybackItem + +**Content:** +Buys back an item from the merchant. +`BuybackItem(slot)` + +**Parameters:** +- `slot` + - *number* - the slot from top-left to bottom-right of the Merchant Buyback window. + +**Description:** +Merchant Buyback +``` + (1) (2) + (3) (4) + (5) (6) + (7) (8) + (9) (10) +(11) (12) +``` + +**Example Usage:** +```lua +-- Buys back the first item in the buyback window +BuybackItem(1) +``` + +**Additional Information:** +This function is commonly used in addons that manage inventory and merchant interactions, such as "Bagnon" or "ElvUI". These addons may use `BuybackItem` to automate the process of buying back accidentally sold items. \ No newline at end of file diff --git a/wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md b/wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md new file mode 100644 index 00000000..8204ef84 --- /dev/null +++ b/wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md @@ -0,0 +1,13 @@ +## Title: C_AccountInfo.GetIDFromBattleNetAccountGUID + +**Content:** +Converts a battle.net account GUID to battle.net ID. +`battleNetAccountID = C_AccountInfo.GetIDFromBattleNetAccountGUID(battleNetAccountGUID)` + +**Parameters:** +- `battleNetAccountGUID` + - *string* : WOWGUID + +**Returns:** +- `battleNetAccountID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md b/wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md new file mode 100644 index 00000000..e5544ded --- /dev/null +++ b/wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md @@ -0,0 +1,13 @@ +## Title: C_AccountInfo.IsGUIDBattleNetAccountType + +**Content:** +Returns whether a GUID is a battle.net account type. +`isBNet = C_AccountInfo.IsGUIDBattleNetAccountType(guid)` + +**Parameters:** +- `guid` + - *string* - WOWGUID + +**Returns:** +- `isBNet` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md b/wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md new file mode 100644 index 00000000..8727c2e4 --- /dev/null +++ b/wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md @@ -0,0 +1,30 @@ +## Title: C_AccountInfo.IsGUIDRelatedToLocalAccount + +**Content:** +Returns whether a GUID is related to the local (self) account. +`isLocalUser = C_AccountInfo.IsGUIDRelatedToLocalAccount(guid)` + +**Parameters:** +- `guid` + - *string* : WOWGUID + +**Returns:** +- `isLocalUser` + - *boolean* + +**Example Usage:** +This function can be used to determine if a specific GUID (Globally Unique Identifier) belongs to the player’s own account. This can be useful in scenarios where you need to check if a certain action or event is related to the player. + +**Example:** +```lua +local guid = UnitGUID("player") +local isLocalUser = C_AccountInfo.IsGUIDRelatedToLocalAccount(guid) +if isLocalUser then + print("This GUID belongs to the local player.") +else + print("This GUID does not belong to the local player.") +end +``` + +**Addons Usage:** +Large addons like **WeakAuras** and **ElvUI** might use this function to personalize user experiences or to ensure certain functionalities are only applied to the local player. For instance, WeakAuras could use it to display specific auras or effects only for the player’s character. \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.GetRewardItemID.md b/wiki-information/functions/C_AchievementInfo.GetRewardItemID.md new file mode 100644 index 00000000..9e5e810c --- /dev/null +++ b/wiki-information/functions/C_AchievementInfo.GetRewardItemID.md @@ -0,0 +1,13 @@ +## Title: C_AchievementInfo.GetRewardItemID + +**Content:** +Returns any reward item for an achievement. +`rewardItemID = C_AchievementInfo.GetRewardItemID(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - AchievementID + +**Returns:** +- `rewardItemID` + - *number?* - The ID of the reward item, if any. \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md b/wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md new file mode 100644 index 00000000..1b587bbc --- /dev/null +++ b/wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md @@ -0,0 +1,20 @@ +## Title: C_AchievementInfo.GetSupercedingAchievements + +**Content:** +Returns the next achievement in a series. +`supercedingAchievements = C_AchievementInfo.GetSupercedingAchievements(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - AchievementID + +**Returns:** +- `supercedingAchievements` + - *number* - Only returns the next ID in a series even though it's in a table. + +**Usage:** +After Level 90 (6193) comes Level 100 (9060) +```lua +/dump C_AchievementInfo.GetSupercedingAchievements(6193) +> {9060} +``` \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.IsValidAchievement.md b/wiki-information/functions/C_AchievementInfo.IsValidAchievement.md new file mode 100644 index 00000000..b1095f47 --- /dev/null +++ b/wiki-information/functions/C_AchievementInfo.IsValidAchievement.md @@ -0,0 +1,19 @@ +## Title: C_AchievementInfo.IsValidAchievement + +**Content:** +Needs summary. +`isValidAchievement = C_AchievementInfo.IsValidAchievement(achievementId)` + +**Parameters:** +- `achievementId` + - *number* + +**Returns:** +- `isValidAchievement` + - *boolean* + +**Example Usage:** +This function can be used to check if a given achievement ID corresponds to a valid achievement in the game. This can be particularly useful for addon developers who want to validate achievement IDs before performing operations on them. + +**Addon Usage:** +Large addons like "Overachiever" use this function to ensure that the achievement IDs they are working with are valid before attempting to display or manipulate achievement data. This helps in preventing errors and improving the reliability of the addon. \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md b/wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md new file mode 100644 index 00000000..cb85b870 --- /dev/null +++ b/wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md @@ -0,0 +1,9 @@ +## Title: C_AchievementInfo.SetPortraitTexture + +**Content:** +Sets a portrait texture for the unit being achievement compared. +`C_AchievementInfo.SetPortraitTexture(textureObject)` + +**Parameters:** +- `textureObject` + - *Texture* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.FindPetActionButtons.md b/wiki-information/functions/C_ActionBar.FindPetActionButtons.md new file mode 100644 index 00000000..378b0691 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.FindPetActionButtons.md @@ -0,0 +1,26 @@ +## Title: C_ActionBar.FindPetActionButtons + +**Content:** +Needs summary. +`slots = C_ActionBar.FindPetActionButtons(petActionID)` + +**Parameters:** +- `petActionID` + - *number* + +**Returns:** +- `slots` + - *number* + +**Description:** +This function is used to find the action bar slots associated with a specific pet action. It returns the slot number where the pet action is located. + +**Example Usage:** +```lua +local petActionID = 1 -- Example pet action ID +local slot = C_ActionBar.FindPetActionButtons(petActionID) +print("Pet action is located in slot:", slot) +``` + +**Addons:** +Large addons like Bartender4 and Dominos use this function to manage and customize pet action bars, allowing players to rearrange and configure their pet abilities more effectively. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.FindSpellActionButtons.md b/wiki-information/functions/C_ActionBar.FindSpellActionButtons.md new file mode 100644 index 00000000..3b2f1d7b --- /dev/null +++ b/wiki-information/functions/C_ActionBar.FindSpellActionButtons.md @@ -0,0 +1,13 @@ +## Title: C_ActionBar.FindSpellActionButtons + +**Content:** +Needs summary. +`slots = C_ActionBar.FindSpellActionButtons(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `slots` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md b/wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md new file mode 100644 index 00000000..2ec8e228 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md @@ -0,0 +1,19 @@ +## Title: C_ActionBar.GetPetActionPetBarIndices + +**Content:** +Needs summary. +`slots = C_ActionBar.GetPetActionPetBarIndices(petActionID)` + +**Parameters:** +- `petActionID` + - *number* + +**Returns:** +- `slots` + - *number* + +**Example Usage:** +This function can be used to determine the slot indices on the pet action bar for a given pet action ID. This can be useful for addons that manage or customize pet action bars. + +**Addon Usage:** +Large addons like Bartender4, which is used for customizing action bars, might use this function to manage the pet action bar slots dynamically. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.HasPetActionButtons.md b/wiki-information/functions/C_ActionBar.HasPetActionButtons.md new file mode 100644 index 00000000..cfb5560f --- /dev/null +++ b/wiki-information/functions/C_ActionBar.HasPetActionButtons.md @@ -0,0 +1,13 @@ +## Title: C_ActionBar.HasPetActionButtons + +**Content:** +True if the pet action is currently on your action bars. +`hasPetActionButtons = C_ActionBar.HasPetActionButtons(petActionID)` + +**Parameters:** +- `petActionID` + - *number* + +**Returns:** +- `hasPetActionButtons` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md b/wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md new file mode 100644 index 00000000..b9af8d1a --- /dev/null +++ b/wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md @@ -0,0 +1,13 @@ +## Title: C_ActionBar.HasPetActionPetBarIndices + +**Content:** +Needs summary. +`hasPetActionPetBarIndices = C_ActionBar.HasPetActionPetBarIndices(petActionID)` + +**Parameters:** +- `petActionID` + - *number* + +**Returns:** +- `hasPetActionPetBarIndices` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.HasSpellActionButtons.md b/wiki-information/functions/C_ActionBar.HasSpellActionButtons.md new file mode 100644 index 00000000..1d0bc849 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.HasSpellActionButtons.md @@ -0,0 +1,13 @@ +## Title: C_ActionBar.HasSpellActionButtons + +**Content:** +Needs summary. +`hasSpellActionButtons = C_ActionBar.HasSpellActionButtons(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `hasSpellActionButtons` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md b/wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md new file mode 100644 index 00000000..fe2710a8 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md @@ -0,0 +1,13 @@ +## Title: C_ActionBar.IsAutoCastPetAction + +**Content:** +Needs summary. +`isAutoCastPetAction = C_ActionBar.IsAutoCastPetAction(slotID)` + +**Parameters:** +- `slotID` + - *number* + +**Returns:** +- `isAutoCastPetAction` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md b/wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md new file mode 100644 index 00000000..ef0f08cc --- /dev/null +++ b/wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md @@ -0,0 +1,13 @@ +## Title: C_ActionBar.IsEnabledAutoCastPetAction + +**Content:** +Needs summary. +`isEnabledAutoCastPetAction = C_ActionBar.IsEnabledAutoCastPetAction(slotID)` + +**Parameters:** +- `slotID` + - *number* + +**Returns:** +- `isEnabledAutoCastPetAction` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsHarmfulAction.md b/wiki-information/functions/C_ActionBar.IsHarmfulAction.md new file mode 100644 index 00000000..d8e32f0e --- /dev/null +++ b/wiki-information/functions/C_ActionBar.IsHarmfulAction.md @@ -0,0 +1,21 @@ +## Title: C_ActionBar.IsHarmfulAction + +**Content:** +Returns true if the specified action is a harmful one. +`isHarmful = C_ActionBar.IsHarmfulAction(actionID, useNeutral)` + +**Parameters:** +- `actionID` + - *number* +- `useNeutral` + - *boolean* + +**Returns:** +- `isHarmful` + - *boolean* + +**Example Usage:** +This function can be used to determine if an action on the action bar is harmful, which can be useful for addons that need to differentiate between harmful and beneficial actions. For example, an addon that automatically casts spells might use this function to ensure it only casts harmful spells on enemies. + +**Addon Usage:** +Large addons like Bartender4, which is a popular action bar replacement addon, might use this function to provide additional customization options for users, such as highlighting harmful actions differently from beneficial ones. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsHelpfulAction.md b/wiki-information/functions/C_ActionBar.IsHelpfulAction.md new file mode 100644 index 00000000..700f4202 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.IsHelpfulAction.md @@ -0,0 +1,21 @@ +## Title: C_ActionBar.IsHelpfulAction + +**Content:** +Returns true if the specified action is a helpful one. +`isHelpful = C_ActionBar.IsHelpfulAction(actionID, useNeutral)` + +**Parameters:** +- `actionID` + - *number* +- `useNeutral` + - *boolean* + +**Returns:** +- `isHelpful` + - *boolean* + +**Example Usage:** +This function can be used to determine if an action (such as a spell or ability) is beneficial, which can be useful for addons that manage action bars or automate certain actions based on the type of ability. + +**Addon Usage:** +Large addons like Bartender4, which is a popular action bar replacement addon, might use this function to categorize and display helpful actions differently from harmful ones. This helps in organizing the action bars more effectively based on the type of action. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md b/wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md new file mode 100644 index 00000000..3951d321 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md @@ -0,0 +1,19 @@ +## Title: C_ActionBar.IsOnBarOrSpecialBar + +**Content:** +Needs summary. +`isOnBarOrSpecialBar = C_ActionBar.IsOnBarOrSpecialBar(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `isOnBarOrSpecialBar` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific spell is present on the action bar or a special bar. This can be particularly useful for addons that manage or customize action bars, ensuring that certain spells are always accessible to the player. + +**Addons:** +Large addons like Bartender4 or Dominos, which are popular action bar replacement addons, might use this function to verify the presence of spells on the action bars they manage. This helps in maintaining consistency and ensuring that the player's key bindings and action bar setups are correctly configured. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md b/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md new file mode 100644 index 00000000..e2288367 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md @@ -0,0 +1,9 @@ +## Title: C_ActionBar.ShouldOverrideBarShowHealthBar + +**Content:** +Needs summary. +`showHealthBar = C_ActionBar.ShouldOverrideBarShowHealthBar()` + +**Returns:** +- `showHealthBar` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md b/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md new file mode 100644 index 00000000..cba24c5e --- /dev/null +++ b/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md @@ -0,0 +1,9 @@ +## Title: C_ActionBar.ShouldOverrideBarShowManaBar + +**Content:** +Needs summary. +`showManaBar = C_ActionBar.ShouldOverrideBarShowManaBar()` + +**Returns:** +- `showManaBar` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md b/wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md new file mode 100644 index 00000000..4ab0af04 --- /dev/null +++ b/wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md @@ -0,0 +1,9 @@ +## Title: C_ActionBar.ToggleAutoCastPetAction + +**Content:** +Needs summary. +`C_ActionBar.ToggleAutoCastPetAction(slotID)` + +**Parameters:** +- `slotID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.DisableAddOn.md b/wiki-information/functions/C_AddOns.DisableAddOn.md new file mode 100644 index 00000000..420dd609 --- /dev/null +++ b/wiki-information/functions/C_AddOns.DisableAddOn.md @@ -0,0 +1,25 @@ +## Title: C_AddOns.DisableAddOn + +**Content:** +Disables an addon on the next session. +`C_AddOns.DisableAddOn(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be disabled, or an index from 1 to `C_AddOns.GetNumAddOns`. Blizzard addons cannot be disabled. +- `character` + - *string?* - The name of the character, excluding the realm name. If omitted, disables the addon for all characters. + +**Usage:** +Disables an addon for all characters on the current realm. +```lua +C_AddOns.DisableAddOn("HelloWorld") +``` +Disables an addon only for the current character. +```lua +C_AddOns.DisableAddOn("HelloWorld", UnitName("player")) +``` + +**Description:** +Related API: +- `C_AddOns.EnableAddOn` \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.DisableAllAddOns.md b/wiki-information/functions/C_AddOns.DisableAllAddOns.md new file mode 100644 index 00000000..0ff30634 --- /dev/null +++ b/wiki-information/functions/C_AddOns.DisableAllAddOns.md @@ -0,0 +1,24 @@ +## Title: C_AddOns.DisableAllAddOns + +**Content:** +Disables all addons on the addon list. +`C_AddOns.DisableAllAddOns()` + +**Parameters:** +- `character` + - *string?* - The name of the character, excluding the realm name. If omitted, disables all addons for all characters. + +**Example Usage:** +```lua +-- Disable all addons for the current character +C_AddOns.DisableAllAddOns() + +-- Disable all addons for a specific character +C_AddOns.DisableAllAddOns("CharacterName") +``` + +**Description:** +This function is useful for quickly disabling all addons, either globally or for a specific character. This can be particularly helpful when troubleshooting issues caused by addon conflicts or when preparing for a clean testing environment. + +**Addons Using This Function:** +While specific large addons using this function are not commonly documented, it is often used in custom scripts and addon management tools to provide users with the ability to quickly disable all addons for troubleshooting purposes. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.DoesAddOnExist.md b/wiki-information/functions/C_AddOns.DoesAddOnExist.md new file mode 100644 index 00000000..4093b068 --- /dev/null +++ b/wiki-information/functions/C_AddOns.DoesAddOnExist.md @@ -0,0 +1,28 @@ +## Title: C_AddOns.DoesAddOnExist + +**Content:** +Needs summary. +`exists = C_AddOns.DoesAddOnExist(name)` + +**Parameters:** +- `name` + - *string|number* + +**Returns:** +- `exists` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific addon is installed and available in the game. For instance, if you want to verify if the "Deadly Boss Mods" addon is installed, you can use this function as follows: +```lua +local addonName = "Deadly Boss Mods" +local exists = C_AddOns.DoesAddOnExist(addonName) +if exists then + print(addonName .. " is installed.") +else + print(addonName .. " is not installed.") +end +``` + +**Usage in Addons:** +Many large addons, such as ElvUI, use this function to check for the presence of other addons to ensure compatibility or to provide additional functionality if certain addons are detected. For example, ElvUI might check if "WeakAuras" is installed to offer enhanced integration features. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.EnableAddOn.md b/wiki-information/functions/C_AddOns.EnableAddOn.md new file mode 100644 index 00000000..a52ee876 --- /dev/null +++ b/wiki-information/functions/C_AddOns.EnableAddOn.md @@ -0,0 +1,25 @@ +## Title: C_AddOns.EnableAddOn + +**Content:** +Enables an addon on the next session. +`C_AddOns.EnableAddOn(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be enabled, or an index from 1 to `C_AddOns.GetNumAddOns`. Blizzard addons can only be enabled by name. +- `character` + - *string?* - The name of the character, excluding the realm name. If omitted, enables the addon for all characters. + +**Usage:** +- Enables an addon for all characters on the current realm. + ```lua + C_AddOns.EnableAddOn("HelloWorld") + ``` +- Enables an addon only for the current character. + ```lua + C_AddOns.EnableAddOn("HelloWorld", UnitName("player")) + ``` + +**Description:** +Related API: +- `C_AddOns.DisableAddOn` \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.EnableAllAddOns.md b/wiki-information/functions/C_AddOns.EnableAllAddOns.md new file mode 100644 index 00000000..1aac37b8 --- /dev/null +++ b/wiki-information/functions/C_AddOns.EnableAllAddOns.md @@ -0,0 +1,9 @@ +## Title: C_AddOns.EnableAllAddOns + +**Content:** +Enables all addons on the addon list. +`C_AddOns.EnableAllAddOns()` + +**Parameters:** +- `character` + - *string?* - The name of the character, excluding the realm name. If omitted, enables all addons for all characters. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnDependencies.md b/wiki-information/functions/C_AddOns.GetAddOnDependencies.md new file mode 100644 index 00000000..e723408c --- /dev/null +++ b/wiki-information/functions/C_AddOns.GetAddOnDependencies.md @@ -0,0 +1,13 @@ +## Title: C_AddOns.GetAddOnDependencies + +**Content:** +Returns a list of TOC dependencies. +`dep1, ... = C_AddOns.GetAddOnDependencies(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. Blizzard addons can only be queried by name. + +**Returns:** +- `dep1, ...` + - *string?* - A list of addon names that are a dependency. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnEnableState.md b/wiki-information/functions/C_AddOns.GetAddOnEnableState.md new file mode 100644 index 00000000..dbeb1a60 --- /dev/null +++ b/wiki-information/functions/C_AddOns.GetAddOnEnableState.md @@ -0,0 +1,39 @@ +## Title: C_AddOns.GetAddOnEnableState + +**Content:** +Queries the enabled state of an addon, optionally for a specific character. +`state = C_AddOns.GetAddOnEnableState(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. +- `character` + - *string?* - The name of the character to check against, or omitted/nil for all characters. + +**Returns:** +- `state` + - *Enum.AddOnEnableState* - The enabled state of the addon. + - `Value` + - `Field` + - `Description` + - `0` + - `None` - Disabled + - `1` + - `Some` - Enabled for some characters; this is only possible if character is nil. + - `2` + - `All` - Enabled + +**Example Usage:** +```lua +local state = C_AddOns.GetAddOnEnableState("MyAddon") +if state == Enum.AddOnEnableState.All then + print("MyAddon is enabled for all characters.") +elseif state == Enum.AddOnEnableState.Some then + print("MyAddon is enabled for some characters.") +else + print("MyAddon is disabled.") +end +``` + +**Additional Information:** +This function is useful for addon developers who need to check if their addon is enabled for specific characters or globally. It can be particularly helpful in scenarios where different settings or behaviors are required based on the addon's enabled state. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnInfo.md b/wiki-information/functions/C_AddOns.GetAddOnInfo.md new file mode 100644 index 00000000..29660786 --- /dev/null +++ b/wiki-information/functions/C_AddOns.GetAddOnInfo.md @@ -0,0 +1,57 @@ +## Title: C_AddOns.GetAddOnInfo + +**Content:** +Needs summary. +`name, title, notes, loadable, reason, security, updateAvailable = C_AddOns.GetAddOnInfo(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to C_AddOns.GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `name` + - *string* - The name of the AddOn (the folder name). +- `title` + - *string* - The localized title of the AddOn as listed in the .toc file. +- `notes` + - *string* - The localized notes about the AddOn from its .toc file. +- `loadable` + - *boolean* - Indicates if the AddOn is loaded or eligible to be loaded, true if it is, false if it is not. +- `reason` + - *string* - The reason why the AddOn cannot be loaded. This is nil if the addon is loadable, otherwise it contains a string token indicating the reason that can be localized by prepending "ADDON_". +- `security` + - *string* - Indicates the security status of the AddOn. This is currently "INSECURE" for all user-provided addons, "SECURE_PROTECTED" for guarded Blizzard addons, and "SECURE" for all other Blizzard AddOns. +- `updateAvailable` + - *boolean* - Not currently used. + +**Description:** +A full list of all reason codes can be found below. + +**Reason Codes:** +- `CORRUPT` - Corrupt +- `DEMAND_LOADED` - Only loadable on demand +- `DEP_BANNED` - Dependency banned +- `DEP_CORRUPT` - Dependency corrupt +- `DEP_DEMAND_LOADED` - Dependency only loadable on demand +- `DEP_DISABLED` - Dependency disabled +- `DEP_EXCLUDED_FROM_BUILD` - Dependency excluded from build +- `DEP_INSECURE` - Dependency incompatible +- `DEP_INTERFACE_VERSION` - Dependency insecure +- `DEP_LOADABLE` - Dependency out of date +- `DEP_MISSING` - Dependency missing +- `DEP_NO_ACTIVE_INTERFACE` - Dependency has no active UI +- `DEP_NOT_AVAILABLE` - Dependency not available +- `DEP_USER_ADDONS_DISABLED` - Dependency user addons disabled +- `DEP_WRONG_ACTIVE_INTERFACE` - Dependency has wrong active UI +- `DEP_WRONG_GAME_TYPE` - Dependency has wrong game type +- `DEP_WRONG_LOAD_PHASE` - Dependency has wrong load phase +- `EXCLUDED_FROM_BUILD` - Excluded from build +- `INSECURE` - Insecure +- `INTERFACE_VERSION` - Out of date +- `MISSING` - Missing +- `NO_ACTIVE_INTERFACE` - No active UI +- `NOT_AVAILABLE` - Not available +- `USER_ADDONS_DISABLED` - User addons disabled +- `WRONG_ACTIVE_INTERFACE` - Wrong active UI +- `WRONG_GAME_TYPE` - Wrong game type +- `WRONG_LOAD_PHASE` - Wrong load phase \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnMetadata.md b/wiki-information/functions/C_AddOns.GetAddOnMetadata.md new file mode 100644 index 00000000..2eee4967 --- /dev/null +++ b/wiki-information/functions/C_AddOns.GetAddOnMetadata.md @@ -0,0 +1,18 @@ +## Title: C_AddOns.GetAddOnMetadata + +**Content:** +Returns the TOC metadata of an addon. +`value = C_AddOns.GetAddOnMetadata(name, variable)` + +**Parameters:** +- `name` + - *string|number* - The name or index of the addon, case insensitive. +- `variable` + - *string* - Variable name, case insensitive. May be Title, Notes, Author, Version, or anything starting with X-. + +**Returns:** +- `value` + - *string?* - The value of the variable. + +**Description:** +Unlike `GetAddOnMetadata`, this function will raise an "Invalid AddOn name" error if supplied the name of an addon that does not exist. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md b/wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md new file mode 100644 index 00000000..8f25e32a --- /dev/null +++ b/wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md @@ -0,0 +1,13 @@ +## Title: C_AddOns.GetAddOnOptionalDependencies + +**Content:** +Returns a list of optional TOC dependencies. +`dep1, ... = C_AddOns.GetAddOnOptionalDependencies(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `dep1, ...` + - *string?* - A list of addon names that are an optional dependency. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetNumAddOns.md b/wiki-information/functions/C_AddOns.GetNumAddOns.md new file mode 100644 index 00000000..2c062e04 --- /dev/null +++ b/wiki-information/functions/C_AddOns.GetNumAddOns.md @@ -0,0 +1,9 @@ +## Title: C_AddOns.GetNumAddOns + +**Content:** +Returns the number of AddOns. +`numAddOns = C_AddOns.GetNumAddOns()` + +**Returns:** +- `numAddOns` + - *number* - The number of user-installed addons. Blizzard addons are not counted. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md b/wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md new file mode 100644 index 00000000..ec5b0fff --- /dev/null +++ b/wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md @@ -0,0 +1,26 @@ +## Title: C_AddOns.IsAddOnLoadOnDemand + +**Content:** +Needs summary. +`loadOnDemand = C_AddOns.IsAddOnLoadOnDemand(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to C_AddOns.GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `loadOnDemand` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific addon is set to load on demand. This is useful for addon developers who want to manage dependencies and ensure that certain addons are only loaded when necessary. + +**Example:** +```lua +local addonName = "MyAddon" +local isLoadOnDemand = C_AddOns.IsAddOnLoadOnDemand(addonName) +print(addonName .. " is load on demand: " .. tostring(isLoadOnDemand)) +``` + +**Usage in Addons:** +Many large addons, such as WeakAuras, use this function to check the load state of their modules or dependencies to optimize performance and memory usage. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddOnLoadable.md b/wiki-information/functions/C_AddOns.IsAddOnLoadable.md new file mode 100644 index 00000000..c3f14a51 --- /dev/null +++ b/wiki-information/functions/C_AddOns.IsAddOnLoadable.md @@ -0,0 +1,19 @@ +## Title: C_AddOns.IsAddOnLoadable + +**Content:** +Needs summary. +`loadable, reason = C_AddOns.IsAddOnLoadable(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. +- `character` + - *string?* - The name of the character to check against, or omitted/nil for all characters. +- `demandLoaded` + - *boolean?* = false + +**Returns:** +- `loadable` + - *boolean* +- `reason` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddOnLoaded.md b/wiki-information/functions/C_AddOns.IsAddOnLoaded.md new file mode 100644 index 00000000..73c4e002 --- /dev/null +++ b/wiki-information/functions/C_AddOns.IsAddOnLoaded.md @@ -0,0 +1,15 @@ +## Title: C_AddOns.IsAddOnLoaded + +**Content:** +Needs summary. +`loadedOrLoading, loaded = C_AddOns.IsAddOnLoaded(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to C_AddOns.GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `loadedOrLoading` + - *boolean* +- `loaded` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md b/wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md new file mode 100644 index 00000000..6ac69a4f --- /dev/null +++ b/wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md @@ -0,0 +1,9 @@ +## Title: C_AddOns.IsAddonVersionCheckEnabled + +**Content:** +Needs summary. +`isEnabled = C_AddOns.IsAddonVersionCheckEnabled()` + +**Returns:** +- `isEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.LoadAddOn.md b/wiki-information/functions/C_AddOns.LoadAddOn.md new file mode 100644 index 00000000..34aa738c --- /dev/null +++ b/wiki-information/functions/C_AddOns.LoadAddOn.md @@ -0,0 +1,18 @@ +## Title: C_AddOns.LoadAddOn + +**Content:** +Needs summary. +`loaded, value = C_AddOns.LoadAddOn(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `loaded` + - *boolean?* - true if the addon was loaded successfully, or if it has already been loaded. +- `value` + - *string?* - Locale-independent reason why the addon could not be loaded e.g. "DISABLED", otherwise returns nil if the addon was loaded. + +**Description:** +Calling this function inside an `ADDON_LOADED` event handler may result in the named addon never receiving its own `ADDON_LOADED` event, as any new registrations for the event do not take effect until the dispatch of the first event has completed. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.SetAddonVersionCheck.md b/wiki-information/functions/C_AddOns.SetAddonVersionCheck.md new file mode 100644 index 00000000..7da470ff --- /dev/null +++ b/wiki-information/functions/C_AddOns.SetAddonVersionCheck.md @@ -0,0 +1,9 @@ +## Title: C_AddOns.SetAddonVersionCheck + +**Content:** +Needs summary. +`C_AddOns.SetAddonVersionCheck(enabled)` + +**Parameters:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md new file mode 100644 index 00000000..847a880d --- /dev/null +++ b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md @@ -0,0 +1,13 @@ +## Title: C_AreaPoiInfo.GetAreaPOIForMap + +**Content:** +Returns area points of interest for a map. +`areaPoiIDs = C_AreaPoiInfo.GetAreaPOIForMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `areaPoiIDs` + - *number* - AreaPOI \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md new file mode 100644 index 00000000..fdc220e8 --- /dev/null +++ b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md @@ -0,0 +1,53 @@ +## Title: C_AreaPoiInfo.GetAreaPOIInfo + +**Content:** +Returns info for an area point of interest (e.g. World PvP objectives). +`poiInfo = C_AreaPoiInfo.GetAreaPOIInfo(uiMapID, areaPoiID)` + +**Parameters:** +- `uiMapID` + - *number* : UiMapID +- `areaPoiID` + - *number* : AreaPOI + +**Returns:** +- `poiInfo` + - *AreaPOIInfo* - a table containing: + - `Field` + - `Type` + - `Description` + - `areaPoiID` + - *number* + - `position` + - *vector2* 🔗 + - `name` + - *string* - e.g. "Domination Point Tower" + - `description` + - *string?* - e.g. "Horde Controlled" or "Grand Master Pet Tamer" + - `textureIndex` + - *number?* + - `tooltipWidgetSet` + - *number?* - Previously widgetSetID (10.2.6) + - `iconWidgetSet` + - *number?* + - `atlasName` + - *string?* - AtlasID + - `uiTextureKit` + - *string?* : textureKit + - `shouldGlow` + - *boolean* + - `factionID` + - *number?* - Added in 10.0.2 + - `isPrimaryMapForPOI` + - *boolean* - Added in 10.0.2 + - `isAlwaysOnFlightmap` + - *boolean* - Added in 10.0.2 + - `addPaddingAboveTooltipWidgets` + - *boolean?* - Previously addPaddingAboveWidgets (10.2.6) + - `highlightWorldQuestsOnHover` + - *boolean* + - `highlightVignettesOnHover` + - *boolean* + +**Description:** +The textureIndex specifies an icon from Interface/Minimap/POIIcons. You can use `GetPOITextureCoords()` to resolve these indices to texture coordinates. \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md new file mode 100644 index 00000000..94803e78 --- /dev/null +++ b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md @@ -0,0 +1,13 @@ +## Title: C_AreaPoiInfo.GetAreaPOITimeLeft + +**Content:** +Returns the number of minutes until the POI expires. +`minutesLeft = C_AreaPoiInfo.GetAreaPOITimeLeft(areaPoiID)` + +**Parameters:** +- `areaPoiID` + - *number* - area point of interest ID. + +**Returns:** +- `minutesLeft` + - *number* - time left in minutes. \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md b/wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md new file mode 100644 index 00000000..1caf56a2 --- /dev/null +++ b/wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md @@ -0,0 +1,18 @@ +## Title: C_AreaPoiInfo.IsAreaPOITimed + +**Content:** +Returns whether an area poi is timed. +`isTimed, hideTimerInTooltip = C_AreaPoiInfo.IsAreaPOITimed(areaPoiID)` + +**Parameters:** +- `areaPoiID` + - *number* + +**Returns:** +- `isTimed` + - *boolean* +- `hideTimerInTooltip` + - *boolean?* + +**Description:** +This statically determines if the POI is timed, `GetAreaPOITimeLeft` retrieves the value from the server and may return nothing for long intervals. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md b/wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md new file mode 100644 index 00000000..e8c70eaf --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md @@ -0,0 +1,18 @@ +## Title: C_AzeriteEmpoweredItem.CanSelectPower + +**Content:** +Needs summary. +`canSelect = C_AzeriteEmpoweredItem.CanSelectPower(azeriteEmpoweredItemLocation, powerID)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* +- `powerID` + - *number* + +**Returns:** +- `canSelect` + - *boolean* + +**Example Usage:** +This function can be used to determine if a specific Azerite power can be selected for an Azerite item. This is useful in addons that manage Azerite gear and powers, such as AzeritePowerWeights, which helps players choose the best Azerite traits for their gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md b/wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md new file mode 100644 index 00000000..7c32ea8d --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md @@ -0,0 +1,17 @@ +## Title: C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec + +**Content:** +Needs summary. +`C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec()` + +**Description:** +This function is used to close the Azerite Empowered Item Respec interface. This is typically used after a player has finished respeccing their Azerite traits and wants to close the UI. + +**Example Usage:** +```lua +-- Example of closing the Azerite Empowered Item Respec interface +C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec() +``` + +**Usage in Addons:** +Large addons like AzeritePowerWeights use this function to manage the Azerite Empowered Item Respec interface, ensuring that the UI is properly closed after the player has made their selections. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md b/wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md new file mode 100644 index 00000000..3aba579f --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec + +**Content:** +Needs summary. +`C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec(azeriteEmpoweredItemLocation)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md new file mode 100644 index 00000000..37b09828 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md @@ -0,0 +1,37 @@ +## Title: C_AzeriteEmpoweredItem.GetAllTierInfo + +**Content:** +Needs summary. +```lua +tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfo(azeriteEmpoweredItemLocation) +tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfoByItemID(itemInfo) +``` + +**Parameters:** + +*GetAllTierInfo:* +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* + +*GetAllTierInfoByItemID:* +- `itemInfo` + - *number|string* - Item ID, Link or Name +- `classID` + - *number?* - Specify a class ID to get tier information about that class, otherwise uses the player's class if left nil + +**Returns:** +- `tierInfo` + - *structure* - AzeriteEmpoweredItemTierInfo + - `Field` + - `Type` + - `Description` + - `azeritePowerIDs` + - *number* + - `unlockLevel` + - *number* + +**Example Usage:** +This function can be used to retrieve information about all the tiers of Azerite powers available for a given Azerite item. This is particularly useful for addons that need to display or process Azerite power information. + +**Addon Usage:** +Large addons like AzeritePowerWeights use this function to calculate and display the optimal Azerite traits for players based on their class and spec. This helps players make informed decisions about which Azerite traits to select for their gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md new file mode 100644 index 00000000..04c5ae6a --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md @@ -0,0 +1,31 @@ +## Title: C_AzeriteEmpoweredItem.GetAllTierInfo + +**Content:** +Needs summary. +```lua +tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfo(azeriteEmpoweredItemLocation) +tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfoByItemID(itemInfo) +``` + +**Parameters:** + +*GetAllTierInfo:* +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* + +*GetAllTierInfoByItemID:* +- `itemInfo` + - *number|string* - Item ID, Link, or Name +- `classID` + - *number?* - Specify a class ID to get tier information about that class, otherwise uses the player's class if left nil + +**Returns:** +- `tierInfo` + - *structure* - AzeriteEmpoweredItemTierInfo + - `Field` + - `Type` + - `Description` + - `azeritePowerIDs` + - *number* + - `unlockLevel` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md new file mode 100644 index 00000000..0e5672b8 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost + +**Content:** +Needs summary. +`cost = C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost()` + +**Returns:** +- `cost` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md new file mode 100644 index 00000000..f5300b2a --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md @@ -0,0 +1,20 @@ +## Title: C_AzeriteEmpoweredItem.GetPowerInfo + +**Content:** +Needs summary. +`powerInfo = C_AzeriteEmpoweredItem.GetPowerInfo(powerID)` + +**Parameters:** +- `powerID` + - *number* + +**Returns:** +- `powerInfo` + - *structure* - AzeriteEmpoweredItemPowerInfo + - `Field` + - `Type` + - `Description` + - `azeritePowerID` + - *number* + - `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md new file mode 100644 index 00000000..6761bc88 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md @@ -0,0 +1,33 @@ +## Title: C_AzeriteEmpoweredItem.GetPowerText + +**Content:** +Needs summary. +`powerText = C_AzeriteEmpoweredItem.GetPowerText(azeriteEmpoweredItemLocation, powerID, level)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* +- `powerID` + - *number* +- `level` + - *Enum.AzeritePowerLevel* + - `Value` + - `Field` + - `Description` + - `0` + - Base + - `1` + - Upgraded + - `2` + - Downgraded + +**Returns:** +- `powerText` + - *structure* - AzeriteEmpoweredItemPowerText + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `description` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md new file mode 100644 index 00000000..25edba3d --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md @@ -0,0 +1,20 @@ +## Title: C_AzeriteEmpoweredItem.GetSpecsForPower + +**Content:** +Needs summary. +`specInfo = C_AzeriteEmpoweredItem.GetSpecsForPower(powerID)` + +**Parameters:** +- `powerID` + - *number* + +**Returns:** +- `specInfo` + - *structure* - AzeriteSpecInfo + - `Field` + - `Type` + - `Description` + - `classID` + - *number* + - `specID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md b/wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md new file mode 100644 index 00000000..aee2e63c --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md @@ -0,0 +1,19 @@ +## Title: C_AzeriteEmpoweredItem.HasAnyUnselectedPowers + +**Content:** +Needs summary. +`hasAnyUnselectedPowers = C_AzeriteEmpoweredItem.HasAnyUnselectedPowers(azeriteEmpoweredItemLocation)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* + +**Returns:** +- `hasAnyUnselectedPowers` + - *boolean* + +**Example Usage:** +This function can be used to check if an Azerite item has any unselected powers. This is useful for addons that manage gear and want to alert the player if they have unselected Azerite powers. + +**Addon Usage:** +- **WeakAuras**: This popular addon could use this function to create alerts for players, reminding them to select Azerite powers on newly acquired gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md b/wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md new file mode 100644 index 00000000..cf5f0bb7 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md @@ -0,0 +1,19 @@ +## Title: C_AzeriteEmpoweredItem.HasBeenViewed + +**Content:** +Needs summary. +`hasBeenViewed = C_AzeriteEmpoweredItem.HasBeenViewed(azeriteEmpoweredItemLocation)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* + +**Returns:** +- `hasBeenViewed` + - *boolean* + +**Example Usage:** +This function can be used to check if an Azerite Empowered Item has been viewed by the player. This can be useful in addons that track player interactions with Azerite gear, such as ensuring that players are aware of new traits available for selection. + +**Addon Usage:** +Large addons like WeakAuras might use this function to create alerts or notifications for players to view their Azerite Empowered Items and select new traits. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md new file mode 100644 index 00000000..55096a8c --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md @@ -0,0 +1,25 @@ +## Title: C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem + +**Content:** +Needs summary. +`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem(itemLocation)` +`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID(itemInfo)` + +**Parameters:** +- **IsAzeriteEmpoweredItem:** + - `itemLocation` + - *ItemLocationMixin* + +- **IsAzeriteEmpoweredItemByID:** + - `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `isAzeriteEmpoweredItem` + - *boolean* + +**Example Usage:** +This function can be used to check if a given item is an Azerite Empowered Item, which is useful for addons that manage gear sets or provide additional information about items in the player's inventory. + +**Addon Usage:** +Large addons like **Pawn** and **AzeritePowerWeights** use this function to determine if an item is an Azerite Empowered Item and to provide recommendations or weights for the best Azerite traits to choose. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md new file mode 100644 index 00000000..2fc7191f --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md @@ -0,0 +1,25 @@ +## Title: C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem + +**Content:** +Needs summary. +`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem(itemLocation)` +`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID(itemInfo)` + +**Parameters:** +- **IsAzeriteEmpoweredItem:** + - `itemLocation` + - *ItemLocationMixin* + +- **IsAzeriteEmpoweredItemByID:** + - `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `isAzeriteEmpoweredItem` + - *boolean* + +**Example Usage:** +This function can be used to determine if a given item is an Azerite Empowered Item, which is useful for addons that manage gear sets or provide additional information about items in the player's inventory. + +**Addon Usage:** +Large addons like **Pawn** and **AzeritePowerWeights** use this function to evaluate and suggest the best Azerite traits for players based on their current gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md new file mode 100644 index 00000000..293b47f6 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md @@ -0,0 +1,15 @@ +## Title: C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable + +**Content:** +Needs summary. +`isAzeritePreviewSourceDisplayable = C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable(itemInfo)` + +**Parameters:** +- `itemInfo` + - *string* +- `classID` + - *number?* - Specify a class ID to determine if it's displayable for that class, otherwise uses the player's class if left nil. + +**Returns:** +- `isAzeritePreviewSourceDisplayable` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md new file mode 100644 index 00000000..d347c525 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md @@ -0,0 +1,15 @@ +## Title: C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped + +**Content:** +Needs summary. +`isHeartOfAzerothEquipped = C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped()` + +**Returns:** +- `isHeartOfAzerothEquipped` + - *boolean* + +**Example Usage:** +This function can be used to check if the player has the Heart of Azeroth equipped, which is essential for accessing Azerite traits in Battle for Azeroth content. + +**Addon Usage:** +Large addons like WeakAuras might use this function to create custom alerts or notifications for players, ensuring they have the Heart of Azeroth equipped when entering specific content or engaging in certain activities. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md new file mode 100644 index 00000000..ac541f6e --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md @@ -0,0 +1,15 @@ +## Title: C_AzeriteEmpoweredItem.IsPowerAvailableForSpec + +**Content:** +Needs summary. +`isPowerAvailableForSpec = C_AzeriteEmpoweredItem.IsPowerAvailableForSpec(powerID, specID)` + +**Parameters:** +- `powerID` + - *number* +- `specID` + - *number* + +**Returns:** +- `isPowerAvailableForSpec` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md new file mode 100644 index 00000000..476670cd --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md @@ -0,0 +1,15 @@ +## Title: C_AzeriteEmpoweredItem.IsPowerSelected + +**Content:** +Needs summary. +`isSelected = C_AzeriteEmpoweredItem.IsPowerSelected(azeriteEmpoweredItemLocation, powerID)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* +- `powerID` + - *number* + +**Returns:** +- `isSelected` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md b/wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md new file mode 100644 index 00000000..cef4445f --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md @@ -0,0 +1,21 @@ +## Title: C_AzeriteEmpoweredItem.SelectPower + +**Content:** +Needs summary. +`success = C_AzeriteEmpoweredItem.SelectPower(azeriteEmpoweredItemLocation, powerID)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* +- `powerID` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Example Usage:** +This function can be used to select a specific Azerite power for an Azerite item. For instance, if you have an Azerite item and you want to programmatically select a power based on certain conditions, you can use this function to do so. + +**Addon Usage:** +Large addons like AzeritePowerWeights use this function to allow players to automatically select the best Azerite powers based on predefined weights and criteria. This helps in optimizing the character's performance without manually selecting each power. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md b/wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md new file mode 100644 index 00000000..184f0d6e --- /dev/null +++ b/wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEmpoweredItem.SetHasBeenViewed + +**Content:** +Needs summary. +`C_AzeriteEmpoweredItem.SetHasBeenViewed(azeriteEmpoweredItemLocation)` + +**Parameters:** +- `azeriteEmpoweredItemLocation` + - *ItemLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.ActivateEssence.md b/wiki-information/functions/C_AzeriteEssence.ActivateEssence.md new file mode 100644 index 00000000..b8888359 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.ActivateEssence.md @@ -0,0 +1,11 @@ +## Title: C_AzeriteEssence.ActivateEssence + +**Content:** +Needs summary. +`C_AzeriteEssence.ActivateEssence(essenceID, milestoneID)` + +**Parameters:** +- `essenceID` + - *number* +- `milestoneID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md b/wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md new file mode 100644 index 00000000..eab07a1d --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md @@ -0,0 +1,21 @@ +## Title: C_AzeriteEssence.CanActivateEssence + +**Content:** +Needs summary. +`canActivate = C_AzeriteEssence.CanActivateEssence(essenceID, milestoneID)` + +**Parameters:** +- `essenceID` + - *number* +- `milestoneID` + - *number* + +**Returns:** +- `canActivate` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific Azerite Essence can be activated at a given milestone. This is particularly useful in addons that manage Azerite Essences, such as those that provide recommendations or automate certain aspects of essence management. + +**Addon Usage:** +Large addons like WeakAuras might use this function to create custom alerts or notifications when an essence can be activated, enhancing the player's gameplay experience by providing timely and relevant information. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md b/wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md new file mode 100644 index 00000000..a4dc6371 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md @@ -0,0 +1,19 @@ +## Title: C_AzeriteEssence.CanDeactivateEssence + +**Content:** +Needs summary. +`canDeactivate = C_AzeriteEssence.CanDeactivateEssence(milestoneID)` + +**Parameters:** +- `milestoneID` + - *number* + +**Returns:** +- `canDeactivate` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific Azerite Essence can be deactivated at a given milestone. This is useful in addons that manage Azerite Essences, allowing players to dynamically change their essences based on the content they are engaging with. + +**Addon Usage:** +Large addons like AzeritePowerWeights use this function to provide players with recommendations on which essences to activate or deactivate based on their current gear and the content they are participating in. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CanOpenUI.md b/wiki-information/functions/C_AzeriteEssence.CanOpenUI.md new file mode 100644 index 00000000..c5556999 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.CanOpenUI.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.CanOpenUI + +**Content:** +Needs summary. +`canOpen = C_AzeriteEssence.CanOpenUI()` + +**Returns:** +- `canOpen` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md new file mode 100644 index 00000000..7df85328 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md @@ -0,0 +1,17 @@ +## Title: C_AzeriteEssence.ClearPendingActivationEssence + +**Content:** +Needs summary. +`C_AzeriteEssence.ClearPendingActivationEssence()` + +**Description:** +This function is used to clear any pending Azerite Essence activation. This can be useful in scenarios where a player has selected an Azerite Essence to activate but decides to cancel the activation before it is finalized. + +**Example Usage:** +```lua +-- Clear any pending Azerite Essence activation +C_AzeriteEssence.ClearPendingActivationEssence() +``` + +**Additional Information:** +This function is part of the Azerite Essence system introduced in Battle for Azeroth. It is used to manage the activation of Azerite Essences, which are powerful abilities that can be slotted into the Heart of Azeroth. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CloseForge.md b/wiki-information/functions/C_AzeriteEssence.CloseForge.md new file mode 100644 index 00000000..c276366b --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.CloseForge.md @@ -0,0 +1,11 @@ +## Title: C_AzeriteEssence.CloseForge + +**Content:** +Needs summary. +`C_AzeriteEssence.CloseForge()` + +**Example Usage:** +This function can be used to close the Azerite Essence Forge UI in World of Warcraft. This is particularly useful in addons that manage Azerite Essences and need to programmatically close the forge interface. + +**Addons Using This Function:** +- **AzeritePowerWeights**: This addon uses `C_AzeriteEssence.CloseForge` to ensure the Azerite Essence Forge UI is closed after the user has finished configuring their essences, providing a smoother user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md b/wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md new file mode 100644 index 00000000..9fca31fb --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md @@ -0,0 +1,15 @@ +## Title: C_AzeriteEssence.GetEssenceHyperlink + +**Content:** +Needs summary. +`link = C_AzeriteEssence.GetEssenceHyperlink(essenceID, rank)` + +**Parameters:** +- `essenceID` + - *number* +- `rank` + - *number* + +**Returns:** +- `link` + - *string* - azessenceLink \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md b/wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md new file mode 100644 index 00000000..43e84d56 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md @@ -0,0 +1,29 @@ +## Title: C_AzeriteEssence.GetEssenceInfo + +**Content:** +Needs summary. +`info = C_AzeriteEssence.GetEssenceInfo(essenceID)` + +**Parameters:** +- `essenceID` + - *number* : AzeriteEssence.db2 + +**Returns:** +- `info` + - *structure* - AzeriteEssenceInfo + - `AzeriteEssenceInfo` + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `name` + - *string* + - `rank` + - *number* + - `unlocked` + - *boolean* + - `valid` + - *boolean* + - `icon` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetEssences.md b/wiki-information/functions/C_AzeriteEssence.GetEssences.md new file mode 100644 index 00000000..40b6f87d --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetEssences.md @@ -0,0 +1,31 @@ +## Title: C_AzeriteEssence.GetEssences + +**Content:** +Needs summary. +`essences = C_AzeriteEssence.GetEssences()` + +**Returns:** +- `essences` + - *structure* - AzeriteEssenceInfo + - `AzeriteEssenceInfo` + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `name` + - *string* + - `rank` + - *number* + - `unlocked` + - *boolean* + - `valid` + - *boolean* + - `icon` + - *number* + +**Example Usage:** +This function can be used to retrieve information about all the Azerite Essences a player has. For instance, an addon could use this to display a list of all available essences along with their ranks and icons. + +**Addons:** +Many popular addons like WeakAuras and AzeritePowerWeights use this function to provide players with detailed information about their Azerite Essences, helping them make informed decisions about which essences to equip. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md b/wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md new file mode 100644 index 00000000..fbff8acc --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md @@ -0,0 +1,19 @@ +## Title: C_AzeriteEssence.GetMilestoneEssence + +**Content:** +Needs summary. +`essenceID = C_AzeriteEssence.GetMilestoneEssence(milestoneID)` + +**Parameters:** +- `milestoneID` + - *number* + +**Returns:** +- `essenceID` + - *number* + +**Example Usage:** +This function can be used to retrieve the essence ID associated with a specific Azerite milestone. For instance, if you want to check which essence is slotted into a particular milestone, you can use this function to get the essence ID and then use other functions to get more details about the essence. + +**Addon Usage:** +Large addons like WeakAuras might use this function to display or track the essences slotted into Azerite milestones, allowing players to create custom alerts or displays based on their current essences. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md b/wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md new file mode 100644 index 00000000..4b496270 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md @@ -0,0 +1,41 @@ +## Title: C_AzeriteEssence.GetMilestoneInfo + +**Content:** +Needs summary. +`info = C_AzeriteEssence.GetMilestoneInfo(milestoneID)` + +**Parameters:** +- `milestoneID` + - *number* + +**Returns:** +- `info` + - *structure* - AzeriteMilestoneInfo + - `AzeriteMilestoneInfo` + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `requiredLevel` + - *number* + - `canUnlock` + - *boolean* + - `unlocked` + - *boolean* + - `rank` + - *number?* (Added in 8.3.0) + - `slot` + - *Enum.AzeriteEssenceSlot?* + - `Enum.AzeriteEssenceSlot` + - `Value` + - `Field` + - `Description` + - `0` + - MainSlot + - `1` + - PassiveOneSlot + - `2` + - PassiveTwoSlot + - `3` + - PassiveThreeSlot (Added in 8.3.0) \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md b/wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md new file mode 100644 index 00000000..45361f7c --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md @@ -0,0 +1,13 @@ +## Title: C_AzeriteEssence.GetMilestoneSpell + +**Content:** +Needs summary. +`spellID = C_AzeriteEssence.GetMilestoneSpell(milestoneID)` + +**Parameters:** +- `milestoneID` + - *number* + +**Returns:** +- `spellID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestones.md b/wiki-information/functions/C_AzeriteEssence.GetMilestones.md new file mode 100644 index 00000000..518e559d --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetMilestones.md @@ -0,0 +1,37 @@ +## Title: C_AzeriteEssence.GetMilestones + +**Content:** +Needs summary. +`milestones = C_AzeriteEssence.GetMilestones()` + +**Returns:** +- `milestones` + - *structure* - AzeriteMilestoneInfo + - `AzeriteMilestoneInfo` + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `requiredLevel` + - *number* + - `canUnlock` + - *boolean* + - `unlocked` + - *boolean* + - `rank` + - *number?* - Added in 8.3.0 + - `slot` + - *Enum.AzeriteEssenceSlot?* + - `Enum.AzeriteEssenceSlot` + - `Value` + - `Field` + - `Description` + - `0` + - MainSlot + - `1` + - PassiveOneSlot + - `2` + - PassiveTwoSlot + - `3` + - PassiveThreeSlot - Added in 8.3.0 \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md b/wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md new file mode 100644 index 00000000..422ccf58 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.GetNumUnlockedEssences + +**Content:** +Needs summary. +`numUnlockedEssences = C_AzeriteEssence.GetNumUnlockedEssences()` + +**Returns:** +- `numUnlockedEssences` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md b/wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md new file mode 100644 index 00000000..76185886 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.GetNumUsableEssences + +**Content:** +Needs summary. +`numUsableEssences = C_AzeriteEssence.GetNumUsableEssences()` + +**Returns:** +- `numUsableEssences` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md new file mode 100644 index 00000000..e85d4afd --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.GetPendingActivationEssence + +**Content:** +Needs summary. +`essenceID = C_AzeriteEssence.GetPendingActivationEssence()` + +**Returns:** +- `essenceID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md b/wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md new file mode 100644 index 00000000..97a5364c --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.HasNeverActivatedAnyEssences + +**Content:** +Needs summary. +`hasNeverActivatedAnyEssences = C_AzeriteEssence.HasNeverActivatedAnyEssences()` + +**Returns:** +- `hasNeverActivatedAnyEssences` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md new file mode 100644 index 00000000..22cfa0b1 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.HasPendingActivationEssence + +**Content:** +Needs summary. +`hasEssence = C_AzeriteEssence.HasPendingActivationEssence()` + +**Returns:** +- `hasEssence` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.IsAtForge.md b/wiki-information/functions/C_AzeriteEssence.IsAtForge.md new file mode 100644 index 00000000..b638f40b --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.IsAtForge.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.IsAtForge + +**Content:** +Needs summary. +`isAtForge = C_AzeriteEssence.IsAtForge()` + +**Returns:** +- `isAtForge` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md new file mode 100644 index 00000000..72960acf --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.SetPendingActivationEssence + +**Content:** +Needs summary. +`C_AzeriteEssence.SetPendingActivationEssence(essenceID)` + +**Parameters:** +- `essenceID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md b/wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md new file mode 100644 index 00000000..e0f186d9 --- /dev/null +++ b/wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteEssence.UnlockMilestone + +**Content:** +Needs summary. +`C_AzeriteEssence.UnlockMilestone(milestoneID)` + +**Parameters:** +- `milestoneID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md b/wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md new file mode 100644 index 00000000..805fda6c --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteItem.FindActiveAzeriteItem + +**Content:** +Returns an `ItemLocationMixin` describing the location of the active Azerite item. +`activeAzeriteItemLocation = C_AzeriteItem.FindActiveAzeriteItem()` + +**Returns:** +- `activeAzeriteItemLocation` + - `ItemLocationMixin` - Describes the location of the active Azerite item. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md b/wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md new file mode 100644 index 00000000..784de9fb --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md @@ -0,0 +1,15 @@ +## Title: C_AzeriteItem.GetAzeriteItemXPInfo + +**Content:** +Needs summary. +`xp, totalLevelXP = C_AzeriteItem.GetAzeriteItemXPInfo(azeriteItemLocation)` + +**Parameters:** +- `azeriteItemLocation` + - *ItemLocationMixin* + +**Returns:** +- `xp` + - *number* +- `totalLevelXP` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.GetPowerLevel.md b/wiki-information/functions/C_AzeriteItem.GetPowerLevel.md new file mode 100644 index 00000000..31ebcb65 --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.GetPowerLevel.md @@ -0,0 +1,27 @@ +## Title: C_AzeriteItem.GetPowerLevel + +**Content:** +Needs summary. +`powerLevel = C_AzeriteItem.GetPowerLevel(azeriteItemLocation)` + +**Parameters:** +- `azeriteItemLocation` + - *ItemLocationMixin* 🔗 + +**Returns:** +- `powerLevel` + - *number* + +**Description:** +This function retrieves the power level of an Azerite item at a specified location. The power level indicates the current level of Azerite power that has been unlocked for the item. + +**Example Usage:** +```lua +local azeriteItemLocation = ItemLocation:CreateFromBagAndSlot(bagID, slotID) +local powerLevel = C_AzeriteItem.GetPowerLevel(azeriteItemLocation) +print("Azerite Power Level: ", powerLevel) +``` + +**Addons Using This Function:** +- **WeakAuras**: Utilizes this function to display the power level of Azerite items in custom auras and notifications. +- **Pawn**: Uses this function to calculate and suggest upgrades for Azerite gear based on the power level. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md b/wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md new file mode 100644 index 00000000..7ab33cb0 --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md @@ -0,0 +1,19 @@ +## Title: C_AzeriteItem.GetUnlimitedPowerLevel + +**Content:** +Needs summary. +`powerLevel = C_AzeriteItem.GetUnlimitedPowerLevel(azeriteItemLocation)` + +**Parameters:** +- `azeriteItemLocation` + - *ItemLocationMixin* + +**Returns:** +- `powerLevel` + - *number* + +**Example Usage:** +This function can be used to retrieve the unlimited power level of an Azerite item, which can be useful for addons that track or display Azerite item information. + +**Addon Usage:** +Large addons like AzeritePowerWeights use this function to determine the power level of Azerite items to help players optimize their gear choices. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md b/wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md new file mode 100644 index 00000000..0c689cd8 --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteItem.HasActiveAzeriteItem + +**Content:** +Returns true if the is either equipped or in the player's (non-bank) bags. +`hasActiveAzeriteItem = C_AzeriteItem.HasActiveAzeriteItem()` + +**Returns:** +- `hasActiveAzeriteItem` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md new file mode 100644 index 00000000..e5f2e35d --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md @@ -0,0 +1,20 @@ +## Title: C_AzeriteItem.IsAzeriteItem + +**Content:** +Needs summary. +`isAzeriteItem = C_AzeriteItem.IsAzeriteItem(itemLocation)` +`isAzeriteItem = C_AzeriteItem.IsAzeriteItemByID(itemInfo)` + +**Parameters:** + +*IsAzeriteItem:* +- `itemLocation` + - *ItemLocationMixin* + +*IsAzeriteItemByID:* +- `itemInfo` + - *number|string* - Item ID, Link or Name + +**Returns:** +- `isAzeriteItem` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md new file mode 100644 index 00000000..8cd92a32 --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteItem.IsAzeriteItemAtMaxLevel + +**Content:** +Needs summary. +`isAtMax = C_AzeriteItem.IsAzeriteItemAtMaxLevel()` + +**Returns:** +- `isAtMax` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md new file mode 100644 index 00000000..82b98d08 --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md @@ -0,0 +1,20 @@ +## Title: C_AzeriteItem.IsAzeriteItem + +**Content:** +Needs summary. +`isAzeriteItem = C_AzeriteItem.IsAzeriteItem(itemLocation)` +`isAzeriteItem = C_AzeriteItem.IsAzeriteItemByID(itemInfo)` + +**Parameters:** + +*IsAzeriteItem:* +- `itemLocation` + - *ItemLocationMixin* + +*IsAzeriteItemByID:* +- `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `isAzeriteItem` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md new file mode 100644 index 00000000..d9172e23 --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md @@ -0,0 +1,13 @@ +## Title: C_AzeriteItem.IsAzeriteItemEnabled + +**Content:** +Needs summary. +`isEnabled = C_AzeriteItem.IsAzeriteItemEnabled(azeriteItemLocation)` + +**Parameters:** +- `azeriteItemLocation` + - *ItemLocationMixin* + +**Returns:** +- `isEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md b/wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md new file mode 100644 index 00000000..3ec21b90 --- /dev/null +++ b/wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md @@ -0,0 +1,9 @@ +## Title: C_AzeriteItem.IsUnlimitedLevelingUnlocked + +**Content:** +Needs summary. +`isUnlimitedLevelingUnlocked = C_AzeriteItem.IsUnlimitedLevelingUnlocked()` + +**Returns:** +- `isUnlimitedLevelingUnlocked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md b/wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md new file mode 100644 index 00000000..56486658 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.ApplyCustomizationChoices + +**Content:** +Submits chosen barber shop customizations to the server for application. +`success = C_BarberShop.ApplyCustomizationChoices()` + +**Returns:** +- `success` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.Cancel.md b/wiki-information/functions/C_BarberShop.Cancel.md new file mode 100644 index 00000000..cfe7a619 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.Cancel.md @@ -0,0 +1,11 @@ +## Title: C_BarberShop.Cancel + +**Content:** +Dismisses the barber shop UI, cancelling all customizations. +`C_BarberShop.Cancel()` + +**Example Usage:** +This function can be used in an addon that provides a custom interface for character customization, allowing users to cancel their changes and exit the barber shop UI programmatically. + +**Addons Using This Function:** +Large addons like "ElvUI" or "WeakAuras" might use this function to provide enhanced user experiences by integrating barber shop functionalities into their custom UI elements. For instance, an addon could provide a button to quickly exit the barber shop without saving changes. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ClearPreviewChoices.md b/wiki-information/functions/C_BarberShop.ClearPreviewChoices.md new file mode 100644 index 00000000..017d3895 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.ClearPreviewChoices.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.ClearPreviewChoices + +**Content:** +Clears all actively previewed customization choices on the character. +`C_BarberShop.ClearPreviewChoices()` + +**Parameters:** +- `clearSavedChoices` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md b/wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md new file mode 100644 index 00000000..c9ffb3b8 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md @@ -0,0 +1,95 @@ +## Title: C_BarberShop.GetAvailableCustomizations + +**Content:** +Needs summary. +`categories = C_BarberShop.GetAvailableCustomizations()` + +**Returns:** +- `categories` + - *CharCustomizationCategory* + - `Field` + - `Type` + - `Description` + - `id` + - *number* + - `orderIndex` + - *number* + - `name` + - *string* + - `icon` + - *string : textureAtlas* + - `selectedIcon` + - *string : textureAtlas* + - `undressModel` + - *boolean* + - `subcategory` + - *boolean* + - `cameraZoomLevel` + - *number* + - `cameraDistanceOffset` + - *number* + - `spellShapeshiftFormID` + - *number?* + - `chrModelID` + - *number?* + - `options` + - *CharCustomizationOption* + - `hasNewChoices` + - *boolean* + - `needsNativeFormCategory` + - *boolean* + +- `CharCustomizationOption` + - `Field` + - `Type` + - `Description` + - `id` + - *number* + - `name` + - *string* + - `orderIndex` + - *number* + - `optionType` + - *Enum.ChrCustomizationOptionType* + - `choices` + - *CharCustomizationChoice* + - `currentChoiceIndex` + - *number?* + - `hasNewChoices` + - *boolean* + - `isSound` + - *boolean* + +- `Enum.ChrCustomizationOptionType` + - `Value` + - `Field` + - `Description` + - `0` + - *SelectionPopout* + - `1` + - *Checkbox* + - `2` + - *Slider* + +- `CharCustomizationChoice` + - `Field` + - `Type` + - `Description` + - `id` + - *number* + - `name` + - *string* + - `ineligibleChoice` + - *boolean* + - `isNew` + - *boolean* + - `swatchColor1` + - *colorRGB?* + - `swatchColor2` + - *colorRGB?* + - `soundKit` + - *number?* + - `isLocked` + - *boolean* + - `lockedText` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md b/wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md new file mode 100644 index 00000000..d092d215 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.GetCurrentCameraZoom + +**Content:** +Returns the current camera zoom level. +`zoomLevel = C_BarberShop.GetCurrentCameraZoom()` + +**Returns:** +- `zoomLevel` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md b/wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md new file mode 100644 index 00000000..34be0468 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md @@ -0,0 +1,50 @@ +## Title: C_BarberShop.GetCurrentCharacterData + +**Content:** +Needs summary. +`characterData = C_BarberShop.GetCurrentCharacterData()` + +**Returns:** +- `characterData` + - *PlayerInfoCharacterData* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `fileName` + - *string* + - `alternateFormRaceData` + - *CharacterAlternateFormData?* + - `createScreenIconAtlas` + - *string* + - `sex` + - *Enum.UnitSex* + +**CharacterAlternateFormData:** +- `Field` +- `Type` +- `Description` +- `raceID` + - *number* +- `name` + - *string* +- `fileName` + - *string* +- `createScreenIconAtlas` + - *string* + +**Enum.UnitSex:** +- `Value` +- `Field` +- `Description` +- `0` + - Male +- `1` + - Female +- `2` + - None +- `3` + - Both +- `4` + - Neutral \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetCurrentCost.md b/wiki-information/functions/C_BarberShop.GetCurrentCost.md new file mode 100644 index 00000000..b4bb0ca1 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.GetCurrentCost.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.GetCurrentCost + +**Content:** +Returns the cost of the currently selected customizations. +`cost = C_BarberShop.GetCurrentCost()` + +**Returns:** +- `cost` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetViewingChrModel.md b/wiki-information/functions/C_BarberShop.GetViewingChrModel.md new file mode 100644 index 00000000..fd6a45da --- /dev/null +++ b/wiki-information/functions/C_BarberShop.GetViewingChrModel.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.GetViewingChrModel + +**Content:** +Needs summary. +`chrModelID = C_BarberShop.GetViewingChrModel()` + +**Returns:** +- `chrModelID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.HasAnyChanges.md b/wiki-information/functions/C_BarberShop.HasAnyChanges.md new file mode 100644 index 00000000..23aac205 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.HasAnyChanges.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.HasAnyChanges + +**Content:** +Needs summary. +`hasChanges = C_BarberShop.HasAnyChanges()` + +**Returns:** +- `hasChanges` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md b/wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md new file mode 100644 index 00000000..dc66ca52 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.IsViewingAlteredForm + +**Content:** +Returns true if the player is currently customizing an alternate form. +`isViewingAlteredForm = C_BarberShop.IsViewingAlteredForm()` + +**Returns:** +- `isViewingAlteredForm` + - *boolean* - true if the player is currently customizing an alternate form. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.IsViewingNativeSex.md b/wiki-information/functions/C_BarberShop.IsViewingNativeSex.md new file mode 100644 index 00000000..e3990edd --- /dev/null +++ b/wiki-information/functions/C_BarberShop.IsViewingNativeSex.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.IsViewingNativeSex + +**Content:** +Returns whether the currently visible body type at the barber shop is different than what the character had before visiting. +`isNativeSex = IsViewingNativeSex()` + +**Returns:** +- `isNativeSex` + - *boolean* - true if the character hasn't changed body type in the barber shop UI, otherwise false \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md b/wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md new file mode 100644 index 00000000..69c45315 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md @@ -0,0 +1,13 @@ +## Title: C_BarberShop.IsViewingVisibleSex + +**Content:** +Returns whether the currently visible body type at the barber shop is the same as `sexId`. +`isVisibleSex = IsViewingVisibleSex(sex)` + +**Parameters:** +- `sex` + - *number* - Ranging from 0 for body type 1 (masculine/male) to 1 for body type 2 (feminine/female). + +**Returns:** +- `isVisibleSex` + - *boolean* - true if the visible body type at barber shop UI matches `sex`, otherwise false. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md b/wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md new file mode 100644 index 00000000..83ae9d51 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md @@ -0,0 +1,17 @@ +## Title: C_BarberShop.PreviewCustomizationChoice + +**Content:** +Previews a customization choice on the character without selecting it. +`C_BarberShop.PreviewCustomizationChoice(optionID, choiceID)` + +**Parameters:** +- `optionID` + - *number* +- `choiceID` + - *number* + +**Example Usage:** +This function can be used in an addon that allows players to preview different hairstyles, facial features, or other customization options in the Barber Shop without committing to the changes. For instance, an addon could provide a UI that lets players cycle through all available options and see how they look before making a final decision. + +**Addons Using This Function:** +Large addons like "BetterBarberShop" use this function to enhance the default Barber Shop interface by providing more intuitive controls for previewing and selecting character customizations. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md b/wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md new file mode 100644 index 00000000..01405e31 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md @@ -0,0 +1,11 @@ +## Title: C_BarberShop.RandomizeCustomizationChoices + +**Content:** +Needs summary. +`C_BarberShop.RandomizeCustomizationChoices()` + +**Example Usage:** +This function can be used to randomize the appearance of a character in the Barber Shop, providing a quick way to see different customization options without manually selecting each one. + +**Addons:** +Large addons like "ElvUI" or "Total RP 3" might use this function to provide users with a quick way to randomize their character's appearance for role-playing purposes or to quickly preview different looks. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ResetCameraRotation.md b/wiki-information/functions/C_BarberShop.ResetCameraRotation.md new file mode 100644 index 00000000..157a85e2 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.ResetCameraRotation.md @@ -0,0 +1,11 @@ +## Title: C_BarberShop.ResetCameraRotation + +**Content:** +Resets the camera rotation. +`C_BarberShop.ResetCameraRotation()` + +**Example Usage:** +This function can be used in an addon that customizes the user interface for the Barber Shop in World of Warcraft. For instance, if an addon allows players to preview different hairstyles and appearances, it might use this function to reset the camera to its default rotation after the player has finished previewing. + +**Addons Using This Function:** +Large addons like "ElvUI" or "Bartender4" might use this function to ensure that the camera view is reset to a default state when exiting the Barber Shop interface, providing a consistent user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md b/wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md new file mode 100644 index 00000000..ca585007 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md @@ -0,0 +1,11 @@ +## Title: C_BarberShop.ResetCustomizationChoices + +**Content:** +Resets all selected customization choices. +`C_BarberShop.ResetCustomizationChoices()` + +**Example Usage:** +This function can be used in an addon that provides a custom interface for the Barber Shop, allowing users to reset their changes and start over without having to exit and re-enter the Barber Shop. + +**Addons:** +Large addons like "ElvUI" or "WeakAuras" might use this function to provide enhanced user interfaces or customizations related to character appearance. For example, an addon could provide a button to reset all changes made in the Barber Shop, improving the user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.RotateCamera.md b/wiki-information/functions/C_BarberShop.RotateCamera.md new file mode 100644 index 00000000..82193a3e --- /dev/null +++ b/wiki-information/functions/C_BarberShop.RotateCamera.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.RotateCamera + +**Content:** +Rotates the camera by the specified number of degrees. +`C_BarberShop.RotateCamera(diffDegrees)` + +**Parameters:** +- `diffDegrees` + - *number* - The number of degrees to rotate the camera. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md b/wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md new file mode 100644 index 00000000..db65d447 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.SetCameraDistanceOffset + +**Content:** +Sets the distance offset of the camera. +`C_BarberShop.SetCameraDistanceOffset(offset)` + +**Parameters:** +- `offset` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md b/wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md new file mode 100644 index 00000000..a0c4be1d --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md @@ -0,0 +1,17 @@ +## Title: C_BarberShop.SetCameraZoomLevel + +**Content:** +Sets the zoom level of the camera. +`C_BarberShop.SetCameraZoomLevel(zoomLevel)` + +**Parameters:** +- `zoomLevel` + - *number* +- `keepCustomZoom` + - *boolean?* + +**Example Usage:** +This function can be used in an addon to adjust the camera zoom level when a player is in the Barber Shop, providing a better view of their character's customization options. + +**Addon Usage:** +Large addons like "ElvUI" or "Bartender4" might use this function to enhance the user interface experience by adjusting the camera zoom level dynamically based on user settings or specific events. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetCustomizationChoice.md b/wiki-information/functions/C_BarberShop.SetCustomizationChoice.md new file mode 100644 index 00000000..4afba84b --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetCustomizationChoice.md @@ -0,0 +1,17 @@ +## Title: C_BarberShop.SetCustomizationChoice + +**Content:** +Selects a customization choice. +`C_BarberShop.SetCustomizationChoice(optionID, choiceID)` + +**Parameters:** +- `optionID` + - *number* +- `choiceID` + - *number* + +**Example Usage:** +This function can be used to programmatically select a customization option in the Barber Shop interface. For instance, if you are developing an addon that allows players to randomize their character's appearance, you could use this function to apply a specific customization choice. + +**Addon Usage:** +Large addons like "BetterWardrobe" might use this function to allow users to save and apply different appearance presets, including hair styles and other customization options available in the Barber Shop. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetModelDressState.md b/wiki-information/functions/C_BarberShop.SetModelDressState.md new file mode 100644 index 00000000..84750502 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetModelDressState.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.SetModelDressState + +**Content:** +Controls whether or not the character should be dressed. +`C_BarberShop.SetModelDressState(dressedState)` + +**Parameters:** +- `dressedState` + - *boolean* - Indicates whether the character should be dressed or not. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetSelectedSex.md b/wiki-information/functions/C_BarberShop.SetSelectedSex.md new file mode 100644 index 00000000..1bce0df5 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetSelectedSex.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.SetSelectedSex + +**Content:** +Changes the selected gender of the character. +`C_BarberShop.SetSelectedSex(sex)` + +**Parameters:** +- `sex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md b/wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md new file mode 100644 index 00000000..e69f5ee4 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.SetViewingAlteredForm + +**Content:** +Controls whether the alternate form for a character is being customized. +`C_BarberShop.SetViewingAlteredForm(isViewingAlteredForm)` + +**Parameters:** +- `isViewingAlteredForm` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetViewingChrModel.md b/wiki-information/functions/C_BarberShop.SetViewingChrModel.md new file mode 100644 index 00000000..9a4c26b7 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetViewingChrModel.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.SetViewingChrModel + +**Content:** +Needs summary. +`C_BarberShop.SetViewingChrModel()` + +**Parameters:** +- `chrModelID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md b/wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md new file mode 100644 index 00000000..5fb905f7 --- /dev/null +++ b/wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.SetViewingShapeshiftForm + +**Content:** +Changes the shapeshift form being customized. Set to nil to revert to customizing the character's normal form. +`C_BarberShop.SetViewingShapeshiftForm()` + +**Parameters:** +- `shapeshiftFormID` + - *number?* - The ID of the shapeshift form to be customized. Can be set to `nil` to revert to the character's normal form. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ZoomCamera.md b/wiki-information/functions/C_BarberShop.ZoomCamera.md new file mode 100644 index 00000000..d6b83b4f --- /dev/null +++ b/wiki-information/functions/C_BarberShop.ZoomCamera.md @@ -0,0 +1,9 @@ +## Title: C_BarberShop.ZoomCamera + +**Content:** +Zooms the camera by a specified amount. +`C_BarberShop.ZoomCamera(zoomAmount)` + +**Parameters:** +- `zoomAmount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md b/wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md new file mode 100644 index 00000000..a0407b24 --- /dev/null +++ b/wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md @@ -0,0 +1,142 @@ +## Title: C_BattleNet.GetFriendAccountInfo + +**Content:** +Returns information about a Battle.net friend account. +```lua +accountInfo = C_BattleNet.GetFriendAccountInfo(friendIndex) +accountInfo = C_BattleNet.GetAccountInfoByID(id) +accountInfo = C_BattleNet.GetAccountInfoByGUID(guid) +``` + +**Parameters:** +- **GetFriendAccountInfo:** + - `friendIndex` + - *number* - Index ranging from 1 to BNGetNumFriends() + - `wowAccountGUID` + - *string?* - BNetAccountGUID + +- **GetAccountInfoByID:** + - `id` + - *number* - bnetAccountID + - `wowAccountGUID` + - *string?* - BNetAccountGUID + +- **GetAccountInfoByGUID:** + - `guid` + - *string* - UnitGUID + +**Returns:** +- `accountInfo` + - *BNetAccountInfo?* + - `Field` + - `Type` + - `Description` + - `bnetAccountID` + - *number* - A temporary ID for the friend's battle.net account during this session + - `accountName` + - *string* - A protected string representing the friend's full name or BattleTag name + - `battleTag` + - *string* - The friend's BattleTag (e.g., "Nickname#0001") + - `isFriend` + - *boolean* + - `isBattleTagFriend` + - *boolean* - Whether or not the friend is known by their BattleTag + - `lastOnlineTime` + - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. + - `isAFK` + - *boolean* - Whether or not the friend is flagged as Away + - `isDND` + - *boolean* - Whether or not the friend is flagged as Busy + - `isFavorite` + - *boolean* - Whether or not the friend is marked as a favorite by you + - `appearOffline` + - *boolean* + - `customMessage` + - *string* - The Battle.net broadcast message + - `customMessageTime` + - *number* - The number of seconds elapsed since the current broadcast message was sent + - `note` + - *string* - The contents of the player's note about this friend + - `rafLinkType` + - *Enum.RafLinkType* + - `gameAccountInfo` + - *BNetGameAccountInfo* + - `Field` + - `Type` + - `Description` + - `gameAccountID` + - *number?* - A temporary ID for the friend's battle.net game account during this session. + - `clientProgram` + - *string* - BNET_CLIENT + - `isOnline` + - *boolean* + - `isGameBusy` + - *boolean* + - `isGameAFK` + - *boolean* + - `wowProjectID` + - *number?* + - `characterName` + - *string?* - The name of the logged in toon/character + - `realmName` + - *string?* - The name of the logged in realm + - `realmDisplayName` + - *string?* + - `realmID` + - *number?* - The ID for the logged in realm + - `factionName` + - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") + - `raceName` + - *string?* - The localized race name (e.g., "Blood Elf") + - `className` + - *string?* - The localized class name (e.g., "Death Knight") + - `areaName` + - *string?* - The localized zone name (e.g., "The Undercity") + - `characterLevel` + - *number?* - The current level (e.g., "90") + - `richPresence` + - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. + - `playerGuid` + - *string?* - A unique numeric identifier for the friend's character during this session. + - `isWowMobile` + - *boolean* + - `canSummon` + - *boolean* + - `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame + - `regionID` + - *number* - Added in 9.1.0 + - `isInCurrentRegion` + - *boolean* - Added in 9.1.0 + +**BNET_CLIENT:** +- **Global** + - `Value` + - `Description` + - `BNET_CLIENT_WOW` + - WoW - World of Warcraft + - `BNET_CLIENT_APP` + - App - Battle.net desktop app + - `BNET_CLIENT_HEROES` + - Hero - Heroes of the Storm + - `BNET_CLIENT_CLNT` + - CLNT + +**Description:** +Related API: `C_BattleNet.GetFriendGameAccountInfo` + +**Usage:** +Shows your own account info. +```lua +/dump C_BattleNet.GetAccountInfoByID(select(3, BNGetInfo())) +``` +Shows your Battle.net friends' account information. +```lua +for i = 1, BNGetNumFriends() do + local acc = C_BattleNet.GetFriendAccountInfo(i) + local game = acc.gameAccountInfo + print(acc.bnetAccountID, acc.accountName, game.gameAccountID, game.isOnline, game.clientProgram) +end +-- 1, "|Kq2|k", 5, true, "BSAp" +-- 2, "|Kq1|k", nil, false, "" +``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetAccountInfoByID.md b/wiki-information/functions/C_BattleNet.GetAccountInfoByID.md new file mode 100644 index 00000000..5b61dfb9 --- /dev/null +++ b/wiki-information/functions/C_BattleNet.GetAccountInfoByID.md @@ -0,0 +1,129 @@ +## Title: C_BattleNet.GetFriendAccountInfo + +**Content:** +Returns information about a Battle.net friend account. +```lua +accountInfo = C_BattleNet.GetFriendAccountInfo(friendIndex) +accountInfo = C_BattleNet.GetAccountInfoByID(id) +accountInfo = C_BattleNet.GetAccountInfoByGUID(guid) +``` + +**Parameters:** +- **GetFriendAccountInfo:** + - `friendIndex` + - *number* - Index ranging from 1 to BNGetNumFriends() + - `wowAccountGUID` + - *string?* - BNetAccountGUID + +- **GetAccountInfoByID:** + - `id` + - *number* - bnetAccountID + - `wowAccountGUID` + - *string?* - BNetAccountGUID + +- **GetAccountInfoByGUID:** + - `guid` + - *string* - UnitGUID + +**Returns:** +- `accountInfo` + - *BNetAccountInfo?* + - `Field` + - `Type` + - `Description` + - `bnetAccountID` + - *number* - A temporary ID for the friend's battle.net account during this session + - `accountName` + - *string* - A protected string representing the friend's full name or BattleTag name + - `battleTag` + - *string* - The friend's BattleTag (e.g., "Nickname#0001") + - `isFriend` + - *boolean* + - `isBattleTagFriend` + - *boolean* - Whether or not the friend is known by their BattleTag + - `lastOnlineTime` + - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. + - `isAFK` + - *boolean* - Whether or not the friend is flagged as Away + - `isDND` + - *boolean* - Whether or not the friend is flagged as Busy + - `isFavorite` + - *boolean* - Whether or not the friend is marked as a favorite by you + - `appearOffline` + - *boolean* + - `customMessage` + - *string* - The Battle.net broadcast message + - `customMessageTime` + - *number* - The number of seconds elapsed since the current broadcast message was sent + - `note` + - *string* - The contents of the player's note about this friend + - `rafLinkType` + - *Enum.RafLinkType* + - `gameAccountInfo` + - *BNetGameAccountInfo* + - `Field` + - `Type` + - `Description` + - `gameAccountID` + - *number?* - A temporary ID for the friend's battle.net game account during this session. + - `clientProgram` + - *string* - BNET_CLIENT + - `isOnline` + - *boolean* + - `isGameBusy` + - *boolean* + - `isGameAFK` + - *boolean* + - `wowProjectID` + - *number?* + - `characterName` + - *string?* - The name of the logged in toon/character + - `realmName` + - *string?* - The name of the logged in realm + - `realmDisplayName` + - *string?* + - `realmID` + - *number?* - The ID for the logged in realm + - `factionName` + - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") + - `raceName` + - *string?* - The localized race name (e.g., "Blood Elf") + - `className` + - *string?* - The localized class name (e.g., "Death Knight") + - `areaName` + - *string?* - The localized zone name (e.g., "The Undercity") + - `characterLevel` + - *number?* - The current level (e.g., "90") + - `richPresence` + - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. + - `playerGuid` + - *string?* - A unique numeric identifier for the friend's character during this session. + - `isWowMobile` + - *boolean* + - `canSummon` + - *boolean* + - `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame + - `regionID` + - *number* - Added in 9.1.0 + - `isInCurrentRegion` + - *boolean* - Added in 9.1.0 + +**Description:** +Related API: `C_BattleNet.GetFriendGameAccountInfo` + +**Usage:** +Shows your own account info. +```lua +/dump C_BattleNet.GetAccountInfoByID(select(3, BNGetInfo())) +``` +Shows your Battle.net friends' account information. +```lua +for i = 1, BNGetNumFriends() do + local acc = C_BattleNet.GetFriendAccountInfo(i) + local game = acc.gameAccountInfo + print(acc.bnetAccountID, acc.accountName, game.gameAccountID, game.isOnline, game.clientProgram) +end +-- 1, "|Kq2|k", 5, true, "BSAp" +-- 2, "|Kq1|k", nil, false, "" +``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md b/wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md new file mode 100644 index 00000000..129e35f2 --- /dev/null +++ b/wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md @@ -0,0 +1,130 @@ +## Title: C_BattleNet.GetFriendAccountInfo + +**Content:** +Returns information about a Battle.net friend account. +```lua +accountInfo = C_BattleNet.GetFriendAccountInfo(friendIndex) +accountInfo = C_BattleNet.GetAccountInfoByID(id) +accountInfo = C_BattleNet.GetAccountInfoByGUID(guid) +``` + +**Parameters:** + +*GetFriendAccountInfo:* +- `friendIndex` + - *number* - Index ranging from 1 to BNGetNumFriends() +- `wowAccountGUID` + - *string?* - BNetAccountGUID + +*GetAccountInfoByID:* +- `id` + - *number* - bnetAccountID +- `wowAccountGUID` + - *string?* - BNetAccountGUID + +*GetAccountInfoByGUID:* +- `guid` + - *string* - UnitGUID + +**Returns:** +- `accountInfo` + - *BNetAccountInfo?* + - `Field` + - `Type` + - `Description` + - `bnetAccountID` + - *number* - A temporary ID for the friend's battle.net account during this session + - `accountName` + - *string* - A protected string representing the friend's full name or BattleTag name + - `battleTag` + - *string* - The friend's BattleTag (e.g., "Nickname#0001") + - `isFriend` + - *boolean* + - `isBattleTagFriend` + - *boolean* - Whether or not the friend is known by their BattleTag + - `lastOnlineTime` + - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. + - `isAFK` + - *boolean* - Whether or not the friend is flagged as Away + - `isDND` + - *boolean* - Whether or not the friend is flagged as Busy + - `isFavorite` + - *boolean* - Whether or not the friend is marked as a favorite by you + - `appearOffline` + - *boolean* + - `customMessage` + - *string* - The Battle.net broadcast message + - `customMessageTime` + - *number* - The number of seconds elapsed since the current broadcast message was sent + - `note` + - *string* - The contents of the player's note about this friend + - `rafLinkType` + - *Enum.RafLinkType* + - `gameAccountInfo` + - *BNetGameAccountInfo* + - `Field` + - `Type` + - `Description` + - `gameAccountID` + - *number?* - A temporary ID for the friend's battle.net game account during this session. + - `clientProgram` + - *string* - BNET_CLIENT + - `isOnline` + - *boolean* + - `isGameBusy` + - *boolean* + - `isGameAFK` + - *boolean* + - `wowProjectID` + - *number?* + - `characterName` + - *string?* - The name of the logged in toon/character + - `realmName` + - *string?* - The name of the logged in realm + - `realmDisplayName` + - *string?* + - `realmID` + - *number?* + - `factionName` + - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") + - `raceName` + - *string?* - The localized race name (e.g., "Blood Elf") + - `className` + - *string?* - The localized class name (e.g., "Death Knight") + - `areaName` + - *string?* - The localized zone name (e.g., "The Undercity") + - `characterLevel` + - *number?* - The current level (e.g., "90") + - `richPresence` + - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. + - `playerGuid` + - *string?* - A unique numeric identifier for the friend's character during this session. + - `isWowMobile` + - *boolean* + - `canSummon` + - *boolean* + - `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame + - `regionID` + - *number* - Added in 9.1.0 + - `isInCurrentRegion` + - *boolean* - Added in 9.1.0 + +**Description:** +Related API: `C_BattleNet.GetFriendGameAccountInfo` + +**Usage:** +Shows your own account info. +```lua +/dump C_BattleNet.GetAccountInfoByID(select(3, BNGetInfo())) +``` +Shows your Battle.net friends' account information. +```lua +for i = 1, BNGetNumFriends() do + local acc = C_BattleNet.GetFriendAccountInfo(i) + local game = acc.gameAccountInfo + print(acc.bnetAccountID, acc.accountName, game.gameAccountID, game.isOnline, game.clientProgram) +end +-- 1, "|Kq2|k", 5, true, "BSAp" +-- 2, "|Kq1|k", nil, false, "" +``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md b/wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md new file mode 100644 index 00000000..03a7aa8d --- /dev/null +++ b/wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md @@ -0,0 +1,111 @@ +## Title: C_BattleNet.GetFriendGameAccountInfo + +**Content:** +Returns information on the game the Battle.net friend is playing. +```lua +gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) +``` + +**Parameters:** +- **GetFriendGameAccountInfo:** + - `friendIndex` + - *number* - Index ranging from 1 to BNGetNumFriends() + - `accountIndex` + - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() + +- **GetGameAccountInfoByID:** + - `id` + - *number* - `gameAccountInfo.gameAccountID` + +- **GetGameAccountInfoByGUID:** + - `guid` + - *string* - `UnitGUID` + +**Returns:** +- `gameAccountInfo` + - *BNetGameAccountInfo?* + - `Field` + - `Type` + - `Description` + - `gameAccountID` + - *number?* - A temporary ID for the friend's battle.net game account during this session. + - `clientProgram` + - *string* - BNET_CLIENT + - `isOnline` + - *boolean* + - `isGameBusy` + - *boolean* + - `isGameAFK` + - *boolean* + - `wowProjectID` + - *number?* + - `characterName` + - *string?* - The name of the logged in toon/character + - `realmName` + - *string?* - The name of the logged in realm + - `realmDisplayName` + - *string?* + - `realmID` + - *number?* - The ID for the logged in realm + - `factionName` + - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") + - `raceName` + - *string?* - The localized race name (e.g., "Blood Elf") + - `className` + - *string?* - The localized class name (e.g., "Death Knight") + - `areaName` + - *string?* - The localized zone name (e.g., "The Undercity") + - `characterLevel` + - *number?* - The current level (e.g., "90") + - `richPresence` + - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. + - `playerGuid` + - *string?* - A unique numeric identifier for the friend's character during this session. + - `isWowMobile` + - *boolean* + - `canSummon` + - *boolean* + - `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame + - `regionID` + - *number* - Added in 9.1.0 + - `isInCurrentRegion` + - *boolean* - Added in 9.1.0 + +**BNET_CLIENT:** +- **Global** + - `Value` + - `Description` + - `BNET_CLIENT_WOW` + - WoW - World of Warcraft + - `BNET_CLIENT_APP` + - App - Battle.net desktop app + - `BNET_CLIENT_HEROES` + - Hero - Heroes of the Storm + - `BNET_CLIENT_CLNT` + - CLNT + +**Description:** +Related API: `C_BattleNet.GetFriendAccountInfo` + +**Usage:** +Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. +```lua +for i = 1, BNGetNumFriends() do + for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do + local game = C_BattleNet.GetFriendGameAccountInfo(i, j) + print(game.gameAccountID, game.isOnline, game.clientProgram) + end +end +-- 5, true, "BSAp" + +C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo +for i = 1, BNGetNumFriends() do + local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo + print(game.gameAccountID, game.isOnline, game.clientProgram) +end +-- 5, true, "BSAp" +-- nil, false, "" +``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md b/wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md new file mode 100644 index 00000000..b7704e45 --- /dev/null +++ b/wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md @@ -0,0 +1,16 @@ +## Title: C_BattleNet.GetFriendNumGameAccounts + +**Content:** +Returns the number of game accounts for the Battle.net friend. +`numGameAccounts = C_BattleNet.GetFriendNumGameAccounts(friendIndex)` + +**Parameters:** +- `friendIndex` + - *number* - The Battle.net friend's index on the friends list ranging from 1 to `BNGetNumFriends()` + +**Returns:** +- `numGameAccounts` + - *number* - The number of accounts or 0 if the friend is not online. + +**Description:** +This function returns the number of ACCOUNTS a player has that are identified with a given BattleTag ID rather than the number of characters on a given account. \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md b/wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md new file mode 100644 index 00000000..449269d5 --- /dev/null +++ b/wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md @@ -0,0 +1,98 @@ +## Title: C_BattleNet.GetFriendGameAccountInfo + +**Content:** +Returns information on the game the Battle.net friend is playing. +```lua +gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) +``` + +**Parameters:** +- **GetFriendGameAccountInfo:** + - `friendIndex` + - *number* - Index ranging from 1 to BNGetNumFriends() + - `accountIndex` + - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() + +- **GetGameAccountInfoByID:** + - `id` + - *number* - gameAccountInfo.gameAccountID + +- **GetGameAccountInfoByGUID:** + - `guid` + - *string* - UnitGUID + +**Returns:** +- `gameAccountInfo` + - *BNetGameAccountInfo?* + - `Field` + - `Type` + - `Description` + - `gameAccountID` + - *number?* - A temporary ID for the friend's battle.net game account during this session. + - `clientProgram` + - *string* - BNET_CLIENT + - `isOnline` + - *boolean* + - `isGameBusy` + - *boolean* + - `isGameAFK` + - *boolean* + - `wowProjectID` + - *number?* + - `characterName` + - *string?* - The name of the logged in toon/character + - `realmName` + - *string?* - The name of the logged in realm + - `realmDisplayName` + - *string?* + - `realmID` + - *number?* - The ID for the logged in realm + - `factionName` + - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") + - `raceName` + - *string?* - The localized race name (e.g., "Blood Elf") + - `className` + - *string?* - The localized class name (e.g., "Death Knight") + - `areaName` + - *string?* - The localized zone name (e.g., "The Undercity") + - `characterLevel` + - *number?* - The current level (e.g., "90") + - `richPresence` + - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. + - `playerGuid` + - *string?* - A unique numeric identifier for the friend's character during this session. + - `isWowMobile` + - *boolean* + - `canSummon` + - *boolean* + - `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame + - `regionID` + - *number* - Added in 9.1.0 + - `isInCurrentRegion` + - *boolean* - Added in 9.1.0 + +**Description:** +Related API: `C_BattleNet.GetFriendAccountInfo` + +**Usage:** +Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. +```lua +for i = 1, BNGetNumFriends() do + for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do + local game = C_BattleNet.GetFriendGameAccountInfo(i, j) + print(game.gameAccountID, game.isOnline, game.clientProgram) + end +end +-- 5, true, "BSAp" + +C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo +for i = 1, BNGetNumFriends() do + local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo + print(game.gameAccountID, game.isOnline, game.clientProgram) +end +-- 5, true, "BSAp" +-- nil, false, "" +``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md b/wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md new file mode 100644 index 00000000..98852aad --- /dev/null +++ b/wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md @@ -0,0 +1,109 @@ +## Title: C_BattleNet.GetFriendGameAccountInfo + +**Content:** +Returns information on the game the Battle.net friend is playing. +```lua +gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) +gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) +``` + +**Parameters:** + +*GetFriendGameAccountInfo:* +- `friendIndex` + - *number* - Index ranging from 1 to BNGetNumFriends() +- `accountIndex` + - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() + +*GetGameAccountInfoByID:* +- `id` + - *number* : gameAccountInfo.gameAccountID + +*GetGameAccountInfoByGUID:* +- `guid` + - *string* : UnitGUID + +**Returns:** +- `gameAccountInfo` + - *BNetGameAccountInfo?* + - `gameAccountID` + - *number?* - A temporary ID for the friend's battle.net game account during this session. + - `clientProgram` + - *string* - BNET_CLIENT + - `isOnline` + - *boolean* + - `isGameBusy` + - *boolean* + - `isGameAFK` + - *boolean* + - `wowProjectID` + - *number?* + - `characterName` + - *string?* - The name of the logged in toon/character + - `realmName` + - *string?* - The name of the logged in realm + - `realmDisplayName` + - *string?* + - `realmID` + - *number?* - The ID for the logged in realm + - `factionName` + - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") + - `raceName` + - *string?* - The localized race name (e.g., "Blood Elf") + - `className` + - *string?* - The localized class name (e.g., "Death Knight") + - `areaName` + - *string?* - The localized zone name (e.g., "The Undercity") + - `characterLevel` + - *number?* - The current level (e.g., "90") + - `richPresence` + - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. + - `playerGuid` + - *string?* - A unique numeric identifier for the friend's character during this session. + - `isWowMobile` + - *boolean* + - `canSummon` + - *boolean* + - `hasFocus` + - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame + - `regionID` + - *number* - Added in 9.1.0 + - `isInCurrentRegion` + - *boolean* - Added in 9.1.0 + +**BNET_CLIENT:** +- `Global` + - `Value` + - `Description` + - `BNET_CLIENT_WOW` + - WoW - World of Warcraft + - `BNET_CLIENT_APP` + - App - Battle.net desktop app + - `BNET_CLIENT_HEROES` + - Hero - Heroes of the Storm + - `BNET_CLIENT_CLNT` + - CLNT + +**Description:** +Related API: `C_BattleNet.GetFriendAccountInfo` + +**Usage:** +Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. +```lua +for i = 1, BNGetNumFriends() do + for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do + local game = C_BattleNet.GetFriendGameAccountInfo(i, j) + print(game.gameAccountID, game.isOnline, game.clientProgram) + end +end +-- 5, true, "BSAp" + +C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo +for i = 1, BNGetNumFriends() do + local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo + print(game.gameAccountID, game.isOnline, game.clientProgram) +end +-- 5, true, "BSAp" +-- nil, false, "" +``` \ No newline at end of file diff --git a/wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md b/wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md new file mode 100644 index 00000000..4387f40a --- /dev/null +++ b/wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md @@ -0,0 +1,13 @@ +## Title: C_BehavioralMessaging.SendNotificationReceipt + +**Content:** +Needs summary. +`C_BehavioralMessaging.SendNotificationReceipt(dbId, openTimeSeconds, readTimeSeconds)` + +**Parameters:** +- `dbId` + - *string* +- `openTimeSeconds` + - *number* +- `readTimeSeconds` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVar.md b/wiki-information/functions/C_CVar.GetCVar.md new file mode 100644 index 00000000..711b0bdd --- /dev/null +++ b/wiki-information/functions/C_CVar.GetCVar.md @@ -0,0 +1,17 @@ +## Title: C_CVar.GetCVar + +**Content:** +Returns the current value of a console variable. +`value = C_CVar.GetCVar(name)` +`= GetCVar` + +**Parameters:** +- `name` + - *string* : CVar - name of the CVar to query the value of. + +**Returns:** +- `value` + - *string?* - current value of the CVar. + +**Description:** +Calling this function with an invalid variable name, or a variable that cannot be queried by AddOns (like "accountName"), will return nil. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarBitfield.md b/wiki-information/functions/C_CVar.GetCVarBitfield.md new file mode 100644 index 00000000..7532a258 --- /dev/null +++ b/wiki-information/functions/C_CVar.GetCVarBitfield.md @@ -0,0 +1,19 @@ +## Title: C_CVar.GetCVarBitfield + +**Content:** +Returns the bitfield of a console variable. +`value = C_CVar.GetCVarBitfield(name, index)` +`= GetCVarBitfield` + +**Parameters:** +- `name` + - *string* : CVar - name of the CVar. +- `index` + - *number* - Bitfield index. + +**Returns:** +- `value` + - *boolean?* - Value of the bitfield. + +**Reference:** +closedInfoFrames \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarBool.md b/wiki-information/functions/C_CVar.GetCVarBool.md new file mode 100644 index 00000000..2083a9db --- /dev/null +++ b/wiki-information/functions/C_CVar.GetCVarBool.md @@ -0,0 +1,14 @@ +## Title: C_CVar.GetCVarBool + +**Content:** +Returns the boolean value of a console variable. +`value = C_CVar.GetCVarBool(name)` +`GetCVarBool` + +**Parameters:** +- `name` + - *string* - Name of the CVar to query the value of. + +**Returns:** +- `value` + - *boolean?* - Compared to GetCVar, "1" would return as true, "0" would return as false. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarDefault.md b/wiki-information/functions/C_CVar.GetCVarDefault.md new file mode 100644 index 00000000..5ad40b33 --- /dev/null +++ b/wiki-information/functions/C_CVar.GetCVarDefault.md @@ -0,0 +1,14 @@ +## Title: C_CVar.GetCVarDefault + +**Content:** +Returns the default value of a console variable. +`defaultValue = C_CVar.GetCVarDefault(name)` +`= GetCVarDefault` + +**Parameters:** +- `name` + - *string* - Name of the console variable to query. + +**Returns:** +- `defaultValue` + - *string?* - Default value of the console variable. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarInfo.md b/wiki-information/functions/C_CVar.GetCVarInfo.md new file mode 100644 index 00000000..7f542488 --- /dev/null +++ b/wiki-information/functions/C_CVar.GetCVarInfo.md @@ -0,0 +1,25 @@ +## Title: C_CVar.GetCVarInfo + +**Content:** +Returns information on a console variable. +`value, defaultValue, isStoredServerAccount, isStoredServerCharacter, isLockedFromUser, isSecure, isReadOnly = C_CVar.GetCVarInfo(name)` + +**Parameters:** +- `name` + - *string* - Name of the CVar to query the value of. Only accepts console variables (i.e. not console commands). + +**Returns:** +- `value` + - *string* - Current value of the CVar. +- `defaultValue` + - *string* - Default value of the CVar. +- `isStoredServerAccount` + - *boolean* - If the CVar scope is set WoW account-wide. Stored on the server per CVar synchronizeConfig. +- `isStoredServerCharacter` + - *boolean* - If the CVar scope is character-specific. Stored on the server per CVar synchronizeConfig. +- `isLockedFromUser` + - *boolean* +- `isSecure` + - *boolean* - If the CVar cannot be set with SetCVar while in combat, which would fire ADDON_ACTION_BLOCKED. It's also not possible to set these via /console. Most nameplate CVars are secure. +- `isReadOnly` + - *boolean* - Returns true for portal, serverAlert, timingTestError. These CVars cannot be changed. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.RegisterCVar.md b/wiki-information/functions/C_CVar.RegisterCVar.md new file mode 100644 index 00000000..ae8973c6 --- /dev/null +++ b/wiki-information/functions/C_CVar.RegisterCVar.md @@ -0,0 +1,14 @@ +## Title: C_CVar.RegisterCVar + +**Content:** +Temporarily registers a custom console variable. +`C_CVar.RegisterCVar(name)` + +**Parameters:** +- `name` + - *string* - Name of the custom CVar to set. +- `value` + - *string|number?* = "0" - Initial value of the CVar. + +**Description:** +You can register your own CVars. They are set game-wide and will persist after relogging/reloading but not after closing the game. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.ResetTestCVars.md b/wiki-information/functions/C_CVar.ResetTestCVars.md new file mode 100644 index 00000000..b39f2e7a --- /dev/null +++ b/wiki-information/functions/C_CVar.ResetTestCVars.md @@ -0,0 +1,20 @@ +## Title: C_CVar.ResetTestCVars + +**Content:** +Resets the ActionCam cvars. +`C_CVar.ResetTestCVars()` + +**Function:** +`ResetTestCVars` + +**Description:** +This function is used to reset the ActionCam-related console variables (CVars) to their default values. The ActionCam is a feature that allows for more dynamic camera movements and angles in the game. + +**Example Usage:** +```lua +-- Reset the ActionCam CVars to their default values +C_CVar.ResetTestCVars() +``` + +**Additional Information:** +This function can be particularly useful for developers and players who are experimenting with the ActionCam settings and want to quickly revert to the default configuration. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.SetCVar.md b/wiki-information/functions/C_CVar.SetCVar.md new file mode 100644 index 00000000..6f6945ff --- /dev/null +++ b/wiki-information/functions/C_CVar.SetCVar.md @@ -0,0 +1,21 @@ +## Title: C_CVar.SetCVar + +**Content:** +Sets a console variable. +`success = C_CVar.SetCVar(name)` + +**Parameters:** +- `name` + - *string* : CVar - Name of the CVar. +- `value` + - *string|number?* = "0" - The new value of the CVar. + +**Returns:** +- `success` + - *boolean* - Whether the CVar was successfully set. Returns nil if attempting to set a secure cvar in combat. + +**Description:** +Some settings require a reload/relog before they take effect. +CVars are not saved to Config.wtf until properly logging out or reloading the game. +Secure CVars cannot be set in combat and only with SetCVar instead of /console. +Character and Account specific variables are stored server-side depending on CVar synchronizeConfig. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.SetCVarBitfield.md b/wiki-information/functions/C_CVar.SetCVarBitfield.md new file mode 100644 index 00000000..4ce75f04 --- /dev/null +++ b/wiki-information/functions/C_CVar.SetCVarBitfield.md @@ -0,0 +1,21 @@ +## Title: C_CVar.SetCVarBitfield + +**Content:** +Sets the bitfield of a console variable. +`success = C_CVar.SetCVarBitfield(name, index, value)` +`= SetCVarBitfield` + +**Parameters:** +- `name` + - *string* - Name of the CVar to set the bitfield of. +- `index` + - *number* - Bitfield index. +- `value` + - *boolean* - The new value of the bitfield. + +**Returns:** +- `success` + - *boolean* - Whether the CVar was successfully set. + +**Reference:** +closedInfoFrames \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.AddEvent.md b/wiki-information/functions/C_Calendar.AddEvent.md new file mode 100644 index 00000000..7a161d68 --- /dev/null +++ b/wiki-information/functions/C_Calendar.AddEvent.md @@ -0,0 +1,21 @@ +## Title: C_Calendar.AddEvent + +**Content:** +Saves the new event currently being created to the server. +`C_Calendar.AddEvent()` + +**Description:** +Finalizes the event candidate created by `C_Calendar.CreatePlayerEvent`, `C_Calendar.CreateGuildSignUpEvent`, and similar. +Requires at least `C_Calendar.EventSetTitle`, `C_Calendar.EventSetDate`, and `C_Calendar.EventSetTime` to be set. +This function is only used to create new events. To save changes to existing events, use `C_Calendar.UpdateEvent`. + +**Usage:** +Creates an event for tomorrow. +```lua +C_Calendar.CreatePlayerEvent() +local d = C_DateAndTime.GetCurrentCalendarTime() +C_Calendar.EventSetDate(d.month, d.monthDay+1, d.year) +C_Calendar.EventSetTime(d.hour, d.minute) +C_Calendar.EventSetTitle("hello") +C_Calendar.AddEvent() +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.AreNamesReady.md b/wiki-information/functions/C_Calendar.AreNamesReady.md new file mode 100644 index 00000000..54c27afe --- /dev/null +++ b/wiki-information/functions/C_Calendar.AreNamesReady.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.AreNamesReady + +**Content:** +Needs summary. +`ready = C_Calendar.AreNamesReady()` + +**Returns:** +- `ready` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CanAddEvent.md b/wiki-information/functions/C_Calendar.CanAddEvent.md new file mode 100644 index 00000000..b76d49ed --- /dev/null +++ b/wiki-information/functions/C_Calendar.CanAddEvent.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.CanAddEvent + +**Content:** +Returns whether the player can add an event. +`canAddEvent = C_Calendar.CanAddEvent()` + +**Returns:** +- `canAddEvent` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CanSendInvite.md b/wiki-information/functions/C_Calendar.CanSendInvite.md new file mode 100644 index 00000000..cdf629a7 --- /dev/null +++ b/wiki-information/functions/C_Calendar.CanSendInvite.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.CanSendInvite + +**Content:** +Returns whether the player can send invites. +`canSendInvite = C_Calendar.CanSendInvite()` + +**Returns:** +- `canSendInvite` + - *boolean* - Indicates if the player can send invites. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CloseEvent.md b/wiki-information/functions/C_Calendar.CloseEvent.md new file mode 100644 index 00000000..60feace3 --- /dev/null +++ b/wiki-information/functions/C_Calendar.CloseEvent.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.CloseEvent + +**Content:** +Closes the selected event without saving it. +`C_Calendar.CloseEvent()` + +**Example Usage:** +This function can be used in an addon that manages calendar events, allowing the user to close an event they were editing without saving any changes. + +**Addons:** +Large addons like "Calendar" or "Group Calendar" might use this function to provide users with the ability to discard changes to events they are editing. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md b/wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md new file mode 100644 index 00000000..bc5b3eed --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md @@ -0,0 +1,17 @@ +## Title: C_Calendar.ContextMenuEventCanComplain + +**Content:** +Returns whether the player can report the event as spam. +`canComplain = C_Calendar.ContextMenuEventCanComplain(offsetMonths, monthDay, eventIndex)` + +**Parameters:** +- `offsetMonths` + - *number* +- `monthDay` + - *number* +- `eventIndex` + - *number* + +**Returns:** +- `canComplain` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md b/wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md new file mode 100644 index 00000000..eeac76cb --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md @@ -0,0 +1,17 @@ +## Title: C_Calendar.ContextMenuEventCanEdit + +**Content:** +Returns whether the player can edit the event. +`canEdit = C_Calendar.ContextMenuEventCanEdit(offsetMonths, monthDay, eventIndex)` + +**Parameters:** +- `offsetMonths` + - *number* +- `monthDay` + - *number* +- `eventIndex` + - *number* + +**Returns:** +- `canEdit` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md b/wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md new file mode 100644 index 00000000..723f64e4 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md @@ -0,0 +1,17 @@ +## Title: C_Calendar.ContextMenuEventCanRemove + +**Content:** +Returns whether the player can remove the event. +`canRemove = C_Calendar.ContextMenuEventCanRemove(offsetMonths, monthDay, eventIndex)` + +**Parameters:** +- `offsetMonths` + - *number* +- `monthDay` + - *number* +- `eventIndex` + - *number* + +**Returns:** +- `canRemove` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md b/wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md new file mode 100644 index 00000000..d3f00aa9 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.ContextMenuEventClipboard + +**Content:** +Needs summary. +`exists = C_Calendar.ContextMenuEventClipboard()` + +**Returns:** +- `exists` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventComplain.md b/wiki-information/functions/C_Calendar.ContextMenuEventComplain.md new file mode 100644 index 00000000..b51a751d --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventComplain.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.ContextMenuEventComplain + +**Content:** +Reports the event as spam. +`C_Calendar.ContextMenuEventComplain()` + +**Example Usage:** +This function can be used in addons that manage or interact with the in-game calendar to report events that are considered spam. For instance, an addon that helps players manage their calendar events might include a feature to quickly report spam events using this function. + +**Addons:** +While there are no specific large addons known to use this function, any addon that deals with calendar events, such as group event planners or guild event managers, could potentially use this function to help maintain a clean and relevant event list. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCopy.md b/wiki-information/functions/C_Calendar.ContextMenuEventCopy.md new file mode 100644 index 00000000..dea4b6a0 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventCopy.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.ContextMenuEventCopy + +**Content:** +Copies the event to the clipboard. +`C_Calendar.ContextMenuEventCopy()` + +**Example Usage:** +This function can be used in an addon to allow users to easily copy calendar events for sharing or duplication purposes. + +**Addons:** +Large addons like "Calendar" or "EventManager" might use this function to enhance user interaction with in-game events, allowing for easier management and sharing of events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md b/wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md new file mode 100644 index 00000000..7fd2969d --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.ContextMenuEventGetCalendarType + +**Content:** +Needs summary. +`calendarType = C_Calendar.ContextMenuEventGetCalendarType()` + +**Returns:** +- `calendarType` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventPaste.md b/wiki-information/functions/C_Calendar.ContextMenuEventPaste.md new file mode 100644 index 00000000..1e18b12a --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventPaste.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.ContextMenuEventPaste + +**Content:** +Pastes the clipboard event to the date. +`C_Calendar.ContextMenuEventPaste(offsetMonths, monthDay)` + +**Parameters:** +- `offsetMonths` + - *number* +- `monthDay` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventRemove.md b/wiki-information/functions/C_Calendar.ContextMenuEventRemove.md new file mode 100644 index 00000000..5305b98f --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventRemove.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.ContextMenuEventRemove + +**Content:** +Deletes the event. +`C_Calendar.ContextMenuEventRemove()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md b/wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md new file mode 100644 index 00000000..6aebe728 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md @@ -0,0 +1,14 @@ +## Title: C_Calendar.ContextMenuEventSignUp + +**Content:** +Needs summary. +`C_Calendar.ContextMenuEventSignUp()` + +**Description:** +This function is used to sign up for an event in the in-game calendar context menu. It is typically used in the context of calendar events where players can sign up to participate in scheduled activities such as raids, dungeons, or other group events. + +**Example Usage:** +An example of how this function might be used is in an addon that manages raid sign-ups. When a player right-clicks on a calendar event and selects the option to sign up, this function would be called to register their participation. + +**Addons:** +Large addons like "Group Calendar" or "Calendar Addon" might use this function to handle event sign-ups directly from the calendar interface, streamlining the process for players to join scheduled events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md b/wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md new file mode 100644 index 00000000..8a4c67f9 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md @@ -0,0 +1,19 @@ +## Title: C_Calendar.ContextMenuGetEventIndex + +**Content:** +Needs summary. +`info = C_Calendar.ContextMenuGetEventIndex()` + +**Returns:** +- `info` + - *structure* - `CalendarEventIndexInfo` + - `CalendarEventIndexInfo` + - `Field` + - `Type` + - `Description` + - `offsetMonths` + - *number* + - `monthDay` + - *number* + - `eventIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md b/wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md new file mode 100644 index 00000000..563e5b17 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md @@ -0,0 +1,8 @@ +## Title: C_Calendar.ContextMenuInviteAvailable + +**Content:** +Accepts the invitation to the event. +`C_Calendar.ContextMenuInviteAvailable()` + +**Example Usage:** +This function can be used in an addon to automatically accept calendar event invitations. For instance, a guild management addon might use this to ensure that all guild members accept important event invitations without manual intervention. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md b/wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md new file mode 100644 index 00000000..af8f11f7 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.ContextMenuInviteDecline + +**Content:** +Declines the invitation to the event. +`C_Calendar.ContextMenuInviteDecline()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md b/wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md new file mode 100644 index 00000000..1f2f7825 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.ContextMenuInviteRemove + +**Content:** +Removes the event from the calendar. +`C_Calendar.ContextMenuInviteRemove()` + +**Example Usage:** +This function can be used in an addon to programmatically remove an event from the in-game calendar. For instance, if you are developing a calendar management addon, you might use this function to allow users to remove events directly from a context menu. + +**Addons Using This Function:** +Large addons like "Group Calendar" might use this function to manage calendar events, allowing users to remove events they no longer wish to attend or that have been canceled. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md b/wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md new file mode 100644 index 00000000..b93c04a1 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.ContextMenuInviteTentative + +**Content:** +Needs summary. +`C_Calendar.ContextMenuInviteTentative()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md b/wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md new file mode 100644 index 00000000..37b48d15 --- /dev/null +++ b/wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md @@ -0,0 +1,13 @@ +## Title: C_Calendar.ContextMenuSelectEvent + +**Content:** +Needs summary. +`C_Calendar.ContextMenuSelectEvent(offsetMonths, monthDay, eventIndex)` + +**Parameters:** +- `offsetMonths` + - *number* +- `monthDay` + - *number* +- `eventIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md b/wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md new file mode 100644 index 00000000..ce9719d2 --- /dev/null +++ b/wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.CreateCommunitySignUpEvent + +**Content:** +Needs summary. +`C_Calendar.CreateCommunitySignUpEvent()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md b/wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md new file mode 100644 index 00000000..c9669811 --- /dev/null +++ b/wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md @@ -0,0 +1,17 @@ +## Title: C_Calendar.CreateGuildAnnouncementEvent + +**Content:** +Needs summary. +`C_Calendar.CreateGuildAnnouncementEvent()` + +**Description:** +This function is used to create a guild announcement event in the in-game calendar. Guild announcement events are typically used to inform guild members about important dates, such as raid schedules, meetings, or other significant events. + +**Example Usage:** +```lua +-- Create a guild announcement event +C_Calendar.CreateGuildAnnouncementEvent() +``` + +**Additional Information:** +This function is part of the Calendar API, which allows for the creation and management of in-game events. It is commonly used by guild management addons to automate the scheduling of events and ensure that all guild members are informed about upcoming activities. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md b/wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md new file mode 100644 index 00000000..d678a8d8 --- /dev/null +++ b/wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.CreateGuildSignUpEvent + +**Content:** +Needs summary. +`C_Calendar.CreateGuildSignUpEvent()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreatePlayerEvent.md b/wiki-information/functions/C_Calendar.CreatePlayerEvent.md new file mode 100644 index 00000000..598ba033 --- /dev/null +++ b/wiki-information/functions/C_Calendar.CreatePlayerEvent.md @@ -0,0 +1,8 @@ +## Title: C_Calendar.CreatePlayerEvent + +**Content:** +Creates a new calendar event candidate for the player. +`C_Calendar.CreatePlayerEvent()` + +**Description:** +The calendar event is finalized with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventAvailable.md b/wiki-information/functions/C_Calendar.EventAvailable.md new file mode 100644 index 00000000..48317421 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventAvailable.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.EventAvailable + +**Content:** +Accepts the invitation to the currently open event. +`C_Calendar.EventAvailable()` + +**Example Usage:** +This function can be used in an addon to automatically accept calendar event invitations, such as guild events or raid schedules. + +**Addons:** +Large addons like "Deadly Boss Mods" (DBM) or "ElvUI" might use this function to manage event invitations and ensure that users are automatically signed up for important events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventCanEdit.md b/wiki-information/functions/C_Calendar.EventCanEdit.md new file mode 100644 index 00000000..afbc1843 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventCanEdit.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventCanEdit + +**Content:** +Returns whether the event can be edited. +`canEdit = C_Calendar.EventCanEdit()` + +**Returns:** +- `canEdit` + - *boolean* - Indicates if the event can be edited. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventClearAutoApprove.md b/wiki-information/functions/C_Calendar.EventClearAutoApprove.md new file mode 100644 index 00000000..84ac408a --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventClearAutoApprove.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.EventClearAutoApprove + +**Content:** +Turns off automatic confirmations. +`C_Calendar.EventClearAutoApprove()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventClearLocked.md b/wiki-information/functions/C_Calendar.EventClearLocked.md new file mode 100644 index 00000000..ad1900b0 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventClearLocked.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.EventClearLocked + +**Content:** +Unlocks the event. +`C_Calendar.EventClearLocked()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventClearModerator.md b/wiki-information/functions/C_Calendar.EventClearModerator.md new file mode 100644 index 00000000..6366c247 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventClearModerator.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventClearModerator + +**Content:** +Needs summary. +`C_Calendar.EventClearModerator(inviteIndex)` + +**Parameters:** +- `inviteIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventDecline.md b/wiki-information/functions/C_Calendar.EventDecline.md new file mode 100644 index 00000000..e7cc202e --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventDecline.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.EventDecline + +**Content:** +Declines the invitation to the currently open event. +`C_Calendar.EventDecline()` + +**Example Usage:** +This function can be used in an addon to automatically decline calendar event invitations. For instance, if you are developing an addon that manages event participation, you could use this function to decline events that do not meet certain criteria. + +**Addons Using This Function:** +Large addons like "Calendar" or "Group Calendar" might use this function to manage event invitations, allowing users to automatically decline events based on their preferences or schedules. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetCalendarType.md b/wiki-information/functions/C_Calendar.EventGetCalendarType.md new file mode 100644 index 00000000..2f05b3bd --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetCalendarType.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventGetCalendarType + +**Content:** +Needs summary. +`calendarType = C_Calendar.EventGetCalendarType()` + +**Returns:** +- `calendarType` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetClubId.md b/wiki-information/functions/C_Calendar.EventGetClubId.md new file mode 100644 index 00000000..020c646a --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetClubId.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventGetClubId + +**Content:** +Needs summary. +`info = C_Calendar.EventGetClubId()` + +**Returns:** +- `info` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetInvite.md b/wiki-information/functions/C_Calendar.EventGetInvite.md new file mode 100644 index 00000000..90ac2b4f --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetInvite.md @@ -0,0 +1,70 @@ +## Title: C_Calendar.EventGetInvite + +**Content:** +Returns status information for an invitee for the currently opened event. +`info = C_Calendar.EventGetInvite(eventIndex)` + +**Parameters:** +- `eventIndex` + - *number* - Ranging from 1 to `C_Calendar.GetNumInvites()` + +**Returns:** +- `info` + - *CalendarEventInviteInfo* + - `Field` + - `Type` + - `Description` + - `name` + - *string?* + - `level` + - *number* + - `className` + - *string?* + - `classFilename` + - *string?* + - `inviteStatus` + - *Enum.CalendarStatus?* + - `modStatus` + - *string?* - "MODERATOR", "CREATOR" + - `inviteIsMine` + - *boolean* - True if the selected entry is the player + - `type` + - *Enum.CalendarInviteType* + - `notes` + - *string* + - `classID` + - *number?* + - `guid` + - *string* + +**Enum.CalendarStatus:** +- `Value` +- `Field` +- `Description` + - `0` + - Invited + - `1` + - Available + - `2` + - Declined + - `3` + - Confirmed + - `4` + - Out + - `5` + - Standby + - `6` + - Signedup + - `7` + - NotSignedup + - `8` + - Tentative + +**Enum.CalendarInviteType:** +- `Value` +- `Field` +- `Description` + - `0` + - Normal + - `1` + - Signup \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md b/wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md new file mode 100644 index 00000000..92cecbd4 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md @@ -0,0 +1,29 @@ +## Title: C_Calendar.EventGetInviteResponseTime + +**Content:** +Needs summary. +`time = C_Calendar.EventGetInviteResponseTime(eventIndex)` + +**Parameters:** +- `eventIndex` + - *number* + +**Returns:** +- `time` + - *Structure* - CalendarTime + - `CalendarTime` + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md b/wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md new file mode 100644 index 00000000..591a61d0 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.EventGetInviteSortCriterion + +**Content:** +Needs summary. +`criterion, reverse = C_Calendar.EventGetInviteSortCriterion()` + +**Returns:** +- `criterion` + - *string* +- `reverse` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetSelectedInvite.md b/wiki-information/functions/C_Calendar.EventGetSelectedInvite.md new file mode 100644 index 00000000..7be95ad3 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetSelectedInvite.md @@ -0,0 +1,25 @@ +## Title: C_Calendar.EventGetSelectedInvite + +**Content:** +Needs summary. +`inviteIndex = C_Calendar.EventGetSelectedInvite()` + +**Returns:** +- `inviteIndex` + - *number?* + +**Description:** +This function is used to get the index of the selected invite in the calendar event. The exact use case and return type are not well-documented, but it is typically used in the context of managing calendar events and invites. + +**Example Usage:** +```lua +local inviteIndex = C_Calendar.EventGetSelectedInvite() +if inviteIndex then + print("Selected invite index: " .. inviteIndex) +else + print("No invite selected.") +end +``` + +**Addons:** +Large addons that manage calendar events, such as "Group Calendar" or "Guild Event Manager," might use this function to handle invites to events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetStatusOptions.md b/wiki-information/functions/C_Calendar.EventGetStatusOptions.md new file mode 100644 index 00000000..d8a04804 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetStatusOptions.md @@ -0,0 +1,42 @@ +## Title: C_Calendar.EventGetStatusOptions + +**Content:** +Needs summary. +`options = C_Calendar.EventGetStatusOptions(eventIndex)` + +**Parameters:** +- `eventIndex` + - *number* + +**Returns:** +- `options` + - *CalendarEventStatusOption* + - `Field` + - `Type` + - `Description` + - `status` + - *Enum.CalendarStatus* + - `statusString` + - *string* + - `Enum.CalendarStatus` + - *Value* + - `Field` + - `Description` + - `0` + - Invited + - `1` + - Available + - `2` + - Declined + - `3` + - Confirmed + - `4` + - Out + - `5` + - Standby + - `6` + - Signedup + - `7` + - NotSignedup + - `8` + - Tentative \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetTextures.md b/wiki-information/functions/C_Calendar.EventGetTextures.md new file mode 100644 index 00000000..0a5802ea --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetTextures.md @@ -0,0 +1,44 @@ +## Title: C_Calendar.EventGetTextures + +**Content:** +Needs summary. +`textures = C_Calendar.EventGetTextures(eventType)` + +**Parameters:** +- `eventType` + - *enum* - CalendarEventType + - `Enum.CalendarEventType` + - **Value** + - **Field** + - **Description** + - `0` + - Raid + - `1` + - Dungeon + - `2` + - PvP + - `3` + - Meeting + - `4` + - Other + - `5` + - HeroicDeprecated + +**Returns:** +- `textures` + - *structure* - CalendarEventTextureInfo + - `Field` + - `Type` + - `Description` + - `title` + - *string* + - `iconTexture` + - *number* + - `expansionLevel` + - *number* + - `difficultyId` + - *number?* + - `mapId` + - *number?* + - `isLfr` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetTypes.md b/wiki-information/functions/C_Calendar.EventGetTypes.md new file mode 100644 index 00000000..882f2e53 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetTypes.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventGetTypes + +**Content:** +Needs summary. +`types = C_Calendar.EventGetTypes()` + +**Returns:** +- `types` + - *string* - See also `Enum.CalendarEventType` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md b/wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md new file mode 100644 index 00000000..e06d291e --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md @@ -0,0 +1,32 @@ +## Title: C_Calendar.EventGetTypesDisplayOrdered + +**Content:** +Needs summary. +`infos = C_Calendar.EventGetTypesDisplayOrdered()` + +**Returns:** +- `infos` + - *structure* - CalendarEventTypeDisplayInfo + - `Field` + - `Type` + - `Description` + - `displayString` + - *string* + - `eventType` + - *enum CalendarEventType* + - `Enum.CalendarEventType` + - `Value` + - `Field` + - `Description` + - `0` + - Raid + - `1` + - Dungeon + - `2` + - PvP + - `3` + - Meeting + - `4` + - Other + - `5` + - HeroicDeprecated \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventHasPendingInvite.md b/wiki-information/functions/C_Calendar.EventHasPendingInvite.md new file mode 100644 index 00000000..de38acae --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventHasPendingInvite.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventHasPendingInvite + +**Content:** +Returns whether the player has an unanswered invitation to the currently selected event. +`hasPendingInvite = C_Calendar.EventHasPendingInvite()` + +**Returns:** +- `hasPendingInvite` + - *boolean* - Indicates if there is a pending invite for the current event. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md b/wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md new file mode 100644 index 00000000..aab88781 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventHaveSettingsChanged + +**Content:** +Returns whether the currently opened event has been modified. +`haveSettingsChanged = C_Calendar.EventHaveSettingsChanged()` + +**Returns:** +- `haveSettingsChanged` + - *boolean* - Indicates if the event settings have been changed. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventInvite.md b/wiki-information/functions/C_Calendar.EventInvite.md new file mode 100644 index 00000000..b5147691 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventInvite.md @@ -0,0 +1,14 @@ +## Title: C_Calendar.EventInvite + +**Content:** +Invites a player to the currently selected event. +`C_Calendar.EventInvite(name)` + +**Parameters:** +- `name` + - *string* + +**Description:** +You can't do invites while another calendar action is pending. +Register to the event "CALENDAR_ACTION_PENDING" and using that, check with `C_Calendar.CanSendInvite` if you can invite. +Inviting a player who is already on the invitation list will result in a " has already been invited." dialog box appearing. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventRemoveInvite.md b/wiki-information/functions/C_Calendar.EventRemoveInvite.md new file mode 100644 index 00000000..78ee4cac --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventRemoveInvite.md @@ -0,0 +1,16 @@ +## Title: C_Calendar.EventRemoveInvite + +**Content:** +Needs summary. +`C_Calendar.EventRemoveInvite(inviteIndex)` +`C_Calendar.EventRemoveInviteByGuid(guid)` + +**Parameters:** + +**EventRemoveInvite:** +- `inviteIndex` + - *number* + +**EventRemoveInviteByGuid:** +- `guid` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md b/wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md new file mode 100644 index 00000000..ae26755a --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md @@ -0,0 +1,15 @@ +## Title: C_Calendar.EventRemoveInvite + +**Content:** +Needs summary. +`C_Calendar.EventRemoveInvite(inviteIndex)` +`C_Calendar.EventRemoveInviteByGuid(guid)` + +**Parameters:** +- **EventRemoveInvite:** + - `inviteIndex` + - *number* + +- **EventRemoveInviteByGuid:** + - `guid` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSelectInvite.md b/wiki-information/functions/C_Calendar.EventSelectInvite.md new file mode 100644 index 00000000..2bdc2ed9 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSelectInvite.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventSelectInvite + +**Content:** +Needs summary. +`C_Calendar.EventSelectInvite(inviteIndex)` + +**Parameters:** +- `inviteIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetAutoApprove.md b/wiki-information/functions/C_Calendar.EventSetAutoApprove.md new file mode 100644 index 00000000..c8468d16 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetAutoApprove.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.EventSetAutoApprove + +**Content:** +Needs summary. +`C_Calendar.EventSetAutoApprove()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetClubId.md b/wiki-information/functions/C_Calendar.EventSetClubId.md new file mode 100644 index 00000000..5f6740de --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetClubId.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventSetClubId + +**Content:** +Needs summary. +`C_Calendar.EventSetClubId()` + +**Parameters:** +- `clubId` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetDate.md b/wiki-information/functions/C_Calendar.EventSetDate.md new file mode 100644 index 00000000..098e6ba8 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetDate.md @@ -0,0 +1,17 @@ +## Title: C_Calendar.EventSetDate + +**Content:** +Sets the date for the currently opened event. +`C_Calendar.EventSetDate(month, monthDay, year)` + +**Parameters:** +- `month` + - *number* - 2 digits. +- `monthDay` + - *number* - 2 digits. +- `year` + - *number* - 4 digits (e.g., 2019). + +**Description:** +The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent` and similar. +The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetDescription.md b/wiki-information/functions/C_Calendar.EventSetDescription.md new file mode 100644 index 00000000..f0da4409 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetDescription.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventSetDescription + +**Content:** +Needs summary. +`C_Calendar.EventSetDescription(description)` + +**Parameters:** +- `description` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetInviteStatus.md b/wiki-information/functions/C_Calendar.EventSetInviteStatus.md new file mode 100644 index 00000000..42658bf7 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetInviteStatus.md @@ -0,0 +1,32 @@ +## Title: C_Calendar.EventSetInviteStatus + +**Content:** +Sets the invitation status of a player to the current event. +`C_Calendar.EventSetInviteStatus(eventIndex, status)` + +**Parameters:** +- `eventIndex` + - *number* +- `status` + - *Enum.CalendarStatus* + - `Value` + - `Field` + - `Description` + - `0` + - Invited + - `1` + - Available + - `2` + - Declined + - `3` + - Confirmed + - `4` + - Out + - `5` + - Standby + - `6` + - Signedup + - `7` + - NotSignedup + - `8` + - Tentative \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetLocked.md b/wiki-information/functions/C_Calendar.EventSetLocked.md new file mode 100644 index 00000000..da8d5891 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetLocked.md @@ -0,0 +1,14 @@ +## Title: C_Calendar.EventSetLocked + +**Content:** +Needs summary. +`C_Calendar.EventSetLocked()` + +**Description:** +This function is used to lock a calendar event, preventing further modifications. This can be useful in scenarios where an event organizer wants to finalize the details of an event and ensure no further changes are made. + +**Example Usage:** +An example use case for this function could be in a guild event management addon where the event organizer locks the event details once all participants have confirmed their attendance. + +**Addons:** +Large addons like "Guild Event Manager" might use this function to lock events after they have been created and confirmed by the participants. This ensures that the event details remain consistent and are not accidentally altered. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetModerator.md b/wiki-information/functions/C_Calendar.EventSetModerator.md new file mode 100644 index 00000000..7049672a --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetModerator.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventSetModerator + +**Content:** +Needs summary. +`C_Calendar.EventSetModerator(inviteIndex)` + +**Parameters:** +- `inviteIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetTextureID.md b/wiki-information/functions/C_Calendar.EventSetTextureID.md new file mode 100644 index 00000000..4042e3a9 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetTextureID.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.EventSetTextureID + +**Content:** +Needs summary. +`C_Calendar.EventSetTextureID(textureIndex)` + +**Parameters:** +- `textureIndex` + - *number* - NOT a FileDataID, but an index relating to the returned table of `API_C_Calendar.EventGetTextures`. You cannot set a custom texture, or even one outside the chosen event type. Therefore, this function currently only has an effect when using the types Raid and Dungeon. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetTime.md b/wiki-information/functions/C_Calendar.EventSetTime.md new file mode 100644 index 00000000..90c7f8ed --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetTime.md @@ -0,0 +1,15 @@ +## Title: C_Calendar.EventSetTime + +**Content:** +Sets the time for the currently opened event. +`C_Calendar.EventSetTime(hour, minute)` + +**Parameters:** +- `hour` + - *number* +- `minute` + - *number* + +**Description:** +The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent` and similar. +The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetTitle.md b/wiki-information/functions/C_Calendar.EventSetTitle.md new file mode 100644 index 00000000..3595f846 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetTitle.md @@ -0,0 +1,13 @@ +## Title: C_Calendar.EventSetTitle + +**Content:** +Sets the title for the currently opened event. +`C_Calendar.EventSetTitle(title)` + +**Parameters:** +- `title` + - *string* + +**Description:** +The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent` and similar. +The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetType.md b/wiki-information/functions/C_Calendar.EventSetType.md new file mode 100644 index 00000000..65d393e8 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSetType.md @@ -0,0 +1,30 @@ +## Title: C_Calendar.EventSetType + +**Content:** +Sets the event type for the current calendar event. +`C_Calendar.EventSetType(typeIndex)` + +**Parameters:** +- `typeIndex` + - *enum* - CalendarEventType + - `Enum.CalendarEventType` + - `Value` + - `Field` + - `Description` + - `0` + - Raid + - `1` + - Dungeon + - `2` + - PvP + - `3` + - Meeting + - `4` + - Other + - `5` + - HeroicDeprecated + +**Description:** +The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent`. +The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. +If the event type is not set before creating with `C_Calendar.AddEvent`, it defaults to 1. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSignUp.md b/wiki-information/functions/C_Calendar.EventSignUp.md new file mode 100644 index 00000000..07a00062 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSignUp.md @@ -0,0 +1,17 @@ +## Title: C_Calendar.EventSignUp + +**Content:** +Needs summary. +`C_Calendar.EventSignUp()` + +**Description:** +This function is used to sign up for an event in the in-game calendar. It is typically used in scenarios where players need to register their participation for scheduled events such as raids, dungeons, or community gatherings. + +**Example Usage:** +```lua +-- Example of signing up for an event +C_Calendar.EventSignUp() +``` + +**Addons:** +Large addons like "Deadly Boss Mods" (DBM) and "ElvUI" may use this function to automate event sign-ups or to provide enhanced calendar functionalities for guilds and communities. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSortInvites.md b/wiki-information/functions/C_Calendar.EventSortInvites.md new file mode 100644 index 00000000..3b6411c1 --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventSortInvites.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.EventSortInvites + +**Content:** +Needs summary. +`C_Calendar.EventSortInvites(criterion, reverse)` + +**Parameters:** +- `criterion` + - *string* +- `reverse` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventTentative.md b/wiki-information/functions/C_Calendar.EventTentative.md new file mode 100644 index 00000000..2c4f204b --- /dev/null +++ b/wiki-information/functions/C_Calendar.EventTentative.md @@ -0,0 +1,5 @@ +## Title: C_Calendar.EventTentative + +**Content:** +Needs summary. +`C_Calendar.EventTentative()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetClubCalendarEvents.md b/wiki-information/functions/C_Calendar.GetClubCalendarEvents.md new file mode 100644 index 00000000..20dd8135 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetClubCalendarEvents.md @@ -0,0 +1,107 @@ +## Title: C_Calendar.GetClubCalendarEvents + +**Content:** +Needs summary. +`events = C_Calendar.GetClubCalendarEvents(clubId, startTime, endTime)` + +**Parameters:** +- `clubId` + - *string* +- `startTime` + - *CalendarTime* +- `endTime` + - *CalendarTime* + +**CalendarTime Fields:** +- `year` + - *number* - The current year (e.g. 2019) +- `month` + - *number* - The current month +- `monthDay` + - *number* - The current day of the month +- `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) +- `hour` + - *number* - The current time in hours +- `minute` + - *number* - The current time in minutes + +**Returns:** +- `events` + - *CalendarDayEvent* + +**CalendarDayEvent Fields:** +- `eventID` + - *string* - Added in 8.1.0 +- `title` + - *string* +- `isCustomTitle` + - *boolean* - Added in 8.0.1 +- `startTime` + - *CalendarTime* +- `endTime` + - *CalendarTime* +- `calendarType` + - *string* - const CALENDARTYPE +- `sequenceType` + - *string* - "START", "END", "", "ONGOING" +- `eventType` + - *Enum.CalendarEventType* +- `iconTexture` + - *number?* - Added in 7.2.5 +- `modStatus` + - *string* - "MODERATOR", "CREATOR" +- `inviteStatus` + - *Enum.CalendarStatus* +- `invitedBy` + - *string* +- `difficulty` + - *number* +- `inviteType` + - *Enum.CalendarInviteType* +- `sequenceIndex` + - *number* +- `numSequenceDays` + - *number* +- `difficultyName` + - *string* +- `dontDisplayBanner` + - *boolean* +- `dontDisplayEnd` + - *boolean* +- `clubID` + - *string* - Added in 8.1.5 +- `isLocked` + - *boolean* - Added in 8.2.0 + +**CALENDARTYPE Values:** +- `"PLAYER"` - Player-created event or invitation +- `"GUILD_ANNOUNCEMENT"` - Guild announcement +- `"GUILD_EVENT"` - Guild event +- `"COMMUNITY_EVENT"` +- `"SYSTEM"` - Other server-provided event +- `"HOLIDAY"` - Seasonal/holiday events +- `"RAID_LOCKOUT"` - Instance lockouts + +**Enum.CalendarEventType Values:** +- `0` - Raid +- `1` - Dungeon +- `2` - PvP +- `3` - Meeting +- `4` - Other +- `5` - HeroicDeprecated + +**Enum.CalendarStatus Values:** +- `0` - Invited +- `1` - Available +- `2` - Declined +- `3` - Confirmed +- `4` - Out +- `5` - Standby +- `6` - Signedup +- `7` - NotSignedup +- `8` - Tentative + +**Enum.CalendarInviteType Values:** +- `0` - Normal +- `1` - Signup \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetDayEvent.md b/wiki-information/functions/C_Calendar.GetDayEvent.md new file mode 100644 index 00000000..21a19933 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetDayEvent.md @@ -0,0 +1,145 @@ +## Title: C_Calendar.GetDayEvent + +**Content:** +Retrieve information about the specified event. +`event = C_Calendar.GetDayEvent(monthOffset, monthDay, index)` + +**Parameters:** +- `monthOffset` + - *number* - the number of months to offset from today. +- `monthDay` + - *number* - the desired day of the month the event exists on. +- `index` + - *number* - the index of the desired event, from 1 through C_Calendar.GetNumDayEvents. + +**Returns:** +- `event` + - *CalendarDayEvent* + - `Field` + - `Type` + - `Description` + - `eventID` + - *string* - Added in 8.1.0 + - `title` + - *string* + - `isCustomTitle` + - *boolean* - Added in 8.0.1 + - `startTime` + - *CalendarTime* + - `endTime` + - *CalendarTime* + - `calendarType` + - *string* - const CALENDARTYPE + - `sequenceType` + - *string* - "START", "END", "", "ONGOING" + - `eventType` + - *Enum.CalendarEventType* + - `iconTexture` + - *number?* - Added in 7.2.5 + - `modStatus` + - *string* - "MODERATOR", "CREATOR" + - `inviteStatus` + - *Enum.CalendarStatus* + - `invitedBy` + - *string* + - `difficulty` + - *number* + - `inviteType` + - *Enum.CalendarInviteType* + - `sequenceIndex` + - *number* + - `numSequenceDays` + - *number* + - `difficultyName` + - *string* + - `dontDisplayBanner` + - *boolean* + - `dontDisplayEnd` + - *boolean* + - `clubID` + - *string* - Added in 8.1.5 + - `isLocked` + - *boolean* - Added in 8.2.0 + +**CalendarTime:** +- `Field` +- `Type` +- `Description` +- `year` + - *number* - The current year (e.g. 2019) +- `month` + - *number* - The current month +- `monthDay` + - *number* - The current day of the month +- `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) +- `hour` + - *number* - The current time in hours +- `minute` + - *number* - The current time in minutes + +**CALENDARTYPE:** +- `Value` +- `Description` +- `"PLAYER"` + - Player-created event or invitation +- `"GUILD_ANNOUNCEMENT"` + - Guild announcement +- `"GUILD_EVENT"` + - Guild event +- `"COMMUNITY_EVENT"` +- `"SYSTEM"` + - Other server-provided event +- `"HOLIDAY"` + - Seasonal/holiday events +- `"RAID_LOCKOUT"` + - Instance lockouts + +**Enum.CalendarEventType:** +- `Value` +- `Field` +- `Description` +- `0` + - Raid +- `1` + - Dungeon +- `2` + - PvP +- `3` + - Meeting +- `4` + - Other +- `5` + - HeroicDeprecated + +**Enum.CalendarStatus:** +- `Value` +- `Field` +- `Description` +- `0` + - Invited +- `1` + - Available +- `2` + - Declined +- `3` + - Confirmed +- `4` + - Out +- `5` + - Standby +- `6` + - Signedup +- `7` + - NotSignedup +- `8` + - Tentative + +**Enum.CalendarInviteType:** +- `Value` +- `Field` +- `Description` +- `0` + - Normal +- `1` + - Signup \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md b/wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md new file mode 100644 index 00000000..64b8b6d5 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md @@ -0,0 +1,18 @@ +## Title: C_Calendar.GetDefaultGuildFilter + +**Content:** +Needs summary. +`info = C_Calendar.GetDefaultGuildFilter()` + +**Returns:** +- `info` + - *structure* - CalendarGuildFilterInfo + - `Field` + - `Type` + - `Description` + - `minLevel` + - *number* + - `maxLevel` + - *number* + - `rank` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetEventIndex.md b/wiki-information/functions/C_Calendar.GetEventIndex.md new file mode 100644 index 00000000..62c96a19 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetEventIndex.md @@ -0,0 +1,19 @@ +## Title: C_Calendar.GetEventIndex + +**Content:** +Needs summary. +`info = C_Calendar.GetEventIndex()` + +**Returns:** +- `info` + - *structure* - `CalendarEventIndexInfo` + - `CalendarEventIndexInfo` + - `Field` + - `Type` + - `Description` + - `offsetMonths` + - *number* + - `monthDay` + - *number* + - `eventIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetEventIndexInfo.md b/wiki-information/functions/C_Calendar.GetEventIndexInfo.md new file mode 100644 index 00000000..85f183cf --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetEventIndexInfo.md @@ -0,0 +1,27 @@ +## Title: C_Calendar.GetEventIndexInfo + +**Content:** +Needs summary. +`eventIndexInfo = C_Calendar.GetEventIndexInfo(eventID)` + +**Parameters:** +- `eventID` + - *string* +- `monthOffset` + - *number?* +- `monthDay` + - *number?* + +**Returns:** +- `eventIndexInfo` + - *structure* - CalendarEventIndexInfo (nilable) + - `CalendarEventIndexInfo` + - `Field` + - `Type` + - `Description` + - `offsetMonths` + - *number* + - `monthDay` + - *number* + - `eventIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetEventInfo.md b/wiki-information/functions/C_Calendar.GetEventInfo.md new file mode 100644 index 00000000..1b663d5b --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetEventInfo.md @@ -0,0 +1,140 @@ +## Title: C_Calendar.GetEventInfo + +**Content:** +Returns info for a calendar event. +`info = C_Calendar.GetEventInfo()` + +**Returns:** +- `info` + - *CalendarEventInfo* + - `Field` + - `Type` + - `Description` + - `title` + - *string* + - `description` + - *string* + - `creator` + - *string?* - The name of the character who created the event. + - `eventType` + - *Enum.CalendarEventType* - The type of event as specified by `C_Calendar.EventSetType`. + - `repeatOption` + - *Enum.CalendarEventRepeatOptions* - The repeat setting. + - `maxSize` + - *number* - Usually 100. + - `textureIndex` + - *number?* - The index of the event's texture in the list returned by `C_Calendar.EventGetTextures`. + - `time` + - *CalendarTime* - When the event occurs. + - `lockoutTime` + - *CalendarTime* + - `isLocked` + - *boolean* - Whether the event is locked. + - `isAutoApprove` + - *boolean* - Whether signups to the event should be automatically approved. + - `hasPendingInvite` + - *boolean* - Whether the player has been invited to this event and has not yet responded. + - `inviteStatus` + - *Enum.CalendarStatus?* - The character's current invite status for the event. + - `inviteType` + - *Enum.CalendarInviteType?* + - `calendarType` + - *string* - const `CALENDARTYPE` + - `communityName` + - *string?* + +**Enum.CalendarEventType** +- `Value` +- `Field` +- `Description` + - `0` + - Raid + - `1` + - Dungeon + - `2` + - PvP + - `3` + - Meeting + - `4` + - Other + - `5` + - HeroicDeprecated + +**Enum.CalendarEventRepeatOptions** +- `Value` +- `Field` +- `Description` + - `0` + - Never + - `1` + - Weekly + - `2` + - Biweekly + - `3` + - Monthly + +**CalendarTime** +- `Field` +- `Type` +- `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes + +**Enum.CalendarStatus** +- `Value` +- `Field` +- `Description` + - `0` + - Invited + - `1` + - Available + - `2` + - Declined + - `3` + - Confirmed + - `4` + - Out + - `5` + - Standby + - `6` + - Signedup + - `7` + - NotSignedup + - `8` + - Tentative + +**Enum.CalendarInviteType** +- `Value` +- `Field` +- `Description` + - `0` + - Normal + - `1` + - Signup + +**CALENDARTYPE** +- `Value` +- `Description` + - `"PLAYER"` + - Player-created event or invitation + - `"GUILD_ANNOUNCEMENT"` + - Guild announcement + - `"GUILD_EVENT"` + - Guild event + - `"COMMUNITY_EVENT"` + - `"SYSTEM"` + - Other server-provided event + - `"HOLIDAY"` + - Seasonal/holiday events + - `"RAID_LOCKOUT"` + - Instance lockouts \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetFirstPendingInvite.md b/wiki-information/functions/C_Calendar.GetFirstPendingInvite.md new file mode 100644 index 00000000..5e4434da --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetFirstPendingInvite.md @@ -0,0 +1,15 @@ +## Title: C_Calendar.GetFirstPendingInvite + +**Content:** +Needs summary. +`firstPendingInvite = C_Calendar.GetFirstPendingInvite(offsetMonths, monthDay)` + +**Parameters:** +- `offsetMonths` + - *number* +- `monthDay` + - *number* + +**Returns:** +- `firstPendingInvite` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetGuildEventInfo.md b/wiki-information/functions/C_Calendar.GetGuildEventInfo.md new file mode 100644 index 00000000..f7c4c7ce --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetGuildEventInfo.md @@ -0,0 +1,59 @@ +## Title: C_Calendar.GetGuildEventInfo + +**Content:** +Needs summary. +`info = C_Calendar.GetGuildEventInfo(index)` + +**Parameters:** +- `index` + - *number* + +**Returns:** +- `info` + - *CalendarGuildEventInfo* + - `Field` + - `Type` + - `Description` + - `eventID` + - *string* + - `year` + - *number* + - `month` + - *number* + - `monthDay` + - *number* + - `weekday` + - *number* + - `hour` + - *number* + - `minute` + - *number* + - `eventType` + - *Enum.CalendarEventType* + - `title` + - *string* + - `calendarType` + - *string* + - `texture` + - *number* + - `inviteStatus` + - *number* + - `clubID` + - *string* + +**Enum.CalendarEventType:** +- `Value` +- `Field` +- `Description` + - `0` + - Raid + - `1` + - Dungeon + - `2` + - PvP + - `3` + - Meeting + - `4` + - Other + - `5` + - HeroicDeprecated \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md b/wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md new file mode 100644 index 00000000..f24e66e6 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md @@ -0,0 +1,23 @@ +## Title: C_Calendar.GetGuildEventSelectionInfo + +**Content:** +Needs summary. +`info = C_Calendar.GetGuildEventSelectionInfo(index)` + +**Parameters:** +- `index` + - *number* + +**Returns:** +- `info` + - *structure* - CalendarEventIndexInfo + - `CalendarEventIndexInfo` + - `Field` + - `Type` + - `Description` + - `offsetMonths` + - *number* + - `monthDay` + - *number* + - `eventIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetHolidayInfo.md b/wiki-information/functions/C_Calendar.GetHolidayInfo.md new file mode 100644 index 00000000..3f3cc5bd --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetHolidayInfo.md @@ -0,0 +1,46 @@ +## Title: C_Calendar.GetHolidayInfo + +**Content:** +Returns seasonal holiday info. +`event = C_Calendar.GetHolidayInfo(monthOffset, monthDay, index)` + +**Parameters:** +- `monthOffset` + - *number* - The offset from the current month (only accepts 0 or 1). +- `monthDay` + - *number* - The day of the month. +- `index` + - *number* + +**Returns:** +- `event` + - *CalendarHolidayInfo* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `description` + - *string* + - `texture` + - *number* + - `startTime` + - *CalendarTime?* + - `endTime` + - *CalendarTime?* + - `CalendarTime` + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetMaxCreateDate.md b/wiki-information/functions/C_Calendar.GetMaxCreateDate.md new file mode 100644 index 00000000..76782ac5 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetMaxCreateDate.md @@ -0,0 +1,28 @@ +## Title: C_Calendar.GetMaxCreateDate + +**Content:** +Returns the last day supported by the Calendar API. +`maxCreateDate = C_Calendar.GetMaxCreateDate()` + +**Returns:** +- `maxCreateDate` + - *structure* - CalendarTime + - `CalendarTime` + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes + +**Description:** +As of the 21st of March 2019, the date returned by this function on EU realms is Tuesday the 31st of March, 2020. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetMinDate.md b/wiki-information/functions/C_Calendar.GetMinDate.md new file mode 100644 index 00000000..86f67a8e --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetMinDate.md @@ -0,0 +1,28 @@ +## Title: C_Calendar.GetMinDate + +**Content:** +Returns the first day supported by the Calendar API. +`minDate = C_Calendar.GetMinDate()` + +**Returns:** +- `minDate` + - *structure* - CalendarTime + - `CalendarTime` + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes + +**Description:** +As of Patch 8.1.5, the date returned by this function on EU realms is Wednesday the 24th of November, 2004. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetMonthInfo.md b/wiki-information/functions/C_Calendar.GetMonthInfo.md new file mode 100644 index 00000000..b8907292 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetMonthInfo.md @@ -0,0 +1,27 @@ +## Title: C_Calendar.GetMonthInfo + +**Content:** +Returns information about the calendar month by offset. +`monthInfo = C_Calendar.GetMonthInfo()` + +**Parameters:** +- `offsetMonths` + - *number? = 0* - Offset in months from the currently selected Calendar month, positive numbers indicating future months. + +**Returns:** +- `monthInfo` + - *structure* - CalendarMonthInfo + - `Field` + - `Type` + - `Description` + - `month` + - *number* - Month index (1-12) + - `year` + - *number* - Year at the offset date (2004+) + - `numDays` + - *number* - Number of days in the month (28-31) + - `firstWeekday` + - *number* - Weekday on which the month begins (1 = Sunday, 2 = Monday, ..., 7 = Saturday) + +**Description:** +This function returns information based on the currently selected calendar month (per `C_Calendar.SetMonth`). Prior to opening the calendar for the first time in a given session, this is set to `C_Calendar.GetMinDate` (i.e. November 2004). \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNextClubId.md b/wiki-information/functions/C_Calendar.GetNextClubId.md new file mode 100644 index 00000000..ff7128e6 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetNextClubId.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.GetNextClubId + +**Content:** +Needs summary. +`clubId = C_Calendar.GetNextClubId()` + +**Returns:** +- `clubId` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumDayEvents.md b/wiki-information/functions/C_Calendar.GetNumDayEvents.md new file mode 100644 index 00000000..109ce019 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetNumDayEvents.md @@ -0,0 +1,15 @@ +## Title: C_Calendar.GetNumDayEvents + +**Content:** +Returns the number of events for a given day/month offset. +`numDayEvents = C_Calendar.GetNumDayEvents(offsetMonths, monthDay)` + +**Parameters:** +- `offsetMonths` + - *number* - The number of months to advance from today. +- `monthDay` + - *number* - The day of the given month. + +**Returns:** +- `numDayEvents` + - *number* - The number of events on the day in question. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumGuildEvents.md b/wiki-information/functions/C_Calendar.GetNumGuildEvents.md new file mode 100644 index 00000000..2b7f9936 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetNumGuildEvents.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.GetNumGuildEvents + +**Content:** +Needs summary. +`numGuildEvents = C_Calendar.GetNumGuildEvents()` + +**Returns:** +- `numGuildEvents` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumInvites.md b/wiki-information/functions/C_Calendar.GetNumInvites.md new file mode 100644 index 00000000..4d334aa3 --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetNumInvites.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.GetNumInvites + +**Content:** +Returns the number of invitees for the currently opened event. +`num = C_Calendar.GetNumInvites()` + +**Returns:** +- `num` + - *number* - The number of invitees for the currently opened event. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumPendingInvites.md b/wiki-information/functions/C_Calendar.GetNumPendingInvites.md new file mode 100644 index 00000000..2661a85f --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetNumPendingInvites.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.GetNumPendingInvites + +**Content:** +Needs summary. +`num = C_Calendar.GetNumPendingInvites()` + +**Returns:** +- `num` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetRaidInfo.md b/wiki-information/functions/C_Calendar.GetRaidInfo.md new file mode 100644 index 00000000..7735b59a --- /dev/null +++ b/wiki-information/functions/C_Calendar.GetRaidInfo.md @@ -0,0 +1,49 @@ +## Title: C_Calendar.GetRaidInfo + +**Content:** +Needs summary. +`info = C_Calendar.GetRaidInfo(offsetMonths, monthDay, eventIndex)` + +**Parameters:** +- `offsetMonths` + - *number* +- `monthDay` + - *number* +- `eventIndex` + - *number* + +**Returns:** +- `info` + - *structure* - CalendarRaidInfo + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `calendarType` + - *string* + - `raidID` + - *number* + - `time` + - *structure* - CalendarTime + - `difficulty` + - *number* + - `difficultyName` + - *string?* + +**CalendarTime:** +- `Field` +- `Type` +- `Description` +- `year` + - *number* - The current year (e.g. 2019) +- `month` + - *number* - The current month +- `monthDay` + - *number* - The current day of the month +- `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) +- `hour` + - *number* - The current time in hours +- `minute` + - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.IsActionPending.md b/wiki-information/functions/C_Calendar.IsActionPending.md new file mode 100644 index 00000000..98244832 --- /dev/null +++ b/wiki-information/functions/C_Calendar.IsActionPending.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.IsActionPending + +**Content:** +Needs summary. +`actionPending = C_Calendar.IsActionPending()` + +**Returns:** +- `actionPending` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.IsEventOpen.md b/wiki-information/functions/C_Calendar.IsEventOpen.md new file mode 100644 index 00000000..8d3aff9d --- /dev/null +++ b/wiki-information/functions/C_Calendar.IsEventOpen.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.IsEventOpen + +**Content:** +Needs summary. +`isOpen = C_Calendar.IsEventOpen()` + +**Returns:** +- `isOpen` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.MassInviteCommunity.md b/wiki-information/functions/C_Calendar.MassInviteCommunity.md new file mode 100644 index 00000000..c0ac3fda --- /dev/null +++ b/wiki-information/functions/C_Calendar.MassInviteCommunity.md @@ -0,0 +1,15 @@ +## Title: C_Calendar.MassInviteCommunity + +**Content:** +Needs summary. +`C_Calendar.MassInviteCommunity(clubId, minLevel, maxLevel)` + +**Parameters:** +- `clubId` + - *string* +- `minLevel` + - *number* +- `maxLevel` + - *number* +- `maxRankOrder` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.MassInviteGuild.md b/wiki-information/functions/C_Calendar.MassInviteGuild.md new file mode 100644 index 00000000..37efefb3 --- /dev/null +++ b/wiki-information/functions/C_Calendar.MassInviteGuild.md @@ -0,0 +1,22 @@ +## Title: C_Calendar.MassInviteGuild + +**Content:** +Needs summary. +`C_Calendar.MassInviteGuild(minLevel, maxLevel, maxRankOrder)` + +**Parameters:** +- `minLevel` + - *number* +- `maxLevel` + - *number* +- `maxRankOrder` + - *number* + +**Example Usage:** +This function can be used to mass invite guild members to a calendar event based on their level and rank. For instance, if you want to invite all guild members between levels 10 and 50 who are of rank 3 or lower, you would call: +```lua +C_Calendar.MassInviteGuild(10, 50, 3) +``` + +**Addons:** +Large addons like **Guild Event Manager** might use this function to automate the process of inviting guild members to events, ensuring that only members who meet certain criteria are invited. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.OpenCalendar.md b/wiki-information/functions/C_Calendar.OpenCalendar.md new file mode 100644 index 00000000..319422cc --- /dev/null +++ b/wiki-information/functions/C_Calendar.OpenCalendar.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.OpenCalendar + +**Content:** +Requests calendar information from the server. Does not open the calendar frame. +`C_Calendar.OpenCalendar()` + +**Description:** +Fires `CALENDAR_UPDATE_EVENT_LIST` when your query has finished processing on the server and new calendar information is available. +If called during the loading process, (even at `PLAYER_ENTERING_WORLD`) the query will not return. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.OpenEvent.md b/wiki-information/functions/C_Calendar.OpenEvent.md new file mode 100644 index 00000000..5443e412 --- /dev/null +++ b/wiki-information/functions/C_Calendar.OpenEvent.md @@ -0,0 +1,17 @@ +## Title: C_Calendar.OpenEvent + +**Content:** +Establishes an event for future calendar API calls +`success = C_Calendar.OpenEvent(offsetMonths, monthDay, index)` + +**Parameters:** +- `offsetMonths` + - *number* - The number of months to offset from today. +- `monthDay` + - *number* - The day of the month on which the desired event is scheduled (1 - 31). +- `index` + - *number* - Ranging from 1 through `C_Calendar.GetNumDayEvents(offsetMonths, monthDay)`. + +**Returns:** +- `success` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.RemoveEvent.md b/wiki-information/functions/C_Calendar.RemoveEvent.md new file mode 100644 index 00000000..f41ac9e5 --- /dev/null +++ b/wiki-information/functions/C_Calendar.RemoveEvent.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.RemoveEvent + +**Content:** +Removes the selected event from the calendar (invitees only). +`C_Calendar.RemoveEvent()` + +**Example Usage:** +This function can be used in an addon to allow users to remove events they have been invited to from their in-game calendar. For instance, a guild management addon might use this function to help members manage their event schedules by removing events they no longer wish to attend. + +**Addons Using This Function:** +Large addons like "Guild Calendar" or "Group Calendar" might use this function to manage calendar events, allowing users to remove events they are no longer interested in attending. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.SetAbsMonth.md b/wiki-information/functions/C_Calendar.SetAbsMonth.md new file mode 100644 index 00000000..773013ea --- /dev/null +++ b/wiki-information/functions/C_Calendar.SetAbsMonth.md @@ -0,0 +1,11 @@ +## Title: C_Calendar.SetAbsMonth + +**Content:** +Sets the reference month and year for functions which use a month offset. +`C_Calendar.SetAbsMonth(month, year)` + +**Parameters:** +- `month` + - *number* +- `year` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.SetMonth.md b/wiki-information/functions/C_Calendar.SetMonth.md new file mode 100644 index 00000000..d407a158 --- /dev/null +++ b/wiki-information/functions/C_Calendar.SetMonth.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.SetMonth + +**Content:** +Needs summary. +`C_Calendar.SetMonth(offsetMonths)` + +**Parameters:** +- `offsetMonths` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.SetNextClubId.md b/wiki-information/functions/C_Calendar.SetNextClubId.md new file mode 100644 index 00000000..4d540ce6 --- /dev/null +++ b/wiki-information/functions/C_Calendar.SetNextClubId.md @@ -0,0 +1,9 @@ +## Title: C_Calendar.SetNextClubId + +**Content:** +Needs summary. +`C_Calendar.SetNextClubId()` + +**Parameters:** +- `clubId` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.UpdateEvent.md b/wiki-information/functions/C_Calendar.UpdateEvent.md new file mode 100644 index 00000000..97fe05e3 --- /dev/null +++ b/wiki-information/functions/C_Calendar.UpdateEvent.md @@ -0,0 +1,8 @@ +## Title: C_Calendar.UpdateEvent + +**Content:** +Saves the selected event. +`C_Calendar.UpdateEvent()` + +**Description:** +The calendar event must be previously opened with `C_Calendar.OpenEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md b/wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md new file mode 100644 index 00000000..95b243ad --- /dev/null +++ b/wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md @@ -0,0 +1,19 @@ +## Title: C_CameraDefaults.GetCameraFOVDefaults + +**Content:** +Needs summary. +`fieldOfViewDegreesDefault, fieldOfViewDegreesPlayerMin, fieldOfViewDegreesPlayerMax = C_CameraDefaults.GetCameraFOVDefaults()` + +**Returns:** +- `fieldOfViewDegreesDefault` + - *number* +- `fieldOfViewDegreesPlayerMin` + - *number* +- `fieldOfViewDegreesPlayerMax` + - *number* + +**Example Usage:** +This function can be used to retrieve the default field of view (FOV) settings for the camera in World of Warcraft. This can be particularly useful for addons that aim to modify or reset camera settings to their default values. + +**Addon Usage:** +Large addons that deal with camera settings or provide custom camera controls, such as DynamicCam, might use this function to ensure they are working within the default FOV parameters set by the game. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md b/wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md new file mode 100644 index 00000000..f53fa926 --- /dev/null +++ b/wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md @@ -0,0 +1,16 @@ +## Title: C_ChatBubbles.GetAllChatBubbles + +**Content:** +Returns all active chat bubbles. +`chatBubbles = C_ChatBubbles.GetAllChatBubbles()` + +**Parameters:** +- `includeForbidden` + - *boolean?* = false + +**Returns:** +- `chatBubbles` + - *Widget_API* + +**Description:** +Previously it was required to iterate over the WorldFrame children to access the chat bubbles. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.CanReportPlayer.md b/wiki-information/functions/C_ChatInfo.CanReportPlayer.md new file mode 100644 index 00000000..1e10c630 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.CanReportPlayer.md @@ -0,0 +1,13 @@ +## Title: C_ChatInfo.CanReportPlayer + +**Content:** +Returns if a player can be reported. +`canReport = C_ReportSystem.CanReportPlayer(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin*🔗 + +**Returns:** +- `canReport` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md b/wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md new file mode 100644 index 00000000..d01a0b5e --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md @@ -0,0 +1,40 @@ +## Title: C_ChatInfo.GetChannelInfoFromIdentifier + +**Content:** +Needs summary. +`info = C_ChatInfo.GetChannelInfoFromIdentifier(channelIdentifier)` + +**Parameters:** +- `channelIdentifier` + - *string* + +**Returns:** +- `info` + - *ChatChannelInfo?* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `shortcut` + - *string* + - `localID` + - *number* + - `instanceID` + - *number* + - `zoneChannelID` + - *number* + - `channelType` + - *Enum.PermanentChatChannelType* + - `Enum.PermanentChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Zone + - `2` + - Communities + - `3` + - Custom \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md b/wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md new file mode 100644 index 00000000..18dc71fa --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md @@ -0,0 +1,21 @@ +## Title: C_ChatInfo.GetChannelRosterInfo + +**Content:** +Needs summary. +`name, owner, moderator, guid = C_ChatInfo.GetChannelRosterInfo(channelIndex, rosterIndex)` + +**Parameters:** +- `channelIndex` + - *number* +- `rosterIndex` + - *number* + +**Returns:** +- `name` + - *string* +- `owner` + - *boolean* +- `moderator` + - *boolean* +- `guid` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelShortcut.md b/wiki-information/functions/C_ChatInfo.GetChannelShortcut.md new file mode 100644 index 00000000..6df6a411 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChannelShortcut.md @@ -0,0 +1,18 @@ +## Title: C_ChatInfo.GetChannelShortcut + +**Content:** +Needs summary. +`shortcut = C_ChatInfo.GetChannelShortcut(channelIndex)` +`shortcut = C_ChatInfo.GetChannelShortcutForChannelID(channelID)` + +**Parameters:** +- `GetChannelShortcut:` + - `channelIndex` + - *number* +- `GetChannelShortcutForChannelID:` + - `channelID` + - *number* + +**Returns:** +- `shortcut` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md b/wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md new file mode 100644 index 00000000..6df6a411 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md @@ -0,0 +1,18 @@ +## Title: C_ChatInfo.GetChannelShortcut + +**Content:** +Needs summary. +`shortcut = C_ChatInfo.GetChannelShortcut(channelIndex)` +`shortcut = C_ChatInfo.GetChannelShortcutForChannelID(channelID)` + +**Parameters:** +- `GetChannelShortcut:` + - `channelIndex` + - *number* +- `GetChannelShortcutForChannelID:` + - `channelID` + - *number* + +**Returns:** +- `shortcut` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md b/wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md new file mode 100644 index 00000000..7a049ebe --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md @@ -0,0 +1,13 @@ +## Title: C_ChatInfo.GetChatLineSenderGUID + +**Content:** +Needs summary. +`guid = C_ChatInfo.GetChatLineSenderGUID(chatLine)` + +**Parameters:** +- `chatLine` + - *number* + +**Returns:** +- `guid` + - *string* : WOWGUID \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md b/wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md new file mode 100644 index 00000000..16a86bc1 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md @@ -0,0 +1,13 @@ +## Title: C_ChatInfo.GetChatLineSenderName + +**Content:** +Needs summary. +`name = C_ChatInfo.GetChatLineSenderName(chatLine)` + +**Parameters:** +- `chatLine` + - *number* + +**Returns:** +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatLineText.md b/wiki-information/functions/C_ChatInfo.GetChatLineText.md new file mode 100644 index 00000000..d79109b7 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChatLineText.md @@ -0,0 +1,13 @@ +## Title: C_ChatInfo.GetChatLineText + +**Content:** +Needs summary. +`text = C_ChatInfo.GetChatLineText(chatLine)` + +**Parameters:** +- `chatLine` + - *number* + +**Returns:** +- `text` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatTypeName.md b/wiki-information/functions/C_ChatInfo.GetChatTypeName.md new file mode 100644 index 00000000..8eb27214 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetChatTypeName.md @@ -0,0 +1,19 @@ +## Title: C_ChatInfo.GetChatTypeName + +**Content:** +Needs summary. +`name = C_ChatInfo.GetChatTypeName(typeID)` + +**Parameters:** +- `typeID` + - *number* + +**Returns:** +- `name` + - *string?* + +**Example Usage:** +This function can be used to retrieve the name of a chat type based on its type ID. For instance, if you have a type ID and you want to know the corresponding chat type name, you can use this function to get that information. + +**Addons Usage:** +Large addons that manage or enhance chat functionalities, such as Prat or Chatter, might use this function to dynamically handle different chat types based on their IDs. This allows for more flexible and robust chat management features. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md b/wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md new file mode 100644 index 00000000..b1b68ca0 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md @@ -0,0 +1,9 @@ +## Title: C_ChatInfo.GetNumActiveChannels + +**Content:** +Needs summary. +`numChannels = C_ChatInfo.GetNumActiveChannels()` + +**Returns:** +- `numChannels` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md b/wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md new file mode 100644 index 00000000..6f858f4a --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md @@ -0,0 +1,19 @@ +## Title: C_ChatInfo.GetRegisteredAddonMessagePrefixes + +**Content:** +Returns addon message prefixes the client is currently registered to receive. +`registeredPrefixes = C_ChatInfo.GetRegisteredAddonMessagePrefixes()` + +**Returns:** +- `registeredPrefixes` + - *string* + +**Reference:** +- `C_ChatInfo.IsAddonMessagePrefixRegistered()` +- `C_ChatInfo.RegisterAddonMessagePrefix()` + +**Example Usage:** +This function can be used to retrieve a list of all addon message prefixes that the client is currently set up to handle. This is useful for debugging or for ensuring that your addon is properly registered to communicate with other addons. + +**Addon Usage:** +Many large addons, such as WeakAuras, use this function to manage communication between different users' clients. By checking which prefixes are registered, the addon can ensure it is able to send and receive the necessary messages for its functionality. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md b/wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md new file mode 100644 index 00000000..3d54ff5d --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md @@ -0,0 +1,23 @@ +## Title: C_ChatInfo.IsAddonMessagePrefixRegistered + +**Content:** +Returns whether the prefix is registered. +`isRegistered = C_ChatInfo.IsAddonMessagePrefixRegistered(prefix)` + +**Parameters:** +- `prefix` + - *string* + +**Returns:** +- `isRegistered` + - *boolean* + +**Reference:** +- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` +- `C_ChatInfo.RegisterAddonMessagePrefix()` + +### Example Usage: +This function can be used to check if a specific prefix for addon communication is already registered before attempting to register it again. This is useful in preventing duplicate registrations which can lead to errors or unexpected behavior. + +### Addon Usage: +Many large addons, such as WeakAuras, use this function to manage their communication channels. For instance, WeakAuras uses custom prefixes to send data between players, ensuring that the prefix is registered before sending messages to avoid conflicts. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsChatLineCensored.md b/wiki-information/functions/C_ChatInfo.IsChatLineCensored.md new file mode 100644 index 00000000..c3e2d1fb --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.IsChatLineCensored.md @@ -0,0 +1,13 @@ +## Title: C_ChatInfo.IsChatLineCensored + +**Content:** +Needs summary. +`isCensored = C_ChatInfo.IsChatLineCensored(chatLine)` + +**Parameters:** +- `chatLine` + - *number* + +**Returns:** +- `isCensored` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsPartyChannelType.md b/wiki-information/functions/C_ChatInfo.IsPartyChannelType.md new file mode 100644 index 00000000..9529b594 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.IsPartyChannelType.md @@ -0,0 +1,29 @@ +## Title: C_ChatInfo.IsPartyChannelType + +**Content:** +Needs summary. +`isPartyChannelType = C_ChatInfo.IsPartyChannelType(channelType)` + +**Parameters:** +- `channelType` + - *Enum.ChatChannelType* + - `Enum.ChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` + - `None` + - `1` + - `Custom` + - `2` + - `Private_Party` + - Documented as "PrivateParty" + - `3` + - `Public_Party` + - Documented as "PublicParty" + - `4` + - `Communities` + +**Returns:** +- `isPartyChannelType` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsValidChatLine.md b/wiki-information/functions/C_ChatInfo.IsValidChatLine.md new file mode 100644 index 00000000..7568151b --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.IsValidChatLine.md @@ -0,0 +1,13 @@ +## Title: C_ChatInfo.IsValidChatLine + +**Content:** +Needs summary. +`isValid = C_ChatInfo.IsValidChatLine()` + +**Parameters:** +- `chatLine` + - *number?* + +**Returns:** +- `isValid` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md b/wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md new file mode 100644 index 00000000..7571ff49 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md @@ -0,0 +1,28 @@ +## Title: C_ChatInfo.RegisterAddonMessagePrefix + +**Content:** +Registers an addon message prefix to receive messages for that prefix. +`result = C_ChatInfo.RegisterAddonMessagePrefix(prefix)` + +**Parameters:** +- `prefix` + - *string* - The message prefix to register for delivery, at most 16 characters. + +**Returns:** +- `result` + - *Enum.RegisterAddonMessagePrefixResult* - Result code indicating if the prefix was registered successfully. + +**Description:** +Registering prefixes does not persist after doing a /reload. +It's recommended to use the addon name as a prefix (provided it fits within the 16 byte limit) since it's more likely to be unique and other addon authors will have an easier time instead of figuring out what addon a certain abbreviation belongs to. See the Globe wut page for a list of addons that use this API to avoid collisions. + +**Reference:** +- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` +- `C_ChatInfo.IsAddonMessagePrefixRegistered()` +- `C_ChatInfo.SendAddonMessage()` + +**Example Usage:** +This function can be used to register a custom prefix for an addon to communicate with other players using the same addon. For example, an addon named "MyAddon" could register the prefix "MyAddonMsg" to send and receive messages specific to that addon. + +**Addons Using This API:** +Many large addons, such as "WeakAuras" and "DBM (Deadly Boss Mods)", use this API to handle inter-addon communication. They register specific prefixes to send data between users running the same addon, ensuring coordinated behavior and data sharing. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.ReportPlayer.md b/wiki-information/functions/C_ChatInfo.ReportPlayer.md new file mode 100644 index 00000000..39617f06 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.ReportPlayer.md @@ -0,0 +1,44 @@ +## Title: C_ReportSystem.OpenReportPlayerDialog + +**Content:** +Opens the dialog for reporting a player. +`C_ReportSystem.OpenReportPlayerDialog(reportType, playerName)` + +**Parameters:** +- `reportType` + - *string* - One of the strings found in PLAYER_REPORT_TYPE +- `playerName` + - *string* - Name of the player being reported +- `playerLocation` + - *PlayerLocationMixin* + +**PLAYER_REPORT_TYPE Constants:** +- `PLAYER_REPORT_TYPE` + - *Constant* - *Value* + - `PLAYER_REPORT_TYPE_SPAM` + - *spam* + - `PLAYER_REPORT_TYPE_LANGUAGE` + - *language* + - `PLAYER_REPORT_TYPE_ABUSE` + - *abuse* + - `PLAYER_REPORT_TYPE_BAD_PLAYER_NAME` + - *badplayername* + - `PLAYER_REPORT_TYPE_BAD_GUILD_NAME` + - *badguildname* + - `PLAYER_REPORT_TYPE_CHEATING` + - *cheater* + - `PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME` + - *badbattlepetname* + - `PLAYER_REPORT_TYPE_BAD_PET_NAME` + - *badpetname* + +**Description:** +This function is not protected and therefore available to Addons, unlike `C_ReportSystem.InitiateReportPlayer` and `C_ReportSystem.SendReportPlayer`. +This reporting restriction was added because AddOn BadBoy allegedly sent out a number of false positives. +Triggers `OPEN_REPORT_PLAYER` once the window is open. + +**Usage:** +Opens the spam report dialog for the current target. +```lua +/run C_ReportSystem.OpenReportPlayerDialog(PLAYER_REPORT_TYPE_SPAM, UnitName("target"), PlayerLocation:CreateFromUnit("target")) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.SendAddonMessage.md b/wiki-information/functions/C_ChatInfo.SendAddonMessage.md new file mode 100644 index 00000000..88fad19f --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.SendAddonMessage.md @@ -0,0 +1,153 @@ +## Title: C_ChatInfo.SendAddonMessage + +**Content:** +Sends a message over an addon comm channel. +`result = C_ChatInfo.SendAddonMessage(prefix, message )` +`= C_ChatInfo.SendAddonMessageLogged` + +**Parameters:** +- `prefix` + - *string* - Message prefix, can be used as your addon identifier; at most 16 characters. +- `message` + - *string* - Text to send, at most 255 characters. All characters (decimal ID 1-255) are permissible except NULL (ASCII 0). +- `chatType` + - *string? = PARTY* - The addon channel to send to. +- `target` + - *string|number?* - The player name or custom channel number receiving the message for "WHISPER" or "CHANNEL" chatTypes. + +**Returns:** +- `result` + - *Enum.SendAddonMessageResult* - Result code indicating if the message has been enqueued by the API for submission. This does not mean that the message has yet been sent, and may still be subject to any server-side throttling. + +**Miscellaneous:** +- `chatType` + - **Retail** + - **Classic** + - **Description** + - `"PARTY"` + - ✔️ + - ✔️ + - Addon message to party members. + - `"RAID"` + - ✔️ + - ✔️ + - Addon message to raid members. If not in a raid group, the message will instead be sent on the PARTY chat type. + - `"INSTANCE_CHAT"` + - ✔️ + - ✔️ + - Addon message to grouped players in instanced content such as dungeons, raids and battlegrounds. + - `"GUILD"` + - ✔️ + - ✔️ + - Addon message to guild members. Prints a "You are not in a guild." system message if you're not in a guild. + - `"OFFICER"` + - ✔️ + - ✔️ + - Addon message to guild officers. + - `"WHISPER"` + - ✔️ + - ✔️ + - Addon message to a player. Only works for players on the same or any connected realms. Use player name as target argument. Prints a "Player is offline." system message if the target is offline. + - `"CHANNEL"` + - ✔️ + - ❌ + - Addon message to a custom chat channel. Use channel number as target argument. Disabled on Classic to prevent players communicating over custom chat channels. + - `"SAY"` + - ❌ + - ✔️ + - Addon message to players within /say range. Subject to heavy throttling and certain specific characters are disallowed. + - `"YELL"` + - ❌ + - ✔️ + - Addon message to players within /yell range. Subject to heavy throttling and certain specific characters are disallowed. + +**Message throttling:** +Communications on all chat types are subject to a per-prefix throttle. Additionally, if too much data is being sent simultaneously on separate prefixes then the client may be disconnected. For this reason, it is strongly recommended to use ChatThrottleLib or AceComm to manage the queueing of messages. +- Each registered prefix is given an allowance of 10 addon messages that can be sent. +- Each message sent on a prefix reduces this allowance by 1. +- If the allowance reaches zero, further attempts to send messages on the same prefix will fail, returning Enum.SendAddonMessageResult.AddonMessageThrottle to the caller. +- Each prefix regains its allowance at a rate of 1 message per second, up to the original maximum of 10 messages. +- This restriction does not apply to whispers outside of instanced content. +- All numbers provided above are the default values, however, these can be dynamically reconfigured by the server at any time. + +**Libraries:** +There is a server-side throttle on in-game addon communication so it's recommended to serialize, compress and encode data before you send them over the addon comms channel. +- **Serialize:** + - LibSerialize + - AceSerializer +- **Compress/Encode:** + - LibDeflate + - LibCompress +- **Comms:** + - ChatThrottleLib + - AceComm + +The LibSerialize project page has detailed examples and documentation for using LibSerialize + LibDeflate and AceComm: +```lua +-- Dependencies: AceAddon-3.0, AceComm-3.0, LibSerialize, LibDeflate +MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceComm-3.0") +local LibSerialize = LibStub("LibSerialize") +local LibDeflate = LibStub("LibDeflate") + +function MyAddon:OnEnable() + self:RegisterComm("MyPrefix") +end + +-- With compression (recommended): +function MyAddon:Transmit(data) + local serialized = LibSerialize:Serialize(data) + local compressed = LibDeflate:CompressDeflate(serialized) + local encoded = LibDeflate:EncodeForWoWAddonChannel(compressed) + self:SendCommMessage("MyPrefix", encoded, "WHISPER", UnitName("player")) +end + +function MyAddon:OnCommReceived(prefix, payload, distribution, sender) + local decoded = LibDeflate:DecodeForWoWAddonChannel(payload) + if not decoded then return end + local decompressed = LibDeflate:DecompressDeflate(decoded) + if not decompressed then return end + local success, data = LibSerialize:Deserialize(decompressed) + if not success then return end + -- Handle `data` +end +``` + +**Description:** +Recipients must register a prefix using `C_ChatInfo.RegisterAddonMessagePrefix()` to receive its messages via `CHAT_MSG_ADDON`. This prefix can be max 16 characters long and it's recommended to use the addon name if possible so other authors can easily see which addon a registered prefix belongs to. +Prior to Patch 11.0.0, Blizzard has provided a deprecation wrapper for this API that shifts the result code to the second return position. A forward-compatible way to reliably access the enum return value is to use a negative select index to grab the last return value. + +**C_ChatInfo.SendAddonMessageLogged:** +Addons transmitting user-generated content should use this API so recipients can report violations of the Code of Conduct. +Fires `CHAT_MSG_ADDON_LOGGED` when receiving messages sent via this function. +The message has to be plain text for the game masters to read it. Moreover, the messages will silently fail to be sent if it contains an unsupported non-printable character. Some amount of metadata is tolerated, but should be kept as minimal as possible to keep the messages readable for Blizzard's game masters. + +This function has been introduced as a solution to growing issues of harassment and doxxing via addon communications, where players would use addons to send content against the terms of service to other players (roleplaying addons are particularly affected as they offer a free form canvas to share RP profiles). As regular addon messages are not logged they cannot be seen by game masters, they had no way to act upon this content. If you use this function, game masters will be able to check the addon communication logs in case of a report and act upon the content. Users should report addon content that is against the terms of service using Blizzard's support website via the Harassment in addon text option. + +**Usage:** +Whispers yourself an addon message when you login or /reload +```lua +local prefix = "SomePrefix123" +local playerName = UnitName("player") +local function OnEvent(self, event, ...) + if event == "CHAT_MSG_ADDON" then + print(event, ...) + elseif event == "PLAYER_ENTERING_WORLD" then + local isLogin, isReload = ... + if isLogin or isReload then + C_ChatInfo.SendAddonMessage(prefix, "You can't see this message", "WHISPER", playerName) + C_ChatInfo.RegisterAddonMessagePrefix(prefix) + C_ChatInfo.SendAddonMessage(prefix, "Hello world!", "WHISPER", playerName) + end + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("CHAT_MSG_ADDON") +f:RegisterEvent("PLAYER_ENTERING_WORLD") +f:SetScript("OnEvent", OnEvent) +``` + +**Reference:** +- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` +- `C_ChatInfo.IsAddonMessagePrefixRegistered()` +- `BNSendGameData()` - Battle.net equivalent. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md b/wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md new file mode 100644 index 00000000..a606bf74 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md @@ -0,0 +1,153 @@ +## Title: C_ChatInfo.SendAddonMessage + +**Content:** +Sends a message over an addon comm channel. +`result = C_ChatInfo.SendAddonMessage(prefix, message )` +`result = C_ChatInfo.SendAddonMessageLogged` + +**Parameters:** +- `prefix` + - *string* - Message prefix, can be used as your addon identifier; at most 16 characters. +- `message` + - *string* - Text to send, at most 255 characters. All characters (decimal ID 1-255) are permissible except NULL (ASCII 0). +- `chatType` + - *string? = PARTY* - The addon channel to send to. +- `target` + - *string|number?* - The player name or custom channel number receiving the message for "WHISPER" or "CHANNEL" chatTypes. + +**Returns:** +- `result` + - *Enum.SendAddonMessageResult* - Result code indicating if the message has been enqueued by the API for submission. This does not mean that the message has yet been sent, and may still be subject to any server-side throttling. + +**Miscellaneous:** +- **chatType** + - **Retail** + - **Classic** + - **Description** + - `"PARTY"` + - ✔️ + - ✔️ + - Addon message to party members. + - `"RAID"` + - ✔️ + - ✔️ + - Addon message to raid members. If not in a raid group, the message will instead be sent on the PARTY chat type. + - `"INSTANCE_CHAT"` + - ✔️ + - ✔️ + - Addon message to grouped players in instanced content such as dungeons, raids, and battlegrounds. + - `"GUILD"` + - ✔️ + - ✔️ + - Addon message to guild members. Prints a "You are not in a guild." system message if you're not in a guild. + - `"OFFICER"` + - ✔️ + - ✔️ + - Addon message to guild officers. + - `"WHISPER"` + - ✔️ + - ✔️ + - Addon message to a player. Only works for players on the same or any connected realms. Use player name as target argument. Prints a "Player is offline." system message if the target is offline. + - `"CHANNEL"` + - ✔️ + - ❌ + - Addon message to a custom chat channel. Use channel number as target argument. Disabled on Classic to prevent players communicating over custom chat channels. + - `"SAY"` + - ❌ + - ✔️ + - Addon message to players within /say range. Subject to heavy throttling and certain specific characters are disallowed. + - `"YELL"` + - ❌ + - ✔️ + - Addon message to players within /yell range. Subject to heavy throttling and certain specific characters are disallowed. + +**Message throttling:** +Communications on all chat types are subject to a per-prefix throttle. Additionally, if too much data is being sent simultaneously on separate prefixes then the client may be disconnected. For this reason, it is strongly recommended to use ChatThrottleLib or AceComm to manage the queueing of messages. +- Each registered prefix is given an allowance of 10 addon messages that can be sent. +- Each message sent on a prefix reduces this allowance by 1. +- If the allowance reaches zero, further attempts to send messages on the same prefix will fail, returning Enum.SendAddonMessageResult.AddonMessageThrottle to the caller. +- Each prefix regains its allowance at a rate of 1 message per second, up to the original maximum of 10 messages. +- This restriction does not apply to whispers outside of instanced content. +- All numbers provided above are the default values, however, these can be dynamically reconfigured by the server at any time. + +**Libraries:** +There is a server-side throttle on in-game addon communication so it's recommended to serialize, compress and encode data before you send them over the addon comms channel. +- **Serialize:** + - LibSerialize + - AceSerializer +- **Compress/Encode:** + - LibDeflate + - LibCompress +- **Comms:** + - ChatThrottleLib + - AceComm + +The LibSerialize project page has detailed examples and documentation for using LibSerialize + LibDeflate and AceComm: +```lua +-- Dependencies: AceAddon-3.0, AceComm-3.0, LibSerialize, LibDeflate +MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceComm-3.0") +local LibSerialize = LibStub("LibSerialize") +local LibDeflate = LibStub("LibDeflate") + +function MyAddon:OnEnable() + self:RegisterComm("MyPrefix") +end + +-- With compression (recommended): +function MyAddon:Transmit(data) + local serialized = LibSerialize:Serialize(data) + local compressed = LibDeflate:CompressDeflate(serialized) + local encoded = LibDeflate:EncodeForWoWAddonChannel(compressed) + self:SendCommMessage("MyPrefix", encoded, "WHISPER", UnitName("player")) +end + +function MyAddon:OnCommReceived(prefix, payload, distribution, sender) + local decoded = LibDeflate:DecodeForWoWAddonChannel(payload) + if not decoded then return end + local decompressed = LibDeflate:DecompressDeflate(decoded) + if not decompressed then return end + local success, data = LibSerialize:Deserialize(decompressed) + if not success then return end + -- Handle `data` +end +``` + +**Description:** +Recipients must register a prefix using `C_ChatInfo.RegisterAddonMessagePrefix()` to receive its messages via `CHAT_MSG_ADDON`. This prefix can be max 16 characters long and it's recommended to use the addon name if possible so other authors can easily see which addon a registered prefix belongs to. + +Prior to Patch 11.0.0, Blizzard has provided a deprecation wrapper for this API that shifts the result code to the second return position. A forward-compatible way to reliably access the enum return value is to use a negative select index to grab the last return value. + +**C_ChatInfo.SendAddonMessageLogged:** +Addons transmitting user-generated content should use this API so recipients can report violations of the Code of Conduct. +Fires `CHAT_MSG_ADDON_LOGGED` when receiving messages sent via this function. +The message has to be plain text for the game masters to read it. Moreover, the messages will silently fail to be sent if it contains an unsupported non-printable character. Some amount of metadata is tolerated, but should be kept as minimal as possible to keep the messages readable for Blizzard's game masters. + +This function has been introduced as a solution to growing issues of harassment and doxxing via addon communications, where players would use addons to send content against the terms of service to other players (roleplaying addons are particularly affected as they offer a free form canvas to share RP profiles). As regular addon messages are not logged they cannot be seen by game masters, they had no way to act upon this content. If you use this function, game masters will be able to check the addon communication logs in case of a report and act upon the content. Users should report addon content that is against the terms of service using Blizzard's support website via the Harassment in addon text option. + +**Usage:** +Whispers yourself an addon message when you login or /reload +```lua +local prefix = "SomePrefix123" +local playerName = UnitName("player") +local function OnEvent(self, event, ...) + if event == "CHAT_MSG_ADDON" then + print(event, ...) + elseif event == "PLAYER_ENTERING_WORLD" then + local isLogin, isReload = ... + if isLogin or isReload then + C_ChatInfo.SendAddonMessage(prefix, "You can't see this message", "WHISPER", playerName) + C_ChatInfo.RegisterAddonMessagePrefix(prefix) + C_ChatInfo.SendAddonMessage(prefix, "Hello world!", "WHISPER", playerName) + end + end +end +local f = CreateFrame("Frame") +f:RegisterEvent("CHAT_MSG_ADDON") +f:RegisterEvent("PLAYER_ENTERING_WORLD") +f:SetScript("OnEvent", OnEvent) +``` + +**Reference:** +- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` +- `C_ChatInfo.IsAddonMessagePrefixRegistered()` +- `BNSendGameData()` - Battle.net equivalent. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md b/wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md new file mode 100644 index 00000000..9edaef40 --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md @@ -0,0 +1,11 @@ +## Title: C_ChatInfo.SwapChatChannelsByChannelIndex + +**Content:** +Needs summary. +`C_ChatInfo.SwapChatChannelsByChannelIndex(firstChannelIndex, secondChannelIndex)` + +**Parameters:** +- `firstChannelIndex` + - *number* +- `secondChannelIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.UncensorChatLine.md b/wiki-information/functions/C_ChatInfo.UncensorChatLine.md new file mode 100644 index 00000000..b8b2770e --- /dev/null +++ b/wiki-information/functions/C_ChatInfo.UncensorChatLine.md @@ -0,0 +1,9 @@ +## Title: C_ChatInfo.UncensorChatLine + +**Content:** +Needs summary. +`C_ChatInfo.UncensorChatLine(chatLine)` + +**Parameters:** +- `chatLine` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AcceptInvitation.md b/wiki-information/functions/C_Club.AcceptInvitation.md new file mode 100644 index 00000000..b108d205 --- /dev/null +++ b/wiki-information/functions/C_Club.AcceptInvitation.md @@ -0,0 +1,9 @@ +## Title: C_Club.AcceptInvitation + +**Content:** +Needs summary. +`C_Club.AcceptInvitation(clubId)` + +**Parameters:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AddClubStreamChatChannel.md b/wiki-information/functions/C_Club.AddClubStreamChatChannel.md new file mode 100644 index 00000000..1e546eae --- /dev/null +++ b/wiki-information/functions/C_Club.AddClubStreamChatChannel.md @@ -0,0 +1,17 @@ +## Title: C_Club.AddClubStreamChatChannel + +**Content:** +Adds a communities channel. +`C_Club.AddClubStreamChatChannel(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Example Usage:** +This function can be used to add a specific stream (chat channel) to a community (club) in World of Warcraft. For instance, if you have a community for your guild and you want to add a new chat channel for raid discussions, you would use this function to do so. + +**Addons:** +Large addons like "ElvUI" or "WeakAuras" might use this function to manage community channels dynamically, especially in scenarios where they provide enhanced communication features or custom chat functionalities. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AdvanceStreamViewMarker.md b/wiki-information/functions/C_Club.AdvanceStreamViewMarker.md new file mode 100644 index 00000000..08fa3461 --- /dev/null +++ b/wiki-information/functions/C_Club.AdvanceStreamViewMarker.md @@ -0,0 +1,11 @@ +## Title: C_Club.AdvanceStreamViewMarker + +**Content:** +Needs summary. +`C_Club.AdvanceStreamViewMarker(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AssignMemberRole.md b/wiki-information/functions/C_Club.AssignMemberRole.md new file mode 100644 index 00000000..9bcf2697 --- /dev/null +++ b/wiki-information/functions/C_Club.AssignMemberRole.md @@ -0,0 +1,25 @@ +## Title: C_Club.AssignMemberRole + +**Content:** +Needs summary. +`C_Club.AssignMemberRole(clubId, memberId, roleId)` + +**Parameters:** +- `clubId` + - *string* +- `memberId` + - *number* +- `roleId` + - *Enum.ClubRoleIdentifier* + - **Enum.ClubRoleIdentifier** + - **Value** + - **Field** + - **Description** + - `1` + - *Owner* + - `2` + - *Leader* + - `3` + - *Moderator* + - `4` + - *Member* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md b/wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md new file mode 100644 index 00000000..acc611db --- /dev/null +++ b/wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md @@ -0,0 +1,19 @@ +## Title: C_Club.CanResolvePlayerLocationFromClubMessageData + +**Content:** +Needs summary. +`canResolve = C_Club.CanResolvePlayerLocationFromClubMessageData(clubId, streamId, epoch, position)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `epoch` + - *number* +- `position` + - *number* + +**Returns:** +- `canResolve` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md b/wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md new file mode 100644 index 00000000..77ec6bac --- /dev/null +++ b/wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md @@ -0,0 +1,5 @@ +## Title: C_Club.ClearAutoAdvanceStreamViewMarker + +**Content:** +Needs summary. +`C_Club.ClearAutoAdvanceStreamViewMarker()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ClearClubPresenceSubscription.md b/wiki-information/functions/C_Club.ClearClubPresenceSubscription.md new file mode 100644 index 00000000..46d3fe4a --- /dev/null +++ b/wiki-information/functions/C_Club.ClearClubPresenceSubscription.md @@ -0,0 +1,5 @@ +## Title: C_Club.ClearClubPresenceSubscription + +**Content:** +Needs summary. +`C_Club.ClearClubPresenceSubscription()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CompareBattleNetDisplayName.md b/wiki-information/functions/C_Club.CompareBattleNetDisplayName.md new file mode 100644 index 00000000..1babbdd8 --- /dev/null +++ b/wiki-information/functions/C_Club.CompareBattleNetDisplayName.md @@ -0,0 +1,17 @@ +## Title: C_Club.CompareBattleNetDisplayName + +**Content:** +Needs summary. +`comparison = C_Club.CompareBattleNetDisplayName(clubId, lhsMemberId, rhsMemberId)` + +**Parameters:** +- `clubId` + - *string* +- `lhsMemberId` + - *number* +- `rhsMemberId` + - *number* + +**Returns:** +- `comparison` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CreateClub.md b/wiki-information/functions/C_Club.CreateClub.md new file mode 100644 index 00000000..87875864 --- /dev/null +++ b/wiki-information/functions/C_Club.CreateClub.md @@ -0,0 +1,30 @@ +## Title: C_Club.CreateClub + +**Content:** +Needs summary. +`C_Club.CreateClub(name, shortName, description, clubType, avatarId, isCrossFaction)` + +**Parameters:** +- `name` + - *string* - The name of the club. +- `shortName` + - *string?* - An optional short name for the club. +- `description` + - *string* - A description of the club. +- `clubType` + - *Enum.ClubType* - Valid types are BattleNet or Character. + - **Value** + - **Field** + - **Description** + - `0` + - *BattleNet* + - `1` + - *Character* + - `2` + - *Guild* + - `3` + - *Other* +- `avatarId` + - *number* - The ID of the avatar for the club. +- `isCrossFaction` + - *boolean?* - An optional boolean indicating if the club is cross-faction. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CreateStream.md b/wiki-information/functions/C_Club.CreateStream.md new file mode 100644 index 00000000..96e1b0e4 --- /dev/null +++ b/wiki-information/functions/C_Club.CreateStream.md @@ -0,0 +1,18 @@ +## Title: C_Club.CreateStream + +**Content:** +Needs summary. +`C_Club.CreateStream(clubId, name, subject, leadersAndModeratorsOnly)` + +**Parameters:** +- `clubId` + - *string* +- `name` + - *string* +- `subject` + - *string* +- `leadersAndModeratorsOnly` + - *boolean* + +**Description:** +Check the canCreateStream privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CreateTicket.md b/wiki-information/functions/C_Club.CreateTicket.md new file mode 100644 index 00000000..98c86008 --- /dev/null +++ b/wiki-information/functions/C_Club.CreateTicket.md @@ -0,0 +1,20 @@ +## Title: C_Club.CreateTicket + +**Content:** +This is protected and only available to the Blizzard UI. Used for creating a ticket for a community club. +`C_Club.CreateTicket(clubId)` + +**Parameters:** +- `clubId` + - *string* +- `allowedRedeemCount` + - *number?* - Number of uses. `nil` means unlimited +- `duration` + - *number?* - Duration in seconds. `nil` never expires +- `defaultStreamId` + - *string?* +- `isCrossFaction` + - *boolean?* + +**Description:** +Check `canCreateTicket` privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DeclineInvitation.md b/wiki-information/functions/C_Club.DeclineInvitation.md new file mode 100644 index 00000000..09135fcc --- /dev/null +++ b/wiki-information/functions/C_Club.DeclineInvitation.md @@ -0,0 +1,9 @@ +## Title: C_Club.DeclineInvitation + +**Content:** +Needs summary. +`C_Club.DeclineInvitation(clubId)` + +**Parameters:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyClub.md b/wiki-information/functions/C_Club.DestroyClub.md new file mode 100644 index 00000000..f3cece5b --- /dev/null +++ b/wiki-information/functions/C_Club.DestroyClub.md @@ -0,0 +1,12 @@ +## Title: C_Club.DestroyClub + +**Content:** +Needs summary. +`C_Club.DestroyClub(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Description:** +Check the canDestroy privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyMessage.md b/wiki-information/functions/C_Club.DestroyMessage.md new file mode 100644 index 00000000..ffd7e727 --- /dev/null +++ b/wiki-information/functions/C_Club.DestroyMessage.md @@ -0,0 +1,21 @@ +## Title: C_Club.DestroyMessage + +**Content:** +Needs summary. +`C_Club.DestroyMessage(clubId, streamId, messageId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `messageId` + - *structure* - ClubMessageIdentifier + - `ClubMessageIdentifier` + - `Field` + - `Type` + - `Description` + - `epoch` + - *number* - number of microseconds since the UNIX epoch + - `position` + - *number* - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyStream.md b/wiki-information/functions/C_Club.DestroyStream.md new file mode 100644 index 00000000..c1a1a1f4 --- /dev/null +++ b/wiki-information/functions/C_Club.DestroyStream.md @@ -0,0 +1,14 @@ +## Title: C_Club.DestroyStream + +**Content:** +Needs summary. +`C_Club.DestroyStream(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Description:** +Check canDestroyStream privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyTicket.md b/wiki-information/functions/C_Club.DestroyTicket.md new file mode 100644 index 00000000..aed41423 --- /dev/null +++ b/wiki-information/functions/C_Club.DestroyTicket.md @@ -0,0 +1,14 @@ +## Title: C_Club.DestroyTicket + +**Content:** +Needs summary. +`C_Club.DestroyTicket(clubId, ticketId)` + +**Parameters:** +- `clubId` + - *string* +- `ticketId` + - *string* + +**Description:** +Check canDestroyTicket privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md b/wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md new file mode 100644 index 00000000..acedd87f --- /dev/null +++ b/wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md @@ -0,0 +1,9 @@ +## Title: C_Club.DoesAnyCommunityHaveUnreadMessages + +**Content:** +Needs summary. +`hasUnreadMessages = C_Club.DoesAnyCommunityHaveUnreadMessages()` + +**Returns:** +- `hasUnreadMessages` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.EditClub.md b/wiki-information/functions/C_Club.EditClub.md new file mode 100644 index 00000000..5b95f0ac --- /dev/null +++ b/wiki-information/functions/C_Club.EditClub.md @@ -0,0 +1,24 @@ +## Title: C_Club.EditClub + +**Content:** +Needs summary. +`C_Club.EditClub(clubId)` + +**Parameters:** +- `clubId` + - *string* +- `name` + - *string?* +- `shortName` + - *string?* +- `description` + - *string?* +- `avatarId` + - *number?* +- `broadcast` + - *string?* +- `crossFaction` + - *boolean?* + +**Description:** +nil arguments will not change existing club data \ No newline at end of file diff --git a/wiki-information/functions/C_Club.EditMessage.md b/wiki-information/functions/C_Club.EditMessage.md new file mode 100644 index 00000000..b2d61ecf --- /dev/null +++ b/wiki-information/functions/C_Club.EditMessage.md @@ -0,0 +1,22 @@ +## Title: C_Club.EditMessage + +**Content:** +Needs summary. +`C_Club.EditMessage(clubId, streamId, messageId, message)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `messageId` + - *ClubMessageIdentifier* + - `Field` + - `Type` + - `Description` + - `epoch` + - *number* - number of microseconds since the UNIX epoch + - `position` + - *number* - sort order for messages at the same time +- `message` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.EditStream.md b/wiki-information/functions/C_Club.EditStream.md new file mode 100644 index 00000000..456a4fc6 --- /dev/null +++ b/wiki-information/functions/C_Club.EditStream.md @@ -0,0 +1,20 @@ +## Title: C_Club.EditStream + +**Content:** +Needs summary. +`C_Club.EditStream(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `name` + - *string?* +- `subject` + - *string?* +- `leadersAndModeratorsOnly` + - *boolean?* + +**Description:** +Check the `canSetStreamName`, `canSetStreamSubject`, `canSetStreamAccess` privileges. `nil` arguments will not change existing stream data. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.Flush.md b/wiki-information/functions/C_Club.Flush.md new file mode 100644 index 00000000..15ae4510 --- /dev/null +++ b/wiki-information/functions/C_Club.Flush.md @@ -0,0 +1,5 @@ +## Title: C_Club.Flush + +**Content:** +Needs summary. +`C_Club.Flush()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.FocusCommunityStreams.md b/wiki-information/functions/C_Club.FocusCommunityStreams.md new file mode 100644 index 00000000..238feb74 --- /dev/null +++ b/wiki-information/functions/C_Club.FocusCommunityStreams.md @@ -0,0 +1,5 @@ +## Title: C_Club.FocusCommunityStreams + +**Content:** +Needs summary. +`C_Club.FocusCommunityStreams()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.FocusStream.md b/wiki-information/functions/C_Club.FocusStream.md new file mode 100644 index 00000000..0ec08320 --- /dev/null +++ b/wiki-information/functions/C_Club.FocusStream.md @@ -0,0 +1,21 @@ +## Title: C_Club.FocusStream + +**Content:** +Needs summary. +`focused = C_Club.FocusStream(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Returns:** +- `focused` + - *boolean* + +**Example Usage:** +This function can be used to set a specific stream within a club as the focused stream. This might be useful in an addon that manages multiple chat streams within a club, allowing the user to highlight or prioritize a particular stream. + +**Addon Usage:** +Large addons like "ElvUI" or "Prat" that manage chat functionalities might use this function to allow users to focus on specific streams within their club chats, enhancing the user experience by providing more control over their chat environment. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetAssignableRoles.md b/wiki-information/functions/C_Club.GetAssignableRoles.md new file mode 100644 index 00000000..af99f669 --- /dev/null +++ b/wiki-information/functions/C_Club.GetAssignableRoles.md @@ -0,0 +1,27 @@ +## Title: C_Club.GetAssignableRoles + +**Content:** +Needs summary. +`assignableRoles = C_Club.GetAssignableRoles(clubId, memberId)` + +**Parameters:** +- `clubId` + - *string* +- `memberId` + - *number* + +**Returns:** +- `assignableRoles` + - *Enum.ClubRoleIdentifier* + - *Enum.ClubRoleIdentifier* + - `Value` + - `Field` + - `Description` + - `1` + - `Owner` + - `2` + - `Leader` + - `3` + - `Moderator` + - `4` + - `Member` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetAvatarIdList.md b/wiki-information/functions/C_Club.GetAvatarIdList.md new file mode 100644 index 00000000..d4605814 --- /dev/null +++ b/wiki-information/functions/C_Club.GetAvatarIdList.md @@ -0,0 +1,24 @@ +## Title: C_Club.GetAvatarIdList + +**Content:** +Needs summary. +`avatarIds = C_Club.GetAvatarIdList(clubType)` + +**Parameters:** +- `clubType` + - *Enum.ClubType* + - `Enum.ClubType` + - `Value` + - `Field` + - `Description` + - `0` - BattleNet + - `1` - Character + - `2` - Guild + - `3` - Other + +**Returns:** +- `avatarIds` + - *number?* + +**Description:** +Listen for `AVATAR_LIST_UPDATED` event. This can happen if we haven't downloaded the Battle.net avatar list yet. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubInfo.md b/wiki-information/functions/C_Club.GetClubInfo.md new file mode 100644 index 00000000..e27dc8cd --- /dev/null +++ b/wiki-information/functions/C_Club.GetClubInfo.md @@ -0,0 +1,55 @@ +## Title: C_Club.GetClubInfo + +**Content:** +Needs summary. +`info = C_Club.GetClubInfo(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `info` + - *ClubInfo?* + - `Field` + - `Type` + - `Description` + - `clubId` + - *string* + - `name` + - *string* + - `shortName` + - *string?* + - `description` + - *string* + - `broadcast` + - *string* + - `clubType` + - *Enum.ClubType* + - `avatarId` + - *number* + - `memberCount` + - *number?* + - `favoriteTimeStamp` + - *number?* + - `joinTime` + - *number?* + - UNIX timestamp measured in microsecond precision. + - `socialQueueingEnabled` + - *boolean?* + - `crossFaction` + - *boolean?* + - Added in 9.2.5 + +**Enum.ClubType:** +- `Value` +- `Field` +- `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubMembers.md b/wiki-information/functions/C_Club.GetClubMembers.md new file mode 100644 index 00000000..650ca39f --- /dev/null +++ b/wiki-information/functions/C_Club.GetClubMembers.md @@ -0,0 +1,29 @@ +## Title: C_Club.GetClubMembers + +**Content:** +Needs summary. +`members = C_Club.GetClubMembers(clubId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string?* + +**Returns:** +- `members` + - *number* + +**Description:** +This function retrieves the members of a specified club. The `clubId` is a unique identifier for the club, and the optional `streamId` can be used to filter members based on a specific stream within the club. + +**Example Usage:** +```lua +local clubId = "1234567890" +local members = C_Club.GetClubMembers(clubId) +print("Number of members in the club:", members) +``` + +**Addons Using This Function:** +- **Communities**: The in-game Communities feature uses this function to display the list of members in a community or guild. +- **Guild Management Addons**: Addons like "Guild Roster Manager" use this function to fetch and display detailed information about guild members. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubPrivileges.md b/wiki-information/functions/C_Club.GetClubPrivileges.md new file mode 100644 index 00000000..23b889fc --- /dev/null +++ b/wiki-information/functions/C_Club.GetClubPrivileges.md @@ -0,0 +1,103 @@ +## Title: C_Club.GetClubPrivileges + +**Content:** +Needs summary. +`privilegeInfo = C_Club.GetClubPrivileges(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `privilegeInfo` + - *structure* - ClubPrivilegeInfo + - `Field` + - `Type` + - `Description` + - `canDestroy` + - *boolean* + - `canSetAttribute` + - *boolean* + - `canSetName` + - *boolean* + - `canSetDescription` + - *boolean* + - `canSetAvatar` + - *boolean* + - `canSetBroadcast` + - *boolean* + - `canSetPrivacyLevel` + - *boolean* + - `canSetOwnMemberAttribute` + - *boolean* + - `canSetOtherMemberAttribute` + - *boolean* + - `canSetOwnMemberNote` + - *boolean* + - `canSetOtherMemberNote` + - *boolean* + - `canSetOwnVoiceState` + - *boolean* + - `canSetOwnPresenceLevel` + - *boolean* + - `canUseVoice` + - *boolean* + - `canVoiceMuteMemberForAll` + - *boolean* + - `canGetInvitation` + - *boolean* + - `canSendInvitation` + - *boolean* + - `canSendGuestInvitation` + - *boolean* + - `canRevokeOwnInvitation` + - *boolean* + - `canRevokeOtherInvitation` + - *boolean* + - `canGetBan` + - *boolean* + - `canGetSuggestion` + - *boolean* + - `canSuggestMember` + - *boolean* + - `canGetTicket` + - *boolean* + - `canCreateTicket` + - *boolean* + - `canDestroyTicket` + - *boolean* + - `canAddBan` + - *boolean* + - `canRemoveBan` + - *boolean* + - `canCreateStream` + - *boolean* + - `canDestroyStream` + - *boolean* + - `canSetStreamPosition` + - *boolean* + - `canSetStreamAttribute` + - *boolean* + - `canSetStreamName` + - *boolean* + - `canSetStreamSubject` + - *boolean* + - `canSetStreamAccess` + - *boolean* + - `canSetStreamVoiceLevel` + - *boolean* + - `canCreateMessage` + - *boolean* + - `canDestroyOwnMessage` + - *boolean* + - `canDestroyOtherMessage` + - *boolean* + - `canEditOwnMessage` + - *boolean* + - `canPinMessage` + - *boolean* + - `kickableRoleIds` + - *number* - Roles that can be kicked and banned + +**Description:** +The privileges for the logged-in user for this club. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md b/wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md new file mode 100644 index 00000000..440d22eb --- /dev/null +++ b/wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md @@ -0,0 +1,31 @@ +## Title: C_Club.GetClubStreamNotificationSettings + +**Content:** +Needs summary. +`settings = C_Club.GetClubStreamNotificationSettings(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `settings` + - *structure* - ClubStreamNotificationSetting + - `ClubStreamNotificationSetting` + - `Field` + - `Type` + - `Description` + - `streamId` + - *string* + - `filter` + - *Enum.ClubStreamNotificationFilter* + - `Enum.ClubStreamNotificationFilter` + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Mention + - `2` + - All \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetCommunityNameResultText.md b/wiki-information/functions/C_Club.GetCommunityNameResultText.md new file mode 100644 index 00000000..0b40b1ba --- /dev/null +++ b/wiki-information/functions/C_Club.GetCommunityNameResultText.md @@ -0,0 +1,55 @@ +## Title: C_Club.GetCommunityNameResultText + +**Content:** +Needs summary. +`errorCode = C_Club.GetCommunityNameResultText(result)` + +**Parameters:** +- `result` + - *Enum.ValidateNameResult* + - **Value** + - **Field** + - **Description** + - `0` + - Success + - `1` + - Failure + - `2` + - NoName + - `3` + - TooShort + - `4` + - TooLong + - `5` + - InvalidCharacter + - `6` + - MixedLanguages + - `7` + - Profane + - `8` + - Reserved + - `9` + - InvalidApostrophe + - `10` + - MultipleApostrophes + - `11` + - ThreeConsecutive + - `12` + - InvalidSpace + - `13` + - ConsecutiveSpaces + - `14` + - RussianConsecutiveSilentCharacters + - `15` + - RussianSilentCharacterAtBeginningOrEnd + - `16` + - DeclensionDoesntMatchBaseName + - `17` + - SpacesDisallowed + +**Returns:** +- `errorCode` + - *string?* + +**Change Log:** +- Added in 8.2.5 \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md b/wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md new file mode 100644 index 00000000..f75a665e --- /dev/null +++ b/wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md @@ -0,0 +1,149 @@ +## Title: C_Club.GetInfoFromLastCommunityChatLine + +**Content:** +Needs summary. +`messageInfo, clubId, streamId, clubType = C_Club.GetInfoFromLastCommunityChatLine()` + +**Returns:** +- `messageInfo` + - *structure* - ClubMessageInfo +- `clubId` + - *string* +- `streamId` + - *string* +- `clubType` + - *Enum.ClubType* + +**ClubMessageInfo:** +- `Field` +- `Type` +- `Description` +- `messageId` + - *ClubMessageIdentifier* +- `content` + - *string* - Protected string +- `author` + - *ClubMemberInfo* +- `destroyer` + - *ClubMemberInfo?* - May be nil even if the message has been destroyed +- `destroyed` + - *boolean* +- `edited` + - *boolean* + +**ClubMessageIdentifier:** +- `Field` +- `Type` +- `Description` +- `epoch` + - *number* - number of microseconds since the UNIX epoch +- `position` + - *number* - sort order for messages at the same time + +**ClubMemberInfo:** +- `Field` +- `Type` +- `Description` +- `isSelf` + - *boolean* +- `memberId` + - *number* +- `name` + - *string?* - name may be encoded as a Kstring +- `role` + - *Enum.ClubRoleIdentifier?* +- `presence` + - *Enum.ClubMemberPresence* +- `clubType` + - *Enum.ClubType?* +- `guid` + - *string?* +- `bnetAccountId` + - *number?* +- `memberNote` + - *string?* +- `officerNote` + - *string?* +- `classID` + - *number?* +- `race` + - *number?* +- `level` + - *number?* +- `zone` + - *string?* +- `achievementPoints` + - *number?* +- `profession1ID` + - *number?* +- `profession1Rank` + - *number?* +- `profession1Name` + - *string?* +- `profession2ID` + - *number?* +- `profession2Rank` + - *number?* +- `profession2Name` + - *string?* +- `lastOnlineYear` + - *number?* +- `lastOnlineMonth` + - *number?* +- `lastOnlineDay` + - *number?* +- `lastOnlineHour` + - *number?* +- `guildRank` + - *string?* +- `guildRankOrder` + - *number?* +- `isRemoteChat` + - *boolean?* +- `overallDungeonScore` + - *number?* - Added in 9.1.0 +- `faction` + - *Enum.PvPFaction?* - Added in 9.2.5 + +**Enum.ClubRoleIdentifier:** +- `Value` +- `Field` +- `Description` +- `1` + - Owner +- `2` + - Leader +- `3` + - Moderator +- `4` + - Member + +**Enum.ClubMemberPresence:** +- `Value` +- `Field` +- `Description` +- `0` + - Unknown +- `1` + - Online +- `2` + - OnlineMobile +- `3` + - Offline +- `4` + - Away +- `5` + - Busy + +**Enum.ClubType:** +- `Value` +- `Field` +- `Description` +- `0` + - BattleNet +- `1` + - Character +- `2` + - Guild +- `3` + - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationCandidates.md b/wiki-information/functions/C_Club.GetInvitationCandidates.md new file mode 100644 index 00000000..346be06c --- /dev/null +++ b/wiki-information/functions/C_Club.GetInvitationCandidates.md @@ -0,0 +1,43 @@ +## Title: C_Club.GetInvitationCandidates + +**Content:** +Returns a list of players that you can send a request to a Battle.net club. Returns an empty list for Character based clubs. +`candidates = C_Club.GetInvitationCandidates(filter, maxResults, cursorPosition, allowFullMatch, clubId)` + +**Parameters:** +- `filter` + - *string?* - Optional filter string to narrow down the search. +- `maxResults` + - *number?* - Optional maximum number of results to return. +- `cursorPosition` + - *number?* - Optional cursor position for pagination. +- `allowFullMatch` + - *boolean?* - Optional boolean to allow full match. +- `clubId` + - *string* - The ID of the club to which you want to send invitations. + +**Returns:** +- `candidates` + - *ClubInvitationCandidateInfo* - A table containing information about each candidate. + - `Field` + - `Type` + - `Description` + - `memberId` + - *number* - The unique ID of the candidate. + - `name` + - *string* - The name of the candidate. + - `priority` + - *number* - The priority of the candidate. + - `status` + - *Enum.ClubInvitationCandidateStatus* - The status of the candidate. + +**Enum.ClubInvitationCandidateStatus:** +- `Value` +- `Field` +- `Description` + - `0` + - `Available` - The candidate is available for an invitation. + - `1` + - `InvitePending` - An invitation is already pending for the candidate. + - `2` + - `AlreadyMember` - The candidate is already a member of the club. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationInfo.md b/wiki-information/functions/C_Club.GetInvitationInfo.md new file mode 100644 index 00000000..3c3f8b4f --- /dev/null +++ b/wiki-information/functions/C_Club.GetInvitationInfo.md @@ -0,0 +1,183 @@ +## Title: C_Club.GetInvitationInfo + +**Content:** +Needs summary. +`invitation = C_Club.GetInvitationInfo(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `invitation` + - *structure* - ClubSelfInvitationInfo (nilable) + - **ClubSelfInvitationInfo** + - `Field` + - `Type` + - `Description` + - `invitationId` + - *string* + - `club` + - *ClubInfo* + - `inviter` + - *ClubMemberInfo* + - `leaders` + - *ClubMemberInfo* + + - **ClubInfo** + - `Field` + - `Type` + - `Description` + - `clubId` + - *string* + - `name` + - *string* + - `shortName` + - *string?* + - `description` + - *string* + - `broadcast` + - *string* + - `clubType` + - *Enum.ClubType* + - `avatarId` + - *number* + - `memberCount` + - *number?* + - `favoriteTimeStamp` + - *number?* + - `joinTime` + - *number?* + - UNIX timestamp measured in microsecond precision. + - `socialQueueingEnabled` + - *boolean?* + - `crossFaction` + - *boolean?* + - Added in 9.2.5 + + - **Enum.ClubType** + - `Value` + - `Field` + - `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other + + - **ClubMemberInfo** + - `Field` + - `Type` + - `Description` + - `isSelf` + - *boolean* + - `memberId` + - *number* + - `name` + - *string?* + - name may be encoded as a Kstring + - `role` + - *Enum.ClubRoleIdentifier?* + - `presence` + - *Enum.ClubMemberPresence* + - `clubType` + - *Enum.ClubType?* + - `guid` + - *string?* + - `bnetAccountId` + - *number?* + - `memberNote` + - *string?* + - `officerNote` + - *string?* + - `classID` + - *number?* + - `race` + - *number?* + - `level` + - *number?* + - `zone` + - *string?* + - `achievementPoints` + - *number?* + - `profession1ID` + - *number?* + - `profession1Rank` + - *number?* + - `profession1Name` + - *string?* + - `profession2ID` + - *number?* + - `profession2Rank` + - *number?* + - `profession2Name` + - *string?* + - `lastOnlineYear` + - *number?* + - `lastOnlineMonth` + - *number?* + - `lastOnlineDay` + - *number?* + - `lastOnlineHour` + - *number?* + - `guildRank` + - *string?* + - `guildRankOrder` + - *number?* + - `isRemoteChat` + - *boolean?* + - `overallDungeonScore` + - *number?* + - Added in 9.1.0 + - `faction` + - *Enum.PvPFaction?* + - Added in 9.2.5 + + - **Enum.ClubRoleIdentifier** + - `Value` + - `Field` + - `Description` + - `1` + - Owner + - `2` + - Leader + - `3` + - Moderator + - `4` + - Member + + - **Enum.ClubMemberPresence** + - `Value` + - `Field` + - `Description` + - `0` + - Unknown + - `1` + - Online + - `2` + - OnlineMobile + - `3` + - Offline + - `4` + - Away + - `5` + - Busy + + - **Enum.ClubType** + - `Value` + - `Field` + - `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other + +**Description:** +Get info about a specific club the active player has been invited to. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationsForClub.md b/wiki-information/functions/C_Club.GetInvitationsForClub.md new file mode 100644 index 00000000..020db154 --- /dev/null +++ b/wiki-information/functions/C_Club.GetInvitationsForClub.md @@ -0,0 +1,132 @@ +## Title: C_Club.GetInvitationsForClub + +**Content:** +Needs summary. +`invitations = C_Club.GetInvitationsForClub(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `invitations` + - *structure* - ClubInvitationInfo + - `Field` + - `Type` + - `Description` + - `invitationId` + - *string* + - `isMyInvitation` + - *boolean* + - `invitee` + - *structure* ClubMemberInfo + - `ClubMemberInfo` + - `Field` + - `Type` + - `Description` + - `isSelf` + - *boolean* + - `memberId` + - *number* + - `name` + - *string?* - name may be encoded as a Kstring + - `role` + - *Enum.ClubRoleIdentifier?* + - `presence` + - *Enum.ClubMemberPresence* + - `clubType` + - *Enum.ClubType?* + - `guid` + - *string?* + - `bnetAccountId` + - *number?* + - `memberNote` + - *string?* + - `officerNote` + - *string?* + - `classID` + - *number?* + - `race` + - *number?* + - `level` + - *number?* + - `zone` + - *string?* + - `achievementPoints` + - *number?* + - `profession1ID` + - *number?* + - `profession1Rank` + - *number?* + - `profession1Name` + - *string?* + - `profession2ID` + - *number?* + - `profession2Rank` + - *number?* + - `profession2Name` + - *string?* + - `lastOnlineYear` + - *number?* + - `lastOnlineMonth` + - *number?* + - `lastOnlineDay` + - *number?* + - `lastOnlineHour` + - *number?* + - `guildRank` + - *string?* + - `guildRankOrder` + - *number?* + - `isRemoteChat` + - *boolean?* + - `overallDungeonScore` + - *number?* - Added in 9.1.0 + - `faction` + - *Enum.PvPFaction?* - Added in 9.2.5 + +**Enum.ClubRoleIdentifier:** +- `Value` +- `Field` +- `Description` + - `1` + - Owner + - `2` + - Leader + - `3` + - Moderator + - `4` + - Member + +**Enum.ClubMemberPresence:** +- `Value` +- `Field` +- `Description` + - `0` + - Unknown + - `1` + - Online + - `2` + - OnlineMobile + - `3` + - Offline + - `4` + - Away + - `5` + - Busy + +**Enum.ClubType:** +- `Value` +- `Field` +- `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other + +**Description:** +Get the pending invitations for this club. Call `RequestInvitationsForClub()` to retrieve invitations from the server. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationsForSelf.md b/wiki-information/functions/C_Club.GetInvitationsForSelf.md new file mode 100644 index 00000000..f2cec9d4 --- /dev/null +++ b/wiki-information/functions/C_Club.GetInvitationsForSelf.md @@ -0,0 +1,179 @@ +## Title: C_Club.GetInvitationsForSelf + +**Content:** +Needs summary. +`invitations = C_Club.GetInvitationsForSelf()` + +**Returns:** +- `invitations` + - *structure* - ClubSelfInvitationInfo + - **ClubSelfInvitationInfo** + - `Field` + - `Type` + - `Description` + - `invitationId` + - *string* + - `club` + - *ClubInfo* + - `inviter` + - *ClubMemberInfo* + - `leaders` + - *ClubMemberInfo* + + - **ClubInfo** + - `Field` + - `Type` + - `Description` + - `clubId` + - *string* + - `name` + - *string* + - `shortName` + - *string?* + - `description` + - *string* + - `broadcast` + - *string* + - `clubType` + - *Enum.ClubType* + - `avatarId` + - *number* + - `memberCount` + - *number?* + - `favoriteTimeStamp` + - *number?* + - `joinTime` + - *number?* + - UNIX timestamp measured in microsecond precision. + - `socialQueueingEnabled` + - *boolean?* + - `crossFaction` + - *boolean?* + - Added in 9.2.5 + + - **Enum.ClubType** + - `Value` + - `Field` + - `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other + + - **ClubMemberInfo** + - `Field` + - `Type` + - `Description` + - `isSelf` + - *boolean* + - `memberId` + - *number* + - `name` + - *string?* + - name may be encoded as a Kstring + - `role` + - *Enum.ClubRoleIdentifier?* + - `presence` + - *Enum.ClubMemberPresence* + - `clubType` + - *Enum.ClubType?* + - `guid` + - *string?* + - `bnetAccountId` + - *number?* + - `memberNote` + - *string?* + - `officerNote` + - *string?* + - `classID` + - *number?* + - `race` + - *number?* + - `level` + - *number?* + - `zone` + - *string?* + - `achievementPoints` + - *number?* + - `profession1ID` + - *number?* + - `profession1Rank` + - *number?* + - `profession1Name` + - *string?* + - `profession2ID` + - *number?* + - `profession2Rank` + - *number?* + - `profession2Name` + - *string?* + - `lastOnlineYear` + - *number?* + - `lastOnlineMonth` + - *number?* + - `lastOnlineDay` + - *number?* + - `lastOnlineHour` + - *number?* + - `guildRank` + - *string?* + - `guildRankOrder` + - *number?* + - `isRemoteChat` + - *boolean?* + - `overallDungeonScore` + - *number?* + - Added in 9.1.0 + - `faction` + - *Enum.PvPFaction?* + - Added in 9.2.5 + + - **Enum.ClubRoleIdentifier** + - `Value` + - `Field` + - `Description` + - `1` + - Owner + - `2` + - Leader + - `3` + - Moderator + - `4` + - Member + + - **Enum.ClubMemberPresence** + - `Value` + - `Field` + - `Description` + - `0` + - Unknown + - `1` + - Online + - `2` + - OnlineMobile + - `3` + - Offline + - `4` + - Away + - `5` + - Busy + + - **Enum.ClubType** + - `Value` + - `Field` + - `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other + +**Description:** +These are the clubs the active player has been invited to. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMemberInfo.md b/wiki-information/functions/C_Club.GetMemberInfo.md new file mode 100644 index 00000000..8b5b26a3 --- /dev/null +++ b/wiki-information/functions/C_Club.GetMemberInfo.md @@ -0,0 +1,122 @@ +## Title: C_Club.GetMemberInfo + +**Content:** +Needs summary. +`info = C_Club.GetMemberInfo(clubId, memberId)` + +**Parameters:** +- `clubId` + - *string* +- `memberId` + - *number* + +**Returns:** +- `info` + - *structure* - ClubMemberInfo (nilable) + - `ClubMemberInfo` + - `Field` + - `Type` + - `Description` + - `isSelf` + - *boolean* + - `memberId` + - *number* + - `name` + - *string?* - name may be encoded as a Kstring + - `role` + - *Enum.ClubRoleIdentifier?* + - `presence` + - *Enum.ClubMemberPresence* + - `clubType` + - *Enum.ClubType?* + - `guid` + - *string?* + - `bnetAccountId` + - *number?* + - `memberNote` + - *string?* + - `officerNote` + - *string?* + - `classID` + - *number?* + - `race` + - *number?* + - `level` + - *number?* + - `zone` + - *string?* + - `achievementPoints` + - *number?* + - `profession1ID` + - *number?* + - `profession1Rank` + - *number?* + - `profession1Name` + - *string?* + - `profession2ID` + - *number?* + - `profession2Rank` + - *number?* + - `profession2Name` + - *string?* + - `lastOnlineYear` + - *number?* + - `lastOnlineMonth` + - *number?* + - `lastOnlineDay` + - *number?* + - `lastOnlineHour` + - *number?* + - `guildRank` + - *string?* + - `guildRankOrder` + - *number?* + - `isRemoteChat` + - *boolean?* + - `overallDungeonScore` + - *number?* - Added in 9.1.0 + - `faction` + - *Enum.PvPFaction?* - Added in 9.2.5 + +**Enum.ClubRoleIdentifier:** +- `Value` + - `Field` + - `Description` + - `1` + - Owner + - `2` + - Leader + - `3` + - Moderator + - `4` + - Member + +**Enum.ClubMemberPresence:** +- `Value` + - `Field` + - `Description` + - `0` + - Unknown + - `1` + - Online + - `2` + - OnlineMobile + - `3` + - Offline + - `4` + - Away + - `5` + - Busy + +**Enum.ClubType:** +- `Value` + - `Field` + - `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMemberInfoForSelf.md b/wiki-information/functions/C_Club.GetMemberInfoForSelf.md new file mode 100644 index 00000000..bf8fab9d --- /dev/null +++ b/wiki-information/functions/C_Club.GetMemberInfoForSelf.md @@ -0,0 +1,123 @@ +## Title: C_Club.GetMemberInfoForSelf + +**Content:** +Needs summary. +`info = C_Club.GetMemberInfoForSelf(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `info` + - *structure* - ClubMemberInfo (nilable) + - `ClubMemberInfo` + - `Field` + - `Type` + - `Description` + - `isSelf` + - *boolean* + - `memberId` + - *number* + - `name` + - *string?* - name may be encoded as a Kstring + - `role` + - *Enum.ClubRoleIdentifier?* + - `presence` + - *Enum.ClubMemberPresence* + - `clubType` + - *Enum.ClubType?* + - `guid` + - *string?* + - `bnetAccountId` + - *number?* + - `memberNote` + - *string?* + - `officerNote` + - *string?* + - `classID` + - *number?* + - `race` + - *number?* + - `level` + - *number?* + - `zone` + - *string?* + - `achievementPoints` + - *number?* + - `profession1ID` + - *number?* + - `profession1Rank` + - *number?* + - `profession1Name` + - *string?* + - `profession2ID` + - *number?* + - `profession2Rank` + - *number?* + - `profession2Name` + - *string?* + - `lastOnlineYear` + - *number?* + - `lastOnlineMonth` + - *number?* + - `lastOnlineDay` + - *number?* + - `lastOnlineHour` + - *number?* + - `guildRank` + - *string?* + - `guildRankOrder` + - *number?* + - `isRemoteChat` + - *boolean?* + - `overallDungeonScore` + - *number?* + - `faction` + - *Enum.PvPFaction?* (Added in 9.2.5) + +**Enum.ClubRoleIdentifier:** +- `Value` +- `Field` +- `Description` + - `1` + - Owner + - `2` + - Leader + - `3` + - Moderator + - `4` + - Member + +**Enum.ClubMemberPresence:** +- `Value` +- `Field` +- `Description` + - `0` + - Unknown + - `1` + - Online + - `2` + - OnlineMobile + - `3` + - Offline + - `4` + - Away + - `5` + - Busy + +**Enum.ClubType:** +- `Value` +- `Field` +- `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other + +**Description:** +Info for the logged-in user for this club. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessageInfo.md b/wiki-information/functions/C_Club.GetMessageInfo.md new file mode 100644 index 00000000..5a339cce --- /dev/null +++ b/wiki-information/functions/C_Club.GetMessageInfo.md @@ -0,0 +1,163 @@ +## Title: C_Club.GetMessageInfo + +**Content:** +Needs summary. +`message = C_Club.GetMessageInfo(clubId, streamId, messageId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `messageId` + - *structure* - ClubMessageIdentifier + +**ClubMessageIdentifier:** +- `Field` +- `Type` +- `Description` +- `epoch` + - *number* - number of microseconds since the UNIX epoch +- `position` + - *number* - sort order for messages at the same time + +**Returns:** +- `message` + - *structure* - ClubMessageInfo (nilable) + +**ClubMessageInfo:** +- `Field` +- `Type` +- `Description` +- `messageId` + - *ClubMessageIdentifier* +- `content` + - *string* - Protected string +- `author` + - *ClubMemberInfo* +- `destroyer` + - *ClubMemberInfo?* - May be nil even if the message has been destroyed +- `destroyed` + - *boolean* +- `edited` + - *boolean* + +**ClubMessageIdentifier:** +- `Field` +- `Type` +- `Description` +- `epoch` + - *number* - number of microseconds since the UNIX epoch +- `position` + - *number* - sort order for messages at the same time + +**ClubMemberInfo:** +- `Field` +- `Type` +- `Description` +- `isSelf` + - *boolean* +- `memberId` + - *number* +- `name` + - *string?* - name may be encoded as a Kstring +- `role` + - *Enum.ClubRoleIdentifier?* +- `presence` + - *Enum.ClubMemberPresence* +- `clubType` + - *Enum.ClubType?* +- `guid` + - *string?* +- `bnetAccountId` + - *number?* +- `memberNote` + - *string?* +- `officerNote` + - *string?* +- `classID` + - *number?* +- `race` + - *number?* +- `level` + - *number?* +- `zone` + - *string?* +- `achievementPoints` + - *number?* +- `profession1ID` + - *number?* +- `profession1Rank` + - *number?* +- `profession1Name` + - *string?* +- `profession2ID` + - *number?* +- `profession2Rank` + - *number?* +- `profession2Name` + - *string?* +- `lastOnlineYear` + - *number?* +- `lastOnlineMonth` + - *number?* +- `lastOnlineDay` + - *number?* +- `lastOnlineHour` + - *number?* +- `guildRank` + - *string?* +- `guildRankOrder` + - *number?* +- `isRemoteChat` + - *boolean?* +- `overallDungeonScore` + - *number?* - Added in 9.1.0 +- `faction` + - *Enum.PvPFaction?* - Added in 9.2.5 + +**Enum.ClubRoleIdentifier:** +- `Value` +- `Field` +- `Description` +- `1` + - Owner +- `2` + - Leader +- `3` + - Moderator +- `4` + - Member + +**Enum.ClubMemberPresence:** +- `Value` +- `Field` +- `Description` +- `0` + - Unknown +- `1` + - Online +- `2` + - OnlineMobile +- `3` + - Offline +- `4` + - Away +- `5` + - Busy + +**Enum.ClubType:** +- `Value` +- `Field` +- `Description` +- `0` + - BattleNet +- `1` + - Character +- `2` + - Guild +- `3` + - Other + +**Description:** +Get info about a particular message. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessageRanges.md b/wiki-information/functions/C_Club.GetMessageRanges.md new file mode 100644 index 00000000..565d91b4 --- /dev/null +++ b/wiki-information/functions/C_Club.GetMessageRanges.md @@ -0,0 +1,34 @@ +## Title: C_Club.GetMessageRanges + +**Content:** +Needs summary. +`ranges = C_Club.GetMessageRanges(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Returns:** +- `ranges` + - *structure* - ClubMessageRange + - `ClubMessageRange` + - `Field` + - `Type` + - `Description` + - `oldestMessageId` + - *ClubMessageIdentifier* + - `newestMessageId` + - *ClubMessageIdentifier* + - `ClubMessageIdentifier` + - `Field` + - `Type` + - `Description` + - `epoch` + - *number* - number of microseconds since the UNIX epoch + - `position` + - *number* - sort order for messages at the same time + +**Description:** +Get the ranges of the messages currently downloaded. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessagesBefore.md b/wiki-information/functions/C_Club.GetMessagesBefore.md new file mode 100644 index 00000000..25ee95f9 --- /dev/null +++ b/wiki-information/functions/C_Club.GetMessagesBefore.md @@ -0,0 +1,165 @@ +## Title: C_Club.GetMessagesBefore + +**Content:** +Needs summary. +`messages = C_Club.GetMessagesBefore(clubId, streamId, newest, count)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `newest` + - *structure* - ClubMessageIdentifier +- `count` + - *number* + +**ClubMessageIdentifier:** +- `Field` +- `Type` +- `Description` +- `epoch` + - *number* - number of microseconds since the UNIX epoch +- `position` + - *number* - sort order for messages at the same time + +**Returns:** +- `messages` + - *structure* - ClubMessageInfo + +**ClubMessageInfo:** +- `Field` +- `Type` +- `Description` +- `messageId` + - *ClubMessageIdentifier* +- `content` + - *string* - Protected string +- `author` + - *ClubMemberInfo* +- `destroyer` + - *ClubMemberInfo?* - May be nil even if the message has been destroyed +- `destroyed` + - *boolean* +- `edited` + - *boolean* + +**ClubMessageIdentifier:** +- `Field` +- `Type` +- `Description` +- `epoch` + - *number* - number of microseconds since the UNIX epoch +- `position` + - *number* - sort order for messages at the same time + +**ClubMemberInfo:** +- `Field` +- `Type` +- `Description` +- `isSelf` + - *boolean* +- `memberId` + - *number* +- `name` + - *string?* - name may be encoded as a Kstring +- `role` + - *Enum.ClubRoleIdentifier?* +- `presence` + - *Enum.ClubMemberPresence* +- `clubType` + - *Enum.ClubType?* +- `guid` + - *string?* +- `bnetAccountId` + - *number?* +- `memberNote` + - *string?* +- `officerNote` + - *string?* +- `classID` + - *number?* +- `race` + - *number?* +- `level` + - *number?* +- `zone` + - *string?* +- `achievementPoints` + - *number?* +- `profession1ID` + - *number?* +- `profession1Rank` + - *number?* +- `profession1Name` + - *string?* +- `profession2ID` + - *number?* +- `profession2Rank` + - *number?* +- `profession2Name` + - *string?* +- `lastOnlineYear` + - *number?* +- `lastOnlineMonth` + - *number?* +- `lastOnlineDay` + - *number?* +- `lastOnlineHour` + - *number?* +- `guildRank` + - *string?* +- `guildRankOrder` + - *number?* +- `isRemoteChat` + - *boolean?* +- `overallDungeonScore` + - *number?* - Added in 9.1.0 +- `faction` + - *Enum.PvPFaction?* - Added in 9.2.5 + +**Enum.ClubRoleIdentifier:** +- `Value` +- `Field` +- `Description` +- `1` + - Owner +- `2` + - Leader +- `3` + - Moderator +- `4` + - Member + +**Enum.ClubMemberPresence:** +- `Value` +- `Field` +- `Description` +- `0` + - Unknown +- `1` + - Online +- `2` + - OnlineMobile +- `3` + - Offline +- `4` + - Away +- `5` + - Busy + +**Enum.ClubType:** +- `Value` +- `Field` +- `Description` +- `0` + - BattleNet +- `1` + - Character +- `2` + - Guild +- `3` + - Other + +**Description:** +Get downloaded messages before (and including) the specified messageId limited by count. These are filtered by ignored players. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessagesInRange.md b/wiki-information/functions/C_Club.GetMessagesInRange.md new file mode 100644 index 00000000..20b1529f --- /dev/null +++ b/wiki-information/functions/C_Club.GetMessagesInRange.md @@ -0,0 +1,159 @@ +## Title: C_Club.GetMessagesInRange + +**Content:** +Get downloaded messages in the given range. +`messages = C_Club.GetMessagesInRange(clubId, streamId, oldest, newest)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `oldest` + - *ClubMessageIdentifier* +- `newest` + - *ClubMessageIdentifier* + +**ClubMessageIdentifier Fields:** +- `epoch` + - *number* - number of microseconds since the UNIX epoch +- `position` + - *number* - sort order for messages at the same time + +**Returns:** +- `messages` + - *ClubMessageInfo* + +**ClubMessageInfo Fields:** +- `messageId` + - *ClubMessageIdentifier* +- `content` + - *string* - Protected string +- `author` + - *ClubMemberInfo* +- `destroyer` + - *ClubMemberInfo?* - May be nil even if the message has been destroyed +- `destroyed` + - *boolean* +- `edited` + - *boolean* + +**ClubMessageIdentifier Fields:** +- `epoch` + - *number* - number of microseconds since the UNIX epoch +- `position` + - *number* - sort order for messages at the same time + +**ClubMemberInfo Fields:** +- `isSelf` + - *boolean* +- `memberId` + - *number* +- `name` + - *string?* - name may be encoded as a Kstring +- `role` + - *Enum.ClubRoleIdentifier?* +- `presence` + - *Enum.ClubMemberPresence* +- `clubType` + - *Enum.ClubType?* +- `guid` + - *string?* +- `bnetAccountId` + - *number?* +- `memberNote` + - *string?* +- `officerNote` + - *string?* +- `classID` + - *number?* +- `race` + - *number?* +- `level` + - *number?* +- `zone` + - *string?* +- `achievementPoints` + - *number?* +- `profession1ID` + - *number?* +- `profession1Rank` + - *number?* +- `profession1Name` + - *string?* +- `profession2ID` + - *number?* +- `profession2Rank` + - *number?* +- `profession2Name` + - *string?* +- `lastOnlineYear` + - *number?* +- `lastOnlineMonth` + - *number?* +- `lastOnlineDay` + - *number?* +- `lastOnlineHour` + - *number?* +- `guildRank` + - *string?* +- `guildRankOrder` + - *number?* +- `isRemoteChat` + - *boolean?* +- `overallDungeonScore` + - *number?* - Added in 9.1.0 +- `faction` + - *Enum.PvPFaction?* - Added in 9.2.5 + +**Enum.ClubRoleIdentifier Values:** +- `1` + - *Owner* +- `2` + - *Leader* +- `3` + - *Moderator* +- `4` + - *Member* + +**Enum.ClubMemberPresence Values:** +- `0` + - *Unknown* +- `1` + - *Online* +- `2` + - *OnlineMobile* +- `3` + - *Offline* +- `4` + - *Away* +- `5` + - *Busy* + +**Enum.ClubType Values:** +- `0` + - *BattleNet* +- `1` + - *Character* +- `2` + - *Guild* +- `3` + - *Other* + +**Description:** +The messages are filtered by ignored players. + +**Usage:** +Prints all guild messages from start to end. Only tested with a small guild. +```lua +local club = C_Club.GetGuildClubId() +local streams = C_Club.GetStreams(club) +local guildStream = streams.streamId +local ranges = C_Club.GetMessageRanges(club, guildStream) +local oldest, newest = ranges.oldestMessageId, ranges.newestMessageId +local messages = C_Club.GetMessagesInRange(club, guildStream, oldest, newest) +for _, v in pairs(messages) do + local timestamp = date("%Y-%m-%d %H:%M:%S", v.messageId.epoch/1e6) + print(format("%s %s: |cffdda0dd%s|r", timestamp, v.author.name, v.content)) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetStreamInfo.md b/wiki-information/functions/C_Club.GetStreamInfo.md new file mode 100644 index 00000000..abe3d4d1 --- /dev/null +++ b/wiki-information/functions/C_Club.GetStreamInfo.md @@ -0,0 +1,44 @@ +## Title: C_Club.GetStreamInfo + +**Content:** +Needs summary. +`streamInfo = C_Club.GetStreamInfo(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Returns:** +- `streamInfo` + - *structure* - ClubStreamInfo (nilable) + - `ClubStreamInfo` + - `Field` + - `Type` + - `Description` + - `streamId` + - *string* + - `name` + - *string* + - `subject` + - *string* + - `leadersAndModeratorsOnly` + - *boolean* + - `streamType` + - *Enum.ClubStreamType* + - `creationTime` + - *number* + +**Enum.ClubStreamType:** +- `Value` +- `Field` +- `Description` +- `0` + - General +- `1` + - Guild +- `2` + - Officer +- `3` + - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetStreamViewMarker.md b/wiki-information/functions/C_Club.GetStreamViewMarker.md new file mode 100644 index 00000000..4e2eb7ce --- /dev/null +++ b/wiki-information/functions/C_Club.GetStreamViewMarker.md @@ -0,0 +1,15 @@ +## Title: C_Club.GetStreamViewMarker + +**Content:** +Needs summary. +`lastReadTime = C_Club.GetStreamViewMarker(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Returns:** +- `lastReadTime` + - *number?* - nil if stream view is at current \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetStreams.md b/wiki-information/functions/C_Club.GetStreams.md new file mode 100644 index 00000000..39c96235 --- /dev/null +++ b/wiki-information/functions/C_Club.GetStreams.md @@ -0,0 +1,68 @@ +## Title: C_Club.GetStreams + +**Content:** +Needs summary. +`streams = C_Club.GetStreams(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `streams` + - *structure* - ClubStreamInfo + - `ClubStreamInfo` + - `Field` + - `Type` + - `Description` + - `streamId` + - *string* + - `name` + - *string* + - `subject` + - *string* + - `leadersAndModeratorsOnly` + - *boolean* + - `streamType` + - *Enum.ClubStreamType* + - `creationTime` + - *number* + + - `Enum.ClubStreamType` + - `Value` + - `Field` + - `Description` + - `0` + - General + - `1` + - Guild + - `2` + - Officer + - `3` + - Other + +**Usage:** +Prints the streams/channels for your guild. +```lua +local club = C_Club.GetGuildClubId() +local streams = C_Club.GetStreams(club) +for _, v in pairs(streams) do + print(v.streamId, v.name) +end +-- 1, "Guild" +-- 2, "Officer" +``` + +Prints all guild messages from start to end. Only tested with a small guild. +```lua +local club = C_Club.GetGuildClubId() +local streams = C_Club.GetStreams(club) +local guildStream = streams.streamId +local ranges = C_Club.GetMessageRanges(club, guildStream) +local oldest, newest = ranges.oldestMessageId, ranges.newestMessageId +local messages = C_Club.GetMessagesInRange(club, guildStream, oldest, newest) +for _, v in pairs(messages) do + local timestamp = date("%Y-%m-%d %H:%M:%S", v.messageId.epoch/1e6) + print(format("%s %s: |cffdda0dd%s|r", timestamp, v.author.name, v.content)) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetSubscribedClubs.md b/wiki-information/functions/C_Club.GetSubscribedClubs.md new file mode 100644 index 00000000..c77d6a8a --- /dev/null +++ b/wiki-information/functions/C_Club.GetSubscribedClubs.md @@ -0,0 +1,52 @@ +## Title: C_Club.GetSubscribedClubs + +**Content:** +Needs summary. +`clubs = C_Club.GetSubscribedClubs()` + +**Returns:** +- `clubs` + - *structure* - ClubInfo + - `ClubInfo` + - `Field` + - `Type` + - `Description` + - `clubId` + - *string* + - `name` + - *string* + - `shortName` + - *string?* + - `description` + - *string* + - `broadcast` + - *string* + - `clubType` + - *Enum.ClubType* + - `avatarId` + - *number* + - `memberCount` + - *number?* + - `favoriteTimeStamp` + - *number?* + - `joinTime` + - *number?* + - UNIX timestamp measured in microsecond precision. + - `socialQueueingEnabled` + - *boolean?* + - `crossFaction` + - *boolean?* + - Added in 9.2.5 + +- `Enum.ClubType` + - `Value` + - `Field` + - `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetTickets.md b/wiki-information/functions/C_Club.GetTickets.md new file mode 100644 index 00000000..a73b58f2 --- /dev/null +++ b/wiki-information/functions/C_Club.GetTickets.md @@ -0,0 +1,141 @@ +## Title: C_Club.GetTickets + +**Content:** +Needs summary. +`tickets = C_Club.GetTickets(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `tickets` + - *structure* - ClubTicketInfo + - `ClubTicketInfo` + - `Field` + - `Type` + - `Description` + - `ticketId` + - *string* + - `allowedRedeemCount` + - *number* + - `currentRedeemCount` + - *number* + - `creationTime` + - *number* - Creation time in microseconds since the UNIX epoch + - `expirationTime` + - *number* - Expiration time in microseconds since the UNIX epoch + - `defaultStreamId` + - *string?* + - `creator` + - *ClubMemberInfo* + - `ClubMemberInfo` + - `Field` + - `Type` + - `Description` + - `isSelf` + - *boolean* + - `memberId` + - *number* + - `name` + - *string?* - name may be encoded as a Kstring + - `role` + - *Enum.ClubRoleIdentifier?* + - `presence` + - *Enum.ClubMemberPresence* + - `clubType` + - *Enum.ClubType?* + - `guid` + - *string?* + - `bnetAccountId` + - *number?* + - `memberNote` + - *string?* + - `officerNote` + - *string?* + - `classID` + - *number?* + - `race` + - *number?* + - `level` + - *number?* + - `zone` + - *string?* + - `achievementPoints` + - *number?* + - `profession1ID` + - *number?* + - `profession1Rank` + - *number?* + - `profession1Name` + - *string?* + - `profession2ID` + - *number?* + - `profession2Rank` + - *number?* + - `profession2Name` + - *string?* + - `lastOnlineYear` + - *number?* + - `lastOnlineMonth` + - *number?* + - `lastOnlineDay` + - *number?* + - `lastOnlineHour` + - *number?* + - `guildRank` + - *string?* + - `guildRankOrder` + - *number?* + - `isRemoteChat` + - *boolean?* + - `overallDungeonScore` + - *number?* - Added in 9.1.0 + - `faction` + - *Enum.PvPFaction?* - Added in 9.2.5 + +**Enum.ClubRoleIdentifier** +- `Value` +- `Field` +- `Description` + - `1` + - Owner + - `2` + - Leader + - `3` + - Moderator + - `4` + - Member + +**Enum.ClubMemberPresence** +- `Value` +- `Field` +- `Description` + - `0` + - Unknown + - `1` + - Online + - `2` + - OnlineMobile + - `3` + - Offline + - `4` + - Away + - `5` + - Busy + +**Enum.ClubType** +- `Value` +- `Field` +- `Description` + - `0` + - BattleNet + - `1` + - Character + - `2` + - Guild + - `3` + - Other + +**Description:** +Get the existing tickets for this club. Call `RequestTickets()` to retrieve tickets from the server. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsAccountMuted.md b/wiki-information/functions/C_Club.IsAccountMuted.md new file mode 100644 index 00000000..82ea260b --- /dev/null +++ b/wiki-information/functions/C_Club.IsAccountMuted.md @@ -0,0 +1,13 @@ +## Title: C_Club.IsAccountMuted + +**Content:** +Needs summary. +`accountMuted = C_Club.IsAccountMuted(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Returns:** +- `accountMuted` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsBeginningOfStream.md b/wiki-information/functions/C_Club.IsBeginningOfStream.md new file mode 100644 index 00000000..124c65d7 --- /dev/null +++ b/wiki-information/functions/C_Club.IsBeginningOfStream.md @@ -0,0 +1,28 @@ +## Title: C_Club.IsBeginningOfStream + +**Content:** +Needs summary. +`isBeginningOfStream = C_Club.IsBeginningOfStream(clubId, streamId, messageId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `messageId` + - *structure* - ClubMessageIdentifier + - `ClubMessageIdentifier` + - `Field` + - `Type` + - `Description` + - `epoch` + - *number* - number of microseconds since the UNIX epoch + - `position` + - *number* - sort order for messages at the same time + +**Returns:** +- `isBeginningOfStream` + - *boolean* + +**Description:** +Returns whether the given message is the first message in the stream, taking into account ignored messages. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsEnabled.md b/wiki-information/functions/C_Club.IsEnabled.md new file mode 100644 index 00000000..388d68be --- /dev/null +++ b/wiki-information/functions/C_Club.IsEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Club.IsEnabled + +**Content:** +Needs summary. +`clubsEnabled = C_Club.IsEnabled()` + +**Returns:** +- `clubsEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsRestricted.md b/wiki-information/functions/C_Club.IsRestricted.md new file mode 100644 index 00000000..949992fa --- /dev/null +++ b/wiki-information/functions/C_Club.IsRestricted.md @@ -0,0 +1,16 @@ +## Title: C_Club.IsRestricted + +**Content:** +Needs summary. +`restrictionReason = C_Club.IsRestricted()` + +**Returns:** +- `restrictionReason` + - *Enum.ClubRestrictionReason* + - `Value` + - `Field` + - `Description` + - `0` + - `None` + - `1` + - `Unavailable` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsSubscribedToStream.md b/wiki-information/functions/C_Club.IsSubscribedToStream.md new file mode 100644 index 00000000..1dfa6fb5 --- /dev/null +++ b/wiki-information/functions/C_Club.IsSubscribedToStream.md @@ -0,0 +1,21 @@ +## Title: C_Club.IsSubscribedToStream + +**Content:** +Needs summary. +`subscribed = C_Club.IsSubscribedToStream(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Returns:** +- `subscribed` + - *boolean* + +**Example Usage:** +This function can be used to check if a player is subscribed to a specific stream within a club. This is useful for addons that manage or display club activities and communications. + +**Addons:** +Large addons like "Community Manager" might use this function to manage and display the subscription status of various streams within a club, ensuring that users are kept up-to-date with the streams they are interested in. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.KickMember.md b/wiki-information/functions/C_Club.KickMember.md new file mode 100644 index 00000000..69cec949 --- /dev/null +++ b/wiki-information/functions/C_Club.KickMember.md @@ -0,0 +1,14 @@ +## Title: C_Club.KickMember + +**Content:** +Needs summary. +`C_Club.KickMember(clubId, memberId)` + +**Parameters:** +- `clubId` + - *string* +- `memberId` + - *number* + +**Description:** +Check `kickableRoleIds` privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.LeaveClub.md b/wiki-information/functions/C_Club.LeaveClub.md new file mode 100644 index 00000000..26db1bb0 --- /dev/null +++ b/wiki-information/functions/C_Club.LeaveClub.md @@ -0,0 +1,9 @@ +## Title: C_Club.LeaveClub + +**Content:** +Needs summary. +`C_Club.LeaveClub(clubId)` + +**Parameters:** +- `clubId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RedeemTicket.md b/wiki-information/functions/C_Club.RedeemTicket.md new file mode 100644 index 00000000..225fe3df --- /dev/null +++ b/wiki-information/functions/C_Club.RedeemTicket.md @@ -0,0 +1,9 @@ +## Title: C_Club.RedeemTicket + +**Content:** +Needs summary. +`C_Club.RedeemTicket(ticketId)` + +**Parameters:** +- `ticketId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestInvitationsForClub.md b/wiki-information/functions/C_Club.RequestInvitationsForClub.md new file mode 100644 index 00000000..9502d425 --- /dev/null +++ b/wiki-information/functions/C_Club.RequestInvitationsForClub.md @@ -0,0 +1,12 @@ +## Title: C_Club.RequestInvitationsForClub + +**Content:** +Needs summary. +`C_Club.RequestInvitationsForClub(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Description:** +Request invitations for this club from the server. Check canGetInvitation privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestMoreMessagesBefore.md b/wiki-information/functions/C_Club.RequestMoreMessagesBefore.md new file mode 100644 index 00000000..1c25c606 --- /dev/null +++ b/wiki-information/functions/C_Club.RequestMoreMessagesBefore.md @@ -0,0 +1,30 @@ +## Title: C_Club.RequestMoreMessagesBefore + +**Content:** +Needs summary. +`alreadyHasMessages = C_Club.RequestMoreMessagesBefore(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `messageId` + - *structure* - ClubMessageIdentifier (optional) + - `ClubMessageIdentifier` + - `Field` + - `Type` + - `Description` + - `epoch` + - *number* - number of microseconds since the UNIX epoch + - `position` + - *number* - sort order for messages at the same time + - `count` + - *number?* + +**Returns:** +- `alreadyHasMessages` + - *boolean* + +**Description:** +Call this when the user scrolls near the top of the message view, and more need to be displayed. The history will be downloaded backwards (newest to oldest). \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestTicket.md b/wiki-information/functions/C_Club.RequestTicket.md new file mode 100644 index 00000000..c7e0ecfa --- /dev/null +++ b/wiki-information/functions/C_Club.RequestTicket.md @@ -0,0 +1,9 @@ +## Title: C_Club.RequestTicket + +**Content:** +Needs summary. +`C_Club.RequestTicket(ticketId)` + +**Parameters:** +- `ticketId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestTickets.md b/wiki-information/functions/C_Club.RequestTickets.md new file mode 100644 index 00000000..38a16783 --- /dev/null +++ b/wiki-information/functions/C_Club.RequestTickets.md @@ -0,0 +1,12 @@ +## Title: C_Club.RequestTickets + +**Content:** +Needs summary. +`C_Club.RequestTickets(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Description:** +Request tickets from server. Check canGetTicket privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RevokeInvitation.md b/wiki-information/functions/C_Club.RevokeInvitation.md new file mode 100644 index 00000000..f5cd30ac --- /dev/null +++ b/wiki-information/functions/C_Club.RevokeInvitation.md @@ -0,0 +1,14 @@ +## Title: C_Club.RevokeInvitation + +**Content:** +Needs summary. +`C_Club.RevokeInvitation(clubId, memberId)` + +**Parameters:** +- `clubId` + - *string* +- `memberId` + - *number* + +**Description:** +Check `canRevokeOwnInvitation` or `canRevokeOtherInvitation`. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SendBattleTagFriendRequest.md b/wiki-information/functions/C_Club.SendBattleTagFriendRequest.md new file mode 100644 index 00000000..31278873 --- /dev/null +++ b/wiki-information/functions/C_Club.SendBattleTagFriendRequest.md @@ -0,0 +1,17 @@ +## Title: C_Club.SendBattleTagFriendRequest + +**Content:** +Needs summary. +`C_Club.SendBattleTagFriendRequest(guildClubId, memberId)` + +**Parameters:** +- `guildClubId` + - *string* +- `memberId` + - *number* + +**Example Usage:** +This function can be used to send a BattleTag friend request to a member of a specific guild club. For instance, if you have the `guildClubId` and `memberId` of a player you wish to add as a friend, you can use this function to send the request programmatically. + +**Additional Information:** +This function is particularly useful for addons that manage social interactions within the game, such as guild management tools or social networking addons. It allows for automated friend requests based on certain criteria or events within the addon. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SendInvitation.md b/wiki-information/functions/C_Club.SendInvitation.md new file mode 100644 index 00000000..880dda75 --- /dev/null +++ b/wiki-information/functions/C_Club.SendInvitation.md @@ -0,0 +1,14 @@ +## Title: C_Club.SendInvitation + +**Content:** +Needs summary. +`C_Club.SendInvitation(clubId, memberId)` + +**Parameters:** +- `clubId` + - *string* +- `memberId` + - *number* + +**Description:** +Check the canSendInvitation privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SendMessage.md b/wiki-information/functions/C_Club.SendMessage.md new file mode 100644 index 00000000..84f0d9b0 --- /dev/null +++ b/wiki-information/functions/C_Club.SendMessage.md @@ -0,0 +1,13 @@ +## Title: C_Club.SendMessage + +**Content:** +This is a protected function and will not work via addons. Used to send a message to a Club Stream. +`C_Club.SendMessage(clubId, streamId, message)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* +- `message` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md b/wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md new file mode 100644 index 00000000..a02a1441 --- /dev/null +++ b/wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md @@ -0,0 +1,14 @@ +## Title: C_Club.SetAutoAdvanceStreamViewMarker + +**Content:** +Needs summary. +`C_Club.SetAutoAdvanceStreamViewMarker(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Description:** +Only one stream can be set for auto-advance at a time. Focused streams will have their view times advanced automatically. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetAvatarTexture.md b/wiki-information/functions/C_Club.SetAvatarTexture.md new file mode 100644 index 00000000..d8cce8da --- /dev/null +++ b/wiki-information/functions/C_Club.SetAvatarTexture.md @@ -0,0 +1,25 @@ +## Title: C_Club.SetAvatarTexture + +**Content:** +Needs summary. +`C_Club.SetAvatarTexture(texture, avatarId, clubType)` + +**Parameters:** +- `texture` + - *table* +- `avatarId` + - *number* +- `clubType` + - *Enum.ClubType* + - `Enum.ClubType` + - **Value** + - **Field** + - **Description** + - `0` + - *BattleNet* + - `1` + - *Character* + - `2` + - *Guild* + - `3` + - *Other* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetClubMemberNote.md b/wiki-information/functions/C_Club.SetClubMemberNote.md new file mode 100644 index 00000000..ebfabf0c --- /dev/null +++ b/wiki-information/functions/C_Club.SetClubMemberNote.md @@ -0,0 +1,16 @@ +## Title: C_Club.SetClubMemberNote + +**Content:** +Needs summary. +`C_Club.SetClubMemberNote(clubId, memberId, note)` + +**Parameters:** +- `clubId` + - *string* +- `memberId` + - *number* +- `note` + - *string* + +**Description:** +Check the `canSetOwnMemberNote` and `canSetOtherMemberNote` privileges. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetClubPresenceSubscription.md b/wiki-information/functions/C_Club.SetClubPresenceSubscription.md new file mode 100644 index 00000000..363fefb4 --- /dev/null +++ b/wiki-information/functions/C_Club.SetClubPresenceSubscription.md @@ -0,0 +1,12 @@ +## Title: C_Club.SetClubPresenceSubscription + +**Content:** +Needs summary. +`C_Club.SetClubPresenceSubscription(clubId)` + +**Parameters:** +- `clubId` + - *string* + +**Description:** +You can only be subscribed to 0 or 1 clubs for presence. Subscribing to a new club automatically unsubscribes you from the existing subscription. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md b/wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md new file mode 100644 index 00000000..560366c9 --- /dev/null +++ b/wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md @@ -0,0 +1,17 @@ +## Title: C_Club.SetClubStreamNotificationSettings + +**Content:** +Needs summary. +`C_Club.SetClubStreamNotificationSettings(clubId, settings)` + +**Parameters:** +- `clubId` + - *string* +- `settings` + - *table* + +**Example Usage:** +This function can be used to set the notification settings for a specific club stream. For instance, if you want to mute notifications for a particular club stream, you can call this function with the appropriate settings. + +**Addons:** +Large addons like "ElvUI" or "WeakAuras" might use this function to manage club notifications based on user preferences. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetCommunityID.md b/wiki-information/functions/C_Club.SetCommunityID.md new file mode 100644 index 00000000..13adc5b6 --- /dev/null +++ b/wiki-information/functions/C_Club.SetCommunityID.md @@ -0,0 +1,9 @@ +## Title: C_Club.SetCommunityID + +**Content:** +Needs summary. +`C_Club.SetCommunityID(communityID)` + +**Parameters:** +- `communityID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetFavorite.md b/wiki-information/functions/C_Club.SetFavorite.md new file mode 100644 index 00000000..00092aca --- /dev/null +++ b/wiki-information/functions/C_Club.SetFavorite.md @@ -0,0 +1,11 @@ +## Title: C_Club.SetFavorite + +**Content:** +Needs summary. +`C_Club.SetFavorite(clubId, isFavorite)` + +**Parameters:** +- `clubId` + - *string* +- `isFavorite` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetSocialQueueingEnabled.md b/wiki-information/functions/C_Club.SetSocialQueueingEnabled.md new file mode 100644 index 00000000..69aa4def --- /dev/null +++ b/wiki-information/functions/C_Club.SetSocialQueueingEnabled.md @@ -0,0 +1,25 @@ +## Title: C_Club.SetSocialQueueingEnabled + +**Content:** +Needs summary. +`C_Club.SetSocialQueueingEnabled(clubId, enabled)` + +**Parameters:** +- `clubId` + - *string* +- `enabled` + - *boolean* + +**Description:** +This function is used to enable or disable social queueing for a specific club. Social queueing allows club members to see each other's activities and join them more easily. + +**Example Usage:** +```lua +-- Enable social queueing for a club with a specific ID +local clubId = "1234567890" +local enabled = true +C_Club.SetSocialQueueingEnabled(clubId, enabled) +``` + +**Addons:** +Large addons like "ElvUI" and "WeakAuras" might use this function to manage social interactions and queueing within their custom interfaces, enhancing the social experience for users. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ShouldAllowClubType.md b/wiki-information/functions/C_Club.ShouldAllowClubType.md new file mode 100644 index 00000000..ebd6703f --- /dev/null +++ b/wiki-information/functions/C_Club.ShouldAllowClubType.md @@ -0,0 +1,20 @@ +## Title: C_Club.ShouldAllowClubType + +**Content:** +Needs summary. +`clubTypeIsAllowed = C_Club.ShouldAllowClubType(clubType)` + +**Parameters:** +- `clubType` + - *Enum.ClubType* + - `0` - BattleNet + - `1` - Character + - `2` - Guild + - `3` - Other + +**Returns:** +- `clubTypeIsAllowed` + - *boolean* + +**Description:** +This function checks if a specific type of club is allowed. The `clubType` parameter is an enumeration that specifies the type of club, such as BattleNet, Character, Guild, or Other. The function returns a boolean indicating whether the specified club type is allowed. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.UnfocusAllStreams.md b/wiki-information/functions/C_Club.UnfocusAllStreams.md new file mode 100644 index 00000000..0ffe0e60 --- /dev/null +++ b/wiki-information/functions/C_Club.UnfocusAllStreams.md @@ -0,0 +1,9 @@ +## Title: C_Club.UnfocusAllStreams + +**Content:** +Needs summary. +`C_Club.UnfocusAllStreams(unsubscribe)` + +**Parameters:** +- `unsubscribe` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.UnfocusStream.md b/wiki-information/functions/C_Club.UnfocusStream.md new file mode 100644 index 00000000..18cc88de --- /dev/null +++ b/wiki-information/functions/C_Club.UnfocusStream.md @@ -0,0 +1,27 @@ +## Title: C_Club.UnfocusStream + +**Content:** +Needs summary. +`C_Club.UnfocusStream(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Description:** +This function is used to unfocus a specific stream within a club. This can be useful in scenarios where an addon or script needs to stop receiving updates or notifications from a particular stream in a club. + +**Example Usage:** +```lua +-- Example of how to use C_Club.UnfocusStream +local clubId = "1234567890" -- Example club ID +local streamId = "0987654321" -- Example stream ID + +-- Unfocus the specified stream +C_Club.UnfocusStream(clubId, streamId) +``` + +**Usage in Addons:** +Large addons that manage in-game communities or chat functionalities, such as "Community Manager" or "Guild Chat Enhancer," might use this function to manage the focus on different streams within a club, ensuring that the user interface remains responsive and relevant to the user's current context. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ValidateText.md b/wiki-information/functions/C_Club.ValidateText.md new file mode 100644 index 00000000..4ff7f378 --- /dev/null +++ b/wiki-information/functions/C_Club.ValidateText.md @@ -0,0 +1,58 @@ +## Title: C_Club.ValidateText + +**Content:** +Needs summary. +`result = C_Club.ValidateText(clubType, text, clubFieldType)` + +**Parameters:** +- `clubType` + - *Enum.ClubType* + - **Value** + - **Field** + - **Description** + - `0` - BattleNet + - `1` - Character + - `2` - Guild + - `3` - Other +- `text` + - *string* +- `clubFieldType` + - *Enum.ClubFieldType* + - **Value** + - **Field** + - **Description** + - `0` - ClubName + - `1` - ClubShortName + - `2` - ClubDescription + - `3` - ClubBroadcast + - `4` - ClubStreamName + - `5` - ClubStreamSubject + - `6` - NumTypes + +**Returns:** +- `result` + - *Enum.ValidateNameResult* + - **Value** + - **Field** + - **Description** + - `0` - Success + - `1` - Failure + - `2` - NoName + - `3` - TooShort + - `4` - TooLong + - `5` - InvalidCharacter + - `6` - MixedLanguages + - `7` - Profane + - `8` - Reserved + - `9` - InvalidApostrophe + - `10` - MultipleApostrophes + - `11` - ThreeConsecutive + - `12` - InvalidSpace + - `13` - ConsecutiveSpaces + - `14` - RussianConsecutiveSilentCharacters + - `15` - RussianSilentCharacterAtBeginningOrEnd + - `16` - DeclensionDoesn't Match BaseName + - `17` - SpacesDisallowed + +**Change Log:** +Added in 8.2.5 \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AddPlayerOverrideName.md b/wiki-information/functions/C_Commentator.AddPlayerOverrideName.md new file mode 100644 index 00000000..d93c396e --- /dev/null +++ b/wiki-information/functions/C_Commentator.AddPlayerOverrideName.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.AddPlayerOverrideName + +**Content:** +Needs summary. +`C_Commentator.AddPlayerOverrideName(playerName, overrideName)` + +**Parameters:** +- `playerName` + - *string* +- `overrideName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md b/wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md new file mode 100644 index 00000000..cfc1ddc7 --- /dev/null +++ b/wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.AddTrackedDefensiveAuras + +**Content:** +Needs summary. +`C_Commentator.AddTrackedDefensiveAuras(spellIDs)` + +**Parameters:** +- `spellIDs` + - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md b/wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md new file mode 100644 index 00000000..3e951c4b --- /dev/null +++ b/wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.AddTrackedOffensiveAuras + +**Content:** +Needs summary. +`C_Commentator.AddTrackedOffensiveAuras(spellIDs)` + +**Parameters:** +- `spellIDs` + - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AreTeamsSwapped.md b/wiki-information/functions/C_Commentator.AreTeamsSwapped.md new file mode 100644 index 00000000..63205200 --- /dev/null +++ b/wiki-information/functions/C_Commentator.AreTeamsSwapped.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.AreTeamsSwapped + +**Content:** +Needs summary. +`teamsAreSwapped = C_Commentator.AreTeamsSwapped()` + +**Returns:** +- `teamsAreSwapped` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AssignPlayerToTeam.md b/wiki-information/functions/C_Commentator.AssignPlayerToTeam.md new file mode 100644 index 00000000..b69d8e6b --- /dev/null +++ b/wiki-information/functions/C_Commentator.AssignPlayerToTeam.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.AssignPlayerToTeam + +**Content:** +Needs summary. +`C_Commentator.AssignPlayerToTeam(playerName, teamName)` + +**Parameters:** +- `playerName` + - *string* +- `teamName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AssignPlayersToTeam.md b/wiki-information/functions/C_Commentator.AssignPlayersToTeam.md new file mode 100644 index 00000000..9309a81c --- /dev/null +++ b/wiki-information/functions/C_Commentator.AssignPlayersToTeam.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.AssignPlayersToTeam + +**Content:** +Needs summary. +`C_Commentator.AssignPlayersToTeam(playerName, teamName)` + +**Parameters:** +- `playerName` + - *string* +- `teamName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md b/wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md new file mode 100644 index 00000000..baf723c3 --- /dev/null +++ b/wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.AssignPlayersToTeamInCurrentInstance + +**Content:** +Needs summary. +`C_Commentator.AssignPlayersToTeamInCurrentInstance(teamIndex, teamName)` + +**Parameters:** +- `teamIndex` + - *number* +- `teamName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md b/wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md new file mode 100644 index 00000000..6427aa76 --- /dev/null +++ b/wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.CanUseCommentatorCheats + +**Content:** +Needs summary. +`canUseCommentatorCheats = C_Commentator.CanUseCommentatorCheats()` + +**Returns:** +- `canUseCommentatorCheats` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ClearCameraTarget.md b/wiki-information/functions/C_Commentator.ClearCameraTarget.md new file mode 100644 index 00000000..6ea4d921 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ClearCameraTarget.md @@ -0,0 +1,8 @@ +## Title: C_Commentator.ClearCameraTarget + +**Content:** +Needs summary. +`C_Commentator.ClearCameraTarget()` + +**Description:** +This function is used to clear the current camera target in the World of Warcraft Commentator mode, which is often used in esports and live event broadcasts to control the camera view. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ClearFollowTarget.md b/wiki-information/functions/C_Commentator.ClearFollowTarget.md new file mode 100644 index 00000000..e920294c --- /dev/null +++ b/wiki-information/functions/C_Commentator.ClearFollowTarget.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.ClearFollowTarget + +**Content:** +Needs summary. +`C_Commentator.ClearFollowTarget()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ClearLookAtTarget.md b/wiki-information/functions/C_Commentator.ClearLookAtTarget.md new file mode 100644 index 00000000..f208fb66 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ClearLookAtTarget.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.ClearLookAtTarget + +**Content:** +Needs summary. +`C_Commentator.ClearLookAtTarget()` + +**Parameters:** +- `lookAtIndex` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.EnterInstance.md b/wiki-information/functions/C_Commentator.EnterInstance.md new file mode 100644 index 00000000..7f1505c6 --- /dev/null +++ b/wiki-information/functions/C_Commentator.EnterInstance.md @@ -0,0 +1,6 @@ +## Title: C_Commentator.EnterInstance + +**Content:** +Needs summary. +`C_Commentator.EnterInstance()` + diff --git a/wiki-information/functions/C_Commentator.ExitInstance.md b/wiki-information/functions/C_Commentator.ExitInstance.md new file mode 100644 index 00000000..6cb78df6 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ExitInstance.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.ExitInstance + +**Content:** +Needs summary. +`C_Commentator.ExitInstance()` + +**Example Usage:** +This function can be used in scenarios where a commentator needs to exit an instance, such as during esports events or live streams where the commentator needs to leave the game instance they are currently in. + +**Addons:** +While specific large addons using this function are not well-documented, it is likely used in custom addons designed for esports events or live streaming tools that manage commentator actions within World of Warcraft. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FindSpectatedUnit.md b/wiki-information/functions/C_Commentator.FindSpectatedUnit.md new file mode 100644 index 00000000..03f38793 --- /dev/null +++ b/wiki-information/functions/C_Commentator.FindSpectatedUnit.md @@ -0,0 +1,17 @@ +## Title: C_Commentator.FindSpectatedUnit + +**Content:** +Needs summary. +`playerIndex, teamIndex, isPet = C_Commentator.FindSpectatedUnit(unitToken)` + +**Parameters:** +- `unitToken` + - *string* - UnitId + +**Returns:** +- `playerIndex` + - *number* +- `teamIndex` + - *number* +- `isPet` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md b/wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md new file mode 100644 index 00000000..e8a39ea7 --- /dev/null +++ b/wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.FindTeamNameInCurrentInstance + +**Content:** +Needs summary. +`teamName = C_Commentator.FindTeamNameInCurrentInstance(teamIndex)` + +**Parameters:** +- `teamIndex` + - *number* + +**Returns:** +- `teamName` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md b/wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md new file mode 100644 index 00000000..b024f79e --- /dev/null +++ b/wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.FindTeamNameInDirectory + +**Content:** +Needs summary. +`teamName = C_Commentator.FindTeamNameInDirectory(playerNames)` + +**Parameters:** +- `playerNames` + - *string* + +**Returns:** +- `teamName` + - *string?* + +**Example Usage:** +This function can be used to find the team name associated with a list of player names in the commentator's directory. This can be particularly useful in esports or tournament settings where commentators need to quickly reference team information based on player names. + +**Addons:** +Large addons or tools used for esports commentary, such as those used in official Blizzard tournaments, might use this function to streamline the process of identifying teams and providing accurate commentary. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FlushCommentatorHistory.md b/wiki-information/functions/C_Commentator.FlushCommentatorHistory.md new file mode 100644 index 00000000..14473b14 --- /dev/null +++ b/wiki-information/functions/C_Commentator.FlushCommentatorHistory.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.FlushCommentatorHistory + +**Content:** +Needs summary. +`C_Commentator.FlushCommentatorHistory()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FollowPlayer.md b/wiki-information/functions/C_Commentator.FollowPlayer.md new file mode 100644 index 00000000..06fe9deb --- /dev/null +++ b/wiki-information/functions/C_Commentator.FollowPlayer.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.FollowPlayer + +**Content:** +Needs summary. +`C_Commentator.FollowPlayer(factionIndex, playerIndex)` + +**Parameters:** +- `factionIndex` + - *number* +- `playerIndex` + - *number* +- `forceInstantTransition` + - *boolean?* + +**Example Usage:** +This function can be used in a World of Warcraft addon designed for commentators or broadcasters to follow a specific player in a PvP match or battleground. By specifying the faction and player index, the camera can be directed to follow the desired player, enhancing the viewing experience for spectators. + +**Addons Using This Function:** +Large addons like "ArenaLive" or "Gladius" might use this function to provide better camera control and player tracking during PvP events, making it easier for commentators to highlight key moments and player actions. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FollowUnit.md b/wiki-information/functions/C_Commentator.FollowUnit.md new file mode 100644 index 00000000..f311c0c3 --- /dev/null +++ b/wiki-information/functions/C_Commentator.FollowUnit.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.FollowUnit + +**Content:** +Needs summary. +`C_Commentator.FollowUnit(token)` + +**Parameters:** +- `token` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ForceFollowTransition.md b/wiki-information/functions/C_Commentator.ForceFollowTransition.md new file mode 100644 index 00000000..0d54e2ed --- /dev/null +++ b/wiki-information/functions/C_Commentator.ForceFollowTransition.md @@ -0,0 +1,6 @@ +## Title: C_Commentator.ForceFollowTransition + +**Content:** +Needs summary. +`C_Commentator.ForceFollowTransition()` + diff --git a/wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md b/wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md new file mode 100644 index 00000000..c4bc812a --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.GetAdditionalCameraWeight + +**Content:** +Needs summary. +`teamIndex, playerIndex = C_Commentator.GetAdditionalCameraWeight()` + +**Returns:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md b/wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md new file mode 100644 index 00000000..aec70a51 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.GetAdditionalCameraWeightByToken + +**Content:** +Needs summary. +`weight = C_Commentator.GetAdditionalCameraWeightByToken(unitToken)` + +**Parameters:** +- `unitToken` + - *string* : UnitId + +**Returns:** +- `weight` + - *number* + +**Example Usage:** +This function can be used in addons or scripts that need to adjust camera behavior based on specific units in a commentator mode, such as in esports broadcasting addons. + +**Addons:** +Large addons like "ArenaLive" or "Gladius" might use this function to enhance the spectator experience by dynamically adjusting camera weights based on the units being tracked. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md b/wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md new file mode 100644 index 00000000..c2824550 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md @@ -0,0 +1,16 @@ +## Title: C_Commentator.GetAllPlayerOverrideNames + +**Content:** +Needs summary. +`nameEntries = C_Commentator.GetAllPlayerOverrideNames()` + +**Returns:** +- `nameEntries` + - *structure* - NameOverrideEntry + - `Field` + - `Type` + - `Description` + - `originalName` + - *string* + - `overrideName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCamera.md b/wiki-information/functions/C_Commentator.GetCamera.md new file mode 100644 index 00000000..41bf50ad --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetCamera.md @@ -0,0 +1,21 @@ +## Title: C_Commentator.GetCamera + +**Content:** +Needs summary. +`xPos, yPos, zPos, yaw, pitch, roll, fov = C_Commentator.GetCamera()` + +**Returns:** +- `xPos` + - *number* +- `yPos` + - *number* +- `zPos` + - *number* +- `yaw` + - *number* +- `pitch` + - *number* +- `roll` + - *number* +- `fov` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCameraCollision.md b/wiki-information/functions/C_Commentator.GetCameraCollision.md new file mode 100644 index 00000000..f9a77bf3 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetCameraCollision.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetCameraCollision + +**Content:** +Needs summary. +`isColliding = C_Commentator.GetCameraCollision()` + +**Returns:** +- `isColliding` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCameraPosition.md b/wiki-information/functions/C_Commentator.GetCameraPosition.md new file mode 100644 index 00000000..582feb18 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetCameraPosition.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.GetCameraPosition + +**Content:** +Needs summary. +`xPos, yPos, zPos = C_Commentator.GetCameraPosition()` + +**Returns:** +- `xPos` + - *number* +- `yPos` + - *number* +- `zPos` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCommentatorHistory.md b/wiki-information/functions/C_Commentator.GetCommentatorHistory.md new file mode 100644 index 00000000..bc09ac43 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetCommentatorHistory.md @@ -0,0 +1,52 @@ +## Title: C_Commentator.GetCommentatorHistory + +**Content:** +Needs summary. +`history = C_Commentator.GetCommentatorHistory()` + +**Returns:** +- `history` + - *CommentatorHistory* + - `Field` + - `Type` + - `Description` + - `series` + - *CommentatorSeries* + - `teamDirectory` + - *CommentatorTeamDirectoryEntry* + - `overrideNameDirectory` + - *CommentatorOverrideNameEntry* + +**CommentatorSeries** +- `Field` +- `Type` +- `Description` +- `teams` + - *CommentatorSeriesTeam* + +**CommentatorSeriesTeam** +- `Field` +- `Type` +- `Description` +- `name` + - *string* +- `score` + - *number* + +**CommentatorTeamDirectoryEntry** +- `Field` +- `Type` +- `Description` +- `playerName` + - *string* +- `teamName` + - *string* + +**CommentatorOverrideNameEntry** +- `Field` +- `Type` +- `Description` +- `originalName` + - *string* +- `newName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCurrentMapID.md b/wiki-information/functions/C_Commentator.GetCurrentMapID.md new file mode 100644 index 00000000..15a3c43f --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetCurrentMapID.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetCurrentMapID + +**Content:** +Needs summary. +`mapID = C_Commentator.GetCurrentMapID()` + +**Returns:** +- `mapID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetDampeningPercent.md b/wiki-information/functions/C_Commentator.GetDampeningPercent.md new file mode 100644 index 00000000..f5f89b06 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetDampeningPercent.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetDampeningPercent + +**Content:** +Needs summary. +`percentage = C_Commentator.GetDampeningPercent()` + +**Returns:** +- `percentage` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md b/wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md new file mode 100644 index 00000000..bb9acdea --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetDistanceBeforeForcedHorizontalConvergence + +**Content:** +Needs summary. +`distance = C_Commentator.GetDistanceBeforeForcedHorizontalConvergence()` + +**Returns:** +- `distance` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md b/wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md new file mode 100644 index 00000000..abf7b2d8 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetDurationToForceHorizontalConvergence + +**Content:** +Needs summary. +`ms = C_Commentator.GetDurationToForceHorizontalConvergence()` + +**Returns:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetExcludeDistance.md b/wiki-information/functions/C_Commentator.GetExcludeDistance.md new file mode 100644 index 00000000..344c28f2 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetExcludeDistance.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetExcludeDistance + +**Content:** +Needs summary. +`excludeDistance = C_Commentator.GetExcludeDistance()` + +**Returns:** +- `excludeDistance` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetHardlockWeight.md b/wiki-information/functions/C_Commentator.GetHardlockWeight.md new file mode 100644 index 00000000..3b260d3b --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetHardlockWeight.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetHardlockWeight + +**Content:** +Needs summary. +`weight = C_Commentator.GetHardlockWeight()` + +**Returns:** +- `weight` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md b/wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md new file mode 100644 index 00000000..bea25f8e --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetHorizontalAngleThresholdToSmooth + +**Content:** +Needs summary. +`angle = C_Commentator.GetHorizontalAngleThresholdToSmooth()` + +**Returns:** +- `angle` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetIndirectSpellID.md b/wiki-information/functions/C_Commentator.GetIndirectSpellID.md new file mode 100644 index 00000000..42be1c1a --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetIndirectSpellID.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.GetIndirectSpellID + +**Content:** +Needs summary. +`indirectSpellID = C_Commentator.GetIndirectSpellID(trackedSpellID)` + +**Parameters:** +- `trackedSpellID` + - *number* + +**Returns:** +- `indirectSpellID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetInstanceInfo.md b/wiki-information/functions/C_Commentator.GetInstanceInfo.md new file mode 100644 index 00000000..634f70ab --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetInstanceInfo.md @@ -0,0 +1,23 @@ +## Title: C_Commentator.GetInstanceInfo + +**Content:** +Needs summary. +`mapID, mapName, status, instanceIDLow, instanceIDHigh = C_Commentator.GetInstanceInfo(mapIndex, instanceIndex)` + +**Parameters:** +- `mapIndex` + - *number* +- `instanceIndex` + - *number* + +**Returns:** +- `mapID` + - *number* +- `mapName` + - *string?* +- `status` + - *number* +- `instanceIDLow` + - *number* +- `instanceIDHigh` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md b/wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md new file mode 100644 index 00000000..1992db91 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetLookAtLerpAmount + +**Content:** +Needs summary. +`amount = C_Commentator.GetLookAtLerpAmount()` + +**Returns:** +- `amount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMapInfo.md b/wiki-information/functions/C_Commentator.GetMapInfo.md new file mode 100644 index 00000000..128b3db9 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMapInfo.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.GetMapInfo + +**Content:** +Needs summary. +`teamSize, minLevel, maxLevel, numInstances = C_Commentator.GetMapInfo(mapIndex)` + +**Parameters:** +- `mapIndex` + - *number* + +**Returns:** +- `teamSize` + - *number* +- `minLevel` + - *number* +- `maxLevel` + - *number* +- `numInstances` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMatchDuration.md b/wiki-information/functions/C_Commentator.GetMatchDuration.md new file mode 100644 index 00000000..1be6349a --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMatchDuration.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMatchDuration + +**Content:** +Needs summary. +`seconds = C_Commentator.GetMatchDuration()` + +**Returns:** +- `seconds` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md b/wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md new file mode 100644 index 00000000..f651274c --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMaxNumPlayersPerTeam + +**Content:** +Needs summary. +`maxNumPlayersPerTeam = C_Commentator.GetMaxNumPlayersPerTeam()` + +**Returns:** +- `maxNumPlayersPerTeam` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMaxNumTeams.md b/wiki-information/functions/C_Commentator.GetMaxNumTeams.md new file mode 100644 index 00000000..583a2535 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMaxNumTeams.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMaxNumTeams + +**Content:** +Needs summary. +`maxNumTeams = C_Commentator.GetMaxNumTeams()` + +**Returns:** +- `maxNumTeams` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMode.md b/wiki-information/functions/C_Commentator.GetMode.md new file mode 100644 index 00000000..9c76829b --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMode.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMode + +**Content:** +Needs summary. +`commentatorMode = C_Commentator.GetMode()` + +**Returns:** +- `commentatorMode` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md b/wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md new file mode 100644 index 00000000..50932803 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMsToHoldForHorizontalMovement + +**Content:** +Needs summary. +`ms = C_Commentator.GetMsToHoldForHorizontalMovement()` + +**Returns:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md b/wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md new file mode 100644 index 00000000..cae5c23f --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMsToHoldForVerticalMovement + +**Content:** +Needs summary. +`ms = C_Commentator.GetMsToHoldForVerticalMovement()` + +**Returns:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md b/wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md new file mode 100644 index 00000000..e9f3aed8 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMsToSmoothHorizontalChange + +**Content:** +Needs summary. +`ms = C_Commentator.GetMsToSmoothHorizontalChange()` + +**Returns:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md b/wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md new file mode 100644 index 00000000..60ba08d0 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetMsToSmoothVerticalChange + +**Content:** +Needs summary. +`ms = C_Commentator.GetMsToSmoothVerticalChange()` + +**Returns:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetNumMaps.md b/wiki-information/functions/C_Commentator.GetNumMaps.md new file mode 100644 index 00000000..6b252f79 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetNumMaps.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetNumMaps + +**Content:** +Needs summary. +`numMaps = C_Commentator.GetNumMaps()` + +**Returns:** +- `numMaps` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetNumPlayers.md b/wiki-information/functions/C_Commentator.GetNumPlayers.md new file mode 100644 index 00000000..999b3b2a --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetNumPlayers.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.GetNumPlayers + +**Content:** +Needs summary. +`numPlayers = C_Commentator.GetNumPlayers(factionIndex)` + +**Parameters:** +- `factionIndex` + - *number* + +**Returns:** +- `numPlayers` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetOrCreateSeries.md b/wiki-information/functions/C_Commentator.GetOrCreateSeries.md new file mode 100644 index 00000000..dd0eded7 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetOrCreateSeries.md @@ -0,0 +1,28 @@ +## Title: C_Commentator.GetOrCreateSeries + +**Content:** +Needs summary. +`data = C_Commentator.GetOrCreateSeries(teamName1, teamName2)` + +**Parameters:** +- `teamName1` + - *string* +- `teamName2` + - *string* + +**Returns:** +- `data` + - *CommentatorSeries* + - `Field` + - `Type` + - `Description` + - `teams` + - *CommentatorSeriesTeam* + - `CommentatorSeriesTeam` + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `score` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md b/wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md new file mode 100644 index 00000000..fbdd9537 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md @@ -0,0 +1,21 @@ +## Title: C_Commentator.GetPlayerAuraInfo + +**Content:** +Needs summary. +`startTime, duration, enable = C_Commentator.GetPlayerAuraInfo(teamIndex, playerIndex, spellID)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* +- `spellID` + - *number* + +**Returns:** +- `startTime` + - *number* +- `duration` + - *number* +- `enable` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md new file mode 100644 index 00000000..a6e73e06 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.GetPlayerAuraInfoByUnit + +**Content:** +Needs summary. +`startTime, duration, enable = C_Commentator.GetPlayerAuraInfoByUnit(token, spellID)` + +**Parameters:** +- `token` + - *string* +- `spellID` + - *number* + +**Returns:** +- `startTime` + - *number* +- `duration` + - *number* +- `enable` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md b/wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md new file mode 100644 index 00000000..c8addaf4 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md @@ -0,0 +1,30 @@ +## Title: C_Commentator.GetPlayerCooldownInfo + +**Content:** +Needs summary. +`startTime, duration, enable = C_Commentator.GetPlayerCooldownInfo(teamIndex, playerIndex, spellID)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* +- `spellID` + - *number* + +**Returns:** +- `startTime` + - *number* +- `duration` + - *number* +- `enable` + - *boolean* + +**Description:** +This function retrieves cooldown information for a specific player's spell in a commentator mode match. It can be used to track the cooldown status of abilities during esports events or other competitive matches. + +**Example Usage:** +An addon designed for commentators might use this function to display cooldown timers for players' abilities on the screen, providing viewers with real-time information about the availability of key spells. + +**Addons:** +Large addons like "ArenaLive" or "Gladius" might use this function to enhance the spectator experience by showing detailed cooldown information for players in PvP matches. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md new file mode 100644 index 00000000..0152d70c --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.GetPlayerCooldownInfoByUnit + +**Content:** +Needs summary. +`startTime, duration, enable = C_Commentator.GetPlayerCooldownInfoByUnit(unitToken, spellID)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `spellID` + - *number* + +**Returns:** +- `startTime` + - *number* +- `duration` + - *number* +- `enable` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md b/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md new file mode 100644 index 00000000..57a0168d --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.GetPlayerCrowdControlInfo + +**Content:** +Needs summary. +`spellID, expiration, duration = C_Commentator.GetPlayerCrowdControlInfo(teamIndex, playerIndex)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* + +**Returns:** +- `spellID` + - *number* +- `expiration` + - *number* +- `duration` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md new file mode 100644 index 00000000..2a48e088 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md @@ -0,0 +1,17 @@ +## Title: C_Commentator.GetPlayerCrowdControlInfoByUnit + +**Content:** +Needs summary. +`spellID, expiration, duration = C_Commentator.GetPlayerCrowdControlInfoByUnit(token)` + +**Parameters:** +- `token` + - *string* + +**Returns:** +- `spellID` + - *number* +- `expiration` + - *number* +- `duration` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerData.md b/wiki-information/functions/C_Commentator.GetPlayerData.md new file mode 100644 index 00000000..29e243dd --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerData.md @@ -0,0 +1,42 @@ +## Title: C_Commentator.GetPlayerData + +**Content:** +Needs summary. +`info = C_Commentator.GetPlayerData(teamIndex, playerIndex)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* + +**Returns:** +- `info` + - *CommentatorPlayerData?* + - `Field` + - `Type` + - `Description` + - `unitToken` + - *string* + - `name` + - *string* + - `faction` + - *number* + - `specialization` + - *number* + - `damageDone` + - *number* + - `damageTaken` + - *number* + - `healingDone` + - *number* + - `healingTaken` + - *number* + - `kills` + - *number* + - `deaths` + - *number* + - `soloShuffleRoundWins` + - *number* + - `soloShuffleRoundLosses` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md b/wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md new file mode 100644 index 00000000..f62083f9 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md @@ -0,0 +1,24 @@ +## Title: C_Commentator.GetPlayerFlagInfo + +**Content:** +Needs summary. +`hasFlag = C_Commentator.GetPlayerFlagInfo(teamIndex, playerIndex)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* + +**Returns:** +- `hasFlag` + - *boolean* + +**Description:** +This function is used to determine if a player in a commentator's view has a flag. It is particularly useful in PvP scenarios, such as battlegrounds or arena matches, where tracking flag possession is crucial for commentary and analysis. + +**Example Usage:** +In a custom addon designed for eSports commentary, this function can be used to highlight players who are currently carrying a flag, allowing commentators to provide more detailed and engaging play-by-play analysis. + +**Addons Using This Function:** +- **Blizzard's Arena Spectator UI**: Utilizes this function to display flag status for players during arena matches, enhancing the viewing experience for spectators. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md new file mode 100644 index 00000000..d973f07b --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md @@ -0,0 +1,22 @@ +## Title: C_Commentator.GetPlayerFlagInfoByUnit + +**Content:** +Needs summary. +`hasFlag = C_Commentator.GetPlayerFlagInfoByUnit(unitToken)` + +**Parameters:** +- `unitToken` + - *string* : UnitId + +**Returns:** +- `hasFlag` + - *boolean* + +**Description:** +This function checks if a player, identified by the `unitToken`, has a flag in a battleground or similar context. It returns `true` if the player has the flag, and `false` otherwise. + +**Example Usage:** +This function can be used in addons that track player status in battlegrounds, such as determining if a player is carrying the flag in Warsong Gulch. + +**Addons:** +Large PvP-oriented addons like "BattlegroundTargets" might use this function to provide real-time information about flag carriers to players. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerOverrideName.md b/wiki-information/functions/C_Commentator.GetPlayerOverrideName.md new file mode 100644 index 00000000..ee4f8a4a --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerOverrideName.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.GetPlayerOverrideName + +**Content:** +Needs summary. +`overrideName = C_Commentator.GetPlayerOverrideName(originalName)` + +**Parameters:** +- `originalName` + - *string* + +**Returns:** +- `overrideName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md b/wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md new file mode 100644 index 00000000..980430d3 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md @@ -0,0 +1,23 @@ +## Title: C_Commentator.GetPlayerSpellCharges + +**Content:** +Needs summary. +`charges, maxCharges, startTime, duration = C_Commentator.GetPlayerSpellCharges(teamIndex, playerIndex, spellID)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* +- `spellID` + - *number* + +**Returns:** +- `charges` + - *number* +- `maxCharges` + - *number* +- `startTime` + - *number* +- `duration` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md new file mode 100644 index 00000000..6550b68f --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md @@ -0,0 +1,21 @@ +## Title: C_Commentator.GetPlayerSpellChargesByUnit + +**Content:** +Needs summary. +`charges, maxCharges, startTime, duration = C_Commentator.GetPlayerSpellChargesByUnit(unitToken, spellID)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `spellID` + - *number* + +**Returns:** +- `charges` + - *number* +- `maxCharges` + - *number* +- `startTime` + - *number* +- `duration` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPositionLerpAmount.md b/wiki-information/functions/C_Commentator.GetPositionLerpAmount.md new file mode 100644 index 00000000..f0aceaa9 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetPositionLerpAmount.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetPositionLerpAmount + +**Content:** +Needs summary. +`amount = C_Commentator.GetPositionLerpAmount()` + +**Returns:** +- `amount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md b/wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md new file mode 100644 index 00000000..6301e0df --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetSmoothFollowTransitioning + +**Content:** +Needs summary. +`enabled = C_Commentator.GetSmoothFollowTransitioning()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetSoftlockWeight.md b/wiki-information/functions/C_Commentator.GetSoftlockWeight.md new file mode 100644 index 00000000..6a562a6a --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetSoftlockWeight.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetSoftlockWeight + +**Content:** +Needs summary. +`weight = C_Commentator.GetSoftlockWeight()` + +**Returns:** +- `weight` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetSpeedFactor.md b/wiki-information/functions/C_Commentator.GetSpeedFactor.md new file mode 100644 index 00000000..452954cd --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetSpeedFactor.md @@ -0,0 +1,12 @@ +## Title: C_Commentator.GetSpeedFactor + +**Content:** +Needs summary. +`factor = C_Commentator.GetSpeedFactor()` + +**Returns:** +- `factor` + - *number* + +**Example Usage:** +This function can be used in addons or scripts that need to retrieve the current speed factor in a commentator mode, which might be useful for adjusting the playback speed of events or animations in a World of Warcraft match commentary addon. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetStartLocation.md b/wiki-information/functions/C_Commentator.GetStartLocation.md new file mode 100644 index 00000000..eb8d94d8 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetStartLocation.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.GetStartLocation + +**Content:** +Needs summary. +`pos = C_Commentator.GetStartLocation(instanceID)` + +**Parameters:** +- `instanceID` + - *number* + +**Returns:** +- `pos` + - *Vector3DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTeamColor.md b/wiki-information/functions/C_Commentator.GetTeamColor.md new file mode 100644 index 00000000..56246a58 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetTeamColor.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.GetTeamColor + +**Content:** +Needs summary. +`color = C_Commentator.GetTeamColor(teamIndex)` +`color = C_Commentator.GetTeamColorByUnit(unitToken)` + +**Parameters:** +- **GetTeamColor:** + - `teamIndex` + - *number* + +- **GetTeamColorByUnit:** + - `unitToken` + - *string* : UnitId + +**Returns:** +- `color` + - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTeamColorByUnit.md b/wiki-information/functions/C_Commentator.GetTeamColorByUnit.md new file mode 100644 index 00000000..ac1164e5 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetTeamColorByUnit.md @@ -0,0 +1,20 @@ +## Title: C_Commentator.GetTeamColor + +**Content:** +Needs summary. +`color = C_Commentator.GetTeamColor(teamIndex)` +`color = C_Commentator.GetTeamColorByUnit(unitToken)` + +**Parameters:** + +*GetTeamColor:* +- `teamIndex` + - *number* + +*GetTeamColorByUnit:* +- `unitToken` + - *string* : UnitId + +**Returns:** +- `color` + - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md b/wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md new file mode 100644 index 00000000..8647cf53 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.GetTimeLeftInMatch + +**Content:** +Needs summary. +`timeLeft = C_Commentator.GetTimeLeftInMatch()` + +**Returns:** +- `timeLeft` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTrackedSpellID.md b/wiki-information/functions/C_Commentator.GetTrackedSpellID.md new file mode 100644 index 00000000..7858b178 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetTrackedSpellID.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.GetTrackedSpellID + +**Content:** +Needs summary. +`trackedSpellID = C_Commentator.GetTrackedSpellID(indirectSpellID)` + +**Parameters:** +- `indirectSpellID` + - *number* + +**Returns:** +- `trackedSpellID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTrackedSpells.md b/wiki-information/functions/C_Commentator.GetTrackedSpells.md new file mode 100644 index 00000000..8b7eee01 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetTrackedSpells.md @@ -0,0 +1,26 @@ +## Title: C_Commentator.GetTrackedSpells + +**Content:** +Needs summary. +`spells = C_Commentator.GetTrackedSpells(teamIndex, playerIndex, category)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* +- `category` + - *number* - Enum.TrackedSpellCategory + - `Enum.TrackedSpellCategory` + - `Value` + - `Field` + - `Description` + - `0` - Offensive + - `1` - Defensive + - `2` - Debuff + - `3` - RacialAbility (Added in 10.0.5) + - `4` - Count + +**Returns:** +- `spells` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md b/wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md new file mode 100644 index 00000000..ec026953 --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md @@ -0,0 +1,29 @@ +## Title: C_Commentator.GetTrackedSpellsByUnit + +**Content:** +Needs summary. +`spells = C_Commentator.GetTrackedSpellsByUnit(unitToken, category)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `category` + - *Enum.TrackedSpellCategory* + - `Value` + - `Field` + - `Description` + - `0` + - Offensive + - `1` + - Defensive + - `2` + - Debuff + - `3` + - RacialAbility + - Added in 10.0.5 + - `4` + - Count + +**Returns:** +- `spells` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetUnitData.md b/wiki-information/functions/C_Commentator.GetUnitData.md new file mode 100644 index 00000000..b4bb27bc --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetUnitData.md @@ -0,0 +1,38 @@ +## Title: C_Commentator.GetUnitData + +**Content:** +Needs summary. +`data = C_Commentator.GetUnitData(unitToken)` + +**Parameters:** +- `unitToken` + - *string* : UnitId + +**Returns:** +- `data` + - *CommentatorUnitData* + - `Field` + - `Type` + - `Description` + - `healthMax` + - *number* + - `health` + - *number* + - `absorbTotal` + - *number* + - `isDeadOrGhost` + - *boolean* + - `isFeignDeath` + - *boolean* + - `powerTypeToken` + - *string* + - `power` + - *number* + - `powerMax` + - *number* + +**Example Usage:** +This function can be used in addons or scripts that need to retrieve detailed information about a unit in a commentator mode, such as in esports broadcasting tools or advanced unit frame addons. + +**Addons Using This Function:** +- **Blizzard's Esports Tools**: Utilized for providing real-time data about units during esports events, allowing commentators to give detailed insights into the game state. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetWargameInfo.md b/wiki-information/functions/C_Commentator.GetWargameInfo.md new file mode 100644 index 00000000..7aa0307e --- /dev/null +++ b/wiki-information/functions/C_Commentator.GetWargameInfo.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.GetWargameInfo + +**Content:** +Needs summary. +`name, minPlayers, maxPlayers, isArena = C_Commentator.GetWargameInfo(listID)` + +**Parameters:** +- `listID` + - *number* + +**Returns:** +- `name` + - *string* +- `minPlayers` + - *number* +- `maxPlayers` + - *number* +- `isArena` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.HasTrackedAuras.md b/wiki-information/functions/C_Commentator.HasTrackedAuras.md new file mode 100644 index 00000000..af7425b9 --- /dev/null +++ b/wiki-information/functions/C_Commentator.HasTrackedAuras.md @@ -0,0 +1,15 @@ +## Title: C_Commentator.HasTrackedAuras + +**Content:** +Needs summary. +`hasOffensiveAura, hasDefensiveAura = C_Commentator.HasTrackedAuras(token)` + +**Parameters:** +- `token` + - *string* + +**Returns:** +- `hasOffensiveAura` + - *boolean* +- `hasDefensiveAura` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsSmartCameraLocked.md b/wiki-information/functions/C_Commentator.IsSmartCameraLocked.md new file mode 100644 index 00000000..7206f759 --- /dev/null +++ b/wiki-information/functions/C_Commentator.IsSmartCameraLocked.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.IsSmartCameraLocked + +**Content:** +Needs summary. +`isSmartCameraLocked = C_Commentator.IsSmartCameraLocked()` + +**Returns:** +- `isSmartCameraLocked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsSpectating.md b/wiki-information/functions/C_Commentator.IsSpectating.md new file mode 100644 index 00000000..85cd4e61 --- /dev/null +++ b/wiki-information/functions/C_Commentator.IsSpectating.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.IsSpectating + +**Content:** +Needs summary. +`isSpectating = C_Commentator.IsSpectating()` + +**Returns:** +- `isSpectating` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md b/wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md new file mode 100644 index 00000000..2a40f866 --- /dev/null +++ b/wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.IsTrackedDefensiveAura + +**Content:** +Needs summary. +`isDefensiveTrigger = C_Commentator.IsTrackedDefensiveAura(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `isDefensiveTrigger` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md b/wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md new file mode 100644 index 00000000..1cdb00a6 --- /dev/null +++ b/wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.IsTrackedOffensiveAura + +**Content:** +Needs summary. +`isOffensiveTrigger = C_Commentator.IsTrackedOffensiveAura(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `isOffensiveTrigger` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedSpell.md b/wiki-information/functions/C_Commentator.IsTrackedSpell.md new file mode 100644 index 00000000..e7322618 --- /dev/null +++ b/wiki-information/functions/C_Commentator.IsTrackedSpell.md @@ -0,0 +1,34 @@ +## Title: C_Commentator.IsTrackedSpell + +**Content:** +Needs summary. +`isTracked = C_Commentator.IsTrackedSpell(teamIndex, playerIndex, spellID, category)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* +- `spellID` + - *number* +- `category` + - *number* - Enum.TrackedSpellCategory + - `Enum.TrackedSpellCategory` + - `Value` + - `Field` + - `Description` + - `0` + - Offensive + - `1` + - Defensive + - `2` + - Debuff + - `3` + - RacialAbility + - Added in 10.0.5 + - `4` + - Count + +**Returns:** +- `isTracked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md b/wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md new file mode 100644 index 00000000..e57c2908 --- /dev/null +++ b/wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md @@ -0,0 +1,31 @@ +## Title: C_Commentator.IsTrackedSpellByUnit + +**Content:** +Needs summary. +`isTracked = C_Commentator.IsTrackedSpellByUnit(unitToken, spellID, category)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `spellID` + - *number* +- `category` + - *Enum.TrackedSpellCategory* + - `Value` + - `Field` + - `Description` + - `0` + - Offensive + - `1` + - Defensive + - `2` + - Debuff + - `3` + - RacialAbility + - Added in 10.0.5 + - `4` + - Count + +**Returns:** +- `isTracked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsUsingSmartCamera.md b/wiki-information/functions/C_Commentator.IsUsingSmartCamera.md new file mode 100644 index 00000000..638c41a4 --- /dev/null +++ b/wiki-information/functions/C_Commentator.IsUsingSmartCamera.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.IsUsingSmartCamera + +**Content:** +Needs summary. +`isUsingSmartCamera = C_Commentator.IsUsingSmartCamera()` + +**Returns:** +- `isUsingSmartCamera` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.LookAtPlayer.md b/wiki-information/functions/C_Commentator.LookAtPlayer.md new file mode 100644 index 00000000..4f36f110 --- /dev/null +++ b/wiki-information/functions/C_Commentator.LookAtPlayer.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.LookAtPlayer + +**Content:** +Needs summary. +`C_Commentator.LookAtPlayer(factionIndex, playerIndex)` + +**Parameters:** +- `factionIndex` + - *number* +- `playerIndex` + - *number* +- `lookAtIndex` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md b/wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md new file mode 100644 index 00000000..caffbc83 --- /dev/null +++ b/wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md @@ -0,0 +1,19 @@ +## Title: C_Commentator.RemoveAllOverrideNames + +**Content:** +Needs summary. +`C_Commentator.RemoveAllOverrideNames()` + +**Description:** +This function is used to remove all override names that have been set for players in the commentator mode. This can be useful in eSports or other competitive settings where player names might need to be anonymized or replaced with aliases for the duration of a match or event. + +**Example Usage:** +In a custom addon designed for managing eSports events, you might use this function to clear all player name overrides at the end of a match to reset the display for the next game. + +```lua +-- Clear all override names at the end of a match +C_Commentator.RemoveAllOverrideNames() +``` + +**Addons:** +While specific large addons using this function are not well-documented, it is likely to be used in custom addons designed for eSports event management or live streaming tools where commentator mode is utilized. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md b/wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md new file mode 100644 index 00000000..78274d93 --- /dev/null +++ b/wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.RemovePlayerOverrideName + +**Content:** +Needs summary. +`C_Commentator.RemovePlayerOverrideName(originalPlayerName)` + +**Parameters:** +- `originalPlayerName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md b/wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md new file mode 100644 index 00000000..d7499165 --- /dev/null +++ b/wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.RequestPlayerCooldownInfo + +**Content:** +Needs summary. +`C_Commentator.RequestPlayerCooldownInfo(teamIndex, playerIndex)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetFoVTarget.md b/wiki-information/functions/C_Commentator.ResetFoVTarget.md new file mode 100644 index 00000000..8f0edab2 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ResetFoVTarget.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.ResetFoVTarget + +**Content:** +Needs summary. +`C_Commentator.ResetFoVTarget()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetSeriesScores.md b/wiki-information/functions/C_Commentator.ResetSeriesScores.md new file mode 100644 index 00000000..dd4d4172 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ResetSeriesScores.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.ResetSeriesScores + +**Content:** +Needs summary. +`C_Commentator.ResetSeriesScores(teamName1, teamName2)` + +**Parameters:** +- `teamName1` + - *string* +- `teamName2` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetSettings.md b/wiki-information/functions/C_Commentator.ResetSettings.md new file mode 100644 index 00000000..15413721 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ResetSettings.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.ResetSettings + +**Content:** +Needs summary. +`C_Commentator.ResetSettings()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetTrackedAuras.md b/wiki-information/functions/C_Commentator.ResetTrackedAuras.md new file mode 100644 index 00000000..0f4ecd86 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ResetTrackedAuras.md @@ -0,0 +1,6 @@ +## Title: C_Commentator.ResetTrackedAuras + +**Content:** +Needs summary. +`C_Commentator.ResetTrackedAuras()` + diff --git a/wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md b/wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md new file mode 100644 index 00000000..3b0cf8ec --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md @@ -0,0 +1,13 @@ +## Title: C_Commentator.SetAdditionalCameraWeight + +**Content:** +Needs summary. +`C_Commentator.SetAdditionalCameraWeight(teamIndex, playerIndex, weight)` + +**Parameters:** +- `teamIndex` + - *number* +- `playerIndex` + - *number* +- `weight` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md b/wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md new file mode 100644 index 00000000..b0cf76de --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md @@ -0,0 +1,20 @@ +## Title: C_Commentator.SetAdditionalCameraWeightByToken + +**Content:** +Needs summary. +`C_Commentator.SetAdditionalCameraWeightByToken(unitToken, weight)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `weight` + - *number* + +**Description:** +This function is used in the World of Warcraft API to set an additional camera weight for a specific unit identified by `unitToken`. The `weight` parameter determines the influence this unit has on the camera's behavior. + +**Example Usage:** +This function can be used in custom addons or scripts that manage camera behavior during events such as PvP tournaments or raids, where certain units (like bosses or key players) need to be focused on more frequently by the camera. + +**Addons:** +Large addons like "Blizzard Esports" might use this function to enhance the viewing experience during live broadcasts by dynamically adjusting the camera focus based on the importance of different units in the game. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetBlocklistedAuras.md b/wiki-information/functions/C_Commentator.SetBlocklistedAuras.md new file mode 100644 index 00000000..e639cf45 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetBlocklistedAuras.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetBlocklistedAuras + +**Content:** +Needs summary. +`C_Commentator.SetBlocklistedAuras(spellIDs)` + +**Parameters:** +- `spellIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md b/wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md new file mode 100644 index 00000000..9c1d4db7 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md @@ -0,0 +1,25 @@ +## Title: C_Commentator.SetBlocklistedCooldowns + +**Content:** +Needs summary. +`C_Commentator.SetBlocklistedCooldowns(specID, spellIDs)` + +**Parameters:** +- `specID` + - *number* +- `spellIDs` + - *number* + +**Description:** +This function is used to set a list of cooldowns that should be blocklisted for a specific specialization in the commentator mode. This can be useful for customizing the display of cooldowns during esports events or other broadcasts where certain cooldowns should not be shown. + +**Example Usage:** +```lua +-- Example: Blocklist specific cooldowns for a specialization +local specID = 71 -- Arms Warrior +local spellIDs = { 12345, 67890 } -- Example spell IDs to blocklist +C_Commentator.SetBlocklistedCooldowns(specID, spellIDs) +``` + +**Usage in Addons:** +This function is particularly useful in addons designed for esports broadcasting, such as the official Blizzard esports tools or third-party commentator addons. It allows broadcasters to control which cooldowns are visible to the audience, enhancing the viewing experience by hiding less relevant information. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCamera.md b/wiki-information/functions/C_Commentator.SetCamera.md new file mode 100644 index 00000000..95d75204 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetCamera.md @@ -0,0 +1,21 @@ +## Title: C_Commentator.SetCamera + +**Content:** +Needs summary. +`C_Commentator.SetCamera(xPos, yPos, zPos, yaw, pitch, roll, fov)` + +**Parameters:** +- `xPos` + - *number* +- `yPos` + - *number* +- `zPos` + - *number* +- `yaw` + - *number* +- `pitch` + - *number* +- `roll` + - *number* +- `fov` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCameraCollision.md b/wiki-information/functions/C_Commentator.SetCameraCollision.md new file mode 100644 index 00000000..77e452ae --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetCameraCollision.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetCameraCollision + +**Content:** +Needs summary. +`C_Commentator.SetCameraCollision(collide)` + +**Parameters:** +- `collide` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCameraPosition.md b/wiki-information/functions/C_Commentator.SetCameraPosition.md new file mode 100644 index 00000000..d4ede736 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetCameraPosition.md @@ -0,0 +1,15 @@ +## Title: C_Commentator.SetCameraPosition + +**Content:** +Needs summary. +`C_Commentator.SetCameraPosition(xPos, yPos, zPos, snapToLocation)` + +**Parameters:** +- `xPos` + - *number* +- `yPos` + - *number* +- `zPos` + - *number* +- `snapToLocation` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCheatsEnabled.md b/wiki-information/functions/C_Commentator.SetCheatsEnabled.md new file mode 100644 index 00000000..462e9451 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetCheatsEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetCheatsEnabled + +**Content:** +Needs summary. +`C_Commentator.SetCheatsEnabled(enableCheats)` + +**Parameters:** +- `enableCheats` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCommentatorHistory.md b/wiki-information/functions/C_Commentator.SetCommentatorHistory.md new file mode 100644 index 00000000..35f0c740 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetCommentatorHistory.md @@ -0,0 +1,52 @@ +## Title: C_Commentator.SetCommentatorHistory + +**Content:** +Needs summary. +`C_Commentator.SetCommentatorHistory(history)` + +**Parameters:** +- `history` + - *CommentatorHistory* + - `Field` + - `Type` + - `Description` + - `series` + - *CommentatorSeries* + - `teamDirectory` + - *CommentatorTeamDirectoryEntry* + - `overrideNameDirectory` + - *CommentatorOverrideNameEntry* + +**CommentatorSeries:** +- `Field` +- `Type` +- `Description` +- `teams` + - *CommentatorSeriesTeam* + +**CommentatorSeriesTeam:** +- `Field` +- `Type` +- `Description` +- `name` + - *string* +- `score` + - *number* + +**CommentatorTeamDirectoryEntry:** +- `Field` +- `Type` +- `Description` +- `playerName` + - *string* +- `teamName` + - *string* + +**CommentatorOverrideNameEntry:** +- `Field` +- `Type` +- `Description` +- `originalName` + - *string* +- `newName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md b/wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md new file mode 100644 index 00000000..0fea0385 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetDistanceBeforeForcedHorizontalConvergence + +**Content:** +Needs summary. +`C_Commentator.SetDistanceBeforeForcedHorizontalConvergence(distance)` + +**Parameters:** +- `distance` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md b/wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md new file mode 100644 index 00000000..ce9f1570 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetDurationToForceHorizontalConvergence + +**Content:** +Needs summary. +`C_Commentator.SetDurationToForceHorizontalConvergence(ms)` + +**Parameters:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetExcludeDistance.md b/wiki-information/functions/C_Commentator.SetExcludeDistance.md new file mode 100644 index 00000000..0acf8f03 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetExcludeDistance.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetExcludeDistance + +**Content:** +Needs summary. +`C_Commentator.SetExcludeDistance(excludeDistance)` + +**Parameters:** +- `excludeDistance` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md b/wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md new file mode 100644 index 00000000..cd949ad9 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.SetFollowCameraSpeeds + +**Content:** +Needs summary. +`C_Commentator.SetFollowCameraSpeeds(elasticSpeed, minSpeed)` + +**Parameters:** +- `elasticSpeed` + - *number* +- `minSpeed` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetHardlockWeight.md b/wiki-information/functions/C_Commentator.SetHardlockWeight.md new file mode 100644 index 00000000..e18dda1b --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetHardlockWeight.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetHardlockWeight + +**Content:** +Needs summary. +`C_Commentator.SetHardlockWeight(weight)` + +**Parameters:** +- `weight` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md b/wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md new file mode 100644 index 00000000..8c472be2 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetHorizontalAngleThresholdToSmooth + +**Content:** +Needs summary. +`C_Commentator.SetHorizontalAngleThresholdToSmooth(angle)` + +**Parameters:** +- `angle` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md b/wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md new file mode 100644 index 00000000..258bf593 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetLookAtLerpAmount + +**Content:** +Needs summary. +`C_Commentator.SetLookAtLerpAmount(amount)` + +**Parameters:** +- `amount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md b/wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md new file mode 100644 index 00000000..9242baf0 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.SetMapAndInstanceIndex + +**Content:** +Needs summary. +`C_Commentator.SetMapAndInstanceIndex(mapIndex, instanceIndex)` + +**Parameters:** +- `mapIndex` + - *number* +- `instanceIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMouseDisabled.md b/wiki-information/functions/C_Commentator.SetMouseDisabled.md new file mode 100644 index 00000000..64c4262e --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetMouseDisabled.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetMouseDisabled + +**Content:** +Needs summary. +`C_Commentator.SetMouseDisabled(disabled)` + +**Parameters:** +- `disabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMoveSpeed.md b/wiki-information/functions/C_Commentator.SetMoveSpeed.md new file mode 100644 index 00000000..8a95c207 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetMoveSpeed.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetMoveSpeed + +**Content:** +Needs summary. +`C_Commentator.SetMoveSpeed(newSpeed)` + +**Parameters:** +- `newSpeed` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md b/wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md new file mode 100644 index 00000000..88d8c2ec --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetMsToHoldForHorizontalMovement + +**Content:** +Needs summary. +`C_Commentator.SetMsToHoldForHorizontalMovement(ms)` + +**Parameters:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md b/wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md new file mode 100644 index 00000000..12264b23 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetMsToHoldForVerticalMovement + +**Content:** +Needs summary. +`C_Commentator.SetMsToHoldForVerticalMovement(ms)` + +**Parameters:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md b/wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md new file mode 100644 index 00000000..c2fe1632 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetMsToSmoothHorizontalChange + +**Content:** +Needs summary. +`C_Commentator.SetMsToSmoothHorizontalChange(ms)` + +**Parameters:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md b/wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md new file mode 100644 index 00000000..048651e6 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetMsToSmoothVerticalChange + +**Content:** +Needs summary. +`C_Commentator.SetMsToSmoothVerticalChange(ms)` + +**Parameters:** +- `ms` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetPositionLerpAmount.md b/wiki-information/functions/C_Commentator.SetPositionLerpAmount.md new file mode 100644 index 00000000..51e53c83 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetPositionLerpAmount.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetPositionLerpAmount + +**Content:** +Needs summary. +`C_Commentator.SetPositionLerpAmount(amount)` + +**Parameters:** +- `amount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md b/wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md new file mode 100644 index 00000000..8e634289 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md @@ -0,0 +1,12 @@ +## Title: C_Commentator.SetRequestedDebuffCooldowns + +**Content:** +Needs summary. +`C_Commentator.SetRequestedDebuffCooldowns(specID, spellIDs)` + +**Parameters:** +- `specID` + - *number* +- `spellIDs` + - *table* + diff --git a/wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md b/wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md new file mode 100644 index 00000000..4bd4a7de --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.SetRequestedDefensiveCooldowns + +**Content:** +Needs summary. +`C_Commentator.SetRequestedDefensiveCooldowns(specID, spellIDs)` + +**Parameters:** +- `specID` + - *number* +- `spellIDs` + - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md b/wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md new file mode 100644 index 00000000..19c6a057 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md @@ -0,0 +1,11 @@ +## Title: C_Commentator.SetRequestedOffensiveCooldowns + +**Content:** +Needs summary. +`C_Commentator.SetRequestedOffensiveCooldowns(specID, spellIDs)` + +**Parameters:** +- `specID` + - *number* +- `spellIDs` + - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSeriesScore.md b/wiki-information/functions/C_Commentator.SetSeriesScore.md new file mode 100644 index 00000000..00b8b9eb --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetSeriesScore.md @@ -0,0 +1,21 @@ +## Title: C_Commentator.SetSeriesScore + +**Content:** +Needs summary. +`C_Commentator.SetSeriesScore(teamName1, teamName2, scoringTeamName, score)` + +**Parameters:** +- `teamName1` + - *string* +- `teamName2` + - *string* +- `scoringTeamName` + - *string* +- `score` + - *number* + +**Example Usage:** +This function can be used in custom addons or scripts designed for managing or displaying scores in a series of matches, such as in esports tournaments or PvP events. + +**Addons:** +While specific large addons using this function are not well-documented, it is likely to be used in addons related to esports or competitive gaming where match series scores need to be tracked and displayed. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSeriesScores.md b/wiki-information/functions/C_Commentator.SetSeriesScores.md new file mode 100644 index 00000000..9ce7d6f6 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetSeriesScores.md @@ -0,0 +1,15 @@ +## Title: C_Commentator.SetSeriesScores + +**Content:** +Needs summary. +`C_Commentator.SetSeriesScores(teamName1, teamName2, score1, score2)` + +**Parameters:** +- `teamName1` + - *string* +- `teamName2` + - *string* +- `score1` + - *number* +- `score2` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSmartCameraLocked.md b/wiki-information/functions/C_Commentator.SetSmartCameraLocked.md new file mode 100644 index 00000000..9f69ee2b --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetSmartCameraLocked.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetSmartCameraLocked + +**Content:** +Needs summary. +`C_Commentator.SetSmartCameraLocked(locked)` + +**Parameters:** +- `locked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md b/wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md new file mode 100644 index 00000000..f3ee3056 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetSmoothFollowTransitioning + +**Content:** +Needs summary. +`C_Commentator.SetSmoothFollowTransitioning(enabled)` + +**Parameters:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSoftlockWeight.md b/wiki-information/functions/C_Commentator.SetSoftlockWeight.md new file mode 100644 index 00000000..16352eb7 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetSoftlockWeight.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetSoftlockWeight + +**Content:** +Needs summary. +`C_Commentator.SetSoftlockWeight(weight)` + +**Parameters:** +- `weight` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSpeedFactor.md b/wiki-information/functions/C_Commentator.SetSpeedFactor.md new file mode 100644 index 00000000..1f4d7d66 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetSpeedFactor.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetSpeedFactor + +**Content:** +Needs summary. +`C_Commentator.SetSpeedFactor(factor)` + +**Parameters:** +- `factor` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetTargetHeightOffset.md b/wiki-information/functions/C_Commentator.SetTargetHeightOffset.md new file mode 100644 index 00000000..153aa353 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetTargetHeightOffset.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetTargetHeightOffset + +**Content:** +Needs summary. +`C_Commentator.SetTargetHeightOffset(offset)` + +**Parameters:** +- `offset` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetUseSmartCamera.md b/wiki-information/functions/C_Commentator.SetUseSmartCamera.md new file mode 100644 index 00000000..20820bde --- /dev/null +++ b/wiki-information/functions/C_Commentator.SetUseSmartCamera.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.SetUseSmartCamera + +**Content:** +Needs summary. +`C_Commentator.SetUseSmartCamera(useSmartCamera)` + +**Parameters:** +- `useSmartCamera` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md b/wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md new file mode 100644 index 00000000..ce935349 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md @@ -0,0 +1,14 @@ +## Title: C_Commentator.SnapCameraLookAtPoint + +**Content:** +Needs summary. +`C_Commentator.SnapCameraLookAtPoint()` + +**Description:** +This function is part of the Commentator API, which is used primarily for managing camera views and other aspects of the spectator mode in World of Warcraft. The `SnapCameraLookAtPoint` function likely snaps the camera to look at a specific point, although the exact details are not provided in the summary. + +**Example Usage:** +This function can be used in custom spectator modes or addons that manage camera views during PvP tournaments or other events where a commentator's perspective is needed. + +**Addons:** +Large addons like the WoW Esports API might use this function to control camera angles and provide better viewing experiences during live streams of competitive events. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.StartWargame.md b/wiki-information/functions/C_Commentator.StartWargame.md new file mode 100644 index 00000000..8d396025 --- /dev/null +++ b/wiki-information/functions/C_Commentator.StartWargame.md @@ -0,0 +1,17 @@ +## Title: C_Commentator.StartWargame + +**Content:** +Needs summary. +`C_Commentator.StartWargame(listID, teamSize, tournamentRules, teamOneCaptain, teamTwoCaptain)` + +**Parameters:** +- `listID` + - *number* +- `teamSize` + - *number* +- `tournamentRules` + - *boolean* +- `teamOneCaptain` + - *string* +- `teamTwoCaptain` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SwapTeamSides.md b/wiki-information/functions/C_Commentator.SwapTeamSides.md new file mode 100644 index 00000000..16a99bd5 --- /dev/null +++ b/wiki-information/functions/C_Commentator.SwapTeamSides.md @@ -0,0 +1,21 @@ +## Title: C_Commentator.SwapTeamSides + +**Content:** +Needs summary. +`C_Commentator.SwapTeamSides()` + +**Description:** +This function is used in the World of Warcraft API to swap the sides of the teams in a commentator's view. This can be particularly useful in esports broadcasting or in-game events where the commentator needs to switch perspectives for better clarity or to follow the action more effectively. + +**Example Usage:** +In a custom addon designed for esports commentary, you might use this function to dynamically change the view of the teams during a live broadcast. + +```lua +-- Example usage in a custom addon +if event == "SWAP_SIDES" then + C_Commentator.SwapTeamSides() +end +``` + +**Addons Using This Function:** +- **WoW Esports Addon**: This addon might use `C_Commentator.SwapTeamSides` to enhance the viewing experience by allowing commentators to switch team perspectives seamlessly during live matches. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ToggleCheats.md b/wiki-information/functions/C_Commentator.ToggleCheats.md new file mode 100644 index 00000000..96a1c6ce --- /dev/null +++ b/wiki-information/functions/C_Commentator.ToggleCheats.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.ToggleCheats + +**Content:** +Needs summary. +`C_Commentator.ToggleCheats()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.UpdateMapInfo.md b/wiki-information/functions/C_Commentator.UpdateMapInfo.md new file mode 100644 index 00000000..1ba84d41 --- /dev/null +++ b/wiki-information/functions/C_Commentator.UpdateMapInfo.md @@ -0,0 +1,9 @@ +## Title: C_Commentator.UpdateMapInfo + +**Content:** +Needs summary. +`C_Commentator.UpdateMapInfo()` + +**Parameters:** +- `targetPlayer` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.UpdatePlayerInfo.md b/wiki-information/functions/C_Commentator.UpdatePlayerInfo.md new file mode 100644 index 00000000..af9f6899 --- /dev/null +++ b/wiki-information/functions/C_Commentator.UpdatePlayerInfo.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.UpdatePlayerInfo + +**Content:** +Needs summary. +`C_Commentator.UpdatePlayerInfo()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ZoomIn.md b/wiki-information/functions/C_Commentator.ZoomIn.md new file mode 100644 index 00000000..d15fd8a3 --- /dev/null +++ b/wiki-information/functions/C_Commentator.ZoomIn.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.ZoomIn + +**Content:** +Needs summary. +`C_Commentator.ZoomIn()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ZoomOut.md b/wiki-information/functions/C_Commentator.ZoomOut.md new file mode 100644 index 00000000..ef6c049c --- /dev/null +++ b/wiki-information/functions/C_Commentator.ZoomOut.md @@ -0,0 +1,5 @@ +## Title: C_Commentator.ZoomOut + +**Content:** +Needs summary. +`C_Commentator.ZoomOut()` \ No newline at end of file diff --git a/wiki-information/functions/C_Console.GetAllCommands.md b/wiki-information/functions/C_Console.GetAllCommands.md new file mode 100644 index 00000000..da5aedfc --- /dev/null +++ b/wiki-information/functions/C_Console.GetAllCommands.md @@ -0,0 +1,76 @@ +## Title: C_Console.GetAllCommands + +**Content:** +Returns all console variables and commands. +`commands = C_Console.GetAllCommands()` + +**Returns:** +- `commands` + - *ConsoleCommandInfo* + - `Field` + - `Type` + - `Description` + - `command` + - *string* + - `help` + - *string* + - `category` + - *Enum.ConsoleCategory* + - `commandType` + - *Enum.ConsoleCommandType* + - `scriptContents` + - *string* + - `scriptParameters` + - *string* + +- `Enum.ConsoleCategory` + - `Value` + - `Field` + - `Description` + - `0` + - Debug + - `1` + - Graphics + - `2` + - Console + - `3` + - Combat + - `4` + - Game + - `5` + - Default + - `6` + - Net + - `7` + - Sound + - `8` + - Gm + - `9` + - Reveal + - `10` + - None + +- `Enum.ConsoleCommandType` + - `Value` + - `Field` + - `Description` + - `0` + - Cvar + - `1` + - Command + - `2` + - Macro + - `3` + - Script + +**Description:** +Not all cvars are returned yet on initial login until VARIABLES_LOADED, e.g. AutoPushSpellToActionBar. + +**Usage:** +Prints all cvars and commands. +```lua +/run for k, v in pairs(C_Console.GetAllCommands()) do print(k, v.command) end +``` + +**Reference:** +[AdvancedInterfaceOptions Issue #38](https://github.com/Stanzilla/AdvancedInterfaceOptions/issues/38) \ No newline at end of file diff --git a/wiki-information/functions/C_Console.GetColorFromType.md b/wiki-information/functions/C_Console.GetColorFromType.md new file mode 100644 index 00000000..cb3ddd7d --- /dev/null +++ b/wiki-information/functions/C_Console.GetColorFromType.md @@ -0,0 +1,28 @@ +## Title: C_Console.GetColorFromType + +**Content:** +Returns color info for a color type. +`color = C_Console.GetColorFromType(colorType)` + +**Parameters:** +- `colorType` + - *Enum.ConsoleColorType* + - `Value` + - `Field` + - `Description` + - `0` - DefaultColor + - `1` - InputColor + - `2` - EchoColor + - `3` - ErrorColor + - `4` - WarningColor + - `5` - GlobalColor + - `6` - AdminColor + - `7` - HighlightColor + - `8` - BackgroundColor + - `9` - ClickbufferColor + - `10` - PrivateColor + - `11` - DefaultGreen + +**Returns:** +- `color` + - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Console.GetFontHeight.md b/wiki-information/functions/C_Console.GetFontHeight.md new file mode 100644 index 00000000..99493b2e --- /dev/null +++ b/wiki-information/functions/C_Console.GetFontHeight.md @@ -0,0 +1,9 @@ +## Title: C_Console.GetFontHeight + +**Content:** +Returns the console's currently used font height. +`fontHeightInPixels = C_Console.GetFontHeight()` + +**Returns:** +- `fontHeightInPixels` + - *number* - The height of the font in pixels used by the console. \ No newline at end of file diff --git a/wiki-information/functions/C_Console.PrintAllMatchingCommands.md b/wiki-information/functions/C_Console.PrintAllMatchingCommands.md new file mode 100644 index 00000000..bc939baf --- /dev/null +++ b/wiki-information/functions/C_Console.PrintAllMatchingCommands.md @@ -0,0 +1,15 @@ +## Title: C_Console.PrintAllMatchingCommands + +**Content:** +Prints all matching console commands. +`C_Console.PrintAllMatchingCommands(partialCommandText)` + +**Parameters:** +- `partialCommandText` + - *string* + +**Example Usage:** +This function can be used to find all console commands that match a given partial text. For instance, if you are unsure of the full command but know it starts with "reload", you can use this function to list all commands that start with "reload". + +**Addons:** +This function is often used in debugging tools and development addons to help developers quickly find and test console commands. \ No newline at end of file diff --git a/wiki-information/functions/C_Console.SetFontHeight.md b/wiki-information/functions/C_Console.SetFontHeight.md new file mode 100644 index 00000000..9e991a0e --- /dev/null +++ b/wiki-information/functions/C_Console.SetFontHeight.md @@ -0,0 +1,9 @@ +## Title: C_Console.SetFontHeight + +**Content:** +Sets the console's font height. +`C_Console.SetFontHeight(fontHeightInPixels)` + +**Parameters:** +- `fontHeightInPixels` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md b/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md new file mode 100644 index 00000000..f3f7ae83 --- /dev/null +++ b/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md @@ -0,0 +1,20 @@ +## Title: C_ConsoleScriptCollection.GetCollectionDataByID + +**Content:** +Needs summary. +`data = C_ConsoleScriptCollection.GetCollectionDataByID(collectionID)` + +**Parameters:** +- `collectionID` + - *number* + +**Returns:** +- `data` + - *ConsoleScriptCollectionData?* + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md b/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md new file mode 100644 index 00000000..839710b6 --- /dev/null +++ b/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md @@ -0,0 +1,20 @@ +## Title: C_ConsoleScriptCollection.GetCollectionDataByTag + +**Content:** +Needs summary. +`data = C_ConsoleScriptCollection.GetCollectionDataByTag(collectionTag)` + +**Parameters:** +- `collectionTag` + - *string* + +**Returns:** +- `data` + - *ConsoleScriptCollectionData?* + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetElements.md b/wiki-information/functions/C_ConsoleScriptCollection.GetElements.md new file mode 100644 index 00000000..4d9b51ee --- /dev/null +++ b/wiki-information/functions/C_ConsoleScriptCollection.GetElements.md @@ -0,0 +1,20 @@ +## Title: C_ConsoleScriptCollection.GetElements + +**Content:** +Needs summary. +`elementIDs = C_ConsoleScriptCollection.GetElements(collectionID)` + +**Parameters:** +- `collectionID` + - *number* + +**Returns:** +- `elementIDs` + - *ConsoleScriptCollectionElementData* + - `Field` + - `Type` + - `Description` + - `collectionID` + - *number?* + - `consoleScriptID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md b/wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md new file mode 100644 index 00000000..319d8827 --- /dev/null +++ b/wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md @@ -0,0 +1,28 @@ +## Title: C_ConsoleScriptCollection.GetScriptData + +**Content:** +Needs summary. +`data = C_ConsoleScriptCollection.GetScriptData(consoleScriptID)` + +**Parameters:** +- `consoleScriptID` + - *number* + +**Returns:** +- `data` + - *ConsoleScriptData* + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `name` + - *string* + - `help` + - *string* + - `script` + - *string* + - `params` + - *string* + - `isLuaScript` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.ContainerIDToInventoryID.md b/wiki-information/functions/C_Container.ContainerIDToInventoryID.md new file mode 100644 index 00000000..a196eebe --- /dev/null +++ b/wiki-information/functions/C_Container.ContainerIDToInventoryID.md @@ -0,0 +1,34 @@ +## Title: C_Container.ContainerIDToInventoryID + +**Content:** +Needs summary. +`inventoryID = C_Container.ContainerIDToInventoryID(containerID)` + +**Parameters:** +- `containerID` + - *number* : Enum.BagIndex + +**Values:** +| Description | containerID | inventoryID | +|---------------|-------------|-------------| +| Backpack | 0 | nil | +| Bag 1 | 1 | 31 | +| Bag 2 | 2 | 32 | +| Bag 3 | 3 | 33 | +| Bag 4 | 4 | 34 | +| Reagent bag | N/A | 35 | +| Bank bag 1 | 5 | 76 | +| Bank bag 2 | 6 | 77 | +| Bank bag 3 | 7 | 78 | +| Bank bag 4 | 8 | 79 | +| Bank bag 5 | 9 | 80 | +| Bank bag 6 | 10 | 81 | +| Bank bag 7 | N/A | 82 | +| Bank | -1 | nil | +| Keyring | -2 | nil | +| Reagent bank | -3 | nil | +| Bank bags | -4 | nil | + +**Returns:** +- `inventoryID` + - *number* : inventorySlotID \ No newline at end of file diff --git a/wiki-information/functions/C_Container.ContainerRefundItemPurchase.md b/wiki-information/functions/C_Container.ContainerRefundItemPurchase.md new file mode 100644 index 00000000..8937da5b --- /dev/null +++ b/wiki-information/functions/C_Container.ContainerRefundItemPurchase.md @@ -0,0 +1,13 @@ +## Title: C_Container.ContainerRefundItemPurchase + +**Content:** +Needs summary. +`C_Container.ContainerRefundItemPurchase(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* +- `isEquipped` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetBagName.md b/wiki-information/functions/C_Container.GetBagName.md new file mode 100644 index 00000000..48ddbd2b --- /dev/null +++ b/wiki-information/functions/C_Container.GetBagName.md @@ -0,0 +1,13 @@ +## Title: C_Container.GetBagName + +**Content:** +Needs summary. +`name = C_Container.GetBagName(bagIndex)` + +**Parameters:** +- `bagIndex` + - *number* + +**Returns:** +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetBagSlotFlag.md b/wiki-information/functions/C_Container.GetBagSlotFlag.md new file mode 100644 index 00000000..e3e7a76f --- /dev/null +++ b/wiki-information/functions/C_Container.GetBagSlotFlag.md @@ -0,0 +1,26 @@ +## Title: C_Container.GetBagSlotFlag + +**Content:** +Needs summary. +`isSet = C_Container.GetBagSlotFlag(bagIndex, flag)` + +**Parameters:** +- `bagIndex` + - *number* +- `flag` + - *Enum.BagSlotFlags* + - `Value` + - `Field` + - `Description` + - `1` - DisableAutoSort + - `2` - PriorityEquipment + - `4` - PriorityConsumables + - `8` - PriorityTradeGoods + - `16` - PriorityJunk + - `32` - PriorityQuestItems + - `63` - BagSlotValidFlagsAll + - `62` - BagSlotPriorityFlagsAll + +**Returns:** +- `isSet` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerFreeSlots.md b/wiki-information/functions/C_Container.GetContainerFreeSlots.md new file mode 100644 index 00000000..76087c9e --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerFreeSlots.md @@ -0,0 +1,19 @@ +## Title: C_Container.GetContainerFreeSlots + +**Content:** +Needs summary. +`freeSlots = C_Container.GetContainerFreeSlots(containerIndex)` + +**Parameters:** +- `containerIndex` + - *number* + +**Returns:** +- `freeSlots` + - *number* + +**Example Usage:** +This function can be used to determine how many free slots are available in a specific container (bag). For instance, an addon that manages inventory space could use this function to alert the player when their bags are nearly full. + +**Addon Usage:** +Large addons like Bagnon, which is an inventory management addon, might use this function to display the number of free slots in each bag. This helps players manage their inventory more efficiently by providing a clear overview of available space. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemCooldown.md b/wiki-information/functions/C_Container.GetContainerItemCooldown.md new file mode 100644 index 00000000..df88edce --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemCooldown.md @@ -0,0 +1,25 @@ +## Title: C_Container.GetContainerItemCooldown + +**Content:** +Needs summary. +`startTime, duration, enable = C_Container.GetContainerItemCooldown(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `startTime` + - *number* +- `duration` + - *number* +- `enable` + - *number* + +**Example Usage:** +This function can be used to check the cooldown status of an item in a specific container slot. For instance, if you want to know when a health potion will be available for use again, you can call this function with the appropriate container and slot indices. + +**Addon Usage:** +Large addons like **Bagnon** and **ArkInventory** use this function to display cooldown information directly on the item icons within the inventory UI, providing players with a visual indication of when items will be ready for use again. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemDurability.md b/wiki-information/functions/C_Container.GetContainerItemDurability.md new file mode 100644 index 00000000..0e7d897d --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemDurability.md @@ -0,0 +1,17 @@ +## Title: C_Container.GetContainerItemDurability + +**Content:** +Needs summary. +`durability, maxDurability = C_Container.GetContainerItemDurability(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `durability` + - *number* +- `maxDurability` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemID.md b/wiki-information/functions/C_Container.GetContainerItemID.md new file mode 100644 index 00000000..fc69ed61 --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemID.md @@ -0,0 +1,25 @@ +## Title: C_Container.GetContainerItemID + +**Content:** +Needs summary. +`itemID = C_Container.GetContainerItemID(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `itemID` + - *number?* + +**Example Usage:** +This function can be used to retrieve the item ID of an item in a specific slot of a container (bag). For example, if you want to check what item is in the first slot of your backpack, you could use: +```lua +local itemID = C_Container.GetContainerItemID(0, 1) +print("Item ID in first slot of backpack:", itemID) +``` + +**Addons Usage:** +Many inventory management addons, such as Bagnon or ArkInventory, use this function to identify items in the player's bags to provide enhanced bag management features. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemInfo.md b/wiki-information/functions/C_Container.GetContainerItemInfo.md new file mode 100644 index 00000000..face95be --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemInfo.md @@ -0,0 +1,46 @@ +## Title: C_Container.GetContainerItemInfo + +**Content:** +Needs summary. +`containerInfo = C_Container.GetContainerItemInfo(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `containerInfo` + - *ContainerItemInfo?* - Returns nil if the container slot is empty. + - `Field` + - `Type` + - `Description` + - `iconFileID` + - *number* + - `stackCount` + - *number* + - `isLocked` + - *boolean* + - `quality` + - *Enum.ItemQuality?* + - `isReadable` + - *boolean* + - `hasLoot` + - *boolean* + - `hyperlink` + - *string* + - `isFiltered` + - *boolean* + - `hasNoValue` + - *boolean* + - `itemID` + - *number* + - `isBound` + - *boolean* + +**Example Usage:** +This function can be used to retrieve detailed information about a specific item in a player's bag. For instance, an addon could use this to display additional information about items when the player hovers over them in their inventory. + +**Addon Usage:** +Large addons like Bagnon use this function to manage and display inventory items. Bagnon, for example, uses it to fetch item details to show item icons, stack counts, and other relevant information in a unified inventory interface. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemLink.md b/wiki-information/functions/C_Container.GetContainerItemLink.md new file mode 100644 index 00000000..fdc4d45f --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemLink.md @@ -0,0 +1,25 @@ +## Title: C_Container.GetContainerItemLink + +**Content:** +Needs summary. +`itemLink = C_Container.GetContainerItemLink(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `itemLink` + - *string* + +**Example Usage:** +This function can be used to retrieve the item link of an item in a specific bag and slot. For example, if you want to get the item link of the item in the first slot of your backpack, you would call: +```lua +local itemLink = C_Container.GetContainerItemLink(0, 1) +print(itemLink) +``` + +**Addons Usage:** +Many inventory management addons, such as Bagnon or ArkInventory, use this function to display item information in custom bag interfaces. They call this function to get the item link and then use the link to fetch more detailed information about the item, such as its name, quality, and tooltip. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md b/wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md new file mode 100644 index 00000000..56f2718b --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md @@ -0,0 +1,28 @@ +## Title: C_Container.GetContainerItemPurchaseCurrency + +**Content:** +Needs summary. +`currencyInfo = C_Container.GetContainerItemPurchaseCurrency(containerIndex, slotIndex, itemIndex, isEquipped)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* +- `itemIndex` + - *number* +- `isEquipped` + - *boolean* + +**Returns:** +- `currencyInfo` + - *ItemPurchaseCurrency* + - `Field` + - `Type` + - `Description` + - `iconFileID` + - *number?* + - `currencyCount` + - *number* + - `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md b/wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md new file mode 100644 index 00000000..61931770 --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md @@ -0,0 +1,30 @@ +## Title: C_Container.GetContainerItemPurchaseInfo + +**Content:** +Needs summary. +`info = C_Container.GetContainerItemPurchaseInfo(containerIndex, slotIndex, isEquipped)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* +- `isEquipped` + - *boolean* + +**Returns:** +- `info` + - *ItemPurchaseInfo* + - `Field` + - `Type` + - `Description` + - `money` + - *number* + - `itemCount` + - *number* + - `refundSeconds` + - *number* + - `currencyCount` + - *number* + - `hasEnchants` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md b/wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md new file mode 100644 index 00000000..47e65f64 --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md @@ -0,0 +1,28 @@ +## Title: C_Container.GetContainerItemPurchaseItem + +**Content:** +Needs summary. +`itemInfo = C_Container.GetContainerItemPurchaseItem(containerIndex, slotIndex, itemIndex, isEquipped)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* +- `itemIndex` + - *number* +- `isEquipped` + - *boolean* + +**Returns:** +- `itemInfo` + - *ItemPurchaseItem* + - `Field` + - `Type` + - `Description` + - `iconFileID` + - *number?* + - `itemCount` + - *number* + - `hyperlink` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemQuestInfo.md b/wiki-information/functions/C_Container.GetContainerItemQuestInfo.md new file mode 100644 index 00000000..a66e8774 --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerItemQuestInfo.md @@ -0,0 +1,24 @@ +## Title: C_Container.GetContainerItemQuestInfo + +**Content:** +Needs summary. +`questInfo = C_Container.GetContainerItemQuestInfo(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number (BagID)* - Index of the bag to query. +- `slotIndex` + - *number* - Index of the slot within the bag (ascending from 1) to query. + +**Returns:** +- `questInfo` + - *ItemQuestInfo* + - `Field` + - `Type` + - `Description` + - `isQuestItem` + - *boolean* - true if the item is a quest item, nil otherwise. Items starting quests are apparently not considered to be quest items. + - `questID` + - *number?* - Quest ID of the quest this item starts, no value if it does not start a quest or if the call refers to a bank bag/slot when the bank is not being visited. + - `isActive` + - *boolean* - true if the quest this item starts has been accepted by the player, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerNumFreeSlots.md b/wiki-information/functions/C_Container.GetContainerNumFreeSlots.md new file mode 100644 index 00000000..cbd2bb16 --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerNumFreeSlots.md @@ -0,0 +1,18 @@ +## Title: C_Container.GetContainerNumFreeSlots + +**Content:** +Returns the number of free slots & the bagType that an equipped bag or backpack belongs to. +`numFreeSlots, bagType = C_Container.GetContainerNumFreeSlots(bagIndex)` + +**Parameters:** +- `bagIndex` + - *number* + +**Returns:** +- `numFreeSlots` + - *number* +- `bagType` + - *number* : ItemFamily + +**Reference:** +- `GetItemFamily` - Returns bagType of item. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerNumSlots.md b/wiki-information/functions/C_Container.GetContainerNumSlots.md new file mode 100644 index 00000000..01537d19 --- /dev/null +++ b/wiki-information/functions/C_Container.GetContainerNumSlots.md @@ -0,0 +1,26 @@ +## Title: C_Container.GetContainerNumSlots + +**Content:** +Needs summary. +`numSlots = C_Container.GetContainerNumSlots(containerIndex)` + +**Parameters:** +- `containerIndex` + - *number* + +**Returns:** +- `numSlots` + - *number* + +**Example Usage:** +This function can be used to determine the number of slots in a specific container (bag) by providing the container index. For instance, you can use it to check how many slots are available in your backpack or any other bag. + +**Example Code:** +```lua +local containerIndex = 0 -- Index for the backpack +local numSlots = C_Container.GetContainerNumSlots(containerIndex) +print("Number of slots in the backpack:", numSlots) +``` + +**Addons Using This Function:** +Many inventory management addons, such as Bagnon and AdiBags, use this function to dynamically display the number of slots available in each container. This helps in providing a more organized and user-friendly interface for managing items. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md b/wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md new file mode 100644 index 00000000..c635e5d7 --- /dev/null +++ b/wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md @@ -0,0 +1,9 @@ +## Title: C_Container.GetInsertItemsLeftToRight + +**Content:** +Needs summary. +`isEnabled = C_Container.GetInsertItemsLeftToRight()` + +**Returns:** +- `isEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetItemCooldown.md b/wiki-information/functions/C_Container.GetItemCooldown.md new file mode 100644 index 00000000..674929fe --- /dev/null +++ b/wiki-information/functions/C_Container.GetItemCooldown.md @@ -0,0 +1,17 @@ +## Title: C_Container.GetItemCooldown + +**Content:** +Needs summary. +`startTime, duration, enable = C_Container.GetItemCooldown(itemID)` + +**Parameters:** +- `itemID` + - *number* - Will not accept an itemlink or name. + +**Returns:** +- `startTime` + - *number* +- `duration` + - *number* +- `enable` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.IsContainerFiltered.md b/wiki-information/functions/C_Container.IsContainerFiltered.md new file mode 100644 index 00000000..64224513 --- /dev/null +++ b/wiki-information/functions/C_Container.IsContainerFiltered.md @@ -0,0 +1,19 @@ +## Title: C_Container.IsContainerFiltered + +**Content:** +Needs summary. +`isFiltered = C_Container.IsContainerFiltered(containerIndex)` + +**Parameters:** +- `containerIndex` + - *number* + +**Returns:** +- `isFiltered` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific container (bag) is currently filtered. For instance, if you want to determine whether a bag is set to only show certain types of items (e.g., equipment, consumables), you can use this function. + +**Addon Usage:** +Large addons like Bagnon or AdiBags might use this function to manage and display the contents of bags more effectively, ensuring that only the relevant items are shown based on user-defined filters. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.PickupContainerItem.md b/wiki-information/functions/C_Container.PickupContainerItem.md new file mode 100644 index 00000000..5cfce0b4 --- /dev/null +++ b/wiki-information/functions/C_Container.PickupContainerItem.md @@ -0,0 +1,11 @@ +## Title: C_Container.PickupContainerItem + +**Content:** +Needs summary. +`C_Container.PickupContainerItem(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetBagPortraitTexture.md b/wiki-information/functions/C_Container.SetBagPortraitTexture.md new file mode 100644 index 00000000..cf6d3d35 --- /dev/null +++ b/wiki-information/functions/C_Container.SetBagPortraitTexture.md @@ -0,0 +1,11 @@ +## Title: C_Container.SetBagPortraitTexture + +**Content:** +Needs summary. +`C_Container.SetBagPortraitTexture(texture, bagIndex)` + +**Parameters:** +- `texture` + - *Texture* - The texture to be set for the bag portrait. +- `bagIndex` + - *number* - The index of the bag. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetBagSlotFlag.md b/wiki-information/functions/C_Container.SetBagSlotFlag.md new file mode 100644 index 00000000..a5d0b204 --- /dev/null +++ b/wiki-information/functions/C_Container.SetBagSlotFlag.md @@ -0,0 +1,32 @@ +## Title: C_Container.SetBagSlotFlag + +**Content:** +Needs summary. +`C_Container.SetBagSlotFlag(bagIndex, flag, isSet)` + +**Parameters:** +- `bagIndex` + - *number* +- `flag` + - *Enum.BagSlotFlags* + - `Value` + - `Field` + - `Description` + - `1` + - `DisableAutoSort` + - `2` + - `PriorityEquipment` + - `4` + - `PriorityConsumables` + - `8` + - `PriorityTradeGoods` + - `16` + - `PriorityJunk` + - `32` + - `PriorityQuestItems` + - `63` + - `BagSlotValidFlagsAll` + - `62` + - `BagSlotPriorityFlagsAll` +- `isSet` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md b/wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md new file mode 100644 index 00000000..cafca196 --- /dev/null +++ b/wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md @@ -0,0 +1,9 @@ +## Title: C_Container.SetInsertItemsLeftToRight + +**Content:** +Needs summary. +`C_Container.SetInsertItemsLeftToRight(enable)` + +**Parameters:** +- `enable` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetItemSearch.md b/wiki-information/functions/C_Container.SetItemSearch.md new file mode 100644 index 00000000..9f320967 --- /dev/null +++ b/wiki-information/functions/C_Container.SetItemSearch.md @@ -0,0 +1,9 @@ +## Title: C_Container.SetItemSearch + +**Content:** +Needs summary. +`C_Container.SetItemSearch(searchString)` + +**Parameters:** +- `searchString` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.ShowContainerSellCursor.md b/wiki-information/functions/C_Container.ShowContainerSellCursor.md new file mode 100644 index 00000000..1efb4688 --- /dev/null +++ b/wiki-information/functions/C_Container.ShowContainerSellCursor.md @@ -0,0 +1,11 @@ +## Title: C_Container.ShowContainerSellCursor + +**Content:** +Needs summary. +`C_Container.ShowContainerSellCursor(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SocketContainerItem.md b/wiki-information/functions/C_Container.SocketContainerItem.md new file mode 100644 index 00000000..886b1003 --- /dev/null +++ b/wiki-information/functions/C_Container.SocketContainerItem.md @@ -0,0 +1,21 @@ +## Title: C_Container.SocketContainerItem + +**Content:** +Needs summary. +`success = C_Container.SocketContainerItem(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Example Usage:** +This function can be used to socket a gem into an item located in a specific container and slot. For instance, if you have a gem and an item in your bag and you want to socket the gem into the item, you would use this function to perform that action programmatically. + +**Addons:** +Large addons like TradeSkillMaster (TSM) might use this function to automate the process of socketing gems into items to optimize gear for selling or personal use. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SplitContainerItem.md b/wiki-information/functions/C_Container.SplitContainerItem.md new file mode 100644 index 00000000..40cbd511 --- /dev/null +++ b/wiki-information/functions/C_Container.SplitContainerItem.md @@ -0,0 +1,13 @@ +## Title: C_Container.SplitContainerItem + +**Content:** +Needs summary. +`C_Container.SplitContainerItem(containerIndex, slotIndex, amount)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* +- `amount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.UseContainerItem.md b/wiki-information/functions/C_Container.UseContainerItem.md new file mode 100644 index 00000000..c84003dd --- /dev/null +++ b/wiki-information/functions/C_Container.UseContainerItem.md @@ -0,0 +1,15 @@ +## Title: C_Container.UseContainerItem + +**Content:** +Needs summary. +`C_Container.UseContainerItem(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* +- `unitToken` + - *string?* +- `reagentBankOpen` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_CreatureInfo.GetClassInfo.md b/wiki-information/functions/C_CreatureInfo.GetClassInfo.md new file mode 100644 index 00000000..1eddbcee --- /dev/null +++ b/wiki-information/functions/C_CreatureInfo.GetClassInfo.md @@ -0,0 +1,70 @@ +## Title: C_CreatureInfo.GetClassInfo + +**Content:** +Returns info for a class by ID. +`classInfo = C_CreatureInfo.GetClassInfo(classID)` + +**Parameters:** +- `classID` + - *number* : ClassId - Ranging from 1 to GetNumClasses() + - Values: + - `ID` + - `className` (enUS) + - `classFile` + - Description + - `1` + - `Warrior` + - `WARRIOR` + - `2` + - `Paladin` + - `PALADIN` + - `3` + - `Hunter` + - `HUNTER` + - `4` + - `Rogue` + - `ROGUE` + - `5` + - `Priest` + - `PRIEST` + - `6` + - `Death Knight` + - `DEATHKNIGHT` + - Added in 3.0.2 + - `7` + - `Shaman` + - `SHAMAN` + - `8` + - `Mage` + - `MAGE` + - `9` + - `Warlock` + - `WARLOCK` + - `10` + - `Monk` + - `MONK` + - Added in 5.0.4 + - `11` + - `Druid` + - `DRUID` + - `12` + - `Demon Hunter` + - `DEMONHUNTER` + - Added in 7.0.3 + - `13` + - `Evoker` + - `EVOKER` + - Added in 10.0.0 + +**Returns:** +- `classInfo` + - *ClassInfo?* + - `Field` + - `Type` + - `Description` + - `className` + - *string* - Localized name, e.g. "Warrior" or "Guerrier". + - `classFile` + - *string* - Locale-independent name, e.g. "WARRIOR". + - `classID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CreatureInfo.GetFactionInfo.md b/wiki-information/functions/C_CreatureInfo.GetFactionInfo.md new file mode 100644 index 00000000..2110ea7c --- /dev/null +++ b/wiki-information/functions/C_CreatureInfo.GetFactionInfo.md @@ -0,0 +1,20 @@ +## Title: C_CreatureInfo.GetFactionInfo + +**Content:** +Returns the faction name for a race. +`factionInfo = C_CreatureInfo.GetFactionInfo(raceID)` + +**Parameters:** +- `raceID` + - *number* + +**Returns:** +- `factionInfo` + - *structure* - FactionInfo (nilable) + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `groupTag` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_CreatureInfo.GetRaceInfo.md b/wiki-information/functions/C_CreatureInfo.GetRaceInfo.md new file mode 100644 index 00000000..76f7713f --- /dev/null +++ b/wiki-information/functions/C_CreatureInfo.GetRaceInfo.md @@ -0,0 +1,28 @@ +## Title: C_CreatureInfo.GetRaceInfo + +**Content:** +Returns both localized and locale-independent race names. +`raceInfo = C_CreatureInfo.GetRaceInfo(raceID)` + +**Parameters:** +- `raceID` + - *number* + +**Returns:** +- `raceInfo` + - *structure* - RaceInfo (nilable) + - `Field` + - `Type` + - `Description` + - `raceName` + - *string* - localized name, e.g. "Night Elf" + - `clientFileString` + - *string* - non-localized name, e.g. "NightElf" + - `raceID` + - *number* + +**Example Usage:** +This function can be used to retrieve race information for displaying in a user interface or for logging purposes. For instance, an addon that customizes character creation screens might use this function to fetch and display race names. + +**Addon Usage:** +Large addons like "Altoholic" might use this function to display race information for characters across different realms and accounts. \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md b/wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md new file mode 100644 index 00000000..b9e711b3 --- /dev/null +++ b/wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md @@ -0,0 +1,31 @@ +## Title: C_CurrencyInfo.GetBasicCurrencyInfo + +**Content:** +Needs summary. +`info = C_CurrencyInfo.GetBasicCurrencyInfo(currencyType)` + +**Parameters:** +- `currencyType` + - *number* +- `quantity` + - *number?* + +**Returns:** +- `info` + - *structure* - CurrencyDisplayInfo + - `CurrencyDisplayInfo` + - `Field` + - `Type` + - `Description` + - `name` + - *string* - CurrencyContainer.ContainerName_lang + - `description` + - *string* + - `icon` + - *number* + - `quality` + - *number* + - `displayAmount` + - *number* + - `actualAmount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md new file mode 100644 index 00000000..29e1b705 --- /dev/null +++ b/wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md @@ -0,0 +1,30 @@ +## Title: C_CurrencyInfo.GetCurrencyContainerInfo + +**Content:** +Needs summary. +`info = C_CurrencyInfo.GetCurrencyContainerInfo(currencyType, quantity)` + +**Parameters:** +- `currencyType` + - *number* - CurrencyID +- `quantity` + - *number* + +**Returns:** +- `info` + - *CurrencyDisplayInfo* + - `Field` + - `Type` + - `Description` + - `name` + - *string* - CurrencyContainer.ContainerName_lang + - `description` + - *string* + - `icon` + - *number* + - `quality` + - *number* + - `displayAmount` + - *number* + - `actualAmount` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md new file mode 100644 index 00000000..1ea4ae77 --- /dev/null +++ b/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md @@ -0,0 +1,67 @@ +## Title: C_CurrencyInfo.GetCurrencyInfo + +**Content:** +Returns info for a currency by ID. +```lua +info = C_CurrencyInfo.GetCurrencyInfo(type) +info = C_CurrencyInfo.GetCurrencyInfoFromLink(link) +``` + +**Parameters:** + +*GetCurrencyInfo:* +- `type` + - *number* : CurrencyID + +*GetCurrencyInfoFromLink:* +- `link` + - *string* : currencyLink + +**Returns:** +- `info` + - *CurrencyInfo* + - `Field` + - `Type` + - `Description` + - `name` + - *string* - Localized name of the currency + - `description` + - *string* - Added in 10.0.0 + - `isHeader` + - *boolean* - Used by currency window (some currency IDs are the headers) + - `isHeaderExpanded` + - *boolean* - Whether header is expanded or collapsed in currency window + - `isTypeUnused` + - *boolean* - Sorts currency at the bottom of currency window in "Unused" header + - `isShowInBackpack` + - *boolean* - Shows currency on Blizzard backpack frame + - `quantity` + - *number* - Current amount of the currency + - `trackedQuantity` + - *number* - Added in 9.1.5 + - `iconFileID` + - *number* - FileID + - `maxQuantity` + - *number* - Total maximum currency possible + - `canEarnPerWeek` + - *boolean* - Whether the currency is limited per week + - `quantityEarnedThisWeek` + - *number* - 0 if canEarnPerWeek is false + - `isTradeable` + - *boolean* + - `quality` + - *Enum.ItemQuality* + - `maxWeeklyQuantity` + - *number* - 0 if canEarnPerWeek is false + - `totalEarned` + - *number* - Added in 9.0.2; Returns 0 if useTotalEarnedForMaxQty is false, prevents earning if equal to maxQuantity + - `discovered` + - *boolean* - Whether the character has ever earned the currency + - `useTotalEarnedForMaxQty` + - *boolean* - Added in 9.0.2; Whether the currency has a moving maximum (e.g. seasonal) + +**Example Usage:** +This function can be used to retrieve detailed information about a specific currency in the game, such as the player's current amount, whether it is displayed in the backpack, and other metadata. For instance, it can be used in an addon to display a custom currency tracker. + +**Addon Usage:** +Large addons like "Titan Panel" use this API to display currency information on the player's UI, allowing players to keep track of their currencies without opening the currency window. \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md new file mode 100644 index 00000000..52c45f98 --- /dev/null +++ b/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md @@ -0,0 +1,61 @@ +## Title: C_CurrencyInfo.GetCurrencyInfo + +**Content:** +Returns info for a currency by ID. +```lua +info = C_CurrencyInfo.GetCurrencyInfo(type) +info = C_CurrencyInfo.GetCurrencyInfoFromLink(link) +``` + +**Parameters:** + +*GetCurrencyInfo:* +- `type` + - *number* : CurrencyID + +*GetCurrencyInfoFromLink:* +- `link` + - *string* : currencyLink + +**Returns:** +- `info` + - *CurrencyInfo* + - `Field` + - `Type` + - `Description` + - `name` + - *string* - Localized name of the currency + - `description` + - *string* - Added in 10.0.0 + - `isHeader` + - *boolean* - Used by currency window (some currency IDs are the headers) + - `isHeaderExpanded` + - *boolean* - Whether header is expanded or collapsed in currency window + - `isTypeUnused` + - *boolean* - Sorts currency at the bottom of currency window in "Unused" header + - `isShowInBackpack` + - *boolean* - Shows currency on Blizzard backpack frame + - `quantity` + - *number* - Current amount of the currency + - `trackedQuantity` + - *number* - Added in 9.1.5 + - `iconFileID` + - *number* - FileID + - `maxQuantity` + - *number* - Total maximum currency possible + - `canEarnPerWeek` + - *boolean* - Whether the currency is limited per week + - `quantityEarnedThisWeek` + - *number* - 0 if canEarnPerWeek is false + - `isTradeable` + - *boolean* + - `quality` + - *Enum.ItemQuality* + - `maxWeeklyQuantity` + - *number* - 0 if canEarnPerWeek is false + - `totalEarned` + - *number* - Added in 9.0.2; Returns 0 if useTotalEarnedForMaxQty is false, prevents earning if equal to maxQuantity + - `discovered` + - *boolean* - Whether the character has ever earned the currency + - `useTotalEarnedForMaxQty` + - *boolean* - Added in 9.0.2; Whether the currency has a moving maximum (e.g. seasonal) \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md new file mode 100644 index 00000000..fb0411e9 --- /dev/null +++ b/wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md @@ -0,0 +1,13 @@ +## Title: C_CurrencyInfo.GetCurrencyListLink + +**Content:** +Get the currencyLink for the specified currency list index. +`link = C_CurrencyInfo.GetCurrencyListLink(index)` + +**Parameters:** +- `index` + - *number* + +**Returns:** +- `link` + - *string* : currencyLink \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md b/wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md new file mode 100644 index 00000000..dd6dc3ca --- /dev/null +++ b/wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md @@ -0,0 +1,15 @@ +## Title: C_CurrencyInfo.IsCurrencyContainer + +**Content:** +Needs summary. +`isCurrencyContainer = C_CurrencyInfo.IsCurrencyContainer(currencyID, quantity)` + +**Parameters:** +- `currencyID` + - *number* +- `quantity` + - *number* + +**Returns:** +- `isCurrencyContainer` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md b/wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md new file mode 100644 index 00000000..be063943 --- /dev/null +++ b/wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md @@ -0,0 +1,5 @@ +## Title: C_Cursor.DropCursorCommunitiesStream + +**Content:** +Needs summary. +`C_Cursor.DropCursorCommunitiesStream()` \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md b/wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md new file mode 100644 index 00000000..3064ac92 --- /dev/null +++ b/wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md @@ -0,0 +1,11 @@ +## Title: C_Cursor.GetCursorCommunitiesStream + +**Content:** +Needs summary. +`clubId, streamId = C_Cursor.GetCursorCommunitiesStream()` + +**Returns:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.GetCursorItem.md b/wiki-information/functions/C_Cursor.GetCursorItem.md new file mode 100644 index 00000000..7b7ffccf --- /dev/null +++ b/wiki-information/functions/C_Cursor.GetCursorItem.md @@ -0,0 +1,12 @@ +## Title: C_Cursor.GetCursorItem + +**Content:** +Returns the item currently dragged by the player. +`item = C_Cursor.GetCursorItem()` + +**Returns:** +- `item` + - *ItemLocationMixin* - The item currently dragged by the player, or nil if not dragging an item. + +**Reference:** +Patch 8.0.1 (2018-07-16): Added. \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md b/wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md new file mode 100644 index 00000000..e3c8c4c6 --- /dev/null +++ b/wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md @@ -0,0 +1,11 @@ +## Title: C_Cursor.SetCursorCommunitiesStream + +**Content:** +Needs summary. +`C_Cursor.SetCursorCommunitiesStream(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md b/wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md new file mode 100644 index 00000000..33790634 --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md @@ -0,0 +1,37 @@ +## Title: C_DateAndTime.AdjustTimeByDays + +**Content:** +Returns the date after a specified amount of days. +`newDate = C_DateAndTime.AdjustTimeByDays(date, days)` +`newDate = C_DateAndTime.AdjustTimeByMinutes(date, minutes)` + +**Parameters:** +- `AdjustTimeByDays:` + - `date` + - *CalendarTime* + - `days` + - *number* +- `AdjustTimeByMinutes:` + - `date` + - *CalendarTime* + - `minutes` + - *number* + +**Returns:** +- `newDate` + - *CalendarTime* + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md b/wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md new file mode 100644 index 00000000..3185a002 --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md @@ -0,0 +1,37 @@ +## Title: C_DateAndTime.AdjustTimeByDays + +**Content:** +Returns the date after a specified amount of days. +`newDate = C_DateAndTime.AdjustTimeByDays(date, days)` +`newDate = C_DateAndTime.AdjustTimeByMinutes(date, minutes)` + +**Parameters:** +- **AdjustTimeByDays:** + - `date` + - *CalendarTime* + - `days` + - *number* +- **AdjustTimeByMinutes:** + - `date` + - *CalendarTime* + - `minutes` + - *number* + +**Returns:** +- `newDate` + - *CalendarTime* + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.CompareCalendarTime.md b/wiki-information/functions/C_DateAndTime.CompareCalendarTime.md new file mode 100644 index 00000000..99bbb704 --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.CompareCalendarTime.md @@ -0,0 +1,32 @@ +## Title: C_DateAndTime.CompareCalendarTime + +**Content:** +Compares two dates with each other. +`comparison = C_DateAndTime.CompareCalendarTime(lhsCalendarTime, rhsCalendarTime)` + +**Parameters:** +- `lhsCalendarTime` + - *CalendarTime* - left-hand side time +- `rhsCalendarTime` + - *CalendarTime* - right-hand side time + +**CalendarTime Fields:** +- `year` + - *number* - The current year (e.g. 2019) +- `month` + - *number* - The current month +- `monthDay` + - *number* - The current day of the month +- `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) +- `hour` + - *number* - The current time in hours +- `minute` + - *number* - The current time in minutes + +**Returns:** +- `comparison` + - *number* + - `1` : `rhsCalendarTime` is at a later time + - `0` : `rhsCalendarTime` is at the same time + - `-1` : `rhsCalendarTime` is at an earlier time \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md b/wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md new file mode 100644 index 00000000..ea35ac1c --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md @@ -0,0 +1,35 @@ +## Title: C_DateAndTime.GetCalendarTimeFromEpoch + +**Content:** +Returns the date for a specified amount of time since the UNIX epoch for the OS time zone. +`date = C_DateAndTime.GetCalendarTimeFromEpoch(epoch)` + +**Parameters:** +- `epoch` + - *number* - time in microseconds + +**Returns:** +- `date` + - *CalendarTime* + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes + +**Usage:** +```lua +local d = C_DateAndTime.GetCalendarTimeFromEpoch(1e6 * 60 * 60 * 24) +print(format("One day since epoch is %d-%02d-%02d %02d:%02d", d.year, d.month, d.monthDay, d.hour, d.minute)) +-- Output: One day since epoch is 1970-01-02 01:00 +``` \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md b/wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md new file mode 100644 index 00000000..fdb76043 --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md @@ -0,0 +1,47 @@ +## Title: C_DateAndTime.GetCurrentCalendarTime + +**Content:** +Returns the realm's current date and time. +`currentCalendarTime = C_DateAndTime.GetCurrentCalendarTime()` + +**Returns:** +- `currentCalendarTime` + - *CalendarTime* + - `Field` + - `Type` + - `Description` + - `year` + - *number* - The current year (e.g. 2019) + - `month` + - *number* - The current month + - `monthDay` + - *number* - The current day of the month + - `weekday` + - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) + - `hour` + - *number* - The current time in hours + - `minute` + - *number* - The current time in minutes + +**Usage:** +```lua +local d = C_DateAndTime.GetCurrentCalendarTime() +local weekDay = CALENDAR_WEEKDAY_NAMES +local month = CALENDAR_FULLDATE_MONTH_NAMES +print(format("The time is %02d:%02d, %s, %d %s %d", d.hour, d.minute, weekDay, d.monthDay, month, d.year)) +-- The time is 07:55, Friday, 15 March 2019 +``` + +**Miscellaneous:** +When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. +```lua +-- unix time +time() -- 1596157547 +GetServerTime() -- 1596157549 +-- local time, same as `date(nil, time())` +date() -- "Fri Jul 31 03:05:47 2020" +-- realm time +GetGameTime() -- 20, 4 +C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 +C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md b/wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md new file mode 100644 index 00000000..c2f6edb1 --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md @@ -0,0 +1,9 @@ +## Title: C_DateAndTime.GetSecondsUntilDailyReset + +**Content:** +Needs summary. +`seconds = C_DateAndTime.GetSecondsUntilDailyReset()` + +**Returns:** +- `seconds` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md b/wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md new file mode 100644 index 00000000..b35c2c37 --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md @@ -0,0 +1,9 @@ +## Title: C_DateAndTime.GetSecondsUntilWeeklyReset + +**Content:** +Returns the number of seconds until the weekly reset. +`seconds = C_DateAndTime.GetSecondsUntilWeeklyReset()` + +**Returns:** +- `seconds` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md b/wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md new file mode 100644 index 00000000..d922fa2f --- /dev/null +++ b/wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md @@ -0,0 +1,23 @@ +## Title: C_DateAndTime.GetServerTimeLocal + +**Content:** +Returns the server's Unix time offset by the server's timezone. +`serverTimeLocal = C_DateAndTime.GetServerTimeLocal()` + +**Returns:** +- `serverTimeLocal` + - *number* - Time in seconds since the epoch, only updates every 60 seconds. + +**Miscellaneous:** +When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. +```lua +-- unix time +time() -- 1596157547 +GetServerTime()) -- 1596157549 +-- local time, same as `date(nil, time())` +date() -- "Fri Jul 31 03:05:47 2020" +-- realm time +GetGameTime() -- 20, 4 +C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 +C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md b/wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md new file mode 100644 index 00000000..d375998d --- /dev/null +++ b/wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md @@ -0,0 +1,19 @@ +## Title: C_DeathInfo.GetCorpseMapPosition + +**Content:** +Returns the location of the player's corpse on the map. +`position = C_DeathInfo.GetCorpseMapPosition(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `position` + - *Vector2DMixin?* - Returns nil when there is no corpse. + +**Example Usage:** +This function can be used in addons that need to display the player's corpse location on the map. For instance, an addon that helps players find their way back to their corpse after dying could use this function to mark the corpse's position on the map. + +**Addon Usage:** +Large addons like "TomTom" or "Mapster" might use this function to provide additional map functionalities, such as marking the location of the player's corpse to assist in navigation after death. \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md b/wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md new file mode 100644 index 00000000..982d92f8 --- /dev/null +++ b/wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md @@ -0,0 +1,13 @@ +## Title: C_DeathInfo.GetDeathReleasePosition + +**Content:** +When the player is dead and hasn't released spirit, returns the location of the graveyard they will release to. +`position = C_DeathInfo.GetDeathReleasePosition(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* + +**Returns:** +- `position` + - *Vector2DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md b/wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md new file mode 100644 index 00000000..00bcd33d --- /dev/null +++ b/wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md @@ -0,0 +1,28 @@ +## Title: C_DeathInfo.GetGraveyardsForMap + +**Content:** +Returns graveyard info and location for a map. +`graveyards = C_DeathInfo.GetGraveyardsForMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `graveyards` + - *GraveyardMapInfo* + - `Field` + - `Type` + - `Description` + - `areaPoiID` + - *number* - AreaPOI.ID + - `position` + - *Vector2DMixin* - + - `name` + - *string* - + - `textureIndex` + - *number* - + - `graveyardID` + - *number* - + - `isGraveyardSelectable` + - *boolean* - \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md b/wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md new file mode 100644 index 00000000..2af589d9 --- /dev/null +++ b/wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md @@ -0,0 +1,33 @@ +## Title: C_DeathInfo.GetSelfResurrectOptions + +**Content:** +Returns self resurrect options for your character, including from soulstones. +`options = C_DeathInfo.GetSelfResurrectOptions()` + +**Returns:** +- `options` + - *structure* - SelfResurrectOption + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `optionType` + - *Enum.SelfResurrectOptionType* + - `id` + - *number* + - `canUse` + - *boolean* + - `isLimited` + - *boolean* + - `priority` + - *number* + +**Enum.SelfResurrectOptionType:** +- `Value` + - `Field` + - `Description` + - `0` + - Spell + - `1` + - Item \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md b/wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md new file mode 100644 index 00000000..519a8bd7 --- /dev/null +++ b/wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md @@ -0,0 +1,20 @@ +## Title: C_DeathInfo.UseSelfResurrectOption + +**Content:** +Uses a soulstone or similar means of self resurrection. +`C_DeathInfo.UseSelfResurrectOption(optionType, id)` + +**Parameters:** +- `optionType` + - *Enum.SelfResurrectOptionType* +- `id` + - *number* + +**Enum.SelfResurrectOptionType:** +- `Value` + - `Field` + - `Description` + - `0` + - Spell + - `1` + - Item \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.AddCategoryFilter.md b/wiki-information/functions/C_Engraving.AddCategoryFilter.md new file mode 100644 index 00000000..bbb7800d --- /dev/null +++ b/wiki-information/functions/C_Engraving.AddCategoryFilter.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.AddCategoryFilter + +**Content:** +Needs summary. +`C_Engraving.AddCategoryFilter(category)` + +**Parameters:** +- `category` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md b/wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md new file mode 100644 index 00000000..aadd75f1 --- /dev/null +++ b/wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.AddExclusiveCategoryFilter + +**Content:** +Needs summary. +`C_Engraving.AddExclusiveCategoryFilter(category)` + +**Parameters:** +- `category` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.CastRune.md b/wiki-information/functions/C_Engraving.CastRune.md new file mode 100644 index 00000000..cf7b86db --- /dev/null +++ b/wiki-information/functions/C_Engraving.CastRune.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.CastRune + +**Content:** +Needs summary. +`C_Engraving.CastRune(skillLineAbilityID)` + +**Parameters:** +- `skillLineAbilityID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.ClearCategoryFilter.md b/wiki-information/functions/C_Engraving.ClearCategoryFilter.md new file mode 100644 index 00000000..0593a640 --- /dev/null +++ b/wiki-information/functions/C_Engraving.ClearCategoryFilter.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.ClearCategoryFilter + +**Content:** +Needs summary. +`C_Engraving.ClearCategoryFilter(category)` + +**Parameters:** +- `category` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.EnableEquippedFilter.md b/wiki-information/functions/C_Engraving.EnableEquippedFilter.md new file mode 100644 index 00000000..d6724fe7 --- /dev/null +++ b/wiki-information/functions/C_Engraving.EnableEquippedFilter.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.EnableEquippedFilter + +**Content:** +Needs summary. +`C_Engraving.EnableEquippedFilter(enabled)` + +**Parameters:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetCurrentRuneCast.md b/wiki-information/functions/C_Engraving.GetCurrentRuneCast.md new file mode 100644 index 00000000..1fcda1fa --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetCurrentRuneCast.md @@ -0,0 +1,26 @@ +## Title: C_Engraving.GetCurrentRuneCast + +**Content:** +Needs summary. +`engravingInfo = C_Engraving.GetCurrentRuneCast()` + +**Returns:** +- `engravingInfo` + - *EngravingData?* + - `Field` + - `Type` + - `Description` + - `skillLineAbilityID` + - *number* + - `itemEnchantmentID` + - *number* + - `name` + - *string* + - `iconTexture` + - *number* + - `equipmentSlot` + - *number* + - `level` + - *number* + - `learnedAbilitySpellIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md b/wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md new file mode 100644 index 00000000..c1775126 --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.GetEngravingModeEnabled + +**Content:** +Needs summary. +`enabled = C_Engraving.GetEngravingModeEnabled()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md b/wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md new file mode 100644 index 00000000..372f1a6f --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.GetExclusiveCategoryFilter + +**Content:** +Needs summary. +`category = C_Engraving.GetExclusiveCategoryFilter()` + +**Returns:** +- `category` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetNumRunesKnown.md b/wiki-information/functions/C_Engraving.GetNumRunesKnown.md new file mode 100644 index 00000000..f1900157 --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetNumRunesKnown.md @@ -0,0 +1,15 @@ +## Title: C_Engraving.GetNumRunesKnown + +**Content:** +Needs summary. +`known, max = C_Engraving.GetNumRunesKnown()` + +**Parameters:** +- `equipmentSlot` + - *number?* + +**Returns:** +- `known` + - *number* +- `max` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetRuneCategories.md b/wiki-information/functions/C_Engraving.GetRuneCategories.md new file mode 100644 index 00000000..014bc87e --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetRuneCategories.md @@ -0,0 +1,16 @@ +## Title: C_Engraving.GetRuneCategories + +**Content:** +Needs summary. +`categories = C_Engraving.GetRuneCategories(shouldFilter, ownedOnly)` + +**Parameters:** +- `shouldFilter` + - *boolean* +- `ownedOnly` + - *boolean* + +**Returns:** +- `categories` + - *number* + diff --git a/wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md b/wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md new file mode 100644 index 00000000..7372ca60 --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md @@ -0,0 +1,30 @@ +## Title: C_Engraving.GetRuneForEquipmentSlot + +**Content:** +Needs summary. +`engravingInfo = C_Engraving.GetRuneForEquipmentSlot(equipmentSlot)` + +**Parameters:** +- `equipmentSlot` + - *number* + +**Returns:** +- `engravingInfo` + - *EngravingData?* + - `Field` + - `Type` + - `Description` + - `skillLineAbilityID` + - *number* + - `itemEnchantmentID` + - *number* + - `name` + - *string* + - `iconTexture` + - *number* + - `equipmentSlot` + - *number* + - `level` + - *number* + - `learnedAbilitySpellIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md b/wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md new file mode 100644 index 00000000..cf527854 --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md @@ -0,0 +1,32 @@ +## Title: C_Engraving.GetRuneForInventorySlot + +**Content:** +Needs summary. +`engravingInfo = C_Engraving.GetRuneForInventorySlot(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `engravingInfo` + - *EngravingData?* + - `Field` + - `Type` + - `Description` + - `skillLineAbilityID` + - *number* + - `itemEnchantmentID` + - *number* + - `name` + - *string* + - `iconTexture` + - *number* + - `equipmentSlot` + - *number* + - `level` + - *number* + - `learnedAbilitySpellIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetRunesForCategory.md b/wiki-information/functions/C_Engraving.GetRunesForCategory.md new file mode 100644 index 00000000..8d85319f --- /dev/null +++ b/wiki-information/functions/C_Engraving.GetRunesForCategory.md @@ -0,0 +1,32 @@ +## Title: C_Engraving.GetRunesForCategory + +**Content:** +Needs summary. +`engravingInfo = C_Engraving.GetRunesForCategory(category, ownedOnly)` + +**Parameters:** +- `category` + - *number* +- `ownedOnly` + - *boolean* + +**Returns:** +- `engravingInfo` + - *EngravingData* + - `Field` + - `Type` + - `Description` + - `skillLineAbilityID` + - *number* + - `itemEnchantmentID` + - *number* + - `name` + - *string* + - `iconTexture` + - *number* + - `equipmentSlot` + - *number* + - `level` + - *number* + - `learnedAbilitySpellIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.HasCategoryFilter.md b/wiki-information/functions/C_Engraving.HasCategoryFilter.md new file mode 100644 index 00000000..0e0bf24e --- /dev/null +++ b/wiki-information/functions/C_Engraving.HasCategoryFilter.md @@ -0,0 +1,13 @@ +## Title: C_Engraving.HasCategoryFilter + +**Content:** +Needs summary. +`result = C_Engraving.HasCategoryFilter(category)` + +**Parameters:** +- `category` + - *number* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsEngravingEnabled.md b/wiki-information/functions/C_Engraving.IsEngravingEnabled.md new file mode 100644 index 00000000..2c41ab0e --- /dev/null +++ b/wiki-information/functions/C_Engraving.IsEngravingEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.IsEngravingEnabled + +**Content:** +Needs summary. +`value = C_Engraving.IsEngravingEnabled()` + +**Returns:** +- `value` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md b/wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md new file mode 100644 index 00000000..90a7492e --- /dev/null +++ b/wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md @@ -0,0 +1,13 @@ +## Title: C_Engraving.IsEquipmentSlotEngravable + +**Content:** +Needs summary. +`result = C_Engraving.IsEquipmentSlotEngravable(equipmentSlot)` + +**Parameters:** +- `equipmentSlot` + - *number* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md b/wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md new file mode 100644 index 00000000..03f13ec7 --- /dev/null +++ b/wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.IsEquippedFilterEnabled + +**Content:** +Needs summary. +`enabled = C_Engraving.IsEquippedFilterEnabled()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md b/wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md new file mode 100644 index 00000000..fe45d9f3 --- /dev/null +++ b/wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md @@ -0,0 +1,15 @@ +## Title: C_Engraving.IsInventorySlotEngravable + +**Content:** +Needs summary. +`result = C_Engraving.IsInventorySlotEngravable(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md b/wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md new file mode 100644 index 00000000..2764838d --- /dev/null +++ b/wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md @@ -0,0 +1,15 @@ +## Title: C_Engraving.IsInventorySlotEngravableByCurrentRuneCast + +**Content:** +Needs summary. +`result = C_Engraving.IsInventorySlotEngravableByCurrentRuneCast(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* +- `slotIndex` + - *number* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsKnownRuneSpell.md b/wiki-information/functions/C_Engraving.IsKnownRuneSpell.md new file mode 100644 index 00000000..96731b61 --- /dev/null +++ b/wiki-information/functions/C_Engraving.IsKnownRuneSpell.md @@ -0,0 +1,13 @@ +## Title: C_Engraving.IsKnownRuneSpell + +**Content:** +Needs summary. +`result = C_Engraving.IsKnownRuneSpell(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsRuneEquipped.md b/wiki-information/functions/C_Engraving.IsRuneEquipped.md new file mode 100644 index 00000000..8b184507 --- /dev/null +++ b/wiki-information/functions/C_Engraving.IsRuneEquipped.md @@ -0,0 +1,13 @@ +## Title: C_Engraving.IsRuneEquipped + +**Content:** +Needs summary. +`result = C_Engraving.IsRuneEquipped(skillLineAbilityID)` + +**Parameters:** +- `skillLineAbilityID` + - *number* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md b/wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md new file mode 100644 index 00000000..e1522424 --- /dev/null +++ b/wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.SetEngravingModeEnabled + +**Content:** +Needs summary. +`C_Engraving.SetEngravingModeEnabled(enabled)` + +**Parameters:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.SetSearchFilter.md b/wiki-information/functions/C_Engraving.SetSearchFilter.md new file mode 100644 index 00000000..8962aa30 --- /dev/null +++ b/wiki-information/functions/C_Engraving.SetSearchFilter.md @@ -0,0 +1,9 @@ +## Title: C_Engraving.SetSearchFilter + +**Content:** +Needs summary. +`C_Engraving.SetSearchFilter(filter)` + +**Parameters:** +- `filter` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md new file mode 100644 index 00000000..9032f2b7 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md @@ -0,0 +1,17 @@ +## Title: C_EquipmentSet.AssignSpecToEquipmentSet + +**Content:** +Assigns an equipment set to a specialization. +`C_EquipmentSet.AssignSpecToEquipmentSet(equipmentSetID, specIndex)` + +**Parameters:** +- `equipmentSetID` + - *number* +- `specIndex` + - *number* + +**Example Usage:** +This function can be used to automatically switch equipment sets when changing specializations. For instance, if a player has different gear sets for their tank and DPS specializations, this function can be used to ensure the correct gear is equipped when switching between these roles. + +**Addons:** +Large addons like "ElvUI" and "WeakAuras" might use this function to enhance their functionality related to equipment management and specialization switching. For example, ElvUI could use it to streamline the process of changing gear sets when the player changes their specialization, providing a smoother user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md b/wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md new file mode 100644 index 00000000..8140eb89 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.CanUseEquipmentSets + +**Content:** +Returns whether any equipment sets can be used. +`canUseEquipmentSets = C_EquipmentSet.CanUseEquipmentSets()` + +**Returns:** +- `canUseEquipmentSets` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md new file mode 100644 index 00000000..2e04efee --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md @@ -0,0 +1,23 @@ +## Title: C_EquipmentSet.CreateEquipmentSet + +**Content:** +Creates an equipment set. +`C_EquipmentSet.CreateEquipmentSet(equipmentSetName)` + +**Parameters:** +- `equipmentSetName` + - *string* - The name of the equipment set to be created. +- `icon` + - *string?* - (Optional) The icon to be used for the equipment set. + +**Example Usage:** +```lua +-- Create a new equipment set named "PvP Gear" +C_EquipmentSet.CreateEquipmentSet("PvP Gear", "Interface\\Icons\\INV_Sword_27") +``` + +**Description:** +This function is used to create a new equipment set with the specified name and optional icon. Equipment sets allow players to quickly switch between different sets of gear, which is particularly useful for changing roles or activities, such as switching from PvE to PvP gear. + +**Usage in Addons:** +Many popular addons, such as "Outfitter" and "ItemRack," use this function to manage and create equipment sets for players. These addons provide a user-friendly interface for creating, updating, and switching between different sets of gear, enhancing the player's ability to manage their equipment efficiently. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md new file mode 100644 index 00000000..fd42d07a --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.DeleteEquipmentSet + +**Content:** +Deletes an equipment set. +`C_EquipmentSet.DeleteEquipmentSet(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md b/wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md new file mode 100644 index 00000000..7373dbbe --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md @@ -0,0 +1,13 @@ +## Title: C_EquipmentSet.EquipmentSetContainsLockedItems + +**Content:** +Returns whether an equipment set has locked items. +`hasLockedItems = C_EquipmentSet.EquipmentSetContainsLockedItems(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* + +**Returns:** +- `hasLockedItems` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md new file mode 100644 index 00000000..a192c7d3 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md @@ -0,0 +1,13 @@ +## Title: C_EquipmentSet.GetEquipmentSetAssignedSpec + +**Content:** +Returns the specialization assigned to an equipment set. +`specIndex = C_EquipmentSet.GetEquipmentSetAssignedSpec(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* + +**Returns:** +- `specIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md new file mode 100644 index 00000000..4bc6cf6e --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md @@ -0,0 +1,13 @@ +## Title: C_EquipmentSet.GetEquipmentSetForSpec + +**Content:** +Returns the equipment set currently assigned to a specific specialization. +`equipmentSetID = C_EquipmentSet.GetEquipmentSetForSpec(specIndex)` + +**Parameters:** +- `specIndex` + - *number* + +**Returns:** +- `equipmentSetID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md new file mode 100644 index 00000000..e5af1cf0 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md @@ -0,0 +1,13 @@ +## Title: C_EquipmentSet.GetEquipmentSetID + +**Content:** +Returns the set ID of an equipment set with the specified name. +`equipmentSetID = C_EquipmentSet.GetEquipmentSetID(equipmentSetName)` + +**Parameters:** +- `equipmentSetName` + - *string* - equipment set name to query + +**Returns:** +- `equipmentSetID` + - *number* - set ID of an equipment set with the specified name, or nil if no sets with the specified name are currently saved. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md new file mode 100644 index 00000000..90d9f0f8 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.GetEquipmentSetIDs + +**Content:** +Returns an array containing all currently saved equipment set IDs. +`equipmentSetIDs = C_EquipmentSet.GetEquipmentSetIDs()` + +**Returns:** +- `equipmentSetIDs` + - *number* - An array of equipment set IDs of the currently available equipment sets. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md new file mode 100644 index 00000000..535f2019 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md @@ -0,0 +1,32 @@ +## Title: C_EquipmentSet.GetEquipmentSetInfo + +**Content:** +Returns information about a saved equipment set. +`name, iconFileID, setID, isEquipped, numItems, numEquipped, numInInventory, numLost, numIgnored = C_EquipmentSet.GetEquipmentSetInfo(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* - equipment set ID to query information about. + +**Returns:** +- `name` + - *string* - name of the equipment set. +- `iconFileID` + - *number* - icon texture selected for the equipment set. +- `setID` + - *number* - equipment set ID. +- `isEquipped` + - *boolean* - true if all non-ignored slots in the set are currently equipped. +- `numItems` + - *number* - number of items included in the set. +- `numEquipped` + - *number* - number of items in the set currently equipped. +- `numInInventory` + - *number* - number of items in the set currently in the player's bags/bank, if bank is available. +- `numLost` + - *number* - number of items in the set that are not currently available to the player. +- `numIgnored` + - *number* - number of inventory slots ignored by the set. + +**Description:** +Equipment set IDs are assigned when the set is created and do not change as other sets are added or deleted. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md b/wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md new file mode 100644 index 00000000..5bcccc6b --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md @@ -0,0 +1,13 @@ +## Title: C_EquipmentSet.GetIgnoredSlots + +**Content:** +Returns ignored slots of an equipment set. +`slotIgnored = C_EquipmentSet.GetIgnoredSlots(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* + +**Returns:** +- `slotIgnored` + - *boolean* - indexed by InventorySlotId \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetItemIDs.md b/wiki-information/functions/C_EquipmentSet.GetItemIDs.md new file mode 100644 index 00000000..9c1dabb8 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetItemIDs.md @@ -0,0 +1,31 @@ +## Title: C_EquipmentSet.GetItemIDs + +**Content:** +Returns the item IDs of an equipment set. +`itemIDs = C_EquipmentSet.GetItemIDs(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* - Appears to return valid info for indices + +**Returns:** +- `itemIDs` + - *table* - a table of numbers indexed by InventorySlotId + +**Usage:** +To print all items that are part of the first set: +```lua +local items = C_EquipmentSet.GetItemIDs(0) +for i = 1, 19 do + if items then + print(i, (GetItemInfo(items[i]))) + end +end +``` + +**Example Use Case:** +This function can be used to retrieve and display the item IDs of all items in a specific equipment set. This is particularly useful for addons that manage or display equipment sets, such as those that help players quickly switch between different gear configurations for different activities (e.g., PvP, PvE, or specific roles like tanking or healing). + +**Addons Using This Function:** +- **Outfitter**: A popular addon that allows players to create, manage, and switch between different equipment sets. It uses this function to retrieve the item IDs for the sets it manages. +- **ItemRack**: Another addon for managing equipment sets, which uses this function to display and switch between different sets of gear. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetItemLocations.md b/wiki-information/functions/C_EquipmentSet.GetItemLocations.md new file mode 100644 index 00000000..80819777 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetItemLocations.md @@ -0,0 +1,23 @@ +## Title: C_EquipmentSet.GetItemLocations + +**Content:** +Returns the location of all items in an equipment set. +`locations = C_EquipmentSet.GetItemLocations(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* + +**Returns:** +- `locations` + - *number* - indexed by InventorySlotId + +**Description:** +The values for each slot can be examined as follows: +- `-1` : The item for this slot is unavailable. +- `0` : The slot should be emptied. +- `1` : This slot is ignored by the equipment set, no change will be made. +- Any other value can be examined by calling `EquipmentManager_UnpackLocation` + +**Details:** +This function does not differentiate between slots that cannot be equipped and slots that you have chosen to ignore in the equipment manager. For example, if you are testing to see if a particular item in your inventory has become unavailable (perhaps you sold it or scrapped it by mistake), you cannot simply scan looking for `-1` values as the ammo slot will return a `-1` as well as slots that you cannot equip at all (such as shields for hunters). Additional coding, likely by class and spec, are needed to make that differentiation. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md b/wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md new file mode 100644 index 00000000..8d591644 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.GetNumEquipmentSets + +**Content:** +Returns the number of saved equipment sets. +`numEquipmentSets = C_EquipmentSet.GetNumEquipmentSets()` + +**Returns:** +- `numEquipmentSets` + - *number* - number of saved sets for the current character. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md b/wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md new file mode 100644 index 00000000..4d402265 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.IgnoreSlotForSave + +**Content:** +Ignores an equipment slot for saving. +`C_EquipmentSet.IgnoreSlotForSave(slot)` + +**Parameters:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md b/wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md new file mode 100644 index 00000000..0067ae90 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md @@ -0,0 +1,19 @@ +## Title: C_EquipmentSet.IsSlotIgnoredForSave + +**Content:** +Returns whether a slot is ignored for saving. +`isSlotIgnored = C_EquipmentSet.IsSlotIgnoredForSave(slot)` + +**Parameters:** +- `slot` + - *number* + +**Returns:** +- `isSlotIgnored` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific equipment slot is set to be ignored when saving an equipment set. This is useful for addons that manage equipment sets and need to ensure certain slots are not altered. + +**Addons:** +Large addons like "ItemRack" and "Outfitter" use this function to manage and save equipment sets, ensuring that specific slots (like trinkets or weapons) can be ignored based on user preferences. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md new file mode 100644 index 00000000..d381ce58 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md @@ -0,0 +1,13 @@ +## Title: C_EquipmentSet.ModifyEquipmentSet + +**Content:** +Modifies an equipment set. +`C_EquipmentSet.ModifyEquipmentSet(equipmentSetID, newName)` + +**Parameters:** +- `equipmentSetID` + - *number* +- `newName` + - *string* +- `newIcon` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md new file mode 100644 index 00000000..b11f9de6 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.PickupEquipmentSet + +**Content:** +Picks up an equipment set, placing it on the cursor. +`C_EquipmentSet.PickupEquipmentSet(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md new file mode 100644 index 00000000..ab66b995 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md @@ -0,0 +1,14 @@ +## Title: C_EquipmentSet.SaveEquipmentSet + +**Content:** +Saves your currently equipped items into an equipment set. +`C_EquipmentSet.SaveEquipmentSet(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* - can be retrieved from an existing equipment set by name with `C_EquipmentSet.GetEquipmentSetID`. +- `icon` + - *string?* - icon to use for the equipment set. If omitted, the existing icon will be used. Accepts both texture names and file IDs, e.g. `"INV_Ammo_Snowball"`, `655708` or `"655708"`. + +**Description:** +Can only modify an existing equipment set. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md b/wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md new file mode 100644 index 00000000..83e2f2fb --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.UnassignEquipmentSetSpec + +**Content:** +Unassigns an equipment set from a specialization. +`C_EquipmentSet.UnassignEquipmentSetSpec(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md b/wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md new file mode 100644 index 00000000..65f1c448 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md @@ -0,0 +1,9 @@ +## Title: C_EquipmentSet.UnignoreSlotForSave + +**Content:** +Unignores a slot for saving. +`C_EquipmentSet.UnignoreSlotForSave(slot)` + +**Parameters:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md new file mode 100644 index 00000000..ff0759c8 --- /dev/null +++ b/wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md @@ -0,0 +1,17 @@ +## Title: C_EquipmentSet.UseEquipmentSet + +**Content:** +Equips items from a specified equipment set. +`setWasEquipped = C_EquipmentSet.UseEquipmentSet(equipmentSetID)` + +**Parameters:** +- `equipmentSetID` + - *number* + +**Returns:** +- `setWasEquipped` + - *boolean* - true if the set was equipped, nil otherwise. Failure conditions include invalid arguments, and engaging in combat. + +**Description:** +This function does not produce error messages when it fails. +FrameXML's `EquipmentManager_EquipSet("name")` will produce a visible error, but will not provide a return value indicating success/failure. \ No newline at end of file diff --git a/wiki-information/functions/C_EventUtils.IsEventValid.md b/wiki-information/functions/C_EventUtils.IsEventValid.md new file mode 100644 index 00000000..10b14817 --- /dev/null +++ b/wiki-information/functions/C_EventUtils.IsEventValid.md @@ -0,0 +1,13 @@ +## Title: C_EventUtils.IsEventValid + +**Content:** +Checks if a named event exists and can be registered for. +`valid = C_EventUtils.IsEventValid(eventName)` + +**Parameters:** +- `eventName` + - *string* - The name of the event to query. + +**Returns:** +- `valid` + - *boolean* - true if the named event exists and can be registered for, false if not. \ No newline at end of file diff --git a/wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md b/wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md new file mode 100644 index 00000000..ef28e838 --- /dev/null +++ b/wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md @@ -0,0 +1,9 @@ +## Title: C_EventUtils.NotifySettingsLoaded + +**Content:** +Notifies the user interface that settings are loaded and are ready to be queried. +`C_EventUtils.NotifySettingsLoaded()` + +**Description:** +Immediately triggers the `SETTINGS_LOADED` event. +This function will be called after both the `PLAYER_ENTERING_WORLD` and `VARIABLES_LOADED` events have fired. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddFriend.md b/wiki-information/functions/C_FriendList.AddFriend.md new file mode 100644 index 00000000..d2cc7893 --- /dev/null +++ b/wiki-information/functions/C_FriendList.AddFriend.md @@ -0,0 +1,15 @@ +## Title: C_FriendList.AddFriend + +**Content:** +Adds a friend to your friend list. +`C_FriendList.AddFriend(name)` + +**Parameters:** +- `name` + - *string* - The name of the player you would like to add. +- `notes` + - *string?* - The note that will show in your friend list. + +**Description:** +You can have a maximum of 100 people on your friends list at the same time. +The player being added does not need to be online for this to work. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddIgnore.md b/wiki-information/functions/C_FriendList.AddIgnore.md new file mode 100644 index 00000000..147d43fe --- /dev/null +++ b/wiki-information/functions/C_FriendList.AddIgnore.md @@ -0,0 +1,18 @@ +## Title: C_FriendList.AddIgnore + +**Content:** +Adds a player to your ignore list. +`added = C_FriendList.AddIgnore(name)` + +**Parameters:** +- `name` + - *string* - the name of the player you would like to ignore. + +**Returns:** +- `added` + - *boolean* - whether the player was successfully added to your ignore list. This seems to only return false when trying to ignore someone who is already being ignored, otherwise true. + +**Description:** +You can have a maximum of 50 people on your ignore list at the same time. +The player being ignored does not need to be online for this to work. +Calling this function when a player is already ignored, removes the ignore. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddOrDelIgnore.md b/wiki-information/functions/C_FriendList.AddOrDelIgnore.md new file mode 100644 index 00000000..d0002c43 --- /dev/null +++ b/wiki-information/functions/C_FriendList.AddOrDelIgnore.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.AddOrDelIgnore + +**Content:** +Adds or removes a player to/from the ignore list. +`C_FriendList.AddOrDelIgnore(name)` + +**Parameters:** +- `name` + - *string* - the name of the player to add or remove. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddOrRemoveFriend.md b/wiki-information/functions/C_FriendList.AddOrRemoveFriend.md new file mode 100644 index 00000000..afdd6483 --- /dev/null +++ b/wiki-information/functions/C_FriendList.AddOrRemoveFriend.md @@ -0,0 +1,14 @@ +## Title: C_FriendList.AddOrRemoveFriend + +**Content:** +Adds or removes a player to or from the friends list. +`C_FriendList.AddOrRemoveFriend(name, notes)` + +**Parameters:** +- `name` + - *string* - The name of the player to add or remove. +- `notes` + - *string* - (Required) The note in the friends frame. + +**Description:** +If the player is already on your friends list, the player will be removed regardless of whether you pass notes as the second argument. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.DelIgnore.md b/wiki-information/functions/C_FriendList.DelIgnore.md new file mode 100644 index 00000000..f51a4166 --- /dev/null +++ b/wiki-information/functions/C_FriendList.DelIgnore.md @@ -0,0 +1,13 @@ +## Title: C_FriendList.DelIgnore + +**Content:** +Removes a player from your ignore list. +`removed = C_FriendList.DelIgnore(name)` + +**Parameters:** +- `name` + - *string* - the name of the player you would like to remove from your ignore list. + +**Returns:** +- `removed` + - *boolean* - whether the player was successfully removed from your ignore list. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.DelIgnoreByIndex.md b/wiki-information/functions/C_FriendList.DelIgnoreByIndex.md new file mode 100644 index 00000000..08725562 --- /dev/null +++ b/wiki-information/functions/C_FriendList.DelIgnoreByIndex.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.DelIgnoreByIndex + +**Content:** +Removes a player from your ignore list. +`C_FriendList.DelIgnoreByIndex(index)` + +**Parameters:** +- `index` + - *number* - index of the player you would like to remove. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetFriendInfo.md b/wiki-information/functions/C_FriendList.GetFriendInfo.md new file mode 100644 index 00000000..c9617304 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetFriendInfo.md @@ -0,0 +1,69 @@ +## Title: C_FriendList.GetFriendInfo + +**Content:** +Retrieves information about a person on your friends list. +```lua +info = C_FriendList.GetFriendInfo(name) +info = C_FriendList.GetFriendInfoByIndex(index) +``` + +**Parameters:** +- **GetFriendInfo:** + - `name` + - *string* - name of friend in the friend list. + +- **GetFriendInfoByIndex:** + - `index` + - *number* - index of the friend, up to `C_FriendList.GetNumFriends()` limited to max 100. + +**Returns:** +- `info` + - *FriendInfo* - a table containing: + - `Field` + - `Type` + - `Description` + - `connected` + - *boolean* - If the friend is online + - `name` + - *string* - Friend's name + - `className` + - *string?* - Friend's class, or "Unknown" (if offline) + - `area` + - *string?* - Current location, or "Unknown" (if offline) + - `notes` + - *string?* - Notes about the friend + - `guid` + - *string* - GUID, example: "Player-1096-085DE703" + - `level` + - *number* - Friend's level, or 0 (if offline) + - `dnd` + - *boolean* - If the friend's current status flag is DND + - `afk` + - *boolean* - If the friend's current status flag is AFK + - `rafLinkType` + - *Enum.RafLinkType* - Type of Recruit-A-Friend link + - `mobile` + - *boolean* - If the friend is on mobile + +**Enum.RafLinkType:** +- `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Recruit + - `2` + - Friend + - `3` + - Both + +**Description:** +Friend information isn't necessarily automatically kept up to date. You can use `C_FriendList.ShowFriends()` to request an update from the server. + +**Usage:** +```lua +local f = C_FriendList.GetFriendInfoByIndex(1) +print(format("Your friend %s (level %d %s) is in %s", f.name, f.level, f.className, f.area)) +-- Your friend Aërto (level 74 Warrior) is in Sholazar Basin +``` \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md b/wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md new file mode 100644 index 00000000..5bf0f020 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md @@ -0,0 +1,69 @@ +## Title: C_FriendList.GetFriendInfo + +**Content:** +Retrieves information about a person on your friends list. +```lua +info = C_FriendList.GetFriendInfo(name) +info = C_FriendList.GetFriendInfoByIndex(index) +``` + +**Parameters:** +- **GetFriendInfo:** + - `name` + - *string* - name of friend in the friend list. + +- **GetFriendInfoByIndex:** + - `index` + - *number* - index of the friend, up to `C_FriendList.GetNumFriends()` limited to max 100. + +**Returns:** +- `info` + - *FriendInfo* + - `Field` + - `Type` + - `Description` + - `connected` + - *boolean* - If the friend is online + - `name` + - *string* + - `className` + - *string?* - Friend's class, or "Unknown" (if offline) + - `area` + - *string?* - Current location, or "Unknown" (if offline) + - `notes` + - *string?* + - `guid` + - *string* - GUID, example: "Player-1096-085DE703" + - `level` + - *number* - Friend's level, or 0 (if offline) + - `dnd` + - *boolean* - If the friend's current status flag is DND + - `afk` + - *boolean* - If the friend's current status flag is AFK + - `rafLinkType` + - *Enum.RafLinkType* + - `mobile` + - *boolean* + +- **Enum.RafLinkType** + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Recruit + - `2` + - Friend + - `3` + - Both + +**Description:** +Friend information isn't necessarily automatically kept up to date. You can use `C_FriendList.ShowFriends()` to request an update from the server. + +**Usage:** +```lua +local f = C_FriendList.GetFriendInfoByIndex(1) +print(format("Your friend %s (level %d %s) is in %s", f.name, f.level, f.className, f.area)) +-- Your friend Aërto (level 74 Warrior) is in Sholazar Basin +``` \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetIgnoreName.md b/wiki-information/functions/C_FriendList.GetIgnoreName.md new file mode 100644 index 00000000..35c7c925 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetIgnoreName.md @@ -0,0 +1,13 @@ +## Title: C_FriendList.GetIgnoreName + +**Content:** +Returns the name of a currently ignored player. +`name = C_FriendList.GetIgnoreName(index)` + +**Parameters:** +- `index` + - *number* - index of the ignored player, up to `C_FriendList.GetNumIgnores` (max 50). + +**Returns:** +- `name` + - *string?* - name of the ignored player. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumFriends.md b/wiki-information/functions/C_FriendList.GetNumFriends.md new file mode 100644 index 00000000..fae152d5 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetNumFriends.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.GetNumFriends + +**Content:** +Returns how many friends you have. +`numFriends = C_FriendList.GetNumFriends()` + +**Returns:** +- `numFriends` + - *number* - the number of friends you have (max 100). \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumIgnores.md b/wiki-information/functions/C_FriendList.GetNumIgnores.md new file mode 100644 index 00000000..d75e9b96 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetNumIgnores.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.GetNumIgnores + +**Content:** +Returns the number of entries on your ignore list. +`numIgnores = C_FriendList.GetNumIgnores()` + +**Returns:** +- `numIgnores` + - *number* - the number of players on your ignore list (max 50). \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumOnlineFriends.md b/wiki-information/functions/C_FriendList.GetNumOnlineFriends.md new file mode 100644 index 00000000..b322a7f1 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetNumOnlineFriends.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.GetNumOnlineFriends + +**Content:** +Returns the number of online friends. +`numOnline = C_FriendList.GetNumOnlineFriends()` + +**Returns:** +- `numOnline` + - *number* - the number of online friends. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumWhoResults.md b/wiki-information/functions/C_FriendList.GetNumWhoResults.md new file mode 100644 index 00000000..659c2867 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetNumWhoResults.md @@ -0,0 +1,15 @@ +## Title: C_FriendList.GetNumWhoResults + +**Content:** +Get the number of entries resulting from your most recent /who query. +`numWhos, totalNumWhos = C_FriendList.GetNumWhoResults()` + +**Returns:** +- `numWhos` + - *number* - Number of results returned +- `totalNumWhos` + - *number* - Number of results to display + +**Description:** +Both return values never seem to go over 50. +If `totalNumWhos` would be bigger than 50, the amount shown will be capped to `MAX_WHOS_FROM_SERVER` (50) in FrameXML. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetSelectedFriend.md b/wiki-information/functions/C_FriendList.GetSelectedFriend.md new file mode 100644 index 00000000..13900112 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetSelectedFriend.md @@ -0,0 +1,12 @@ +## Title: C_FriendList.GetSelectedFriend + +**Content:** +Returns the index of the currently selected friend. +`index = C_FriendList.GetSelectedFriend()` + +**Returns:** +- `index` + - *number?* - The index of the friend which is currently selected on the friend list. Returns nil if you have no friends. + +**Description:** +This function is necessary because indices can change in response to friend status updates. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetSelectedIgnore.md b/wiki-information/functions/C_FriendList.GetSelectedIgnore.md new file mode 100644 index 00000000..f30a7fcc --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetSelectedIgnore.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.GetSelectedIgnore + +**Content:** +Returns the currently selected index in the ignore listing. +`index = C_FriendList.GetSelectedIgnore()` + +**Returns:** +- `index` + - *number?* - the index of the ignored player which is currently selected on the friend list. Returns nil if you have nobody ignored. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetWhoInfo.md b/wiki-information/functions/C_FriendList.GetWhoInfo.md new file mode 100644 index 00000000..dccb5ee9 --- /dev/null +++ b/wiki-information/functions/C_FriendList.GetWhoInfo.md @@ -0,0 +1,43 @@ +## Title: C_FriendList.GetWhoInfo + +**Content:** +Retrieves info about a character on your current /who list. +`info = C_FriendList.GetWhoInfo(index)` + +**Parameters:** +- `index` + - *number* - Index 1 up to `C_FriendList.GetNumWhoResults()` + +**Returns:** +- `info` + - *WhoInfo* + - `Field` + - `Type` + - `Description` + - `fullName` + - *string* - Character-Realm name + - `fullGuildName` + - *string* - Guild name + - `level` + - *number* + - `raceStr` + - *string* + - `classStr` + - *string* - Localized class name + - `area` + - *string* - The character's current zone + - `filename` + - *string?* - Localization-independent classFilename + - `gender` + - *number* - Sex of the character. 2 for male, 3 for female + +**Usage:** +```lua +local p = C_FriendList.GetWhoInfo(1) +print(format("%s (level %d %s %s) is in %s", p.fullName, p.level, p.raceStr, p.classStr, p.area)) +-- Output: Nartan-Ravenholdt (level 43 Kul Tiran Druid) is in Eastern Plaguelands +``` + +**Reference:** +- `C_FriendList.SendWho()` +- `/who` \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsFriend.md b/wiki-information/functions/C_FriendList.IsFriend.md new file mode 100644 index 00000000..da792740 --- /dev/null +++ b/wiki-information/functions/C_FriendList.IsFriend.md @@ -0,0 +1,13 @@ +## Title: C_FriendList.IsFriend + +**Content:** +Returns whether a character is your friend. +`isFriend = C_FriendList.IsFriend(guid)` + +**Parameters:** +- `guid` + - *string* - GUID + +**Returns:** +- `isFriend` + - *boolean* - whether the character is your friend. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsIgnored.md b/wiki-information/functions/C_FriendList.IsIgnored.md new file mode 100644 index 00000000..03e6439b --- /dev/null +++ b/wiki-information/functions/C_FriendList.IsIgnored.md @@ -0,0 +1,13 @@ +## Title: C_FriendList.IsIgnored + +**Content:** +Returns whether a character is being ignored by you. +`isIgnored = C_FriendList.IsIgnored(token)` + +**Parameters:** +- `token` + - *string* - The UnitId or name of the character. + +**Returns:** +- `isIgnored` + - *boolean* - whether the character is ignored. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsIgnoredByGuid.md b/wiki-information/functions/C_FriendList.IsIgnoredByGuid.md new file mode 100644 index 00000000..64b71f30 --- /dev/null +++ b/wiki-information/functions/C_FriendList.IsIgnoredByGuid.md @@ -0,0 +1,13 @@ +## Title: C_FriendList.IsIgnoredByGuid + +**Content:** +Returns whether a character is being ignored by you. +`isIgnored = C_FriendList.IsIgnoredByGuid(guid)` + +**Parameters:** +- `guid` + - *string* - GUID of the character. + +**Returns:** +- `isIgnored` + - *boolean* - whether the character is ignored. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsOnIgnoredList.md b/wiki-information/functions/C_FriendList.IsOnIgnoredList.md new file mode 100644 index 00000000..4acfb9d8 --- /dev/null +++ b/wiki-information/functions/C_FriendList.IsOnIgnoredList.md @@ -0,0 +1,13 @@ +## Title: C_FriendList.IsOnIgnoredList + +**Content:** +Needs summary. +`isIgnored = C_FriendList.IsOnIgnoredList(token)` + +**Parameters:** +- `token` + - *string* + +**Returns:** +- `isIgnored` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.RemoveFriend.md b/wiki-information/functions/C_FriendList.RemoveFriend.md new file mode 100644 index 00000000..4f81eed3 --- /dev/null +++ b/wiki-information/functions/C_FriendList.RemoveFriend.md @@ -0,0 +1,13 @@ +## Title: C_FriendList.RemoveFriend + +**Content:** +Removes a friend from the friends list. +`removed = C_FriendList.RemoveFriend(name)` + +**Parameters:** +- `name` + - *string* - the name of the friend to remove. + +**Returns:** +- `removed` + - *boolean* - whether the friend was successfully removed. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.RemoveFriendByIndex.md b/wiki-information/functions/C_FriendList.RemoveFriendByIndex.md new file mode 100644 index 00000000..b2e47fff --- /dev/null +++ b/wiki-information/functions/C_FriendList.RemoveFriendByIndex.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.RemoveFriendByIndex + +**Content:** +Removes a friend from the friends list. +`C_FriendList.RemoveFriendByIndex(index)` + +**Parameters:** +- `index` + - *number* - the index of the friend in the friends list to remove. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SendWho.md b/wiki-information/functions/C_FriendList.SendWho.md new file mode 100644 index 00000000..cdc0b916 --- /dev/null +++ b/wiki-information/functions/C_FriendList.SendWho.md @@ -0,0 +1,46 @@ +## Title: C_FriendList.SendWho + +**Content:** +Requests a list of other online players. +`C_FriendList.SendWho(filter, origin)` + +**Parameters:** +- `filter` + - *string* - The criteria for which you want to perform a Who query. This can be anything for which you could normally search in a Who query: + - Any string, which will be matched against players' names, guild names, zones, and levels. + - Name (`n-""`) + - Zone (`z-""`) + - Race (`r-""`) + - Class (`c-""`) + - Guild (`g-""`) + - Level ranges: (`-`) + - These can be combined, but no more than one of each type can be searched for at once. Note that the quotation marks around the zone, race, and class must be present. Double quotation marks are required, as single quotation marks won't work. +- `origin` + - *Enum.SocialWhoOrigin* + - `Value` + - `Field` + - `Description` + - `0` - Unknown + - `1` - Social + - `2` - Chat + - `3` - Item + +**Description:** +Fires `WHO_LIST_UPDATE` when the requested query has been processed. Note that there is a server-side cooldown; queries are not guaranteed to generate a response. + +**Usage:** +- Searches for players in the level 20 to 40 range. + ```lua + C_FriendList.SendWho("20-40") + ``` +- Searches for Night Elf Rogues in Teldrassil, of levels 10-15, with the string "bob" in their (guild) names. + ```lua + C_FriendList.SendWho('bob z-"Teldrassil" r-"Night Elf" c-"Rogue" 10-15') + ``` + +**Reference:** +- `C_FriendList.GetWhoInfo()` +- `C_FriendList.SetWhoToUi()` + +**Example Use Case:** +This function can be used in addons that need to search for players based on specific criteria, such as finding potential group members or guild recruits. For example, an addon like "LookingForGroup" might use this function to find players who meet certain level and class requirements for a dungeon run. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetFriendNotes.md b/wiki-information/functions/C_FriendList.SetFriendNotes.md new file mode 100644 index 00000000..fd1991b8 --- /dev/null +++ b/wiki-information/functions/C_FriendList.SetFriendNotes.md @@ -0,0 +1,15 @@ +## Title: C_FriendList.SetFriendNotes + +**Content:** +Sets the note text for a friend. +`found = C_FriendList.SetFriendNotes(name, notes)` + +**Parameters:** +- `name` + - *string* - name of friend in the friend list. +- `notes` + - *string* - the text that the friend's note will be set to, up to 48 characters, anything longer will be truncated. + +**Returns:** +- `found` + - *boolean* - Whether the friend's note was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md b/wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md new file mode 100644 index 00000000..b945f814 --- /dev/null +++ b/wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md @@ -0,0 +1,11 @@ +## Title: C_FriendList.SetFriendNotesByIndex + +**Content:** +Sets the note text for a friend. +`C_FriendList.SetFriendNotesByIndex(index, notes)` + +**Parameters:** +- `index` + - *number* - index of the friend, up to `C_FriendList.GetNumFriends` (max 100). Note that status changes can re-order the friend list, indices are not guaranteed to remain stable across events. +- `notes` + - *string* - the text that the friend's note will be set to, up to 48 characters, anything longer will be truncated. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetSelectedFriend.md b/wiki-information/functions/C_FriendList.SetSelectedFriend.md new file mode 100644 index 00000000..63bfdf75 --- /dev/null +++ b/wiki-information/functions/C_FriendList.SetSelectedFriend.md @@ -0,0 +1,12 @@ +## Title: C_FriendList.SetSelectedFriend + +**Content:** +Updates the current selected friend. +`C_FriendList.SetSelectedFriend(index)` + +**Parameters:** +- `index` + - *number* - the index of the friend to be selected. + +**Description:** +This function is necessary because indices can change in response to friend status updates. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetSelectedIgnore.md b/wiki-information/functions/C_FriendList.SetSelectedIgnore.md new file mode 100644 index 00000000..26015cec --- /dev/null +++ b/wiki-information/functions/C_FriendList.SetSelectedIgnore.md @@ -0,0 +1,9 @@ +## Title: C_FriendList.SetSelectedIgnore + +**Content:** +Sets the currently selected ignore entry. +`C_FriendList.SetSelectedIgnore(index)` + +**Parameters:** +- `index` + - *number* - the index of the ignored player to be selected. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetWhoToUi.md b/wiki-information/functions/C_FriendList.SetWhoToUi.md new file mode 100644 index 00000000..f8c4d9e2 --- /dev/null +++ b/wiki-information/functions/C_FriendList.SetWhoToUi.md @@ -0,0 +1,14 @@ +## Title: C_FriendList.SetWhoToUi + +**Content:** +Sets how the result of a /who request will be delivered. +`C_FriendList.SetWhoToUi(whoToUi)` + +**Parameters:** +- `whoToUi` + - *boolean* - If true the results will always be delivered as a WHO_LIST_UPDATE event and displayed in the FriendsFrame. If false the results may be returned as a sequence of CHAT_MSG_SYSTEM events (up to 3 results) or a WHO_LIST_UPDATE event (4+ results). + +**Description:** +The /who query is subject to a server-side throttle; throttled requests are silently dropped. +This setting does not persist between relog/reload. +The FriendsFrame will automatically display open to display the results when the WHO_LIST_UPDATE event is triggered. You may hide the frame using `HideUIPanel(FriendsFrame)` (protected during combat lockdown), or temporarily unregister it from WHO_LIST_UPDATE to prevent this behavior if your addon relies on performing /who queries in the background. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.ShowFriends.md b/wiki-information/functions/C_FriendList.ShowFriends.md new file mode 100644 index 00000000..89baba7b --- /dev/null +++ b/wiki-information/functions/C_FriendList.ShowFriends.md @@ -0,0 +1,11 @@ +## Title: C_FriendList.ShowFriends + +**Content:** +Requests updated friends information from server. +`C_FriendList.ShowFriends()` + +**Example Usage:** +This function can be used in an addon to refresh the friends list data. For instance, if you are developing an addon that displays your friends' online status, you can call `C_FriendList.ShowFriends()` to ensure you have the most up-to-date information. + +**Addons Using This Function:** +Many social and communication addons, such as "Prat" or "Chatter," use this function to keep the friends list current and to provide accurate information to the user. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SortWho.md b/wiki-information/functions/C_FriendList.SortWho.md new file mode 100644 index 00000000..51972339 --- /dev/null +++ b/wiki-information/functions/C_FriendList.SortWho.md @@ -0,0 +1,24 @@ +## Title: C_FriendList.SortWho + +**Content:** +Sorts the last /who reply received by the client. +`C_FriendList.SortWho(sorting)` + +**Parameters:** +- `sorting` + - *string* - The column by which you wish to sort the who list: + - `"name"` (default) + - `"level"` + - `"class"` + - `"zone"` + - `"guild"` + - `"race"` + +**Reference:** +`WHO_LIST_UPDATE` is fired when the list is sorted. + +**Description:** +This function changes the mapping between `C_FriendList.GetWhoInfo` indices and result rows. +FrameXML will show the who frame on this event, even if it was not visible before. +Calling the same sort twice will reverse the sort. +You may sort by guild, race, or zone even if it is not the currently selected second column on the who frame. \ No newline at end of file diff --git a/wiki-information/functions/C_FunctionContainers.CreateCallback.md b/wiki-information/functions/C_FunctionContainers.CreateCallback.md new file mode 100644 index 00000000..a1c51881 --- /dev/null +++ b/wiki-information/functions/C_FunctionContainers.CreateCallback.md @@ -0,0 +1,37 @@ +## Title: C_FunctionContainers.CreateCallback + +**Content:** +Creates a function container that invokes a cancellable callback function. +`container = C_FunctionContainers.CreateCallback(func)` + +**Parameters:** +- `func` + - *function* - A Lua function to be called. + +**Returns:** +- `container` + - *FunctionContainer* - A container object bound to the supplied function. + +**Description:** +The supplied callback must be a Lua function. The API will reject C functions and any non-function values. + +**Usage:** +The following snippet creates a function container and schedules it to be executed every second, cancelling itself after five calls. +```lua +local container +container = C_FunctionContainers.CreateCallback(function() + container.timesCalled = container.timesCalled + 1 + if container.timesCalled == 5 then + container:Cancel() + end + print("Called!") +end) +container.timesCalled = 0 +C_Timer.NewTicker(1, container) +``` + +**Example Use Case:** +This function can be used in scenarios where you need to repeatedly execute a function with the ability to cancel it after a certain condition is met. For instance, it can be used in an addon to periodically check for updates or changes in the game state and stop checking after a certain number of iterations. + +**Addon Usage:** +Large addons like WeakAuras might use this function to create dynamic and cancellable callbacks for custom animations or periodic checks. This allows for efficient resource management by ensuring that callbacks are only active when needed and can be cancelled when their purpose is fulfilled. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.AddSDLMapping.md b/wiki-information/functions/C_GamePad.AddSDLMapping.md new file mode 100644 index 00000000..8e6a597b --- /dev/null +++ b/wiki-information/functions/C_GamePad.AddSDLMapping.md @@ -0,0 +1,20 @@ +## Title: C_GamePad.AddSDLMapping + +**Content:** +Needs summary. +`success = C_GamePad.AddSDLMapping(platform, mapping)` + +**Parameters:** +- `platform` + - *Enum.ClientPlatformType* + - `Value` + - `Field` + - `Description` + - `0` - Windows + - `1` - Macintosh +- `mapping` + - *string* + +**Returns:** +- `success` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ApplyConfigs.md b/wiki-information/functions/C_GamePad.ApplyConfigs.md new file mode 100644 index 00000000..b49b4329 --- /dev/null +++ b/wiki-information/functions/C_GamePad.ApplyConfigs.md @@ -0,0 +1,5 @@ +## Title: C_GamePad.ApplyConfigs + +**Content:** +Needs summary. +`C_GamePad.ApplyConfigs()` \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.AxisIndexToConfigName.md b/wiki-information/functions/C_GamePad.AxisIndexToConfigName.md new file mode 100644 index 00000000..10912c1e --- /dev/null +++ b/wiki-information/functions/C_GamePad.AxisIndexToConfigName.md @@ -0,0 +1,19 @@ +## Title: C_GamePad.AxisIndexToConfigName + +**Content:** +Needs summary. +`configName = C_GamePad.AxisIndexToConfigName(axisIndex)` + +**Parameters:** +- `axisIndex` + - *number* + +**Returns:** +- `configName` + - *string?* + +**Example Usage:** +This function can be used to retrieve the configuration name for a specific gamepad axis index. This is useful for addons that need to map gamepad inputs to specific actions or settings. + +**Addons:** +While there is no specific large addon mentioned, any addon that deals with gamepad support, such as ConsolePort, might use this function to handle gamepad axis configurations. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ButtonBindingToIndex.md b/wiki-information/functions/C_GamePad.ButtonBindingToIndex.md new file mode 100644 index 00000000..0e2380d6 --- /dev/null +++ b/wiki-information/functions/C_GamePad.ButtonBindingToIndex.md @@ -0,0 +1,19 @@ +## Title: C_GamePad.ButtonBindingToIndex + +**Content:** +Converts the name of a keybinding to its assigned gamepad button index. Returns nil if no gamepad button is assigned to the requested keybinding. +`buttonIndex = C_GamePad.ButtonBindingToIndex(bindingName)` + +**Parameters:** +- `bindingName` + - *string* + +**Returns:** +- `buttonIndex` + - *number?* + +**Example Usage:** +This function can be used to map a specific keybinding to a gamepad button index, which is useful for addons that provide gamepad support or custom keybinding configurations. + +**Addon Usage:** +Large addons like ConsolePort use this function to provide seamless gamepad integration by mapping World of Warcraft keybindings to gamepad buttons, enhancing the gameplay experience for players who prefer using a gamepad. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ButtonIndexToBinding.md b/wiki-information/functions/C_GamePad.ButtonIndexToBinding.md new file mode 100644 index 00000000..be16192c --- /dev/null +++ b/wiki-information/functions/C_GamePad.ButtonIndexToBinding.md @@ -0,0 +1,19 @@ +## Title: C_GamePad.ButtonIndexToBinding + +**Content:** +Returns the name of the keybinding assigned to a specified gamepad button index. Returns nil if no keybinding is assigned to the requested button. +`bindingName = C_GamePad.ButtonIndexToBinding(buttonIndex)` + +**Parameters:** +- `buttonIndex` + - *number* + +**Returns:** +- `bindingName` + - *string?* + +**Example Usage:** +This function can be used to retrieve the keybinding name for a specific button on a gamepad. For instance, if you want to check what action is bound to the "A" button on an Xbox controller, you would use this function with the appropriate button index. + +**Addons:** +Large addons that support gamepad functionality, such as ConsolePort, may use this function to dynamically display or modify keybindings based on the gamepad button indices. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md b/wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md new file mode 100644 index 00000000..3b106d23 --- /dev/null +++ b/wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md @@ -0,0 +1,13 @@ +## Title: C_GamePad.ButtonIndexToConfigName + +**Content:** +Needs summary. +`configName = C_GamePad.ButtonIndexToConfigName(buttonIndex)` + +**Parameters:** +- `buttonIndex` + - *number* + +**Returns:** +- `configName` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ClearLedColor.md b/wiki-information/functions/C_GamePad.ClearLedColor.md new file mode 100644 index 00000000..b81cbbf9 --- /dev/null +++ b/wiki-information/functions/C_GamePad.ClearLedColor.md @@ -0,0 +1,6 @@ +## Title: C_GamePad.ClearLedColor + +**Content:** +Needs summary. +`C_GamePad.ClearLedColor()` + diff --git a/wiki-information/functions/C_GamePad.DeleteConfig.md b/wiki-information/functions/C_GamePad.DeleteConfig.md new file mode 100644 index 00000000..9fbbfe26 --- /dev/null +++ b/wiki-information/functions/C_GamePad.DeleteConfig.md @@ -0,0 +1,16 @@ +## Title: C_GamePad.DeleteConfig + +**Content:** +Needs summary. +`C_GamePad.DeleteConfig(configID)` + +**Parameters:** +- `configID` + - *GamePadConfigID* + - `Field` + - `Type` + - `Description` + - `vendorID` + - *number?* + - `productID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetActiveDeviceID.md b/wiki-information/functions/C_GamePad.GetActiveDeviceID.md new file mode 100644 index 00000000..5cc35f7f --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetActiveDeviceID.md @@ -0,0 +1,9 @@ +## Title: C_GamePad.GetActiveDeviceID + +**Content:** +Needs summary. +`deviceID = C_GamePad.GetActiveDeviceID()` + +**Returns:** +- `deviceID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetAllConfigIDs.md b/wiki-information/functions/C_GamePad.GetAllConfigIDs.md new file mode 100644 index 00000000..cf1d5bd3 --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetAllConfigIDs.md @@ -0,0 +1,16 @@ +## Title: C_GamePad.GetAllConfigIDs + +**Content:** +Needs summary. +`configIDs = C_GamePad.GetAllConfigIDs()` + +**Returns:** +- `configIDs` + - *GamePadConfigID* + - `Field` + - `Type` + - `Description` + - `vendorID` + - *number?* + - `productID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetAllDeviceIDs.md b/wiki-information/functions/C_GamePad.GetAllDeviceIDs.md new file mode 100644 index 00000000..0421fa0b --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetAllDeviceIDs.md @@ -0,0 +1,9 @@ +## Title: C_GamePad.GetAllDeviceIDs + +**Content:** +Needs summary. +`deviceIDs = C_GamePad.GetAllDeviceIDs()` + +**Returns:** +- `deviceIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetCombinedDeviceID.md b/wiki-information/functions/C_GamePad.GetCombinedDeviceID.md new file mode 100644 index 00000000..33cd4e90 --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetCombinedDeviceID.md @@ -0,0 +1,9 @@ +## Title: C_GamePad.GetCombinedDeviceID + +**Content:** +Needs summary. +`deviceID = C_GamePad.GetCombinedDeviceID()` + +**Returns:** +- `deviceID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetConfig.md b/wiki-information/functions/C_GamePad.GetConfig.md new file mode 100644 index 00000000..8ea37750 --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetConfig.md @@ -0,0 +1,109 @@ +## Title: C_GamePad.GetConfig + +**Content:** +Needs summary. +`config = C_GamePad.GetConfig(configID)` + +**Parameters:** +- `configID` + - *GamePadConfigID* + +**Returns:** +- `config` + - *GamePadConfig?* + - `Field` + - `Type` + - `Description` + - `comment` + - *string?* + - `name` + - *string?* + - `configID` + - *GamePadConfigID* + - `labelStyle` + - *string?* + - `rawButtonMappings` + - *GamePadRawButtonMapping* + - `rawAxisMappings` + - *GamePadRawAxisMapping* + - `axisConfigs` + - *GamePadAxisConfig* + - `stickConfigs` + - *GamePadStickConfig* + +**GamePadConfigID:** +- `Field` +- `Type` +- `Description` +- `vendorID` + - *number?* +- `productID` + - *number?* + +**GamePadRawButtonMapping:** +- `Field` +- `Type` +- `Description` +- `rawIndex` + - *number* +- `button` + - *string?* +- `axis` + - *string?* +- `axisValue` + - *number?* +- `comment` + - *string?* + +**GamePadRawAxisMapping:** +- `Field` +- `Type` +- `Description` +- `rawIndex` + - *number* +- `axis` + - *string?* +- `comment` + - *string?* + +**GamePadAxisConfig:** +- `Field` +- `Type` +- `Description` +- `axis` + - *string* +- `shift` + - *number?* +- `scale` + - *number?* +- `deadzone` + - *number?* +- `buttonThreshold` + - *number?* +- `buttonPos` + - *string?* +- `buttonNeg` + - *string?* +- `comment` + - *string?* + +**GamePadStickConfig:** +- `Field` +- `Type` +- `Description` +- `stick` + - *string* +- `axisX` + - *string?* +- `axisY` + - *string?* +- `deadzone` + - *number?* +- `deadzoneX` + - *number?* +- `deadzoneY` + - *number?* +- `comment` + - *string?* + +**Added in 9.1.5** \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetDeviceMappedState.md b/wiki-information/functions/C_GamePad.GetDeviceMappedState.md new file mode 100644 index 00000000..464e39d4 --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetDeviceMappedState.md @@ -0,0 +1,41 @@ +## Title: C_GamePad.GetDeviceMappedState + +**Content:** +Needs summary. +`state = C_GamePad.GetDeviceMappedState()` + +**Parameters:** +- `deviceID` + - *number?* + +**Returns:** +- `state` + - *GamePadMappedState?* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `labelStyle` + - *string* + - `buttonCount` + - *number* + - `axisCount` + - *number* + - `stickCount` + - *number* + - `buttons` + - *boolean* + - `axes` + - *number* + - `sticks` + - *GamePadStick* + - `Field` + - `Type` + - `Description` + - `x` + - *number* + - `y` + - *number* + - `len` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetDeviceRawState.md b/wiki-information/functions/C_GamePad.GetDeviceRawState.md new file mode 100644 index 00000000..7b3c75e5 --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetDeviceRawState.md @@ -0,0 +1,30 @@ +## Title: C_GamePad.GetDeviceRawState + +**Content:** +Needs summary. +`rawState = C_GamePad.GetDeviceRawState(deviceID)` + +**Parameters:** +- `deviceID` + - *number* + +**Returns:** +- `rawState` + - *GamePadRawState?* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `vendorID` + - *number* + - `productID` + - *number* + - `rawButtonCount` + - *number* + - `rawAxisCount` + - *number* + - `rawButtons` + - *boolean* + - `rawAxes` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetLedColor.md b/wiki-information/functions/C_GamePad.GetLedColor.md new file mode 100644 index 00000000..5eb1eaec --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetLedColor.md @@ -0,0 +1,9 @@ +## Title: C_GamePad.GetLedColor + +**Content:** +Needs summary. +`color = C_GamePad.GetLedColor()` + +**Returns:** +- `color` + - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetPowerLevel.md b/wiki-information/functions/C_GamePad.GetPowerLevel.md new file mode 100644 index 00000000..c0a728db --- /dev/null +++ b/wiki-information/functions/C_GamePad.GetPowerLevel.md @@ -0,0 +1,28 @@ +## Title: C_GamePad.GetPowerLevel + +**Content:** +Needs summary. +`powerLevel = C_GamePad.GetPowerLevel()` + +**Parameters:** +- `deviceID` + - *number?* + +**Returns:** +- `powerLevel` + - *GamePadPowerLevel* + - `Value` + - `Field` + - `Description` + - `0` + - Critical + - `1` + - Low + - `2` + - Medium + - `3` + - High + - `4` + - Wired + - `5` + - Unknown \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.IsEnabled.md b/wiki-information/functions/C_GamePad.IsEnabled.md new file mode 100644 index 00000000..a1cb17d6 --- /dev/null +++ b/wiki-information/functions/C_GamePad.IsEnabled.md @@ -0,0 +1,15 @@ +## Title: C_GamePad.IsEnabled + +**Content:** +Returns true if gamepad support is enabled on this system. +`enabled = C_GamePad.IsEnabled()` + +**Returns:** +- `enabled` + - *boolean* - True if gamepad support is enabled. + +**Example Usage:** +This function can be used to check if the gamepad support is enabled before attempting to bind gamepad controls or display gamepad-specific UI elements. + +**Addons:** +Large addons like ConsolePort use this function to determine if they should initialize gamepad-specific features and configurations. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.SetConfig.md b/wiki-information/functions/C_GamePad.SetConfig.md new file mode 100644 index 00000000..b1368656 --- /dev/null +++ b/wiki-information/functions/C_GamePad.SetConfig.md @@ -0,0 +1,103 @@ +## Title: C_GamePad.SetConfig + +**Content:** +Needs summary. +`C_GamePad.SetConfig(config)` + +**Parameters:** +- `config` + - *GamePadConfig* + - `Field` + - `Type` + - `Description` + - `comment` + - *string?* + - `name` + - *string?* + - `configID` + - *GamePadConfigID* + - `labelStyle` + - *string?* + - `rawButtonMappings` + - *GamePadRawButtonMapping* + - `rawAxisMappings` + - *GamePadRawAxisMapping* + - `axisConfigs` + - *GamePadAxisConfig* + - `stickConfigs` + - *GamePadStickConfig* + +**GamePadConfigID:** +- `Field` +- `Type` +- `Description` +- `vendorID` + - *number?* +- `productID` + - *number?* + +**GamePadRawButtonMapping:** +- `Field` +- `Type` +- `Description` +- `rawIndex` + - *number* +- `button` + - *string?* +- `axis` + - *string?* +- `axisValue` + - *number?* +- `comment` + - *string?* + +**GamePadRawAxisMapping:** +- `Field` +- `Type` +- `Description` +- `rawIndex` + - *number* +- `axis` + - *string?* +- `comment` + - *string?* + +**GamePadAxisConfig:** +- `Field` +- `Type` +- `Description` +- `axis` + - *string* +- `shift` + - *number?* +- `scale` + - *number?* +- `deadzone` + - *number?* +- `buttonThreshold` + - *number?* +- `buttonPos` + - *string?* +- `buttonNeg` + - *string?* +- `comment` + - *string?* + +**GamePadStickConfig:** +- `Field` +- `Type` +- `Description` +- `stick` + - *string* +- `axisX` + - *string?* +- `axisY` + - *string?* +- `deadzone` + - *number?* +- `deadzoneX` + - *number?* (Added in 9.1.5) +- `deadzoneY` + - *number?* (Added in 9.1.5) +- `comment` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.SetLedColor.md b/wiki-information/functions/C_GamePad.SetLedColor.md new file mode 100644 index 00000000..511dcc79 --- /dev/null +++ b/wiki-information/functions/C_GamePad.SetLedColor.md @@ -0,0 +1,9 @@ +## Title: C_GamePad.SetLedColor + +**Content:** +Needs summary. +`C_GamePad.SetLedColor(color)` + +**Parameters:** +- `color` + - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.SetVibration.md b/wiki-information/functions/C_GamePad.SetVibration.md new file mode 100644 index 00000000..24d73e6b --- /dev/null +++ b/wiki-information/functions/C_GamePad.SetVibration.md @@ -0,0 +1,19 @@ +## Title: C_GamePad.SetVibration + +**Content:** +Makes the gamepad vibrate. +`C_GamePad.SetVibration(vibrationType, intensity)` + +**Parameters:** +- `vibrationType` + - *string* +- `intensity` + - *number* + +**Description:** +Vibration duration lasts for around 1 second. +"Trigger" type vibrations appear to be only supported by the PS5 controller, as trigger haptic vibration. + +**Usage:** +Vibrates the gamepad at 100% intensity. +`C_GamePad.SetVibration("High", 1)` \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.StickIndexToConfigName.md b/wiki-information/functions/C_GamePad.StickIndexToConfigName.md new file mode 100644 index 00000000..2d6dd491 --- /dev/null +++ b/wiki-information/functions/C_GamePad.StickIndexToConfigName.md @@ -0,0 +1,13 @@ +## Title: C_GamePad.StickIndexToConfigName + +**Content:** +Needs summary. +`configName = C_GamePad.StickIndexToConfigName(stickIndex)` + +**Parameters:** +- `stickIndex` + - *number* + +**Returns:** +- `configName` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.StopVibration.md b/wiki-information/functions/C_GamePad.StopVibration.md new file mode 100644 index 00000000..e32f0d9a --- /dev/null +++ b/wiki-information/functions/C_GamePad.StopVibration.md @@ -0,0 +1,19 @@ +## Title: C_GamePad.StopVibration + +**Content:** +Needs summary. +`C_GamePad.StopVibration()` + +**Example Usage:** +This function can be used to stop any ongoing vibration on a gamepad. For instance, if a game event triggers a vibration and you want to stop it after a certain condition is met, you can call this function. + +**Example:** +```lua +-- Example of stopping gamepad vibration after a certain event +if event == "PLAYER_DEAD" then + C_GamePad.StopVibration() +end +``` + +**Addons:** +While there are no specific large addons known to use this function extensively, it can be useful in custom addons that provide enhanced gamepad support or custom gamepad feedback mechanisms. \ No newline at end of file diff --git a/wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md b/wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md new file mode 100644 index 00000000..a25fc656 --- /dev/null +++ b/wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md @@ -0,0 +1,9 @@ +## Title: C_GameRules.IsSelfFoundAllowed + +**Content:** +Needs summary. +`active = C_GameRules.IsSelfFoundAllowed()` + +**Returns:** +- `active` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.CloseGossip.md b/wiki-information/functions/C_GossipInfo.CloseGossip.md new file mode 100644 index 00000000..107a1cac --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.CloseGossip.md @@ -0,0 +1,11 @@ +## Title: C_GossipInfo.CloseGossip + +**Content:** +Closes the gossip window. +`C_GossipInfo.CloseGossip()` + +**Example Usage:** +This function can be used in a script or addon to automatically close the gossip window after interacting with an NPC. For instance, if you have an addon that automates quest acceptance and completion, you might use `C_GossipInfo.CloseGossip()` to close the gossip window once the interaction is complete. + +**Addons Using This Function:** +Many quest automation addons, such as "AutoTurnIn" and "QuickQuest," use this function to streamline the questing process by automatically closing the gossip window after accepting or completing quests. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.ForceGossip.md b/wiki-information/functions/C_GossipInfo.ForceGossip.md new file mode 100644 index 00000000..10287b88 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.ForceGossip.md @@ -0,0 +1,12 @@ +## Title: C_GossipInfo.ForceGossip + +**Content:** +Returns true if gossip text must be displayed. For example, making this return true shows the Banker gossip. +`forceGossip = C_GossipInfo.ForceGossip()` + +**Returns:** +- `forceGossip` + - *boolean* + +**Description:** +When this is made to return true, gossip text will no longer be skipped if there is only one non-gossip option. For example, when speaking to the Banker. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetActiveQuests.md b/wiki-information/functions/C_GossipInfo.GetActiveQuests.md new file mode 100644 index 00000000..5a27d770 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetActiveQuests.md @@ -0,0 +1,30 @@ +## Title: C_GossipInfo.GetActiveQuests + +**Content:** +Returns the quests which can be turned in at a quest giver. +`info = C_GossipInfo.GetActiveQuests()` + +**Returns:** +- `info` + - *GossipQuestUIInfo* + - `Field` + - `Type` + - `Description` + - `title` + - *string* + - `questLevel` + - *number* + - `isTrivial` + - *boolean* + - `frequency` + - *number?* + - `repeatable` + - *boolean?* + - `isComplete` + - *boolean?* + - `isLegendary` + - *boolean* + - `isIgnored` + - *boolean* + - `questID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetAvailableQuests.md b/wiki-information/functions/C_GossipInfo.GetAvailableQuests.md new file mode 100644 index 00000000..454f7e1b --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetAvailableQuests.md @@ -0,0 +1,34 @@ +## Title: C_GossipInfo.GetAvailableQuests + +**Content:** +Returns the available quests at a quest giver. +`info = C_GossipInfo.GetAvailableQuests()` + +**Returns:** +- `info` + - *GossipQuestUIInfo* + - `Field` + - `Type` + - `Description` + - `title` + - *string* + - `questLevel` + - *number* + - `isTrivial` + - *boolean* + - `frequency` + - *number?* + - `repeatable` + - *boolean?* + - `isComplete` + - *boolean?* + - `isLegendary` + - *boolean* + - `isIgnored` + - *boolean* + - `questID` + - *number* + +**Description:** +Available quests are quests that the player does not yet have in their quest log. +This list is available after `GOSSIP_SHOW` has fired. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md b/wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md new file mode 100644 index 00000000..cd5e09c2 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md @@ -0,0 +1,9 @@ +## Title: C_GossipInfo.GetCompletedOptionDescriptionString + +**Content:** +Needs summary. +`description = C_GossipInfo.GetCompletedOptionDescriptionString()` + +**Returns:** +- `description` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md b/wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md new file mode 100644 index 00000000..b4be0e5d --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md @@ -0,0 +1,9 @@ +## Title: C_GossipInfo.GetCustomGossipDescriptionString + +**Content:** +Needs summary. +`description = C_GossipInfo.GetCustomGossipDescriptionString()` + +**Returns:** +- `description` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md b/wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md new file mode 100644 index 00000000..1ac9b12c --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md @@ -0,0 +1,38 @@ +## Title: C_GossipInfo.GetFriendshipReputation + +**Content:** +Needs summary. +`reputationInfo = C_GossipInfo.GetFriendshipReputation(friendshipFactionID)` + +**Parameters:** +- `friendshipFactionID` + - *number* + +**Returns:** +- `reputationInfo` + - *FriendshipReputationInfo* + - `Field` + - `Type` + - `Description` + - `friendshipFactionID` + - *number* + - `standing` + - *number* + - `maxRep` + - *number* + - `name` + - *string?* + - `text` + - *string* + - `texture` + - *number* + - `reaction` + - *string* + - `reactionThreshold` + - *number* + - `nextThreshold` + - *number?* + - `reversedColor` + - *boolean* + - `overrideColor` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md b/wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md new file mode 100644 index 00000000..944faaa7 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md @@ -0,0 +1,20 @@ +## Title: C_GossipInfo.GetFriendshipReputationRanks + +**Content:** +Needs summary. +`rankInfo = C_GossipInfo.GetFriendshipReputationRanks(friendshipFactionID)` + +**Parameters:** +- `friendshipFactionID` + - *number* + +**Returns:** +- `rankInfo` + - *FriendshipReputationRankInfo* + - `Field` + - `Type` + - `Description` + - `currentLevel` + - *number* + - `maxLevel` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md b/wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md new file mode 100644 index 00000000..6c3f23c9 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md @@ -0,0 +1,12 @@ +## Title: C_GossipInfo.GetNumActiveQuests + +**Content:** +Returns the number of active quests that you should eventually turn in to this NPC. +`numQuests = C_GossipInfo.GetNumActiveQuests()` + +**Returns:** +- `numQuests` + - *number* + +**Description:** +This information is available when the `GOSSIP_SHOW` event fires. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md b/wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md new file mode 100644 index 00000000..a6ed7a8b --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md @@ -0,0 +1,15 @@ +## Title: C_GossipInfo.GetNumAvailableQuests + +**Content:** +Returns the number of quests (that you are not already on) offered by this NPC. +`numQuests = C_GossipInfo.GetNumAvailableQuests()` + +**Returns:** +- `numQuests` + - *number* + +**Example Usage:** +This function can be used in an addon to determine how many new quests an NPC is offering to the player. For instance, an addon could use this to display a notification or update a UI element indicating the number of available quests when interacting with an NPC. + +**Addon Usage:** +Large addons like Questie or Storyline might use this function to enhance the questing experience by providing additional information about available quests directly in the game's interface. Questie, for example, could use this to mark NPCs on the map that have new quests available for the player. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetOptions.md b/wiki-information/functions/C_GossipInfo.GetOptions.md new file mode 100644 index 00000000..4dbe1dcd --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetOptions.md @@ -0,0 +1,94 @@ +## Title: C_GossipInfo.GetOptions + +**Content:** +Returns the available gossip options at a quest giver. +`info = C_GossipInfo.GetOptions()` + +**Returns:** +- `info` + - *GossipOptionUIInfo* + - `Field` + - `Type` + - `Description` + - `gossipOptionID` + - *number?* - This can be nil to avoid automation + - `name` + - *string* - Text of the gossip item + - `icon` + - *number : fileID* - Icon of the gossip type + - `rewards` + - *GossipOptionRewardInfo* + - `status` + - *Enum.GossipOptionStatus* + - `spellID` + - *number?* + - `flags` + - *number* + - `overrideIconID` + - *number? : fileID* + - `selectOptionWhenOnlyOption` + - *boolean* + - `orderIndex` + - *number* + +- `GossipOptionRewardInfo` + - `Field` + - `Type` + - `Description` + - `id` + - *number* + - `quantity` + - *number* + - `rewardType` + - *Enum.GossipOptionRewardType* + +- `Enum.GossipOptionRewardType` + - `Value` + - `Field` + - `Description` + - `0` + - *Item* + - `1` + - *Currency* + +- `Enum.GossipOptionStatus` + - `Value` + - `Field` + - `Description` + - `0` + - *Available* + - `1` + - *Unavailable* + - `2` + - *Locked* + - `3` + - *AlreadyComplete* + +**Description:** +Related Events: +- `GOSSIP_SHOW` + +Related API: +- `C_GossipInfo.SelectOption` +- `C_GossipInfo.SelectOptionByIndex` +- `C_GossipInfo.SelectActiveQuest` +- `C_GossipInfo.SelectAvailableQuest` + +**Usage:** +Prints gossip options and automatically selects the vendor gossip when e.g. at an innkeeper. +```lua +local function OnEvent(self, event) + local info = C_GossipInfo.GetOptions() + for i, v in pairs(info) do + print(i, v.icon, v.name, v.gossipOptionID) + if v.icon == 132060 then -- interface/gossipframe/vendorgossipicon.blp + print("Selecting vendor gossip option.") + C_GossipInfo.SelectOption(v.gossipOptionID) + end + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("GOSSIP_SHOW") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md b/wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md new file mode 100644 index 00000000..27531865 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md @@ -0,0 +1,13 @@ +## Title: C_GossipInfo.GetPoiForUiMapID + +**Content:** +Returns any gossip point of interest on the map. +`gossipPoiID = C_GossipInfo.GetPoiForUiMapID(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `gossipPoiID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetPoiInfo.md b/wiki-information/functions/C_GossipInfo.GetPoiInfo.md new file mode 100644 index 00000000..9b453515 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetPoiInfo.md @@ -0,0 +1,26 @@ +## Title: C_GossipInfo.GetPoiInfo + +**Content:** +Returns info for a gossip point of interest (e.g. the red flags when asking city guards for directions). +`gossipPoiInfo = C_GossipInfo.GetPoiInfo(uiMapID, gossipPoiID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID +- `gossipPoiID` + - *number* + +**Returns:** +- `gossipPoiInfo` + - *GossipPoiInfo?* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `textureIndex` + - *number* - Used for `GetPOITextureCoords()` + - `position` + - *Vector2DMixin* + - `inBattleMap` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetText.md b/wiki-information/functions/C_GossipInfo.GetText.md new file mode 100644 index 00000000..25161237 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.GetText.md @@ -0,0 +1,12 @@ +## Title: C_GossipInfo.GetText + +**Content:** +Returns the gossip text. +`gossipText = C_GossipInfo.GetText()` + +**Returns:** +- `gossipText` + - *string* + +**Description:** +Available when GOSSIP_SHOW fires. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectActiveQuest.md b/wiki-information/functions/C_GossipInfo.SelectActiveQuest.md new file mode 100644 index 00000000..f08ff1a1 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.SelectActiveQuest.md @@ -0,0 +1,15 @@ +## Title: C_GossipInfo.SelectActiveQuest + +**Content:** +Selects an active quest from the gossip window. +`C_GossipInfo.SelectActiveQuest(optionID)` + +**Parameters:** +- `optionID` + - *number* - questID from `C_GossipInfo.GetActiveQuests` + +**Example Usage:** +This function can be used in an addon to automate the selection of active quests from NPCs that offer multiple quests. For instance, if an NPC offers several quests and you want to programmatically select a specific one, you can use this function. + +**Addon Usage:** +Large addons like **Questie** or **Zygor Guides** might use this function to streamline quest interactions, ensuring that the correct quest is selected without user intervention. This can be particularly useful in questing guides or automation scripts where minimizing user input is desired. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md b/wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md new file mode 100644 index 00000000..53ab0e80 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md @@ -0,0 +1,15 @@ +## Title: C_GossipInfo.SelectAvailableQuest + +**Content:** +Selects an available quest from the gossip window. +`C_GossipInfo.SelectAvailableQuest(optionID)` + +**Parameters:** +- `optionID` + - *number* - questID from `C_GossipInfo.GetAvailableQuests` + +**Example Usage:** +This function can be used in an addon to automate the selection of available quests from NPCs. For instance, an addon designed to streamline questing might use this function to automatically pick up all available quests from an NPC when the player interacts with them. + +**Addons Using This Function:** +- **Questie**: A popular quest helper addon that provides quest information and tracking. It uses this function to automate the process of accepting quests from NPCs, making the questing experience more efficient for players. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectOption.md b/wiki-information/functions/C_GossipInfo.SelectOption.md new file mode 100644 index 00000000..27aee227 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.SelectOption.md @@ -0,0 +1,35 @@ +## Title: C_GossipInfo.SelectOption + +**Content:** +Selects a gossip (conversation) option. +`C_GossipInfo.SelectOption(optionID)` + +**Parameters:** +- `optionID` + - *number* - gossipOptionID from `C_GossipInfo.GetOptions()` +- `text` + - *string?* +- `confirmed` + - *boolean?* + +**Usage:** +Prints gossip options and automatically selects the vendor gossip when e.g. at an innkeeper. +```lua +local function OnEvent(self, event) + local info = C_GossipInfo.GetOptions() + for i, v in pairs(info) do + print(i, v.icon, v.name, v.gossipOptionID) + if v.icon == 132060 then -- interface/gossipframe/vendorgossipicon.blp + print("Selecting vendor gossip option.") + C_GossipInfo.SelectOption(v.gossipOptionID) + end + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("GOSSIP_SHOW") +f:SetScript("OnEvent", OnEvent) +``` + +**Reference:** +UI SelectGossipOption - This is an API for players and addon authors to continue to be able to select by index rather than ID. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md b/wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md new file mode 100644 index 00000000..e3cfcaf9 --- /dev/null +++ b/wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md @@ -0,0 +1,19 @@ +## Title: C_GossipInfo.SelectOptionByIndex + +**Content:** +Needs summary. +`C_GossipInfo.SelectOptionByIndex(optionID)` + +**Parameters:** +- `optionID` + - *number* - orderIndex from `C_GossipInfo.GetOptions()` +- `text` + - *string?* +- `confirmed` + - *boolean?* + +**Example Usage:** +This function can be used to programmatically select a gossip option in a conversation with an NPC. For instance, if an NPC offers multiple dialogue options, you can use this function to select a specific option based on its index. + +**Addons:** +Large addons like "Questie" or "Zygor Guides" might use this function to automate quest interactions, allowing the addon to select the appropriate dialogue options without user intervention. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md b/wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md new file mode 100644 index 00000000..dc41361c --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md @@ -0,0 +1,15 @@ +## Title: C_GuildInfo.CanEditOfficerNote + +**Content:** +Returns true if the player can edit guild officer notes. +`canEditOfficerNote = C_GuildInfo.CanEditOfficerNote()` + +**Returns:** +- `canEditOfficerNote` + - *boolean* - true if the player can edit guild officer notes + +**Example Usage:** +This function can be used in an addon to check if the player has the necessary permissions to edit officer notes in the guild. For instance, an addon that manages guild information might use this function to enable or disable the UI elements for editing officer notes based on the player's permissions. + +**Addons:** +Large addons like "Guild Roster Manager" might use this function to determine if the player can edit officer notes and provide appropriate functionalities based on that permission. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md b/wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md new file mode 100644 index 00000000..64c26589 --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md @@ -0,0 +1,15 @@ +## Title: C_GuildInfo.CanSpeakInGuildChat + +**Content:** +Returns true if the player can use guild chat. +`canSpeakInGuildChat = C_GuildInfo.CanSpeakInGuildChat()` + +**Returns:** +- `canSpeakInGuildChat` + - *boolean* - true if the player can use guild chat + +**Example Usage:** +This function can be used to check if a player has the necessary permissions to send messages in the guild chat. For instance, an addon could use this to enable or disable guild chat-related features based on the player's permissions. + +**Addons:** +Large addons like "ElvUI" or "Prat" might use this function to manage chat functionalities, ensuring that guild chat options are only available to players who have the permission to use them. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md b/wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md new file mode 100644 index 00000000..f9f322a4 --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md @@ -0,0 +1,9 @@ +## Title: C_GuildInfo.CanViewOfficerNote + +**Content:** +Returns true if the player can view guild officer notes. +`canViewOfficerNote = C_GuildInfo.CanViewOfficerNote()` + +**Returns:** +- `canViewOfficerNote` + - *boolean* - true if the player can view guild officer notes, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md b/wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md new file mode 100644 index 00000000..22682bfb --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md @@ -0,0 +1,13 @@ +## Title: C_GuildInfo.GetGuildRankOrder + +**Content:** +Returns the current rank of a guild member. +`rankOrder = C_GuildInfo.GetGuildRankOrder(guid)` + +**Parameters:** +- `guid` + - *string* + +**Returns:** +- `rankOrder` + - *number* - Starting at 1 (Guild Master) \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md b/wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md new file mode 100644 index 00000000..1af54000 --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md @@ -0,0 +1,33 @@ +## Title: C_GuildInfo.GetGuildTabardInfo + +**Content:** +Needs summary. +`tabardInfo = C_GuildInfo.GetGuildTabardInfo(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `tabardInfo` + - *structure* - GuildTabardInfo (nilable) + - `GuildTabardInfo` + - `Field` + - `Type` + - `Description` + - `backgroundColor` + - *ColorMixin* + - `borderColor` + - *ColorMixin* + - `emblemColor` + - *ColorMixin* + - `emblemFileID` + - *number* - GuildEmblem.db2 + - `emblemStyle` + - *number* + +**Example Usage:** +This function can be used to retrieve the tabard information of a guild, which can be useful for displaying guild tabards in custom UI elements or addons. + +**Addons:** +Large addons like "ElvUI" and "Guild Roster Manager" might use this function to display guild tabard information in their custom guild interfaces. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md b/wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md new file mode 100644 index 00000000..6fccdd7c --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md @@ -0,0 +1,83 @@ +## Title: C_GuildInfo.GuildControlGetRankFlags + +**Content:** +Returns the permission flags for a rank index. +`permissions = C_GuildInfo.GuildControlGetRankFlags(rankOrder)` + +**Parameters:** +- `rankOrder` + - *number* - Starting at 1 (Guild Master) + +**Returns:** +- `permissions` + - *boolean* - table indices ranging from 1 to 21. + - `GUILDCONTROL_OPTION` + - `Index` + - `GlobalString` + - `Name` + - `Description` + - `1` + - `GUILDCONTROL_OPTION1` + - Guildchat Listen + - `2` + - `GUILDCONTROL_OPTION2` + - Guildchat Speak + - `3` + - `GUILDCONTROL_OPTION3` + - Officerchat Listen + - `4` + - `GUILDCONTROL_OPTION4` + - Officerchat Speak + - `5` + - `GUILDCONTROL_OPTION5` + - Promote + - `6` + - `GUILDCONTROL_OPTION6` + - Demote + - `7` + - `GUILDCONTROL_OPTION7` + - Invite Member + - `8` + - `GUILDCONTROL_OPTION8` + - Remove Member + - `9` + - `GUILDCONTROL_OPTION9` + - Set MOTD + - `10` + - `GUILDCONTROL_OPTION10` + - Edit Public Note + - `11` + - `GUILDCONTROL_OPTION11` + - View Officer Note + - `12` + - `GUILDCONTROL_OPTION12` + - Edit Officer Note + - `13` + - `GUILDCONTROL_OPTION13` + - Modify Guild Info + - `14` + - `GUILDCONTROL_OPTION14` + - Create Guild Event + - `15` + - `GUILDCONTROL_OPTION15` + - Guild Bank Repair + - Use guild funds for repairs + - `16` + - `GUILDCONTROL_OPTION16` + - Withdraw Gold + - Withdraw gold from the guild bank + - `17` + - `GUILDCONTROL_OPTION17` + - Create Guild Event + - `18` + - `GUILDCONTROL_OPTION18` + - Requires Authenticator + - `19` + - `GUILDCONTROL_OPTION19` + - Modify Bank Tabs + - `20` + - `GUILDCONTROL_OPTION20` + - Remove Guild Event + - `21` + - `GUILDCONTROL_OPTION21` + - Recruitment \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GuildRoster.md b/wiki-information/functions/C_GuildInfo.GuildRoster.md new file mode 100644 index 00000000..6ddba2df --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.GuildRoster.md @@ -0,0 +1,12 @@ +## Title: C_GuildInfo.GuildRoster + +**Content:** +Requests updated guild roster information from the server. +`C_GuildInfo.GuildRoster()` + +**Description:** +`GUILD_ROSTER_UPDATE` fires when updated (but not necessarily altered) information is received from the server. +The call will be ignored completely if the last `GuildRoster()` call was less than 10 seconds ago (most likely to limit the traffic caused by frequent opening/closing of the guild tab). + +**Reference:** +`GetGuildRosterInfo` \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.IsGuildOfficer.md b/wiki-information/functions/C_GuildInfo.IsGuildOfficer.md new file mode 100644 index 00000000..b9a2c1e1 --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.IsGuildOfficer.md @@ -0,0 +1,9 @@ +## Title: C_GuildInfo.IsGuildOfficer + +**Content:** +Needs summary. +`isOfficer = C_GuildInfo.IsGuildOfficer()` + +**Returns:** +- `isOfficer` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md b/wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md new file mode 100644 index 00000000..9d5c8d44 --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md @@ -0,0 +1,15 @@ +## Title: C_GuildInfo.IsGuildRankAssignmentAllowed + +**Content:** +Needs summary. +`isGuildRankAssignmentAllowed = C_GuildInfo.IsGuildRankAssignmentAllowed(guid, rankOrder)` + +**Parameters:** +- `guid` + - *string* +- `rankOrder` + - *number* - Starting at 1 (Guild Master) + +**Returns:** +- `isGuildRankAssignmentAllowed` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.MemberExistsByName.md b/wiki-information/functions/C_GuildInfo.MemberExistsByName.md new file mode 100644 index 00000000..0c96cf05 --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.MemberExistsByName.md @@ -0,0 +1,13 @@ +## Title: C_GuildInfo.MemberExistsByName + +**Content:** +Needs summary. +`exists = C_GuildInfo.MemberExistsByName(name)` + +**Parameters:** +- `name` + - *string* + +**Returns:** +- `exists` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md b/wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md new file mode 100644 index 00000000..9f87e4ab --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md @@ -0,0 +1,17 @@ +## Title: C_GuildInfo.QueryGuildMembersForRecipe + +**Content:** +Needs summary. +`updatedRecipeSpellID = C_GuildInfo.QueryGuildMembersForRecipe(skillLineID, recipeSpellID)` + +**Parameters:** +- `skillLineID` + - *number* +- `recipeSpellID` + - *number* +- `recipeLevel` + - *number?* + +**Returns:** +- `updatedRecipeSpellID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.RemoveFromGuild.md b/wiki-information/functions/C_GuildInfo.RemoveFromGuild.md new file mode 100644 index 00000000..8874473b --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.RemoveFromGuild.md @@ -0,0 +1,18 @@ +## Title: C_GuildInfo.RemoveFromGuild + +**Content:** +Removes a member from the guild. +`C_GuildInfo.RemoveFromGuild(guid)` + +**Parameters:** +- `guid` + - *string* + +**Reference:** +- `GuildUninvite()` + +**Example Usage:** +This function can be used in a guild management addon to automate the removal of inactive or problematic members from the guild. + +**Addon Usage:** +Large guild management addons like "Guild Roster Manager" might use this function to provide guild leaders with tools to manage their guild members efficiently. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md b/wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md new file mode 100644 index 00000000..6635b627 --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md @@ -0,0 +1,11 @@ +## Title: C_GuildInfo.SetGuildRankOrder + +**Content:** +Sets the guild rank for a member. +`C_GuildInfo.SetGuildRankOrder(guid, rankOrder)` + +**Parameters:** +- `guid` + - *string* +- `rankOrder` + - *number* - Starting at 1 (Guild Master) \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.SetNote.md b/wiki-information/functions/C_GuildInfo.SetNote.md new file mode 100644 index 00000000..e369acfa --- /dev/null +++ b/wiki-information/functions/C_GuildInfo.SetNote.md @@ -0,0 +1,16 @@ +## Title: C_GuildInfo.SetNote + +**Content:** +Sets the guild note for a member. +`C_GuildInfo.SetNote(guid, note, isPublic)` + +**Parameters:** +- `guid` + - *string* +- `note` + - *string* +- `isPublic` + - *boolean* + +**Reference:** +GuildRosterSetPublicNote() \ No newline at end of file diff --git a/wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md b/wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md new file mode 100644 index 00000000..4bfde96c --- /dev/null +++ b/wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md @@ -0,0 +1,18 @@ +## Title: C_Heirloom.CanHeirloomUpgradeFromPending + +**Content:** +Returns true if an heirloom can be upgraded by using an upgrade item. +`boolean = C_Heirloom.CanHeirloomUpgradeFromPending(itemID)` + +**Parameters:** +- `itemID` + - *number* - a heirloom itemID + +**Returns:** +- *boolean* + +**Example Usage:** +This function can be used to check if a specific heirloom item can be upgraded before attempting to use an upgrade item on it. This is useful in addons that manage heirloom collections or automate the upgrading process. + +**Addons:** +Large addons like "Altoholic" and "AllTheThings" might use this function to provide users with information about their heirloom items and whether they can be upgraded. \ No newline at end of file diff --git a/wiki-information/functions/C_Heirloom.GetHeirloomInfo.md b/wiki-information/functions/C_Heirloom.GetHeirloomInfo.md new file mode 100644 index 00000000..0bbbf193 --- /dev/null +++ b/wiki-information/functions/C_Heirloom.GetHeirloomInfo.md @@ -0,0 +1,37 @@ +## Title: C_Heirloom.GetHeirloomInfo + +**Content:** +Returns information about a heirloom by itemID. +`name, itemEquipLoc, isPvP, itemTexture, upgradeLevel, source, searchFiltered, effectiveLevel, minLevel, maxLevel = C_Heirloom.GetHeirloomInfo(itemID)` + +**Parameters:** +- `itemID` + - *number* - a heirloom itemID + +**Returns:** +- `name` + - *string* - false if not a heirloom item +- `itemEquipLoc` + - *string* +- `isPvP` + - *boolean* +- `itemTexture` + - *string* +- `upgradeLevel` + - *number* +- `source` + - *number* - heirloom source index +- `searchFiltered` + - *boolean* +- `effectiveLevel` + - *number* +- `minLevel` + - *number* +- `maxLevel` + - *number* + +**Example Usage:** +This function can be used to retrieve detailed information about a specific heirloom item, which can be useful for addons that manage heirloom collections or display heirloom information to the player. + +**Addons:** +Large addons like "Altoholic" use this function to display heirloom information across multiple characters, helping players keep track of their heirloom collections. \ No newline at end of file diff --git a/wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md b/wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md new file mode 100644 index 00000000..52a01526 --- /dev/null +++ b/wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md @@ -0,0 +1,9 @@ +## Title: C_Heirloom.GetHeirloomItemIDs + +**Content:** +Returns the heirloom item IDs for all classes. +`itemIDs = C_Heirloom.GetHeirloomItemIDs()` + +**Returns:** +- `itemIDs` + - *number* - Heirloom item IDs for all classes. \ No newline at end of file diff --git a/wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md b/wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md new file mode 100644 index 00000000..b34507ca --- /dev/null +++ b/wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md @@ -0,0 +1,12 @@ +## Title: C_InterfaceFileManifest.GetInterfaceArtFiles + +**Content:** +Obtains a list of all interface art file names. +`images = C_InterfaceFileManifest.GetInterfaceArtFiles()` + +**Returns:** +- `images` + - *string?* - A list of file names. + +**Description:** +This function always returns nil inside the FrameXML environment. It only returns a table while on Glue screens such as character selection, where addon code cannot run. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.DoesItemExist.md b/wiki-information/functions/C_Item.DoesItemExist.md new file mode 100644 index 00000000..0997b188 --- /dev/null +++ b/wiki-information/functions/C_Item.DoesItemExist.md @@ -0,0 +1,27 @@ +## Title: C_Item.DoesItemExist + +**Content:** +Needs summary. +```lua +itemExists = C_Item.DoesItemExist(emptiableItemLocation) +itemExists = C_Item.DoesItemExistByID(itemInfo) +``` + +**Parameters:** +- **DoesItemExist:** + - `emptiableItemLocation` + - *ItemLocationMixin* + +- **DoesItemExistByID:** + - `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `itemExists` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific item exists in the game. For instance, it can be useful in inventory management addons to verify if an item is valid before performing operations on it. + +**Addons Using This Function:** +Large addons like **Bagnon** and **ArkInventory** might use this function to ensure that items being displayed or manipulated in the inventory actually exist, preventing errors and improving user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.DoesItemExistByID.md b/wiki-information/functions/C_Item.DoesItemExistByID.md new file mode 100644 index 00000000..71d9e04f --- /dev/null +++ b/wiki-information/functions/C_Item.DoesItemExistByID.md @@ -0,0 +1,19 @@ +## Title: C_Item.DoesItemExist + +**Content:** +Needs summary. +`itemExists = C_Item.DoesItemExist(emptiableItemLocation)` +`itemExists = C_Item.DoesItemExistByID(itemInfo)` + +**Parameters:** +- **DoesItemExist:** + - `emptiableItemLocation` + - *ItemLocationMixin* + +- **DoesItemExistByID:** + - `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `itemExists` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetCurrentItemLevel.md b/wiki-information/functions/C_Item.GetCurrentItemLevel.md new file mode 100644 index 00000000..59fcad5c --- /dev/null +++ b/wiki-information/functions/C_Item.GetCurrentItemLevel.md @@ -0,0 +1,20 @@ +## Title: C_Item.GetCurrentItemLevel + +**Content:** +Needs summary. +`currentItemLevel = C_Item.GetCurrentItemLevel(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin* 🔗 + +**Returns:** +- `currentItemLevel` + - *number?* + +**Example Usage:** +This function can be used to determine the current item level of an item in a specific location, such as a player's inventory or equipped gear. This is particularly useful for addons that need to display or compare item levels. + +**Addon Usage:** +- **Pawn**: This popular addon uses `C_Item.GetCurrentItemLevel` to help players determine which items are upgrades by comparing item levels and other stats. +- **SimulationCraft**: This addon uses the function to export a player's current gear setup, including item levels, for simulation purposes. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemGUID.md b/wiki-information/functions/C_Item.GetItemGUID.md new file mode 100644 index 00000000..b936bb32 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemGUID.md @@ -0,0 +1,13 @@ +## Title: C_Item.GetItemGUID + +**Content:** +Needs summary. +`itemGuid = C_Item.GetItemGUID(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin* 🔗 + +**Returns:** +- `itemGUID` + - *string* - ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemID.md b/wiki-information/functions/C_Item.GetItemID.md new file mode 100644 index 00000000..455bca46 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemID.md @@ -0,0 +1,19 @@ +## Title: C_Item.GetItemID + +**Content:** +Needs summary. +`itemID = C_Item.GetItemID(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin*🔗 + +**Returns:** +- `itemID` + - *number* + +**Example Usage:** +This function can be used to retrieve the unique item ID of an item located in a specific inventory slot. For instance, if you want to get the item ID of the item equipped in the main hand slot, you can use this function with the appropriate `ItemLocationMixin`. + +**Addons:** +Many large addons, such as TradeSkillMaster (TSM), use this function to identify items in the player's inventory or bank to manage auctions, inventory, and crafting operations. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemIDForItemInfo.md b/wiki-information/functions/C_Item.GetItemIDForItemInfo.md new file mode 100644 index 00000000..81e5fc74 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemIDForItemInfo.md @@ -0,0 +1,25 @@ +## Title: C_Item.GetItemIDForItemInfo + +**Content:** +Needs summary. +`itemID = C_Item.GetItemIDForItemInfo(itemInfo)` + +**Parameters:** +- `itemInfo` + - *number|string* + +**Returns:** +- `itemID` + - *number* + +**Description:** +This function retrieves the item ID for a given item information input, which can be either an item ID or an item link. + +**Example Usage:** +```lua +local itemID = C_Item.GetItemIDForItemInfo("item:168185::::::::120:253::13::::") -- Returns the item ID for the given item link +print(itemID) -- Output: 168185 +``` + +**Use in Addons:** +Many addons that deal with item management, such as inventory or auction house addons, use this function to convert item links or other item information into a standardized item ID for further processing. For example, the popular addon "Auctioneer" might use this function to identify items for auction data analysis. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemIcon.md b/wiki-information/functions/C_Item.GetItemIcon.md new file mode 100644 index 00000000..c5b5f0b4 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemIcon.md @@ -0,0 +1,31 @@ +## Title: C_Item.GetItemIcon + +**Content:** +Needs summary. +```lua +icon = C_Item.GetItemIcon(itemLocation) +icon = C_Item.GetItemIconByID(itemInfo) +``` + +**Parameters:** + +*GetItemIcon:* +- `itemLocation` + - *ItemLocationMixin* + +*GetItemIconByID:* +- `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `icon` + - *number?* : FileID + +**Reference:** +- `GetItemIcon()` + +**Example Usage:** +This function can be used to retrieve the icon of an item, which can be useful for displaying item icons in custom UI elements or addons. + +**Addon Usage:** +Large addons like **WeakAuras** and **ElvUI** might use this function to display item icons dynamically based on the player's inventory or equipment. For instance, WeakAuras could use it to show an icon of a specific item when certain conditions are met, enhancing the visual feedback for players. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemIconByID.md b/wiki-information/functions/C_Item.GetItemIconByID.md new file mode 100644 index 00000000..a0af8bc6 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemIconByID.md @@ -0,0 +1,31 @@ +## Title: C_Item.GetItemIcon + +**Content:** +Needs summary. +```lua +icon = C_Item.GetItemIcon(itemLocation) +icon = C_Item.GetItemIconByID(itemInfo) +``` + +**Parameters:** + +*GetItemIcon:* +- `itemLocation` + - *ItemLocationMixin* + +*GetItemIconByID:* +- `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `icon` + - *number?* : FileID + +**Reference:** +- `GetItemIcon()` + +**Example Usage:** +This function can be used to retrieve the icon of an item, which can be useful for displaying item icons in custom UI elements or addons. + +**Addon Usage:** +Large addons like **WeakAuras** and **ElvUI** use this function to display item icons dynamically based on the player's inventory or equipment. For example, WeakAuras might use it to show an icon of a specific item when certain conditions are met, enhancing the visual feedback for players. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemInventoryType.md b/wiki-information/functions/C_Item.GetItemInventoryType.md new file mode 100644 index 00000000..3c3405ad --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemInventoryType.md @@ -0,0 +1,163 @@ +## Title: C_Item.GetItemInventoryType + +**Content:** +Needs summary. +`inventoryType = C_Item.GetItemInventoryType(itemLocation)` +`inventoryType = C_Item.GetItemInventoryTypeByID(itemInfo)` + +**Parameters:** +- **GetItemInventoryType:** + - `itemLocation` + - *ItemLocationMixin* + +- **GetItemInventoryTypeByID:** + - `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `inventoryType` + - *Enum.InventoryType* + - **Value** + - **Field** + - **ItemEquipLocGlobalString (enUS)** + - **InvSlotId** + - `0` + - **IndexNonEquipType** + - `INVTYPE_NON_EQUIP` + - Non-equippable + - `1` + - **IndexHeadType** + - `INVTYPE_HEAD` + - Head + - `2` + - **IndexNeckType** + - `INVTYPE_NECK` + - Neck + - `3` + - **IndexShoulderType** + - `INVTYPE_SHOULDER` + - Shoulder + - `4` + - **IndexBodyType** + - `INVTYPE_BODY` + - Shirt + - `5` + - **IndexChestType** + - `INVTYPE_CHEST` + - Chest + - `6` + - **IndexWaistType** + - `INVTYPE_WAIST` + - Waist + - `7` + - **IndexLegsType** + - `INVTYPE_LEGS` + - Legs + - `8` + - **IndexFeetType** + - `INVTYPE_FEET` + - Feet + - `9` + - **IndexWristType** + - `INVTYPE_WRIST` + - Wrist + - `10` + - **IndexHandType** + - `INVTYPE_HAND` + - Hands + - `11` + - **IndexFingerType** + - `INVTYPE_FINGER` + - Finger + - `12` + - **IndexTrinketType** + - `INVTYPE_TRINKET` + - Trinket + - `13` + - **IndexWeaponType** + - `INVTYPE_WEAPON` + - One-Hand + - `14` + - **IndexShieldType** + - `INVTYPE_SHIELD` + - Off Hand + - `15` + - **IndexRangedType** + - `INVTYPE_RANGED` + - Ranged + - `16` + - **IndexCloakType** + - `INVTYPE_CLOAK` + - Back + - `17` + - **Index2HweaponType** + - `INVTYPE_2HWEAPON` + - Two-Hand + - `18` + - **IndexBagType** + - `INVTYPE_BAG` + - Bag + - `19` + - **IndexTabardType** + - `INVTYPE_TABARD` + - Tabard + - `20` + - **IndexRobeType** + - `INVTYPE_ROBE` + - Chest + - `21` + - **IndexWeaponmainhandType** + - `INVTYPE_WEAPONMAINHAND` + - Main Hand + - `22` + - **IndexWeaponoffhandType** + - `INVTYPE_WEAPONOFFHAND` + - Off Hand + - `23` + - **IndexHoldableType** + - `INVTYPE_HOLDABLE` + - Held In Off-hand + - `24` + - **IndexAmmoType** + - `INVTYPE_AMMO` + - Ammo + - `25` + - **IndexThrownType** + - `INVTYPE_THROWN` + - Thrown + - `26` + - **IndexRangedrightType** + - `INVTYPE_RANGEDRIGHT` + - Ranged + - `27` + - **IndexQuiverType** + - `INVTYPE_QUIVER` + - Quiver + - `28` + - **IndexRelicType** + - `INVTYPE_RELIC` + - Relic + - `29` + - **IndexProfessionToolType** + - `INVTYPE_PROFESSION_TOOL` + - Profession Tool + - `30` + - **IndexProfessionGearType** + - `INVTYPE_PROFESSION_GEAR` + - Profession Equipment + - `31` + - **IndexEquipablespellOffensiveType** + - `INVTYPE_EQUIPABLESPELL_OFFENSIVE` + - Equipable Spell - Offensive + - `32` + - **IndexEquipablespellUtilityType** + - `INVTYPE_EQUIPABLESPELL_UTILITY` + - Equipable Spell - Utility + - `33` + - **IndexEquipablespellDefensiveType** + - `INVTYPE_EQUIPABLESPELL_DEFENSIVE` + - Equipable Spell - Defensive + - `34` + - **IndexEquipablespellWeaponType** + - `INVTYPE_EQUIPABLESPELL_WEAPON` + - Equipable Spell - Weapon \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemInventoryTypeByID.md b/wiki-information/functions/C_Item.GetItemInventoryTypeByID.md new file mode 100644 index 00000000..3c3405ad --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemInventoryTypeByID.md @@ -0,0 +1,163 @@ +## Title: C_Item.GetItemInventoryType + +**Content:** +Needs summary. +`inventoryType = C_Item.GetItemInventoryType(itemLocation)` +`inventoryType = C_Item.GetItemInventoryTypeByID(itemInfo)` + +**Parameters:** +- **GetItemInventoryType:** + - `itemLocation` + - *ItemLocationMixin* + +- **GetItemInventoryTypeByID:** + - `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `inventoryType` + - *Enum.InventoryType* + - **Value** + - **Field** + - **ItemEquipLocGlobalString (enUS)** + - **InvSlotId** + - `0` + - **IndexNonEquipType** + - `INVTYPE_NON_EQUIP` + - Non-equippable + - `1` + - **IndexHeadType** + - `INVTYPE_HEAD` + - Head + - `2` + - **IndexNeckType** + - `INVTYPE_NECK` + - Neck + - `3` + - **IndexShoulderType** + - `INVTYPE_SHOULDER` + - Shoulder + - `4` + - **IndexBodyType** + - `INVTYPE_BODY` + - Shirt + - `5` + - **IndexChestType** + - `INVTYPE_CHEST` + - Chest + - `6` + - **IndexWaistType** + - `INVTYPE_WAIST` + - Waist + - `7` + - **IndexLegsType** + - `INVTYPE_LEGS` + - Legs + - `8` + - **IndexFeetType** + - `INVTYPE_FEET` + - Feet + - `9` + - **IndexWristType** + - `INVTYPE_WRIST` + - Wrist + - `10` + - **IndexHandType** + - `INVTYPE_HAND` + - Hands + - `11` + - **IndexFingerType** + - `INVTYPE_FINGER` + - Finger + - `12` + - **IndexTrinketType** + - `INVTYPE_TRINKET` + - Trinket + - `13` + - **IndexWeaponType** + - `INVTYPE_WEAPON` + - One-Hand + - `14` + - **IndexShieldType** + - `INVTYPE_SHIELD` + - Off Hand + - `15` + - **IndexRangedType** + - `INVTYPE_RANGED` + - Ranged + - `16` + - **IndexCloakType** + - `INVTYPE_CLOAK` + - Back + - `17` + - **Index2HweaponType** + - `INVTYPE_2HWEAPON` + - Two-Hand + - `18` + - **IndexBagType** + - `INVTYPE_BAG` + - Bag + - `19` + - **IndexTabardType** + - `INVTYPE_TABARD` + - Tabard + - `20` + - **IndexRobeType** + - `INVTYPE_ROBE` + - Chest + - `21` + - **IndexWeaponmainhandType** + - `INVTYPE_WEAPONMAINHAND` + - Main Hand + - `22` + - **IndexWeaponoffhandType** + - `INVTYPE_WEAPONOFFHAND` + - Off Hand + - `23` + - **IndexHoldableType** + - `INVTYPE_HOLDABLE` + - Held In Off-hand + - `24` + - **IndexAmmoType** + - `INVTYPE_AMMO` + - Ammo + - `25` + - **IndexThrownType** + - `INVTYPE_THROWN` + - Thrown + - `26` + - **IndexRangedrightType** + - `INVTYPE_RANGEDRIGHT` + - Ranged + - `27` + - **IndexQuiverType** + - `INVTYPE_QUIVER` + - Quiver + - `28` + - **IndexRelicType** + - `INVTYPE_RELIC` + - Relic + - `29` + - **IndexProfessionToolType** + - `INVTYPE_PROFESSION_TOOL` + - Profession Tool + - `30` + - **IndexProfessionGearType** + - `INVTYPE_PROFESSION_GEAR` + - Profession Equipment + - `31` + - **IndexEquipablespellOffensiveType** + - `INVTYPE_EQUIPABLESPELL_OFFENSIVE` + - Equipable Spell - Offensive + - `32` + - **IndexEquipablespellUtilityType** + - `INVTYPE_EQUIPABLESPELL_UTILITY` + - Equipable Spell - Utility + - `33` + - **IndexEquipablespellDefensiveType** + - `INVTYPE_EQUIPABLESPELL_DEFENSIVE` + - Equipable Spell - Defensive + - `34` + - **IndexEquipablespellWeaponType** + - `INVTYPE_EQUIPABLESPELL_WEAPON` + - Equipable Spell - Weapon \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemLink.md b/wiki-information/functions/C_Item.GetItemLink.md new file mode 100644 index 00000000..e858438d --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemLink.md @@ -0,0 +1,13 @@ +## Title: C_Item.GetItemLink + +**Content:** +Needs summary. +`itemLink = C_Item.GetItemLink(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin* 🔗 + +**Returns:** +- `itemLink` + - *string?* : ItemLink \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemMaxStackSize.md b/wiki-information/functions/C_Item.GetItemMaxStackSize.md new file mode 100644 index 00000000..927b72a8 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemMaxStackSize.md @@ -0,0 +1,19 @@ +## Title: C_Item.GetItemMaxStackSize + +**Content:** +Needs summary. +`stackSize = C_Item.GetItemMaxStackSize(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin* + +**Returns:** +- `stackSize` + - *number?* + +**Example Usage:** +This function can be used to determine the maximum stack size of an item at a given location, which is useful for inventory management addons. + +**Addons:** +Large addons like Bagnon or ArkInventory might use this function to display or manage item stacks within the player's inventory. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md b/wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md new file mode 100644 index 00000000..401fc999 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md @@ -0,0 +1,19 @@ +## Title: C_Item.GetItemMaxStackSizeByID + +**Content:** +Needs summary. +`stackSize = C_Item.GetItemMaxStackSizeByID(itemInfo)` + +**Parameters:** +- `itemInfo` + - *string* + +**Returns:** +- `stackSize` + - *number?* + +**Example Usage:** +This function can be used to determine the maximum stack size of an item in World of Warcraft. For instance, if you want to know how many potions you can stack in one inventory slot, you can use this function to get that information. + +**Addon Usage:** +Large addons like Auctioneer may use this function to determine how many items can be listed in a single auction stack, optimizing the auction creation process for users. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemName.md b/wiki-information/functions/C_Item.GetItemName.md new file mode 100644 index 00000000..46100b2e --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemName.md @@ -0,0 +1,28 @@ +## Title: C_Item.GetItemName + +**Content:** +Needs summary. +```lua +itemName = C_Item.GetItemName(itemLocation) +itemName = C_Item.GetItemNameByID(itemInfo) +``` + +**Parameters:** + +**GetItemName:** +- `itemLocation` + - *ItemLocationMixin* + +**GetItemNameByID:** +- `itemInfo` + - *number|string* - Item ID, Link or Name + +**Returns:** +- `itemName` + - *string?* + +**Example Usage:** +This function can be used to retrieve the name of an item based on its location or ID. For instance, if you have an item in your inventory and you want to display its name in a custom UI element, you can use `C_Item.GetItemName` to get the name and then display it. + +**Addons:** +Many large addons like **WeakAuras** and **TradeSkillMaster** use similar functions to display item names dynamically based on user interactions or inventory changes. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemNameByID.md b/wiki-information/functions/C_Item.GetItemNameByID.md new file mode 100644 index 00000000..0d925cba --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemNameByID.md @@ -0,0 +1,37 @@ +## Title: C_Item.GetItemName + +**Content:** +Needs summary. +`itemName = C_Item.GetItemName(itemLocation)` +`itemName = C_Item.GetItemNameByID(itemInfo)` + +**Parameters:** +- **GetItemName:** + - `itemLocation` + - *ItemLocationMixin* + +- **GetItemNameByID:** + - `itemInfo` + - *number|string* - Item ID, Link, or Name + +**Returns:** +- `itemName` + - *string?* + +**Description:** +The `C_Item.GetItemName` function retrieves the name of an item based on its location or ID. This can be particularly useful for addons that need to display item names dynamically, such as inventory management addons or tooltip enhancements. + +**Example Usage:** +```lua +local itemLocation = ItemLocation:CreateFromBagAndSlot(bag, slot) +local itemName = C_Item.GetItemName(itemLocation) +print("Item Name: ", itemName) + +local itemID = 12345 +local itemNameByID = C_Item.GetItemNameByID(itemID) +print("Item Name by ID: ", itemNameByID) +``` + +**Addons Using This Function:** +- **Bagnon:** An inventory management addon that uses this function to display item names in the player's bags. +- **TipTac:** A tooltip enhancement addon that uses this function to show item names in tooltips. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemQuality.md b/wiki-information/functions/C_Item.GetItemQuality.md new file mode 100644 index 00000000..a2a204e4 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemQuality.md @@ -0,0 +1,52 @@ +## Title: C_Item.GetItemQuality + +**Content:** +Needs summary. +`itemQuality = C_Item.GetItemQuality(itemLocation)` +`itemQuality = C_Item.GetItemQualityByID(itemInfo)` + +**Parameters:** +- **GetItemQuality:** + - `itemLocation` + - *ItemLocationMixin* + +- **GetItemQualityByID:** + - `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `itemQuality` + - *Enum.ItemQuality* + - **Value** + - **Field** + - **GlobalString (enUS)** + - `0` + - Poor + - ITEM_QUALITY0_DESC + - `1` + - Common + - ITEM_QUALITY1_DESC + - `2` + - Uncommon + - ITEM_QUALITY2_DESC + - `3` + - Rare + - ITEM_QUALITY3_DESC + - `4` + - Epic + - ITEM_QUALITY4_DESC + - `5` + - Legendary + - ITEM_QUALITY5_DESC + - `6` + - Artifact + - ITEM_QUALITY6_DESC + - `7` + - Heirloom + - ITEM_QUALITY7_DESC + - `8` + - WoW Token + - ITEM_QUALITY8_DESC + +**Reference:** +`GetItemQualityColor()` \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemQualityByID.md b/wiki-information/functions/C_Item.GetItemQualityByID.md new file mode 100644 index 00000000..d20ff1d4 --- /dev/null +++ b/wiki-information/functions/C_Item.GetItemQualityByID.md @@ -0,0 +1,62 @@ +## Title: C_Item.GetItemQuality + +**Content:** +Needs summary. +```lua +itemQuality = C_Item.GetItemQuality(itemLocation) +itemQuality = C_Item.GetItemQualityByID(itemInfo) +``` + +**Parameters:** + +**GetItemQuality:** +- `itemLocation` + - *ItemLocationMixin* + +**GetItemQualityByID:** +- `itemInfo` + - *number|string* - Item ID, Link, or Name + +**Returns:** +- `itemQuality` + - *Enum.ItemQuality* + - `Value` + - `Field` + - `GlobalString (enUS)` + - `0` + - Poor + - ITEM_QUALITY0_DESC + - `1` + - Common + - ITEM_QUALITY1_DESC + - `2` + - Uncommon + - ITEM_QUALITY2_DESC + - `3` + - Rare + - ITEM_QUALITY3_DESC + - `4` + - Epic + - ITEM_QUALITY4_DESC + - `5` + - Legendary + - ITEM_QUALITY5_DESC + - `6` + - Artifact + - ITEM_QUALITY6_DESC + - `7` + - Heirloom + - ITEM_QUALITY7_DESC + - `8` + - WoW Token + - ITEM_QUALITY8_DESC + +**Reference:** +- `GetItemQualityColor()` + +**Example Usage:** +This function can be used to determine the quality of an item, which is useful for addons that need to display item quality or filter items based on their quality. For instance, an addon that manages inventory might use this function to sort items by quality or to highlight high-quality items. + +**Addons Using This Function:** +- **Bagnon**: A popular inventory management addon that uses item quality to color-code items in the player's bags. +- **Auctioneer**: An addon that helps players with auction house activities, which might use item quality to determine pricing strategies for different items. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetStackCount.md b/wiki-information/functions/C_Item.GetStackCount.md new file mode 100644 index 00000000..09ba2632 --- /dev/null +++ b/wiki-information/functions/C_Item.GetStackCount.md @@ -0,0 +1,19 @@ +## Title: C_Item.GetStackCount + +**Content:** +Needs summary. +`stackCount = C_Item.GetStackCount(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin* + +**Returns:** +- `stackCount` + - *number* + +**Example Usage:** +This function can be used to determine the number of items in a specific item location, such as a bag slot or bank slot. For instance, if you want to check how many potions you have in a specific bag slot, you can use this function to get that count. + +**Addon Usage:** +Large addons like Bagnon, which manage and display inventory, might use this function to display the stack count of items in the player's bags and bank. This helps in providing a clear and concise view of the player's inventory. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsBound.md b/wiki-information/functions/C_Item.IsBound.md new file mode 100644 index 00000000..b189d5db --- /dev/null +++ b/wiki-information/functions/C_Item.IsBound.md @@ -0,0 +1,13 @@ +## Title: C_Item.IsBound + +**Content:** +Needs summary. +`isBound = C_Item.IsBound(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin* - The location of the item to be checked. + +**Returns:** +- `isBound` + - *boolean* - Whether or not the item is soul- or accountbound. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsItemDataCached.md b/wiki-information/functions/C_Item.IsItemDataCached.md new file mode 100644 index 00000000..244c0823 --- /dev/null +++ b/wiki-information/functions/C_Item.IsItemDataCached.md @@ -0,0 +1,19 @@ +## Title: C_Item.IsItemDataCached + +**Content:** +Needs summary. +`isCached = C_Item.IsItemDataCached(itemLocation)` +`isCached = C_Item.IsItemDataCachedByID(itemInfo)` + +**Parameters:** +- **IsItemDataCached:** + - `itemLocation` + - *ItemLocationMixin* + +- **IsItemDataCachedByID:** + - `itemInfo` + - *string* : ItemLink or ID + +**Returns:** +- `isCached` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsItemDataCachedByID.md b/wiki-information/functions/C_Item.IsItemDataCachedByID.md new file mode 100644 index 00000000..244c0823 --- /dev/null +++ b/wiki-information/functions/C_Item.IsItemDataCachedByID.md @@ -0,0 +1,19 @@ +## Title: C_Item.IsItemDataCached + +**Content:** +Needs summary. +`isCached = C_Item.IsItemDataCached(itemLocation)` +`isCached = C_Item.IsItemDataCachedByID(itemInfo)` + +**Parameters:** +- **IsItemDataCached:** + - `itemLocation` + - *ItemLocationMixin* + +- **IsItemDataCachedByID:** + - `itemInfo` + - *string* : ItemLink or ID + +**Returns:** +- `isCached` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsLocked.md b/wiki-information/functions/C_Item.IsLocked.md new file mode 100644 index 00000000..839baa4c --- /dev/null +++ b/wiki-information/functions/C_Item.IsLocked.md @@ -0,0 +1,19 @@ +## Title: C_Item.IsLocked + +**Content:** +Needs summary. +`isLocked = C_Item.IsLocked(itemLocation)` + +**Parameters:** +- `itemLocation` + - *ItemLocationMixin*🔗 + +**Returns:** +- `isLocked` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific item in a player's inventory is currently locked (e.g., due to being in use or being a quest item). + +**Addon Usage:** +Large addons like **Bagnon** or **ArkInventory** might use this function to determine the lock status of items when displaying inventory grids, ensuring that locked items are visually distinct or handled differently in the UI. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.LockItem.md b/wiki-information/functions/C_Item.LockItem.md new file mode 100644 index 00000000..1a5fa349 --- /dev/null +++ b/wiki-information/functions/C_Item.LockItem.md @@ -0,0 +1,16 @@ +## Title: C_Item.LockItem + +**Content:** +Needs summary. +`C_Item.LockItem(itemLocation)` +`C_Item.LockItemByGUID(itemGUID)` + +**Parameters:** + +**LockItem:** +- `itemLocation` + - *ItemLocationMixin* + +**LockItemByGUID:** +- `itemGUID` + - *string* : ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.LockItemByGUID.md b/wiki-information/functions/C_Item.LockItemByGUID.md new file mode 100644 index 00000000..d7bd6086 --- /dev/null +++ b/wiki-information/functions/C_Item.LockItemByGUID.md @@ -0,0 +1,16 @@ +## Title: C_Item.LockItem + +**Content:** +Needs summary. +`C_Item.LockItem(itemLocation)` +`C_Item.LockItemByGUID(itemGUID)` + +**Parameters:** + +**LockItem:** +- `itemLocation` + - *ItemLocationMixin* + +**LockItemByGUID:** +- `itemGUID` + - *string* - ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.RequestLoadItemData.md b/wiki-information/functions/C_Item.RequestLoadItemData.md new file mode 100644 index 00000000..0006464a --- /dev/null +++ b/wiki-information/functions/C_Item.RequestLoadItemData.md @@ -0,0 +1,17 @@ +## Title: C_Item.RequestLoadItemData + +**Content:** +Requests item data and fires `ITEM_DATA_LOAD_RESULT`. +```lua +C_Item.RequestLoadItemData(itemLocation) +C_Item.RequestLoadItemDataByID(itemInfo) +``` + +**Parameters:** +- **RequestLoadItemData:** + - `itemLocation` + - *ItemLocationMixin* + +- **RequestLoadItemDataByID:** + - `itemInfo` + - *string* : ItemLink or ID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.RequestLoadItemDataByID.md b/wiki-information/functions/C_Item.RequestLoadItemDataByID.md new file mode 100644 index 00000000..0006464a --- /dev/null +++ b/wiki-information/functions/C_Item.RequestLoadItemDataByID.md @@ -0,0 +1,17 @@ +## Title: C_Item.RequestLoadItemData + +**Content:** +Requests item data and fires `ITEM_DATA_LOAD_RESULT`. +```lua +C_Item.RequestLoadItemData(itemLocation) +C_Item.RequestLoadItemDataByID(itemInfo) +``` + +**Parameters:** +- **RequestLoadItemData:** + - `itemLocation` + - *ItemLocationMixin* + +- **RequestLoadItemDataByID:** + - `itemInfo` + - *string* : ItemLink or ID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.UnlockItem.md b/wiki-information/functions/C_Item.UnlockItem.md new file mode 100644 index 00000000..b13399f8 --- /dev/null +++ b/wiki-information/functions/C_Item.UnlockItem.md @@ -0,0 +1,16 @@ +## Title: C_Item.UnlockItem + +**Content:** +Needs summary. +`C_Item.UnlockItem(itemLocation)` +`C_Item.UnlockItemByGUID(itemGUID)` + +**Parameters:** + +**UnlockItem:** +- `itemLocation` + - *ItemLocationMixin* + +**UnlockItemByGUID:** +- `itemGUID` + - *string* : ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.UnlockItemByGUID.md b/wiki-information/functions/C_Item.UnlockItemByGUID.md new file mode 100644 index 00000000..b13399f8 --- /dev/null +++ b/wiki-information/functions/C_Item.UnlockItemByGUID.md @@ -0,0 +1,16 @@ +## Title: C_Item.UnlockItem + +**Content:** +Needs summary. +`C_Item.UnlockItem(itemLocation)` +`C_Item.UnlockItemByGUID(itemGUID)` + +**Parameters:** + +**UnlockItem:** +- `itemLocation` + - *ItemLocationMixin* + +**UnlockItemByGUID:** +- `itemGUID` + - *string* : ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md b/wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md new file mode 100644 index 00000000..a30f284b --- /dev/null +++ b/wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md @@ -0,0 +1,11 @@ +## Title: C_ItemSocketInfo.CompleteSocketing + +**Content:** +Completes socketing an item, binding it to the player. +`C_ItemSocketInfo.CompleteSocketing()` + +**Example Usage:** +This function can be used in an addon to automate the process of socketing gems into an item. For instance, an addon could provide a user interface for selecting gems and then call this function to complete the socketing process. + +**Addons Using This Function:** +Large addons like Pawn use this function to help players optimize their gear by suggesting the best gems to socket and then automating the socketing process. \ No newline at end of file diff --git a/wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md b/wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md new file mode 100644 index 00000000..d7c72354 --- /dev/null +++ b/wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md @@ -0,0 +1,9 @@ +## Title: C_ItemUpgrade.GetItemHyperlink + +**Content:** +Returns an itemLink of the anticipated result from applying item upgrading using the ItemUpgradeFrame. +`link = C_ItemUpgrade.GetItemHyperlink()` + +**Returns:** +- `link` + - *string* - itemLink \ No newline at end of file diff --git a/wiki-information/functions/C_KeyBindings.GetBindingIndex.md b/wiki-information/functions/C_KeyBindings.GetBindingIndex.md new file mode 100644 index 00000000..1632e6a7 --- /dev/null +++ b/wiki-information/functions/C_KeyBindings.GetBindingIndex.md @@ -0,0 +1,13 @@ +## Title: C_KeyBindings.GetBindingIndex + +**Content:** +Needs summary. +`bindingIndex = C_KeyBindings.GetBindingIndex(action)` + +**Parameters:** +- `action` + - *string* + +**Returns:** +- `bindingIndex` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_KeyBindings.GetCustomBindingType.md b/wiki-information/functions/C_KeyBindings.GetCustomBindingType.md new file mode 100644 index 00000000..fa03e213 --- /dev/null +++ b/wiki-information/functions/C_KeyBindings.GetCustomBindingType.md @@ -0,0 +1,18 @@ +## Title: C_KeyBindings.GetCustomBindingType + +**Content:** +Returns the type of a custom binding. +`customBindingType = C_KeyBindings.GetCustomBindingType(bindingIndex)` + +**Parameters:** +- `bindingIndex` + - *number* + +**Returns:** +- `customBindingType` + - *Enum.CustomBindingType (nilable)* + - `Value` + - `Field` + - `Description` + - `0` + - VoicePushToTalk \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md b/wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md new file mode 100644 index 00000000..2e3ecf44 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md @@ -0,0 +1,11 @@ +## Title: C_LFGInfo.CanPlayerUseGroupFinder + +**Content:** +Returns true if the player is allowed to use group finder tools, or false and a reason string if not. +`canUse, failureReason = C_LFGInfo.CanPlayerUseGroupFinder()` + +**Returns:** +- `canUse` + - *boolean* +- `failureReason` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md b/wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md new file mode 100644 index 00000000..9d4ba125 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md @@ -0,0 +1,11 @@ +## Title: C_LFGInfo.CanPlayerUseLFD + +**Content:** +Returns true if the player is allowed to queue for instanced dungeon content, or false and a reason string if not. +`canUse, failureReason = C_LFGInfo.CanPlayerUseLFD()` + +**Returns:** +- `canUse` + - *boolean* +- `failureReason` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md b/wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md new file mode 100644 index 00000000..21f71272 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md @@ -0,0 +1,11 @@ +## Title: C_LFGInfo.CanPlayerUseLFR + +**Content:** +Returns true if the player is allowed to queue for instanced raid content, or false and a reason string if not. +`canUse, failureReason = C_LFGInfo.CanPlayerUseLFR()` + +**Returns:** +- `canUse` + - *boolean* +- `failureReason` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md b/wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md new file mode 100644 index 00000000..ab149481 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md @@ -0,0 +1,11 @@ +## Title: C_LFGInfo.CanPlayerUsePVP + +**Content:** +Returns true if the player is allowed to queue for instanced PvP content, or false and a reason string if not. +`canUse, failureReason = C_LFGInfo.CanPlayerUsePVP()` + +**Returns:** +- `canUse` + - *boolean* +- `failureReason` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md b/wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md new file mode 100644 index 00000000..beffd7dc --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md @@ -0,0 +1,11 @@ +## Title: C_LFGInfo.CanPlayerUsePremadeGroup + +**Content:** +Returns true if the player is allowed to use the premade group finder, or false and a reason string if not. +`canUse, failureReason = C_LFGInfo.CanPlayerUsePremadeGroup()` + +**Returns:** +- `canUse` + - *boolean* +- `failureReason` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md b/wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md new file mode 100644 index 00000000..652d01ba --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md @@ -0,0 +1,14 @@ +## Title: C_LFGInfo.ConfirmLfgExpandSearch + +**Content:** +Needs summary. +`C_LFGInfo.ConfirmLfgExpandSearch()` + +**Description:** +This function is used to confirm the expansion of the search radius for the Looking For Group (LFG) system. When the LFG system cannot find a match within the initial search parameters, it may prompt the user to expand the search to include a wider range of potential matches. This function confirms that action. + +**Example Usage:** +An addon might use this function to automatically confirm the expansion of the search radius, ensuring that the player finds a group more quickly without manual intervention. + +**Addons:** +Large addons like "DBM (Deadly Boss Mods)" or "ElvUI" might use this function to enhance the LFG experience by automating certain aspects of the group-finding process. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md b/wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md new file mode 100644 index 00000000..10f38cbf --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md @@ -0,0 +1,30 @@ +## Title: C_LFGInfo.GetAllEntriesForCategory + +**Content:** +Returns any dungeons for a LFG category you're queued up for. +`lfgDungeonIDs = C_LFGInfo.GetAllEntriesForCategory(category)` + +**Parameters:** +- `category` + - *number* + - *Enum* + - `Value` + - `Description` + - `LE_LFG_CATEGORY_LFD` + - *1* - Dungeon Finder + - `LE_LFG_CATEGORY_LFR` + - *2* - Other Raids + - `LE_LFG_CATEGORY_RF` + - *3* - Raid Finder + - `LE_LFG_CATEGORY_SCENARIO` + - *4* - Scenarios + - `LE_LFG_CATEGORY_FLEXRAID` + - *5* - Flexible Raid + - `LE_LFG_CATEGORY_WORLDPVP` + - *6* - Ashran + - `LE_LFG_CATEGORY_BATTLEFIELD` + - *7* - Brawl + +**Returns:** +- `lfgDungeonIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.GetLFDLockStates.md b/wiki-information/functions/C_LFGInfo.GetLFDLockStates.md new file mode 100644 index 00000000..eaccbe33 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.GetLFDLockStates.md @@ -0,0 +1,24 @@ +## Title: C_LFGInfo.GetLFDLockStates + +**Content:** +Needs summary. +`lockInfo = C_LFGInfo.GetLFDLockStates()` + +**Returns:** +- `lockInfo` + - *LFGLockInfo* + - `Field` + - `Type` + - `Description` + - `lfgID` + - *number* + - `reason` + - *number* - index. See LFG_INSTANCE_INVALID_CODES + - `hideEntry` + - *boolean* + +**Example Usage:** +This function can be used to retrieve the lockout states for various LFG (Looking For Group) instances. This is useful for determining which instances a player is locked out of and the reasons for the lockout. + +**Addon Usage:** +Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to display lockout information to players, helping them manage their dungeon and raid lockouts more effectively. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md b/wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md new file mode 100644 index 00000000..34a5e217 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md @@ -0,0 +1,11 @@ +## Title: C_LFGInfo.GetRoleCheckDifficultyDetails + +**Content:** +Needs summary. +`maxLevel, isLevelReduced = C_LFGInfo.GetRoleCheckDifficultyDetails()` + +**Returns:** +- `maxLevel` + - *number?* +- `isLevelReduced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.HideNameFromUI.md b/wiki-information/functions/C_LFGInfo.HideNameFromUI.md new file mode 100644 index 00000000..9f722186 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.HideNameFromUI.md @@ -0,0 +1,40 @@ +## Title: C_LFGInfo.HideNameFromUI + +**Content:** +Returns true if a dungeon name has to be hidden in the UI. +`shouldHide = C_LFGInfo.HideNameFromUI(dungeonID)` + +**Parameters:** +- `dungeonID` + - *number* + +**Returns:** +- `shouldHide` + - *boolean* + +**Description:** +List of IDs where `shouldHide` is true. +- **ID**: 1030 + - **Name**: 7.0 Artifacts - Sub Rog - Acquisition - Demonic Portal World + - **DifficultyID**: 12: Normal Scenario +- **ID**: 1090 + - **Name**: Boost 2.0 R&D + - **DifficultyID**: 12: Normal Scenario +- **ID**: 1307 + - **Name**: Tideskorn Harbor Acquisition Scenarios - JMC + - **DifficultyID**: 12: Normal Scenario +- **ID**: 1309 + - **Name**: Shield's Rest Acquisition Scenarios - JMC + - **DifficultyID**: 12: Normal Scenario +- **ID**: 1371 + - **Name**: Priest Order Formation - JMC + - **DifficultyID**: 12: Normal Scenario +- **ID**: 1381 + - **Name**: Blade in Twilight + - **DifficultyID**: 12: Normal Scenario +- **ID**: 1382 + - **Name**: Sword of Kings + - **DifficultyID**: 12: Normal Scenario +- **ID**: 1436 + - **Name**: 7.2 Broken Shore Intro - Legion Command Ship (KMS) + - **DifficultyID**: 12: Normal Scenario \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md b/wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md new file mode 100644 index 00000000..5da3c211 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md @@ -0,0 +1,9 @@ +## Title: C_LFGInfo.IsGroupFinderEnabled + +**Content:** +Needs summary. +`enabled = C_LFGInfo.IsGroupFinderEnabled()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md b/wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md new file mode 100644 index 00000000..e8a9ab2b --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md @@ -0,0 +1,9 @@ +## Title: C_LFGInfo.IsInLFGFollowerDungeon + +**Content:** +Needs summary. +`result = C_LFGInfo.IsInLFGFollowerDungeon()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsLFDEnabled.md b/wiki-information/functions/C_LFGInfo.IsLFDEnabled.md new file mode 100644 index 00000000..e7b60ed5 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.IsLFDEnabled.md @@ -0,0 +1,9 @@ +## Title: C_LFGInfo.IsLFDEnabled + +**Content:** +Needs summary. +`enabled = C_LFGInfo.IsLFDEnabled()` + +**Returns:** +- `enabled` + - *boolean* - Indicates whether the Looking For Dungeon (LFD) system is enabled. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md b/wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md new file mode 100644 index 00000000..41ed5684 --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md @@ -0,0 +1,13 @@ +## Title: C_LFGInfo.IsLFGFollowerDungeon + +**Content:** +Needs summary. +`result = C_LFGInfo.IsLFGFollowerDungeon(dungeonID)` + +**Parameters:** +- `dungeonID` + - *number* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsLFREnabled.md b/wiki-information/functions/C_LFGInfo.IsLFREnabled.md new file mode 100644 index 00000000..287fe9ca --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.IsLFREnabled.md @@ -0,0 +1,9 @@ +## Title: C_LFGInfo.IsLFREnabled + +**Content:** +Needs summary. +`enabled = C_LFGInfo.IsLFREnabled()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md b/wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md new file mode 100644 index 00000000..b17f26ff --- /dev/null +++ b/wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md @@ -0,0 +1,9 @@ +## Title: C_LFGInfo.IsPremadeGroupEnabled + +**Content:** +Needs summary. +`enabled = C_LFGInfo.IsPremadeGroupEnabled()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ApplyToGroup.md b/wiki-information/functions/C_LFGList.ApplyToGroup.md new file mode 100644 index 00000000..e331f7d1 --- /dev/null +++ b/wiki-information/functions/C_LFGList.ApplyToGroup.md @@ -0,0 +1,21 @@ +## Title: C_LFGList.ApplyToGroup + +**Content:** +Needs summary. +`C_LFGList.ApplyToGroup(resultID)` + +**Parameters:** +- `resultID` + - *number* +- `tankOK` + - *boolean?* +- `healerOK` + - *boolean?* +- `damageOK` + - *boolean?* + +**Example Usage:** +This function can be used to apply to a group in the Looking For Group (LFG) system. For instance, if you find a group you want to join, you can use this function to send an application to that group. + +**Addons:** +Large addons like **Deadly Boss Mods (DBM)** and **ElvUI** might use this function to automate group applications or to enhance the LFG experience by providing additional UI elements or notifications. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md b/wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md new file mode 100644 index 00000000..fc348170 --- /dev/null +++ b/wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md @@ -0,0 +1,9 @@ +## Title: C_LFGList.CanActiveEntryUseAutoAccept + +**Content:** +Needs summary. +`canUseAutoAccept = C_LFGList.CanActiveEntryUseAutoAccept()` + +**Returns:** +- `canUseAutoAccept` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.CanCreateQuestGroup.md b/wiki-information/functions/C_LFGList.CanCreateQuestGroup.md new file mode 100644 index 00000000..2ed17118 --- /dev/null +++ b/wiki-information/functions/C_LFGList.CanCreateQuestGroup.md @@ -0,0 +1,19 @@ +## Title: C_LFGList.CanCreateQuestGroup + +**Content:** +Needs summary. +`canCreate = C_LFGList.CanCreateQuestGroup(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `canCreate` + - *boolean* + +**Example Usage:** +This function can be used to determine if a player can create a group for a specific quest using the Looking For Group (LFG) system. For instance, if you have a quest ID and want to check if you can create a group for it, you can use this function to get a boolean result. + +**Addons Usage:** +Large addons like "World Quest Tracker" might use this function to allow players to create groups for world quests directly from the quest tracker interface. This enhances the player's ability to find groups for completing world quests more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearApplicationTextFields.md b/wiki-information/functions/C_LFGList.ClearApplicationTextFields.md new file mode 100644 index 00000000..59d0cbf6 --- /dev/null +++ b/wiki-information/functions/C_LFGList.ClearApplicationTextFields.md @@ -0,0 +1,5 @@ +## Title: C_LFGList.ClearApplicationTextFields + +**Content:** +Needs summary. +`C_LFGList.ClearApplicationTextFields()` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearCreationTextFields.md b/wiki-information/functions/C_LFGList.ClearCreationTextFields.md new file mode 100644 index 00000000..3338b7d5 --- /dev/null +++ b/wiki-information/functions/C_LFGList.ClearCreationTextFields.md @@ -0,0 +1,17 @@ +## Title: C_LFGList.ClearCreationTextFields + +**Content:** +Needs summary. +`C_LFGList.ClearCreationTextFields()` + +**Description:** +This function is used to clear the text fields in the Looking For Group (LFG) creation interface. This can be useful when resetting the form or preparing it for a new entry. + +**Example Usage:** +```lua +-- Clear the text fields in the LFG creation interface +C_LFGList.ClearCreationTextFields() +``` + +**Usage in Addons:** +Large addons like "Premade Groups Filter" might use this function to reset the LFG creation form when users are setting up new group listings. This ensures that no residual text from previous entries remains, providing a clean slate for new group descriptions and titles. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearSearchResults.md b/wiki-information/functions/C_LFGList.ClearSearchResults.md new file mode 100644 index 00000000..30df5844 --- /dev/null +++ b/wiki-information/functions/C_LFGList.ClearSearchResults.md @@ -0,0 +1,5 @@ +## Title: C_LFGList.ClearSearchResults + +**Content:** +Needs summary. +`C_LFGList.ClearSearchResults()` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearSearchTextFields.md b/wiki-information/functions/C_LFGList.ClearSearchTextFields.md new file mode 100644 index 00000000..d32fad07 --- /dev/null +++ b/wiki-information/functions/C_LFGList.ClearSearchTextFields.md @@ -0,0 +1,6 @@ +## Title: C_LFGList.ClearSearchTextFields + +**Content:** +Needs summary. +`C_LFGList.ClearSearchTextFields()` + diff --git a/wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md b/wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md new file mode 100644 index 00000000..ca3c9924 --- /dev/null +++ b/wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md @@ -0,0 +1,14 @@ +## Title: C_LFGList.CopyActiveEntryInfoToCreationFields + +**Content:** +Needs summary. +`C_LFGList.CopyActiveEntryInfoToCreationFields()` + +**Description:** +This function is used to copy the information from an active LFG (Looking For Group) entry to the creation fields, which can be useful when you want to quickly recreate or edit an existing LFG entry without manually re-entering all the details. + +**Example Usage:** +An example use case for this function would be in an addon that helps players manage their LFG entries. If a player wants to quickly recreate a group with the same settings as a previous one, this function can be called to populate the creation fields with the previous entry's information. + +**Addons:** +Large addons like "Premade Groups Filter" or "LFG Bulletin Board" might use this function to streamline the process of creating and managing LFG entries, making it easier for players to find and join groups. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.CreateListing.md b/wiki-information/functions/C_LFGList.CreateListing.md new file mode 100644 index 00000000..0cb755a6 --- /dev/null +++ b/wiki-information/functions/C_LFGList.CreateListing.md @@ -0,0 +1,29 @@ +## Title: C_LFGList.CreateListing + +**Content:** +Creates a group finder listing. +`success = C_LFGList.CreateListing(activityID, itemLevel, honorLevel)` + +**Parameters:** +- `activityID` + - *number* : GroupFinderActivity.ID +- `itemLevel` + - *number* +- `honorLevel` + - *number* +- `autoAccept` + - *boolean?* +- `privateGroup` + - *boolean?* +- `questID` + - *number?* + +**Returns:** +- `success` + - *boolean* - Generally returns true if there was a valid group title. + +**Usage:** +Creates a group listing for "Custom PvE". Requires the title of the listing to have been typed manually, otherwise it silently fails. Setting the title is explicitly protected. +```lua +/run C_LFGList.CreateListing(16, 0, 0) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md b/wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md new file mode 100644 index 00000000..c085abda --- /dev/null +++ b/wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md @@ -0,0 +1,28 @@ +## Title: C_LFGList.DoesEntryTitleMatchPrebuiltTitle + +**Content:** +Needs summary. +`matches = C_LFGList.DoesEntryTitleMatchPrebuiltTitle(activityID, groupID)` + +**Parameters:** +- `activityID` + - *number* +- `groupID` + - *number* +- `playstyle` + - *Enum.LFGEntryPlaystyle?* + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Standard + - `2` + - Casual + - `3` + - Hardcore + +**Returns:** +- `matches` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActiveEntryInfo.md b/wiki-information/functions/C_LFGList.GetActiveEntryInfo.md new file mode 100644 index 00000000..1115cfdc --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetActiveEntryInfo.md @@ -0,0 +1,52 @@ +## Title: C_LFGList.GetActiveEntryInfo + +**Content:** +Returns information about your currently listed group. +`entryData = C_LFGList.GetActiveEntryInfo()` + +**Returns:** +- `entryData` + - *LfgEntryData* + - `activityID` + - *number* - The activityID of the group. Use `C_LFGList.GetActivityInfo(activityID)` to get more information about the activity. This field is not present in Classic. + - `activityIDs` + - *number* - List of activity IDs for the listed group. This field is exclusive to Classic. + - `requiredItemLevel` + - *number* - Item level requirement for applications. Returns 0 if no requirement is set. + - `requiredHonorLevel` + - *number* - Honor level requirement for applications. + - `name` + - *string* - Protected string. + - `comment` + - *string* - Protected string. + - `voiceChat` + - *string* - Voice chat specified by group creator. Returns an empty string if no voice chat is specified. + - `duration` + - *number* - Expiration time of the group in seconds. Currently starts at 1800 seconds (30 minutes). If no player joins the group within this time, the group is delisted for inactivity. + - `autoAccept` + - *boolean* - If new applicants are automatically invited. + - `privateGroup` + - *boolean* - Indicates if the group is private. + - `questID` + - *number?* - Quest ID associated with the group, if any. + - `requiredDungeonScore` + - *number?* - Required dungeon score for applications. + - `requiredPvpRating` + - *number?* - Required PvP rating for applications. + - `playstyle` + - *Enum.LFGEntryPlaystyle?* - Playstyle of the group. + - `isCrossFactionListing` + - *boolean* - Indicates if the group is cross-faction. Added in 9.2.5. + +**Enum.LFGEntryPlaystyle:** +- `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Standard + - `2` + - Casual + - `3` + - Hardcore \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityFullName.md b/wiki-information/functions/C_LFGList.GetActivityFullName.md new file mode 100644 index 00000000..d32e494f --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetActivityFullName.md @@ -0,0 +1,17 @@ +## Title: C_LFGList.GetActivityFullName + +**Content:** +Needs summary. +`fullName = C_LFGList.GetActivityFullName(activityID)` + +**Parameters:** +- `activityID` + - *number* +- `questID` + - *number?* +- `showWarmode` + - *boolean?* + +**Returns:** +- `fullName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityGroupInfo.md b/wiki-information/functions/C_LFGList.GetActivityGroupInfo.md new file mode 100644 index 00000000..fdfa38f8 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetActivityGroupInfo.md @@ -0,0 +1,21 @@ +## Title: C_LFGList.GetActivityGroupInfo + +**Content:** +Returns info for an activity group. +`name, groupOrder = C_LFGList.GetActivityGroupInfo(groupID)` + +**Parameters:** +- `groupID` + - *number* - The groupID for which information are requested, as returned by `C_LFGList.GetAvailableActivityGroups()`. + +**Returns:** +- `name` + - *string* - Name of the group. +- `groupOrder` + - *number* - ? + +**Example Usage:** +This function can be used to retrieve the name and order of a specific activity group in the Looking For Group (LFG) system. For instance, if you have a group ID and want to display the name of the group in your addon, you can use this function to get that information. + +**Addons Using This Function:** +Large addons like **Deadly Boss Mods (DBM)** and **ElvUI** may use this function to display or organize LFG activities based on their group information. For example, DBM might use it to categorize different raid activities, while ElvUI could use it to enhance the user interface for LFG activities. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityInfo.md b/wiki-information/functions/C_LFGList.GetActivityInfo.md new file mode 100644 index 00000000..ffddb3da --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetActivityInfo.md @@ -0,0 +1,70 @@ +## Title: C_LFGList.GetActivityInfo + +**Content:** +Returns information about an activity for premade groups. +`fullName, shortName, categoryID, groupID, itemLevel, filters, minLevel, maxPlayers, displayType, orderIndex, useHonorLevel, showQuickJoinToast, isMythicPlusActivity, isRatedPvpActivity, isCurrentRaidActivity = C_LFGList.GetActivityInfo(activityID)` + +**Parameters:** +- `activityID` + - *number* : GroupFinderActivity.ID - The activityID for which information is requested, as returned by `C_LFGList.GetAvailableActivities()`. + +**Returns:** +- `fullName` + - *string* - Full name of the activity. +- `shortName` + - *string* - Short name of the activity, for example just "World Bosses" instead of the fullName "World Bosses (Pandaria)". +- `categoryID` + - *number* - The categoryID of this activity, as returned by `C_LFGList.GetAvailableCategories()`. +- `groupID` + - *number* - The groupID of this activity, as returned by `C_LFGList.GetAvailableActivityGroups()`. +- `itemLevel` + - *number* - Minimum item level required for this activity. Returns 0 if no requirement. +- `filters` + - *number* - Bit mask of filters for this activity. See details. +- `minLevel` + - *number* - Minimum level required for this activity. +- `maxPlayers` + - *number* - Maximum number of players allowed for this activity. +- `displayType` + - *number* - The display type ID for this activity. See details. +- `orderIndex` + - *number* - How the activity is ordered. See details. +- `useHonorLevel` + - *boolean* +- `showQuickJoinToast` + - *boolean* +- `isMythicPlusActivity` + - *boolean* +- `isRatedPvpActivity` + - *boolean* +- `isCurrentRaidActivity` + - *boolean* + +**Description:** +**DisplayType:** +The display type determines how the current size of a group is displayed in the list. This number ranges from 1 to NUM_LE_LFG_LIST_DISPLAY_TYPES: +- `LE_LFG_LIST_DISPLAY_TYPE_ROLE_COUNT` + - *1* - Display how many of each class role are present in the group. This is used for custom groups, for example. +- `LE_LFG_LIST_DISPLAY_TYPE_ROLE_ENUMERATE` + - *2* - Each present and each missing player in the group is depicted with a role icon. This is used for 5-man dungeons, for example. +- `LE_LFG_LIST_DISPLAY_TYPE_CLASS_ENUMERATE` + - *3* - ? +- `LE_LFG_LIST_DISPLAY_TYPE_HIDE_ALL` + - *4* - Hide all group size indicators. +- `LE_LFG_LIST_DISPLAY_TYPE_PLAYER_COUNT` + - *5* - Only display the total number of players in the group. This is used for questing groups, for example. + +**ActivityOrder:** +Please add any available information to this section. + +**Miscellaneous:** +**Filters:** +Please add any available information to this section. +- `LE_LFG_LIST_FILTER_RECOMMENDED` + - *1* - ? +- `LE_LFG_LIST_FILTER_NOT_RECOMMENDED` + - *2* - ? +- `LE_LFG_LIST_FILTER_PVE` + - *4* - ? +- `LE_LFG_LIST_FILTER_PVP` + - *8* - ? \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md b/wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md new file mode 100644 index 00000000..c3e142c2 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md @@ -0,0 +1,13 @@ +## Title: C_LFGList.GetActivityInfoExpensive + +**Content:** +Returns the zone associated with an activity. +`currentArea = C_LFGList.GetActivityInfoExpensive(activityID)` + +**Parameters:** +- `activityID` + - *number* - The activityID for which information is requested, as returned by `C_LFGList.GetAvailableActivities()`. + +**Returns:** +- `currentArea` + - *boolean* - True if you are in the zone of the activity, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityInfoTable.md b/wiki-information/functions/C_LFGList.GetActivityInfoTable.md new file mode 100644 index 00000000..b9e75e9f --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetActivityInfoTable.md @@ -0,0 +1,78 @@ +## Title: C_LFGList.GetActivityInfoTable + +**Content:** +Needs summary. +`activityInfo = C_LFGList.GetActivityInfoTable(activityID)` + +**Parameters:** +- `activityID` + - *number* +- `questID` + - *number?* +- `showWarmode` + - *boolean?* + +**Returns:** +- `activityInfo` + - *GroupFinderActivityInfo* + - `Field` + - `Type` + - `Description` + - `fullName` + - *string* + - `shortName` + - *string* + - `categoryID` + - *number* + - `groupFinderActivityGroupID` + - *number* + - `ilvlSuggestion` + - *number* + - `filters` + - *number* + - `minLevel` + - *number* + - `maxNumPlayers` + - *number* + - `displayType` + - *Enum.LFGListDisplayType* + - `orderIndex` + - *number* + - `useHonorLevel` + - *boolean* + - `showQuickJoinToast` + - *boolean* + - `isMythicPlusActivity` + - *boolean* + - `isRatedPvpActivity` + - *boolean* + - `isCurrentRaidActivity` + - *boolean* + - `isPvpActivity` + - *boolean* + - `isMythicActivity` + - *boolean* + - `allowCrossFaction` + - *boolean* + - *Added in 9.2.5* + - `useDungeonRoleExpectations` + - *boolean* + - *Added in 10.0.0* + +**Enum.LFGListDisplayType:** +- `Value` +- `Field` +- `Description` +- `0` + - *RoleCount* +- `1` + - *RoleEnumerate* +- `2` + - *ClassEnumerate* +- `3` + - *HideAll* +- `4` + - *PlayerCount* +- `5` + - *Comment* + - *Added in 10.0.0* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md b/wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md new file mode 100644 index 00000000..c06892d1 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md @@ -0,0 +1,28 @@ +## Title: C_LFGList.GetApplicantDungeonScoreForListing + +**Content:** +Needs summary. +`bestDungeonScoreForListing = C_LFGList.GetApplicantDungeonScoreForListing(localID, applicantIndex, activityID)` + +**Parameters:** +- `localID` + - *number* +- `applicantIndex` + - *number* +- `activityID` + - *number* + +**Returns:** +- `bestDungeonScoreForListing` + - *BestDungeonScoreMapInfo* + - `Field` + - `Type` + - `Description` + - `mapScore` + - *number* + - `mapName` + - *string* + - `bestRunLevel` + - *number* + - `finishedSuccess` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantInfo.md b/wiki-information/functions/C_LFGList.GetApplicantInfo.md new file mode 100644 index 00000000..cdb39da6 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetApplicantInfo.md @@ -0,0 +1,48 @@ +## Title: C_LFGList.GetApplicantInfo + +**Content:** +Returns status information and a custom message of an applicant. +`applicantData = C_LFGList.GetApplicantInfo(applicantID)` + +**Parameters:** +- `applicantID` + - *number* - Ascending number of applicants since the creation of the activity. + +**Returns:** +- `applicantData` + - *structure* - LfgApplicantData + - `Field` + - `Type` + - `Description` + - `applicantID` + - *number* - Same as applicantID or nil + - `applicationStatus` + - *string* + - `pendingApplicationStatus` + - *string?* - "applied", "cancelled" + - `numMembers` + - *number* - 1 or higher if a group + - `isNew` + - *boolean* + - `comment` + - *string* - Applicant custom message + - `displayOrderID` + - *number* + - `applicationStatus` + - *Value* - Description + - `applied` + - `invited` + - `failed` + - `cancelled` + - `declined` + - `declined_full` + - `declined_delisted` + - `timedout` + - `inviteaccepted` + - `invitedeclined` + +**Example Usage:** +This function can be used to retrieve detailed information about an applicant to a group activity, such as a dungeon or raid. For instance, it can be used to display the applicant's status and custom message in a custom LFG (Looking For Group) addon. + +**Addons Using This Function:** +Large addons like "ElvUI" and "DBM" (Deadly Boss Mods) may use this function to manage group applications and display relevant information to the user. For example, ElvUI could use it to enhance the LFG interface, while DBM might use it to track the status of group members. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md b/wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md new file mode 100644 index 00000000..703602cb --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md @@ -0,0 +1,46 @@ +## Title: C_LFGList.GetApplicantMemberInfo + +**Content:** +Returns info for an applicant. +`name, class, localizedClass, level, itemLevel, honorLevel, tank, healer, damage, assignedRole, relationship, dungeonScore, pvpItemLevel = C_LFGList.GetApplicantMemberInfo(applicantID, memberIndex)` + +**Parameters:** +- `applicantID` + - *number* - ascending number of applicants since creation of the activity returned by `C_LFGList.GetApplicants()` +- `memberIndex` + - *number* - iteration of `C_LFGList.GetApplicants()` argument #4 (numMembers) + +**Returns:** +1. `name` + - *string* - Character name and realm +2. `class` + - *string* - English class name (uppercase) +3. `localizedClass` + - *string* - Localized class name +4. `level` + - *number* +5. `itemLevel` + - *number* +6. `honorLevel` + - *number* +7. `tank` + - *boolean* - true if applicant offers tank role +8. `healer` + - *boolean* - true if applicant offers healer role +9. `damage` + - *boolean* - true if applicant offers damage role +10. `assignedRole` + - *string* - English role name (uppercase) +11. `relationship` + - *boolean?* - true if a friend, otherwise nil +12. `dungeonScore` + - *number* +13. `pvpItemLevel` + - *number* + +**Example Usage:** +This function can be used to retrieve detailed information about applicants for a group activity in the Looking For Group (LFG) system. For instance, an addon could use this to display a list of applicants along with their roles, item levels, and other relevant information to help the group leader make informed decisions about who to invite. + +**Addons Using This Function:** +- **ElvUI**: This popular UI overhaul addon uses `C_LFGList.GetApplicantMemberInfo` to enhance the LFG interface, providing more detailed information about applicants directly in the UI. +- **Raider.IO**: This addon uses the function to fetch and display dungeon scores and other relevant information about applicants, helping group leaders to assess the suitability of applicants for high-level Mythic+ dungeons. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantMemberStats.md b/wiki-information/functions/C_LFGList.GetApplicantMemberStats.md new file mode 100644 index 00000000..354e7af1 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetApplicantMemberStats.md @@ -0,0 +1,37 @@ +## Title: C_LFGList.GetApplicantMemberStats + +**Content:** +Returns the Proving Grounds stats of an applicant. +`stats = C_LFGList.GetApplicantMemberStats(applicantID, memberIndex)` + +**Parameters:** +- `applicantID` + - *number* - ascending number of applicants since creation of the activity returned by `C_LFGList.GetApplicants()` +- `memberIndex` + - *number* - iteration of `C_LFGList.GetApplicants()` argument #4 (numMembers) + +**Returns:** +- `stats` + - *table* + +**Description:** +Currently used to check proving ground stats of an applicant group member +- **Entry** + - **PG Tank** + - `stats>0` - Gold + - `stats>0` - Silver + - `stats>0` - Bronze +- **Entry** + - **PG Healer** + - `stats>0` - Gold + - `stats>0` - Silver + - `stats>0` - Bronze +- **Entry** + - **PG Damage** + - `stats>0` - Gold + - `stats>0` - Silver + - `stats>0` - Bronze + +**Reference:** +- `C_LFGList.GetApplicants()` +- `C_LFGList.GetApplicantMemberInfo(applicantID)` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md b/wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md new file mode 100644 index 00000000..7bec2de4 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md @@ -0,0 +1,28 @@ +## Title: C_LFGList.GetApplicantPvpRatingInfoForListing + +**Content:** +Needs summary. +`pvpRatingInfo = C_LFGList.GetApplicantPvpRatingInfoForListing(localID, applicantIndex, activityID)` + +**Parameters:** +- `localID` + - *number* +- `applicantIndex` + - *number* +- `activityID` + - *number* + +**Returns:** +- `pvpRatingInfo` + - *PvpRatingInfo* + - `Field` + - `Type` + - `Description` + - `bracket` + - *number* + - `rating` + - *number* + - `activityName` + - *string* + - `tier` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicants.md b/wiki-information/functions/C_LFGList.GetApplicants.md new file mode 100644 index 00000000..a34e80a7 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetApplicants.md @@ -0,0 +1,23 @@ +## Title: C_LFGList.GetApplicants + +**Content:** +Returns the list of applicants to your group. +`applicants = C_LFGList.GetApplicants()` + +**Returns:** +- `applicants` + - *table* - a simple table with applicantIDs (numbers) + +**Example Usage:** +This function can be used to retrieve the list of players who have applied to join your group in the Looking For Group (LFG) system. For instance, you can loop through the returned table to get details about each applicant. + +```lua +local applicants = C_LFGList.GetApplicants() +for _, applicantID in ipairs(applicants) do + -- Process each applicantID + print("Applicant ID:", applicantID) +end +``` + +**Addon Usage:** +Large addons like "ElvUI" and "DBM" (Deadly Boss Mods) may use this function to manage group applications more effectively, providing custom notifications or automating group management tasks based on the list of applicants. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetAvailableActivities.md b/wiki-information/functions/C_LFGList.GetAvailableActivities.md new file mode 100644 index 00000000..eadfe0c7 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetAvailableActivities.md @@ -0,0 +1,17 @@ +## Title: C_LFGList.GetAvailableActivities + +**Content:** +Returns a list of available LFG activities. +`activities = C_LFGList.GetAvailableActivities()` + +**Parameters:** +- `categoryID` + - *number?* - Use to only get activityIDs associated with a specific category. Use `C_LFGList.GetAvailableCategories()` to get a list of all available categoryIDs. If omitted, the function returns activities of all categories. +- `groupID` + - *number?* - Use to only get activityIDs associated with a specific group. See `C_LFGList.GetActivityGroupInfo` for more information. If omitted, the function returns activities of all groups. +- `filter` + - *number?* - Bit mask to filter the results. See `C_LFGList.GetActivityInfo` for more information. + +**Returns:** +- `activities` + - *table* - A table containing the requested activityIDs (not in order). \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md b/wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md new file mode 100644 index 00000000..35dbcf93 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md @@ -0,0 +1,15 @@ +## Title: C_LFGList.GetAvailableActivityGroups + +**Content:** +Returns a list of available LFG groups. +`groups = C_LFGList.GetAvailableActivityGroups(categoryID)` + +**Parameters:** +- `categoryID` + - *number* - The categoryID of the category you want to get available groups of. Use `C_LFGList.GetAvailableCategories()` to get a list of all available categoryIDs. +- `filter` + - *number?* - Bit mask to filter the results. See `C_LFGList.GetActivityInfo` for more information. + +**Returns:** +- `groups` + - *table* - A table containing the requested groupIDs (not in order). \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetAvailableCategories.md b/wiki-information/functions/C_LFGList.GetAvailableCategories.md new file mode 100644 index 00000000..f060fd8f --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetAvailableCategories.md @@ -0,0 +1,13 @@ +## Title: C_LFGList.GetAvailableCategories + +**Content:** +Returns a list of available LFG categories. +`categories = C_LFGList.GetAvailableCategories()` + +**Parameters:** +- `filter` + - *number?* - Bit mask to filter the results. If omitted the function returns all categories. See `C_LFGList.GetActivityInfo` for more information. + +**Returns:** +- `categories` + - *table* - A table containing the requested categoryIDs (not in order). \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetCategoryInfo.md b/wiki-information/functions/C_LFGList.GetCategoryInfo.md new file mode 100644 index 00000000..45c8ec43 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetCategoryInfo.md @@ -0,0 +1,19 @@ +## Title: C_LFGList.GetCategoryInfo + +**Content:** +Returns information about a specific category. Each category can contain many activity groups, which can contain many activities. +`name, separateRecommended, autoChoose, preferCurrentArea = C_LFGList.GetCategoryInfo(categoryID)` + +**Parameters:** +- `categoryID` + - *number* - The categoryID of the category you want to query. Use `C_LFGList.GetAvailableCategories()` to get a list of all available categoryIDs. + +**Returns:** +- `name` + - *string* - The name of the category. +- `separateRecommended` + - *boolean* +- `autoChoose` + - *boolean* +- `preferCurrentArea` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetFilteredSearchResults.md b/wiki-information/functions/C_LFGList.GetFilteredSearchResults.md new file mode 100644 index 00000000..ba1bc197 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetFilteredSearchResults.md @@ -0,0 +1,11 @@ +## Title: C_LFGList.GetFilteredSearchResults + +**Content:** +Needs summary. +`totalResultsFound, filteredResults = C_LFGList.GetFilteredSearchResults()` + +**Returns:** +- `totalResultsFound` + - *number?* = 0 +- `filteredResults` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetKeystoneForActivity.md b/wiki-information/functions/C_LFGList.GetKeystoneForActivity.md new file mode 100644 index 00000000..830f8a3e --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetKeystoneForActivity.md @@ -0,0 +1,19 @@ +## Title: C_LFGList.GetKeystoneForActivity + +**Content:** +Needs summary. +`level = C_LFGList.GetKeystoneForActivity(activityID)` + +**Parameters:** +- `activityID` + - *number* + +**Returns:** +- `level` + - *number* + +**Example Usage:** +This function can be used to retrieve the keystone level for a specific activity in the Looking For Group (LFG) system. For instance, if you have an activity ID for a Mythic+ dungeon, you can use this function to get the keystone level required for that activity. + +**Addons Usage:** +Large addons like **Raider.IO** and **Mythic Dungeon Tools** might use this function to display or calculate the keystone levels for various activities, helping players to find suitable groups for their Mythic+ runs. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md b/wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md new file mode 100644 index 00000000..30cae712 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md @@ -0,0 +1,32 @@ +## Title: C_LFGList.GetLfgCategoryInfo + +**Content:** +Needs summary. +`categoryData = C_LFGList.GetLfgCategoryInfo(categoryID)` + +**Parameters:** +- `categoryID` + - *number* + +**Returns:** +- `categoryData` + - *LfgCategoryData* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `searchPromptOverride` + - *string?* + - `separateRecommended` + - *boolean* + - `autoChooseActivity` + - *boolean* + - `preferCurrentArea` + - *boolean* + - `showPlaystyleDropdown` + - *boolean* + - `allowCrossFaction` + - *boolean* + +**Added in 9.2.5** \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetRoles.md b/wiki-information/functions/C_LFGList.GetRoles.md new file mode 100644 index 00000000..3cecde2f --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetRoles.md @@ -0,0 +1,17 @@ +## Title: C_LFGList.GetRoles + +**Content:** +Returns the currently selected Group Finder roles as a table. +`roles = C_LFGList.GetRoles()` + +**Returns:** +- `roles` + - *table* + - `Key` (*string*) + - `Value` (*boolean*) + - `dps` + - true/false + - `healer` + - true/false + - `tank` + - true/false \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetSearchResultInfo.md b/wiki-information/functions/C_LFGList.GetSearchResultInfo.md new file mode 100644 index 00000000..a0495507 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetSearchResultInfo.md @@ -0,0 +1,109 @@ +## Title: C_LFGList.GetSearchResultInfo + +**Content:** +Needs summary. +`searchResultData = C_LFGList.GetSearchResultInfo(searchResultID)` + +**Parameters:** +- `searchResultID` + - *number* + +**Returns:** +- `searchResultData` + - *LfgSearchResultData* + - `Field` + - `Type` + - `Description` + - `searchResultID` + - *number* + - `activityID` + - *number* - Activity ID for the found group. This field is not present in Classic. + - `activityIDs` + - *number* - List of activity IDs for the found group. This field is exclusive to Classic. + - `leaderName` + - *string?* + - `name` + - *string* - Protected string + - `comment` + - *string* - Protected string + - `voiceChat` + - *string* + - `requiredItemLevel` + - *number* + - `requiredHonorLevel` + - *number* + - `hasSelf` + - *boolean* - Added in 10.0.0 + - `numMembers` + - *number* + - `numBNetFriends` + - *number* + - `numCharFriends` + - *number* + - `numGuildMates` + - *number* + - `isDelisted` + - *boolean* + - `autoAccept` + - *boolean* + - `isWarMode` + - *boolean* + - `age` + - *number* + - `questID` + - *number?* + - `leaderOverallDungeonScore` + - *number?* + - `leaderDungeonScoreInfo` + - *BestDungeonScoreMapInfo?* + - `leaderPvpRatingInfo` + - *PvpRatingInfo?* + - `requiredDungeonScore` + - *number?* + - `requiredPvpRating` + - *number?* + - `playstyle` + - *Enum.LFGEntryPlaystyle?* + - `crossFactionListing` + - *boolean?* - Added in 9.2.5 + - `leaderFactionGroup` + - *number* - Added in 9.2.5 + +**BestDungeonScoreMapInfo** +- `Field` +- `Type` +- `Description` +- `mapScore` + - *number* +- `mapName` + - *string* +- `bestRunLevel` + - *number* +- `finishedSuccess` + - *boolean* + +**PvpRatingInfo** +- `Field` +- `Type` +- `Description` +- `bracket` + - *number* +- `rating` + - *number* +- `activityName` + - *string* +- `tier` + - *number* + +**Enum.LFGEntryPlaystyle** +- `Value` +- `Field` +- `Description` +- `0` + - None +- `1` + - Standard +- `2` + - Casual +- `3` + - Hardcore \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetSearchResults.md b/wiki-information/functions/C_LFGList.GetSearchResults.md new file mode 100644 index 00000000..4f68f4b8 --- /dev/null +++ b/wiki-information/functions/C_LFGList.GetSearchResults.md @@ -0,0 +1,11 @@ +## Title: C_LFGList.GetSearchResults + +**Content:** +Returns a table of search result IDs. +`totalResultsFound, results = C_LFGList.GetSearchResults()` + +**Returns:** +- `totalResultsFound` + - *number?* = 0 - Total number of IDs inside results +- `results` + - *number* - Table of resultIDs \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.HasActiveEntryInfo.md b/wiki-information/functions/C_LFGList.HasActiveEntryInfo.md new file mode 100644 index 00000000..1a41f76a --- /dev/null +++ b/wiki-information/functions/C_LFGList.HasActiveEntryInfo.md @@ -0,0 +1,9 @@ +## Title: C_LFGList.HasActiveEntryInfo + +**Content:** +Needs summary. +`hasActiveEntryInfo = C_LFGList.HasActiveEntryInfo()` + +**Returns:** +- `hasActiveEntryInfo` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.HasSearchResultInfo.md b/wiki-information/functions/C_LFGList.HasSearchResultInfo.md new file mode 100644 index 00000000..39ae7548 --- /dev/null +++ b/wiki-information/functions/C_LFGList.HasSearchResultInfo.md @@ -0,0 +1,13 @@ +## Title: C_LFGList.HasSearchResultInfo + +**Content:** +Needs summary. +`hasSearchResultInfo = C_LFGList.HasSearchResultInfo(searchResultID)` + +**Parameters:** +- `searchResultID` + - *number* + +**Returns:** +- `hasSearchResultInfo` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.InviteApplicant.md b/wiki-information/functions/C_LFGList.InviteApplicant.md new file mode 100644 index 00000000..883f7209 --- /dev/null +++ b/wiki-information/functions/C_LFGList.InviteApplicant.md @@ -0,0 +1,12 @@ +## Title: C_LFGList.InviteApplicant + +**Content:** +Invites a queued applicant to your group. +`C_LFGList.InviteApplicant(applicantID)` + +**Parameters:** +- `applicantID` + - *number* + +**Reference:** +- 2014-10-14, LFGList.xml, version 6.0.2.19033, near line 281, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md b/wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md new file mode 100644 index 00000000..7ad100c3 --- /dev/null +++ b/wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md @@ -0,0 +1,19 @@ +## Title: C_LFGList.IsPlayerAuthenticatedForLFG + +**Content:** +Needs summary. +`isAuthenticated = C_LFGList.IsPlayerAuthenticatedForLFG()` + +**Parameters:** +- `activityID` + - *number?* : GroupFinderActivity.ID + +**Returns:** +- `isAuthenticated` + - *boolean* + +**Example Usage:** +This function can be used to check if a player is authenticated for a specific activity in the Looking For Group (LFG) system. For instance, before attempting to join a group for a dungeon or raid, you can verify if the player meets the necessary authentication requirements. + +**Addons:** +Large addons like "Deadly Boss Mods (DBM)" and "ElvUI" might use this function to ensure that players meet the necessary criteria before allowing them to join specific group activities. This helps in maintaining the integrity and smooth functioning of group activities by ensuring all participants are properly authenticated. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.RemoveListing.md b/wiki-information/functions/C_LFGList.RemoveListing.md new file mode 100644 index 00000000..031e72b2 --- /dev/null +++ b/wiki-information/functions/C_LFGList.RemoveListing.md @@ -0,0 +1,14 @@ +## Title: C_LFGList.RemoveListing + +**Content:** +Needs summary. +`C_LFGList.RemoveListing()` + +**Description:** +This function is used to remove a listing from the Looking For Group (LFG) system. It is typically called when a player no longer wants their group to be listed for others to join. + +**Example Usage:** +A player might use this function to remove their group from the LFG listing after they have found enough members or decided to disband the group. + +**Addons:** +Large addons like "Premade Groups Filter" and "LFG Bulletin Board" might use this function to manage group listings dynamically based on user preferences and group status. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.RequestAvailableActivities.md b/wiki-information/functions/C_LFGList.RequestAvailableActivities.md new file mode 100644 index 00000000..a652bb5b --- /dev/null +++ b/wiki-information/functions/C_LFGList.RequestAvailableActivities.md @@ -0,0 +1,11 @@ +## Title: C_LFGList.RequestAvailableActivities + +**Content:** +Signals the server to request that it send the client information about available activities. +`C_LFGList.RequestAvailableActivities()` + +**Reference:** +- `LFG_LIST_AVAILABILITY_UPDATE`, when this information is available to the client + +**Description:** +This is a prerequisite for at least some of the `C_LFGList.GetAvailable*` functions to return meaningful data. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.SetRoles.md b/wiki-information/functions/C_LFGList.SetRoles.md new file mode 100644 index 00000000..810508f1 --- /dev/null +++ b/wiki-information/functions/C_LFGList.SetRoles.md @@ -0,0 +1,21 @@ +## Title: C_LFGList.SetRoles + +**Content:** +Sets the player's Group Finder roles +`success = C_LFGList.SetRoles(roles)` + +**Parameters:** +- `roles` + - *table* - A table with each role as a string key, and a boolean value for whether that role should be selected. All roles must be present in the table. + - `Key (string)` + - `Value (boolean)` + - `dps` + - true/false + - `healer` + - true/false + - `tank` + - true/false + +**Returns:** +- `success` + - *boolean* - Whether setting the roles was successful or not \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.SetSearchToQuestID.md b/wiki-information/functions/C_LFGList.SetSearchToQuestID.md new file mode 100644 index 00000000..8673295b --- /dev/null +++ b/wiki-information/functions/C_LFGList.SetSearchToQuestID.md @@ -0,0 +1,9 @@ +## Title: C_LFGList.SetSearchToQuestID + +**Content:** +Needs summary. +`C_LFGList.SetSearchToQuestID(questID)` + +**Parameters:** +- `questID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.UpdateListing.md b/wiki-information/functions/C_LFGList.UpdateListing.md new file mode 100644 index 00000000..78623b19 --- /dev/null +++ b/wiki-information/functions/C_LFGList.UpdateListing.md @@ -0,0 +1,41 @@ +## Title: C_LFGList.UpdateListing + +**Content:** +Updates information for the players' currently listed group. +```lua +-- Retail +C_LFGList.UpdateListing(activityID, itemLevel, honorLevel, autoAccept, privateGroup) +-- Classic +C_LFGList.UpdateListing(activityIDs) +``` + +**Parameters:** + +**Retail:** +- `activityID` + - *number* - Activity ID to register the group for. +- `itemLevel` + - *number* - Minimum required item level for group applicants. +- `honorLevel` + - *number* - Minimum required honor level for group applicants. +- `autoAccept` + - *boolean* - If true, new applicants will be automatically invited to join the group. +- `privateGroup` + - *boolean* - If true, the listing will only be visible to friends and guild members of players inside the group. +- `questID` + - *number?* - Optional quest ID to associate with the group listing. +- `mythicPlusRating` + - *number?* - Optional mythic plus rating needed to signup to the group listing. +- `pvpRating` + - *number?* - Optional pvp rating needed to signup to the group listing. +- `selectedPlaystyle` + - *number?* - Refers to Enum.LFGEntryPlaystyle values. +- `isCrossFaction` + - *boolean = true* - Optional. If false, the group listing will not be visible to players of the opposite faction. If nil, true will be assumed. + +**Classic:** +- `activityIDs` + - *number* - Table of up to three activity IDs to register the group listing for. + +**Description:** +For Classic, a player can register interest in a maximum of three activities at once. Other options for listings such as preferred item level, auto-accept, and private groups do not exist. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md b/wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md new file mode 100644 index 00000000..2a3ba9b5 --- /dev/null +++ b/wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md @@ -0,0 +1,19 @@ +## Title: C_LFGList.ValidateRequiredDungeonScore + +**Content:** +Needs summary. +`passes = C_LFGList.ValidateRequiredDungeonScore(dungeonScore)` + +**Parameters:** +- `dungeonScore` + - *number* + +**Returns:** +- `passes` + - *boolean* + +**Example Usage:** +This function can be used to validate if a player's dungeon score meets the required threshold for a specific dungeon or activity in the Looking For Group (LFG) system. + +**Addons Usage:** +Large addons like **Raider.IO** might use this function to check if a player's dungeon score qualifies them for certain group activities or dungeons. This helps in automating the process of group formation based on player performance metrics. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md b/wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md new file mode 100644 index 00000000..285c0bd4 --- /dev/null +++ b/wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md @@ -0,0 +1,21 @@ +## Title: C_LFGList.ValidateRequiredPvpRatingForActivity + +**Content:** +Needs summary. +`passes = C_LFGList.ValidateRequiredPvpRatingForActivity(activityID, rating)` + +**Parameters:** +- `activityID` + - *number* +- `rating` + - *number* + +**Returns:** +- `passes` + - *boolean* + +**Example Usage:** +This function can be used to check if a player's PvP rating meets the required rating for a specific activity in the Looking For Group (LFG) system. + +**Addons Usage:** +Large addons like "Premade Groups Filter" might use this function to filter out activities based on the player's PvP rating, ensuring that only eligible activities are shown to the player. \ No newline at end of file diff --git a/wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md b/wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md new file mode 100644 index 00000000..ccb27eae --- /dev/null +++ b/wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Loot.IsLegacyLootModeEnabled + +**Content:** +Needs summary. +`isLegacyLootModeEnabled = C_Loot.IsLegacyLootModeEnabled()` + +**Returns:** +- `isLegacyLootModeEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LootHistory.GetItem.md b/wiki-information/functions/C_LootHistory.GetItem.md new file mode 100644 index 00000000..0ef773bd --- /dev/null +++ b/wiki-information/functions/C_LootHistory.GetItem.md @@ -0,0 +1,23 @@ +## Title: C_LootHistory.GetItem + +**Content:** +Returns item details for a loot event. +`rollID, itemLink, numPlayers, isDone, winnerIdx, isMasterLoot = C_LootHistory.GetItem(itemIdx)` + +**Parameters:** +- `itemIdx` + - *number* - Loot history ID + +**Returns:** +- `rollID` + - *number* +- `itemLink` + - *string* +- `numPlayers` + - *number* - Total players eligible for item +- `isDone` + - *boolean* +- `winnerIdx` + - *number* - See C_LootHistory.GetPlayerInfo +- `isMasterLoot` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LootHistory.GetPlayerInfo.md b/wiki-information/functions/C_LootHistory.GetPlayerInfo.md new file mode 100644 index 00000000..e46233af --- /dev/null +++ b/wiki-information/functions/C_LootHistory.GetPlayerInfo.md @@ -0,0 +1,23 @@ +## Title: C_LootHistory.GetPlayerInfo + +**Content:** +Returns player details for a loot event. +`name, class, rollType, roll, isWinner, isMe = C_LootHistory.GetPlayerInfo(itemIdx, playerIdx)` + +**Parameters:** +- `itemIdx` + - *number* - See `C_LootHistory.GetItem` + +**Returns:** +- `name` + - *string* +- `class` + - *string* +- `rollType` + - *number* - (0: pass, 1: need, 2: greed, 3: disenchant) +- `roll` + - *number* +- `isWinner` + - *boolean* +- `isMe` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md new file mode 100644 index 00000000..f8f72d2a --- /dev/null +++ b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md @@ -0,0 +1,51 @@ +## Title: C_LossOfControl.GetActiveLossOfControlData + +**Content:** +Returns info about an active loss-of-control effect. +`event = C_LossOfControl.GetActiveLossOfControlData(index)` +`event = C_LossOfControl.GetActiveLossOfControlDataByUnit(unitToken, index)` + +**Parameters:** + +*GetActiveLossOfControlData:* +- `index` + - *number* - Ranging from 1 to `C_LossOfControl.GetActiveLossOfControlDataCount()` + +*GetActiveLossOfControlDataByUnit:* +- `unitToken` + - *string* : UnitId - Only works while in commentator mode. +- `index` + - *number* + +**Returns:** +- `event` + - *LossOfControlData?* + - `Field` + - `Type` + - `Description` + - `locType` + - *string* - Effect type, e.g. "SCHOOL_INTERRUPT" + - `spellID` + - *number* - Spell ID causing the effect + - `displayText` + - *string* - Name of the effect, e.g. "Interrupted" + - `iconTexture` + - *number* - FileID + - `startTime` + - *number?* - Time at which this effect began, as per `GetTime()` + - `timeRemaining` + - *number?* - Number of seconds remaining. + - `duration` + - *number?* - Duration of the effect, in seconds. + - `lockoutSchool` + - *number* - Locked out spell school identifier; can be fed into `GetSchoolString()` to retrieve school name. + - `priority` + - *number* + - `displayType` + - *number* - An integer specifying how this event should be displayed to the player, per the Interface-configured options: + - 0: the effect should not be displayed. + - 1: the effect should be displayed as a brief alert when it occurs. + - 2: the effect should be displayed for its full duration. + +**Description:** +Loss of Control debuffs that are applied only while standing in an Area of Effect may not include a `startTime`, `timeRemaining` nor `duration` in the table returned. An example of this is Vol'zith the Whisperer's Yawning Gate ability. \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md new file mode 100644 index 00000000..52b5002f --- /dev/null +++ b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md @@ -0,0 +1,52 @@ +## Title: C_LossOfControl.GetActiveLossOfControlData + +**Content:** +Returns info about an active loss-of-control effect. +```lua +event = C_LossOfControl.GetActiveLossOfControlData(index) +event = C_LossOfControl.GetActiveLossOfControlDataByUnit(unitToken, index) +``` + +**Parameters:** +- **GetActiveLossOfControlData:** + - `index` + - *number* - Ranging from 1 to `C_LossOfControl.GetActiveLossOfControlDataCount()` + +- **GetActiveLossOfControlDataByUnit:** + - `unitToken` + - *string* : UnitId - Only works while in commentator mode. + - `index` + - *number* + +**Returns:** +- `event` + - *LossOfControlData?* + - `Field` + - `Type` + - `Description` + - `locType` + - *string* - Effect type, e.g. "SCHOOL_INTERRUPT" + - `spellID` + - *number* - Spell ID causing the effect + - `displayText` + - *string* - Name of the effect, e.g. "Interrupted" + - `iconTexture` + - *number* - FileID + - `startTime` + - *number?* - Time at which this effect began, as per `GetTime()` + - `timeRemaining` + - *number?* - Number of seconds remaining. + - `duration` + - *number?* - Duration of the effect, in seconds. + - `lockoutSchool` + - *number* - Locked out spell school identifier; can be fed into `GetSchoolString()` to retrieve school name. + - `priority` + - *number* + - `displayType` + - *number* - An integer specifying how this event should be displayed to the player, per the Interface-configured options: + - 0: the effect should not be displayed. + - 1: the effect should be displayed as a brief alert when it occurs. + - 2: the effect should be displayed for its full duration. + +**Description:** +Loss of Control debuffs that are applied only while standing in an Area of Effect may not include a `startTime`, `timeRemaining` nor `duration` in the table returned. An example of this is Vol'zith the Whisperer's Yawning Gate ability. \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md new file mode 100644 index 00000000..f8d207ff --- /dev/null +++ b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md @@ -0,0 +1,18 @@ +## Title: C_LossOfControl.GetActiveLossOfControlDataCount + +**Content:** +Returns the number of active loss-of-control effects. +`count = C_LossOfControl.GetActiveLossOfControlDataCount()` +`count = C_LossOfControl.GetActiveLossOfControlDataCountByUnit(unitToken)` + +**Parameters:** +- **GetActiveLossOfControlDataCount:** + - None + +- **GetActiveLossOfControlDataCountByUnit:** + - `unitToken` + - *string* : UnitId - Only works while in commentator mode. + +**Returns:** +- `count` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md new file mode 100644 index 00000000..25af75e5 --- /dev/null +++ b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md @@ -0,0 +1,20 @@ +## Title: C_LossOfControl.GetActiveLossOfControlDataCount + +**Content:** +Returns the number of active loss-of-control effects. +```lua +count = C_LossOfControl.GetActiveLossOfControlDataCount() +count = C_LossOfControl.GetActiveLossOfControlDataCountByUnit(unitToken) +``` + +**Parameters:** +- **GetActiveLossOfControlDataCount:** + - None + +- **GetActiveLossOfControlDataCountByUnit:** + - `unitToken` + - *string* : UnitId - Only works while in commentator mode. + +**Returns:** +- `count` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Mail.HasInboxMoney.md b/wiki-information/functions/C_Mail.HasInboxMoney.md new file mode 100644 index 00000000..8a982c2b --- /dev/null +++ b/wiki-information/functions/C_Mail.HasInboxMoney.md @@ -0,0 +1,19 @@ +## Title: C_Mail.HasInboxMoney + +**Content:** +Returns true if a mail has money attached. +`inboxItemHasMoneyAttached = C_Mail.HasInboxMoney(inboxIndex)` + +**Parameters:** +- `inboxIndex` + - *number* + +**Returns:** +- `inboxItemHasMoneyAttached` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific mail in the player's inbox contains money. This is useful for addons that manage mail, such as those that automate the collection of auction house sales or other financial transactions. + +**Addon Usage:** +Large addons like Postal use this function to help manage and display mail contents efficiently. Postal, for example, can use this function to highlight mails that contain money, making it easier for players to quickly identify and collect their earnings. \ No newline at end of file diff --git a/wiki-information/functions/C_Mail.IsCommandPending.md b/wiki-information/functions/C_Mail.IsCommandPending.md new file mode 100644 index 00000000..4a4b46a0 --- /dev/null +++ b/wiki-information/functions/C_Mail.IsCommandPending.md @@ -0,0 +1,9 @@ +## Title: C_Mail.IsCommandPending + +**Content:** +Returns true if the current mail command is still processing. +`isCommandPending = C_Mail.IsCommandPending()` + +**Returns:** +- `isCommandPending` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetAreaInfo.md b/wiki-information/functions/C_Map.GetAreaInfo.md new file mode 100644 index 00000000..beb42aa8 --- /dev/null +++ b/wiki-information/functions/C_Map.GetAreaInfo.md @@ -0,0 +1,16 @@ +## Title: C_Map.GetAreaInfo + +**Content:** +Returns a map subzone name. +`name = C_Map.GetAreaInfo(areaID)` + +**Parameters:** +- `areaID` + - *number* - AreaTable.db2 + +**Returns:** +- `name` + - *string* + +**Reference:** +- `C_MapExplorationInfo.GetExploredAreaIDsAtPosition()` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetBestMapForUnit.md b/wiki-information/functions/C_Map.GetBestMapForUnit.md new file mode 100644 index 00000000..d6ed231d --- /dev/null +++ b/wiki-information/functions/C_Map.GetBestMapForUnit.md @@ -0,0 +1,29 @@ +## Title: C_Map.GetBestMapForUnit + +**Content:** +Returns the current UI map for the given unit. Only works for the player and group members. +`uiMapID = C_Map.GetBestMapForUnit(unitToken)` + +**Parameters:** +- `unitToken` + - *string* : UnitId + +**Returns:** +- `uiMapID` + - *number?* : UiMapID - Returns the "lowest" map the unit is on. For example, if a unit is in a microdungeon it will return that instead of the zone or continent map. + +**Description:** +Related API: +- `C_Map.GetMapInfo` +- `GetInstanceInfo` + +Related Events: +- `ZONE_CHANGED` +- `ZONE_CHANGED_NEW_AREA` + +**Usage:** +Prints the current map for the player. +```lua +/run local mapID = C_Map.GetBestMapForUnit("player"); print(format("You are in %s (%d)", C_Map.GetMapInfo(mapID).name, mapID)) +-- You are in Stormwind City (84) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetBountySetIDForMap.md b/wiki-information/functions/C_Map.GetBountySetIDForMap.md new file mode 100644 index 00000000..483fc07a --- /dev/null +++ b/wiki-information/functions/C_Map.GetBountySetIDForMap.md @@ -0,0 +1,13 @@ +## Title: C_Map.GetBountySetIDForMap + +**Content:** +Needs summary. +`bountySetID = C_Map.GetBountySetIDForMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* + +**Returns:** +- `bountySetID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetFallbackWorldMapID.md b/wiki-information/functions/C_Map.GetFallbackWorldMapID.md new file mode 100644 index 00000000..bd0da331 --- /dev/null +++ b/wiki-information/functions/C_Map.GetFallbackWorldMapID.md @@ -0,0 +1,10 @@ +## Title: C_Map.GetFallbackWorldMapID + +**Content:** +Returns the world map id. +`uiMapID = C_Map.GetFallbackWorldMapID()` + +**Returns:** +- `uiMapID` + - *number* - UiMapID + - Returns 947 (Azeroth) \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md b/wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md new file mode 100644 index 00000000..c9b3072c --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md @@ -0,0 +1,23 @@ +## Title: C_Map.GetMapArtBackgroundAtlas + +**Content:** +Returns the background atlas for a map. +`atlasName = C_Map.GetMapArtBackgroundAtlas(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* : UiMapID + - **Values:** + - `ID` | `Atlas` + - `993` | `AdventureMap_TileBg` + - `994` | `AdventureMap_TileBg` + - `1011` | `AdventureMap_TileBg` + - `1014` | `AdventureMap_TileBg` + - `1208` | `AdventureMap_TileBg` + - `1209` | `AdventureMap_TileBg` + - `1384` | `AdventureMap_TileBg` + - `1467` | `AdventureMap_TileBg` + +**Returns:** +- `atlasName` + - *string* - AtlasID \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md b/wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md new file mode 100644 index 00000000..e4293176 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md @@ -0,0 +1,26 @@ +## Title: C_Map.GetMapArtHelpTextPosition + +**Content:** +Returns the position for the "Click to Zoom In" hint text on flight maps. +`position = C_Map.GetMapArtHelpTextPosition(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* : UiMapID + +**Returns:** +- `position` + - *Enum.MapCanvasPosition* + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - BottomLeft + - `2` + - BottomRight + - `3` + - TopLeft + - `4` + - TopRight \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtID.md b/wiki-information/functions/C_Map.GetMapArtID.md new file mode 100644 index 00000000..00402546 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapArtID.md @@ -0,0 +1,19 @@ +## Title: C_Map.GetMapArtID + +**Content:** +Returns the art for a (phased) map. +`uiMapArtID = C_Map.GetMapArtID(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `uiMapArtID` + - *number* + +**Example Usage:** +This function can be used to retrieve the art ID for a specific map, which can then be used to display the correct map art in a custom UI or addon. + +**Addon Usage:** +Large addons like "TomTom" or "HandyNotes" might use this function to ensure they are displaying the correct map art for phased areas, ensuring that waypoints and notes are accurately placed on the map. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtLayerTextures.md b/wiki-information/functions/C_Map.GetMapArtLayerTextures.md new file mode 100644 index 00000000..b1cf60a5 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapArtLayerTextures.md @@ -0,0 +1,32 @@ +## Title: C_Map.GetMapArtLayerTextures + +**Content:** +Returns the art layer textures for a map. +`textures = C_Map.GetMapArtLayerTextures(uiMapID, layerIndex)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID +- `layerIndex` + - *number* + +**Returns:** +- `textures` + - *number* + +**Description:** +This function is used to retrieve the textures for a specific art layer of a map. It can be useful for addons that need to display or manipulate map textures. + +**Example Usage:** +```lua +local uiMapID = 1415 -- Example map ID +local layerIndex = 1 -- Example layer index +local textures = C_Map.GetMapArtLayerTextures(uiMapID, layerIndex) +for i, texture in ipairs(textures) do + print("Texture " .. i .. ": " .. texture) +end +``` + +**Addons Using This Function:** +- **Mapster**: An addon that enhances the World Map. It uses this function to retrieve and display custom map textures. +- **HandyNotes**: An addon that adds custom notes to the world map. It may use this function to overlay additional textures on the map. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtLayers.md b/wiki-information/functions/C_Map.GetMapArtLayers.md new file mode 100644 index 00000000..a7da9dae --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapArtLayers.md @@ -0,0 +1,30 @@ +## Title: C_Map.GetMapArtLayers + +**Content:** +Returns the art layers for a map. +`layerInfo = C_Map.GetMapArtLayers(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `layerInfo` + - *UiMapLayerInfo* + - `Field` + - `Type` + - `Description` + - `layerWidth` + - *number* + - `layerHeight` + - *number* + - `tileWidth` + - *number* + - `tileHeight` + - *number* + - `minScale` + - *number* + - `maxScale` + - *number* + - `additionalZoomSteps` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapBannersForMap.md b/wiki-information/functions/C_Map.GetMapBannersForMap.md new file mode 100644 index 00000000..f16868af --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapBannersForMap.md @@ -0,0 +1,24 @@ +## Title: C_Map.GetMapBannersForMap + +**Content:** +Returns the poi banners for a map. +`mapBanners = C_Map.GetMapBannersForMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `mapBanners` + - *MapBannerInfo* + - `Field` + - `Type` + - `Description` + - `areaPoiID` + - *number* + - `name` + - *string* + - `atlasName` + - *string* + - `uiTextureKit` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapChildrenInfo.md b/wiki-information/functions/C_Map.GetMapChildrenInfo.md new file mode 100644 index 00000000..ee7d24c5 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapChildrenInfo.md @@ -0,0 +1,109 @@ +## Title: C_Map.GetMapChildrenInfo + +**Content:** +Returns info for the children of a map. +`info = C_Map.GetMapChildrenInfo(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID +- `mapType` + - *Enum.UIMapType?* - Filters results by a specific map type. +- `allDescendants` + - *boolean?* - Whether to recurse on each child or not. + +**Returns:** +- `info` + - *UiMapDetails* + - `Field` + - `Type` + - `Description` + - `mapID` + - *number* - UiMapID + - `name` + - *string* + - `mapType` + - *Enum.UIMapType* + - `parentMapID` + - *number* - Returns 0 if there is no parent map + - `flags` + - *Enum.UIMapFlag* - Added in 9.0.1 + +**Enum.UIMapType:** +- `Value` +- `Field` +- `Description` +- `0` + - Cosmic +- `1` + - World +- `2` + - Continent +- `3` + - Zone +- `4` + - Dungeon +- `5` + - Micro +- `6` + - Orphan + +**Enum.UIMapFlag:** +- `Value` +- `Field` +- `Description` +- `0x1` + - NoHighlight +- `0x2` + - ShowOverlays +- `0x4` + - ShowTaxiNodes +- `0x8` + - GarrisonMap +- `0x10` + - FallbackToParentMap +- `0x20` + - NoHighlightTexture +- `0x40` + - ShowTaskObjectives +- `0x80` + - NoWorldPositions +- `0x100` + - HideArchaeologyDigs +- `0x200` + - DoNotTranslateBranches (Renamed from Deprecated in 10.2.5) +- `0x400` + - HideIcons +- `0x800` + - HideVignettes +- `0x1000` + - ForceAllOverlayExplored +- `0x2000` + - FlightMapShowZoomOut +- `0x4000` + - FlightMapAutoZoom +- `0x8000` + - ForceOnNavbar +- `0x10000` + - AlwaysAllowUserWaypoints +- `0x20000` + - AlwaysAllowTaxiPathing + +**Usage:** +Children of the "Cosmic" uiMapID (not to be confused with the UIMapType). +```lua +/dump C_Map.GetMapChildrenInfo(946) +{ + {mapType=2, mapID=101, name="Outland", parentMapID=946}, + {mapType=2, mapID=572, name="Draenor", parentMapID=946}, + {mapType=1, mapID=947, name="Azeroth", parentMapID=946} +} +``` +Children of the "Cosmic" uiMapID with mapType==2 +```lua +/dump C_Map.GetMapChildrenInfo(946, 2) +{ + {mapType=2, mapID=101, name="Outland", parentMapID=946}, + {mapType=2, mapID=572, name="Draenor", parentMapID=946} +} +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapDisplayInfo.md b/wiki-information/functions/C_Map.GetMapDisplayInfo.md new file mode 100644 index 00000000..960fca04 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapDisplayInfo.md @@ -0,0 +1,19 @@ +## Title: C_Map.GetMapDisplayInfo + +**Content:** +Returns whether group member pins should be hidden. +`hideIcons = C_Map.GetMapDisplayInfo(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `hideIcons` + - *boolean* + +**Example Usage:** +This function can be used to determine if the map should hide group member icons, which can be useful for custom map displays or addons that modify the map interface. + +**Addon Usage:** +Large addons like "TomTom" or "HandyNotes" might use this function to decide whether to display group member icons on custom map overlays. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapGroupID.md b/wiki-information/functions/C_Map.GetMapGroupID.md new file mode 100644 index 00000000..925a82b9 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapGroupID.md @@ -0,0 +1,19 @@ +## Title: C_Map.GetMapGroupID + +**Content:** +Returns the map group for a map. +`uiMapGroupID = C_Map.GetMapGroupID(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `uiMapGroupID` + - *number* + +**Example Usage:** +This function can be used to determine the group ID of a specific map, which can be useful for addons that need to handle map-related data, such as displaying map overlays or managing map transitions. + +**Addons:** +Large addons like "TomTom" and "World Quest Tracker" might use this function to manage and display map-related information efficiently. For example, "TomTom" could use it to group waypoints by map group, while "World Quest Tracker" might use it to organize world quests by their map groups. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapGroupMembersInfo.md b/wiki-information/functions/C_Map.GetMapGroupMembersInfo.md new file mode 100644 index 00000000..6f249e4b --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapGroupMembersInfo.md @@ -0,0 +1,22 @@ +## Title: C_Map.GetMapGroupMembersInfo + +**Content:** +Returns the floors for a map group. +`info = C_Map.GetMapGroupMembersInfo(uiMapGroupID)` + +**Parameters:** +- `uiMapGroupID` + - *number* + +**Returns:** +- `info` + - *table* `UiMapGroupMemberInfo` + - `Field` + - `Type` + - `Description` + - `mapID` + - *number* - `UiMapID` + - `relativeHeightIndex` + - *number* + - `name` + - *string* - Floor name \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md b/wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md new file mode 100644 index 00000000..ab2e07ff --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md @@ -0,0 +1,31 @@ +## Title: C_Map.GetMapHighlightInfoAtPosition + +**Content:** +Returns a map highlight pin for a location. +`fileDataID, atlasID, texturePercentageX, texturePercentageY, textureX, textureY, scrollChildX, scrollChildY = C_Map.GetMapHighlightInfoAtPosition(uiMapID, x, y)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID +- `x` + - *number* +- `y` + - *number* + +**Returns:** +- `fileDataID` + - *number* - FileDataID +- `atlasID` + - *string* - AtlasID +- `texturePercentageX` + - *number* +- `texturePercentageY` + - *number* +- `textureX` + - *number* +- `textureY` + - *number* +- `scrollChildX` + - *number* +- `scrollChildY` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapInfo.md b/wiki-information/functions/C_Map.GetMapInfo.md new file mode 100644 index 00000000..932dc585 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapInfo.md @@ -0,0 +1,100 @@ +## Title: C_Map.GetMapInfo + +**Content:** +Returns map information. +`info = C_Map.GetMapInfo(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* : UiMapID + +**Returns:** +- `info` + - *UiMapDetails* + - `Field` + - `Type` + - `Description` + - `mapID` + - *number* - UiMapID + - `name` + - *string* + - `mapType` + - *Enum.UIMapType* + - `parentMapID` + - *number* - Returns 0 if there is no parent map + - `flags` + - *Enum.UIMapFlag* - Added in 9.0.1 + +**Enum.UIMapType:** +- `Value` +- `Field` +- `Description` + - `0` + - Cosmic + - `1` + - World + - `2` + - Continent + - `3` + - Zone + - `4` + - Dungeon + - `5` + - Micro + - `6` + - Orphan + +**Enum.UIMapFlag:** +- `Value` +- `Field` +- `Description` + - `0x1` + - NoHighlight + - `0x2` + - ShowOverlays + - `0x4` + - ShowTaxiNodes + - `0x8` + - GarrisonMap + - `0x10` + - FallbackToParentMap + - `0x20` + - NoHighlightTexture + - `0x40` + - ShowTaskObjectives + - `0x80` + - NoWorldPositions + - `0x100` + - HideArchaeologyDigs + - `0x200` + - DoNotTranslateBranches (Renamed from Deprecated in 10.2.5) + - `0x400` + - HideIcons + - `0x800` + - HideVignettes + - `0x1000` + - ForceAllOverlayExplored + - `0x2000` + - FlightMapShowZoomOut + - `0x4000` + - FlightMapAutoZoom + - `0x8000` + - ForceOnNavbar + - `0x10000` + - AlwaysAllowUserWaypoints + - `0x20000` + - AlwaysAllowTaxiPathing + +**Description:** +- **Related API:** + - `C_Map.GetBestMapForUnit` +- **Related Events:** + - `ZONE_CHANGED` + - `ZONE_CHANGED_NEW_AREA` + +**Usage:** +Prints the current map for the player. +```lua +/run local mapID = C_Map.GetBestMapForUnit("player"); print(format("You are in %s (%d)", C_Map.GetMapInfo(mapID).name, mapID)) +-- You are in Stormwind City (84) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapInfoAtPosition.md b/wiki-information/functions/C_Map.GetMapInfoAtPosition.md new file mode 100644 index 00000000..896c3b05 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapInfoAtPosition.md @@ -0,0 +1,99 @@ +## Title: C_Map.GetMapInfoAtPosition + +**Content:** +Returns info for any child or adjacent maps at a position on the map. +`info = C_Map.GetMapInfoAtPosition(uiMapID, x, y)` + +**Parameters:** +- `uiMapID` + - *number* : UiMapID +- `x` + - *number* +- `y` + - *number* +- `ignoreZoneMapPositionData` + - *boolean?* + +**Returns:** +- `info` + - *UiMapDetails* + - `Field` + - `Type` + - `Description` + - `mapID` + - *number* - UiMapID + - `name` + - *string* + - `mapType` + - *Enum.UIMapType* + - `parentMapID` + - *number* - Returns 0 if there is no parent map + - `flags` + - *Enum.UIMapFlag* - Added in 9.0.1 + +**Enum.UIMapType:** +- `Value` +- `Field` +- `Description` + - `0` + - Cosmic + - `1` + - World + - `2` + - Continent + - `3` + - Zone + - `4` + - Dungeon + - `5` + - Micro + - `6` + - Orphan + +**Enum.UIMapFlag:** +- `Value` +- `Field` +- `Description` + - `0x1` + - NoHighlight + - `0x2` + - ShowOverlays + - `0x4` + - ShowTaxiNodes + - `0x8` + - GarrisonMap + - `0x10` + - FallbackToParentMap + - `0x20` + - NoHighlightTexture + - `0x40` + - ShowTaskObjectives + - `0x80` + - NoWorldPositions + - `0x100` + - HideArchaeologyDigs + - `0x200` + - DoNotTranslateBranches (Renamed from Deprecated in 10.2.5) + - `0x400` + - HideIcons + - `0x800` + - HideVignettes + - `0x1000` + - ForceAllOverlayExplored + - `0x2000` + - FlightMapShowZoomOut + - `0x4000` + - FlightMapAutoZoom + - `0x8000` + - ForceOnNavbar + - `0x10000` + - AlwaysAllowUserWaypoints + - `0x20000` + - AlwaysAllowTaxiPathing + +**Description:** +No return value in instances, the WoD Garrison, the beginning of the new player experience, or empty regions of the cosmic map. +Otherwise, returns map info for: +- Child maps, such as zones in a continent. +- Adjacent maps, such as zones next to the current one. +- The current map, similar to `C_Map.GetMapInfo()`. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapLevels.md b/wiki-information/functions/C_Map.GetMapLevels.md new file mode 100644 index 00000000..c17298dc --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapLevels.md @@ -0,0 +1,19 @@ +## Title: C_Map.GetMapLevels + +**Content:** +Returns the suggested player and battle pet levels for a map. +`playerMinLevel, playerMaxLevel, petMinLevel, petMaxLevel = C_Map.GetMapLevels(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `playerMinLevel` + - *number* +- `playerMaxLevel` + - *number* +- `petMinLevel` + - *number?* = 0 +- `petMaxLevel` + - *number?* = 0 \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapLinksForMap.md b/wiki-information/functions/C_Map.GetMapLinksForMap.md new file mode 100644 index 00000000..73bd91bb --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapLinksForMap.md @@ -0,0 +1,26 @@ +## Title: C_Map.GetMapLinksForMap + +**Content:** +Returns the map pins that link to another map. +`mapLinks = C_Map.GetMapLinksForMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `mapLinks` + - *MapLinkInfo* + - `Field` + - `Type` + - `Description` + - `areaPoiID` + - *number* + - `position` + - *Vector2DMixin* 🔗 + - `name` + - *string* + - `atlasName` + - *string* + - `linkedUiMapID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapPosFromWorldPos.md b/wiki-information/functions/C_Map.GetMapPosFromWorldPos.md new file mode 100644 index 00000000..b59ca013 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapPosFromWorldPos.md @@ -0,0 +1,19 @@ +## Title: C_Map.GetMapPosFromWorldPos + +**Content:** +Translates a world map position to a map position. +`uiMapID, mapPosition = C_Map.GetMapPosFromWorldPos(continentID, worldPosition)` + +**Parameters:** +- `continentID` + - *number* - InstanceID of the continent +- `worldPosition` + - *Vector2DMixin* - The world position to be translated +- `overrideUiMapID` + - *number?* - If you don't set this to the map that you want a relative position in, it defaults to the mapID for the player's continent, essentially normalizing world coordinates (i.e. 478.1,598.2) into continent map coordinates (i.e. 0.44,0.61) + +**Returns:** +- `uiMapID` + - *number* - UiMapID +- `mapPosition` + - *Vector2DMixin* - The translated map position \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapRectOnMap.md b/wiki-information/functions/C_Map.GetMapRectOnMap.md new file mode 100644 index 00000000..57854723 --- /dev/null +++ b/wiki-information/functions/C_Map.GetMapRectOnMap.md @@ -0,0 +1,21 @@ +## Title: C_Map.GetMapRectOnMap + +**Content:** +Needs summary. +`minX, maxX, minY, maxY = C_Map.GetMapRectOnMap(uiMapID, topUiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID +- `topUiMapID` + - *number* + +**Returns:** +- `minX` + - *number* +- `maxX` + - *number* +- `minY` + - *number* +- `maxY` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetPlayerMapPosition.md b/wiki-information/functions/C_Map.GetPlayerMapPosition.md new file mode 100644 index 00000000..0de6fd9a --- /dev/null +++ b/wiki-information/functions/C_Map.GetPlayerMapPosition.md @@ -0,0 +1,32 @@ +## Title: C_Map.GetPlayerMapPosition + +**Content:** +Returns the location of the unit on a map. +`position = C_Map.GetPlayerMapPosition(uiMapID, unitToken)` + +**Parameters:** +- `uiMapID` + - *number* : UiMapID +- `unitToken` + - *string* : UnitId + +**Returns:** +- `position` + - *Vector2DMixin?* + +**Usage:** +Prints the current map coords for the player. +```lua +local map = C_Map.GetBestMapForUnit("player") +local position = C_Map.GetPlayerMapPosition(map, "player") +print(position:GetXY()) -- 0.54766619205475, 0.54863452911377 +``` + +Sending a map pin for a target: +Sends a map pin to General chat for the target (but still uses your own location). +```lua +/run local c,p,t,m=C_Map,"player","target"m=c.GetBestMapForUnit(p)c.SetUserWaypoint{uiMapID=m,position=c.GetPlayerMapPosition(m,p)}SendChatMessage(format("%%t (%d%%)%s",UnitHealth(t)/UnitHealthMax(t)*100,c.GetUserWaypointHyperlink()),"CHANNEL",nil,1) +``` + +**Reference:** +WoWInterface: C_Map.GetPlayerMapPosition Memory Usage \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetWorldPosFromMapPos.md b/wiki-information/functions/C_Map.GetWorldPosFromMapPos.md new file mode 100644 index 00000000..33b8647b --- /dev/null +++ b/wiki-information/functions/C_Map.GetWorldPosFromMapPos.md @@ -0,0 +1,29 @@ +## Title: C_Map.GetWorldPosFromMapPos + +**Content:** +Translates a map position to a world map position. +`continentID, worldPosition = C_Map.GetWorldPosFromMapPos(uiMapID, mapPosition)` + +**Parameters:** +- `uiMapID` + - *number* : UiMapID +- `mapPosition` + - *Vector2DMixin* - as returned from `C_Map.GetPlayerMapPosition()` + +**Returns:** +- `continentID` + - *number* : InstanceID +- `worldPosition` + - *Vector2DMixin* + +**Usage:** +Prints the world coords and size for the boundary box of Elwynn Forest. +```lua +/dump C_Map.GetWorldPosFromMapPos(37, {x=0, y=0}) -- x = -7939.580078125, y = 1535.4200439453 +/dump C_Map.GetWorldPosFromMapPos(37, {x=1, y=1}) -- x = -10254.200195312, y = -1935.4200439453 +/dump C_Map.GetMapWorldSize(37) -- 3470.8400878906, 2314.6201171875 +``` + +**Reference:** +- `UnitPosition()` +- HereBeDragons library \ No newline at end of file diff --git a/wiki-information/functions/C_Map.MapHasArt.md b/wiki-information/functions/C_Map.MapHasArt.md new file mode 100644 index 00000000..3299d329 --- /dev/null +++ b/wiki-information/functions/C_Map.MapHasArt.md @@ -0,0 +1,19 @@ +## Title: C_Map.MapHasArt + +**Content:** +Returns true if the map has art and can be displayed by the FrameXML. +`hasArt = C_Map.MapHasArt(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `hasArt` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific map has art assets before attempting to display it in a custom UI element. For instance, an addon that provides enhanced map features might use this function to ensure that the map data is available before rendering additional overlays or markers. + +**Addon Usage:** +Large addons like "TomTom" or "HandyNotes" might use this function to verify the presence of map art before adding waypoints or notes to the map, ensuring that their features are only applied to maps that can be properly displayed. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.RequestPreloadMap.md b/wiki-information/functions/C_Map.RequestPreloadMap.md new file mode 100644 index 00000000..b7a9c50d --- /dev/null +++ b/wiki-information/functions/C_Map.RequestPreloadMap.md @@ -0,0 +1,9 @@ +## Title: C_Map.RequestPreloadMap + +**Content:** +Preloads textures for a map. +`C_Map.RequestPreloadMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md b/wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md new file mode 100644 index 00000000..6886450f --- /dev/null +++ b/wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md @@ -0,0 +1,15 @@ +## Title: C_MapExplorationInfo.GetExploredAreaIDsAtPosition + +**Content:** +Returns the explored areas for the location on a map. +`areaID = C_MapExplorationInfo.GetExploredAreaIDsAtPosition(uiMapID, normalizedPosition)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID +- `normalizedPosition` + - *Vector2DMixin* + +**Returns:** +- `areaID` + - *number?* - AreaTable.db2 \ No newline at end of file diff --git a/wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md b/wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md new file mode 100644 index 00000000..d26af5c4 --- /dev/null +++ b/wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md @@ -0,0 +1,47 @@ +## Title: C_MapExplorationInfo.GetExploredMapTextures + +**Content:** +Returns explored map textures for a map. +`overlayInfo = C_MapExplorationInfo.GetExploredMapTextures(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `overlayInfo` + - *UiMapExplorationInfo* + - `Field` + - `Type` + - `Description` + - `textureWidth` + - *number* + - `textureHeight` + - *number* + - `offsetX` + - *number* + - `offsetY` + - *number* + - `isShownByMouseOver` + - *boolean* + - `isDrawOnTopLayer` + - *boolean* + - `fileDataIDs` + - *number* + - `hitRect` + - *UiMapExplorationHitRect* + - `UiMapExplorationHitRect` + - `Field` + - `Type` + - `Description` + - `top` + - *number* + - `bottom` + - *number* + - `left` + - *number* + - `right` + - *number* + +**Added in:** +Patch 10.0.0 \ No newline at end of file diff --git a/wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md b/wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md new file mode 100644 index 00000000..c7644f05 --- /dev/null +++ b/wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md @@ -0,0 +1,13 @@ +## Title: C_MerchantFrame.GetBuybackItemID + +**Content:** +Needs summary. +`buybackItemID = C_MerchantFrame.GetBuybackItemID(buybackSlotIndex)` + +**Parameters:** +- `buybackSlotIndex` + - *number* + +**Returns:** +- `buybackItemID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetNumTrackingTypes.md b/wiki-information/functions/C_Minimap.GetNumTrackingTypes.md new file mode 100644 index 00000000..e4b8d51c --- /dev/null +++ b/wiki-information/functions/C_Minimap.GetNumTrackingTypes.md @@ -0,0 +1,9 @@ +## Title: C_Minimap.GetNumTrackingTypes + +**Content:** +Needs summary. +`numTrackingTypes = C_Minimap.GetNumTrackingTypes()` + +**Returns:** +- `numTrackingTypes` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md b/wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md new file mode 100644 index 00000000..ab18a27a --- /dev/null +++ b/wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md @@ -0,0 +1,19 @@ +## Title: C_Minimap.GetObjectIconTextureCoords + +**Content:** +Needs summary. +`textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW = C_Minimap.GetObjectIconTextureCoords()` + +**Parameters:** +- `index` + - *number?* + +**Returns:** +- `textureCoordsX` + - *number* +- `textureCoordsY` + - *number* +- `textureCoordsZ` + - *number* +- `textureCoordsW` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetPOITextureCoords.md b/wiki-information/functions/C_Minimap.GetPOITextureCoords.md new file mode 100644 index 00000000..1a1edae7 --- /dev/null +++ b/wiki-information/functions/C_Minimap.GetPOITextureCoords.md @@ -0,0 +1,19 @@ +## Title: C_Minimap.GetPOITextureCoords + +**Content:** +Needs summary. +`textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW = C_Minimap.GetPOITextureCoords()` + +**Parameters:** +- `index` + - *number?* + +**Returns:** +- `textureCoordsX` + - *number* +- `textureCoordsY` + - *number* +- `textureCoordsZ` + - *number* +- `textureCoordsW` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetTrackingInfo.md b/wiki-information/functions/C_Minimap.GetTrackingInfo.md new file mode 100644 index 00000000..103a3390 --- /dev/null +++ b/wiki-information/functions/C_Minimap.GetTrackingInfo.md @@ -0,0 +1,23 @@ +## Title: C_Minimap.GetTrackingInfo + +**Content:** +Needs summary. +`name, textureFileID, active, type, subType, spellID = C_Minimap.GetTrackingInfo(spellIndex)` + +**Parameters:** +- `spellIndex` + - *number* + +**Returns:** +- `name` + - *string* +- `textureFileID` + - *number* +- `active` + - *boolean* +- `type` + - *string* +- `subType` + - *number* +- `spellID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.SetTracking.md b/wiki-information/functions/C_Minimap.SetTracking.md new file mode 100644 index 00000000..a09b7879 --- /dev/null +++ b/wiki-information/functions/C_Minimap.SetTracking.md @@ -0,0 +1,11 @@ +## Title: C_Minimap.SetTracking + +**Content:** +Needs summary. +`C_Minimap.SetTracking(index, on)` + +**Parameters:** +- `index` + - *number* +- `on` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.AddActiveModelScene.md b/wiki-information/functions/C_ModelInfo.AddActiveModelScene.md new file mode 100644 index 00000000..1f45c2b0 --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.AddActiveModelScene.md @@ -0,0 +1,14 @@ +## Title: C_ModelInfo.AddActiveModelScene + +**Content:** +Needs summary. +`C_ModelInfo.AddActiveModelScene(modelSceneFrame, modelSceneID)` + +**Parameters:** +- `modelSceneFrame` + - *table* +- `modelSceneID` + - *number* + +**Description:** +This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md b/wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md new file mode 100644 index 00000000..9ffa66fd --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md @@ -0,0 +1,14 @@ +## Title: C_ModelInfo.AddActiveModelSceneActor + +**Content:** +Needs summary. +`C_ModelInfo.AddActiveModelSceneActor(modelSceneFrameActor, modelSceneActorID)` + +**Parameters:** +- `modelSceneFrameActor` + - *table* +- `modelSceneActorID` + - *number* + +**Description:** +This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md b/wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md new file mode 100644 index 00000000..0ffc8d65 --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md @@ -0,0 +1,12 @@ +## Title: C_ModelInfo.ClearActiveModelScene + +**Content:** +Needs summary. +`C_ModelInfo.ClearActiveModelScene(modelSceneFrame)` + +**Parameters:** +- `modelSceneFrame` + - *table* + +**Description:** +This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md b/wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md new file mode 100644 index 00000000..ef5b7119 --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md @@ -0,0 +1,12 @@ +## Title: C_ModelInfo.ClearActiveModelSceneActor + +**Content:** +Needs summary. +`C_ModelInfo.ClearActiveModelSceneActor(modelSceneFrameActor)` + +**Parameters:** +- `modelSceneFrameActor` + - *table* + +**Description:** +This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md new file mode 100644 index 00000000..4d14757f --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md @@ -0,0 +1,30 @@ +## Title: C_ModelInfo.GetModelSceneActorDisplayInfoByID + +**Content:** +Needs summary. +`actorDisplayInfo = C_ModelInfo.GetModelSceneActorDisplayInfoByID(modelActorDisplayID)` + +**Parameters:** +- `modelActorDisplayID` + - *number* + +**Returns:** +- `actorDisplayInfo` + - *UIModelSceneActorDisplayInfo* + - `Field` + - `Type` + - `Description` + - `animation` + - *number* + - `animationVariation` + - *number* + - `animSpeed` + - *number* + - `animationKitID` + - *number?* + - `spellVisualKitID` + - *number?* + - `alpha` + - *number* + - `scale` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md new file mode 100644 index 00000000..02b2e0dc --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md @@ -0,0 +1,38 @@ +## Title: C_ModelInfo.GetModelSceneActorInfoByID + +**Content:** +Needs summary. +`actorInfo = C_ModelInfo.GetModelSceneActorInfoByID(modelActorID)` + +**Parameters:** +- `modelActorID` + - *number* + +**Returns:** +- `actorInfo` + - *UIModelSceneActorInfo* + - `Field` + - `Type` + - `Description` + - `modelActorID` + - *number* + - `scriptTag` + - *string* + - `position` + - *Vector3DMixin* 🔗 + - `yaw` + - *number* + - `pitch` + - *number* + - `roll` + - *number* + - `normalizeScaleAggressiveness` + - *number?* + - `useCenterForOriginX` + - *boolean* + - `useCenterForOriginY` + - *boolean* + - `useCenterForOriginZ` + - *boolean* + - `modelActorDisplayID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md new file mode 100644 index 00000000..07066d28 --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md @@ -0,0 +1,52 @@ +## Title: C_ModelInfo.GetModelSceneCameraInfoByID + +**Content:** +Needs summary. +`modelSceneCameraInfo = C_ModelInfo.GetModelSceneCameraInfoByID(modelSceneCameraID)` + +**Parameters:** +- `modelSceneCameraID` + - *number* + +**Returns:** +- `modelSceneCameraInfo` + - *UIModelSceneCameraInfo* + - `Field` + - `Type` + - `Description` + - `modelSceneCameraID` + - *number* + - `scriptTag` + - *string* + - `cameraType` + - *string* + - `target` + - *Vector3DMixin* + - `yaw` + - *number* + - `pitch` + - *number* + - `roll` + - *number* + - `zoomDistance` + - *number* + - `minZoomDistance` + - *number* + - `maxZoomDistance` + - *number* + - `zoomedTargetOffset` + - *Vector3DMixin* + - `zoomedYawOffset` + - *number* + - `zoomedPitchOffset` + - *number* + - `zoomedRollOffset` + - *number* + - `flags` + - *Enum.ModelSceneSetting* + - `Enum.ModelSceneSetting` + - `Value` + - `Field` + - `Description` + - `1` + - AlignLightToOrbitDelta \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md new file mode 100644 index 00000000..8a518a22 --- /dev/null +++ b/wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md @@ -0,0 +1,42 @@ +## Title: C_ModelInfo.GetModelSceneInfoByID + +**Content:** +Needs summary. +`modelSceneType, modelCameraIDs, modelActorsIDs, flags = C_ModelInfo.GetModelSceneInfoByID(modelSceneID)` + +**Parameters:** +- `modelSceneID` + - *number* + +**Returns:** +- `modelSceneType` + - *Enum.ModelSceneType* + - `Value` + - `Field` + - `Description` + - `0` - MountJournal + - `1` - PetJournalCard + - `2` - ShopCard + - `3` - EncounterJournal + - `4` - PetJournalLoadout + - `5` - ArtifactTier2 + - `6` - ArtifactTier2ForgingScene + - `7` - ArtifactTier2SlamEffect + - `8` - CommentatorVictoryFanfare + - `9` - ArtifactRelicTalentEffect + - `10` - PvPWarModeOrb + - `11` - PvPWarModeFire + - `12` - PartyPose + - `13` - AzeriteItemLevelUpToast + - `14` - AzeritePowers + - `15` - AzeriteRewardGlow + - `16` - HeartOfAzeroth + - `17` - WorldMapThreat + - `18` - Soulbinds + - `19` - JailersTowerAnimaGlow +- `modelCameraIDs` + - *number* +- `modelActorsIDs` + - *number* +- `flags` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.ClearFanfare.md b/wiki-information/functions/C_MountJournal.ClearFanfare.md new file mode 100644 index 00000000..78be36ad --- /dev/null +++ b/wiki-information/functions/C_MountJournal.ClearFanfare.md @@ -0,0 +1,9 @@ +## Title: C_MountJournal.ClearFanfare + +**Content:** +Needs summary. +`C_MountJournal.ClearFanfare(mountID)` + +**Parameters:** +- `mountID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.ClearRecentFanfares.md b/wiki-information/functions/C_MountJournal.ClearRecentFanfares.md new file mode 100644 index 00000000..c54c6cde --- /dev/null +++ b/wiki-information/functions/C_MountJournal.ClearRecentFanfares.md @@ -0,0 +1,5 @@ +## Title: C_MountJournal.ClearRecentFanfares + +**Content:** +Needs summary. +`C_MountJournal.ClearRecentFanfares()` \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.Dismiss.md b/wiki-information/functions/C_MountJournal.Dismiss.md new file mode 100644 index 00000000..dec579ec --- /dev/null +++ b/wiki-information/functions/C_MountJournal.Dismiss.md @@ -0,0 +1,12 @@ +## Title: C_MountJournal.Dismiss + +**Content:** +Dismisses the currently summoned mount. +`C_MountJournal.Dismiss()` + +**Reference:** +- `COMPANION_UPDATE`, at which time `IsMounted()` will correctly return false +- See also: `C_MountJournal.SummonByID` + +**Description:** +Has no result if the player is not mounted. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md b/wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md new file mode 100644 index 00000000..9b9fb1ea --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md @@ -0,0 +1,13 @@ +## Title: C_MountJournal.GetAllCreatureDisplayIDsForMountID + +**Content:** +Needs summary. +`creatureDisplayIDs = C_MountJournal.GetAllCreatureDisplayIDsForMountID(mountID)` + +**Parameters:** +- `mountID` + - *number* + +**Returns:** +- `creatureDisplayIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md b/wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md new file mode 100644 index 00000000..faf921cb --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md @@ -0,0 +1,23 @@ +## Title: C_MountJournal.GetCollectedDragonridingMounts + +**Content:** +Needs summary. +`mountIDs = C_MountJournal.GetCollectedDragonridingMounts()` + +**Returns:** +- `mountIDs` + - *number* + +**Description:** +This function retrieves the IDs of the dragonriding mounts that the player has collected. The returned `mountIDs` can be used to display or manage the player's collection of dragonriding mounts. + +**Example Usage:** +```lua +local mountIDs = C_MountJournal.GetCollectedDragonridingMounts() +for _, mountID in ipairs(mountIDs) do + print("Collected Dragonriding Mount ID:", mountID) +end +``` + +**Change Log:** +Patch 10.0.0 (2022-11-15): Added. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md b/wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md new file mode 100644 index 00000000..ec2f5fb5 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md @@ -0,0 +1,20 @@ +## Title: C_MountJournal.GetCollectedFilterSetting + +**Content:** +Indicates whether the specified mount journal filter is enabled. +`isChecked = C_MountJournal.GetCollectedFilterSetting(filterIndex)` + +**Parameters:** +- `filterIndex` + - *number* + - **Value** | **Enum** | **Description** + - `1` | `LE_MOUNT_JOURNAL_FILTER_COLLECTED` + - `2` | `LE_MOUNT_JOURNAL_FILTER_NOT_COLLECTED` + - `3` | `LE_MOUNT_JOURNAL_FILTER_UNUSABLE` + +**Returns:** +- `isChecked` + - *boolean* - true if the filter is enabled (mounts matching the filter are displayed), or false if the filter is disabled (mounts matching the filter are hidden) + +**Description:** +Returns true if the specified ID is not associated with an existing filter. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md new file mode 100644 index 00000000..afae3384 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md @@ -0,0 +1,126 @@ +## Title: C_MountJournal.GetMountAllCreatureDisplayInfoByID + +**Content:** +Returns the display IDs for a mount. +`allDisplayInfo = C_MountJournal.GetMountAllCreatureDisplayInfoByID(mountID)` +`allDisplayInfo = C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo(mountIndex)` + +**Parameters:** +- `GetMountAllCreatureDisplayInfoByID:` + - `mountID` + - *number* - MountID + +- `GetDisplayedMountAllCreatureDisplayInfo:` + - `mountIndex` + - *number* - the index of the displayed mount, i.e. mount in list that matches current search query and filters, in the range of 1 to `C_MountJournal.GetNumDisplayedMounts` + +**Values:** +Note: This list is up to date as of patch 8.1.5 (29737) Mar 14 2019 +- `ID` +- `Name` +- `DisplayIDs` + - `17` + - `Felsteed` + - `2346, 51651` + - `83` + - `Dreadsteed` + - `14554, 51652` + - `422` + - `Vicious War Steed` + - `38668, 91643` + - `435` + - `Mountain Horse` + - `39096, 91641` + - `436` + - `Swift Mountain Horse` + - `39095, 91642` + - `860` + - `Archmage's Prismatic Disc` + - `73770, 73768, 73769` + - `861` + - `High Priest's Lightsworn Seeker` + - `73774, 73775, 73773` + - `866` + - `Deathlord's Vilebrood Vanquisher` + - `73785, 75313, 75314` + - `867` + - `Battlelord's Bloodthirsty War Wyrm` + - `73778, 75994, 75995` + - `888` + - `Farseer's Raging Tempest` + - `76024, 74144, 76025` + - `925` + - `Onyx War Hyena` + - `75322, 91593` + - `926` + - `Alabaster Hyena` + - `75323, 91592` + - `928` + - `Dune Scavenger` + - `75324, 91591` + - `996` + - `Seabraid Stallion` + - `80357, 91599` + - `997` + - `Gilded Ravasaur` + - `80358, 91594` + - `1010` + - `Admiralty Stallion` + - `82148, 91600` + - `1011` + - `Shu-Zen, the Divine Sentinel` + - `81772, 84570, 84571, 84570, 81772` + - `1015` + - `Dapple Gray` + - `81693, 91601` + - `1016` + - `Smoky Charger` + - `82161, 91602` + - `1018` + - `Terrified Pack Mule` + - `81694, 91603` + - `1019` + - `Goldenmane` + - `81690, 91604` + - `1038` + - `Zandalari Direhorn` + - `83525, 91595` + - `1173` + - `Broken Highland Mustang` + - `87773, 91606` + - `1174` + - `Highland Mustang` + - `87774, 91607` + - `1182` + - `Lil' Donkey` + - `85581, 91608` + - `1198` + - `Kul Tiran Charger` + - `88974, 91640` + - `1220` + - `Bruce` + - `90419, 90420` + - `1221` + - `Hogrus, Swine of Good Fortune` + - `90398, 91597` + - `1222` + - `Vulpine Familiar` + - `90397, 91598` + - `1225` + - `Crusader's Direhorn` + - `90501, 91596` + - `1245` + - `Bloodflank Charger` + - `91388, 91609` + +**Returns:** +- `allDisplayInfo` + - *structure* - MountCreatureDisplayInfo + - `MountCreatureDisplayInfo` + - `Field` + - `Type` + - `Description` + - `creatureDisplayID` + - *number* - CreatureDisplayID + - `isVisible` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountID.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountID.md new file mode 100644 index 00000000..0a9a0894 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetDisplayedMountID.md @@ -0,0 +1,26 @@ +## Title: C_MountJournal.GetDisplayedMountID + +**Content:** +Needs summary. +`mountID = C_MountJournal.GetDisplayedMountID(displayIndex)` + +**Parameters:** +- `displayIndex` + - *number* + +**Returns:** +- `mountID` + - *number* + +**Example Usage:** +This function can be used to retrieve the mount ID of a mount displayed at a specific index in the Mount Journal. This is useful for addons that need to interact with or display information about mounts in the player's collection. + +**Example:** +```lua +local displayIndex = 1 +local mountID = C_MountJournal.GetDisplayedMountID(displayIndex) +print("The mount ID at display index 1 is:", mountID) +``` + +**Addons:** +Large addons like "MountJournalEnhanced" use this function to provide additional sorting and filtering options for mounts in the Mount Journal. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md new file mode 100644 index 00000000..e0818398 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md @@ -0,0 +1,63 @@ +## Title: C_MountJournal.GetMountInfoByID + +**Content:** +Returns information about the specified mount. +```lua +name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetMountInfoByID(mountID) +name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetDisplayedMountInfo(displayIndex) +``` + +**Parameters:** +- **GetMountInfoByID:** + - `mountID` + - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` + +- **GetDisplayedMountInfo:** + - `displayIndex` + - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` + +**Returns:** +1. `name` + - *string* - The name of the mount. +2. `spellID` + - *number* - The ID of the spell that summons the mount. +3. `icon` + - *number* : FileID - Icon texture used by the mount. +4. `isActive` + - *boolean* - Indicates if the player is currently mounted on the mount. +5. `isUsable` + - *boolean* - Indicates if the mount is usable based on the player's current location, riding skill, profession skill, class, etc. +6. `sourceType` + - *number* - Indicates generally how the mount may be obtained; a localized string describing the acquisition method is returned by `C_MountJournal.GetMountInfoExtraByID`. +7. `isFavorite` + - *boolean* - Indicates if the mount is currently marked as a favorite. +8. `isFactionSpecific` + - *boolean* - true if the mount is only available to one faction, false otherwise. +9. `faction` + - *number?* - 0 if the mount is available only to Horde players, 1 if the mount is available only to Alliance players, or nil if the mount is not faction-specific. +10. `shouldHideOnChar` + - *boolean* - Indicates if the mount should be hidden in the player's mount journal (includes Swift Spectral Gryphon and mounts specific to the opposite faction). +11. `isCollected` + - *boolean* - Indicates if the player has learned the mount. +12. `mountID` + - *number* - ID of the mount. +13. `isForDragonriding` + - *boolean* - Indicates if the mount is for Dragonriding. + +**Description:** +Current values of the `sourceType` return include: +- 0 - not categorized; includes many mounts that should (and may eventually) be included in one of the other categories + +| BATTLE_PET_SOURCE | ID | Constant | Value | Description | +|-------------------|----|----------|-------|-------------| +| 1 | BATTLE_PET_SOURCE_1 | Drop | 1 | Drop | +| 2 | BATTLE_PET_SOURCE_2 | Quest | 2 | Quest | +| 3 | BATTLE_PET_SOURCE_3 | Vendor | 3 | Vendor | +| 4 | BATTLE_PET_SOURCE_4 | Profession | 4 | Profession | +| 5 | BATTLE_PET_SOURCE_5 | Pet Battle | 5 | Pet Battle | +| 6 | BATTLE_PET_SOURCE_6 | Achievement| 6 | Achievement | +| 7 | BATTLE_PET_SOURCE_7 | World Event| 7 | World Event | +| 8 | BATTLE_PET_SOURCE_8 | Promotion | 8 | Promotion | +| 9 | BATTLE_PET_SOURCE_9 | Trading Card Game | 9 | Trading Card Game | +| 10 | BATTLE_PET_SOURCE_10| In-Game Shop | 10 | In-Game Shop | +| 11 | BATTLE_PET_SOURCE_11| Discovery | 11 | Discovery | \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md new file mode 100644 index 00000000..3a62573c --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md @@ -0,0 +1,62 @@ +## Title: C_MountJournal.GetMountInfoExtraByID + +**Content:** +Returns extra information about the specified mount. +```lua +creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, +uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview += C_MountJournal.GetMountInfoExtraByID(mountID) += C_MountJournal.GetDisplayedMountInfoExtra(index) +``` + +**Parameters:** +- **GetMountInfoExtraByID:** + - `mountID` + - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` + +- **GetDisplayedMountInfoExtra:** + - `index` + - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` + +**Returns:** +- `creatureDisplayInfoID` + - *number* : DisplayID - If nil, then the mount has multiple displayIDs, from `C_MountJournal.GetMountAllCreatureDisplayInfoByID()`. This is not consistent however, since this can be not nil and still have multiple displayIds. +- `description` + - *string* - flavor text describing the mount +- `source` + - *string* - information about how the mount is obtained, including vendor name and location, monetary cost, etc. +- `isSelfMount` + - *boolean* - true if the player transforms into the mount (e.g., Obsidian Nightwing or Sandstone Drake), or false for normal mounts +- `mountTypeID` + - *number* - a number indicating the capabilities of the mount; known values include: + - 230 for most ground mounts + - 231 for + - 232 for (was named Abyssal Seahorse prior to Warlords of Draenor) + - 241 for Blue, Green, Red, and Yellow Qiraji Battle Tank (restricted to use inside Temple of Ahn'Qiraj) + - 242 for Swift Spectral Gryphon (hidden in the mount journal, used while dead in certain zones) + - 247 for + - 248 for most flying mounts, including those that change capability based on riding skill + - 254 for + - 269 for + - 284 for and Chauffeured Mechano-Hog + - 398 for + - 402 for Dragonriding + - 407 for + - 408 for + - 412 for Otto and Ottuk + - 424 for Dragonriding mounts, including mounts that have dragonriding animations but are not yet enabled for dragonriding. +- `uiModelSceneID` + - *number* : ModelSceneID +- `animID` + - *number* +- `spellVisualKitID` + - *number* +- `disablePlayerMountPreview` + - *boolean* + +**Example Usage:** +This function can be used to retrieve detailed information about a specific mount, which can be useful for addons that manage or display mount collections. For example, an addon could use this function to show additional details about a mount when a player hovers over it in their mount journal. + +**Addons Using This Function:** +- **Altoholic:** This addon uses `C_MountJournal.GetMountInfoExtraByID` to display detailed mount information across multiple characters, helping players manage their collections more effectively. +- **Mount Journal Enhanced:** This addon enhances the default mount journal by adding more detailed information about each mount, including the extra information retrieved by this function. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetIsFavorite.md b/wiki-information/functions/C_MountJournal.GetIsFavorite.md new file mode 100644 index 00000000..0d5ed0fd --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetIsFavorite.md @@ -0,0 +1,15 @@ +## Title: C_MountJournal.GetIsFavorite + +**Content:** +Indicates whether the specified mount is marked as a favorite. +`isFavorite, canSetFavorite = C_MountJournal.GetIsFavorite(mountIndex)` + +**Parameters:** +- `mountIndex` + - *number* - Index of the mount, in the range of 1 to `C_MountJournal.GetNumMounts()` (inclusive) + +**Returns:** +- `isFavorite` + - *boolean* +- `canSetFavorite` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md b/wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md new file mode 100644 index 00000000..83c4333a --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md @@ -0,0 +1,64 @@ +## Title: C_MountJournal.GetMountAllCreatureDisplayInfoByID + +**Content:** +Returns the display IDs for a mount. +`allDisplayInfo = C_MountJournal.GetMountAllCreatureDisplayInfoByID(mountID)` +`allDisplayInfo = C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo(mountIndex)` + +**Parameters:** +- `GetMountAllCreatureDisplayInfoByID:` + - `mountID` + - *number* - MountID + +- `GetDisplayedMountAllCreatureDisplayInfo:` + - `mountIndex` + - *number* - the index of the displayed mount, i.e. mount in list that matches current search query and filters, in the range of 1 to `C_MountJournal.GetNumDisplayedMounts` + +**Values:** +Note: This list is up to date as of patch 8.1.5 (29737) Mar 14 2019 +- `ID` +- `Name` +- `DisplayIDs` + - 17 - Felsteed - 2346, 51651 + - 83 - Dreadsteed - 14554, 51652 + - 422 - Vicious War Steed - 38668, 91643 + - 435 - Mountain Horse - 39096, 91641 + - 436 - Swift Mountain Horse - 39095, 91642 + - 860 - Archmage's Prismatic Disc - 73770, 73768, 73769 + - 861 - High Priest's Lightsworn Seeker - 73774, 73775, 73773 + - 866 - Deathlord's Vilebrood Vanquisher - 73785, 75313, 75314 + - 867 - Battlelord's Bloodthirsty War Wyrm - 73778, 75994, 75995 + - 888 - Farseer's Raging Tempest - 76024, 74144, 76025 + - 925 - Onyx War Hyena - 75322, 91593 + - 926 - Alabaster Hyena - 75323, 91592 + - 928 - Dune Scavenger - 75324, 91591 + - 996 - Seabraid Stallion - 80357, 91599 + - 997 - Gilded Ravasaur - 80358, 91594 + - 1010 - Admiralty Stallion - 82148, 91600 + - 1011 - Shu-Zen, the Divine Sentinel - 81772, 84570, 84571, 84570, 81772 + - 1015 - Dapple Gray - 81693, 91601 + - 1016 - Smoky Charger - 82161, 91602 + - 1018 - Terrified Pack Mule - 81694, 91603 + - 1019 - Goldenmane - 81690, 91604 + - 1038 - Zandalari Direhorn - 83525, 91595 + - 1173 - Broken Highland Mustang - 87773, 91606 + - 1174 - Highland Mustang - 87774, 91607 + - 1182 - Lil' Donkey - 85581, 91608 + - 1198 - Kul Tiran Charger - 88974, 91640 + - 1220 - Bruce - 90419, 90420 + - 1221 - Hogrus, Swine of Good Fortune - 90398, 91597 + - 1222 - Vulpine Familiar - 90397, 91598 + - 1225 - Crusader's Direhorn - 90501, 91596 + - 1245 - Bloodflank Charger - 91388, 91609 + +**Returns:** +- `allDisplayInfo` + - *structure* - MountCreatureDisplayInfo + - `MountCreatureDisplayInfo` + - `Field` + - `Type` + - `Description` + - `creatureDisplayID` + - *number* - CreatureDisplayID + - `isVisible` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountFromItem.md b/wiki-information/functions/C_MountJournal.GetMountFromItem.md new file mode 100644 index 00000000..52be07dc --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountFromItem.md @@ -0,0 +1,19 @@ +## Title: C_MountJournal.GetMountFromItem + +**Content:** +Returns the mount for an item ID. +`mountID = C_MountJournal.GetMountFromItem(itemID)` + +**Parameters:** +- `itemID` + - *number* + +**Returns:** +- `mountID` + - *number?* + +**Example Usage:** +This function can be used to determine which mount is associated with a specific item ID. For instance, if you have an item that you suspect grants a mount, you can use this function to confirm the mount ID. + +**Addons Usage:** +Large addons like "AllTheThings" use this function to track and catalog mounts associated with items, helping players to complete their mount collections. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountFromSpell.md b/wiki-information/functions/C_MountJournal.GetMountFromSpell.md new file mode 100644 index 00000000..c83078a1 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountFromSpell.md @@ -0,0 +1,19 @@ +## Title: C_MountJournal.GetMountFromSpell + +**Content:** +Returns the mount for a spell ID. +`mountID = C_MountJournal.GetMountFromSpell(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `mountID` + - *number?* + +**Example Usage:** +This function can be used to retrieve the mount ID associated with a specific spell ID. This is particularly useful for addons that manage or display mount collections, allowing them to link spells to their corresponding mounts. + +**Addon Usage:** +Large addons like "MountJournalEnhanced" or "CollectMe" might use this function to enhance the user interface for mount collections, providing additional information or functionality based on the mount ID retrieved from a spell ID. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountIDs.md b/wiki-information/functions/C_MountJournal.GetMountIDs.md new file mode 100644 index 00000000..7c740ff0 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountIDs.md @@ -0,0 +1,9 @@ +## Title: C_MountJournal.GetMountIDs + +**Content:** +Returns the IDs of mounts listed in the mount journal. +`mountIDs = C_MountJournal.GetMountIDs()` + +**Returns:** +- `mountIDs` + - *number* - MountID \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountInfoByID.md b/wiki-information/functions/C_MountJournal.GetMountInfoByID.md new file mode 100644 index 00000000..05a81f5a --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountInfoByID.md @@ -0,0 +1,63 @@ +## Title: C_MountJournal.GetMountInfoByID + +**Content:** +Returns information about the specified mount. +```lua +name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetMountInfoByID(mountID) +name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetDisplayedMountInfo(displayIndex) +``` + +**Parameters:** +- **GetMountInfoByID:** + - `mountID` + - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` + +- **GetDisplayedMountInfo:** + - `displayIndex` + - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` + +**Returns:** +1. `name` + - *string* - The name of the mount. +2. `spellID` + - *number* - The ID of the spell that summons the mount. +3. `icon` + - *number* : FileID - Icon texture used by the mount. +4. `isActive` + - *boolean* - Indicates if the player is currently mounted on the mount. +5. `isUsable` + - *boolean* - Indicates if the mount is usable based on the player's current location, riding skill, profession skill, class, etc. +6. `sourceType` + - *number* - Indicates generally how the mount may be obtained; a localized string describing the acquisition method is returned by `C_MountJournal.GetMountInfoExtraByID`. +7. `isFavorite` + - *boolean* - Indicates if the mount is currently marked as a favorite. +8. `isFactionSpecific` + - *boolean* - true if the mount is only available to one faction, false otherwise. +9. `faction` + - *number?* - 0 if the mount is available only to Horde players, 1 if the mount is available only to Alliance players, or nil if the mount is not faction-specific. +10. `shouldHideOnChar` + - *boolean* - Indicates if the mount should be hidden in the player's mount journal (includes Swift Spectral Gryphon and mounts specific to the opposite faction). +11. `isCollected` + - *boolean* - Indicates if the player has learned the mount. +12. `mountID` + - *number* - ID of the mount. +13. `isForDragonriding` + - *boolean* - Indicates if the mount is used for Dragonriding. + +**Description:** +Current values of the `sourceType` return include: +- 0 - not categorized; includes many mounts that should (and may eventually) be included in one of the other categories + +| BATTLE_PET_SOURCE | ID | Constant | Value | Description | +|-------------------|----|----------|-------|-------------| +| 1 | 1 | BATTLE_PET_SOURCE_1 | Drop | Drop | +| 2 | 2 | BATTLE_PET_SOURCE_2 | Quest | Quest | +| 3 | 3 | BATTLE_PET_SOURCE_3 | Vendor | Vendor | +| 4 | 4 | BATTLE_PET_SOURCE_4 | Profession | Profession | +| 5 | 5 | BATTLE_PET_SOURCE_5 | Pet Battle | Pet Battle | +| 6 | 6 | BATTLE_PET_SOURCE_6 | Achievement| Achievement | +| 7 | 7 | BATTLE_PET_SOURCE_7 | World Event| World Event | +| 8 | 8 | BATTLE_PET_SOURCE_8 | Promotion | Promotion | +| 9 | 9 | BATTLE_PET_SOURCE_9 | Trading Card Game | Trading Card Game | +| 10 | 10 | BATTLE_PET_SOURCE_10| In-Game Shop | In-Game Shop | +| 11 | 11 | BATTLE_PET_SOURCE_11| Discovery | Discovery | \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md b/wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md new file mode 100644 index 00000000..d961fa24 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md @@ -0,0 +1,62 @@ +## Title: C_MountJournal.GetMountInfoExtraByID + +**Content:** +Returns extra information about the specified mount. +```lua +creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, +uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview += C_MountJournal.GetMountInfoExtraByID(mountID) += C_MountJournal.GetDisplayedMountInfoExtra(index) +``` + +**Parameters:** +- **GetMountInfoExtraByID:** + - `mountID` + - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` + +- **GetDisplayedMountInfoExtra:** + - `index` + - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` + +**Returns:** +- `creatureDisplayInfoID` + - *number* : DisplayID - If nil, then the mount has multiple displayIDs, from `C_MountJournal.GetMountAllCreatureDisplayInfoByID()`. This is not consistent however, since this can be not nil and still have multiple displayIds. +- `description` + - *string* - flavor text describing the mount +- `source` + - *string* - information about how the mount is obtained, including vendor name and location, monetary cost, etc. +- `isSelfMount` + - *boolean* - true if the player transforms into the mount (e.g., Obsidian Nightwing or Sandstone Drake), or false for normal mounts +- `mountTypeID` + - *number* - a number indicating the capabilities of the mount; known values include: + - 230 for most ground mounts + - 231 for + - 232 for (was named Abyssal Seahorse prior to Warlords of Draenor) + - 241 for Blue, Green, Red, and Yellow Qiraji Battle Tank (restricted to use inside Temple of Ahn'Qiraj) + - 242 for Swift Spectral Gryphon (hidden in the mount journal, used while dead in certain zones) + - 247 for + - 248 for most flying mounts, including those that change capability based on riding skill + - 254 for + - 269 for + - 284 for and Chauffeured Mechano-Hog + - 398 for + - 402 for Dragonriding + - 407 for + - 408 for + - 412 for Otto and Ottuk + - 424 for Dragonriding mounts, including mounts that have dragonriding animations but are not yet enabled for dragonriding. +- `uiModelSceneID` + - *number* : ModelSceneID +- `animID` + - *number* +- `spellVisualKitID` + - *number* +- `disablePlayerMountPreview` + - *boolean* + +**Example Usage:** +This function can be used to retrieve detailed information about a specific mount, which can be useful for addons that manage or display mount collections. For example, an addon could use this function to show additional details about a mount when a player hovers over it in their mount journal. + +**Addons Using This Function:** +- **MountJournalEnhanced**: This addon enhances the default mount journal by adding more filters and sorting options. It uses `C_MountJournal.GetMountInfoExtraByID` to display additional information about each mount, such as its source and description. +- **AllTheThings**: This comprehensive collection tracking addon uses this function to provide detailed information about mounts, helping players track which mounts they have collected and which ones they still need to obtain. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountLink.md b/wiki-information/functions/C_MountJournal.GetMountLink.md new file mode 100644 index 00000000..03bf4ea6 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountLink.md @@ -0,0 +1,19 @@ +## Title: C_MountJournal.GetMountLink + +**Content:** +Needs summary. +`mountCreatureDisplayInfoLink = C_MountJournal.GetMountLink(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `mountCreatureDisplayInfoLink` + - *string?* + +**Example Usage:** +This function can be used to retrieve a link to a mount's creature display information based on its spell ID. This can be useful for addons that need to display or manipulate mount information. + +**Addon Usage:** +Large addons like "MountJournalEnhanced" might use this function to provide additional details or functionalities related to mounts, such as displaying mount links in tooltips or chat. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md b/wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md new file mode 100644 index 00000000..5a311d67 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md @@ -0,0 +1,23 @@ +## Title: C_MountJournal.GetMountUsabilityByID + +**Content:** +Returns if a mount is currently usable by the player. +`isUsable, useError = C_MountJournal.GetMountUsabilityByID(mountID, checkIndoors)` + +**Parameters:** +- `mountID` + - *number* +- `checkIndoors` + - *boolean* + +**Returns:** +- `isUsable` + - *boolean* +- `useError` + - *string?* + +**Example Usage:** +This function can be used to check if a specific mount can be used in the current environment. For instance, you might want to check if a flying mount can be used indoors or if a specific mount is restricted in certain areas. + +**Addon Usage:** +Large addons like "MountJournalEnhanced" use this function to provide users with detailed information about mount usability, including restrictions and error messages when attempting to use a mount in an inappropriate location. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md b/wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md new file mode 100644 index 00000000..a4320654 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md @@ -0,0 +1,12 @@ +## Title: C_MountJournal.GetNumDisplayedMounts + +**Content:** +Returns the number of (filtered) mounts shown in the mount journal. +`numMounts = C_MountJournal.GetNumDisplayedMounts()` + +**Returns:** +- `numMounts` + - *number* + +**Reference:** +- `C_MountJournal.GetNumMounts` \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetNumMounts.md b/wiki-information/functions/C_MountJournal.GetNumMounts.md new file mode 100644 index 00000000..b8e87d82 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetNumMounts.md @@ -0,0 +1,15 @@ +## Title: C_MountJournal.GetNumMounts + +**Content:** +Returns the number of mounts listed in the mount journal. +`numMounts = C_MountJournal.GetNumMounts()` + +**Returns:** +- `numMounts` + - *number* + +**Description:** +Unlike the corresponding function for the pet journal, the number returned by this function includes not only the mounts that are currently visible in the mount journal, but also the mounts that are hidden by the player's current filter preferences, mounts that are hidden because they are not available to the player's faction, and mounts that are never displayed, such as the Swift Spectral Gryphon which players are mounted on while dead in certain zones. + +**Reference:** +- `C_MountJournal.GetNumDisplayedMounts` \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md b/wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md new file mode 100644 index 00000000..497e0436 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md @@ -0,0 +1,9 @@ +## Title: C_MountJournal.GetNumMountsNeedingFanfare + +**Content:** +Needs summary. +`numMountsNeedingFanfare = C_MountJournal.GetNumMountsNeedingFanfare()` + +**Returns:** +- `numMountsNeedingFanfare` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsSourceChecked.md b/wiki-information/functions/C_MountJournal.IsSourceChecked.md new file mode 100644 index 00000000..6564c51b --- /dev/null +++ b/wiki-information/functions/C_MountJournal.IsSourceChecked.md @@ -0,0 +1,19 @@ +## Title: C_MountJournal.IsSourceChecked + +**Content:** +Needs summary. +`isChecked = C_MountJournal.IsSourceChecked(filterIndex)` + +**Parameters:** +- `filterIndex` + - *number* + +**Returns:** +- `isChecked` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific source filter is currently checked in the Mount Journal. For instance, if you want to verify whether mounts obtained from a specific source (like achievements or vendors) are being displayed, you can use this function. + +**Addons:** +Large addons like "AllTheThings" use this function to filter and display mounts based on their sources, helping players track their mount collection progress more effectively. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsTypeChecked.md b/wiki-information/functions/C_MountJournal.IsTypeChecked.md new file mode 100644 index 00000000..10c40345 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.IsTypeChecked.md @@ -0,0 +1,19 @@ +## Title: C_MountJournal.IsTypeChecked + +**Content:** +Needs summary. +`isChecked = C_MountJournal.IsTypeChecked(filterIndex)` + +**Parameters:** +- `filterIndex` + - *number* + +**Returns:** +- `isChecked` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific mount type filter is currently active in the Mount Journal. For instance, if you want to check if the "Flying" mount filter is enabled, you would use the corresponding filter index for flying mounts. + +**Addons Usage:** +Large addons like "MountsJournal" or "CollectMe" might use this function to determine which mount types are currently being filtered by the user, allowing them to display or hide mounts accordingly. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md b/wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md new file mode 100644 index 00000000..9fa8e0bb --- /dev/null +++ b/wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md @@ -0,0 +1,9 @@ +## Title: C_MountJournal.IsUsingDefaultFilters + +**Content:** +Needs summary. +`isUsingDefaultFilters = C_MountJournal.IsUsingDefaultFilters()` + +**Returns:** +- `isUsingDefaultFilters` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsValidSourceFilter.md b/wiki-information/functions/C_MountJournal.IsValidSourceFilter.md new file mode 100644 index 00000000..72a2d64c --- /dev/null +++ b/wiki-information/functions/C_MountJournal.IsValidSourceFilter.md @@ -0,0 +1,19 @@ +## Title: C_MountJournal.IsValidSourceFilter + +**Content:** +Needs summary. +`isValid = C_MountJournal.IsValidSourceFilter(filterIndex)` + +**Parameters:** +- `filterIndex` + - *number* + +**Returns:** +- `isValid` + - *boolean* + +**Example Usage:** +This function can be used to check if a given source filter index is valid within the Mount Journal. This is useful for addons that manage or display mount collections, ensuring that the filters applied are valid and won't cause errors. + +**Addons:** +Large addons like "AllTheThings" and "CollectMe" might use this function to validate source filters when displaying or managing mount collections. This ensures that the filters applied by the user or the addon itself are valid and won't result in unexpected behavior. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsValidTypeFilter.md b/wiki-information/functions/C_MountJournal.IsValidTypeFilter.md new file mode 100644 index 00000000..7f1937fc --- /dev/null +++ b/wiki-information/functions/C_MountJournal.IsValidTypeFilter.md @@ -0,0 +1,19 @@ +## Title: C_MountJournal.IsValidTypeFilter + +**Content:** +Needs summary. +`isValid = C_MountJournal.IsValidTypeFilter(filterIndex)` + +**Parameters:** +- `filterIndex` + - *number* + +**Returns:** +- `isValid` + - *boolean* + +**Example Usage:** +This function can be used to check if a given filter index is valid within the Mount Journal. This is useful when creating custom UIs or addons that interact with the Mount Journal and need to validate filter indices before applying them. + +**Addons:** +Large addons like "MountsJournal" or "CollectMe" might use this function to ensure that the filter indices they are working with are valid before applying filters to the Mount Journal. This helps in preventing errors and ensuring smooth functionality. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.NeedsFanfare.md b/wiki-information/functions/C_MountJournal.NeedsFanfare.md new file mode 100644 index 00000000..b273d229 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.NeedsFanfare.md @@ -0,0 +1,13 @@ +## Title: C_MountJournal.NeedsFanfare + +**Content:** +Needs summary. +`needsFanfare = C_MountJournal.NeedsFanfare(mountID)` + +**Parameters:** +- `mountID` + - *number* + +**Returns:** +- `needsFanfare` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.Pickup.md b/wiki-information/functions/C_MountJournal.Pickup.md new file mode 100644 index 00000000..d66c7281 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.Pickup.md @@ -0,0 +1,27 @@ +## Title: C_MountJournal.Pickup + +**Content:** +Picks up the specified mount onto the cursor, usually in preparation for placing it on an action button. +`C_MountJournal.Pickup(displayIndex)` + +**Parameters:** +- `displayIndex` + - *number* - Index of the mount, in the range of 1 to `C_MountJournal.GetNumMounts()` (inclusive), or 0 to pick up the "Summon Random Favorite Mount" button. + +**Description:** +- Triggers `CURSOR_UPDATE` to indicate that the contents of the cursor have changed. +- Triggers `ACTIONBAR_SHOWGRID` to indicate that the outlines of empty action bar buttons are now being displayed. +- Does nothing if the specified index is out of bounds or belongs to a mount that the player has not collected. +- When a mount is on the cursor, `GetCursorInfo()` returns `"mount", ` where `` is the same as the second value returned by `GetActionInfo()` for an action button containing the same mount. +- When the "Summon Random Favorite Mount" button is on the cursor or action button, the `mountActionID` is 268435455. + +**Reference:** +- `ClearCursor()` +- `GetCursorInfo()` +- `PlaceAction()` + +**Example Usage:** +This function can be used in macros or addons to allow players to easily place mounts on their action bars. For instance, an addon could provide a user interface for managing mounts and use `C_MountJournal.Pickup` to let players drag and drop mounts onto their action bars. + +**Addon Usage:** +Large addons like Bartender4 or Dominos, which provide extensive customization of action bars, might use this function to facilitate the placement of mounts on action buttons. This allows users to manage their mounts directly from the addon’s interface. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetAllSourceFilters.md b/wiki-information/functions/C_MountJournal.SetAllSourceFilters.md new file mode 100644 index 00000000..6d707558 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetAllSourceFilters.md @@ -0,0 +1,9 @@ +## Title: C_MountJournal.SetAllSourceFilters + +**Content:** +Needs summary. +`C_MountJournal.SetAllSourceFilters(isChecked)` + +**Parameters:** +- `isChecked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetAllTypeFilters.md b/wiki-information/functions/C_MountJournal.SetAllTypeFilters.md new file mode 100644 index 00000000..a76d48df --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetAllTypeFilters.md @@ -0,0 +1,9 @@ +## Title: C_MountJournal.SetAllTypeFilters + +**Content:** +Needs summary. +`C_MountJournal.SetAllTypeFilters(isChecked)` + +**Parameters:** +- `isChecked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md b/wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md new file mode 100644 index 00000000..e873c24e --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md @@ -0,0 +1,23 @@ +## Title: C_MountJournal.SetCollectedFilterSetting + +**Content:** +Enables or disables the specified mount journal filter. +`C_MountJournal.SetCollectedFilterSetting(filterIndex, isChecked)` + +**Parameters:** +- `filterIndex` + - *number* + - `Value` + - `Enum` + - `Description` + - `1` + - `LE_MOUNT_JOURNAL_FILTER_COLLECTED` + - `2` + - `LE_MOUNT_JOURNAL_FILTER_NOT_COLLECTED` + - `3` + - `LE_MOUNT_JOURNAL_FILTER_UNUSABLE` +- `isChecked` + - *boolean* + +**Description:** +Does nothing if the specified ID is not associated with an existing filter. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetDefaultFilters.md b/wiki-information/functions/C_MountJournal.SetDefaultFilters.md new file mode 100644 index 00000000..50a73411 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetDefaultFilters.md @@ -0,0 +1,17 @@ +## Title: C_MountJournal.SetDefaultFilters + +**Content:** +Needs summary. +`C_MountJournal.SetDefaultFilters()` + +**Description:** +This function resets the mount journal filters to their default state. This can be useful if you have applied multiple filters and want to quickly revert to the default view without manually unchecking each filter. + +**Example Usage:** +```lua +-- Reset the mount journal filters to default +C_MountJournal.SetDefaultFilters() +``` + +**Use in Addons:** +Large addons like "MountsJournal" or "CollectMe" might use this function to ensure that the mount list is in a known state before applying their own custom filters or sorting logic. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetIsFavorite.md b/wiki-information/functions/C_MountJournal.SetIsFavorite.md new file mode 100644 index 00000000..78882fc7 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetIsFavorite.md @@ -0,0 +1,14 @@ +## Title: C_MountJournal.SetIsFavorite + +**Content:** +Marks or unmarks the specified mount as a favorite. +`C_MountJournal.SetIsFavorite(mountIndex, isFavorite)` + +**Parameters:** +- `mountIndex` + - *number* - Index of the mount, in the range of 1 to `C_MountJournal.GetNumMounts()` (inclusive) +- `isFavorite` + - *boolean* + +**Description:** +Does nothing if the specified index is out of range. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetSearch.md b/wiki-information/functions/C_MountJournal.SetSearch.md new file mode 100644 index 00000000..d8a2bb5a --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetSearch.md @@ -0,0 +1,9 @@ +## Title: C_MountJournal.SetSearch + +**Content:** +Needs summary. +`C_MountJournal.SetSearch(searchValue)` + +**Parameters:** +- `searchValue` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetSourceFilter.md b/wiki-information/functions/C_MountJournal.SetSourceFilter.md new file mode 100644 index 00000000..60be1328 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetSourceFilter.md @@ -0,0 +1,26 @@ +## Title: C_MountJournal.SetSourceFilter + +**Content:** +Needs summary. +`C_MountJournal.SetSourceFilter(filterIndex, isChecked)` + +**Parameters:** +- `filterIndex` + - *number* +- `isChecked` + - *boolean* + +**Description:** +This function is used to set the source filter for the Mount Journal. The `filterIndex` parameter specifies which filter to set, and the `isChecked` parameter specifies whether the filter should be enabled or disabled. + +**Example Usage:** +```lua +-- Enable the filter for mounts obtained from achievements +C_MountJournal.SetSourceFilter(1, true) + +-- Disable the filter for mounts obtained from vendors +C_MountJournal.SetSourceFilter(2, false) +``` + +**Additional Information:** +This function is commonly used in addons that manage or enhance the Mount Journal, such as MountFarmHelper or MountJournalEnhanced. These addons use this function to allow users to quickly filter and find specific mounts based on their source. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetTypeFilter.md b/wiki-information/functions/C_MountJournal.SetTypeFilter.md new file mode 100644 index 00000000..80edf6d1 --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SetTypeFilter.md @@ -0,0 +1,11 @@ +## Title: C_MountJournal.SetTypeFilter + +**Content:** +Needs summary. +`C_MountJournal.SetTypeFilter(filterIndex, isChecked)` + +**Parameters:** +- `filterIndex` + - *number* +- `isChecked` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SummonByID.md b/wiki-information/functions/C_MountJournal.SummonByID.md new file mode 100644 index 00000000..bfec52db --- /dev/null +++ b/wiki-information/functions/C_MountJournal.SummonByID.md @@ -0,0 +1,20 @@ +## Title: C_MountJournal.SummonByID + +**Content:** +Summons the specified mount. +`C_MountJournal.SummonByID(mountID)` + +**Parameters:** +- `mountID` + - *number* : MountID - Valid mount IDs are returned from `C_MountJournal.GetMountIDs()`, or 0 to summon a random favorite mount appropriate to the current area. + +**Reference:** +- `UNIT_SPELLCAST_SENT`, when the player begins casting the spell to summon the mount. +- `COMPANION_UPDATE`, after the spellcast completes, but at this time `IsMounted()` does not yet return true. +- See also: `C_MountJournal.Dismiss`. + +**Description:** +If the specified index is out of range, nothing happens. +If the player has not yet collected the specified mount, no mount is summoned, and an error message is displayed in the center of the player's screen. The text of the error message is contained in the global variable `MOUNT_JOURNAL_NOT_COLLECTED`; in English clients, it is "You have not collected this mount." +If the specified index is 0, but the player has not marked any mounts as favorites, or does not have any favorite mounts that are appropriate for the current area, the error message "You have no valid favorite mounts." (global variable `ERR_MOUNT_NO_FAVORITES`) is displayed. +If the player cannot fly in the current area, then "appropriate for the current area" only includes ground-only mounts; it does not include flying mounts which can also run on land. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md b/wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md new file mode 100644 index 00000000..283a82d5 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md @@ -0,0 +1,47 @@ +## Title: C_NamePlate.GetNamePlateForUnit + +**Content:** +Returns the nameplate for a unit. +`nameplate = C_NamePlate.GetNamePlateForUnit(unitId)` + +**Parameters:** +- `unitId` + - *string* - UnitId +- `isSecure` + - *boolean?* - If protected nameplates for friendly units while in instanced areas should be returned. + +**Returns:** +- `nameplate` + - *NameplateBase?* - Frame|NamePlateBaseMixin + - `Field` + - `Type` + - `Description` + - `UnitFrame` + - *Button* + - `driverFrame` + - *NamePlateDriverFrame* - points to NamePlateDriverFrame (NamePlateDriverMixin) + - `namePlateUnitToken` + - *string* - e.g. "nameplate1" + - `template` + - *string* - e.g. "NamePlateUnitFrameTemplate" + - `NamePlateBaseMixin` + - `OnAdded` + - *function* + - `OnRemoved` + - *function* + - `OnOptionsUpdated` + - *function* + - `ApplyOffsets` + - *function* + - `GetAdditionalInsetPadding` + - *function* + - `GetPreferredInsets` + - *function* + - `OnSizeChanged` + - *function* + +**Example Usage:** +This function can be used to retrieve the nameplate frame associated with a specific unit, which can be useful for customizing the appearance or behavior of nameplates in addons. + +**Addon Usage:** +Large addons like ElvUI and Plater Nameplates use this function to manage and customize nameplates for units, allowing for enhanced visual customization and additional functionality such as displaying debuffs, health bars, and other unit-specific information directly on the nameplate. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.GetNamePlates.md b/wiki-information/functions/C_NamePlate.GetNamePlates.md new file mode 100644 index 00000000..06f4175f --- /dev/null +++ b/wiki-information/functions/C_NamePlate.GetNamePlates.md @@ -0,0 +1,46 @@ +## Title: C_NamePlate.GetNamePlates + +**Content:** +Returns the currently visible nameplates. +`nameplates = C_NamePlate.GetNamePlates()` + +**Parameters:** +- `isSecure` + - *boolean?* - Whether protected nameplates for friendly units while in instanced areas should be returned. + +**Returns:** +- `nameplates` + - *NameplateBase : Frame|NamePlateBaseMixin* + - `Field` + - `Type` + - `Description` + - `UnitFrame` + - *Button* + - `driverFrame` + - *NamePlateDriverFrame* - points to NamePlateDriverFrame (NamePlateDriverMixin) + - `namePlateUnitToken` + - *string* - e.g. "nameplate1" + - `template` + - *string* - e.g. "NamePlateUnitFrameTemplate" + - `NamePlateBaseMixin` + - `OnAdded` + - *function* + - `OnRemoved` + - *function* + - `OnOptionsUpdated` + - *function* + - `ApplyOffsets` + - *function* + - `GetAdditionalInsetPadding` + - *function* + - `GetPreferredInsets` + - *function* + - `OnSizeChanged` + - *function* + +**Example Usage:** +This function can be used to retrieve all currently visible nameplates, which is useful for addons that need to interact with or display information about nameplates. For example, an addon that customizes nameplate appearance or adds additional information like health percentages or debuffs would use this function to get the list of nameplates to modify. + +**Addons Using This Function:** +- **TidyPlates**: A popular addon that enhances the default nameplates with additional customization options and information. It uses `C_NamePlate.GetNamePlates` to retrieve the current nameplates and apply its custom styles and data overlays. +- **Plater Nameplates**: Another widely used nameplate addon that offers extensive customization and scripting capabilities. It leverages this function to manage and update the nameplates dynamically based on user settings and scripts. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md b/wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md new file mode 100644 index 00000000..5e1b44b3 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md @@ -0,0 +1,9 @@ +## Title: C_NamePlate.SetNamePlateEnemyClickThrough + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateEnemyClickThrough(clickthrough)` + +**Parameters:** +- `clickthrough` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md b/wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md new file mode 100644 index 00000000..935adad6 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md @@ -0,0 +1,15 @@ +## Title: C_NamePlate.SetNamePlateEnemyPreferredClickInsets + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateEnemyPreferredClickInsets(left, right, top, bottom)` + +**Parameters:** +- `left` + - *number* +- `right` + - *number* +- `top` + - *number* +- `bottom` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md b/wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md new file mode 100644 index 00000000..485af6d5 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md @@ -0,0 +1,11 @@ +## Title: C_NamePlate.SetNamePlateEnemySize + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateEnemySize(width, height)` + +**Parameters:** +- `width` + - *number* +- `height` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md new file mode 100644 index 00000000..fc7aa434 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md @@ -0,0 +1,9 @@ +## Title: C_NamePlate.SetNamePlateFriendlyClickThrough + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateFriendlyClickThrough(clickthrough)` + +**Parameters:** +- `clickthrough` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md new file mode 100644 index 00000000..cf91a177 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md @@ -0,0 +1,15 @@ +## Title: C_NamePlate.SetNamePlateFriendlyPreferredClickInsets + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateFriendlyPreferredClickInsets(left, right, top, bottom)` + +**Parameters:** +- `left` + - *number* +- `right` + - *number* +- `top` + - *number* +- `bottom` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md new file mode 100644 index 00000000..d515c678 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md @@ -0,0 +1,17 @@ +## Title: C_NamePlate.SetNamePlateFriendlySize + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateFriendlySize(width, height)` + +**Parameters:** +- `width` + - *number* +- `height` + - *number* + +**Example Usage:** +This function can be used to set the size of friendly nameplates in the game. For instance, if you want to make friendly nameplates larger for better visibility in a crowded area, you could use this function to adjust their width and height. + +**Addons:** +Large addons like ElvUI and Plater Nameplates might use this function to allow users to customize the appearance of friendly nameplates according to their preferences. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md b/wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md new file mode 100644 index 00000000..c8a0ded5 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md @@ -0,0 +1,9 @@ +## Title: C_NamePlate.SetNamePlateSelfClickThrough + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateSelfClickThrough(clickthrough)` + +**Parameters:** +- `clickthrough` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md b/wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md new file mode 100644 index 00000000..a2367ec2 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md @@ -0,0 +1,15 @@ +## Title: C_NamePlate.SetNamePlateSelfPreferredClickInsets + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateSelfPreferredClickInsets(left, right, top, bottom)` + +**Parameters:** +- `left` + - *number* +- `right` + - *number* +- `top` + - *number* +- `bottom` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md b/wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md new file mode 100644 index 00000000..dc70a1e5 --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md @@ -0,0 +1,22 @@ +## Title: C_NamePlate.SetNamePlateSelfSize + +**Content:** +Needs summary. +`C_NamePlate.SetNamePlateSelfSize(width, height)` + +**Parameters:** +- `width` + - *number* +- `height` + - *number* + +**Example Usage:** +This function can be used to set the size of the player's own nameplate. For instance, if you want to make your nameplate larger for better visibility, you can call this function with the desired width and height. + +```lua +-- Example: Set the player's nameplate size to 150 width and 40 height +C_NamePlate.SetNamePlateSelfSize(150, 40) +``` + +**Usage in Addons:** +Large addons like ElvUI and Plater Nameplates use this function to customize the appearance of nameplates, including the player's own nameplate, to provide a more personalized and informative UI experience. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md b/wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md new file mode 100644 index 00000000..976aaa1e --- /dev/null +++ b/wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md @@ -0,0 +1,11 @@ +## Title: C_NamePlate.SetTargetClampingInsets + +**Content:** +Needs summary. +`C_NamePlate.SetTargetClampingInsets(verticalInset, unk)` + +**Parameters:** +- `verticalInset` + - *number* - The clamping inset from the top and bottom of the screen. +- `unk` + - *number* - Unknown \ No newline at end of file diff --git a/wiki-information/functions/C_NewItems.ClearAll.md b/wiki-information/functions/C_NewItems.ClearAll.md new file mode 100644 index 00000000..678f9a56 --- /dev/null +++ b/wiki-information/functions/C_NewItems.ClearAll.md @@ -0,0 +1,9 @@ +## Title: C_NewItems.ClearAll + +**Content:** +Clears the new item flag on all items in the player's inventory. +`C_NewItems.ClearAll()` + +**Reference:** +- `C_NewItems.IsNewItem` +- `C_NewItems.RemoveNewItem` \ No newline at end of file diff --git a/wiki-information/functions/C_NewItems.IsNewItem.md b/wiki-information/functions/C_NewItems.IsNewItem.md new file mode 100644 index 00000000..07cd1610 --- /dev/null +++ b/wiki-information/functions/C_NewItems.IsNewItem.md @@ -0,0 +1,19 @@ +## Title: C_NewItems.IsNewItem + +**Content:** +Returns true if the item in the inventory slot is flagged as new. +`isNew = C_NewItems.IsNewItem(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* - BagID of the container. +- `slotIndex` + - *number* - ID of the inventory slot within the container. + +**Returns:** +- `isNew` + - *boolean* - Returns true if the inventory slot holds a newly-acquired item; otherwise false (empty slot or a non-new item). + +**Reference:** +- `C_NewItems.RemoveNewItem(bag, slot)` - Used by FrameXML/ContainerFrame.lua to clear the new-item flag after interacting with the new item or closing the bags. +- `IsBattlePayItem(bag, slot)` - Used by FrameXML/ContainerFrame.lua to emphasize recent purchases from the In-Game Store. \ No newline at end of file diff --git a/wiki-information/functions/C_NewItems.RemoveNewItem.md b/wiki-information/functions/C_NewItems.RemoveNewItem.md new file mode 100644 index 00000000..99b5954a --- /dev/null +++ b/wiki-information/functions/C_NewItems.RemoveNewItem.md @@ -0,0 +1,14 @@ +## Title: C_NewItems.RemoveNewItem + +**Content:** +Clears the "new item" flag. +`C_NewItems.RemoveNewItem(containerIndex, slotIndex)` + +**Parameters:** +- `containerIndex` + - *number* : bagID - container slot id. +- `slotIndex` + - *number* - slot within the bag to clear the "new item" flag for. + +**Reference:** +- `C_NewItems.ClearAll` \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md b/wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md new file mode 100644 index 00000000..1d33ab4e --- /dev/null +++ b/wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md @@ -0,0 +1,21 @@ +## Title: C_PaperDollInfo.GetArmorEffectiveness + +**Content:** +Needs summary. +`effectiveness = C_PaperDollInfo.GetArmorEffectiveness(armor, attackerLevel)` + +**Parameters:** +- `armor` + - *number* +- `attackerLevel` + - *number* + +**Returns:** +- `effectiveness` + - *number* + +**Example Usage:** +This function can be used to determine the effectiveness of a player's armor against an attacker of a specific level. This can be particularly useful for addons that calculate damage mitigation or for theorycrafters analyzing the impact of armor on damage taken. + +**Addon Usage:** +Large addons like Pawn or SimulationCraft might use this function to provide players with detailed information about how their armor will perform against enemies of different levels. This helps players make informed decisions about gear upgrades and optimizations. \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md b/wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md new file mode 100644 index 00000000..f679efc5 --- /dev/null +++ b/wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md @@ -0,0 +1,13 @@ +## Title: C_PaperDollInfo.GetArmorEffectivenessAgainstTarget + +**Content:** +Needs summary. +`effectiveness = C_PaperDollInfo.GetArmorEffectivenessAgainstTarget(armor)` + +**Parameters:** +- `armor` + - *number* + +**Returns:** +- `effectiveness` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md b/wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md new file mode 100644 index 00000000..6d8a4068 --- /dev/null +++ b/wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md @@ -0,0 +1,15 @@ +## Title: C_PaperDollInfo.GetMinItemLevel + +**Content:** +Needs summary. +`minItemLevel = C_PaperDollInfo.GetMinItemLevel()` + +**Returns:** +- `minItemLevel` + - *number?* + +**Example Usage:** +This function can be used to retrieve the minimum item level of the player's equipment. This can be useful for addons that need to check if the player meets certain item level requirements for dungeons, raids, or other content. + +**Addon Usage:** +Large addons like "Pawn" or "GearScore" might use this function to evaluate and compare the player's gear to suggest upgrades or improvements. \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md b/wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md new file mode 100644 index 00000000..bb56dd08 --- /dev/null +++ b/wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md @@ -0,0 +1,9 @@ +## Title: C_PaperDollInfo.OffhandHasShield + +**Content:** +Needs summary. +`offhandHasShield = C_PaperDollInfo.OffhandHasShield()` + +**Returns:** +- `offhandHasShield` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md b/wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md new file mode 100644 index 00000000..bbbf775b --- /dev/null +++ b/wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md @@ -0,0 +1,9 @@ +## Title: C_PaperDollInfo.OffhandHasWeapon + +**Content:** +Needs summary. +`offhandHasWeapon = C_PaperDollInfo.OffhandHasWeapon()` + +**Returns:** +- `offhandHasWeapon` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md b/wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md new file mode 100644 index 00000000..a9348b13 --- /dev/null +++ b/wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md @@ -0,0 +1,9 @@ +## Title: C_PartyInfo.ConfirmLeaveParty + +**Content:** +Immediately leave the party with no regard for potentially destructive actions. +`C_PartyInfo.ConfirmLeaveParty()` + +**Parameters:** +- `category` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.GetActiveCategories.md b/wiki-information/functions/C_PartyInfo.GetActiveCategories.md new file mode 100644 index 00000000..3132c3a6 --- /dev/null +++ b/wiki-information/functions/C_PartyInfo.GetActiveCategories.md @@ -0,0 +1,9 @@ +## Title: C_PartyInfo.GetActiveCategories + +**Content:** +Needs summary. +`categories = C_PartyInfo.GetActiveCategories()` + +**Returns:** +- `categories` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md b/wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md new file mode 100644 index 00000000..a08182fc --- /dev/null +++ b/wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md @@ -0,0 +1,13 @@ +## Title: C_PartyInfo.GetInviteConfirmationInvalidQueues + +**Content:** +Needs summary. +`invalidQueues = C_PartyInfo.GetInviteConfirmationInvalidQueues(inviteGUID)` + +**Parameters:** +- `inviteGUID` + - *string* + +**Returns:** +- `invalidQueues` + - *unknown* QueueSpecificInfo \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md b/wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md new file mode 100644 index 00000000..2a4ccf54 --- /dev/null +++ b/wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md @@ -0,0 +1,19 @@ +## Title: C_PartyInfo.IsCrossFactionParty + +**Content:** +Needs summary. +`isCrossFactionParty = C_PartyInfo.IsCrossFactionParty()` + +**Parameters:** +- `category` + - *number?* - If not provided, the active party is used. + +**Returns:** +- `isCrossFactionParty` + - *boolean* + +**Example Usage:** +This function can be used to determine if the current party is a cross-faction party, which can be useful for addons that need to handle faction-specific logic differently. + +**Addons:** +Large addons like "ElvUI" or "DBM" might use this function to adjust their behavior based on whether the party is cross-faction, ensuring compatibility and proper functionality across different faction members. \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.IsPartyFull.md b/wiki-information/functions/C_PartyInfo.IsPartyFull.md new file mode 100644 index 00000000..b82098db --- /dev/null +++ b/wiki-information/functions/C_PartyInfo.IsPartyFull.md @@ -0,0 +1,29 @@ +## Title: C_PartyInfo.IsPartyFull + +**Content:** +Needs summary. +`isFull = C_PartyInfo.IsPartyFull()` + +**Parameters:** +- `category` + - *number?* - If not provided, the active party is used. + +**Returns:** +- `isFull` + - *boolean* + +**Example Usage:** +This function can be used to check if the current party is full. This is useful in scenarios where you want to ensure that there is space available before inviting another player to the party. + +**Example:** +```lua +if not C_PartyInfo.IsPartyFull() then + -- Invite a player to the party + InviteUnit("PlayerName") +else + print("The party is full.") +end +``` + +**Addons Usage:** +Large addons like "ElvUI" and "DBM" (Deadly Boss Mods) might use this function to manage party compositions and ensure that party-related features are only activated when the party is not full. For example, DBM might use it to check if there is room to invite more players for a raid. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.ClearSearchFilter.md b/wiki-information/functions/C_PetJournal.ClearSearchFilter.md new file mode 100644 index 00000000..97445524 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.ClearSearchFilter.md @@ -0,0 +1,14 @@ +## Title: C_PetJournal.ClearSearchFilter + +**Content:** +Clears the search box in the pet journal. +`C_PetJournal.ClearSearchFilter()` + +**Reference:** +- `C_PetJournal.SetSearchFilter` + +**Example Usage:** +This function can be used in addons that manage or enhance the pet journal interface. For instance, an addon that provides advanced search and filtering options for pets might use `C_PetJournal.ClearSearchFilter` to reset the search box before applying new filters. + +**Addons:** +Large addons like "Rematch" use this function to manage pet collections and provide a better user interface for pet battles and pet management. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.FindPetIDByName.md b/wiki-information/functions/C_PetJournal.FindPetIDByName.md new file mode 100644 index 00000000..6ca0c9e6 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.FindPetIDByName.md @@ -0,0 +1,15 @@ +## Title: C_PetJournal.FindPetIDByName + +**Content:** +Returns pet species and GUID by pet name. +`speciesId, petGUID = C_PetJournal.FindPetIDByName(petName)` + +**Parameters:** +- `petName` + - *string* - Name of the pet to find species/GUID of. + +**Returns:** +- `speciesId` + - *number* - Species ID of the first battle pet (or species) with the specified name, nil if no such pet exists. +- `petGUID` + - *string* - GUID of the first battle pet collected by the player with the specified name, nil if the player has not collected any pets with the specified name. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md b/wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md new file mode 100644 index 00000000..c3bc8c9c --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md @@ -0,0 +1,15 @@ +## Title: C_PetJournal.GetNumCollectedInfo + +**Content:** +Returns the number of collected battle pets of a particular species. +`numCollected, limit = C_PetJournal.GetNumCollectedInfo(speciesId)` + +**Parameters:** +- `speciesId` + - *number* - Battle pet species ID to query, e.g. 635 for Adder battle pets. + +**Returns:** +- `numCollected` + - *number* - Number of battle pets of the queried species the player has collected. +- `limit` + - *number* - Maximum number of battle pets of the queried species the player may collect. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPetSources.md b/wiki-information/functions/C_PetJournal.GetNumPetSources.md new file mode 100644 index 00000000..c6d40af7 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetNumPetSources.md @@ -0,0 +1,14 @@ +## Title: C_PetJournal.GetNumPetSources + +**Content:** +Returns information about the number of pet sources. +`numSources = C_PetJournal.GetNumPetSources()` + +**Returns:** +- `numSources` + - *number* - Number of pet sources available + +**Reference:** +- `C_PetJournal.SetAllPetSourcesChecked` +- `C_PetJournal.IsPetSourceChecked` +- `C_PetJournal.SetPetSourceChecked` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPetTypes.md b/wiki-information/functions/C_PetJournal.GetNumPetTypes.md new file mode 100644 index 00000000..0741c916 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetNumPetTypes.md @@ -0,0 +1,14 @@ +## Title: C_PetJournal.GetNumPetTypes + +**Content:** +Returns information about the number of pet types. +`numTypes = C_PetJournal.GetNumPetTypes()` + +**Returns:** +- `numTypes` + - *number* - Number of pet types available + +**Reference:** +- `C_PetJournal.SetAllPetTypesChecked` +- `C_PetJournal.IsPetTypeChecked` +- `C_PetJournal.SetPetTypeFilter` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPets.md b/wiki-information/functions/C_PetJournal.GetNumPets.md new file mode 100644 index 00000000..9602035f --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetNumPets.md @@ -0,0 +1,11 @@ +## Title: C_PetJournal.GetNumPets + +**Content:** +Returns information about the number of battle pets. +`numPets, numOwned = C_PetJournal.GetNumPets()` + +**Returns:** +- `numPets` + - *number* - Total number of pets available +- `numOwned` + - *number* - Number of pets currently owned \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md b/wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md new file mode 100644 index 00000000..51b697b2 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md @@ -0,0 +1,15 @@ +## Title: C_PetJournal.GetNumPetsInJournal + +**Content:** +Needs summary. +`maxAllowed, numPets = C_PetJournal.GetNumPetsInJournal(creatureID)` + +**Parameters:** +- `creatureID` + - *number* + +**Returns:** +- `maxAllowed` + - *number* +- `numPets` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md b/wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md new file mode 100644 index 00000000..1ad712d7 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md @@ -0,0 +1,13 @@ +## Title: C_PetJournal.GetOwnedBattlePetString + +**Content:** +Returns a formatted string indicating how many of a battle pet species the player has collected. +`ownedString = C_PetJournal.GetOwnedBattlePetString(speciesId)` + +**Parameters:** +- `speciesId` + - *number* - Battle pet species ID. + +**Returns:** +- `ownedString` + - *string* - a description of how many pets of this species you've collected, e.g. `"|cFFFFD200Collected (1/3)"`, or `nil` if you haven't collected any. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md b/wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md new file mode 100644 index 00000000..a5abcfba --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md @@ -0,0 +1,20 @@ +## Title: C_PetJournal.GetPetCooldownByGUID + +**Content:** +Returns the cooldown associated with summoning a battle pet companion. +`start, duration, isEnabled = C_PetJournal.GetPetCooldownByGUID(GUID)` + +**Parameters:** +- `GUID` + - *string* - GUID of a battle pet in your collection to query the cooldown of. + +**Returns:** +- `start` + - *number* - the time the cooldown period began, based on GetTime(). +- `duration` + - *number* - the duration of the cooldown period. +- `isEnabled` + - *number* - 1 if the cooldown is not paused. + +**Description:** +If the queried pet is not currently on a cooldown, this function will return 0, 0, 1. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md b/wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md new file mode 100644 index 00000000..1fd8e5a6 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md @@ -0,0 +1,72 @@ +## Title: C_PetJournal.GetPetInfoByIndex + +**Content:** +Returns information about a battle pet. +`petID, speciesID, owned, customName, level, favorite, isRevoked, speciesName, icon, petType, companionID, tooltip, description, isWild, canBattle, isTradeable, isUnique, obtainable = C_PetJournal.GetPetInfoByIndex(index)` + +**Parameters:** +- `index` + - *number* - Numeric index of the pet in the Pet Journal, ascending from 1. + +**Returns:** +- `Index` +- `Value` +- `Type` +- `Details` + - `1` + - `petID` + - *String* - GUID for this specific pet + - `2` + - `speciesID` + - *Number* - Identifier for the pet species + - `3` + - `owned` + - *Boolean* - Whether the pet is owned by the player + - `4` + - `customName` + - *String* - Name assigned by the player or nil if unnamed + - `5` + - `level` + - *Number* - The pet's current battle level + - `6` + - `favorite` + - *Boolean* - Whether the pet is marked as a favorite + - `7` + - `isRevoked` + - *Boolean* - True if the pet is revoked; false otherwise. + - `8` + - `speciesName` + - *String* - Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.) + - `9` + - `icon` + - *String* - Full path for the species' icon + - `10` + - `petType` + - *Number* - Index of the species' petType. + - `11` + - `companionID` + - *Number* - NPC ID for the summoned companion pet. + - `12` + - `tooltip` + - *String* - Section of the tooltip that provides location information + - `13` + - `description` + - *String* - Section of the tooltip that provides pet description ("flavor text") + - `14` + - `isWild` + - *Boolean* - True if the pet was/can be caught in the wild, false otherwise. + - `15` + - `canBattle` + - *Boolean* - True if this pet can be used in battles, false otherwise. + - `16` + - `isTradeable` + - *Boolean* - True if this pet can be traded, false otherwise. + - `17` + - `isUnique` + - *Boolean* - True if this pet is unique, false otherwise. + - `18` + - `obtainable` + - *Boolean* - True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets). + +**Description:** +`index` is subject to filter and search result, e.g., a search for "Snake" where `index` is 1 will return information about the first snake in the journal, whereas an empty search and filter will return information about the first pet in the journal. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md b/wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md new file mode 100644 index 00000000..85cfd718 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md @@ -0,0 +1,38 @@ +## Title: C_PetJournal.GetPetInfoByPetID + +**Content:** +Returns information about a battle pet. +`speciesID, customName, level, xp, maxXp, displayID, isFavorite, name, icon, petType, creatureID, sourceText, description, isWild, canBattle, tradable, unique, obtainable = C_PetJournal.GetPetInfoByPetID(petID)` + +**Parameters:** +- `petID` + - *string* : GUID + +**Returns:** +| Index | Value | Type | Details | +|-------|-------------|---------|-----------------------------------------------------------------------------------------------| +| 1 | speciesID | Number | Identifier for the pet species | +| 2 | customName | String | Name assigned by the player or nil if unnamed | +| 3 | level | Number | The pet's current battle level | +| 4 | xp | Number | The pet's current xp | +| 5 | maxXp | Number | The pet's maximum xp | +| 6 | displayID | Number | The display ID of the pet | +| 7 | isFavorite | Boolean | Whether the pet is marked as a favorite | +| 8 | name | String | Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.) | +| 9 | icon | String | Full path for the species' icon | +| 10 | petType | Number | Index of the species' pet type | +| 11 | creatureID | Number | NPC ID for the summoned companion pet | +| 12 | sourceText | String | Section of the tooltip that provides location information | +| 13 | description | String | Section of the tooltip that provides pet description ("flavor text") | +| 14 | isWild | Boolean | For pets in the player's possession, true if the pet was caught in the wild. For pets not in the player's possession, true if the pet can be caught in the wild. | +| 15 | canBattle | Boolean | True if this pet can be used in battles, false otherwise. | +| 16 | tradable | Boolean | True if this pet can be traded, false otherwise. | +| 17 | unique | Boolean | True if this pet is unique, false otherwise. | +| 18 | obtainable | Boolean | True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets). | + +**Description:** +Information about the player's battle pets is available after `UPDATE_SUMMONPETS_ACTION` has fired. + +**Reference:** +- `C_PetJournal.GetPetStats` +- `C_PetJournal.GetPetInfoBySpeciesID` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md b/wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md new file mode 100644 index 00000000..1d94f2cf --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md @@ -0,0 +1,28 @@ +## Title: C_PetJournal.GetPetInfoBySpeciesID + +**Content:** +Returns information about a pet species. +`speciesName, speciesIcon, petType, companionID, tooltipSource, tooltipDescription, isWild, canBattle, isTradeable, isUnique, obtainable, creatureDisplayID = C_PetJournal.GetPetInfoBySpeciesID(speciesID)` + +**Parameters:** +- `speciesID` + - *number* - identifier for the pet species + +**Returns:** +| Index | Value | Type | Details | +|-------|---------------------|---------|--------------------------------------------------------------------------------------------------------------| +| 1 | speciesName | String | Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.) | +| 2 | speciesIcon | String | Full path for the species' icon | +| 3 | petType | Number | Index of the species' pet type. | +| 4 | companionID | Number | NPC ID for the summoned companion pet. | +| 5 | tooltipSource | String | Section of the species tooltip that provides location information | +| 6 | tooltipDescription | String | Section of the species tooltip that provides pet description ("flavor text") | +| 7 | isWild | Boolean | For pets in the player's possession, true if the pet was caught in the wild. For pets not in the player's possession, true if the pet can be caught in the wild. | +| 8 | canBattle | Boolean | True if this pet can be used in battles, false otherwise. | +| 9 | isTradeable | Boolean | True if this pet can be traded, false otherwise. | +| 10 | isUnique | Boolean | True if this pet is unique, false otherwise. | +| 11 | obtainable | Boolean | True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets). | +| 12 | creatureDisplayID | Number | Creature display ID of the species. | + +**Reference:** +`C_PetJournal.GetPetInfoByPetID` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md b/wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md new file mode 100644 index 00000000..a1455a10 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md @@ -0,0 +1,25 @@ +## Title: C_PetJournal.GetPetLoadOutInfo + +**Content:** +Returns information about a slot in your battle pet team. +`petGUID, ability1, ability2, ability3, locked = C_PetJournal.GetPetLoadOutInfo(slotIndex)` + +**Parameters:** +- `slotIndex` + - *number* - battle pet slot index, an integer between 1 and 3. Values outside this range throw an error. + +**Returns:** +- `petGUID` + - *string* - GUID of the battle pet currently in this slot. +- `ability1` + - *number* - Ability ID of the first (level 1/10) ability selected for the battle pet in this slot. +- `ability2` + - *number* - Ability ID of the second (level 2/15) ability selected for the battle pet in this slot. +- `ability3` + - *number* - Ability ID of the third (level 4/20) ability selected for the battle pet in this slot. +- `locked` + - *boolean* - false if the player can place a battle pet in this slot, true otherwise. + +**Description:** +Ability IDs are returned even for slots that are not yet unlocked by a low-level battle pet. +Slots are locked until the player has earned the necessary achievement/skill. The first slot is unlocked by learning. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetSortParameter.md b/wiki-information/functions/C_PetJournal.GetPetSortParameter.md new file mode 100644 index 00000000..acf2eec3 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetPetSortParameter.md @@ -0,0 +1,12 @@ +## Title: C_PetJournal.GetPetSortParameter + +**Content:** +Returns the index of the currently active sort parameter. +`sortParameter = C_PetJournal.GetPetSortParameter()` + +**Returns:** +- `sortParameter` + - *number* - currently active ordering for `C_PetJournal.GetPetInfoByIndex`, e.g. 1 for sorting by name. + +**Reference:** +- `C_PetJournal.SetPetSortParameter` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetSummonInfo.md b/wiki-information/functions/C_PetJournal.GetPetSummonInfo.md new file mode 100644 index 00000000..3ae51b05 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetPetSummonInfo.md @@ -0,0 +1,27 @@ +## Title: C_PetJournal.GetPetSummonInfo + +**Content:** +Needs summary. +`isSummonable, error, errorText = C_PetJournal.GetPetSummonInfo(battlePetGUID)` + +**Parameters:** +- `battlePetGUID` + - *string* + +**Returns:** +- `isSummonable` + - *boolean* +- `error` + - *Enum.PetJournalError* + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - PetIsDead + - `2` - JournalIsLocked + - `3` - InvalidFaction + - `4` - NoFavoritesToSummon + - `5` - NoValidRandomSummon + - `6` - InvalidCovenant +- `errorText` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md b/wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md new file mode 100644 index 00000000..d712cc84 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md @@ -0,0 +1,15 @@ +## Title: C_PetJournal.GetSummonedPetGUID + +**Content:** +Returns information about a battle pet. +`summonedPetGUID = C_PetJournal.GetSummonedPetGUID()` + +**Returns:** +- `summonedPetGUID` + - *string* - GUID identifying the currently-summoned battle pet, or nil if no battle pet is summoned. + +**Description:** +Blizzard has moved all petIDs over to the "petGUID" system, but left all of their functions using the petID terminology (not the petGUID terminology) except for this one. For consistency, the term "petID" should continue to be used. + +**Reference:** +- `C_PetJournal.SummonPetByGUID` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.IsFilterChecked.md b/wiki-information/functions/C_PetJournal.IsFilterChecked.md new file mode 100644 index 00000000..f1f91d29 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.IsFilterChecked.md @@ -0,0 +1,18 @@ +## Title: C_PetJournal.IsFilterChecked + +**Content:** +Returns true if the selected filter is checked. +`isFiltered = C_PetJournal.IsFilterChecked(filter)` + +**Parameters:** +- `filter` + - *number* - Bitfield for each filter + - `LE_PET_JOURNAL_FILTER_COLLECTED`: Pets you have collected + - `LE_PET_JOURNAL_FILTER_NOT_COLLECTED`: Pets you have not collected + +**Returns:** +- `isFiltered` + - *boolean* - True if the filter is checked, false if the filter is unchecked + +**Reference:** +- `C_PetJournal.SetFilterChecked` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.IsPetSourceChecked.md b/wiki-information/functions/C_PetJournal.IsPetSourceChecked.md new file mode 100644 index 00000000..9a2da1a1 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.IsPetSourceChecked.md @@ -0,0 +1,18 @@ +## Title: C_PetJournal.IsPetSourceChecked + +**Content:** +Returns true if the pet source is checked. +`isChecked = C_PetJournal.IsPetSourceChecked(index)` + +**Parameters:** +- `index` + - *number* - Index (from 1 to GetNumPetSources()) of all available pet sources + +**Returns:** +- `isChecked` + - *boolean* - True if the source is checked, false if the source is unchecked + +**Reference:** +- `C_PetJournal.SetAllPetSourcesChecked` +- `C_PetJournal.SetPetSourceChecked` +- `C_PetJournal.GetNumPetSources` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.IsPetTypeChecked.md b/wiki-information/functions/C_PetJournal.IsPetTypeChecked.md new file mode 100644 index 00000000..018bb0c6 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.IsPetTypeChecked.md @@ -0,0 +1,18 @@ +## Title: C_PetJournal.IsPetTypeChecked + +**Content:** +Returns true if the pet type is checked. +`isChecked = C_PetJournal.IsPetTypeChecked(index)` + +**Parameters:** +- `index` + - *number* - Index (from 1 to GetNumPetTypes()) of all available pet types + +**Returns:** +- `isChecked` + - *boolean* - True if the filter is checked, false if the filter is unchecked + +**Reference:** +- `C_PetJournal.SetAllPetTypesChecked` +- `C_PetJournal.SetPetTypeFilter` +- `C_PetJournal.GetNumPetTypes` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PetIsFavorite.md b/wiki-information/functions/C_PetJournal.PetIsFavorite.md new file mode 100644 index 00000000..f9cf7663 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.PetIsFavorite.md @@ -0,0 +1,13 @@ +## Title: C_PetJournal.PetIsFavorite + +**Content:** +Returns true if the collected battle pet is favorited. +`isFavorite = C_PetJournal.PetIsFavorite(petGUID)` + +**Parameters:** +- `petGUID` + - *string* - GUID of a battle pet in your collection. + +**Returns:** +- `isFavorite` + - *boolean* - true if this pet is marked as a favorite, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PetIsRevoked.md b/wiki-information/functions/C_PetJournal.PetIsRevoked.md new file mode 100644 index 00000000..df7b34ac --- /dev/null +++ b/wiki-information/functions/C_PetJournal.PetIsRevoked.md @@ -0,0 +1,17 @@ +## Title: C_PetJournal.PetIsRevoked + +**Content:** +Returns whether or not the pet is revoked. +`isRevoked = C_PetJournal.PetIsRevoked(petID)` + +**Parameters:** +- `petID` + - *string* - Unique identifier for this specific pet. + +**Returns:** +- `isRevoked` + - *boolean* - true if the pet is revoked. + +**Description:** +Revoked pets are pets that have been stripped from the player in every fashion except for their name. They remain in the Pet Journal, but they cannot be summoned or used in battle. In addition, the rarity border and level icon will not appear around and over the pet's name in the Pet Journal's scrolling list. +This function returns true for Blizzard Pet Store pets on the PTR, which suggests that `isRevoked` is only ever true for pets that cost money and have not been authorized for a specific World of Warcraft account. This mechanic is likely in place to prevent characters from transferring with an unused Blizzard Pet Store pet to a different account that does not have access to that pet. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PetIsSummonable.md b/wiki-information/functions/C_PetJournal.PetIsSummonable.md new file mode 100644 index 00000000..3ff941fd --- /dev/null +++ b/wiki-information/functions/C_PetJournal.PetIsSummonable.md @@ -0,0 +1,13 @@ +## Title: C_PetJournal.PetIsSummonable + +**Content:** +Returns true if you can summon this pet. +`isSummonable = C_PetJournal.PetIsSummonable(battlePetGUID)` + +**Parameters:** +- `battlePetGUID` + - *string* - Unique identifier for this specific pet. + +**Returns:** +- `isSummonable` + - *boolean* - True if the pet can be summoned, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PickupPet.md b/wiki-information/functions/C_PetJournal.PickupPet.md new file mode 100644 index 00000000..ef5f746c --- /dev/null +++ b/wiki-information/functions/C_PetJournal.PickupPet.md @@ -0,0 +1,17 @@ +## Title: C_PetJournal.PickupPet + +**Content:** +Places a battle pet onto the mouse cursor. +`C_PetJournal.PickupPet(petID)` + +**Parameters:** +- `petID` + - *string* - GUID of a battle pet in your collection. + +**Description:** +The function places a specific battle pet in your collection on your cursor. +Battle pets on your cursor can be placed on your action bars. +Attempting to pick up a battle pet that's already on the cursor clears the cursor instead. + +**Reference:** +`GetCursorInfo` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md b/wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md new file mode 100644 index 00000000..9727f0b4 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md @@ -0,0 +1,14 @@ +## Title: C_PetJournal.SetAllPetSourcesChecked + +**Content:** +Sets or clears all the pet sources in the filter menu. +`C_PetJournal.SetAllPetSourcesChecked(value)` + +**Parameters:** +- `value` + - *boolean* - True to set all the pet sources, false to clear all the pet sources + +**Reference:** +- `C_PetJournal.SetPetSourceChecked` +- `C_PetJournal.IsPetSourceChecked` +- `C_PetJournal.GetNumPetSources` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md b/wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md new file mode 100644 index 00000000..1f28718d --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md @@ -0,0 +1,14 @@ +## Title: C_PetJournal.SetAllPetTypesChecked + +**Content:** +Sets or clears all the pet types in the filter menu. +`C_PetJournal.SetAllPetTypesChecked(value)` + +**Parameters:** +- `value` + - *boolean* - True to set all the pet types, false to clear all the pet types + +**Reference:** +- `C_PetJournal.SetPetTypeFilter` +- `C_PetJournal.IsPetTypeChecked` +- `C_PetJournal.GetNumPetTypes` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetFavorite.md b/wiki-information/functions/C_PetJournal.SetFavorite.md new file mode 100644 index 00000000..9663179b --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetFavorite.md @@ -0,0 +1,13 @@ +## Title: C_PetJournal.SetFavorite + +**Content:** +Sets (or clears) the pet as a favorite. +`C_PetJournal.SetFavorite(petID, value)` + +**Parameters:** +- `petID` + - *string* - Unique identifier for this specific pet +- `value` + - *number* - + - `0`: Pet is not a favorite + - `1`: Pet is a favorite \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetFilterChecked.md b/wiki-information/functions/C_PetJournal.SetFilterChecked.md new file mode 100644 index 00000000..01e08ae6 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetFilterChecked.md @@ -0,0 +1,16 @@ +## Title: C_PetJournal.SetFilterChecked + +**Content:** +Sets the filters in the filter menu. +`C_PetJournal.SetFilterChecked(filter, value)` + +**Parameters:** +- `filter` + - *number* - Bitfield for each filter + - `LE_PET_JOURNAL_FILTER_COLLECTED`: Pets you have collected + - `LE_PET_JOURNAL_FILTER_NOT_COLLECTED`: Pets you have not collected +- `value` + - *boolean* - True to set the filter, false to clear the filter + +**Reference:** +- `C_PetJournal.IsFilterChecked` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md b/wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md new file mode 100644 index 00000000..fc3467fe --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md @@ -0,0 +1,24 @@ +## Title: C_PetJournal.SetPetLoadOutInfo + +**Content:** +Places the specified pet into a battle pet slot. +`C_PetJournal.SetPetLoadOutInfo(slotIndex, petID)` + +**Parameters:** +- `slotIndex` + - *number* - Battle pet slot index, integer between 1 and 3. +- `petID` + - *string* - Battle pet GUID of a pet in your collection to move into the battle pet slot. + +**Description:** +If the pet specified by `petID` is already in a battle pet slot, the pets are exchanged. + +**Reference:** +- `C_PetJournal.SetAbility` +- `C_PetJournal.GetPetLoadOutInfo` + +### Example Usage: +This function can be used in an addon to automate the process of setting up battle pets for pet battles. For instance, an addon could allow users to save and load different pet battle teams quickly. + +### Addon Usage: +- **Rematch**: A popular addon that helps players manage their pet battle teams. It uses `C_PetJournal.SetPetLoadOutInfo` to set pets into specific slots when loading saved teams. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetSortParameter.md b/wiki-information/functions/C_PetJournal.SetPetSortParameter.md new file mode 100644 index 00000000..d88d2ed5 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetPetSortParameter.md @@ -0,0 +1,25 @@ +## Title: C_PetJournal.SetPetSortParameter + +**Content:** +Changes the battle pet ordering in the pet journal. +`C_PetJournal.SetPetSortParameter(sortParameter)` + +**Parameters:** +- `sortParameter` + - *number* - Index of the ordering type that should be applied to `C_PetJournal.GetPetInfoByIndex` returns; one of the following global numeric values: + - `LE_SORT_BY_NAME` + - `LE_SORT_BY_LEVEL` + - `LE_SORT_BY_RARITY` + - `LE_SORT_BY_PETTYPE` + +**Reference:** +- `C_PetJournal.GetPetSortParameter` + +### Example Usage: +This function can be used to change the sorting order of pets in the Pet Journal. For instance, if you want to sort your pets by their level, you would call: +```lua +C_PetJournal.SetPetSortParameter(LE_SORT_BY_LEVEL) +``` + +### Addon Usage: +Large addons like "Rematch" use this function to allow users to customize the sorting of their pet lists based on different criteria such as name, level, rarity, or pet type. This enhances the user experience by providing flexible ways to organize and manage their pet collections. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetSourceChecked.md b/wiki-information/functions/C_PetJournal.SetPetSourceChecked.md new file mode 100644 index 00000000..993f4431 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetPetSourceChecked.md @@ -0,0 +1,16 @@ +## Title: C_PetJournal.SetPetSourceChecked + +**Content:** +Sets the pet source in the filter menu. +`C_PetJournal.SetPetSourceChecked(index, value)` + +**Parameters:** +- `index` + - *number* - Index (from 1 to GetNumPetSources()) of all available pet sources +- `value` + - *boolean* - True to set the pet source, false to clear the pet source + +**Reference:** +- `C_PetJournal.SetAllPetSourcesChecked` +- `C_PetJournal.IsPetSourceChecked` +- `C_PetJournal.GetNumPetSources` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetTypeFilter.md b/wiki-information/functions/C_PetJournal.SetPetTypeFilter.md new file mode 100644 index 00000000..aa3f4431 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetPetTypeFilter.md @@ -0,0 +1,16 @@ +## Title: C_PetJournal.SetPetTypeFilter + +**Content:** +Sets the pet type in the filter menu. +`C_PetJournal.SetPetTypeFilter(index, value)` + +**Parameters:** +- `index` + - *number* - Index (from 1 to GetNumPetTypes()) of all available pet types +- `value` + - *boolean* - True to set the pet type, false to clear the pet type + +**Reference:** +- `C_PetJournal.SetAllPetTypesChecked` +- `C_PetJournal.IsPetTypeChecked` +- `C_PetJournal.GetNumPetTypes` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetSearchFilter.md b/wiki-information/functions/C_PetJournal.SetSearchFilter.md new file mode 100644 index 00000000..75678876 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SetSearchFilter.md @@ -0,0 +1,12 @@ +## Title: C_PetJournal.SetSearchFilter + +**Content:** +Sets the search filter in the pet journal. +`C_PetJournal.SetSearchFilter(text)` + +**Parameters:** +- `text` + - *string* - Search text for the pet journal + +**Reference:** +- `C_PetJournal.ClearSearchFilter` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SummonPetByGUID.md b/wiki-information/functions/C_PetJournal.SummonPetByGUID.md new file mode 100644 index 00000000..2a1d6d06 --- /dev/null +++ b/wiki-information/functions/C_PetJournal.SummonPetByGUID.md @@ -0,0 +1,29 @@ +## Title: C_PetJournal.SummonPetByGUID + +**Content:** +Summons (or dismisses) a pet. +`C_PetJournal.SummonPetByGUID(petID)` + +**Parameters:** +- `petID` + - *string* - GUID of the battle pet to summon. If the pet is already summoned, it will be dismissed. + +**Description:** +You can dismiss the currently-summoned battle pet by running: +```lua +C_PetJournal.SummonPetByGUID(C_PetJournal.GetSummonedPetGUID()) +``` +Note that this will throw an error if you do not have a pet summoned. +Blizzard has moved all petIDs over to the "petGUID" system, but left all of their functions using the petID terminology (not the petGUID terminology) except for this one. For consistency, the term "petID" should continue to be used. + +**Reference:** +- `C_PetJournal.GetSummonedPetGUID` + +### Example Usage: +This function can be used in macros or addons to manage battle pets. For example, you could create a macro to summon a specific pet by its GUID: +```lua +/run C_PetJournal.SummonPetByGUID("BattlePet-0-000012345678") +``` + +### Addon Usage: +Large addons like Rematch use this function to manage pet teams and automate the summoning and dismissing of pets based on the player's preferences and the current situation in the game. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.CanUseItem.md b/wiki-information/functions/C_PlayerInfo.CanUseItem.md new file mode 100644 index 00000000..b35c3c64 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.CanUseItem.md @@ -0,0 +1,19 @@ +## Title: C_PlayerInfo.CanUseItem + +**Content:** +Needs summary. +`isUseable = C_PlayerInfo.CanUseItem(itemID)` + +**Parameters:** +- `itemID` + - *number* + +**Returns:** +- `isUseable` + - *boolean* + +**Example Usage:** +This function can be used to check if a player can use a specific item based on their current state, such as level, class, or other restrictions. + +**Addon Usage:** +Large addons like WeakAuras might use this function to determine if a player can use a specific item before displaying an alert or creating a custom UI element. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md b/wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md new file mode 100644 index 00000000..1ab22ce4 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md @@ -0,0 +1,16 @@ +## Title: C_PlayerInfo.GUIDIsPlayer + +**Content:** +Returns true if the GUID belongs to a player. +`isPlayer = C_PlayerInfo.GUIDIsPlayer(guid)` + +**Parameters:** +- `guid` + - *string* - The GUID to be checked. + +**Returns:** +- `isPlayer` + - *boolean* - True if the GUID represents a player unit, or false if not. + +**Description:** +This function currently as of patch 9.0.2 only validates that the supplied GUID begins with the string "Player-". \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md b/wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md new file mode 100644 index 00000000..45d7acf9 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md @@ -0,0 +1,11 @@ +## Title: C_PlayerInfo.GetAlternateFormInfo + +**Content:** +Returns if the player has an alternate form and if they are currently in that form. +`hasAlternateForm, inAlternateForm = C_PlayerInfo.GetAlternateFormInfo()` + +**Returns:** +- `hasAlternateForm` + - *boolean* +- `inAlternateForm` + - *boolean* - Whether the player is in their alternate form (such as in human form for worgen). \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetClass.md b/wiki-information/functions/C_PlayerInfo.GetClass.md new file mode 100644 index 00000000..b1b1d996 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetClass.md @@ -0,0 +1,17 @@ +## Title: C_PlayerInfo.GetClass + +**Content:** +Returns the class of a player. +`className, classFilename, classID = C_PlayerInfo.GetClass(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin*🔗 + +**Returns:** +- `className` + - *string?* +- `classFilename` + - *string?* +- `classID` + - *number?* : ClassId \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetDisplayID.md b/wiki-information/functions/C_PlayerInfo.GetDisplayID.md new file mode 100644 index 00000000..ef0b3085 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetDisplayID.md @@ -0,0 +1,9 @@ +## Title: C_PlayerInfo.GetDisplayID + +**Content:** +Needs summary. +`displayID = C_PlayerInfo.GetDisplayID()` + +**Returns:** +- `displayID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetName.md b/wiki-information/functions/C_PlayerInfo.GetName.md new file mode 100644 index 00000000..ba2decee --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetName.md @@ -0,0 +1,27 @@ +## Title: C_PlayerInfo.GetName + +**Content:** +Returns the name of a player. +`name = C_PlayerInfo.GetName(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin*🔗 + +**Returns:** +- `name` + - *string?* + +**Example Usage:** +```lua +local playerLocation = PlayerLocation:CreateFromUnit("player") +local playerName = C_PlayerInfo.GetName(playerLocation) +print("Player's name is: " .. (playerName or "Unknown")) +``` + +**Description:** +This function is useful for retrieving the name of a player based on their location. It can be particularly handy in addons that need to display or log player names dynamically. + +**Addons Using This Function:** +- **Details! Damage Meter**: Uses this function to fetch and display player names in the damage and healing meters. +- **WeakAuras**: Utilizes this function to get player names for custom triggers and displays. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md b/wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md new file mode 100644 index 00000000..6a8b5883 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md @@ -0,0 +1,9 @@ +## Title: C_PlayerInfo.GetNativeDisplayID + +**Content:** +Needs summary. +`nativeDisplayID = C_PlayerInfo.GetNativeDisplayID()` + +**Returns:** +- `nativeDisplayID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md b/wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md new file mode 100644 index 00000000..712b2302 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md @@ -0,0 +1,13 @@ +## Title: C_PlayerInfo.GetPetStableCreatureDisplayInfoID + +**Content:** +Needs summary. +`creatureDisplayInfoID = C_PlayerInfo.GetPetStableCreatureDisplayInfoID(index)` + +**Parameters:** +- `index` + - *number* + +**Returns:** +- `creatureDisplayInfoID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md b/wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md new file mode 100644 index 00000000..a63b852d --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md @@ -0,0 +1,50 @@ +## Title: C_PlayerInfo.GetPlayerCharacterData + +**Content:** +Needs summary. +`characterData = C_PlayerInfo.GetPlayerCharacterData()` + +**Returns:** +- `characterData` + - *PlayerInfoCharacterData* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `fileName` + - *string* + - `alternateFormRaceData` + - *CharacterAlternateFormData?* + - `createScreenIconAtlas` + - *string* + - `sex` + - *Enum.UnitSex* + +**CharacterAlternateFormData** +- `Field` +- `Type` +- `Description` +- `raceID` + - *number* +- `name` + - *string* +- `fileName` + - *string* +- `createScreenIconAtlas` + - *string* + +**Enum.UnitSex** +- `Value` +- `Field` +- `Description` +- `0` + - Male +- `1` + - Female +- `2` + - None +- `3` + - Both +- `4` + - Neutral \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetRace.md b/wiki-information/functions/C_PlayerInfo.GetRace.md new file mode 100644 index 00000000..993bd527 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetRace.md @@ -0,0 +1,27 @@ +## Title: C_PlayerInfo.GetRace + +**Content:** +Returns the race of a player. +`raceID = C_PlayerInfo.GetRace(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin*🔗 + +**Returns:** +- `raceID` + - *number?* + +**Example Usage:** +```lua +local playerLocation = PlayerLocation:CreateFromUnit("player") +local raceID = C_PlayerInfo.GetRace(playerLocation) +print("Player's race ID is:", raceID) +``` + +**Description:** +This function is useful for determining the race of a player character, which can be used in various addons to customize behavior or display information based on the player's race. For example, an addon might use this function to provide race-specific tips or to adjust the appearance of the UI based on the player's race. + +**Addons Using This Function:** +- **WeakAuras**: This popular addon uses `C_PlayerInfo.GetRace` to customize auras and triggers based on the player's race, allowing for more personalized and relevant notifications. +- **ElvUI**: This comprehensive UI overhaul addon may use this function to adjust the interface elements and themes according to the player's race, providing a more immersive experience. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetSex.md b/wiki-information/functions/C_PlayerInfo.GetSex.md new file mode 100644 index 00000000..6af4071b --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.GetSex.md @@ -0,0 +1,35 @@ +## Title: C_PlayerInfo.GetSex + +**Content:** +Returns the sex of a player. +`sex = C_PlayerInfo.GetSex(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* + +**Returns:** +- `sex` + - *Enum.UnitSex?* + - `Value` + - `Field` + - `Description` + - `0` + - Male + - `1` + - Female + - `2` + - None + - `3` + - Both + - `4` + - Neutral + +**Usage:** +Returns the gender of your character. +```lua +/dump C_PlayerInfo.GetSex(PlayerLocation:CreateFromUnit("player")) -- 1 (Female) +``` + +**Reference:** +- `UnitSex()` \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md b/wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md new file mode 100644 index 00000000..f855ef26 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md @@ -0,0 +1,19 @@ +## Title: C_PlayerInfo.HasVisibleInvSlot + +**Content:** +Needs summary. +`isVisible = C_PlayerInfo.HasVisibleInvSlot(slot)` + +**Parameters:** +- `slot` + - *number* + +**Returns:** +- `isVisible` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific inventory slot is visible on the player's character. For instance, it can be useful in addons that manage or display equipment, ensuring that certain slots are not hidden or obscured. + +**Addon Usage:** +Large addons like "ElvUI" or "WeakAuras" might use this function to dynamically adjust the user interface based on the visibility of inventory slots, providing a more customized and responsive experience for the player. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsConnected.md b/wiki-information/functions/C_PlayerInfo.IsConnected.md new file mode 100644 index 00000000..b163b668 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.IsConnected.md @@ -0,0 +1,22 @@ +## Title: C_PlayerInfo.IsConnected + +**Content:** +Returns true if the player is connected. +`isConnected = C_PlayerInfo.IsConnected()` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin?* + +**Returns:** +- `isConnected` + - *boolean?* + +**Reference:** +- `UnitIsConnected()` + +**Example Usage:** +This function can be used to check if a specific player is currently connected to the game. This is particularly useful in scenarios where you need to verify the connection status of a player before performing certain actions, such as sending a message or inviting them to a group. + +**Addon Usage:** +Large addons like "ElvUI" and "WeakAuras" might use this function to ensure that the player or other players are connected before updating UI elements or triggering certain events. For instance, "ElvUI" could use it to check the connection status of group members to display accurate information in the unit frames. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md b/wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md new file mode 100644 index 00000000..ddc33ad2 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md @@ -0,0 +1,9 @@ +## Title: C_PlayerInfo.IsDisplayRaceNative + +**Content:** +Needs summary. +`isDisplayRaceNative = C_PlayerInfo.IsDisplayRaceNative()` + +**Returns:** +- `isDisplayRaceNative` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsMirrorImage.md b/wiki-information/functions/C_PlayerInfo.IsMirrorImage.md new file mode 100644 index 00000000..6049499b --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.IsMirrorImage.md @@ -0,0 +1,9 @@ +## Title: C_PlayerInfo.IsMirrorImage + +**Content:** +Needs summary. +`isMirrorImage = C_PlayerInfo.IsMirrorImage()` + +**Returns:** +- `isMirrorImage` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md b/wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md new file mode 100644 index 00000000..a7ad6f6c --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md @@ -0,0 +1,9 @@ +## Title: C_PlayerInfo.IsPlayerNPERestricted + +**Content:** +Returns true if the player has new player experience restrictions in place. +`isRestricted = C_PlayerInfo.IsPlayerNPERestricted()` + +**Returns:** +- `isRestricted` + - *boolean* - True if the player has new player experience restrictions in place. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md b/wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md new file mode 100644 index 00000000..a2529162 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md @@ -0,0 +1,9 @@ +## Title: C_PlayerInfo.IsSelfFoundActive + +**Content:** +Needs summary. +`active = C_PlayerInfo.IsSelfFoundActive()` + +**Returns:** +- `active` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md b/wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md new file mode 100644 index 00000000..088b5eb2 --- /dev/null +++ b/wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md @@ -0,0 +1,22 @@ +## Title: C_PlayerInfo.UnitIsSameServer + +**Content:** +Returns true if a player is from the same or connected realm. +`unitIsSameServer = C_PlayerInfo.UnitIsSameServer(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* + +**Returns:** +- `unitIsSameServer` + - *boolean* + +**Usage:** +Shows if your target is on the same (connected) realm. +```lua +/dump C_PlayerInfo.UnitIsSameServer(PlayerLocation:CreateFromUnit("target")) +``` + +**Reference:** +- `UnitIsSameServer` \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md b/wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md new file mode 100644 index 00000000..a629ce94 --- /dev/null +++ b/wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md @@ -0,0 +1,77 @@ +## Title: C_PlayerInteractionManager.ClearInteraction + +**Content:** +Needs summary. +`C_PlayerInteractionManager.ClearInteraction()` + +**Parameters:** +- `type` + - *Enum.PlayerInteractionType?* + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - TradePartner + - `2` - Item + - `3` - Gossip + - `4` - QuestGiver + - `5` - Merchant + - `6` - TaxiNode + - `7` - Trainer + - `8` - Banker + - `9` - AlliedRaceDetailsGiver + - `10` - GuildBanker + - `11` - Registrar + - `12` - Vendor + - `13` - PetitionVendor + - `14` - TabardVendor + - `15` - TalentMaster + - `16` - SpecializationMaster + - `17` - MailInfo + - `18` - SpiritHealer + - `19` - AreaSpiritHealer + - `20` - Binder + - `21` - Auctioneer + - `22` - StableMaster + - `23` - BattleMaster + - `24` - Transmogrifier + - `25` - LFGDungeon + - `26` - VoidStorageBanker + - `27` - BlackMarketAuctioneer + - `28` - AdventureMap + - `29` - WorldMap + - `30` - GarrArchitect + - `31` - GarrTradeskill + - `32` - GarrMission + - `33` - ShipmentCrafter + - `34` - GarrRecruitment + - `35` - GarrTalent + - `36` - Trophy + - `37` - PlayerChoice + - `38` - ArtifactForge + - `39` - ObliterumForge + - `40` - ScrappingMachine + - `41` - ContributionCollector + - `42` - AzeriteRespec + - `43` - IslandQueue + - `44` - ItemInteraction + - `45` - ChromieTime + - `46` - CovenantPreview + - `47` - AnimaDiversion + - `48` - LegendaryCrafting + - `49` - WeeklyRewards + - `50` - Soulbind + - `51` - CovenantSanctum + - `52` - NewPlayerGuide + - `53` - ItemUpgrade + - `54` - AdventureJournal + - `55` - Renown + - `56` - AzeriteForge + - `57` - PerksProgramVendor + - `58` - ProfessionsCraftingOrder + - `59` - Professions + - `60` - ProfessionsCustomerOrder + - `61` - TraitSystem + - `62` - BarbersChoice + - `63` - JailersTowerBuffs + - `64` - MajorFactionRenown \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md b/wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md new file mode 100644 index 00000000..b8b86d01 --- /dev/null +++ b/wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md @@ -0,0 +1,77 @@ +## Title: C_PlayerInteractionManager.ConfirmationInteraction + +**Content:** +Needs summary. +`C_PlayerInteractionManager.ConfirmationInteraction()` + +**Parameters:** +- `type` + - *Enum.PlayerInteractionType?* + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - TradePartner + - `2` - Item + - `3` - Gossip + - `4` - QuestGiver + - `5` - Merchant + - `6` - TaxiNode + - `7` - Trainer + - `8` - Banker + - `9` - AlliedRaceDetailsGiver + - `10` - GuildBanker + - `11` - Registrar + - `12` - Vendor + - `13` - PetitionVendor + - `14` - TabardVendor + - `15` - TalentMaster + - `16` - SpecializationMaster + - `17` - MailInfo + - `18` - SpiritHealer + - `19` - AreaSpiritHealer + - `20` - Binder + - `21` - Auctioneer + - `22` - StableMaster + - `23` - BattleMaster + - `24` - Transmogrifier + - `25` - LFGDungeon + - `26` - VoidStorageBanker + - `27` - BlackMarketAuctioneer + - `28` - AdventureMap + - `29` - WorldMap + - `30` - GarrArchitect + - `31` - GarrTradeskill + - `32` - GarrMission + - `33` - ShipmentCrafter + - `34` - GarrRecruitment + - `35` - GarrTalent + - `36` - Trophy + - `37` - PlayerChoice + - `38` - ArtifactForge + - `39` - ObliterumForge + - `40` - ScrappingMachine + - `41` - ContributionCollector + - `42` - AzeriteRespec + - `43` - IslandQueue + - `44` - ItemInteraction + - `45` - ChromieTime + - `46` - CovenantPreview + - `47` - AnimaDiversion + - `48` - LegendaryCrafting + - `49` - WeeklyRewards + - `50` - Soulbind + - `51` - CovenantSanctum + - `52` - NewPlayerGuide + - `53` - ItemUpgrade + - `54` - AdventureJournal + - `55` - Renown + - `56` - AzeriteForge + - `57` - PerksProgramVendor + - `58` - ProfessionsCraftingOrder + - `59` - Professions + - `60` - ProfessionsCustomerOrder + - `61` - TraitSystem + - `62` - BarbersChoice + - `63` - JailersTowerBuffs + - `64` - MajorFactionRenown \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md b/wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md new file mode 100644 index 00000000..5363a9bb --- /dev/null +++ b/wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md @@ -0,0 +1,23 @@ +## Title: C_PlayerInteractionManager.InteractUnit + +**Content:** +Needs summary. +`success = C_PlayerInteractionManager.InteractUnit(unit)` + +**Parameters:** +- `unit` + - *string* +- `exactMatch` + - *boolean?* = false +- `looseTargeting` + - *boolean?* = true + +**Returns:** +- `success` + - *boolean* + +**Example Usage:** +This function can be used to interact with a specific unit in the game. For instance, if you want to interact with an NPC or another player, you can use this function to initiate the interaction. + +**Addons Usage:** +Large addons like "ElvUI" or "Questie" might use this function to automate interactions with NPCs for questing or other purposes. For example, "Questie" could use it to automatically interact with quest givers or turn in quests. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md b/wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md new file mode 100644 index 00000000..e48fd015 --- /dev/null +++ b/wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md @@ -0,0 +1,81 @@ +## Title: C_PlayerInteractionManager.IsInteractingWithNpcOfType + +**Content:** +Needs summary. +`interacting = C_PlayerInteractionManager.IsInteractingWithNpcOfType(type)` + +**Parameters:** +- `type` + - *Enum.PlayerInteractionType* + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - TradePartner + - `2` - Item + - `3` - Gossip + - `4` - QuestGiver + - `5` - Merchant + - `6` - TaxiNode + - `7` - Trainer + - `8` - Banker + - `9` - AlliedRaceDetailsGiver + - `10` - GuildBanker + - `11` - Registrar + - `12` - Vendor + - `13` - PetitionVendor + - `14` - TabardVendor + - `15` - TalentMaster + - `16` - SpecializationMaster + - `17` - MailInfo + - `18` - SpiritHealer + - `19` - AreaSpiritHealer + - `20` - Binder + - `21` - Auctioneer + - `22` - StableMaster + - `23` - BattleMaster + - `24` - Transmogrifier + - `25` - LFGDungeon + - `26` - VoidStorageBanker + - `27` - BlackMarketAuctioneer + - `28` - AdventureMap + - `29` - WorldMap + - `30` - GarrArchitect + - `31` - GarrTradeskill + - `32` - GarrMission + - `33` - ShipmentCrafter + - `34` - GarrRecruitment + - `35` - GarrTalent + - `36` - Trophy + - `37` - PlayerChoice + - `38` - ArtifactForge + - `39` - ObliterumForge + - `40` - ScrappingMachine + - `41` - ContributionCollector + - `42` - AzeriteRespec + - `43` - IslandQueue + - `44` - ItemInteraction + - `45` - ChromieTime + - `46` - CovenantPreview + - `47` - AnimaDiversion + - `48` - LegendaryCrafting + - `49` - WeeklyRewards + - `50` - Soulbind + - `51` - CovenantSanctum + - `52` - NewPlayerGuide + - `53` - ItemUpgrade + - `54` - AdventureJournal + - `55` - Renown + - `56` - AzeriteForge + - `57` - PerksProgramVendor + - `58` - ProfessionsCraftingOrder + - `59` - Professions + - `60` - ProfessionsCustomerOrder + - `61` - TraitSystem + - `62` - BarbersChoice + - `63` - JailersTowerBuffs + - `64` - MajorFactionRenown + +**Returns:** +- `interacting` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md b/wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md new file mode 100644 index 00000000..7dac9999 --- /dev/null +++ b/wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md @@ -0,0 +1,9 @@ +## Title: C_PlayerInteractionManager.IsReplacingUnit + +**Content:** +Needs summary. +`replacing = C_PlayerInteractionManager.IsReplacingUnit()` + +**Returns:** +- `replacing` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md b/wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md new file mode 100644 index 00000000..fcbb61a1 --- /dev/null +++ b/wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md @@ -0,0 +1,81 @@ +## Title: C_PlayerInteractionManager.IsValidNPCInteraction + +**Content:** +Needs summary. +`isValidInteraction = C_PlayerInteractionManager.IsValidNPCInteraction(type)` + +**Parameters:** +- `type` + - *Enum.PlayerInteractionType* + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - TradePartner + - `2` - Item + - `3` - Gossip + - `4` - QuestGiver + - `5` - Merchant + - `6` - TaxiNode + - `7` - Trainer + - `8` - Banker + - `9` - AlliedRaceDetailsGiver + - `10` - GuildBanker + - `11` - Registrar + - `12` - Vendor + - `13` - PetitionVendor + - `14` - TabardVendor + - `15` - TalentMaster + - `16` - SpecializationMaster + - `17` - MailInfo + - `18` - SpiritHealer + - `19` - AreaSpiritHealer + - `20` - Binder + - `21` - Auctioneer + - `22` - StableMaster + - `23` - BattleMaster + - `24` - Transmogrifier + - `25` - LFGDungeon + - `26` - VoidStorageBanker + - `27` - BlackMarketAuctioneer + - `28` - AdventureMap + - `29` - WorldMap + - `30` - GarrArchitect + - `31` - GarrTradeskill + - `32` - GarrMission + - `33` - ShipmentCrafter + - `34` - GarrRecruitment + - `35` - GarrTalent + - `36` - Trophy + - `37` - PlayerChoice + - `38` - ArtifactForge + - `39` - ObliterumForge + - `40` - ScrappingMachine + - `41` - ContributionCollector + - `42` - AzeriteRespec + - `43` - IslandQueue + - `44` - ItemInteraction + - `45` - ChromieTime + - `46` - CovenantPreview + - `47` - AnimaDiversion + - `48` - LegendaryCrafting + - `49` - WeeklyRewards + - `50` - Soulbind + - `51` - CovenantSanctum + - `52` - NewPlayerGuide + - `53` - ItemUpgrade + - `54` - AdventureJournal + - `55` - Renown + - `56` - AzeriteForge + - `57` - PerksProgramVendor + - `58` - ProfessionsCraftingOrder + - `59` - Professions + - `60` - ProfessionsCustomerOrder + - `61` - TraitSystem + - `62` - BarbersChoice + - `63` - JailersTowerBuffs + - `64` - MajorFactionRenown + +**Returns:** +- `isValidInteraction` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md b/wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md new file mode 100644 index 00000000..39b6e540 --- /dev/null +++ b/wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md @@ -0,0 +1,23 @@ +## Title: C_PvP.GetArenaCrowdControlInfo + +**Content:** +Needs summary. +`spellID, startTime, duration = C_PvP.GetArenaCrowdControlInfo(playerToken)` + +**Parameters:** +- `playerToken` + - *string* + +**Returns:** +- `spellID` + - *number* +- `startTime` + - *number* +- `duration` + - *number* + +**Example Usage:** +This function can be used to get information about crowd control effects on a player in an arena match. For instance, an addon could use this to display a timer for how long a player will be affected by a crowd control spell. + +**Addon Usage:** +- **Gladius**: This popular PvP addon uses `C_PvP.GetArenaCrowdControlInfo` to track and display crowd control durations on enemy players in arena matches, helping players to better manage their cooldowns and crowd control strategies. \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md b/wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md new file mode 100644 index 00000000..fea622b5 --- /dev/null +++ b/wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md @@ -0,0 +1,40 @@ +## Title: C_PvP.GetBattlefieldVehicleInfo + +**Content:** +Returns battleground vehicle info. +`info = C_PvP.GetBattlefieldVehicleInfo(vehicleIndex, uiMapID)` + +**Parameters:** +- `vehicleIndex` + - *number* +- `uiMapID` + - *number* : UiMapID + +**Returns:** +- `info` + - *BattlefieldVehicleInfo* + - `Field` + - `Type` + - `Description` + - `x` + - *number* + - `y` + - *number* + - `name` + - *string* + - `isOccupied` + - *boolean* + - `atlas` + - *string* + - `textureWidth` + - *number* + - `textureHeight` + - *number* + - `facing` + - *number* + - `isPlayer` + - *boolean* + - `isAlive` + - *boolean* + - `shouldDrawBelowPlayerBlips` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetBattlefieldVehicles.md b/wiki-information/functions/C_PvP.GetBattlefieldVehicles.md new file mode 100644 index 00000000..7a5438e9 --- /dev/null +++ b/wiki-information/functions/C_PvP.GetBattlefieldVehicles.md @@ -0,0 +1,38 @@ +## Title: C_PvP.GetBattlefieldVehicles + +**Content:** +Needs summary. +`vehicles = C_PvP.GetBattlefieldVehicles(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* + +**Returns:** +- `vehicles` + - *BattlefieldVehicleInfo* + - `Field` + - `Type` + - `Description` + - `x` + - *number* + - `y` + - *number* + - `name` + - *string* + - `isOccupied` + - *boolean* + - `atlas` + - *string* + - `textureWidth` + - *number* + - `textureHeight` + - *number* + - `facing` + - *number* + - `isPlayer` + - *boolean* + - `isAlive` + - *boolean* + - `shouldDrawBelowPlayerBlips` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetRandomBGRewards.md b/wiki-information/functions/C_PvP.GetRandomBGRewards.md new file mode 100644 index 00000000..a15bbc12 --- /dev/null +++ b/wiki-information/functions/C_PvP.GetRandomBGRewards.md @@ -0,0 +1,33 @@ +## Title: C_PvP.GetRandomBGRewards + +**Content:** +Needs summary. +`honor, experience, itemRewards, currencyRewards = C_PvP.GetRandomBGRewards()` + +**Returns:** +- `honor` + - *number* +- `experience` + - *number* +- `itemRewards` + - *BattlefieldItemReward?* + - `Field` + - `Type` + - `Description` + - `id` + - *number* + - `name` + - *string* + - `texture` + - *number* + - `quantity` + - *number* +- `currencyRewards` + - *BattlefieldCurrencyReward?* + - `Field` + - `Type` + - `Description` + - `id` + - *number* + - `quantity` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.IsInBrawl.md b/wiki-information/functions/C_PvP.IsInBrawl.md new file mode 100644 index 00000000..0abebc4f --- /dev/null +++ b/wiki-information/functions/C_PvP.IsInBrawl.md @@ -0,0 +1,9 @@ +## Title: C_PvP.IsInBrawl + +**Content:** +Needs summary. +`isInBrawl = C_PvP.IsInBrawl()` + +**Returns:** +- `isInBrawl` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.IsPVPMap.md b/wiki-information/functions/C_PvP.IsPVPMap.md new file mode 100644 index 00000000..ad4b333b --- /dev/null +++ b/wiki-information/functions/C_PvP.IsPVPMap.md @@ -0,0 +1,9 @@ +## Title: C_PvP.IsPVPMap + +**Content:** +Needs summary. +`isPVPMap = C_PvP.IsPVPMap()` + +**Returns:** +- `isPVPMap` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.IsRatedMap.md b/wiki-information/functions/C_PvP.IsRatedMap.md new file mode 100644 index 00000000..c35f4a7b --- /dev/null +++ b/wiki-information/functions/C_PvP.IsRatedMap.md @@ -0,0 +1,15 @@ +## Title: C_PvP.IsRatedMap + +**Content:** +Returns if the map is a rated battleground or arena. +`isRatedMap = C_PvP.IsRatedMap()` + +**Returns:** +- `isRatedMap` + - *boolean* + +**Example Usage:** +This function can be used to determine if the current map is a rated battleground or arena, which can be useful for addons that track player performance or provide specific features for rated PvP environments. + +**Addons:** +Many PvP-oriented addons, such as Gladius, use this function to adjust their behavior based on whether the player is in a rated match. For example, they might display additional statistics or enable certain features only in rated environments. \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.RequestCrowdControlSpell.md b/wiki-information/functions/C_PvP.RequestCrowdControlSpell.md new file mode 100644 index 00000000..24eb9dda --- /dev/null +++ b/wiki-information/functions/C_PvP.RequestCrowdControlSpell.md @@ -0,0 +1,9 @@ +## Title: C_PvP.RequestCrowdControlSpell + +**Content:** +Needs summary. +`C_PvP.RequestCrowdControlSpell(playerToken)` + +**Parameters:** +- `playerToken` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md b/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md new file mode 100644 index 00000000..1cc3560f --- /dev/null +++ b/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md @@ -0,0 +1,56 @@ +## Title: C_QuestInfoSystem.GetQuestRewardSpellInfo + +**Content:** +Needs summary. +`info = C_QuestInfoSystem.GetQuestRewardSpellInfo(questID, spellID)` + +**Parameters:** +- `questID` + - *number?* +- `spellID` + - *number* - Spell Ids from C_QuestInfoSystem.GetQuestRewardSpells + +**Returns:** +- `info` + - *QuestRewardSpellInfo?* + - `Field` + - `Type` + - `Description` + - `texture` + - *number* : fileID + - `name` + - *string* + - `garrFollowerID` + - *number?* + - `isTradeskill` + - *boolean* + - `isSpellLearned` + - *boolean* + - `hideSpellLearnText` + - *boolean* + - `isBoostSpell` + - *boolean* + - `genericUnlock` + - *boolean* + - `type` + - *Enum.QuestCompleteSpellType* + - `Enum.QuestCompleteSpellType` + - `Value` + - `Field` + - `Description` + - `0` + - LegacyBehavior + - `1` + - Follower + - `2` + - Tradeskill + - `3` + - Ability + - `4` + - Aura + - `5` + - Spell + - `6` + - Unlock + - `7` + - Companion \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md b/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md new file mode 100644 index 00000000..cd8c4fdc --- /dev/null +++ b/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md @@ -0,0 +1,13 @@ +## Title: C_QuestInfoSystem.GetQuestRewardSpells + +**Content:** +Needs summary. +`spellIDs = C_QuestInfoSystem.GetQuestRewardSpells()` + +**Parameters:** +- `questID` + - *number?* + +**Returns:** +- `spellIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md b/wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md new file mode 100644 index 00000000..beba3786 --- /dev/null +++ b/wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md @@ -0,0 +1,19 @@ +## Title: C_QuestInfoSystem.GetQuestShouldToastCompletion + +**Content:** +Needs summary. +`shouldToast = C_QuestInfoSystem.GetQuestShouldToastCompletion()` + +**Parameters:** +- `questID` + - *number?* + +**Returns:** +- `shouldToast` + - *boolean* + +**Example Usage:** +This function can be used to determine if a quest completion should trigger a toast notification. This can be particularly useful for addons that manage quest tracking and notifications, ensuring that important quest completions are highlighted to the player. + +**Addon Usage:** +Large addons like "Questie" or "TomTom" might use this function to enhance the user experience by providing visual feedback when a quest is completed, ensuring players are aware of their progress and achievements. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md b/wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md new file mode 100644 index 00000000..3ad80c58 --- /dev/null +++ b/wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md @@ -0,0 +1,13 @@ +## Title: C_QuestInfoSystem.HasQuestRewardSpells + +**Content:** +Needs summary. +`hasRewardSpells = C_QuestInfoSystem.HasQuestRewardSpells()` + +**Parameters:** +- `questID` + - *number?* + +**Returns:** +- `hasRewardSpells` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md b/wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md new file mode 100644 index 00000000..5632be3f --- /dev/null +++ b/wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md @@ -0,0 +1,9 @@ +## Title: C_QuestLog.GetMapForQuestPOIs + +**Content:** +Needs summary. +`uiMapID = C_QuestLog.GetMapForQuestPOIs()` + +**Returns:** +- `uiMapID` + - *number* - UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetMaxNumQuests.md b/wiki-information/functions/C_QuestLog.GetMaxNumQuests.md new file mode 100644 index 00000000..45d20f4d --- /dev/null +++ b/wiki-information/functions/C_QuestLog.GetMaxNumQuests.md @@ -0,0 +1,9 @@ +## Title: C_QuestLog.GetMaxNumQuests + +**Content:** +This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries, etc. +`maxNumQuests = C_QuestLog.GetMaxNumQuests()` + +**Returns:** +- `maxNumQuests` + - *number* - The maximum number of quests a player can be on. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md b/wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md new file mode 100644 index 00000000..7c6f66f7 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md @@ -0,0 +1,9 @@ +## Title: C_QuestLog.GetMaxNumQuestsCanAccept + +**Content:** +This is the maximum number of standard quests a player can accept. These are quests that are normally visible in the quest log. +`maxNumQuestsCanAccept = C_QuestLog.GetMaxNumQuestsCanAccept()` + +**Returns:** +- `maxNumQuestsCanAccept` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetQuestInfo.md b/wiki-information/functions/C_QuestLog.GetQuestInfo.md new file mode 100644 index 00000000..7be17631 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.GetQuestInfo.md @@ -0,0 +1,20 @@ +## Title: C_QuestLog.GetQuestInfo + +**Content:** +Returns the name for a Quest ID. +`title = C_QuestLog.GetQuestInfo(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `title` + - *string* - name of the quest + +**Description:** +This API does not require the quest to be in your quest log. +If the name is still an empty string (after having queried it from the server once) then the quest is assumed to have been removed. + +**Reference:** +QuestEventListener \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetQuestObjectives.md b/wiki-information/functions/C_QuestLog.GetQuestObjectives.md new file mode 100644 index 00000000..790c0c13 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.GetQuestObjectives.md @@ -0,0 +1,31 @@ +## Title: C_QuestLog.GetQuestObjectives + +**Content:** +Returns info for the objectives of a quest. +`objectives = C_QuestLog.GetQuestObjectives(questID)` + +**Parameters:** +- `questID` + - *number* - Unique QuestID for the quest to be queried. + +**Returns:** +- `objectives` + - *table* - a table (can be an empty table for quests without objectives) containing: a subtable for each objective which in turn contains the below values + - `Field` + - `Type` + - `Description` + - `text` + - *string* - the text displayed in the quest log and the quest tracker + - `type` + - *string* - "monster", "item", etc. + - `finished` + - *boolean* - true if the objective has been completed + - `numFulfilled` + - *number* - number of partial objectives fulfilled + - `numRequired` + - *number* - number of partial objectives required + +**Description:** +For example, calling this function for the quest Colonel Kurzen returns a table with three subtables (with keys 1, 2, and 3), two with the type "monster" and one with the type "item". +Quests that have been encountered before (i.e. cached) are able to be queried instantly, however, if the function is supplied a quest ID of a quest that isn't cached yet, it will not return anything until called again. Sometimes three calls are needed to fully cache everything (such as text). +It returns an empty table for some quests without any objectives, for example, A Threat Within. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetQuestsOnMap.md b/wiki-information/functions/C_QuestLog.GetQuestsOnMap.md new file mode 100644 index 00000000..12bf4be1 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.GetQuestsOnMap.md @@ -0,0 +1,32 @@ +## Title: C_QuestLog.GetQuestsOnMap + +**Content:** +Needs summary. +`quests = C_QuestLog.GetQuestsOnMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `quests` + - *QuestOnMapInfo* - a table containing the following fields: + - `Field` + - `Type` + - `Description` + - `questID` + - *number* + - `x` + - *number* + - `y` + - *number* + - `type` + - *number* + - `isMapIndicatorQuest` + - *boolean* + +**Example Usage:** +This function can be used to retrieve a list of quests available on a specific map. For instance, an addon could use this to display all quests on the player's current map, allowing for a more interactive and informative map interface. + +**Addon Usage:** +Large addons like **Questie** use this function to populate the world map with available quests, providing players with visual indicators of where they can pick up new quests. This enhances the questing experience by making it easier to find and track quests. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.IsOnQuest.md b/wiki-information/functions/C_QuestLog.IsOnQuest.md new file mode 100644 index 00000000..0d5fc9e5 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.IsOnQuest.md @@ -0,0 +1,13 @@ +## Title: C_QuestLog.IsOnQuest + +**Content:** +Needs summary. +`isOnQuest = C_QuestLog.IsOnQuest(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `isOnQuest` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md b/wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md new file mode 100644 index 00000000..97c9afa3 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md @@ -0,0 +1,20 @@ +## Title: C_QuestLog.IsQuestFlaggedCompleted + +**Content:** +Returns if a quest has been completed. +`isCompleted = C_QuestLog.IsQuestFlaggedCompleted(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `isCompleted` + - *boolean* - Returns true if completed; returns false if not completed or if the questID is invalid. + +**Usage:** +Returns if WANTED: "Hogger" has been completed. +`/dump C_QuestLog.IsQuestFlaggedCompleted(176)` + +**Reference:** +- `C_QuestLog.GetAllCompletedQuestIDs()` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md b/wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md new file mode 100644 index 00000000..16ee0456 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md @@ -0,0 +1,9 @@ +## Title: C_QuestLog.SetMapForQuestPOIs + +**Content:** +Needs summary. +`C_QuestLog.SetMapForQuestPOIs(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md b/wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md new file mode 100644 index 00000000..b4f08fa0 --- /dev/null +++ b/wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md @@ -0,0 +1,19 @@ +## Title: C_QuestLog.ShouldShowQuestRewards + +**Content:** +Needs summary. +`shouldShow = C_QuestLog.ShouldShowQuestRewards(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `shouldShow` + - *boolean* + +**Example Usage:** +This function can be used to determine if the rewards for a specific quest should be shown to the player. This can be particularly useful in custom quest tracking addons or UI modifications where you want to conditionally display quest rewards. + +**Addon Usage:** +Large addons like Questie or TomTom might use this function to enhance their quest tracking features by showing or hiding quest rewards based on certain conditions. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.CanStart.md b/wiki-information/functions/C_QuestSession.CanStart.md new file mode 100644 index 00000000..bb91dfec --- /dev/null +++ b/wiki-information/functions/C_QuestSession.CanStart.md @@ -0,0 +1,13 @@ +## Title: C_QuestSession.CanStart + +**Content:** +Indicates the player may request starting Party Sync. +`allowed = C_QuestSession.CanStart()` + +**Returns:** +- `allowed` + - *boolean* - True if the player is in a party that has not yet begun to activate Party Sync. + +**Reference:** +- `C_QuestSession.CanStop()` - Applicable after Party Sync has begun. +- `C_QuestSession.RequestSessionStart()` - Used to request Party Sync, if CanStart() is true. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.CanStop.md b/wiki-information/functions/C_QuestSession.CanStop.md new file mode 100644 index 00000000..29dc927f --- /dev/null +++ b/wiki-information/functions/C_QuestSession.CanStop.md @@ -0,0 +1,13 @@ +## Title: C_QuestSession.CanStop + +**Content:** +Indicates the player may request stopping Party Sync. +`allowed = C_QuestSession.CanStop()` + +**Returns:** +- `allowed` + - *boolean* - True if the player is in a party with Party Sync but may end it. + +**Reference:** +- `C_QuestSession.CanStart()` - Applicable before Party Sync has begun. +- `C_QuestSession.RequestSessionStop()` - Used to terminate Party Sync, if `CanStop()` is true. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.Exists.md b/wiki-information/functions/C_QuestSession.Exists.md new file mode 100644 index 00000000..35c28529 --- /dev/null +++ b/wiki-information/functions/C_QuestSession.Exists.md @@ -0,0 +1,12 @@ +## Title: C_QuestSession.Exists + +**Content:** +Indicates Party Sync is active or requested by a party member. +`exists = C_QuestSession.Exists()` + +**Returns:** +- `exists` + - *boolean* - True if Party Sync is active or there is a pending request to activate it; false otherwise. + +**Reference:** +- `C_QuestSession.HasJoined()` - Only true when active (excludes pending requests). \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md b/wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md new file mode 100644 index 00000000..190d310f --- /dev/null +++ b/wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md @@ -0,0 +1,23 @@ +## Title: C_QuestSession.GetAvailableSessionCommand + +**Content:** +Needs summary. +`command = C_QuestSession.GetAvailableSessionCommand()` + +**Returns:** +- `command` + - *Enum.QuestSessionCommand* + - `Enum.QuestSessionCommand` + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - Start + - `2` - Stop + - `3` - SessionActiveNoCommand + +**Example Usage:** +This function can be used to determine the current available command for a quest session. For instance, if you are developing an addon that manages quest sessions, you can use this function to check if a session can be started, stopped, or if there is no command available. + +**Addon Usage:** +Large addons like "World Quest Tracker" might use this function to manage quest sessions more effectively, ensuring that players are aware of the current state of their quest sessions and can act accordingly. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetPendingCommand.md b/wiki-information/functions/C_QuestSession.GetPendingCommand.md new file mode 100644 index 00000000..25e9a96f --- /dev/null +++ b/wiki-information/functions/C_QuestSession.GetPendingCommand.md @@ -0,0 +1,23 @@ +## Title: C_QuestSession.GetPendingCommand + +**Content:** +Needs summary. +`hasPendingCommand = C_QuestSession.HasPendingCommand()` + +**Returns:** +- `command` + - *Enum* - Enum.QuestSessionCommand + - `Value` + - `Field` + - `Description` + - `0` + - `None` + - `1` + - `Start` + - `2` + - `Stop` + - `3` + - `SessionActiveNoCommand` + +**Reference:** +`C_QuestSession.HasPendingCommand()` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md b/wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md new file mode 100644 index 00000000..5adda01c --- /dev/null +++ b/wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md @@ -0,0 +1,9 @@ +## Title: C_QuestSession.GetProposedMaxLevelForSession + +**Content:** +Needs summary. +`proposedMaxLevel = C_QuestSession.GetProposedMaxLevelForSession()` + +**Returns:** +- `proposedMaxLevel` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md b/wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md new file mode 100644 index 00000000..fcff7039 --- /dev/null +++ b/wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md @@ -0,0 +1,22 @@ +## Title: C_QuestSession.GetSessionBeginDetails + +**Content:** +Identifies the party member requesting Party Sync. +`details = C_QuestSession.GetSessionBeginDetails()` + +**Returns:** +- `details` + - *QuestSessionPlayerDetails?* - Returns nil if there is no pending request from another party member. + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `guid` + - *string* - GUID + +**Description:** +This only applies when a pending request was initiated by another party member. + +**Reference:** +C_QuestSession.SendSessionBeginResponse(beginSession) - Used to indicate agreement with starting Party Sync. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md b/wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md new file mode 100644 index 00000000..c276c7fd --- /dev/null +++ b/wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md @@ -0,0 +1,12 @@ +## Title: C_QuestSession.GetSuperTrackedQuest + +**Content:** +Needs summary. +`questID = C_QuestSession.GetSuperTrackedQuest()` + +**Returns:** +- `questID` + - *number?* - QuestID + +**Reference:** +- `C_QuestSession.SetQuestIsSuperTracked(questID, superTrack)` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.HasJoined.md b/wiki-information/functions/C_QuestSession.HasJoined.md new file mode 100644 index 00000000..1ba9a2ee --- /dev/null +++ b/wiki-information/functions/C_QuestSession.HasJoined.md @@ -0,0 +1,12 @@ +## Title: C_QuestSession.HasJoined + +**Content:** +Indicates Party Sync is active. +`hasJoined = C_QuestSession.HasJoined()` + +**Returns:** +- `hasJoined` + - *boolean* - True if Party Sync is active; false otherwise. + +**Reference:** +- `C_QuestSession.Exists()` - Also true when there is a pending request to activate Party Sync. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.HasPendingCommand.md b/wiki-information/functions/C_QuestSession.HasPendingCommand.md new file mode 100644 index 00000000..65759fe7 --- /dev/null +++ b/wiki-information/functions/C_QuestSession.HasPendingCommand.md @@ -0,0 +1,12 @@ +## Title: C_QuestSession.HasPendingCommand + +**Content:** +Needs summary. +`hasPendingCommand = C_QuestSession.HasPendingCommand()` + +**Returns:** +- `hasPendingCommand` + - *boolean* + +**Reference:** +- `C_QuestSession.GetPendingCommand()` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.RequestSessionStart.md b/wiki-information/functions/C_QuestSession.RequestSessionStart.md new file mode 100644 index 00000000..016bf191 --- /dev/null +++ b/wiki-information/functions/C_QuestSession.RequestSessionStart.md @@ -0,0 +1,9 @@ +## Title: C_QuestSession.RequestSessionStart + +**Content:** +Requests party members to begin Party Sync if permissible. +`C_QuestSession.RequestSessionStart()` + +**Reference:** +- `C_QuestSession.CanStart()` - Indicates if a request to begin Party Sync at this time is permissible. +- `C_QuestSession.RequestSessionStop()` - Applicable after Party Sync has begun. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.RequestSessionStop.md b/wiki-information/functions/C_QuestSession.RequestSessionStop.md new file mode 100644 index 00000000..4dc4c34a --- /dev/null +++ b/wiki-information/functions/C_QuestSession.RequestSessionStop.md @@ -0,0 +1,9 @@ +## Title: C_QuestSession.RequestSessionStop + +**Content:** +Stops Party Sync if permissible. +`C_QuestSession.RequestSessionStop()` + +**Reference:** +- `C_QuestSession.CanStop()` - Indicates if stopping Party Sync at this time is permissible. +- `C_QuestSession.RequestSessionStart()` - Applicable before Party Sync has begun. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md b/wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md new file mode 100644 index 00000000..c7dfc3b7 --- /dev/null +++ b/wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md @@ -0,0 +1,15 @@ +## Title: C_QuestSession.SendSessionBeginResponse + +**Content:** +Consents to activating Party Sync following a request by another party member. +`C_QuestSession.SendSessionBeginResponse(beginSession)` + +**Parameters:** +- `beginSession` + - *boolean* - True to agree with starting Party Sync, or false to reject it. + +**Description:** +This only applies when a pending request was initiated by another party member. + +**Reference:** +- `C_QuestSession.GetSessionBeginDetails()` - Indicates which party member asked for the Party Sync to begin. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md b/wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md new file mode 100644 index 00000000..90c1947d --- /dev/null +++ b/wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md @@ -0,0 +1,17 @@ +## Title: C_QuestSession.SetQuestIsSuperTracked + +**Content:** +Needs summary. +`C_QuestSession.SetQuestIsSuperTracked(questID, superTrack)` + +**Parameters:** +- `questID` + - *number* - QuestID +- `superTrack` + - *boolean* + +**Reference:** +- `C_QuestSession.GetSuperTrackedQuest()` + +**References:** +- 2019-09-24, QuestSession.lua, version 8.2.5.31960, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/C_RaidLocks.IsEncounterComplete.md b/wiki-information/functions/C_RaidLocks.IsEncounterComplete.md new file mode 100644 index 00000000..ad2e7dce --- /dev/null +++ b/wiki-information/functions/C_RaidLocks.IsEncounterComplete.md @@ -0,0 +1,23 @@ +## Title: C_RaidLocks.IsEncounterComplete + +**Content:** +Needs summary. +`encounterIsComplete = C_RaidLocks.IsEncounterComplete(mapID, encounterID)` + +**Parameters:** +- `mapID` + - *number* : UiMapID +- `encounterID` + - *number* : JournalEncounterID +- `difficultyID` + - *number?* : DifficultyID + +**Returns:** +- `encounterIsComplete` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific encounter within a raid instance has been completed. This is particularly useful for raid tracking addons or for players who want to ensure they have completed all encounters in a raid for the week. + +**Addons:** +Large addons like "DBM (Deadly Boss Mods)" or "BigWigs" might use this function to track encounter completions and provide alerts or updates to the player. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.CanReportPlayer.md b/wiki-information/functions/C_ReportSystem.CanReportPlayer.md new file mode 100644 index 00000000..6da48865 --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.CanReportPlayer.md @@ -0,0 +1,13 @@ +## Title: C_ReportSystem.CanReportPlayer + +**Content:** +Returns if a player can be reported. +`canReport = C_ReportSystem.CanReportPlayer(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* - The location of the player to be reported. + +**Returns:** +- `canReport` + - *boolean* - Returns `true` if the player can be reported, otherwise `false`. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md b/wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md new file mode 100644 index 00000000..a1677b75 --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md @@ -0,0 +1,19 @@ +## Title: C_ReportSystem.CanReportPlayerForLanguage + +**Content:** +Needs summary. +`canReport = C_ReportSystem.CanReportPlayerForLanguage(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* + +**Returns:** +- `canReport` + - *boolean* + +**Example Usage:** +This function can be used to determine if a player can be reported for inappropriate language based on their location. For instance, in a custom addon that monitors chat for offensive language, this function can be used to check if the offending player can be reported. + +**Addons Using This Function:** +Large addons like "BadBoy" (a chat spam filter) might use this function to automate the reporting of players who use inappropriate language in chat. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md b/wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md new file mode 100644 index 00000000..2fdd7337 --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md @@ -0,0 +1,39 @@ +## Title: C_ReportSystem.GetMajorCategoriesForReportType + +**Content:** +Needs summary. +`majorCategories = C_ReportSystem.GetMajorCategoriesForReportType(reportType)` + +**Parameters:** +- `reportType` + - *Enum.ReportType* + - **Value** + - **Field** + - **Description** + - `0` - Chat + - `1` - InWorld + - `2` - ClubFinderPosting + - `3` - ClubFinderApplicant + - `4` - GroupFinderPosting + - `5` - GroupFinderApplicant + - `6` - ClubMember + - `7` - GroupMember + - `8` - Friend + - `9` - Pet + - `10` - BattlePet + - `11` - Calendar + - `12` - Mail + - `13` - PvP + - `14` - PvPScoreboard (Added in 9.2.7) + - `15` - PvPGroupMember (Added in 10.0.5) + +**Returns:** +- `majorCategories` + - *Enum.ReportMajorCategory* + - **Value** + - **Field** + - **Description** + - `0` - InappropriateCommunication + - `1` - GameplaySabotage + - `2` - Cheating + - `3` - InappropriateName \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md b/wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md new file mode 100644 index 00000000..c8375c54 --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md @@ -0,0 +1,20 @@ +## Title: C_ReportSystem.GetMajorCategoryString + +**Content:** +Needs summary. +`majorCategoryString = C_ReportSystem.GetMajorCategoryString(majorCategory)` + +**Parameters:** +- `majorCategory` + - *Enum.ReportMajorCategory* + - `Value` + - `Field` + - `Description` + - `0` - InappropriateCommunication + - `1` - GameplaySabotage + - `2` - Cheating + - `3` - InappropriateName + +**Returns:** +- `majorCategoryString` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md b/wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md new file mode 100644 index 00000000..fa6ff5f5 --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md @@ -0,0 +1,59 @@ +## Title: C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory + +**Content:** +Needs summary. +`minorCategories = C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory(reportType, majorCategory)` + +**Parameters:** +- `reportType` + - *Enum.ReportType* + - `Value` + - `Field` + - `Description` + - `0` - Chat + - `1` - InWorld + - `2` - ClubFinderPosting + - `3` - ClubFinderApplicant + - `4` - GroupFinderPosting + - `5` - GroupFinderApplicant + - `6` - ClubMember + - `7` - GroupMember + - `8` - Friend + - `9` - Pet + - `10` - BattlePet + - `11` - Calendar + - `12` - Mail + - `13` - PvP + - `14` - PvPScoreboard (Added in 9.2.7) + - `15` - PvPGroupMember (Added in 10.0.5) +- `majorCategory` + - *Enum.ReportMajorCategory* + - `Value` + - `Field` + - `Description` + - `0` - InappropriateCommunication + - `1` - GameplaySabotage + - `2` - Cheating + - `3` - InappropriateName + +**Returns:** +- `minorCategories` + - *Enum.ReportMinorCategory* + - `Value` + - `Field` + - `Description` + - `0x1` - TextChat + - `0x2` - Boosting + - `0x4` - Spam + - `0x8` - Afk + - `0x10` - IntentionallyFeeding + - `0x20` - BlockingProgress + - `0x40` - Hacking + - `0x80` - Botting + - `0x100` - Advertisement + - `0x200` - BTag + - `0x400` - GroupName + - `0x800` - CharacterName + - `0x1000` - GuildName + - `0x2000` - Description + - `0x4000` - Name \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md b/wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md new file mode 100644 index 00000000..62df455f --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md @@ -0,0 +1,46 @@ +## Title: C_ReportSystem.GetMinorCategoryString + +**Content:** +Needs summary. +`minorCategoryString = C_ReportSystem.GetMinorCategoryString(minorCategory)` + +**Parameters:** +- `minorCategory` + - *Enum.ReportMinorCategory* + - `Value` + - `Field` + - `Description` + - `0x1` + - TextChat + - `0x2` + - Boosting + - `0x4` + - Spam + - `0x8` + - Afk + - `0x10` + - IntentionallyFeeding + - `0x20` + - BlockingProgress + - `0x40` + - Hacking + - `0x80` + - Botting + - `0x100` + - Advertisement + - `0x200` + - BTag + - `0x400` + - GroupName + - `0x800` + - CharacterName + - `0x1000` + - GuildName + - `0x2000` + - Description + - `0x4000` + - Name + +**Returns:** +- `minorCategoryString` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md b/wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md new file mode 100644 index 00000000..416a120d --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md @@ -0,0 +1,33 @@ +## Title: C_ReportSystem.InitiateReportPlayer + +**Content:** +Initiates a report against a player. +`token = C_ReportSystem.InitiateReportPlayer(complaintType)` + +**Parameters:** +- `complaintType` + - *string* : PLAYER_REPORT_TYPE - the reason for reporting. +- `playerLocation` + - *PlayerLocationMixin* + +**PLAYER_REPORT_TYPE Constants:** +- `PLAYER_REPORT_TYPE_SPAM` + - *spam* +- `PLAYER_REPORT_TYPE_LANGUAGE` + - *language* +- `PLAYER_REPORT_TYPE_ABUSE` + - *abuse* +- `PLAYER_REPORT_TYPE_BAD_PLAYER_NAME` + - *badplayername* +- `PLAYER_REPORT_TYPE_BAD_GUILD_NAME` + - *badguildname* +- `PLAYER_REPORT_TYPE_CHEATING` + - *cheater* +- `PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME` + - *badbattlepetname* +- `PLAYER_REPORT_TYPE_BAD_PET_NAME` + - *badpetname* + +**Returns:** +- `token` + - *number* - the token used for `C_ReportSystem.SendReportPlayer`. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md b/wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md new file mode 100644 index 00000000..fe5edb8b --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md @@ -0,0 +1,35 @@ +## Title: C_ReportSystem.OpenReportPlayerDialog + +**Content:** +Opens the dialog for reporting a player. +`C_ReportSystem.OpenReportPlayerDialog(reportType, playerName)` + +**Parameters:** +- `reportType` + - *string* - One of the strings found in PLAYER_REPORT_TYPE +- `playerName` + - *string* - Name of the player being reported +- `playerLocation` + - *PlayerLocationMixin* + +### PLAYER_REPORT_TYPE +- **Constant** - **Value** + - `PLAYER_REPORT_TYPE_SPAM` - spam + - `PLAYER_REPORT_TYPE_LANGUAGE` - language + - `PLAYER_REPORT_TYPE_ABUSE` - abuse + - `PLAYER_REPORT_TYPE_BAD_PLAYER_NAME` - badplayername + - `PLAYER_REPORT_TYPE_BAD_GUILD_NAME` - badguildname + - `PLAYER_REPORT_TYPE_CHEATING` - cheater + - `PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME` - badbattlepetname + - `PLAYER_REPORT_TYPE_BAD_PET_NAME` - badpetname + +**Description:** +This function is not protected and therefore available to Addons, unlike `C_ReportSystem.InitiateReportPlayer` and `C_ReportSystem.SendReportPlayer`. +This reporting restriction was added because AddOn BadBoy allegedly sent out a number of false positives. +Triggers `OPEN_REPORT_PLAYER` once the window is open. + +**Usage:** +Opens the spam report dialog for the current target. +```lua +/run C_ReportSystem.OpenReportPlayerDialog(PLAYER_REPORT_TYPE_SPAM, UnitName("target"), PlayerLocation:CreateFromUnit("target")) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.ReportServerLag.md b/wiki-information/functions/C_ReportSystem.ReportServerLag.md new file mode 100644 index 00000000..ea9827d4 --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.ReportServerLag.md @@ -0,0 +1,17 @@ +## Title: C_ReportSystem.ReportServerLag + +**Content:** +Needs summary. +`C_ReportSystem.ReportServerLag()` + +**Description:** +This function is used to report server lag to Blizzard. It can be useful for players experiencing latency issues to notify the developers about server performance problems. + +**Example Usage:** +A player experiencing significant lag during gameplay can use this function to report the issue: +```lua +C_ReportSystem.ReportServerLag() +``` + +**Addons:** +While specific large addons using this function are not well-documented, it can be integrated into custom addons designed to monitor and report server performance issues automatically. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md b/wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md new file mode 100644 index 00000000..1ca7f46c --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md @@ -0,0 +1,18 @@ +## Title: C_ReportSystem.ReportStuckInCombat + +**Content:** +Needs summary. +`C_ReportSystem.ReportStuckInCombat()` + +**Description:** +This function is used to report that a player is stuck in combat. This can be useful in situations where the game does not properly recognize that combat has ended, preventing the player from performing certain actions such as mounting or using certain abilities. + +**Example Usage:** +```lua +-- Example of using C_ReportSystem.ReportStuckInCombat +C_ReportSystem.ReportStuckInCombat() +print("Reported being stuck in combat.") +``` + +**Usage in Addons:** +While not commonly used in large addons, this function can be useful in custom scripts or smaller addons designed to handle specific combat-related issues. For example, an addon that helps players manage combat states might use this function to automatically report when the player is stuck in combat, potentially triggering other actions to resolve the issue. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SendReport.md b/wiki-information/functions/C_ReportSystem.SendReport.md new file mode 100644 index 00000000..cccfaa3b --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.SendReport.md @@ -0,0 +1,11 @@ +## Title: C_ReportSystem.SendReport + +**Content:** +Not allowed to be called by addons +`C_ReportSystem.SendReport(reportInfo)` + +**Parameters:** +- `reportInfo` + - *ReportInfoMixin* +- `playerLocation` + - *PlayerLocationMixin* (optional) \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SendReportPlayer.md b/wiki-information/functions/C_ReportSystem.SendReportPlayer.md new file mode 100644 index 00000000..cae964be --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.SendReportPlayer.md @@ -0,0 +1,11 @@ +## Title: C_ReportSystem.SendReportPlayer + +**Content:** +Sends an initiated report against a player. +`C_ReportSystem.SendReportPlayer(token)` + +**Parameters:** +- `token` + - *number* - the token from C_ReportSystem.InitiateReportPlayer. +- `comment` + - *string?* - any comments and details. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md b/wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md new file mode 100644 index 00000000..bd79334b --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md @@ -0,0 +1,13 @@ +## Title: C_ReportSystem.SetPendingReportPetTarget + +**Content:** +Report a pet for an inappropriate name. +`set = C_ReportSystem.SetPendingReportPetTarget()` + +**Parameters:** +- `target` + - *string?* : UnitId - defaults to "target". + +**Returns:** +- `set` + - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md b/wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md new file mode 100644 index 00000000..0ce8043c --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md @@ -0,0 +1,20 @@ +## Title: C_ReportSystem.SetPendingReportTarget + +**Content:** +Populates the reporting window with details about a target player. +`set = C_ReportSystem.SetPendingReportTarget()` +`set = C_ReportSystem.SetPendingReportTargetByGuid()` + +**Parameters:** + +*SetPendingReportTarget:* +- `target` + - *string?* : UnitId - defaults to "target" + +*SetPendingReportTargetByGuid:* +- `guid` + - *string?* : GUID + +**Returns:** +- `set` + - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md b/wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md new file mode 100644 index 00000000..0ce8043c --- /dev/null +++ b/wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md @@ -0,0 +1,20 @@ +## Title: C_ReportSystem.SetPendingReportTarget + +**Content:** +Populates the reporting window with details about a target player. +`set = C_ReportSystem.SetPendingReportTarget()` +`set = C_ReportSystem.SetPendingReportTargetByGuid()` + +**Parameters:** + +*SetPendingReportTarget:* +- `target` + - *string?* : UnitId - defaults to "target" + +*SetPendingReportTargetByGuid:* +- `guid` + - *string?* : GUID + +**Returns:** +- `set` + - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.GetFactionParagonInfo.md b/wiki-information/functions/C_Reputation.GetFactionParagonInfo.md new file mode 100644 index 00000000..fdb1b19b --- /dev/null +++ b/wiki-information/functions/C_Reputation.GetFactionParagonInfo.md @@ -0,0 +1,36 @@ +## Title: C_Reputation.GetFactionParagonInfo + +**Content:** +Returns Paragon info on a faction. +`currentValue, threshold, rewardQuestID, hasRewardPending, tooLowLevelForParagon = C_Reputation.GetFactionParagonInfo(factionID)` + +**Parameters:** +- `factionID` + - *number* - FactionID + +**Returns:** +- `currentValue` + - *number* - The amount of reputation you have earned in the current level of Paragon. +- `threshold` + - *number* - The amount of reputation until you gain the next Paragon level. +- `rewardQuestID` + - *number* - The ID of the quest once you attain a new Paragon level (or your first). +- `hasRewardPending` + - *boolean* - True if the player has attained a Paragon level but has not completed the reward quest. +- `tooLowLevelForParagon` + - *boolean* - True if the player level is too low to complete the Paragon reward quest. + +**Description:** +The `currentValue` return value contains a prefix that indicates the amount of paragon rewards you have gotten so far. +For example, having received a paragon reward for The Undying Army 12 times, if one calls the above function and the current rep level is 717, the result for `currentValue` will be 120717. + +**Usage:** +Reading the current reputation points of the Venthyr covenant: +```lua +local factionID = 2413 +local currentValue, threshold, rewardQuestID, hasRewardPending, tooLowLevelForParagon = C_Reputation.GetFactionParagonInfo(factionID) +-- total iterations (= Rewards Earned) +local level = math.floor(currentValue/threshold)-(hasRewardPending and 1 or 0) +local realValue = tonumber(string.sub(currentValue, string.len(level) + 1)) +print("current rep: ", realValue, " (", threshold, "), level: ", level) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.IsFactionParagon.md b/wiki-information/functions/C_Reputation.IsFactionParagon.md new file mode 100644 index 00000000..3a9e2474 --- /dev/null +++ b/wiki-information/functions/C_Reputation.IsFactionParagon.md @@ -0,0 +1,18 @@ +## Title: C_Reputation.IsFactionParagon + +**Content:** +Returns true if a faction is a paragon reputation. +`isParagon = C_Reputation.IsFactionParagon(factionID)` + +**Parameters:** +- `factionID` + - *number* - The factionID from the 14th return of `GetFactionInfo` or the 6th return from `GetWatchedFactionInfo`. + +**Returns:** +- `isParagon` + - *boolean* - true if the faction is Paragon level, false otherwise. + +**Reference:** +- `GetFactionInfo` +- `GetWatchedFactionInfo` +- `C_Reputation.GetFactionParagonInfo` \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md b/wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md new file mode 100644 index 00000000..d438ddb1 --- /dev/null +++ b/wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md @@ -0,0 +1,9 @@ +## Title: C_Reputation.RequestFactionParagonPreloadRewardData + +**Content:** +Needs summary. +`C_Reputation.RequestFactionParagonPreloadRewardData(factionID)` + +**Parameters:** +- `factionID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.SetWatchedFaction.md b/wiki-information/functions/C_Reputation.SetWatchedFaction.md new file mode 100644 index 00000000..fd78e331 --- /dev/null +++ b/wiki-information/functions/C_Reputation.SetWatchedFaction.md @@ -0,0 +1,9 @@ +## Title: C_Reputation.SetWatchedFaction + +**Content:** +Needs summary. +`C_Reputation.SetWatchedFaction(factionID)` + +**Parameters:** +- `factionID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md b/wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md new file mode 100644 index 00000000..859fb0f5 --- /dev/null +++ b/wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md @@ -0,0 +1,102 @@ +## Title: C_ScriptedAnimations.GetAllScriptedAnimationEffects + +**Content:** +Needs summary. +`scriptedAnimationEffects = C_ScriptedAnimations.GetAllScriptedAnimationEffects()` + +**Returns:** +- `scriptedAnimationEffects` + - *ScriptedAnimationEffect* + - `Field` + - `Type` + - `Description` + - `id` + - *number* + - `visual` + - *number* + - `visualScale` + - *number* + - `duration` + - *number* + - `trajectory` + - *Enum.ScriptedAnimationTrajectory* + - `yawRadians` + - *number* + - `pitchRadians` + - *number* + - `rollRadians` + - *number* + - `offsetX` + - *number* + - `offsetY` + - *number* + - `offsetZ` + - *number* + - `animation` + - *number* + - `animationSpeed` + - *number* + - `alpha` + - *number* + - `useTargetAsSource` + - *boolean* + - `startBehavior` + - *Enum.ScriptedAnimationBehavior?* + - `startSoundKitID` + - *number?* + - `finishEffectID` + - *number?* + - `finishBehavior` + - *Enum.ScriptedAnimationBehavior?* + - `finishSoundKitID` + - *number?* + - `startAlphaFade` + - *number?* + - `startAlphaFadeDuration` + - *number?* + - `endAlphaFade` + - *number?* + - `endAlphaFadeDuration` + - *number?* + - `animationStartOffset` + - *number?* + - `loopingSoundKitID` + - *number?* + - `particleOverrideScale` + - *number?* + +**Enum.ScriptedAnimationTrajectory** +- `Value` +- `Field` +- `Description` + - `0` + - AtSource + - `1` + - AtTarget + - `2` + - Straight + - `3` + - CurveLeft + - `4` + - CurveRight + - `5` + - CurveRandom + - `6` + - HalfwayBetween + +**Enum.ScriptedAnimationBehavior** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - TargetShake + - `2` + - TargetKnockBack + - `3` + - SourceRecoil + - `4` + - SourceCollideWithTarget + - `5` + - UIParentShake \ No newline at end of file diff --git a/wiki-information/functions/C_Seasons.GetActiveSeason.md b/wiki-information/functions/C_Seasons.GetActiveSeason.md new file mode 100644 index 00000000..c8234617 --- /dev/null +++ b/wiki-information/functions/C_Seasons.GetActiveSeason.md @@ -0,0 +1,23 @@ +## Title: C_Seasons.GetActiveSeason + +**Content:** +Returns the ID of the season that is active on the current realm. +`seasonID = C_Seasons.GetActiveSeason()` + +**Returns:** +- `seasonID` + - *Enum.SeasonID* - The currently active season ID. + - `Value` + - `Field` + - `Description` + - `0` + - `NoSeason` - Used for normal (non-seasonal) realms. + - `1` + - `SeasonOfMastery` - Season of Mastery realms. + - `2` + - `SeasonOfDiscovery` - Season of Discovery realms. + - `3` + - `Hardcore` + +**Description:** +This function will not return nil when no season is active; instead, the NoSeason ID will be returned. \ No newline at end of file diff --git a/wiki-information/functions/C_Seasons.HasActiveSeason.md b/wiki-information/functions/C_Seasons.HasActiveSeason.md new file mode 100644 index 00000000..891d5391 --- /dev/null +++ b/wiki-information/functions/C_Seasons.HasActiveSeason.md @@ -0,0 +1,12 @@ +## Title: C_Seasons.HasActiveSeason + +**Content:** +Returns true if the player is on a seasonal realm. +`active = C_Seasons.HasActiveSeason()` + +**Returns:** +- `active` + - *boolean* - true if the player is on a seasonal realm, otherwise false. + +**Description:** +Information about the current season active on a realm can be queried via `C_Seasons.GetActiveSeason`. \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetLastItem.md b/wiki-information/functions/C_Social.GetLastItem.md new file mode 100644 index 00000000..869d2525 --- /dev/null +++ b/wiki-information/functions/C_Social.GetLastItem.md @@ -0,0 +1,19 @@ +## Title: C_Social.GetLastItem + +**Content:** +Needs summary. +`itemID, itemName, iconFileID, itemQuality, itemLevel, itemLinkString = C_Social.GetLastItem()` + +**Returns:** +- `itemID` + - *number* +- `itemName` + - *string* +- `iconFileID` + - *number* +- `itemQuality` + - *number* +- `itemLevel` + - *number* +- `itemLinkString` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetLastScreenshot.md b/wiki-information/functions/C_Social.GetLastScreenshot.md new file mode 100644 index 00000000..08cfb168 --- /dev/null +++ b/wiki-information/functions/C_Social.GetLastScreenshot.md @@ -0,0 +1,9 @@ +## Title: C_Social.GetLastScreenshotIndex + +**Content:** +Returns the index of the last screenshot. +`screenshotIndex = C_Social.GetLastScreenshotIndex()` + +**Returns:** +- `screenshotIndex` + - *number* - index of the screenshot. Zero if no screenshots have been taken yet. \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetNumCharactersPerMedia.md b/wiki-information/functions/C_Social.GetNumCharactersPerMedia.md new file mode 100644 index 00000000..400df2fc --- /dev/null +++ b/wiki-information/functions/C_Social.GetNumCharactersPerMedia.md @@ -0,0 +1,9 @@ +## Title: C_Social.GetMaxTweetLength + +**Content:** +Returns the max character length of a tweet. +`maxTweetLength = C_Social.GetMaxTweetLength()` + +**Returns:** +- `maxTweetLength` + - *number* - the current max character length for the user (280). \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetScreenshotByIndex.md b/wiki-information/functions/C_Social.GetScreenshotByIndex.md new file mode 100644 index 00000000..f7d5e092 --- /dev/null +++ b/wiki-information/functions/C_Social.GetScreenshotByIndex.md @@ -0,0 +1,24 @@ +## Title: C_Social.GetScreenshotInfoByIndex + +**Content:** +Returns the display resolution of a screenshot. +`screenWidth, screenHeight = C_Social.GetScreenshotInfoByIndex(index)` + +**Parameters:** +- `index` + - *number* - index of the screenshot. Does not persist between sessions. + +**Returns:** +- `screenWidth` + - *number* - width of the screen in pixels. +- `screenHeight` + - *number* - height of the screen in pixels. + +**Usage:** +Prints the screenshot information of this session. +```lua +for i = 1, C_Social.GetLastScreenshotIndex() do + local width, height = C_Social.GetScreenshotInfoByIndex(i) + print(i, width, height) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetTweetLength.md b/wiki-information/functions/C_Social.GetTweetLength.md new file mode 100644 index 00000000..0740fc97 --- /dev/null +++ b/wiki-information/functions/C_Social.GetTweetLength.md @@ -0,0 +1,13 @@ +## Title: C_Social.GetTweetLength + +**Content:** +Needs summary. +`tweetLength = C_Social.GetTweetLength(tweetText)` + +**Parameters:** +- `tweetText` + - *string* + +**Returns:** +- `tweetLength` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.IsSocialEnabled.md b/wiki-information/functions/C_Social.IsSocialEnabled.md new file mode 100644 index 00000000..24a82cd4 --- /dev/null +++ b/wiki-information/functions/C_Social.IsSocialEnabled.md @@ -0,0 +1,9 @@ +## Title: C_Social.IsSocialEnabled + +**Content:** +Needs summary. +`isEnabled = C_Social.IsSocialEnabled()` + +**Returns:** +- `isEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterCheckStatus.md b/wiki-information/functions/C_Social.TwitterCheckStatus.md new file mode 100644 index 00000000..ac492565 --- /dev/null +++ b/wiki-information/functions/C_Social.TwitterCheckStatus.md @@ -0,0 +1,5 @@ +## Title: C_Social.TwitterCheckStatus + +**Content:** +Not allowed to be called by addons. +`C_Social.TwitterCheckStatus()` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterConnect.md b/wiki-information/functions/C_Social.TwitterConnect.md new file mode 100644 index 00000000..485bf7b1 --- /dev/null +++ b/wiki-information/functions/C_Social.TwitterConnect.md @@ -0,0 +1,5 @@ +## Title: C_Social.TwitterConnect + +**Content:** +Not allowed to be called by addons. +`C_Social.TwitterConnect()` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterDisconnect.md b/wiki-information/functions/C_Social.TwitterDisconnect.md new file mode 100644 index 00000000..82060144 --- /dev/null +++ b/wiki-information/functions/C_Social.TwitterDisconnect.md @@ -0,0 +1,5 @@ +## Title: C_Social.TwitterDisconnect + +**Content:** +Not allowed to be called by addons. +`C_Social.TwitterDisconnect()` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md b/wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md new file mode 100644 index 00000000..b240e4e9 --- /dev/null +++ b/wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md @@ -0,0 +1,9 @@ +## Title: C_Social.TwitterGetMSTillCanPost + +**Content:** +Needs summary. +`msTimeLeft = C_Social.TwitterGetMSTillCanPost()` + +**Returns:** +- `msTimeLeft` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterPostMessage.md b/wiki-information/functions/C_Social.TwitterPostMessage.md new file mode 100644 index 00000000..bfd62140 --- /dev/null +++ b/wiki-information/functions/C_Social.TwitterPostMessage.md @@ -0,0 +1,12 @@ +## Title: C_Social.TwitterPostMessage + +**Content:** +Needs summary. +`C_Social.TwitterPostMessage(message)` + +**Parameters:** +- `message` + - *string* + +**Description:** +Not allowed to be called by addons. \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md b/wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md new file mode 100644 index 00000000..199b2b12 --- /dev/null +++ b/wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md @@ -0,0 +1,5 @@ +## Title: C_SocialRestrictions.AcknowledgeRegionalChatDisabled + +**Content:** +Needs summary. +`C_SocialRestrictions.AcknowledgeRegionalChatDisabled()` \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md b/wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md new file mode 100644 index 00000000..694f115d --- /dev/null +++ b/wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md @@ -0,0 +1,9 @@ +## Title: C_SocialRestrictions.IsChatDisabled + +**Content:** +Needs summary. +`disabled = C_SocialRestrictions.IsChatDisabled()` + +**Returns:** +- `disabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsMuted.md b/wiki-information/functions/C_SocialRestrictions.IsMuted.md new file mode 100644 index 00000000..7b4777b2 --- /dev/null +++ b/wiki-information/functions/C_SocialRestrictions.IsMuted.md @@ -0,0 +1,9 @@ +## Title: C_SocialRestrictions.IsMuted + +**Content:** +Needs summary. +`isMuted = C_SocialRestrictions.IsMuted()` + +**Returns:** +- `isMuted` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsSilenced.md b/wiki-information/functions/C_SocialRestrictions.IsSilenced.md new file mode 100644 index 00000000..889bed36 --- /dev/null +++ b/wiki-information/functions/C_SocialRestrictions.IsSilenced.md @@ -0,0 +1,9 @@ +## Title: C_SocialRestrictions.IsSilenced + +**Content:** +Needs summary. +`isSilenced = C_SocialRestrictions.IsSilenced()` + +**Returns:** +- `isSilenced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsSquelched.md b/wiki-information/functions/C_SocialRestrictions.IsSquelched.md new file mode 100644 index 00000000..54d3ed33 --- /dev/null +++ b/wiki-information/functions/C_SocialRestrictions.IsSquelched.md @@ -0,0 +1,9 @@ +## Title: C_SocialRestrictions.IsSquelched + +**Content:** +Needs summary. +`isSquelched = C_SocialRestrictions.IsSquelched()` + +**Returns:** +- `isSquelched` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md b/wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md new file mode 100644 index 00000000..b6c09d8f --- /dev/null +++ b/wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md @@ -0,0 +1,9 @@ +## Title: C_SocialRestrictions.SetChatDisabled + +**Content:** +Needs summary. +`C_SocialRestrictions.SetChatDisabled(disabled)` + +**Parameters:** +- `disabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Sound.GetSoundScaledVolume.md b/wiki-information/functions/C_Sound.GetSoundScaledVolume.md new file mode 100644 index 00000000..837beb41 --- /dev/null +++ b/wiki-information/functions/C_Sound.GetSoundScaledVolume.md @@ -0,0 +1,13 @@ +## Title: C_Sound.GetSoundScaledVolume + +**Content:** +Needs summary. +`scaledVolume = C_Sound.GetSoundScaledVolume(soundHandle)` + +**Parameters:** +- `soundHandle` + - *number* + +**Returns:** +- `scaledVolume` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Sound.IsPlaying.md b/wiki-information/functions/C_Sound.IsPlaying.md new file mode 100644 index 00000000..3c156167 --- /dev/null +++ b/wiki-information/functions/C_Sound.IsPlaying.md @@ -0,0 +1,19 @@ +## Title: C_Sound.IsPlaying + +**Content:** +Needs summary. +`isPlaying = C_Sound.IsPlaying(soundHandle)` + +**Parameters:** +- `soundHandle` + - *number* + +**Returns:** +- `isPlaying` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific sound is currently playing in the game. For instance, if you have a custom addon that plays a sound when a certain event occurs, you can use `C_Sound.IsPlaying` to verify if the sound is still playing before attempting to play it again. + +**Addons:** +Many large addons that manage sound effects, such as DBM (Deadly Boss Mods) or WeakAuras, might use this function to ensure that sounds are not played multiple times simultaneously, which can help in managing sound clutter and improving the user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_Sound.PlayItemSound.md b/wiki-information/functions/C_Sound.PlayItemSound.md new file mode 100644 index 00000000..59384550 --- /dev/null +++ b/wiki-information/functions/C_Sound.PlayItemSound.md @@ -0,0 +1,22 @@ +## Title: C_Sound.PlayItemSound + +**Content:** +Needs summary. +`C_Sound.PlayItemSound(soundType, itemLocation)` + +**Parameters:** +- `soundType` + - *Enum.ItemSoundType* + - `Value` + - `Field` + - `Description` + - `0` + - Pickup + - `1` + - Drop + - `2` + - Use + - `3` + - Close +- `itemLocation` + - *ItemLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Spell.DoesSpellExist.md b/wiki-information/functions/C_Spell.DoesSpellExist.md new file mode 100644 index 00000000..1a386372 --- /dev/null +++ b/wiki-information/functions/C_Spell.DoesSpellExist.md @@ -0,0 +1,16 @@ +## Title: C_Spell.DoesSpellExist + +**Content:** +Needs summary. +`spellExists = C_Spell.DoesSpellExist(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `spellExists` + - *boolean* + +**Reference:** +DoesSpellExist() - This is apparently not the same since it points to a different function reference. \ No newline at end of file diff --git a/wiki-information/functions/C_Spell.IsSpellDataCached.md b/wiki-information/functions/C_Spell.IsSpellDataCached.md new file mode 100644 index 00000000..58a61a6b --- /dev/null +++ b/wiki-information/functions/C_Spell.IsSpellDataCached.md @@ -0,0 +1,29 @@ +## Title: C_Spell.IsSpellDataCached + +**Content:** +Needs summary. +`isCached = C_Spell.IsSpellDataCached(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `isCached` + - *boolean* + +**Description:** +This function checks if the data for a specific spell, identified by its `spellID`, is already cached on the client. This can be useful for addons that need to ensure spell data is available before attempting to use or display it. + +**Example Usage:** +```lua +local spellID = 12345 +if C_Spell.IsSpellDataCached(spellID) then + print("Spell data is cached.") +else + print("Spell data is not cached.") +end +``` + +**Addons Using This Function:** +- **WeakAuras**: This popular addon uses `C_Spell.IsSpellDataCached` to check if spell data is available before creating custom auras and effects based on specific spells. This ensures that the addon can provide accurate and up-to-date information to the player. \ No newline at end of file diff --git a/wiki-information/functions/C_Spell.RequestLoadSpellData.md b/wiki-information/functions/C_Spell.RequestLoadSpellData.md new file mode 100644 index 00000000..d4cb82c3 --- /dev/null +++ b/wiki-information/functions/C_Spell.RequestLoadSpellData.md @@ -0,0 +1,12 @@ +## Title: C_Spell.RequestLoadSpellData + +**Content:** +Requests spell data and fires `SPELL_DATA_LOAD_RESULT`. +`C_Spell.RequestLoadSpellData(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Reference:** +- `SpellMixin` \ No newline at end of file diff --git a/wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md b/wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md new file mode 100644 index 00000000..fba82b71 --- /dev/null +++ b/wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md @@ -0,0 +1,21 @@ +## Title: C_SpellBook.GetSpellLinkFromSpellID + +**Content:** +Needs summary. +`spellLink = C_SpellBook.GetSpellLinkFromSpellID(spellID)` + +**Parameters:** +- `spellID` + - *number* +- `glyphID` + - *number?* + +**Returns:** +- `spellLink` + - *string* + +**Example Usage:** +This function can be used to retrieve the link of a spell given its spell ID. This is particularly useful for addons that need to display or manipulate spell links. + +**Addon Usage:** +Large addons like WeakAuras might use this function to fetch and display spell links in custom auras or notifications. \ No newline at end of file diff --git a/wiki-information/functions/C_StableInfo.GetNumActivePets.md b/wiki-information/functions/C_StableInfo.GetNumActivePets.md new file mode 100644 index 00000000..19a03c5c --- /dev/null +++ b/wiki-information/functions/C_StableInfo.GetNumActivePets.md @@ -0,0 +1,12 @@ +## Title: C_StableInfo.GetNumActivePets + +**Content:** +Needs summary. +`numActivePets = C_StableInfo.GetNumActivePets()` + +**Returns:** +- `numActivePets` + - *number* + +**Description:** +Appears to be added for a "Hunter Tame Tutorial". \ No newline at end of file diff --git a/wiki-information/functions/C_StableInfo.GetNumStablePets.md b/wiki-information/functions/C_StableInfo.GetNumStablePets.md new file mode 100644 index 00000000..2f8232ce --- /dev/null +++ b/wiki-information/functions/C_StableInfo.GetNumStablePets.md @@ -0,0 +1,12 @@ +## Title: C_StableInfo.GetNumStablePets + +**Content:** +Needs summary. +`numStablePets = C_StableInfo.GetNumStablePets()` + +**Returns:** +- `numStablePets` + - *number* + +**Description:** +Appears to be added for a "Hunter Tame Tutorial". \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md b/wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md new file mode 100644 index 00000000..2799ca7b --- /dev/null +++ b/wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md @@ -0,0 +1,13 @@ +## Title: C_StorePublic.DoesGroupHavePurchaseableProducts + +**Content:** +Needs summary. +`hasPurchaseableProducts = C_StorePublic.DoesGroupHavePurchaseableProducts(groupID)` + +**Parameters:** +- `groupID` + - *number* + +**Returns:** +- `hasPurchaseableProducts` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md b/wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md new file mode 100644 index 00000000..268b6617 --- /dev/null +++ b/wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md @@ -0,0 +1,9 @@ +## Title: C_StorePublic.HasPurchaseableProducts + +**Content:** +Needs summary. +`hasPurchaseableProducts = C_StorePublic.HasPurchaseableProducts()` + +**Returns:** +- `hasPurchaseableProducts` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md b/wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md new file mode 100644 index 00000000..08b7a237 --- /dev/null +++ b/wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md @@ -0,0 +1,9 @@ +## Title: C_StorePublic.IsDisabledByParentalControls + +**Content:** +Returns whether access to the in-game shop is disabled by parental controls. +`isDisabled = C_StorePublic.IsDisabledByParentalControls()` + +**Returns:** +- `isDisabled` + - *boolean* - true if the player cannot access the in-game shop due to parental controls, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.IsEnabled.md b/wiki-information/functions/C_StorePublic.IsEnabled.md new file mode 100644 index 00000000..6ac5cc9b --- /dev/null +++ b/wiki-information/functions/C_StorePublic.IsEnabled.md @@ -0,0 +1,9 @@ +## Title: C_StorePublic.IsEnabled + +**Content:** +Returns whether the In-Game Store is available for the player. +`isEnabled = C_StorePublic.IsEnabled()` + +**Returns:** +- `isEnabled` + - *boolean* - true if the store is available, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.CancelSummon.md b/wiki-information/functions/C_SummonInfo.CancelSummon.md new file mode 100644 index 00000000..df1bb4a0 --- /dev/null +++ b/wiki-information/functions/C_SummonInfo.CancelSummon.md @@ -0,0 +1,11 @@ +## Title: C_SummonInfo.CancelSummon + +**Content:** +Declines a summon request. +`C_SummonInfo.CancelSummon()` + +**Example Usage:** +This function can be used in a scenario where a player receives a summon request but decides not to accept it. For instance, an addon could automatically decline summon requests under certain conditions, such as being in combat or in a specific zone. + +**Addons:** +While there are no specific large addons known to use this function directly, it could be utilized in custom scripts or smaller addons that manage player interactions and automate responses to summon requests. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.ConfirmSummon.md b/wiki-information/functions/C_SummonInfo.ConfirmSummon.md new file mode 100644 index 00000000..26cac83a --- /dev/null +++ b/wiki-information/functions/C_SummonInfo.ConfirmSummon.md @@ -0,0 +1,11 @@ +## Title: C_SummonInfo.ConfirmSummon + +**Content:** +Accepts a summon request. +`C_SummonInfo.ConfirmSummon()` + +**Example Usage:** +This function can be used in a scenario where a player receives a summon request from another player or a warlock's summoning portal. By calling `C_SummonInfo.ConfirmSummon()`, the player can automatically accept the summon without manually clicking the accept button. + +**Addon Usage:** +Large addons like **DBM (Deadly Boss Mods)** or **ElvUI** might use this function to streamline the summoning process during raids or group activities, ensuring that players can quickly and efficiently respond to summon requests without interrupting their gameplay. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md b/wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md new file mode 100644 index 00000000..c30fa0d7 --- /dev/null +++ b/wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md @@ -0,0 +1,9 @@ +## Title: C_SummonInfo.GetSummonConfirmAreaName + +**Content:** +Returns the zone where you will be summoned to. +`areaName = C_SummonInfo.GetSummonConfirmAreaName()` + +**Returns:** +- `areaName` + - *string* - the zone of the summoning origin. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md b/wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md new file mode 100644 index 00000000..8fb03187 --- /dev/null +++ b/wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md @@ -0,0 +1,12 @@ +## Title: C_SummonInfo.GetSummonConfirmSummoner + +**Content:** +Returns the name of the player summoning you. +`summoner = C_SummonInfo.GetSummonConfirmSummoner()` + +**Returns:** +- `summoner` + - *string?* - name of the player summoning you, or nil if no summon is currently pending. + +**Description:** +The function returns correct results after the `CONFIRM_SUMMON` event. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md b/wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md new file mode 100644 index 00000000..f28a13fe --- /dev/null +++ b/wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md @@ -0,0 +1,9 @@ +## Title: C_SummonInfo.GetSummonConfirmTimeLeft + +**Content:** +Returns the time left in seconds for accepting a summon. +`timeLeft = C_SummonInfo.GetSummonConfirmTimeLeft()` + +**Returns:** +- `timeLeft` + - *number* - Time in seconds. Zero if not being summoned. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonReason.md b/wiki-information/functions/C_SummonInfo.GetSummonReason.md new file mode 100644 index 00000000..3e7856a6 --- /dev/null +++ b/wiki-information/functions/C_SummonInfo.GetSummonReason.md @@ -0,0 +1,9 @@ +## Title: C_SummonInfo.GetSummonReason + +**Content:** +Returns the reason for a summon. +`summonReason = C_SummonInfo.GetSummonReason()` + +**Returns:** +- `summonReason` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md b/wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md new file mode 100644 index 00000000..a428b91e --- /dev/null +++ b/wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md @@ -0,0 +1,9 @@ +## Title: C_SummonInfo.IsSummonSkippingStartExperience + +**Content:** +Returns true if the summon will take the player out of a confined starting zone. +`isSummonSkippingStartExperience = C_SummonInfo.IsSummonSkippingStartExperience()` + +**Returns:** +- `isSummonSkippingStartExperience` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_System.GetFrameStack.md b/wiki-information/functions/C_System.GetFrameStack.md new file mode 100644 index 00000000..134e866f --- /dev/null +++ b/wiki-information/functions/C_System.GetFrameStack.md @@ -0,0 +1,9 @@ +## Title: C_System.GetFrameStack + +**Content:** +Returns an array of all UI objects under the mouse cursor, as would be exposed through the frame stack tooltip. The returned table is ordered from highest object level to lowest. +`objects = C_System.GetFrameStack()` + +**Returns:** +- `objects` + - *ScriptRegion* - A table of all UI objects under the mouse cursor, ordered from highest object level to lowest. \ No newline at end of file diff --git a/wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md b/wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md new file mode 100644 index 00000000..5ff31e77 --- /dev/null +++ b/wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md @@ -0,0 +1,18 @@ +## Title: C_SystemVisibilityManager.IsSystemVisible + +**Content:** +Needs summary. +`visible = C_SystemVisibilityManager.IsSystemVisible(system)` + +**Parameters:** +- `system` + - *Enum.UISystemType* + - `Value` + - `Field` + - `Description` + - `0` + - InGameNavigation + +**Returns:** +- `visible` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetChannelEnabled.md b/wiki-information/functions/C_TTSSettings.GetChannelEnabled.md new file mode 100644 index 00000000..c7bbb133 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetChannelEnabled.md @@ -0,0 +1,40 @@ +## Title: C_TTSSettings.GetChannelEnabled + +**Content:** +Needs summary. +`enabled = C_TTSSettings.GetChannelEnabled(channelInfo)` + +**Parameters:** +- `channelInfo` + - *ChatChannelInfo* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `shortcut` + - *string* + - `localID` + - *number* + - `instanceID` + - *number* + - `zoneChannelID` + - *number* + - `channelType` + - *Enum.PermanentChatChannelType* + - `Enum.PermanentChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Zone + - `2` + - Communities + - `3` + - Custom + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md b/wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md new file mode 100644 index 00000000..e1eaeafd --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md @@ -0,0 +1,9 @@ +## Title: C_TTSSettings.GetCharacterSettingsSaved + +**Content:** +Needs summary. +`settingsBeenSaved = C_TTSSettings.GetCharacterSettingsSaved()` + +**Returns:** +- `settingsBeenSaved` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md b/wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md new file mode 100644 index 00000000..38139001 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md @@ -0,0 +1,13 @@ +## Title: C_TTSSettings.GetChatTypeEnabled + +**Content:** +Needs summary. +`enabled = C_TTSSettings.GetChatTypeEnabled(chatName)` + +**Parameters:** +- `chatName` + - *string* + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetSetting.md b/wiki-information/functions/C_TTSSettings.GetSetting.md new file mode 100644 index 00000000..90c6e108 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetSetting.md @@ -0,0 +1,21 @@ +## Title: C_TTSSettings.GetSetting + +**Content:** +Needs summary. +`enabled = C_TTSSettings.GetSetting(setting)` + +**Parameters:** +- `setting` + - *Enum.TtsBoolSetting* + - `Value` + - `Field` + - `Description` + - `0` - PlaySoundSeparatingChatLineBreaks + - `1` - AddCharacterNameToSpeech + - `2` - PlayActivitySoundWhenNotFocused + - `3` - AlternateSystemVoice + - `4` - NarrateMyMessages + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetSpeechRate.md b/wiki-information/functions/C_TTSSettings.GetSpeechRate.md new file mode 100644 index 00000000..9fe10161 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetSpeechRate.md @@ -0,0 +1,9 @@ +## Title: C_TTSSettings.GetSpeechRate + +**Content:** +Needs summary. +`rate = C_TTSSettings.GetSpeechRate()` + +**Returns:** +- `rate` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetSpeechVolume.md b/wiki-information/functions/C_TTSSettings.GetSpeechVolume.md new file mode 100644 index 00000000..09a6f291 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetSpeechVolume.md @@ -0,0 +1,9 @@ +## Title: C_TTSSettings.GetSpeechVolume + +**Content:** +Needs summary. +`volume = C_TTSSettings.GetSpeechVolume()` + +**Returns:** +- `volume` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md b/wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md new file mode 100644 index 00000000..786d5d85 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md @@ -0,0 +1,20 @@ +## Title: C_TTSSettings.GetVoiceOptionID + +**Content:** +Get the user's preferred text to speech voices. +`voiceID = C_TTSSettings.GetVoiceOptionID(voiceType)` + +**Parameters:** +- `voiceType` + - *Enum.TtsVoiceType* + - `Value` + - `Field` + - `Description` + - `0` + - Standard + - `1` + - Alternate + +**Returns:** +- `voiceID` + - *number* - Used with `C_VoiceChat.SpeakText()`. \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md b/wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md new file mode 100644 index 00000000..5806fc7d --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md @@ -0,0 +1,20 @@ +## Title: C_TTSSettings.GetVoiceOptionName + +**Content:** +Needs summary. +`voiceName = C_TTSSettings.GetVoiceOptionName(voiceType)` + +**Parameters:** +- `voiceType` + - *Enum.TtsVoiceType* + - `Value` + - `Field` + - `Description` + - `0` + - Standard + - `1` + - Alternate + +**Returns:** +- `voiceName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md b/wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md new file mode 100644 index 00000000..24ec9d42 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md @@ -0,0 +1,6 @@ +## Title: C_TTSSettings.MarkCharacterSettingsSaved + +**Content:** +Needs summary. +`C_TTSSettings.MarkCharacterSettingsSaved()` + diff --git a/wiki-information/functions/C_TTSSettings.SetChannelEnabled.md b/wiki-information/functions/C_TTSSettings.SetChannelEnabled.md new file mode 100644 index 00000000..c5f635c1 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetChannelEnabled.md @@ -0,0 +1,38 @@ +## Title: C_TTSSettings.SetChannelEnabled + +**Content:** +Needs summary. +`C_TTSSettings.SetChannelEnabled(channelInfo)` + +**Parameters:** +- `channelInfo` + - *ChatChannelInfo* + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `shortcut` + - *string* + - `localID` + - *number* + - `instanceID` + - *number* + - `zoneChannelID` + - *number* + - `channelType` + - *Enum.PermanentChatChannelType* + - `Enum.PermanentChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Zone + - `2` + - Communities + - `3` + - Custom +- `newVal` + - *boolean? = false* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md b/wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md new file mode 100644 index 00000000..08037dd5 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md @@ -0,0 +1,11 @@ +## Title: C_TTSSettings.SetChannelKeyEnabled + +**Content:** +Needs summary. +`C_TTSSettings.SetChannelKeyEnabled(channelKey)` + +**Parameters:** +- `channelKey` + - *string* +- `newVal` + - *boolean? = false* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md b/wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md new file mode 100644 index 00000000..eba4eb9a --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md @@ -0,0 +1,11 @@ +## Title: C_TTSSettings.SetChatTypeEnabled + +**Content:** +Needs summary. +`C_TTSSettings.SetChatTypeEnabled(chatName)` + +**Parameters:** +- `chatName` + - *string* +- `newVal` + - *boolean? = false* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetDefaultSettings.md b/wiki-information/functions/C_TTSSettings.SetDefaultSettings.md new file mode 100644 index 00000000..a94618bc --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetDefaultSettings.md @@ -0,0 +1,6 @@ +## Title: C_TTSSettings.SetDefaultSettings + +**Content:** +Needs summary. +`C_TTSSettings.SetDefaultSettings()` + diff --git a/wiki-information/functions/C_TTSSettings.SetSetting.md b/wiki-information/functions/C_TTSSettings.SetSetting.md new file mode 100644 index 00000000..334bbfb4 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetSetting.md @@ -0,0 +1,19 @@ +## Title: C_TTSSettings.SetSetting + +**Content:** +Needs summary. +`C_TTSSettings.SetSetting(setting)` + +**Parameters:** +- `setting` + - *Enum.TtsBoolSetting* + - `Value` + - `Field` + - `Description` + - `0` - PlaySoundSeparatingChatLineBreaks + - `1` - AddCharacterNameToSpeech + - `2` - PlayActivitySoundWhenNotFocused + - `3` - AlternateSystemVoice + - `4` - NarrateMyMessages +- `newVal` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetSpeechRate.md b/wiki-information/functions/C_TTSSettings.SetSpeechRate.md new file mode 100644 index 00000000..2f004e3b --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetSpeechRate.md @@ -0,0 +1,9 @@ +## Title: C_TTSSettings.SetSpeechRate + +**Content:** +Needs summary. +`C_TTSSettings.SetSpeechRate(newVal)` + +**Parameters:** +- `newVal` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetSpeechVolume.md b/wiki-information/functions/C_TTSSettings.SetSpeechVolume.md new file mode 100644 index 00000000..59dd0ed5 --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetSpeechVolume.md @@ -0,0 +1,9 @@ +## Title: C_TTSSettings.SetSpeechVolume + +**Content:** +Needs summary. +`C_TTSSettings.SetSpeechVolume(newVal)` + +**Parameters:** +- `newVal` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetVoiceOption.md b/wiki-information/functions/C_TTSSettings.SetVoiceOption.md new file mode 100644 index 00000000..650e0d4a --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetVoiceOption.md @@ -0,0 +1,17 @@ +## Title: C_TTSSettings.SetVoiceOption + +**Content:** +Needs summary. +`C_TTSSettings.SetVoiceOption(voiceType, voiceID)` + +**Parameters:** +- `voiceType` + - *Enum.TtsVoiceType* + - `Value` + - `Field` + - `Description` + - `0` - Standard + - `1` - Alternate +- `voiceID` + - *number* + diff --git a/wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md b/wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md new file mode 100644 index 00000000..b3ed523d --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md @@ -0,0 +1,33 @@ +## Title: C_TTSSettings.SetVoiceOptionName + +**Content:** +Needs summary. +`C_TTSSettings.SetVoiceOptionName(voiceType, voiceName)` + +**Parameters:** +- `voiceType` + - *Enum.TtsVoiceType* + - `Value` + - `Field` + - `Description` + - `0` + - Standard + - `1` + - Alternate +- `voiceName` + - *string* + +**Description:** +This function is used to set the voice option for text-to-speech settings in World of Warcraft. The `voiceType` parameter allows you to choose between standard and alternate voice types, while the `voiceName` parameter specifies the name of the voice to be used. + +**Example Usage:** +```lua +-- Set the voice option to the standard voice type with a specific voice name +C_TTSSettings.SetVoiceOptionName(Enum.TtsVoiceType.Standard, "VoiceName1") + +-- Set the voice option to the alternate voice type with a different voice name +C_TTSSettings.SetVoiceOptionName(Enum.TtsVoiceType.Alternate, "VoiceName2") +``` + +**Addons:** +Large addons that provide accessibility features, such as text-to-speech, may use this function to customize the voice settings for users. For example, an addon designed to assist visually impaired players might allow users to select different voices for better clarity and understanding. \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md b/wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md new file mode 100644 index 00000000..b25faacf --- /dev/null +++ b/wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md @@ -0,0 +1,15 @@ +## Title: C_TTSSettings.ShouldOverrideMessage + +**Content:** +Needs summary. +`overrideMessage = C_TTSSettings.ShouldOverrideMessage(language, messageText)` + +**Parameters:** +- `language` + - *number* +- `messageText` + - *string* + +**Returns:** +- `overrideMessage` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md b/wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md new file mode 100644 index 00000000..db5b32d9 --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md @@ -0,0 +1,13 @@ +## Title: C_TaskQuest.DoesMapShowTaskQuestObjectives + +**Content:** +Needs summary. +`showsTaskQuestObjectives = C_TaskQuest.DoesMapShowTaskQuestObjectives(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `showsTaskQuestObjectives` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md b/wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md new file mode 100644 index 00000000..a3fd8007 --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md @@ -0,0 +1,25 @@ +## Title: C_TaskQuest.GetQuestInfoByQuestID + +**Content:** +Needs summary. +`questTitle, factionID, capped, displayAsObjective = C_TaskQuest.GetQuestInfoByQuestID(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `questTitle` + - *string* +- `factionID` + - *number?* : FactionID +- `capped` + - *boolean?* +- `displayAsObjective` + - *boolean?* + +**Example Usage:** +This function can be used to retrieve detailed information about a specific task quest by its quest ID. For instance, it can be used in an addon to display quest information in a custom quest tracker. + +**Addons Using This Function:** +Large addons like World Quest Tracker use this function to fetch and display information about world quests, including their titles, associated factions, and whether they are capped or displayed as objectives. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestLocation.md b/wiki-information/functions/C_TaskQuest.GetQuestLocation.md new file mode 100644 index 00000000..9da8ed8e --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetQuestLocation.md @@ -0,0 +1,17 @@ +## Title: C_TaskQuest.GetQuestLocation + +**Content:** +Needs summary. +`locationX, locationY = C_TaskQuest.GetQuestLocation(questID, uiMapID)` + +**Parameters:** +- `questID` + - *number* +- `uiMapID` + - *number* : UiMapID + +**Returns:** +- `locationX` + - *number* +- `locationY` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md b/wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md new file mode 100644 index 00000000..f2f76513 --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md @@ -0,0 +1,27 @@ +## Title: C_TaskQuest.GetQuestProgressBarInfo + +**Content:** +Needs summary. +`progress = C_TaskQuest.GetQuestProgressBarInfo(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `progress` + - *number* + +**Description:** +This function retrieves the progress of a quest that has a progress bar. The progress is returned as a number, which typically represents the percentage of completion. + +**Example Usage:** +```lua +local questID = 12345 +local progress = C_TaskQuest.GetQuestProgressBarInfo(questID) +print("Quest Progress: " .. progress .. "%") +``` + +**Addons Using This Function:** +- **World Quest Tracker**: This addon uses `C_TaskQuest.GetQuestProgressBarInfo` to display the progress of world quests on the map and in the quest tracker. +- **TomTom**: This popular navigation addon may use this function to provide users with progress updates for quests that involve traveling to specific locations. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md b/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md new file mode 100644 index 00000000..9370515e --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md @@ -0,0 +1,21 @@ +## Title: C_TaskQuest.GetQuestTimeLeftSeconds + +**Content:** +Returns the time left for a quest. +```lua +secondsLeft = C_TaskQuest.GetQuestTimeLeftSeconds(questID) +minutesLeft = C_TaskQuest.GetQuestTimeLeftMinutes(questID) +``` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- **GetQuestTimeLeftSeconds:** + - `secondsLeft` + - *number* - time left in seconds. + +- **GetQuestTimeLeftMinutes:** + - `minutesLeft` + - *number* - time left in minutes. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md b/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md new file mode 100644 index 00000000..9370515e --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md @@ -0,0 +1,21 @@ +## Title: C_TaskQuest.GetQuestTimeLeftSeconds + +**Content:** +Returns the time left for a quest. +```lua +secondsLeft = C_TaskQuest.GetQuestTimeLeftSeconds(questID) +minutesLeft = C_TaskQuest.GetQuestTimeLeftMinutes(questID) +``` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- **GetQuestTimeLeftSeconds:** + - `secondsLeft` + - *number* - time left in seconds. + +- **GetQuestTimeLeftMinutes:** + - `minutesLeft` + - *number* - time left in minutes. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestZoneID.md b/wiki-information/functions/C_TaskQuest.GetQuestZoneID.md new file mode 100644 index 00000000..7e2010ff --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetQuestZoneID.md @@ -0,0 +1,13 @@ +## Title: C_TaskQuest.GetQuestZoneID + +**Content:** +Needs summary. +`uiMapID = C_TaskQuest.GetQuestZoneID(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `uiMapID` + - *number* : UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md b/wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md new file mode 100644 index 00000000..3e677dc4 --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md @@ -0,0 +1,39 @@ +## Title: C_TaskQuest.GetQuestsForPlayerByMapID + +**Content:** +Locates world quests, follower quests, and bonus objectives on a map. +`taskPOIs = C_TaskQuest.GetQuestsForPlayerByMapID(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `taskPOIs` + - *TaskPOIData* + - `Field` + - `Type` + - `Description` + - `questId` + - *number* + - `x` + - *number* + - `y` + - *number* + - `inProgress` + - *boolean* + - `numObjectives` + - *number* + - `mapID` + - *number* + - `isQuestStart` + - *boolean* + - `isDaily` + - *boolean* + - `isCombatAllyQuest` + - *boolean* + - `childDepth` + - *number?* + +**Reference:** +- `C_QuestLine.GetAvailableQuestLines()` \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetThreatQuests.md b/wiki-information/functions/C_TaskQuest.GetThreatQuests.md new file mode 100644 index 00000000..cb21b552 --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetThreatQuests.md @@ -0,0 +1,23 @@ +## Title: C_TaskQuest.GetThreatQuests + +**Content:** +Needs summary. +`quests = C_TaskQuest.GetThreatQuests()` + +**Returns:** +- `quests` + - *number* + +**Description:** +This function retrieves the list of threat quests available. Threat quests are typically world quests that have a higher level of difficulty or importance. + +**Example Usage:** +```lua +local threatQuests = C_TaskQuest.GetThreatQuests() +for _, questID in ipairs(threatQuests) do + print("Threat Quest ID:", questID) +end +``` + +**Addons:** +Large addons like World Quest Tracker may use this function to display or track threat quests separately from regular world quests, providing players with information on more challenging or significant quests available in the game world. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md b/wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md new file mode 100644 index 00000000..5920741c --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md @@ -0,0 +1,13 @@ +## Title: C_TaskQuest.GetUIWidgetSetIDFromQuestID + +**Content:** +Needs summary. +`UiWidgetSetID = C_TaskQuest.GetUIWidgetSetIDFromQuestID(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `UiWidgetSetID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.IsActive.md b/wiki-information/functions/C_TaskQuest.IsActive.md new file mode 100644 index 00000000..824fb7f7 --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.IsActive.md @@ -0,0 +1,19 @@ +## Title: C_TaskQuest.IsActive + +**Content:** +Needs summary. +`active = C_TaskQuest.IsActive(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `active` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific task quest is currently active. For instance, an addon that tracks world quests might use this function to determine if a particular world quest is available for the player. + +**Addon Usage:** +Large addons like World Quest Tracker use this function to filter and display only the active world quests on the map, providing players with up-to-date information on available quests. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md b/wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md new file mode 100644 index 00000000..860a7061 --- /dev/null +++ b/wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md @@ -0,0 +1,9 @@ +## Title: C_TaskQuest.RequestPreloadRewardData + +**Content:** +Needs summary. +`C_TaskQuest.RequestPreloadRewardData(questID)` + +**Parameters:** +- `questID` + - *number* - Unique QuestID for the quest to be queried. \ No newline at end of file diff --git a/wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md b/wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md new file mode 100644 index 00000000..47d31306 --- /dev/null +++ b/wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md @@ -0,0 +1,45 @@ +## Title: C_TaxiMap.GetAllTaxiNodes + +**Content:** +Returns information on taxi nodes at the current flight master. +`taxiNodes = C_TaxiMap.GetAllTaxiNodes(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `taxiNodes` + - *TaxiNodeInfo* + - `Field` + - `Type` + - `Description` + - `nodeID` + - *number* + - `position` + - *vector2* + - `name` + - *string* + - `state` + - *Enum.FlightPathState* + - `slotIndex` + - *number* + - `textureKit` + - *string* - textureKit + - `useSpecialIcon` + - *boolean* + - `specialIconCostString` + - *string?* + - `isMapLayerTransition` + - *boolean* + +**Enum.FlightPathState:** +- `Value` +- `Field` +- `Description` + - `0` + - Current + - `1` + - Reachable + - `2` + - Unreachable \ No newline at end of file diff --git a/wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md b/wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md new file mode 100644 index 00000000..cfa062b0 --- /dev/null +++ b/wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md @@ -0,0 +1,38 @@ +## Title: C_TaxiMap.GetTaxiNodesForMap + +**Content:** +Returns information on taxi nodes for a given map, without considering the current flight master. +`mapTaxiNodes = C_TaxiMap.GetTaxiNodesForMap(uiMapID)` + +**Parameters:** +- `uiMapID` + - *number* - UiMapID + +**Returns:** +- `mapTaxiNodes` + - *MapTaxiNodeInfo* + - `Field` + - `Type` + - `Description` + - `nodeID` + - *number* + - `position` + - *Vector2DMixin* + - `name` + - *string* + - `atlasName` + - *string* - AtlasID + - `faction` + - *Enum.FlightPathFaction* + - `textureKit` + - *string* + +**Enum.FlightPathFaction Values:** +- `Field` +- `Description` +- `0` + - Neutral +- `1` + - Horde +- `2` + - Alliance \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.ClearTitleIconTexture.md b/wiki-information/functions/C_Texture.ClearTitleIconTexture.md new file mode 100644 index 00000000..f8d37fa9 --- /dev/null +++ b/wiki-information/functions/C_Texture.ClearTitleIconTexture.md @@ -0,0 +1,9 @@ +## Title: C_Texture.ClearTitleIconTexture + +**Content:** +Needs summary. +`C_Texture.ClearTitleIconTexture(texture)` + +**Parameters:** +- `texture` + - *Texture* \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetAtlasElementID.md b/wiki-information/functions/C_Texture.GetAtlasElementID.md new file mode 100644 index 00000000..630813de --- /dev/null +++ b/wiki-information/functions/C_Texture.GetAtlasElementID.md @@ -0,0 +1,19 @@ +## Title: C_Texture.GetAtlasElementID + +**Content:** +Needs summary. +`elementID = C_Texture.GetAtlasElementID(atlas)` + +**Parameters:** +- `atlas` + - *string* - textureAtlas + +**Returns:** +- `elementID` + - *number* + +**Example Usage:** +This function can be used to retrieve the element ID of a specific texture atlas. This is useful in scenarios where you need to manipulate or reference specific elements within a texture atlas. + +**Addon Usage:** +Large addons like WeakAuras might use this function to dynamically reference and manipulate texture elements for custom visual effects and UI elements. \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetAtlasID.md b/wiki-information/functions/C_Texture.GetAtlasID.md new file mode 100644 index 00000000..667b43d3 --- /dev/null +++ b/wiki-information/functions/C_Texture.GetAtlasID.md @@ -0,0 +1,19 @@ +## Title: C_Texture.GetAtlasID + +**Content:** +Needs summary. +`atlasID = C_Texture.GetAtlasID(atlas)` + +**Parameters:** +- `atlas` + - *string* - textureAtlas + +**Returns:** +- `atlasID` + - *number* + +**Example Usage:** +This function can be used to retrieve the unique ID of a texture atlas, which can be useful for managing and referencing textures in your addon. + +**Addons Using This Function:** +Large addons like WeakAuras might use this function to dynamically reference and manage texture atlases for custom visual effects. \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetAtlasInfo.md b/wiki-information/functions/C_Texture.GetAtlasInfo.md new file mode 100644 index 00000000..78d7fd60 --- /dev/null +++ b/wiki-information/functions/C_Texture.GetAtlasInfo.md @@ -0,0 +1,71 @@ +## Title: C_Texture.GetAtlasInfo + +**Content:** +Returns atlas info. +`info = C_Texture.GetAtlasInfo(atlas)` + +**Parameters:** +- `atlas` + - *string* - Name of the atlas + +**Returns:** +- `info` + - *AtlasInfo* + - `Field` + - `Type` + - `Description` + - `width` + - *number* + - `height` + - *number* + - `rawSize` + - *vector2* + - `leftTexCoord` + - *number* + - `rightTexCoord` + - *number* + - `topTexCoord` + - *number* + - `bottomTexCoord` + - *number* + - `tilesHorizontally` + - *boolean* + - `tilesVertically` + - *boolean* + - `file` + - *number?* - FileID of parent texture + - `filename` + - *string?* + - `sliceData` + - *UITextureSliceData?* + - `UITextureSliceData` + - `Field` + - `Type` + - `Description` + - `marginLeft` + - *number* + - `marginTop` + - *number* + - `marginRight` + - *number* + - `marginBottom` + - *number* + - `sliceMode` + - *Enum.UITextureSliceMode* + - `Enum.UITextureSliceMode` + - `Value` + - `Field` + - `Description` + - `0` + - Stretched + - Default + - `1` + - Tiled + +**Reference:** +- `Texture:GetAtlas()` +- `Texture:SetAtlas()` +- `UI CreateAtlasMarkup` - Returns an inline fontstring texture from an atlas +- `Helix/AtlasInfo.lua` - Lua table containing atlas info +- `UiTextureAtlasMember.db2` - DBC for atlases +- `Texture Atlas Viewer` - Addon for browsing atlases in-game \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md b/wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md new file mode 100644 index 00000000..d7397891 --- /dev/null +++ b/wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md @@ -0,0 +1,16 @@ +## Title: C_Texture.GetFilenameFromFileDataID + +**Content:** +Returns a string representing a file ID. +`filename = C_Texture.GetFilenameFromFileDataID(fileDataID)` + +**Parameters:** +- `fileDataID` + - *number* - The file ID to query. + +**Returns:** +- `filename` + - *string* - A string of the form "FileData ID {fileDataID}". + +**Description:** +This appears to mirror the return value of `TextureBase:GetTextureFilePath`. \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetTitleIconTexture.md b/wiki-information/functions/C_Texture.GetTitleIconTexture.md new file mode 100644 index 00000000..f26d5d79 --- /dev/null +++ b/wiki-information/functions/C_Texture.GetTitleIconTexture.md @@ -0,0 +1,31 @@ +## Title: C_Texture.GetTitleIconTexture + +**Content:** +Needs summary. +`C_Texture.GetTitleIconTexture(titleID, version, callback)` + +**Parameters:** +- `titleID` + - *string* +- `version` + - *Enum.TitleIconVersion* + - `Value` + - `Field` + - `Description` + - `0` + - Small + - `1` + - Medium + - `2` + - Large +- `callback` + - *function : GetTitleIconTextureCallback* + - `Param` + - `Type` + - `Description` + - `1` + - success + - *boolean* + - `2` + - texture + - *number : fileID* \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.IsTitleIconTextureReady.md b/wiki-information/functions/C_Texture.IsTitleIconTextureReady.md new file mode 100644 index 00000000..4dff0bfa --- /dev/null +++ b/wiki-information/functions/C_Texture.IsTitleIconTextureReady.md @@ -0,0 +1,24 @@ +## Title: C_Texture.IsTitleIconTextureReady + +**Content:** +Needs summary. +`ready = C_Texture.IsTitleIconTextureReady(titleID, version)` + +**Parameters:** +- `titleID` + - *string* +- `version` + - *Enum.TitleIconVersion* + - `Value` + - `Field` + - `Description` + - `0` + - Small + - `1` + - Medium + - `2` + - Large + +**Returns:** +- `ready` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.SetTitleIconTexture.md b/wiki-information/functions/C_Texture.SetTitleIconTexture.md new file mode 100644 index 00000000..0c69aacd --- /dev/null +++ b/wiki-information/functions/C_Texture.SetTitleIconTexture.md @@ -0,0 +1,22 @@ +## Title: C_Texture.SetTitleIconTexture + +**Content:** +Needs summary. +`C_Texture.SetTitleIconTexture(texture, titleID, version)` + +**Parameters:** +- `texture` + - *Texture* +- `titleID` + - *string* +- `version` + - *Enum.TitleIconVersion* + - `Value` + - `Field` + - `Description` + - `0` + - Small + - `1` + - Medium + - `2` + - Large \ No newline at end of file diff --git a/wiki-information/functions/C_Timer.After.md b/wiki-information/functions/C_Timer.After.md new file mode 100644 index 00000000..8614725a --- /dev/null +++ b/wiki-information/functions/C_Timer.After.md @@ -0,0 +1,32 @@ +## Title: C_Timer.After + +**Content:** +Schedules a timer. +`C_Timer.After(seconds, callback)` + +**Parameters:** +- `seconds` + - *number* - Time in seconds before the timer finishes. +- `callback` + - *function|FunctionContainer* - Callback function to run. + +**Usage:** +Prints "Hello" after 2.5 seconds. +```lua +/run C_Timer.After(2.5, function() print("Hello") end) +``` +RunNextFrame is a utility function with zero seconds delay. +```lua +-- prints "hello" and then "world" +RunNextFrame(function() print("world") end) +print("hello") +``` + +**Description:** +With a duration of 0 ms, the earliest the callback will be called is on the next frame. +Timing accuracy is limited to the frame rate. +C_Timer.After() is generally more efficient than using an Animation or OnUpdate script. + +In most cases, initiating a second C_Timer is still going to be cheaper than using an Animation or OnUpdate. The issue here is that both Animation and OnUpdate calls have overhead that applies every frame while they are active. For OnUpdate, the overhead lies in the extra function call to Lua. For Animations, we’re doing work C-side that allows us to support smoothing, parallel animations, and animation propagation. In contrast, the new C_Timer system uses a standard heap implementation. It’s only doing work when the timer is created or destroyed (and even then, that work is fairly minimal). + +The one case where you’re better off not using the new C_Timer system is when you have a ticker with a very short period – something that’s going to fire every couple frames. For example, you have a ticker you want to fire every 0.05 seconds; you’re going to be best served by using an OnUpdate function (where about half the function calls will do something useful and half will just decrement the timer). \ No newline at end of file diff --git a/wiki-information/functions/C_Timer.NewTicker.md b/wiki-information/functions/C_Timer.NewTicker.md new file mode 100644 index 00000000..9d871bb8 --- /dev/null +++ b/wiki-information/functions/C_Timer.NewTicker.md @@ -0,0 +1,50 @@ +## Title: C_Timer.NewTimer + +**Content:** +Schedules a (repeating) timer that can be canceled. +`cbObject = C_Timer.NewTimer(seconds, callback)` +`cbObject = C_Timer.NewTicker(seconds, callback)` + +**Parameters:** +- `seconds` + - *number* - Time in seconds between each iteration. +- `callback` + - *function|FunctionContainer* - Callback function to run. +- `iterations` + - *number?* - Number of times to repeat, or indefinite if omitted. + +**Returns:** +- `cbObject` + - *userdata : FunctionContainer* - Timer handle with `:Cancel()` and `:IsCancelled()` methods. + +**Description:** +The callback function will be supplied a view of the timer handle (`cbObject`) when invoked. +The handle returned from the function and the one supplied to the callback are distinct objects that both reference a shared state. See the examples for more details. +`C_Timer.NewTimer()` has just a single iteration and is essentially the same as `C_Timer.NewTicker(duration, callback, 1)`. +Errors thrown inside a callback function will not halt the ticker. + +**Usage:** +- Schedules a repeating timer which runs 4 times. + ```lua + /run C_Timer.NewTicker(2.5, function() print(GetTime()) end, 4) + ``` +- Schedules a timer but cancels it right away. + ```lua + local myTimer = C_Timer.NewTimer(3, function() print("Hello") end) + print(myTimer:IsCancelled()) -- false + myTimer:Cancel() + print(myTimer:IsCancelled()) -- true + ``` +- Schedules a timer that prints a value written to a field stored on the timer handle itself. Timer handles all reference the same shared state internally, so user-defined fields written to handles can be used to supply additional data for use by the callback. + ```lua + local myTimer = C_Timer.NewTimer(2.5, function(self) print("self.data is:", self.data) end) + myTimer.data = GetTime() + ``` +- Schedules a repeating timer which runs 4 times and prints the timer handle returned from the function and supplied to the callback. Note that each print will result in a different object address being displayed, indicating the timer handles have a distinct identity. + ```lua + /run print(C_Timer.NewTicker(0.25, function(self) print(self) end, 4)) + ``` + +**Reference:** +- AceTimer-3.0 +- OnUpdate \ No newline at end of file diff --git a/wiki-information/functions/C_Timer.NewTimer.md b/wiki-information/functions/C_Timer.NewTimer.md new file mode 100644 index 00000000..acffd4fb --- /dev/null +++ b/wiki-information/functions/C_Timer.NewTimer.md @@ -0,0 +1,50 @@ +## Title: C_Timer.NewTimer + +**Content:** +Schedules a (repeating) timer that can be canceled. +`cbObject = C_Timer.NewTimer(seconds, callback)` +`cbObject = C_Timer.NewTicker(seconds, callback)` + +**Parameters:** +- `seconds` + - *number* - Time in seconds between each iteration. +- `callback` + - *function|FunctionContainer* - Callback function to run. +- `iterations` + - *number?* - Number of times to repeat, or indefinite if omitted. + +**Returns:** +- `cbObject` + - *userdata : FunctionContainer* - Timer handle with `:Cancel()` and `:IsCancelled()` methods. + +**Description:** +The callback function will be supplied a view of the timer handle (`cbObject`) when invoked. +The handle returned from the function and the one supplied to the callback are distinct objects that both reference a shared state. See the examples for more details. +`C_Timer.NewTimer()` has just a single iteration and is essentially the same as `C_Timer.NewTicker(duration, callback, 1)` +Errors thrown inside a callback function will not halt the ticker. + +**Usage:** +- Schedules a repeating timer which runs 4 times. + ```lua + /run C_Timer.NewTicker(2.5, function() print(GetTime()) end, 4) + ``` +- Schedules a timer but cancels it right away. + ```lua + local myTimer = C_Timer.NewTimer(3, function() print("Hello") end) + print(myTimer:IsCancelled()) -- false + myTimer:Cancel() + print(myTimer:IsCancelled()) -- true + ``` +- Schedules a timer that prints a value written to a field stored on the timer handle itself. Timer handles all reference the same shared state internally, so user-defined fields written to handles can be used to supply additional data for use by the callback. + ```lua + local myTimer = C_Timer.NewTimer(2.5, function(self) print("self.data is:", self.data) end) + myTimer.data = GetTime() + ``` +- Schedules a repeating timer which runs 4 times and prints the timer handle returned from the function and supplied to the callback. Note that each print will result in a different object address being displayed, indicating the timer handles have a distinct identity. + ```lua + /run print(C_Timer.NewTicker(0.25, function(self) print(self) end, 4)) + ``` + +**Reference:** +- AceTimer-3.0 +- OnUpdate \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetNumToys.md b/wiki-information/functions/C_ToyBox.GetNumToys.md new file mode 100644 index 00000000..a0a3da28 --- /dev/null +++ b/wiki-information/functions/C_ToyBox.GetNumToys.md @@ -0,0 +1,9 @@ +## Title: C_ToyBox.GetNumToys + +**Content:** +Returns the total amount of toys. +`numToys = C_ToyBox.GetNumToys()` + +**Returns:** +- `numToys` + - *number* - The amount of toys in the game; this is not affected by the toy box filter. \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetToyFromIndex.md b/wiki-information/functions/C_ToyBox.GetToyFromIndex.md new file mode 100644 index 00000000..4959878b --- /dev/null +++ b/wiki-information/functions/C_ToyBox.GetToyFromIndex.md @@ -0,0 +1,13 @@ +## Title: C_ToyBox.GetToyFromIndex + +**Content:** +Returns a toy by index. +`itemID = C_ToyBox.GetToyFromIndex(index)` + +**Parameters:** +- `index` + - *number* - Ranging from 1 to `C_ToyBox.GetNumFilteredToys`. + +**Returns:** +- `itemID` + - *number* - The Item ID of the toy. Returns -1 if the index is invalid. \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetToyInfo.md b/wiki-information/functions/C_ToyBox.GetToyInfo.md new file mode 100644 index 00000000..07398638 --- /dev/null +++ b/wiki-information/functions/C_ToyBox.GetToyInfo.md @@ -0,0 +1,23 @@ +## Title: C_ToyBox.GetToyInfo + +**Content:** +Returns toy info. +`itemID, toyName, icon, isFavorite, hasFanfare, itemQuality = C_ToyBox.GetToyInfo(itemID)` + +**Parameters:** +- `itemID` + - *number* - The itemID returned from `C_ToyBox.GetToyFromIndex()`; possible values listed at ToyID. + +**Returns:** +- `itemID` + - *number* - The Item ID of the toy. +- `toyName` + - *string* - The name of the toy. +- `icon` + - *number* - The icon texture (FileID). +- `isFavorite` + - *boolean* - Whether the toy is set to favorite. +- `hasFanfare` + - *boolean* - Shows a highlight for the toy. +- `itemQuality` + - *Enum.ItemQuality* \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetToyLink.md b/wiki-information/functions/C_ToyBox.GetToyLink.md new file mode 100644 index 00000000..cfbbda2b --- /dev/null +++ b/wiki-information/functions/C_ToyBox.GetToyLink.md @@ -0,0 +1,20 @@ +## Title: C_ToyBox.GetToyLink + +**Content:** +Returns the item link for a toy. +`C_ToyBox.GetToyLink(itemID)` + +**Parameters:** +- `itemID` + - *number* - Numeric ID of the item. + +**Returns:** +- `itemLink` + - *string?* - The toy's localized itemLink, or nil if that itemID is not a toy. + +**External Resources:** +- GitHub FrameXML +- GetheGlobe "wut?" Tool +- Townlong-YakBlizzard API Docs +- Townlong-YakOffline /api addon +- MrBuds \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md b/wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md new file mode 100644 index 00000000..a8d035f2 --- /dev/null +++ b/wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md @@ -0,0 +1,9 @@ +## Title: C_ToyBoxInfo.ClearFanfare + +**Content:** +Clears a fanfare for a toy. +`C_ToyBoxInfo.ClearFanfare(itemID)` + +**Parameters:** +- `itemID` + - *number* - The ID of the toy item to clear the fanfare for. \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md b/wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md new file mode 100644 index 00000000..b794e487 --- /dev/null +++ b/wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md @@ -0,0 +1,13 @@ +## Title: C_ToyBoxInfo.NeedsFanfare + +**Content:** +Returns whether a toy needs a fanfare. +`needsFanfare = C_ToyBoxInfo.NeedsFanfare(itemID)` + +**Parameters:** +- `itemID` + - *number* + +**Returns:** +- `needsFanfare` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CanPurchaseRank.md b/wiki-information/functions/C_Traits.CanPurchaseRank.md new file mode 100644 index 00000000..d55a4250 --- /dev/null +++ b/wiki-information/functions/C_Traits.CanPurchaseRank.md @@ -0,0 +1,21 @@ +## Title: C_Traits.CanPurchaseRank + +**Content:** +Checks whether a node entry is purchasable. +`canPurchase = C_Traits.CanPurchaseRank(configID, nodeID, nodeEntryID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* +- `nodeEntryID` + - *number* + +**Returns:** +- `canPurchase` + - *boolean* + +**Description:** +There is generally little value in calling this API, instead, you can call `C_Traits.PurchaseRank` or `C_Traits.SetSelection` directly, and check their return values. +Currently, the default UI only uses this API for profession nodes, to check whether unlocking a node, or spending points on the node is possible, and not for generic talents or class talents. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CanRefundRank.md b/wiki-information/functions/C_Traits.CanRefundRank.md new file mode 100644 index 00000000..f1c85b13 --- /dev/null +++ b/wiki-information/functions/C_Traits.CanRefundRank.md @@ -0,0 +1,15 @@ +## Title: C_Traits.CanRefundRank + +**Content:** +Needs summary. +`canRefund = C_Traits.CanRefundRank(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* + +**Returns:** +- `canRefund` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md b/wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md new file mode 100644 index 00000000..894cf80e --- /dev/null +++ b/wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md @@ -0,0 +1,16 @@ +## Title: C_Traits.CascadeRepurchaseRanks + +**Content:** +Needs summary. +`success = C_Traits.CascadeRepurchaseRanks(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* + +**Returns:** +- `success` + - *boolean* + diff --git a/wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md b/wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md new file mode 100644 index 00000000..7c165970 --- /dev/null +++ b/wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md @@ -0,0 +1,9 @@ +## Title: C_Traits.ClearCascadeRepurchaseHistory + +**Content:** +Needs summary. +`C_Traits.ClearCascadeRepurchaseHistory(configID)` + +**Parameters:** +- `configID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CommitConfig.md b/wiki-information/functions/C_Traits.CommitConfig.md new file mode 100644 index 00000000..5bdb7363 --- /dev/null +++ b/wiki-information/functions/C_Traits.CommitConfig.md @@ -0,0 +1,16 @@ +## Title: C_Traits.CommitConfig + +**Content:** +Applies any pending changes to talents. +`success = C_Traits.CommitConfig(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Reference:** +C_ClassTalents.CommitConfig should be used instead, when committing talent tree talents. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.ConfigHasStagedChanges.md b/wiki-information/functions/C_Traits.ConfigHasStagedChanges.md new file mode 100644 index 00000000..d16d1433 --- /dev/null +++ b/wiki-information/functions/C_Traits.ConfigHasStagedChanges.md @@ -0,0 +1,13 @@ +## Title: C_Traits.ConfigHasStagedChanges + +**Content:** +Needs summary. +`hasChanges = C_Traits.ConfigHasStagedChanges(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `hasChanges` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GenerateImportString.md b/wiki-information/functions/C_Traits.GenerateImportString.md new file mode 100644 index 00000000..15132c4d --- /dev/null +++ b/wiki-information/functions/C_Traits.GenerateImportString.md @@ -0,0 +1,62 @@ +## Title: C_Traits.GenerateImportString + +**Content:** +Generate a talent loadout string for a given loadout +`importString = C_Traits.GenerateImportString(configID)` + +**Parameters:** +- `configID` + - *number* - a talent loadout, e.g. from `C_ClassTalents.GetConfigIDsBySpecID` or simply `C_ClassTalents.GetActiveConfigID`. + +**Returns:** +- `importString` + - *string* - a talent loadout string, which can be used to import the loadout, can be sent to a friend, or used on external websites. An empty string is returned if the client can't find data for the loadout. + +**Description:** +No data is available until the first `TRAIT_CONFIG_LIST_UPDATED`. When reloading UI, data is available immediately. +This API works only for talent loadouts for the current character, but it does work for other specs. The returned string can be used in the Talent Tree UI to import the loadout, and its format has been documented by Blizzard in `Blizzard_ClassTalentImportExport.lua`. + +It's important to note that if you use this API with a loadout outside your current spec, the Specialization ID in the header will be incorrect, since that will always reflect your current spec instead. So you may want to change the header with code like this: + +```lua +-- note: this example is made for Serialization Version 1 specifically, and if Blizzard updates the format, this may no longer work +local bitWidthHeaderVersion = 8; +local bitWidthHeaderSpecID = 16; + +local function fixLoadoutString(loadoutString, specID) + local exportStream = ExportUtil.MakeExportDataStream(); + local importStream = ExportUtil.MakeImportDataStream(loadoutString); + + if importStream:ExtractValue(bitWidthHeaderVersion) ~= 1 then + return nil; -- only version 1 is supported + end + + local headerSpecID = importStream:ExtractValue(bitWidthHeaderSpecID); + if headerSpecID == specID then + return loadoutString; -- no update needed + end + + exportStream:AddValue(bitWidthHeaderVersion, 1); + exportStream:AddValue(bitWidthHeaderSpecID, specID); + local remainingBits = importStream:GetNumberOfBits() - bitWidthHeaderVersion - bitWidthHeaderSpecID; + + -- copy the remaining bits in batches of 16 + while remainingBits > 0 do + local bitsToCopy = math.min(remainingBits, 16); + exportStream:AddValue(bitsToCopy, importStream:ExtractValue(bitsToCopy)); + remainingBits = remainingBits - bitsToCopy; + end + + return exportStream:GetExportString(); +end + +local spec = 62; -- assuming you're playing mage +local configID = C_ClassTalents.GetConfigIDsBySpecID(specID); -- assuming you have an arcane loadout +print(fixLoadoutString(C_Traits.GenerateImportString(configID), specID)) +``` + +**Example Usage:** +This function can be used to share talent loadouts with friends or to save and import loadouts from external websites. For instance, you can generate a loadout string for your current talent configuration and send it to a friend who can then import it into their game. + +**Addons:** +Many popular addons like WeakAuras and ElvUI use similar APIs to manage and share configurations. This specific API can be used by talent management addons to facilitate the sharing and importing of talent builds. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GenerateInspectImportString.md b/wiki-information/functions/C_Traits.GenerateInspectImportString.md new file mode 100644 index 00000000..3ad16bb5 --- /dev/null +++ b/wiki-information/functions/C_Traits.GenerateInspectImportString.md @@ -0,0 +1,19 @@ +## Title: C_Traits.GenerateInspectImportString + +**Content:** +Returns a Talent Build String for an inspected target. +`importString = C_Traits.GenerateInspectImportString(target)` + +**Parameters:** +- `target` + - *string* : UnitId - For example "target" + +**Returns:** +- `importString` + - *string* - the Talent Build String, or an empty string if inspect information is not available + +**Description:** +You must first inspect a player before this API returns any data. After inspecting, you should use `C_Traits.HasValidInspectData` to confirm valid inspect data is available to the client. + +**Reference:** +`C_Traits.GenerateImportString` to retrieve Talent Build Strings for the current player character. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConditionInfo.md b/wiki-information/functions/C_Traits.GetConditionInfo.md new file mode 100644 index 00000000..8ac1931e --- /dev/null +++ b/wiki-information/functions/C_Traits.GetConditionInfo.md @@ -0,0 +1,70 @@ +## Title: C_Traits.GetConditionInfo + +**Content:** +Returns conditionInfo applicable to the configID you enter +`condInfo = C_Traits.GetConditionInfo(configID, condID)` + +**Parameters:** +- `configID` + - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. +- `condID` + - *number* - trait conditionId as found in e.g. `C_Traits.GetNodeInfo` or `C_Traits.GetEntryInfo` + +**Returns:** +- `condInfo` + - *TraitCondInfo* - returns nil if no info is found + - `Field` + - `Type` + - `Description` + - `condID` + - *number* - as supplied in the arguments + - `ranksGranted` + - *number?* - if the condition is met, this number of ranks is granted to applicable nodes + - `isAlwaysMet` + - *boolean* - generally false, no TraitConditions are currently used where this is true + - `isMet` + - *boolean* - whether the condition is met + - `isGate` + - *boolean* - whether the condition is a Gate - this generally only impacts tooltips and class talent trees + - `questID` + - *number?* - no conditions seem to currently exist with this value - presumably these would require a quest to be completed; or, less likely, require the quest to be in your questlog + - `achievementID` + - *number?* - condition is met if the achievement has been earned + - `specSetID` + - *number?* - condition is met if your spec matches any spec from the specified specSet (see `C_SpecializationInfo.GetSpecIDs`) + - `playerLevel` + - *number?* - condition is met if you are at or above the specified level + - `traitCurrencyID` + - *number?* - combined with spentAmountRequired - matches the ID in TraitCurrencyCost (see `C_Traits.GetNodeCost`, and `C_Traits.GetTreeCurrencyInfo`) + - `spentAmountRequired` + - *number?* - condition is met if you spent the specified amount in the specified traitCurrency + - `tooltipFormat` + - *string?* - a tooltip string, potentially with placeholders suitable for `string.format`, which can be displayed if the condition isn't met + - `tooltipText` + - *string?* - Blizzard_SharedTalentUI adds this data to the response manually, see `Blizzard_SharedTalentUtil.lua`; the data is based on tooltipFormat, and adds quest/achievement/spec/level/spending info + +**Description:** +Trait conditions have specific types. These types are not exposed in the API, but an enum is documented (`Enum.TraitConditionType`). +Conditions broadly fall into 2 categories, 'Friendly' and 'NotFriendly'. Friendly conditions give benefits, while NotFriendly conditions impose restrictions. + +**Enum.TraitConditionType:** +- `Value` +- `Field` +- `Category` +- `Description` + - `0` + - `Available` + - `NotFriendly` + - Nodes are available by default, but if any condition of this type is not met, then the node is not available - e.g. Gates are implemented this way + - `1` + - `Visible` + - `NotFriendly` + - Nodes are visible by default, but if any condition of this type is not met, then the node is not visible - e.g. if a condition requires a specific spec, the node will be hidden + - `2` + - `Granted` + - `Friendly` + - Grants rank(s) for the relevant node + - `3` + - `Increased` + - `Friendly` + - No condition of this type currently exists, presumably they work similar to Granted \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigIDBySystemID.md b/wiki-information/functions/C_Traits.GetConfigIDBySystemID.md new file mode 100644 index 00000000..95bd2fc9 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetConfigIDBySystemID.md @@ -0,0 +1,19 @@ +## Title: C_Traits.GetConfigIDBySystemID + +**Content:** +Needs summary. +`configID = C_Traits.GetConfigIDBySystemID(systemID)` + +**Parameters:** +- `systemID` + - *number* - The systems are defined in TraitSystem.db2. E.g. Dragonriding is 1 + +**Returns:** +- `configID` + - *number* + +**Example Usage:** +This function can be used to retrieve the configuration ID for a specific trait system. For instance, if you want to get the configuration ID for the Dragonriding system, you would call this function with the systemID corresponding to Dragonriding. + +**Addons:** +Large addons that manage or display trait systems, such as talent tree managers or custom UI enhancements, might use this function to dynamically load and display the correct configuration for different systems. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigIDByTreeID.md b/wiki-information/functions/C_Traits.GetConfigIDByTreeID.md new file mode 100644 index 00000000..05db24fa --- /dev/null +++ b/wiki-information/functions/C_Traits.GetConfigIDByTreeID.md @@ -0,0 +1,13 @@ +## Title: C_Traits.GetConfigIDByTreeID + +**Content:** +Used for "Generic Trait" trees, such as dragonflying talents. Not used for player talent trees. +`configID = C_Traits.GetConfigIDByTreeID(treeID)` + +**Parameters:** +- `treeID` + - *number* + +**Returns:** +- `configID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigInfo.md b/wiki-information/functions/C_Traits.GetConfigInfo.md new file mode 100644 index 00000000..763a4f65 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetConfigInfo.md @@ -0,0 +1,42 @@ +## Title: C_Traits.GetConfigInfo + +**Content:** +Needs summary. +`configInfo = C_Traits.GetConfigInfo(configID)` + +**Parameters:** +- `configID` + - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. + +**Returns:** +- `configInfo` + - *TraitConfigInfo* + - `Field` + - `Type` + - `Description` + - `ID` + - *number* - ConfigID + - `type` + - *Enum.TraitConfigType* + - `name` + - *string* - E.g. talent loadout name + - `treeIDs` + - *number* - Can be used in e.g. `C_Traits.GetTreeNodes` or `C_Traits.GetTreeInfo` + - `usesSharedActionBars` + - *boolean* - Whether the talent loadout uses shared/global action bar setup, or loadout specific setup + +**Enum.TraitConfigType:** +- `Value` +- `Field` +- `Description` + - `0` + - Invalid + - `1` + - Combat + - Talent Tree + - `2` + - Profession + - Profession Specialization + - `3` + - Generic + - E.g. Dragon Riding talents \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigsByType.md b/wiki-information/functions/C_Traits.GetConfigsByType.md new file mode 100644 index 00000000..459a4d32 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetConfigsByType.md @@ -0,0 +1,20 @@ +## Title: C_Traits.GetConfigsByType + +**Content:** +Needs summary. +`configIDs = C_Traits.GetConfigsByType(configType)` + +**Parameters:** +- `configType` + - *Enum.TraitConfigType* + - `Value` + - `Field` + - `Description` + - `0` - Invalid + - `1` - Combat (Talent Tree) + - `2` - Profession (Profession Specialization) + - `3` - Generic (E.g. Dragon Riding talents) + +**Returns:** +- `configIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetDefinitionInfo.md b/wiki-information/functions/C_Traits.GetDefinitionInfo.md new file mode 100644 index 00000000..cfb87350 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetDefinitionInfo.md @@ -0,0 +1,44 @@ +## Title: C_Traits.GetDefinitionInfo + +**Content:** +Needs summary. +`definitionInfo = C_Traits.GetDefinitionInfo(definitionID)` + +**Parameters:** +- `definitionID` + - *number* + +**Returns:** +- `definitionInfo` + - *TraitDefinitionInfo* + - `Field` + - `Type` + - `Description` + - `spellID` + - *number?* + - `overrideName` + - *string?* + - `overrideSubtext` + - *string?* + - `overrideDescription` + - *string?* + - `overrideIcon` + - *number?* + - `overriddenSpellID` + - *number?* + - `subType` + - *Enum.TraitDefinitionSubType?* + - **Enum.TraitDefinitionSubType** + - `Value` + - `Field` + - `Description` + - `0` + - DragonflightRed + - `1` + - DragonflightBlue + - `2` + - DragonflightGreen + - `3` + - DragonflightBronze + - `4` + - DragonflightBlack \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetEntryInfo.md b/wiki-information/functions/C_Traits.GetEntryInfo.md new file mode 100644 index 00000000..8730bd4a --- /dev/null +++ b/wiki-information/functions/C_Traits.GetEntryInfo.md @@ -0,0 +1,52 @@ +## Title: C_Traits.GetEntryInfo + +**Content:** +Needs summary. +`entryInfo = C_Traits.GetEntryInfo(configID, entryID)` + +**Parameters:** +- `configID` + - *number* +- `entryID` + - *number* + +**Returns:** +- `entryInfo` + - *TraitEntryInfo* + - `Field` + - `Type` + - `Description` + - `definitionID` + - *number* + - `type` + - *Enum.TraitNodeEntryType* + - `maxRanks` + - *number* + - `isAvailable` + - *boolean* + - `conditionIDs` + - *number* + +**Enum.TraitNodeEntryType Values:** +- `Field` +- `Description` +- `0` + - SpendHex +- `1` + - SpendSquare +- `2` + - SpendCircle +- `3` + - SpendSmallCircle +- `4` + - DeprecatedSelect +- `5` + - DragAndDrop +- `6` + - SpendDiamond +- `7` + - ProfPath +- `8` + - ProfPerk +- `9` + - ProfPathUnlock \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md b/wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md new file mode 100644 index 00000000..ae0d3e61 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md @@ -0,0 +1,13 @@ +## Title: C_Traits.GetLoadoutSerializationVersion + +**Content:** +Returns the version of the Talent Build String format. +`serializationVersion = C_Traits.GetLoadoutSerializationVersion()` + +**Returns:** +- `serializationVersion` + - *number* + +**Description:** +The Talent Build String is encoded with a header, this header contains the version of the format. If the build string's version doesn't match the return from this API, the game will not attempt to parse the string any further. +Currently, this is simply 1, it is assumed that Blizzard will increase the version number to 2 if they make any changes to the format of their Talent Build Strings. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetNodeCost.md b/wiki-information/functions/C_Traits.GetNodeCost.md new file mode 100644 index 00000000..97f9e2ed --- /dev/null +++ b/wiki-information/functions/C_Traits.GetNodeCost.md @@ -0,0 +1,22 @@ +## Title: C_Traits.GetNodeCost + +**Content:** +Needs summary. +`costs = C_Traits.GetNodeCost(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* + +**Returns:** +- `costs` + - *TraitCurrencyCost* + - `Field` + - `Type` + - `Description` + - `ID` + - *number* - TraitCurrencyID, see `C_Traits.GetTraitCurrencyInfo` and `C_Traits.GetTreeCurrencyInfo` + - `amount` + - *number* - the amount of TraitCurrency a given node/entry costs \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetNodeInfo.md b/wiki-information/functions/C_Traits.GetNodeInfo.md new file mode 100644 index 00000000..bf72ab39 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetNodeInfo.md @@ -0,0 +1,121 @@ +## Title: C_Traits.GetNodeInfo + +**Content:** +Returns NodeInfo applicable to the configID you enter. +`nodeInfo = C_Traits.GetNodeInfo(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. +- `nodeID` + - *number* - e.g. from `C_Traits.GetTreeNodes` + +**Returns:** +- `nodeInfo` + - *TraitNodeInfo?* - if the configID is not valid, returns nil. If information for a node cannot be retrieved for another reason, all fields are zeroed out. Most information relates to your current preview state, unless otherwise specified + - `Field` + - `Type` + - `Description` + - `ID` + - *number* - nodeID, 0 if node information isn't available to you + - `posX` + - *number* - X offset relative to the top-left corner of the UI, some class talent trees have an additional global offset + - `posY` + - *number* - Y offset relative to the top-left corner of the UI, some class talent trees have an additional global offset + - `flags` + - *number* - &1: ShowMultipleIcons - generally 0 for regular nodes, 1 for choice nodes + - `entryIDs` + - *number* - List of entryIDs - generally there is 1 for regular nodes, 2 for choice nodes; used in `C_Traits.GetEntryInfo` + - `entryIDsWithCommittedRanks` + - *number* - Committed entryIDs, which can be different from the preview state. E.g. moving talents/traits around, without pressing the confirm button, will not change this value + - `canPurchaseRank` + - *boolean* - False if you already have the max ranks purchased / granted; true otherwise + - `canRefundRank` + - *boolean* - False if you purchased 0 ranks; true otherwise + - `isAvailable` + - *boolean* - False if not available due to Gates (i.e. you may need to spend x more points to unlock a new row of traits/talents) + - `isVisible` + - *boolean* - False if a node should not be shown in the UI, this generally only happens when all other info is zeroed out as well + - `ranksPurchased` + - *number* - Number of ranks purchased, automatically granted ranks do not count + - `activeRank` + - *number* - The current (preview) rank for the node - used to track if the node is maxed, or has progress; this can never be greater than maxRanks + - `currentRank` + - *number* - Similar to activeRank - used for tooltips and other texts; through bugs, it can be possible for this to be greater than maxRanks, seems to be the sum of GrantedRanks + PurchasedRanks + - `activeEntry` + - *TraitEntryRankInfo?* - The currently selected (preview) entry; if no entry is learned, regular nodes have an entry with rank 0, choice nodes have nil; the rank matches activeRank + - `nextEntry` + - *TraitEntryRankInfo?* - The next entry when spending a point; nil for choice nodes, or if maxed + - `maxRanks` + - *number* - Maximum ranks for a node, also applies to choice nodes + - `type` + - *Enum.TraitNodeType* - The type of node, has implications for how the API interacts with the node, and how the UI displays and interacts with the node + - `visibleEdges` + - *TraitOutEdgeInfo* - Outgoing connections for a node, filtered to only return edges with a visible target node - the UI displays these as arrows pointing towards other nodes + - `meetsEdgeRequirements` + - *boolean* - True if incoming edge requirements are met (see `Enum.TraitEdgeType`), or if there are no incoming edges (i.e. the initial nodes in a tree), false otherwise - the UI uses this to disable the node button + - `groupIDs` + - *number* - TraitNodeGroups are not generally exposed through the API, but they relate to how Gates work, TraitCurrency costs, TraitConditions, and possibly more + - `conditionIDs` + - *number* - Can be used for `C_Traits.GetConditionInfo` conditions can grant ranks, limit visibility to specs, set Gate requirements, and more + - `isCascadeRepurchasable` + - *boolean* - If true, you can shift-click to purchase back nodes that you previously had selected, but were deselected because you unlearned something higher up in the tree + - `cascadeRepurchaseEntryID` + - *number?* - TraitEntryRankInfo + - `Field` + - `Type` + - `Description` + - `entryID` + - *number* - As used in `C_Traits.GetEntryInfo` + - `rank` + - *number* - May be 0 for single choice nodes + +**Enum.TraitNodeType** +- `Value` +- `Field` +- `Description` +- `0` + - Single - The most common type, includes multi-rank traits and single-rank traits +- `1` + - Tiered - Unsure where this is used, but seems to result in the node and nodeEntry costs being combined in some way +- `2` + - Selection - Applies to all choice nodes, where you can select between multiple (generally 2) options + +**TraitOutEdgeInfo** +- `Field` +- `Type` +- `Description` +- `targetNode` + - *number* - The target nodeID +- `type` + - *Enum.TraitEdgeType* - Has implications on how meetsEdgeRequirements is calculated +- `visualStyle` + - *Enum.TraitEdgeVisualStyle* - Defines how the UI displays the edge +- `isActive` + - *boolean* - Active edges generally have a different visual, and meetsEdgeRequirements is calculated based on active incoming edges + +**Enum.TraitEdgeType** +- `Value` +- `Field` +- `Description` +- `0` + - VisualOnly - Simply results in a visual connection, has no impact on edge requirements +- `1` + - DeprecatedRankConnection - Presumably deprecated, and can be ignored +- `2` + - SufficientForAvailability - If any incoming edge of this type is active, all edges of this type pass the edge requirements +- `3` + - RequiredForAvailability - All incoming edges of this type must be active to pass the edge requirements +- `4` + - MutuallyExclusive - No edges of this type currently exist, but the UI does show a different visual effect - presumably, only 1 incoming edge if this type is allowed to be active, to pass the edge requirements +- `5` + - DeprecatedSelectionOption - Presumably deprecated, and can be ignored + +**Enum.TraitEdgeVisualStyle** +- `Value` +- `Field` +- `Description` +- `0` + - None - No edges of this type exist, presumably, they would not display in the UI +- `1` + - Straight - A simple straight arrow between nodes \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetStagedChangesCost.md b/wiki-information/functions/C_Traits.GetStagedChangesCost.md new file mode 100644 index 00000000..8bff095a --- /dev/null +++ b/wiki-information/functions/C_Traits.GetStagedChangesCost.md @@ -0,0 +1,20 @@ +## Title: C_Traits.GetStagedChangesCost + +**Content:** +Needs summary. +`costs = C_Traits.GetStagedChangesCost(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `costs` + - *TraitCurrencyCost* + - `Field` + - `Type` + - `Description` + - `ID` + - *number* - TraitCurrencyID, see `C_Traits.GetTraitCurrencyInfo` and `C_Traits.GetTreeCurrencyInfo` + - `amount` + - *number* - the amount of TraitCurrency a given node/entry costs \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetStagedPurchases.md b/wiki-information/functions/C_Traits.GetStagedPurchases.md new file mode 100644 index 00000000..22460e5f --- /dev/null +++ b/wiki-information/functions/C_Traits.GetStagedPurchases.md @@ -0,0 +1,13 @@ +## Title: C_Traits.GetStagedPurchases + +**Content:** +Needs summary. +`nodeIDsWithPurchases = C_Traits.GetStagedPurchases(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `nodeIDsWithPurchases` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md b/wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md new file mode 100644 index 00000000..23e01b80 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md @@ -0,0 +1,52 @@ +## Title: C_Traits.GetTraitCurrencyInfo + +**Content:** +Returns meta information about a TraitCurrency. Use `C_Traits.GetTreeCurrencyInfo` if you're looking for TraitCurrency spent/available instead. +```lua +flags, type, currencyTypesID, icon = C_Traits.GetTraitCurrencyInfo(traitCurrencyID) +``` + +**Parameters:** +- `traitCurrencyID` + - *number* + +**Returns:** +- `flags` + - *number* - any combination of bit flags of `Enum.TraitCurrencyFlag` +- `type` + - *Enum.TraitCurrencyFlag* - indicates how the TraitCurrency is sourced +- `currencyTypesID` + - *number?* - CurrencyID, if non-empty, the TraitCurrency is directly linked to the specified Currency +- `icon` + - *number?* - IconID + +**Enum.TraitCurrencyFlag:** +- `Value` +- `Field` +- `Description` + - `0x1` + - `ShowQuantityAsSpent` + - Currently not used by any TraitCurrency + - `0x2` + - `TraitSourcedShowMax` + - Currently not used by any TraitCurrency + - `0x4` + - `UseClassIcon` + - Currently, all currencies with this flag are TalentTree class talent points + - `0x8` + - `UseSpecIcon` + - Currently, all currencies with this flag are TalentTree spec talent points + +**Enum.TraitCurrencyType:** +- `Value` +- `Field` +- `Description` + - `0` + - `Gold` + - Currency used is gold + - `1` + - `CurrencyTypesBased` + - TraitCurrencies of this type will spend regular CurrencyID, see `currencyTypesID` return value + - `2` + - `TraitSourced` + - This TraitCurrency can be earned through being above a certain level (e.g. for talent points), earning achievements (e.g. for some profession unlocks, or dragon riding), or by spending points in another TraitNode (e.g. profession unlocks). See `TraitCurrencySource.db2` \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitDescription.md b/wiki-information/functions/C_Traits.GetTraitDescription.md new file mode 100644 index 00000000..f77e66a6 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTraitDescription.md @@ -0,0 +1,15 @@ +## Title: C_Traits.GetTraitDescription + +**Content:** +Needs summary. +`description = C_Traits.GetTraitDescription(entryID, rank)` + +**Parameters:** +- `entryID` + - *number* +- `rank` + - *number* + +**Returns:** +- `description` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitSystemFlags.md b/wiki-information/functions/C_Traits.GetTraitSystemFlags.md new file mode 100644 index 00000000..f5745c9d --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTraitSystemFlags.md @@ -0,0 +1,26 @@ +## Title: C_Traits.GetTraitSystemFlags + +**Content:** +Returns flags for "Generic Trait" trees, such as dragonriding talents. Not related to player talent trees. +`flags = C_Traits.GetTraitSystemFlags(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `flags` + - *number* - See `Enum.TraitSystemFlag` + +**Description:** +This function is used to retrieve flags associated with generic trait systems, which are different from the player talent trees. An example of such a system is the dragonriding talents. The flags returned can be used to determine specific properties or states of the trait system. + +**Example Usage:** +```lua +local configID = 12345 -- Example config ID for a dragonriding talent tree +local flags = C_Traits.GetTraitSystemFlags(configID) +print(flags) -- Outputs the flags associated with the given config ID +``` + +**Addons:** +Large addons that manage or enhance talent systems, such as WeakAuras or ElvUI, might use this function to display or modify information related to generic trait systems like dragonriding talents. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md b/wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md new file mode 100644 index 00000000..6e0b4d31 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md @@ -0,0 +1,13 @@ +## Title: C_Traits.GetTraitSystemWidgetSetID + +**Content:** +Needs summary. +`uiWidgetSetID = C_Traits.GetTraitSystemWidgetSetID(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `uiWidgetSetID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md b/wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md new file mode 100644 index 00000000..d9f1720a --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md @@ -0,0 +1,28 @@ +## Title: C_Traits.GetTreeCurrencyInfo + +**Content:** +Returns the list of TraitCurrencies related to a TraitTree. +`treeCurrencyInfo = C_Traits.GetTreeCurrencyInfo(configID, treeID, excludeStagedChanges)` + +**Parameters:** +- `configID` + - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. +- `treeID` + - *number* - For TalentTrees a class-specific TreeID, for professions `C_ProfSpecs.GetSpecTabIDsForSkillLine`. +- `excludeStagedChanges` + - *boolean* - If true, the committed value is returned; if false, the staged value is returned instead. + +**Returns:** +- `treeCurrencyInfo` + - *TreeCurrencyInfo* - For TalentTrees, the first currency returned is for the class points, the second currency is spec points. + - `Field` + - `Type` + - `Description` + - `traitCurrencyID` + - *number* - Can be used in e.g. `C_Traits.GetNodeCost` and `C_Traits.GetTraitCurrencyInfo` + - `quantity` + - *number* - How much currency is available to be used, e.g. available talent points, or profession knowledge. + - `maxQuantity` + - *number?* - For TalentTrees, the amount of points available at your current level. + - `spent` + - *number* - The amount of currency already spent on traits. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeHash.md b/wiki-information/functions/C_Traits.GetTreeHash.md new file mode 100644 index 00000000..ad15e782 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTreeHash.md @@ -0,0 +1,18 @@ +## Title: C_Traits.GetTreeHash + +**Content:** +Get a checksum of the specified tree's structure. +`result = C_Traits.GetTreeHash(treeID)` + +**Parameters:** +- `treeID` + - *number* + +**Returns:** +- `result` + - *number* - 16 numbers between 1 and 256 + +**Description:** +The default UI uses this checksum to check whether a talent string was created based on a different talent layout. The hash can be expected to change if any talents are changed. +It's important to realize that the hash does not cover any player choices; its only purpose is to determine if a talent string corresponds to a valid tree. +Third-party websites will use a table with 16 zeroes instead, to disable this specific validation step. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeInfo.md b/wiki-information/functions/C_Traits.GetTreeInfo.md new file mode 100644 index 00000000..0fde3771 --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTreeInfo.md @@ -0,0 +1,33 @@ +## Title: C_Traits.GetTreeInfo + +**Content:** +Needs summary. +`treeInfo = C_Traits.GetTreeInfo(configID, treeID)` + +**Parameters:** +- `configID` + - *number* +- `treeID` + - *number* + +**Returns:** +- `treeInfo` + - *TraitTreeInfo* + - `Field` + - `Type` + - `Description` + - `ID` + - *number* + - `gates` + - *TraitGateInfo* + - `hideSingleRankNumbers` + - *boolean* + +**TraitGateInfo** +- `Field` +- `Type` +- `Description` +- `topLeftNodeID` + - *number* +- `conditionID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeNodes.md b/wiki-information/functions/C_Traits.GetTreeNodes.md new file mode 100644 index 00000000..e0a7fb8d --- /dev/null +++ b/wiki-information/functions/C_Traits.GetTreeNodes.md @@ -0,0 +1,19 @@ +## Title: C_Traits.GetTreeNodes + +**Content:** +Returns a list of nodeIDs for a given treeID. For talent trees, this contains nodes for all specializations of the tree's class. +`nodeIDs = C_Traits.GetTreeNodes(treeID)` + +**Parameters:** +- `treeID` + - *number* - e.g. from `C_Traits.GetConfigInfo` + +**Returns:** +- `nodeIDs` + - *number* - list of nodeIDs in ascending order, can be used in `C_Traits.GetNodeInfo` + +**Example Usage:** +This function can be used to retrieve all node IDs for a specific talent tree, which can then be further queried for detailed node information using `C_Traits.GetNodeInfo`. + +**Addons:** +Large addons like WeakAuras might use this function to dynamically display talent tree information and track changes in a player's talent configuration. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.HasValidInspectData.md b/wiki-information/functions/C_Traits.HasValidInspectData.md new file mode 100644 index 00000000..43840e5a --- /dev/null +++ b/wiki-information/functions/C_Traits.HasValidInspectData.md @@ -0,0 +1,9 @@ +## Title: C_Traits.HasValidInspectData + +**Content:** +Needs summary. +`hasValidInspectData = C_Traits.HasValidInspectData()` + +**Returns:** +- `hasValidInspectData` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.IsReadyForCommit.md b/wiki-information/functions/C_Traits.IsReadyForCommit.md new file mode 100644 index 00000000..891643df --- /dev/null +++ b/wiki-information/functions/C_Traits.IsReadyForCommit.md @@ -0,0 +1,9 @@ +## Title: C_Traits.IsReadyForCommit + +**Content:** +Needs summary. +`isReadyForCommit = C_Traits.IsReadyForCommit()` + +**Returns:** +- `isReadyForCommit` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.PurchaseRank.md b/wiki-information/functions/C_Traits.PurchaseRank.md new file mode 100644 index 00000000..ae68232f --- /dev/null +++ b/wiki-information/functions/C_Traits.PurchaseRank.md @@ -0,0 +1,18 @@ +## Title: C_Traits.PurchaseRank + +**Content:** +Attempt to purchase a rank. Changes are not applied until they are committed (through `C_Traits.CommitConfig` or `C_ClassTalents.CommitConfig`). +`success = C_Traits.PurchaseRank(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Reference:** +`C_Traits.SetSelection` to purchase/select a Selection node. `C_Traits.PurchaseRank` should not be used with selection nodes (aka choice nodes). \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.RefundAllRanks.md b/wiki-information/functions/C_Traits.RefundAllRanks.md new file mode 100644 index 00000000..c32d0eb6 --- /dev/null +++ b/wiki-information/functions/C_Traits.RefundAllRanks.md @@ -0,0 +1,34 @@ +## Title: C_Traits.RefundAllRanks + +**Content:** +Needs summary. +`success = C_Traits.RefundAllRanks(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Description:** +This function is used to refund all ranks for a specific node in a given configuration. It can be useful in scenarios where a player wants to reset their trait points and reallocate them differently. + +**Example Usage:** +```lua +local configID = 12345 +local nodeID = 67890 +local success = C_Traits.RefundAllRanks(configID, nodeID) +if success then + print("All ranks have been successfully refunded.") +else + print("Failed to refund ranks.") +end +``` + +**Addons Using This Function:** +- **WeakAuras**: This popular addon might use this function to allow players to reset their trait points and reconfigure their abilities based on different scenarios or encounters. +- **ElvUI**: Another widely used addon that could leverage this function to provide users with an easy way to reset and reallocate their trait points within the UI. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.RefundRank.md b/wiki-information/functions/C_Traits.RefundRank.md new file mode 100644 index 00000000..09ec240e --- /dev/null +++ b/wiki-information/functions/C_Traits.RefundRank.md @@ -0,0 +1,23 @@ +## Title: C_Traits.RefundRank + +**Content:** +Attempt to refund a rank. Changes are not applied until they are committed (through `C_Traits.CommitConfig` or `C_ClassTalents.CommitConfig`). +`success = C_Traits.RefundRank(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* +- `clearEdges` + - *boolean?* - if true, refunding the talent will refund all talents that no longer meet their requirements + +**Returns:** +- `success` + - *boolean* + +**Description:** +If you pass `clearEdges = true`, it's possible that refunding a node results in other nodes being refunded too. E.g. if you no longer meet a gate criterium, or if the node is the only path to a set of selected talents. + +**Reference:** +- `C_Traits.SetSelection` to unselect a Selection node. `C_Traits.RefundRank` must not be used with selection nodes (aka choice nodes). \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.ResetTree.md b/wiki-information/functions/C_Traits.ResetTree.md new file mode 100644 index 00000000..8692ac5a --- /dev/null +++ b/wiki-information/functions/C_Traits.ResetTree.md @@ -0,0 +1,35 @@ +## Title: C_Traits.ResetTree + +**Content:** +Resets the tree, refunding any purchased traits where possible. The reset is not automatically saved, use `C_Traits.CommitConfig` for that. +`success = C_Traits.ResetTree(configID, treeID)` + +**Parameters:** +- `configID` + - *number* +- `treeID` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Description:** +This function is used to reset a talent tree, refunding any purchased traits. It is important to note that the reset is not automatically saved, so you must use `C_Traits.CommitConfig` to save the changes. + +**Example Usage:** +```lua +local configID = 12345 +local treeID = 67890 +local success = C_Traits.ResetTree(configID, treeID) +if success then + print("Tree reset successfully!") + C_Traits.CommitConfig(configID) +else + print("Failed to reset the tree.") +end +``` + +**Addons Using This Function:** +- **WeakAuras**: This popular addon uses `C_Traits.ResetTree` to manage and reset custom talent configurations for different encounters or scenarios. +- **ElvUI**: This comprehensive UI replacement addon may use this function to reset talent trees as part of its configuration management features. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.ResetTreeByCurrency.md b/wiki-information/functions/C_Traits.ResetTreeByCurrency.md new file mode 100644 index 00000000..ac27cf7f --- /dev/null +++ b/wiki-information/functions/C_Traits.ResetTreeByCurrency.md @@ -0,0 +1,20 @@ +## Title: C_Traits.ResetTreeByCurrency + +**Content:** +Resets the tree, refunding any purchased traits where possible, but only if the trait costs the specified traitCurrencyID. +`success = C_Traits.ResetTreeByCurrency(configID, treeID, traitCurrencyID)` + +**Parameters:** +- `configID` + - *number* +- `treeID` + - *number* +- `traitCurrencyID` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Description:** +This API is used to reset only class talents, or only spec talents, rather than resetting the entire tree with `C_Traits.ResetTree`. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.RollbackConfig.md b/wiki-information/functions/C_Traits.RollbackConfig.md new file mode 100644 index 00000000..f8633151 --- /dev/null +++ b/wiki-information/functions/C_Traits.RollbackConfig.md @@ -0,0 +1,13 @@ +## Title: C_Traits.RollbackConfig + +**Content:** +Rolls back any pending changes to the trait config - reverting any unsaved changes. +`success = C_Traits.RollbackConfig(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `success` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.SetSelection.md b/wiki-information/functions/C_Traits.SetSelection.md new file mode 100644 index 00000000..05422770 --- /dev/null +++ b/wiki-information/functions/C_Traits.SetSelection.md @@ -0,0 +1,23 @@ +## Title: C_Traits.SetSelection + +**Content:** +Attempt to change the current selection for a selection node (aka choice node). Changes are not applied until they are committed (through `C_Traits.CommitConfig` or `C_ClassTalents.CommitConfig`). +`success = C_Traits.SetSelection(configID, nodeID)` + +**Parameters:** +- `configID` + - *number* +- `nodeID` + - *number* +- `nodeEntryID` + - *number?* - pass nil to unselect the node, effectively the equivalent of `C_Traits.RefundRank`. +- `clearEdges` + - *boolean?* - if true, unselecting the node will refund all talents that no longer meet their requirements + +**Returns:** +- `success` + - *boolean* + +**Description:** +This API can be used to set the initial selection, change a selection, or unselect a selection node (aka choice node). Passing `clearEdges = true`, and unselecting a selection node, may result in other talents being refunded, e.g., if you no longer meet a gate criterion, or if the selection node is the only path to a set of selected talents. +You should not use the `C_Traits.PurchaseRank` or `C_Traits.RefundRank` APIs on selection nodes. `C_Traits.SetSelection` is the only API used to modify selection node choices. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.StageConfig.md b/wiki-information/functions/C_Traits.StageConfig.md new file mode 100644 index 00000000..3fe60e43 --- /dev/null +++ b/wiki-information/functions/C_Traits.StageConfig.md @@ -0,0 +1,30 @@ +## Title: C_Traits.StageConfig + +**Content:** +Needs summary. +`success = C_Traits.StageConfig(configID)` + +**Parameters:** +- `configID` + - *number* + +**Returns:** +- `success` + - *boolean* + +**Description:** +This function stages a configuration for traits. The `configID` parameter is the unique identifier for the configuration you want to stage. The function returns a boolean indicating whether the staging was successful. + +**Example Usage:** +```lua +local configID = 12345 +local success = C_Traits.StageConfig(configID) +if success then + print("Configuration staged successfully.") +else + print("Failed to stage configuration.") +end +``` + +**Addons Using This Function:** +Large addons that manage character traits or configurations, such as WeakAuras or ElvUI, might use this function to stage trait configurations before applying them. This ensures that the configuration is valid and can be applied without errors. \ No newline at end of file diff --git a/wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md b/wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md new file mode 100644 index 00000000..c4f034b5 --- /dev/null +++ b/wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md @@ -0,0 +1,9 @@ +## Title: C_UI.DoesAnyDisplayHaveNotch + +**Content:** +True if any display attached has a notch. This does not mean the current view intersects the notch. +`notchPresent = C_UI.DoesAnyDisplayHaveNotch()` + +**Returns:** +- `notchPresent` + - *boolean* - True if any display attached has a notch. \ No newline at end of file diff --git a/wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md b/wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md new file mode 100644 index 00000000..725324fe --- /dev/null +++ b/wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md @@ -0,0 +1,15 @@ +## Title: C_UI.GetTopLeftNotchSafeRegion + +**Content:** +Region of screen left of screen notch. Zeros if no notch. +`left, right, top, bottom = C_UI.GetTopLeftNotchSafeRegion()` + +**Returns:** +- `left` + - *number* +- `right` + - *number* +- `top` + - *number* +- `bottom` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md b/wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md new file mode 100644 index 00000000..516cbe89 --- /dev/null +++ b/wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md @@ -0,0 +1,15 @@ +## Title: C_UI.GetTopRightNotchSafeRegion + +**Content:** +Region of screen right of screen notch. Zeros if no notch. +`left, right, top, bottom = C_UI.GetTopRightNotchSafeRegion()` + +**Returns:** +- `left` + - *number* +- `right` + - *number* +- `top` + - *number* +- `bottom` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UI.Reload.md b/wiki-information/functions/C_UI.Reload.md new file mode 100644 index 00000000..18d15010 --- /dev/null +++ b/wiki-information/functions/C_UI.Reload.md @@ -0,0 +1,15 @@ +## Title: C_UI.Reload + +**Content:** +Reloads the User Interface. +`C_UI.Reload()` + +**Description:** +Reloading the interface saves the current settings to disk, and updates any addon files previously loaded by the game. In order to load new files (or addons), the game must be restarted. +You can also use the `/reload` slash command; or the console equivalent: `/console ReloadUI`. + +**Example Usage:** +This function is commonly used by addon developers to quickly test changes to their addons without needing to restart the game. For instance, after modifying an addon's Lua or XML files, calling `C_UI.Reload()` will apply those changes immediately. + +**Popular Addons Using This Function:** +Many popular addons, such as ElvUI and WeakAuras, provide a button or command to reload the UI, leveraging this function to help users apply configuration changes or updates without restarting the game. \ No newline at end of file diff --git a/wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md b/wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md new file mode 100644 index 00000000..68a49459 --- /dev/null +++ b/wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md @@ -0,0 +1,9 @@ +## Title: C_UI.ShouldUIParentAvoidNotch + +**Content:** +UIParent will shift down to avoid notch if true. This does not mean there is a notch. +`willAvoidNotch = C_UI.ShouldUIParentAvoidNotch()` + +**Returns:** +- `willAvoidNotch` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_UIColor.GetColors.md b/wiki-information/functions/C_UIColor.GetColors.md new file mode 100644 index 00000000..943682d5 --- /dev/null +++ b/wiki-information/functions/C_UIColor.GetColors.md @@ -0,0 +1,19 @@ +## Title: C_UIColor.GetColors + +**Content:** +Returns a list of UI colors to be imported into the global environment on login. +`colors = C_UIColor.GetColors()` + +**Returns:** +- `colors` + - *DBColorExport* - A list of UI color structures. + - `Field` + - `Type` + - `Description` + - `baseTag` + - *string* - The global name to associate with this color. + - `color` + - *ColorMixin* - The color data. + +**Description:** +UI colors are stored within the global color client database. \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md b/wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md new file mode 100644 index 00000000..74b29b74 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md @@ -0,0 +1,78 @@ +## Title: C_UIWidgetManager.GetAllWidgetsBySetID + +**Content:** +Returns all widgets for a widget set ID. +`widgets = C_UIWidgetManager.GetAllWidgetsBySetID(setID)` + +**Parameters:** +- `setID` + - *number* : UiWidgetSetID + +**ID Location Function:** +- `1` - `C_UIWidgetManager.GetTopCenterWidgetSetID()` +- `2` - `C_UIWidgetManager.GetBelowMinimapWidgetSetID()` +- `240` - `C_UIWidgetManager.GetObjectiveTrackerWidgetSetID()` +- `283` - `C_UIWidgetManager.GetPowerBarWidgetSetID()` + +**Returns:** +- `widgets` + - *UIWidgetInfo* + - `Field` + - `Type` + - `Description` + - `widgetID` + - *number* - UiWidget.db2 + - `widgetSetID` + - *number* - UiWidgetSetID + - `widgetType` + - *Enum.UIWidgetVisualizationType* + - `unitToken` + - *string?* - UnitId; Added in 9.0.1 + +**Enum.UIWidgetVisualizationType:** +- `Value` - `Key` - `Data Function` - `Description` +- `0` - `IconAndText` - `C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo` +- `1` - `CaptureBar` - `C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo` +- `2` - `StatusBar` - `C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo` +- `3` - `DoubleStatusBar` - `C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo` +- `4` - `IconTextAndBackground` - `C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo` +- `5` - `DoubleIconAndText` - `C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo` +- `6` - `StackedResourceTracker` - `C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo` +- `7` - `IconTextAndCurrencies` - `C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo` +- `8` - `TextWithState` - `C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo` +- `9` - `HorizontalCurrencies` - `C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo` +- `10` - `BulletTextList` - `C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo` +- `11` - `ScenarioHeaderCurrenciesAndBackground` - `C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo` +- `12` - `TextureAndText` - `C_UIWidgetManager.GetTextureAndTextVisualizationInfo` (Added in 8.2.0) +- `13` - `SpellDisplay` - `C_UIWidgetManager.GetSpellDisplayVisualizationInfo` (Added in 8.1.0) +- `14` - `DoubleStateIconRow` - `C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo` (Added in 8.1.5) +- `15` - `TextureAndTextRow` - `C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo` (Added in 8.2.0) +- `16` - `ZoneControl` - `C_UIWidgetManager.GetZoneControlVisualizationInfo` (Added in 8.2.0) +- `17` - `CaptureZone` - `C_UIWidgetManager.GetCaptureZoneVisualizationInfo` (Added in 8.2.5) +- `18` - `TextureWithAnimation` - `C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo` (Added in 9.0.1) +- `19` - `DiscreteProgressSteps` - `C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo` (Added in 9.0.1) +- `20` - `ScenarioHeaderTimer` - `C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo` (Added in 9.0.1) +- `21` - `TextColumnRow` - `C_UIWidgetManager.GetTextColumnRowVisualizationInfo` (Added in 9.1.0) +- `22` - `Spacer` - `C_UIWidgetManager.GetSpacerVisualizationInfo` (Added in 9.1.0) +- `23` - `UnitPowerBar` - `C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo` (Added in 9.2.0) +- `24` - `FillUpFrames` - `C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo` (Added in 10.0.0) +- `25` - `TextWithSubtext` - `C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo` (Added in 10.0.2) +- `26` - `WorldLootObject` (Added in 10.1.0) +- `27` - `ItemDisplay` - `C_UIWidgetManager.GetItemDisplayVisualizationInfo` (Added in 10.1.0) + +**Usage:** +Prints all UI widget IDs for the top center part of the screen, e.g. on Warsong Gulch: +```lua +local topCenter = C_UIWidgetManager.GetTopCenterWidgetSetID() +local widgets = C_UIWidgetManager.GetAllWidgetsBySetID(topCenter) +for _, w in pairs(widgets) do + print(w.widgetType, w.widgetID) +end +-- Output: +-- 0, 6 -- IconAndText, VisID 3: Icon And Text: No Texture Kit +-- 3, 2 -- DoubleStatusBar, VisID 1197: PvP - CTF - Double Status Bar +-- 14, 1640 -- DoubleStateIconRow, VisID 1201: PvP - CTF - Flag Status +``` + +**Reference:** +`UPDATE_UI_WIDGET` \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md b/wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md new file mode 100644 index 00000000..4de05ac6 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md @@ -0,0 +1,19 @@ +## Title: C_UIWidgetManager.GetBelowMinimapWidgetSetID + +**Content:** +Needs summary. +`setID = C_UIWidgetManager.GetBelowMinimapWidgetSetID()` + +**Returns:** +- `setID` + - *number* : UiWidgetSetID - Returns 2 + - `ID` + - `Location Function` + - `1` + - `C_UIWidgetManager.GetTopCenterWidgetSetID()` + - `2` + - `C_UIWidgetManager.GetBelowMinimapWidgetSetID()` + - `240` + - `C_UIWidgetManager.GetObjectiveTrackerWidgetSetID()` + - `283` + - `C_UIWidgetManager.GetPowerBarWidgetSetID()` \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md new file mode 100644 index 00000000..5fb32548 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md @@ -0,0 +1,86 @@ +## Title: C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *BulletTextListWidgetVisualizationInfo?* + - `shownState` + - *Enum.WidgetShownState* + - `enabledState` + - *Enum.WidgetEnabledState* + - `lines` + - *string* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- **Value** - **Field** - **Description** + - `0` - Hidden + - `1` - Shown + +**Enum.WidgetEnabledState** +- **Value** - **Field** - **Description** + - `0` - Disabled + - `1` - Yellow (Renamed from Enabled in 10.1.0) + - `2` - Red + - `3` - White (Added in 9.1.0) + - `4` - Green (Added in 9.1.0) + - `5` - Artifact (Renamed from Gold in 10.1.0) + - `6` - Black (Added in 9.2.0) + +**Enum.WidgetAnimationType** +- **Value** - **Field** - **Description** + - `0` - None + - `1` - Fade + +**Enum.UIWidgetScale** +- **Value** - **Field** - **Description** + - `0` - OneHundred + - `1` - Ninty + - `2` - Eighty + - `3` - Seventy + - `4` - Sixty + - `5` - Fifty + +**Enum.UIWidgetLayoutDirection** +- **Value** - **Field** - **Description** + - `0` - Default + - `1` - Vertical + - `2` - Horizontal + - `3` - Overlap + - `4` - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- **Value** - **Field** - **Description** + - `0` - None + - `1` - Front + - `2` - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md new file mode 100644 index 00000000..00c1df6d --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md @@ -0,0 +1,162 @@ +## Title: C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *CaptureBarWidgetVisualizationInfo?* + - `Field` + - `Type` + - `Description` + - `shownState` + - *Enum.WidgetShownState* + - `barValue` + - *number* + - `barMinValue` + - *number* + - `barMaxValue` + - *number* + - `neutralZoneSize` + - *number* + - `neutralZoneCenter` + - *number* + - `tooltip` + - *string* + - `glowAnimType` + - *Enum.CaptureBarWidgetGlowAnimType* + - `fillDirectionType` + - *Enum.CaptureBarWidgetFillDirectionType* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Shown + +**Enum.CaptureBarWidgetGlowAnimType** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Pulse + +**Enum.CaptureBarWidgetFillDirectionType** +- `Value` +- `Field` +- `Description` + - `0` + - RightToLeft + - `1` + - LeftToRight + +**Enum.UIWidgetTooltipLocation** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- `Value` +- `Field` +- `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md new file mode 100644 index 00000000..62cfc55e --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md @@ -0,0 +1,135 @@ +## Title: C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from UPDATE_UI_WIDGET and C_UIWidgetManager.GetAllWidgetsBySetID() + +**Returns:** +- `widgetInfo` + - *DoubleIconAndTextWidgetVisualizationInfo?* + - `shownState` + - *Enum.WidgetShownState* + - `label` + - *string* + - `leftText` + - *string* + - `leftTooltip` + - *string* + - `rightText` + - *string* + - `rightTooltip` + - *string* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- **Value** + - **Field** + - **Description** + - `0` + - Hidden + - `1` + - Shown + +**Enum.UIWidgetTooltipLocation** +- **Value** + - **Field** + - **Description** + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType** +- **Value** + - **Field** + - **Description** + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- **Value** + - **Field** + - **Description** + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- **Value** + - **Field** + - **Description** + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- **Value** + - **Field** + - **Description** + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md new file mode 100644 index 00000000..ac8beb4c --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md @@ -0,0 +1,171 @@ +## Title: C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *DoubleStatusBarWidgetVisualizationInfo?* + - `Field` + - `Type` + - `Description` + - `shownState` + - *Enum.WidgetShownState* + - `leftBarMin` + - *number* + - `leftBarMax` + - *number* + - `leftBarValue` + - *number* + - `leftBarTooltip` + - *string* + - `rightBarMin` + - *number* + - `rightBarMax` + - *number* + - `rightBarValue` + - *number* + - `rightBarTooltip` + - *string* + - `barValueTextType` + - *Enum.StatusBarValueTextType* + - `text` + - *string* + - `leftBarTooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `rightBarTooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `fillMotionType` + - *Enum.UIWidgetMotionType* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Shown + +**Enum.StatusBarValueTextType** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Percentage + - `2` + - Value + - `3` + - Time + - `4` + - TimeShowOneLevelOnly + - `5` + - ValueOverMax + - `6` + - ValueOverMaxNormalized + +**Enum.UIWidgetTooltipLocation** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- `Value` +- `Field` +- `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md new file mode 100644 index 00000000..4159aa97 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md @@ -0,0 +1,145 @@ +## Title: C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *HorizontalCurrenciesWidgetVisualizationInfo?* + - `Field` + - `Type` + - `Description` + - `shownState` + - *Enum.WidgetShownState* + - `currencies` + - *UIWidgetCurrencyInfo* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Shown + +**UIWidgetCurrencyInfo** +- `Field` +- `Type` +- `Description` + - `iconFileID` + - *number* + - `leadingText` + - *string* + - `text` + - *string* + - `tooltip` + - *string* + - `isCurrencyMaxed` + - *boolean* + +**Enum.UIWidgetTooltipLocation** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- `Value` +- `Field` +- `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md new file mode 100644 index 00000000..823acd1b --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md @@ -0,0 +1,138 @@ +## Title: C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *IconAndTextWidgetVisualizationInfo?* + - `Field` + - `Type` + - `Description` + - `state` + - *Enum.IconAndTextWidgetState* + - `text` + - *string* + - `tooltip` + - *string* + - `dynamicTooltip` + - *string* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.IconAndTextWidgetState:** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Shown + - `2` + - ShownWithDynamicIconFlashing + - `3` + - ShownWithDynamicIconNotFlashing + +**Enum.UIWidgetTooltipLocation:** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType:** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale:** +- `Value` +- `Field` +- `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection:** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer:** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md new file mode 100644 index 00000000..8e949935 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md @@ -0,0 +1,105 @@ +## Title: C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *IconTextAndBackgroundWidgetVisualizationInfo?* + - `Field` + - `Type` + - `Description` + - `shownState` + - *Enum.WidgetShownState* + - `text` + - *string* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Shown + +**Enum.WidgetAnimationType** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- `Value` +- `Field` +- `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md new file mode 100644 index 00000000..e7e42f83 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md @@ -0,0 +1,171 @@ +## Title: C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *IconTextAndCurrenciesWidgetVisualizationInfo?* + - `shownState` + - *Enum.WidgetShownState* + - `enabledState` + - *Enum.WidgetEnabledState* + - `descriptionShownState` + - *Enum.WidgetShownState* + - `descriptionEnabledState` + - *Enum.WidgetEnabledState* + - `text` + - *string* + - `description` + - *string* + - `currencies` + - *UIWidgetCurrencyInfo* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState:** +- `Value` + - `Field` + - `Description` + - `0` + - Hidden + - `1` + - Shown + +**Enum.WidgetEnabledState:** +- `Value` + - `Field` + - `Description` + - `0` + - Disabled + - `1` + - Yellow (Renamed from Enabled in 10.1.0) + - `2` + - Red + - `3` + - White (Added in 9.1.0) + - `4` + - Green (Added in 9.1.0) + - `5` + - Artifact (Renamed from Gold in 10.1.0) + - `6` + - Black (Added in 9.2.0) + +**UIWidgetCurrencyInfo:** +- `Field` + - `Type` + - `Description` + - `iconFileID` + - *number* + - `leadingText` + - *string* + - `text` + - *string* + - `tooltip` + - *string* + - `isCurrencyMaxed` + - *boolean* + +**Enum.UIWidgetTooltipLocation:** +- `Value` + - `Field` + - `Description` + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType:** +- `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale:** +- `Value` + - `Field` + - `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection:** +- `Value` + - `Field` + - `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer:** +- `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md new file mode 100644 index 00000000..f1c6ed24 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md @@ -0,0 +1,119 @@ +## Title: C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo?* + - `shownState` + - *Enum.WidgetShownState* + - `currencies` + - *UIWidgetCurrencyInfo* + - `headerText` + - *string* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- **Value** + - **Field** + - **Description** + - `0` + - Hidden + - `1` + - Shown + +**UIWidgetCurrencyInfo** +- **Field** + - **Type** + - **Description** + - `iconFileID` + - *number* + - `leadingText` + - *string* + - `text` + - *string* + - `tooltip` + - *string* + - `isCurrencyMaxed` + - *boolean* + +**Enum.WidgetAnimationType** +- **Value** + - **Field** + - **Description** + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- **Value** + - **Field** + - **Description** + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- **Value** + - **Field** + - **Description** + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- **Value** + - **Field** + - **Description** + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md new file mode 100644 index 00000000..be601333 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md @@ -0,0 +1,145 @@ +## Title: C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *StackedResourceTrackerWidgetVisualizationInfo?* + - `Field` + - `Type` + - `Description` + - `shownState` + - *Enum.WidgetShownState* + - `resources` + - *UIWidgetCurrencyInfo* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Shown + +**UIWidgetCurrencyInfo** +- `Field` +- `Type` +- `Description` + - `iconFileID` + - *number* + - `leadingText` + - *string* + - `text` + - *string* + - `tooltip` + - *string* + - `isCurrencyMaxed` + - *boolean* + +**Enum.UIWidgetTooltipLocation** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- `Value` +- `Field` +- `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md new file mode 100644 index 00000000..0e7a28d3 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md @@ -0,0 +1,214 @@ +## Title: C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *StatusBarWidgetVisualizationInfo?* + - `shownState` + - *Enum.WidgetShownState* + - `barMin` + - *number* + - `barMax` + - *number* + - `barValue` + - *number* + - `text` + - *string* + - `tooltip` + - *string* + - `barValueTextType` + - *Enum.StatusBarValueTextType* + - `overrideBarText` + - *string* + - `overrideBarTextShownType` + - *Enum.StatusBarOverrideBarTextShownType* + - `colorTint` + - *Enum.StatusBarColorTintValue* + - `partitionValues` + - *number* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `fillMotionType` + - *Enum.UIWidgetMotionType* + - `barTextEnabledState` + - *Enum.WidgetEnabledState* + - `barTextFontType` + - *Enum.UIWidgetFontType* + - `barTextSizeType` + - *Enum.UIWidgetTextSizeType* + - `textEnabledState` + - *Enum.WidgetEnabledState* + - `textFontType` + - *Enum.UIWidgetFontType* + - `textSizeType` + - *Enum.UIWidgetTextSizeType* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* : textureKit + - `frameTextureKit` + - *string* : textureKit + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState:** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Shown + +**Enum.StatusBarValueTextType:** +- `Value` +- `Field` +- `Description` + - `0` + - Hidden + - `1` + - Percentage + - `2` + - Value + - `3` + - Time + - `4` + - TimeShowOneLevelOnly + - `5` + - ValueOverMax + - `6` + - ValueOverMaxNormalized + +**Enum.StatusBarOverrideBarTextShownType:** +- `Value` +- `Field` +- `Description` + - `0` + - Never + - `1` + - Always + - `2` + - OnlyOnMouseover + - `3` + - OnlyNotOnMouseover + +**Enum.StatusBarColorTintValue:** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Black + - `2` + - White + - `3` + - Red + - `4` + - Yellow + - `5` + - Orange + - `6` + - Purple + - `7` + - Green + - `8` + - Blue + +**Enum.UIWidgetTooltipLocation:** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetAnimationType:** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale:** +- `Value` +- `Field` +- `Description` + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection:** +- `Value` +- `Field` +- `Description` + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer:** +- `Value` +- `Field` +- `Description` + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md new file mode 100644 index 00000000..48297373 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md @@ -0,0 +1,203 @@ +## Title: C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` + +**Returns:** +- `widgetInfo` + - *TextWithStateWidgetVisualizationInfo?* + - `shownState` + - *Enum.WidgetShownState* + - `enabledState` + - *Enum.WidgetEnabledState* + - `text` + - *string* + - `tooltip` + - *string* + - `textSizeType` + - *Enum.UIWidgetTextSizeType* + - `fontType` + - *Enum.UIWidgetFontType* + - `bottomPadding` + - *number* + - `tooltipLoc` + - *Enum.UIWidgetTooltipLocation* + - `hAlign` + - *Enum.WidgetTextHorizontalAlignmentType* + - `widgetSizeSetting` + - *number* + - `textureKit` + - *string* + - `frameTextureKit` + - *string* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `inAnimType` + - *Enum.WidgetAnimationType* + - `outAnimType` + - *Enum.WidgetAnimationType* + - `widgetScale` + - *Enum.UIWidgetScale* + - `layoutDirection` + - *Enum.UIWidgetLayoutDirection* + - `modelSceneLayer` + - *Enum.UIWidgetModelSceneLayer* + - `scriptedAnimationEffectID` + - *number* + +**Enum.WidgetShownState** +- **Value** + - **Field** + - **Description** + - `0` + - Hidden + - `1` + - Shown + +**Enum.WidgetEnabledState** +- **Value** + - **Field** + - **Description** + - `0` + - Disabled + - `1` + - Yellow (Renamed from Enabled in 10.1.0) + - `2` + - Red + - `3` + - White (Added in 9.1.0) + - `4` + - Green (Added in 9.1.0) + - `5` + - Artifact (Renamed from Gold in 10.1.0) + - `6` + - Black (Added in 9.2.0) + +**Enum.UIWidgetTextSizeType** +- **Value** + - **Field** + - **Description** + - `0` + - Small12Pt + - `1` + - Medium16Pt + - `2` + - Large24Pt + - `3` + - Huge27Pt + - `4` + - Standard14Pt + - `5` + - Small10Pt + - `6` + - Small11Pt + - `7` + - Medium18Pt + - `8` + - Large20Pt + +**Enum.UIWidgetFontType** +- **Value** + - **Field** + - **Description** + - `0` + - Normal + - `1` + - Shadow + - `2` + - Outline + +**Enum.UIWidgetTooltipLocation** +- **Value** + - **Field** + - **Description** + - `0` + - Default + - `1` + - BottomLeft + - `2` + - Left + - `3` + - TopLeft + - `4` + - Top + - `5` + - TopRight + - `6` + - Right + - `7` + - BottomRight + - `8` + - Bottom + +**Enum.WidgetTextHorizontalAlignmentType** +- **Value** + - **Field** + - **Description** + - `0` + - Left + - `1` + - Center + - `2` + - Right + +**Enum.WidgetAnimationType** +- **Value** + - **Field** + - **Description** + - `0` + - None + - `1` + - Fade + +**Enum.UIWidgetScale** +- **Value** + - **Field** + - **Description** + - `0` + - OneHundred + - `1` + - Ninty + - `2` + - Eighty + - `3` + - Seventy + - `4` + - Sixty + - `5` + - Fifty + +**Enum.UIWidgetLayoutDirection** +- **Value** + - **Field** + - **Description** + - `0` + - Default + - `1` + - Vertical + - `2` + - Horizontal + - `3` + - Overlap + - `4` + - HorizontalForceNewRow + +**Enum.UIWidgetModelSceneLayer** +- **Value** + - **Field** + - **Description** + - `0` + - None + - `1` + - Front + - `2` + - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md new file mode 100644 index 00000000..740290e5 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md @@ -0,0 +1,41 @@ +## Title: C_UIWidgetManager.GetTextureWithStateVisualizationInfo + +**Content:** +Needs summary. +`widgetInfo = C_UIWidgetManager.GetTextureWithStateVisualizationInfo(widgetID)` + +**Parameters:** +- `widgetID` + - *number* + +**Returns:** +- `widgetInfo` + - *structure* - TextureWithStateVisualizationInfo (nilable) + - `Key` + - `Type` + - `Description` + - `shownState` + - *Enum.WidgetShownState* + - `name` + - *string* + - `backgroundTextureKitID` + - *number* + - `portraitTextureKitID` + - *number* + - `hasTimer` + - *boolean* + - `orderIndex` + - *number* + - `widgetTag` + - *string* + - `Enum.WidgetShownState` + - `Value` + - `Field` + - `Description` + - `0` + - Hidden + - `1` + - Shown + +**Reference:** +Blizzard API Documentation \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md b/wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md new file mode 100644 index 00000000..f622bd90 --- /dev/null +++ b/wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md @@ -0,0 +1,33 @@ +## Title: C_UIWidgetManager.GetTopCenterWidgetSetID + +**Content:** +Returns the widget set ID for the top center part of the screen. +`setID = C_UIWidgetManager.GetTopCenterWidgetSetID()` + +**Returns:** +- `setID` + - *number* : UiWidgetSetID - Returns 1 + - `ID` + - `Location Function` + - `1` + - `C_UIWidgetManager.GetTopCenterWidgetSetID()` + - `2` + - `C_UIWidgetManager.GetBelowMinimapWidgetSetID()` + - `240` + - `C_UIWidgetManager.GetObjectiveTrackerWidgetSetID()` + - `283` + - `C_UIWidgetManager.GetPowerBarWidgetSetID()` + +**Usage:** +Prints all UI widget IDs for the top center part of the screen, e.g. on Warsong Gulch: +```lua +local topCenter = C_UIWidgetManager.GetTopCenterWidgetSetID() +local widgets = C_UIWidgetManager.GetAllWidgetsBySetID(topCenter) +for _, w in pairs(widgets) do + print(w.widgetType, w.widgetID) +end +-- Output example: +-- 0, 6 -- IconAndText, VisID 3: Icon And Text: No Texture Kit +-- 3, 2 -- DoubleStatusBar, VisID 1197: PvP - CTF - Double Status Bar +-- 14, 1640 -- DoubleStateIconRow, VisID 1201: PvP - CTF - Flag Status +``` \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md b/wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md new file mode 100644 index 00000000..5d819472 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md @@ -0,0 +1,58 @@ +## Title: C_UnitAuras.AddPrivateAuraAnchor + +**Content:** +Needs summary. +`anchorID = C_UnitAuras.AddPrivateAuraAnchor(args)` + +**Parameters:** +- `args` + - *AddPrivateAuraAnchorArgs* + - `Field` + - `Type` + - `Description` + - `unitToken` + - *string* + - `auraIndex` + - *number* + - `parent` + - *Frame* + - `showCountdownFrame` + - *boolean* + - `showCountdownNumbers` + - *boolean* + - `iconInfo` + - *PrivateAuraIconInfo?* + - `durationAnchor` + - *AnchorBinding?* + +**PrivateAuraIconInfo** +- `Field` +- `Type` +- `Description` +- `iconAnchor` + - *AnchorBinding* +- `iconWidth` + - *number : uiUnit* +- `iconHeight` + - *number : uiUnit* + +**AnchorBinding** +- `Field` +- `Type` +- `Description` +- `point` + - *string : FramePoint* + - TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER +- `relativeTo` + - *ScriptRegion* +- `relativePoint` + - *string : FramePoint* + - TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER +- `offsetX` + - *number : uiUnit* +- `offsetY` + - *number : uiUnit* + +**Returns:** +- `anchorID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md b/wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md new file mode 100644 index 00000000..4022ea59 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md @@ -0,0 +1,26 @@ +## Title: C_UnitAuras.AddPrivateAuraAppliedSound + +**Content:** +Needs summary. +`privateAuraSoundID = C_UnitAuras.AddPrivateAuraAppliedSound(sound)` + +**Parameters:** +- `sound` + - *UnitPrivateAuraAppliedSoundInfo* + - `Field` + - `Type` + - `Description` + - `unitToken` + - *string* + - `spellID` + - *number* + - `soundFileName` + - *string?* + - `soundFileID` + - *number?* + - `outputChannel` + - *string?* + +**Returns:** +- `privateAuraSoundID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.AuraIsPrivate.md b/wiki-information/functions/C_UnitAuras.AuraIsPrivate.md new file mode 100644 index 00000000..b86bb438 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.AuraIsPrivate.md @@ -0,0 +1,19 @@ +## Title: C_UnitAuras.AuraIsPrivate + +**Content:** +Needs summary. +`isPrivate = C_UnitAuras.AuraIsPrivate(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `isPrivate` + - *boolean* + +**Example Usage:** +This function can be used to determine if a specific aura (identified by its spell ID) is private. This can be useful in addons that manage or display aura information, ensuring that private auras are handled appropriately. + +**Addon Usage:** +Large addons like WeakAuras might use this function to filter out private auras when displaying aura information to the player, ensuring that only relevant and non-private auras are shown in custom UI elements. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md b/wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md new file mode 100644 index 00000000..64af695a --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md @@ -0,0 +1,65 @@ +## Title: C_UnitAuras.GetAuraDataByAuraInstanceID + +**Content:** +Returns information about an aura on a unit by a given aura instance ID. +`aura = C_UnitAuras.GetAuraDataByAuraInstanceID(unit, auraInstanceID)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to query. +- `auraInstanceID` + - *number* - An aura instance ID. + +**Returns:** +- `aura` + - *UnitAuraInfo?* - Structured information about the found aura, if any. + - `applications` + - *number* + - `auraInstanceID` + - *number* + - `canApplyAura` + - *boolean* - Whether or not the player can apply this aura. + - `charges` + - *number* + - `dispelName` + - *string?* + - `duration` + - *number* + - `expirationTime` + - *number* + - `icon` + - *number* + - `isBossAura` + - *boolean* - Whether or not this aura was applied by a boss. + - `isFromPlayerOrPlayerPet` + - *boolean* - Whether or not this aura was applied by a player or their pet. + - `isHarmful` + - *boolean* - Whether or not this aura is a debuff. + - `isHelpful` + - *boolean* - Whether or not this aura is a buff. + - `isNameplateOnly` + - *boolean* - Whether or not this aura should appear on nameplates. + - `isRaid` + - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. + - `isStealable` + - *boolean* + - `maxCharges` + - *number* + - `name` + - *string* - The name of the aura. + - `nameplateShowAll` + - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - `nameplateShowPersonal` + - *boolean* + - `points` + - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - `sourceUnit` + - *string?* - Token of the unit that applied the aura. + - `spellId` + - *number* - The spell ID of the aura. + - `timeMod` + - *number* + +**Description:** +Related Events +- `UNIT_AURA` \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md b/wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md new file mode 100644 index 00000000..b9d3443b --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md @@ -0,0 +1,81 @@ +## Title: C_UnitAuras.GetAuraDataByIndex + +**Content:** +Needs summary. +`aura = C_UnitAuras.GetAuraDataByIndex(unitToken, index)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `index` + - *number* +- `filter` + - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". + +**Miscellaneous:** +- **Filter** | **Description** + - `"HELPFUL"` | Buffs + - `"HARMFUL"` | Debuffs + - `"PLAYER"` | Auras Debuffs applied by the player + - `"RAID"` | Buffs the player can apply and debuffs the player can dispel + - `"CANCELABLE"` | Buffs that can be cancelled with /cancelaura or CancelUnitBuff() + - `"NOT_CANCELABLE"` | Buffs that cannot be cancelled + - `"INCLUDE_NAME_PLATE_ONLY"` | Auras that should be shown on nameplates + - `"MAW"` | Torghast Anima Powers + +**Returns:** +- `aura` + - *AuraData?* + - `Field` + - `Type` + - `Description` + - `applications` + - *number* + - `auraInstanceID` + - *number* + - `canApplyAura` + - *boolean* - Whether or not the player can apply this aura. + - `charges` + - *number* + - `dispelName` + - *string?* + - `duration` + - *number* + - `expirationTime` + - *number* + - `icon` + - *number* + - `isBossAura` + - *boolean* - Whether or not this aura was applied by a boss. + - `isFromPlayerOrPlayerPet` + - *boolean* - Whether or not this aura was applied by a player or their pet. + - `isHarmful` + - *boolean* - Whether or not this aura is a debuff. + - `isHelpful` + - *boolean* - Whether or not this aura is a buff. + - `isNameplateOnly` + - *boolean* - Whether or not this aura should appear on nameplates. + - `isRaid` + - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. + - `isStealable` + - *boolean* + - `maxCharges` + - *number* + - `name` + - *string* - The name of the aura. + - `nameplateShowAll` + - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - `nameplateShowPersonal` + - *boolean* + - `points` + - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - `sourceUnit` + - *string?* - Token of the unit that applied the aura. + - `spellId` + - *number* - The spell ID of the aura. + - `timeMod` + - *number* + +**Description:** +C_UnitAuras.GetBuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HELPFUL"), returning only buffs and ignores any HARMFUL filter. +C_UnitAuras.GetDebuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HARMFUL"), returning only debuffs and ignores any HELPFUL filter. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md b/wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md new file mode 100644 index 00000000..5600f549 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md @@ -0,0 +1,64 @@ +## Title: C_UnitAuras.GetAuraDataBySlot + +**Content:** +Returns information about an aura on a unit by a given slot index. +`aura = C_UnitAuras.GetAuraDataBySlot(unit, slot)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to query. +- `slot` + - *number* - A slot index obtained from the variable returns of UnitAuraSlots. + +**Returns:** +- `aura` + - *UnitAuraInfo?* - Structured information about the found aura, if any. + - `applications` + - *number* + - `auraInstanceID` + - *number* + - `canApplyAura` + - *boolean* - Whether or not the player can apply this aura. + - `charges` + - *number* + - `dispelName` + - *string?* + - `duration` + - *number* + - `expirationTime` + - *number* + - `icon` + - *number* + - `isBossAura` + - *boolean* - Whether or not this aura was applied by a boss. + - `isFromPlayerOrPlayerPet` + - *boolean* - Whether or not this aura was applied by a player or their pet. + - `isHarmful` + - *boolean* - Whether or not this aura is a debuff. + - `isHelpful` + - *boolean* - Whether or not this aura is a buff. + - `isNameplateOnly` + - *boolean* - Whether or not this aura should appear on nameplates. + - `isRaid` + - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. + - `isStealable` + - *boolean* + - `maxCharges` + - *number* + - `name` + - *string* - The name of the aura. + - `nameplateShowAll` + - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - `nameplateShowPersonal` + - *boolean* + - `points` + - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - `sourceUnit` + - *string?* - Token of the unit that applied the aura. + - `spellId` + - *number* - The spell ID of the aura. + - `timeMod` + - *number* + +**Description:** +This API can be used as an alternative to UnitAuraBySlot to obtain information about the aura in a structured table. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md b/wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md new file mode 100644 index 00000000..f017f713 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md @@ -0,0 +1,89 @@ +## Title: C_UnitAuras.GetAuraDataBySpellName + +**Content:** +Needs summary. +`aura = C_UnitAuras.GetAuraDataBySpellName(unitToken, spellName)` + +**Parameters:** +- `unitToken` + - *string* - UnitId +- `spellName` + - *string* +- `filter` + - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". + +**Miscellaneous:** +- **Filter** + - **Description** + - `"HELPFUL"` + - Buffs + - `"HARMFUL"` + - Debuffs + - `"PLAYER"` + - Auras Debuffs applied by the player + - `"RAID"` + - Buffs the player can apply and debuffs the player can dispel + - `"CANCELABLE"` + - Buffs that can be cancelled with /cancelaura or CancelUnitBuff() + - `"NOT_CANCELABLE"` + - Buffs that cannot be cancelled + - `"INCLUDE_NAME_PLATE_ONLY"` + - Auras that should be shown on nameplates + - `"MAW"` + - Torghast Anima Powers + +**Returns:** +- `aura` + - *AuraData?* + - `applications` + - *number* + - `auraInstanceID` + - *number* + - `canApplyAura` + - *boolean* - Whether or not the player can apply this aura. + - `charges` + - *number* + - `dispelName` + - *string?* + - `duration` + - *number* + - `expirationTime` + - *number* + - `icon` + - *number* + - `isBossAura` + - *boolean* - Whether or not this aura was applied by a boss. + - `isFromPlayerOrPlayerPet` + - *boolean* - Whether or not this aura was applied by a player or their pet. + - `isHarmful` + - *boolean* - Whether or not this aura is a debuff. + - `isHelpful` + - *boolean* - Whether or not this aura is a buff. + - `isNameplateOnly` + - *boolean* - Whether or not this aura should appear on nameplates. + - `isRaid` + - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. + - `isStealable` + - *boolean* + - `maxCharges` + - *number* + - `name` + - *string* - The name of the aura. + - `nameplateShowAll` + - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - `nameplateShowPersonal` + - *boolean* + - `points` + - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - `sourceUnit` + - *string?* - Token of the unit that applied the aura. + - `spellId` + - *number* - The spell ID of the aura. + - `timeMod` + - *number* + +**Example Usage:** +This function can be used to retrieve detailed information about a specific aura (buff or debuff) on a unit by its spell name. For instance, if you want to check if a player has a specific buff and get its details, you can use this function. + +**Addon Usage:** +Large addons like WeakAuras use this function to track and display aura information on units. WeakAuras can create custom visual and audio alerts based on the presence and details of specific auras, helping players to react to buffs and debuffs in real-time. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraSlots.md b/wiki-information/functions/C_UnitAuras.GetAuraSlots.md new file mode 100644 index 00000000..a88a933e --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetAuraSlots.md @@ -0,0 +1,43 @@ +## Title: C_UnitAuras.GetAuraSlots + +**Content:** +Needs summary. +`outContinuationToken, slots = C_UnitAuras.GetAuraSlots(unitToken, filter)` + +**Parameters:** +- `unitToken` + - *string* - UnitToken +- `filter` + - *string* +- `maxSlots` + - *number?* +- `continuationToken` + - *number?* + +**Returns:** +- `outContinuationToken` + - *number?* - (Variable returns) +- `slots` + - *number* + +**Description:** +This function is used to retrieve the aura slots for a given unit. The `unitToken` parameter specifies the unit whose auras are being queried, and the `filter` parameter allows for filtering specific types of auras (e.g., "HELPFUL", "HARMFUL"). The `maxSlots` and `continuationToken` parameters are optional and can be used to handle large numbers of auras by paginating the results. + +**Example Usage:** +```lua +local unitToken = "player" +local filter = "HELPFUL" +local maxSlots = 40 +local continuationToken = nil + +continuationToken, slots = C_UnitAuras.GetAuraSlots(unitToken, filter, maxSlots, continuationToken) + +for i, slot in ipairs(slots) do + local aura = C_UnitAuras.GetAuraDataBySlot(unitToken, slot) + print(aura.name, aura.duration) +end +``` + +**Addons Using This Function:** +- **WeakAuras**: This popular addon uses `C_UnitAuras.GetAuraSlots` to track and display buffs and debuffs on units, allowing players to create custom visual and audio alerts based on aura conditions. +- **ElvUI**: This comprehensive UI replacement addon uses the function to manage and display unit auras in its unit frames, providing players with detailed information about buffs and debuffs on themselves and their targets. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md b/wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md new file mode 100644 index 00000000..fea30561 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md @@ -0,0 +1,87 @@ +## Title: C_UnitAuras.GetBuffDataByIndex + +**Content:** +Needs summary. +`aura = C_UnitAuras.GetBuffDataByIndex(unitToken, index)` + +**Parameters:** +- `unitToken` + - *string* +- `index` + - *number* +- `filter` + - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". + +**Miscellaneous:** +- **Filter** + - **Description** + - `"HELPFUL"` + - Buffs + - `"HARMFUL"` + - Debuffs + - `"PLAYER"` + - Auras Debuffs applied by the player + - `"RAID"` + - Buffs the player can apply and debuffs the player can dispel + - `"CANCELABLE"` + - Buffs that can be cancelled with /cancelaura or CancelUnitBuff() + - `"NOT_CANCELABLE"` + - Buffs that cannot be cancelled + - `"INCLUDE_NAME_PLATE_ONLY"` + - Auras that should be shown on nameplates + - `"MAW"` + - Torghast Anima Powers + +**Returns:** +- `aura` + - *AuraData?* + - `applications` + - *number* + - `auraInstanceID` + - *number* + - `canApplyAura` + - *boolean* - Whether or not the player can apply this aura. + - `charges` + - *number* + - `dispelName` + - *string?* + - `duration` + - *number* + - `expirationTime` + - *number* + - `icon` + - *number* + - `isBossAura` + - *boolean* - Whether or not this aura was applied by a boss. + - `isFromPlayerOrPlayerPet` + - *boolean* - Whether or not this aura was applied by a player or their pet. + - `isHarmful` + - *boolean* - Whether or not this aura is a debuff. + - `isHelpful` + - *boolean* - Whether or not this aura is a buff. + - `isNameplateOnly` + - *boolean* - Whether or not this aura should appear on nameplates. + - `isRaid` + - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. + - `isStealable` + - *boolean* + - `maxCharges` + - *number* + - `name` + - *string* - The name of the aura. + - `nameplateShowAll` + - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - `nameplateShowPersonal` + - *boolean* + - `points` + - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - `sourceUnit` + - *string?* - Token of the unit that applied the aura. + - `spellId` + - *number* - The spell ID of the aura. + - `timeMod` + - *number* + +**Description:** +C_UnitAuras.GetBuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HELPFUL"), returning only buffs and ignores any HARMFUL filter. +C_UnitAuras.GetDebuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HARMFUL"), returning only debuffs and ignores any HELPFUL filter. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md b/wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md new file mode 100644 index 00000000..1c41a186 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md @@ -0,0 +1,16 @@ +## Title: C_UnitAuras.GetCooldownAuraBySpellID + +**Content:** +Obtains the spell ID of a passive cooldown effect associated with a spell. +`passiveCooldownSpellID = C_UnitAuras.GetCooldownAuraBySpellID(spellID)` + +**Parameters:** +- `spellID` + - *number* - The spell ID to query. + +**Returns:** +- `passiveCooldownSpellID` + - *number?* - The spell ID of an associated passive aura effect, if any. + +**Description:** +This API is used in conjunction with `C_UnitAuras.GetPlayerAuraBySpellID` to display passive effect cooldowns on action buttons. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md b/wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md new file mode 100644 index 00000000..38bc6636 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md @@ -0,0 +1,90 @@ +## Title: C_UnitAuras.GetDebuffDataByIndex + +**Content:** +Needs summary. +`aura = C_UnitAuras.GetDebuffDataByIndex(unitToken, index)` + +**Parameters:** +- `unitToken` + - *string* +- `index` + - *number* +- `filter` + - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HARMFUL". + +**Miscellaneous:** +- **Filter** + - **Description** + - `"HELPFUL"` + - Buffs + - `"HARMFUL"` + - Debuffs + - `"PLAYER"` + - Auras Debuffs applied by the player + - `"RAID"` + - Buffs the player can apply and debuffs the player can dispel + - `"CANCELABLE"` + - Buffs that can be cancelled with /cancelaura or CancelUnitBuff() + - `"NOT_CANCELABLE"` + - Buffs that cannot be cancelled + - `"INCLUDE_NAME_PLATE_ONLY"` + - Auras that should be shown on nameplates + - `"MAW"` + - Torghast Anima Powers + +**Returns:** +- `aura` + - *AuraData?* + - `Field` + - `Type` + - `Description` + - `applications` + - *number* + - `auraInstanceID` + - *number* + - `canApplyAura` + - *boolean* - Whether or not the player can apply this aura. + - `charges` + - *number* + - `dispelName` + - *string?* + - `duration` + - *number* + - `expirationTime` + - *number* + - `icon` + - *number* + - `isBossAura` + - *boolean* - Whether or not this aura was applied by a boss. + - `isFromPlayerOrPlayerPet` + - *boolean* - Whether or not this aura was applied by a player or their pet. + - `isHarmful` + - *boolean* - Whether or not this aura is a debuff. + - `isHelpful` + - *boolean* - Whether or not this aura is a buff. + - `isNameplateOnly` + - *boolean* - Whether or not this aura should appear on nameplates. + - `isRaid` + - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. + - `isStealable` + - *boolean* + - `maxCharges` + - *number* + - `name` + - *string* - The name of the aura. + - `nameplateShowAll` + - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - `nameplateShowPersonal` + - *boolean* + - `points` + - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - `sourceUnit` + - *string?* - Token of the unit that applied the aura. + - `spellId` + - *number* - The spell ID of the aura. + - `timeMod` + - *number* + +**Description:** +C_UnitAuras.GetBuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HELPFUL"), returning only buffs and ignores any HARMFUL filter. +C_UnitAuras.GetDebuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HARMFUL"), returning only debuffs and ignores any HELPFUL filter. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md b/wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md new file mode 100644 index 00000000..23450453 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md @@ -0,0 +1,66 @@ +## Title: C_UnitAuras.GetPlayerAuraBySpellID + +**Content:** +Returns information about an aura on the player by a given spell ID. +`aura = C_UnitAuras.GetPlayerAuraBySpellID(spellID)` + +**Parameters:** +- `spellID` + - *number* - The spell ID to query. + +**Returns:** +- `aura` + - *AuraData?* - Structured information about the found aura, if any. + - `applications` + - *number* + - `auraInstanceID` + - *number* + - `canApplyAura` + - *boolean* - Whether or not the player can apply this aura. + - `charges` + - *number* + - `dispelName` + - *string?* + - `duration` + - *number* + - `expirationTime` + - *number* + - `icon` + - *number* + - `isBossAura` + - *boolean* - Whether or not this aura was applied by a boss. + - `isFromPlayerOrPlayerPet` + - *boolean* - Whether or not this aura was applied by a player or their pet. + - `isHarmful` + - *boolean* - Whether or not this aura is a debuff. + - `isHelpful` + - *boolean* - Whether or not this aura is a buff. + - `isNameplateOnly` + - *boolean* - Whether or not this aura should appear on nameplates. + - `isRaid` + - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. + - `isStealable` + - *boolean* + - `maxCharges` + - *number* + - `name` + - *string* - The name of the aura. + - `nameplateShowAll` + - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. + - `nameplateShowPersonal` + - *boolean* + - `points` + - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + - `sourceUnit` + - *string?* - Token of the unit that applied the aura. + - `spellId` + - *number* - The spell ID of the aura. + - `timeMod` + - *number* + +**Example Usage:** +This function can be used to check if a player has a specific buff or debuff by its spell ID. For instance, if you want to check if the player has the "Power Word: Fortitude" buff, you can use its spell ID to query this function. + +**Addons Using This Function:** +- **WeakAuras**: This popular addon uses this function to track and display auras on the player, allowing for highly customizable alerts and displays based on the player's current buffs and debuffs. +- **ElvUI**: This comprehensive UI replacement addon uses this function to manage and display aura information on unit frames, providing players with clear and concise information about their current auras. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md b/wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md new file mode 100644 index 00000000..86bc51cc --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md @@ -0,0 +1,28 @@ +## Title: C_UnitAuras.IsAuraFilteredOutByInstanceID + +**Content:** +Tests if an aura passes a specific filter. +`isFiltered = C_UnitAuras.IsAuraFilteredOutByInstanceID(unit, auraInstanceID, filterString)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to query. +- `auraInstanceID` + - *number* - The aura instance ID to test. +- `filterString` + - *string* - The aura filter string to test, e.g., "HELPFUL" or "HARMFUL". + +**Miscellaneous:** +- **Filter** | **Description** + - `"HELPFUL"` | Buffs + - `"HARMFUL"` | Debuffs + - `"PLAYER"` | Auras Debuffs applied by the player + - `"RAID"` | Buffs the player can apply and debuffs the player can dispel + - `"CANCELABLE"` | Buffs that can be cancelled with /cancelaura or CancelUnitBuff() + - `"NOT_CANCELABLE"` | Buffs that cannot be cancelled + - `"INCLUDE_NAME_PLATE_ONLY"` | Auras that should be shown on nameplates + - `"MAW"` | Torghast Anima Powers + +**Returns:** +- `isFiltered` + - *boolean* - true if the aura passes the specified filter, or false if not. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md b/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md new file mode 100644 index 00000000..98bb6c90 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md @@ -0,0 +1,9 @@ +## Title: C_UnitAuras.RemovePrivateAuraAnchor + +**Content:** +Needs summary. +`C_UnitAuras.RemovePrivateAuraAnchor(anchorID)` + +**Parameters:** +- `anchorID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md b/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md new file mode 100644 index 00000000..7daf59b0 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md @@ -0,0 +1,9 @@ +## Title: C_UnitAuras.RemovePrivateAuraAppliedSound + +**Content:** +Needs summary. +`C_UnitAuras.RemovePrivateAuraAppliedSound(privateAuraSoundID)` + +**Parameters:** +- `privateAuraSoundID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md b/wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md new file mode 100644 index 00000000..4fbafa25 --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md @@ -0,0 +1,24 @@ +## Title: C_UnitAuras.SetPrivateWarningTextAnchor + +**Content:** +Needs summary. +`C_UnitAuras.SetPrivateWarningTextAnchor(parent)` + +**Parameters:** +- `parent` + - *Frame* - The parent frame to which the warning text will be anchored. +- `anchor` + - *AnchorBinding?* - The anchor binding details. + - `Field` + - `Type` + - `Description` + - `point` + - *string* - FramePoint (e.g., TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER) + - `relativeTo` + - *ScriptRegion* - The region relative to which the anchor point is set. + - `relativePoint` + - *string* - FramePoint (e.g., TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER) + - `offsetX` + - *number* - Horizontal offset in UI units. + - `offsetY` + - *number* - Vertical offset in UI units. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.WantsAlteredForm.md b/wiki-information/functions/C_UnitAuras.WantsAlteredForm.md new file mode 100644 index 00000000..8d3b424d --- /dev/null +++ b/wiki-information/functions/C_UnitAuras.WantsAlteredForm.md @@ -0,0 +1,13 @@ +## Title: C_UnitAuras.WantsAlteredForm + +**Content:** +Needs summary. +`wantsAlteredForm = C_UnitAuras.WantsAlteredForm(unitToken)` + +**Parameters:** +- `unitToken` + - *string* + +**Returns:** +- `wantsAlteredForm` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_UserFeedback.SubmitBug.md b/wiki-information/functions/C_UserFeedback.SubmitBug.md new file mode 100644 index 00000000..8f511f44 --- /dev/null +++ b/wiki-information/functions/C_UserFeedback.SubmitBug.md @@ -0,0 +1,32 @@ +## Title: C_UserFeedback.SubmitBug + +**Content:** +Replaces `GMSubmitBug`. +`success = C_UserFeedback.SubmitBug(bugInfo)` + +**Parameters:** +- `bugInfo` + - *string* +- `suppressNotification` + - *boolean?* = false + +**Returns:** +- `success` + - *boolean* + +**Example Usage:** +```lua +local bugInfo = "There is a bug with the quest 'A Threat Within'. The NPC does not spawn." +local success = C_UserFeedback.SubmitBug(bugInfo, true) +if success then + print("Bug report submitted successfully.") +else + print("Failed to submit bug report.") +end +``` + +**Description:** +This function is used to submit a bug report directly to Blizzard's bug tracking system. It replaces the older `GMSubmitBug` function. The `suppressNotification` parameter is optional and defaults to `false`. When set to `true`, it suppresses the notification that usually appears after submitting a bug report. + +**Change Log:** +Patch 8.0.1 (2018-07-17): Added. \ No newline at end of file diff --git a/wiki-information/functions/C_UserFeedback.SubmitSuggestion.md b/wiki-information/functions/C_UserFeedback.SubmitSuggestion.md new file mode 100644 index 00000000..f6bb5693 --- /dev/null +++ b/wiki-information/functions/C_UserFeedback.SubmitSuggestion.md @@ -0,0 +1,30 @@ +## Title: C_UserFeedback.SubmitSuggestion + +**Content:** +Replaces `GMSubmitSuggestion`. +`success = C_UserFeedback.SubmitSuggestion(suggestion)` + +**Parameters:** +- `suggestion` + - *string* + +**Returns:** +- `success` + - *boolean* + +**Example Usage:** +```lua +local suggestion = "Add more flight paths in the new zone." +local success = C_UserFeedback.SubmitSuggestion(suggestion) +if success then + print("Suggestion submitted successfully!") +else + print("Failed to submit suggestion.") +end +``` + +**Description:** +This function allows players to submit suggestions directly to the game developers. It replaces the older `GMSubmitSuggestion` function and provides a streamlined way to send feedback. + +**Usage in Addons:** +Large addons like **ElvUI** and **WeakAuras** might use this function to allow users to submit suggestions for improvements or new features directly from the addon interface. This can enhance user engagement and provide valuable feedback to addon developers. \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md b/wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md new file mode 100644 index 00000000..22cfe865 --- /dev/null +++ b/wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md @@ -0,0 +1,9 @@ +## Title: C_VideoOptions.GetCurrentGameWindowSize + +**Content:** +Needs summary. +`size = C_VideoOptions.GetCurrentGameWindowSize()` + +**Returns:** +- `size` + - *Vector2DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md b/wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md new file mode 100644 index 00000000..30bd9fd5 --- /dev/null +++ b/wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md @@ -0,0 +1,13 @@ +## Title: C_VideoOptions.GetDefaultGameWindowSize + +**Content:** +Needs summary. +`size = C_VideoOptions.GetDefaultGameWindowSize(monitor)` + +**Parameters:** +- `monitor` + - *number* + +**Returns:** +- `size` + - *Vector2DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md b/wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md new file mode 100644 index 00000000..460bb97f --- /dev/null +++ b/wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md @@ -0,0 +1,15 @@ +## Title: C_VideoOptions.GetGameWindowSizes + +**Content:** +Needs summary. +`sizes = C_VideoOptions.GetGameWindowSizes(monitor, fullscreen)` + +**Parameters:** +- `monitor` + - *number* +- `fullscreen` + - *boolean* + +**Returns:** +- `sizes` + - *vector2* \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md b/wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md new file mode 100644 index 00000000..a8adfd8d --- /dev/null +++ b/wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md @@ -0,0 +1,18 @@ +## Title: C_VideoOptions.GetGxAdapterInfo + +**Content:** +Returns info about the system's graphics adapter. +`adapters = C_VideoOptions.GetGxAdapterInfo()` + +**Returns:** +- `adapters` + - *structure* - GxAdapterInfoDetails + - `Field` + - `Type` + - `Description` + - `name` + - *string* - e.g. "NVIDIA GeForce GTX 1060GB" + - `isLowPower` + - *boolean* + - `isExternal` + - *boolean* - whether the adapter is external \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.SetGameWindowSize.md b/wiki-information/functions/C_VideoOptions.SetGameWindowSize.md new file mode 100644 index 00000000..9c4a997c --- /dev/null +++ b/wiki-information/functions/C_VideoOptions.SetGameWindowSize.md @@ -0,0 +1,11 @@ +## Title: C_VideoOptions.SetGameWindowSize + +**Content:** +Needs summary. +`C_VideoOptions.SetGameWindowSize(x, y)` + +**Parameters:** +- `x` + - *number* +- `y` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ActivateChannel.md b/wiki-information/functions/C_VoiceChat.ActivateChannel.md new file mode 100644 index 00000000..8ae03bae --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.ActivateChannel.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.ActivateChannel + +**Content:** +Needs summary. +`C_VoiceChat.ActivateChannel(channelID)` + +**Parameters:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md b/wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md new file mode 100644 index 00000000..eb6c4c61 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.ActivateChannelTranscription + +**Content:** +Needs summary. +`C_VoiceChat.ActivateChannelTranscription(channelID)` + +**Parameters:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.BeginLocalCapture.md b/wiki-information/functions/C_VoiceChat.BeginLocalCapture.md new file mode 100644 index 00000000..15869eaa --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.BeginLocalCapture.md @@ -0,0 +1,21 @@ +## Title: C_VoiceChat.BeginLocalCapture + +**Content:** +Needs summary. +`C_VoiceChat.BeginLocalCapture(listenToLocalUser)` + +**Parameters:** +- `listenToLocalUser` + - *boolean* + +**Description:** +This function is used to start capturing local voice input. The `listenToLocalUser` parameter determines whether the local user can hear their own voice during the capture. + +**Example Usage:** +```lua +-- Start capturing local voice input and allow the user to hear their own voice +C_VoiceChat.BeginLocalCapture(true) +``` + +**Use in Addons:** +Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to provide voice communication features within their interfaces, allowing users to communicate more effectively during gameplay. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md b/wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md new file mode 100644 index 00000000..5bd33c69 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.CanPlayerUseVoiceChat + +**Content:** +Needs summary. +`canUseVoiceChat = C_VoiceChat.CanPlayerUseVoiceChat()` + +**Returns:** +- `canUseVoiceChat` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.CreateChannel.md b/wiki-information/functions/C_VoiceChat.CreateChannel.md new file mode 100644 index 00000000..222de635 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.CreateChannel.md @@ -0,0 +1,42 @@ +## Title: C_VoiceChat.CreateChannel + +**Content:** +Needs summary. +`status = C_VoiceChat.CreateChannel(channelDisplayName)` + +**Parameters:** +- `channelDisplayName` + - *string* + +**Returns:** +- `status` + - *Enum.VoiceChatStatusCode* + - `Enum.VoiceChatStatusCode` + - `Value` + - `Field` + - `Description` + - `0` - Success + - `1` - OperationPending + - `2` - TooManyRequests + - `3` - LoginProhibited + - `4` - ClientNotInitialized + - `5` - ClientNotLoggedIn + - `6` - ClientAlreadyLoggedIn + - `7` - ChannelNameTooShort + - `8` - ChannelNameTooLong + - `9` - ChannelAlreadyExists + - `10` - AlreadyInChannel + - `11` - TargetNotFound + - `12` - Failure + - `13` - ServiceLost + - `14` - UnableToLaunchProxy + - `15` - ProxyConnectionTimeOut + - `16` - ProxyConnectionUnableToConnect + - `17` - ProxyConnectionUnexpectedDisconnect + - `18` - Disabled + - `19` - UnsupportedChatChannelType + - `20` - InvalidCommunityStream + - `21` - PlayerSilenced + - `22` - PlayerVoiceChatParentalDisabled + - `23` - InvalidInputDevice (Added in 8.2.0) + - `24` - InvalidOutputDevice (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.DeactivateChannel.md b/wiki-information/functions/C_VoiceChat.DeactivateChannel.md new file mode 100644 index 00000000..328da1e9 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.DeactivateChannel.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.DeactivateChannel + +**Content:** +Needs summary. +`C_VoiceChat.DeactivateChannel(channelID)` + +**Parameters:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md b/wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md new file mode 100644 index 00000000..19665f62 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.DeactivateChannelTranscription + +**Content:** +Needs summary. +`C_VoiceChat.DeactivateChannelTranscription(channelID)` + +**Parameters:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.EndLocalCapture.md b/wiki-information/functions/C_VoiceChat.EndLocalCapture.md new file mode 100644 index 00000000..245268bb --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.EndLocalCapture.md @@ -0,0 +1,18 @@ +## Title: C_VoiceChat.EndLocalCapture + +**Content:** +Needs summary. +`C_VoiceChat.EndLocalCapture()` + +**Description:** +This function is used to end the local voice chat capture. It is typically used in scenarios where you want to stop capturing the user's voice input, such as when the user leaves a voice chat channel or disables voice chat functionality. + +**Example Usage:** +```lua +-- Example of ending local voice chat capture +C_VoiceChat.EndLocalCapture() +print("Voice chat capture has been ended.") +``` + +**Usage in Addons:** +Large addons that manage voice communication, such as "ElvUI" or "DBM (Deadly Boss Mods)", might use this function to control voice chat features, ensuring that voice capture is properly managed when users join or leave voice channels. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetActiveChannelID.md b/wiki-information/functions/C_VoiceChat.GetActiveChannelID.md new file mode 100644 index 00000000..092fd814 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetActiveChannelID.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetActiveChannelID + +**Content:** +Needs summary. +`channelID = C_VoiceChat.GetActiveChannelID()` + +**Returns:** +- `channelID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetActiveChannelType.md b/wiki-information/functions/C_VoiceChat.GetActiveChannelType.md new file mode 100644 index 00000000..2a4e0b6c --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetActiveChannelType.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetActiveChannelType + +**Content:** +Needs summary. +`channelType = C_VoiceChat.GetActiveChannelType()` + +**Returns:** +- `channelType` + - *unknown* ChatChannelType (nilable) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md b/wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md new file mode 100644 index 00000000..e7777d64 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md @@ -0,0 +1,25 @@ +## Title: C_VoiceChat.GetAvailableInputDevices + +**Content:** +Needs summary. +`inputDevices = C_VoiceChat.GetAvailableInputDevices()` + +**Returns:** +- `inputDevices` + - *structure* - VoiceAudioDevice (nilable) + - `VoiceAudioDevice` + - `Field` + - `Type` + - `Description` + - `deviceID` + - *string* + - `displayName` + - *string* + - `isActive` + - *boolean* + - `isSystemDefault` + - *boolean* + - `isCommsDefault` + - *boolean* + +**Added in:** 9.1.0 \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md b/wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md new file mode 100644 index 00000000..3ddc5494 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md @@ -0,0 +1,26 @@ +## Title: C_VoiceChat.GetAvailableOutputDevices + +**Content:** +Needs summary. +`outputDevices = C_VoiceChat.GetAvailableOutputDevices()` + +**Returns:** +- `outputDevices` + - *structure* - VoiceAudioDevice (nilable) + - `VoiceAudioDevice` + - `Field` + - `Type` + - `Description` + - `deviceID` + - *string* + - `displayName` + - *string* + - `isActive` + - *boolean* + - `isSystemDefault` + - *boolean* + - `isCommsDefault` + - *boolean* + +**Change Log:** +- Added in 9.1.0 \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetChannel.md b/wiki-information/functions/C_VoiceChat.GetChannel.md new file mode 100644 index 00000000..79627b07 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetChannel.md @@ -0,0 +1,71 @@ +## Title: C_VoiceChat.GetChannel + +**Content:** +Needs summary. +`channel = C_VoiceChat.GetChannel(channelID)` + +**Parameters:** +- `channelID` + - *number* + +**Returns:** +- `channel` + - *structure* - VoiceChatChannel (nilable) + - `VoiceChatChannel` + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `channelID` + - *number* + - `channelType` + - *Enum.ChatChannelType* + - `clubId` + - *string* + - `streamId` + - *string* + - `volume` + - *number* + - `isActive` + - *boolean* + - `isMuted` + - *boolean* + - `isTransmitting` + - *boolean* + - `isTranscribing` + - *boolean* + - `members` + - *VoiceChatMember* + - `Enum.ChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Custom + - `2` + - Private_Party + - Documented as "PrivateParty" + - `3` + - Public_Party + - Documented as "PublicParty" + - `4` + - Communities + - `VoiceChatMember` + - `Field` + - `Type` + - `Description` + - `energy` + - *number* + - `memberID` + - *number* + - `isActive` + - *boolean* + - `isSpeaking` + - *boolean* + - `isMutedForAll` + - *boolean* + - `isSilenced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md b/wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md new file mode 100644 index 00000000..7e632a05 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md @@ -0,0 +1,56 @@ +## Title: C_VoiceChat.GetChannelForChannelType + +**Content:** +Needs summary. +`channel = C_VoiceChat.GetChannelForChannelType(channelType)` + +**Parameters:** +- `channelType` + - *Enum.ChatChannelType* + - `Enum.ChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - Custom + - `2` - Private_Party (Documented as "PrivateParty") + - `3` - Public_Party (Documented as "PublicParty") + - `4` - Communities + +**Returns:** +- `channel` + - *structure* - VoiceChatChannel (nilable) + - `VoiceChatChannel` + - `Field` + - `Type` + - `Description` + - `name` - *string* + - `channelID` - *number* + - `channelType` - *Enum.ChatChannelType* + - `clubId` - *string* + - `streamId` - *string* + - `volume` - *number* + - `isActive` - *boolean* + - `isMuted` - *boolean* + - `isTransmitting` - *boolean* + - `isTranscribing` - *boolean* (Added in 9.1.0) + - `members` - *VoiceChatMember* + - `Enum.ChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` - None + - `1` - Custom + - `2` - Private_Party (Documented as "PrivateParty") + - `3` - Public_Party (Documented as "PublicParty") + - `4` - Communities + - `VoiceChatMember` + - `Field` + - `Type` + - `Description` + - `energy` - *number* + - `memberID` - *number* + - `isActive` - *boolean* + - `isSpeaking` - *boolean* + - `isMutedForAll` - *boolean* + - `isSilenced` - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md b/wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md new file mode 100644 index 00000000..e18c79ae --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md @@ -0,0 +1,75 @@ +## Title: C_VoiceChat.GetChannelForCommunityStream + +**Content:** +Needs summary. +`channel = C_VoiceChat.GetChannelForCommunityStream(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* + +**Returns:** +- `channel` + - *structure* - VoiceChatChannel (nilable) + - `VoiceChatChannel` + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `channelID` + - *number* + - `channelType` + - *Enum.ChatChannelType* + - `clubId` + - *string* + - `streamId` + - *string* + - `volume` + - *number* + - `isActive` + - *boolean* + - `isMuted` + - *boolean* + - `isTransmitting` + - *boolean* + - `isTranscribing` + - *boolean* + - `members` + - *VoiceChatMember* + - `Enum.ChatChannelType` + - `Value` + - `Field` + - `Description` + - `0` + - None + - `1` + - Custom + - `2` + - Private_Party + - Documented as "PrivateParty" + - `3` + - Public_Party + - Documented as "PublicParty" + - `4` + - Communities + - `VoiceChatMember` + - `Field` + - `Type` + - `Description` + - `energy` + - *number* + - `memberID` + - *number* + - `isActive` + - *boolean* + - `isSpeaking` + - *boolean* + - `isMutedForAll` + - *boolean* + - `isSilenced` + - *boolean* + +**Added in 9.1.0** \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetCommunicationMode.md b/wiki-information/functions/C_VoiceChat.GetCommunicationMode.md new file mode 100644 index 00000000..83335740 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetCommunicationMode.md @@ -0,0 +1,17 @@ +## Title: C_VoiceChat.GetCommunicationMode + +**Content:** +Needs summary. +`communicationMode = C_VoiceChat.GetCommunicationMode()` + +**Returns:** +- `communicationMode` + - *Enum.CommunicationMode (nilable)* + - *Enum.CommunicationMode* + - `Value` + - `Field` + - `Description` + - `0` + - `PushToTalk` + - `1` + - `OpenMic` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md b/wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md new file mode 100644 index 00000000..ba63490f --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md @@ -0,0 +1,62 @@ +## Title: C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode + +**Content:** +Needs summary. +`statusCode = C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode()` + +**Returns:** +- `statusCode` + - *Enum.VoiceChatStatusCode?* + - `Value` + - `Field` + - `Description` + - `0` + - Success + - `1` + - OperationPending + - `2` + - TooManyRequests + - `3` + - LoginProhibited + - `4` + - ClientNotInitialized + - `5` + - ClientNotLoggedIn + - `6` + - ClientAlreadyLoggedIn + - `7` + - ChannelNameTooShort + - `8` + - ChannelNameTooLong + - `9` + - ChannelAlreadyExists + - `10` + - AlreadyInChannel + - `11` + - TargetNotFound + - `12` + - Failure + - `13` + - ServiceLost + - `14` + - UnableToLaunchProxy + - `15` + - ProxyConnectionTimeOut + - `16` + - ProxyConnectionUnableToConnect + - `17` + - ProxyConnectionUnexpectedDisconnect + - `18` + - Disabled + - `19` + - UnsupportedChatChannelType + - `20` + - InvalidCommunityStream + - `21` + - PlayerSilenced + - `22` + - PlayerVoiceChatParentalDisabled + - `23` + - InvalidInputDevice (Added in 8.2.0) + - `24` + - InvalidOutputDevice (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetInputVolume.md b/wiki-information/functions/C_VoiceChat.GetInputVolume.md new file mode 100644 index 00000000..6f986d81 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetInputVolume.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetInputVolume + +**Content:** +Needs summary. +`volume = C_VoiceChat.GetInputVolume()` + +**Returns:** +- `volume` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md b/wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md new file mode 100644 index 00000000..02201e25 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md @@ -0,0 +1,25 @@ +## Title: C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo + +**Content:** +Needs summary. +`memberInfo = C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo()` + +**Returns:** +- `memberInfo` + - *structure* - VoiceChatMember (nilable) + - `VoiceChatMember` + - `Field` + - `Type` + - `Description` + - `energy` + - *number* + - `memberID` + - *number* + - `isActive` + - *boolean* + - `isSpeaking` + - *boolean* + - `isMutedForAll` + - *boolean* + - `isSilenced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md b/wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md new file mode 100644 index 00000000..028ba1df --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md @@ -0,0 +1,13 @@ +## Title: C_VoiceChat.GetLocalPlayerMemberID + +**Content:** +Needs summary. +`memberID = C_VoiceChat.GetLocalPlayerMemberID(channelID)` + +**Parameters:** +- `channelID` + - *number* + +**Returns:** +- `memberID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md b/wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md new file mode 100644 index 00000000..ebc4b154 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetMasterVolumeScale + +**Content:** +Needs summary. +`scale = C_VoiceChat.GetMasterVolumeScale()` + +**Returns:** +- `scale` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberGUID.md b/wiki-information/functions/C_VoiceChat.GetMemberGUID.md new file mode 100644 index 00000000..fd23c7bd --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetMemberGUID.md @@ -0,0 +1,15 @@ +## Title: C_VoiceChat.GetMemberGUID + +**Content:** +Needs summary. +`memberGUID = C_VoiceChat.GetMemberGUID(memberID, channelID)` + +**Parameters:** +- `memberID` + - *number* +- `channelID` + - *number* + +**Returns:** +- `memberGUID` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberID.md b/wiki-information/functions/C_VoiceChat.GetMemberID.md new file mode 100644 index 00000000..c6450ad6 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetMemberID.md @@ -0,0 +1,15 @@ +## Title: C_VoiceChat.GetMemberID + +**Content:** +Needs summary. +`memberID = C_VoiceChat.GetMemberID(channelID, memberGUID)` + +**Parameters:** +- `channelID` + - *number* +- `memberGUID` + - *string* + +**Returns:** +- `memberID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberInfo.md b/wiki-information/functions/C_VoiceChat.GetMemberInfo.md new file mode 100644 index 00000000..daf11bde --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetMemberInfo.md @@ -0,0 +1,31 @@ +## Title: C_VoiceChat.GetMemberInfo + +**Content:** +Needs summary. +`memberInfo = C_VoiceChat.GetMemberInfo(memberID, channelID)` + +**Parameters:** +- `memberID` + - *number* +- `channelID` + - *number* + +**Returns:** +- `memberInfo` + - *structure* - VoiceChatMember (nilable) + - `VoiceChatMember` + - `Field` + - `Type` + - `Description` + - `energy` + - *number* + - `memberID` + - *number* + - `isActive` + - *boolean* + - `isSpeaking` + - *boolean* + - `isMutedForAll` + - *boolean* + - `isSilenced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberName.md b/wiki-information/functions/C_VoiceChat.GetMemberName.md new file mode 100644 index 00000000..92346baa --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetMemberName.md @@ -0,0 +1,24 @@ +## Title: C_VoiceChat.GetMemberName + +**Content:** +Needs summary. +`memberName = C_VoiceChat.GetMemberName(memberID, channelID)` + +**Parameters:** +- `memberID` + - *number* +- `channelID` + - *number* + +**Returns:** +- `memberName` + - *string?* + +**Description:** +This function retrieves the name of a member in a specified voice chat channel. It can be useful for addons that manage or display voice chat information, such as showing who is speaking in a voice channel. + +**Example Usage:** +An addon could use this function to display the names of all members in a voice chat channel, helping users to identify who is currently connected and speaking. + +**Addons:** +Large addons like **DBM (Deadly Boss Mods)** or **ElvUI** might use this function to enhance their voice chat features, providing better integration and user experience by displaying member names in their custom UI elements. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberVolume.md b/wiki-information/functions/C_VoiceChat.GetMemberVolume.md new file mode 100644 index 00000000..64cc4864 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetMemberVolume.md @@ -0,0 +1,27 @@ +## Title: C_VoiceChat.GetMemberVolume + +**Content:** +Needs summary. +`volume = C_VoiceChat.GetMemberVolume(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin*🔗 + +**Returns:** +- `volume` + - *number?* + +**Description:** +This function retrieves the volume level for a specific member in the voice chat, identified by their `playerLocation`. + +**Example Usage:** +```lua +local playerLocation = PlayerLocation:CreateFromUnit("player") +local volume = C_VoiceChat.GetMemberVolume(playerLocation) +print("Current volume level for the player:", volume) +``` + +**Addons Using This Function:** +- **DBM (Deadly Boss Mods):** Utilizes this function to adjust voice alerts based on individual player volume settings. +- **ElvUI:** May use this function to integrate voice chat volume controls within its comprehensive UI customization options. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetOutputVolume.md b/wiki-information/functions/C_VoiceChat.GetOutputVolume.md new file mode 100644 index 00000000..b825a98a --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetOutputVolume.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetOutputVolume + +**Content:** +Needs summary. +`volume = C_VoiceChat.GetOutputVolume()` + +**Returns:** +- `volume` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md b/wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md new file mode 100644 index 00000000..6bb2aabe --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetPTTButtonPressedState + +**Content:** +Needs summary. +`isPressed = C_VoiceChat.GetPTTButtonPressedState()` + +**Returns:** +- `isPressed` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetProcesses.md b/wiki-information/functions/C_VoiceChat.GetProcesses.md new file mode 100644 index 00000000..840e51f0 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetProcesses.md @@ -0,0 +1,78 @@ +## Title: C_VoiceChat.GetProcesses + +**Content:** +Needs summary. +`processes = C_VoiceChat.GetProcesses()` + +**Returns:** +- `processes` + - *structure* - VoiceChatProcess + - `Field` + - `Type` + - `Description` + - `name` + - *string* + - `channels` + - *structure* VoiceChatChannel + +**VoiceChatChannel:** +- `Field` +- `Type` +- `Description` +- `name` + - *string* +- `channelID` + - *number* +- `channelType` + - *Enum.ChatChannelType* +- `clubId` + - *string* +- `streamId` + - *string* +- `volume` + - *number* +- `isActive` + - *boolean* +- `isMuted` + - *boolean* +- `isTransmitting` + - *boolean* +- `isTranscribing` + - *boolean* +- `Added in 9.1.0` +- `members` + - *VoiceChatMember* + +**Enum.ChatChannelType:** +- `Value` +- `Field` +- `Description` +- `0` + - None +- `1` + - Custom +- `2` + - Private_Party + - Documented as "PrivateParty" +- `3` + - Public_Party + - Documented as "PublicParty" +- `4` + - Communities + +**VoiceChatMember:** +- `Field` +- `Type` +- `Description` +- `energy` + - *number* +- `memberID` + - *number* +- `isActive` + - *boolean* +- `isSpeaking` + - *boolean* +- `isMutedForAll` + - *boolean* +- `isSilenced` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md b/wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md new file mode 100644 index 00000000..8a7b8258 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetPushToTalkBinding + +**Content:** +Needs summary. +`keys = C_VoiceChat.GetPushToTalkBinding()` + +**Returns:** +- `keys` + - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md b/wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md new file mode 100644 index 00000000..00256f89 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md @@ -0,0 +1,16 @@ +## Title: C_VoiceChat.GetRemoteTtsVoices + +**Content:** +Needs summary. +`ttsVoices = C_VoiceChat.GetRemoteTtsVoices()` + +**Returns:** +- `ttsVoices` + - *VoiceTtsVoiceType* + - `Field` + - `Type` + - `Description` + - `voiceID` + - *number* + - `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetTtsVoices.md b/wiki-information/functions/C_VoiceChat.GetTtsVoices.md new file mode 100644 index 00000000..de93ebb1 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetTtsVoices.md @@ -0,0 +1,16 @@ +## Title: C_VoiceChat.GetTtsVoices + +**Content:** +Needs summary. +`ttsVoices = C_VoiceChat.GetTtsVoices()` + +**Returns:** +- `ttsVoices` + - *VoiceTtsVoiceType* + - `Field` + - `Type` + - `Description` + - `voiceID` + - *number* + - `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetVADSensitivity.md b/wiki-information/functions/C_VoiceChat.GetVADSensitivity.md new file mode 100644 index 00000000..ed00a853 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.GetVADSensitivity.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.GetVADSensitivity + +**Content:** +Needs summary. +`sensitivity = C_VoiceChat.GetVADSensitivity()` + +**Returns:** +- `sensitivity` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md b/wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md new file mode 100644 index 00000000..e49aafde --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md @@ -0,0 +1,31 @@ +## Title: C_VoiceChat.IsChannelJoinPending + +**Content:** +Needs summary. +`isPending = C_VoiceChat.IsChannelJoinPending(channelType)` + +**Parameters:** +- `channelType` + - *Enum.ChatChannelType* +- `clubId` + - *string?* +- `streamId` + - *string?* + +**Enum.ChatChannelType Values:** +- `0` + - `None` +- `1` + - `Custom` +- `2` + - `Private_Party` + - Documented as "PrivateParty" +- `3` + - `Public_Party` + - Documented as "PublicParty" +- `4` + - `Communities` + +**Returns:** +- `isPending` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsDeafened.md b/wiki-information/functions/C_VoiceChat.IsDeafened.md new file mode 100644 index 00000000..cddd1cc0 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsDeafened.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsDeafened + +**Content:** +Needs summary. +`isDeafened = C_VoiceChat.IsDeafened()` + +**Returns:** +- `isDeafened` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsEnabled.md b/wiki-information/functions/C_VoiceChat.IsEnabled.md new file mode 100644 index 00000000..250a3f02 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsEnabled.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsEnabled + +**Content:** +Needs summary. +`isEnabled = C_VoiceChat.IsEnabled()` + +**Returns:** +- `isEnabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsLoggedIn.md b/wiki-information/functions/C_VoiceChat.IsLoggedIn.md new file mode 100644 index 00000000..35663767 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsLoggedIn.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsLoggedIn + +**Content:** +Needs summary. +`isLoggedIn = C_VoiceChat.IsLoggedIn()` + +**Returns:** +- `isLoggedIn` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md b/wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md new file mode 100644 index 00000000..e9a3b3a5 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md @@ -0,0 +1,15 @@ +## Title: C_VoiceChat.IsMemberLocalPlayer + +**Content:** +Needs summary. +`isLocalPlayer = C_VoiceChat.IsMemberLocalPlayer(memberID, channelID)` + +**Parameters:** +- `memberID` + - *number* +- `channelID` + - *number* + +**Returns:** +- `isLocalPlayer` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMemberMuted.md b/wiki-information/functions/C_VoiceChat.IsMemberMuted.md new file mode 100644 index 00000000..f1bca09e --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsMemberMuted.md @@ -0,0 +1,27 @@ +## Title: C_VoiceChat.IsMemberMuted + +**Content:** +Needs summary. +`mutedForMe = C_VoiceChat.IsMemberMuted(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* + +**Returns:** +- `mutedForMe` + - *boolean?* + +**Description:** +This function checks if a specific member in the voice chat is muted for the player. The `playerLocation` parameter is a `PlayerLocationMixin` object that specifies the location of the player whose mute status is being queried. + +**Example Usage:** +```lua +local playerLocation = PlayerLocation:CreateFromUnit("target") +local isMuted = C_VoiceChat.IsMemberMuted(playerLocation) +print("Is the target muted for me?", isMuted) +``` + +**Addons Using This Function:** +- **DBM (Deadly Boss Mods):** Uses this function to ensure that important voice alerts are not missed by checking if key members are muted. +- **ElvUI:** Utilizes this function to manage voice chat settings and ensure smooth communication during raids and battlegrounds. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md b/wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md new file mode 100644 index 00000000..f83db14a --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md @@ -0,0 +1,16 @@ +## Title: C_VoiceChat.IsMemberMutedForAll + +**Content:** +Needs summary. +`mutedForAll = C_VoiceChat.IsMemberMutedForAll(memberID, channelID)` + +**Parameters:** +- `memberID` + - *number* +- `channelID` + - *number* + +**Returns:** +- `mutedForAll` + - *boolean?* + diff --git a/wiki-information/functions/C_VoiceChat.IsMemberSilenced.md b/wiki-information/functions/C_VoiceChat.IsMemberSilenced.md new file mode 100644 index 00000000..43923c3c --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsMemberSilenced.md @@ -0,0 +1,15 @@ +## Title: C_VoiceChat.IsMemberSilenced + +**Content:** +Needs summary. +`silenced = C_VoiceChat.IsMemberSilenced(memberID, channelID)` + +**Parameters:** +- `memberID` + - *number* +- `channelID` + - *number* + +**Returns:** +- `silenced` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMuted.md b/wiki-information/functions/C_VoiceChat.IsMuted.md new file mode 100644 index 00000000..599eb452 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsMuted.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsMuted + +**Content:** +Needs summary. +`isMuted = C_VoiceChat.IsMuted()` + +**Returns:** +- `isMuted` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsParentalDisabled.md b/wiki-information/functions/C_VoiceChat.IsParentalDisabled.md new file mode 100644 index 00000000..fed787e2 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsParentalDisabled.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsParentalDisabled + +**Content:** +Needs summary. +`isParentalDisabled = C_VoiceChat.IsParentalDisabled()` + +**Returns:** +- `isParentalDisabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsParentalMuted.md b/wiki-information/functions/C_VoiceChat.IsParentalMuted.md new file mode 100644 index 00000000..7185ae90 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsParentalMuted.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsParentalMuted + +**Content:** +Needs summary. +`isParentalMuted = C_VoiceChat.IsParentalMuted()` + +**Returns:** +- `isParentalMuted` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md b/wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md new file mode 100644 index 00000000..6eb7226f --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md @@ -0,0 +1,13 @@ +## Title: C_VoiceChat.IsPlayerUsingVoice + +**Content:** +Needs summary. +`isUsingVoice = C_VoiceChat.IsPlayerUsingVoice(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* + +**Returns:** +- `isUsingVoice` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsSilenced.md b/wiki-information/functions/C_VoiceChat.IsSilenced.md new file mode 100644 index 00000000..fcc1e732 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsSilenced.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsSilenced + +**Content:** +Needs summary. +`isSilenced = C_VoiceChat.IsSilenced()` + +**Returns:** +- `isSilenced` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md b/wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md new file mode 100644 index 00000000..58d0d75d --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsSpeakForMeActive + +**Content:** +Needs summary. +`isActive = C_VoiceChat.IsSpeakForMeActive()` + +**Returns:** +- `isActive` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md b/wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md new file mode 100644 index 00000000..dcda2e51 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsSpeakForMeAllowed + +**Content:** +Needs summary. +`isAllowed = C_VoiceChat.IsSpeakForMeAllowed()` + +**Returns:** +- `isAllowed` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsTranscribing.md b/wiki-information/functions/C_VoiceChat.IsTranscribing.md new file mode 100644 index 00000000..2e5339d5 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsTranscribing.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsTranscribing + +**Content:** +Needs summary. +`isTranscribing = C_VoiceChat.IsTranscribing()` + +**Returns:** +- `isTranscribing` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md b/wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md new file mode 100644 index 00000000..e86ea0ca --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsTranscriptionAllowed + +**Content:** +Needs summary. +`isAllowed = C_VoiceChat.IsTranscriptionAllowed()` + +**Returns:** +- `isAllowed` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md b/wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md new file mode 100644 index 00000000..0688dadc --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.IsVoiceChatConnected + +**Content:** +Needs summary. +`connected = C_VoiceChat.IsVoiceChatConnected()` + +**Returns:** +- `connected` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.LeaveChannel.md b/wiki-information/functions/C_VoiceChat.LeaveChannel.md new file mode 100644 index 00000000..c839fed4 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.LeaveChannel.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.LeaveChannel + +**Content:** +Needs summary. +`C_VoiceChat.LeaveChannel(channelID)` + +**Parameters:** +- `channelID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.Login.md b/wiki-information/functions/C_VoiceChat.Login.md new file mode 100644 index 00000000..78eebc88 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.Login.md @@ -0,0 +1,38 @@ +## Title: C_VoiceChat.Login + +**Content:** +Needs summary. +`status = C_VoiceChat.Login()` + +**Returns:** +- `status` + - *Enum.VoiceChatStatusCode* + - `Enum.VoiceChatStatusCode` + - `Value` + - `Field` + - `Description` + - `0` - Success + - `1` - OperationPending + - `2` - TooManyRequests + - `3` - LoginProhibited + - `4` - ClientNotInitialized + - `5` - ClientNotLoggedIn + - `6` - ClientAlreadyLoggedIn + - `7` - ChannelNameTooShort + - `8` - ChannelNameTooLong + - `9` - ChannelAlreadyExists + - `10` - AlreadyInChannel + - `11` - TargetNotFound + - `12` - Failure + - `13` - ServiceLost + - `14` - UnableToLaunchProxy + - `15` - ProxyConnectionTimeOut + - `16` - ProxyConnectionUnableToConnect + - `17` - ProxyConnectionUnexpectedDisconnect + - `18` - Disabled + - `19` - UnsupportedChatChannelType + - `20` - InvalidCommunityStream + - `21` - PlayerSilenced + - `22` - PlayerVoiceChatParentalDisabled + - `23` - InvalidInputDevice (Added in 8.2.0) + - `24` - InvalidOutputDevice (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.Logout.md b/wiki-information/functions/C_VoiceChat.Logout.md new file mode 100644 index 00000000..e6ed2c57 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.Logout.md @@ -0,0 +1,63 @@ +## Title: C_VoiceChat.Logout + +**Content:** +Needs summary. +`status = C_VoiceChat.Logout()` + +**Returns:** +- `status` + - *Enum.VoiceChatStatusCode* + - `Enum.VoiceChatStatusCode` + - `Value` + - `Field` + - `Description` + - `0` + - `Success` + - `1` + - `OperationPending` + - `2` + - `TooManyRequests` + - `3` + - `LoginProhibited` + - `4` + - `ClientNotInitialized` + - `5` + - `ClientNotLoggedIn` + - `6` + - `ClientAlreadyLoggedIn` + - `7` + - `ChannelNameTooShort` + - `8` + - `ChannelNameTooLong` + - `9` + - `ChannelAlreadyExists` + - `10` + - `AlreadyInChannel` + - `11` + - `TargetNotFound` + - `12` + - `Failure` + - `13` + - `ServiceLost` + - `14` + - `UnableToLaunchProxy` + - `15` + - `ProxyConnectionTimeOut` + - `16` + - `ProxyConnectionUnableToConnect` + - `17` + - `ProxyConnectionUnexpectedDisconnect` + - `18` + - `Disabled` + - `19` + - `UnsupportedChatChannelType` + - `20` + - `InvalidCommunityStream` + - `21` + - `PlayerSilenced` + - `22` + - `PlayerVoiceChatParentalDisabled` + - `23` + - `InvalidInputDevice` (Added in 8.2.0) + - `24` + - `InvalidOutputDevice` (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md b/wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md new file mode 100644 index 00000000..a8b8e9ea --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md @@ -0,0 +1,8 @@ +## Title: C_VoiceChat.MarkChannelsDiscovered + +**Content:** +Needs summary. +`C_VoiceChat.MarkChannelsDiscovered()` + +**Description:** +Once the UI has enumerated all channels, use this to reset the channel discovery state, it will be updated again if appropriate. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md b/wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md new file mode 100644 index 00000000..56fac07f --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md @@ -0,0 +1,11 @@ +## Title: C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel + +**Content:** +Needs summary. +`C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel(clubId, streamId)` + +**Parameters:** +- `clubId` + - *string* +- `streamId` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md b/wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md new file mode 100644 index 00000000..a3776c26 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md @@ -0,0 +1,37 @@ +## Title: C_VoiceChat.RequestJoinChannelByChannelType + +**Content:** +Needs summary. +`C_VoiceChat.RequestJoinChannelByChannelType(channelType)` + +**Parameters:** +- `channelType` + - *Enum.ChatChannelType* + - `Value` + - `Field` + - `Description` + - `0` + - `None` + - `1` + - `Custom` + - `2` + - `Private_Party` + - Documented as "PrivateParty" + - `3` + - `Public_Party` + - Documented as "PublicParty" + - `4` + - `Communities` + +**Additional Information:** +- `autoActivate` + - *boolean?* + +**Example Usage:** +```lua +-- Example of joining a custom voice chat channel +C_VoiceChat.RequestJoinChannelByChannelType(Enum.ChatChannelType.Custom) +``` + +**Addons Usage:** +Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to facilitate voice communication within custom or party channels, enhancing coordination during raids or group activities. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetCommunicationMode.md b/wiki-information/functions/C_VoiceChat.SetCommunicationMode.md new file mode 100644 index 00000000..0b4e5dcd --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetCommunicationMode.md @@ -0,0 +1,17 @@ +## Title: C_VoiceChat.SetCommunicationMode + +**Content:** +Needs summary. +`C_VoiceChat.SetCommunicationMode(communicationMode)` + +**Parameters:** +- `communicationMode` + - *Enum.CommunicationMode* + - `Enum.CommunicationMode` + - **Value** + - **Field** + - **Description** + - `0` + - PushToTalk + - `1` + - OpenMic \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetDeafened.md b/wiki-information/functions/C_VoiceChat.SetDeafened.md new file mode 100644 index 00000000..d345feb4 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetDeafened.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetDeafened + +**Content:** +Needs summary. +`C_VoiceChat.SetDeafened(isDeafened)` + +**Parameters:** +- `isDeafened` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetInputDevice.md b/wiki-information/functions/C_VoiceChat.SetInputDevice.md new file mode 100644 index 00000000..c4a7dfda --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetInputDevice.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetInputDevice + +**Content:** +Needs summary. +`C_VoiceChat.SetInputDevice(deviceID)` + +**Parameters:** +- `deviceID` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetInputVolume.md b/wiki-information/functions/C_VoiceChat.SetInputVolume.md new file mode 100644 index 00000000..b7d478da --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetInputVolume.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetInputVolume + +**Content:** +Needs summary. +`C_VoiceChat.SetInputVolume(volume)` + +**Parameters:** +- `volume` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md b/wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md new file mode 100644 index 00000000..aaacceed --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetMasterVolumeScale + +**Content:** +Needs summary. +`C_VoiceChat.SetMasterVolumeScale(scale)` + +**Parameters:** +- `scale` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMemberMuted.md b/wiki-information/functions/C_VoiceChat.SetMemberMuted.md new file mode 100644 index 00000000..6ec61f2b --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetMemberMuted.md @@ -0,0 +1,19 @@ +## Title: C_VoiceChat.SetMemberMuted + +**Content:** +Needs summary. +`C_VoiceChat.SetMemberMuted(playerLocation, muted)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* - The location of the player to be muted. +- `muted` + - *boolean* - Whether the player should be muted (true) or unmuted (false). + +**Example Usage:** +```lua +local playerLocation = PlayerLocation:CreateFromUnit("target") +C_VoiceChat.SetMemberMuted(playerLocation, true) +``` + +This function can be used to programmatically mute or unmute a player in voice chat, which can be useful in addons that manage voice communication, such as raid coordination tools or social addons. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMemberVolume.md b/wiki-information/functions/C_VoiceChat.SetMemberVolume.md new file mode 100644 index 00000000..87f776cb --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetMemberVolume.md @@ -0,0 +1,14 @@ +## Title: C_VoiceChat.SetMemberVolume + +**Content:** +Needs summary. +`C_VoiceChat.SetMemberVolume(playerLocation, volume)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* +- `volume` + - *number* + +**Description:** +Adjusts member volume across all channels. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMuted.md b/wiki-information/functions/C_VoiceChat.SetMuted.md new file mode 100644 index 00000000..0929b73b --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetMuted.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetMuted + +**Content:** +Needs summary. +`C_VoiceChat.SetMuted(isMuted)` + +**Parameters:** +- `isMuted` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetOutputDevice.md b/wiki-information/functions/C_VoiceChat.SetOutputDevice.md new file mode 100644 index 00000000..ac00271b --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetOutputDevice.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetOutputDevice + +**Content:** +Needs summary. +`C_VoiceChat.SetOutputDevice(deviceID)` + +**Parameters:** +- `deviceID` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetOutputVolume.md b/wiki-information/functions/C_VoiceChat.SetOutputVolume.md new file mode 100644 index 00000000..a8aea529 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetOutputVolume.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetOutputVolume + +**Content:** +Needs summary. +`C_VoiceChat.SetOutputVolume(volume)` + +**Parameters:** +- `volume` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetPortraitTexture.md b/wiki-information/functions/C_VoiceChat.SetPortraitTexture.md new file mode 100644 index 00000000..af6aa557 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetPortraitTexture.md @@ -0,0 +1,19 @@ +## Title: C_VoiceChat.SetPortraitTexture + +**Content:** +Needs summary. +`C_VoiceChat.SetPortraitTexture(textureObject, memberID, channelID)` + +**Parameters:** +- `textureObject` + - *table* +- `memberID` + - *number* +- `channelID` + - *number* + +**Example Usage:** +This function can be used to set the portrait texture for a voice chat member in a specific channel. For instance, if you are developing an addon that manages voice chat and you want to display the portrait of each member in the chat, you can use this function to set the appropriate texture. + +**Addon Usage:** +Large addons like **ElvUI** or **DBM (Deadly Boss Mods)** might use this function to enhance their voice chat features, such as displaying member portraits in custom UI elements or during boss encounters to show who is speaking. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md b/wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md new file mode 100644 index 00000000..ba419f15 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetPushToTalkBinding + +**Content:** +Needs summary. +`C_VoiceChat.SetPushToTalkBinding(keys)` + +**Parameters:** +- `keys` + - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetVADSensitivity.md b/wiki-information/functions/C_VoiceChat.SetVADSensitivity.md new file mode 100644 index 00000000..e695e88b --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SetVADSensitivity.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SetVADSensitivity + +**Content:** +Needs summary. +`C_VoiceChat.SetVADSensitivity(sensitivity)` + +**Parameters:** +- `sensitivity` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md b/wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md new file mode 100644 index 00000000..3cd28206 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md @@ -0,0 +1,12 @@ +## Title: C_VoiceChat.ShouldDiscoverChannels + +**Content:** +Needs summary. +`shouldDiscoverChannels = C_VoiceChat.ShouldDiscoverChannels()` + +**Returns:** +- `shouldDiscoverChannels` + - *boolean* + +**Description:** +Use this while loading to determine if the UI should attempt to rediscover the previously joined/active voice channels. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md b/wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md new file mode 100644 index 00000000..b7ad7462 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.SpeakRemoteTextSample + +**Content:** +Needs summary. +`C_VoiceChat.SpeakRemoteTextSample(text)` + +**Parameters:** +- `text` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SpeakText.md b/wiki-information/functions/C_VoiceChat.SpeakText.md new file mode 100644 index 00000000..9d8c4b58 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.SpeakText.md @@ -0,0 +1,41 @@ +## Title: C_VoiceChat.SpeakText + +**Content:** +Reads text to speech. +`C_VoiceChat.SpeakText(voiceID, text, destination, rate, volume)` + +**Parameters:** +- `voiceID` + - *number* - Voice IDs from `.GetTtsVoices` or `.GetRemoteTtsVoices`. +- `text` + - *string* - The message to speak. +- `destination` + - *Enum.VoiceTtsDestination* + - `Value` + - `Field` + - `Description` + - `0` - RemoteTransmission + - `1` - LocalPlayback + - `2` - RemoteTransmissionWithLocalPlayback + - `3` - QueuedRemoteTransmission + - `4` - QueuedLocalPlayback + - `5` - QueuedRemoteTransmissionWithLocalPlayback + - `6` - ScreenReader +- `rate` + - *number* - Speech rate; the speed at which the text is read. +- `volume` + - *number* - Volume level of the speech. + +**Description:** +Despite the name, nearly-simultaneous queued messages will play out of order; the 'queue' is neither FIFO or LIFO. +The languages packs installed will vary, and it is possible for none to be installed. The user's local preferences may be found with `C_TTSSettings.GetVoiceOptionID`. + +**Usage:** +Speaks a message with Microsoft David (enUS system locale). +```lua +/run C_VoiceChat.SpeakText(0, "Hello world", Enum.VoiceTtsDestination.LocalPlayback, 0, 100) +``` +Speaks a message with Microsoft Zira (enUS system locale), with a slower speech rate. +```lua +/run C_VoiceChat.SpeakText(1, "Hello world", Enum.VoiceTtsDestination.LocalPlayback, -10, 100) +``` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.StopSpeakingText.md b/wiki-information/functions/C_VoiceChat.StopSpeakingText.md new file mode 100644 index 00000000..561b7f22 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.StopSpeakingText.md @@ -0,0 +1,5 @@ +## Title: C_VoiceChat.StopSpeakingText + +**Content:** +Needs summary. +`C_VoiceChat.StopSpeakingText()` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ToggleDeafened.md b/wiki-information/functions/C_VoiceChat.ToggleDeafened.md new file mode 100644 index 00000000..f89a6429 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.ToggleDeafened.md @@ -0,0 +1,5 @@ +## Title: C_VoiceChat.ToggleDeafened + +**Content:** +Needs summary. +`C_VoiceChat.ToggleDeafened()` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md b/wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md new file mode 100644 index 00000000..abfaff16 --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md @@ -0,0 +1,9 @@ +## Title: C_VoiceChat.ToggleMemberMuted + +**Content:** +Needs summary. +`C_VoiceChat.ToggleMemberMuted(playerLocation)` + +**Parameters:** +- `playerLocation` + - *PlayerLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ToggleMuted.md b/wiki-information/functions/C_VoiceChat.ToggleMuted.md new file mode 100644 index 00000000..0fcb3b5a --- /dev/null +++ b/wiki-information/functions/C_VoiceChat.ToggleMuted.md @@ -0,0 +1,5 @@ +## Title: C_VoiceChat.ToggleMuted + +**Content:** +Needs summary. +`C_VoiceChat.ToggleMuted()` \ No newline at end of file diff --git a/wiki-information/functions/C_XMLUtil.GetTemplateInfo.md b/wiki-information/functions/C_XMLUtil.GetTemplateInfo.md new file mode 100644 index 00000000..8093c264 --- /dev/null +++ b/wiki-information/functions/C_XMLUtil.GetTemplateInfo.md @@ -0,0 +1,38 @@ +## Title: C_XMLUtil.GetTemplateInfo + +**Content:** +Returns information about a defined XML template. +`info = C_XMLUtil.GetTemplateInfo(name)` + +**Parameters:** +- `name` + - *string* - The name of the template to query. + +**Returns:** +- `info` + - *XMLTemplateInfo?* - Information about the queried template if found, or nil if the template does not exist. + - `Field` + - `Type` + - `Description` + - `type` + - *string* - The frame type ("Frame", "Button", etc.) of the XML template. + - `width` + - *number* - The statically defined width present in a `` element on the template. If no width is defined, this will be zero. + - `height` + - *number* - The statically defined height present in a `` element on the template. If no height is defined, this will be zero. + - `inherits` + - *string?* - A comma-delimited string of inherited templates, matching the inherits XML attribute. If no templates are inherited, this will be nil. + - `keyValues` + - *XMLTemplateKeyValue* - A list of defined key/value pairs defined within a `` element on the template. If no key/values pairs are defined, this will be an empty table. + - `XMLTemplateKeyValue` + - `Field` + - `Type` + - `Description` + - `key` + - *string* - The value used as the key when this template is instantiated. This will be the string as-supplied in the key attribute on the `` element itself and not the actual Lua value. + - `keyType` + - *string* - The type of the defined key. + - `type` + - *string* - The type of the defined value. + - `value` + - *string* - The value assigned to the key when this template is instantiated. This will be the string as-supplied in the value attribute on the `` element itself and not the actual Lua value. \ No newline at end of file diff --git a/wiki-information/functions/C_XMLUtil.GetTemplates.md b/wiki-information/functions/C_XMLUtil.GetTemplates.md new file mode 100644 index 00000000..2482103e --- /dev/null +++ b/wiki-information/functions/C_XMLUtil.GetTemplates.md @@ -0,0 +1,24 @@ +## Title: C_XMLUtil.GetTemplates + +**Content:** +Returns a list of all registered XML templates. +`templates = C_XMLUtil.GetTemplates()` + +**Returns:** +- `templates` + - *XMLTemplateListInfo* - An array of tables for each registered XML template. + - `Field` + - `Type` + - `Description` + - `name` + - *string* - The name of the XML template. + - `type` + - *string* - The frame type ("Frame", "Button", etc.) of the XML template. + +**Usage:** +The following snippet will print all the names and frame types of registered XML templates. +```lua +for _, template in ipairs(C_XMLUtil.GetTemplates()) do + print(template.name, template.type) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/CalculateStringEditDistance.md b/wiki-information/functions/CalculateStringEditDistance.md new file mode 100644 index 00000000..beeca6c4 --- /dev/null +++ b/wiki-information/functions/CalculateStringEditDistance.md @@ -0,0 +1,30 @@ +## Title: CalculateStringEditDistance + +**Content:** +Needs summary. +`distance = CalculateStringEditDistance(firstString, secondString)` + +**Parameters:** +- `firstString` + - *stringView* +- `secondString` + - *stringView* + +**Returns:** +- `distance` + - *number* + +**Description:** +This function calculates the edit distance between two strings, which is a measure of how dissimilar two strings are to one another by counting the minimum number of operations required to transform one string into the other. This can be useful for various text processing tasks, such as spell checking, DNA sequence analysis, and natural language processing. + +**Example Usage:** +```lua +local str1 = "kitten" +local str2 = "sitting" +local distance = CalculateStringEditDistance(str1, str2) +print("The edit distance between 'kitten' and 'sitting' is:", distance) +``` + +**Addons Using This Function:** +- **WeakAuras**: This popular addon for creating custom visual and audio alerts uses `CalculateStringEditDistance` to compare strings for various triggers and conditions. +- **ElvUI**: A comprehensive UI overhaul addon that might use this function for comparing user input strings for configuration and customization purposes. \ No newline at end of file diff --git a/wiki-information/functions/CallCompanion.md b/wiki-information/functions/CallCompanion.md new file mode 100644 index 00000000..8b3deed5 --- /dev/null +++ b/wiki-information/functions/CallCompanion.md @@ -0,0 +1,28 @@ +## Title: CallCompanion + +**Content:** +Summons a companion. +`CallCompanion(type, id)` + +**Parameters:** +- `type` + - *string* - The type of companion to summon or dismiss: "CRITTER" or "MOUNT". +- `id` + - *number* - The companion index to summon or dismiss, ascending from 1. + +**Usage:** +The following macro summons the first mount your character has acquired: +```lua +/run CallCompanion("MOUNT",1) +``` +The following macro summons a random mount your character has acquired: +```lua +/run CallCompanion("MOUNT", random(GetNumCompanions("MOUNT"))) +``` + +**Description:** +The list of companions is usually, but not always, alphabetically sorted. You may not rely on the indices to remain stable, even if the number of companions is not altered. + +**Reference:** +- `GetNumCompanions` +- `GetCompanionInfo` \ No newline at end of file diff --git a/wiki-information/functions/CameraOrSelectOrMoveStart.md b/wiki-information/functions/CameraOrSelectOrMoveStart.md new file mode 100644 index 00000000..258d4996 --- /dev/null +++ b/wiki-information/functions/CameraOrSelectOrMoveStart.md @@ -0,0 +1,10 @@ +## Title: CameraOrSelectOrMoveStart + +**Content:** +Begin "Left click" in the 3D world. +`CameraOrSelectOrMoveStart()` + +**Description:** +This function is called when left-clicking in the 3-D world. It is most useful for selecting a target for a pending spell cast. +Calling this function clears the "mouseover" unit. +When used alone, puts you into a "mouselook" mode until `CameraOrSelectOrMoveStop` is called. \ No newline at end of file diff --git a/wiki-information/functions/CameraOrSelectOrMoveStop.md b/wiki-information/functions/CameraOrSelectOrMoveStop.md new file mode 100644 index 00000000..d49f3f75 --- /dev/null +++ b/wiki-information/functions/CameraOrSelectOrMoveStop.md @@ -0,0 +1,14 @@ +## Title: CameraOrSelectOrMoveStop + +**Content:** +Called when you release the "Left-Click" mouse button. +`CameraOrSelectOrMoveStop()` + +**Parameters:** +- `stickyFlag` + - *Flag (optional)* - If present and set then any camera offset is 'sticky' and remains until explicitly cancelled. + +**Description:** +This function is called when left-clicking in the 3-D world. +When used alone, it can cancel a "mouselook" started by a call to `CameraOrSelectOrMoveStart`. +**IMPORTANT:** The normal restrictions regarding hardware event initiations still apply to anything this function might do. \ No newline at end of file diff --git a/wiki-information/functions/CameraZoomIn.md b/wiki-information/functions/CameraZoomIn.md new file mode 100644 index 00000000..165827dc --- /dev/null +++ b/wiki-information/functions/CameraZoomIn.md @@ -0,0 +1,13 @@ +## Title: CameraZoomIn + +**Content:** +Zooms the camera in. +`CameraZoomIn(increment)` + +**Parameters:** +- `(float increment)` + +**Description:** +Zooms the camera into the viewplane by increment. The increment must be between 0.0 and 50 with 0.0 indicating no zoom relative to current view and 50 being maximum zoom. From a completely zoomed out position, an increment of 50 will result in a first person camera angle. + +As of patch 1.9.0, if the 'Interface Options > Advanced Options > Max Camera Distance' setting is set to Low, then the largest value for increment is 15. If this setting is set to High, then the largest value for increment is 30. With `/console CVar_cameraDistanceMaxFactor` the maximum value is 50. \ No newline at end of file diff --git a/wiki-information/functions/CanAbandonQuest.md b/wiki-information/functions/CanAbandonQuest.md new file mode 100644 index 00000000..b571e227 --- /dev/null +++ b/wiki-information/functions/CanAbandonQuest.md @@ -0,0 +1,16 @@ +## Title: CanAbandonQuest + +**Content:** +Returns whether the player can abandon a specific quest. +`canAbandon = CanAbandonQuest(questID)` + +**Parameters:** +- `questID` + - *number* - quest ID of the quest to query, e.g. 5944 for In Dreams. + +**Returns:** +- `canAbandon` + - *boolean* - 1 if the player is currently on the specified quest and can abandon it, nil otherwise. + +**Description:** +Some quests cannot be abandoned. These include some of the Battle Pet Tamers quests. \ No newline at end of file diff --git a/wiki-information/functions/CanBeRaidTarget.md b/wiki-information/functions/CanBeRaidTarget.md new file mode 100644 index 00000000..5e7244ae --- /dev/null +++ b/wiki-information/functions/CanBeRaidTarget.md @@ -0,0 +1,22 @@ +## Title: CanBeRaidTarget + +**Content:** +Returns true if the unit can be marked with a raid target icon. +`canBeRaidTarget = CanBeRaidTarget(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `canBeRaidTarget` + - *boolean* - true if raid target markers can be assigned to the queried unit, false otherwise. + +**Reference:** +- `SetRaidTarget` + +**Example Usage:** +This function can be used in a raid addon to determine if a specific unit can be marked with a raid target icon. For instance, in a boss encounter, you might want to mark certain adds or players with specific icons for better coordination. + +**Addons Using This Function:** +Many raid management addons, such as Deadly Boss Mods (DBM) and BigWigs, use this function to automate the marking of units during encounters. This helps raid leaders quickly assign targets without manual intervention. \ No newline at end of file diff --git a/wiki-information/functions/CanChangePlayerDifficulty.md b/wiki-information/functions/CanChangePlayerDifficulty.md new file mode 100644 index 00000000..22308b17 --- /dev/null +++ b/wiki-information/functions/CanChangePlayerDifficulty.md @@ -0,0 +1,11 @@ +## Title: CanChangePlayerDifficulty + +**Content:** +Needs summary. +`canChange, notOnCooldown = CanChangePlayerDifficulty()` + +**Returns:** +- `canChange` + - *boolean* +- `notOnCooldown` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanDualWield.md b/wiki-information/functions/CanDualWield.md new file mode 100644 index 00000000..5f43b04f --- /dev/null +++ b/wiki-information/functions/CanDualWield.md @@ -0,0 +1,73 @@ +## Title: CanDualWield + +**Content:** +Returns whether the player can dual wield weapons. +`canDualWield = CanDualWield()` + +**Returns:** +- `canDualWield` + - *boolean* - This returns true if One-Hand weapons can be equipped into both `INVSLOT_MAINHAND` and `INVSLOT_OFFHAND`. + +**Description:** +Fury Warriors can dual wield one-hand weapons, and two-hand weapons (or a combination) from the baseline passive. + +**Parameters:** +- **Retail:** + - **Class** + - **CanDualWield** + - **IsSpellKnown** + - **IsPlayerSpell** + - Rogue + - ✔️ + - ❌ 674 + - ✔️ 674 + - Hunter + - ✔️ + - ❌ 674 + - ✔️ 674 + - Demon Hunter + - ✔️ + - ❌ 674 + - ✔️ 674 + - Frost Death Knight + - ✔️ + - ❌ 674 + - ✔️ 674 + - Brewmaster Monk + - ✔️ + - ❌ 674 + - ❌ 674 + - Windwalker Monk + - ✔️ + - ❌ 674 + - ❌ 674 + - Enhancement Shaman + - ✔️ + - ❌ 674 + - ❌ 674 + - Fury Warrior + - ✔️ + - ❌ 674, ✔️ 46917 + - ❌ 674, ✔️ 46917 + +- **Classic:** + - **Class** + - **CanDualWield** + - **IsSpellKnown** + - **IsPlayerSpell** + - Rogue (level 10) + - ✔️ + - ✔️ 674 + - ✔️ 674 + - Hunter (level 20) + - ✔️ + - ✔️ 674 + - ✔️ 674 + - Warrior (level 20) + - ✔️ + - ✔️ 674 + - ✔️ 674 + +**Reference:** +- `Enum.InventoryType` +- `InventorySlotId` \ No newline at end of file diff --git a/wiki-information/functions/CanEditMOTD.md b/wiki-information/functions/CanEditMOTD.md new file mode 100644 index 00000000..6296b945 --- /dev/null +++ b/wiki-information/functions/CanEditMOTD.md @@ -0,0 +1,9 @@ +## Title: CanEditMOTD + +**Content:** +Returns true if the player can edit the guild message of the day. +`canEdit = CanEditMOTD()` + +**Returns:** +- `canEdit` + - *boolean* - Returns true if the player can edit the guild MOTD \ No newline at end of file diff --git a/wiki-information/functions/CanEjectPassengerFromSeat.md b/wiki-information/functions/CanEjectPassengerFromSeat.md new file mode 100644 index 00000000..b989ae19 --- /dev/null +++ b/wiki-information/functions/CanEjectPassengerFromSeat.md @@ -0,0 +1,13 @@ +## Title: CanEjectPassengerFromSeat + +**Content:** +Needs summary. +`canEject = CanEjectPassengerFromSeat(virtualSeatIndex)` + +**Parameters:** +- `virtualSeatIndex` + - *number* + +**Returns:** +- `canEject` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanGrantLevel.md b/wiki-information/functions/CanGrantLevel.md new file mode 100644 index 00000000..5c539f5c --- /dev/null +++ b/wiki-information/functions/CanGrantLevel.md @@ -0,0 +1,24 @@ +## Title: CanGrantLevel + +**Content:** +Returns whether you can grant levels to a particular player. +`status = CanGrantLevel(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `status` + - *boolean* - true if you can grant levels to the unit; nil otherwise (unit is not RAF-linked to you, does not meet level requirements, or you are out of levels to grant). + +**Usage:** +The snippet below prints whether you can grant levels to your target right now. +```lua +local status = CanGrantLevel("target") +if status then + print("I can grant levels to my friend!") +else + print("I am out of free levels for now.") +end +``` \ No newline at end of file diff --git a/wiki-information/functions/CanGuildDemote.md b/wiki-information/functions/CanGuildDemote.md new file mode 100644 index 00000000..d2a85674 --- /dev/null +++ b/wiki-information/functions/CanGuildDemote.md @@ -0,0 +1,15 @@ +## Title: CanGuildDemote + +**Content:** +Returns true if the player can demote guild members. +`canDemote = CanGuildDemote()` + +**Returns:** +- `canDemote` + - *boolean* - Returns true if the player can demote. + +**Example Usage:** +This function can be used in a guild management addon to check if the current player has the permissions to demote other guild members. For instance, before displaying the demote option in a guild member's context menu, the addon can call `CanGuildDemote()` to ensure the player has the necessary permissions. + +**Addons Using This Function:** +Large guild management addons like "Guild Roster Manager" may use this function to manage guild ranks and permissions effectively. It helps in ensuring that only players with the appropriate permissions can perform demotions within the guild. \ No newline at end of file diff --git a/wiki-information/functions/CanGuildInvite.md b/wiki-information/functions/CanGuildInvite.md new file mode 100644 index 00000000..d18bc13c --- /dev/null +++ b/wiki-information/functions/CanGuildInvite.md @@ -0,0 +1,9 @@ +## Title: CanGuildInvite + +**Content:** +Returns true if the player can invite new members to the guild. +`canInvite = CanGuildInvite()` + +**Returns:** +- `canInvite` + - *boolean* - Whether you can invite people to your current guild \ No newline at end of file diff --git a/wiki-information/functions/CanGuildPromote.md b/wiki-information/functions/CanGuildPromote.md new file mode 100644 index 00000000..27f05793 --- /dev/null +++ b/wiki-information/functions/CanGuildPromote.md @@ -0,0 +1,22 @@ +## Title: CanGuildPromote + +**Content:** +Returns true if the player can promote guild members. +`canPromote = CanGuildPromote()` + +**Returns:** +- `canPromote` + - *boolean* - Returns 1 if the player can promote, nil if not. + +**Usage:** +```lua +if CanGuildPromote() then + -- do stuff +end +``` + +**Example Use Case:** +This function can be used in guild management addons to check if the current player has the permission to promote other guild members. For instance, an addon that automates guild promotions based on certain criteria can use this function to ensure the player has the necessary permissions before attempting to promote a member. + +**Addons Using This Function:** +Many guild management addons, such as "Guild Roster Manager" and "GuildMaster", use this function to manage guild ranks and permissions effectively. These addons often include features like automated promotions, demotions, and rank adjustments based on player activity and contributions. \ No newline at end of file diff --git a/wiki-information/functions/CanInspect.md b/wiki-information/functions/CanInspect.md new file mode 100644 index 00000000..a3e59cd4 --- /dev/null +++ b/wiki-information/functions/CanInspect.md @@ -0,0 +1,21 @@ +## Title: CanInspect + +**Content:** +Returns true if the player can inspect the unit. +`canInspect = CanInspect(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId +- `showError` + - *boolean?* - If true, the function will display an error message ("You can't inspect that unit") if you cannot inspect the specified unit. + +**Returns:** +- `canInspect` + - *boolean* - True if you can inspect the specified unit + +**Description:** +You cannot inspect NPCs, nor PvP-enabled hostile players in PvP-enabled locations. + +**Reference:** +- `NotifyInspect` \ No newline at end of file diff --git a/wiki-information/functions/CanJoinBattlefieldAsGroup.md b/wiki-information/functions/CanJoinBattlefieldAsGroup.md new file mode 100644 index 00000000..fbd03606 --- /dev/null +++ b/wiki-information/functions/CanJoinBattlefieldAsGroup.md @@ -0,0 +1,21 @@ +## Title: CanJoinBattlefieldAsGroup + +**Content:** +Returns true if the player can join a battlefield with a group. +`isTrue = CanJoinBattlefieldAsGroup()` + +**Returns:** +- `isTrue` + - *boolean* - returns true, if the player can join the battlefield as group + +**Usage:** +```lua +if (CanJoinBattlefieldAsGroup()) then + JoinBattlefield(0, 1) -- join battlefield as group +else + JoinBattlefield(0, 0) -- join battlefield as single player +end +``` + +**Result:** +Queries the player either as group or as single player. \ No newline at end of file diff --git a/wiki-information/functions/CanLootUnit.md b/wiki-information/functions/CanLootUnit.md new file mode 100644 index 00000000..ea0a1fd5 --- /dev/null +++ b/wiki-information/functions/CanLootUnit.md @@ -0,0 +1,15 @@ +## Title: CanLootUnit + +**Content:** +Needs summary. +`hasLoot, canLoot = CanLootUnit(targetUnit)` + +**Parameters:** +- `targetUnit` + - *string* : WOWGUID + +**Returns:** +- `hasLoot` + - *boolean* +- `canLoot` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanMerchantRepair.md b/wiki-information/functions/CanMerchantRepair.md new file mode 100644 index 00000000..6b7fac35 --- /dev/null +++ b/wiki-information/functions/CanMerchantRepair.md @@ -0,0 +1,9 @@ +## Title: CanMerchantRepair + +**Content:** +Returns true if the merchant can repair items. +`canRepair = CanMerchantRepair()` + +**Returns:** +- `canRepair` + - *number* - Is 1 if the merchant can repair, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/CanReplaceGuildMaster.md b/wiki-information/functions/CanReplaceGuildMaster.md new file mode 100644 index 00000000..37e92893 --- /dev/null +++ b/wiki-information/functions/CanReplaceGuildMaster.md @@ -0,0 +1,13 @@ +## Title: CanReplaceGuildMaster + +**Content:** +Returns whether you can impeach the Guild Master due to inactivity. +`canReplace = CanReplaceGuildMaster()` + +**Returns:** +- `canReplace` + - *boolean* - true if you can replace the Guild Master. + +**Reference:** +- `ReplaceGuildMaster` + - New in 4.3: Inactive Guild Leader Replacement \ No newline at end of file diff --git a/wiki-information/functions/CanSendAuctionQuery.md b/wiki-information/functions/CanSendAuctionQuery.md new file mode 100644 index 00000000..01fd64e4 --- /dev/null +++ b/wiki-information/functions/CanSendAuctionQuery.md @@ -0,0 +1,15 @@ +## Title: CanSendAuctionQuery + +**Content:** +Determine if a new auction house query can be sent (via `QueryAuctionItems()`) +`canQuery, canQueryAll = CanSendAuctionQuery()` + +**Returns:** +- `canQuery` + - *boolean* - True if a normal auction house query can be made +- `canQueryAll` + - *boolean* - True if a full ("getall") auction house query can be made (added in 2.3) + +**Description:** +There is always a short delay (usually less than a second) after each query before another query can take place. +Full ("getall") queries are only allowed once every ~15 minutes. \ No newline at end of file diff --git a/wiki-information/functions/CanShowAchievementUI.md b/wiki-information/functions/CanShowAchievementUI.md new file mode 100644 index 00000000..2c6ed7ea --- /dev/null +++ b/wiki-information/functions/CanShowAchievementUI.md @@ -0,0 +1,14 @@ +## Title: CanShowAchievementUI + +**Content:** +Returns if the AchievementUI can be displayed. +`canShow = CanShowAchievementUI()` + +**Returns:** +- `canShow` + - *boolean* - true if the achievement data is available (and hence the AchievementUI can be displayed), false otherwise. + +**Description:** +This function returns false if called while the player is logging in (but not on subsequent UI reloads). +Achievement completion data is streamed to the client when the character logs in. +The streaming process is indicated by `RECEIVED_ACHIEVEMENT_LIST` events and generally completes before `PLAYER_LOGIN`. \ No newline at end of file diff --git a/wiki-information/functions/CanShowResetInstances.md b/wiki-information/functions/CanShowResetInstances.md new file mode 100644 index 00000000..da5cb5fa --- /dev/null +++ b/wiki-information/functions/CanShowResetInstances.md @@ -0,0 +1,9 @@ +## Title: CanShowResetInstances + +**Content:** +Returns true if the character can currently reset their instances. +`canReset = CanShowResetInstances()` + +**Returns:** +- `canReset` + - *boolean* - true if player can reset instances \ No newline at end of file diff --git a/wiki-information/functions/CanSummonFriend.md b/wiki-information/functions/CanSummonFriend.md new file mode 100644 index 00000000..d88d3197 --- /dev/null +++ b/wiki-information/functions/CanSummonFriend.md @@ -0,0 +1,23 @@ +## Title: CanSummonFriend + +**Content:** +Returns whether you can RaF summon a particular unit. +`summonable = CanSummonFriend(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The player to check whether you can summon. + +**Returns:** +- `summonable` + - *boolean* - 1 if you can summon the unit using RaF, nil otherwise. + +**Usage:** +The snippet below checks whether you can summon the target, and, if so, whispers and summons her to you. +```lua +local t = "target"; +if CanSummonFriend(t) then + SendChatMessage("I am summoning you!", "WHISPER", nil, t) + SummonFriend(t) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/CanSwitchVehicleSeat.md b/wiki-information/functions/CanSwitchVehicleSeat.md new file mode 100644 index 00000000..09f9cc2d --- /dev/null +++ b/wiki-information/functions/CanSwitchVehicleSeat.md @@ -0,0 +1,9 @@ +## Title: CanSwitchVehicleSeat + +**Content:** +Needs summary. +`canSwitch = CanSwitchVehicleSeat()` + +**Returns:** +- `canSwitch` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanUpgradeExpansion.md b/wiki-information/functions/CanUpgradeExpansion.md new file mode 100644 index 00000000..16892061 --- /dev/null +++ b/wiki-information/functions/CanUpgradeExpansion.md @@ -0,0 +1,9 @@ +## Title: CanUpgradeExpansion + +**Content:** +Needs summary. +`canUpgradeExpansion = CanUpgradeExpansion()` + +**Returns:** +- `canUpgradeExpansion` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CancelDuel.md b/wiki-information/functions/CancelDuel.md new file mode 100644 index 00000000..5d8d0de0 --- /dev/null +++ b/wiki-information/functions/CancelDuel.md @@ -0,0 +1,18 @@ +## Title: CancelDuel + +**Content:** +Forfeits the current duel or declines a duel invitation. +`CancelDuel()` + +**Reference:** +- `StartDuel` +- `AcceptDuel` + +**Example Usage:** +```lua +-- If the player is currently in a duel and wants to forfeit +CancelDuel() +``` + +**Addons Usage:** +Many PvP-related addons might use `CancelDuel` to provide users with a quick way to forfeit duels through the addon interface. For example, an addon that manages PvP settings and preferences might include a button to cancel ongoing duels. \ No newline at end of file diff --git a/wiki-information/functions/CancelItemTempEnchantment.md b/wiki-information/functions/CancelItemTempEnchantment.md new file mode 100644 index 00000000..df78dcb5 --- /dev/null +++ b/wiki-information/functions/CancelItemTempEnchantment.md @@ -0,0 +1,15 @@ +## Title: CancelItemTempEnchantment + +**Content:** +Removes temporary weapon enchants (e.g. Rogue poisons and sharpening stones). +`CancelItemTempEnchantment(weaponHand)` + +**Parameters:** +- `weaponHand` + - *number* - 1 for Main Hand, 2 for Off Hand. + +**Example Usage:** +This function can be used in macros or addons to remove temporary enchants from weapons. For instance, a Rogue might use this to remove poisons from their weapons before applying a different type of poison. + +**Addons:** +Many large addons, such as WeakAuras, might use this function to manage weapon enchants dynamically based on certain conditions or triggers. \ No newline at end of file diff --git a/wiki-information/functions/CancelLogout.md b/wiki-information/functions/CancelLogout.md new file mode 100644 index 00000000..3f2ac391 --- /dev/null +++ b/wiki-information/functions/CancelLogout.md @@ -0,0 +1,8 @@ +## Title: CancelLogout + +**Content:** +Cancels the logout timer (from camping or quitting). +`CancelLogout()` + +**Description:** +This is called whenever the logout dialogs are hidden. \ No newline at end of file diff --git a/wiki-information/functions/CancelPendingEquip.md b/wiki-information/functions/CancelPendingEquip.md new file mode 100644 index 00000000..9a7ea6ca --- /dev/null +++ b/wiki-information/functions/CancelPendingEquip.md @@ -0,0 +1,12 @@ +## Title: CancelPendingEquip + +**Content:** +Cancels a pending equip confirmation. +`CancelPendingEquip(slot)` + +**Parameters:** +- `slot` + - *number* - equipment slot to cancel equipping an item to. + +**Description:** +When attempting to equip an item which will become soulbound, the equip operation is suspended, and a dialog is presented for the user to decide whether or not to proceed. This call is made by that dialog if the user decides not to equip the item. \ No newline at end of file diff --git a/wiki-information/functions/CancelPreloadingMovie.md b/wiki-information/functions/CancelPreloadingMovie.md new file mode 100644 index 00000000..8ada6af0 --- /dev/null +++ b/wiki-information/functions/CancelPreloadingMovie.md @@ -0,0 +1,9 @@ +## Title: CancelPreloadingMovie + +**Content:** +Needs summary. +`CancelPreloadingMovie(movieId)` + +**Parameters:** +- `movieId` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/CancelShapeshiftForm.md b/wiki-information/functions/CancelShapeshiftForm.md new file mode 100644 index 00000000..d519855f --- /dev/null +++ b/wiki-information/functions/CancelShapeshiftForm.md @@ -0,0 +1,9 @@ +## Title: CancelShapeshiftForm + +**Content:** +Cancels a shapeshift form. +`CancelShapeshiftForm()` + +**Description:** +Shapeshifting cannot be cancelled through normal buff functions as that would allow insecure code to manipulate the macro conditional. +You can use `/cancelform` in a macro instead. \ No newline at end of file diff --git a/wiki-information/functions/CancelTrackingBuff.md b/wiki-information/functions/CancelTrackingBuff.md new file mode 100644 index 00000000..492924a5 --- /dev/null +++ b/wiki-information/functions/CancelTrackingBuff.md @@ -0,0 +1,11 @@ +## Title: CancelTrackingBuff + +**Content:** +Cancels your current tracking buff (skills like Find Minerals and Track Humanoids). +`CancelTrackingBuff()` + +**Example Usage:** +This function can be used in macros or addons to automatically cancel a tracking buff. For instance, if a player wants to switch from tracking minerals to tracking herbs, they can use this function to cancel the current tracking buff before applying the new one. + +**Addons:** +Many large addons related to gathering professions, such as GatherMate2, may use this function to manage tracking buffs efficiently. For example, an addon could automatically switch tracking based on the player's current zone or the resources they are most interested in. \ No newline at end of file diff --git a/wiki-information/functions/CancelTrade.md b/wiki-information/functions/CancelTrade.md new file mode 100644 index 00000000..103bdcf7 --- /dev/null +++ b/wiki-information/functions/CancelTrade.md @@ -0,0 +1,11 @@ +## Title: CancelTrade + +**Content:** +Declines the current trade offer. +`CancelTrade()` + +**Parameters:** +- None + +**Returns:** +- None \ No newline at end of file diff --git a/wiki-information/functions/CancelUnitBuff.md b/wiki-information/functions/CancelUnitBuff.md new file mode 100644 index 00000000..071d7954 --- /dev/null +++ b/wiki-information/functions/CancelUnitBuff.md @@ -0,0 +1,16 @@ +## Title: CancelUnitBuff + +**Content:** +Removes a specific buff from the character. +`CancelUnitBuff(unit, buffIndex)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to cancel the buff from, must be under the player's control. +- `buffIndex` + - *number* - index of the buff to cancel, ascending from 1. +- `filter` + - *string* - any combination of "HELPFUL|HARMFUL|PLAYER|RAID|CANCELABLE|NOT_CANCELABLE". + +**Description:** +This function does not work for canceling druid forms, rogue Stealth, death knight presences, or priest Shadowform. \ No newline at end of file diff --git a/wiki-information/functions/CaseAccentInsensitiveParse.md b/wiki-information/functions/CaseAccentInsensitiveParse.md new file mode 100644 index 00000000..89a1ccdf --- /dev/null +++ b/wiki-information/functions/CaseAccentInsensitiveParse.md @@ -0,0 +1,35 @@ +## Title: CaseAccentInsensitiveParse + +**Content:** +Converts a string with accented letters to lowercase. +`lower = CaseAccentInsensitiveParse(name)` + +**Parameters:** +- `name` + - *string* - The string to be converted to lowercase. + +**Returns:** +- `lower` + - *string* - A lowercased equivalent of the input string. + +**Description:** +This API only supports a limited set of codepoints for conversion and is not suitable as a general-purpose Unicode-aware case conversion function. +The table below documents support for uppercase characters within defined Unicode codepoint blocks. A block is considered "supported" only if all uppercase class characters within the block will be converted to their lowercase equivalents by this function. + +| Block Name | Supported | Notes | +|--------------------|-----------|-----------------------------------------------------------------------| +| Basic Latin | ✔️ | | +| Latin-1 Supplement | ✔️ | | +| Latin Extended-A | ❌ | Limited support for Œ (U+0152) and Ÿ (U+0178) only. | + +**Usage:** +This example demonstrates the support for the Basic and Supplemental Latin codepoint ranges, outputting a lowercased pair of strings. +```lua +local basic = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" +local supplemental = "ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞ" +print(CaseAccentInsensitiveParse(basic)) +print(CaseAccentInsensitiveParse(supplemental)) +-- Prints: +-- abcdefghijklmnopqrstuvwxyz +-- àáâãäåæçèéêëìíîïðñòóôõöøùúûüýþ +``` \ No newline at end of file diff --git a/wiki-information/functions/CastPetAction.md b/wiki-information/functions/CastPetAction.md new file mode 100644 index 00000000..38d28c46 --- /dev/null +++ b/wiki-information/functions/CastPetAction.md @@ -0,0 +1,11 @@ +## Title: CastPetAction + +**Content:** +Cast the corresponding pet skill. +`CastPetAction(index)` + +**Parameters:** +- `index` + - *number* - pet action bar slot index, ascending from 1. +- `target` + - *string? : UnitId* - The unit to cast the action on; defaults to "target". \ No newline at end of file diff --git a/wiki-information/functions/CastShapeshiftForm.md b/wiki-information/functions/CastShapeshiftForm.md new file mode 100644 index 00000000..616a3d38 --- /dev/null +++ b/wiki-information/functions/CastShapeshiftForm.md @@ -0,0 +1,21 @@ +## Title: CastShapeshiftForm + +**Content:** +Casts a shapeshift ability. +`CastShapeshiftForm(index)` + +**Parameters:** +- `index` + - *number* - specifies which shapeshift form to activate or toggle; generally equivalent to the index of the form on the stance bar. + +**Example Usage:** +```lua +-- Example: Cast the first shapeshift form (e.g., Bear Form for Druids) +CastShapeshiftForm(1) +``` + +**Description:** +This function is typically used by classes that have shapeshifting abilities, such as Druids. It allows the player to switch between different forms, such as Bear Form, Cat Form, etc., by specifying the index of the form. + +**Addons:** +Many addons that enhance class-specific functionalities, such as "WeakAuras" or "TellMeWhen," use this function to automate or provide visual cues for shapeshifting abilities. For example, an addon might automatically switch the player to Bear Form when their health drops below a certain threshold. \ No newline at end of file diff --git a/wiki-information/functions/CastSpell.md b/wiki-information/functions/CastSpell.md new file mode 100644 index 00000000..8fabc653 --- /dev/null +++ b/wiki-information/functions/CastSpell.md @@ -0,0 +1,31 @@ +## Title: CastSpell + +**Content:** +Casts a spell from the spellbook. +`CastSpell(spellIndex, spellbookType)` + +**Parameters:** +- `spellIndex` + - *number* - index of the spell to cast. +- `spellbookType` + - *string* - spellbook to cast the spell from; one of + - `BOOKTYPE_SPELL` ("spell") for player spells + - `BOOKTYPE_PET` ("pet") for pet abilities + +**Description:** +This function cannot be used from insecure execution paths except to "cast" trade skills (e.g. Cooking, Alchemy). + +**Reference:** +- `CastSpellByName` + +**Example Usage:** +```lua +-- Cast the first spell in the player's spellbook +CastSpell(1, BOOKTYPE_SPELL) + +-- Cast the first ability in the pet's spellbook +CastSpell(1, BOOKTYPE_PET) +``` + +**Addons Usage:** +Many addons that automate spell casting or provide custom spell casting interfaces use `CastSpell`. For example, the popular addon "Bartender" uses it to allow players to cast spells directly from custom action bars. \ No newline at end of file diff --git a/wiki-information/functions/CastSpellByName.md b/wiki-information/functions/CastSpellByName.md new file mode 100644 index 00000000..d895e836 --- /dev/null +++ b/wiki-information/functions/CastSpellByName.md @@ -0,0 +1,14 @@ +## Title: CastSpellByName + +**Content:** +Casts a spell by name. +`CastSpellByName(spellName)` + +**Parameters:** +- `name` + - *string* - Name of the spell to cast, e.g. "Alchemy". +- `target` + - *string? : UnitId* - The unit to cast the spell on. If omitted, "target" is assumed for spells that require a target. + +**Description:** +You can still use this function to open trade skill windows and to summon mounts even from a tainted execution path. \ No newline at end of file diff --git a/wiki-information/functions/CastingInfo.md b/wiki-information/functions/CastingInfo.md new file mode 100644 index 00000000..d0dff2c5 --- /dev/null +++ b/wiki-information/functions/CastingInfo.md @@ -0,0 +1,34 @@ +## Title: CastingInfo + +**Content:** +Returns the player's currently casting spell. +`name, text, texture, startTime, endTime, isTradeSkill, castID, notInterruptible, spellID = CastingInfo()` + +**Returns:** +- `name` + - *string* - The name of the spell. +- `text` + - *string* - The name to be displayed. +- `texture` + - *number* : FileID +- `startTime` + - *number* - Specifies when casting began in milliseconds (corresponds to GetTime()*1000). +- `endTime` + - *number* - Specifies when casting will end in milliseconds (corresponds to GetTime()*1000). +- `isTradeSkill` + - *boolean* +- `castID` + - *string* - e.g. "Cast-3-4479-0-1318-2053-000014AD63" +- `notInterruptible` + - *boolean* - This is always nil. +- `spellID` + - *number* + +**Description:** +In Classic, only casting information for the player is available. This API is essentially the same as `UnitCastingInfo("player")`. + +**Example Usage:** +This function can be used in addons to track the player's current casting spell. For instance, an addon that displays a custom casting bar would use `CastingInfo()` to get the details of the spell being cast and update the bar accordingly. + +**Addons Using This API:** +Many popular addons like Quartz and Gnosis use this API to provide enhanced casting bar functionalities, showing detailed information about the spell being cast, including start and end times, and whether the spell is interruptible. \ No newline at end of file diff --git a/wiki-information/functions/ChangeActionBarPage.md b/wiki-information/functions/ChangeActionBarPage.md new file mode 100644 index 00000000..0c9a8daf --- /dev/null +++ b/wiki-information/functions/ChangeActionBarPage.md @@ -0,0 +1,13 @@ +## Title: ChangeActionBarPage + +**Content:** +Changes the current action bar page. +`ChangeActionBarPage(actionBarPage)` + +**Parameters:** +- `actionBarPage` + - *number* - Which page of your action bar to switch to. Expects an integer 1-6. + +**Description:** +Notifies the UI that the current action button set has been updated to the current value of the `CURRENT_ACTIONBAR_PAGE` global variable. +Will cause an `ACTIONBAR_PAGE_CHANGED` event to fire only if there was actually a change (tested in 9.0.5). \ No newline at end of file diff --git a/wiki-information/functions/ChangeChatColor.md b/wiki-information/functions/ChangeChatColor.md new file mode 100644 index 00000000..68db37ab --- /dev/null +++ b/wiki-information/functions/ChangeChatColor.md @@ -0,0 +1,24 @@ +## Title: ChangeChatColor + +**Content:** +Updates the color for a type of chat message. +`ChangeChatColor(channelname, red, green, blue)` + +**Parameters:** +- `channelname` + - *string* - Name of the channel as given in chat-cache.txt files. +- `red, green, blue` + - *number* - RGB values (0-1, floats). + +**Usage:** +```lua +ChangeChatColor("CHANNEL1", 255/255, 192/255, 192/255); +ChangeChatColor("CHANNEL1", 255/255, 192/255, 192/255); +``` + +**Miscellaneous:** +Result: +Reset the General channel to the default (255,192,192, slightly off-white) color. + +**Reference:** +`FontString:SetTextColor()`. \ No newline at end of file diff --git a/wiki-information/functions/ChannelBan.md b/wiki-information/functions/ChannelBan.md new file mode 100644 index 00000000..663821bc --- /dev/null +++ b/wiki-information/functions/ChannelBan.md @@ -0,0 +1,14 @@ +## Title: ChannelBan + +**Content:** +Bans a player from the specified channel. +`ChannelBan(channelName, playerName)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel to ban on +- `playerName` + - *string* - The name of the player to ban + +**Usage:** +`ChannelBan("uimods", "Sembiance")` \ No newline at end of file diff --git a/wiki-information/functions/ChannelInfo.md b/wiki-information/functions/ChannelInfo.md new file mode 100644 index 00000000..1217de3c --- /dev/null +++ b/wiki-information/functions/ChannelInfo.md @@ -0,0 +1,26 @@ +## Title: ChannelInfo + +**Content:** +Returns the player's currently channeling spell. +`name, text, texture, startTime, endTime, isTradeSkill, notInterruptible, spellID = ChannelInfo()` + +**Returns:** +- `name` + - *string* - The name of the spell, or nil if no spell is being channeled. +- `text` + - *string* - The name to be displayed. +- `texture` + - *number* : FileID +- `startTime` + - *number* - Specifies when channeling began in milliseconds (corresponds to GetTime()*1000). +- `endTime` + - *number* - Specifies when channeling will end in milliseconds (corresponds to GetTime()*1000). +- `isTradeSkill` + - *boolean* +- `notInterruptible` + - *boolean* - This is always nil. +- `spellID` + - *number* + +**Description:** +In Classic, only channeling information for the player is available. This API is essentially the same as `UnitChannelInfo("player")`. \ No newline at end of file diff --git a/wiki-information/functions/ChannelInvite.md b/wiki-information/functions/ChannelInvite.md new file mode 100644 index 00000000..a31b058a --- /dev/null +++ b/wiki-information/functions/ChannelInvite.md @@ -0,0 +1,14 @@ +## Title: ChannelInvite + +**Content:** +Invites the specified user to the channel. +`ChannelInvite(channelName, playerName)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel to invite to +- `playerName` + - *string* - The name of the player to invite + +**Usage:** +`ChannelInvite("uimods", "Sembiance")` \ No newline at end of file diff --git a/wiki-information/functions/ChannelKick.md b/wiki-information/functions/ChannelKick.md new file mode 100644 index 00000000..0481fd4f --- /dev/null +++ b/wiki-information/functions/ChannelKick.md @@ -0,0 +1,14 @@ +## Title: ChannelKick + +**Content:** +Kicks a player from the specified channel. +`ChannelKick(channelName, playerName)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel to kick from +- `playerName` + - *string* - The name of the player to kick + +**Usage:** +`ChannelKick("uimods", "alexyoshi")` \ No newline at end of file diff --git a/wiki-information/functions/CheckInbox.md b/wiki-information/functions/CheckInbox.md new file mode 100644 index 00000000..0fc0985d --- /dev/null +++ b/wiki-information/functions/CheckInbox.md @@ -0,0 +1,9 @@ +## Title: CheckInbox + +**Content:** +Queries the server for mail. +`CheckInbox()` + +**Description:** +This function requires that the mailbox window is open. +After it is called and the inbox populated, the client's stored mailbox information can be accessed from anywhere in the world. That is, functions like `GetInboxHeaderInfo()` and `GetInboxNumItems()` may be called from anywhere. Note that only the *stored* information can be accessed -- to get current inbox info, you have to call `CheckInbox()` again. \ No newline at end of file diff --git a/wiki-information/functions/CheckInteractDistance.md b/wiki-information/functions/CheckInteractDistance.md new file mode 100644 index 00000000..533a3940 --- /dev/null +++ b/wiki-information/functions/CheckInteractDistance.md @@ -0,0 +1,38 @@ +## Title: CheckInteractDistance + +**Content:** +Returns true if the player is in range to perform a specific interaction with the unit. +`inRange = CheckInteractDistance(unit, distIndex)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to compare distance to. +- `distIndex` + - *number* - A value from 1 to 5: + - 1 = Compare Achievements, 28 yards + - 2 = Trade, 8 yards + - 3 = Duel, 7 yards + - 4 = Follow, 28 yards + - 5 = Pet-battle Duel, 7 yards + +**Returns:** +- `inRange` + - *boolean* - 1 if you are in range to perform the interaction, nil otherwise. + +**Description:** +If "unit" is a hostile unit, the return values are the same. But you obviously won't be able to do things like Trade. + +**Usage:** +```lua +if ( CheckInteractDistance("target", 4) ) then + FollowUnit("target"); +else + -- we're too far away to follow the target +end +``` + +**Example Use Case:** +This function can be used in addons that need to check if a player is within a certain range to perform actions like trading, dueling, or following another player. For instance, an addon that automates following a party member would use this function to ensure the player is close enough to follow the target. + +**Addons Using This Function:** +Many large addons, such as "Questie" and "Zygor Guides," use this function to determine if the player is within range to interact with NPCs or other players for quest objectives or guide steps. \ No newline at end of file diff --git a/wiki-information/functions/CheckTalentMasterDist.md b/wiki-information/functions/CheckTalentMasterDist.md new file mode 100644 index 00000000..c76abe32 --- /dev/null +++ b/wiki-information/functions/CheckTalentMasterDist.md @@ -0,0 +1,9 @@ +## Title: CheckTalentMasterDist + +**Content:** +Needs summary. +`result = CheckTalentMasterDist()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ClassicExpansionAtLeast.md b/wiki-information/functions/ClassicExpansionAtLeast.md new file mode 100644 index 00000000..7aaba77f --- /dev/null +++ b/wiki-information/functions/ClassicExpansionAtLeast.md @@ -0,0 +1,13 @@ +## Title: ClassicExpansionAtLeast + +**Content:** +Needs summary. +`isAtLeast = ClassicExpansionAtLeast(expansionLevel)` + +**Parameters:** +- `expansionLevel` + - *number* + +**Returns:** +- `isAtLeast` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ClearCursor.md b/wiki-information/functions/ClearCursor.md new file mode 100644 index 00000000..ad852000 --- /dev/null +++ b/wiki-information/functions/ClearCursor.md @@ -0,0 +1,22 @@ +## Title: ClearCursor + +**Content:** +Clears any objects from the cursor. +`ClearCursor()` + +**Parameters:** +- None + +**Returns:** +- None + +**Usage:** +```lua +ClearCursor(); +PickUpContainerItem(0,1); +ClearCursor(); +PickUpContainerItem(0,1); +``` + +**Description:** +This function was added in patch 1.12 (The Drums of War). \ No newline at end of file diff --git a/wiki-information/functions/ClearOverrideBindings.md b/wiki-information/functions/ClearOverrideBindings.md new file mode 100644 index 00000000..b1434ad7 --- /dev/null +++ b/wiki-information/functions/ClearOverrideBindings.md @@ -0,0 +1,12 @@ +## Title: ClearOverrideBindings + +**Content:** +Removes all override bindings owned by a specific frame. +`ClearOverrideBindings(owner)` + +**Parameters:** +- `owner` + - *Frame* - The frame to clear override bindings for. + +**Description:** +The client will automatically restore overridden bindings once override bindings are cleared. \ No newline at end of file diff --git a/wiki-information/functions/ClearSendMail.md b/wiki-information/functions/ClearSendMail.md new file mode 100644 index 00000000..2399bb7f --- /dev/null +++ b/wiki-information/functions/ClearSendMail.md @@ -0,0 +1,20 @@ +## Title: ClearSendMail + +**Content:** +Clears the text and item attachments in the Send Mail tab. +`ClearSendMail()` + +**Parameters:** +- None + +**Returns:** +- `nil` + +**Description:** +This function is used to clear any text and item attachments that have been added to the Send Mail tab in the in-game mail system. This can be useful for addons that manage or automate mail sending, ensuring that the mail tab is reset to a clean state before performing any operations. + +**Example Usage:** +An addon that automates sending items to a bank alt might use `ClearSendMail()` to ensure no leftover items or text from a previous mail operation interfere with the current one. + +**Addons Using This Function:** +- **Postal**: A popular mail management addon that enhances the in-game mail interface. It uses `ClearSendMail()` to clear the mail tab when performing batch mail operations, ensuring that each mail is sent correctly without leftover data from previous mails. \ No newline at end of file diff --git a/wiki-information/functions/ClearTarget.md b/wiki-information/functions/ClearTarget.md new file mode 100644 index 00000000..da46b566 --- /dev/null +++ b/wiki-information/functions/ClearTarget.md @@ -0,0 +1,9 @@ +## Title: ClearTarget + +**Content:** +Clears the selected target. +`willMakeChange = ClearTarget()` + +**Returns:** +- `willMakeChange` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ClickSendMailItemButton.md b/wiki-information/functions/ClickSendMailItemButton.md new file mode 100644 index 00000000..b64179d0 --- /dev/null +++ b/wiki-information/functions/ClickSendMailItemButton.md @@ -0,0 +1,11 @@ +## Title: ClickSendMailItemButton + +**Content:** +Drops or picks up an item from the cursor to the Send Mail tab. +`ClickSendMailItemButton(itemIndex)` + +**Parameters:** +- `itemIndex` + - *number* - The index of the item (1-ATTACHMENTS_MAX_SEND(12)) +- `clearItem` + - *boolean?* - Clear the item already in this slot. (Done by right-clicking an item) \ No newline at end of file diff --git a/wiki-information/functions/ClickStablePet.md b/wiki-information/functions/ClickStablePet.md new file mode 100644 index 00000000..69ba58b2 --- /dev/null +++ b/wiki-information/functions/ClickStablePet.md @@ -0,0 +1,18 @@ +## Title: ClickStablePet + +**Content:** +Selects a stable pet. +`ClickStablePet(index)` + +**Parameters:** +- `index` + - *number* + +**Reference:** +- `GetSelectedStablePet()` + +**Example Usage:** +This function can be used in macros or addons to automate the selection of a pet from the stable. For instance, if you have a specific pet you want to select based on its index in the stable, you can use this function to do so. + +**Addons:** +Large addons like "PetTracker" might use this function to manage and automate pet selections within the game. \ No newline at end of file diff --git a/wiki-information/functions/CloseItemText.md b/wiki-information/functions/CloseItemText.md new file mode 100644 index 00000000..86882afa --- /dev/null +++ b/wiki-information/functions/CloseItemText.md @@ -0,0 +1,8 @@ +## Title: CloseItemText + +**Content:** +Close an open item text (book, plaque, etc). +`CloseItemText()` + +**Description:** +Causes the `ITEM_TEXT_CLOSED` event to be sent. \ No newline at end of file diff --git a/wiki-information/functions/CloseLoot.md b/wiki-information/functions/CloseLoot.md new file mode 100644 index 00000000..adca37fe --- /dev/null +++ b/wiki-information/functions/CloseLoot.md @@ -0,0 +1,15 @@ +## Title: CloseLoot + +**Content:** +Close the loot window. +`CloseLoot()` + +**Parameters:** +- `errNum` + - *number?* - A reason for the window closing. Unsure whether/how the game deals with error codes passed to it. + +**Reference:** +- `LOOT_CLOSED` + +**Description:** +Pretty self-explanatory. Unless there is some type of error, don't pass the error argument. \ No newline at end of file diff --git a/wiki-information/functions/ClosePetition.md b/wiki-information/functions/ClosePetition.md new file mode 100644 index 00000000..86effa6f --- /dev/null +++ b/wiki-information/functions/ClosePetition.md @@ -0,0 +1,8 @@ +## Title: ClosePetition + +**Content:** +Closes the current petition. +`ClosePetition()` + +**Description:** +Triggers `PETITION_CLOSED`. \ No newline at end of file diff --git a/wiki-information/functions/CloseSocketInfo.md b/wiki-information/functions/CloseSocketInfo.md new file mode 100644 index 00000000..5e0d07e4 --- /dev/null +++ b/wiki-information/functions/CloseSocketInfo.md @@ -0,0 +1,8 @@ +## Title: CloseSocketInfo + +**Content:** +Cancels pending gems for socketing. +`CloseSocketInfo()` + +**Reference:** +AcceptSockets \ No newline at end of file diff --git a/wiki-information/functions/ClosestUnitPosition.md b/wiki-information/functions/ClosestUnitPosition.md new file mode 100644 index 00000000..a3be0939 --- /dev/null +++ b/wiki-information/functions/ClosestUnitPosition.md @@ -0,0 +1,17 @@ +## Title: ClosestUnitPosition + +**Content:** +Returns the unit position of the closest creature by ID. Only works for mobs in the starting zones. +`xPos, yPos, distance = ClosestUnitPosition(creatureID)` + +**Parameters:** +- `creatureID` + - *number* - NPC ID of a GUID of a creature. + +**Returns:** +- `xPos` + - *number* +- `yPos` + - *number* +- `distance` + - *number* - Relative distance in yards. \ No newline at end of file diff --git a/wiki-information/functions/CollapseFactionHeader.md b/wiki-information/functions/CollapseFactionHeader.md new file mode 100644 index 00000000..8fd9a67b --- /dev/null +++ b/wiki-information/functions/CollapseFactionHeader.md @@ -0,0 +1,12 @@ +## Title: CollapseFactionHeader + +**Content:** +Collapse a faction header row. +`CollapseFactionHeader(rowIndex)` + +**Parameters:** +- `rowIndex` + - *number* - The row index of the header to collapse (Specifying a non-header row can have unpredictable results). The `UPDATE_FACTION` event is fired after the change since faction indexes will have been shifted around. + +**Reference:** +- `ExpandFactionHeader` \ No newline at end of file diff --git a/wiki-information/functions/CollapseQuestHeader.md b/wiki-information/functions/CollapseQuestHeader.md new file mode 100644 index 00000000..6b53f418 --- /dev/null +++ b/wiki-information/functions/CollapseQuestHeader.md @@ -0,0 +1,31 @@ +## Title: ExpandQuestHeader + +**Content:** +Expands/collapses a quest log header. +`ExpandQuestHeader(index)` +`CollapseQuestHeader(index)` + +**Parameters:** +- `index` + - *number* - Position in the quest log from 1 at the top, including collapsed and invisible content. +- `isAuto` + - *boolean* - Used when resetting the quest log to a default state. + +**Description:** +Applies to all headers when the index does not point to a header, including out-of-range values like 0. +Fires `QUEST_LOG_UPDATE`. Toggle `QuestMapFrame.ignoreQuestLogUpdate` to suppress the normal event handler. + +**Usage:** +Expand all quest headers: +```lua +ExpandQuestHeader(0) +``` +Collapse the first quest header (always at position 1) while suppressing the normal event handler: +```lua +QuestMapFrame.ignoreQuestLogUpdate = true +CollapseQuestHeader(1) +QuestMapFrame.ignoreQuestLogUpdate = nil +``` + +**Reference:** +`QuestMapFrame_ResetFilters()` - FrameXML function to restore the default expanded/collapsed state. \ No newline at end of file diff --git a/wiki-information/functions/CollapseSkillHeader.md b/wiki-information/functions/CollapseSkillHeader.md new file mode 100644 index 00000000..1472ddfb --- /dev/null +++ b/wiki-information/functions/CollapseSkillHeader.md @@ -0,0 +1,12 @@ +## Title: CollapseSkillHeader + +**Content:** +Collapses a header in the skills window. +`CollapseSkillHeader(index)` + +**Parameters:** +- `index` + - *number* - The index of a line in the skills window, can be a header or skill line belonging to a header. Index 0 ("All") will collapse all headers. + +**Reference:** +- `GetSkillLineInfo()` \ No newline at end of file diff --git a/wiki-information/functions/CollapseTrainerSkillLine.md b/wiki-information/functions/CollapseTrainerSkillLine.md new file mode 100644 index 00000000..3e6ee86e --- /dev/null +++ b/wiki-information/functions/CollapseTrainerSkillLine.md @@ -0,0 +1,25 @@ +## Title: CollapseTrainerSkillLine + +**Content:** +Collapses a header in the trainer window, hiding all spells below it. +`CollapseTrainerSkillLine(index)` + +**Parameters:** +- `index` + - *number* - The index of a line in the trainer window (if the supplied index is not a header, an error is produced). + - Index 0 ("All") will collapse all headers. + - Note that indices are affected by the trainer filter, see `GetTrainerServiceTypeFilter()` and `SetTrainerServiceTypeFilter()` + +**Usage:** +Collapses all trainer headers. This can also be done by using index 0 instead. +```lua +for i = 1, GetNumTrainerServices() do + local category = select(3, GetTrainerServiceInfo(i)) + if category == "header" then + CollapseTrainerSkillLine(i) + end +end +``` + +**Reference:** +- `GetTrainerServiceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/CombatLogAdvanceEntry.md b/wiki-information/functions/CombatLogAdvanceEntry.md new file mode 100644 index 00000000..1e83e5f8 --- /dev/null +++ b/wiki-information/functions/CombatLogAdvanceEntry.md @@ -0,0 +1,40 @@ +## Title: CombatLogAdvanceEntry + +**Content:** +Advances the combat log selection by the given amount of entries. +`CombatLogAdvanceEntry(count)` + +**Parameters:** +- `count` + - *number* - number of entries to traverse within the combat log, see details below. Can be negative. +- `ignoreFilter` + - *boolean* - set to true to ignore combat log filters + +**Returns:** +- `isValidIndex` + - *boolean* - will return false if the new index does not exist in the combat log, but will still set the entry regardless. Otherwise, returns true for valid indices. + +**Description:** +This function will traverse through the combat log by the given number of entries. It will not fail, or throw an error if you attempt to advance to an index that does not exist, instead it will return false but will still set the selected entry to that invalid index, and does NOT wrap around to the beginning when it reaches the end. + +**Usage:** +Combat log indexing and traversal +```lua +CombatLogSetCurrentEntry(0, true); -- sets current entry to the most recent entry, ignoring filters. +-- will return false +-- the above function sets the selected entry to 0, or the last value in the list. attempting to advance +1 entries from the end will result in an invalid index. +local success = CombatLogAdvanceEntry(1, true); + +-- will return true +-- instead of adding one to the index, we subtract one to move backwards through the combat log history. +local success = CombatLogAdvanceEntry(-1, true); + +CombatLogSetCurrentEntry(1, true); -- sets current entry to the first, or oldest entry, ignoring filters. +-- will return true +-- adding one to the index, we now traverse up from the oldest entry, as set above. +local success = CombatLogAdvanceEntry(1, true); +``` + +**Reference:** +- `CombatLogSetCurrentEntry()` +- `COMBAT_LOG_EVENT` \ No newline at end of file diff --git a/wiki-information/functions/CombatLogGetCurrentEntry.md b/wiki-information/functions/CombatLogGetCurrentEntry.md new file mode 100644 index 00000000..628e9737 --- /dev/null +++ b/wiki-information/functions/CombatLogGetCurrentEntry.md @@ -0,0 +1,10 @@ +## Title: CombatLogGetCurrentEntry + +**Content:** +Returns the combat log entry that is currently selected by `CombatLogSetCurrentEntry()`. +```lua +local timestamp, subevent, hideCaster, sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags = CombatLogGetCurrentEntry(); +``` + +**Returns:** +This function's returns are identical to those of `CombatLogGetCurrentEventInfo()`. For more details see `COMBAT_LOG_EVENT`. \ No newline at end of file diff --git a/wiki-information/functions/CombatLogGetCurrentEventInfo.md b/wiki-information/functions/CombatLogGetCurrentEventInfo.md new file mode 100644 index 00000000..999ce386 --- /dev/null +++ b/wiki-information/functions/CombatLogGetCurrentEventInfo.md @@ -0,0 +1,47 @@ +## Title: CombatLogGetCurrentEventInfo + +**Content:** +Returns the current COMBAT_LOG_EVENT payload. +`arg1, arg2, ... = CombatLogGetCurrentEventInfo()` + +**Returns:** +Returns a variable number of values: 11 base values and up to 13 extra values based upon the subtype of the event. + +**Description:** +In the new event system for 8.0, supporting the original functionality of the CLEU event was problematic due to the "context" arguments, i.e. each argument can be interpreted differently depending on the previous arguments. The payload was subsequently moved to this function. + +**Usage:** +Prints all CLEU parameters. +```lua +local function OnEvent(self, event) + print(CombatLogGetCurrentEventInfo()) +end +local f = CreateFrame("Frame") +f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") +f:SetScript("OnEvent", OnEvent) +``` + +Displays your spell or melee critical hits. +```lua +local playerGUID = UnitGUID("player") +local MSG_CRITICAL_HIT = "Your %s critically hit %s for %d damage!" +local f = CreateFrame("Frame") +f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") +f:SetScript("OnEvent", function(self, event) + local _, subevent, _, sourceGUID, _, _, _, _, destName = CombatLogGetCurrentEventInfo() + local spellId, amount, critical + if subevent == "SWING_DAMAGE" then + amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) + elseif subevent == "SPELL_DAMAGE" then + spellId, _, _, amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) + end + if critical and sourceGUID == playerGUID then + -- get the link of the spell or the MELEE globalstring + local action = spellId and GetSpellLink(spellId) or MELEE + print(MSG_CRITICAL_HIT:format(action, destName, amount)) + end +end) +``` + +**Example Use Case:** +This function is commonly used in combat log analysis addons such as Recount and Details! Damage Meter. These addons use `CombatLogGetCurrentEventInfo` to parse combat log events and provide detailed statistics on damage, healing, and other combat metrics. \ No newline at end of file diff --git a/wiki-information/functions/CombatLogSetCurrentEntry.md b/wiki-information/functions/CombatLogSetCurrentEntry.md new file mode 100644 index 00000000..c8b1bb0c --- /dev/null +++ b/wiki-information/functions/CombatLogSetCurrentEntry.md @@ -0,0 +1,47 @@ +## Title: CombatLogSetCurrentEntry + +**Content:** +Sets the currently selected combat log entry to the given value, to be retrieved using `CombatLogGetCurrentEntry()`. +`CombatLogSetCurrentEntry(index)` + +**Parameters:** +- `index` + - *number* - see details below +- `ignoreFilter` + - *boolean* - set to true to ignore combat log filters + +**Returns:** +- `isValidIndex` + - *boolean* - will return false if the index does not exist in the combat log, but will still set the entry. Otherwise, returns true for valid indices. + +**Description:** +Combat log indexing works a bit differently than standard Lua indexing. You can treat the combat log like a big table, with the oldest entries being placed at the beginning, and the newest entries at the end. +Unlike standard Lua tables, however, an index of 0 will set the entry to the most recent combat log entry. Additionally, you are also able to index the combat log backwards using negative values. For example, an index of -1 will return the second to last, or second most recent entry in the combat log. +See `CombatLogAdvanceEntry()` for details on traversing the combat log. + +**Usage:** +```lua +-- Combat log indexing +CombatLogSetCurrentEntry(0, true); -- most recent entry, ignoring filters. +local newestEntry = {CombatLogGetCurrentEntry()}; + +CombatLogSetCurrentEntry(1, true); -- oldest entry, ignoring filters. +local oldestEntry = {CombatLogGetCurrentEntry()}; + +CombatLogSetCurrentEntry(-5, true); -- fifth newest entry, ignoring filters. +local fifthNewestEntry = {CombatLogGetCurrentEntry()}; + +CombatLogSetCurrentEntry(5, true); -- fifth oldest entry, ignoring filters. +local fifthOldestEntry = {CombatLogGetCurrentEntry()}; +``` + +**Reference:** +- `CombatLogGetCurrentEntry()` +- `CombatLogAdvanceEntry()` + +**Example Use Case:** +This function can be used in addons that analyze combat logs for specific events or patterns. For instance, an addon that tracks damage taken over time might use this function to set the current entry to various points in the combat log to gather data. + +**Addons Using This Function:** +- **Recount**: A popular damage meter addon that tracks and displays damage, healing, and other combat-related statistics. It uses combat log entries to compile and display detailed combat data. +- **Details! Damage Meter**: Another comprehensive damage meter addon that provides in-depth analysis of combat logs to present detailed statistics on player performance. \ No newline at end of file diff --git a/wiki-information/functions/CombatLog_Object_IsA.md b/wiki-information/functions/CombatLog_Object_IsA.md new file mode 100644 index 00000000..2c0a9939 --- /dev/null +++ b/wiki-information/functions/CombatLog_Object_IsA.md @@ -0,0 +1,64 @@ +## Title: CombatLog_Object_IsA + +**Content:** +Returns whether a unit from the combat log matches a given filter. +`isMatch = CombatLog_Object_IsA(unitFlags, mask)` + +**Parameters:** +- `unitFlags` + - *number* - UnitFlag bitfield, i.e. sourceFlags or destFlags from COMBAT_LOG_EVENT. +- `mask` + - *number* - COMBATLOG_FILTER constant. + +**Returns:** +- `isMatch` + - *boolean* - True if a bitfield in each of the four main categories matches. + +**Description:** +Both of the arguments to this function must be valid Combat Log Objects. That is, for the four main categories of the UnitFlag bitfield, there must be at least one nonzero bit. Passing in a single COMBATLOG_OBJECT constant will cause the check to return false. + +**Miscellaneous:** +- **Constant** - bit field + - `COMBATLOG_FILTER_ME` + - `0x0000000000000001` + - `COMBATLOG_FILTER_MINE` + - `0x0000000000000005` + - `COMBATLOG_FILTER_MY_PET` + - `0x0000000000000011` + - `COMBATLOG_FILTER_FRIENDLY_UNITS` + - `0x00000000000000E1` + - `COMBATLOG_FILTER_HOSTILE_PLAYERS` + - `0x00000000000004E1` + - `COMBATLOG_FILTER_HOSTILE_UNITS` + - `0x00000000000004E2` + - `COMBATLOG_FILTER_NEUTRAL_UNITS` + - `0x00000000000004E4` + - `COMBATLOG_FILTER_UNKNOWN_UNITS` + - `0x0000000000000800` + - `COMBATLOG_FILTER_EVERYTHING` + - `0xFFFFFFFFFFFFFFFF` + +You can also construct your own filter; make sure to use at least one constant from each category: +```lua +local COMBATLOG_FILTER_FRIENDLY_PLAYERS = bit.bor( + COMBATLOG_OBJECT_AFFILIATION_PARTY, + COMBATLOG_OBJECT_AFFILIATION_RAID, + COMBATLOG_OBJECT_AFFILIATION_OUTSIDER, + COMBATLOG_OBJECT_REACTION_FRIENDLY, + COMBATLOG_OBJECT_CONTROL_PLAYER, + COMBATLOG_OBJECT_TYPE_PLAYER +) +``` + +**Usage:** +Prints if the combat log source unit is a hostile NPC. +```lua +local f = CreateFrame("Frame") +f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") +f:SetScript("OnEvent", function(self, event) + local timestamp, subevent, _, sourceGUID, sourceName, sourceFlags = CombatLogGetCurrentEventInfo() + if CombatLog_Object_IsA(sourceFlags, COMBATLOG_FILTER_HOSTILE_UNITS) then + print(subevent, sourceName, format("0x%X", sourceFlags), "is a hostile NPC") + end +end) +``` \ No newline at end of file diff --git a/wiki-information/functions/CombatTextSetActiveUnit.md b/wiki-information/functions/CombatTextSetActiveUnit.md new file mode 100644 index 00000000..23a65d0e --- /dev/null +++ b/wiki-information/functions/CombatTextSetActiveUnit.md @@ -0,0 +1,17 @@ +## Title: CombatTextSetActiveUnit + +**Content:** +Changes the entity for which COMBAT_TEXT_UPDATE events fire. +`CombatTextSetActiveUnit(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The entity you want to receive notifications for. + +**Description:** +The event is tied to the entity rather than the unit -- thus, if you call `CombatTextSetActiveUnit("target")` and then target something else, you'll get notifications for the unit you were targeting when calling the function, rather than your new target. +Only one unit can be "active" at a time. +The `COMBAT_TEXT_UPDATE` event is used to provide part of Blizzard's Floating Combat Text functionality; it fires to notify of aura gains/losses and incoming damage and heals. + +**Reference:** +- `COMBAT_TEXT_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/CompleteQuest.md b/wiki-information/functions/CompleteQuest.md new file mode 100644 index 00000000..50d9ed32 --- /dev/null +++ b/wiki-information/functions/CompleteQuest.md @@ -0,0 +1,10 @@ +## Title: CompleteQuest + +**Content:** +Continues the quest dialog to the reward selection step. +`CompleteQuest()` + +**Description:** +Unlike the name would suggest, this does not finalize the completion of a quest. Instead, it is called when you press the continue button, and is used to continue from the progress dialog to the completion dialog. See `GetQuestReward()` for actually completing a quest. + +If you're interested in hooking the function called when completing a quest, check out `QuestRewardCompleteButton_OnClick` (in `FrameXML\\QuestFrame.lua`) instead. \ No newline at end of file diff --git a/wiki-information/functions/ConfirmAcceptQuest.md b/wiki-information/functions/ConfirmAcceptQuest.md new file mode 100644 index 00000000..3ed8b934 --- /dev/null +++ b/wiki-information/functions/ConfirmAcceptQuest.md @@ -0,0 +1,8 @@ +## Title: ConfirmAcceptQuest + +**Content:** +Accepts a quest started by a group member (e.g. escort quests). +`ConfirmAcceptQuest()` + +**Description:** +Can be used after the `QUEST_ACCEPT_CONFIRM` event has fired. \ No newline at end of file diff --git a/wiki-information/functions/ConfirmLootRoll.md b/wiki-information/functions/ConfirmLootRoll.md new file mode 100644 index 00000000..871c14be --- /dev/null +++ b/wiki-information/functions/ConfirmLootRoll.md @@ -0,0 +1,30 @@ +## Title: ConfirmLootRoll + +**Content:** +Confirms a loot roll. +`ConfirmLootRoll(rollID)` + +**Parameters:** +- `rollID` + - *number* - As passed by the event. (The number increases with every roll you have in a party) +- `roll` + - *number* - Type of roll: (also passed by the event) + - `1` : Need roll + - `2` : Greed roll + - `3` : Disenchant roll + +**Usage:** +```lua +local f = CreateFrame("Frame", "MyAddon") +f:RegisterEvent("CONFIRM_LOOT_ROLL") +f:SetScript("OnEvent", function(self, event, ...) + if event == "CONFIRM_LOOT_ROLL" then + local rollID, roll = ... + ConfirmLootRoll(rollID, roll) + end +end) +``` + +**Reference:** +- `CONFIRM_LOOT_ROLL` +- `CONFIRM_DISENCHANT_ROLL` \ No newline at end of file diff --git a/wiki-information/functions/ConfirmLootSlot.md b/wiki-information/functions/ConfirmLootSlot.md new file mode 100644 index 00000000..0079b707 --- /dev/null +++ b/wiki-information/functions/ConfirmLootSlot.md @@ -0,0 +1,12 @@ +## Title: ConfirmLootSlot + +**Content:** +Confirms looting of a BoP item. +`ConfirmLootSlot(slot)` + +**Parameters:** +- `slot` + - *number* - the loot slot of a BoP loot item that is waiting for confirmation + +**Description:** +If the player has already clicked on a LootButton object with loot index 1, and the item is "Bind on Pickup" and awaiting confirmation, then the item will be looted and placed in the player's bags. \ No newline at end of file diff --git a/wiki-information/functions/ConfirmPetUnlearn.md b/wiki-information/functions/ConfirmPetUnlearn.md new file mode 100644 index 00000000..dac9ee0d --- /dev/null +++ b/wiki-information/functions/ConfirmPetUnlearn.md @@ -0,0 +1,9 @@ +## Title: ConfirmPetUnlearn + +**Content:** +Confirms unlearning the current pet's skills. +`ConfirmPetUnlearn()` + +**Reference:** +- `GetSelectedStablePet()` +- `CONFIRM_PET_UNLEARN` \ No newline at end of file diff --git a/wiki-information/functions/ConfirmReadyCheck.md b/wiki-information/functions/ConfirmReadyCheck.md new file mode 100644 index 00000000..adb8ac97 --- /dev/null +++ b/wiki-information/functions/ConfirmReadyCheck.md @@ -0,0 +1,12 @@ +## Title: ConfirmReadyCheck + +**Content:** +Responds to a ready check. +`ConfirmReadyCheck(isReady)` + +**Parameters:** +- `isReady` + - *number?* - 1 if the player is ready, nil if the player is not ready + +**Description:** +This function is used in response to receiving a READY_CHECK event. Normally this event will display the ReadyCheckFrame dialog which will in turn call ConfirmReadyCheck in response to the user clicking the Yes or No button. \ No newline at end of file diff --git a/wiki-information/functions/ConsoleAddMessage.md b/wiki-information/functions/ConsoleAddMessage.md new file mode 100644 index 00000000..15f6eff2 --- /dev/null +++ b/wiki-information/functions/ConsoleAddMessage.md @@ -0,0 +1,9 @@ +## Title: ConsoleAddMessage + +**Content:** +Needs summary. +`ConsoleAddMessage(message)` + +**Parameters:** +- `message` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/ConsoleExec.md b/wiki-information/functions/ConsoleExec.md new file mode 100644 index 00000000..ebf62823 --- /dev/null +++ b/wiki-information/functions/ConsoleExec.md @@ -0,0 +1,12 @@ +## Title: ConsoleExec + +**Content:** +Execute a console command. +`ConsoleExec(command)` + +**Parameters:** +- `command` + - *string* - The console command to execute. + +**Description:** +`/run ConsoleExec("command")` is equivalent to `/console command`. \ No newline at end of file diff --git a/wiki-information/functions/ConsoleGetAllCommands.md b/wiki-information/functions/ConsoleGetAllCommands.md new file mode 100644 index 00000000..edd8549e --- /dev/null +++ b/wiki-information/functions/ConsoleGetAllCommands.md @@ -0,0 +1,64 @@ +## Title: ConsoleGetAllCommands + +**Content:** +Needs summary. +`commands = ConsoleGetAllCommands()` + +**Returns:** +- `commands` + - *ConsoleCommandInfo* + - `Field` + - `Type` + - `Description` + - `command` + - *string* + - `help` + - *string* + - `category` + - *Enum.ConsoleCategory* + - `commandType` + - *Enum.ConsoleCommandType* + - `scriptContents` + - *string* + - `scriptParameters` + - *string* + +**Enum.ConsoleCategory:** +- `Value` + - `Field` + - `Description` + - `0` + - Debug + - `1` + - Graphics + - `2` + - Console + - `3` + - Combat + - `4` + - Game + - `5` + - Default + - `6` + - Net + - `7` + - Sound + - `8` + - Gm + - `9` + - Reveal + - `10` + - None + +**Enum.ConsoleCommandType:** +- `Value` + - `Field` + - `Description` + - `0` + - Cvar + - `1` + - Command + - `2` + - Macro + - `3` + - Script \ No newline at end of file diff --git a/wiki-information/functions/ConsoleGetColorFromType.md b/wiki-information/functions/ConsoleGetColorFromType.md new file mode 100644 index 00000000..14867353 --- /dev/null +++ b/wiki-information/functions/ConsoleGetColorFromType.md @@ -0,0 +1,28 @@ +## Title: ConsoleGetColorFromType + +**Content:** +Needs summary. +`color = ConsoleGetColorFromType(colorType)` + +**Parameters:** +- `colorType` + - *Enum.ConsoleColorType* + - `Value` + - `Field` + - `Description` + - `0` - DefaultColor + - `1` - InputColor + - `2` - EchoColor + - `3` - ErrorColor + - `4` - WarningColor + - `5` - GlobalColor + - `6` - AdminColor + - `7` - HighlightColor + - `8` - BackgroundColor + - `9` - ClickbufferColor + - `10` - PrivateColor + - `11` - DefaultGreen + +**Returns:** +- `color` + - *colorRGB* \ No newline at end of file diff --git a/wiki-information/functions/ConsoleGetFontHeight.md b/wiki-information/functions/ConsoleGetFontHeight.md new file mode 100644 index 00000000..fc3d24f7 --- /dev/null +++ b/wiki-information/functions/ConsoleGetFontHeight.md @@ -0,0 +1,9 @@ +## Title: ConsoleGetFontHeight + +**Content:** +Needs summary. +`fontHeightInPixels = ConsoleGetFontHeight()` + +**Returns:** +- `fontHeightInPixels` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/ConsolePrintAllMatchingCommands.md b/wiki-information/functions/ConsolePrintAllMatchingCommands.md new file mode 100644 index 00000000..36502f86 --- /dev/null +++ b/wiki-information/functions/ConsolePrintAllMatchingCommands.md @@ -0,0 +1,9 @@ +## Title: ConsolePrintAllMatchingCommands + +**Content:** +Needs summary. +`ConsolePrintAllMatchingCommands(partialCommandText)` + +**Parameters:** +- `partialCommandText` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/ConsoleSetFontHeight.md b/wiki-information/functions/ConsoleSetFontHeight.md new file mode 100644 index 00000000..99babf9b --- /dev/null +++ b/wiki-information/functions/ConsoleSetFontHeight.md @@ -0,0 +1,9 @@ +## Title: ConsoleSetFontHeight + +**Content:** +Needs summary. +`ConsoleSetFontHeight(fontHeightInPixels)` + +**Parameters:** +- `fontHeightInPixels` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/ContainerIDToInventoryID.md b/wiki-information/functions/ContainerIDToInventoryID.md new file mode 100644 index 00000000..f9cf29b2 --- /dev/null +++ b/wiki-information/functions/ContainerIDToInventoryID.md @@ -0,0 +1,37 @@ +## Title: ContainerIDToInventoryID + +**Content:** +`bagID = ContainerIDToInventoryID(containerID)` + +**Parameters:** +- `bagID` + - *number* - BagID between 1 and NUM_BAG_SLOTS + NUM_BANKBAGSLOTS + +**Values:** +| ID | Vanilla1.13.7 | Vanilla1.14.0 | TBC2.5.2 | Retail | Description | +|----|---------------|---------------|----------|--------|-------------| +| 1 | 20 | | | | 1st character bag | +| 2 | 21 | | | | 2nd character bag | +| 3 | 22 | | | | 3rd character bag | +| 4 | 23 | | | | 4th character bag | +| 48-71 | 48-71 | 48-75 | 52-79 | | bank slots (vanilla: 24, bcc/retail: 28) | +| 5 | 72 | 76 | 76 | 80 | 1st bank bag | +| 6 | 73 | 77 | 77 | 81 | 2nd bank bag | +| 7 | 74 | 78 | 78 | 82 | 3rd bank bag | +| 8 | 75 | 79 | 79 | 83 | 4th bank bag | +| 9 | 76 | 80 | 80 | 84 | 5th bank bag | +| 10 | 77 | 81 | 81 | 85 | 6th bank bag | +| 11 | | 82 | 86 | | 7th bank bag | + +**Returns:** +- `inventoryID` + - *number* - InventorySlotId used in functions like `PutItemInBag()` and `GetInventoryItemLink()` + +**Usage:** +Prints all bag container IDs and their respective inventory IDs (You need to be at the bank for bank inventory IDs to return valid results): +```lua +for i = 1, NUM_BAG_SLOTS + NUM_BANKBAGSLOTS do + local invID = ContainerIDToInventoryID(i) + print(i, invID, GetInventoryItemLink("player", invID)) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/ConvertToParty.md b/wiki-information/functions/ConvertToParty.md new file mode 100644 index 00000000..83e1f9fd --- /dev/null +++ b/wiki-information/functions/ConvertToParty.md @@ -0,0 +1,8 @@ +## Title: ConvertToParty + +**Content:** +Converts a raid group with 5 or fewer members to a party. +`ConvertToParty()` + +**Reference:** +`ConvertToRaid` \ No newline at end of file diff --git a/wiki-information/functions/ConvertToRaid.md b/wiki-information/functions/ConvertToRaid.md new file mode 100644 index 00000000..de7313a5 --- /dev/null +++ b/wiki-information/functions/ConvertToRaid.md @@ -0,0 +1,8 @@ +## Title: C_PartyInfo.ConvertToRaid + +**Content:** +Needs summary. +`C_PartyInfo.ConvertToRaid()` + +**Description:** +Usually, this will convert to raid immediately. In some cases (e.g. PartySync), the user will be prompted to confirm converting to raid, because it's potentially destructive. \ No newline at end of file diff --git a/wiki-information/functions/CopyToClipboard.md b/wiki-information/functions/CopyToClipboard.md new file mode 100644 index 00000000..9bff731d --- /dev/null +++ b/wiki-information/functions/CopyToClipboard.md @@ -0,0 +1,28 @@ +## Title: CopyToClipboard + +**Content:** +Copies text to the clipboard. +`length = CopyToClipboard(text)` + +**Parameters:** +- `text` + - *string* +- `removeMarkup` + - *boolean?* = false + +**Returns:** +- `length` + - *number* + +**Example Usage:** +```lua +local textToCopy = "Hello, World!" +local length = CopyToClipboard(textToCopy) +print("Copied text length: " .. length) +``` + +**Description:** +The `CopyToClipboard` function is useful for copying text programmatically within the game. This can be particularly handy for addons that need to allow users to easily copy information, such as coordinates, item links, or other data, to their clipboard for use outside the game. + +**Addons Using This Function:** +Many UI enhancement addons, such as ElvUI and WeakAuras, use this function to provide users with the ability to copy text directly from the game interface to their system clipboard. This enhances user experience by allowing easy sharing of information. \ No newline at end of file diff --git a/wiki-information/functions/CreateFont.md b/wiki-information/functions/CreateFont.md new file mode 100644 index 00000000..5bfb4f56 --- /dev/null +++ b/wiki-information/functions/CreateFont.md @@ -0,0 +1,28 @@ +## Title: CreateFont + +**Content:** +Creates a Font object. +`fontObject = CreateFont(name)` + +**Parameters:** +- `name` + - *string* - Globally-accessible name to be assigned for use as `_G`. + +**Returns:** +- `fontObject` + - *Font* - Reference to the new font object. + +**Description:** +Font objects, similar to XML `` elements, may be used to create a common font pattern assigned to several widgets via `FontInstance:SetFontObject(fontObject)`. +Subsequently changing the font object will affect the text displayed on every widget it was assigned to. +Since the new font object is created without any properties, it should be initialized via `FontInstance:SetFont(path, height)` or `Font:CopyFontObject(otherFont)`. + +**Example Usage:** +```lua +local myFont = CreateFont("MyFont") +myFont:SetFont("Fonts\\FRIZQT__.TTF", 12) +myText:SetFontObject(myFont) +``` + +**Addons Using This:** +Many large addons, such as ElvUI and WeakAuras, use `CreateFont` to create custom font objects for consistent text styling across various UI elements. For example, ElvUI uses it to ensure that all text elements adhere to the user's chosen font settings, providing a cohesive look and feel. \ No newline at end of file diff --git a/wiki-information/functions/CreateFrame.md b/wiki-information/functions/CreateFrame.md new file mode 100644 index 00000000..ac6ceab2 --- /dev/null +++ b/wiki-information/functions/CreateFrame.md @@ -0,0 +1,105 @@ +## Title: CreateFrame + +**Content:** +Creates a Frame object. +`frame = CreateFrame(frameType)` + +**Parameters:** +- `frameType` + - *string* - Type of the frame; e.g. "Frame" or "Button". +- `name` + - *string?* - Globally accessible name to assign to the frame, or nil for an anonymous frame. +- `parent` + - *Frame?* - Parent object to assign to the frame, or nil to be parentless; cannot be a string. Can also be set with `Region:SetParent()`. +- `template` + - *string?* - Comma-delimited list of virtual XML templates to inherit; see also a complete list of FrameXML templates. +- `id` + - *number?* - ID to assign to the frame. Can also be set with `Frame:SetID()`. + +**Returns:** +- `frame` + - *Frame* - The created Frame object or one of the other frame type objects. + +**Miscellaneous:** +Possible frame types are available from the XML schema: +- Frame +- ArchaeologyDigSiteFrame +- Browser +- Button +- CheckButton +- Checkout +- CinematicModel +- ColorSelect +- Cooldown +- DressUpModel +- EditBox +- FogOfWarFrame +- GameTooltip +- MessageFrame +- Model +- ModelScene +- MovieFrame +- OffScreenFrame +- PlayerModel +- QuestPOIFrame +- ScenarioPOIFrame +- ScrollFrame +- SimpleHTML +- Slider +- StatusBar +- TabardModel +- UnitPositionFrame + +**Description:** +Fires the frame's OnLoad script, if it has one from an inherited template. +Frames cannot be deleted or garbage collected, so it may be preferable to reuse them. +Intrinsic frames may also be used. + +**Usage:** +Shows a texture which is also parented to UIParent so it will have the same UI scale and hidden when toggled with Alt-Z +```lua +local f = CreateFrame("Frame", nil, UIParent) +f:SetPoint("CENTER") +f:SetSize(64, 64) +f.tex = f:CreateTexture() +f.tex:SetAllPoints(f) +f.tex:SetTexture("interface/icons/inv_mushroom_11") +``` + +Creates a button which inherits textures and widget scripts from UIPanelButtonTemplate +```lua +local btn = CreateFrame("Button", nil, UIParent, "UIPanelButtonTemplate") +btn:SetPoint("CENTER") +btn:SetSize(100, 40) +btn:SetText("Click me") +btn:SetScript("OnClick", function(self, button, down) + print("Pressed", button, down and "down" or "up") +end) +btn:RegisterForClicks("AnyDown", "AnyUp") +``` + +Displays an animated model for a DisplayID. +```lua +local m = CreateFrame("PlayerModel") +m:SetPoint("CENTER") +m:SetSize(200, 200) +m:SetDisplayInfo(21723) -- murloccostume.m2 +``` + +Registers for events being fired, like chat messages and when you start/stop moving. +```lua +local function OnEvent(self, event, ...) + print(event, ...) +end +local f = CreateFrame("Frame") +f:RegisterEvent("CHAT_MSG_CHANNEL") +f:RegisterEvent("PLAYER_STARTED_MOVING") +f:RegisterEvent("PLAYER_STOPPED_MOVING") +f:SetScript("OnEvent", OnEvent) +``` + +**Reference:** +- `CreateFramePool()` + +**Example Use Case:** +CreateFrame is widely used in many addons to create various UI elements. For example, the popular addon "WeakAuras" uses `CreateFrame` to create custom frames for displaying auras and other visual indicators. \ No newline at end of file diff --git a/wiki-information/functions/CreateMacro.md b/wiki-information/functions/CreateMacro.md new file mode 100644 index 00000000..dc37f929 --- /dev/null +++ b/wiki-information/functions/CreateMacro.md @@ -0,0 +1,36 @@ +## Title: CreateMacro + +**Content:** +Creates a macro. +`macroId = CreateMacro(name, iconFileID)` + +**Parameters:** +- `name` + - *string* - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit. +- `iconFileID` + - *number|string* - A FileID or string identifying the icon texture to use. The available icons can be retrieved by calling `GetMacroIcons()` and `GetMacroItemIcons()`; other textures inside `Interface\\ICONS` may also be used. +- `body` + - *string?* - The macro commands to be executed. If this string is longer than 255 characters, only the first 255 will be saved. +- `perCharacter` + - *boolean?* - true to create a per-character macro, nil to create a general macro available to all characters. + +**Returns:** +- `macroId` + - *number* - The 1-based index of the newly-created macro, as displayed in the "Create Macros" UI. + +**Usage:** +Creates an empty macro with the respective FileID for "trade_engineering": +```lua +/run CreateMacro("test", 136243) +``` +Creates a character-specific macro. The question mark icon will dynamically display the Hearthstone icon: +```lua +/run CreateMacro("to home", "INV_Misc_QuestionMark", "/cast Hearthstone", true) +``` + +**Description:** +This function will generate an error if the maximum macros of the specified kind already exist (120 for per account and 18 for per character). +It is possible to create macros with duplicate names. You should enumerate the current macros using `GetNumMacros()` and `GetMacroInfo(macroId)` to ensure that your new macro name doesn't already exist. Macros with duplicate names can be used in most situations, but the behavior of macro functions that retrieve a macro by name is undefined when multiple macros of that name exist. + +**Reference:** +- `EditMacro` \ No newline at end of file diff --git a/wiki-information/functions/CreateWindow.md b/wiki-information/functions/CreateWindow.md new file mode 100644 index 00000000..9d9485ae --- /dev/null +++ b/wiki-information/functions/CreateWindow.md @@ -0,0 +1,16 @@ +## Title: CreateWindow + +**Content:** +Needs summary. +`window = CreateWindow()` + +**Parameters:** +- `popupStyle` + - *boolean?* = true + +**Returns:** +- `window` + - *SimpleWindow?* + +**Description:** +This function is disabled in public clients and will always return nil. \ No newline at end of file diff --git a/wiki-information/functions/CursorCanGoInSlot.md b/wiki-information/functions/CursorCanGoInSlot.md new file mode 100644 index 00000000..41204fba --- /dev/null +++ b/wiki-information/functions/CursorCanGoInSlot.md @@ -0,0 +1,13 @@ +## Title: CursorCanGoInSlot + +**Content:** +True if the item held by the cursor can be equipped in the specified (equipment) inventory slot. +`fitsInSlot = CursorCanGoInSlot(invSlot)` + +**Parameters:** +- `invSlot` + - *number* : inventorySlotId - Inventory slot to query + +**Returns:** +- `fitsInSlot` + - *boolean* - 1 if the thing currently on the cursor can go into the specified slot, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/CursorHasItem.md b/wiki-information/functions/CursorHasItem.md new file mode 100644 index 00000000..cd667a73 --- /dev/null +++ b/wiki-information/functions/CursorHasItem.md @@ -0,0 +1,12 @@ +## Title: CursorHasItem + +**Content:** +Returns true if the cursor currently holds an item. +`hasItem = CursorHasItem()` + +**Returns:** +- `hasItem` + - *boolean* - Whether the cursor is holding an item. + +**Description:** +This function returns nil if the item on the cursor was not picked up via `PickupContainerItem`, e.g. items from the guild bank (which are picked up via `PickupGuildBankItem`) or a merchant item. \ No newline at end of file diff --git a/wiki-information/functions/CursorHasMacro.md b/wiki-information/functions/CursorHasMacro.md new file mode 100644 index 00000000..8c070208 --- /dev/null +++ b/wiki-information/functions/CursorHasMacro.md @@ -0,0 +1,9 @@ +## Title: CursorHasMacro + +**Content:** +Needs summary. +`result = CursorHasMacro()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CursorHasMoney.md b/wiki-information/functions/CursorHasMoney.md new file mode 100644 index 00000000..fad9f3e6 --- /dev/null +++ b/wiki-information/functions/CursorHasMoney.md @@ -0,0 +1,15 @@ +## Title: CursorHasMoney + +**Content:** +Needs summary. +`result = CursorHasMoney()` + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +This function can be used to check if the cursor is currently holding money. This is useful in scenarios where you need to verify if a player is attempting to drag and drop money, such as when making a trade or depositing money into a guild bank. + +**Addons:** +Many large addons that deal with trading, banking, or auction house functionalities might use this function to ensure proper handling of money transactions. For example, the popular addon "TradeSkillMaster" could use this function to verify if the user is trying to move money while managing their auctions or inventory. \ No newline at end of file diff --git a/wiki-information/functions/CursorHasSpell.md b/wiki-information/functions/CursorHasSpell.md new file mode 100644 index 00000000..2a49b4f1 --- /dev/null +++ b/wiki-information/functions/CursorHasSpell.md @@ -0,0 +1,9 @@ +## Title: CursorHasSpell + +**Content:** +Needs summary. +`result = CursorHasSpell()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/DeathRecap_GetEvents.md b/wiki-information/functions/DeathRecap_GetEvents.md new file mode 100644 index 00000000..4a36fa13 --- /dev/null +++ b/wiki-information/functions/DeathRecap_GetEvents.md @@ -0,0 +1,51 @@ +## Title: DeathRecap_GetEvents + +**Content:** +Returns a table representing the last five damaging combat events against the player. +`events = DeathRecap_GetEvents()` + +**Parameters:** +- `recapID` + - *number* - The specific death to view, from 1 to the most recent death. If this is not given, the most recent ID is used. + +**Returns:** +- `events` + - *table* - A table of events for the chosen death, or nil if the player has not died this session. + +**Description:** +The return table contains five sub tables. The keys for these tables are the same as the param names used for COMBAT_LOG_EVENT. +Example: +```lua +{ + { + timestamp = 1421121447.489, + event = "SWING_DAMAGE", + hideCaster = false, + sourceGUID = "Creature-0-3296-870-59-72280-0000347644", + sourceName = "Manifestation of Pride", + sourceFlags = 2632, + sourceRaidFlags = 0, + destGUID = "Player-3296-0084A447", + destName = "Gethe", + destFlags = 1297, + destRaidFlags = 0, + amount = 1472, + overkill = -1, + school = 1, + critical = false, + glancing = false, + crushing = false, + isOffHand = false, + multistrike = false, + currentHP = 2185, + }, + {...}, + {...}, + {...}, + {...}, +} +``` + +**Reference:** +- `DeathRecap_HasEvents` +- `GetDeathRecapLink` \ No newline at end of file diff --git a/wiki-information/functions/DeathRecap_HasEvents.md b/wiki-information/functions/DeathRecap_HasEvents.md new file mode 100644 index 00000000..38d0a4d9 --- /dev/null +++ b/wiki-information/functions/DeathRecap_HasEvents.md @@ -0,0 +1,13 @@ +## Title: DeathRecap_HasEvents + +**Content:** +Returns a boolean for if the player has any available death events. +`hasEvents = DeathRecap_HasEvents()` + +**Returns:** +- `hasEvents` + - *boolean* - Whether or not `DeathRecap_GetEvents` can return a useful value. + +**Reference:** +- `DeathRecap_GetEvents` +- `GetDeathRecapLink` \ No newline at end of file diff --git a/wiki-information/functions/DeclineArenaTeam.md b/wiki-information/functions/DeclineArenaTeam.md new file mode 100644 index 00000000..b3baa900 --- /dev/null +++ b/wiki-information/functions/DeclineArenaTeam.md @@ -0,0 +1,15 @@ +## Title: DeclineArenaTeam + +**Content:** +Declines a pending arena team invitation. +`DeclineArenaTeam()` + +**Description:** +Only one arena team invitation may be pending at any time. + +**Reference:** +- `ARENA_TEAM_INVITE_REQUEST` +- `ARENA_TEAM_INVITE_CANCEL` + +**See also:** +- `AcceptArenaTeam` \ No newline at end of file diff --git a/wiki-information/functions/DeclineChannelInvite.md b/wiki-information/functions/DeclineChannelInvite.md new file mode 100644 index 00000000..d50f002c --- /dev/null +++ b/wiki-information/functions/DeclineChannelInvite.md @@ -0,0 +1,13 @@ +## Title: DeclineChannelInvite + +**Content:** +Declines an invitation to join a specific chat channel. +`DeclineChannelInvite(channel)` + +**Parameters:** +- `channel` + - *string* - name of the channel the player was invited to but does not wish to join. + +**Description:** +`CHANNEL_INVITE_REQUEST` fires when the player has been invited to a chat channel. +There is no equivalent Accept function; FrameXML merely calls `JoinPermanentChannel` when the invitation is accepted. \ No newline at end of file diff --git a/wiki-information/functions/DeclineGroup.md b/wiki-information/functions/DeclineGroup.md new file mode 100644 index 00000000..3cca2a22 --- /dev/null +++ b/wiki-information/functions/DeclineGroup.md @@ -0,0 +1,22 @@ +## Title: DeclineGroup + +**Content:** +Declines an invitation to a group. +`DeclineGroup()` + +**Usage:** +The following snippet auto-declines invitations from characters whose names contain Ghost. +```lua +local frame = CreateFrame("FRAME") +frame:RegisterEvent("PARTY_INVITE_REQUEST") +frame:SetScript("OnEvent", function(self, event, sender) + if sender:match("Ghost") then + DeclineGroup() + end +end) +``` + +**Description:** +You can use this after receiving the `PARTY_INVITE_REQUEST` event. If there is no invitation to a party, this function doesn't do anything. +Calling this function does NOT cause the "accept/decline dialog" to go away. Use `StaticPopup_Hide("PARTY_INVITE")` to hide the dialog. +Depending on the order events are dispatched in, your event handler may run before UIParent's, and therefore attempt to hide the dialog before it is shown. Delaying the attempt to hide the popup until `PARTY_MEMBERS_CHANGED` resolves this. \ No newline at end of file diff --git a/wiki-information/functions/DeclineGuild.md b/wiki-information/functions/DeclineGuild.md new file mode 100644 index 00000000..e82c7ae5 --- /dev/null +++ b/wiki-information/functions/DeclineGuild.md @@ -0,0 +1,11 @@ +## Title: DeclineGuild + +**Content:** +Declines a guild invite. +`DeclineGuild()` + +**Reference:** +- `GUILD_INVITE_REQUEST` +- `GUILD_INVITE_CANCEL` +- See also: + - `AcceptGuild` \ No newline at end of file diff --git a/wiki-information/functions/DeclineName.md b/wiki-information/functions/DeclineName.md new file mode 100644 index 00000000..8f08f265 --- /dev/null +++ b/wiki-information/functions/DeclineName.md @@ -0,0 +1,37 @@ +## Title: DeclineName + +**Content:** +Returns suggested declensions for a Russian name. +`genitive, dative, accusative, instrumental, prepositional = DeclineName(name, gender, declensionSet)` + +**Parameters:** +- `name` + - *string* - Nominative form of the player's or pet's name (string) +- `gender` + - *number* - Gender for the returned names (for declensions of the player's name, should match the player's gender; for the pet's name, should be neuter). + - `ID` + - `Gender` + - `1` + - Neutrum / Unknown + - `2` + - Male + - `3` + - Female +- `declensionSet` + - *number* - Ranging from 1 to `GetNumDeclensionSets()`. Lower indices correspond to "better" suggestions for the given name. + +**Returns:** +- `genitive` + - *string* +- `dative` + - *string* +- `accusative` + - *string* +- `instrumental` + - *string* +- `prepositional` + - *string* + +**Description:** +Requires the ruRU client. +Static names for e.g NPCs are in `DeclinedWord.db2`, `DeclinedWordCases.db2`. \ No newline at end of file diff --git a/wiki-information/functions/DeclineQuest.md b/wiki-information/functions/DeclineQuest.md new file mode 100644 index 00000000..6a38c4c8 --- /dev/null +++ b/wiki-information/functions/DeclineQuest.md @@ -0,0 +1,11 @@ +## Title: DeclineQuest + +**Content:** +Declines the currently offered quest. +`DeclineQuest()` + +**Description:** +You can call this function once the QUEST_DETAIL event fires. + +**Reference:** +[AcceptQuest](#acceptquest) \ No newline at end of file diff --git a/wiki-information/functions/DeclineResurrect.md b/wiki-information/functions/DeclineResurrect.md new file mode 100644 index 00000000..f8a673c8 --- /dev/null +++ b/wiki-information/functions/DeclineResurrect.md @@ -0,0 +1,11 @@ +## Title: DeclineResurrect + +**Content:** +Declines a resurrection offer. +`DeclineResurrect()` + +**Reference:** +- `RESURRECT_REQUEST` + +**See also:** +- `AcceptResurrect` \ No newline at end of file diff --git a/wiki-information/functions/DeclineSpellConfirmationPrompt.md b/wiki-information/functions/DeclineSpellConfirmationPrompt.md new file mode 100644 index 00000000..ad037032 --- /dev/null +++ b/wiki-information/functions/DeclineSpellConfirmationPrompt.md @@ -0,0 +1,22 @@ +## Title: DeclineSpellConfirmationPrompt + +**Content:** +Declines a spell confirmation prompt (e.g. bonus loot roll). +`DeclineSpellConfirmationPrompt(spellID)` + +**Parameters:** +- `spellID` + - *number* - spell ID of the prompt to decline. + +**Description:** +SPELL_CONFIRMATION_PROMPT fires when a spell confirmation prompt might be presented to the player; it provides the spellID and information about the type, text, and duration of the confirmation prompt. +Calling this function declines the spell prompt: the player does not perform the prompted action. + +**Reference:** +- `AcceptSpellConfirmationPrompt` + +### Example Usage: +This function can be used in scenarios where an addon or script needs to automatically decline certain spell confirmation prompts, such as declining bonus loot rolls in a raid environment. + +### Addon Usage: +Large addons like Deadly Boss Mods (DBM) might use this function to automatically decline certain prompts during encounters to ensure that the player's focus remains on the fight mechanics rather than on additional prompts. \ No newline at end of file diff --git a/wiki-information/functions/DeleteCursorItem.md b/wiki-information/functions/DeleteCursorItem.md new file mode 100644 index 00000000..c2d42157 --- /dev/null +++ b/wiki-information/functions/DeleteCursorItem.md @@ -0,0 +1,8 @@ +## Title: DeleteCursorItem + +**Content:** +Destroys the item held by the cursor. +`DeleteCursorItem()` + +**Description:** +This does not deselect the item, this destroys it. Use `ClearCursor()` to drop an item from the cursor without destroying it. \ No newline at end of file diff --git a/wiki-information/functions/DeleteInboxItem.md b/wiki-information/functions/DeleteInboxItem.md new file mode 100644 index 00000000..99e0c03f --- /dev/null +++ b/wiki-information/functions/DeleteInboxItem.md @@ -0,0 +1,16 @@ +## Title: DeleteInboxItem + +**Content:** +Requests the server to remove a mailbox message. +`DeleteInboxItem(index)` + +**Parameters:** +- `index` + - *number* - the index of the message (1 is the first message) + +**Description:** +`DeleteInboxItem()` returns immediately but one must listen for `MAIL_INBOX_UPDATE`. +The asynchronous request may fail for different reasons, such as an invalid index or when another deletion request is already in progress. +`DeleteInboxItem()` is an unconditional request; the server does not check whether the message still has an item or money attached. +The confirmation box that appears in-game for these conditions is instead triggered by `InboxItemCanDelete` before calling `DeleteInboxItem`. +Note that `InboxItemCanDelete` is not a permission-checking function, it is just an API for determining whether a message is returnable (and thus has a misleading name). All messages are in fact deletable. \ No newline at end of file diff --git a/wiki-information/functions/DeleteMacro.md b/wiki-information/functions/DeleteMacro.md new file mode 100644 index 00000000..1beb9b1d --- /dev/null +++ b/wiki-information/functions/DeleteMacro.md @@ -0,0 +1,38 @@ +## Title: DeleteMacro + +**Content:** +Deletes a macro. +`DeleteMacro(indexOrName)` + +**Parameters:** +The sole argument has two forms to identify which macro to delete. +- `indexOrName` + - *number|string* - Index ranging from 1 to 120 for account-wide macros and 121 to 138 for character-specific ones or name of the macro to delete. + +**Usage:** +Deleting all global macros: +```lua +-- Start at the end, and move backward to first position (1). +for i = 0 + select(1, GetNumMacros()), 1, -1 do + DeleteMacro(i) +end +``` + +Deleting all character-specific macros: +```lua +-- Start at the end, and move backward to first position (121). +for i = 120 + select(2, GetNumMacros()), 121, -1 do + DeleteMacro(i) +end +``` + +**Reference:** +- `GetMacroInfo()` +- `EditMacro()` +- `PickupMacro()` + +**Example Use Case:** +This function can be used in a scenario where a player wants to clear out all their macros, either globally or character-specific, to start fresh or to manage their macro slots more efficiently. + +**Addons Using This Function:** +Many macro management addons, such as "GSE: Gnome Sequencer Enhanced", use this function to delete existing macros before creating new ones to ensure there are no conflicts or to reset the macro list. \ No newline at end of file diff --git a/wiki-information/functions/DescendStop.md b/wiki-information/functions/DescendStop.md new file mode 100644 index 00000000..d14f69de --- /dev/null +++ b/wiki-information/functions/DescendStop.md @@ -0,0 +1,11 @@ +## Title: DescendStop + +**Content:** +Stops descending while flying or swimming. +`DescendStop()` + +**Example Usage:** +This function can be used in macros or scripts to control character movement, particularly useful in scenarios where precise control over flying or swimming is required. + +**Addons:** +Many addons that enhance character movement or provide custom controls for flying mounts might use this function. For example, addons like "FlightMaster" or "EasyFly" could utilize `DescendStop()` to provide better control over descent during flight. \ No newline at end of file diff --git a/wiki-information/functions/DestroyTotem.md b/wiki-information/functions/DestroyTotem.md new file mode 100644 index 00000000..4bcf01fe --- /dev/null +++ b/wiki-information/functions/DestroyTotem.md @@ -0,0 +1,12 @@ +## Title: DestroyTotem + +**Content:** +Destroys a totem/minion. +`DestroyTotem(slot)` + +**Parameters:** +- `slot` + - *number* - The totem type to be destroyed, where Fire is 1, Earth is 2, Water is 3, and Air is 4. + +**Reference:** +- `PLAYER_TOTEM_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/DisableAddOn.md b/wiki-information/functions/DisableAddOn.md new file mode 100644 index 00000000..6adfdf27 --- /dev/null +++ b/wiki-information/functions/DisableAddOn.md @@ -0,0 +1,42 @@ +## Title: DisableAddOn + +**Content:** +Disables an addon for subsequent sessions. +`DisableAddOn(addon)` + +**Parameters:** +- `addon` + - *number* - addonIndex from 1 to GetNumAddOns() + - *or string* - addonName (as in toc/folder filename) of the addon, case insensitive. +- `character` + - *string?* - playerName of the character (without realm) + - *or boolean?* - enableAll True if the addon should be enabled/disabled for all characters on the realm. + - Defaults to the current character. This param is currently bugged when attempting to use it (Issue #156). + +**Description:** +Takes effect only after reloading the UI. +Attempting to disable secure addons with the GuardedAddOn TOC metadata field will result in a "Cannot disable a guarded AddOn" error. + +**Usage:** +Enables the addon at index 1 for the current character. +```lua +function PrintAddonInfo(idx) + local name = GetAddOnInfo(idx) + local enabledState = GetAddOnEnableState(nil, idx) + print(name, enabledState) +end + +PrintAddonInfo(1) -- "HelloWorld", 0 +EnableAddOn(1) +PrintAddonInfo(1) -- "HelloWorld", 2 +``` + +This should enable an addon for all characters, provided it isn't bugged. +```lua +EnableAddOn("HelloWorld", true) +``` + +Blizzard addons can be only accessed by name instead of index. +```lua +DisableAddOn("Blizzard_CombatLog") +``` \ No newline at end of file diff --git a/wiki-information/functions/DismissCompanion.md b/wiki-information/functions/DismissCompanion.md new file mode 100644 index 00000000..8c566eaf --- /dev/null +++ b/wiki-information/functions/DismissCompanion.md @@ -0,0 +1,9 @@ +## Title: DismissCompanion + +**Content:** +Dismisses the current companion. +`DismissCompanion(type)` + +**Parameters:** +- `type` + - *string* - type of companion to dismiss, either "MOUNT" or "CRITTER". \ No newline at end of file diff --git a/wiki-information/functions/Dismount.md b/wiki-information/functions/Dismount.md new file mode 100644 index 00000000..64884fb2 --- /dev/null +++ b/wiki-information/functions/Dismount.md @@ -0,0 +1,18 @@ +## Title: Dismount + +**Content:** +Dismounts the character. +`Dismount()` + +**Example Usage:** +```lua +-- This will dismount the player if they are currently mounted +Dismount() +``` + +**Description:** +The `Dismount` function is used to dismount the player's character if they are currently mounted. This can be useful in various scenarios, such as when a player needs to interact with an object or NPC that requires them to be on foot. + +**Usage in Addons:** +Many addons that manage mounts or provide enhanced mount functionality may use the `Dismount` function. For example: +- **Mount addons** like "MountManager" or "GupPet" might use this function to automatically dismount the player when they need to perform certain actions that cannot be done while mounted. \ No newline at end of file diff --git a/wiki-information/functions/DisplayChannelOwner.md b/wiki-information/functions/DisplayChannelOwner.md new file mode 100644 index 00000000..13ae2a2b --- /dev/null +++ b/wiki-information/functions/DisplayChannelOwner.md @@ -0,0 +1,9 @@ +## Title: DisplayChannelOwner + +**Content:** +Prints the name of the owner of the specified channel. +`DisplayChannelOwner(channelName)` + +**Parameters:** +- `channelName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/DoReadyCheck.md b/wiki-information/functions/DoReadyCheck.md new file mode 100644 index 00000000..553f022f --- /dev/null +++ b/wiki-information/functions/DoReadyCheck.md @@ -0,0 +1,24 @@ +## Title: DoReadyCheck + +**Content:** +Initiates a ready check. +`DoReadyCheck()` + +**Description:** +This function initiates a raid ready check and will cause all raid members to receive a READY_CHECK event. Processing of the ready check results appears to be either server-side or internal to the client and does not seem to be directly available to the scripting system. + +Since there's no event that emits when everyone is ready, you'll have to use `CHAT_MSG_SYSTEM` events and check if the message contains the string "Everyone is Ready", which is server-sided emitted to the player when everyone is ready in a party. + +You can accomplish this by registering the event: +```lua +local frame = CreateFrame("Frame") -- Create the frame +frame:RegisterEvent("CHAT_MSG_SYSTEM") -- Register the event +frame:SetScript("OnEvent", function(self, event, msg) -- When the event fires do: + if strfind(msg, "Everyone is Ready") then -- Check if the System Message contains the string "Everyone is Ready". + -- Insert code for when all players are ready! + end +end) +``` + +**Example Usage:** +This function is commonly used in raid management addons to ensure all members are ready before starting an encounter. For instance, the popular addon "Deadly Boss Mods" (DBM) uses ready checks to confirm that all raid members are prepared for a boss fight. \ No newline at end of file diff --git a/wiki-information/functions/DoTradeSkill.md b/wiki-information/functions/DoTradeSkill.md new file mode 100644 index 00000000..8213aa10 --- /dev/null +++ b/wiki-information/functions/DoTradeSkill.md @@ -0,0 +1,23 @@ +## Title: DoTradeSkill + +**Content:** +Performs the tradeskill a specified number of times. +`DoTradeSkill(index, repeat)` + +**Parameters:** +- `index` + - *number* - The index of the tradeskill recipe. +- `repeat` + - *number* - The number of times to repeat the creation of the specified recipe. + +**Example Usage:** +```lua +-- Example: Crafting 5 items of the first recipe in the tradeskill window +DoTradeSkill(1, 5) +``` + +**Description:** +The `DoTradeSkill` function is used to automate the crafting process in World of Warcraft. By specifying the index of the tradeskill recipe and the number of times to repeat the action, players can efficiently craft multiple items without manual intervention. + +**Usage in Addons:** +Many large addons, such as TradeSkillMaster (TSM), use `DoTradeSkill` to automate crafting processes. TSM, for example, allows players to queue up multiple items to be crafted and then uses this function to process the queue, making it easier to manage large-scale crafting operations. \ No newline at end of file diff --git a/wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md b/wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md new file mode 100644 index 00000000..e2ef573b --- /dev/null +++ b/wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md @@ -0,0 +1,9 @@ +## Title: DoesCurrentLocaleSellExpansionLevels + +**Content:** +Needs summary. +`regionSellsExpansions = DoesCurrentLocaleSellExpansionLevels()` + +**Returns:** +- `regionSellsExpansions` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/DoesSpellExist.md b/wiki-information/functions/DoesSpellExist.md new file mode 100644 index 00000000..c0c1e01d --- /dev/null +++ b/wiki-information/functions/DoesSpellExist.md @@ -0,0 +1,16 @@ +## Title: DoesSpellExist + +**Content:** +This function returns true if the player character knows the spell. +`spellExists = DoesSpellExist(spellName)` + +**Parameters:** +- `spellName` + - *string* + +**Returns:** +- `spellExists` + - *boolean* + +**Reference:** +C_Spell.DoesSpellExist \ No newline at end of file diff --git a/wiki-information/functions/DropItemOnUnit.md b/wiki-information/functions/DropItemOnUnit.md new file mode 100644 index 00000000..47020c68 --- /dev/null +++ b/wiki-information/functions/DropItemOnUnit.md @@ -0,0 +1,20 @@ +## Title: DropItemOnUnit + +**Content:** +Drops an item from the cursor onto a unit, i.e. to initiate a trade. +`DropItemOnUnit(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - Unit to which you want to give the item on the cursor. + +**Usage:** +```lua +if (CursorHasItem()) then + DropItemOnUnit("pet"); +end; +``` + +**Miscellaneous:** +**Result:** +Item is dropped from the cursor and given to the player's pet. \ No newline at end of file diff --git a/wiki-information/functions/EditMacro.md b/wiki-information/functions/EditMacro.md new file mode 100644 index 00000000..866eb957 --- /dev/null +++ b/wiki-information/functions/EditMacro.md @@ -0,0 +1,33 @@ +## Title: EditMacro + +**Content:** +Modifies an existing macro. +`macroID = EditMacro(macroInfo, name)` + +**Parameters:** +- `macroInfo` + - *number|string* - The index or name of the macro to be edited. Index ranges from 1 to 120 for account-wide macros and 121 to 138 for character-specific. +- `name` + - *string* - The name to assign to the macro. The current UI imposes a 16-character limit. The existing name remains unchanged if this argument is nil. +- `icon` + - *number|string : FileID* - The path to the icon texture to assign to the macro. The existing icon remains unchanged if this argument is nil. +- `body` + - *string?* - The macro commands to be executed. If this string is longer than 255 characters, only the first 255 will be saved. + +**Returns:** +- `macroID` + - *number* - The new index of the macro, as displayed in the "Create Macros" UI. Same as argument "index" unless the macro name is changed, as they are sorted alphabetically. + +**Description:** +If this function is called from within the macro that is edited, the rest of the macro (from the final character's position of the `/run` command onward) will run the new version. + +**Usage:** +```lua +local macroID = EditMacro(1, "GoHome", 134414, "/use Hearthstone") +``` + +**Example Use Case:** +This function can be used to dynamically update a macro based on certain conditions or events in the game. For instance, an addon could use `EditMacro` to change the behavior of a macro depending on the player's current location or status. + +**Addon Usage:** +Many large addons, such as GSE (Gnome Sequencer Enhanced), use `EditMacro` to manage and update macros for users. GSE allows players to create complex sequences of abilities and spells, and it uses `EditMacro` to update these sequences dynamically based on user input or game events. \ No newline at end of file diff --git a/wiki-information/functions/EjectPassengerFromSeat.md b/wiki-information/functions/EjectPassengerFromSeat.md new file mode 100644 index 00000000..fd35d0f4 --- /dev/null +++ b/wiki-information/functions/EjectPassengerFromSeat.md @@ -0,0 +1,9 @@ +## Title: EjectPassengerFromSeat + +**Content:** +Needs summary. +`EjectPassengerFromSeat(virtualSeatIndex)` + +**Parameters:** +- `virtualSeatIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/EnableAddOn.md b/wiki-information/functions/EnableAddOn.md new file mode 100644 index 00000000..71679ef3 --- /dev/null +++ b/wiki-information/functions/EnableAddOn.md @@ -0,0 +1,41 @@ +## Title: EnableAddOn + +**Content:** +Enables an addon for subsequent sessions. +`EnableAddOn(addon)` + +**Parameters:** +- `addon` + - *number* - addonIndex from 1 to `GetNumAddOns()` + - *or string* - addonName (as in toc/folder filename) of the addon, case insensitive. +- `character` + - *string?* - playerName of the character (without realm) + - *or boolean?* - enableAll True if the addon should be enabled/disabled for all characters on the realm. + - Defaults to the current character. This param is currently bugged when attempting to use it (Issue #156). + +**Description:** +Takes effect only after reloading the UI. + +**Usage:** +Enables the addon at index 1 for the current character. +```lua +function PrintAddonInfo(idx) + local name = GetAddOnInfo(idx) + local enabledState = GetAddOnEnableState(nil, idx) + print(name, enabledState) +end + +PrintAddonInfo(1) -- "HelloWorld", 0 +EnableAddOn(1) +PrintAddonInfo(1) -- "HelloWorld", 2 +``` + +This should enable an addon for all characters, provided it isn't bugged. +```lua +EnableAddOn("HelloWorld", true) +``` + +Blizzard addons can be only accessed by name instead of index. +```lua +DisableAddOn("Blizzard_CombatLog") +``` \ No newline at end of file diff --git a/wiki-information/functions/EnumerateFrames.md b/wiki-information/functions/EnumerateFrames.md new file mode 100644 index 00000000..404b3d87 --- /dev/null +++ b/wiki-information/functions/EnumerateFrames.md @@ -0,0 +1,33 @@ +## Title: EnumerateFrames + +**Content:** +Returns the frame which follows the current frame. +`nextFrame = EnumerateFrames()` + +**Parameters:** +- `currentFrame` + - *Frame* - The current frame. If omitted, returns the first frame. + +**Returns:** +- `nextFrame` + - *Frame* - The frame following `currentFrame`. Returns `nil` if there are no more frames. + +**Usage:** +The following snippet prints the names of all visible frames under the mouse cursor. +```lua +local f = EnumerateFrames() +while f do + if f:IsVisible() and f:IsMouseOver() then + print(f:GetDebugName()) + end + f = EnumerateFrames(f) +end +``` + +**Description:** +This API enumerates every single non-forbidden frame whether named, unnamed, or anonymous script handlers. This includes all descendants of other frames. +- If you're using this to search for a frame, make sure you return or break out of the while loop early so you don't continue looping after you get what you need. Not only will you save CPU time, you will also have access to the frame sooner and are less likely to cause lockups. +- If you know the name of the frame you're looking for, don't use this function, just use the frame's name directly or get it from the `_G` table. +- If you're looking for frame(s) that have specific events registered, don't use this function, just use `GetFramesRegisteredForEvent`. +- Don't make new frames inside the while loop. +- The order of iteration follows the order that the frames were created in. \ No newline at end of file diff --git a/wiki-information/functions/EnumerateServerChannels.md b/wiki-information/functions/EnumerateServerChannels.md new file mode 100644 index 00000000..c57d6a4e --- /dev/null +++ b/wiki-information/functions/EnumerateServerChannels.md @@ -0,0 +1,9 @@ +## Title: EnumerateServerChannels + +**Content:** +Returns all available server channels (zone dependent). +`channel1, channel2, ... = EnumerateServerChannels()` + +**Returns:** +- `channel1, channel2, ...` + - *strings* containing all available server channels in this zone \ No newline at end of file diff --git a/wiki-information/functions/EquipCursorItem.md b/wiki-information/functions/EquipCursorItem.md new file mode 100644 index 00000000..ff1d1497 --- /dev/null +++ b/wiki-information/functions/EquipCursorItem.md @@ -0,0 +1,19 @@ +## Title: EquipCursorItem + +**Content:** +Equips the currently picked up item to a specific inventory slot. +`EquipCursorItem(slot)` + +**Parameters:** +- `slot` + - *number* - The InventorySlotId to place the item into. + +**Usage:** +```lua +EquipCursorItem(GetInventorySlotInfo("HEADSLOT")); +EquipCursorItem(GetInventorySlotInfo("HEADSLOT")); +``` + +**Miscellaneous:** +**Result:** +Attempts to equip the currently picked up item to the head slot. \ No newline at end of file diff --git a/wiki-information/functions/EquipItemByName.md b/wiki-information/functions/EquipItemByName.md new file mode 100644 index 00000000..c1067936 --- /dev/null +++ b/wiki-information/functions/EquipItemByName.md @@ -0,0 +1,19 @@ +## Title: EquipItemByName + +**Content:** +Equips an item, optionally into a specified slot. +`EquipItemByName(itemId or itemName or itemLink)` + +**Parameters:** +- `(itemId or "itemName" or "itemLink")` + - `itemId` + - *number* - The numeric ID of the item. i.e., 12345 + - `itemName` + - *string* - The name of the item, i.e., "Worn Dagger". Partial names are valid inputs as well, i.e., "Worn". If several items with the same piece of name exist, the first one found will be equipped. + - `itemLink` + - *string* - The itemLink, when Shift-Clicking items. + - `slot` + - *number?* - The inventory slot to put the item in, obtained via `GetInventorySlotInfo()`. + +**Reference:** +- Blue post confirming 3.3.0 change. \ No newline at end of file diff --git a/wiki-information/functions/EquipPendingItem.md b/wiki-information/functions/EquipPendingItem.md new file mode 100644 index 00000000..f3f3f2aa --- /dev/null +++ b/wiki-information/functions/EquipPendingItem.md @@ -0,0 +1,12 @@ +## Title: EquipPendingItem + +**Content:** +Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot. +`EquipPendingItem(invSlot)` + +**Parameters:** +- `invSlot` + - *number* : InventorySlotId - The slot ID of the item being equipped + +**Description:** +When the player attempts to use a Bind-on-Equip or Bind-on-Pickup item for the first time, the game triggers a confirmation dialog. This method appears to be an internal method used by that dialog which equips the item which activated the dialog if accepted. \ No newline at end of file diff --git a/wiki-information/functions/ExpandCurrencyList.md b/wiki-information/functions/ExpandCurrencyList.md new file mode 100644 index 00000000..dc520f0d --- /dev/null +++ b/wiki-information/functions/ExpandCurrencyList.md @@ -0,0 +1,15 @@ +## Title: ExpandCurrencyList + +**Content:** +Alters the expanded state of a currency list header. +`ExpandCurrencyList(id, expanded)` + +**Parameters:** +- `id` + - *Number* - Index of the header in the currency list to expand/collapse. +- `expanded` + - *Number* - 0 to set to collapsed state; 1 to set to expanded state. + +**Notes and Caveats:** +This function affects the `isExpanded` return value of the `GetCurrencyListInfo` API function, but has no immediate impact on the currency UI (which caches the expanded state when it is shown). +Currencies under collapsed headers are still available to `GetCurrencyListInfo`, so this is a purely visual switch. \ No newline at end of file diff --git a/wiki-information/functions/ExpandFactionHeader.md b/wiki-information/functions/ExpandFactionHeader.md new file mode 100644 index 00000000..53eaa408 --- /dev/null +++ b/wiki-information/functions/ExpandFactionHeader.md @@ -0,0 +1,22 @@ +## Title: ExpandFactionHeader + +**Content:** +Expand a faction header row. +`ExpandFactionHeader(rowIndex)` + +**Parameters:** +- `rowIndex` + - *number* - The row index of the header to expand (Specifying a non-header row can have unpredictable results). The `UPDATE_FACTION` event is fired after the change since faction indexes will have been shifted around. + +**Reference:** +- `CollapseFactionHeader` + +**Example Usage:** +```lua +-- Example of expanding a faction header +local factionIndex = 1 -- Assuming the first faction is a header +ExpandFactionHeader(factionIndex) +``` + +**Additional Information:** +This function is often used in addons that manage or display faction reputation information. For example, an addon like "ReputationBars" might use this function to ensure all faction headers are expanded before displaying detailed reputation bars for each faction. \ No newline at end of file diff --git a/wiki-information/functions/ExpandQuestHeader.md b/wiki-information/functions/ExpandQuestHeader.md new file mode 100644 index 00000000..6b53f418 --- /dev/null +++ b/wiki-information/functions/ExpandQuestHeader.md @@ -0,0 +1,31 @@ +## Title: ExpandQuestHeader + +**Content:** +Expands/collapses a quest log header. +`ExpandQuestHeader(index)` +`CollapseQuestHeader(index)` + +**Parameters:** +- `index` + - *number* - Position in the quest log from 1 at the top, including collapsed and invisible content. +- `isAuto` + - *boolean* - Used when resetting the quest log to a default state. + +**Description:** +Applies to all headers when the index does not point to a header, including out-of-range values like 0. +Fires `QUEST_LOG_UPDATE`. Toggle `QuestMapFrame.ignoreQuestLogUpdate` to suppress the normal event handler. + +**Usage:** +Expand all quest headers: +```lua +ExpandQuestHeader(0) +``` +Collapse the first quest header (always at position 1) while suppressing the normal event handler: +```lua +QuestMapFrame.ignoreQuestLogUpdate = true +CollapseQuestHeader(1) +QuestMapFrame.ignoreQuestLogUpdate = nil +``` + +**Reference:** +`QuestMapFrame_ResetFilters()` - FrameXML function to restore the default expanded/collapsed state. \ No newline at end of file diff --git a/wiki-information/functions/ExpandSkillHeader.md b/wiki-information/functions/ExpandSkillHeader.md new file mode 100644 index 00000000..a96f4d3e --- /dev/null +++ b/wiki-information/functions/ExpandSkillHeader.md @@ -0,0 +1,25 @@ +## Title: ExpandSkillHeader + +**Content:** +Expands a header in the skills window. +`ExpandSkillHeader(index)` + +**Parameters:** +- `index` + - *number* - The index of a line in the skills window. Index 0 ("All") will expand all headers. + +**Reference:** +- `GetSkillLineInfo()` + +**Example Usage:** +```lua +-- Expanding all skill headers +ExpandSkillHeader(0) + +-- Expanding a specific skill header by index +local skillIndex = 3 +ExpandSkillHeader(skillIndex) +``` + +**Common Addon Usage:** +Many addons that manage or display profession and skill information, such as TradeSkillMaster or Skillet, may use this function to ensure all skill headers are expanded before processing or displaying skill data. \ No newline at end of file diff --git a/wiki-information/functions/ExpandTradeSkillSubClass.md b/wiki-information/functions/ExpandTradeSkillSubClass.md new file mode 100644 index 00000000..26a7e52a --- /dev/null +++ b/wiki-information/functions/ExpandTradeSkillSubClass.md @@ -0,0 +1,29 @@ +## Title: ExpandTradeSkillSubClass + +**Content:** +Expands a header within a tradeskill window. +`ExpandTradeSkillSubClass(index)` + +**Parameters:** +- `index` + - *number* - index within the tradeskill window + +**Reference:** +It is unknown whether an event triggers. + +**Usage:** +```lua +_, skillType, _, isExpanded, _, _ = GetTradeSkillInfo(skillIndex) +for index = GetNumTradeSkills(), 1, -1 do + if skillType == "header" then + ExpandTradeSkillSubClass(index) + end +end +``` + +**Result:** +All your currently-listed subclasses will be expanded. Subclasses that are folded within another will remain at their former state, collapsed or expanded. + +**Description:** +No error is generated when already isExpanded. +An error is generated when the skillType ~= "header": Bad skill line in ExpandTradeSkillSubClass. \ No newline at end of file diff --git a/wiki-information/functions/ExpandTrainerSkillLine.md b/wiki-information/functions/ExpandTrainerSkillLine.md new file mode 100644 index 00000000..ee1fd0a0 --- /dev/null +++ b/wiki-information/functions/ExpandTrainerSkillLine.md @@ -0,0 +1,26 @@ +## Title: ExpandTrainerSkillLine + +**Content:** +Expands a header in the trainer window, showing all spells below it. +`ExpandTrainerSkillLine(index)` + +**Parameters:** +- `index` + - *number* - The index of a line in the trainer window (if the supplied index is not a header, an error is produced). + - Index 0 ("All") will expand all headers. + - Note that indices are affected by the trainer filter, see `GetTrainerServiceTypeFilter()` and `SetTrainerServiceTypeFilter()` + +**Reference:** +- `GetTrainerServiceInfo()` + +**Example Usage:** +```lua +-- Expanding all headers in the trainer window +ExpandTrainerSkillLine(0) + +-- Expanding a specific header by index +ExpandTrainerSkillLine(2) +``` + +**Additional Information:** +This function is useful in addons that manage or enhance the trainer window interface, such as those that provide additional filtering or sorting options for available skills. \ No newline at end of file diff --git a/wiki-information/functions/FactionToggleAtWar.md b/wiki-information/functions/FactionToggleAtWar.md new file mode 100644 index 00000000..939019b3 --- /dev/null +++ b/wiki-information/functions/FactionToggleAtWar.md @@ -0,0 +1,12 @@ +## Title: FactionToggleAtWar + +**Content:** +Toggles the At War status for a faction. +`FactionToggleAtWar(rowIndex)` + +**Parameters:** +- `rowIndex` + - *number* - The row index of the faction to toggle the At War status for. The row must have a true `canToggleAtWar` value (From `GetFactionInfo`). + +**Description:** +The `UPDATE_FACTION` event will be fired after the change. \ No newline at end of file diff --git a/wiki-information/functions/FillLocalizedClassList.md b/wiki-information/functions/FillLocalizedClassList.md new file mode 100644 index 00000000..a6eefee7 --- /dev/null +++ b/wiki-information/functions/FillLocalizedClassList.md @@ -0,0 +1,63 @@ +## Title: FillLocalizedClassList + +**Content:** +Fills a table with localized male or female class names. +`t = FillLocalizedClassList(tbl, isFemale)` + +**Parameters:** +- `classTable` + - *table* - The table you want to be filled with the data. +- `isFemale` + - *boolean?* - If the table should be filled with female class names. + +**Returns:** +- `classTable` + - *table* - The same table argument you passed. + +**Usage:** +Prints all female class names. +```lua +local t = {} +FillLocalizedClassList(t, true) +for classFile, name in pairs(t) do + print(classFile, name) +end +``` + +FrameXML already populates the `LOCALIZED_CLASS_NAMES_MALE` and `LOCALIZED_CLASS_NAMES_FEMALE` globals. +```lua +/dump LOCALIZED_CLASS_NAMES_MALE, LOCALIZED_CLASS_NAMES_FEMALE +-- on frFR locale +-- Male class names += { + DEATHKNIGHT = "Chevalier de la mort", + DEMONHUNTER = "Chasseur de démons", + DRUID = "Druide", + EVOKER = "Évocateur", + HUNTER = "Chasseur", + MAGE = "Mage", + MONK = "Moine", + PALADIN = "Paladin", + PRIEST = "Prêtre", + ROGUE = "Voleur", + SHAMAN = "Chaman", + WARLOCK = "Démoniste", + WARRIOR = "Guerrier", +}, +-- Female class names += { + DEATHKNIGHT = "Chevalier de la mort", + DEMONHUNTER = "Chasseuse de démons", + DRUID = "Druidesse", + EVOKER = "Évocatrice", + HUNTER = "Chasseresse", + MAGE = "Mage", + MONK = "Moniale", + PALADIN = "Paladin", + PRIEST = "Prêtresse", + ROGUE = "Voleuse", + SHAMAN = "Chamane", + WARLOCK = "Démoniste", + WARRIOR = "Guerrière", +} +``` \ No newline at end of file diff --git a/wiki-information/functions/FindBaseSpellByID.md b/wiki-information/functions/FindBaseSpellByID.md new file mode 100644 index 00000000..fba95701 --- /dev/null +++ b/wiki-information/functions/FindBaseSpellByID.md @@ -0,0 +1,16 @@ +## Title: FindBaseSpellByID + +**Content:** +Needs summary. +`baseSpellID = FindBaseSpellByID(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `baseSpellID` + - *number* + +**Reference:** +- `FindSpellOverrideByID` \ No newline at end of file diff --git a/wiki-information/functions/FindSpellOverrideByID.md b/wiki-information/functions/FindSpellOverrideByID.md new file mode 100644 index 00000000..44cf3a4f --- /dev/null +++ b/wiki-information/functions/FindSpellOverrideByID.md @@ -0,0 +1,16 @@ +## Title: FindSpellOverrideByID + +**Content:** +Needs summary. +`overrideSpellID = FindSpellOverrideByID(spellID)` + +**Parameters:** +- `spellID` + - *number* + +**Returns:** +- `overrideSpellID` + - *number* + +**Reference:** +- `FindBaseSpellByID` \ No newline at end of file diff --git a/wiki-information/functions/FlashClientIcon.md b/wiki-information/functions/FlashClientIcon.md new file mode 100644 index 00000000..45260466 --- /dev/null +++ b/wiki-information/functions/FlashClientIcon.md @@ -0,0 +1,15 @@ +## Title: FlashClientIcon + +**Content:** +Flashes the game client icon in the Operating System. +`FlashClientIcon()` + +**Usage:** +Flashes the client icon after 5 seconds. +```lua +/run C_Timer.After(5, FlashClientIcon) +``` +Prevents flashing the client icon by NOP'ing it. +```lua +FlashClientIcon = function() end +``` \ No newline at end of file diff --git a/wiki-information/functions/FlipCameraYaw.md b/wiki-information/functions/FlipCameraYaw.md new file mode 100644 index 00000000..90f127a8 --- /dev/null +++ b/wiki-information/functions/FlipCameraYaw.md @@ -0,0 +1,12 @@ +## Title: FlipCameraYaw + +**Content:** +Rotates the camera around the Z-axis. +`FlipCameraYaw(angle)` + +**Parameters:** +- `angle` + - *number* - The angle in degrees to rotate the camera. + +**Description:** +Rotates the camera about the Z-axis by the angle amount specified in degrees. \ No newline at end of file diff --git a/wiki-information/functions/FocusUnit.md b/wiki-information/functions/FocusUnit.md new file mode 100644 index 00000000..54166fb7 --- /dev/null +++ b/wiki-information/functions/FocusUnit.md @@ -0,0 +1,9 @@ +## Title: FocusUnit + +**Content:** +Sets the focus target. +`FocusUnit()` + +**Parameters:** +- `name` + - *string?* : UnitId - The unit to focus. \ No newline at end of file diff --git a/wiki-information/functions/FollowUnit.md b/wiki-information/functions/FollowUnit.md new file mode 100644 index 00000000..a8259d01 --- /dev/null +++ b/wiki-information/functions/FollowUnit.md @@ -0,0 +1,14 @@ +## Title: FollowUnit + +**Content:** +Follows a friendly player unit. +`FollowUnit(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to follow. + +**Description:** +You can stop follow by following the player itself: `FollowUnit("player")`. This can have side effects if the character is in a vehicle. +It is not possible to stop following someone from a script. The player needs to take action (move, jump, sit, whatever). See the Discussion page. +For historical reference, see also `FollowByName()`, which has been removed from the API. \ No newline at end of file diff --git a/wiki-information/functions/ForceGossip.md b/wiki-information/functions/ForceGossip.md new file mode 100644 index 00000000..0850effd --- /dev/null +++ b/wiki-information/functions/ForceGossip.md @@ -0,0 +1,9 @@ +## Title: ForceGossip + +**Content:** +Returns whether the gossip text must be displayed. +`forced = ForceGossip()` + +**Returns:** +- `forced` + - *boolean* - 1 if the client should display the gossip text for this NPC, nil if it is okay to skip directly to the only interaction option available. \ No newline at end of file diff --git a/wiki-information/functions/ForceQuit.md b/wiki-information/functions/ForceQuit.md new file mode 100644 index 00000000..23d09746 --- /dev/null +++ b/wiki-information/functions/ForceQuit.md @@ -0,0 +1,11 @@ +## Title: ForceQuit + +**Content:** +Instantly quits the game, ignoring the 20 seconds timer. +`ForceQuit()` + +**Description:** +Your character will remain present in Azeroth (and attackable by NPCs and other players) until the realm server notices that your WoW client is not connected anymore. + +**Reference:** +`Quit` \ No newline at end of file diff --git a/wiki-information/functions/FrameXML_Debug.md b/wiki-information/functions/FrameXML_Debug.md new file mode 100644 index 00000000..812fa640 --- /dev/null +++ b/wiki-information/functions/FrameXML_Debug.md @@ -0,0 +1,16 @@ +## Title: FrameXML_Debug + +**Content:** +Queries or sets the FrameXML debug logging flag. +`enabled = FrameXML_Debug()` + +**Parameters:** +- `enabled` + - *number?* - 0 to disable debug logging, or 1 to enable it. If not specified, the logging flag will not be modified. + +**Returns:** +- `enabled` + - *number* - The applied logging flag value. + +**Description:** +When FrameXML debugging is enabled, extensive information about the load process is written to `World of Warcraft/.../Logs/FrameXML.log` and `GlueXML.log`. This information includes addon and file load order, as well as the names of all created frames and templates. \ No newline at end of file diff --git a/wiki-information/functions/GMRequestPlayerInfo.md b/wiki-information/functions/GMRequestPlayerInfo.md new file mode 100644 index 00000000..224c75b4 --- /dev/null +++ b/wiki-information/functions/GMRequestPlayerInfo.md @@ -0,0 +1,13 @@ +## Title: GMRequestPlayerInfo + +**Content:** +`GMRequestPlayerInfo()` + +**Parameters:** +- Nothing + +**Returns:** +- Nothing + +**Description:** +Always yields an 'Access Denied' error. \ No newline at end of file diff --git a/wiki-information/functions/GMSubmitBug.md b/wiki-information/functions/GMSubmitBug.md new file mode 100644 index 00000000..9dd9c062 --- /dev/null +++ b/wiki-information/functions/GMSubmitBug.md @@ -0,0 +1,15 @@ +## Title: C_UserFeedback.SubmitBug + +**Content:** +Replaces `GMSubmitBug`. +`success = C_UserFeedback.SubmitBug(bugInfo)` + +**Parameters:** +- `bugInfo` + - *string* +- `suppressNotification` + - *boolean?* = false + +**Returns:** +- `success` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GMSubmitSuggestion.md b/wiki-information/functions/GMSubmitSuggestion.md new file mode 100644 index 00000000..a4ddd4ba --- /dev/null +++ b/wiki-information/functions/GMSubmitSuggestion.md @@ -0,0 +1,19 @@ +## Title: C_UserFeedback.SubmitSuggestion + +**Content:** +Replaces `GMSubmitSuggestion`. +`success = C_UserFeedback.SubmitSuggestion(suggestion)` + +**Parameters:** +- `suggestion` + - *string* + +**Returns:** +- `success` + - *boolean* + +**Example Usage:** +This function can be used to submit a suggestion to the game's feedback system. For instance, if a player wants to suggest a new feature or report a minor issue that doesn't require immediate attention, they can use this function to send their feedback directly to the developers. + +**Addons:** +While not commonly used in large addons, this function can be found in smaller utility addons that provide in-game feedback options for players. These addons might include a UI element where players can type their suggestions and submit them without leaving the game. \ No newline at end of file diff --git a/wiki-information/functions/GetAbandonQuestItems.md b/wiki-information/functions/GetAbandonQuestItems.md new file mode 100644 index 00000000..5a4bc7e5 --- /dev/null +++ b/wiki-information/functions/GetAbandonQuestItems.md @@ -0,0 +1,9 @@ +## Title: C_QuestLog.GetAbandonQuestItems + +**Content:** +Needs summary. +`itemIDs = C_QuestLog.GetAbandonQuestItems()` + +**Returns:** +- `itemIDs` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAbandonQuestName.md b/wiki-information/functions/GetAbandonQuestName.md new file mode 100644 index 00000000..7a8cc0ef --- /dev/null +++ b/wiki-information/functions/GetAbandonQuestName.md @@ -0,0 +1,16 @@ +## Title: GetAbandonQuestName + +**Content:** +Returns the name of a quest that will be abandoned if `AbandonQuest` is called. +`questName = GetAbandonQuestName()` + +**Returns:** +- `questName` + - *string* - Name of the quest that will be abandoned. + +**Description:** +The FrameXML-provided quest log calls `SetAbandonQuest` whenever a quest entry is selected, so this function will usually return the name of the currently selected quest. + +**Reference:** +- `SetAbandonQuest` +- `AbandonQuest` \ No newline at end of file diff --git a/wiki-information/functions/GetAccountExpansionLevel.md b/wiki-information/functions/GetAccountExpansionLevel.md new file mode 100644 index 00000000..66625f3f --- /dev/null +++ b/wiki-information/functions/GetAccountExpansionLevel.md @@ -0,0 +1,55 @@ +## Title: GetAccountExpansionLevel + +**Content:** +Returns the expansion level the account has been flagged for. +`expansionLevel = GetAccountExpansionLevel()` + +**Returns:** +- `expansionLevel` + - *number* - The expansion the player's game license has been flagged for. + - `NUM_LE_EXPANSION_LEVELS` + - `Value` + - `Enum` + - `Description` + - `LE_EXPANSION_LEVEL_CURRENT` + - 0 + - `LE_EXPANSION_CLASSIC` + - Vanilla / Classic Era + - 1 + - `LE_EXPANSION_BURNING_CRUSADE` + - The Burning Crusade + - 2 + - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` + - Wrath of the Lich King + - 3 + - `LE_EXPANSION_CATACLYSM` + - Cataclysm + - 4 + - `LE_EXPANSION_MISTS_OF_PANDARIA` + - Mists of Pandaria + - 5 + - `LE_EXPANSION_WARLORDS_OF_DRAENOR` + - Warlords of Draenor + - 6 + - `LE_EXPANSION_LEGION` + - Legion + - 7 + - `LE_EXPANSION_BATTLE_FOR_AZEROTH` + - Battle for Azeroth + - 8 + - `LE_EXPANSION_SHADOWLANDS` + - Shadowlands + - 9 + - `LE_EXPANSION_DRAGONFLIGHT` + - Dragonflight + - 10 + - `LE_EXPANSION_11_0` + +**Usage:** +Before and after pre-ordering the Shadowlands expansion. Requires a client restart to update, if still in-game. +```lua +/dump GetAccountExpansionLevel() -- 7 -> 8 +``` + +**Reference:** +`GetExpansionLevel()` - Returns the newest expansion actually available to the player. \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementCategory.md b/wiki-information/functions/GetAchievementCategory.md new file mode 100644 index 00000000..fb48cee3 --- /dev/null +++ b/wiki-information/functions/GetAchievementCategory.md @@ -0,0 +1,24 @@ +## Title: GetAchievementCategory + +**Content:** +Returns the category number the requested achievement belongs to. +`categoryID = GetAchievementCategory(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - ID of the achievement to retrieve information for. + +**Returns:** +- `categoryID` + - *number* - ID of the achievement's category. + +**Reference:** +- `GetAchievementComparisonInfo` +- `SetAchievementComparisonUnit` +- `GetNumComparisonCompletedAchievements` + +**Example Usage:** +This function can be used to categorize achievements in an addon that tracks player progress. For instance, an addon like "Overachiever" might use this function to organize achievements into their respective categories for easier navigation and display. + +**Addons Using This Function:** +- **Overachiever**: This popular achievement tracking addon uses `GetAchievementCategory` to sort and display achievements by their categories, helping players to focus on specific types of achievements they want to complete. \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementComparisonInfo.md b/wiki-information/functions/GetAchievementComparisonInfo.md new file mode 100644 index 00000000..0c59941c --- /dev/null +++ b/wiki-information/functions/GetAchievementComparisonInfo.md @@ -0,0 +1,28 @@ +## Title: GetAchievementComparisonInfo + +**Content:** +Returns information about the comparison unit's achievements. +`completed, month, day, year = GetAchievementComparisonInfo(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - ID of the achievement to retrieve information for. + +**Returns:** +- `completed` + - *boolean* - Returns true/false depending on whether the unit has completed the achievement or not. +- `month` + - *number* - Month in which the unit has completed the achievement. Returns nil if completed is false. +- `day` + - *number* - Day of the month in which the unit has completed the achievement. Returns nil if completed is false. +- `year` + - *number* - Year (two digits, 21st century is assumed) in which the unit has completed the achievement. Returns nil if completed is false. + +**Description:** +Only accurate after the `SetAchievementComparisonUnit` is called and the `INSPECT_ACHIEVEMENT_READY` event has fired. +Inaccurate after `ClearAchievementComparisonUnit` has been called. + +**Reference:** +- `ClearAchievementComparisonUnit` +- `SetAchievementComparisonUnit` +- `GetNumComparisonCompletedAchievements` \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementCriteriaInfo.md b/wiki-information/functions/GetAchievementCriteriaInfo.md new file mode 100644 index 00000000..a7d8ea6c --- /dev/null +++ b/wiki-information/functions/GetAchievementCriteriaInfo.md @@ -0,0 +1,210 @@ +## Title: GetAchievementCriteriaInfo + +**Content:** +Returns info for the specified achievement criteria. +```lua +criteriaString, criteriaType, completed, quantity, reqQuantity, charName, flags, assetID, quantityString, criteriaID, eligible + = GetAchievementCriteriaInfo(achievementID, criteriaIndex) + = GetAchievementCriteriaInfoByID(achievementID, criteriaID) +``` + +**Parameters:** +- **GetAchievementCriteriaInfo:** + - `achievementID` + - *number* - Achievement ID the queried criteria belongs to. + - `criteriaIndex` + - *number* - Index of the criteria to query, ascending from 1 up to `GetAchievementNumCriteria(achievementID)`. + +- **GetAchievementCriteriaInfoByID:** + - `achievementID` + - *number* + - `criteriaID` + - *number* - Unique ID of the criteria to query. + - `countHidden` + - *boolean* + +**Values:** +See `Criteria.db2` + +**Achievement Criteria Info:** +- **Value** +- **Description** +- **Corresponding AssetID** + - `0` + - Monster kill + - Monster ID + - `1` + - Winning PvP objectives in a thorough manner (holding all bases, controlling all flags) + - `5` + - Reaching a player level + - Player level + - `7` + - Weapon skill + - probably a skill ID of some sort + - `8` + - Another achievement + - Achievement ID + - `9` + - Completing quests globally + - `10` + - Completing a daily quest every day + - `11` + - Completing quests in specific areas + - `12` + - Collecting currency + - Currency ID + - `14` + - Completing daily quests + - `16` + - Dying in specific locations + - Location + - `20` + - Defeating a boss encounter + - NPC ID + - `27` + - Completing a quest + - Quest ID + - `28` + - Getting a spell cast on you + - Spell ID + - `29` + - Casting a spell (often crafting) + - Spell ID + - `30` + - PvP objectives (flags, assaulting, defending) + - `31` + - PvP kills in battleground PvP locations + - `32` + - Winning ranked arena matches in specific locations + - (probably a location ID) + - `34` + - Squashling (owning a specific pet?) + - Spell ID + - `35` + - PvP kills while under the influence of something + - `36` + - Acquiring items (soulbound) + - Item ID + - `37` + - Winning arenas + - `38` + - Highest-reached arena team rating + - Team size + - `39` + - Achieving arena team rating + - Team size + - `41` + - Eating or drinking a specific item + - Item ID + - `42` + - Fishing things up + - Item ID + - `43` + - Exploration + - (location ID?) + - `44` + - Reaching a PvP rank (old PvP system) + - Rank + - `45` + - Purchasing 7 bank slots + - `46` + - Exalted rep + - Faction ID + - `47` + - 5 reputations to exalted + - `49` + - Equipping items + - Slot ID (quality is presumably encoded into flags) + - `52` + - Killing specific classes of player + - `53` + - Kill-a-given-race + - (Race ID?) + - `54` + - Using emotes on targets + - (likely the emote ID) + - `55` + - Healing + - `56` + - Being a wrecking ball in Alterac Valley + - `57` + - Having items (tabards and legendaries) + - Item ID + - `59` + - Getting gold from vendors + - `62` + - Getting gold from quest rewards + - `67` + - Looting gold + - `68` + - Reading books + - Object ID + - `70` + - Killing players in world PvP locations + - `72` + - Fishing things from schools or wreckage + - Object ID + - `73` + - Killing Mal'Ganis on Heroic. Why? Who can say. + - `74` + - Earning a title (for guild achievements) + - `75` + - Obtaining mounts + - `96` + - Obtaining battle pets + - NPC ID of the pet + - `109` + - Fishing, either in general or in specific locations + - `110` + - Casting spells on specific target + - Spell ID + - `112` + - Learning cooking recipes + - `113` + - Honorable kills + - `124` + - Spending guild gold on repairs + - `125` + - Reaching a guild level + - `126` + - Crafting items as a guild + - `127` + - Fishing as a guild + - `128` + - Purchasing guild bank tabs + - `129` + - Guild achievement points + - `130` + - Winning rated battlegrounds + - `132` + - Reaching rated battleground rating + - `133` + - Purchasing a guild crest + +**Returns:** +1. `criteriaString` + - *string* - The name of the criteria. +2. `criteriaType` + - *number* - Criteria type; specifies the meaning of the `assetID`. +3. `completed` + - *boolean* - True if you've completed this criteria; false otherwise. +4. `quantity` + - *number* - Quantity requirement imposed by some `criteriaType`. +5. `reqQuantity` + - *number* - The required quantity for the criteria. Used mostly in achievements with progress bars. Usually 0. +6. `charName` + - *string* - The name of the character that completed this achievement. +7. `flags` + - *number* - Some flags. Currently unknown purpose. +8. `assetID` + - *number* - Criteria data whose meaning depends on the type. +9. `quantityString` + - *string* - The string used to display the current quantity. Usually the string form of the `quantity` return. +10. `criteriaID` + - *number* - Unique criteria ID. +11. `eligible` + - *boolean* - True if the criteria is eligible to be completed; false otherwise. Used to determine whether to show the criteria line in the objectives tracker in red or not. +12. `duration` + - *number* +13. `elapsed` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementCriteriaInfoByID.md b/wiki-information/functions/GetAchievementCriteriaInfoByID.md new file mode 100644 index 00000000..a798ee7a --- /dev/null +++ b/wiki-information/functions/GetAchievementCriteriaInfoByID.md @@ -0,0 +1,117 @@ +## Title: GetAchievementCriteriaInfo + +**Content:** +Returns info for the specified achievement criteria. +```lua +criteriaString, criteriaType, completed, quantity, reqQuantity, charName, flags, assetID, quantityString, criteriaID, eligible + = GetAchievementCriteriaInfo(achievementID, criteriaIndex) + = GetAchievementCriteriaInfoByID(achievementID, criteriaID) +``` + +**Parameters:** + +*GetAchievementCriteriaInfo:* +- `achievementID` + - *number* - Achievement ID the queried criteria belongs to. +- `criteriaIndex` + - *number* - Index of the criteria to query, ascending from 1 up to `GetAchievementNumCriteria(achievementID)`. + +*GetAchievementCriteriaInfoByID:* +- `achievementID` + - *number* +- `criteriaID` + - *number* - Unique ID of the criteria to query. +- `countHidden` + - *boolean* + +**Achievement Criteria Info:** +- **Value** - **Description** - **Corresponding AssetID** + - `0` - Monster kill - Monster ID + - `1` - Winning PvP objectives in a thorough manner (holding all bases, controlling all flags) + - `5` - Reaching a player level - Player level + - `7` - Weapon skill - probably a skill ID of some sort + - `8` - Another achievement - Achievement ID + - `9` - Completing quests globally + - `10` - Completing a daily quest every day + - `11` - Completing quests in specific areas + - `12` - Collecting currency - Currency ID + - `14` - Completing daily quests + - `16` - Dying in specific locations - Location + - `20` - Defeating a boss encounter - NPC ID + - `27` - Completing a quest - Quest ID + - `28` - Getting a spell cast on you - Spell ID + - `29` - Casting a spell (often crafting) - Spell ID + - `30` - PvP objectives (flags, assaulting, defending) + - `31` - PvP kills in battleground PvP locations + - `32` - Winning ranked arena matches in specific locations - (probably a location ID) + - `34` - Squashling (owning a specific pet?) - Spell ID + - `35` - PvP kills while under the influence of something + - `36` - Acquiring items (soulbound) - Item ID + - `37` - Winning arenas + - `38` - Highest-reached arena team rating - Team size + - `39` - Achieving arena team rating - Team size + - `41` - Eating or drinking a specific item - Item ID + - `42` - Fishing things up - Item ID + - `43` - Exploration - (location ID?) + - `44` - Reaching a PvP rank (old PvP system) - Rank + - `45` - Purchasing 7 bank slots + - `46` - Exalted rep - Faction ID + - `47` - 5 reputations to exalted + - `49` - Equipping items - Slot ID (quality is presumably encoded into flags) + - `52` - Killing specific classes of player + - `53` - Kill-a-given-race - (Race ID?) + - `54` - Using emotes on targets - (likely the emote ID) + - `55` - Healing + - `56` - Being a wrecking ball in Alterac Valley + - `57` - Having items (tabards and legendaries) - Item ID + - `59` - Getting gold from vendors + - `62` - Getting gold from quest rewards + - `67` - Looting gold + - `68` - Reading books - Object ID + - `70` - Killing players in world PvP locations + - `72` - Fishing things from schools or wreckage - Object ID + - `73` - Killing Mal'Ganis on Heroic. Why? Who can say. + - `74` - Earning a title (for guild achievements) + - `75` - Obtaining mounts + - `96` - Obtaining battle pets - NPC ID of the pet + - `109` - Fishing, either in general or in specific locations + - `110` - Casting spells on specific target - Spell ID + - `112` - Learning cooking recipes + - `113` - Honorable kills + - `124` - Spending guild gold on repairs + - `125` - Reaching a guild level + - `126` - Crafting items as a guild + - `127` - Fishing as a guild + - `128` - Purchasing guild bank tabs + - `129` - Guild achievement points + - `130` - Winning rated battlegrounds + - `132` - Reaching rated battleground rating + - `133` - Purchasing a guild crest + +**Returns:** +1. `criteriaString` + - *string* - The name of the criteria. +2. `criteriaType` + - *number* - Criteria type; specifies the meaning of the assetID. +3. `completed` + - *boolean* - True if you've completed this criteria; false otherwise. +4. `quantity` + - *number* - Quantity requirement imposed by some criteriaType. +5. `reqQuantity` + - *number* - The required quantity for the criteria. Used mostly in achievements with progress bars. Usually 0. +6. `charName` + - *string* - The name of the character that completed this achievement. +7. `flags` + - *number* - Some flags. Currently unknown purpose. +8. `assetID` + - *number* - Criteria data whose meaning depends on the type. +9. `quantityString` + - *string* - The string used to display the current quantity. Usually the string form of the quantity return. +10. `criteriaID` + - *number* - Unique criteria ID. +11. `eligible` + - *boolean* - True if the criteria is eligible to be completed; false otherwise. Used to determine whether to show the criteria line in the objectives tracker in red or not. +12. `duration` + - *number* +13. `elapsed` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementLink.md b/wiki-information/functions/GetAchievementLink.md new file mode 100644 index 00000000..5afab093 --- /dev/null +++ b/wiki-information/functions/GetAchievementLink.md @@ -0,0 +1,13 @@ +## Title: GetAchievementLink + +**Content:** +Returns an achievement link. +`achievementLink = GetAchievementLink(AchievementID)` + +**Parameters:** +- `achievementID` + - *number* - The ID of the Achievement. + +**Returns:** +- `achievementLink` + - *string* - The achievementLink to this achievement. \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementNumCriteria.md b/wiki-information/functions/GetAchievementNumCriteria.md new file mode 100644 index 00000000..b57bc2c3 --- /dev/null +++ b/wiki-information/functions/GetAchievementNumCriteria.md @@ -0,0 +1,16 @@ +## Title: GetAchievementNumCriteria + +**Content:** +Returns the number of criteria for an achievement. +`numCriteria = GetAchievementNumCriteria(achievementID)` + +**Parameters:** +- `achievementID` + - Uniquely identifies each achievement + +**Returns:** +- `numCriteria` + - *number* - The number of criteria required for the given Achievement + +**Description:** +Used in conjunction with `GetAchievementCriteriaInfo`. \ No newline at end of file diff --git a/wiki-information/functions/GetActionBarPage.md b/wiki-information/functions/GetActionBarPage.md new file mode 100644 index 00000000..05ebe4a1 --- /dev/null +++ b/wiki-information/functions/GetActionBarPage.md @@ -0,0 +1,15 @@ +## Title: GetActionBarPage + +**Content:** +Returns the current action bar page. +`index = GetActionBarPage()` + +**Returns:** +- `index` + - *number* - integer index of the current action bar page, ascending from 1. + +**Description:** +The returned value reflects the player-selected action bar, which might not actually be available if overridden by a vehicle, mind control, temporary shapeshift, or other similar mechanics. +This function is available in the RestrictedEnvironment. +Can be queried using the macro conditional. +CURRENT_ACTIONBAR_PAGE is obsolete. \ No newline at end of file diff --git a/wiki-information/functions/GetActionBarToggles.md b/wiki-information/functions/GetActionBarToggles.md new file mode 100644 index 00000000..48caa554 --- /dev/null +++ b/wiki-information/functions/GetActionBarToggles.md @@ -0,0 +1,15 @@ +## Title: GetActionBarToggles + +**Content:** +Returns the enabled states for the extra action bars. +`bottomLeftState, bottomRightState, sideRightState, sideRight2State = GetActionBarToggles()` + +**Returns:** +- `bottomLeftState` + - *Flag* - 1 if the left-hand bottom action bar is shown, nil otherwise. +- `bottomRightState` + - *Flag* - 1 if the right-hand bottom action bar is shown, nil otherwise. +- `sideRightState` + - *Flag* - 1 if the first (outer) right side action bar is shown, nil otherwise. +- `sideRight2State` + - *Flag* - 1 if the second (inner) right side action bar is shown, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetActionCharges.md b/wiki-information/functions/GetActionCharges.md new file mode 100644 index 00000000..10a8f7ff --- /dev/null +++ b/wiki-information/functions/GetActionCharges.md @@ -0,0 +1,28 @@ +## Title: GetActionCharges + +**Content:** +Returns information about the charges of a charge-accumulating player ability. +`currentCharges, maxCharges, cooldownStart, cooldownDuration, chargeModRate = GetActionCharges(slot)` + +**Parameters:** +- `slot` + - *number* - The action slot to retrieve data from. + +**Returns:** +- `currentCharges` + - *number* - The number of charges of the ability currently available. +- `maxCharges` + - *number* - The maximum number of charges the ability may have available. +- `cooldownStart` + - *number* - Time (per GetTime) at which the next charge cooldown began, or 2^32 / 1000 if the spell is not currently recharging. +- `cooldownDuration` + - *number* - Time (in seconds) required to gain a charge. +- `chargeModRate` + - *number* - The rate at which the charge cooldown widget's animation should be updated. + +**Description:** +Abilities like can be used by the player rapidly, and then slowly accumulate charges over time. The `cooldownStart` and `cooldownDuration` return values indicate the cooldown timer for acquiring the next charge (when `currentCharges` is less than `maxCharges`). +If the queried spell does not accumulate charges over time (e.g. or ), this function does not return any values. + +**Reference:** +- `GetSpellCharges()` - Referring to any spell ID or localized spell name. \ No newline at end of file diff --git a/wiki-information/functions/GetActionCooldown.md b/wiki-information/functions/GetActionCooldown.md new file mode 100644 index 00000000..792d8f77 --- /dev/null +++ b/wiki-information/functions/GetActionCooldown.md @@ -0,0 +1,32 @@ +## Title: GetActionCooldown + +**Content:** +Returns cooldown info for the specified action slot. +`start, duration, enable, modRate = GetActionCooldown(slot)` + +**Parameters:** +- `slot` + - *number* - The action slot to retrieve data from. + +**Returns:** +- `start` + - *number* - The time at which the current cooldown period began (relative to the result of GetTime), or 0 if the cooldown is not active or not applicable. +- `duration` + - *number* - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable. +- `enable` + - *number* - Indicates if cooldown is enabled, is greater than 0 if a cooldown could be active, and 0 if a cooldown cannot be active. This lets you know when a shapeshifting form has ended and the actual countdown has started. +- `modRate` + - *number* - The rate at which the cooldown widget's animation should be updated. + +**Usage:** +```lua +local start, duration, enable, modRate = GetActionCooldown(slot); +if ( start == 0 ) then + -- do stuff when cooldown is not active +else + -- do stuff when cooldown is under effect +end +``` + +**Example Use Case:** +This function is commonly used in addons that manage action bars, such as Bartender4 or Dominos, to display cooldown timers on action buttons. It helps players to know when they can use their abilities again by showing a visual cooldown overlay on the action buttons. \ No newline at end of file diff --git a/wiki-information/functions/GetActionCount.md b/wiki-information/functions/GetActionCount.md new file mode 100644 index 00000000..abee64da --- /dev/null +++ b/wiki-information/functions/GetActionCount.md @@ -0,0 +1,42 @@ +## Title: GetActionCount + +**Content:** +Returns the available number of uses for an action. +`text = GetActionCount(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - An action slot ID. + +**Returns:** +- `text` + - *number* - How often an item-based action (see details) may be performed; or always zero for other action types. + +**Description:** +Use with `IsConsumableAction()` and `IsStackableAction()` to confirm that 'zero' is due to having zero uses of an item-based action, rather than always returning zero. +In Classic, use with `IsItemAction()` to ignore abilities that require a reagent; or alternatively use with `GetItemCount(itemID)` if the itemID of a reagent is known. +In Retail, use with `GetActionCharges()` for abilities with multiple charges. + +**Usage:** +The following example originates from an older version of FrameXML/ActionButton.lua to display a number on each action button if applicable. +```lua +function ActionButton_UpdateCount (self) + local text = _G; + local action = self.action; + if ( IsConsumableAction(action) or IsStackableAction(action) or (not IsItemAction(action) and GetActionCount(action) > 0) ) then + local count = GetActionCount(action); + if ( count > (self.maxDisplayCount or 9999 ) ) then + text:SetText("*"); + else + text:SetText(count); + end + else + local charges, maxCharges, chargeStart, chargeDuration = GetActionCharges(action); + if (maxCharges > 1) then + text:SetText(charges); + else + text:SetText(""); + end + end +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetActionInfo.md b/wiki-information/functions/GetActionInfo.md new file mode 100644 index 00000000..d56c98ec --- /dev/null +++ b/wiki-information/functions/GetActionInfo.md @@ -0,0 +1,31 @@ +## Title: GetActionInfo + +**Content:** +Returns info for an action. +`actionType, id, subType = GetActionInfo(slot)` + +**Parameters:** +- `slot` + - *number* - Action slot to retrieve information about. + +**Returns:** +- `actionType` + - *string* - Type of action button. (e.g. spell, item, macro, companion, equipmentset, flyout) +- `id` + - *Mixed* - Appropriate identifier for the action specified by actionType -- e.g. spell IDs for spells, item IDs for items, equipment set names for equipment sets. +- `subType` + - *Mixed* - Additional identifier for the action specified by actionType -- e.g. whether the companion ID is for a MOUNT or a CRITTER companion. + +**Usage:** +```lua +local actionType, id, subType = GetActionInfo(1); +if (actionType == "companion" and subType == "MOUNT") then + print("Button 1 is a mount:", GetSpellLink(id)) +end +``` + +**Example Use Case:** +This function can be used to determine what type of action is assigned to a specific action bar slot. For instance, if you want to check if a particular slot is assigned to a mount, you can use this function to retrieve the action type and subtype, and then perform actions based on that information. + +**Addons Using This Function:** +Many popular addons like Bartender4 and Dominos use `GetActionInfo` to manage and customize action bars. These addons rely on this function to retrieve and display the correct icons and tooltips for the actions assigned to each slot. \ No newline at end of file diff --git a/wiki-information/functions/GetActionLossOfControlCooldown.md b/wiki-information/functions/GetActionLossOfControlCooldown.md new file mode 100644 index 00000000..0488dd63 --- /dev/null +++ b/wiki-information/functions/GetActionLossOfControlCooldown.md @@ -0,0 +1,20 @@ +## Title: GetActionLossOfControlCooldown + +**Content:** +Returns information about a loss-of-control cooldown affecting an action. +`start, duration = GetActionLossOfControlCooldown(slot)` + +**Parameters:** +- `slot` + - *number* - action slot to query information about. + +**Returns:** +- `start` + - *number* - time at which the cooldown began, per GetTime. +- `duration` + - *number* - duration of the cooldown in seconds; 0 if the action is not currently affected by a loss-of-control cooldown. + +**Reference:** +- `Cooldown:SetLossOfControlCooldown` +- `C_LossOfControl.GetEventInfo` +- `LOSS_OF_CONTROL_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetActionText.md b/wiki-information/functions/GetActionText.md new file mode 100644 index 00000000..0342d6ad --- /dev/null +++ b/wiki-information/functions/GetActionText.md @@ -0,0 +1,14 @@ +## Title: GetActionText + +**Content:** +Returns the label text for an action. +`text = GetActionText(actionSlot)` + +**Parameters:** +- `actionSlot` + - *ActionSlot* - The queried slot. + +**Returns:** +- `text` + - *String* - The action's text, if present. Macro actions use their names for their action text. + - *nil* - If the slot has no action text, or is empty. Most standard WoW action icons don't have action text. \ No newline at end of file diff --git a/wiki-information/functions/GetActionTexture.md b/wiki-information/functions/GetActionTexture.md new file mode 100644 index 00000000..619461e9 --- /dev/null +++ b/wiki-information/functions/GetActionTexture.md @@ -0,0 +1,14 @@ +## Title: GetActionTexture + +**Content:** +Returns the icon texture for an action. +`texture = GetActionTexture(actionSlot)` + +**Parameters:** +- `actionSlot` + - *ActionSlot* - The queried slot. + +**Returns:** +- `texture` + - *String* - The texture filepath for the action's icon image + - *nil* - if the slot is empty \ No newline at end of file diff --git a/wiki-information/functions/GetActiveTalentGroup.md b/wiki-information/functions/GetActiveTalentGroup.md new file mode 100644 index 00000000..25418ae1 --- /dev/null +++ b/wiki-information/functions/GetActiveTalentGroup.md @@ -0,0 +1,15 @@ +## Title: GetActiveTalentGroup + +**Content:** +Returns the index of the current active talent group. +`index = GetActiveTalentGroup(isInspect, isPet);` + +**Parameters:** +- `isInspect` + - *Boolean* - If true returns the information for the inspected unit instead of the player. +- `isPet` + - *Boolean* - If true returns the information for the inspected pet. + +**Returns:** +- `index` + - *Number* - The index of the current active talent group (1 for primary / 2 for secondary). \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnCPUUsage.md b/wiki-information/functions/GetAddOnCPUUsage.md new file mode 100644 index 00000000..b6013b83 --- /dev/null +++ b/wiki-information/functions/GetAddOnCPUUsage.md @@ -0,0 +1,36 @@ +## Title: GetAddOnCPUUsage + +**Content:** +Returns the total time used for an addon. +`time = GetAddOnCPUUsage(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `time` + - *number* - The total time used by the specified AddOn, in milliseconds. + +**Description:** +This function will raise an error if a secure Blizzard addon is queried. +This function returns a cached value calculated by `UpdateAddOnCPUUsage()`. The time is the sum of `GetFunctionCPUUsage(f, false)` for all functions `f` created on behalf of the AddOn. These functions include both functions created directly by the AddOn itself, as well as functions created by external functions that were called by the AddOn. That means even though an external function does not belong to an AddOn, functions created by that external function are attributed to the calling AddOn. + +Notably, the time used does NOT include calls into the WoW API. + +Running this code will show the addon using 300-350ms CPU time: +```lua +e = debugprofilestop() + 500 +while debugprofilestop() < e do end +-- we're spending a lot of time simply calling the API! +``` + +But running THIS code will show the addon using much closer to 500ms CPU time: +```lua +e = debugprofilestop() + 500 +while debugprofilestop() < e do + for i = 1, 1000 do end +end +``` + +However, in both cases, `:GetFrameCPUUsage()` on the addon's frame will report 500ms used. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnDependencies.md b/wiki-information/functions/GetAddOnDependencies.md new file mode 100644 index 00000000..f2f39d6e --- /dev/null +++ b/wiki-information/functions/GetAddOnDependencies.md @@ -0,0 +1,13 @@ +## Title: GetAddOnDependencies + +**Content:** +Returns the TOC dependencies of an addon. +`dep1, dep2, ... = GetAddOnDependencies(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `dep1, dep2, ...` + - *string* - List of addon names that are a required dependency. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnEnableState.md b/wiki-information/functions/GetAddOnEnableState.md new file mode 100644 index 00000000..4e0720d4 --- /dev/null +++ b/wiki-information/functions/GetAddOnEnableState.md @@ -0,0 +1,21 @@ +## Title: GetAddOnEnableState + +**Content:** +Get the enabled state of an addon for a character. +`enabledState = GetAddOnEnableState(character, name)` + +**Parameters:** +- `character` + - *string?* - The name of the character to check against or nil. +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `enabledState` + - *number* - The enabled state of the addon. + - `0` - disabled + - `1` - enabled for some + - `2` - enabled + +**Description:** +This is primarily used by the default UI to set the checkbox state in the AddOnList. A return of 1 is only possible if `character` is nil. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnInfo.md b/wiki-information/functions/GetAddOnInfo.md new file mode 100644 index 00000000..28780a34 --- /dev/null +++ b/wiki-information/functions/GetAddOnInfo.md @@ -0,0 +1,44 @@ +## Title: GetAddOnInfo + +**Content:** +Get information about an AddOn. +`name, title, notes, loadable, reason, security, newVersion = GetAddOnInfo(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `name` + - *string* - The name of the AddOn (the folder name). +- `title` + - *string* - The title of the AddOn as listed in the .toc file (presumably this is the appropriate localized one). +- `notes` + - *string* - The notes about the AddOn from its .toc file (presumably this is the appropriate localized one). +- `loadable` + - *boolean* - Indicates if the AddOn is loaded or eligible to be loaded, true if it is, false if it is not. +- `reason` + - *string* - The reason why the AddOn cannot be loaded. This is nil if the addon is loadable, otherwise it contains a string token indicating the reason that can be localized by prepending "ADDON_". ("BANNED", "CORRUPT", "DEMAND_LOADED", "DISABLED", "INCOMPATIBLE", "INTERFACE_VERSION", "MISSING") +- `security` + - *string* - Indicates the security status of the AddOn. This is currently "INSECURE" for all user-provided addons, "SECURE_PROTECTED" for guarded Blizzard addons, and "SECURE" for all other Blizzard AddOns. +- `newVersion` + - *boolean* - Not currently used. + +**Description:** +If the function is passed a string, `name` will always be the value passed, so check if `reason` equals "MISSING" to find out if an addon exists. +If the function is passed a number that is out of range, you will get an error message, specifically: ` AddOn index must be in the range of 1 to `. + +**Example Usage:** +```lua +local name, title, notes, loadable, reason, security, newVersion = GetAddOnInfo("MyAddon") +if reason == "MISSING" then + print("Addon does not exist.") +else + print("Addon exists and is loadable: ", loadable) +end +``` + +**AddOns Using This Function:** +Many large addons use `GetAddOnInfo` to check the status of other addons or to manage dependencies. For example: +- **WeakAuras**: Uses it to check if certain addons are present and to manage compatibility. +- **ElvUI**: Uses it to ensure that required modules or plugins are available and loaded correctly. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnMemoryUsage.md b/wiki-information/functions/GetAddOnMemoryUsage.md new file mode 100644 index 00000000..acb336ae --- /dev/null +++ b/wiki-information/functions/GetAddOnMemoryUsage.md @@ -0,0 +1,32 @@ +## Title: GetAddOnMemoryUsage + +**Content:** +Returns the memory used for an addon. +`mem = GetAddOnMemoryUsage(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `mem` + - *number* - Memory usage of the addon in kilobytes. + +**Description:** +This function returns a cached value calculated by `UpdateAddOnMemoryUsage()`. This function will raise an error if a secure Blizzard addon is queried. + +**Usage:** +Prints the memory usage for all addons. +```lua +UpdateAddOnMemoryUsage() +for i = 1, GetNumAddOns() do + local name = GetAddOnInfo(i) + print(GetAddOnMemoryUsage(i), name) +end +``` + +**Example Use Case:** +This function can be used by addon developers to monitor and optimize the memory usage of their addons. For instance, developers can periodically check the memory usage to ensure their addon is not consuming excessive resources, which can help in maintaining the performance of the game. + +**Addons Using This Function:** +Many performance monitoring addons, such as "Addon Control Panel" and "Details! Damage Meter," use this function to display memory usage statistics to the user. This helps players identify which addons are using the most memory and manage their addon load accordingly. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnMetadata.md b/wiki-information/functions/GetAddOnMetadata.md new file mode 100644 index 00000000..9905ee47 --- /dev/null +++ b/wiki-information/functions/GetAddOnMetadata.md @@ -0,0 +1,18 @@ +## Title: GetAddOnMetadata + +**Content:** +Returns the TOC metadata of an addon. +`value = GetAddOnMetadata(index, field)` +`GetAddOnMetadata(name, field)` + +**Parameters:** +- `index` + - *index* - The index in the addon list. Note that you cannot query Blizzard addons by index. +- `name` + - *string* - The name of the addon, case insensitive. +- `field` + - *string* - Field name, case insensitive. May be Title, Notes, Author, Version, or anything starting with X- + +**Returns:** +- `value` + - *string?* - The value of the field. \ No newline at end of file diff --git a/wiki-information/functions/GetAllowLowLevelRaid.md b/wiki-information/functions/GetAllowLowLevelRaid.md new file mode 100644 index 00000000..4e98105c --- /dev/null +++ b/wiki-information/functions/GetAllowLowLevelRaid.md @@ -0,0 +1,9 @@ +## Title: GetAllowLowLevelRaid + +**Content:** +Needs summary. +`allowLowLevel = GetAllowLowLevelRaid()` + +**Returns:** +- `allowLowLevel` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GetArenaTeamIndexBySize.md b/wiki-information/functions/GetArenaTeamIndexBySize.md new file mode 100644 index 00000000..8b85b1b3 --- /dev/null +++ b/wiki-information/functions/GetArenaTeamIndexBySize.md @@ -0,0 +1,17 @@ +## Title: GetArenaTeamIndexBySize + +**Content:** +Returns the index of an arena team for the specified team size. +`index = GetArenaTeamIndexBySize(size)` + +**Parameters:** +- `size` + - *number* - team size (number of people), i.e. 2, 3, or 5. + +**Returns:** +- `index` + - *number* - arena team index for the specified team size, or nil if the player is not in a team of the specified size. + +**Description:** +Arena team indices typically correspond to their creation/join order, and may be discontinuous. +You can get information about a given team from its index using `GetArenaTeam`. \ No newline at end of file diff --git a/wiki-information/functions/GetArenaTeamRosterInfo.md b/wiki-information/functions/GetArenaTeamRosterInfo.md new file mode 100644 index 00000000..1e35cdf1 --- /dev/null +++ b/wiki-information/functions/GetArenaTeamRosterInfo.md @@ -0,0 +1,33 @@ +## Title: GetArenaTeamRosterInfo + +**Content:** +Requests information regarding the arena team that the player is in, see Returns for a full list of what this returns. +`name, rank, level, class, online, played, win, seasonPlayed, seasonWin, personalRating = GetArenaTeamRosterInfo(teamindex, playerid)` + +**Parameters:** +- `teamindex` + - *number* - Index of the team you want information on, can be a value between 1 and 3. +- `playerindex` + - *number* - Index of the team member. Starts at 1. + +**Returns:** +- `name` + - *string* - Name of the player. +- `rank` + - *number* - 0 denotes team captain, while 1 denotes a regular member. +- `level` + - *number* - Player level. +- `class` + - *string* - The localized class of the player. +- `online` + - *number* - 1 denotes the player being online. nil denotes the player as offline. +- `played` + - *number* - Number of games this player has played this week. +- `win` + - *number* - Number of games this player has won this week. +- `seasonPlayed` + - *number* - Number of games played the entire season. +- `seasonWin` + - *number* - Number of games this player has won this week. +- `personalRating` + - *number* - Player's personal rating with this team. \ No newline at end of file diff --git a/wiki-information/functions/GetArmorPenetration.md b/wiki-information/functions/GetArmorPenetration.md new file mode 100644 index 00000000..59e2daaf --- /dev/null +++ b/wiki-information/functions/GetArmorPenetration.md @@ -0,0 +1,9 @@ +## Title: GetArmorPenetration + +**Content:** +Returns the percentage of target's armor your physical attacks ignore due to armor penetration. +`armorPen = GetArmorPenetration()` + +**Returns:** +- `armorPen` + - *number* - Percent of armor ignored by your physical attacks. \ No newline at end of file diff --git a/wiki-information/functions/GetAtlasInfo.md b/wiki-information/functions/GetAtlasInfo.md new file mode 100644 index 00000000..78d7fd60 --- /dev/null +++ b/wiki-information/functions/GetAtlasInfo.md @@ -0,0 +1,71 @@ +## Title: C_Texture.GetAtlasInfo + +**Content:** +Returns atlas info. +`info = C_Texture.GetAtlasInfo(atlas)` + +**Parameters:** +- `atlas` + - *string* - Name of the atlas + +**Returns:** +- `info` + - *AtlasInfo* + - `Field` + - `Type` + - `Description` + - `width` + - *number* + - `height` + - *number* + - `rawSize` + - *vector2* + - `leftTexCoord` + - *number* + - `rightTexCoord` + - *number* + - `topTexCoord` + - *number* + - `bottomTexCoord` + - *number* + - `tilesHorizontally` + - *boolean* + - `tilesVertically` + - *boolean* + - `file` + - *number?* - FileID of parent texture + - `filename` + - *string?* + - `sliceData` + - *UITextureSliceData?* + - `UITextureSliceData` + - `Field` + - `Type` + - `Description` + - `marginLeft` + - *number* + - `marginTop` + - *number* + - `marginRight` + - *number* + - `marginBottom` + - *number* + - `sliceMode` + - *Enum.UITextureSliceMode* + - `Enum.UITextureSliceMode` + - `Value` + - `Field` + - `Description` + - `0` + - Stretched + - Default + - `1` + - Tiled + +**Reference:** +- `Texture:GetAtlas()` +- `Texture:SetAtlas()` +- `UI CreateAtlasMarkup` - Returns an inline fontstring texture from an atlas +- `Helix/AtlasInfo.lua` - Lua table containing atlas info +- `UiTextureAtlasMember.db2` - DBC for atlases +- `Texture Atlas Viewer` - Addon for browsing atlases in-game \ No newline at end of file diff --git a/wiki-information/functions/GetAttackPowerForStat.md b/wiki-information/functions/GetAttackPowerForStat.md new file mode 100644 index 00000000..93205b87 --- /dev/null +++ b/wiki-information/functions/GetAttackPowerForStat.md @@ -0,0 +1,20 @@ +## Title: GetAttackPowerForStat + +**Content:** +Returns the amount of attack power contributed by a specific amount of a stat. +`attackPower = GetAttackPowerForStat(stat, value)` + +**Parameters:** +- `stat` + - *number* - Index of the stat (Strength, Agility, ...) to check the bonus AP of. + - 1: `LE_UNIT_STAT_STRENGTH` + - 2: `LE_UNIT_STAT_AGILITY` + - 3: `LE_UNIT_STAT_STAMINA` + - 4: `LE_UNIT_STAT_INTELLECT` + - 5: `LE_UNIT_STAT_SPIRIT` (not available in 9.0.5) +- `value` + - *number* - Amount of the stat to check the AP value of. + +**Returns:** +- `attackPower` + - *number* - Amount of attack power granted by the specified amount of the specified stat. \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemBattlePetInfo.md b/wiki-information/functions/GetAuctionItemBattlePetInfo.md new file mode 100644 index 00000000..bae15fb7 --- /dev/null +++ b/wiki-information/functions/GetAuctionItemBattlePetInfo.md @@ -0,0 +1,27 @@ +## Title: GetAuctionItemBattlePetInfo + +**Content:** +Retrieves info about one Battle Pet in the current retrieved list of Battle Pets from the Auction House. +`creatureID, displayID = GetAuctionItemBattlePetInfo(type, index)` + +**Parameters:** +- `type` + - *string* - One of the following: + - `"list"` - An item up for auction, the "Browse" tab in the dialog. + - `"bidder"` - An item the player has bid on, the "Bids" tab in the dialog. + - `"owner"` - An item the player has up for auction, the "Auctions" tab in the dialog. +- `index` + - *number* - The index of the item in the list to retrieve info from (normally 1-50, inclusive). + +**Returns:** +- `creatureID` + - *number* - An indexing value Blizzard uses to number NPCs. +- `displayID` + - *number* - An indexing value Blizzard uses to number model/skin combinations. + +**Description:** +The `displayID` return appears to always be 0, possibly because the function is only used by Blizzard in conjunction with `DressUpBattlePet`. + +**Reference:** +- `DressUpBattlePet` +- `GetAuctionItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemInfo.md b/wiki-information/functions/GetAuctionItemInfo.md new file mode 100644 index 00000000..645df98b --- /dev/null +++ b/wiki-information/functions/GetAuctionItemInfo.md @@ -0,0 +1,76 @@ +## Title: GetAuctionItemInfo + +**Content:** +Retrieves info about one item in the current retrieved list of items from the Auction House. +```lua +name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, bidderFullName, owner, ownerFullName, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo(type, index) +``` + +**Parameters:** +- `type` + - *string* - One of the following: + - `"list"` - An item up for auction, the "Browse" tab in the dialog. + - `"bidder"` - An item the player has bid on, the "Bids" tab in the dialog. + - `"owner"` - An item the player has up for auction, the "Auctions" tab in the dialog. +- `index` + - *number* - The index of the item in the list to retrieve info from (normally 1-50, inclusive) + +**Returns:** +1. `name` + - *string* - the name of the item +2. `texture` + - *number* - the fileID of the texture of the item +3. `count` + - *number* - the number of items in the auction item, zero if item is "sold" in the "owner" auctions +4. `quality` + - *Enum.ItemQuality* +5. `canUse` + - *boolean* - true if the user can use the item, false if not +6. `level` + - *number* - the level required to use the item +7. `levelColHeader` + - *string* - The preceding level return value changes depending on the value of levelColHeader: + - `"REQ_LEVEL_ABBR"` - level represents the required character level + - `"SKILL_ABBR"` - level represents the required skill level (for recipes) + - `"ITEM_LEVEL_ABBR"` - level represents the item level + - `"SLOT_ABBR"` - level represents the number of slots (for containers) +8. `minBid` + - *number* - the starting bid price +9. `minIncrement` + - *number* - the minimum amount of item at which to put the next bid +10. `buyoutPrice` + - *number* - zero if no buy out, otherwise it contains the buyout price of the auction item +11. `bidAmount` + - *number* - the current highest bid, zero if no one has bid yet +12. `highBidder` + - *string?* - returns name of highest bidder, nil otherwise +13. `bidderFullName` + - *string?* - returns bidder's full name if from virtual realm, nil otherwise +14. `owner` + - *string* - the player that is selling the item +15. `ownerFullName` + - *string?* - returns owner's full name if from virtual realm, nil otherwise +16. `saleStatus` + - *number* - 1 for sold, 0 for unsold +17. `itemId` + - *number* - item id +18. `hasAllInfo` + - *boolean* - was everything returned + +**Usage:** +```lua +-- Retrieves info about the first item in the list of your currently auctioned items. +local name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, + highBidder, bidderFullName, owner, ownerFullName, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo("owner", 1); +``` + +**Description:** +- **Auctions being returned as nil:** + As of 4.0.1, auctions will be returned as "nil" for items not yet in the client's itemcache. New items resolve at a rate of 30 unique itemids every 30 seconds. (Note that "of the Xxx" items share the same itemid) + Blizzard's standard auction house view overcomes this problem by reacting to `AUCTION_ITEM_LIST_UPDATE` and re-querying the items. + +- **The "owner" field and playername resolving:** + Note that the "owner" field can be nil. This happens because the auction listing internally contains player GUIDs rather than names, and the WoW client does not query the server for names until `GetAuctionItemInfo()` is actually called for the item, and the result takes one RTT to arrive. The GUID->name mapping is then stored in a name resolution cache, which gets cleared upon logout (not UI reload). + Blizzard's standard auction house view overcomes this problem by reacting to `AUCTION_ITEM_LIST_UPDATE` and re-querying the items. + However, this event-driven approach does not really work for e.g. scanner engines. There, the correct solution is to re-query items with nil owners for a short time (a low number of seconds). There IS a possibility that it NEVER returns something - this happens when someone puts something up for auction and then deletes his character. + Note that the playername resolver will only resolve a certain number of sellers every 30 seconds. When this limit is exceeded, it will appear as if responses arrive in batches every 30 seconds. \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemLink.md b/wiki-information/functions/GetAuctionItemLink.md new file mode 100644 index 00000000..489efc7d --- /dev/null +++ b/wiki-information/functions/GetAuctionItemLink.md @@ -0,0 +1,19 @@ +## Title: GetAuctionItemLink + +**Content:** +Retrieves the itemLink of one item in the current retrieved list of items from the Auction House. +`itemLink = GetAuctionItemLink(type, index)` + +**Parameters:** +- `type` + - *string* - One of the following: + - `"list"` - An item up for auction, the "Browse" tab in the dialog. + - `"bidder"` - An item the player has bid on, the "Bids" tab in the dialog. + - `"owner"` - An item the player has up for auction, the "Auctions" tab in the dialog. +- `index` + - *number* - The index of the item in the list to retrieve info from (normally 1-50, inclusive). + +**Returns:** +- `itemLink` + - *itemLink* - The itemLink for the specified item or + - `nil`, if type and/or index is invalid. \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemSubClasses.md b/wiki-information/functions/GetAuctionItemSubClasses.md new file mode 100644 index 00000000..8de251e3 --- /dev/null +++ b/wiki-information/functions/GetAuctionItemSubClasses.md @@ -0,0 +1,39 @@ +## Title: GetAuctionItemSubClasses + +**Content:** +Gets a list of the sub-classes for an Auction House item class. +`subClass1, subClass2, subClass3, ... = GetAuctionItemSubClasses(classID)` + +**Parameters:** +- `classID` + - *number* - ID of the item class. + +**Returns:** +- `subClass1, subClass2, subClass3, ...` + - *number* - The valid subclasses for an item class. + +**Usage:** +Prints all subclass IDs for the Consumables category. +```lua +local classID = LE_ITEM_CLASS_CONSUMABLE +for _, subClassID in pairs({GetAuctionItemSubClasses(classID)}) do + print(subClassID, (GetItemSubClassInfo(classID, subClassID))) +end +``` +Output: +``` +0, Explosives and Devices +1, Potion +2, Elixir +3, Flask +5, Food & Drink +7, Bandage +9, Vantus Runes +8, Other +``` + +**Reference:** +- ItemType - List of item (sub)classes +- GetItemClassInfo +- GetItemSubClassInfo +- GetAuctionItemClasses (removed) \ No newline at end of file diff --git a/wiki-information/functions/GetAutoCompleteRealms.md b/wiki-information/functions/GetAutoCompleteRealms.md new file mode 100644 index 00000000..0aa214be --- /dev/null +++ b/wiki-information/functions/GetAutoCompleteRealms.md @@ -0,0 +1,18 @@ +## Title: GetAutoCompleteRealms + +**Content:** +Returns a table of realm names for auto-completion. +`realmNames = GetAutoCompleteRealms()` + +**Parameters:** +- `realmNames` + - *table?* - If a table is provided, it will be populated with realm names; otherwise, a new table will be created. + +**Returns:** +- `realmNames` + - *table* - An array of realm names the player can interact with through Connected Realms. Realm names will be in normalized format without spaces or hyphens (see GetNormalizedRealmName). + +**Description:** +Certain characters are removed from realm names, most notably Space and - while others remain, such as ' and variants of Latin letters (e.g. umlauts and accented letters). +The supplied table is not wiped; only the array keys needed to return the result are modified. +May not be available at load time until PLAYER_LOGIN (i.e. found to not work during VARIABLES_LOADED). \ No newline at end of file diff --git a/wiki-information/functions/GetAutoCompleteResults.md b/wiki-information/functions/GetAutoCompleteResults.md new file mode 100644 index 00000000..c1c99fbf --- /dev/null +++ b/wiki-information/functions/GetAutoCompleteResults.md @@ -0,0 +1,48 @@ +## Title: GetAutoCompleteResults + +**Content:** +Returns possible player names matching a given prefix string and specified requirements. +`results = GetAutoCompleteResults(text, numResults, cursorPosition, allowFullMatch, includeBitField, excludeBitField)` + +**Parameters:** +- `text` + - *string* - First characters of the possible names to be autocompleted +- `numResults` + - *number* - Number of results desired. +- `cursorPosition` + - *number* - Position of the cursor within the editbox (i.e. how much of the text string should be matching). +- `allowFullMatch` + - *boolean* +- `includeBitField` + - *number* - Bit mask of filters that the results must match at least one of. +- `excludeBitField` + - *number* - Bit mask of filters that the results must not match any of. + +**Filter values:** +The `includeBitField` and `excludeBitField` bit mask parameters can be composed from the following components: + +| AutocompleteFlag | Global | Value | Description | +|-------------------------------|-------------------|--------------|-----------------------------------------------------------------------------| +| AUTOCOMPLETE_FLAG_NONE | 0x00000000 | Mask usable for including or excluding no results. | +| AUTOCOMPLETE_FLAG_IN_GROUP | 0x00000001 | Matches characters in your current party or raid. | +| AUTOCOMPLETE_FLAG_IN_GUILD | 0x00000002 | Matches characters in your current guild. | +| AUTOCOMPLETE_FLAG_FRIEND | 0x00000004 | Matches characters on your character-specific friends list. | +| AUTOCOMPLETE_FLAG_BNET | 0x00000008 | Matches characters on your Battle.net friends list. | +| AUTOCOMPLETE_FLAG_INTERACTED_WITH | 0x00000010 | Matches characters that the player has interacted with directly, such as exchanging whispers. | +| AUTOCOMPLETE_FLAG_ONLINE | 0x00000020 | Matches characters that are currently online. | +| AUTO_COMPLETE_IN_AOI | 0x00000040 | Matches characters in the local area of interest. | +| AUTO_COMPLETE_ACCOUNT_CHARACTER | 0x00000080 | Matches characters on any of the current players' Battle.net game accounts. | +| AUTOCOMPLETE_FLAG_ALL | 0xFFFFFFFF | Mask usable for including or excluding all results. | + +**Returns:** +- `results` + - *table* - Auto-completed names of players that satisfy the requirements. + - `Field` + - `Type` + - `Description` + - `bnetID` + - *number* + - `name` + - *string* - The realm part can possibly be omitted for players on the same realm. This format might be inconsistent (on Classic), e.g. Foo-Nethergarde Keep and Foo-MirageRaceway + - `priority` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAutoDeclineGuildInvites.md b/wiki-information/functions/GetAutoDeclineGuildInvites.md new file mode 100644 index 00000000..6e24ee69 --- /dev/null +++ b/wiki-information/functions/GetAutoDeclineGuildInvites.md @@ -0,0 +1,12 @@ +## Title: GetAutoDeclineGuildInvites + +**Content:** +Returns true if guild invites are being automatically declined. +`autoDecline = GetAutoDeclineGuildInvites()` + +**Returns:** +- `autoDecline` + - *boolean* + +**Reference:** +- `SetAutoDeclineGuildInvites` \ No newline at end of file diff --git a/wiki-information/functions/GetAvailableBandwidth.md b/wiki-information/functions/GetAvailableBandwidth.md new file mode 100644 index 00000000..70fbc505 --- /dev/null +++ b/wiki-information/functions/GetAvailableBandwidth.md @@ -0,0 +1,9 @@ +## Title: GetAvailableBandwidth + +**Content:** +Needs summary. +`result = GetAvailableBandwidth()` + +**Returns:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAvailableLocales.md b/wiki-information/functions/GetAvailableLocales.md new file mode 100644 index 00000000..8e00ce4a --- /dev/null +++ b/wiki-information/functions/GetAvailableLocales.md @@ -0,0 +1,19 @@ +## Title: GetAvailableLocales + +**Content:** +Returns the available locale strings. +`locale1, locale2, ... = GetAvailableLocales()` + +**Parameters:** +- `ignoreLocalRestrictions` + - *boolean?* - If true, returns the complete list of locales. + +**Returns:** +- `locale1, locale2, ...` + - *string* + +**Usage:** +```lua +/dump GetAvailableLocales() -- "enUS", "esMX", "ptBR" (on a US server) +/dump GetAvailableLocales(true) -- "enUS", "koKR", "frFR", "deDE", "zhCN", "esES", "zhTW", "esMX", "ruRU", "ptBR", "itIT" +``` \ No newline at end of file diff --git a/wiki-information/functions/GetAverageItemLevel.md b/wiki-information/functions/GetAverageItemLevel.md new file mode 100644 index 00000000..efa1dd8f --- /dev/null +++ b/wiki-information/functions/GetAverageItemLevel.md @@ -0,0 +1,35 @@ +## Title: GetAverageItemLevel + +**Content:** +Returns the character's average item level. +`avgItemLevel, avgItemLevelEquipped, avgItemLevelPvp = GetAverageItemLevel()` + +**Returns:** +- `avgItemLevel` + - *number* - The average item level of the player. This value is not rounded off to any significant digits. +- `avgItemLevelEquipped` + - *number* - The average equipped item level of the player. This value is not rounded off to any significant digits. +- `avgItemLevelPvp` + - *number* - The average equipped item level your character is considered to have under PvP situations. Item slots are weighted and gems are taken into account to compute this value. It is likely used to derive PvP Scaling coefficient. + +**Usage:** +The following macro prints your average and equipped item levels (to two decimal places) to chat: +```lua +/run print(("Average Item level: %.2f; Equipped item level: %.2f"):format(GetAverageItemLevel())) +``` + +**Description:** +This function is only used to get the average iLevel of the player. It cannot be used to get the average iLevel of anybody else. +Currently, Blizzard's formula for equipped average item level is as follows: +``` + sum of item levels for equipped gear (I) +----------------------------------------- = Equipped Average Item Level + number of slots (S) +``` +- (I) = in taking the sum, the tabard and shirt always count as zero +- some heirloom items count as zero, other heirlooms count as one +- (S) = number of slots depends on the contents of the main and off hand as follows: + - 17 with both hands holding items + - 17 with a single one-hand item (or a single two-handed item with Titan's Grip) + - 16 with a two-handed item equipped (and no Titan's Grip) + - 16 with both hands empty \ No newline at end of file diff --git a/wiki-information/functions/GetBackgroundLoadingStatus.md b/wiki-information/functions/GetBackgroundLoadingStatus.md new file mode 100644 index 00000000..a7137e30 --- /dev/null +++ b/wiki-information/functions/GetBackgroundLoadingStatus.md @@ -0,0 +1,9 @@ +## Title: GetBackgroundLoadingStatus + +**Content:** +Needs summary. +`result = GetBackgroundLoadingStatus()` + +**Returns:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetBackpackCurrencyInfo.md b/wiki-information/functions/GetBackpackCurrencyInfo.md new file mode 100644 index 00000000..36037891 --- /dev/null +++ b/wiki-information/functions/GetBackpackCurrencyInfo.md @@ -0,0 +1,19 @@ +## Title: GetBackpackCurrencyInfo + +**Content:** +Returns info for a tracked currency in the backpack. +`name, count, icon, currencyID = GetBackpackCurrencyInfo(index)` + +**Parameters:** +- `index` + - *number* - Index, ascending from 1 to `GetNumWatchedTokens()`. + +**Returns:** +- `name` + - *string* - Localized currency name. +- `count` + - *number* - Amount currently possessed by the player. +- `icon` + - *number* - FileID of the currency icon. +- `currencyID` + - *number* - CurrencyID of the currency. \ No newline at end of file diff --git a/wiki-information/functions/GetBankSlotCost.md b/wiki-information/functions/GetBankSlotCost.md new file mode 100644 index 00000000..6c63ad85 --- /dev/null +++ b/wiki-information/functions/GetBankSlotCost.md @@ -0,0 +1,25 @@ +## Title: GetBankSlotCost + +**Content:** +Returns the cost of the next bank bag slot. +`cost = GetBankSlotCost(numSlots)` + +**Parameters:** +- `numSlots` + - *number* - Number of slots already purchased. + +**Returns:** +- `cost` + - *number* - Price of the next bank slot in copper. + +**Usage:** +The following example outputs the amount of money you'll have to pay for the next bank slot: +```lua +local numSlots, full = GetNumBankSlots(); +if full then + print("You may not buy any more bank slots"); +else + local c = GetBankSlotCost(numSlots); + print(("Your next bank slot costs %d g %d s %d c"):format(c / 10000, c / 100 % 100, c % 100)); +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldEstimatedWaitTime.md b/wiki-information/functions/GetBattlefieldEstimatedWaitTime.md new file mode 100644 index 00000000..96d02bf8 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldEstimatedWaitTime.md @@ -0,0 +1,9 @@ +## Title: GetBattlefieldEstimatedWaitTime + +**Content:** +Returns the estimated queue time to enter the battlefield. +`waitTime = GetBattlefieldEstimatedWaitTime()` + +**Returns:** +- `waitTime` + - *number* - Milliseconds until a battlefield will be available. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldFlagPosition.md b/wiki-information/functions/GetBattlefieldFlagPosition.md new file mode 100644 index 00000000..dbed622d --- /dev/null +++ b/wiki-information/functions/GetBattlefieldFlagPosition.md @@ -0,0 +1,18 @@ +## Title: GetBattlefieldFlagPosition + +**Content:** +Used to position the flag icon on the world map and the battlefield minimap. +`flagX, flagY, flagToken = GetBattlefieldFlagPosition(index)` + +**Parameters:** +- `index` + - *number* - Index to get the flag position from + +**Returns:** +- `flagX` + - *number* - Position of the flag on the map. +- `flagY` + - *number* - Position of the flag on the map. +- `flagToken` + - *string* - Name of flag texture in `Interface\\WorldStateFrame\\` + - In Warsong Gulch the names of the flag textures are the strings "AllianceFlag" and "HordeFlag". \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldInstanceExpiration.md b/wiki-information/functions/GetBattlefieldInstanceExpiration.md new file mode 100644 index 00000000..ab17b503 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldInstanceExpiration.md @@ -0,0 +1,9 @@ +## Title: GetBattlefieldInstanceExpiration + +**Content:** +Get shutdown timer for the battlefield instance. +`expiration = GetBattlefieldInstanceExpiration()` + +**Returns:** +- `expiration` + - *number* - the number of milliseconds before the Battlefield will close after a battle is finished. This is 0 before the battle is finished. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldInstanceInfo.md b/wiki-information/functions/GetBattlefieldInstanceInfo.md new file mode 100644 index 00000000..fd9363d4 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldInstanceInfo.md @@ -0,0 +1,13 @@ +## Title: GetBattlefieldInstanceInfo + +**Content:** +Returns the battlefield instance ID for an index in the battlemaster listing. +`instanceID = GetBattlefieldInstanceInfo(index)` + +**Parameters:** +- `index` + - *number* - The battlefield instance index, from 1 to `GetNumBattlefields()` when speaking to the battlemaster. + +**Returns:** +- `instanceID` + - *number* - The battlefield instance ID. For example, the ID in "Warsong Gulch 2". \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldInstanceRunTime.md b/wiki-information/functions/GetBattlefieldInstanceRunTime.md new file mode 100644 index 00000000..53d5fd96 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldInstanceRunTime.md @@ -0,0 +1,9 @@ +## Title: GetBattlefieldInstanceRunTime + +**Content:** +Returns the time passed since the battlefield started. +`time = GetBattlefieldInstanceRunTime()` + +**Returns:** +- `time` + - *number* - milliseconds passed since the battle started \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldPortExpiration.md b/wiki-information/functions/GetBattlefieldPortExpiration.md new file mode 100644 index 00000000..b0536ec5 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldPortExpiration.md @@ -0,0 +1,13 @@ +## Title: GetBattlefieldPortExpiration + +**Content:** +Returns the remaining seconds before the battlefield port expires. +`expiration = GetBattlefieldPortExpiration(index)` + +**Parameters:** +- `index` + - *number* - Index of queue to get the expiration from + +**Returns:** +- `expiration` + - *number* - Remaining time of battlefield port in seconds \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldScore.md b/wiki-information/functions/GetBattlefieldScore.md new file mode 100644 index 00000000..31220f6a --- /dev/null +++ b/wiki-information/functions/GetBattlefieldScore.md @@ -0,0 +1,64 @@ +## Title: GetBattlefieldScore + +**Content:** +Returns info for a player's score in battlefields. +`name, killingBlows, honorableKills, deaths, honorGained, faction, race, class, classToken, damageDone, healingDone, bgRating, ratingChange, preMatchMMR, mmrChange, talentSpec = GetBattlefieldScore(index)` + +**Parameters:** +- `index` + - *number* - The character's index in battlegrounds, going from 1 to `GetNumBattlefieldScores()`. + +**Returns:** +- `name` + - *string* - The player's name, with their server name attached if from a different server to the player. +- `killingBlows` + - *number* - Number of killing blows. +- `honorableKills` + - *number* - Number of honorable kills. +- `deaths` + - *number* - The number of deaths. +- `honorGained` + - *number* - The amount of honor gained so far (Bonus Honor). +- `faction` + - *number* - (Battlegrounds: Horde = 0, Alliance = 1 / Arenas: Green Team = 0, Yellow Team = 1). +- `race` + - *string* - The player's race (Orc, Undead, Human, etc). +- `class` + - *string* - The player's class (Mage, Hunter, Warrior, etc). +- `classToken` + - *string* - The player's class name in English given in all capitals (MAGE, HUNTER, WARRIOR, etc). +- `damageDone` + - *number* - The amount of damage done. +- `healingDone` + - *number* - The amount of healing done. +- `bgRating` + - *number* - The player's battleground rating. +- `ratingChange` + - *number* - The change in the player's rating. +- `preMatchMMR` + - *number* - The player's matchmaking rating before the match. +- `mmrChange` + - *number* - The change in the player's matchmaking rating. +- `talentSpec` + - *string* - Localized name of player build. + +**Usage:** +How to count the number of players in each faction. +```lua +local numScores = GetNumBattlefieldScores() +local numHorde = 0 +local numAlliance = 0 +for i = 1, numScores do + name, killingBlows, honorableKills, deaths, honorGained, faction = GetBattlefieldScore(i) + if (faction) then + if (faction == 0) then + numHorde = numHorde + 1 + else + numAlliance = numAlliance + 1 + end + end +end +``` + +**Example Use Case:** +This function can be used in addons that track player performance in battlegrounds or arenas. For example, an addon like "Recount" or "Details!" could use this function to display detailed statistics about each player's performance, such as damage done, healing done, and number of kills. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldStatInfo.md b/wiki-information/functions/GetBattlefieldStatInfo.md new file mode 100644 index 00000000..14d19be2 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldStatInfo.md @@ -0,0 +1,45 @@ +## Title: GetBattlefieldStatInfo + +**Content:** +Get list of battleground specific columns on the scoreboard. +`name, icon, tooltip = GetBattlefieldStatInfo(index)` + +**Parameters:** +- `index` + - *number* - Column to get data for + +**Returns:** +- `name` + - *string* - Name of the column (e.g., Flags Captured) +- `icon` + - *string* - Icon displayed when on the scoreboard rows (e.g., Horde flag icon next to the flag captures of an Alliance player) +- `tooltip` + - *string* - Tooltip displayed when hovering over a column's name + +**Description:** +Used to retrieve the custom scoreboard columns inside a battleground. + +**Example Usage:** +```lua +local index = 1 +local name, icon, tooltip = GetBattlefieldStatInfo(index) +print("Column Name: ", name) +print("Icon: ", icon) +print("Tooltip: ", tooltip) +``` + +**Battleground Specific Columns:** +- **Warsong Gulch:** + - Flags Captured + - Flags Returned +- **Arathi Basin:** + - Bases Assaulted + - Bases Defended +- **Alterac Valley:** + - Graveyards Assaulted + - Graveyards Defended + - Towers Assaulted + - Towers Defended + - Mines Captured + - Leaders Killed + - Secondary Objectives \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldStatus.md b/wiki-information/functions/GetBattlefieldStatus.md new file mode 100644 index 00000000..907a76e0 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldStatus.md @@ -0,0 +1,48 @@ +## Title: GetBattlefieldStatus + +**Content:** +Returns the status of the battlefield the player is either queued for or inside. +`status, mapName, teamSize, registeredMatch, suspendedQueue, queueType, gameType, role, asGroup, shortDescription, longDescription = GetBattlefieldStatus(index)` + +**Parameters:** +- `index` + - *number* - Index of the battlefield you wish to view, in the range of 1 to GetMaxBattlefieldID() + +**Returns:** +- `status` + - *string* - Battlefield status, one of: + - `queued` - Waiting for a battlefield to become ready, you're in the queue + - `confirm` - Ready to join a battlefield + - `active` - Inside an active battlefield + - `none` - Not queued for anything in this index + - `error` - This should never happen +- `mapName` + - *string* - Localized name of the battlefield (e.g., Warsong Gulch or Blade's Edge Arena) +- `teamSize` + - *number* - Team size of the battlefield's queue (2, 3, or 5 in an arena queue, or 0 in other queue types) +- `registeredMatch` + - *number* - 1 in a registered arena queue, or 0 in a skirmish or non-arena queue; use teamSize to check for arenas. +- `suspendedQueue` + - *unknown* - (used to determine whether the eye icon on the LFG minimap button should animate, presumed boolean or 1/nil) +- `queueType` + - *string* - The type of battleground, one of: + - `ARENA` + - `BATTLEGROUND` + - `WARGAME` +- `gameType` + - *string* - ??? (displayed as-is to the user on the queue ready dialog, so presumed localized; can be an empty string) +- `role` + - *string* - The role assigned to the player (TANK, DAMAGER, HEALER) in a non-rated battleground, or nil for other queue types. +- `asGroup` + - *unknown* +- `shortDescription` + - *string* +- `longDescription` + - *string* + +**Example Usage:** +This function can be used to check the status of a player's queue for battlegrounds or arenas. For instance, an addon could use this to display the current queue status and estimated wait time for the player. + +**Addons Using This Function:** +- **DBM (Deadly Boss Mods):** Uses this function to provide alerts and status updates for players queued for battlegrounds or arenas. +- **BattlegroundTargets:** Utilizes this function to display detailed information about the player's current battleground queue status and team composition. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldTimeWaited.md b/wiki-information/functions/GetBattlefieldTimeWaited.md new file mode 100644 index 00000000..75b52349 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldTimeWaited.md @@ -0,0 +1,21 @@ +## Title: GetBattlefieldTimeWaited + +**Content:** +Returns the time the player has waited in the queue. +`timeInQueue = GetBattlefieldTimeWaited(battlegroundQueuePosition)` + +**Parameters:** +- `battlegroundQueuePosition` + - *number* - The queue position. + +**Returns:** +- `timeInQueue` + - *number* - Milliseconds this player has been waiting in the queue. + +**Usage:** +You queue up for Arathi Basin and Alterac Valley. +```lua +x = GetBattlefieldTimeWaited(1); -- Arathi Basin +y = GetBattlefieldTimeWaited(2); -- Alterac Valley +``` +As soon as the join message appears, that slot is "empty" (returns 0) but they are not reordered, queuing up again will use the lowest slot available. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldWinner.md b/wiki-information/functions/GetBattlefieldWinner.md new file mode 100644 index 00000000..8b345211 --- /dev/null +++ b/wiki-information/functions/GetBattlefieldWinner.md @@ -0,0 +1,17 @@ +## Title: GetBattlefieldWinner + +**Content:** +Returns the winner of the battlefield. +`winner = GetBattlefieldWinner()` + +**Returns:** +- `winner` + - *number* - Faction/team that has won the battlefield. Results are: + - `nil` if nobody has won + - `0` for Horde + - `1` for Alliance + - `255` for a draw in a battleground + - `0` for Green Team and `1` for Yellow in an arena + +**Description:** +Gets the winner of the battleground that the player is currently in. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlegroundInfo.md b/wiki-information/functions/GetBattlegroundInfo.md new file mode 100644 index 00000000..202561e0 --- /dev/null +++ b/wiki-information/functions/GetBattlegroundInfo.md @@ -0,0 +1,37 @@ +## Title: GetBattlegroundInfo + +**Content:** +Returns information about a battleground type. +`name, canEnter, isHoliday, isRandom, battleGroundID, info = GetBattlegroundInfo(index)` + +**Parameters:** +- `index` + - *number* - battleground type index, 1 to `GetNumBattlegroundTypes()`. + +**Returns:** +- `localizedName` + - *string* - Localized battleground name. +- `canEnter` + - *boolean* - `true` if the player can queue for this battleground, `false` otherwise. +- `isHoliday` + - *boolean* - `true` if this battleground is currently granting bonus honor due to a battleground holiday, `false` otherwise. +- `isRandom` + - *boolean* - `true` if this battleground is the random. +- `battleGroundID` + - *number* - the ID associated with the Battleground. See `BattlemasterList.db2` for full list. +- `mapDescription` + - *string* - Localized information about the battleground map. +- `bgInstanceID` + - *number* - InstanceID of the battleground map. +- `maxPlayers` + - *number* - Maximum number of players allowed in the battleground. +- `gameType` + - *string* - Type of the game (e.g., "CTF" for Capture the Flag). Empty string if none. +- `iconTexture` + - *number* - Path to the icon texture representing the battleground. +- `shortDescription` + - *string* - Short description of the battleground. +- `longDescription` + - *string* - Long description of the battleground. +- `hasControllingHoliday` + - *number* - `1` if there's a controlling holiday for the battleground, `0` otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlegroundPoints.md b/wiki-information/functions/GetBattlegroundPoints.md new file mode 100644 index 00000000..1275f4ae --- /dev/null +++ b/wiki-information/functions/GetBattlegroundPoints.md @@ -0,0 +1,19 @@ +## Title: GetBattlegroundPoints + +**Content:** +Returns battleground points earned by a team. +`currentPoints, maxPoints = GetBattlegroundPoints(team)` + +**Parameters:** +- `team` + - *number* - team to query the points of; 0 for Horde, 1 for Alliance. + +**Returns:** +- `currentPoints` + - *number* - current battleground points earned by the team. +- `maxPoints` + - *number* - maximum amount of battleground points the team can earn. + +**Description:** +As of 5.3, both return values are always 0; FrameXML comments in WorldStateFrame.lua state: +Long-term we'd like the battleground objectives to work more like this, but it's not working for 5.3. \ No newline at end of file diff --git a/wiki-information/functions/GetBestFlexRaidChoice.md b/wiki-information/functions/GetBestFlexRaidChoice.md new file mode 100644 index 00000000..6210bb88 --- /dev/null +++ b/wiki-information/functions/GetBestFlexRaidChoice.md @@ -0,0 +1,14 @@ +## Title: GetBestFlexRaidChoice + +**Content:** +Returns the dungeon ID of the most appropriate Flex Raid instance for the player. +`flexDungeonID = GetBestFlexRaidChoice()` + +**Returns:** +- `flexDungeonID` + - *number* - dungeon ID of the most appropriate Flex Raid instance for the player, or nil if no Flex Raids are currently appropriate. + +**Description:** +If there are no flex raids available for your character (i.e. you're below level 90), this function returns nil. +Otherwise, it returns the dungeon ID of the most advanced Flex Raid the player is eligible for. +You can retrieve information about the suggested flex raid using `GetLFGDungeonInfo`. \ No newline at end of file diff --git a/wiki-information/functions/GetBestRFChoice.md b/wiki-information/functions/GetBestRFChoice.md new file mode 100644 index 00000000..dac0947b --- /dev/null +++ b/wiki-information/functions/GetBestRFChoice.md @@ -0,0 +1,24 @@ +## Title: GetBestRFChoice + +**Content:** +Returns the suggested raid for the Raid Finder. +`dungeonId = GetBestRFChoice()` + +**Parameters:** +- None + +**Returns:** +- `dungeonId` + - *number* - Dungeon ID + +**Usage:** +```lua +/dump GetBestRFChoice() +-- Example output: 416 +``` + +**Example Use Case:** +This function can be used to programmatically determine the best raid choice for a player using the Raid Finder. For instance, an addon could use this function to automatically suggest or queue the player for the most appropriate raid based on the game's internal logic. + +**Addons Using This Function:** +While specific large addons using this function are not documented, it is likely that raid management or automation addons could leverage this function to enhance the user experience by providing intelligent raid suggestions. \ No newline at end of file diff --git a/wiki-information/functions/GetBillingTimeRested.md b/wiki-information/functions/GetBillingTimeRested.md new file mode 100644 index 00000000..add36906 --- /dev/null +++ b/wiki-information/functions/GetBillingTimeRested.md @@ -0,0 +1,30 @@ +## Title: GetBillingTimeRested + +**Content:** +Returns the amount of "healthy" time left for players on Chinese realms. +`secondsRemaining = GetBillingTimeRested()` + +**Returns:** +- `secondsRemaining` + - *number* - Amount of time left in seconds to play as rested. See details below for clarification. Returns nil for EU and US accounts. + +**Usage:** +The official function (modified to output in the chat frame) when you have partial play time left: +```lua +print(string.format(PLAYTIME_TIRED, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) +``` +The official function (modified to output in the chat frame) when you have no play time left at all: +```lua +print(string.format(PLAYTIME_UNHEALTHY, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) +``` + +**Description:** +Only relevant on Chinese realms. +- When you reach 3 hours remaining you will get "tired", reducing both the amount of money and experience that you receive by 1/2. +- If you play for 5 hours you will get "unhealthy", and won't be able to turn in quests, receive experience or loot. +- The time left is stored on your account, and will display the same amount on every character. +- The time will decay as you stay logged out. + +**Reference:** +- PartialPlayTime +- NoPlayTime \ No newline at end of file diff --git a/wiki-information/functions/GetBindLocation.md b/wiki-information/functions/GetBindLocation.md new file mode 100644 index 00000000..a8ee8c91 --- /dev/null +++ b/wiki-information/functions/GetBindLocation.md @@ -0,0 +1,20 @@ +## Title: GetBindLocation + +**Content:** +Returns the subzone the character's Hearthstone is set to. +`location = GetBindLocation()` + +**Returns:** +Returns the String name of the subzone the player's Hearthstone is set to, e.g. "Tarren Mill", "Crossroads", or "Brill". + +**Usage:** +```lua +bindLocation = GetBindLocation(); +-- If the player's Hearthstone is set to the inn at Allerian Stronghold then bindLocation is assigned "Allerian Stronghold". +``` + +**Example Use Case:** +This function can be used in addons that need to display or utilize the player's current Hearthstone location. For instance, an addon that manages travel routes or provides information about the nearest flight paths might use this function to offer more relevant suggestions based on the player's bind location. + +**Addons Using This Function:** +Many travel and utility addons, such as "TomTom" and "Hearthstone Tracker," use this function to provide players with information about their Hearthstone location and to enhance the player's travel experience in the game. \ No newline at end of file diff --git a/wiki-information/functions/GetBinding.md b/wiki-information/functions/GetBinding.md new file mode 100644 index 00000000..c6c584b6 --- /dev/null +++ b/wiki-information/functions/GetBinding.md @@ -0,0 +1,39 @@ +## Title: GetBinding + +**Content:** +Returns the name and keys for a binding by index. +`command, category, key1, key2, ... = GetBinding(index)` + +**Parameters:** +- `index` + - *number* - index of the binding to query, from 1 to GetNumBindings(). +- `alwaysIncludeGamepad` + - *boolean?* - If gamepad support is disabled, then gamepad bindings are only returned if this is true. + +**Returns:** +- `command` + - *string* - Command this binding will perform (e.g. MOVEFORWARD). For well-behaved bindings, a human-readable description is stored in the `_G` global variable. +- `category` + - *string* - Category this binding was declared in (e.g. BINDING_HEADER_MOVEMENT). For well-behaved bindings, a human-readable title is stored in the `_G` global variable. +- `key1, key2, ...` + - *string?* - Key combination this binding is bound to (e.g. W, CTRL-F). `key1` and `key2` can be nil if there is nothing bound to the command. + +**Description:** +Even though the default Key Binding window only shows up to two bindings for each command, it is actually possible to bind more using `SetBinding`, and this function will return all of the keys bound to the given command, not just the first two. + +**Usage:** +```lua +local function dumpBinding(command, category, ...) + local cmdName = _G[command] + local catName = _G[category] + print(("%s > %s (%s) is bound to:"):format(catName or "?", cmdName or "?", command), strjoin(", ", ...)) +end + +dumpBinding(GetBinding(5)) -- "Movement Keys > Turn Right (TURNRIGHT) is bound to: D, RIGHT" +``` + +**Reference:** +- `GetBindingAction` +- `GetBindingKey` +- `GetBindingByKey` +- `Bindings.xml` \ No newline at end of file diff --git a/wiki-information/functions/GetBindingAction.md b/wiki-information/functions/GetBindingAction.md new file mode 100644 index 00000000..d2167537 --- /dev/null +++ b/wiki-information/functions/GetBindingAction.md @@ -0,0 +1,27 @@ +## Title: GetBindingAction + +**Content:** +Returns the binding name for a key (combination). +`action = GetBindingAction(binding)` + +**Parameters:** +- `binding` + - *string* - The name of the key (e.g., "BUTTON1", "1", "CTRL-G") +- `checkOverride` + - *boolean?* - if true, override bindings will be checked, otherwise, only default (bindings.xml/SetBinding) bindings are consulted. + +**Returns:** +- `action` + - *string* - action command performed by the binding. If no action is bound to the key, an empty string is returned. + +**Reference:** +- `GetBindingByKey` + +**Example Usage:** +```lua +local action = GetBindingAction("CTRL-G") +print(action) -- This will print the action bound to "CTRL-G" if any, otherwise an empty string. +``` + +**Additional Information:** +This function is commonly used in addons that manage or display key bindings, such as Bartender4 or ElvUI. These addons use `GetBindingAction` to retrieve and display the current key bindings for various actions, allowing users to customize their gameplay experience. \ No newline at end of file diff --git a/wiki-information/functions/GetBindingByKey.md b/wiki-information/functions/GetBindingByKey.md new file mode 100644 index 00000000..a39b2fe4 --- /dev/null +++ b/wiki-information/functions/GetBindingByKey.md @@ -0,0 +1,20 @@ +## Title: GetBindingByKey + +**Content:** +Returns the binding action performed when the specified key combination is triggered. +`bindingAction = GetBindingByKey(key)` + +**Parameters:** +- `key` + - *string* - binding key to query, e.g. "G", "ALT-G", "ALT-CTRL-SHIFT-F1". + +**Returns:** +- `bindingAction` + - *string* - binding action that will be performed, e.g. "TOGGLEAUTORUN", "CLICK Purrseus:k1", or nil if no action will be performed. + +**Description:** +This function takes into account override bindings by default. +This discards modifiers from the key argument until a binding matches; thus, querying for ALT-CTRL-SHIFT-G can return the action performed due to the simple "G" binding. + +**Reference:** +`GetBindingAction` \ No newline at end of file diff --git a/wiki-information/functions/GetBindingKey.md b/wiki-information/functions/GetBindingKey.md new file mode 100644 index 00000000..f9d02b7e --- /dev/null +++ b/wiki-information/functions/GetBindingKey.md @@ -0,0 +1,36 @@ +## Title: GetBindingKey + +**Content:** +Returns the keys bound to the given command. +`key1, key2, ... = GetBindingKey(command)` + +**Parameters:** +- `command` + - The name of the command to get key bindings for (e.g. MOVEFORWARD, TOGGLEFRIENDSTAB) + +**Returns:** +- (Variable returns) + - `key1` + - *string* - The string representation(s) of all the key(s) bound to this command (e.g. W, CTRL-F) + - `key2` + - *string* + +**Usage:** +```lua +local command, key1, key2 = GetBinding("MOVEFORWARD") +DEFAULT_CHAT_FRAME:AddMessage(BINDING_NAME_MOVEFORWARD .. " has the following keys bound:") +if key1 then + DEFAULT_CHAT_FRAME:AddMessage(key1) +end +if key2 then + DEFAULT_CHAT_FRAME:AddMessage(key2) +end +``` + +**Description:** +Even though the default Key Binding window only shows up to two bindings for each command, it is actually possible to bind more using SetBinding, and this function will return all of the keys bound to the given command, not just the first two. + +**Reference:** +- `GetBinding` +- `GetBindingAction` +- `GetBindingByKey` \ No newline at end of file diff --git a/wiki-information/functions/GetBindingText.md b/wiki-information/functions/GetBindingText.md new file mode 100644 index 00000000..07c0e85c --- /dev/null +++ b/wiki-information/functions/GetBindingText.md @@ -0,0 +1,23 @@ +## Title: GetBindingText + +**Content:** +Returns the string for the given key and prefix. Essentially a specialized `getglobal()` for bindings. +`text = GetBindingText()` + +**Parameters:** +- `key` + - *string?* - The name of the key (e.g. "UP", "SHIFT-PAGEDOWN") +- `prefix` + - *string?* - The prefix of the variable name you're looking for. Usually "KEY_" or "BINDING_NAME_". +- `abbreviate` + - *boolean?* - Whether to return an abbreviated version of the modifier keys + +**Returns:** +- `text` + - *string* - The value of the global variable derived from the prefix and key name you specified. For example, "UP" and "KEY_" would return the value of the global variable `KEY_UP` which is "Up Arrow" in the English locale. If the global variable doesn't exist for the combination specified, it appears to just return the key name you specified. Modifier key prefixes are stripped from the input and added back into the output. The third parameter, if true, causes the function to simply substitute the abbreviations 'c', 'a', 's', and 'st' for the strings CTRL, ALT, SHIFT, and STRG (German client only) in the result. + +**Usage:** +```lua +/dump GetBindingText("UP", "KEY_") +-- "Up Arrow" +``` \ No newline at end of file diff --git a/wiki-information/functions/GetBlockChance.md b/wiki-information/functions/GetBlockChance.md new file mode 100644 index 00000000..109f53a1 --- /dev/null +++ b/wiki-information/functions/GetBlockChance.md @@ -0,0 +1,16 @@ +## Title: GetBlockChance + +**Content:** +Returns the block chance percentage. +`blockChance = GetBlockChance()` + +**Returns:** +- `blockChance` + - *number* - The player's block chance in percentage. + +**Reference:** +- `GetDodgeChance` +- `GetCritChance` +- `GetParryChance` +- `GetCombatRating` +- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetBonusBarOffset.md b/wiki-information/functions/GetBonusBarOffset.md new file mode 100644 index 00000000..2b4f328d --- /dev/null +++ b/wiki-information/functions/GetBonusBarOffset.md @@ -0,0 +1,42 @@ +## Title: GetBonusBarOffset + +**Content:** +Returns the current bonus action bar index (e.g. for the Rogue stealth bar). +`offset = GetBonusBarOffset()` + +**Parameters:** +- **Returns** + - `offset` - *Number* - The current bonus action bar index. + +**Description:** +Certain classes have "bonus action bars" for their class-specific actions, e.g. the various Stance Bars for the Warrior class. `GetBonusBarOffset()` returns the index of the current action bar that is being displayed. Note that simply scrolling through the action bar pages won't change the output; only switching to the different bonus bars. Each class has their own way of indexing their bonus bars. + +- **Warrior** + - Battle Stance: 1 + - Defensive Stance: 2 + - Berserker Stance: 3 +- **Druid** + - Caster: 0 + - Cat: 1 + - Tree of Life: 2 + - Bear: 3 + - Moonkin: 4 +- **Rogue** + - Normal: 0 + - Stealthed: 1 +- **Priest** + - Normal: 0 + - Shadowform: 1 +- **All Characters** + - When Possessing a Target: 5 + +**Usage:** +```lua +/script ChatFrame1:AddMessage(GetBonusBarOffset()) +``` +This will simply print the output of `GetBonusBarOffset()`. It should change as you change between your bonus bars. + +```lua +slotID = (1 + (NUM_ACTIONBAR_PAGES + GetBonusBarOffset() - 1) * NUM_ACTIONBAR_BUTTONS) +``` +Here, `slotID` will be the action slot number for the first slot of the current bonus bar. For example, for a Warrior in Defensive Stance, `slotID = 85`, which is correct. (ActionSlot) \ No newline at end of file diff --git a/wiki-information/functions/GetBuildInfo.md b/wiki-information/functions/GetBuildInfo.md new file mode 100644 index 00000000..abd0416b --- /dev/null +++ b/wiki-information/functions/GetBuildInfo.md @@ -0,0 +1,54 @@ +## Title: GetBuildInfo + +**Content:** +Returns info for the current client build. +`version, build, date, tocversion, localizedVersion, buildType = GetBuildInfo()` + +**Returns:** +- `version` + - *string* - Current patch version +- `build` + - *string* - Build number +- `date` + - *string* - Build date +- `tocversion` + - *number* - Interface (.toc) version number +- `localizedVersion` + - *string* - Localized translation for the string "Version" +- `buildType` + - *string* - Localized build type and machine architecture + +**Description:** +In the initial testing build of Patch 10.1.0 (48480) the `localizedVersion` and `buildType` return values do not function as intended and will return an empty string and a string with just a space character respectively. + +**Usage:** +```lua +/dump GetBuildInfo() -- "9.0.2", "36665", "Nov 17 2020", 90002 +``` + +**Miscellaneous:** +- **Flavor** + - **Patch** + - **TOC version** +- **The War Within** + - **11.0.0** + - **110000** +- **Mainline PTR** + - **10.2.7** + - **100207** +- **Mainline** + - **10.2.6** + - **100207** +- **Cataclysm Classic** + - **4.4.0** + - **40400** +- **Wrath Classic** + - **3.4.3** + - **30403** +- **Classic Era** + - **1.15.2** + - **11502** + +**Reference:** +- [Public client builds - List of documented builds](https://wow.tools/builds/) +- [List of datamined builds](https://www.townlong-yak.com/framexml/builds) \ No newline at end of file diff --git a/wiki-information/functions/GetButtonMetatable.md b/wiki-information/functions/GetButtonMetatable.md new file mode 100644 index 00000000..256a5ffa --- /dev/null +++ b/wiki-information/functions/GetButtonMetatable.md @@ -0,0 +1,12 @@ +## Title: GetButtonMetatable + +**Content:** +Returns the metatable used by Button objects. +`metatable = GetButtonMetatable()` + +**Returns:** +- `metatable` + - *table* - The metatable used by Button objects. + +**Description:** +The metatable returned by this function is shared between all non-forbidden Button object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetBuybackItemInfo.md b/wiki-information/functions/GetBuybackItemInfo.md new file mode 100644 index 00000000..9fed3250 --- /dev/null +++ b/wiki-information/functions/GetBuybackItemInfo.md @@ -0,0 +1,26 @@ +## Title: GetBuybackItemInfo + +**Content:** +Returns info for an item that can be bought back from a merchant. +`name, icon, price, quantity = GetBuybackItemInfo(slotIndex)` + +**Parameters:** +- `slotIndex` + - *number* - The index of a slot in the merchant's buyback inventory, between 1 and `GetNumBuybackItems()`. + +**Returns:** +- `name` + - *string* - The name of the item. +- `icon` + - *number (fileID)* - Icon texture of the item. +- `price` + - *number* - The price, in copper, it will cost to buy the item(s) back. +- `quantity` + - *number* - The quantity of items in the stack. +- `numAvailable` + - *number* - The number available. +- `isUsable` + - *boolean* - True if the item is usable, false otherwise. + +**Reference:** +- `GetNumBuybackItems` \ No newline at end of file diff --git a/wiki-information/functions/GetCVarInfo.md b/wiki-information/functions/GetCVarInfo.md new file mode 100644 index 00000000..7f542488 --- /dev/null +++ b/wiki-information/functions/GetCVarInfo.md @@ -0,0 +1,25 @@ +## Title: C_CVar.GetCVarInfo + +**Content:** +Returns information on a console variable. +`value, defaultValue, isStoredServerAccount, isStoredServerCharacter, isLockedFromUser, isSecure, isReadOnly = C_CVar.GetCVarInfo(name)` + +**Parameters:** +- `name` + - *string* - Name of the CVar to query the value of. Only accepts console variables (i.e. not console commands). + +**Returns:** +- `value` + - *string* - Current value of the CVar. +- `defaultValue` + - *string* - Default value of the CVar. +- `isStoredServerAccount` + - *boolean* - If the CVar scope is set WoW account-wide. Stored on the server per CVar synchronizeConfig. +- `isStoredServerCharacter` + - *boolean* - If the CVar scope is character-specific. Stored on the server per CVar synchronizeConfig. +- `isLockedFromUser` + - *boolean* +- `isSecure` + - *boolean* - If the CVar cannot be set with SetCVar while in combat, which would fire ADDON_ACTION_BLOCKED. It's also not possible to set these via /console. Most nameplate CVars are secure. +- `isReadOnly` + - *boolean* - Returns true for portal, serverAlert, timingTestError. These CVars cannot be changed. \ No newline at end of file diff --git a/wiki-information/functions/GetCameraZoom.md b/wiki-information/functions/GetCameraZoom.md new file mode 100644 index 00000000..9be09e6f --- /dev/null +++ b/wiki-information/functions/GetCameraZoom.md @@ -0,0 +1,12 @@ +## Title: GetCameraZoom + +**Content:** +Returns the current zoom level of the camera. +`zoom = GetCameraZoom()` + +**Returns:** +- `zoom` + - *number* - the currently set zoom level + +**Description:** +Doesn't take camera collisions with the environment into account and will return what the camera would be at. If the camera is in motion, the zoom level that is set that frame is used, not the zoom level that the camera is traveling to. \ No newline at end of file diff --git a/wiki-information/functions/GetCategoryList.md b/wiki-information/functions/GetCategoryList.md new file mode 100644 index 00000000..1cbb73a3 --- /dev/null +++ b/wiki-information/functions/GetCategoryList.md @@ -0,0 +1,13 @@ +## Title: GetCategoryList + +**Content:** +Returns the list of achievement categories. +`idTable = GetCategoryList()` + +**Returns:** +- `idTable` + - *table* - array containing achievement category IDs, in no particular order. + +**Reference:** +- `GetCategoryInfo(categoryId)` +- `GetCategoryNumAchievements(categoryId)` \ No newline at end of file diff --git a/wiki-information/functions/GetCategoryNumAchievements.md b/wiki-information/functions/GetCategoryNumAchievements.md new file mode 100644 index 00000000..186b7e30 --- /dev/null +++ b/wiki-information/functions/GetCategoryNumAchievements.md @@ -0,0 +1,32 @@ +## Title: GetCategoryNumAchievements + +**Content:** +Returns the number of achievements for a category. +`total, completed, incompleted = GetCategoryNumAchievements(categoryId)` + +**Parameters:** +- `categoryId` + - *number* - Achievement category ID, as returned by GetCategoryList. +- `includeAll` + - *boolean?* - If true-equivalent, include all achievements, otherwise, only includes those currently visible. + +**Returns:** +- `total` + - *number* - total number of achievements in the specified category. +- `completed` + - *number* - number of completed achievements in the specified category. +- `incompleted` + - *number* - number of incompleted achievements in the specified category. + +**Usage:** +The snippet below prints the achievement IDs and names of all achievements in the World Events > Midsummer category: +```lua +for i=1, (GetCategoryNumAchievements(161)) do + local id, name = GetAchievementInfo(161, i) + print(id, name) +end +``` + +**Reference:** +- `GetCategoryList` +- `GetAchievementInfo(categoryId, index)` \ No newline at end of file diff --git a/wiki-information/functions/GetCemeteryPreference.md b/wiki-information/functions/GetCemeteryPreference.md new file mode 100644 index 00000000..613520e5 --- /dev/null +++ b/wiki-information/functions/GetCemeteryPreference.md @@ -0,0 +1,9 @@ +## Title: GetCemeteryPreference + +**Content:** +Needs summary. +`result = GetCemeteryPreference()` + +**Returns:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetChannelList.md b/wiki-information/functions/GetChannelList.md new file mode 100644 index 00000000..65ac7d3b --- /dev/null +++ b/wiki-information/functions/GetChannelList.md @@ -0,0 +1,24 @@ +## Title: GetChannelList + +**Content:** +Returns the list of joined chat channels. +`id, name, disabled, ... = GetChannelList()` + +**Returns:** +- (Variable returns: `id1, name1, disabled1, id2, name2, disabled2, ...`) + - `id` + - *number* - channel number + - `name` + - *string* - channel name + - `disabled` + - *boolean* - If the channel is disabled, e.g. the Trade channel when you're not in a city. + +**Usage:** +Prints the channels the player is currently in. +```lua +local channels = {GetChannelList()} +for i = 1, #channels, 3 do + local id, name, disabled = channels[i], channels[i+1], channels[i+2] + print(id, name, disabled) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetChannelName.md b/wiki-information/functions/GetChannelName.md new file mode 100644 index 00000000..8143aff4 --- /dev/null +++ b/wiki-information/functions/GetChannelName.md @@ -0,0 +1,22 @@ +## Title: GetChannelName + +**Content:** +Returns info for a chat channel. +`id, name, instanceID, isCommunitiesChannel = GetChannelName(name)` + +**Parameters:** +- `name` + - *string|number* - name of the channel to query, e.g. "Trade - City", or a channel ID to query, e.g. 1 for the chat channel currently addressable using /1. + +**Returns:** +- `id` + - *number* - The ID of the channel, or 0 if the channel is not found. +- `name` + - *string* - The name of the channel, e.g. "Trade - Stormwind", or nil if the player is not in the queried channel. +- `instanceID` + - *number* - Index used to deduplicate channels. Usually zero, unless two channels with the same name exist. +- `isCommunitiesChannel` + - *boolean* - True if this is a Blizzard Communities channel, false if not. + +**Description:** +Note that querying `GetChannelName("Trade - City")` may return values which appear to be valid even while the player is not in a city. Consider using `GetChannelName((GetChannelName("Trade - City"))) > 0` to check whether you really have access to the Trade channel. \ No newline at end of file diff --git a/wiki-information/functions/GetChatWindowInfo.md b/wiki-information/functions/GetChatWindowInfo.md new file mode 100644 index 00000000..7db3cf7c --- /dev/null +++ b/wiki-information/functions/GetChatWindowInfo.md @@ -0,0 +1,40 @@ +## Title: GetChatWindowInfo + +**Content:** +Returns info for a chat window. +`name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(frameIndex)` + +**Parameters:** +- `frameIndex` + - *number* - The index of the chat window to get information for (starts at 1). + +**Returns:** +- `name` + - *string* - The name of the chat window, or an empty string for its default name. +- `fontSize` + - *number* - The font size for the window. +- `r` + - *number* - The red component of the window's background color (0.0 - 1.0). +- `g` + - *number* - The green component of the window's background color (0.0 - 1.0). +- `b` + - *number* - The blue component of the window's background color (0.0 - 1.0). +- `alpha` + - *number* - The alpha level (opacity) of the window background (0.0 - 1.0). +- `shown` + - *number* - 1 if the window is shown, 0 if it is hidden. +- `locked` + - *number* - 1 if the window is locked in place, 0 if it is movable. +- `docked` + - *number* - 1 to NUM_CHAT_WINDOWS; Index Order of docked tab EG: General = 1, Combat Log = 2. nil if floating. +- `uninteractable` + - *number* - 1 if the window is uninteractable, 0 if it is interactable. + +**Usage:** +```lua +local name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(i); +``` + +**Description:** +Retrieves Chat Window configuration information. This is what FrameXML uses to know how to display the actual windows. This configuration information is set via the `SetChatWindow...()` family of functions which causes the "UPDATE_CHAT_WINDOWS" event to fire. FrameXML calls `GetChatWindowInfo()` when it receives this event. +`frameIndex` can be any chat window index between 1 and NUM_CHAT_WINDOWS. `1` is the main chat window. \ No newline at end of file diff --git a/wiki-information/functions/GetChatWindowMessages.md b/wiki-information/functions/GetChatWindowMessages.md new file mode 100644 index 00000000..d0f00490 --- /dev/null +++ b/wiki-information/functions/GetChatWindowMessages.md @@ -0,0 +1,17 @@ +## Title: GetChatWindowMessages + +**Content:** +Returns subscribed message types for a chat window. +`type1, ... = GetChatWindowMessages(index)` + +**Parameters:** +- `index` + - *number* - Chat window index, ascending from 1. + +**Returns:** +- `type1, ...` + - *string* - Chat type received by the window. + +**Reference:** +- `AddChatWindowMessages` +- `RemoveChatWindowMessages` \ No newline at end of file diff --git a/wiki-information/functions/GetClassInfo.md b/wiki-information/functions/GetClassInfo.md new file mode 100644 index 00000000..1d43cb70 --- /dev/null +++ b/wiki-information/functions/GetClassInfo.md @@ -0,0 +1,68 @@ +## Title: GetClassInfo + +**Content:** +Returns information about a class. +`className, classFile, classID = GetClassInfo(classID)` + +**Parameters:** +- `classID` + - *number* : ClassId - Ranging from 1 to `GetNumClasses()` + - Values: + - `ID` + - `className` (enUS) + - `classFile` + - `Description` + - `1` + - `Warrior` + - `WARRIOR` + - `2` + - `Paladin` + - `PALADIN` + - `3` + - `Hunter` + - `HUNTER` + - `4` + - `Rogue` + - `ROGUE` + - `5` + - `Priest` + - `PRIEST` + - `6` + - `Death Knight` + - `DEATHKNIGHT` + - Added in 3.0.2 + - `7` + - `Shaman` + - `SHAMAN` + - `8` + - `Mage` + - `MAGE` + - `9` + - `Warlock` + - `WARLOCK` + - `10` + - `Monk` + - `MONK` + - Added in 5.0.4 + - `11` + - `Druid` + - `DRUID` + - `12` + - `Demon Hunter` + - `DEMONHUNTER` + - Added in 7.0.3 + - `13` + - `Evoker` + - `EVOKER` + - Added in 10.0.0 + +**Returns:** +- `className` + - *string* - Localized name, e.g. "Warrior" or "Guerrier". +- `classFile` + - *string* - Locale-independent name, e.g. "WARRIOR". +- `classID` + - *number* : ClassId + +**Description:** +Returns nil for classes that don't exist in Classic. \ No newline at end of file diff --git a/wiki-information/functions/GetClassicExpansionLevel.md b/wiki-information/functions/GetClassicExpansionLevel.md new file mode 100644 index 00000000..63841619 --- /dev/null +++ b/wiki-information/functions/GetClassicExpansionLevel.md @@ -0,0 +1,9 @@ +## Title: GetClassicExpansionLevel + +**Content:** +Needs summary. +`expansionLevel = GetClassicExpansionLevel()` + +**Returns:** +- `expansionLevel` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetClickFrame.md b/wiki-information/functions/GetClickFrame.md new file mode 100644 index 00000000..9e27ba99 --- /dev/null +++ b/wiki-information/functions/GetClickFrame.md @@ -0,0 +1,18 @@ +## Title: GetClickFrame + +**Content:** +Returns the frame registered with the given object name. +`frame = GetClickFrame(name)` + +**Parameters:** +- `name` + - *string* - The name of the frame to obtain. + +**Returns:** +- `frame` + - *table?* - The table handle to the named frame if it exists, else nil. + +**Description:** +This function acts as a secure cache for frame name to object lookups. The first call to this function will cache the frame object registered assigned to name in the global namespace, and all subsequent calls thereafter will return the same frame even if the global is later replaced. +This function will not cache frame objects if the queried name does not match their actual object name as returned by `UIObject:GetName()`. +If called securely, this function returns the frame to the caller untainted. \ No newline at end of file diff --git a/wiki-information/functions/GetClientDisplayExpansionLevel.md b/wiki-information/functions/GetClientDisplayExpansionLevel.md new file mode 100644 index 00000000..c014a930 --- /dev/null +++ b/wiki-information/functions/GetClientDisplayExpansionLevel.md @@ -0,0 +1,50 @@ +## Title: GetClientDisplayExpansionLevel + +**Content:** +Returns the expansion level of the game client. +`expansionLevel = GetClientDisplayExpansionLevel()` + +**Returns:** +- `expansionLevel` + - *number* + - `NUM_LE_EXPANSION_LEVELS` + - **Value** + - **Enum** + - **Description** + - `LE_EXPANSION_LEVEL_CURRENT` + - 0 + - `LE_EXPANSION_CLASSIC` + - Vanilla / Classic Era + - 1 + - `LE_EXPANSION_BURNING_CRUSADE` + - The Burning Crusade + - 2 + - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` + - Wrath of the Lich King + - 3 + - `LE_EXPANSION_CATACLYSM` + - Cataclysm + - 4 + - `LE_EXPANSION_MISTS_OF_PANDARIA` + - Mists of Pandaria + - 5 + - `LE_EXPANSION_WARLORDS_OF_DRAENOR` + - Warlords of Draenor + - 6 + - `LE_EXPANSION_LEGION` + - Legion + - 7 + - `LE_EXPANSION_BATTLE_FOR_AZEROTH` + - Battle for Azeroth + - 8 + - `LE_EXPANSION_SHADOWLANDS` + - Shadowlands + - 9 + - `LE_EXPANSION_DRAGONFLIGHT` + - Dragonflight + - 10 + - `LE_EXPANSION_11_0` + +**Usage:** +Before and after updating to the 9.0.1 pre-patch. +`/dump GetClientDisplayExpansionLevel() -- 7 -> 8` \ No newline at end of file diff --git a/wiki-information/functions/GetCoinIcon.md b/wiki-information/functions/GetCoinIcon.md new file mode 100644 index 00000000..220160b3 --- /dev/null +++ b/wiki-information/functions/GetCoinIcon.md @@ -0,0 +1,21 @@ +## Title: GetCoinIcon + +**Content:** +Returns the path to the texture used for a given amount of money. +`texturePath = GetCoinIcon(amount)` + +**Parameters:** +- `amount` + - *number* - amount of money in copper + +**Returns:** +- `texturePath` + - *string* - Path to icon used for the amount of money. + +**Description:** +Currently returns `"Interface/Icons/INV_Misc_Coin_XX"`, where `XX` ranges from 01 to 06. Respectively, these correspond to: +- 01, 02 - Gold coins (loose and stack) +- 03, 04 - Silver coins (loose and stack) +- 05, 06 - Copper coins (loose and stack) + +These are not the same icons used in a standard money frame (e.g., under your main backpack), instead these are the ones used in loot frames. \ No newline at end of file diff --git a/wiki-information/functions/GetCoinText.md b/wiki-information/functions/GetCoinText.md new file mode 100644 index 00000000..278b79c3 --- /dev/null +++ b/wiki-information/functions/GetCoinText.md @@ -0,0 +1,51 @@ +## Title: GetCoinText + +**Content:** +Breaks up an amount of money into gold/silver/copper. +`formattedAmount = GetCoinText(amount)` + +**Parameters:** +- `amount` + - *number* - the amount of money in copper (for example, the return value from GetMoney) +- `separator` + - *string?* - a string to insert between the formatted amounts of currency, if there is more than one type + +**Returns:** +- `formattedAmount` + - *string* - a (presumably localized) string suitable for printing or displaying + +**Usage:** +```lua +-- Example usage of GetMoney and GetCoinText +GetMoney() +local money = GetMoney() +local gold = floor(money / 1e4) +local silver = floor(money / 100 % 100) +local copper = money % 100 +print(("You have %dg %ds %dc"):format(gold, silver, copper)) +-- Output: You have 10851g 62s 40c + +-- Using GetCoinText +print(GetCoinText(GetMoney())) -- "10851 Gold, 62 Silver, 40 Copper" +print(GetCoinText(12345678, " ")) -- "1234 Gold 23 Silver 45 Copper" +print(GetCoinText(12345678, "X")) -- "1234 GoldX23 SilverX45 Copper" + +-- Using GetMoneyString +print(GetMoneyString(12345678)) +print(GetMoneyString(12345678, true)) +-- Output: 1234 56 78 +-- Output: 1,234 56 78 + +-- Using GetCoinTextureString +print(GetCoinTextureString(1234578)) +print(GetCoinTextureString(1234578, 24)) +-- Output: 1234 56 78 +-- Output: 1234 56 78 +``` + +**Example Use Case:** +This function is particularly useful for addons that need to display the player's current amount of money in a user-friendly format. For instance, an auction house addon might use `GetCoinText` to show the total amount of money a player has after selling items. + +**Addons Using This Function:** +- **Auctioneer**: This addon uses `GetCoinText` to display the player's current gold, silver, and copper in various parts of its interface, such as when listing items for sale or showing the total earnings from auctions. +- **Bagnon**: This inventory management addon uses `GetCoinText` to show the total amount of money a player has across all their characters and banks. \ No newline at end of file diff --git a/wiki-information/functions/GetCoinTextureString.md b/wiki-information/functions/GetCoinTextureString.md new file mode 100644 index 00000000..d9cac0da --- /dev/null +++ b/wiki-information/functions/GetCoinTextureString.md @@ -0,0 +1,51 @@ +## Title: GetCoinTextureString + +**Content:** +Breaks up an amount of money into gold/silver/copper with icons. +`formattedAmount = GetCoinTextureString(amount)` + +**Parameters:** +- `amount` + - *number* - the amount of money in copper (for example, the return value from GetMoney) +- `fontHeight` + - *number?* - the height of the coin icon; if not specified, defaults to 14. + +**Returns:** +- `formattedAmount` + - *string* - a string suitable for printing or displaying. + +**Usage:** +```lua +-- Example usage of GetMoney and GetCoinTextureString +GetMoney() +local money = GetMoney() +local gold = floor(money / 1e4) +local silver = floor(money / 100 % 100) +local copper = money % 100 +print(("You have %dg %ds %dc"):format(gold, silver, copper)) +-- You have 10851g 62s 40c + +-- Using GetCoinText +print(GetCoinText(GetMoney())) -- "10851 Gold, 62 Silver, 40 Copper" +print(GetCoinText(12345678, " ")) -- "1234 Gold 23 Silver 45 Copper" +print(GetCoinText(12345678, "X")) -- "1234 GoldX23 SilverX45 Copper" + +-- Using GetMoneyString +print(GetMoneyString(12345678)) +print(GetMoneyString(12345678, true)) +-- 1234 56 78 +-- 1,234 56 78 + +-- Using GetCoinTextureString +print(GetCoinTextureString(1234578)) +print(GetCoinTextureString(1234578, 24)) +-- 1234 56 78 +-- 1234 56 78 +``` + +**Example Use Case:** +This function is particularly useful in addons that display the player's current money in a more visually appealing way, such as in tooltips, UI elements, or chat messages. For instance, an addon like "Titan Panel" might use this function to show the player's gold, silver, and copper with appropriate icons on the panel. + +**Addons Using This Function:** +- **Titan Panel:** This popular addon uses `GetCoinTextureString` to display the player's current money on the panel with icons, making it easier to read at a glance. +- **Bagnon:** Another widely used addon, Bagnon, might use this function to show the total money across all characters in a unified and visually appealing format. \ No newline at end of file diff --git a/wiki-information/functions/GetCombatRating.md b/wiki-information/functions/GetCombatRating.md new file mode 100644 index 00000000..b1c01bc1 --- /dev/null +++ b/wiki-information/functions/GetCombatRating.md @@ -0,0 +1,89 @@ +## Title: GetCombatRating + +**Content:** +Returns a specific combat rating. +`rating = GetCombatRating(ratingIndex)` + +**Parameters:** +- `ratingIndex` + - *number* - One of the following constants from FrameXML/PaperDollFrame.lua: + - `Value` + - `Field` + - `Description` + - `1` + - `CR_WEAPON_SKILL` - Removed in patch 6.0.2 + - `2` + - `CR_DEFENSE_SKILL` + - `3` + - `CR_DODGE` + - `4` + - `CR_PARRY` + - `5` + - `CR_BLOCK` + - `6` + - `CR_HIT_MELEE` + - `7` + - `CR_HIT_RANGED` + - `8` + - `CR_HIT_SPELL` + - `9` + - `CR_CRIT_MELEE` + - `10` + - `CR_CRIT_RANGED` + - `11` + - `CR_CRIT_SPELL` + - `12` + - `CR_MULTISTRIKE` - Formerly CR_HIT_TAKEN_MELEE until patch 6.0.2 + - `13` + - `CR_READINESS` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 + - `14` + - `CR_SPEED` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 + - `15` + - `CR_RESILIENCE_CRIT_TAKEN` + - `16` + - `CR_RESILIENCE_PLAYER_DAMAGE_TAKEN` + - `17` + - `CR_LIFESTEAL` - Formerly CR_CRIT_TAKEN_SPELL until patch 6.0.2 + - `18` + - `CR_HASTE_MELEE` + - `19` + - `CR_HASTE_RANGED` + - `20` + - `CR_HASTE_SPELL` + - `21` + - `CR_AVOIDANCE` - Formerly CR_WEAPON_SKILL_MAINHAND until patch 6.0.2 + - `22` + - `CR_WEAPON_SKILL_OFFHAND` - Removed in patch 6.0.2 + - `23` + - `CR_WEAPON_SKILL_RANGED` + - `24` + - `CR_EXPERTISE` + - `25` + - `CR_ARMOR_PENETRATION` + - `26` + - `CR_MASTERY` + - `27` + - `CR_PVP_POWER` - Removed in patch 6.0.2 + - `29` + - `CR_VERSATILITY_DAMAGE_DONE` + - `31` + - `CR_VERSATILITY_DAMAGE_TAKEN` + +**Returns:** +- `rating` + - *number* - the actual rating for the combat rating. + +**Description:** +Related API: `GetCombatRatingBonus` + +**Usage:** +```lua +local hitRating = GetCombatRating(CR_HIT_MELEE) +print(hitRating) -- 63 +``` + +**Example Use Case:** +This function can be used to retrieve the player's current rating for a specific combat stat, which can be useful for addons that display detailed character statistics or for custom UI elements that need to show combat ratings. + +**Addons Using This API:** +Many popular addons like "Details! Damage Meter" and "Recount" use this API to display detailed combat statistics and performance metrics for players. \ No newline at end of file diff --git a/wiki-information/functions/GetCombatRatingBonus.md b/wiki-information/functions/GetCombatRatingBonus.md new file mode 100644 index 00000000..b69013b6 --- /dev/null +++ b/wiki-information/functions/GetCombatRatingBonus.md @@ -0,0 +1,87 @@ +## Title: GetCombatRatingBonus + +**Content:** +Returns the bonus percentage for a specific combat rating. +`ratingBonus = GetCombatRatingBonus(ratingIndex)` + +**Parameters:** +- `ratingIndex` + - *number* - One of the following values from FrameXML/PaperDollFrame.lua: + - `Value` + - `Field` + - `Description` + - `1` + - `CR_WEAPON_SKILL` - Removed in patch 6.0.2 + - `2` + - `CR_DEFENSE_SKILL` + - `3` + - `CR_DODGE` + - `4` + - `CR_PARRY` + - `5` + - `CR_BLOCK` + - `6` + - `CR_HIT_MELEE` + - `7` + - `CR_HIT_RANGED` + - `8` + - `CR_HIT_SPELL` + - `9` + - `CR_CRIT_MELEE` + - `10` + - `CR_CRIT_RANGED` + - `11` + - `CR_CRIT_SPELL` + - `12` + - `CR_MULTISTRIKE` - Formerly CR_HIT_TAKEN_MELEE until patch 6.0.2 + - `13` + - `CR_READINESS` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 + - `14` + - `CR_SPEED` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 + - `15` + - `CR_RESILIENCE_CRIT_TAKEN` + - `16` + - `CR_RESILIENCE_PLAYER_DAMAGE_TAKEN` + - `17` + - `CR_LIFESTEAL` - Formerly CR_CRIT_TAKEN_SPELL until patch 6.0.2 + - `18` + - `CR_HASTE_MELEE` + - `19` + - `CR_HASTE_RANGED` + - `20` + - `CR_HASTE_SPELL` + - `21` + - `CR_AVOIDANCE` - Formerly CR_WEAPON_SKILL_MAINHAND until patch 6.0.2 + - `22` + - `CR_WEAPON_SKILL_OFFHAND` - Removed in patch 6.0.2 + - `23` + - `CR_WEAPON_SKILL_RANGED` + - `24` + - `CR_EXPERTISE` + - `25` + - `CR_ARMOR_PENETRATION` + - `26` + - `CR_MASTERY` + - `27` + - `CR_PVP_POWER` - Removed in patch 6.0.2 + - `29` + - `CR_VERSATILITY_DAMAGE_DONE` + - `31` + - `CR_VERSATILITY_DAMAGE_TAKEN` + +**Returns:** +- `ratingBonus` + - *number* - the actual bonus in percent the combat rating confers; e.g. 5.13452 + +**Usage:** +```lua +hitBonus = GetCombatRatingBonus(CR_HIT_MELEE) -- 5.13452 +``` + +**Reference:** +- `GetCombatRating`: Gets the underlying rating that contributes to the bonus +- `GetCritChance`: Gets the player's current Crit Chance % +- `GetMastery`: Gets the player's current Mastery % +- `GetDodgeChance`: Gets the player's current Dodge Chance % +- `GetParryChance`: Gets the player's current Parry Chance % +- `GetBlockChance`: Gets the player's current Block Chance % \ No newline at end of file diff --git a/wiki-information/functions/GetComboPoints.md b/wiki-information/functions/GetComboPoints.md new file mode 100644 index 00000000..8489ef72 --- /dev/null +++ b/wiki-information/functions/GetComboPoints.md @@ -0,0 +1,35 @@ +## Title: GetComboPoints + +**Content:** +Returns the amount of current combo points. +`comboPoints = GetComboPoints(unit, target)` + +**Parameters:** +- `unit` + - *string* : UnitId - Normally "player" or "vehicle". +- `target` + - *string* : UnitId - Normally "target". + +**Returns:** +- `comboPoints` + - *number* - Number of combo points unit has on target; between 0 and 5 inclusive. + +**Description:** +`UNIT_COMBO_POINTS` fires when combo points are updated. It fires every 10 seconds outside of combat if the rogue has shared combo points, and it continues to fire every 10 seconds until the combo point pool is empty. + +Patch 6.0.2 (2014-10-14): Combo Points for rogues are now shared across all targets and they are no longer lost when switching targets. + +`GetComboPoints` will return 0 if the target is friendly or not found. Use `UnitPower(unitId, 4)` to get combo points without an enemy targeted. + +**Reference:** +- `UnitPower` + +**Example Usage:** +```lua +local comboPoints = GetComboPoints("player", "target") +print("Current combo points on target: ", comboPoints) +``` + +**Addons Using This Function:** +- **ElvUI**: A comprehensive UI replacement addon that uses `GetComboPoints` to display combo points on the unit frames. +- **WeakAuras**: A powerful and flexible framework for displaying highly customizable graphics on your screen to indicate buffs, debuffs, and other relevant information, including combo points. \ No newline at end of file diff --git a/wiki-information/functions/GetCompanionCooldown.md b/wiki-information/functions/GetCompanionCooldown.md new file mode 100644 index 00000000..f3c9e673 --- /dev/null +++ b/wiki-information/functions/GetCompanionCooldown.md @@ -0,0 +1,19 @@ +## Title: GetCompanionCooldown + +**Content:** +Returns cooldown information about the companions you have. +`startTime, duration, isEnabled = GetCompanionCooldown("type", id)` + +**Parameters:** +- `type` + - *String (companionType)* - Type of the companion being queried ("CRITTER" or "MOUNT") +- `id` + - *Number* - The slot id to query (starts at 1). + +**Returns:** +- `start` + - *Number* - the time the cooldown period began, based on GetTime(). +- `duration` + - *Number* - the duration of the cooldown period. +- `isEnabled` + - *Number* - 1 if the companion has a cooldown. \ No newline at end of file diff --git a/wiki-information/functions/GetCompanionInfo.md b/wiki-information/functions/GetCompanionInfo.md new file mode 100644 index 00000000..23778a28 --- /dev/null +++ b/wiki-information/functions/GetCompanionInfo.md @@ -0,0 +1,39 @@ +## Title: GetCompanionInfo + +**Content:** +Returns info for a companion. +`creatureID, creatureName, creatureSpellID, icon, issummoned, mountType = GetCompanionInfo(type, id)` + +**Parameters:** +- `type` + - *string* - Companion type to query: "CRITTER" or "MOUNT". +- `id` + - *number* - Index of the slot to query. Starting at 1 and going up to `GetNumCompanions("type")`. + +**Returns:** +- `creatureID` + - *number* - The NPC ID of the companion. +- `creatureName` + - *string* - The name of the companion. +- `creatureSpellID` + - *number* - The spell ID to cast the companion. This is not passed to `CallCompanion`, but can be used with, e.g., `GetSpellInfo`. +- `icon` + - *string* - The texture of the icon for the companion. +- `issummoned` + - *boolean* - 1 if the companion is summoned, nil if it's not. +- `mountType` + - *number* - Bitfield for air/ground/water mounts + - 0x1: Ground + - 0x2: Can fly + - 0x4: ? (set for most mounts) + - 0x8: Underwater + - 0x10: Can jump (turtles cannot) + +**Description:** +The indices are unstable: you may not rely on the ("type", id) mapping to the same companion after an arbitrary amount of time, even if the player does not learn/unlearn any companions during the period. +Generally, the indices are ordered alphabetically, though this order may be violated during the initial loading process and upon zoning. + +**Reference:** +- `GetNumCompanions` +- `CallCompanion` +- `C_PetJournal` function \ No newline at end of file diff --git a/wiki-information/functions/GetComparisonStatistic.md b/wiki-information/functions/GetComparisonStatistic.md new file mode 100644 index 00000000..0ae4c61a --- /dev/null +++ b/wiki-information/functions/GetComparisonStatistic.md @@ -0,0 +1,13 @@ +## Title: GetComparisonStatistic + +**Content:** +Returns the specified statistic from the comparison player unit. +`value = GetComparisonStatistic(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - The ID of the Achievement. + +**Returns:** +- `value` + - *string* - The value of the requested Statistic from the comparison unit. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerFreeSlots.md b/wiki-information/functions/GetContainerFreeSlots.md new file mode 100644 index 00000000..abdc5464 --- /dev/null +++ b/wiki-information/functions/GetContainerFreeSlots.md @@ -0,0 +1,21 @@ +## Title: GetContainerFreeSlots + +**Content:** +Populates a table with references to unused slots inside a container. +```lua +returnTable = GetContainerFreeSlots(index) +GetContainerFreeSlots(index, returnTable) +``` + +**Parameters:** +- `index` + - *number* - the slot containing the bag, e.g. 0 for backpack, etc. +- `returnTable` + - *table?* - Provide an empty table and the function will populate it with the free slots + +**Returns:** +- `returnTable` + - *table* - If you do not specify `returnTable` as an argument, the function constructs and returns a new table instead + +**Reference:** +- `GetContainerNumFreeSlots` \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemCooldown.md b/wiki-information/functions/GetContainerItemCooldown.md new file mode 100644 index 00000000..9d414335 --- /dev/null +++ b/wiki-information/functions/GetContainerItemCooldown.md @@ -0,0 +1,21 @@ +## Title: GetContainerItemCooldown + +**Content:** +Returns cooldown information for an item in your inventory. +`startTime, duration, isEnabled = GetContainerItemCooldown(bagID, slot)` + +**Parameters:** +- `(bagID, slot)` + - `bagID` + - *number* - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags + - `slot` + - *number* - slot number of the bag item you want the info for. + +**Returns:** +- `startTime, duration, isEnabled` + - `startTime` + - the time the cooldown period began + - `duration` + - the duration of the cooldown period + - `isEnabled` + - 1 if the item has a cooldown, 0 otherwise \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemDurability.md b/wiki-information/functions/GetContainerItemDurability.md new file mode 100644 index 00000000..ae86b17d --- /dev/null +++ b/wiki-information/functions/GetContainerItemDurability.md @@ -0,0 +1,26 @@ +## Title: GetContainerItemDurability + +**Content:** +Returns the durability of an item in a container slot. +`current, maximum = GetContainerItemDurability(bag, slot)` + +**Parameters:** +- `bag` + - *number* - Index of the bag slot the bag storing the item is in. +- `slot` + - *number* - Index of the bag slot containing the item to query durability of. + +**Returns:** +- `current` + - *number* - current durability value. +- `maximum` + - *number* - maximum durability value. + +**Reference:** +- `GetInventoryItemDurability` + +**Example Usage:** +This function can be used to check the durability of items in a player's inventory, which is useful for addons that manage equipment or provide alerts when items are close to breaking. + +**Addon Usage:** +Large addons like "ElvUI" and "WeakAuras" may use this function to display durability information on the user interface, helping players keep track of their gear's condition. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemID.md b/wiki-information/functions/GetContainerItemID.md new file mode 100644 index 00000000..8cc72f6e --- /dev/null +++ b/wiki-information/functions/GetContainerItemID.md @@ -0,0 +1,15 @@ +## Title: GetContainerItemID + +**Content:** +Returns the item ID in a container slot. +`itemId = GetContainerItemID(bag, slot)` + +**Parameters:** +- `bag` + - *number (BagID)* - Index of the bag to query. +- `slot` + - *number* - Index of the slot within the bag to query; ascending from 1. + +**Returns:** +- `itemId` + - *number* - item ID of the item held in the container slot, nil if there is no item in the container slot. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemInfo.md b/wiki-information/functions/GetContainerItemInfo.md new file mode 100644 index 00000000..3c73a718 --- /dev/null +++ b/wiki-information/functions/GetContainerItemInfo.md @@ -0,0 +1,46 @@ +## Title: GetContainerItemInfo + +**Content:** +Returns info for an item in a container slot. +`icon, itemCount, locked, quality, readable, lootable, itemLink, isFiltered, noValue, itemID, isBound = GetContainerItemInfo(bagID, slot)` + +**Parameters:** +- `bagID` + - *number* - BagID of the bag the item is in, e.g. 0 for your backpack. +- `slot` + - *number* - index of the slot inside the bag to look up. + +**Returns:** +1. `texture` + - *number* - The icon texture (FileID) for the item in the specified bag slot. +2. `itemCount` + - *number* - The number of items in the specified bag slot. +3. `locked` + - *boolean* - True if the item is locked by the server, false otherwise. +4. `quality` + - *number* - The Quality of the item. +5. `readable` + - *boolean* - True if the item can be "read" (as in a book), false otherwise. +6. `lootable` + - *boolean* - True if the item is a temporary container containing items that can be looted, false otherwise. +7. `itemLink` + - *string* - The itemLink of the item in the specified bag slot. +8. `isFiltered` + - *boolean* - True if the item is grayed-out during the current inventory search, false otherwise. +9. `noValue` + - *boolean* - True if the item has no gold value, false otherwise. +10. `itemID` + - *number* - The unique ID for the item in the specified bag slot. +11. `isBound` + - *boolean* - True if the item is bound to the current character, false otherwise. + +**Reference:** +- `GetItemInfo` +- `GetItemInfoInstant` + +**Example Usage:** +This function can be used to retrieve detailed information about items in a player's inventory, which is useful for inventory management addons. For example, an addon could use this function to display item counts, quality, and other attributes in a custom inventory UI. + +**Addons Using This Function:** +- **Bagnon**: A popular inventory management addon that consolidates all bags into a single window. It uses `GetContainerItemInfo` to display item details and manage inventory efficiently. +- **ArkInventory**: Another comprehensive inventory addon that allows for highly customizable bag layouts and item sorting. It relies on `GetContainerItemInfo` to fetch item data for its various features. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemLink.md b/wiki-information/functions/GetContainerItemLink.md new file mode 100644 index 00000000..6db14b26 --- /dev/null +++ b/wiki-information/functions/GetContainerItemLink.md @@ -0,0 +1,24 @@ +## Title: GetContainerItemLink + +**Content:** +Returns a link of the object located in the specified slot of a specified bag. +`itemLink = GetContainerItemLink(bagID, slotIndex)` + +**Parameters:** +- `bagID` + - *number* - Bag index (bagID). Valid indices are integers -2 through 11. 0 is the backpack. +- `slotIndex` + - *number* - Slot index within the specified bag, ascending from 1. Slot 1 is typically the leftmost topmost slot. + +**Returns:** +- `itemLink` + - *string* - a chat link for the object in the specified bag slot; nil if there is no such object. This is typically, but not always an ItemLink. + +**Usage:** +The following macro prints the ItemLink of the item located in bag 0, slot 1. +```lua +/run link=GetContainerItemLink(0,1); printable=gsub(link, "\\124", "\\124\\124"); print("Here's the item link for the first slot of your backpack: \\"" .. printable .. "\\"") +``` + +**Description:** +Since Patch 5.0.4, certain companion pets may be put in a cage and traded. The cage is not an item, but nevertheless occupies bag slots. For such caged companions, the returned link describes a battle pet ("|Hbattlet:...") rather than an item ("|Hitem:..."). \ No newline at end of file diff --git a/wiki-information/functions/GetContainerNumFreeSlots.md b/wiki-information/functions/GetContainerNumFreeSlots.md new file mode 100644 index 00000000..8c41d8a6 --- /dev/null +++ b/wiki-information/functions/GetContainerNumFreeSlots.md @@ -0,0 +1,18 @@ +## Title: GetContainerNumFreeSlots + +**Content:** +Returns the number of free slots in a bag. +`numberOfFreeSlots, bagType = GetContainerNumFreeSlots(bagID)` + +**Parameters:** +- `bagID` + - *number* - the slot containing the bag, e.g. 0 for backpack, etc. + +**Returns:** +- `numberOfFreeSlots` + - *number* - the number of free slots in the specified bag. +- `bagType` + - *number (itemFamily Bitfield)* - The type of the container, described using bits to indicate its permissible contents. + +**Reference:** +- `GetContainerFreeSlots` - Returns a table containing references to each free slot \ No newline at end of file diff --git a/wiki-information/functions/GetContainerNumSlots.md b/wiki-information/functions/GetContainerNumSlots.md new file mode 100644 index 00000000..33db61b9 --- /dev/null +++ b/wiki-information/functions/GetContainerNumSlots.md @@ -0,0 +1,17 @@ +## Title: GetContainerNumSlots + +**Content:** +Returns the total number of slots in the bag specified by the index. +`numberOfSlots = GetContainerNumSlots(bagID)` + +**Parameters:** +- `bagID` + - *number* - the slot containing the bag, e.g. 0 for backpack, etc. + +**Returns:** +- `numberOfSlots` + - *number* - the number of slots in the specified bag, or 0 if there is no bag in the given slot. + +**Description:** +In 2.0.3, the Key Ring(-2) always returns 32. The size of the bag displayed is determined by the amount of space used in the keyring. +As of 3.0.3, immediately after a PLAYER_ENTERING_WORLD event (initial login or zone change through an instance, i.e., any time you see a loading screen), several events of BAG_UPDATE are fired, one for each bag slot you have purchased. All bag data is available during the PLAYER_ENTERING_WORLD event, but this function returns 0 for bags that have not had the BAG_UPDATE function called. This is most likely due to the UI resetting its internal cache sometime between the PLAYER_ENTERING_WORLD event and the first BAG_UPDATE event. \ No newline at end of file diff --git a/wiki-information/functions/GetCorpseRecoveryDelay.md b/wiki-information/functions/GetCorpseRecoveryDelay.md new file mode 100644 index 00000000..565c4a36 --- /dev/null +++ b/wiki-information/functions/GetCorpseRecoveryDelay.md @@ -0,0 +1,9 @@ +## Title: GetCorpseRecoveryDelay + +**Content:** +Needs summary. +`result = GetCorpseRecoveryDelay()` + +**Returns:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetCraftDescription.md b/wiki-information/functions/GetCraftDescription.md new file mode 100644 index 00000000..8e2d989b --- /dev/null +++ b/wiki-information/functions/GetCraftDescription.md @@ -0,0 +1,23 @@ +## Title: GetCraftDescription + +**Content:** +This command returns a string description of what the current craft does. +`craftDescription = GetCraftDescription(index)` + +**Parameters:** +- `index` + - *number* - Number from 1 to X number of total crafts, where 1 is the top-most craft listed. + +**Returns:** +- `craftDescription` + - *string* - Returns, for example, "Permanently enchant a two handed melee weapon to grant +25 Agility." + +**Example Usage:** +```lua +local index = 1 +local description = GetCraftDescription(index) +print(description) -- Output: "Permanently enchant a two handed melee weapon to grant +25 Agility." +``` + +**Additional Information:** +This function is often used in crafting-related addons to display detailed information about what each craft does. For example, an addon that helps players manage their professions might use this function to show descriptions of all available crafts in a user-friendly interface. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftDisplaySkillLine.md b/wiki-information/functions/GetCraftDisplaySkillLine.md new file mode 100644 index 00000000..4b6b27f4 --- /dev/null +++ b/wiki-information/functions/GetCraftDisplaySkillLine.md @@ -0,0 +1,19 @@ +## Title: GetCraftDisplaySkillLine + +**Content:** +This command retrieves displayable information for the current craft. +`name, rank, maxRank = GetCraftDisplaySkillLine()` + +**Returns:** +- `name` + - *string* - The name of the active craft, or nil if the current craft has no displayable name. Also nil if there are no active crafting windows. +- `rank` + - *number* - The player's current rank for the named craft, if applicable. +- `maxRank` + - *number* - The maximum rank for the named craft, if applicable. + +**Description:** +The two crafts, Beast Training and Enchanting, have a slightly different UI: the latter has a blue progress bar at the top of the window indicating the player's rank while the former does not. Accordingly, this function returns nil when the Beast Training window is open, while all return values should be valid when the Enchanting window is open. + +**Reference:** +`GetCraftSkillLine()` returns the name of the currently active crafting window regardless of whether the name should be displayed. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftInfo.md b/wiki-information/functions/GetCraftInfo.md new file mode 100644 index 00000000..faaf4c41 --- /dev/null +++ b/wiki-information/functions/GetCraftInfo.md @@ -0,0 +1,23 @@ +## Title: GetCraftInfo + +**Content:** +`craftName, craftSubSpellName, craftType, numAvailable, isExpanded, trainingPointCost, requiredLevel = GetCraftInfo(index)` + +**Parameters:** +- `index` + - *number* - 1 to GetNumCrafts() + +**Returns:** +- `craftName` + - Name of the item you can craft +- `craftSubSpellName` +- `craftType` + - *string* - "header" or how hard it is to create the item; trivial, easy, medium, or optimal. +- `numAvailable` + - This is the number of items you can create with the reagents you have in your inventory (the number is also shown in the UI). +- `isExpanded` + - Only applies to headers. Indicates whether they are expanded or contracted. Nil if not applicable. +- `trainingPointCost` + - This is the number of training points needed to train this skill if at a trainer. Nil if the craft window is not a trainer. +- `requiredLevel` + - The required level to train this skill if at a trainer. Nil if the craft window is not a trainer. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftItemLink.md b/wiki-information/functions/GetCraftItemLink.md new file mode 100644 index 00000000..424d3fe6 --- /dev/null +++ b/wiki-information/functions/GetCraftItemLink.md @@ -0,0 +1,18 @@ +## Title: GetCraftItemLink + +**Content:** +Returns an itemLink for the specified trade skill item in the current active trade skill. +`itemLink = GetCraftItemLink(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the current active trade skill. + +**Returns:** +- `itemLink` + - *itemLink* - the corresponding item link for that item or + - *nil* - if the index is invalid or there is no active trade skill. + +**Description:** +This function works with the trade skill which is currently active. Initially, there is no active trade skill. A trade skill becomes active when a trade skill window is opened, for instance. +Note that not all trade skills will change the active trade skill for this function. Only those which can generate chat links for a single trade skill will change the active setting (not to be mixed up with item links for crafted items). At the moment, this is only the enchanting trade skill window. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftName.md b/wiki-information/functions/GetCraftName.md new file mode 100644 index 00000000..8a0ef001 --- /dev/null +++ b/wiki-information/functions/GetCraftName.md @@ -0,0 +1,9 @@ +## Title: GetCraftName + +**Content:** +Gets the name displayed on the craft window. +`craftName = GetCraftName()` + +**Returns:** +- `craftName` + - *string* - It appears to return the localized name for Enchanting, Poisons for Rogues, and Cooking. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftNumReagents.md b/wiki-information/functions/GetCraftNumReagents.md new file mode 100644 index 00000000..0d197c46 --- /dev/null +++ b/wiki-information/functions/GetCraftNumReagents.md @@ -0,0 +1,13 @@ +## Title: GetCraftNumReagents + +**Content:** +This command tells the caller how many reagents are required for said craft. +`numRequiredReagents = GetCraftNumReagents(index)` + +**Parameters:** +- `index` + - *Numeric* - Number from 1 to X, where X is the total number of possible crafts. + +**Returns:** +- `numRequiredReagents` + - *Integer* - This is the number of required reagents for said craft. For example, 4 (for any craft that requires 4 reagents to perform). \ No newline at end of file diff --git a/wiki-information/functions/GetCraftReagentInfo.md b/wiki-information/functions/GetCraftReagentInfo.md new file mode 100644 index 00000000..41efac89 --- /dev/null +++ b/wiki-information/functions/GetCraftReagentInfo.md @@ -0,0 +1,21 @@ +## Title: GetCraftReagentInfo + +**Content:** +This command tells the caller the name of the reagent, path to the used texture, number of required reagents, and number of said reagents that the caller currently has in their bags. +`name, texturePath, numRequired, numHave = GetCraftReagentInfo(index, n)` + +**Parameters:** +- `index` + - *number* - starting at 1 going down to X number of possible crafts, where 1 is the top-most listed craft. +- `n` + - *number* - starting at 1 to X, where X is the total number of reagents said craft requires. + +**Returns:** +- `name` + - Name of the reagent required. e.g., "Large Brilliant Shard" +- `texturePath` + - Path to the required item texture. e.g., "Interface\\Icons\\INV_Enchant_ShardBrilliantLarge" +- `numRequired` + - *number* - Number of total required reagents. +- `numHave` + - *number* - Number of total required reagents that the user has on them currently. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftReagentItemLink.md b/wiki-information/functions/GetCraftReagentItemLink.md new file mode 100644 index 00000000..c150360e --- /dev/null +++ b/wiki-information/functions/GetCraftReagentItemLink.md @@ -0,0 +1,19 @@ +## Title: GetCraftReagentItemLink + +**Content:** +This command returns a required reagent (as an itemLink) for a specific craftable item from the currently visible tradeskill window. +`reagentLink = GetCraftReagentItemLink(index, n)` + +**Parameters:** +- `index` + - *number* - index of the requested craft recipe, where 1 is the top-most listed recipe. +- `n` + - *number* - index of the Nth reagent for the recipe, where 1 is the first reagent. + +**Returns:** +- `reagentLink` + - *string* - itemLink for the requested reagent. + +**Description:** +If you specify an invalid index, `nil` is returned. +If there is no visible tradeskill window, `nil` is returned. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftRecipeLink.md b/wiki-information/functions/GetCraftRecipeLink.md new file mode 100644 index 00000000..68ab9b4c --- /dev/null +++ b/wiki-information/functions/GetCraftRecipeLink.md @@ -0,0 +1,17 @@ +## Title: GetCraftRecipeLink + +**Content:** +Returns the EnchantLink for a craft. +`link = GetCraftRecipeLink(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the current active trade skill. + +**Returns:** +- `link` + - *string* - An EnchantLink (color coded with href) which can be included in chat messages to show the reagents and the items the craft creates. + +**Description:** +This function works with the trade skill which is currently active and only the trade skills that use the CraftFrame, not the TradeSkillFrame. Initially, there is no active trade skill. A trade skill becomes active when a trade skill window is opened, for instance. +Note that not all trade skills will change the active trade skill for this function. At the moment, only enchanting and hunter's train-pet window use CraftFrame. Use `GetTradeSkillRecipeLink` for the other professions. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftSkillLine.md b/wiki-information/functions/GetCraftSkillLine.md new file mode 100644 index 00000000..cf095f41 --- /dev/null +++ b/wiki-information/functions/GetCraftSkillLine.md @@ -0,0 +1,16 @@ +## Title: GetCraftSkillLine + +**Content:** +This command tells the caller which, if any, crafting window is currently open. +`currentCraftingWindow = GetCraftSkillLine(n)` + +**Parameters:** +- `n` + - *number* - Not sure how this is used, but any number greater than zero seems to behave identically. Passing zero always results in a nil return value. + +**Returns:** +- `currentCraftingWindow` + - *string* - The name of the currently opened crafting window, or nil if no crafting window is open. This will be one of "Enchanting" or "Beast Training". + +**Description:** +This function is not quite the same as `GetCraftDisplaySkillLine()`. The latter returns nil in case the Beast Training window is open, while the current function returns "Beast Training". \ No newline at end of file diff --git a/wiki-information/functions/GetCraftSpellFocus.md b/wiki-information/functions/GetCraftSpellFocus.md new file mode 100644 index 00000000..1e756f6a --- /dev/null +++ b/wiki-information/functions/GetCraftSpellFocus.md @@ -0,0 +1,13 @@ +## Title: GetCraftSpellFocus + +**Content:** +`catalystName, number1 = GetCraftSpellFocus(index)` + +**Parameters:** +- `index` + - *number* - 1 to GetNumCrafts() + +**Returns:** +When called while the enchanting screen is open, this function returns which rod is required, if any. I don't know whether this function also applies to other types of crafts or spells. +Returns two values when a rod is required: a string that contains the name of the rod, and the number "1". I don't know what the "1" means. +Returns nil if no rods are required. \ No newline at end of file diff --git a/wiki-information/functions/GetCritChance.md b/wiki-information/functions/GetCritChance.md new file mode 100644 index 00000000..09cde630 --- /dev/null +++ b/wiki-information/functions/GetCritChance.md @@ -0,0 +1,16 @@ +## Title: GetCritChance + +**Content:** +Returns the melee critical hit chance percentage. +`critChance = GetCritChance()` + +**Returns:** +- `critChance` + - *number* - The player's melee critical hit chance, as a percentage; e.g. 5.3783211 corresponding to a ~5.38% crit chance. + +**Reference:** +- `GetBlockChance` +- `GetDodgeChance` +- `GetParryChance` +- `GetCombatRating` +- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyInfo.md b/wiki-information/functions/GetCurrencyInfo.md new file mode 100644 index 00000000..ab9800ef --- /dev/null +++ b/wiki-information/functions/GetCurrencyInfo.md @@ -0,0 +1,35 @@ +## Title: GetCurrencyInfo + +**Content:** +Retrieve Information about a currency at index including its amount. +`name, currentAmount, texture, earnedThisWeek, weeklyMax, totalMax, isDiscovered, rarity = GetCurrencyInfo(id or "currencyLink" or "currencyString")` + +**Parameters:** +One of the following three ways to specify which currency to query: +- `id` + - *Integer* - CurrencyID +- `currencyLink` + - *String* - The full currencyLink as found with `GetCurrencyLink()` or `GetCurrencyListLink()`. +- `currencyString` + - *String* - A fragment of the currencyLink string for the item, e.g. `"currency:396"` for Valor Points. + +**Returns:** +- `name` + - *String* - the name of the currency, localized to the language +- `amount` + - *Number* - Current amount of the currency at index +- `texture` + - *String* - The file name of the currency's icon. +- `earnedThisWeek` + - *Number* - The amount of the currency earned this week +- `weeklyMax` + - *Number* - Maximum amount of currency possible to be earned this week +- `totalMax` + - *Number* - Total maximum currency possible to stockpile +- `isDiscovered` + - *Boolean* - Whether the character has ever got some of this currency +- `rarity` + - *Integer* - Rarity indicator for this currency + +**External Resources:** +[Wowhead](https://www.wowhead.com) \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyLink.md b/wiki-information/functions/GetCurrencyLink.md new file mode 100644 index 00000000..9299f560 --- /dev/null +++ b/wiki-information/functions/GetCurrencyLink.md @@ -0,0 +1,18 @@ +## Title: GetCurrencyLink + +**Content:** +Get the currencyLink for the specified currencyID. +`currencyLink = GetCurrencyLink(currencyID, currencyAmount)` + +**Parameters:** +- `currencyID` + - *Integer* - currency index - see table at GetCurrencyInfo for a list +- `currencyAmount` + - *Integer* - currency amount + +**Returns:** +- `currencyLink` + - *String* - The currency link (similar to itemLink) for the specified index (e.g. `"|cffa335ee|Hcurrency:396:0|h|h|r"` for Valor Points) or nil if the index is for a header. + +**Reference:** +- `GetCurrencyListLink` (for currencies visible in the currency tab) \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyListInfo.md b/wiki-information/functions/GetCurrencyListInfo.md new file mode 100644 index 00000000..47e65c16 --- /dev/null +++ b/wiki-information/functions/GetCurrencyListInfo.md @@ -0,0 +1,41 @@ +## Title: GetCurrencyListInfo + +**Content:** +Returns information about an entry in the currency list. +`name, isHeader, isExpanded, isUnused, isWatched, count, icon, maximum, hasWeeklyLimit, currentWeeklyAmount, unknown, itemID = GetCurrencyListInfo(index)` + +**Parameters:** +- `id` + - *Number* - index, ascending from 1 to `GetCurrencyListSize()`. + +**Returns:** +- `name` + - *String* - localized currency (or currency header) name. +- `isHeader` + - *Boolean* - true if this entry is a header, false otherwise. +- `isExpanded` + - *Boolean* - true if this entry is an expanded header, false otherwise. +- `isUnused` + - *Boolean* - true if this entry is a currency marked as unused, false otherwise. +- `isWatched` + - *Boolean* - true if this entry is a currency currently displayed on the backpack, false otherwise. +- `count` + - *Number* - amount of this currency in the player's possession (0 for headers). +- `icon` + - *String* - path to the icon texture for item-based currencies, invalid for arena/honor points. +- `maximum` + - *Number* - 0 if this currency has no limit, otherwise integer value with 2 extra zeros (e.g. 400000 = 4000.00 as in Justice Points and Honor Points). +- `hasWeeklyLimit` + - *Number* - 1 if this currency has a weekly limit (Valor Points), nil otherwise. +- `currentWeeklyAmount` + - *Number* - amount of this currency obtained for the current week, nil otherwise. +- `unknown` + - *unknown* - possible deprecated slot for itemID? All known cases return nil. +- `itemID` + - *Number* - item ID corresponding to this item-based currency, invalid for arena/honor points. + +**Notes and Caveats:** +- Information about currencies under collapsed headers is available; it is up to the UI code to respect the `isExpanded` flag. +- Indices are generally based on localized alphabetic order. +- The headers "contain" all currencies with index greater than theirs until the next header. This is not a nested structure. +- Marking a currency as unused alters its index, as the currency is moved down the list to fit under an "Unused" header. \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyListSize.md b/wiki-information/functions/GetCurrencyListSize.md new file mode 100644 index 00000000..ef332c46 --- /dev/null +++ b/wiki-information/functions/GetCurrencyListSize.md @@ -0,0 +1,13 @@ +## Title: GetCurrencyListSize + +**Content:** +Returns the number of entries in the currency list. +`listSize = GetCurrencyListSize();` + +**Returns:** +- `listSize` + - *Number* - number of entries in the player's currency list. + +**Reference:** +- `GetCurrencyListInfo` +- `GetCurrencyListLink` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentBindingSet.md b/wiki-information/functions/GetCurrentBindingSet.md new file mode 100644 index 00000000..58c1f29f --- /dev/null +++ b/wiki-information/functions/GetCurrentBindingSet.md @@ -0,0 +1,16 @@ +## Title: GetCurrentBindingSet + +**Content:** +Returns if either account or character-specific bindings are active. +`which = GetCurrentBindingSet()` + +**Returns:** +- `which` + - *number* - One of the following values: + - `ACCOUNT_BINDINGS = 1` + - indicates that account-wide bindings are currently active. + - `CHARACTER_BINDINGS = 2` + - indicates that per-character bindings are currently active. + +**Description:** +The return value of this function depends on the last call to `SaveBindings`. \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentCombatTextEventInfo.md b/wiki-information/functions/GetCurrentCombatTextEventInfo.md new file mode 100644 index 00000000..b7d3b531 --- /dev/null +++ b/wiki-information/functions/GetCurrentCombatTextEventInfo.md @@ -0,0 +1,11 @@ +## Title: GetCurrentCombatTextEventInfo + +**Content:** +Returns the current COMBAT_TEXT_UPDATE payload. +`desc1, desc2 = GetCurrentCombatTextEventInfo()` + +**Returns:** +- `desc1` + - *any* - This field varies depending on the type of message. +- `desc2` + - *any* - This field varies depending on the type of message. \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentEventID.md b/wiki-information/functions/GetCurrentEventID.md new file mode 100644 index 00000000..076aa1dc --- /dev/null +++ b/wiki-information/functions/GetCurrentEventID.md @@ -0,0 +1,9 @@ +## Title: GetCurrentEventID + +**Content:** +Needs summary. +`eventID = GetCurrentEventID()` + +**Returns:** +- `eventID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentGraphicsAPI.md b/wiki-information/functions/GetCurrentGraphicsAPI.md new file mode 100644 index 00000000..7c266e8e --- /dev/null +++ b/wiki-information/functions/GetCurrentGraphicsAPI.md @@ -0,0 +1,12 @@ +## Title: GetCurrentGraphicsAPI + +**Content:** +Returns the currently selected graphics API. +`gxAPI = GetCurrentGraphicsAPI()` + +**Returns:** +- `graphicsAPI` + - `gxAPI` - Can be any of; D3D12, D3D11, D3D11_LEGACY, gll or opengl + +**Reference:** +CVar `gxApi` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentRegion.md b/wiki-information/functions/GetCurrentRegion.md new file mode 100644 index 00000000..51f50951 --- /dev/null +++ b/wiki-information/functions/GetCurrentRegion.md @@ -0,0 +1,38 @@ +## Title: GetCurrentRegion + +**Content:** +Returns a numeric ID representing the region the player is currently logged into. +`regionID = GetCurrentRegion()` + +**Returns:** +The following region IDs are known: +- `ID` + - `Description` +- `1` + - US (includes Brazil and Oceania) +- `2` + - Korea +- `3` + - Europe (includes Russia) +- `4` + - Taiwan (see Details) +- `5` + - China + +**Description:** +The value returned is deduced from the portal console variable, which may be set by the game client at launch to match the selected account region in the Battle.net desktop application. It does not necessarily indicate the region of the realm that the player is logged into, but instead the region of the Battle.net portal used to contact the login servers and provide a realm list. +This function is mostly reliable except in the case where the user modifies the portal from the login screen after having launched the game client through the Battle.net desktop application. The game client will prefer to use the login server addresses specified by the desktop application over the portal, causing a mismatch between the logged in region and what this function will report. +Realms located in Taiwan use the Korean Battle.net portal, meaning this function will typically always report the current region as being Korea rather than Taiwan when connected to these realms. Other functions like `C_BattleNet.GetFriendAccountInfo` may however return region IDs that correctly identify Taiwanese realms. + +**Notes and Caveats:** +The following snippet demonstrates use of this API in conjunction with `C_BattleNet.GetGameAccountInfoByGUID` to more reliably obtain the current region ID of the player. +```lua +local function GetActualRegion() + local gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(UnitGUID("player")) + return gameAccountInfo and gameAccountInfo.regionID or GetCurrentRegion() +end +print(GetActualRegion()) +``` + +**Reference:** +`GetCurrentRegionName` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentRegionName.md b/wiki-information/functions/GetCurrentRegionName.md new file mode 100644 index 00000000..e1bbae1c --- /dev/null +++ b/wiki-information/functions/GetCurrentRegionName.md @@ -0,0 +1,15 @@ +## Title: GetCurrentRegionName + +**Content:** +Returns the name of the current region. +`regionName = GetCurrentRegionName()` + +**Returns:** +- `regionName` + - *string* + +**Description:** +Refer to `GetCurrentRegion` for information on what region names this function can return, as well as details on quirks these two functions share. + +**Reference:** +- `GetCurrentRegion` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentResolution.md b/wiki-information/functions/GetCurrentResolution.md new file mode 100644 index 00000000..bbc7b9a6 --- /dev/null +++ b/wiki-information/functions/GetCurrentResolution.md @@ -0,0 +1,21 @@ +## Title: GetCurrentResolution + +**Content:** +Returns the index of the current screen resolution. +`index = GetCurrentResolution()` + +**Parameters:** +- Nothing + +**Returns:** +- `index` + - *number* - This value will be the index of one of the values yielded by `GetScreenResolutions()` + +**Usage:** +```lua +message('The current screen resolution is ' .. ({GetScreenResolutions()})[GetCurrentResolution()]) +``` +Output: +``` +The current screen resolution is 1024x768 +``` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentTitle.md b/wiki-information/functions/GetCurrentTitle.md new file mode 100644 index 00000000..366808da --- /dev/null +++ b/wiki-information/functions/GetCurrentTitle.md @@ -0,0 +1,9 @@ +## Title: GetCurrentTitle + +**Content:** +Returns the current title. +`currentTitle = GetCurrentTitle()` + +**Returns:** +- `currentTitle` + - *number* - TitleId; Returns -1 if not using any title. \ No newline at end of file diff --git a/wiki-information/functions/GetCursorDelta.md b/wiki-information/functions/GetCursorDelta.md new file mode 100644 index 00000000..134d4c47 --- /dev/null +++ b/wiki-information/functions/GetCursorDelta.md @@ -0,0 +1,15 @@ +## Title: GetCursorDelta + +**Content:** +Returns the distance that the cursor has moved since the last frame. +`x, y = GetCursorDelta()` + +**Returns:** +- `x` + - *number* - Distance along the X axis that the cursor has travelled. +- `y` + - *number* - Distance along the Y axis that the cursor has travelled. + +**Description:** +If the cursor hasn't moved between two frames, this function will return zeroes. +Values returned by this function are independent of UI scaling. The `GetScaledCursorDelta` utility function can be used to apply the effective scale of `UIParent` to the returned values. \ No newline at end of file diff --git a/wiki-information/functions/GetCursorInfo.md b/wiki-information/functions/GetCursorInfo.md new file mode 100644 index 00000000..ff19b9bc --- /dev/null +++ b/wiki-information/functions/GetCursorInfo.md @@ -0,0 +1,49 @@ +## Title: GetCursorInfo + +**Content:** +Returns what the mouse cursor is holding. +`infoType, ... = GetCursorInfo()` + +**Returns:** +The first return value is a string indicating the nature of an object on the cursor; additional return values provide detail. The following return value combinations have been observed: +- `"item"`, `itemID`, `itemLink` + - `itemID` : *number* - Item ID of the item on the cursor. + - `itemLink` : *string* - ItemLink of the item on the cursor. +- `"spell"`, `spellIndex`, `bookType`, `spellID` + - `spellIndex` : *number* - The index of the spell in the spell book. + - `bookType` : *string* - Always BOOKTYPE_SPELL (or else the type would have been "petaction"). + - `spellID` : *number* - Spell ID of the spell on the cursor. +- `"petaction"`, `spellID`, `spellIndex`, `retVal3` + - `spellID` : *number* - Spell ID of the pet action on the cursor, or unknown 0-4 number if the spell is a shared pet control spell (Follow, Stay, Assist, Defensive, etc...). + - `spellIndex` : *number* - The index of the spell in the pet spell book, or nil if the spell is a shared pet control spell (Follow, Stay, Assist, Defensive, etc...). + - `retVal3` : Needs summary. +- `"macro"`, `index` + - `index` : *number* - The index of the macro on the cursor. +- `"money"`, `amount` + - `amount` : *number* - The amount of money in copper. +- `"mount"`, `mountID`, `mountIndex` + - `mountID` : *number* - The ID of the mount. + - `mountIndex` : *number* - The index of the mount in the journal. +- `"merchant"`, `index` + - `index` : *number* - The index of the merchant item. +- `"battlepet"`, `petGUID` + - `petGUID` : *string* - GUID of a battle pet in your collection. + +**Description:** +Related Events: +- `CURSOR_UPDATE` +- `CURSOR_CHANGED` + +Related API: +- `GetCursorPosition` + +**Usage:** +The following snippet, if you're holding an item, prints out the amount of that item in your bags. +```lua +local infoType, itemID, itemLink = GetCursorInfo() +if infoType == "item" then + print("You have " .. GetItemCount(itemLink) .. "x" .. itemLink .. " in your bags.") +else + print("You're not holding an item on your cursor.") +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetCursorMoney.md b/wiki-information/functions/GetCursorMoney.md new file mode 100644 index 00000000..910f761d --- /dev/null +++ b/wiki-information/functions/GetCursorMoney.md @@ -0,0 +1,9 @@ +## Title: GetCursorMoney + +**Content:** +Returns the amount of money held by the cursor. +`copper = GetCursorMoney()` + +**Returns:** +- `copper` + - *number* - Amount of money, in copper, currently held on the cursor. \ No newline at end of file diff --git a/wiki-information/functions/GetCursorPosition.md b/wiki-information/functions/GetCursorPosition.md new file mode 100644 index 00000000..5ca46265 --- /dev/null +++ b/wiki-information/functions/GetCursorPosition.md @@ -0,0 +1,29 @@ +## Title: GetCursorPosition + +**Content:** +Returns the cursor's position on the screen. +`x, y = GetCursorPosition()` + +**Returns:** +- `x` + - *number* - x coordinate unaffected by UI scale; 0 at the left edge of the screen. +- `y` + - *number* - y coordinate unaffected by UI scale; 0 at the bottom edge of the screen. + +**Description:** +Returns scale-independent coordinates similar to `Cursor:GetCenter()` if 'Cursor' was a valid frame not affected by scaling. +Assuming `UIParent` spans the entire screen, you can convert these coordinates to `UIParent` offsets by dividing by its effective scale. The following snippet positions a small texture at the cursor's location. + +```lua +local uiScale, x, y = UIParent:GetEffectiveScale(), GetCursorPosition() +local tex = UIParent:CreateTexture() +tex:SetTexture(1,1,1) +tex:SetSize(4,4) +tex:SetPoint("CENTER", nil, "BOTTOMLEFT", x / uiScale, y / uiScale) +``` + +**Example Usage:** +This function is often used in addons that need to track the cursor's position for custom UI elements or interactions. For instance, an addon that creates custom tooltips or context menus at the cursor's location would use `GetCursorPosition` to determine where to display these elements. + +**Addons Using This Function:** +Many large addons, such as ElvUI and WeakAuras, utilize `GetCursorPosition` to enhance user interaction by dynamically positioning UI elements relative to the cursor. For example, WeakAuras might use it to display configuration options or visual effects at the cursor's location during setup. \ No newline at end of file diff --git a/wiki-information/functions/GetDeathRecapLink.md b/wiki-information/functions/GetDeathRecapLink.md new file mode 100644 index 00000000..42616089 --- /dev/null +++ b/wiki-information/functions/GetDeathRecapLink.md @@ -0,0 +1,17 @@ +## Title: GetDeathRecapLink + +**Content:** +Returns a chat link for a specific death. +`recapLink = GetDeathRecapLink(recapID)` + +**Parameters:** +- `recapID` + - *number* - The specific death to view, from 1 to the most recent death. + +**Returns:** +- `events` + - *string* - deathLink + +**Reference:** +- `DeathRecap_HasEvents` +- `DeathRecap_GetEvents` \ No newline at end of file diff --git a/wiki-information/functions/GetDefaultLanguage.md b/wiki-information/functions/GetDefaultLanguage.md new file mode 100644 index 00000000..2ecef452 --- /dev/null +++ b/wiki-information/functions/GetDefaultLanguage.md @@ -0,0 +1,15 @@ +## Title: GetDefaultLanguage + +**Content:** +Returns the character's default language. +`language, languageID = GetDefaultLanguage()` + +**Returns:** +- `language` + - *string* - The player's default language, usually the faction's common language (i.e. "Common" and "Orcish"). +- `languageID` + - *number* - LanguageID + +**Usage:** +`/dump GetDefaultLanguage()` +> "Common", 7 \ No newline at end of file diff --git a/wiki-information/functions/GetDefaultScale.md b/wiki-information/functions/GetDefaultScale.md new file mode 100644 index 00000000..2a11e1cb --- /dev/null +++ b/wiki-information/functions/GetDefaultScale.md @@ -0,0 +1,18 @@ +## Title: GetDefaultScale + +**Content:** +Returns the default UI scaling value for the current screen size. +`scale = GetDefaultScale()` + +**Returns:** +- `scale` + - *number* - The default scale for the UI as a floating point value. + +**Usage:** +The below example creates an unparented frame that will always render at a size of 300x300 pixels. The scale of the frame is managed through the inherited DefaultScaleFrame template, which internally uses this API to apply the correct scale to the frame if the screen size changes. +```lua +UnscaledFrame = CreateFrame("Frame", nil, nil, "BackdropTemplate, DefaultScaleFrame") +UnscaledFrame:SetPoint("CENTER") +UnscaledFrame:SetSize(300, 300) +UnscaledFrame:SetBackdrop({ bgFile = "" }) +``` \ No newline at end of file diff --git a/wiki-information/functions/GetDetailedItemLevelInfo.md b/wiki-information/functions/GetDetailedItemLevelInfo.md new file mode 100644 index 00000000..399af901 --- /dev/null +++ b/wiki-information/functions/GetDetailedItemLevelInfo.md @@ -0,0 +1,30 @@ +## Title: GetDetailedItemLevelInfo + +**Content:** +Returns detailed item level info. +`effectiveILvl, isPreview, baseILvl = GetDetailedItemLevelInfo(itemID or itemString or itemName or itemLink)` + +**Parameters:** +One of the following four ways to specify which item to query: +- `itemId` + - *number* - Numeric ID of the item. e.g. 30234 for +- `itemName` + - *string* - Name of an item owned by the player at some point during this play session, e.g. "Nordrassil Wrath-Kilt". +- `itemString` + - *string* - A fragment of the itemString for the item, e.g. "item:30234:0:0:0:0:0:0:0" or "item:30234". +- `itemLink` + - *string* - The full itemLink. + +**Returns:** +- `effectiveILvl` + - *number* - same as in tooltip. +- `isPreview` + - *boolean* - True means it would have a + in the tooltip, a minimal level for item used in loot preview in encounter journal +- `baseILvl` + - *number* - base item level + +**Description:** +- `effectiveLevel`: + - matches all the upgrades (WF/TF) applied to item + - does not show scaling down in timewalking instances - i.e. matches number in parenthesis in tooltip + - does not show correct item level for artifact off-hand items - it always stays as 750 instead of matching main hand \ No newline at end of file diff --git a/wiki-information/functions/GetDifficultyInfo.md b/wiki-information/functions/GetDifficultyInfo.md new file mode 100644 index 00000000..9212d8ac --- /dev/null +++ b/wiki-information/functions/GetDifficultyInfo.md @@ -0,0 +1,37 @@ +## Title: GetDifficultyInfo + +**Content:** +Returns information about a difficulty. +`name, groupType, isHeroic, isChallengeMode, displayHeroic, displayMythic, toggleDifficultyID, isLFR, minPlayers, maxPlayers = GetDifficultyInfo(id)` + +**Parameters:** +- `id` + - *number* - difficulty ID to query, ascending from 1. + +**Returns:** +- `name` + - *string* - Difficulty name, e.g. "10 Player (Heroic)" +- `groupType` + - *string* - Group type appropriate for this difficulty; "party" or "raid". +- `isHeroic` + - *boolean* - true if this is a heroic difficulty, false otherwise. +- `isChallengeMode` + - *boolean* - true if this is challenge mode difficulty, false otherwise. +- `displayHeroic` + - *boolean* - display the Heroic skull icon on the instance banner of the minimap +- `displayMythic` + - *boolean* - display the Mythic skull icon on the instance banner of the minimap +- `toggleDifficultyID` + - *number* - difficulty ID of the corresponding heroic/non-heroic difficulty for 10/25-man raids, if one exists. +- `isLFR` + - *boolean* - true if this is looking for raid difficulty, false otherwise. +- `minPlayers` + - *number* - minimum players needed. +- `maxPlayers` + - *number* - maximum players allowed. + +**Reference:** +- `DifficultyID` (a list of possible difficultyIDs) +- `SetDungeonDifficultyID` +- `GetInstanceInfo` +- `GetRaidDifficultyID` \ No newline at end of file diff --git a/wiki-information/functions/GetDodgeChance.md b/wiki-information/functions/GetDodgeChance.md new file mode 100644 index 00000000..6edd08d7 --- /dev/null +++ b/wiki-information/functions/GetDodgeChance.md @@ -0,0 +1,16 @@ +## Title: GetDodgeChance + +**Content:** +Returns the dodge chance percentage. +`dodgeChance = GetDodgeChance()` + +**Returns:** +- `dodgeChance` + - *number* - Player's dodge chance in percentage. + +**Reference:** +- `GetBlockChance` +- `GetCritChance` +- `GetParryChance` +- `GetCombatRating` +- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetDodgeChanceFromAttribute.md b/wiki-information/functions/GetDodgeChanceFromAttribute.md new file mode 100644 index 00000000..51c7eb20 --- /dev/null +++ b/wiki-information/functions/GetDodgeChanceFromAttribute.md @@ -0,0 +1,9 @@ +## Title: GetDodgeChanceFromAttribute + +**Content:** +Needs summary. +`dodgeChance = GetDodgeChanceFromAttribute()` + +**Returns:** +- `dodgeChance` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetDownloadedPercentage.md b/wiki-information/functions/GetDownloadedPercentage.md new file mode 100644 index 00000000..5fc98680 --- /dev/null +++ b/wiki-information/functions/GetDownloadedPercentage.md @@ -0,0 +1,9 @@ +## Title: GetDownloadedPercentage + +**Content:** +Needs summary. +`result = GetDownloadedPercentage()` + +**Returns:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetDungeonDifficultyID.md b/wiki-information/functions/GetDungeonDifficultyID.md new file mode 100644 index 00000000..fdc0a195 --- /dev/null +++ b/wiki-information/functions/GetDungeonDifficultyID.md @@ -0,0 +1,15 @@ +## Title: GetDungeonDifficultyID + +**Content:** +Returns the selected dungeon difficulty. +`difficultyID = GetDungeonDifficultyID()` + +**Returns:** +- `difficultyID` + - *number* : The player's (or group leader's) current dungeon difficulty ID preference. + +**Reference:** +- [DifficultyID](https://wowpedia.fandom.com/wiki/DifficultyID) (a list of possible difficultyIDs) +- [GetDifficultyInfo](https://wowpedia.fandom.com/wiki/API_GetDifficultyInfo) +- [SetDungeonDifficultyID](https://wowpedia.fandom.com/wiki/API_SetDungeonDifficultyID) +- [GetRaidDifficultyID](https://wowpedia.fandom.com/wiki/API_GetRaidDifficultyID) \ No newline at end of file diff --git a/wiki-information/functions/GetEditBoxMetatable.md b/wiki-information/functions/GetEditBoxMetatable.md new file mode 100644 index 00000000..bd8302b6 --- /dev/null +++ b/wiki-information/functions/GetEditBoxMetatable.md @@ -0,0 +1,12 @@ +## Title: GetEditBoxMetatable + +**Content:** +Returns the metatable used by EditBox objects. +`metatable = GetEditBoxMetatable()` + +**Returns:** +- `metatable` + - *table* - The metatable used by EditBox objects. + +**Description:** +The metatable returned by this function is shared between all non-forbidden EditBox object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetEventTime.md b/wiki-information/functions/GetEventTime.md new file mode 100644 index 00000000..b458218d --- /dev/null +++ b/wiki-information/functions/GetEventTime.md @@ -0,0 +1,19 @@ +## Title: GetEventTime + +**Content:** +Needs summary. +`totalElapsedTime, numExecutedHandlers, slowestHandlerName, slowestHandlerTime = GetEventTime(eventProfileIndex)` + +**Parameters:** +- `eventProfileIndex` + - *number* + +**Returns:** +- `totalElapsedTime` + - *number* +- `numExecutedHandlers` + - *number* +- `slowestHandlerName` + - *string* +- `slowestHandlerTime` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetExpansionDisplayInfo.md b/wiki-information/functions/GetExpansionDisplayInfo.md new file mode 100644 index 00000000..db29755c --- /dev/null +++ b/wiki-information/functions/GetExpansionDisplayInfo.md @@ -0,0 +1,64 @@ +## Title: GetExpansionDisplayInfo + +**Content:** +Returns the logo and banner textures for an expansion id. +`info = GetExpansionDisplayInfo(expansionLevel)` + +**Parameters:** +- `expansionLevel` + - *number* + - `NUM_LE_EXPANSION_LEVELS` + - **Value** + - **Enum** + - **Description** + - `LE_EXPANSION_LEVEL_CURRENT` + - 0 + - `LE_EXPANSION_CLASSIC` + - Vanilla / Classic Era + - `LE_EXPANSION_BURNING_CRUSADE` + - The Burning Crusade + - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` + - Wrath of the Lich King + - `LE_EXPANSION_CATACLYSM` + - Cataclysm + - `LE_EXPANSION_MISTS_OF_PANDARIA` + - Mists of Pandaria + - `LE_EXPANSION_WARLORDS_OF_DRAENOR` + - Warlords of Draenor + - `LE_EXPANSION_LEGION` + - Legion + - `LE_EXPANSION_BATTLE_FOR_AZEROTH` + - Battle for Azeroth + - `LE_EXPANSION_SHADOWLANDS` + - Shadowlands + - `LE_EXPANSION_DRAGONFLIGHT` + - Dragonflight + - `LE_EXPANSION_11_0` + +**Returns:** +- `info` + - *ExpansionDisplayInfo?* + - **Field** + - **Type** + - **Description** + - `logo` + - *number* + - `banner` + - *string* + - `features` + - *ExpansionDisplayInfoFeature* + - `highResBackgroundID` + - *number* + - Added in 10.0.0 + - `lowResBackgroundID` + - *number* + - Added in 10.0.0 + +**ExpansionDisplayInfoFeature:** +- **Field** +- **Type** +- **Description** +- `icon` + - *number* +- `text` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/GetExpansionLevel.md b/wiki-information/functions/GetExpansionLevel.md new file mode 100644 index 00000000..0d56e589 --- /dev/null +++ b/wiki-information/functions/GetExpansionLevel.md @@ -0,0 +1,53 @@ +## Title: GetExpansionLevel + +**Content:** +Returns the expansion level currently accessible by the player. +`expansionLevel = GetExpansionLevel()` + +**Returns:** +- `expansionLevel` + - *number* - The newest expansion currently accessible by the player. + - `NUM_LE_EXPANSION_LEVELS` + - `Value` + - `Enum` + - `Description` + - `LE_EXPANSION_LEVEL_CURRENT` + - 0 + - `LE_EXPANSION_CLASSIC` + - Vanilla / Classic Era + - `LE_EXPANSION_BURNING_CRUSADE` + - The Burning Crusade + - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` + - Wrath of the Lich King + - `LE_EXPANSION_CATACLYSM` + - Cataclysm + - `LE_EXPANSION_MISTS_OF_PANDARIA` + - Mists of Pandaria + - `LE_EXPANSION_WARLORDS_OF_DRAENOR` + - Warlords of Draenor + - `LE_EXPANSION_LEGION` + - Legion + - `LE_EXPANSION_BATTLE_FOR_AZEROTH` + - Battle for Azeroth + - `LE_EXPANSION_SHADOWLANDS` + - Shadowlands + - `LE_EXPANSION_DRAGONFLIGHT` + - Dragonflight + - `LE_EXPANSION_11_0` + - The War Within + +**Description:** +Trial/Starter accounts are automatically upgraded to the second to last expansion. +Updated after `UPDATE_EXPANSION_LEVEL` fires. + +**Usage:** +Before and after the Shadowlands global launch on November 23, 2020, at 3:00 p.m. PST. Requires the player to have pre-ordered/purchased the expansion. +```lua +/dump GetExpansionLevel() -- 7 -> 8 +/dump GetAccountExpansionLevel() -- 8 +/dump GetServerExpansionLevel() -- 7 -> 8 +``` +This API is equivalent to: +```lua +GetExpansionLevel() == min(GetAccountExpansionLevel(), GetServerExpansionLevel()) +``` \ No newline at end of file diff --git a/wiki-information/functions/GetExpansionTrialInfo.md b/wiki-information/functions/GetExpansionTrialInfo.md new file mode 100644 index 00000000..6b906c92 --- /dev/null +++ b/wiki-information/functions/GetExpansionTrialInfo.md @@ -0,0 +1,11 @@ +## Title: GetExpansionTrialInfo + +**Content:** +Needs summary. +`isExpansionTrialAccount, expansionTrialRemainingSeconds = GetExpansionTrialInfo()` + +**Returns:** +- `isExpansionTrialAccount` + - *boolean* +- `expansionTrialRemainingSeconds` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetExpertise.md b/wiki-information/functions/GetExpertise.md new file mode 100644 index 00000000..4f6ab0b3 --- /dev/null +++ b/wiki-information/functions/GetExpertise.md @@ -0,0 +1,19 @@ +## Title: GetExpertise + +**Content:** +Returns the player's expertise percentage for main hand, offhand, and ranged attacks. +`mainhandExpertise, offhandExpertise, rangedExpertise = GetExpertise()` + +**Returns:** +- `mainhandExpertise` + - *number* - Expertise percentage for swings with your main hand weapon. +- `offhandExpertise` + - *number* - Expertise percentage for swings with your offhand weapon. +- `rangedExpertise` + - *number* - Expertise percentage for your ranged weapon. + +**Description:** +Expertise reduces the chance that the player's attacks are dodged or parried by an enemy. This function returns the amount of percentage points Expertise reduces the dodge/parry chance by (e.g. a return value of 3.5 means a 3.5% reduction to both dodge and parry probabilities). + +**Reference:** +`GetCombatRating(CR_EXPERTISE)` \ No newline at end of file diff --git a/wiki-information/functions/GetExpertisePercent.md b/wiki-information/functions/GetExpertisePercent.md new file mode 100644 index 00000000..9347c2f9 --- /dev/null +++ b/wiki-information/functions/GetExpertisePercent.md @@ -0,0 +1,14 @@ +## Title: GetExpertisePercent + +**Content:** +Returns your current expertise reduction to chance to be dodged or parried, in percent. +`expertisePercent, offhandExpertisePercent = GetExpertisePercent()` + +**Returns:** +- `expertisePercent` + - *number* - Percentage reduction in dodge and parry chances for swings with your main hand weapon. +- `offhandExpertisePercent` + - *number* - Percentage reduction in dodge and parry chances for swings with your offhand weapon. + +**Reference:** +- `GetExpertise()` \ No newline at end of file diff --git a/wiki-information/functions/GetFactionInfo.md b/wiki-information/functions/GetFactionInfo.md new file mode 100644 index 00000000..abebb777 --- /dev/null +++ b/wiki-information/functions/GetFactionInfo.md @@ -0,0 +1,104 @@ +## Title: GetFactionInfo + +**Content:** +Returns info for a faction. +```lua +name, description, standingID, barMin, barMax, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus += GetFactionInfo(factionIndex) += GetFactionInfoByID(factionID) +``` + +**Parameters:** +- **GetFactionInfo:** + - `factionIndex` + - *number* - Index from the currently displayed row in the player's reputation pane, including headers but excluding factions that are hidden because their parent header is collapsed. + +- **GetFactionInfoByID:** + - `factionID` + - *number* - FactionID + +**Returns:** +1. `name` + - *string* - Name of the faction +2. `description` + - *string* - Description as shown in the detail pane that appears when you click on the faction row +3. `standingID` + - *number* - StandingId representing the current standing (e.g., 4 for Neutral, 5 for Friendly). +4. `barMin` + - *number* - Minimum reputation since beginning of Neutral to reach the current standing. +5. `barMax` + - *number* - Maximum reputation since the beginning of Neutral before graduating to the next standing. +6. `barValue` + - *number* - Total reputation earned with the faction versus 0 at the beginning of Neutral. +7. `atWarWith` + - *boolean* - True if the player is at war with the faction +8. `canToggleAtWar` + - *boolean* - True if the player can toggle the "At War" checkbox +9. `isHeader` + - *boolean* - True if the faction is a header (collapsible group title) +10. `isCollapsed` + - *boolean* - True if the faction is a header and is currently collapsed +11. `hasRep` + - *boolean* - True if the faction is a header and has its own reputation (e.g., The Tillers) +12. `isWatched` + - *boolean* - True if the "Show as Experience Bar" checkbox for the faction is currently checked +13. `isChild` + - *boolean* - True if the faction is a second-level header (e.g., Sholazar Basin) or is the child of a second-level header (e.g., The Oracles) +14. `factionID` + - *number* - Unique FactionID. +15. `hasBonusRepGain` + - *boolean* - True if the player has purchased a Grand Commendation to unlock bonus reputation gains with this faction +16. `canSetInactive` + - *boolean* + +**Description:** +- **Headers:** + - Top-level headers (e.g., Cataclysm or Classic) return values for standingID, barMin, and barMax as if the player were at 0/3000 Neutral with a faction (4, 0, and 3000 respectively) except for the Inactive header, which returns values of 0. + - Other headers that do not have their own reputation (e.g., Sholazar Basin or Steamwheedle Cartel) return values for their child faction with which the player has the highest reputation. For example, if the player is 999/1000 Exalted with Booty Bay, 2900/21000 Revered with Everlook, 5300/12000 Honored with Gadgetzan, and 10/6000 Friendly with Ratchet, querying the Steamwheedle Cartel header will return the standingId, barMin, and barMax values for Booty Bay. + +- **Total Reputation:** + - Within the game, reputation is shown as a formatted value of XXXX/YYYYY (e.g., 1234/12000) but outside of the reputation tab these values are not available directly. The game uses a flat value for reputation. + - The earnedValue returned by `GetFactionInfo()` is NOT the value on your reputation bars, but instead the distance your reputation has moved from 0 (1/3000 Neutral). All reputations given by the game are simply the number of reputation points from the 0 point, Neutral and above are positive reputations, anything below Neutral is a negative value and must be treated as such for any reputation calculations. + + - **Game Value Breakdown:** + - 1/3000 Neutral: Earned Value = 1 + - 1600/6000 Friendly: Earned Value = 4600 (3000 + 1600) + - 11000/12000 Honored: Earned Value = 20000 (3000 + 6000 + 11000) + - 1400/3000 Unfriendly: Earned Value = -1600 + - 2500/3000 Hostile: Earned Value = -3500 (-3000 + -500) + + - Notice that for negative reputation, the Earned value is how far below 0 your reputation is, not how far till Hated or Exalted. + +**Usage:** +Prints the name and total reputation earned for every faction currently displayed in the player's reputation pane: +```lua +for factionIndex = 1, GetNumFactions() do + local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, + isHeader, isCollapsed, hasRep, isWatched, isChild, factionID = GetFactionInfo(factionIndex) + if hasRep or not isHeader then + DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) + end +end +``` + +Prints the name and total reputation for all factions: +```lua +local numFactions = GetNumFactions() +local factionIndex = 1 +while (factionIndex <= numFactions) do + local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, + isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfo(factionIndex) + if isHeader and isCollapsed then + ExpandFactionHeader(factionIndex) + numFactions = GetNumFactions() + end + if hasRep or not isHeader then + DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) + end + factionIndex = factionIndex + 1 +end +``` + +**Reference:** +- `GetFriendshipReputation()` +- `GetFriendshipReputationRanks()` \ No newline at end of file diff --git a/wiki-information/functions/GetFactionInfoByID.md b/wiki-information/functions/GetFactionInfoByID.md new file mode 100644 index 00000000..1d80152f --- /dev/null +++ b/wiki-information/functions/GetFactionInfoByID.md @@ -0,0 +1,103 @@ +## Title: GetFactionInfo + +**Content:** +Returns info for a faction. +```lua +name, description, standingID, barMin, barMax, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfo(factionIndex) +name, description, standingID, barMin, barMax, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfoByID(factionID) +``` + +**Parameters:** +- **GetFactionInfo:** + - `factionIndex` + - *number* - Index from the currently displayed row in the player's reputation pane, including headers but excluding factions that are hidden because their parent header is collapsed. + +- **GetFactionInfoByID:** + - `factionID` + - *number* - FactionID + +**Returns:** +1. `name` + - *string* - Name of the faction +2. `description` + - *string* - Description as shown in the detail pane that appears when you click on the faction row +3. `standingID` + - *number* - StandingId representing the current standing (e.g., 4 for Neutral, 5 for Friendly). +4. `barMin` + - *number* - Minimum reputation since beginning of Neutral to reach the current standing. +5. `barMax` + - *number* - Maximum reputation since the beginning of Neutral before graduating to the next standing. +6. `barValue` + - *number* - Total reputation earned with the faction versus 0 at the beginning of Neutral. +7. `atWarWith` + - *boolean* - True if the player is at war with the faction +8. `canToggleAtWar` + - *boolean* - True if the player can toggle the "At War" checkbox +9. `isHeader` + - *boolean* - True if the faction is a header (collapsible group title) +10. `isCollapsed` + - *boolean* - True if the faction is a header and is currently collapsed +11. `hasRep` + - *boolean* - True if the faction is a header and has its own reputation (e.g., The Tillers) +12. `isWatched` + - *boolean* - True if the "Show as Experience Bar" checkbox for the faction is currently checked +13. `isChild` + - *boolean* - True if the faction is a second-level header (e.g., Sholazar Basin) or is the child of a second-level header (e.g., The Oracles) +14. `factionID` + - *number* - Unique FactionID. +15. `hasBonusRepGain` + - *boolean* - True if the player has purchased a Grand Commendation to unlock bonus reputation gains with this faction +16. `canSetInactive` + - *boolean* + +**Description:** +- **Headers:** + - Top-level headers (e.g., Cataclysm or Classic) return values for standingID, barMin, and barMax as if the player were at 0/3000 Neutral with a faction (4, 0, and 3000 respectively) except for the Inactive header, which returns values of 0. + - Other headers that do not have their own reputation (e.g., Sholazar Basin or Steamwheedle Cartel) return values for their child faction with which the player has the highest reputation. For example, if the player is 999/1000 Exalted with Booty Bay, 2900/21000 Revered with Everlook, 5300/12000 Honored with Gadgetzan, and 10/6000 Friendly with Ratchet, querying the Steamwheedle Cartel header will return the standingId, barMin, and barMax values for Booty Bay. + +- **Total Reputation:** + - Within the game, reputation is shown as a formatted value of XXXX/YYYYY (e.g., 1234/12000) but outside of the reputation tab these values are not available directly. The game uses a flat value for reputation. + - The earnedValue returned by `GetFactionInfo()` is NOT the value on your reputation bars, but instead the distance your reputation has moved from 0 (1/3000 Neutral). All reputations given by the game are simply the number of reputation points from the 0 point, Neutral and above are positive reputations, anything below Neutral is a negative value and must be treated as such for any reputation calculations. + + - **Game Value Breakdown:** + - 1/3000 Neutral: 1 + - 1600/6000 Friendly: 4600 (3000 + 1600) + - 11000/12000 Honored: 20000 (3000 + 6000 + 11000) + - 1400/3000 Unfriendly: -1600 + - 2500/3000 Hostile: -3500 (3000 + -500) + + - Notice that for negative reputation, the Earned value is how far below 0 your reputation is, not how far till Hated or Exalted. + +**Usage:** +Prints the name and total reputation earned for every faction currently displayed in the player's reputation pane: +```lua +for factionIndex = 1, GetNumFactions() do + local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, + isHeader, isCollapsed, hasRep, isWatched, isChild, factionID = GetFactionInfo(factionIndex) + if hasRep or not isHeader then + DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) + end +end +``` + +Prints the name and total reputation for all factions: +```lua +local numFactions = GetNumFactions() +local factionIndex = 1 +while (factionIndex <= numFactions) do + local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, + isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfo(factionIndex) + if isHeader and isCollapsed then + ExpandFactionHeader(factionIndex) + numFactions = GetNumFactions() + end + if hasRep or not isHeader then + DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) + end + factionIndex = factionIndex + 1 +end +``` + +**Reference:** +- `GetFriendshipReputation()` +- `GetFriendshipReputationRanks()` \ No newline at end of file diff --git a/wiki-information/functions/GetFileIDFromPath.md b/wiki-information/functions/GetFileIDFromPath.md new file mode 100644 index 00000000..6b4933e7 --- /dev/null +++ b/wiki-information/functions/GetFileIDFromPath.md @@ -0,0 +1,27 @@ +## Title: GetFileIDFromPath + +**Content:** +Returns the FileID for an Interface file path. +`fileID = GetFileIDFromPath(filePath)` + +**Parameters:** +- `filePath` + - *string* - The path to a game file. For example `Interface/Icons/Temp.blp` + +**Returns:** +- `fileID` + - *number* : FileID - The internal ID corresponding to the file path. Negative integers are temporary IDs; these are not specified in the CASC root file and may change when the client is restarted. + +**Usage:** +- Interface/ path + ```lua + /dump GetFileIDFromPath("Interface/Icons/Temp") -- 136235 + ``` +- Custom file path + ```lua + /dump GetFileIDFromPath("Interface/testimg.jpg") -- -1163 + /dump GetFileIDFromPath("hello/test.jpg") -- -2 + ``` + +**Reference:** +- [#wowuidev 2019-04-23](https://infobot.rikers.org/%23wowuidev/20190423.html.gz) \ No newline at end of file diff --git a/wiki-information/functions/GetFileStreamingStatus.md b/wiki-information/functions/GetFileStreamingStatus.md new file mode 100644 index 00000000..8ff1b367 --- /dev/null +++ b/wiki-information/functions/GetFileStreamingStatus.md @@ -0,0 +1,9 @@ +## Title: GetFileStreamingStatus + +**Content:** +Needs summary. +`result = GetFileStreamingStatus()` + +**Returns:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetFirstBagBankSlotIndex.md b/wiki-information/functions/GetFirstBagBankSlotIndex.md new file mode 100644 index 00000000..7a2e4634 --- /dev/null +++ b/wiki-information/functions/GetFirstBagBankSlotIndex.md @@ -0,0 +1,12 @@ +## Title: GetFirstBagBankSlotIndex + +**Content:** +Returns the index of the first bag slot within the bank container. +`index = GetFirstBagBankSlotIndex()` + +**Returns:** +- `index` + - *number* - The slot index of the first bank bag. + +**Description:** +This function was added to resolve an inconsistency with the value of the `NUM_BANKGENERIC_SLOTS` constant and the actual slot index assigned to the first bank bag. On Classic Era, this constant is defined as 24 matching the number of displayed item slots in the bank frame, however, bag slots start at index 28 as they do on Burning Crusade Classic. \ No newline at end of file diff --git a/wiki-information/functions/GetFirstTradeSkill.md b/wiki-information/functions/GetFirstTradeSkill.md new file mode 100644 index 00000000..e0154869 --- /dev/null +++ b/wiki-information/functions/GetFirstTradeSkill.md @@ -0,0 +1,12 @@ +## Title: GetFirstTradeSkill + +**Content:** +Returns the index of the first non-header trade skill entry. +`skillId = GetFirstTradeSkill()` + +**Parameters:** +- `()` + +**Returns:** +- `skillId` + - *number* - The ID of the first visible non-header trade skill entry. \ No newline at end of file diff --git a/wiki-information/functions/GetFontInfo.md b/wiki-information/functions/GetFontInfo.md new file mode 100644 index 00000000..e6b1817b --- /dev/null +++ b/wiki-information/functions/GetFontInfo.md @@ -0,0 +1,52 @@ +## Title: GetFontInfo + +**Content:** +Returns a structured table of information about the given font object. +`fontInfo = GetFontInfo(font)` + +**Parameters:** +- `font` + - *Font🔗|string* - Either a font object or the name of a global font object. + +**Returns:** +- `fontInfo` + - *FontInfo* + - `Field` + - `Type` + - `Description` + - `height` + - *number* - Height (size) of the font object + - `outline` + - *string* - Comma delimited list of font flags such as OUTLINE, THICKOUTLINE, and MONOCHROME + - `color` + - *ColorInfo* - Table of color values for the font object + - `shadow` + - *FontShadow?* - Optional table of shadow information for the font object + - `FontShadow` + - `Field` + - `Type` + - `Description` + - `x` + - *number* - Horizontal offset for the shadow + - `y` + - *number* - Vertical offset for the shadow + - `color` + - *ColorInfo* - Table of color values for the shadow + - `ColorInfo` + - `Field` + - `Type` + - `Description` + - `r` + - *number* + - `g` + - *number* + - `b` + - *number* + - `a` + - *number* + +**Description:** +If a font has no outline or monochrome flags applied, the outline field in the returned table will always be an empty string. + +**Reference:** +GetFonts \ No newline at end of file diff --git a/wiki-information/functions/GetFontStringMetatable.md b/wiki-information/functions/GetFontStringMetatable.md new file mode 100644 index 00000000..3fd922b4 --- /dev/null +++ b/wiki-information/functions/GetFontStringMetatable.md @@ -0,0 +1,12 @@ +## Title: GetFontStringMetatable + +**Content:** +Returns the metatable used by FontString objects. +`metatable = GetFontStringMetatable()` + +**Returns:** +- `metatable` + - *table* - The metatable used by FontString objects. + +**Description:** +The metatable returned by this function is shared between all non-forbidden FontString object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetFonts.md b/wiki-information/functions/GetFonts.md new file mode 100644 index 00000000..b9b30ddb --- /dev/null +++ b/wiki-information/functions/GetFonts.md @@ -0,0 +1,16 @@ +## Title: GetFonts + +**Content:** +Returns a list of available fonts. +`fonts = GetFonts()` + +**Returns:** +- `fonts` + - *string* - a table containing font object names. + +**Description:** +The names in the returned table may correspond to globally accessible font objects of the same name. +The names in the returned table can be used in conjunction with `GetFontInfo` to query font attributes such as sizing or coloring information. + +**Reference:** +- `GetFontInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetFrameCPUUsage.md b/wiki-information/functions/GetFrameCPUUsage.md new file mode 100644 index 00000000..7536159e --- /dev/null +++ b/wiki-information/functions/GetFrameCPUUsage.md @@ -0,0 +1,24 @@ +## Title: GetFrameCPUUsage + +**Content:** +Returns the total time used by and number of calls of a frame's event handlers. +`time, count = GetFrameCPUUsage(frame)` + +**Parameters:** +- `frame` + - *Frame* - Specifies the frame. +- `includeChildren` + - *boolean* - If false, only event handlers of the specified frame are considered. If true or omitted, the values returned will include the handlers for all of the frame's children as well. + +**Returns:** +- `time` + - *number* - The total time used by the specified event handlers, in milliseconds. +- `count` + - *number* - The total number of times the event handlers were called. + +**Description:** +The values returned are just the sum of the values returned by `GetFunctionCPUUsage(handler)` for all current handlers. This means that it's not per-frame values, but per-function values. The difference is that if, for example, an `OnEvent` handler is used by two frames A and B, and, say, `B:OnEvent()` is called, both A and B get blamed for it. + +It also means that if a frame's handlers change, the CPU used by the previous handlers is ignored, because only the current handlers are considered. + +Note that `OnUpdate` CPU usage is NOT included at all (tested at 6.0.3). \ No newline at end of file diff --git a/wiki-information/functions/GetFrameMetatable.md b/wiki-information/functions/GetFrameMetatable.md new file mode 100644 index 00000000..fb9ebcc1 --- /dev/null +++ b/wiki-information/functions/GetFrameMetatable.md @@ -0,0 +1,12 @@ +## Title: GetFrameMetatable + +**Content:** +Returns the metatable used by Frame objects. +`metatable = GetFrameMetatable()` + +**Returns:** +- `metatable` + - *table* - The metatable used by Frame objects. + +**Description:** +The metatable returned by this function is shared between all non-forbidden Frame object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetFramerate.md b/wiki-information/functions/GetFramerate.md new file mode 100644 index 00000000..ed0f2778 --- /dev/null +++ b/wiki-information/functions/GetFramerate.md @@ -0,0 +1,20 @@ +## Title: GetFramerate + +**Content:** +Returns the current framerate. +`framerate = GetFramerate()` + +**Returns:** +- `framerate` + - *number* - The current framerate in frames per second. + +**Usage:** +```lua +local framerate = GetFramerate() +print("Your current framerate is "..floor(framerate).." fps") +``` + +**Description:** +Notice the returned value adjusts slowly when the FPS quickly drops from 60 to 6, for example. If the FPS drops very fast, this function will be decreasing to 40, 20, 15, etc, for the next couple of seconds until it reaches 6. This delay means it is not as accurate as third-party FPS programs, but still functional. Alternatively, no delay is seen when the FPS is increased quickly. + +You can also toggle the Framerate Display with `ToggleFramerate` (normally the Ctrl-R hotkey). You can also see the same framerate in the tooltip of the GameMenu button on the main action bar. \ No newline at end of file diff --git a/wiki-information/functions/GetFramesRegisteredForEvent.md b/wiki-information/functions/GetFramesRegisteredForEvent.md new file mode 100644 index 00000000..514c6574 --- /dev/null +++ b/wiki-information/functions/GetFramesRegisteredForEvent.md @@ -0,0 +1,35 @@ +## Title: GetFramesRegisteredForEvent + +**Content:** +Returns all frames registered for the specified event, in dispatch order. +`frame1, frame2, ... = GetFramesRegisteredForEvent(event)` + +**Parameters:** +- `event` + - *string* - Event for which to return registered frames, e.g. "PLAYER_LOGOUT" + +**Returns:** +- `frame1, ...` + - *Widget* - widget registered for the specified event. + +**Description:** +The first frame returned will be the first to receive the given event, and likewise the last returned will receive the event last. A frame can be moved to the end of this event list order by unregistering and then reregistering for the event. +Currently, frames registered via `Frame:RegisterAllEvents` will be returned before all other frames, but they will actually receive events last (as they are used to profile the normal frames' handlers). This suggests that the above ordering is not always reliable. (Last checked 8.3.7) + +**Usage:** +The snippet below unregisters the PLAYER_LOGOUT events from every frame listening for it: +```lua +local function unregister(event, widget, ...) + if widget then + widget:UnregisterEvent(event) + return unregister(event, ...) + end +end +unregister("PLAYER_LOGOUT", GetFramesRegisteredForEvent("PLAYER_LOGOUT")) +``` + +**Example Use Case:** +This function can be used in debugging or addon development to understand which frames are listening for a specific event and in what order they will receive the event. This can be particularly useful when troubleshooting event handling issues or optimizing event dispatching. + +**Addon Usage:** +Large addons like ElvUI or WeakAuras might use this function to manage event handling more efficiently, ensuring that their frames are registered and unregistered for events in the correct order to avoid conflicts and ensure optimal performance. \ No newline at end of file diff --git a/wiki-information/functions/GetFunctionCPUUsage.md b/wiki-information/functions/GetFunctionCPUUsage.md new file mode 100644 index 00000000..8e0af95d --- /dev/null +++ b/wiki-information/functions/GetFunctionCPUUsage.md @@ -0,0 +1,20 @@ +## Title: GetFunctionCPUUsage + +**Content:** +Returns information about CPU usage by a function. +`usage, calls = GetFunctionCPUUsage(func, includeSubroutines)` + +**Parameters:** +- `func` + - *function* - The function to query CPU usage for. +- `includeSubroutines` + - *boolean* - Whether to include subroutine calls in the CPU usage calculation. + +**Returns:** +- `usage` + - *number* - The amount of CPU time used by the function. +- `calls` + - *number* - The number of times the function has been called. + +**Description:** +Only returns valid data if the `scriptProfile` CVar is set to 1; returns 0 otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetGameTime.md b/wiki-information/functions/GetGameTime.md new file mode 100644 index 00000000..8b604df9 --- /dev/null +++ b/wiki-information/functions/GetGameTime.md @@ -0,0 +1,44 @@ +## Title: GetGameTime + +**Content:** +Returns the realm's current time in hours and minutes. +`hours, minutes = GetGameTime()` + +**Returns:** +- `hours` + - *number* - The current hour (0-23). +- `minutes` + - *number* - The minutes passed in the current hour (0-59). + +**Description:** +This function can unexpectedly return results inconsistent with actual realm server time. The value returned is from the physical instance server you are actually playing on, and not that of the world instance server (realm server) you log into. Servers for instances such as for raids and PvP are often shared between login world servers, and instance servers are not always running using the same timezone as the login realm server. This is particularly noticeable for Oceanic and other low population world servers. + +**Usage:** +```lua +/dump GetGameTime() -- 18, 41 +``` + +**Miscellaneous:** +When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. +```lua +-- unix time +time() -- 1596157547 +GetServerTime() -- 1596157549 +-- local time, same as `date(nil, time())` +date() -- "Fri Jul 31 03:05:47 2020" +-- realm time +GetGameTime() -- 20, 4 +C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 +C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) +``` + +**Reference:** +- `time()` +- `GetTime()` + +### Example Usage +This function can be used in addons to display the current realm time, which can be useful for scheduling events or displaying time-sensitive information. + +### Addons Using This Function +- **DBM (Deadly Boss Mods):** Uses `GetGameTime` to synchronize raid timers with the realm time. +- **ElvUI:** Utilizes `GetGameTime` to display the current realm time on the user interface. \ No newline at end of file diff --git a/wiki-information/functions/GetGlyphLink.md b/wiki-information/functions/GetGlyphLink.md new file mode 100644 index 00000000..7095241b --- /dev/null +++ b/wiki-information/functions/GetGlyphLink.md @@ -0,0 +1,31 @@ +## Title: GetGlyphLink + +**Content:** +Returns a link to a glyph specified by index and talent group. +`link = GetGlyphLink(index)` + +**Parameters:** +- `index` + - *number* - Ranging from 1 to 6, the glyph's index. See Notes for more information. +- `talentGroup` + - *number?* - Optional, ranging from 1 (primary) to 2 (secondary) the talent group to query. Defaults to the currently active talent group. + +**Returns:** +- `link` + - *string* - The link to the glyph if it's populated, otherwise empty string. + +**Notes and Caveats:** +The indices are not in a logical order, see table and gallery picture below for reference. + +**Glyph indices:** +| Index | Glyph type | Level to unlock | +|-------|-------------|-----------------| +| 1 | Major | 15 | +| 2 | Minor | 15 | +| 3 | Minor | 50 | +| 4 | Major | 30 | +| 5 | Minor | 70 | +| 6 | Major | 80 | + +**Miscellaneous:** +Indices for each glyph slot \ No newline at end of file diff --git a/wiki-information/functions/GetGlyphSocketInfo.md b/wiki-information/functions/GetGlyphSocketInfo.md new file mode 100644 index 00000000..924353a9 --- /dev/null +++ b/wiki-information/functions/GetGlyphSocketInfo.md @@ -0,0 +1,23 @@ +## Title: GetGlyphSocketInfo + +**Content:** +Returns information on a glyph socket. +`enabled, glyphType, glyphSpellID, iconFile = GetGlyphSocketInfo(socketID)` + +**Parameters:** +- `socketID` + - *number* - The socket index to query, ranging from 1 through NUM_GLYPH_SLOTS. +- `talentGroup` + - *number?* - The talent specialization group to query. Defaults to 1. + +**Returns:** +- `enabled` + - *boolean* - True if the socket has a glyph inserted. +- `glyphType` + - *number* - The type of glyph accepted by this socket. Either 1 Major, 2 Minor, or 3 Prime. +- `glyphIndex` + - *number* - The socket's index for the glyph type. Either 0, 1, 2. +- `glyphSpellID` + - *number?* - The spell ID of the socketed glyph. +- `iconFile` + - *number?* - FileID - The file ID of the sigil icon associated with the socketed glyph. \ No newline at end of file diff --git a/wiki-information/functions/GetGossipActiveQuests.md b/wiki-information/functions/GetGossipActiveQuests.md new file mode 100644 index 00000000..2bca225d --- /dev/null +++ b/wiki-information/functions/GetGossipActiveQuests.md @@ -0,0 +1,30 @@ +## Title: GetGossipActiveQuests + +**Content:** +Returns a list of active quests from a gossip NPC. For getting the number of active quests from a non-gossip NPC see `GetNumActiveQuests`. +```lua +title1, level1, isLowLevel1, isComplete1, isLegendary1, isIgnored1, title2, ... = GetGossipActiveQuests() +``` + +**Returns:** +The following six return values are provided for each active quest: +- `title` + - *string* - The name of the quest +- `level` + - *number* - The level of the quest +- `isLowLevel` + - *boolean* - true if the quest is low level, false otherwise +- `isComplete` + - *boolean* - true if the quest is complete, false otherwise +- `isLegendary` + - *boolean* - true if the quest is a legendary quest, false otherwise +- `isIgnored` + - *boolean* - true if the quest has been ignored, false otherwise + +**Description:** +The active quests for an NPC are available after `GOSSIP_SHOW` has fired. + +**Reference:** +- `GetGossipAvailableQuests` +- `GetNumAvailableQuests` +- `GetNumActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetGossipAvailableQuests.md b/wiki-information/functions/GetGossipAvailableQuests.md new file mode 100644 index 00000000..e722e560 --- /dev/null +++ b/wiki-information/functions/GetGossipAvailableQuests.md @@ -0,0 +1,33 @@ +## Title: GetGossipAvailableQuests + +**Content:** +Returns a list of available quests from a gossip NPC. For getting the number of available quests from a non-gossip NPC see `GetNumAvailableQuests`. +```lua +title1, level1, isTrivial1, frequency1, isRepeatable1, isLegendary1, isIgnored1, title2, ... = GetGossipAvailableQuests() +``` + +**Returns:** +The following seven return values are provided for each quest offered by the NPC: +- `title` + - *string* - The name of the quest. +- `level` + - *number* - The level of the quest. +- `isTrivial` + - *boolean* - true if the quest is trivial (too low-level compared to the character), false otherwise. +- `frequency` + - *number* - 1 if the quest is a normal quest, `LE_QUEST_FREQUENCY_DAILY` (2) for daily quests, `LE_QUEST_FREQUENCY_WEEKLY` (3) for weekly quests. +- `isRepeatable` + - *boolean* - true if the quest is repeatable, false otherwise. +- `isLegendary` + - *boolean* - true if the quest is a legendary quest, false otherwise. +- `isIgnored` + - *boolean* - true if the quest has been ignored, false otherwise. + +**Description:** +Available quests are quests that the player does not yet have in their quest log. +This list is available after `GOSSIP_SHOW` has fired. + +**Reference:** +- `GetGossipActiveQuests` +- `GetNumAvailableQuests` +- `GetNumActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetGossipOptions.md b/wiki-information/functions/GetGossipOptions.md new file mode 100644 index 00000000..00d44ab3 --- /dev/null +++ b/wiki-information/functions/GetGossipOptions.md @@ -0,0 +1,14 @@ +## Title: GetGossipOptions + +**Content:** +Get the available gossip items on an NPC (possibly stuff like the BWL and MC orbs too). +`title1, gossip1, ... = GetGossipOptions()` + +**Returns:** +- `title` + - *string* - The title of the gossip item. +- `gossip` + - *string* - The gossip type: banker, battlemaster, binder, gossip, healer, petition, tabard, taxi, trainer, unlearn, vendor, workorder + +**Description:** +The gossip options are available after `GOSSIP_SHOW` has fired. \ No newline at end of file diff --git a/wiki-information/functions/GetGossipText.md b/wiki-information/functions/GetGossipText.md new file mode 100644 index 00000000..d3103b8f --- /dev/null +++ b/wiki-information/functions/GetGossipText.md @@ -0,0 +1,18 @@ +## Title: GetGossipText + +**Content:** +Get the gossip text. +`text = GetGossipText()` + +**Returns:** +- `text` + - *string* - The text of the gossip. + +**Reference:** +- `GOSSIP_SHOW` + +**Example Usage:** +This function can be used in an addon to retrieve the gossip text from an NPC when the gossip window is shown. For example, it can be used to automate responses or to log the gossip text for later review. + +**Addon Usage:** +Many questing and automation addons, such as "Questie" or "Zygor Guides," use this function to interact with NPCs and automate the questing process by reading and responding to gossip text. \ No newline at end of file diff --git a/wiki-information/functions/GetGraphicsAPIs.md b/wiki-information/functions/GetGraphicsAPIs.md new file mode 100644 index 00000000..7b47ed57 --- /dev/null +++ b/wiki-information/functions/GetGraphicsAPIs.md @@ -0,0 +1,24 @@ +## Title: GetGraphicsAPIs + +**Content:** +Returns the supported graphics APIs for the system, D3D11_LEGACY, D3D11, D3D12, etc. +`cvarValues, ... = GetGraphicsAPIs()` + +**Returns:** +- (variable returns: `cvarValue1`, `cvarValue2`, ...) + - `cvarValues` + - *string* - a value for CVar `gxApi`. + - `Value` + - `Description` + - `D3D11_LEGACY` + - Old single-threaded rendering backend using DirectX 11 + - `D3D11` + - New multi-threaded rendering backend using DirectX 11 + - `D3D12` + - Multi-threaded rendering backend using DirectX 12 + - `metal` + - `gll` + - `opengl` + +**Reference:** +Kaivax 2019-03-12. New Graphics APIs in 8.1.5. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankItemInfo.md b/wiki-information/functions/GetGuildBankItemInfo.md new file mode 100644 index 00000000..883171c8 --- /dev/null +++ b/wiki-information/functions/GetGuildBankItemInfo.md @@ -0,0 +1,23 @@ +## Title: GetGuildBankItemInfo + +**Content:** +Returns item info for a guild bank slot. +`texture, itemCount, locked, isFiltered, quality = GetGuildBankItemInfo(tab, slot)` + +**Parameters:** +- `tab` + - *number* - The index of the tab in the guild bank +- `slot` + - *number* - The index of the slot in the chosen tab. + +**Returns:** +- `texture` + - *number* - The id of the texture to use for the item. Returns nil if there is no item. +- `itemCount` + - *number* - The size of the item stack at the chosen slot. Returns 0 if there is no item. +- `locked` + - *boolean* - Whether or not the slot is locked. Returns nil if it's not locked or the item doesn't exist, 1 otherwise. +- `isFiltered` + - *boolean* - Returns true if the slot should be hidden because of the user's filter, false otherwise. +- `quality` + - *number* - The quality of the item at the chosen slot. Returns nil if there is no item. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankItemLink.md b/wiki-information/functions/GetGuildBankItemLink.md new file mode 100644 index 00000000..6d419b0f --- /dev/null +++ b/wiki-information/functions/GetGuildBankItemLink.md @@ -0,0 +1,15 @@ +## Title: GetGuildBankItemLink + +**Content:** +Returns the item link for a guild bank slot. +`itemLink = GetGuildBankItemLink(tab, slot)` + +**Parameters:** +- `tab` + - *number* - The index of the tab in the guild bank +- `slot` + - *number* - The index of the slot in the provided tab. + +**Returns:** +- `itemLink` + - *string* - The item link for the item. Returns nil if there is no item. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankMoney.md b/wiki-information/functions/GetGuildBankMoney.md new file mode 100644 index 00000000..3ba0c8b6 --- /dev/null +++ b/wiki-information/functions/GetGuildBankMoney.md @@ -0,0 +1,21 @@ +## Title: GetGuildBankMoney + +**Content:** +Returns the amount of money in the guild bank. +`retVal1 = GetGuildBankMoney()` + +**Returns:** +- `retVal1` + - *number* - money in copper + +**Usage:** +```lua +/script DEFAULT_CHAT_FRAME:AddMessage(GetGuildBankMoney()); +``` +**Result:** +``` +8900000 +``` + +**Description:** +Will return 0 (zero) if the guild bank frame was not opened, or a cached value from the last time the guild bank frame was opened on any character since the game client was started. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankTabInfo.md b/wiki-information/functions/GetGuildBankTabInfo.md new file mode 100644 index 00000000..afe87cd5 --- /dev/null +++ b/wiki-information/functions/GetGuildBankTabInfo.md @@ -0,0 +1,28 @@ +## Title: GetGuildBankTabInfo + +**Content:** +Returns info for a guild bank tab. +`name, icon, isViewable, canDeposit, numWithdrawals, remainingWithdrawals, filtered = GetGuildBankTabInfo(tab)` + +**Parameters:** +- `tab` + - *number* - The index of the guild bank tab. (result of `GetCurrentGuildBankTab()`) + +**Returns:** +- `name` + - *string* - Title of the bank tab. +- `icon` + - *string* - Path to the bank tab icon texture. +- `isViewable` + - *boolean* - True if the player can click on the bank tab. +- `canDeposit` + - *boolean* - True if the player can deposit items. +- `numWithdrawals` + - *number* - Available withdrawals per day. +- `remainingWithdrawals` + - *number* - Remaining withdrawals for the day. +- `filtered` + - *boolean* - True if the requested tab is filtered out. + +**Description:** +As of 4.0.3, the `remainingWithdrawals` value seems to be bugged, in that it returns the value for the currently selected tab rather than the tab passed to the function. This bug can be demonstrated by entering `/dump GetGuildBankTabInfo(1)` while viewing different tabs of the bank; the value returned reflects the currently viewed tab, rather than the first tab. You can get around this by calling `QueryGuildBankTab(tabNum)` before calling this function. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankTabPermissions.md b/wiki-information/functions/GetGuildBankTabPermissions.md new file mode 100644 index 00000000..73aa785e --- /dev/null +++ b/wiki-information/functions/GetGuildBankTabPermissions.md @@ -0,0 +1,37 @@ +## Title: GetGuildBankTabPermissions + +**Content:** +Gets display / player's access info. Limited data available without bank proximity. +`canView, canDeposit, canEdit, stacksPerDay = GetGuildBankTabPermissions(tab)` + +**Parameters:** +- `tab` + - *number* - guild bank tab number + +**Returns:** +- `canView` + - *boolean* - 1 if the selected rank can view this guild bank tab, nil otherwise. +- `canDeposit` + - *boolean* - 1 if the selected rank can deposit to this guild bank tab, nil otherwise. +- `canEdit` + - *boolean* - 1 if the selected rank can edit the bank tab text, nil otherwise. +- `stacksPerDay` + - *number* - Amount of withdrawable stacks per day or 0 if none. + +**Usage:** +```lua +local canView, canDeposit, canEdit, stacksPerDay = GetGuildBankTabPermissions(1); +if canDeposit then + DEFAULT_CHAT_FRAME:AddMessage("Can view, deposit and retrieve " .. stacksPerDay .. " stacks a day on tab 1."); +elseif canView then + DEFAULT_CHAT_FRAME:AddMessage("Can view and retrieve " .. stacksPerDay .. " stacks a day on tab 1."); +else + DEFAULT_CHAT_FRAME:AddMessage("Can not view tab 1."); +end +``` + +**Miscellaneous:** +- **Result:** + - If you are the guild master, this will return data for the rank you currently have selected in guild control. Else, it will return data for your own rank. + - Guild masters can always view, deposit and withdraw without limits; this function does not properly return that. Use `IsGuildLeader()` if you want to know if this is the case. + - Note that being able to deposit implies being able to view. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankTransaction.md b/wiki-information/functions/GetGuildBankTransaction.md new file mode 100644 index 00000000..c2a06065 --- /dev/null +++ b/wiki-information/functions/GetGuildBankTransaction.md @@ -0,0 +1,33 @@ +## Title: GetGuildBankTransaction + +**Content:** +Returns info for an item transaction from the guild bank. +`type, name, itemLink, count, tab1, tab2, year, month, day, hour = GetGuildBankTransaction(tab, index)` + +**Parameters:** +- `tab` + - *number* - Tab number, ascending from 1 to `GetNumGuildBankTabs()`. +- `index` + - *number* - Transaction index, ascending from 1 to `GetNumGuildBankTransactions(tab)`. Higher indices correspond to more recent entries. + +**Returns:** +- `type` + - *string* - Transaction type. ("deposit", "withdraw" or "move") +- `name` + - *string* - Name of player who made the transaction. +- `itemLink` + - *string* - `itemLink` of transaction item. +- `count` + - *number* - Amount of items. +- `tab1` + - *number* - For `type=="move"`, this is the origin tab. +- `tab2` + - *number* - For `type=="move"`, this is the destination tab. +- `year` + - *number* - The number of years since this transaction took place. +- `month` + - *number* - The number of months since this transaction took place. +- `day` + - *number* - The number of days since this transaction took place. +- `hour` + - *number* - The number of hours since this transaction took place. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankWithdrawGoldLimit.md b/wiki-information/functions/GetGuildBankWithdrawGoldLimit.md new file mode 100644 index 00000000..4ae1929a --- /dev/null +++ b/wiki-information/functions/GetGuildBankWithdrawGoldLimit.md @@ -0,0 +1,33 @@ +## Title: GetGuildBankWithdrawGoldLimit + +**Content:** +Returns withdraw limit for currently selected rank in guild control. +`dailyGoldWithdrawlLimit = GetGuildBankWithdrawGoldLimit()` + +**Parameters:** +- **Arguments** + - none + +**Returns:** +- `dailyGoldWithdrawlLimit` + - *number* - amount (in GOLD) the currently selected Guild Rank can withdraw per day + +**Description:** +In order for this to work properly, you need to have a rank set in the guildControl. + +Example of checking the daily limit for the currently logged on character: +```lua +-- create somewhere to store the result and default it +local dailyGoldWithdrawlLimit = 0 + +-- need to get the guildRankIndex for the currently logged on player +guildName, _, guildRankIndex = GetGuildInfo("player") + +-- guildName is nil if the character isn't in a guild +if (guildName ~= nil) then + -- This character is in a guild, so set the current rank so the limit will work + GuildControlSetRank(guildRankIndex) + dailyGoldWithdrawlLimit = GetGuildBankWithdrawGoldLimit() +end +``` +**NOTE:** This return value is in GOLD unlike many other currency returns in WoW where they give you copper pieces. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankWithdrawMoney.md b/wiki-information/functions/GetGuildBankWithdrawMoney.md new file mode 100644 index 00000000..109efa4a --- /dev/null +++ b/wiki-information/functions/GetGuildBankWithdrawMoney.md @@ -0,0 +1,12 @@ +## Title: GetGuildBankWithdrawMoney + +**Content:** +Returns the amount of money the player is allowed to withdraw from the guild bank. +`withdrawLimit = GetGuildBankWithdrawMoney()` + +**Returns:** +- `withdrawLimit` + - Amount of money the player is allowed to withdraw from the guild bank (in copper), or 2^64 if the player has unlimited withdrawal privileges (is Guild Master). + +**Description:** +Returns the amount remaining for the day; that is (Daily amount) - (amount already spent). \ No newline at end of file diff --git a/wiki-information/functions/GetGuildInfo.md b/wiki-information/functions/GetGuildInfo.md new file mode 100644 index 00000000..e4a136f6 --- /dev/null +++ b/wiki-information/functions/GetGuildInfo.md @@ -0,0 +1,36 @@ +## Title: GetGuildInfo + +**Content:** +Returns guild info for a player unit. +`guildName, guildRankName, guildRankIndex, realm = GetGuildInfo(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit whose guild information you wish to query. + +**Returns:** +- `guildName` + - *string* - The name of the guild the unit is in (or nil?). +- `guildRankName` + - *string* - unit's rank in unit's guild. +- `guildRankIndex` + - *number* - unit's rank (index). - zero based index (0 is Guild Master, 1 and above are lower ranks) +- `realm` + - *string?* - The name of the realm the guild is in, or nil if the guild's realm is the same as your current one. + +**Description:** +This function only works in close proximity to the unit you are trying to get info from. It is the same distance that the character portrait loads if you are in party with them. It will abandon the data shortly after you leave the area, even if the portrait is remembered. + +If using with UnitId "player" on loading it happens that this value is nil even if the player is in a guild. Here's a little function which checks in the `GUILD_ROSTER_UPDATE` and `PLAYER_GUILD_UPDATE` events, if guild name is available. As long as it is not, no actions are fired by my guild event handling. + +```lua +local function IsPlayerInGuild() + return IsInGuild() and GetGuildInfo("player") +end +``` + +**Example Usage:** +This function can be used to display guild information for a player in a custom UI element or addon. For instance, you might use it to show the guild name and rank of party members in a custom party frame. + +**Addon Usage:** +Many large addons, such as ElvUI and PitBull Unit Frames, use `GetGuildInfo` to display guild information in their unit frames. This allows players to see at a glance which guild their party or raid members belong to and their rank within that guild. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterInfo.md b/wiki-information/functions/GetGuildRosterInfo.md new file mode 100644 index 00000000..ab577d83 --- /dev/null +++ b/wiki-information/functions/GetGuildRosterInfo.md @@ -0,0 +1,58 @@ +## Title: GetGuildRosterInfo + +**Content:** +Returns info for a guild member. +`name, rankName, rankIndex, level, classDisplayName, zone, publicNote, officerNote, isOnline, status, class, achievementPoints, achievementRank, isMobile, canSoR, repStanding, guid = GetGuildRosterInfo(index)` + +**Parameters:** +- `index` + - *number* - Ranging from 1 to `GetNumGuildMembers()` + +**Returns:** +- `name` + - *string* - Name of character with realm (e.g. "Arthas-Silvermoon") +- `rankName` + - *string* - Name of character's guild rank (e.g. Guild Master, Officer, Member, ...) +- `rankIndex` + - *number* - Index of rank starting at 0 for GM (add 1 for `GuildControlGetRankName(index)`) +- `level` + - *number* - Character's level +- `classDisplayName` + - *string* - Localized class name (e.g. "Mage", "Warrior", "Guerrier", ...) +- `zone` + - *string* - Character's location (last location if offline) +- `publicNote` + - *string* - Character's public note, returns "" if you can't view notes or no note +- `officerNote` + - *string* - Character's officer note, returns "" if you can't view notes or no note +- `isOnline` + - *boolean* - true: online - false: offline +- `status` + - *number* - 0: none - 1: AFK - 2: Busy (Do Not Disturb) (changed in 4.3.2) +- `class` + - *string* - Localization-independent class name (e.g. "MAGE", "WARRIOR", "DEATHKNIGHT", ...) +- `achievementPoints` + - *number* - Character's achievement points +- `achievementRank` + - *number* - Where the character ranks in guild if sorted by achievement points +- `isMobile` + - *boolean* - true: player logged into app with this character +- `canSoR` + - *boolean* - true: can use Scroll of Resurrection on character (deprecated) +- `repStanding` + - *number* - Standing ID for character's guild reputation +- `guid` + - *string* - Character's GUID + +**Description:** +- **Related API:** + - `C_GuildInfo.GuildRoster` +- **Related Events:** + - `GUILD_ROSTER_UPDATE` + +**Example Usage:** +This function can be used to retrieve detailed information about each member of a guild, which can be useful for guild management addons. For example, an addon could use this function to display a list of all guild members along with their ranks, levels, and online status. + +**Addons Using This API:** +- **ElvUI:** A comprehensive UI replacement addon that uses `GetGuildRosterInfo` to display guild member information in its guild panel. +- **Guild Roster Manager (GRM):** An addon designed to help guild leaders manage their guilds more effectively, using this API to fetch and display detailed member information. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterLastOnline.md b/wiki-information/functions/GetGuildRosterLastOnline.md new file mode 100644 index 00000000..c852fc23 --- /dev/null +++ b/wiki-information/functions/GetGuildRosterLastOnline.md @@ -0,0 +1,39 @@ +## Title: GetGuildRosterLastOnline + +**Content:** +Returns time since the guild member was last online. +`yearsOffline, monthsOffline, daysOffline, hoursOffline = GetGuildRosterLastOnline(index)` + +**Parameters:** +- `index` + - *number* - index of the guild roster entry you wish to query. + +**Returns:** +- `yearsOffline` + - *number* - number of years since the member was last online. May return nil. +- `monthsOffline` + - *number* - number of months since the member was last online. May return nil. +- `daysOffline` + - *number* - number of days since the member was last online. May return nil. +- `hoursOffline` + - *number* - number of hours since the member was last online. May return nil. + +**Usage:** +```lua +local i, tmax, tname, years, months, days, hours, toff = 1, 0, "placeholder"; +while (GetGuildRosterInfo(i) ~= nil) do + years, months, days, hours = GetGuildRosterLastOnline(i); + years, months, days, hours = years and years or 0, months and months or 0, days and days or 0, hours and hours or 0; + toff = (((years*12)+months)*30.5+days)*24+hours; + if (toff > tmax) then + tname = GetGuildRosterInfo(i); + tmax = toff; + end + i = i + 1; +end +message("Been offline the longest: " .. tname .. " (~" .. tmax .. " hours)"); +``` + +**Miscellaneous:** +Result: +Displays a message with the name of the person in your guild who has been offline the longest. Note that this requires an updated guild list showing offline members (open Social tab, click "Show offline members"). \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterMOTD.md b/wiki-information/functions/GetGuildRosterMOTD.md new file mode 100644 index 00000000..d1d49829 --- /dev/null +++ b/wiki-information/functions/GetGuildRosterMOTD.md @@ -0,0 +1,9 @@ +## Title: GetGuildRosterMOTD + +**Content:** +Returns the guild message of the day. +`motd = GetGuildRosterMOTD()` + +**Returns:** +- `motd` + - *string* - Returns the guild MOTD, or an empty string if not set or not in a guild \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterShowOffline.md b/wiki-information/functions/GetGuildRosterShowOffline.md new file mode 100644 index 00000000..ad047bbf --- /dev/null +++ b/wiki-information/functions/GetGuildRosterShowOffline.md @@ -0,0 +1,9 @@ +## Title: GetGuildRosterShowOffline + +**Content:** +Returns true if the guild roster is showing offline members. +`showoffline = GetGuildRosterShowOffline()` + +**Returns:** +- `showoffline` + - *Flag* - 1 if online members are shown, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildTabardFiles.md b/wiki-information/functions/GetGuildTabardFiles.md new file mode 100644 index 00000000..fc69930f --- /dev/null +++ b/wiki-information/functions/GetGuildTabardFiles.md @@ -0,0 +1,19 @@ +## Title: GetGuildTabardFiles + +**Content:** +Returns File IDs of tabard textures used in guild bank logo. +`tabardBackgroundUpper, tabardBackgroundLower, tabardEmblemUpper, tabardEmblemLower, tabardBorderUpper, tabardBorderLower = GetGuildTabardFiles()` + +**Returns:** +- `tabardBackgroundUpper` + - *number* : FileID +- `tabardBackgroundLower` + - *number* : FileID +- `tabardEmblemUpper` + - *number* : FileID +- `tabardEmblemLower` + - *number* : FileID +- `tabardBorderUpper` + - *number* : FileID +- `tabardBorderLower` + - *number* : FileID \ No newline at end of file diff --git a/wiki-information/functions/GetHaste.md b/wiki-information/functions/GetHaste.md new file mode 100644 index 00000000..a9f4f0d2 --- /dev/null +++ b/wiki-information/functions/GetHaste.md @@ -0,0 +1,17 @@ +## Title: GetHaste + +**Content:** +Returns the player's haste percentage. +`haste = GetHaste()` + +**Returns:** +- `haste` + - *number* + +**Description:** +Related API: +- `GetCombatRating(CR_HASTE_MELEE)` +- `GetCombatRatingBonus(CR_HASTE_MELEE)` + +**Usage:** +`/dump GetHaste()` \ No newline at end of file diff --git a/wiki-information/functions/GetHitModifier.md b/wiki-information/functions/GetHitModifier.md new file mode 100644 index 00000000..369b60ad --- /dev/null +++ b/wiki-information/functions/GetHitModifier.md @@ -0,0 +1,18 @@ +## Title: GetHitModifier + +**Content:** +Returns the amount of Melee Hit %, not from Melee Hit Rating, that your character has. +`hitMod = GetHitModifier()` + +**Returns:** +- `hitMod` + - *number* - hit modifier (e.g. 16 for 16%) + +**Usage:** +Returns the Melee Hit Chance displayed in the paper doll. +```lua +/dump GetCombatRatingBonus(CR_HIT_MELEE) + GetHitModifier() +``` + +**Reference:** +API GetSpellHitModifier \ No newline at end of file diff --git a/wiki-information/functions/GetHomePartyInfo.md b/wiki-information/functions/GetHomePartyInfo.md new file mode 100644 index 00000000..8d95cbf6 --- /dev/null +++ b/wiki-information/functions/GetHomePartyInfo.md @@ -0,0 +1,13 @@ +## Title: GetHomePartyInfo + +**Content:** +Returns names of characters in your home (non-instance) party. +`homePlayers = GetHomePartyInfo()` + +**Parameters:** +- `homePlayers` + - *table* - table to populate and return; a new table is created if this argument is omitted. + +**Returns:** +- `homePlayers` + - *table* - array containing your (non-instance) party members' names, or nil if you're not in any non-instance party. \ No newline at end of file diff --git a/wiki-information/functions/GetInboxHeaderInfo.md b/wiki-information/functions/GetInboxHeaderInfo.md new file mode 100644 index 00000000..a1146a78 --- /dev/null +++ b/wiki-information/functions/GetInboxHeaderInfo.md @@ -0,0 +1,41 @@ +## Title: GetInboxHeaderInfo + +**Content:** +Returns info for a message in the mailbox. +`packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply, isGM = GetInboxHeaderInfo(index)` + +**Parameters:** +- `index` + - *number* - the index of the message (ascending from 1). + +**Returns:** +- `packageIcon` + - *string* - texture path for package icon if it contains a package (nil otherwise). +- `stationeryIcon` + - *string* - texture path for mail message icon. +- `sender` + - *string* - name of the player who sent the message. +- `subject` + - *string* - the message subject. +- `money` + - *number* - The amount of money attached. +- `CODAmount` + - *number* - The amount of COD payment required to receive the package. +- `daysLeft` + - *number* - The number of days (fractional) before the message expires. +- `hasItem` + - *number* - Either the number of attachments or nil if no items are present. Note that items that have been taken from the mailbox continue to occupy empty slots, but hasItem is the total number of items remaining in the mailbox. Use `ATTACHMENTS_MAX_RECEIVE` for the total number of attachments rather than this. +- `wasRead` + - *boolean* - 1 if the mail has been read, nil otherwise. Using `GetInboxText()` marks an item as read. +- `wasReturned` + - *boolean* - 1 if the mail was returned, nil otherwise. +- `textCreated` + - *boolean* - 1 if a letter object has been created from this mail, nil otherwise. +- `canReply` + - *boolean* - 1 if this letter can be replied to, nil otherwise. +- `isGM` + - *boolean* - 1 if this letter was sent by a GameMaster. + +**Description:** +This function may be called from anywhere in the world, but will only be current as of the last time `CheckInbox` was called. +Details of an Auction House message can be extracted with `GetInboxInvoiceInfo`. \ No newline at end of file diff --git a/wiki-information/functions/GetInboxInvoiceInfo.md b/wiki-information/functions/GetInboxInvoiceInfo.md new file mode 100644 index 00000000..93a6d928 --- /dev/null +++ b/wiki-information/functions/GetInboxInvoiceInfo.md @@ -0,0 +1,28 @@ +## Title: GetInboxInvoiceInfo + +**Content:** +Returns info for an auction house invoice. +`invoiceType, itemName, playerName, bid, buyout, deposit, consignment = GetInboxInvoiceInfo(index)` + +**Parameters:** +- `index` + - *number* - The index of the message, starting from 1. + +**Returns:** +- `invoiceType` + - *string?* - One of "buyer", "seller" or "seller_temp_invoice"; or nil if there is no invoice. +- `itemName` + - *string?* - The name of the item sold/bought, or nil if there is no invoice. +- `playerName` + - *string?* - The player that sold/bought the item, or nil if there were multiple buyers/sellers involved. Will also return nil if there is no invoice. +- `bid` + - *number* - The amount of money bid on the item. +- `buyout` + - *number* - The amount of money set as buyout for the auction. +- `deposit` + - *number* - The amount paid as deposit for the auction. +- `consignment` + - *number* - The fee charged by the auction house for selling your consignment. + +**Description:** +During the 1 hour delay on auction house payments, the message "Sale Pending: " may be queried with `GetInboxInvoiceInfo()` to determine the bid, buyout, deposit, and consignment fee amounts. This is useful, since `GetInboxHeaderInfo()` for that message (correctly) reports 0 money attached. \ No newline at end of file diff --git a/wiki-information/functions/GetInboxItem.md b/wiki-information/functions/GetInboxItem.md new file mode 100644 index 00000000..8390b110 --- /dev/null +++ b/wiki-information/functions/GetInboxItem.md @@ -0,0 +1,54 @@ +## Title: GetInboxItem + +**Content:** +Returns info for an item attached to a message in the mailbox. +`name, itemID, texture, count, quality, canUse = GetInboxItem(index, itemIndex)` + +**Parameters:** +- `index` + - *number* - The index of the message to query, in the range +- `itemIndex` + - *number* - The index of the item to query, in the range + +**Returns:** +- `name` + - *string* - The localized name of the item +- `itemID` + - *number* - Numeric ID of the item. +- `texture` + - *string* - The path to the icon texture for the item +- `count` + - *number* - The number of items in the stack +- `quality` + - *number* - The quality index of the item +- `canUse` + - *boolean* - 1 if the player can use the item, or nil otherwise + +**Usage:** +Loop over all messages currently in the player's mailbox, get information about the items attached to them, and print it to the chat frame: +```lua +for i = 1, GetInboxNumItems() do + -- An underscore is commonly used to name variables you aren't going to use in your code: + local _, _, sender, subject, _, _, _, hasItem = GetInboxHeaderInfo(i) + if hasItem then + print("Message", subject, "from", sender, "has attachments:") + for j = 1, ATTACHMENTS_MAX_RECEIVE do + local name, itemID, texture, count, quality, canUse = GetInboxItem(i, j) + if name then + -- Construct an icon string: + print("\128T"..texture..":0\128t", name, "x", count) + end + end + else + print("Message", subject, "from", sender, "has no attachments.") + end +end +``` + +**Description:** +As of 2.3.3 this function is bugged and the quality is always returned as -1. If you need to know the item's quality, get a link for the item using `GetInboxItemLink`, and pass the link to `GetItemInfo`. + +**Reference:** +- `GetInboxItemLink` +- `GetSendMailItem` +- `GetSendMailItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetInboxItemLink.md b/wiki-information/functions/GetInboxItemLink.md new file mode 100644 index 00000000..4fae86e5 --- /dev/null +++ b/wiki-information/functions/GetInboxItemLink.md @@ -0,0 +1,36 @@ +## Title: GetInboxItemLink + +**Content:** +Returns the item link of an item attached to a message in the mailbox. +`itemLink = GetInboxItemLink(message, attachment)` + +**Parameters:** +- `message` + - *number* - The index of the message to query, in the range of +- `attachment` + - *number* - The index of the attachment to query, in the range of + +**Returns:** +- `itemLink` + - *itemLink* - The itemLink for the specified item + +**Description:** +`ATTACHMENTS_MAX_RECEIVE` is defined in Constants.lua, and currently (Jan 2014) has a value of 16. Using this variable instead of a hardcoded 16 is recommended in case Blizzard changes the maximum number of items that may be attached to a received message. + +**Usage:** +To determine which messages are currently displayed in the mailbox frame, check the `pageNum` property set on the InboxFrame and do the math: +```lua +local maxIndex = GetInboxNumItems() +if maxIndex > 0 then + local firstIndex = ((InboxFrame.pageNum - 1) * INBOXITEMS_TO_DISPLAY) + 1 + local lastIndex = math.min(maxIndex, firstIndex + (INBOXITEMS_TO_DISPLAY - 1)) + print("Currently displaying messages", firstIndex, "though", lastIndex) +else + print("No messages to display") +end +``` + +**Reference:** +- `GetInboxItem` +- `GetSendMailItem` +- `GetSendMailItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetInboxNumItems.md b/wiki-information/functions/GetInboxNumItems.md new file mode 100644 index 00000000..d17b7675 --- /dev/null +++ b/wiki-information/functions/GetInboxNumItems.md @@ -0,0 +1,17 @@ +## Title: GetInboxNumItems + +**Content:** +Returns the number of messages in the mailbox. +`numItems, totalItems = GetInboxNumItems()` + +**Returns:** +- `numItems` + - *number* - The number of items in the mailbox. +- `totalItems` + - *number* - The total number of items in the mailbox, including those that are not visible due to pagination. + +**Example Usage:** +This function can be used to check the number of messages in a player's mailbox, which can be useful for addons that manage mail or notify players of new mail. + +**Addons Using This Function:** +- **Postal**: A popular mailbox management addon that uses this function to display the number of messages and manage mail efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetInspectArenaData.md b/wiki-information/functions/GetInspectArenaData.md new file mode 100644 index 00000000..fd01ad1b --- /dev/null +++ b/wiki-information/functions/GetInspectArenaData.md @@ -0,0 +1,25 @@ +## Title: GetInspectArenaData + +**Content:** +Returns the inspected unit's rated PvP stats. +`rating, seasonPlayed, seasonWon, weeklyPlayed, weeklyWon = GetInspectArenaData(bracketId)` + +**Parameters:** +- `bracketId` + - *number* - rated PvP bracket to query, ascending from 1 for 2v2, 3v3, and 5v5 arenas, and Rated Battlegrounds respectively. + +**Returns:** +- `rating` + - *number* - inspected unit's current personal rating in the specified bracket. +- `seasonPlayed` + - *number* - number of games played in the bracket during the current season. +- `seasonWon` + - *number* - number of games won in the bracket during the current season. +- `weeklyPlayed` + - *number* - number of games played in the bracket during the current week. +- `weeklyWon` + - *number* - number of games won in the bracket during the current week. + +**Description:** +Information is available when the `INSPECT_HONOR_UPDATE` event fires, or when `HasInspectHonorData` returns true. +You must request information from the server by calling `RequestInspectHonorData`. \ No newline at end of file diff --git a/wiki-information/functions/GetInspectHonorData.md b/wiki-information/functions/GetInspectHonorData.md new file mode 100644 index 00000000..a75cca75 --- /dev/null +++ b/wiki-information/functions/GetInspectHonorData.md @@ -0,0 +1,22 @@ +## Title: GetInspectHonorData + +**Content:** +Returns honor info for the inspected player unit. +`todayHK, todayHonor, yesterdayHK, yesterdayHonor, lifetimeHK, lifetimeRank = GetInspectHonorData()` + +**Returns:** +- `todayHK` + - *number* - Honor kills made today. +- `todayHonor` + - *number* - Honor rewarded today. +- `yesterdayHK` + - *number* - Amount of honor kills made yesterday. +- `yesterdayHonor` + - *number* - The honor rewarded yesterday. +- `lifetimeHK` + - *number* - Total lifetime honor kills. +- `lifetimeRank` + - *number* - Highest PvP rank ever attained. + +**Description:** +Before this function can return any information, `NotifyInspect(unit)` must be called first, followed by a call to the `RequestInspectHonorData` function. \ No newline at end of file diff --git a/wiki-information/functions/GetInspectPVPRankProgress.md b/wiki-information/functions/GetInspectPVPRankProgress.md new file mode 100644 index 00000000..dc1cfdc8 --- /dev/null +++ b/wiki-information/functions/GetInspectPVPRankProgress.md @@ -0,0 +1,13 @@ +## Title: GetInspectPVPRankProgress + +**Content:** +Gets the inspected unit's progress towards the next PvP rank. +`rankProgress = GetInspectPVPRankProgress()` + +**Returns:** +- `rankProgress` + - *number* - The progress made toward the next PVP rank normalized between 0 and 1 + +**Description:** +Requires you to be inspecting a unit and call `GetInspectHonorData()` first before this API returns updated information. +If not inspecting a unit, `NotifyInspect("unit")` must be called first. \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceBootTimeRemaining.md b/wiki-information/functions/GetInstanceBootTimeRemaining.md new file mode 100644 index 00000000..765ad198 --- /dev/null +++ b/wiki-information/functions/GetInstanceBootTimeRemaining.md @@ -0,0 +1,9 @@ +## Title: GetInstanceBootTimeRemaining + +**Content:** +Needs summary. +`result = GetInstanceBootTimeRemaining()` + +**Returns:** +- `result` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceInfo.md b/wiki-information/functions/GetInstanceInfo.md new file mode 100644 index 00000000..43cda826 --- /dev/null +++ b/wiki-information/functions/GetInstanceInfo.md @@ -0,0 +1,30 @@ +## Title: GetInstanceInfo + +**Content:** +Returns info for the map instance the character is currently in. +`name, instanceType, difficultyID, difficultyName, maxPlayers, dynamicDifficulty, isDynamic, instanceID, instanceGroupSize, LfgDungeonID = GetInstanceInfo()` + +**Returns:** +1. `name` + - *string* - The localized name of the instance—otherwise, the continent name (e.g., Eastern Kingdoms, Kalimdor, Outland, Northrend, Pandaria). +2. `instanceType` + - *string* - "none" if the player is not in an instance, "scenario" for scenarios, "party" for dungeons, "raid" for raids, "arena" for arenas, and "pvp" for battlegrounds. Many of the following return values will be nil or otherwise useless in the case of "none". +3. `difficultyID` + - *number* - The DifficultyID of the instance. Will return 0 while not in an instance. +4. `difficultyName` + - *string* - The localized name for the instance's difficulty ("10 Player", "25 Player (Heroic)", etc.). +5. `maxPlayers` + - *number* - Maximum number of players permitted within the instance at the same time. +6. `dynamicDifficulty` + - *number* - The difficulty of dynamic enabled instances. This no longer appears to be used. +7. `isDynamic` + - *boolean* - If the instance difficulty can be changed while zoned in. This is true for most raids after and including Icecrown Citadel. +8. `instanceID` + - *number* - The InstanceID for the instance or continent. +9. `instanceGroupSize` + - *number* - The number of players within your instance group. +10. `LfgDungeonID` + - *number* - The LfgDungeonID for the current instance group, nil if not in a dungeon finder group. + +**Description:** +Related API: `C_Map.GetBestMapForUnit` \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceLockTimeRemaining.md b/wiki-information/functions/GetInstanceLockTimeRemaining.md new file mode 100644 index 00000000..76dd367b --- /dev/null +++ b/wiki-information/functions/GetInstanceLockTimeRemaining.md @@ -0,0 +1,23 @@ +## Title: GetInstanceLockTimeRemaining + +**Content:** +Returns info for the instance lock timer for the current instance. +`lockTimeleft, isPreviousInstance, encountersTotal, encountersComplete = GetInstanceLockTimeRemaining()` + +**Returns:** +- `lockTimeLeft` + - *number* - Seconds until lock period ends. +- `isPreviousInstance` + - *boolean* - Whether this instance has yet to be entered since last lockout expired (allowing for lock extension options). +- `encountersTotal` + - *number* - Total number of bosses in the instance. +- `encountersComplete` + - *number* - Number of bosses already dead in the instance. + +**Description:** +On the continent of Pandaria, unlike other open world continents, `encountersTotal` is reported as 4. According to `GetInstanceLockTimeRemainingEncounter`, this corresponds with the first 4 Pandaria world bosses of the expansion - Galleon, Sha of Anger, Nalak, and Oondasta. +As of patch 5.4, the new world boss system isolates non-instance lockouts to `GetNumSavedWorldBosses` and `GetSavedWorldBossInfo`. It is likely that interacting with those bosses or their loot no longer has any effect on the old instance-based system represented by this function. + +**Reference:** +- `GetInstanceLockTimeRemainingEncounter(...)` - drills down to specific boss +- `GetSavedInstanceInfo(...)` - newer, expanded version of this function \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md b/wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md new file mode 100644 index 00000000..6653f97a --- /dev/null +++ b/wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md @@ -0,0 +1,21 @@ +## Title: GetInstanceLockTimeRemainingEncounter + +**Content:** +Returns information about bosses in the instance the player is about to be saved to. +`bossName, texture, isKilled = GetInstanceLockTimeRemainingEncounter(id)` + +**Parameters:** +- `id` + - *number* - Index of the boss to query, ascending from 1 to encountersTotal return value from GetInstanceLockTimeRemaining. + +**Returns:** +- `bossName` + - *string* - Name of the boss. +- `texture` + - *string* - ? +- `isKilled` + - *boolean* - true if the boss has been killed. + +**Reference:** +- `GetInstanceLockTimeRemaining()` - zooms out to full instance's info +- `GetSavedWorldBossInfo(...)` - also provides boss info, but for world bosses \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryAlertStatus.md b/wiki-information/functions/GetInventoryAlertStatus.md new file mode 100644 index 00000000..972cfa90 --- /dev/null +++ b/wiki-information/functions/GetInventoryAlertStatus.md @@ -0,0 +1,27 @@ +## Title: GetInventoryAlertStatus + +**Content:** +Returns the durability status of an equipped item. +`alertStatus = GetInventoryAlertStatus(index)` + +**Parameters:** +- `index` + - *string* - one of the following: + - Head + - Shoulders + - Chest + - Waist + - Legs + - Feet + - Wrists + - Hands + - Weapon + - Shield + - Ranged + +**Returns:** +- `alertStatus` + - *number* - 0 for normal (6 or more durability points left), 1 for yellow (5 to 1 durability points left), 2 for broken (0 durability points left). + +**Description:** +Used primarily for DurabilityFrame, i.e., the armor man placed under the Minimap when your equipment is damaged or broken. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemBroken.md b/wiki-information/functions/GetInventoryItemBroken.md new file mode 100644 index 00000000..61d92a14 --- /dev/null +++ b/wiki-information/functions/GetInventoryItemBroken.md @@ -0,0 +1,15 @@ +## Title: GetInventoryItemBroken + +**Content:** +Returns true if an inventory item has zero durability. +`isBroken = GetInventoryItemBroken(unit, invSlotId)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit whose inventory is to be queried. +- `invSlotId` + - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. + +**Returns:** +- `isBroken` + - *Flag* - Returns nil if the specified item is not broken, or 1 if it is. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemCooldown.md b/wiki-information/functions/GetInventoryItemCooldown.md new file mode 100644 index 00000000..568c292c --- /dev/null +++ b/wiki-information/functions/GetInventoryItemCooldown.md @@ -0,0 +1,19 @@ +## Title: GetInventoryItemCooldown + +**Content:** +Get cooldown information for an inventory item. +`start, duration, enable = GetInventoryItemCooldown(unit, invSlotId)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit whose inventory is to be queried. +- `invSlotId` + - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. + +**Returns:** +- `start` + - *number* - The start time of the cooldown period, or 0 if there is no cooldown (or no item in the slot) +- `duration` + - *number* - The duration of the cooldown period (NOT the remaining time). 0 if the item has no use/cooldown or the slot is empty. +- `enable` + - *number* - Returns 1 or 0. 1 if the inventory item is capable of having a cooldown, 0 if not. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemCount.md b/wiki-information/functions/GetInventoryItemCount.md new file mode 100644 index 00000000..1152ad8c --- /dev/null +++ b/wiki-information/functions/GetInventoryItemCount.md @@ -0,0 +1,30 @@ +## Title: GetInventoryItemCount + +**Content:** +Determine the quantity of an item in an inventory slot. +`count = GetInventoryItemCount(unit, invSlotId)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit whose inventory is to be queried. +- `invSlotId` + - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. + +**Returns:** +- `count` + - *number* - Returns 1 on empty slots (Thus, on empty ammo slot, 1 is returned). For containers (Bags, etc.), this returns the number of items stored inside the container (Thus, empty containers return 0). Under all other conditions, this function returns the amount of items in the specified slot. + +**Usage:** +```lua +local ammoSlot = GetInventorySlotInfo("AmmoSlot"); +local ammoCount = GetInventoryItemCount("player", ammoSlot); +if ((ammoCount == 1) and (not GetInventoryItemTexture("player", ammoSlot))) then + ammoCount = 0; +end; +``` + +**Example Use Case:** +This function can be used to check the amount of ammunition a player has left in their ammo slot. This is particularly useful for classes that rely on ammunition, such as Hunters in earlier expansions of World of Warcraft. + +**Addon Usage:** +Large addons like WeakAuras might use this function to create custom alerts or notifications for players when their ammunition is running low. This helps players to manage their inventory more effectively during gameplay. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemDurability.md b/wiki-information/functions/GetInventoryItemDurability.md new file mode 100644 index 00000000..617573cb --- /dev/null +++ b/wiki-information/functions/GetInventoryItemDurability.md @@ -0,0 +1,19 @@ +## Title: GetInventoryItemDurability + +**Content:** +Returns the durability of an equipped item. +`current, maximum = GetInventoryItemDurability(invSlotId)` + +**Parameters:** +- `invSlotId` + - *number* - InventorySlotId + +**Returns:** +- `current` + - *number* - current durability value. +- `maximum` + - *number* - maximum durability value. + +**Reference:** +- `GetInventorySlotInfo` +- `GetContainerItemDurability` \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemGems.md b/wiki-information/functions/GetInventoryItemGems.md new file mode 100644 index 00000000..66c49672 --- /dev/null +++ b/wiki-information/functions/GetInventoryItemGems.md @@ -0,0 +1,13 @@ +## Title: GetInventoryItemGems + +**Content:** +Returns item ids of the gems socketed in the item in the specified inventory slot. +`gem1, gem2, ... = GetInventoryItemGems(invSlot);` + +**Parameters:** +- `invSlot` + - *Number (InventorySlotId)* - Index of the inventory slot to query. + +**Returns:** +- `gem1, gem2, ...` + - *Number* - Item ID of the gem(s) socketed within the item in the queried slot. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemID.md b/wiki-information/functions/GetInventoryItemID.md new file mode 100644 index 00000000..3e6d9638 --- /dev/null +++ b/wiki-information/functions/GetInventoryItemID.md @@ -0,0 +1,29 @@ +## Title: GetInventoryItemID + +**Content:** +Returns the item ID for an equipped item. +`itemId, unknown = GetInventoryItemID(unit, invSlotId)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit whose inventory is to be queried. +- `invSlotId` + - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. + +**Returns:** +- `itemId` + - *number* - item id of the item in the inventory slot; nil if there is no item. +- `unknown` + - *number* - ? + +**Example Usage:** +```lua +local unit = "player" +local invSlotId = GetInventorySlotInfo("HeadSlot") +local itemId = GetInventoryItemID(unit, invSlotId) +print("Item ID in Head Slot: ", itemId) +``` + +**Common Usage in Addons:** +- **WeakAuras**: This function is often used to check if a player has a specific item equipped, which can then trigger custom visual or audio alerts. +- **Pawn**: Utilizes this function to compare currently equipped items with potential upgrades, helping players make better gear choices. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemLink.md b/wiki-information/functions/GetInventoryItemLink.md new file mode 100644 index 00000000..3d576b9c --- /dev/null +++ b/wiki-information/functions/GetInventoryItemLink.md @@ -0,0 +1,24 @@ +## Title: GetInventoryItemLink + +**Content:** +Returns the item link for an equipped item. +`itemLink = GetInventoryItemLink(unit, invSlotId)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit whose inventory is to be queried. +- `invSlotId` + - *number* : InventorySlotId - The inventory slot to be queried. + +**Returns:** +- `itemLink` + - *string?* : ItemLink - The item link for the specified item. + +**Usage:** +```lua +local mainHandLink = GetInventoryItemLink("player", GetInventorySlotInfo("MainHandSlot")) +local _, _, _, _, _, _, itemType = GetItemInfo(mainHandLink) +DEFAULT_CHAT_FRAME:AddMessage(itemType) +``` +**Result:** +Prints the subtype of the mainhand weapon - for example "Mace" or "Sword". \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemQuality.md b/wiki-information/functions/GetInventoryItemQuality.md new file mode 100644 index 00000000..63f50255 --- /dev/null +++ b/wiki-information/functions/GetInventoryItemQuality.md @@ -0,0 +1,15 @@ +## Title: GetInventoryItemQuality + +**Content:** +Returns the quality of an equipped item. +`quality = GetInventoryItemQuality(unitId, invSlotId)` + +**Parameters:** +- `unitId` + - *string* : UnitId - The unit whose inventory is to be queried. +- `invSlotId` + - *number* : InventorySlotId - The slot ID to be queried, obtained via `GetInventorySlotInfo()`. + +**Returns:** +- `quality` + - *Enum.ItemQuality* \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemTexture.md b/wiki-information/functions/GetInventoryItemTexture.md new file mode 100644 index 00000000..1e9841ce --- /dev/null +++ b/wiki-information/functions/GetInventoryItemTexture.md @@ -0,0 +1,15 @@ +## Title: GetInventoryItemTexture + +**Content:** +Returns the texture for an equipped item. +`texture = GetInventoryItemTexture(unit, invSlotId)` + +**Parameters:** +- `unit` + - *string* : UnitId +- `invSlotId` + - *number* : InventorySlotId + +**Returns:** +- `texture` + - *number* : FileDataID \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemsForSlot.md b/wiki-information/functions/GetInventoryItemsForSlot.md new file mode 100644 index 00000000..e7901061 --- /dev/null +++ b/wiki-information/functions/GetInventoryItemsForSlot.md @@ -0,0 +1,72 @@ +## Title: GetInventoryItemsForSlot + +**Content:** +Returns a list of items that can be equipped in a given inventory slot. +`returnTable = GetInventoryItemsForSlot(slot, returnTable)` + +**Parameters:** +- `slot` + - *number* : InvSlotId - The inventory slot ID. +- `returnTable` + - *table* - The table that will be populated with available items. +- `transmogrify` + - *boolean?* + +**Returns:** +- `returnTable` + - *table* - A key-value table ItemLocation bitfield -> ItemLink. + +**Usage:** +Prints all items that can go in the main hand slot, one is currently equipped, the other is in the backpack. +```lua +/dump GetInventoryItemsForSlot(INVSLOT_MAINHAND, {}) +-- Output: +-- { +-- [bitfield1] = "ItemLink1", +-- [bitfield2] = "ItemLink2" +-- } +``` + +Prints the information in a more user-readable state. +```lua +local locations = { + "player", + "bank", + "bags", + "voidStorage", + "slot", + "bag", + "tab", + "voidSlot", +} + +function PrintInventoryItemsForSlot(slot) + local items = GetInventoryItemsForSlot(slot, {}) + for bitfield, link in pairs(items) do + print(link, string.format("0x%X", bitfield)) + local locs = {EquipmentManager_UnpackLocation(bitfield)} + local t = {} + for k, v in pairs(locs) do + t[k] = v or nil + end + DevTools_Dump(t) + end +end + +-- /run PrintInventoryItemsForSlot(INVSLOT_MAINHAND) +-- Example Output: +-- "ItemLink1", 0x100010 +-- player=true, +-- slot=16 +-- "ItemLink2", 0x30000A +-- player=true, +-- bags=true, +-- bag=0, +-- slot=10 +``` + +**Example Use Case:** +This function can be used to list all items that can be equipped in a specific slot, which is useful for creating custom equipment managers or transmogrification tools. + +**Addon Usage:** +Large addons like "Pawn" and "ItemRack" use this function to determine which items can be equipped in specific slots, helping players optimize their gear and manage equipment sets efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetInventorySlotInfo.md b/wiki-information/functions/GetInventorySlotInfo.md new file mode 100644 index 00000000..472cc766 --- /dev/null +++ b/wiki-information/functions/GetInventorySlotInfo.md @@ -0,0 +1,31 @@ +## Title: GetInventorySlotInfo + +**Content:** +Returns info for an equipment slot. +`invSlotId, textureName, checkRelic = GetInventorySlotInfo(invSlotName)` + +**Parameters:** +- `invSlotName` + - *string* - InventorySlotName to query (e.g. "HEADSLOT"). + +**Returns:** +- `invSlotId` + - *number* - The ID to use to refer to that slot in the other GetInventory functions. +- `textureName` + - *string* - The texture to use for the empty slot on the paper doll display. +- `checkRelic` + - *boolean* + +**Example Usage:** +```lua +local invSlotId, textureName, checkRelic = GetInventorySlotInfo("HEADSLOT") +print("Slot ID:", invSlotId) +print("Texture Name:", textureName) +print("Check Relic:", checkRelic) +``` + +**Description:** +The `GetInventorySlotInfo` function is useful for addon developers who need to interact with specific equipment slots. For example, it can be used to get the slot ID for the head slot, which can then be used in other inventory-related functions to get or set items in that slot. + +**Usage in Addons:** +Large addons like "ElvUI" and "WeakAuras" use this function to manage and display equipment slots. For instance, ElvUI uses it to customize the appearance of the character frame, while WeakAuras might use it to trigger alerts based on the player's equipped items. \ No newline at end of file diff --git a/wiki-information/functions/GetInviteConfirmationInfo.md b/wiki-information/functions/GetInviteConfirmationInfo.md new file mode 100644 index 00000000..6e97dbba --- /dev/null +++ b/wiki-information/functions/GetInviteConfirmationInfo.md @@ -0,0 +1,38 @@ +## Title: GetInviteConfirmationInfo + +**Content:** +Retrieves information about a player that could be invited. +`confirmationType, name, guid, rolesInvalid, willConvertToRaid, level, spec, itemLevel = GetInviteConfirmationInfo(invite)` + +**Parameters:** +- `invite` + - *unknown* - return value of function `GetNextPendingInviteConfirmation` + +**Returns:** +- `confirmationType` + - *number* - Integer value related to constants like `LE_INVITE_CONFIRMATION_REQUEST` +- `name` + - *string* - name of the player +- `guid` + - *string* - a string containing the hexadecimal representation of the player's GUID. Player-- (Example: "Player-976-0002FD64") +- `rolesInvalid` + - *boolean* - The player has no valid roles. +- `willConvertToRaid` + - *boolean* - Inviting this player or group will convert your party to a raid. +- `level` + - *number* - player level +- `spec` + - *number* - player specialization id. The player specialization name can be requested by `GetSpecializationInfoByID`. +- `itemLevel` + - *number* - player item level + +**Reference:** +- `GetNextPendingInviteConfirmation` + +**Related Constants:** +- `LE_INVITE_CONFIRMATION_QUEUE_WARNING = 3` +- `LE_INVITE_CONFIRMATION_RELATION_NONE = 0` +- `LE_INVITE_CONFIRMATION_RELATION_FRIEND = 1` +- `LE_INVITE_CONFIRMATION_RELATION_GUILD = 2` +- `LE_INVITE_CONFIRMATION_REQUEST = 1` +- `LE_INVITE_CONFIRMATION_SUGGEST = 2` \ No newline at end of file diff --git a/wiki-information/functions/GetInviteReferralInfo.md b/wiki-information/functions/GetInviteReferralInfo.md new file mode 100644 index 00000000..5975e00f --- /dev/null +++ b/wiki-information/functions/GetInviteReferralInfo.md @@ -0,0 +1,36 @@ +## Title: C_PartyInfo.GetInviteReferralInfo + +**Content:** +Returns info for Quick join invites. +`outReferredByGuid, outReferredByName, outRelationType, outIsQuickJoin, outClubId = C_PartyInfo.GetInviteReferralInfo(inviteGUID)` + +**Parameters:** +- `inviteGUID` + - *string* + +**Returns:** +- `outReferredByGuid` + - *string* +- `outReferredByName` + - *string* +- `outRelationType` + - *Enum.PartyRequestJoinRelation* +- `outIsQuickJoin` + - *boolean* +- `outClubId` + - *string* + +**Enum.PartyRequestJoinRelation:** +- `Value` +- `Field` +- `Description` + - `0` + - `None` + - `1` + - `Friend` + - `2` + - `Guild` + - `3` + - `Club` + - `4` + - `NumPartyRequestJoinRelations` \ No newline at end of file diff --git a/wiki-information/functions/GetItemClassInfo.md b/wiki-information/functions/GetItemClassInfo.md new file mode 100644 index 00000000..0c6d9630 --- /dev/null +++ b/wiki-information/functions/GetItemClassInfo.md @@ -0,0 +1,29 @@ +## Title: GetItemClassInfo + +**Content:** +Returns the name of the item type. +`name = GetItemClassInfo(classID)` + +**Parameters:** +- `classID` + - *number* - ID of the ItemType + +**Returns:** +- `name` + - *string* - Name of the item type + +**Usage:** +```lua +for i = 0, Enum.ItemClassMeta.NumValues-1 do + print(i, GetItemClassInfo(i)) +end +-- Output: +-- 0, Consumable +-- 1, Container +-- 2, Weapon +-- ... +``` + +**Reference:** +- `GetItemSubClassInfo` +- `GetItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetItemCooldown.md b/wiki-information/functions/GetItemCooldown.md new file mode 100644 index 00000000..45c8888d --- /dev/null +++ b/wiki-information/functions/GetItemCooldown.md @@ -0,0 +1,54 @@ +## Title: GetItemCooldown + +**Content:** +Returns cooldown info for an item ID. +`startTime, duration, enable = GetItemCooldown(itemInfo)` + +**Parameters:** +- `itemInfo` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `startTime` + - *number* - The time when the cooldown started (as returned by GetTime()) or zero if no cooldown. +- `duration` + - *number* - The number of seconds the cooldown will last, or zero if no cooldown. +- `enable` + - *number* - 1 if the item is ready or on cooldown, 0 if the item is used, but the cooldown didn't start yet (e.g. potion in combat). + +**Description:** +As of patch 4.0.1, you can no longer use this function to return the Cooldown of an item link or name, you MUST pass in the itemID. +If you need the original behavior, here is a function that simulates that function... + +```lua +function GetItemCooldown_Orig(searchItemLink) + local bagID = 1; + local bagName = GetBagName(bagID); + local searchItemName = GetItemInfo(searchItemLink); + if (searchItemName == nil) then return nil end + while (bagName ~= nil) do + local slots = GetContainerNumSlots(bagID); + for slot = 1, slots, 1 do + local _, _, _, _, _, _, itemLink = GetContainerItemInfo(bagID, slot); + if (itemLink ~= nil) then + local startTime, duration, isEnabled = GetContainerItemCooldown(bagID, slot); + if (startTime ~= nil and startTime > 0 and itemLink ~= nil) then + if (searchItemName == itemName) then + return startTime, duration, isEnabled; + end + end + end + end + -- Restart While Loop + bagID = bagID + 1; + bagName = GetBagName(bagID); + end + return nil; +end +``` + +**Example Usage:** +This function can be used to check the cooldown of a specific item in your inventory, such as a health potion or a trinket, to determine if it is ready to be used again. + +**Addons:** +Many large addons, such as WeakAuras and OmniCC, use this function to track item cooldowns and display them to the player. WeakAuras, for example, can create custom visual and audio alerts when an item comes off cooldown, while OmniCC overlays cooldown numbers directly on item icons. \ No newline at end of file diff --git a/wiki-information/functions/GetItemCount.md b/wiki-information/functions/GetItemCount.md new file mode 100644 index 00000000..ef95c162 --- /dev/null +++ b/wiki-information/functions/GetItemCount.md @@ -0,0 +1,36 @@ +## Title: GetItemCount + +**Content:** +Returns the number (or available charges) of an item in the inventory. +`count = GetItemCount(itemInfo)` + +**Parameters:** +- `itemInfo` + - *number|string* - Item ID, Link, or Name +- `includeBank` + - *boolean?* - If true, includes the bank +- `includeUses` + - *boolean?* - If true, includes each charge of an item similar to GetActionCount() +- `includeReagentBank` + - *boolean?* - If true, includes the reagent bank + +**Returns:** +- `count` + - *number* - The number of items in your possession, or charges if includeUses is true and the item has charges. + +**Usage:** +```lua +local count = GetItemCount(29434) +print("Badge of Justice:", count) + +local count = GetItemCount(33312, nil, true) +print("Mana Saphire Charges:", count) + +local clothInBags = GetItemCount("Netherweave Cloth") +local clothInTotal = GetItemCount("Netherweave Cloth", true) +print("Netherweave Cloth:", clothInBags, "(bags)", (clothInTotal - clothInBags), "(bank)") +``` + +**Reference:** +- Iriel 2007-08-27. Upcoming 2.3 Changes - Concise List. BlueTracker. Archived from the original +- slouken 2006-10-11. Re: 2.0.0 Changes - Concise List. Archived from the original \ No newline at end of file diff --git a/wiki-information/functions/GetItemFamily.md b/wiki-information/functions/GetItemFamily.md new file mode 100644 index 00000000..35329af6 --- /dev/null +++ b/wiki-information/functions/GetItemFamily.md @@ -0,0 +1,90 @@ +## Title: GetItemFamily + +**Content:** +Returns the bag type that an item can go into, or for bags the type of items that it can contain. +`bagType = GetItemFamily(item)` + +**Parameters:** +- `item` + - *number|string* : Item ID, Link or Name + +**Returns:** +- `bagType` + - *number* : ItemFamily - Bitfield of the type of bags an item can go into, or if the item is a container what it can contain. Will return nil for uncached items, like most item API. + +**Usage:** +```lua +local itemFamilyIDs = { + [0x1] = "Arrows", + [0x2] = "Bullets", + [0x4] = "Soul Shards", + [0x8] = "Leatherworking Supplies", + [0x10] = "Inscription Supplies", + [0x20] = "Herbs", + [0x40] = "Enchanting Supplies", + [0x80] = "Engineering Supplies", + [0x100] = "Keys", + [0x200] = "Gems", + [0x400] = "Mining Supplies", + [0x800] = "Soulbound Equipment", + [0x1000] = "Vanity Pets", + [0x2000] = "Currency Tokens", + [0x4000] = "Quest Items", + [0x8000] = "Fishing Supplies", + [0x10000] = "Cooking Supplies", + [0x20000] = "Toys", + [0x40000] = "Archaeology", + [0x80000] = "Alchemy", + [0x100000] = "Blacksmithing", + [0x200000] = "First Aid", + [0x400000] = "Jewelcrafting", + [0x800000] = "Skinning", + [0x1000000] = "Tailoring", +} +local itemFamilyFlags = {} +for k, v in pairs(itemFamilyIDs) do + itemFamilyFlags[k] = v +end +local function PrintItemFamily(item) + local bagType = GetItemFamily(item) + print(format("0x%X", bagType)) + for k, v in pairs(itemFamilyFlags) do + if bit.band(bagType, k) > 0 then + print(format("0x%X, %s", k, v)) + end + end +end +PrintItemFamily(22786) -- Dreaming Glory +-- 0x200020 +-- 0x20, Herbs +-- 0x200000, Alchemy +PrintItemFamily(190395) -- Serevite Ore +-- 0x1400480 +-- 0x80, Engineering Supplies +-- 0x400, Mining Supplies +-- 0x400000, Blacksmithing +-- 0x1000000, Jewelcrafting +PrintItemFamily(37700) -- Crystallized Air +-- 0x4004C8 +-- 0x8, Leatherworking Supplies +-- 0x40, Enchanting Supplies +-- 0x80, Engineering Supplies +-- 0x400, Mining Supplies +-- 0x400000, Blacksmithing +PrintItemFamily(38347) -- Mammoth Mining Bag +-- 0x400 +-- 0x400, Mining Supplies +``` + +**Description:** +To simply check if an item is a bag, with itemEquipLoc: +```lua +select(9, GetItemInfo(item)) == "INVTYPE_BAG" +``` +Checking if an item is a specific type of bag, with item subclassID: +```lua +select(13, GetItemInfo(item)) == 4 -- Engineering Bag +``` + +**Reference:** +- `C_Container.GetContainerNumFreeSlots` - Returns the number of free slots & the bagType that an equipped bag or backpack belongs to. \ No newline at end of file diff --git a/wiki-information/functions/GetItemGem.md b/wiki-information/functions/GetItemGem.md new file mode 100644 index 00000000..b3cd71b2 --- /dev/null +++ b/wiki-information/functions/GetItemGem.md @@ -0,0 +1,27 @@ +## Title: GetItemGem + +**Content:** +Returns the gem for a socketed equipment item. +`itemName, itemLink = GetItemGem(item, index)` + +**Parameters:** +- `item` + - *string* - The name of the equipment item (the item must be equipped or in your inventory for this to work) or the ItemLink +- `index` + - *number* - The index of the desired gem: 1, 2, or 3 + +**Returns:** +- `itemName` + - *string* - The name of the gem at the specified index. +- `itemLink` + - *string* - ItemLink + +**Description:** +Using the name may be ambiguous if you have more than one of the named item. + +**Usage:** +Prints the 2nd gem socketed in this item. +```lua +local link = "|cff0070dd|Hitem:87451:::41438:::::53:257:::1:6658:2:9:35:28:1035:::|h|h|r" +print(GetItemGem(link, 2)) -- "Perfect Brilliant Bloodstone", "|cff1eff00|Hitem:41438::::::::53:257:::::::|h|h|r" +``` \ No newline at end of file diff --git a/wiki-information/functions/GetItemIcon.md b/wiki-information/functions/GetItemIcon.md new file mode 100644 index 00000000..754e0d01 --- /dev/null +++ b/wiki-information/functions/GetItemIcon.md @@ -0,0 +1,16 @@ +## Title: GetItemIcon + +**Content:** +Returns the icon texture for an item. +`icon = GetItemIcon(itemID)` + +**Parameters:** +- `itemID` + - *number* - The ID of the item to query e.g. 23405 for . + +**Returns:** +- `icon` + - *number* : FileID - Icon texture used by the item. + +**Description:** +Unlike `GetItemInfo()`, this function does not require the item to be readily available from the item cache. \ No newline at end of file diff --git a/wiki-information/functions/GetItemInfo.md b/wiki-information/functions/GetItemInfo.md new file mode 100644 index 00000000..e49369ce --- /dev/null +++ b/wiki-information/functions/GetItemInfo.md @@ -0,0 +1,86 @@ +## Title: C_Item.GetItemInfo + +**Content:** +Returns info for an item. +`itemName, itemLink, itemQuality, itemLevel, itemMinLevel, itemType, itemSubType, itemStackCount, itemEquipLoc, itemTexture, sellPrice, classID, subclassID, bindType, expansionID, setID, isCraftingReagent = C_Item.GetItemInfo(itemInfo)` + +**Parameters:** +- `item` + - *number|string* : Item ID, Link or Name + - Accepts any valid item ID but returns nil if the item is not cached yet. + - Accepts an item link, or minimally in item:%d format. + - Accepts a localized item name but this requires the item to be or have been in the player's inventory (bags/bank) for that session. + +**Returns:** +Returns nil if the item is not cached yet or does not exist. +1. `itemName` + - *string* - The localized name of the item. +2. `itemLink` + - *string : ItemLink* - The localized link of the item. +3. `itemQuality` + - *number : Enum.ItemQuality* - The quality of the item, e.g. 2 for Uncommon and 3 for Rare quality items. +4. `itemLevel` + - *number* - The base item level, not including upgrades. See GetDetailedItemLevelInfo() for getting the actual item level. +5. `itemMinLevel` + - *number* - The minimum level required to use the item, or 0 if there is no level requirement. +6. `itemType` + - *string : ItemType* - The localized type name of the item: Armor, Weapon, Quest, etc. +7. `itemSubType` + - *string : ItemType* - The localized sub-type name of the item: Bows, Guns, Staves, etc. +8. `itemStackCount` + - *number* - The max amount of an item per stack, e.g. 200 for Runecloth. +9. `itemEquipLoc` + - *string : ItemEquipLoc* - The inventory equipment location in which the item may be equipped e.g. "INVTYPE_HEAD", or an empty string if it cannot be equipped. +10. `itemTexture` + - *number : FileID* - The texture for the item icon. +11. `sellPrice` + - *number* - The vendor price in copper, or 0 for items that cannot be sold. +12. `classID` + - *number : ItemType* - The numeric ID of itemType +13. `subclassID` + - *number : ItemType* - The numeric ID of itemSubType +14. `bindType` + - *number : Enum.ItemBind* - When the item becomes soulbound, e.g. 1 for Bind on Pickup items. +15. `expansionID` + - *number : LE_EXPANSION* - The related Expansion, e.g. 8 for Shadowlands. On Classic this appears to be always 254. +16. `setID` + - *number? : ItemSetID* - For example 761 for (itemID 21524). +17. `isCraftingReagent` + - *boolean* - Whether the item can be used as a crafting reagent. + +**Usage:** +Prints item information for +```lua +/dump GetItemInfo(4306) +-- Returns: +-- "Silk Cloth", -- itemName +-- "|cffffffff|Hitem:4306::::::::53:258:::::::|h|h|r", -- itemLink +-- 1, -- itemQuality: Enum.ItemQuality.Common +-- 13, -- itemLevel +-- 0, -- itemMinLevel +-- "Tradeskill", -- itemType +-- "Cloth", -- itemSubType +-- 200, -- itemStackCount +-- "", -- itemEquipLoc +-- 132905, -- itemTexture +-- 150, -- sellPrice +-- 7, -- classID: LE_ITEM_CLASS_TRADEGOODS +-- 5, -- subclassID +-- 0, -- bindType: Enum.ItemBind.None +-- 0, -- expansionID: LE_EXPANSION_CLASSIC +-- nil, -- setID +-- true -- isCraftingReagent +``` + +Item information may not have been cached. You can use `ItemMixin:ContinueOnItemLoad()` to asynchronously query the data. +```lua +local item = Item:CreateFromItemID(21524) +item:ContinueOnItemLoad(function() + local name = item:GetItemName() + local icon = item:GetItemIcon() + print(name, icon) -- "Red Winter Hat", 133169 +end) +``` + +**Reference:** +- `GetItemInfoInstant()` \ No newline at end of file diff --git a/wiki-information/functions/GetItemInfoInstant.md b/wiki-information/functions/GetItemInfoInstant.md new file mode 100644 index 00000000..59cec82e --- /dev/null +++ b/wiki-information/functions/GetItemInfoInstant.md @@ -0,0 +1,45 @@ +## Title: C_Item.GetItemInfoInstant + +**Content:** +Returns readily available info for an item. +`itemID, itemType, itemSubType, itemEquipLoc, icon, classID, subClassID = C_Item.GetItemInfoInstant(itemInfo)` + +**Parameters:** +- `item` + - *number|string* : Item ID, Link or Name + - Accepts any valid item ID. + - Accepts an item link, or minimally in item:%d format. + - Accepts a localized item name but this requires the item to be or have been in the player's inventory (bags/bank) for that session. + +**Returns:** +- `itemID` + - *number* - ID of the item. +- `itemType` + - *string* : ItemType - The localized type name of the item: Armor, Weapon, Quest, etc. +- `itemSubType` + - *string* : ItemType - The localized sub-type name of the item: Bows, Guns, Staves, etc. +- `itemEquipLoc` + - *string* : ItemEquipLoc - The inventory equipment location in which the item may be equipped e.g. "INVTYPE_HEAD", or an empty string if it cannot be equipped. +- `icon` + - *number* : fileID - The texture for the item icon. +- `classID` + - *number* : ItemType - The numeric ID of itemType +- `subClassID` + - *number* : ItemType - The numeric ID of itemSubType + +**Description:** +This function only returns info that doesn't require a query to the server. Which has the advantage over `GetItemInfo()` as it will always return data for valid items. + +**Usage:** +Prints item information for +```lua +/dump GetItemInfoInstant(4306) +-- Output: +-- 4306, -- itemID +-- "Tradeskill", -- itemType +-- "Cloth", -- itemSubType +-- "", -- itemEquipLoc +-- 132905, -- icon +-- 7, -- classID +-- 5 -- subclassID +``` \ No newline at end of file diff --git a/wiki-information/functions/GetItemQualityColor.md b/wiki-information/functions/GetItemQualityColor.md new file mode 100644 index 00000000..59ea3fe9 --- /dev/null +++ b/wiki-information/functions/GetItemQualityColor.md @@ -0,0 +1,49 @@ +## Title: GetItemQualityColor + +**Content:** +Returns the color for an item quality. +`r, g, b, hex = GetItemQualityColor(quality)` + +**Parameters:** +- `quality` + - *Enum.ItemQuality* - The quality of the item. + +**Returns:** +- `r` + - *number* - Red component of the color (0 to 1, inclusive). +- `g` + - *number* - Green component of the color (0 to 1, inclusive). +- `b` + - *number* - Blue component of the color (0 to 1, inclusive). +- `hex` + - *string* - UI escape sequence for this color, without the leading `|c`. + +**Description:** +It is recommended to use the global `ITEM_QUALITY_COLORS` table instead of repeatedly calling this function. +In particular, `ITEM_QUALITY_COLORS.hex` already includes the leading `|c` escape sequence whereas the fourth return value of this function does not. +If an invalid quality index is specified, `GetItemQualityColor()` returns white (same as index 1): +- `r = 1` +- `g = 1` +- `b = 1` +- `hex = |cffffffff` + +**Usage:** +```lua +for i = 0, 8 do + local r, g, b, hex = GetItemQualityColor(i) + print(i, '|c'..hex, _G, string.sub(hex, 3)) +end +``` + +**Miscellaneous:** +**Result:** +Will print all qualities, in their individual colors. +- 0 Poor 9d9d9d +- 1 Common ffffff +- 2 Uncommon 1eff00 +- 3 Rare 0070dd +- 4 Epic a335ee +- 5 Legendary ff8000 +- 6 Artifact e6cc80 +- 7 Heirloom 00ccff +- 8 WoW Token 00ccff \ No newline at end of file diff --git a/wiki-information/functions/GetItemSpecInfo.md b/wiki-information/functions/GetItemSpecInfo.md new file mode 100644 index 00000000..1592c78b --- /dev/null +++ b/wiki-information/functions/GetItemSpecInfo.md @@ -0,0 +1,23 @@ +## Title: GetItemSpecInfo + +**Content:** +Returns which specializations an item is useful for. +`specTable = GetItemSpecInfo(itemLink or itemID or itemName)` + +**Parameters:** +- `itemLink` or `itemID` or `itemName` + - *Mixed* - link, id, or name of the item to query. +- `specTable` + - *table* - if provided, this table will be populated with the results and returned; otherwise, a new table will be created. + +**Returns:** +- `specTable` + - *table* - if the item is flagged as being for specific specializations, an array containing the SpecializationIDs of specializations of the player's class for which the queried item is suitable; nil if information is unavailable. + +**Description:** +The supplied specTable is not wiped; only the array keys necessary to return the result are modified. +Spec information is only available for some items. +The returned specialization IDs are not sorted. You can use `table.sort` to bring them into the same order as the Specialization pane displays. + +**Reference:** +- `GetSpecializationInfoByID` \ No newline at end of file diff --git a/wiki-information/functions/GetItemSpell.md b/wiki-information/functions/GetItemSpell.md new file mode 100644 index 00000000..48369dcd --- /dev/null +++ b/wiki-information/functions/GetItemSpell.md @@ -0,0 +1,25 @@ +## Title: GetItemSpell + +**Content:** +Returns the spell effect for an item. +`spellName, spellID = GetItemSpell(itemID or itemString or itemName or itemLink)` + +**Parameters:** +One of the following four ways to specify which item to query: +- `itemId` + - *number* - Numeric ID of the item. +- `itemName` + - *string* - Name of an item owned by the player at some point during this session. +- `itemString` + - *string* - A fragment of the itemString for the item, e.g. `"item:30234:0:0:0:0:0:0:0"` or `"item:30234"`. +- `itemLink` + - *string* - The full itemLink. + +**Returns:** +- `spellName` + - *string* - The name of the spell. +- `spellID` + - *number* - The spell's unique identifier. + +**Description:** +Useful for determining whether an item is usable. \ No newline at end of file diff --git a/wiki-information/functions/GetItemStats.md b/wiki-information/functions/GetItemStats.md new file mode 100644 index 00000000..88ac70c0 --- /dev/null +++ b/wiki-information/functions/GetItemStats.md @@ -0,0 +1,43 @@ +## Title: GetItemStats + +**Content:** +Returns a table of stats for an item. +`stats = GetItemStats(itemLink)` + +**Parameters:** +- `itemLink` + - *String* - An item link for which to get stats. +- `statTable` + - *Table* - An optional, empty table that will be filled with stats and returned. If this parameter is omitted, a new table is returned. + +**Returns:** +- `stats` + - *Table* - A table of item stats. If `statTable` was supplied, it will also be returned. + +**Usage:** +The key for each entry in the dictionary is the name of a constant in `Interface\\FrameXML\\GlobalStrings.lua`, and the value of that constant is the localized name for the stat. For example, an item that has 10 Stamina and no other stats would return `{ "ITEM_MOD_STAMINA_SHORT" = 10 }`. + +```lua +stats = GetItemStats(GetInventoryItemLink("player", 16)) +DEFAULT_CHAT_FRAME:AddMessage("Your main hand item has " .. tostring(stats or 0) .. " " .. ITEM_MOD_STAMINA_SHORT .. ".") +``` + +This would return something like: +``` +Your main hand item has 10 Stamina. +``` + +The stat table contains the stats for the "base" version of an item, without any enchantments or gems. There is no way to get the stats for the gemmed and enchanted version of an item. + +**Description:** +If `statTable` is supplied, it should be empty. `GetItemStats` will add the stats of the item to this table without clearing it first. Stats left over from a previous call to `GetItemStats` will be overwritten if present on the new item. For example, if the table already contains 10 Strength and 20 Stamina and `GetItemStats` is called on an item with 30 Intellect and 30 Stamina, the new table will contain 10 Strength, 30 Intellect, and 30 Stamina, not 50 Stamina. + +```lua +local stats = {} +GetItemStats("item:41002", stats) +table.wipe(stats) +GetItemStats("item:41003", stats) +``` + +**Example Use Case:** +This function can be used in addons that need to display or process item stats, such as gear comparison tools or inventory management addons. For instance, the popular addon Pawn uses similar functionality to evaluate and compare the stats of different items to help players choose the best gear. \ No newline at end of file diff --git a/wiki-information/functions/GetItemSubClassInfo.md b/wiki-information/functions/GetItemSubClassInfo.md new file mode 100644 index 00000000..2a10cd02 --- /dev/null +++ b/wiki-information/functions/GetItemSubClassInfo.md @@ -0,0 +1,50 @@ +## Title: GetItemSubClassInfo + +**Content:** +Returns the name of the item subtype. +`name, isArmorType = GetItemSubClassInfo(classID, subClassID)` + +**Parameters:** +- `classID` + - *number* - ID of the ItemType +- `subClassID` + - *number* - ID of the item subtype + +**Returns:** +- `name` + - *string* - Name of the item subtype +- `isArmorType` + - *boolean* - Seems to only return true for classID 4: Armor - subClassID 0 to 4 Miscellaneous, Cloth, Leather, Mail, Plate + +**Usage:** +Prints the Herbalism subtype for the Profession itemtype. +```lua +print(GetItemSubClassInfo(Enum.ItemClass.Profession, Enum.ItemProfessionSubclass.Herbalism)) +-- "Herbalism", false +``` + +Prints the info of all Profession subtypes. +```lua +for i = Enum.ItemProfessionSubclassMeta.MinValue, Enum.ItemProfessionSubclassMeta.MaxValue do + print(i, GetItemSubClassInfo(Enum.ItemClass.Profession, i)) +end +-- Output: +-- 0, "Blacksmithing", false +-- 1, "Leatherworking", false +-- 2, "Alchemy", false +-- 3, "Herbalism", false +-- 4, "Cooking", false +-- 5, "Mining", false +-- 6, "Tailoring", false +-- 7, "Engineering", false +-- 8, "Enchanting", false +-- 9, "Fishing", false +-- 10, "Skinning", false +-- 11, "Jewelcrafting", false +-- 12, "Inscription", false +-- 13, "Archaeology", false +``` + +**Reference:** +- `GetItemClassInfo` +- `GetItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetLFGBootProposal.md b/wiki-information/functions/GetLFGBootProposal.md new file mode 100644 index 00000000..24c13c77 --- /dev/null +++ b/wiki-information/functions/GetLFGBootProposal.md @@ -0,0 +1,32 @@ +## Title: GetLFGBootProposal + +**Content:** +Returns info for a LFG votekick in progress. +`inProgress, didVote, myVote, targetName, totalVotes, bootVotes, timeLeft, reason = GetLFGBootProposal()` + +**Returns:** +- `inProgress` + - *boolean* - true if a Kick vote is currently in progress, false otherwise. +- `didVote` + - *boolean* - true if you have already voted, false otherwise. +- `myVote` + - *boolean* - true if you've voted to kick the player, false otherwise. +- `targetName` + - *string* - name of the player being voted on. +- `totalVotes` + - *number* - total votes cast so far. +- `bootVotes` + - *number* - votes in favor of kicking the player cast so far. +- `timeLeft` + - *number* - amount of time left to vote. +- `reason` + - *string* - reason given for initiating a vote kick vote against a player. + +**Reference:** +- `LFG_BOOT_PROPOSAL_UPDATE` + +**Example Usage:** +This function can be used in addons that manage or monitor group activities, such as those that provide enhanced LFG (Looking For Group) functionalities. For instance, an addon could use this function to display a custom UI element showing the status of a votekick, including who is being voted on and how much time is left to vote. + +**Addons Using This Function:** +Large addons like Deadly Boss Mods (DBM) or ElvUI might use this function to provide additional context or alerts during group activities, ensuring that players are aware of ongoing votekicks and can participate in the decision-making process. \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDeserterExpiration.md b/wiki-information/functions/GetLFGDeserterExpiration.md new file mode 100644 index 00000000..76946a4e --- /dev/null +++ b/wiki-information/functions/GetLFGDeserterExpiration.md @@ -0,0 +1,27 @@ +## Title: GetLFGDeserterExpiration + +**Content:** +Returns the time at which you may once again use the dungeon finder after prematurely leaving a group. +`expiryTime = GetLFGDeserterExpiration()` + +**Returns:** +- `expiryTime` + - *number?* - time (GetTime() value) at which you may once again use the dungeon finder; nil if you're not currently under the effects of the deserter penalty. + +**Reference:** +- `GetLFGRandomCooldownExpiration` +- `UnitHasLFGDeserter` + +**Example Usage:** +```lua +local expiryTime = GetLFGDeserterExpiration() +if expiryTime then + print("You can use the dungeon finder again at: " .. date("%Y-%m-%d %H:%M:%S", expiryTime)) +else + print("You are not currently under the deserter penalty.") +end +``` + +**Addons Using This Function:** +- **DBM (Deadly Boss Mods):** Utilizes this function to inform players about their deserter status and when they can rejoin the dungeon finder. +- **ElvUI:** Uses this function to display cooldown timers for various penalties, including the deserter debuff, in its user interface. \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonEncounterInfo.md b/wiki-information/functions/GetLFGDungeonEncounterInfo.md new file mode 100644 index 00000000..22fee11e --- /dev/null +++ b/wiki-information/functions/GetLFGDungeonEncounterInfo.md @@ -0,0 +1,31 @@ +## Title: GetLFGDungeonEncounterInfo + +**Content:** +Returns info about a specific encounter in an LFG/RF dungeon. +`bossName, texture, isKilled, unknown4 = GetLFGDungeonEncounterInfo(dungeonID, encounterIndex)` + +**Parameters:** +- `dungeonID` + - *number* - Ranging from 1 to around 2000 in patch 8.1.5 +- `encounterIndex` + - *number* - Index from 1 to `GetLFGDungeonNumEncounters()`. For multi-part raids, many bosses will never be accessible to players because they were in an earlier 'wing'. + +**Returns:** +- `bossName` + - *string* - The localized name of the encounter in question +- `texture` + - *string* - The file path for a texture associated with the encounter, usually an achievement icon. If Blizzard hasn't designated one for the encounter, expect this return to be nil. +- `isKilled` + - *boolean* - True if you have killed/looted the boss since the last reset period +- `unknown4` + - *boolean* - Unused by Blizzard, has an unknown purpose, and seems to always be false + +**Usage:** +```lua +/dump GetLFGDungeonEncounterInfo(610,1) +-- => "Jin'rokh the Breaker", nil, true, false +``` + +**Reference:** +- `GetSavedInstanceEncounterInfo` - A moderately similar function to this one, except it works off of saved instance indexes instead of dungeon IDs. +- `GetLFGDungeonInfo` - A more generic function; it allows you to pull up information on the dungeon itself instead of the individual encounters. \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonInfo.md b/wiki-information/functions/GetLFGDungeonInfo.md new file mode 100644 index 00000000..51025945 --- /dev/null +++ b/wiki-information/functions/GetLFGDungeonInfo.md @@ -0,0 +1,63 @@ +## Title: GetLFGDungeonInfo + +**Content:** +Returns info for a LFG dungeon. +```lua +name, typeID, subtypeID, minLevel, maxLevel, recLevel, minRecLevel, maxRecLevel, expansionLevel, groupID, textureFilename, difficulty, maxPlayers, description, isHoliday, bonusRepAmount, minPlayers, isTimeWalker, name2, minGearLevel, isScalingDungeon, lfgMapID = GetLFGDungeonInfo(dungeonID) +``` + +**Parameters:** +- `dungeonID` + - *number* : LfgDungeonID + +**Returns:** +1. `name` + - *string* - The name of the dungeon/event +2. `typeID` + - *number* - 1=TYPEID_DUNGEON or LFR, 2=raid instance, 4=outdoor area, 6=TYPEID_RANDOM_DUNGEON +3. `subtypeID` + - *number* - 0=Unknown, 1=LFG_SUBTYPEID_DUNGEON, 2=LFG_SUBTYPEID_HEROIC, 3=LFG_SUBTYPEID_RAID, 4=LFG_SUBTYPEID_SCENARIO, 5=LFG_SUBTYPEID_FLEXRAID +4. `minLevel` + - *number* - Earliest level permitted to walk into the instance portal +5. `maxLevel` + - *number* - Highest level permitted to walk into the instance portal +6. `recLevel` + - *number* - Recommended level to queue for this dungeon +7. `minRecLevel` + - *number* - Earliest level to queue for this dungeon +8. `maxRecLevel` + - *number* - Highest level to queue for this dungeon +9. `expansionLevel` + - *number* - Refers to GetAccountExpansionLevel() values +10. `groupID` + - *number* - Unknown +11. `textureFilename` + - *string* - For example "Interface\\LFDFRAME\\LFGIcon-%s.blp" where %s is the textureFilename value +12. `difficulty` + - *number* : DifficultyID +13. `maxPlayers` + - *number* - Maximum players allowed +14. `description` + - *string* - Usually empty for most dungeons but events contain descriptions of the event, like Love is in the Air daily or Brewfest, e.g. (string) +15. `isHoliday` + - *boolean* - If true then this is a holiday event +16. `bonusRepAmount` + - *number* - Unknown +17. `minPlayers` + - *number* - Minimum number of players (before the group disbands?); usually nil +18. `isTimeWalker` + - *boolean* - If true then it's Timewalking Dungeon +19. `name2` + - *string* - Currently unknown. Note: seems to show the alternative name used by the Instance Lockout interface, as returned by GetSavedInstanceInfo(). +20. `minGearLevel` + - *number* - The minimum average item level to queue for this dungeon; may be 0 if item level is ignored. +21. `isScalingDungeon` + - *boolean* +22. `lfgMapID` + - *number* : InstanceID + +**Reference:** +- `GetSavedInstanceInfo` - A similar function to this, except for the player's saved dungeon/raid lockout data (does not include Raid Finder) +- `GetSavedWorldBossInfo` - A similar function to this, except for the player's saved world boss lockout data +- `GetRFDungeonInfo` - Almost completely identical; this function uses Raid Finder indexes instead of dungeon IDs +- `GetLFGDungeonEncounterInfo` - A more specific function; this lets you check up on the individual encounters within a given LFG Dungeon \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonNumEncounters.md b/wiki-information/functions/GetLFGDungeonNumEncounters.md new file mode 100644 index 00000000..4c070c8b --- /dev/null +++ b/wiki-information/functions/GetLFGDungeonNumEncounters.md @@ -0,0 +1,20 @@ +## Title: GetLFGDungeonNumEncounters + +**Content:** +Returns the number of encounters and number of completed encounters for a specified dungeon ID. +`numEncounters, numCompleted = GetLFGDungeonNumEncounters(dungeonID)` + +**Parameters:** +- `dungeonID` + - *number* : LfgDungeonID + +**Returns:** +- `numEncounters` + - *number* - Number of encounters in the specified dungeon. +- `numCompleted` + - *number* - Number of completed encounters in the specified dungeon. + +**Reference:** +- `GetLFGDungeonInfo` +- `GetRFDungeonInfo` +- `GetLFGDungeonEncounterInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md b/wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md new file mode 100644 index 00000000..131215b8 --- /dev/null +++ b/wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md @@ -0,0 +1,32 @@ +## Title: GetLFGDungeonRewardCapBarInfo + +**Content:** +Returns the weekly limits reward for a currency (e.g. Valor Point Cap). +`VALOR_TIER1_LFG_ID = 301` +`currencyID, DungeonID, Quantity, Limit, overallQuantity, overallLimit, periodPurseQuantity, periodPurseLimit, purseQuantity, purseLimit = GetLFGDungeonRewardCapBarInfo(VALOR_TIER1_LFG_ID)` + +**Parameters:** +- `VALOR_TIER1_LFG_ID` + - *Number* - ID of the dungeon type for which information is being sought (currently 301) + +**Returns:** +- `currencyID` + - *number* - ID for the currency +- `DungeonID` + - *number* - ID for the dungeon type +- `Quantity` + - *number* - Quantity gained from basic dungeons +- `Limit` + - *number* - Limit gained from basic dungeons +- `overallQuantity` + - *number* - Quantity gained from high-end dungeons (Zandalari) +- `overallLimit` + - *number* - Limit gained from high-end dungeons (Zandalari) +- `periodPurseQuantity` + - *number* - Quantity gained from all sources (raids) +- `periodPurseLimit` + - *number* - Limit gained from all sources (raids) +- `purseQuantity` + - *number* - Currently possessed amount +- `purseLimit` + - *number* - Limit for possessed amount \ No newline at end of file diff --git a/wiki-information/functions/GetLFGRoles.md b/wiki-information/functions/GetLFGRoles.md new file mode 100644 index 00000000..8cd2241a --- /dev/null +++ b/wiki-information/functions/GetLFGRoles.md @@ -0,0 +1,15 @@ +## Title: GetLFGRoles + +**Content:** +Returns the roles the player signed up for in the Dungeon Finder. +`isLeader, isTank, isHealer, isDPS = GetLFGRoles()` + +**Returns:** +- `isLeader` + - *boolean* - if you signed up as a candidate for group leader +- `isTank` + - *boolean* - if you signed up as a tank +- `isHealer` + - *boolean* - if you signed up as a healer +- `isDPS` + - *boolean* - if you signed up as DPS \ No newline at end of file diff --git a/wiki-information/functions/GetLanguageByIndex.md b/wiki-information/functions/GetLanguageByIndex.md new file mode 100644 index 00000000..fcad727e --- /dev/null +++ b/wiki-information/functions/GetLanguageByIndex.md @@ -0,0 +1,74 @@ +## Title: GetLanguageByIndex + +**Content:** +Returns the languages that the character can speak by index. +`language, languageID = GetLanguageByIndex(index)` + +**Parameters:** +- `index` + - *number* - Ranging from 1 up to `GetNumLanguages()` + +**Values:** +- `ID` +- `Name` +- `Patch` + - 1: Orcish + - 2: Darnassian + - 3: Taurahe + - 6: Dwarvish + - 7: Common + - 8: Demonic + - 9: Titan + - 10: Thalassian + - 11: Draconic + - 12: Kalimag + - 13: Gnomish + - 14: Zandali + - 33: Forsaken (1.0.0) + - 35: Draenei (2.0.0) + - 36: Zombie (2.4.3) + - 37: Gnomish Binary (2.4.3) + - 38: Goblin Binary (2.4.3) + - 39: Gilnean (4.0.1) + - 40: Goblin (4.0.1) + - 42: Pandaren (5.0.3) + - 43: Pandaren (5.0.3) + - 44: Pandaren (5.0.3) + - 168: Sprite (5.0.3) + - 178: Shath'Yar (6.x / 7.x) + - 179: Nerglish (6.x / 7.x) + - 180: Moonkin (6.x / 7.x) + - 181: Shalassian (7.3.5) + - 182: Thalassian (7.3.5) + - 285: Vulpera (8.3.0) + - 287: Complex Cipher (9.2.0) + - 288: Basic Cypher (9.2.0) + - 290: Metrial (9.2.0) + - 291: Altonian (9.2.0) + - 292: Sopranian (9.2.0) + - 293: Aealic (9.2.0) + - 294: Dealic (9.2.0) + - 295: Trebelim (9.2.0) + - 296: Bassalim (9.2.0) + - 297: Embedded Languages (9.2.0) + - 298: Unknowable (9.2.0) + - 303: Furbolg (10.0.7) + +**Returns:** +- `language` + - *string* +- `languageID` + - *number* - LanguageID + +**Usage:** +Prints the available languages for the player. +```lua +for i = 1, GetNumLanguages() do + print(GetLanguageByIndex(i)) +end +``` +-- e.g. for Blood elf +```lua +> "Orcish", 1 +> "Thalassian", 10 +``` \ No newline at end of file diff --git a/wiki-information/functions/GetLatestThreeSenders.md b/wiki-information/functions/GetLatestThreeSenders.md new file mode 100644 index 00000000..532f35a4 --- /dev/null +++ b/wiki-information/functions/GetLatestThreeSenders.md @@ -0,0 +1,9 @@ +## Title: GetLatestThreeSenders + +**Content:** +Returns up to three senders of unread mail. +`sender1, sender2, sender3 = GetLatestThreeSenders()` + +**Returns:** +- `sender1, sender2, sender3` + - *String/nil* - Name of the sender ("Bob", "Alliance Auction House", ...), or nil if unavailable. \ No newline at end of file diff --git a/wiki-information/functions/GetLocale.md b/wiki-information/functions/GetLocale.md new file mode 100644 index 00000000..16c38f96 --- /dev/null +++ b/wiki-information/functions/GetLocale.md @@ -0,0 +1,35 @@ +## Title: GetLocale + +**Content:** +Returns the game client locale. +`locale = GetLocale()` + +**Returns:** +- `locale` + - *string* + +**Usage:** +```lua +if GetLocale() == "frFR" then + print("bonjour") +else + print("hello") +end +``` + +**Parameters:** +- `localeId` +- `localeName` + +**Description:** +1. `enUS` - English (United States) (enGB clients return enUS) +2. `koKR` - Korean (Korea) +3. `frFR` - French (France) +4. `deDE` - German (Germany) +5. `zhCN` - Chinese (Simplified, PRC) +6. `esES` - Spanish (Spain) +7. `zhTW` - Chinese (Traditional, Taiwan) +8. `esMX` - Spanish (Mexico) +9. `ruRU` - Russian (Russia) +10. `ptBR` - Portuguese (Brazil) +11. `itIT` - Italian (Italy) \ No newline at end of file diff --git a/wiki-information/functions/GetLootInfo.md b/wiki-information/functions/GetLootInfo.md new file mode 100644 index 00000000..70d9b47a --- /dev/null +++ b/wiki-information/functions/GetLootInfo.md @@ -0,0 +1,30 @@ +## Title: GetLootInfo + +**Content:** +Returns a table with all of the loot info for the current loot window. +`info = GetLootInfo()` + +**Returns:** +- `info` + - *table* + - `Field` + - `Type` + - `Description` + - `isQuestItem` + - *boolean?* + - `item` + - *string* - Item Name, e.g. "Linen Cloth" or "65 Copper" + - `locked` + - *boolean* - Whether you are eligible to loot this item or not. Locked items are by default shown tinted red. + - `quality` + - *number* - Item Quality + - `quantity` + - *number* - The quantity of the item in a stack. The quantity for coin is always 0. + - `roll` + - *boolean* + - `texture` + - *number* - Texture FileID + +**Reference:** +- `GetLootSlotInfo` +- `LOOT_READY` - When this event fires, the function will have new data available. \ No newline at end of file diff --git a/wiki-information/functions/GetLootMethod.md b/wiki-information/functions/GetLootMethod.md new file mode 100644 index 00000000..a6809241 --- /dev/null +++ b/wiki-information/functions/GetLootMethod.md @@ -0,0 +1,13 @@ +## Title: GetLootMethod + +**Content:** +Returns the current loot method. +`lootmethod, masterlooterPartyID, masterlooterRaidID = GetLootMethod()` + +**Returns:** +- `lootmethod` + - *string (LootMethod)* - One of 'freeforall', 'roundrobin', 'master', 'group', 'needbeforegreed', 'personalloot'. Appears to be 'freeforall' if you are not grouped. +- `masterlooterPartyID` + - *number* - Returns 0 if player is the master looter, 1-4 if party member is master looter (corresponding to party1-4) and nil if the master looter isn't in the player's party or master looting is not used. +- `masterlooterRaidID` + - *number* - Returns index of the master looter in the raid (corresponding to a raidX unit), or nil if the player is not in a raid or master looting is not used. \ No newline at end of file diff --git a/wiki-information/functions/GetLootRollItemInfo.md b/wiki-information/functions/GetLootRollItemInfo.md new file mode 100644 index 00000000..aa6816f0 --- /dev/null +++ b/wiki-information/functions/GetLootRollItemInfo.md @@ -0,0 +1,48 @@ +## Title: GetLootRollItemInfo + +**Content:** +Returns information about the loot event with rollID. +`texture, name, count, quality, bindOnPickUp, canNeed, canGreed, canDisenchant, reasonNeed, reasonGreed, reasonDisenchant, deSkillRequired, canTransmog = GetLootRollItemInfo(rollID)` + +**Parameters:** +- `rollID` + - *number* - The number increments by 1 for each new roll. The count is not reset by reloading the UI. + +**Returns:** +- `texture` + - *string* - The path of the texture of the item icon. +- `name` + - *string* - The name of the item. +- `count` + - *number* - The quantity of the item. +- `quality` + - *number* - The quality of the item. Starting with 1 for common, going up to 5 for legendary. +- `bindOnPickUp` + - *boolean* - Returns 1 when the item is bind on pickup, nil otherwise. +- `canNeed` + - *boolean* - Returns 1 when you can roll need on the item, nil otherwise. +- `canGreed` + - *boolean* - Returns 1 when you can roll greed on the item, nil otherwise. +- `canDisenchant` + - *boolean* - Returns 1 when you can disenchant the item, nil otherwise. +- `reasonNeed` + - *number* - See details. +- `reasonGreed` + - *number* - See details. +- `reasonDisenchant` + - *number* - See details. +- `deSkillRequired` + - *number* - Required skill in enchanting to disenchant the item. +- `canTransmog` + - *boolean* - Returns 1 when you can transmogrify the item, nil otherwise. + +**Description:** +The return values `reasonNeed`/`reasonGreed`/`reasonDisenchant` can be numbers from 0 to 5. The following logic is used in FrameXML: +If the player cannot roll need/greed/disenchant, the respective loot button is disabled and gets a tooltip from one of the following global strings, where the number is determined by the return values `reasonNeed`/`reasonGreed`/`reasonDisenchant`: +- `LOOT_ROLL_INELIGIBLE_REASON1`: "Your class may not roll need on this item." +- `LOOT_ROLL_INELIGIBLE_REASON2`: "You already have the maximum amount of this item." +- `LOOT_ROLL_INELIGIBLE_REASON3`: "This item may not be disenchanted." +- `LOOT_ROLL_INELIGIBLE_REASON4`: "You do not have an Enchanter of skill %d in your group." +- `LOOT_ROLL_INELIGIBLE_REASON5`: "Need rolls are disabled for this item." + +For example, `NeedButton.reason = _G`. If the player can roll need/greed/disenchant, the respective value of `reasonNeed`/`reasonGreed`/`reasonDisenchant` returns 0. \ No newline at end of file diff --git a/wiki-information/functions/GetLootRollItemLink.md b/wiki-information/functions/GetLootRollItemLink.md new file mode 100644 index 00000000..6c513743 --- /dev/null +++ b/wiki-information/functions/GetLootRollItemLink.md @@ -0,0 +1,19 @@ +## Title: GetLootRollItemLink + +**Content:** +Retrieves the itemLink of an item being rolled on. +`itemLink = GetLootRollItemLink(id)` + +**Parameters:** +- `id` + - *number* - id is a number used by the server to keep track of items being rolled on. It is generated server side and transmitted to the client. + +**Returns:** +- `itemLink` + - *itemLink* + +**Example Usage:** +This function can be used in an addon to display the item link of an item currently being rolled on in a loot roll frame. For instance, an addon could use this to show detailed information about the item to help players decide whether to roll Need, Greed, or Pass. + +**Addons Using This Function:** +Many loot management addons, such as "LootRollManager" or "XLoot", use this function to enhance the default loot roll interface by providing additional item information and customization options. \ No newline at end of file diff --git a/wiki-information/functions/GetLootSlotInfo.md b/wiki-information/functions/GetLootSlotInfo.md new file mode 100644 index 00000000..e95b0bbc --- /dev/null +++ b/wiki-information/functions/GetLootSlotInfo.md @@ -0,0 +1,38 @@ +## Title: GetLootSlotInfo + +**Content:** +Returns info for a loot slot. +`lootIcon, lootName, lootQuantity, currencyID, lootQuality, locked, isQuestItem, questID, isActive = GetLootSlotInfo(slot)` + +**Parameters:** +- `slot` + - *number* - the index of the loot (1 is the first item, typically coin) + +**Returns:** +- `lootIcon` + - *string* - The path of the graphical icon for the item. +- `lootName` + - *string* - The name of the item. +- `lootQuantity` + - *number* - The quantity of the item in a stack. Note: Quantity for coin is always 0. +- `currencyID` + - *number* - The identifying number of the currency loot in slot, if applicable. Note: Returns nil for slots with coin and regular items. +- `lootQuality` + - *number* - The Enum.ItemQuality code for the item. +- `locked` + - *boolean* - Whether you are eligible to loot this item or not. Locked items are by default shown tinted red. +- `isQuestItem` + - *boolean* - Self-explanatory. +- `questID` + - *number* - The identifying number for the quest. +- `isActive` + - *boolean* - True if the item starts a quest that you are not currently on. + +**Description:** +When returning coin data, the 'quantity' is always 0 and the 'item' contains the amount and text. It also includes a line break after each type of coin. The linebreak can be removed by string substitution. +`print("coins: "..string.gsub(item,"\\n"," "))` + +**Reference:** +- `GetLootSourceInfo` +- `GetLootSlotLink` +- `GetLootSlotType` \ No newline at end of file diff --git a/wiki-information/functions/GetLootSlotLink.md b/wiki-information/functions/GetLootSlotLink.md new file mode 100644 index 00000000..5e5a802d --- /dev/null +++ b/wiki-information/functions/GetLootSlotLink.md @@ -0,0 +1,29 @@ +## Title: GetLootSlotLink + +**Content:** +Returns the item link for a loot slot. +`itemLink = GetLootSlotLink(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the list to retrieve info from (1 to GetNumLootItems()) + +**Returns:** +- `itemLink` + - *string* - The itemLink for the specified item, or nil if index is invalid. + +**Usage:** +The example below will display the item links into your chat window. +```lua +local linkstext = "" +for index = 1, GetNumLootItems() do + if LootSlotHasItem(index) then + local itemLink = GetLootSlotLink(index) + linkstext = linkstext .. itemLink + end +end +print(linkstext) +``` + +**Example Use Case:** +This function can be used in addons that manage loot distribution or display loot information. For instance, an addon like "LootMaster" might use this function to retrieve and display item links for all items in a loot window, allowing raid leaders to distribute loot more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetLootSlotType.md b/wiki-information/functions/GetLootSlotType.md new file mode 100644 index 00000000..e7c5ddae --- /dev/null +++ b/wiki-information/functions/GetLootSlotType.md @@ -0,0 +1,34 @@ +## Title: GetLootSlotType + +**Content:** +Returns an integer loot type for a given loot slot. +`slotType = GetLootSlotType(slotIndex)` + +**Parameters:** +- `slotIndex` + - *number* - Position in loot window to query, from 1 - `GetNumLootItems()`. + +**Returns:** +- `slotType` + - *number* - Type ID indicating slot content type: + - `0`: `LOOT_SLOT_NONE` / `Enum.LootSlotType.None` - No contents + - `1`: `LOOT_SLOT_ITEM` / `Enum.LootSlotType.Item` - A regular item + - `2`: `LOOT_SLOT_MONEY` / `Enum.LootSlotType.Money` - Gold/silver/copper coin + - `3`: `LOOT_SLOT_CURRENCY` / `Enum.LootSlotType.Currency` - Other currency amount, such as + +As of 10.0.0.46455 the constants `LOOT_SLOT_NONE`, `LOOT_SLOT_ITEM`, `LOOT_SLOT_MONEY`, `LOOT_SLOT_CURRENCY` are no longer defined. A new enumerator table is defined (`Enum.LootSlotType`) with the same values. + +**Usage:** +The following snippet takes all items from the open loot window, leaving other loot types: +```lua +for slot = 1, GetNumLootItems() do + if GetLootSlotType(slot) == Enum.LootSlotType.Item then + LootSlot(slot); + end +end +``` + +**Reference:** +- `GetNumLootItems` +- `LootSlot` +- `LOOT_OPENED` \ No newline at end of file diff --git a/wiki-information/functions/GetLootSourceInfo.md b/wiki-information/functions/GetLootSourceInfo.md new file mode 100644 index 00000000..bccf1463 --- /dev/null +++ b/wiki-information/functions/GetLootSourceInfo.md @@ -0,0 +1,37 @@ +## Title: GetLootSourceInfo + +**Content:** +Returns information about the source of the objects in a loot slot. +`guid, quantity, ... = GetLootSourceInfo(lootSlot)` + +**Parameters:** +- `lootSlot` + - *number* - index of the loot slot, ascending from 1 up to `GetNumLootItems()` + +**Returns:** +(Variable returns: `guid1, quantity1, guid2, quantity2, ...`) +- `guid` + - *string* - GUID of the source being looted. Can also return GameObject GUIDs for objects like ore veins and herbs, and Item GUIDs for containers like lockboxes. +- `quantity` + - *number* - Quantity of the object being looted from this source. + +**Usage:** +Prints out the source GUID and quantity of each loot source item individually. +```lua +local function OnEvent(self, event) + for i = 1, GetNumLootItems() do + local sources = {GetLootSourceInfo(i)} + local _, name = GetLootSlotInfo(i) + for j = 1, #sources, 2 do + print(i, name, j, sources[j], sources[j+1]) + end + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("LOOT_OPENED") +f:SetScript("OnEvent", OnEvent) +``` + +**Reference:** +- `GetLootSlotInfo()` \ No newline at end of file diff --git a/wiki-information/functions/GetLootThreshold.md b/wiki-information/functions/GetLootThreshold.md new file mode 100644 index 00000000..3499e09f --- /dev/null +++ b/wiki-information/functions/GetLootThreshold.md @@ -0,0 +1,15 @@ +## Title: GetLootThreshold + +**Content:** +Returns the loot threshold quality for e.g. master loot. +`threshold = GetLootThreshold()` + +**Returns:** +- `threshold` + - *number* - The minimum quality of item which will be rolled for or assigned by the master looter. The value is 0 to 7, which represents Poor to Heirloom. + +**Example Usage:** +This function can be used to determine the current loot threshold in a group or raid setting. For instance, if you are developing an addon that needs to display or adjust loot settings, you can use `GetLootThreshold` to fetch the current threshold and make decisions based on it. + +**Addons Using This Function:** +Many raid management addons, such as "Deadly Boss Mods" (DBM) and "BigWigs", use this function to ensure that loot distribution settings are appropriate for the encounter difficulty and group composition. \ No newline at end of file diff --git a/wiki-information/functions/GetMacroBody.md b/wiki-information/functions/GetMacroBody.md new file mode 100644 index 00000000..14cd1404 --- /dev/null +++ b/wiki-information/functions/GetMacroBody.md @@ -0,0 +1,25 @@ +## Title: GetMacroBody + +**Content:** +Returns the body (macro text) of a macro. +`body = GetMacroBody(macro)` + +**Parameters:** +- `macro` + - *number|string* - Macro index or name. + +**Returns:** +- `body` + - *string?* - The macro body or nothing if the macro doesn't exist. + +**Usage:** +```lua +/dump GetMacroBody("Flash Heal") +-- Output: "#showtooltip\n/cast Flash Heal\n" +``` + +**Example Use Case:** +This function can be used to retrieve the text of a macro for inspection or modification. For instance, an addon could use this to check if a specific macro exists and then update its content based on certain conditions. + +**Addons Using This Function:** +Many macro management addons, such as "GSE: Gnome Sequencer Enhanced", use this function to read and manipulate macro texts programmatically. This allows users to create complex sequences and automate their gameplay more effectively. \ No newline at end of file diff --git a/wiki-information/functions/GetMacroIndexByName.md b/wiki-information/functions/GetMacroIndexByName.md new file mode 100644 index 00000000..3511b269 --- /dev/null +++ b/wiki-information/functions/GetMacroIndexByName.md @@ -0,0 +1,19 @@ +## Title: GetMacroIndexByName + +**Content:** +Returns the index for a macro by name. +`macroSlot = GetMacroIndexByName(name)` + +**Parameters:** +- `name` + - *string* - Macro name to query. + +**Returns:** +- `macroSlot` + - *number* - Macro slot index containing a macro with the queried name, or 0 if no such slot exists. + +**Description:** +Slots 1-120 are used for general macros, and 121-138 for character-specific macros. + +**Reference:** +[GetMacroInfo](https://wowpedia.fandom.com/wiki/API_GetMacroInfo) \ No newline at end of file diff --git a/wiki-information/functions/GetMacroInfo.md b/wiki-information/functions/GetMacroInfo.md new file mode 100644 index 00000000..bfb52a80 --- /dev/null +++ b/wiki-information/functions/GetMacroInfo.md @@ -0,0 +1,17 @@ +## Title: GetMacroInfo + +**Content:** +Returns info for a macro. +`name, icon, body = GetMacroInfo(macro)` + +**Parameters:** +- `macro` + - *number|string* - Macro slot index or the name of the macro. Slots 1 through 120 are general macros; 121 through 138 are per-character macros. + +**Returns:** +- `name` + - *string* - The name of the macro. +- `icon` + - *number : fileID* - Macro icon texture. +- `body` + - *string* - Macro contents. \ No newline at end of file diff --git a/wiki-information/functions/GetMacroSpell.md b/wiki-information/functions/GetMacroSpell.md new file mode 100644 index 00000000..db8e4d02 --- /dev/null +++ b/wiki-information/functions/GetMacroSpell.md @@ -0,0 +1,33 @@ +## Title: GetMacroSpell + +**Content:** +Returns information about the spell a given macro is set to cast. +`id = GetMacroSpell(slot or macroName)` + +**Parameters:** +- `slot` + - *number* - The macro slot to query. +- `macroName` + - *string* - The name of the macro to query. + +**Returns:** +- `id` + - *number* - The ability's spellId. + +**Description:** +Action-bar addons use this function to display dynamic macro icons, tooltips, and glow effects. As a macro's cast sequence changes, this function indicates which will be cast next. + +**Usage:** +```lua +local macroName = "MyMacro" +local index = GetMacroIndexByName(macroName) +if index then + local spellId = GetMacroSpell(index) + if spellId then + print(macroName .. " will now cast " .. GetSpellLink(spellId)) + end +end +``` + +**Reference:** +- Aerythlea 2018-11-14. Battle for Azeroth Addon Changes. \ No newline at end of file diff --git a/wiki-information/functions/GetManaRegen.md b/wiki-information/functions/GetManaRegen.md new file mode 100644 index 00000000..01bdb4c4 --- /dev/null +++ b/wiki-information/functions/GetManaRegen.md @@ -0,0 +1,14 @@ +## Title: GetManaRegen + +**Content:** +Returns the mana regeneration per second. +`base, casting = GetManaRegen()` + +**Returns:** +- `base` + - *number* - Mana regeneration per second when not casting spells. +- `casting` + - *number* - Mana regeneration per second while casting spells. + +**Description:** +To get the same values as displayed in the PaperDoll, multiply the values by 5. \ No newline at end of file diff --git a/wiki-information/functions/GetMasterLootCandidate.md b/wiki-information/functions/GetMasterLootCandidate.md new file mode 100644 index 00000000..c61594ca --- /dev/null +++ b/wiki-information/functions/GetMasterLootCandidate.md @@ -0,0 +1,22 @@ +## Title: GetMasterLootCandidate + +**Content:** +Returns the name of an eligible player for receiving master loot by index. +`candidate = GetMasterLootCandidate(slot, index)` + +**Parameters:** +- `slot` + - *number* - The loot slot number of the item you want to get information about +- `index` + - *number* - The number of the player whose name you wish to return. Typically between 1 and 40. + +**Returns:** +- `candidate` + - *string* - The name of the player. + +**Description:** +Only valid if the player is the master looter. + +**Reference:** +- `GetNumRaidMembers()` +- `GiveMasterLoot(slot, index)` \ No newline at end of file diff --git a/wiki-information/functions/GetMaxBattlefieldID.md b/wiki-information/functions/GetMaxBattlefieldID.md new file mode 100644 index 00000000..b738300e --- /dev/null +++ b/wiki-information/functions/GetMaxBattlefieldID.md @@ -0,0 +1,12 @@ +## Title: GetMaxBattlefieldID + +**Content:** +Returns the max number of battlefields you can queue for. +`maxBattlefieldID = GetMaxBattlefieldID()` + +**Returns:** +- `maxBattlefieldID` + - *number* - Max number of Battlefields + +**Description:** +Replaces `MAX_BATTLEFIELD_QUEUES`. \ No newline at end of file diff --git a/wiki-information/functions/GetMaxLevelForExpansionLevel.md b/wiki-information/functions/GetMaxLevelForExpansionLevel.md new file mode 100644 index 00000000..b1c533ba --- /dev/null +++ b/wiki-information/functions/GetMaxLevelForExpansionLevel.md @@ -0,0 +1,44 @@ +## Title: GetMaxLevelForExpansionLevel + +**Content:** +Maps an expansion level to a maximum character level for that expansion. +`maxLevel = GetMaxLevelForExpansionLevel(expansionLevel)` + +**Parameters:** +- `expansionLevel` + - *number* + - Values: + - `Value` + - `Enum` + - `MaxLevel` + - `0` + - `LE_EXPANSION_CLASSIC` + - `30` + - `1` + - `LE_EXPANSION_BURNING_CRUSADE` + - `30` + - `2` + - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` + - `30` + - `3` + - `LE_EXPANSION_CATACLYSM` + - `35` + - `4` + - `LE_EXPANSION_MISTS_OF_PANDARIA` + - `35` + - `5` + - `LE_EXPANSION_WARLORDS_OF_DRAENOR` + - `40` + - `6` + - `LE_EXPANSION_LEGION` + - `45` + - `7` + - `LE_EXPANSION_BATTLE_FOR_AZEROTH` + - `50` + - `8` + - `LE_EXPANSION_SHADOWLANDS` + - `60` + +**Returns:** +- `maxLevel` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetMaximumExpansionLevel.md b/wiki-information/functions/GetMaximumExpansionLevel.md new file mode 100644 index 00000000..8304c84a --- /dev/null +++ b/wiki-information/functions/GetMaximumExpansionLevel.md @@ -0,0 +1,35 @@ +## Title: GetMaximumExpansionLevel + +**Content:** +Needs summary. +`expansionLevel = GetMaximumExpansionLevel()` + +**Returns:** +- `expansionLevel` + - *number* + - `NUM_LE_EXPANSION_LEVELS` + - **Value** + - **Enum** + - **Description** + - `LE_EXPANSION_LEVEL_CURRENT` + - *0* - Vanilla / Classic Era + - `LE_EXPANSION_BURNING_CRUSADE` + - *1* - The Burning Crusade + - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` + - *2* - Wrath of the Lich King + - `LE_EXPANSION_CATACLYSM` + - *3* - Cataclysm + - `LE_EXPANSION_MISTS_OF_PANDARIA` + - *4* - Mists of Pandaria + - `LE_EXPANSION_WARLORDS_OF_DRAENOR` + - *5* - Warlords of Draenor + - `LE_EXPANSION_LEGION` + - *6* - Legion + - `LE_EXPANSION_BATTLE_FOR_AZEROTH` + - *7* - Battle for Azeroth + - `LE_EXPANSION_SHADOWLANDS` + - *8* - Shadowlands + - `LE_EXPANSION_DRAGONFLIGHT` + - *9* - Dragonflight + - `LE_EXPANSION_11_0` + - *10* \ No newline at end of file diff --git a/wiki-information/functions/GetMeleeHaste.md b/wiki-information/functions/GetMeleeHaste.md new file mode 100644 index 00000000..21753ab8 --- /dev/null +++ b/wiki-information/functions/GetMeleeHaste.md @@ -0,0 +1,17 @@ +## Title: GetMeleeHaste + +**Content:** +Returns the player's melee haste percentage. +`meleeHaste = GetMeleeHaste()` + +**Returns:** +- `meleeHaste` + - *number* + +**Description:** +Related API: +- `GetCombatRating(CR_HASTE_MELEE)` +- `GetCombatRatingBonus(CR_HASTE_MELEE)` + +**Usage:** +`/dump GetMeleeHaste()` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemCostInfo.md b/wiki-information/functions/GetMerchantItemCostInfo.md new file mode 100644 index 00000000..db226ed9 --- /dev/null +++ b/wiki-information/functions/GetMerchantItemCostInfo.md @@ -0,0 +1,20 @@ +## Title: GetMerchantItemCostInfo + +**Content:** +Returns "alternative currency" information about an item. +`itemCount = GetMerchantItemCostInfo(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the merchant's inventory + +**Returns:** +- `itemCount` + - *number* - The number of different types of items required to purchase the item. + +**Description:** +The `itemCount` is the number of different types of items required, not how many of those types. For example, the Scout's Tabard which requires 3 Arathi Basin Marks of Honor and 3 Warsong Gulch Marks of Honor would return a 2 for the item count. To find out how many of each item is required, use the `GetMerchantItemCostItem` function. + +**Reference:** +- `GetMerchantItemInfo` +- `GetMerchantItemCostItem` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemCostItem.md b/wiki-information/functions/GetMerchantItemCostItem.md new file mode 100644 index 00000000..80bfe657 --- /dev/null +++ b/wiki-information/functions/GetMerchantItemCostItem.md @@ -0,0 +1,24 @@ +## Title: GetMerchantItemCostItem + +**Content:** +Returns info for the currency cost for a merchant item. +`itemTexture, itemValue, itemLink, currencyName = GetMerchantItemCostItem(index, itemIndex)` + +**Parameters:** +- `index` + - *number* - Slot in the merchant's inventory to query. +- `itemIndex` + - *number* - The index for the required item cost type, ascending from 1 to itemCount returned by GetMerchantItemCostInfo. + +**Returns:** +- `itemTexture` + - *string* - The texture that represents the item's icon +- `itemValue` + - *number* - The number of that item required +- `itemLink` + - *string* - An itemLink for the cost item, nil if a currency. +- `currencyName` + - *string* - Name of the currency required, nil if an item. + +**Description:** +`itemIndex` counts into the number of different "alternate currency" tokens required to buy the item under consideration. For example, looking at the 25-player Tier 9 vendor, a chestpiece costs 75 Emblems of Triumph and 1 Trophy of the Crusade. This function would be called with arguments (N,1) to retrieve information about the Emblems and (N,2) to retrieve information about the Trophy, where N is the index of the chestpiece in the merchant window. \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemID.md b/wiki-information/functions/GetMerchantItemID.md new file mode 100644 index 00000000..8b01e530 --- /dev/null +++ b/wiki-information/functions/GetMerchantItemID.md @@ -0,0 +1,19 @@ +## Title: GetMerchantItemID + +**Content:** +Returns the itemID of an item of the current merchant window. +`itemID = GetMerchantItemID(Index)` + +**Parameters:** +- `Index` + - *number* - Index + +**Returns:** +- `itemID` + - *itemID* - itemID of Merchant Item at Index + +**Usage:** +To get the itemID of an item of the current merchant window: +```lua +/dump GetMerchantItemID(1) -- = 194298 +``` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemInfo.md b/wiki-information/functions/GetMerchantItemInfo.md new file mode 100644 index 00000000..608892e3 --- /dev/null +++ b/wiki-information/functions/GetMerchantItemInfo.md @@ -0,0 +1,46 @@ +## Title: GetMerchantItemInfo + +**Content:** +Returns info for a merchant item. +`name, texture, price, quantity, numAvailable, isPurchasable, isUsable, extendedCost = GetMerchantItemInfo(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the merchant's inventory + +**Returns:** +- `name` + - *string* - The name of the item +- `texture` + - *string* - The texture that represents the item's icon +- `price` + - *number* - The price of the item (in copper) +- `quantity` + - *number* - The quantity that will be purchased (the batch size, e.g. 5 for vials) +- `numAvailable` + - *number* - The number of this item that the merchant has in stock. -1 for unlimited stock. +- `isPurchasable` + - *boolean* - Is true if the item can be purchased, false otherwise +- `isUsable` + - *boolean* - Is true if the player can use this item, false otherwise +- `extendedCost` + - *boolean* - Is true if the item has extended (PvP) cost info, false otherwise + +**Usage:** +```lua +local name, texture, price, quantity, numAvailable, isUsable, extendedCost = GetMerchantItemInfo(4); +message(name .. " " .. price .. "c"); +``` + +**Miscellaneous:** +Result: +A message stating the name and price of the item in merchant slot 4 appears. + +**Reference:** +- `GetMerchantItemCostInfo` + +**Example Use Case:** +This function can be used in an addon to display detailed information about items sold by NPC merchants. For instance, an addon could use this function to create a custom merchant interface that shows additional information about each item, such as its price in a more readable format or whether the player can use the item. + +**Addons Using This Function:** +Many popular addons like Auctioneer and TradeSkillMaster use this function to gather information about items sold by merchants, which can then be used to help players make informed purchasing decisions or to automate buying processes. \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemLink.md b/wiki-information/functions/GetMerchantItemLink.md new file mode 100644 index 00000000..ffcd41fb --- /dev/null +++ b/wiki-information/functions/GetMerchantItemLink.md @@ -0,0 +1,19 @@ +## Title: GetMerchantItemLink + +**Content:** +Returns the item link for a merchant item. +`link = GetMerchantItemLink(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the merchant's inventory + +**Returns:** +- `itemLink` + - *string?* - returns a string that will show as a clickable link to the item + +**Usage:** +Show item link will appear in the default chat frame. +```lua +DEFAULT_CHAT_FRAME:AddMessage(GetMerchantItemLink(4)); +``` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemMaxStack.md b/wiki-information/functions/GetMerchantItemMaxStack.md new file mode 100644 index 00000000..6881c984 --- /dev/null +++ b/wiki-information/functions/GetMerchantItemMaxStack.md @@ -0,0 +1,13 @@ +## Title: GetMerchantItemMaxStack + +**Content:** +Returns the maximum stack size for a merchant item. +`maxStack = GetMerchantItemMaxStack(index)` + +**Parameters:** +- `index` + - *number* - The index of the item in the merchant's inventory. + +**Returns:** +- `maxStack` + - *number* - The maximum stack size for the item. \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantNumItems.md b/wiki-information/functions/GetMerchantNumItems.md new file mode 100644 index 00000000..556daad0 --- /dev/null +++ b/wiki-information/functions/GetMerchantNumItems.md @@ -0,0 +1,12 @@ +## Title: GetMerchantNumItems + +**Content:** +Returns the number of different items a merchant sells. +`numItems = GetMerchantNumItems()` + +**Returns:** +- `numItems` + - *number* - the number of items the merchant carries. + +**Description:** +If you are not currently interacting with a merchant, the last known value is returned. \ No newline at end of file diff --git a/wiki-information/functions/GetMinimapZoneText.md b/wiki-information/functions/GetMinimapZoneText.md new file mode 100644 index 00000000..ac24ad2d --- /dev/null +++ b/wiki-information/functions/GetMinimapZoneText.md @@ -0,0 +1,16 @@ +## Title: GetMinimapZoneText + +**Content:** +Returns the zone text that is displayed over the minimap. +`zone = GetMinimapZoneText()` + +**Returns:** +- `zone` + - *string* - name of the (sub-)zone currently shown above the minimap, e.g. "Trade District". + +**Description:** +The `MINIMAP_ZONE_CHANGED` event fires when the return value of this function changes. +The return value equals that of `GetSubZoneText()` or `GetZoneText()` depending on whether the player is currently in a named sub-zone or not. + +**Reference:** +- `GetRealZoneText()` \ No newline at end of file diff --git a/wiki-information/functions/GetMinimumExpansionLevel.md b/wiki-information/functions/GetMinimumExpansionLevel.md new file mode 100644 index 00000000..32981d8b --- /dev/null +++ b/wiki-information/functions/GetMinimumExpansionLevel.md @@ -0,0 +1,50 @@ +## Title: GetMinimumExpansionLevel + +**Content:** +Needs summary. +`expansionLevel = GetMinimumExpansionLevel()` + +**Returns:** +- `expansionLevel` + - *number* - Corresponds to the expansion level constants: + - `Value` + - `Enum` + - `Description` + - `LE_EXPANSION_LEVEL_CURRENT` + - *0* - LE_EXPANSION_CLASSIC + - *Vanilla / Classic Era* + - `1` + - *LE_EXPANSION_BURNING_CRUSADE* + - *The Burning Crusade* + - `2` + - *LE_EXPANSION_WRATH_OF_THE_LICH_KING* + - *Wrath of the Lich King* + - `3` + - *LE_EXPANSION_CATACLYSM* + - *Cataclysm* + - `4` + - *LE_EXPANSION_MISTS_OF_PANDARIA* + - *Mists of Pandaria* + - `5` + - *LE_EXPANSION_WARLORDS_OF_DRAENOR* + - *Warlords of Draenor* + - `6` + - *LE_EXPANSION_LEGION* + - *Legion* + - `7` + - *LE_EXPANSION_BATTLE_FOR_AZEROTH* + - *Battle for Azeroth* + - `8` + - *LE_EXPANSION_SHADOWLANDS* + - *Shadowlands* + - `9` + - *LE_EXPANSION_DRAGONFLIGHT* + - *Dragonflight* + - `10` + - *LE_EXPANSION_11_0* + +**Example Usage:** +This function can be used to determine the minimum expansion level required for certain features or content in the game. For instance, if a developer wants to check if a player has access to content from a specific expansion, they can use this function to get the minimum expansion level and compare it with the required expansion level for that content. + +**Addons Usage:** +Large addons like "WeakAuras" might use this function to ensure compatibility with different expansions by checking the minimum expansion level and adjusting their features accordingly. This helps in providing a seamless experience for users across various expansions. \ No newline at end of file diff --git a/wiki-information/functions/GetMirrorTimerInfo.md b/wiki-information/functions/GetMirrorTimerInfo.md new file mode 100644 index 00000000..ff02f592 --- /dev/null +++ b/wiki-information/functions/GetMirrorTimerInfo.md @@ -0,0 +1,32 @@ +## Title: GetMirrorTimerInfo + +**Content:** +Returns info for the mirror timer, e.g. fatigue, breath, and feign death. +`timer, initial, maxvalue, scale, paused, label = GetMirrorTimerInfo(id)` + +**Parameters:** +- `id` + - *number* - timer index, from 1 to MIRRORTIMER_NUMTIMERS (3 as of 3.2). In general, the following correspondence holds: 1 = Fatigue, 2 = Breath, 3 = Feign Death. + +**Returns:** +- `timer` + - *string* - A string identifying timer type; "EXHAUSTION", "BREATH", and "FEIGNDEATH", or "UNKNOWN" indicating that the timer corresponding to that index is not currently active, and other return values are invalid. +- `initial` + - *number* - Value of the timer when it started. +- `maxvalue` + - *number* - Maximum value of the timer. +- `scale` + - *number* - Change in timer value per second. +- `paused` + - *boolean* - 0 if the timer is currently running, a value greater than zero if it is not. +- `label` + - *string* - Localized timer name. + +**Description:** +Calling the function with an out-of-range index results in an error. The syntax specification in the error text is invalid; this function may not be called with "BREATH", "EXHAUSTION" etc as arguments. +The current value of the timer may be retrieved using `GetMirrorTimerProgress("timer")`. Most timers tend to count down to zero, at which point something bad happens. + +**Reference:** +- `MIRROR_TIMER_START` is fired when a timer becomes active. +- `MIRROR_TIMER_STOP` is fired when a timer becomes inactive. +- `MIRROR_TIMER_PAUSE` is fired when a timer is paused. \ No newline at end of file diff --git a/wiki-information/functions/GetMirrorTimerProgress.md b/wiki-information/functions/GetMirrorTimerProgress.md new file mode 100644 index 00000000..edbe3d38 --- /dev/null +++ b/wiki-information/functions/GetMirrorTimerProgress.md @@ -0,0 +1,16 @@ +## Title: GetMirrorTimerProgress + +**Content:** +Returns the current value of the mirror timer. +`value = GetMirrorTimerProgress(timer)` + +**Parameters:** +- `timer` + - *string* - the first return value from `GetMirrorTimerInfo`, identifying the timer queried. Valid values include "EXHAUSTION", "BREATH" and "FEIGNDEATH". + +**Returns:** +- `value` + - *number* - current value of the timer. If the timer is not active, 0 is returned. + +**Reference:** +- `GetMirrorTimerInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetModifiedClick.md b/wiki-information/functions/GetModifiedClick.md new file mode 100644 index 00000000..fc1b7e84 --- /dev/null +++ b/wiki-information/functions/GetModifiedClick.md @@ -0,0 +1,35 @@ +## Title: GetModifiedClick + +**Content:** +Returns the modifier key assigned to the given action. +`key = GetModifiedClick(action)` + +**Parameters:** +- `action` + - *string* - The action to query. Actions defined by Blizzard: + - `AUTOLOOTTOGGLE` + - `CHATLINK` + - `COMPAREITEMS` + - `DRESSUP` + - `FOCUSCAST` + - `OPENALLBAGS` + - `PICKUPACTION` + - `QUESTWATCHTOGGLE` + - `SELFCAST` + - `SHOWITEMFLYOUT` + - `SOCKETITEM` + - `SPLITSTACK` + - `STICKYCAMERA` + - `TOKENWATCHTOGGLE` + +**Returns:** +- `key` + - *string* - The modifier key assigned to this action. May be one of: + - `ALT` + - `CTRL` + - `SHIFT` + - `NONE` + +**Reference:** +- `IsModifiedClick` +- `SetModifiedClick` \ No newline at end of file diff --git a/wiki-information/functions/GetMoney.md b/wiki-information/functions/GetMoney.md new file mode 100644 index 00000000..1cbe9118 --- /dev/null +++ b/wiki-information/functions/GetMoney.md @@ -0,0 +1,50 @@ +## Title: GetMoney + +**Content:** +Returns the amount of money the player character owns. +`money = GetMoney()` + +**Returns:** +- `money` + - *number* - The amount of money the player's character has, in copper. + +**Description:** +Related Events: +- `PLAYER_MONEY` + +Available after: +- `PLAYER_ENTERING_WORLD` (on login) + +**Usage:** +```lua +GetMoney() +local money = GetMoney() +local gold = floor(money / 1e4) +local silver = floor(money / 100 % 100) +local copper = money % 100 +print(("You have %dg %ds %dc"):format(gold, silver, copper)) +-- You have 10851g 62s 40c + +GetCoinText(amount) +print(GetCoinText(GetMoney())) -- "10851 Gold, 62 Silver, 40 Copper" +print(GetCoinText(12345678, " ")) -- "1234 Gold 23 Silver 45 Copper" +print(GetCoinText(12345678, "X")) -- "1234 GoldX23 SilverX45 Copper" + +GetMoneyString(amount) +print(GetMoneyString(12345678)) +print(GetMoneyString(12345678, true)) +-- 1234 56 78 +-- 1,234 56 78 + +GetCoinTextureString(amount) +print(GetCoinTextureString(1234578)) +print(GetCoinTextureString(1234578, 24)) +-- 1234 56 78 +-- 1234 56 78 +``` + +**Example Use Case:** +The `GetMoney` function can be used in addons to display the player's current money in various formats. For instance, an addon that tracks and displays the player's wealth over time would use this function to get the current amount of money and then store or display it. + +**Addons Using This Function:** +Many popular addons, such as "Titan Panel" and "Bagnon," use the `GetMoney` function to display the player's current money on the screen or in the inventory interface. These addons provide a convenient way to keep track of your gold, silver, and copper without having to open the character's inventory. \ No newline at end of file diff --git a/wiki-information/functions/GetMouseButtonClicked.md b/wiki-information/functions/GetMouseButtonClicked.md new file mode 100644 index 00000000..d3262bb8 --- /dev/null +++ b/wiki-information/functions/GetMouseButtonClicked.md @@ -0,0 +1,13 @@ +## Title: GetMouseButtonClicked + +**Content:** +Returns the mouse button responsible during an OnClick event (e.g. "RightButton"). +`buttonName = GetMouseButtonClicked()` + +**Returns:** +- `buttonName` + - *string* - name of the button responsible for the innermost OnClick event. For example, "LeftButton" + +**Description:** +The `buttonName` return value may be an arbitrary string (as the `Button:Click` method accepts arbitrary arguments). +If there are multiple OnClick handler dispatches on the call stack, information about the innermost one is returned. \ No newline at end of file diff --git a/wiki-information/functions/GetMouseFocus.md b/wiki-information/functions/GetMouseFocus.md new file mode 100644 index 00000000..fde03081 --- /dev/null +++ b/wiki-information/functions/GetMouseFocus.md @@ -0,0 +1,18 @@ +## Title: GetMouseFocus + +**Content:** +Returns the frame that currently has mouse focus. +`frame = GetMouseFocus()` + +**Returns:** +- `frame` + - *Frame* - The frame that currently has the mouse focus. + +**Description:** +The frame must have `enableMouse="true"` + +**Usage:** +You can get the name of the mouse-enabled frame beneath the pointer with this: +```lua +/dump GetMouseFocus():GetName() -- WorldFrame +``` \ No newline at end of file diff --git a/wiki-information/functions/GetMultiCastTotemSpells.md b/wiki-information/functions/GetMultiCastTotemSpells.md new file mode 100644 index 00000000..ac5bea73 --- /dev/null +++ b/wiki-information/functions/GetMultiCastTotemSpells.md @@ -0,0 +1,50 @@ +## Title: GetMultiCastTotemSpells + +**Content:** +Returns a list of valid spells for a totem bar slot. +`totem1, totem2, totem3, totem4, totem5, totem6, totem7 = GetMultiCastTotemSpells(slot)` + +**Parameters:** +- `slot` + - *number* - The totem bar slot number: + - Call of the Elements + - 133 - Fire + - 134 - Earth + - 135 - Water + - 136 - Air + - Call of the Ancestors + - 137 - Fire + - 138 - Earth + - 139 - Water + - 140 - Air + - Call of the Spirits + - 141 - Fire + - 142 - Earth + - 143 - Water + - 144 - Air + +**Returns:** +- `totem1` + - *number* - The spell Id of the first valid spell for the slot +- `totem2` + - *number* - The spell Id of the second valid spell for the slot +- `totem3` + - *number* - The spell Id of the third valid spell for the slot +- `totem4` + - *number* - The spell Id of the fourth valid spell for the slot +- `totem5` + - *number* - The spell Id of the fifth valid spell for the slot +- `totem6` + - *number* - The spell Id of the sixth valid spell for the slot +- `totem7` + - *number* - The spell Id of the seventh valid spell for the slot + +**Usage:** +```lua +totem1, totem2, totem3, totem4, totem5, totem6, totem7 = GetMultiCastTotemSpells(134) +totem1, totem2, totem3, totem4, totem5, totem6, totem7 = GetMultiCastTotemSpells(134) +``` + +**Miscellaneous:** +Result: +A list of spell ids that can go in totem bar slot number 134. Slot 134 is the Earth slot for the Call of the Elements spell. \ No newline at end of file diff --git a/wiki-information/functions/GetNetStats.md b/wiki-information/functions/GetNetStats.md new file mode 100644 index 00000000..96d76fd3 --- /dev/null +++ b/wiki-information/functions/GetNetStats.md @@ -0,0 +1,26 @@ +## Title: GetNetStats + +**Content:** +Returns bandwidth and latency network information. +`bandwidthIn, bandwidthOut, latencyHome, latencyWorld = GetNetStats()` + +**Returns:** +- `bandwidthIn` + - *number* - Current incoming bandwidth (download) usage, measured in KB/s. +- `bandwidthOut` + - *number* - Current outgoing bandwidth (upload) usage, measured in KB/s. +- `latencyHome` + - *number* - Average roundtrip latency to the home realm server (only updated every 30 seconds). +- `latencyWorld` + - *number* - Average roundtrip latency to the current world server (only updated every 30 seconds). + +**Description:** +Home/World latency (updated) - 4.0.6 | 2011-02-11 19:54 | Gelmkar + +In essence, Home refers to your connection to your realm server. This connection sends chat data, auction house stuff, guild chat and info, some addon data, and various other data. It is a pretty slim connection in terms of bandwidth requirements. + +World is a reference to the connection to our servers that transmits all the other data... combat, data from the people around you (specs, gear, enchants, etc.), NPCs, mobs, casting, professions, etc. Going into a highly populated zone (like a capital city) will drastically increase the amount of data being sent over this connection and will raise the reported latency. + +Prior to 4.0.6, the in-game latency monitor only showed 'World' latency, which caused a lot of confusion for people who had no lag while chatting, but couldn't cast or interact with NPCs and ended up getting kicked offline. We hoped that including the latency meters for both connections would assist in clarifying this for everyone. + +As is probably obvious based upon this information, the two connections are not used equally. There is a much larger amount of data being sent over the World connection, which is a good reason you may see disparities between the two times. If there is a large chunk of data 'queued' up on the server and waiting to be sent to your client, that 'ping' to the server is going to have to wait its turn in line, and the actual number returned will be much higher than the 'Home' connection. \ No newline at end of file diff --git a/wiki-information/functions/GetNextAchievement.md b/wiki-information/functions/GetNextAchievement.md new file mode 100644 index 00000000..c59f1e6c --- /dev/null +++ b/wiki-information/functions/GetNextAchievement.md @@ -0,0 +1,13 @@ +## Title: GetNextAchievement + +**Content:** +Returns the next achievement in a chain. +`nextAchievementID = GetNextAchievement(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - The ID of the Achievement + +**Returns:** +- `nextAchievementID` + - *number or nil* - The ID of the next Achievement in chain. \ No newline at end of file diff --git a/wiki-information/functions/GetNextStableSlotCost.md b/wiki-information/functions/GetNextStableSlotCost.md new file mode 100644 index 00000000..a081d941 --- /dev/null +++ b/wiki-information/functions/GetNextStableSlotCost.md @@ -0,0 +1,9 @@ +## Title: GetNextStableSlotCost + +**Content:** +Returns the next stable slot's cost in copper. +`nextSlotCost = GetNextStableSlotCost()` + +**Returns:** +- `nextSlotCost` + - *number* - The cost of the next stable slot in copper. \ No newline at end of file diff --git a/wiki-information/functions/GetNormalizedRealmName.md b/wiki-information/functions/GetNormalizedRealmName.md new file mode 100644 index 00000000..7ed2d5a9 --- /dev/null +++ b/wiki-information/functions/GetNormalizedRealmName.md @@ -0,0 +1,37 @@ +## Title: GetRealmName + +**Content:** +Returns the realm name. +```lua +realm = GetRealmName() +normalizedRealm = GetNormalizedRealmName() +``` + +**Returns:** +- `realm` + - *string* - The name of the realm. +- `normalizedRealm` + - *string?* - The name of the realm without spaces or hyphens. + +**Description:** +- **Related API:** + - `GetRealmID` +- The normalized realm name is used for addressing whispers and in-game mail. +- When logging in, `GetNormalizedRealmName()` only returns information starting from as early as the `PLAYER_LOGIN` event. +- When transitioning through a loading screen, `GetNormalizedRealmName()` may return nil between the `LOADING_SCREEN_ENABLED` and `LOADING_SCREEN_DISABLED` events. + +**Usage:** +A small list of realm IDs and names. +```lua +-- /dump GetRealmID(), GetRealmName(), GetNormalizedRealmName() +503, "Azjol-Nerub", "AzjolNerub" +513, "Twilight's Hammer", "Twilight'sHammer" +635, "Defias Brotherhood", "DefiasBrotherhood" +1049, "愤怒使者", "愤怒使者" +1093, "Ahn'Qiraj", "Ahn'Qiraj" +1413, "Aggra (Português)", "Aggra(Português)" +1925, "Вечная Песня", "ВечнаяПесня" +``` + +**Reference:** +- `UnitName()` - Returns a character name and the server (if different from the player's current server) \ No newline at end of file diff --git a/wiki-information/functions/GetNumActiveQuests.md b/wiki-information/functions/GetNumActiveQuests.md new file mode 100644 index 00000000..cbe91366 --- /dev/null +++ b/wiki-information/functions/GetNumActiveQuests.md @@ -0,0 +1,15 @@ +## Title: GetNumActiveQuests + +**Content:** +Returns the number of quests which can be turned in at a non-gossip quest giver. +`nbrActiveQuests = GetGossipActiveQuests()` + +**Returns:** +This returns the number of active quests from a non-gossip quest NPC. +- `nbrActiveQuests` + - *number* - The number of active quests. + +**Reference:** +- `GetNumAvailableQuests` +- `GetGossipAvailableQuests` +- `GetGossipActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetNumAddOns.md b/wiki-information/functions/GetNumAddOns.md new file mode 100644 index 00000000..62e765a1 --- /dev/null +++ b/wiki-information/functions/GetNumAddOns.md @@ -0,0 +1,23 @@ +## Title: GetNumAddOns + +**Content:** +Get the number of user-supplied AddOns. +`count = GetNumAddOns()` + +**Returns:** +- `count` + - *number* - The number of user-supplied AddOns installed. This is the maximum valid index to the other AddOn functions. This count does NOT include Blizzard-supplied UI component AddOns. + +**Example Usage:** +This function can be used to iterate over all installed user-supplied AddOns. For example, you can use it in combination with `GetAddOnInfo` to list all AddOns: + +```lua +local numAddOns = GetNumAddOns() +for i = 1, numAddOns do + local name, title, notes, loadable, reason, security = GetAddOnInfo(i) + print(name, title, notes, loadable, reason, security) +end +``` + +**AddOns Using This Function:** +Many large AddOns and AddOn managers, such as **ElvUI** and **WeakAuras**, use this function to manage and display information about other installed AddOns. For instance, AddOn managers might use it to provide a list of all installed AddOns, allowing users to enable or disable them as needed. \ No newline at end of file diff --git a/wiki-information/functions/GetNumAuctionItems.md b/wiki-information/functions/GetNumAuctionItems.md new file mode 100644 index 00000000..5f0a2147 --- /dev/null +++ b/wiki-information/functions/GetNumAuctionItems.md @@ -0,0 +1,32 @@ +## Title: GetNumAuctionItems + +**Content:** +Retrieves the number of auction items of a certain type. +`batch, count = GetNumAuctionItems(list)` + +**Parameters:** +- `(string type)` + - `type` + - One of the following: + - `"list"` - Items up for auction, the "Browse" tab in the dialog. + - `"bidder"` - Items the player has bid on, the "Bids" tab in the dialog. + - `"owner"` - Items the player has up for auction, the "Auctions" tab in the dialog. + +**Returns:** +- `batch` + - The size of the batch being viewed, 50 for a page view. +- `count` + - The total number of items in the query. + - For a GetAll query, the batch and count are the same. + - Bug seen in 4.0.1: If an AH has over 42554 items, batch will be returned as 42554, and count will be a seemingly random VERY HIGH number - ~1 billion has been seen. + +**Usage:** +```lua +numBatchAuctions, totalAuctions = GetNumAuctionItems("bidder"); +``` + +**Example Use Case:** +This function can be used in an addon that tracks auction house activity. For instance, an addon like Auctioneer might use this function to determine how many items a player has bid on or listed for sale, and then display this information in a user-friendly format. + +**Addons Using This Function:** +- **Auctioneer:** This popular addon uses `GetNumAuctionItems` to manage and display auction data, helping players to buy, sell, and bid on items more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetNumAvailableQuests.md b/wiki-information/functions/GetNumAvailableQuests.md new file mode 100644 index 00000000..dfcb67df --- /dev/null +++ b/wiki-information/functions/GetNumAvailableQuests.md @@ -0,0 +1,15 @@ +## Title: GetNumAvailableQuests + +**Content:** +Returns the number of available quests at a non-gossip quest giver. +`nbrAvailableQuests = GetGossipAvailableQuests()` + +**Returns:** +This returns the number of available quests from a non-gossip quest NPC. +- `nbrAvailableQuests` + - *number* - The number of available quests. + +**Reference:** +- `GetNumActiveQuests` +- `GetGossipAvailableQuests` +- `GetGossipActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBankSlots.md b/wiki-information/functions/GetNumBankSlots.md new file mode 100644 index 00000000..7bf9cd8e --- /dev/null +++ b/wiki-information/functions/GetNumBankSlots.md @@ -0,0 +1,14 @@ +## Title: GetNumBankSlots + +**Content:** +Returns the number of purchased bank bag slots. +`numSlots, full = GetNumBankSlots()` + +**Returns:** +- `numSlots` + - *number* - Number of bag slots already purchased. +- `full` + - *boolean* - True if no further slots are available. + +**Reference:** +- `GetBankSlotCost` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBattlefieldStats.md b/wiki-information/functions/GetNumBattlefieldStats.md new file mode 100644 index 00000000..916583a2 --- /dev/null +++ b/wiki-information/functions/GetNumBattlefieldStats.md @@ -0,0 +1,9 @@ +## Title: GetNumBattlefieldStats + +**Content:** +Appears to return the number of columns in the battleground/field scoreboard, other than the common ones (Killing Blows, Kills, Deaths, Bonus Honour): +`local numStats = GetNumBattlefieldStats()` + +**Returns:** +- `numStats` + - *number* - Number of columns available for the battleground (2 for Warsong Gulch and Arathi Basin, 7 for Alterac Valley) \ No newline at end of file diff --git a/wiki-information/functions/GetNumBattlefields.md b/wiki-information/functions/GetNumBattlefields.md new file mode 100644 index 00000000..488ba6e9 --- /dev/null +++ b/wiki-information/functions/GetNumBattlefields.md @@ -0,0 +1,15 @@ +## Title: GetNumBattlefields + +**Content:** +Returns the number of available instances for the selected battleground at the battlemaster. +`numBattlefields = GetNumBattlefields()` + +**Returns:** +- `numBattlefields` + - *number* + +**Description:** +Battleground types are selected by `RequestBattlegroundInstanceInfo(index)`. + +**Reference:** +- `GetBattlefieldInstanceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBattlegroundTypes.md b/wiki-information/functions/GetNumBattlegroundTypes.md new file mode 100644 index 00000000..56842825 --- /dev/null +++ b/wiki-information/functions/GetNumBattlegroundTypes.md @@ -0,0 +1,12 @@ +## Title: GetNumBattlegroundTypes + +**Content:** +Returns the number of battleground types. +`numBattlegrounds = GetNumBattlegroundTypes()` + +**Returns:** +- `numBattlegrounds` + - *number* - the number of distinct battleground types offered by the server. The player may not be able to join all of those due to level restrictions. + +**Reference:** +- `GetBattlegroundInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBindings.md b/wiki-information/functions/GetNumBindings.md new file mode 100644 index 00000000..b2b0de55 --- /dev/null +++ b/wiki-information/functions/GetNumBindings.md @@ -0,0 +1,9 @@ +## Title: GetNumBindings + +**Content:** +Returns the number of bindings and headers in the key bindings window. +`numKeyBindings = GetNumBindings()` + +**Returns:** +- `numKeyBindings` + - The total number of key bindings (including headers) listed in the key bindings window. \ No newline at end of file diff --git a/wiki-information/functions/GetNumBuybackItems.md b/wiki-information/functions/GetNumBuybackItems.md new file mode 100644 index 00000000..2342eddc --- /dev/null +++ b/wiki-information/functions/GetNumBuybackItems.md @@ -0,0 +1,12 @@ +## Title: GetNumBuybackItems + +**Content:** +Returns the number of items available for buyback. +`numItems = GetNumBuybackItems()` + +**Returns:** +- `numItems` + - *number* - the number of items available for buyback; the maximum index for `GetBuybackItemInfo()`. + +**Description:** +Returns 0 when not at a merchant. \ No newline at end of file diff --git a/wiki-information/functions/GetNumClasses.md b/wiki-information/functions/GetNumClasses.md new file mode 100644 index 00000000..f097f9f9 --- /dev/null +++ b/wiki-information/functions/GetNumClasses.md @@ -0,0 +1,12 @@ +## Title: GetNumClasses + +**Content:** +Returns the number of player classes in the game. +`numClasses = GetNumClasses()` + +**Returns:** +- `numClasses` + - *number* + +**Description:** +This returns 11 (Druid) in Classic since it actually returns the highest class ID. \ No newline at end of file diff --git a/wiki-information/functions/GetNumCompanions.md b/wiki-information/functions/GetNumCompanions.md new file mode 100644 index 00000000..f4b363b0 --- /dev/null +++ b/wiki-information/functions/GetNumCompanions.md @@ -0,0 +1,20 @@ +## Title: GetNumCompanions + +**Content:** +Returns the number of mounts. +`count = GetNumCompanions(type)` + +**Parameters:** +- `type` + - *string* - Type of companions to count: "CRITTER", or "MOUNT". + +**Returns:** +- `count` + - *number* - The number of companions of a specific type. + +**Usage:** +The following snippet prints how many mounts the player has collected. +```lua +local count = GetNumCompanions("MOUNT"); +print('Hello, I have collected a total of ' .. count .. ' mounts.'); +``` \ No newline at end of file diff --git a/wiki-information/functions/GetNumComparisonCompletedAchievements.md b/wiki-information/functions/GetNumComparisonCompletedAchievements.md new file mode 100644 index 00000000..e5e03f37 --- /dev/null +++ b/wiki-information/functions/GetNumComparisonCompletedAchievements.md @@ -0,0 +1,25 @@ +## Title: GetNumComparisonCompletedAchievements + +**Content:** +Returns the number of completed achievements for the comparison player. +`total, completed = GetNumComparisonCompletedAchievements(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - ID of the achievement to retrieve information for. + +**Returns:** +- `total` + - *number* - Total number of achievements currently in the game. +- `completed` + - *number* - Number of achievements completed by the comparison unit. + +**Description:** +- Does not include Feats of Strength. +- Only accurate after the `SetAchievementComparisonUnit` is called and the `INSPECT_ACHIEVEMENT_READY` event has fired. +- Inaccurate after `ClearAchievementComparisonUnit` has been called. + +**Reference:** +- `SetAchievementComparisonUnit` - to select a target before using this function. +- `ClearAchievementComparisonUnit` - to clear the selection after using this function. +- `GetNumCompletedAchievements` - for details about the player's own progress. \ No newline at end of file diff --git a/wiki-information/functions/GetNumCompletedAchievements.md b/wiki-information/functions/GetNumCompletedAchievements.md new file mode 100644 index 00000000..f2cb2cbe --- /dev/null +++ b/wiki-information/functions/GetNumCompletedAchievements.md @@ -0,0 +1,18 @@ +## Title: GetNumCompletedAchievements + +**Content:** +Returns the total and completed number of achievements. +`total, completed = GetNumCompletedAchievements()` + +**Returns:** +- `total`, `completed` + - `total` + - *number* - total number of available achievements + - `completed` + - *number* - total number of completed achievements + +**Description:** +Unknown whether this takes Feats of Strength into account. + +**Reference:** +GetNumComparisonCompletedAchievements - To get information about another player's progress \ No newline at end of file diff --git a/wiki-information/functions/GetNumCrafts.md b/wiki-information/functions/GetNumCrafts.md new file mode 100644 index 00000000..eb8fbbd7 --- /dev/null +++ b/wiki-information/functions/GetNumCrafts.md @@ -0,0 +1,18 @@ +## Title: GetNumCrafts + +**Content:** +Returns the number of crafts in the currently opened crafting window. Usually used to loop through all available crafts to perform API `GetCraftInfo` on them. +`numberOfCrafts = GetNumCrafts()` + +**Example Usage:** +```lua +local numberOfCrafts = GetNumCrafts() +for i = 1, numberOfCrafts do + local craftName, craftSubSpellName, craftType, numAvailable, isExpanded, trainingPointCost, requiredLevel = GetCraftInfo(i) + print("Craft Name: " .. craftName) +end +``` + +**Additional Information:** +- This function is often used in crafting-related addons to iterate through all available crafts and gather information about them. +- Addons like "TradeSkillMaster" use this function to manage and optimize crafting operations by retrieving detailed information about each craft available in the crafting window. \ No newline at end of file diff --git a/wiki-information/functions/GetNumDeclensionSets.md b/wiki-information/functions/GetNumDeclensionSets.md new file mode 100644 index 00000000..ccc4aaac --- /dev/null +++ b/wiki-information/functions/GetNumDeclensionSets.md @@ -0,0 +1,20 @@ +## Title: GetNumDeclensionSets + +**Content:** +Returns the number of suggested declension sets for a Russian name. +`numDeclensionSets = GetNumDeclensionSets(name, gender)` + +**Parameters:** +- `name` + - *string* +- `gender` + - *number* + +**Returns:** +- `numDeclensionSets` + - *number* - Used for `DeclineName()` + +**Description:** +Requires the ruRU client. +Declension sets are sets of additional names prompted during character creation in the ruRU client. +Static names for e.g NPCs are in `DeclinedWord.db2`, `DeclinedWordCases.db2`. \ No newline at end of file diff --git a/wiki-information/functions/GetNumExpansions.md b/wiki-information/functions/GetNumExpansions.md new file mode 100644 index 00000000..3c2a7a4a --- /dev/null +++ b/wiki-information/functions/GetNumExpansions.md @@ -0,0 +1,9 @@ +## Title: GetNumExpansions + +**Content:** +Needs summary. +`numExpansions = GetNumExpansions()` + +**Returns:** +- `numExpansions` + - *number* - e.g. returned 9 during the Shadowlands pre-patch \ No newline at end of file diff --git a/wiki-information/functions/GetNumFactions.md b/wiki-information/functions/GetNumFactions.md new file mode 100644 index 00000000..8d16b848 --- /dev/null +++ b/wiki-information/functions/GetNumFactions.md @@ -0,0 +1,9 @@ +## Title: GetNumFactions + +**Content:** +Returns the number of lines in the faction display. +`numFactions = GetNumFactions()` + +**Returns:** +- `numFactions` + - *number* - The number of lines in your faction display (based on known factions and expanded/collapsed faction lines) \ No newline at end of file diff --git a/wiki-information/functions/GetNumFlexRaidDungeons.md b/wiki-information/functions/GetNumFlexRaidDungeons.md new file mode 100644 index 00000000..4e9f4457 --- /dev/null +++ b/wiki-information/functions/GetNumFlexRaidDungeons.md @@ -0,0 +1,15 @@ +## Title: GetNumFlexRaidDungeons + +**Content:** +Returns the number of available Flexible Raid instances. +`numInstances = GetNumFlexRaidDungeons()` + +**Returns:** +- `numInstances` + - *number* - number of instances available for flexible raid groups. + +**Description:** +The return value does not take your character or instance availability into account; it is simply the number of flexible raid instances the client is aware of. + +**Reference:** +- `GetFlexRaidDungeonInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumFrames.md b/wiki-information/functions/GetNumFrames.md new file mode 100644 index 00000000..ae04f504 --- /dev/null +++ b/wiki-information/functions/GetNumFrames.md @@ -0,0 +1,12 @@ +## Title: GetNumFrames + +**Content:** +Get the current number of Frame (and derivative) objects. +`numFrames = GetNumFrames()` + +**Returns:** +- `numFrames` + - *number* - The current number of frames. + +**Description:** +There are around 7860 frames on a fresh login on patch 10.0.7. \ No newline at end of file diff --git a/wiki-information/functions/GetNumGlyphSockets.md b/wiki-information/functions/GetNumGlyphSockets.md new file mode 100644 index 00000000..897ab590 --- /dev/null +++ b/wiki-information/functions/GetNumGlyphSockets.md @@ -0,0 +1,13 @@ +## Title: GetNumGlyphSockets + +**Content:** +Returns the number of glyph sockets the player will have access to at max level. +`numGlyphSockets = GetNumGlyphSockets();` + +**Returns:** +- `numGlyphSockets` + - *Number* - Number of glyph sockets the player will have access to at max level. + +**Notes and Caveats:** +Sockets have individual level requirements; not every socket may be usable at the character's particular level. +Returns the same value as `NUM_GLYPH_SLOTS`. \ No newline at end of file diff --git a/wiki-information/functions/GetNumGossipActiveQuests.md b/wiki-information/functions/GetNumGossipActiveQuests.md new file mode 100644 index 00000000..d26ef47e --- /dev/null +++ b/wiki-information/functions/GetNumGossipActiveQuests.md @@ -0,0 +1,16 @@ +## Title: GetNumGossipActiveQuests + +**Content:** +Returns the number of active quests that you should eventually turn in to this NPC. +`numActiveQuests = GetNumGossipActiveQuests()` + +**Returns:** +- `numActiveQuests` + - *number* - Number of quests you're on that should be turned in to the NPC you're gossiping with. + +**Description:** +This information is available when the `GOSSIP_SHOW` event fires. + +**Reference:** +- `GetGossipActiveQuests` +- `SelectGossipActiveQuest` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGossipAvailableQuests.md b/wiki-information/functions/GetNumGossipAvailableQuests.md new file mode 100644 index 00000000..578e3ca7 --- /dev/null +++ b/wiki-information/functions/GetNumGossipAvailableQuests.md @@ -0,0 +1,16 @@ +## Title: GetNumGossipAvailableQuests + +**Content:** +Returns the number of quests (that you are not already on) offered by this NPC. +`numNewQuests = GetNumGossipAvailableQuests()` + +**Returns:** +- `numNewQuests` + - *number* - Number of quests you can pick up from this NPC. + +**Description:** +This information is available when the `GOSSIP_SHOW` event fires. + +**Reference:** +- `GetGossipAvailableQuests` +- `SelectGossipAvailableQuest` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGossipOptions.md b/wiki-information/functions/GetNumGossipOptions.md new file mode 100644 index 00000000..a36f8b06 --- /dev/null +++ b/wiki-information/functions/GetNumGossipOptions.md @@ -0,0 +1,16 @@ +## Title: GetNumGossipOptions + +**Content:** +Returns the number of conversation options available with this NPC. +`numOptions = GetNumGossipOptions()` + +**Returns:** +- `numOptions` + - *number* - Number of conversation options you can select. + +**Description:** +This information is available when the `GOSSIP_SHOW` event fires. + +**Reference:** +- `GetGossipOptions` +- `SelectGossipOption` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGroupMembers.md b/wiki-information/functions/GetNumGroupMembers.md new file mode 100644 index 00000000..75d0f655 --- /dev/null +++ b/wiki-information/functions/GetNumGroupMembers.md @@ -0,0 +1,26 @@ +## Title: GetNumGroupMembers + +**Content:** +Returns the number of players in the group. +`numMembers = GetNumGroupMembers()` + +**Parameters:** +- `groupType` + - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. + - **Value** + - **Enum** + - **Description** + - `1` + - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. + - `2` + - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder + +**Returns:** +- `numGroupMembers` + - *number* - total number of players in the group (either party or raid), 0 if not in a group. + +**Description:** +- **Related API:** + - `GetNumSubgroupMembers` +- **Related Events:** + - `GROUP_ROSTER_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGuildMembers.md b/wiki-information/functions/GetNumGuildMembers.md new file mode 100644 index 00000000..fef9a795 --- /dev/null +++ b/wiki-information/functions/GetNumGuildMembers.md @@ -0,0 +1,40 @@ +## Title: GetNumGuildMembers + +**Content:** +Returns the number of total and online guild members. +`numTotalGuildMembers, numOnlineGuildMembers, numOnlineAndMobileMembers = GetNumGuildMembers()` + +**Returns:** +- `numTotalGuildMembers` + - *number* - Total number of players in the Guild, or 0 if not in a guild. +- `numOnlineGuildMembers` + - *number* - Number of players currently online in Guild, or 0 if not in a guild. +- `numOnlineAndMobileMembers` + - *number* - Number of players currently online in Guild (includes players online through the mobile application), or 0 if not in a guild. + +**Usage:** +```lua +local numTotal, numOnline, numOnlineAndMobile = GetNumGuildMembers(); +DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " offline, " .. (numOnlineAndMobile - numOnline) .. " on mobile."); +local numTotal, numOnline, numOnlineAndMobile = GetNumGuildMembers(); +DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " offline, " .. (numOnlineAndMobile - numOnline) .. " on mobile."); +``` + +**Miscellaneous:** +Result: +Displays the number of people online, offline, on mobile, and the total headcount of your guild in the default chat frame. + +**Description:** +You may need to call `C_GuildInfo.GuildRoster()` first in order to obtain correct data. May return wrong values immediately after quitting a guild. Maximum returned value is 500. +There is another problem with the return values as they depend on `SetGuildRosterShowOffline()` setting. A simple program like: +```lua +DEFAULT_CHAT_FRAME:AddMessage("Firing SetGuildRosterShowOffline(false)"); +SetGuildRosterShowOffline(false) +DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(): "..tostring(GetNumGuildMembers())); +DEFAULT_CHAT_FRAME:AddMessage("Firing SetGuildRosterShowOffline(true)"); +SetGuildRosterShowOffline(true) +DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(): "..tostring(GetNumGuildMembers())); +``` +will show the difference. +Take care, if your function called by `GUILD_ROSTER_UPDATE` event handling wants to set the show offline status via `SetGuildRosterShowOffline()`. This may cause, due to guild roster updates, a loop, where a user that has opened the guild panel can't switch the status anymore, even if you reset the original status in your function. +This is because `SetGuildRosterShowOffline()` fires a `GUILD_ROSTER_UPDATE` event if changed. \ No newline at end of file diff --git a/wiki-information/functions/GetNumLanguages.md b/wiki-information/functions/GetNumLanguages.md new file mode 100644 index 00000000..b1847d2e --- /dev/null +++ b/wiki-information/functions/GetNumLanguages.md @@ -0,0 +1,20 @@ +## Title: GetNumLanguages + +**Content:** +Returns the number of languages your character can speak. +`numLanguages = GetNumLanguages()` + +**Returns:** +- `numLanguages` + - *number* + +**Usage:** +Prints the available languages for the player. +```lua +for i = 1, GetNumLanguages() do + print(GetLanguageByIndex(i)) +end +-- e.g. for Blood elf +-- > "Orcish", 1 +-- > "Thalassian", 10 +``` \ No newline at end of file diff --git a/wiki-information/functions/GetNumLootItems.md b/wiki-information/functions/GetNumLootItems.md new file mode 100644 index 00000000..b0767d97 --- /dev/null +++ b/wiki-information/functions/GetNumLootItems.md @@ -0,0 +1,9 @@ +## Title: GetNumLootItems + +**Content:** +Returns the number of items in the loot window. +`numLootItems = GetNumLootItems()` + +**Returns:** +- `numLootItems` + - *number* - The slot number of the last item in the loot window. \ No newline at end of file diff --git a/wiki-information/functions/GetNumMacros.md b/wiki-information/functions/GetNumMacros.md new file mode 100644 index 00000000..f5f81eb6 --- /dev/null +++ b/wiki-information/functions/GetNumMacros.md @@ -0,0 +1,11 @@ +## Title: GetNumMacros + +**Content:** +Returns the number of account and character macros. +`global, perChar = GetNumMacros()` + +**Returns:** +- `global` + - *number* - Number of macros accessible to all characters. +- `perChar` + - *number* - Number of macros accessible to the current character only. \ No newline at end of file diff --git a/wiki-information/functions/GetNumPetitionNames.md b/wiki-information/functions/GetNumPetitionNames.md new file mode 100644 index 00000000..62adc276 --- /dev/null +++ b/wiki-information/functions/GetNumPetitionNames.md @@ -0,0 +1,9 @@ +## Title: GetNumPetitionNames + +**Content:** +Returns the number of signatures on the current petition. +`numNames = GetNumPetitionNames()` + +**Returns:** +- `numNames` + - *number* - The number of names that have signed the petition \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestChoices.md b/wiki-information/functions/GetNumQuestChoices.md new file mode 100644 index 00000000..3e850ab1 --- /dev/null +++ b/wiki-information/functions/GetNumQuestChoices.md @@ -0,0 +1,14 @@ +## Title: GetNumQuestChoices + +**Content:** +Returns the number of available rewards for the current quest. +`numChoices = GetNumQuestChoices()` + +**Returns:** +- `numChoices` + - *number* - number of rewards the player can choose between. + +**Reference:** +- `GetNumQuestRewards` +- `GetNumRewardCurrencies` +- `GetQuestItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestItems.md b/wiki-information/functions/GetNumQuestItems.md new file mode 100644 index 00000000..210e5460 --- /dev/null +++ b/wiki-information/functions/GetNumQuestItems.md @@ -0,0 +1,9 @@ +## Title: GetNumQuestItems + +**Content:** +Returns the number of required items to complete the current quest. +`numRequiredItems = GetNumQuestItems()` + +**Returns:** +- `numRequiredItems` + - *number* - The number of required items for the quest \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLeaderBoards.md b/wiki-information/functions/GetNumQuestLeaderBoards.md new file mode 100644 index 00000000..7a613ee3 --- /dev/null +++ b/wiki-information/functions/GetNumQuestLeaderBoards.md @@ -0,0 +1,16 @@ +## Title: GetNumQuestLeaderBoards + +**Content:** +Returns the number of objectives for a quest. +`numQuestLogLeaderBoards = GetNumQuestLeaderBoards()` + +**Parameters:** +- `questID` + - *number* - Identifier of the quest. If not provided, defaults to the currently selected Quest, via `SelectQuestLogEntry()`. + +**Returns:** +- `numQuestLogLeaderBoards` + - *number* - The number of objectives this quest possesses (Can be 0). + +**Description:** +Previous versions of this page stated that the function returns three values, but did not list what the other two values were. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLogChoices.md b/wiki-information/functions/GetNumQuestLogChoices.md new file mode 100644 index 00000000..ae8b6056 --- /dev/null +++ b/wiki-information/functions/GetNumQuestLogChoices.md @@ -0,0 +1,15 @@ +## Title: GetNumQuestLogChoices + +**Content:** +Returns the number of options someone has when getting a quest item. +`numQuestChoices = GetNumQuestLogChoices(questID)` + +**Parameters:** +- `questID` + - *number* - Unique QuestID for the quest to be queried. +- `includeCurrencies` + - *boolean?* - Optional parameter to include currencies in the count. + +**Returns:** +- `numQuestChoices` + - *number* - The number of quest item options for this quest. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLogEntries.md b/wiki-information/functions/GetNumQuestLogEntries.md new file mode 100644 index 00000000..3a078c7c --- /dev/null +++ b/wiki-information/functions/GetNumQuestLogEntries.md @@ -0,0 +1,24 @@ +## Title: GetNumQuestLogEntries + +**Content:** +Returns the number of entries in the quest log. +`numEntries, numQuests = GetNumQuestLogEntries()` + +**Returns:** +- `numEntries` + - *number* - Number of entries in the Quest Log, including collapsable zone headers. +- `numQuests` + - *number* - Number of actual quests in the Quest Log, not counting zone headers. + +**Usage:** +This snippet displays the number of visible entries (headers and non-collapsed quests) in the quest log and quest count total to the default chat frame. +```lua +local numEntries, numQuests = GetNumQuestLogEntries() +print(numEntries .. " entries containing " .. numQuests .. " quests in your quest log.") +``` + +**Example Use Case:** +This function can be used in addons that manage or display quest information. For instance, an addon that provides enhanced quest tracking or sorting might use this function to determine how many quests are currently in the player's quest log and display this information in a custom UI. + +**Addons Using This Function:** +- **Questie:** A popular addon that enhances the questing experience by showing available quests, objectives, and turn-ins on the map. It uses `GetNumQuestLogEntries` to keep track of the number of quests the player has and to update its interface accordingly. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLogRewards.md b/wiki-information/functions/GetNumQuestLogRewards.md new file mode 100644 index 00000000..f74bb09d --- /dev/null +++ b/wiki-information/functions/GetNumQuestLogRewards.md @@ -0,0 +1,12 @@ +## Title: GetNumQuestLogRewards + +**Content:** +Returns the number of unconditional rewards for the current quest in the quest log. +`numQuestRewards = GetNumQuestLogRewards()` + +**Returns:** +- `numQuestRewards` + - *number* - The number of rewards for this quest + +**Description:** +This refers to items always awarded upon quest completion; for quests where the player is allowed to choose a reward, see `GetNumQuestLogChoices()`. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestRewards.md b/wiki-information/functions/GetNumQuestRewards.md new file mode 100644 index 00000000..84fcf1e0 --- /dev/null +++ b/wiki-information/functions/GetNumQuestRewards.md @@ -0,0 +1,14 @@ +## Title: GetNumQuestRewards + +**Content:** +Returns the number of unconditional rewards at a quest giver. +`numRewards = GetNumQuestRewards()` + +**Returns:** +- `numRewards` + - *number* - number of unconditional item rewards. + +**Reference:** +- `GetNumQuestChoices` +- `GetNumRewardCurrencies` +- `GetQuestItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestWatches.md b/wiki-information/functions/GetNumQuestWatches.md new file mode 100644 index 00000000..a126bbee --- /dev/null +++ b/wiki-information/functions/GetNumQuestWatches.md @@ -0,0 +1,9 @@ +## Title: GetNumQuestWatches + +**Content:** +Returns the number of tracked quests. +`numWatches = GetNumQuestWatches()` + +**Returns:** +- `numWatches` + - *number* - The number of quests currently being tracked. \ No newline at end of file diff --git a/wiki-information/functions/GetNumRewardCurrencies.md b/wiki-information/functions/GetNumRewardCurrencies.md new file mode 100644 index 00000000..87eea8b6 --- /dev/null +++ b/wiki-information/functions/GetNumRewardCurrencies.md @@ -0,0 +1,15 @@ +## Title: GetNumRewardCurrencies + +**Content:** +Returns the number of currency rewards for the quest currently being viewed in the quest log or quest info frame. +`numCurrencies = GetNumRewardCurrencies()` + +**Returns:** +- `numCurrencies` + - *number* - The number of currency rewards + +**Reference:** +- `GetNumQuestRewards` +- `GetNumQuestChoices` +- `GetQuestCurrencyInfo` +- `GetQuestLogRewardCurrencyInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumSavedInstances.md b/wiki-information/functions/GetNumSavedInstances.md new file mode 100644 index 00000000..951879f5 --- /dev/null +++ b/wiki-information/functions/GetNumSavedInstances.md @@ -0,0 +1,18 @@ +## Title: GetNumSavedInstances + +**Content:** +Returns the number of instances for which the character is locked out. +`numInstances = GetNumSavedInstances()` + +**Returns:** +- `numInstances` + - *number* - number of instances with available lockouts, 0 if none. + +**Description:** +Returns the number of records that can be queried via `GetSavedInstanceInfo(...)`. +The count returned includes not just locked instances, but expired and extended lockouts as well. +The count does not include world bosses, which use `GetNumSavedWorldBosses()`. + +**Reference:** +- `GetSavedInstanceInfo(...)` - drills down to a specific saved instance +- `GetNumSavedWorldBosses()` - same function as this, but for world bosses \ No newline at end of file diff --git a/wiki-information/functions/GetNumSkillLines.md b/wiki-information/functions/GetNumSkillLines.md new file mode 100644 index 00000000..d7999d5c --- /dev/null +++ b/wiki-information/functions/GetNumSkillLines.md @@ -0,0 +1,28 @@ +## Title: GetNumSkillLines + +**Content:** +Returns the number of skill lines in the skill window, including headers. +`numSkills = GetNumSkillLines()` + +**Returns:** +- `numSkills` + - *number* + +**Reference:** +- `GetSkillLineInfo()` + +**Example Usage:** +This function can be used to iterate through all skill lines in the skill window. For example, you might use it in a loop to gather information about each skill line: + +```lua +local numSkills = GetNumSkillLines() +for i = 1, numSkills do + local skillName, isHeader = GetSkillLineInfo(i) + if not isHeader then + print("Skill:", skillName) + end +end +``` + +**Addons:** +Many addons that manage or display profession and skill information, such as TradeSkillMaster, use this function to gather data about the player's skills. \ No newline at end of file diff --git a/wiki-information/functions/GetNumSockets.md b/wiki-information/functions/GetNumSockets.md new file mode 100644 index 00000000..3ba94be4 --- /dev/null +++ b/wiki-information/functions/GetNumSockets.md @@ -0,0 +1,22 @@ +## Title: GetNumSockets + +**Content:** +Returns the number of sockets for an item in the socketing window. + +**Parameters:** +- None + +**Returns:** +- `Sockets` + - *Number* - The number of sockets in the item currently in the item socketing window. If the item socketing window is closed, 0. + +**Usage:** +```lua +local SocketCount = GetNumSockets() +for i = 1, SocketCount do + print(GetSocketInfo(i)) +end +``` + +**Description:** +This function is only useful if the item socketing window is currently visible. \ No newline at end of file diff --git a/wiki-information/functions/GetNumSpellTabs.md b/wiki-information/functions/GetNumSpellTabs.md new file mode 100644 index 00000000..d9f96fc7 --- /dev/null +++ b/wiki-information/functions/GetNumSpellTabs.md @@ -0,0 +1,12 @@ +## Title: GetNumSpellTabs + +**Content:** +Returns the number of tabs in the spellbook. +`numTabs = GetNumSpellTabs()` + +**Returns:** +- `numTabs` + - *number* - number of ability tabs in the player's spellbook (e.g. 4 -- "General", "Arcane", "Fire", "Frost") + +**Description:** +Each of the player's professions also gets a spellbook tab, but these tabs are not included in the count returned by this function. \ No newline at end of file diff --git a/wiki-information/functions/GetNumStableSlots.md b/wiki-information/functions/GetNumStableSlots.md new file mode 100644 index 00000000..4889e314 --- /dev/null +++ b/wiki-information/functions/GetNumStableSlots.md @@ -0,0 +1,9 @@ +## Title: GetNumStableSlots + +**Content:** +Returns the amount of stable slots. +`numSlots = GetNumStableSlots()` + +**Returns:** +- `numSlots` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetNumSubgroupMembers.md b/wiki-information/functions/GetNumSubgroupMembers.md new file mode 100644 index 00000000..5ac51091 --- /dev/null +++ b/wiki-information/functions/GetNumSubgroupMembers.md @@ -0,0 +1,26 @@ +## Title: GetNumSubgroupMembers + +**Content:** +Returns the number of other players in the party or raid subgroup. +`numSubgroupMembers = GetNumSubgroupMembers()` + +**Parameters:** +- `groupType` + - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. + - **Value** + - **Enum** + - **Description** + - `1` + - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. + - `2` + - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder + +**Returns:** +- `numSubgroupMembers` + - *number* - number of players in the player's sub-group, excluding the player. + +**Description:** +- **Related API** + - `GetNumGroupMembers` +- **Related Events** + - `GROUP_ROSTER_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetNumTalentGroups.md b/wiki-information/functions/GetNumTalentGroups.md new file mode 100644 index 00000000..9a1913e7 --- /dev/null +++ b/wiki-information/functions/GetNumTalentGroups.md @@ -0,0 +1,19 @@ +## Title: GetNumTalentGroups + +**Content:** +Returns the total number of talent groups for the player. +`num = GetNumTalentGroups()` + +**Parameters:** +- `isInspect` + - *boolean?* = false + +**Returns:** +- `num` + - *number* - The number of talent groups. 1 by default, 2 if Dual Talent Specialization is purchased. + +**Description:** +Using `isInspect` requires calling `NotifyInspect()` and awaiting `INSPECT_READY`. If not done, it returns information for the player instead. + +**Related API:** +- `GetNumTalentTabs` \ No newline at end of file diff --git a/wiki-information/functions/GetNumTalentTabs.md b/wiki-information/functions/GetNumTalentTabs.md new file mode 100644 index 00000000..4e5c4650 --- /dev/null +++ b/wiki-information/functions/GetNumTalentTabs.md @@ -0,0 +1,13 @@ +## Title: GetNumTalentTabs + +**Content:** +Returns the total number of talent tabs for the player. +`numTabs = GetNumTalentTabs()` + +**Parameters:** +- `isInspect` + - *boolean* - Optional, will return the number of talent tabs for the current inspect target if true (see NotifyInspect). + +**Returns:** +- `numTabs` + - *number* - The number of talent tabs available (for example Elemental, Enhancement, and Restoration for Shamans). \ No newline at end of file diff --git a/wiki-information/functions/GetNumTalents.md b/wiki-information/functions/GetNumTalents.md new file mode 100644 index 00000000..8ed5bef1 --- /dev/null +++ b/wiki-information/functions/GetNumTalents.md @@ -0,0 +1,17 @@ +## Title: GetNumTalents + +**Content:** +Returns the amount of talents for a specialization. +`numTalents = GetNumTalents(tabIndex)` + +**Parameters:** +- `tabIndex` + - *number* - Ranging from 1 to `GetNumTalentTabs()` + +**Returns:** +- `numTalents` + - *number* - The amount of talents offered by a specialization. + +**Reference:** +- `UnitCharacterPoints` - returns the amount of unspent talent points +- `GetTalentInfo/Classic` \ No newline at end of file diff --git a/wiki-information/functions/GetNumTitles.md b/wiki-information/functions/GetNumTitles.md new file mode 100644 index 00000000..f677c75b --- /dev/null +++ b/wiki-information/functions/GetNumTitles.md @@ -0,0 +1,9 @@ +## Title: GetNumTitles + +**Content:** +Returns the number of titles, specifically the highest title ID. +`numTitles = GetNumTitles()` + +**Returns:** +- `numTitles` + - *number* - TitleId \ No newline at end of file diff --git a/wiki-information/functions/GetNumTrackedAchievements.md b/wiki-information/functions/GetNumTrackedAchievements.md new file mode 100644 index 00000000..e15addfe --- /dev/null +++ b/wiki-information/functions/GetNumTrackedAchievements.md @@ -0,0 +1,20 @@ +## Title: GetNumTrackedAchievements + +**Content:** +Returns the number of tracked achievements. +`numTracked = GetNumTrackedAchievements()` + +**Returns:** +- `numTracked` + - *number* - number of achievements you are currently tracking, up to 10. + +**Reference:** +- `AddTrackedAchievement` +- `GetTrackedAchievements` +- `RemoveTrackedAchievement` + +**Example Usage:** +This function can be used to determine how many achievements a player is currently tracking. For instance, an addon could use this to display a list of tracked achievements or to ensure that the player does not exceed the tracking limit. + +**Addon Usage:** +Large addons like "Overachiever" use this function to manage and display tracked achievements, providing players with enhanced achievement tracking and management features. \ No newline at end of file diff --git a/wiki-information/functions/GetNumTradeSkills.md b/wiki-information/functions/GetNumTradeSkills.md new file mode 100644 index 00000000..3d2da529 --- /dev/null +++ b/wiki-information/functions/GetNumTradeSkills.md @@ -0,0 +1,15 @@ +## Title: GetNumTradeSkills + +**Content:** +Get the number of trade skill entries (including headers) +`numSkills = GetNumTradeSkills()` + +**Returns:** +- `numSkills` + - *number* - The number of trade skills which are available (including headers) + +**Example Usage:** +This function can be used to determine the total number of trade skills a player has, including headers which are used to categorize the skills. This is useful for addons that need to display or manage the player's trade skills. + +**Addon Usage:** +Large addons like TradeSkillMaster (TSM) use this function to gather information about the player's trade skills. TSM uses this data to provide detailed management and automation of crafting, auctioning, and other trade skill-related activities. \ No newline at end of file diff --git a/wiki-information/functions/GetOSLocale.md b/wiki-information/functions/GetOSLocale.md new file mode 100644 index 00000000..489260ff --- /dev/null +++ b/wiki-information/functions/GetOSLocale.md @@ -0,0 +1,25 @@ +## Title: GetOSLocale + +**Content:** +Returns the locale of the Operating System. +`locale = GetOSLocale()` + +**Returns:** +- `locale` + - *string* - Recognized values are: + - `LanguageRegions = {}` + - `LanguageRegions = 0` + - `LanguageRegions = 1` + - `LanguageRegions = 2` + - `LanguageRegions = 3` + - `LanguageRegions = 4` + - `LanguageRegions = 5` + - `LanguageRegions = 6` + - `LanguageRegions = 7` + - `LanguageRegions = 8` + - `LanguageRegions = 9` + - `LanguageRegions = 10` + - `LanguageRegions = 11` + - `LanguageRegions = 12` + - `LanguageRegions = 13` + - `LanguageRegions = 14` \ No newline at end of file diff --git a/wiki-information/functions/GetObjectIconTextureCoords.md b/wiki-information/functions/GetObjectIconTextureCoords.md new file mode 100644 index 00000000..9db373f5 --- /dev/null +++ b/wiki-information/functions/GetObjectIconTextureCoords.md @@ -0,0 +1,22 @@ +## Title: GetObjectIconTextureCoords + +**Content:** +Returns texture coordinates of an object icon. +`left, right, top, bottom = GetObjectIconTextureCoords(objectIcon)` + +**Parameters:** +- `objectIcon` + - *number* - index of the object icon to retrieve texture coordinates for, ascending from -2. + +**Returns:** +- `left` + - *number* - left edge of the specified icon, 0 for the texture's left edge and 1 for the texture's right edge. +- `right` + - *number* - right edge of the specified icon, 0 for the texture's left edge and 1 for the texture's right edge. +- `top` + - *number* - top edge of the specified icon, 0 for the texture's top edge and 1 for the texture's bottom edge. +- `bottom` + - *number* - bottom edge of the specified icon, 0 for the texture's top edge and 1 for the texture's bottom edge. + +**Description:** +Returns texture coordinates into `Interface\\MINIMAP\\OBJECTICONS.blp`, the minimap blip texture. \ No newline at end of file diff --git a/wiki-information/functions/GetOptOutOfLoot.md b/wiki-information/functions/GetOptOutOfLoot.md new file mode 100644 index 00000000..fba43803 --- /dev/null +++ b/wiki-information/functions/GetOptOutOfLoot.md @@ -0,0 +1,12 @@ +## Title: GetOptOutOfLoot + +**Content:** +Returns true if the player is automatically passing on all loot. +`optedOut = GetOptOutOfLoot()` + +**Returns:** +- `optedOut` + - *boolean* - 1 if the player is currently passing on all loot, nil otherwise. + +**Reference:** +- `SetOptOutOfLoot` \ No newline at end of file diff --git a/wiki-information/functions/GetOwnerAuctionItems.md b/wiki-information/functions/GetOwnerAuctionItems.md new file mode 100644 index 00000000..e4d152ce --- /dev/null +++ b/wiki-information/functions/GetOwnerAuctionItems.md @@ -0,0 +1,12 @@ +## Title: GetOwnerAuctionItems + +**Content:** +Updates owned auction list. +`GetOwnerAuctionItems()` + +**Usage:** +When selling multiple stacks of items (multisell) sometimes the last few stacks get posted without a subsequent list update. +Useful for when `AUCTION_OWNED_LIST_UPDATE` fires but the list isn't actually updated until you switch to the tab. + +**Description:** +Manually calling this function doesn't appear to do anything by itself. Having an event handler registered for the event, calling it shortly after an auction is posted or calling it in an `OnShow` handler can make it work. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPDesired.md b/wiki-information/functions/GetPVPDesired.md new file mode 100644 index 00000000..16ce3a56 --- /dev/null +++ b/wiki-information/functions/GetPVPDesired.md @@ -0,0 +1,9 @@ +## Title: GetPVPDesired + +**Content:** +Returns true if the player has enabled their PvP flag. +`desired = GetPVPDesired()` + +**Returns:** +- `desired` + - *boolean* - true if the player has enabled their PvP flag \ No newline at end of file diff --git a/wiki-information/functions/GetPVPLastWeekStats.md b/wiki-information/functions/GetPVPLastWeekStats.md new file mode 100644 index 00000000..c7f12498 --- /dev/null +++ b/wiki-information/functions/GetPVPLastWeekStats.md @@ -0,0 +1,15 @@ +## Title: GetPVPLastWeekStats + +**Content:** +Gets the player's PVP contribution statistics for the previous week. +`hk, dk, contribution, rank = GetPVPLastWeekStats()` + +**Returns:** +- `hk` + - *number* - The number of honorable kills. +- `dk` + - *number* - The number of dishonorable kills. +- `contribution` + - *number* - The estimated number of honor contribution points. +- `rank` + - *number* - The honor rank the player had. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPLifetimeStats.md b/wiki-information/functions/GetPVPLifetimeStats.md new file mode 100644 index 00000000..7686bf43 --- /dev/null +++ b/wiki-information/functions/GetPVPLifetimeStats.md @@ -0,0 +1,19 @@ +## Title: GetPVPLifetimeStats + +**Content:** +Returns the character's lifetime PvP statistics. +`lifetimeHonorableKills, lifetimeMaxPVPRank = GetPVPLifetimeStats()` + +**Returns:** +- `lifetimeHonorableKills` + - *number* - The number of honorable kills you have made +- `lifetimeMaxPVPRank` + - *number* - The highest rank you have achieved (Use `GetPVPRankInfo(highestRank)` to get the name of the rank) + +**Usage:** +Prints the player's PVP rank name to the default chat frame. +```lua +local _, _, highestRank = GetPVPLifetimeStats() +local pvpRank = GetPVPRankInfo(highestRank) +print(pvpRank) +``` \ No newline at end of file diff --git a/wiki-information/functions/GetPVPRankInfo.md b/wiki-information/functions/GetPVPRankInfo.md new file mode 100644 index 00000000..73ba8a7d --- /dev/null +++ b/wiki-information/functions/GetPVPRankInfo.md @@ -0,0 +1,41 @@ +## Title: GetPVPRankInfo + +**Content:** +Returns information about a specific PvP rank. +`rankName, rankNumber = GetPVPRankInfo(rankID)` + +**Parameters:** +- `rankID` + - *number* - The PvP rank ID as returned by `UnitPVPRank()` +- `faction` + - *number?* - 0 for Horde, 1 for Alliance. Defaults to the player's faction. Previously accepted a UnitId but now takes a faction ID. + +**Values:** +Dishonorable ranks like "Pariah" exist but were never used in Vanilla. + +| Rank ID | Alliance | Horde | Rank Number | +|---------|--------------------|-------------------|-------------| +| 0 | Pariah | Pariah | -4 | +| 1 | Outlaw | Outlaw | -3 | +| 2 | Exiled | Exiled | -2 | +| 3 | Dishonored | Dishonored | -1 | +| 4 | Private | Scout | 1 | +| 5 | Corporal | Grunt | 2 | +| 6 | Sergeant | Sergeant | 3 | +| 7 | Master Sergeant | Senior Sergeant | 4 | +| 8 | Sergeant Major | First Sergeant | 5 | +| 9 | Knight | Stone Guard | 6 | +| 10 | Knight-Lieutenant | Blood Guard | 7 | +| 11 | Knight-Captain | Legionnaire | 8 | +| 12 | Knight-Champion | Centurion | 9 | +| 13 | Lieutenant Commander | Champion | 10 | +| 14 | Commander | Lieutenant General| 11 | +| 15 | Marshal | General | 12 | +| 16 | Field Marshal | Warlord | 13 | +| 17 | Grand Marshal | High Warlord | 14 | + +**Returns:** +- `rankName` + - *string* - The localized name of the PvP rank. +- `rankNumber` + - *number* - The PvP rank number. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPRankProgress.md b/wiki-information/functions/GetPVPRankProgress.md new file mode 100644 index 00000000..6dd2cf35 --- /dev/null +++ b/wiki-information/functions/GetPVPRankProgress.md @@ -0,0 +1,9 @@ +## Title: GetPVPRankProgress + +**Content:** +Returns the player's progress to the next PvP rank. +`progress = GetPVPRankProgress()` + +**Returns:** +- `progress` + - *number* - Progress towards the next rank, value normalized between 0 and 1. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPRoles.md b/wiki-information/functions/GetPVPRoles.md new file mode 100644 index 00000000..d8dd4f7a --- /dev/null +++ b/wiki-information/functions/GetPVPRoles.md @@ -0,0 +1,17 @@ +## Title: GetPVPRoles + +**Content:** +Returns which roles the player is willing to perform in PvP battlegrounds. +`tank, healer, dps = GetPVPRoles()` + +**Returns:** +- `tank` + - *boolean* - true if the player is marked as willing to tank, false otherwise. +- `healer` + - *boolean* - true if the player is marked as willing to heal, false otherwise. +- `dps` + - *boolean* - true if the player is marked as willing to deal damage, false otherwise. + +**Reference:** +- `SetPVPRoles` +- `PVP_ROLE_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetPVPSessionStats.md b/wiki-information/functions/GetPVPSessionStats.md new file mode 100644 index 00000000..dc2d2e0c --- /dev/null +++ b/wiki-information/functions/GetPVPSessionStats.md @@ -0,0 +1,21 @@ +## Title: GetPVPSessionStats + +**Content:** +Returns the character's Honor statistics for this session. +`honorableKills, dishonorableKills = GetPVPSessionStats()` + +**Returns:** +- `honorableKills` + - *number* - Amount of honorable kills you have today, returns 0 if you haven't killed anybody today. +- `dishonorableKills` + - *number* - Note: Not sure if this is dishonorable kills or estimated honor points for today. + +**Description:** +Used for retrieving how many honorable kills and honor points you have for today, currently the honor points value is calculated using the estimated honor points from killing an enemy player, and does not take diminishing returns or bonus honor into effect. + +**Usage:** +Displays how many honorable kills and estimated honor points you have for today. +```lua +local hk, hp = GetPVPSessionStats(); +DEFAULT_CHAT_FRAME:AddMessage("You currently have " .. hk .. " honorable kills today, and an estimated " .. hp .. " honor points."); +``` \ No newline at end of file diff --git a/wiki-information/functions/GetPVPThisWeekStats.md b/wiki-information/functions/GetPVPThisWeekStats.md new file mode 100644 index 00000000..5bc770ad --- /dev/null +++ b/wiki-information/functions/GetPVPThisWeekStats.md @@ -0,0 +1,11 @@ +## Title: GetPVPThisWeekStats + +**Content:** +Gets your PVP contribution statistics for the current week. +`hk, contribution = GetPVPThisWeekStats()` + +**Returns:** +- `hk` + - *number* - The number of honorable kills. +- `contribution` + - *number* - The estimated honor points made. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPTimer.md b/wiki-information/functions/GetPVPTimer.md new file mode 100644 index 00000000..83e84842 --- /dev/null +++ b/wiki-information/functions/GetPVPTimer.md @@ -0,0 +1,29 @@ +## Title: GetPVPTimer + +**Content:** +Returns the time left in milliseconds until the player is unflagged for PvP. +`timer = GetPVPTimer()` + +**Returns:** +- `timer` + - *number* - Amount of time (in milliseconds) until your PVP flag wears off. + +**Description:** +- If you are flagged for PVP permanently, the function returns 301000. +- If you are not flagged for PVP the function returns either 301000 or -1. + +**Usage:** +The following snippet displays your current PVP status: +```lua +local sec = math.floor(GetPVPTimer()/1000) +local msg = (not UnitIsPVP("player")) and "You are not flagged for PVP" or + (sec==301 and "You are perma-flagged for PVP" or + "Your PVP flag wears off in "..(sec>60 and math.floor(sec/60).." minutes " or "")..(sec%60).." seconds") +DEFAULT_CHAT_FRAME:AddMessage(msg) +``` + +**Example Use Case:** +This function can be used in addons that manage or display player status, particularly in PvP environments. For instance, an addon could use this function to show a countdown timer for when a player will be unflagged from PvP, helping players to manage their PvP status more effectively. + +**Addons Using This Function:** +- **PvPStatus**: An addon that tracks and displays the player's PvP flag status and the remaining time until the flag is removed. It uses `GetPVPTimer` to provide real-time updates to the player. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPYesterdayStats.md b/wiki-information/functions/GetPVPYesterdayStats.md new file mode 100644 index 00000000..3779be90 --- /dev/null +++ b/wiki-information/functions/GetPVPYesterdayStats.md @@ -0,0 +1,11 @@ +## Title: GetPVPYesterdayStats + +**Content:** +Returns the character's Honor statistics for yesterday. +`honorableKills, dishonorableKills = GetPVPYesterdayStats()` + +**Returns:** +- `honorableKills` + - *number* - The number of honorable kills +- `dishonorableKills` + - *number* - The number of dishonorable kills \ No newline at end of file diff --git a/wiki-information/functions/GetParryChance.md b/wiki-information/functions/GetParryChance.md new file mode 100644 index 00000000..7fef5cf8 --- /dev/null +++ b/wiki-information/functions/GetParryChance.md @@ -0,0 +1,16 @@ +## Title: GetParryChance + +**Content:** +Returns the parry chance percentage. +`parryChance = GetParryChance()` + +**Returns:** +- `parryChance` + - *number* - Player's parry chance in percentage. + +**Reference:** +- `GetBlockChance` +- `GetDodgeChance` +- `GetCritChance` +- `GetCombatRating` +- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetParryChanceFromAttribute.md b/wiki-information/functions/GetParryChanceFromAttribute.md new file mode 100644 index 00000000..d9a2d8e3 --- /dev/null +++ b/wiki-information/functions/GetParryChanceFromAttribute.md @@ -0,0 +1,9 @@ +## Title: GetParryChanceFromAttribute + +**Content:** +Needs summary. +`parryChance = GetParryChanceFromAttribute()` + +**Returns:** +- `parryChance` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetPartyAssignment.md b/wiki-information/functions/GetPartyAssignment.md new file mode 100644 index 00000000..72ba112d --- /dev/null +++ b/wiki-information/functions/GetPartyAssignment.md @@ -0,0 +1,31 @@ +## Title: GetPartyAssignment + +**Content:** +Returns true if a group member is assigned the main tank/assist role. +`isAssigned = GetPartyAssignment(assignment)` + +**Parameters:** +- `assignment` + - *string* - The role to search, either "MAINTANK" or "MAINASSIST" (not case-sensitive). +- `raidmember` + - *string* - UnitId +- `exactMatch` + - *boolean* + +**Returns:** +- `isAssigned` + - *boolean* + +**Example Usage:** +```lua +local isMainTank = GetPartyAssignment("MAINTANK", "player") +if isMainTank then + print("You are the main tank!") +else + print("You are not the main tank.") +end +``` + +**Addons Using This Function:** +- **Deadly Boss Mods (DBM):** Utilizes this function to determine and announce the roles of players during raid encounters. +- **Grid:** Uses this function to display role-specific indicators on the unit frames. \ No newline at end of file diff --git a/wiki-information/functions/GetPersonalRatedInfo.md b/wiki-information/functions/GetPersonalRatedInfo.md new file mode 100644 index 00000000..7961d116 --- /dev/null +++ b/wiki-information/functions/GetPersonalRatedInfo.md @@ -0,0 +1,36 @@ +## Title: GetPersonalRatedInfo + +**Content:** +Returns information about the player's personal PvP rating in a specific bracket. +`rating, seasonBest, weeklyBest, seasonPlayed, seasonWon, weeklyPlayed, weeklyWon, cap = GetPersonalRatedInfo(index)` + +**Parameters:** +- `index` + - *number* - PvP bracket index ascending from 1 for 2v2, 3v3, 5v5, and 10v10 rated battlegrounds. + +**Returns:** +- `rating` + - *number* - the player's current rating. +- `seasonBest` + - *number* - the player's season best rating. +- `weeklyBest` + - *number* - the player's weekly best rating. +- `seasonPlayed` + - *number* - number of games played in this bracket this season. +- `seasonWon` + - *number* - number of games won in this bracket this season. +- `weeklyPlayed` + - *number* - number of games played in this bracket this week. +- `weeklyWon` + - *number* - number of games won in this bracket this season. +- `cap` + - *number* - projected conquest cap in points. + +**Reference:** +`GetInspectArenaData` + +**Example Usage:** +This function can be used to display a player's current and historical performance in different PvP brackets. For instance, an addon that tracks and displays PvP statistics could use this function to show detailed information about a player's ratings and game history. + +**Addon Usage:** +Large PvP-focused addons like "GladiatorlosSA" or "REFlex - Arena/Battleground Historian" might use this function to provide players with insights into their performance, helping them to track their progress and improve their strategies in rated PvP matches. \ No newline at end of file diff --git a/wiki-information/functions/GetPetActionCooldown.md b/wiki-information/functions/GetPetActionCooldown.md new file mode 100644 index 00000000..9043968e --- /dev/null +++ b/wiki-information/functions/GetPetActionCooldown.md @@ -0,0 +1,32 @@ +## Title: GetPetActionCooldown + +**Content:** +Returns cooldown info for an action on the pet action bar. +`startTime, duration, enable = GetPetActionCooldown(index)` + +**Parameters:** +- `index` + - *number* - The index of the pet action button you want to query for cooldown info. + +**Returns:** +- `startTime` + - *number* - The time when the cooldown started (as returned by GetTime()) or zero if no cooldown +- `duration` + - *number* - The number of seconds the cooldown will last, or zero if no cooldown +- `enable` + - *boolean* - 0 if no cooldown, 1 if cooldown is in effect (probably) + +**Example Usage:** +```lua +local index = 1 -- Example index for the first pet action button +local startTime, duration, enable = GetPetActionCooldown(index) +if enable == 1 then + print("Cooldown started at:", startTime) + print("Cooldown duration:", duration) +else + print("No cooldown in effect.") +end +``` + +**Additional Information:** +This function is commonly used in addons that manage pet abilities, such as those for hunters and warlocks. For example, the popular addon "PetTracker" might use this function to display cooldowns for pet abilities on the action bar. \ No newline at end of file diff --git a/wiki-information/functions/GetPetActionInfo.md b/wiki-information/functions/GetPetActionInfo.md new file mode 100644 index 00000000..8471add7 --- /dev/null +++ b/wiki-information/functions/GetPetActionInfo.md @@ -0,0 +1,32 @@ +## Title: GetPetActionInfo + +**Content:** +Returns info for an action on the pet action bar. +`name, texture, isToken, isActive, autoCastAllowed, autoCastEnabled, spellID, checksRange, inRange = GetPetActionInfo(index)` + +**Parameters:** +- `index` + - *number* - The index of the pet action button you want to query. + +**Returns:** +- `name` + - *string* - The name of the action (or its global ID if isToken is true). +- `texture` + - *string* - The name (or its global ID, if isToken is true) of the texture for the action. +- `isToken` + - *boolean* - Indicates if the action is a reference to a global action, or not (guess). +- `isActive` + - *boolean* - Returns true if the ability is currently active. +- `autoCastAllowed` + - *boolean* - Returns true if this ability can use autocast. +- `autoCastEnabled` + - *boolean* - Returns true if autocast is currently enabled for this ability. +- `spellID` + - *number* - Returns the spell ID associated with this ability. +- `checksRange` + - *boolean* - Returns true if this ability has a numeric range requirement. +- `inRange` + - *boolean* - Returns true if this ability is currently in range. + +**Description:** +Information based on a post from Sarf plus some guesswork, so may not be 100% accurate. \ No newline at end of file diff --git a/wiki-information/functions/GetPetActionSlotUsable.md b/wiki-information/functions/GetPetActionSlotUsable.md new file mode 100644 index 00000000..6f89a3cc --- /dev/null +++ b/wiki-information/functions/GetPetActionSlotUsable.md @@ -0,0 +1,13 @@ +## Title: GetPetActionSlotUsable + +**Content:** +Indicates if the current player's pet can currently use the specified pet action. +`isUsable = GetPetActionSlotUsable(index)` + +**Parameters:** +- `index` + - *number* - The index of the pet action button you want to query. + +**Returns:** +- `isUsable` + - *boolean* - Returns true if the pet action is currently usable, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetPetExperience.md b/wiki-information/functions/GetPetExperience.md new file mode 100644 index 00000000..7bb33ddd --- /dev/null +++ b/wiki-information/functions/GetPetExperience.md @@ -0,0 +1,21 @@ +## Title: GetPetExperience + +**Content:** +Returns the pet's current and total XP required for the next level. +`currXP, nextXP = GetPetExperience()` + +**Returns:** +- `currXP` + - *number* - The current XP total +- `nextXP` + - *number* - The XP total required for the next level + +**Usage:** +```lua +local currXP, nextXP = GetPetExperience(); +DEFAULT_CHAT_FRAME:AddMessage("Pet experience: " .. currXP .. " / " .. nextXP); +``` + +**Miscellaneous:** +Result: +Pet experience is displayed in the default chat frame. \ No newline at end of file diff --git a/wiki-information/functions/GetPetFoodTypes.md b/wiki-information/functions/GetPetFoodTypes.md new file mode 100644 index 00000000..210aa033 --- /dev/null +++ b/wiki-information/functions/GetPetFoodTypes.md @@ -0,0 +1,29 @@ +## Title: GetPetFoodTypes + +**Content:** +Returns the food types the pet can eat. +`petFoodList = { GetPetFoodTypes() }` + +**Returns:** +- multiple Strings (not a table) + - Possible strings: + - Meat + - Fish + - Fruit + - Fungus + - Bread + - Cheese + +**Usage:** +To print every string from the list into the default chatframe. +```lua +local petFoodList = { GetPetFoodTypes() }; +if #petFoodList > 0 then + local index, foodType; + for index, foodType in pairs(petFoodList) do + DEFAULT_CHAT_FRAME:AddMessage(foodType); + end +else + DEFAULT_CHAT_FRAME:AddMessage("No pet food types available."); +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetPetHappiness.md b/wiki-information/functions/GetPetHappiness.md new file mode 100644 index 00000000..1e688fe3 --- /dev/null +++ b/wiki-information/functions/GetPetHappiness.md @@ -0,0 +1,33 @@ +## Title: GetPetHappiness + +**Content:** +Returns the pet's happiness, damage percentage, and loyalty gain rate. +`happiness, damagePercentage, loyaltyRate = GetPetHappiness()` + +**Returns:** +- `happiness` + - *number* - the numerical happiness value of the pet (1 = unhappy, 2 = content, 3 = happy) +- `damagePercentage` + - *number* - damage modifier, happiness affects this (unhappy = 75%, content = 100%, happy = 125%) +- `loyaltyRate` + - *number* - the rate at which your pet is currently gaining loyalty (< 0, losing loyalty, > 0, gaining loyalty) + +**Usage:** +```lua +local happiness, damagePercentage, loyaltyRate = GetPetHappiness() +if not happiness then + print("No Pet") +else + local happy = ({"Unhappy", "Content", "Happy"}) + local loyalty = loyaltyRate > 0 and "gaining" or "losing" + print("Pet is " .. happy[happiness]) + print("Pet is doing " .. damagePercentage .. "% damage") + print("Pet is " .. loyalty .. " loyalty") +end +``` + +**Example Use Case:** +This function can be used in a Hunter's pet management addon to display the pet's current happiness and loyalty status, which can affect the pet's performance in combat. + +**Addons Using This Function:** +- **PetTracker:** This addon uses `GetPetHappiness` to provide detailed information about the player's pet, including its happiness and loyalty status, which can be crucial for maintaining optimal pet performance. \ No newline at end of file diff --git a/wiki-information/functions/GetPetLoyalty.md b/wiki-information/functions/GetPetLoyalty.md new file mode 100644 index 00000000..0cf14982 --- /dev/null +++ b/wiki-information/functions/GetPetLoyalty.md @@ -0,0 +1,9 @@ +## Title: GetPetLoyalty + +**Content:** +Returns pet loyalty flavor text. +`petLoyaltyText = GetPetLoyalty()` + +**Returns:** +- `petLoyaltyText` + - *string* - The localized pet loyalty level, i.e. "(Loyalty Level 6) Best Friend". \ No newline at end of file diff --git a/wiki-information/functions/GetPetSpellBonusDamage.md b/wiki-information/functions/GetPetSpellBonusDamage.md new file mode 100644 index 00000000..9e8f518e --- /dev/null +++ b/wiki-information/functions/GetPetSpellBonusDamage.md @@ -0,0 +1,9 @@ +## Title: GetPetSpellBonusDamage + +**Content:** +Needs summary. +`spellBonus = GetPetSpellBonusDamage()` + +**Returns:** +- `spellBonus` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetPetTrainingPoints.md b/wiki-information/functions/GetPetTrainingPoints.md new file mode 100644 index 00000000..cee595bd --- /dev/null +++ b/wiki-information/functions/GetPetTrainingPoints.md @@ -0,0 +1,11 @@ +## Title: GetPetTrainingPoints + +**Content:** +Gets the training point information about the current pet. +`totalPoints, spent = GetPetTrainingPoints()` + +**Returns:** +- `totalPoints` + - *number* - The total of points spent and points available. +- `spent` + - *number* - The number of points spent. \ No newline at end of file diff --git a/wiki-information/functions/GetPetitionInfo.md b/wiki-information/functions/GetPetitionInfo.md new file mode 100644 index 00000000..d718b9fe --- /dev/null +++ b/wiki-information/functions/GetPetitionInfo.md @@ -0,0 +1,24 @@ +## Title: GetPetitionInfo + +**Content:** +Returns info for the petition being viewed. +`petitionType, title, bodyText, maxSigs, originator, isOriginator, minSigs = GetPetitionInfo()` + +**Returns:** +- `petitionType` + - *string* - The type of petition (e.g., "guild" or "arena") +- `title` + - *string* - The title of the group being created +- `bodyText` + - *string* - The body text of the petition +- `maxSigs` + - *number* - The maximum number of signatures allowed on the petition +- `originator` + - *string* - The name of the person who started the petition +- `isOriginator` + - *boolean* - Whether the player is the originator of the petition +- `minSigs` + - *number* - The minimum number of signatures required for the petition + +**Reference:** +- `PETITION_SHOW` - Indicates information is available. \ No newline at end of file diff --git a/wiki-information/functions/GetPhysicalScreenSize.md b/wiki-information/functions/GetPhysicalScreenSize.md new file mode 100644 index 00000000..fd40a785 --- /dev/null +++ b/wiki-information/functions/GetPhysicalScreenSize.md @@ -0,0 +1,11 @@ +## Title: GetPhysicalScreenSize + +**Content:** +Returns physical screen size of the game. +`width, height = GetPhysicalScreenSize()` + +**Returns:** +- `width` + - *number* - game physical screen width. +- `height` + - *number* - game physical screen height. \ No newline at end of file diff --git a/wiki-information/functions/GetPlayerFacing.md b/wiki-information/functions/GetPlayerFacing.md new file mode 100644 index 00000000..9713c047 --- /dev/null +++ b/wiki-information/functions/GetPlayerFacing.md @@ -0,0 +1,12 @@ +## Title: GetPlayerFacing + +**Content:** +Returns the direction the character is facing in radians. +`facing = GetPlayerFacing()` + +**Returns:** +- `facing` + - *number* - Direction the player is facing in radians, in the range, where 0 is North and values increase counterclockwise. + +**Description:** +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. \ No newline at end of file diff --git a/wiki-information/functions/GetPlayerInfoByGUID.md b/wiki-information/functions/GetPlayerInfoByGUID.md new file mode 100644 index 00000000..7e849abe --- /dev/null +++ b/wiki-information/functions/GetPlayerInfoByGUID.md @@ -0,0 +1,36 @@ +## Title: GetPlayerInfoByGUID + +**Content:** +Returns character info for another player from their GUID. +`localizedClass, englishClass, localizedRace, englishRace, sex, name, realm = GetPlayerInfoByGUID(guid)` + +**Parameters:** +- `guid` + - *string* - The GUID of the player you're querying. + +**Returns:** +- `localizedClass` + - *string* - Localized class name. +- `englishClass` + - *string* - Localization-independent class name. +- `localizedRace` + - *string* - Localized race name. +- `englishRace` + - *string* - Localization-independent race name. +- `sex` + - *number* - Gender ID of the character. 2 for male, or 3 for female. +- `name` + - *string* - The name of the character. +- `realm` + - *string* - Normalized realm name of the character. Returns an empty string if the character is from the same realm as the player. + +**Usage:** +When used on yourself. +```lua +/dump UnitGUID("target"), GetPlayerInfoByGUID(UnitGUID("target")) +> "Player-1096-06DF65C1", "Priest", "PRIEST", "Human", "Human", 3, "Xiaohuli", "" +``` +When used on a player from another realm, in this case from the same connected realm. +```lua +> "Player-1096-0971D0BE", "Monk", "MONK", "Night Elf", "NightElf", 2, "Coldbits", "DarkmoonFaire" +``` \ No newline at end of file diff --git a/wiki-information/functions/GetPossessInfo.md b/wiki-information/functions/GetPossessInfo.md new file mode 100644 index 00000000..f236b2da --- /dev/null +++ b/wiki-information/functions/GetPossessInfo.md @@ -0,0 +1,24 @@ +## Title: GetPossessInfo + +**Content:** +Returns info for an action on the possession bar. +`texture, spellID, enabled = GetPossessInfo(index)` + +**Parameters:** +- `index` + - *number* - The slot of the possess bar to check, ascending from 1. + +**Returns:** +- `texture` + - *string* - The icon texture used for this slot, nil if the slot is empty +- `spellID` + - *number* - The name of the action in this slot, nil if the slot is empty. +- `enabled` + - *boolean* - true if there is an action in this slot, nil otherwise. + +**Description:** +The possession bar is shown by the default UI (like a stance bar) while the player is controlling another target, such as while channeling. +Typically, the first slot contains the spell used to control the other unit (which does nothing), while the second slot has a "Cancel" action that ends the effect. + +**Reference:** +- `IsPossessBarVisible` \ No newline at end of file diff --git a/wiki-information/functions/GetPreviousAchievement.md b/wiki-information/functions/GetPreviousAchievement.md new file mode 100644 index 00000000..8861c617 --- /dev/null +++ b/wiki-information/functions/GetPreviousAchievement.md @@ -0,0 +1,13 @@ +## Title: GetPreviousAchievement + +**Content:** +Returns the previous achievement in a chain. +`previousAchievementID = GetPreviousAchievement(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - The ID of the Achievement + +**Returns:** +- `previousAchievementID` + - *number or nil* - The ID of the previous Achievement in chain. \ No newline at end of file diff --git a/wiki-information/functions/GetProfessionInfo.md b/wiki-information/functions/GetProfessionInfo.md new file mode 100644 index 00000000..61580d37 --- /dev/null +++ b/wiki-information/functions/GetProfessionInfo.md @@ -0,0 +1,34 @@ +## Title: GetProfessionInfo + +**Content:** +Gets details on a profession from its index including name, icon, and skill level. +`name, icon, skillLevel, maxSkillLevel, numAbilities, spelloffset, skillLine, skillModifier, specializationIndex, specializationOffset = GetProfessionInfo(index)` + +**Parameters:** +- `index` + - *number* - The skillLineIDs from GetProfessions + +**Returns:** +- `name` + - *string* - The localized skill name +- `icon` + - *string* - the location of the icon image +- `skillLevel` + - *number* - the current skill level +- `maxSkillLevel` + - *number* - the current skill cap (75 for apprentice, 150 for journeyman etc.) +- `numAbilities` + - *number* - The number of abilities/icons listed. These are the icons you put on your action bars. +- `spelloffset` + - *number* - The offset id of the first Spell of this profession. (you can `CastSpell(spelloffset + 1, "Spell")` to use the first spell of this profession) +- `skillLine` + - *number* - Reference to the profession. +- `skillModifier` + - *number* - Additional modifiers to your profession levels. IE: Lures for Fishing. +- `specializationIndex` + - *number* - A value indicating which specialization is known (ie. Transmute specialist for Alchemist) +- `specializationOffset` + - *number* - Haven't figured this one out yet + +**Description:** +This also seems to return some kind of data on the talent trees and guild perks. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestBackgroundMaterial.md b/wiki-information/functions/GetQuestBackgroundMaterial.md new file mode 100644 index 00000000..5770463b --- /dev/null +++ b/wiki-information/functions/GetQuestBackgroundMaterial.md @@ -0,0 +1,12 @@ +## Title: GetQuestBackgroundMaterial + +**Content:** +Returns the background texture for the displayed quest. +`material = GetQuestBackgroundMaterial()` + +**Returns:** +- `material` + - *string?* - The material string for this quest, or nil if the default, "Parchment", is to be used. + +**Description:** +This texture is used to paint the background of the Blizzard Quest Frame. It does not appear in the Quest Log, but only when initially reading, accepting, or handing in the quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestCurrencyInfo.md b/wiki-information/functions/GetQuestCurrencyInfo.md new file mode 100644 index 00000000..cc7deea3 --- /dev/null +++ b/wiki-information/functions/GetQuestCurrencyInfo.md @@ -0,0 +1,48 @@ +## Title: GetQuestCurrencyInfo + +**Content:** +Returns information about a currency token rewarded from the quest currently being viewed in the quest info frame. +`name, texture, numItems, quality = GetQuestCurrencyInfo(itemType, index)` + +**Parameters:** +- `itemType` + - *string* - The category of the currency to query. Currently "reward" is the only category in use for currencies. +- `index` + - *number* - The index of the currency to query, in the range. + +**Returns:** +- `name` + - *string* - The localized name of the currency. +- `texture` + - *string* - The path to the icon texture used for the currency. +- `numItems` + - *number* - The amount of the currency that will be rewarded. +- `quality` + - *number* - Indicates the rarity of the currency. + +**Description:** +This function does not work for quests being viewed from the player's quest log. Use `GetQuestLogRewardCurrencyInfo` instead. Check `QuestInfoFrame.questLog` to determine whether the quest info frame is currently displaying a quest log quest or not. + +**Usage:** +Print a list of currencies rewarded by the currently viewed quest to the chat frame: +```lua +local numRewardCurrencies = GetNumRewardCurrencies() +if numRewardCurrencies > 0 then + print("This quest rewards", numRewardCurrencies, "currencies:") + for i = 1, numRewardCurrencies do + local name, texture, numItems + if QuestInfoFrame.questLog then + name, texture, numItems = GetQuestLogRewardCurrencyInfo(i) + else + name, texture, numItems = GetQuestCurrencyInfo("reward", i) + end + print(format("|T%s:0|t %dx %s", texture, numItems, name)) + end +else + print("This quest does not reward any currencies.") +end +``` + +**Reference:** +- `GetNumRewardCurrencies` +- `GetQuestLogRewardCurrencyInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestFactionGroup.md b/wiki-information/functions/GetQuestFactionGroup.md new file mode 100644 index 00000000..eac620ed --- /dev/null +++ b/wiki-information/functions/GetQuestFactionGroup.md @@ -0,0 +1,20 @@ +## Title: GetQuestFactionGroup + +**Content:** +`factionGroup = GetQuestFactionGroup(questID)` + +**Parameters:** +- `questID` + - *number* - Unique QuestID. + +**Returns:** +- `factionGroup` + - *number* + - **Key** | **Value** | **Description** + - --- | --- | --- + - 0 | Neutral | LE_QUEST_FACTION_ALLIANCE + - 1 | Alliance | LE_QUEST_FACTION_HORDE + - 2 | Horde | + +**Reference:** +QuestMapFrame.lua, patch 6.0.2 \ No newline at end of file diff --git a/wiki-information/functions/GetQuestGreenRange.md b/wiki-information/functions/GetQuestGreenRange.md new file mode 100644 index 00000000..7e36bb4b --- /dev/null +++ b/wiki-information/functions/GetQuestGreenRange.md @@ -0,0 +1,13 @@ +## Title: GetQuestGreenRange + +**Content:** +Return for how many levels below you quests and mobs remain "green" (i.e. yield XP) +`range = GetQuestGreenRange()` + +**Returns:** +- `range` + - *number* - an integer value, currently up to 12 (at level 60) + +**Usage:** +- At level 9, `GetQuestGreenRange()` returns 5 +- At level 50, `GetQuestGreenRange()` returns 10 \ No newline at end of file diff --git a/wiki-information/functions/GetQuestID.md b/wiki-information/functions/GetQuestID.md new file mode 100644 index 00000000..3917dd92 --- /dev/null +++ b/wiki-information/functions/GetQuestID.md @@ -0,0 +1,16 @@ +## Title: GetQuestID + +**Content:** +Returns the ID of the displayed quest at a quest giver. +`questID = GetQuestID()` + +**Returns:** +- `questID` + - *number* - quest ID of the offered/discussed quest. + +**Description:** +Only returns proper (non-zero) values: +- after `QUEST_DETAIL` for offered quests and `QUEST_PROGRESS` / `QUEST_COMPLETE` for accepted quests. +- before `QUEST_FINISHED`. + +This function is not related to your quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestIndexForTimer.md b/wiki-information/functions/GetQuestIndexForTimer.md new file mode 100644 index 00000000..98c04770 --- /dev/null +++ b/wiki-information/functions/GetQuestIndexForTimer.md @@ -0,0 +1,13 @@ +## Title: GetQuestIndexForTimer + +**Content:** +Gets the quest log index of a quest being timed. +`questIndex = GetQuestIndexForTimer(timerId)` + +**Parameters:** +- `timerId` + - *number* - The ID of a quest timer. + +**Returns:** +- `questIndex` + - *number* - The quest log's index of the timed quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestIndexForWatch.md b/wiki-information/functions/GetQuestIndexForWatch.md new file mode 100644 index 00000000..fee73980 --- /dev/null +++ b/wiki-information/functions/GetQuestIndexForWatch.md @@ -0,0 +1,16 @@ +## Title: GetQuestIndexForWatch + +**Content:** +Gets the quest log index of a watched quest. +`questIndex = GetQuestIndexForWatch(watchIndex)` + +**Parameters:** +- `watchIndex` + - *number* - The index of a quest watch; an integer between 1 and `GetNumQuestWatches()`. + +**Returns:** +- `questIndex` + - *number* - The quest log's index of the watched quest. + +**Notes and Caveats:** +This function can return nil for valid `watchIndex` values if the watched quest isn't yet in the client cache. This can happen when logging in after clearing the cache. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestItemInfo.md b/wiki-information/functions/GetQuestItemInfo.md new file mode 100644 index 00000000..0f937e87 --- /dev/null +++ b/wiki-information/functions/GetQuestItemInfo.md @@ -0,0 +1,45 @@ +## Title: GetQuestItemInfo + +**Content:** +Returns info for a required/reward/choice quest item. +`name, texture, count, quality, isUsable, itemID = GetQuestItemInfo(type, index)` + +**Parameters:** +- `type` + - *string* - type of the item to query. One of the following values: + - `"required"`: Items the quest requires the player to gather. + - `"reward"`: Unconditional quest rewards. + - `"choice"`: One of the possible quest rewards. +- `index` + - *number* - index of the item of the specified type to return information about, ascending from 1. + +**Returns:** +- `name` + - *string* - The item's name. +- `texture` + - *number : FileID* - The item's icon texture. +- `count` + - *number* - Amount of the item required or awarded by the quest. +- `quality` + - *Enum.ItemQuality* - The item's quality. +- `isUsable` + - *boolean* - True if the quest item is usable by the current player. +- `itemID` + - *number* - The item's ID. + +**Description:** +This function returns information about the current quest: the one for which the QUEST_* family of events has fired most recently. Quests in the quest log use `GetQuestLogRewardInfo` and `GetQuestLogChoiceInfo`. + +**Reference:** +- `GetNumQuestChoices` +- `GetNumQuestRewards` + +**Example Usage:** +```lua +local name, texture, count, quality, isUsable, itemID = GetQuestItemInfo("reward", 1) +print("Reward Item Name: ", name) +``` + +**Addons Using This Function:** +- **Questie**: Uses `GetQuestItemInfo` to display detailed information about quest rewards and required items in the quest tracker and tooltips. +- **AllTheThings**: Utilizes this function to gather data on quest items for collection tracking and completionist purposes. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestItemLink.md b/wiki-information/functions/GetQuestItemLink.md new file mode 100644 index 00000000..966b15f0 --- /dev/null +++ b/wiki-information/functions/GetQuestItemLink.md @@ -0,0 +1,29 @@ +## Title: GetQuestItemLink + +**Content:** +Returns the item link for a required/reward/choice quest item. +`itemLink = GetQuestItemLink(type, index)` + +**Parameters:** +- `(String "type", Integer index)` + - `type` + - *string* - "required", "reward" or "choice" + - `index` + - *number* - Quest reward item index. + +**Returns:** +- `itemLink` + - *string* - The link to the quest item specified. + +**Usage:** +```lua +local link = GetQuestItemLink("choice", 1); +local link = GetQuestItemLink("choice", 1); +``` + +**Miscellaneous:** +Result: +``` +|cff9d9d9d|Hitem:7073:0:0:0:0:0:0:0|h|h|r +``` +Last updated: Patch 1.6.1 \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLink.md b/wiki-information/functions/GetQuestLink.md new file mode 100644 index 00000000..f487cc87 --- /dev/null +++ b/wiki-information/functions/GetQuestLink.md @@ -0,0 +1,14 @@ +## Title: GetQuestLink + +**Content:** +Returns a QuestLink for a quest. +`questLink = GetQuestLink(questID)` + +**Parameters:** +- `questID` + - *number* - Unique identifier for a quest. + +**Returns:** +- `QuestLink` + - *string* - The link to the quest specified + - or `nil`, if the QuestID is invalid. `nil` is also returned if the specified QuestID is not currently in the player's quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogGroupNum.md b/wiki-information/functions/GetQuestLogGroupNum.md new file mode 100644 index 00000000..4cd52c6e --- /dev/null +++ b/wiki-information/functions/GetQuestLogGroupNum.md @@ -0,0 +1,9 @@ +## Title: GetQuestLogGroupNum + +**Content:** +Returns the suggested number of players for a quest. +`suggestedGroup = GetQuestLogGroupNum(questID)` + +**Returns:** +- `suggestedGroup` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogIndexByID.md b/wiki-information/functions/GetQuestLogIndexByID.md new file mode 100644 index 00000000..a5009093 --- /dev/null +++ b/wiki-information/functions/GetQuestLogIndexByID.md @@ -0,0 +1,21 @@ +## Title: GetQuestLogIndexByID + +**Content:** +Returns the current quest log index of a quest by its ID. +`questLogIndex = GetQuestLogIndexByID(questID)` + +**Parameters:** +- `questID` + - *number* - Unique identifier for each quest. Used as each quest's URL on database sites such as Wowhead. + +**Returns:** +- `questLogIndex` + - *number* - The index of the queried quest in the quest log. Returns "0" if a quest with this questID does not exist in the quest log. + +**Usage:** +This snippet gets the QuestID of the most recently displayed quest in a Gossip frame, then gets the index. Now that we have the index of the quest, we can utilize many of the functions that require a quest index. For example, `GetQuestLink()` requires a quest index. +```lua +local qID = GetQuestID(); +local qLink = GetQuestLink(GetQuestLogIndexByID(qID)); +print("Here's a link to the quest I'm currently viewing at a quest-giver: " .. qLink); +``` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogItemLink.md b/wiki-information/functions/GetQuestLogItemLink.md new file mode 100644 index 00000000..563fa73f --- /dev/null +++ b/wiki-information/functions/GetQuestLogItemLink.md @@ -0,0 +1,23 @@ +## Title: GetQuestLogItemLink + +**Content:** +Returns item link for selected quest reward/choice/required item from quest log. +`itemLink = GetQuestLogItemLink(type, index)` + +**Parameters:** +- `type` + - *string* - "required", "reward" or "choice" +- `index` + - *table* - Integer - Quest reward item index (starts with 1). + +**Returns:** +- `itemLink` + - *string* - The link to the quest item specified + - or `nil`, if the type and/or index is invalid, there is no active quest at the moment or if the server did not transmit the item information until the timeout (which can happen, if the item is not in the local item cache yet) + +**Description:** +The active quest is being set when browsing the quest log. The quest log must not be open for this function to work, but a quest must be active. +The different types refer to the different item lists, a quest can contain. +- "reward" is the list of items which will be granted upon finishing the quest. +- "choice" is the list of items the player can choose from, once the quest is finished. +- "required" should be the list of items which have to be handed in for the quest to be finished (this has not been verified). \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogLeaderBoard.md b/wiki-information/functions/GetQuestLogLeaderBoard.md new file mode 100644 index 00000000..931dbdbf --- /dev/null +++ b/wiki-information/functions/GetQuestLogLeaderBoard.md @@ -0,0 +1,39 @@ +## Title: GetQuestLogLeaderBoard + +**Content:** +Returns info for a quest objective in the quest log. +`description, objectiveType, isCompleted = GetQuestLogLeaderBoard(i, questIndex)` + +**Parameters:** +- `i` + - *number* - Index of the quest objective to query, ascending from 1 to GetNumQuestLeaderBoards(questIndex). +- `questIndex` + - *Optional Number* - Index of the quest log entry to query, ascending from 1 to GetNumQuestLogEntries. If not provided or invalid, defaults to the currently selected quest (via SelectQuestLogEntry). + +**Returns:** +- `description` + - *string* - Text description of the objective, e.g. "0/3 Monsters slain" +- `objectiveType` + - *string* - A token describing objective type, one of "item", "object", "monster", "reputation", "log", "event", "player", or "progressbar". +- `isCompleted` + - *boolean* - true if sub-objective is completed, false otherwise + +**Usage:** +The following function attempts to parse the description message to figure out exact progress towards the objective: +```lua +function GetLeaderBoardDetails(boardIndex, questIndex) + local description, objectiveType, isCompleted = GetQuestLogLeaderBoard(boardIndex, questIndex) + local itemName, numItems, numNeeded = description:match("(.*):%s*(%d+)%s*/%s*(%d+)") + return objectiveType, itemName, numItems, numNeeded, isCompleted +end +-- returns eg. "monster", "Young Nightsaber slain", 1, 7, nil +``` + +**Description:** +- The type "player" was added in WotLK, which is used by No Mercy! and probably other quests. +- The type "log" was added sometime around patch 3.3.0, and seems to have replaced many instances of "event". +- Only ever found one quest, The Thandol Span that had an "object" objective. +- The description return value can be incomplete under some circumstances, with localized item or NPC names missing from the text. + +**Reference:** +- `GetQuestObjectiveInfo` - A function with identical returns, but takes a QuestID argument instead of QuestLogIndex. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogPushable.md b/wiki-information/functions/GetQuestLogPushable.md new file mode 100644 index 00000000..da50c3a7 --- /dev/null +++ b/wiki-information/functions/GetQuestLogPushable.md @@ -0,0 +1,32 @@ +## Title: GetQuestLogPushable + +**Content:** +Returns true if the currently loaded quest in the quest window is able to be shared with other players. +`isPushable = GetQuestLogPushable()` + +**Returns:** +- `isPushable` + - *boolean* - 1 if the quest can be shared, nil otherwise. + +**Usage:** +```lua +-- Determine whether the selected quest is pushable or not +if ( GetQuestLogPushable() and GetNumPartyMembers() > 0 ) then + QuestFramePushQuestButton:Enable(); +else + QuestFramePushQuestButton:Disable(); +end +``` + +**Miscellaneous:** +Result: +QuestFramePushQuestButton is enabled or disabled based on whether the currently active quest is sharable (and you being in a party!). + +**Description:** +Use `SelectQuestLogEntry(questID)` to set the currently active quest before calling `GetQuestLogPushable()`. To initiate pushing (sharing) of a quest, use `QuestLogPushQuest()`. + +**Example Use Case:** +This function can be used in an addon that manages quest sharing within a party. For instance, an addon could automatically enable or disable the quest sharing button based on whether the selected quest is shareable and if the player is in a party. + +**Addons Using This Function:** +Many quest management addons, such as Questie, use this function to determine if a quest can be shared with party members. This helps in automating the process of sharing quests, ensuring that all party members are on the same page. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogQuestText.md b/wiki-information/functions/GetQuestLogQuestText.md new file mode 100644 index 00000000..aff4ddc7 --- /dev/null +++ b/wiki-information/functions/GetQuestLogQuestText.md @@ -0,0 +1,15 @@ +## Title: GetQuestLogQuestText + +**Content:** +Returns the description and objective text in the quest log. +`questDescription, questObjectives = GetQuestLogQuestText()` + +**Parameters:** +- `questLogIndex` + - *number?* - (Optional) The index of the quest in the quest log. + +**Returns:** +- `questDescription` + - *string* - The quest description +- `questObjectives` + - *string* - The quest objective \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRequiredMoney.md b/wiki-information/functions/GetQuestLogRequiredMoney.md new file mode 100644 index 00000000..e7b6ca3d --- /dev/null +++ b/wiki-information/functions/GetQuestLogRequiredMoney.md @@ -0,0 +1,19 @@ +## Title: C_QuestLog.GetRequiredMoney + +**Content:** +Returns the amount of money required for quest completion. +`requiredMoney = C_QuestLog.GetRequiredMoney()` + +**Parameters:** +- `questID` + - *number?* - Uses the selected quest if no questID is provided. + +**Returns:** +- `requiredMoney` + - *number* + +**Example Usage:** +This function can be used to determine if a player has enough money to complete a quest that requires a monetary payment. For instance, if a quest requires a donation or a fee to proceed, you can use this function to check the required amount and compare it with the player's current money. + +**Addon Usage:** +Large addons like Questie or WoW-Pro Guides might use this function to display additional information about quests, such as the required money for completion, directly in the quest log or quest tracker interface. This helps players manage their quests more effectively by providing all necessary information at a glance. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardCurrencyInfo.md b/wiki-information/functions/GetQuestLogRewardCurrencyInfo.md new file mode 100644 index 00000000..df6e7688 --- /dev/null +++ b/wiki-information/functions/GetQuestLogRewardCurrencyInfo.md @@ -0,0 +1,53 @@ +## Title: GetQuestLogRewardCurrencyInfo + +**Content:** +Provides information about a currency reward for the quest currently being viewed in the quest log, or of the provided questId. +`name, texture, numItems, currencyId, quality = GetQuestLogRewardCurrencyInfo(index)` + +**Parameters:** +- `index` + - *number* - The index of the currency to query, in the range of +- `questId` + - *number* - The id of a quest + +**Returns:** +- `name` + - *string* - The localized name of the currency +- `texture` + - *string* - The path to the icon texture used for the currency +- `numItems` + - *number* - The amount of the currency that will be rewarded +- `currencyId` + - *number* - The id of the currency +- `quality` + - *number* - The quality of the currency + +**Description:** +When no questId is provided, this function only works for the quest currently viewed in the quest log. +When a questId is provided, the function will provide information only if the quest reward data is loaded (QUEST_LOG_UPDATE). +For quests being viewed from NPCs, use `GetQuestCurrencyInfo` instead. Check `QuestInfoFrame.questLog` to determine whether the quest info frame is currently displaying a quest log quest or not. + +**Usage:** +Print a list of currencies rewarded by the currently viewed quest to the chat frame: +```lua +local numRewardCurrencies = GetNumRewardCurrencies() +if numRewardCurrencies > 0 then + print("This quest rewards", numRewardCurrencies, "currencies:") + for i = 1, numRewardCurrencies do + local name, texture, numItems + if QuestInfoFrame.questLog then + name, texture, numItems = GetQuestLogRewardCurrencyInfo(i) + else + name, texture, numItems = GetQuestCurrencyInfo("reward", i) + end + print(format("|T%s:0|t %dx %s", texture, numItems, name)) + end +else + print("This quest does not reward any currencies.") +end +``` + +**Reference:** +- `GetNumQuestCurrencies` +- `GetNumRewardCurrencies` +- `GetQuestCurrencyInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardInfo.md b/wiki-information/functions/GetQuestLogRewardInfo.md new file mode 100644 index 00000000..83f765b9 --- /dev/null +++ b/wiki-information/functions/GetQuestLogRewardInfo.md @@ -0,0 +1,31 @@ +## Title: GetQuestLogRewardInfo + +**Content:** +Returns info for an unconditional quest reward item in the quest log. +`itemName, itemTexture, numItems, quality, isUsable, itemID, itemLevel = GetQuestLogRewardInfo(itemIndex)` + +**Parameters:** +- `itemIndex` + - *number* - Index of the item reward to query, up to GetNumQuestLogRewards +- `questID` + - *number?* - Unique identifier for a quest. + +**Returns:** +- `itemName` + - *string* - The name of the quest item +- `itemTexture` + - *string* - The texture of the quest item +- `numItems` + - *number* - How many of the quest item +- `quality` + - *number* - Quality of the quest item +- `isUsable` + - *boolean* - If the quest item is usable by the current player +- `itemID` + - *number* - Unique identifier for the item +- `itemLevel` + - *number* - Scaled item level of the reward, based on the character's item level + +**Description:** +This function is used for quest reward items that are rewarded unconditionally (mandatory) upon completion of a quest. For information about reward items a player can choose from, use `GetQuestLogChoiceInfo` instead. +This function appears to get info for the currently viewed quest completion dialog if called without a questID. Otherwise, it returns information about the supplied questID. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardMoney.md b/wiki-information/functions/GetQuestLogRewardMoney.md new file mode 100644 index 00000000..e3a90f7b --- /dev/null +++ b/wiki-information/functions/GetQuestLogRewardMoney.md @@ -0,0 +1,17 @@ +## Title: GetQuestLogRewardMoney + +**Content:** +Returns the amount of money rewarded for a quest. +`money = GetQuestLogRewardMoney()` + +**Parameters:** +- `QuestID` + - *number?* - Unique identifier for a quest. + +**Returns:** +- `rewardMoney` + - *number?* - The amount of copper this quest gives as a reward. + +**Description:** +The `questID` argument is optional. When called without a `questID`, it returns the reward for the most recently viewed quest in the quest log window. +Returns 0 if the `questID` is not currently in the quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardSpell.md b/wiki-information/functions/GetQuestLogRewardSpell.md new file mode 100644 index 00000000..ac2a1d2e --- /dev/null +++ b/wiki-information/functions/GetQuestLogRewardSpell.md @@ -0,0 +1,34 @@ +## Title: GetQuestLogRewardSpell + +**Content:** +Returns the spell reward for a quest. +`texture, name, isTradeskillSpell, isSpellLearned, hideSpellLearnText, isBoostSpell, garrFollowerID, genericUnlock, spellID = GetQuestLogRewardSpell(rewardIndex, questID)` + +**Parameters:** +- `rewardIndex` + - *number* - The index of the spell reward to get the details for, from 1 to GetNumRewardSpells +- `questID` + - *number* - Unique QuestID for the quest to be queried. + +**Returns:** +- `texture` + - *string* - The texture of the spell icon +- `name` + - *string* - The spell name +- `isTradeskillSpell` + - *boolean* - Whether the spell is a tradeskill spell +- `isSpellLearned` + - *boolean* - Whether the spell has been learned already +- `hideSpellLearnText` + - *unknown* +- `isBoostSpell` + - *boolean* - Unknown +- `garrFollowerID` + - *number* - If the spell grants a Garrison follower, it's ID. +- `genericUnlock` + - *unknown* +- `spellID` + - *number* - Unknown + +**Description:** +Returns information about the spell reward of the current selected quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogSpecialItemCooldown.md b/wiki-information/functions/GetQuestLogSpecialItemCooldown.md new file mode 100644 index 00000000..17989399 --- /dev/null +++ b/wiki-information/functions/GetQuestLogSpecialItemCooldown.md @@ -0,0 +1,17 @@ +## Title: GetQuestLogSpecialItemCooldown + +**Content:** +Returns cooldown information about a special quest item based on a given index. +`start, duration, enable = GetQuestLogSpecialItemCooldown(questLogIndex)` + +**Parameters:** +- `questLogIndex` + - *number* - The index of the quest to query. The number of quests can be retrieved with `GetNumQuestLogEntries()`. + +**Returns:** +- `start` + - *number* - The value of `GetTime()` when the quest item's cooldown began (or 0 if the item is off cooldown). +- `duration` + - *number* - The duration of the item's cooldown (is 0 if the item is ready). +- `enable` + - *number* - 1 if the item is enabled, otherwise 0 (needs verification). \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogSpecialItemInfo.md b/wiki-information/functions/GetQuestLogSpecialItemInfo.md new file mode 100644 index 00000000..23ff5786 --- /dev/null +++ b/wiki-information/functions/GetQuestLogSpecialItemInfo.md @@ -0,0 +1,19 @@ +## Title: GetQuestLogSpecialItemInfo + +**Content:** +Returns information about a special quest item based on a given index. +`link, item, charges, showItemWhenComplete = GetQuestLogSpecialItemInfo(questLogIndex)` + +**Parameters:** +- `questLogIndex` + - *number* - The index of the quest to query. The number of quests can be retrieved with `GetNumQuestLogEntries()`. + +**Returns:** +- `link` + - *string?* - ItemLink +- `item` + - *number* - The icon ID +- `charges` + - *number* - The number of charges, or 0 if unlimited. If the item is consumed on use this seems to be -1 (e.g., Mana Remnants) +- `showItemWhenComplete` + - *boolean* - Whether the item remains visible when complete \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogTimeLeft.md b/wiki-information/functions/GetQuestLogTimeLeft.md new file mode 100644 index 00000000..107866ac --- /dev/null +++ b/wiki-information/functions/GetQuestLogTimeLeft.md @@ -0,0 +1,9 @@ +## Title: GetQuestLogTimeLeft + +**Content:** +Returns the time left in seconds for the current quest. +`timeLeft = GetQuestLogTimeLeft()` + +**Returns:** +- `questTimer` + - *number* - The seconds remaining to finish the timed quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogTitle.md b/wiki-information/functions/GetQuestLogTitle.md new file mode 100644 index 00000000..e4befd29 --- /dev/null +++ b/wiki-information/functions/GetQuestLogTitle.md @@ -0,0 +1,61 @@ +## Title: GetQuestLogTitle + +**Content:** +Returns information about a quest in your quest log. +`title, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isBounty, isStory, isHidden, isScaling = GetQuestLogTitle(questLogIndex)` + +**Parameters:** +- `questLogIndex` + - *number* - The index of the quest you wish to get information about, between 1 and `GetNumQuestLogEntries()`'s first return value. + +**Returns:** +- `title` + - *string* - The title of the quest, or nil if the index is out of range. +- `level` + - *number* - The level of the quest. +- `suggestedGroup` + - *number* - If the quest is designed for more than one player, it is the number of players suggested to complete the quest. Otherwise, it is 0. +- `isHeader` + - *boolean* - true if the entry is a header, false otherwise. +- `isCollapsed` + - *boolean* - true if the entry is a collapsed header, false otherwise. +- `isComplete` + - *number* - 1 if the quest is completed, -1 if the quest is failed, nil otherwise. +- `frequency` + - *number* - 1 if the quest is a normal quest, `LE_QUEST_FREQUENCY_DAILY` (2) for daily quests, `LE_QUEST_FREQUENCY_WEEKLY` (3) for weekly quests. +- `questID` + - *number* - The quest identification number. This is the number found in `GetQuestsCompleted()` after it has been completed. It is also the number used to identify quests on sites such as Wowhead.com (Example: Rest and Relaxation) +- `startEvent` + - *boolean* - ? +- `displayQuestID` + - *boolean* - true if the questID is displayed before the title, false otherwise. +- `isOnMap` + - *boolean* - ? +- `hasLocalPOI` + - *boolean* - ? +- `isTask` + - *boolean* - ? +- `isBounty` + - *boolean* - ? (true for Legion World Quests; is it true for other WQs?) +- `isStory` + - *boolean* - ? +- `isHidden` + - *boolean* - true if the quest is not visible inside the player's quest log. +- `isScaling` + - *boolean* - ? + +**Usage:** +```lua +local i = 1 +while GetQuestLogTitle(i) do + local title, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isBounty, isStory, isHidden, isScaling = GetQuestLogTitle(i) + if ( not isHeader ) then + DEFAULT_CHAT_FRAME:AddMessage(title .. " " .. questID) + end + i = i + 1 +end +``` + +**Miscellaneous:** +Result: +Prints the name, level, and Quest ID of all quests in your quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestResetTime.md b/wiki-information/functions/GetQuestResetTime.md new file mode 100644 index 00000000..74ed35c3 --- /dev/null +++ b/wiki-information/functions/GetQuestResetTime.md @@ -0,0 +1,30 @@ +## Title: GetQuestResetTime + +**Content:** +Returns the number of seconds until daily quests reset. +`nextReset = GetQuestResetTime()` + +**Returns:** +- `nextReset` + - *number* - Number of seconds until the next daily quest reset. + +**Description:** +At the first UI load per login, this function returns the time since the Unix epoch instead. Appears to give the correct value as of the second `QUEST_LOG_UPDATE` event to occur after login. +In 6.x returned incorrect answers for players inside instances hosted on servers that use a different reset time (e.g., Oceanic and Brazilian players in US continental instance servers). Fixed in 7.x. + +A simple test case: +```lua +print("init", GetQuestResetTime()) +local frame = CreateFrame("Frame") +frame:RegisterEvent("PLAYER_LOGIN") +frame:RegisterEvent("QUEST_LOG_UPDATE") +frame:SetScript("OnEvent", function(self, event) + print(event, GetQuestResetTime()) +end) +``` + +**Example Use Case:** +This function can be used in addons that track daily quest progress and need to reset their data or provide notifications to the player when daily quests are about to reset. For example, an addon that helps players manage their daily quest routines could use this function to display a countdown timer until the next reset. + +**Addons Using This Function:** +Many quest tracking addons, such as "Questie" and "Daily Global Check," use this function to ensure they provide accurate information about daily quest availability and reset times. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestReward.md b/wiki-information/functions/GetQuestReward.md new file mode 100644 index 00000000..a01491e1 --- /dev/null +++ b/wiki-information/functions/GetQuestReward.md @@ -0,0 +1,12 @@ +## Title: GetQuestReward + +**Content:** +Completes the quest and chooses a quest reward, if applicable. +`GetQuestReward(itemChoice)` + +**Parameters:** +- `itemChoice` + - *number* - The quest reward chosen + +**Usage:** +`GetQuestReward(QuestFrameRewardPanel.itemChoice);` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestSortIndex.md b/wiki-information/functions/GetQuestSortIndex.md new file mode 100644 index 00000000..739ee75c --- /dev/null +++ b/wiki-information/functions/GetQuestSortIndex.md @@ -0,0 +1,17 @@ +## Title: GetQuestSortIndex + +**Content:** +Returns the index of the collapsible category the queried quest belongs to. +`sortIndex = GetQuestSortIndex(questLogIndex)` + +**Parameters:** +- `questLogIndex` + - *number* - The index of the quest to query. The number of quests can be retrieved with `GetNumQuestLogEntries()`. + +**Returns:** +- `sortIndex` + - *number* - The index of the category starting from 1. + +**Notes and Caveats:** +Quests are usually split per zone, so if for example there are quests from 5 zones present, `sortIndex` will range between 1-5. +Querying the category header itself will return the same `sortIndex` as the quests it lists. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestTagInfo.md b/wiki-information/functions/GetQuestTagInfo.md new file mode 100644 index 00000000..fdf51b07 --- /dev/null +++ b/wiki-information/functions/GetQuestTagInfo.md @@ -0,0 +1,52 @@ +## Title: GetQuestTagInfo + +**Content:** +Retrieves tag information about the quest. +`tagID, tagName, worldQuestType, rarity, isElite, tradeskillLineIndex, displayTimeLeft = GetQuestTagInfo(questID)` + +**Parameters:** +- `questID` + - *number* - The ID of the quest to retrieve the tag info for. + +**Returns:** +- `tagID` + - *number* - the tagID, nil if quest is not tagged +- `tagName` + - *string* - human readable representation of the tagID, nil if quest is not tagged +- `worldQuestType` + - *number* - type of world quest, or nil if not world quest +- `rarity` + - *number* - the rarity of the quest (used for world quests) +- `isElite` + - *boolean* - is this an elite quest? (used for world quests) +- `tradeskillLineIndex` + - *tradeskillID* if this is a profession quest (used to determine which profession icon to display for world quests) +- `displayTimeLeft` + - *?* + +**Description:** +- `tagID` +- `tagName` + - 1: Group + - 41: PvP + - 62: Raid + - 81: Dungeon + - 83: Legendary + - 85: Heroic + - 98: Scenario + - 102: Account + - 117: Leatherworking World Quest + +- `worldQuestTypes` + - `LE_QUEST_TAG_TYPE_PVP` + - `LE_QUEST_TAG_TYPE_PET_BATTLE` + - `LE_QUEST_TAG_TYPE_PROFESSION` + - `LE_QUEST_TAG_TYPE_DUNGEON` + +- `rarity` + - `LE_WORLD_QUEST_QUALITY_COMMON` + - `LE_WORLD_QUEST_QUALITY_RARE` + - `LE_WORLD_QUEST_QUALITY_EPIC` + +**Reference:** +`GetQuestLogTitle` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestTimers.md b/wiki-information/functions/GetQuestTimers.md new file mode 100644 index 00000000..c3fb4f3f --- /dev/null +++ b/wiki-information/functions/GetQuestTimers.md @@ -0,0 +1,37 @@ +## Title: GetQuestTimers + +**Content:** +Returns all of the quest timers currently in progress. +`questTimers = GetQuestTimers()` + +**Parameters:** +- None + +**Returns:** +- `questTimers` + - *Strings* - Values in seconds of all quest timers currently in progress + +**Usage:** +```lua +QuestTimerFrame_Update(GetQuestTimers()); + +function QuestTimerFrame_Update(...) + for i=1, arg.n, 1 do + SecondsToTime(arg); + end +end + +QuestTimerFrame_Update(GetQuestTimers()); + +function QuestTimerFrame_Update(...) + for i=1, arg.n, 1 do + SecondsToTime(arg); + end +end +``` + +**Miscellaneous:** +Result: +``` +"300", "240", "100" +``` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestsCompleted.md b/wiki-information/functions/GetQuestsCompleted.md new file mode 100644 index 00000000..cdfbdd1b --- /dev/null +++ b/wiki-information/functions/GetQuestsCompleted.md @@ -0,0 +1,63 @@ +## Title: GetQuestsCompleted + +**Content:** +Returns a list of quests the character has completed in its lifetime. +`questsCompleted = GetQuestsCompleted()` + +**Parameters:** +- `table` + - *table* - If supplied, fills this table with quests. Any other keys will be unchanged. + +**Returns:** +- `questsCompleted` + - *table* - The list of completed quests, keyed by quest IDs. + +**Description:** +A quest appears in the list only after it has been completed and turned in, not while it is in your log. +Completing certain quests can cause other quests (alternate versions, etc.) to appear completed also. +Some quests are invisible. These quests are not offered to players but suddenly become "completed" due to some other in-game occurrence. +Daily quests appear completed only if they have been completed that day. +Pet Battle quests are account-wide and will be returned from this API across all characters. They can be discerned with `GetQuestTagInfo()` tagID 102. + +**Usage:** +Prints completed questIds and their names (quest data gets cached from the server after the first query) +```lua +for id in pairs(GetQuestsCompleted()) do + local name = C_QuestLog.GetQuestInfo(id) + print(id, name) +end +``` +For a fresh Human Priest who only completed two starter quests: Beating Them Back! (28763) and Lions for Lambs (28771) +```lua +/dump GetQuestsCompleted() +{ + [28763] = true, -- "Beating Them Back!" -- Mage + [28763] = true, -- "Beating Them Back!" -- Paladin + [28763] = true, -- "Beating Them Back!" -- Priest + [28763] = true, -- "Beating Them Back!" -- Rogue + [28763] = true, -- "Beating Them Back!" -- Warlock + [28763] = true, -- "Beating Them Back!" -- Warrior + [28763] = true, -- "Beating Them Back!" -- Hunter + [28763] = true, -- "Beating Them Back!" -- unknown + [28763] = true, -- "Beating Them Back!" -- Monk + [28771] = true, -- "Lions for Lambs" + [28771] = true, -- "Lions for Lambs" + [28771] = true, -- "Lions for Lambs" + [28771] = true, -- "Lions for Lambs" -- Priest + [28771] = true, -- "Lions for Lambs" + [28771] = true, -- "Lions for Lambs" + [28771] = true, -- "Lions for Lambs" + [28771] = true, -- "Lions for Lambs" + [28771] = true, -- "Lions for Lambs" +} +``` + +**Reference:** +- `IsQuestFlaggedCompleted()` +- `C_QuestLog.GetQuestInfo()` + +**Example Use Case:** +This function can be used to track a player's progress through questlines, especially useful for completionist players or for addons that provide quest tracking and management features. + +**Addons Using This API:** +- **Questie:** A popular addon that provides a comprehensive quest tracking system, showing available and completed quests on the map. It uses `GetQuestsCompleted` to determine which quests the player has already completed to avoid showing redundant information. \ No newline at end of file diff --git a/wiki-information/functions/GetRFDungeonInfo.md b/wiki-information/functions/GetRFDungeonInfo.md new file mode 100644 index 00000000..5798da49 --- /dev/null +++ b/wiki-information/functions/GetRFDungeonInfo.md @@ -0,0 +1,70 @@ +## Title: GetRFDungeonInfo + +**Content:** +Returns info about a Raid Finder dungeon by index. Limited by player level and other factors, so only Raid Finder dungeons listed in the LFG tool can be looked up. +`ID, name, typeID, subtypeID, minLevel, maxLevel, recLevel, minRecLevel, maxRecLevel, expansionLevel, groupID, textureFilename, difficulty, maxPlayers, description, isHoliday, bonusRepAmount, minPlayers, isTimewalking, name2, minGearLevel, isScaling, lfgMapID = GetRFDungeonInfo(index)` + +**Parameters:** +- `index` + - *number* - index of a Raid Finder dungeon, from 1 to GetNumRFDungeons() + +**Returns:** +- `ID` + - *number* - Dungeon ID +- `name` + - *string* - The name of the dungeon/event +- `typeID` + - *number* - 1=TYPEID_DUNGEON or LFR, 2=raid instance, 4=outdoor area, 6=TYPEID_RANDOM_DUNGEON +- `subtypeID` + - *number* - 0=Unknown, 1=LFG_SUBTYPEID_DUNGEON, 2=LFG_SUBTYPEID_HEROIC, 3=LFG_SUBTYPEID_RAID, 4=LFG_SUBTYPEID_SCENARIO, 5=LFG_SUBTYPEID_FLEXRAID +- `minLevel` + - *number* - Earliest level you can enter this dungeon (using the portal, not LFD) +- `maxLevel` + - *number* - Highest level you can enter this dungeon (using the portal, not LFD) +- `recLevel` + - *number* - Recommended level to queue up for this dungeon +- `minRecLevel` + - *number* - Earliest level you can queue up for the dungeon +- `maxRecLevel` + - *number* - Highest level you can queue up for the dungeon +- `expansionLevel` + - *number* - Referring to GetAccountExpansionLevel() values +- `groupID` + - *number* - Unknown +- `textureFilename` + - *string* - For example "Interface\\LFDFRAME\\LFGIcon-%s.blp" where %s is the textureFilename value +- `difficulty` + - *number* - 0 for Normal and 1 for Heroic +- `maxPlayers` + - *number* - Maximum players allowed +- `description` + - *string* - Usually empty for most dungeons but events contain descriptions of the event, like Love is in the Air daily or Brewfest, e.g. (string) +- `isHoliday` + - *boolean* - If true then this is a holiday event +- `bonusRepAmount` + - *number* - Unknown +- `minPlayers` + - *number* - Minimum number of players (before the group disbands?); usually nil +- `isTimeWalking` + - *boolean* - If true then it's Timewalking Dungeon +- `name2` + - *string* - Returns the name of the raid +- `minGearLevel` + - *number* - The minimum average item level to queue for this dungeon; may be 0 if item level is ignored. +- `isScaling` + - *boolean* +- `lfgMapID` + - *number* - InstanceID + +**Usage:** +- `/dump GetRFDungeonInfo(1)` + - `=> 417, "Fall of Deathwing", 1, 3, 85, 85, 85, 85, 85, 3, 0, "FALLOFDEATHWING", 1, 25, "Deathwing must be destroyed, or all is lost.", false, 0, nil, false, "Dragon Soul", 0, false, 967` +- `/dump GetRFDungeonInfo(2)` + - `=> 416, "The Siege of Wyrmrest Temple", 1, 3, 85, 85, 85, 85, 85, 3, 0, "SIEGEOFWYRMRESTTEMPLE", 1, 25, "Deathwing seeks to destroy Wyrmrest Temple and end the lives of the Dragon Aspects and Thrall.", false, 0, nil, false, "Dragon Soul", 0, false, 967` + +**Reference:** +- `GetNumRFDungeons` - Counts of the number of Raid Finder dungeons the player can query with this function +- `GetSavedInstanceInfo` - A similar function to this, except for the player's saved dungeon/raid lockout data (does not include Raid Finder) +- `GetSavedWorldBossInfo` - A similar function to this, except for the player's saved world boss lockout data +- `GetLFGDungeonInfo` - Almost completely identical; this function uses dungeon IDs instead of Raid Finder indexes +- `GetLFGDungeonEncounterInfo` - A more specific function; this lets you check up on the individual encounters within a given LFG Dungeon \ No newline at end of file diff --git a/wiki-information/functions/GetRaidDifficultyID.md b/wiki-information/functions/GetRaidDifficultyID.md new file mode 100644 index 00000000..b17871d3 --- /dev/null +++ b/wiki-information/functions/GetRaidDifficultyID.md @@ -0,0 +1,16 @@ +## Title: GetRaidDifficultyID + +**Content:** +Returns the player's currently selected raid difficulty. +`difficultyID = GetRaidDifficultyID()` + +**Returns:** +- `difficultyID` + - *number* - The player's (or group leader's) current raid difficulty ID preference. See `GetDifficultyInfo` for a list of possible difficultyIDs. + +**Description:** +You may use `GetDifficultyInfo` to retrieve information about the returned ID value. + +**Reference:** +- `SetRaidDifficultyID` +- `GetDungeonDifficultyID` \ No newline at end of file diff --git a/wiki-information/functions/GetRaidRosterInfo.md b/wiki-information/functions/GetRaidRosterInfo.md new file mode 100644 index 00000000..0eaefcda --- /dev/null +++ b/wiki-information/functions/GetRaidRosterInfo.md @@ -0,0 +1,40 @@ +## Title: GetRaidRosterInfo + +**Content:** +Returns info for a member of your raid. +`name, rank, subgroup, level, class, fileName, zone, online, isDead, role, isML, combatRole = GetRaidRosterInfo(raidIndex)` + +**Parameters:** +- `raidIndex` + - *number* - The index of a raid member between 1 and MAX_RAID_MEMBERS (40). It's discouraged to use GetNumGroupMembers() since there can be "holes" between raid1 to raid40. + +**Returns:** +- `name` + - *string* - raid member's name. Returns "Name-Server" for cross-realm players. +- `rank` + - *number* - Returns 2 if the raid member is the leader of the raid, 1 if the raid member is promoted to assistant, and 0 otherwise. +- `subgroup` + - *number* - The raid party this character is currently a member of. Raid subgroups are numbered as on the standard raid window. +- `level` + - *number* - The level of the character. If this character is offline, the level will show as 0 (not nil). +- `class` + - *string* - The character's class (localized), with the first letter capitalized (e.g. "Priest"). This function works as normal for offline characters. +- `fileName` + - *string* - The system representation of the character's class; always in English, always fully capitalized. +- `zone` + - *string?* - The name of the zone this character is currently in. This is the value returned by GetRealZoneText. It is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline". +- `online` + - *boolean* - Returns 1 if raid member is online, nil otherwise. +- `isDead` + - *boolean* - Returns 1 if raid member is dead (hunters Feigning Death are considered alive), nil otherwise. +- `role` + - *string* - The player's role within the raid ("maintank" or "mainassist"). +- `isML` + - *boolean* - Returns 1 if the raid member is master looter, nil otherwise. +- `combatRole` + - *string* - Returns the combat role of the player if one is selected, i.e. "DAMAGER", "TANK" or "HEALER". Returns "NONE" otherwise. + +**Description:** +Do not make any assumptions about raidid (raid1, raid2, etc) to name mappings remaining the same or not. When the raid changes, people MAY retain it or not, depending on raid size and WoW patch. Yes, this behavior has changed with patches in the past and may do it again. +`zone` can return nil for oneself (unitId == "player") if one has not changed locations since last reloading the UI. After changing locations, this returns. Use `PlayerLocation:CreateFromUnit("player")` as a workaround. +When an out of bounds index is used (more than the players in a raid, or beyond MAX_RAID_MEMBERS), some non-nil return values are possible: =0, =1, =1, =false, ="NONE". \ No newline at end of file diff --git a/wiki-information/functions/GetRaidTargetIndex.md b/wiki-information/functions/GetRaidTargetIndex.md new file mode 100644 index 00000000..0080f79b --- /dev/null +++ b/wiki-information/functions/GetRaidTargetIndex.md @@ -0,0 +1,42 @@ +## Title: GetRaidTargetIndex + +**Content:** +Returns the raid target of a unit. +`index = GetRaidTargetIndex(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `index` + - *number?* + - **Value** - **Icon** + - 1 - Yellow 4-point Star + - 2 - Orange Circle + - 3 - Purple Diamond + - 4 - Green Triangle + - 5 - White Crescent Moon + - 6 - Blue Square + - 7 - Red "X" Cross + - 8 - White Skull + +**Description:** +Raid target icons are typically displayed by unit frames, as well as above the marked entities in the 3D world. The targets can be assigned by raid leaders and assistants, party members, and the player while soloing, and are only visible to other players within the same group. +This function can return arbitrary values if the queried unit does not exist. Use `UnitExists()` to check whether a unit is valid. +For example: `"raid2target"` when `"raid2"` is offline and not targeting anything at all misbehaves. + +**Related API:** +- `SetRaidTarget` + +**Related Events:** +- `RAID_TARGET_UPDATE` + +**Usage:** +Prints the raid target index for your target. +```lua +/dump GetRaidTargetIndex("target") +``` + +**Reference:** +- `RaidFlag` \ No newline at end of file diff --git a/wiki-information/functions/GetRangedCritChance.md b/wiki-information/functions/GetRangedCritChance.md new file mode 100644 index 00000000..a0ad6e8e --- /dev/null +++ b/wiki-information/functions/GetRangedCritChance.md @@ -0,0 +1,12 @@ +## Title: GetRangedCritChance + +**Content:** +Returns the ranged critical hit chance. +`critChance = GetRangedCritChance()` + +**Returns:** +- `critChance` + - *number* - The player's ranged critical hit chance, as a percentage; e.g. 5.3783211 corresponding to a ~5.38% crit chance. + +**Description:** +If you are displaying this figure in a UI element and want it to update, hook to the `UNIT_INVENTORY_CHANGED` and `SPELLS_CHANGED` events as well as any other that affect equipment and buffs. \ No newline at end of file diff --git a/wiki-information/functions/GetRangedHaste.md b/wiki-information/functions/GetRangedHaste.md new file mode 100644 index 00000000..fff5329b --- /dev/null +++ b/wiki-information/functions/GetRangedHaste.md @@ -0,0 +1,16 @@ +## Title: GetRangedHaste + +**Content:** +Returns the player's ranged haste amount granted through buffs. +`haste = GetRangedHaste()` + +**Returns:** +- `haste` + - *number* - The player's ranged haste amount granted through buffs, as a percentage; e.g. 36.36363 corresponding to a ~36.36% increased attack speed. + +**Description:** +Reports only the ranged haste granted from buffs, such as and Quick Shots (from ) but excluding a hunter's quiver. + +**Related API:** +- `GetCombatRating(CR_HASTE_RANGED)` +- `GetCombatRatingBonus(CR_HASTE_RANGED)` \ No newline at end of file diff --git a/wiki-information/functions/GetRealZoneText.md b/wiki-information/functions/GetRealZoneText.md new file mode 100644 index 00000000..4223f3a3 --- /dev/null +++ b/wiki-information/functions/GetRealZoneText.md @@ -0,0 +1,29 @@ +## Title: GetRealZoneText + +**Content:** +Returns the map instance name. +`zone = GetRealZoneText()` + +**Parameters:** +- `instanceID` + - *number?* : InstanceID - When omitted, returns current instanceID name. + +**Returns:** +- `zone` + - *string* - The name of the map instance. + +**Description:** +Returns the name of the map instance which can be different from `GetZoneText()`. +The returned zone name is localized to the game client's language. + +**Usage:** +Returns the current zone. +```lua +/dump GetRealZoneText() +> "Stormwind City" +``` +Returns the name of a specific instanceID. +```lua +/dump GetRealZoneText(451) +> "Development Land" +``` \ No newline at end of file diff --git a/wiki-information/functions/GetRealmID.md b/wiki-information/functions/GetRealmID.md new file mode 100644 index 00000000..017052d5 --- /dev/null +++ b/wiki-information/functions/GetRealmID.md @@ -0,0 +1,15 @@ +## Title: GetRealmID + +**Content:** +Needs summary. +`realmID = GetRealmID()` + +**Returns:** +- `realmID` + - *number* + +**Usage:** +`/dump GetRealmID(), GetRealmName() -- 635, "Defias Brotherhood"` + +**Reference:** +LibRealmInfo \ No newline at end of file diff --git a/wiki-information/functions/GetRealmName.md b/wiki-information/functions/GetRealmName.md new file mode 100644 index 00000000..d9098634 --- /dev/null +++ b/wiki-information/functions/GetRealmName.md @@ -0,0 +1,37 @@ +## Title: GetRealmName + +**Content:** +Returns the realm name. +```lua +realm = GetRealmName() +normalizedRealm = GetNormalizedRealmName() +``` + +**Returns:** +- `realm` + - *string* - The name of the realm. +- `normalizedRealm` + - *string?* - The name of the realm without spaces or hyphens. + +**Description:** +- **Related API:** + - `GetRealmID` +- The normalized realm name is used for addressing whispers and in-game mail. +- When logging in, `GetNormalizedRealmName()` only returns information starting from as early as the `PLAYER_LOGIN` event. +- When transitioning through a loading screen, `GetNormalizedRealmName()` may return nil between the `LOADING_SCREEN_ENABLED` and `LOADING_SCREEN_DISABLED` events. + +**Usage:** +A small list of realm IDs and names. +```lua +-- /dump GetRealmID(), GetRealmName(), GetNormalizedRealmName() +503, "Azjol-Nerub", "AzjolNerub" +513, "Twilight's Hammer", "Twilight'sHammer" +635, "Defias Brotherhood", "DefiasBrotherhood" +1049, "愤怒使者", "愤怒使者" +1093, "Ahn'Qiraj", "Ahn'Qiraj" +1413, "Aggra (Português)", "Aggra(Português)" +1925, "Вечная Песня", "ВечнаяПесня" +``` + +**Reference:** +- `UnitName()` - Returns a character name and the server (if different from the player's current server). \ No newline at end of file diff --git a/wiki-information/functions/GetRepairAllCost.md b/wiki-information/functions/GetRepairAllCost.md new file mode 100644 index 00000000..80e2f1dd --- /dev/null +++ b/wiki-information/functions/GetRepairAllCost.md @@ -0,0 +1,16 @@ +## Title: GetRepairAllCost + +**Content:** +`repairAllCost, canRepair = GetRepairAllCost()` + +**Parameters:** +- **Arguments:** none + +**Returns:** +- `repairAllCost` + - *number* - repair cost +- `canRepair` + - *boolean* - repairs needed? + +**Description:** +Used by MerchantFrame when the MerchantRepairAllButton button is clicked. Does NOT work without the proper type of merchant window open. \ No newline at end of file diff --git a/wiki-information/functions/GetRestState.md b/wiki-information/functions/GetRestState.md new file mode 100644 index 00000000..bcaf2be9 --- /dev/null +++ b/wiki-information/functions/GetRestState.md @@ -0,0 +1,31 @@ +## Title: GetRestState + +**Content:** +Returns if the character is in a rested or normal state. +`exhaustionID, name, factor = GetRestState()` + +**Returns:** +- `exhaustionID` + - *number* - Rest state index; observed values are 1 if the player is "Rested", 2 if the player is in a normal state. +- `name` + - *string* - Name of the current rest state; observed: "Rested" or "Normal". +- `factor` + - *number* - XP multiplier applied to experience gain from killing monsters in the current rest state. + +**Usage:** +```lua +rested = GetRestState(); +if rested == 1 then + print("You're rested. Now's the time to maximize experience gain!"); +elseif rested == 2 then + print("You're not rested. Find an inn and camp for the night?"); +else + print("You've discovered a hitherto unknown rest state. Would you like some coffee?"); +end +``` + +**Example Use Case:** +This function can be used in addons that track player experience and suggest optimal times for leveling. For instance, an addon could notify players when they are in a rested state to maximize their experience gain from killing monsters. + +**Addons Using This Function:** +- **RestedXP**: This addon uses `GetRestState` to provide players with information on their rested state, helping them plan their leveling sessions more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetRestrictedAccountData.md b/wiki-information/functions/GetRestrictedAccountData.md new file mode 100644 index 00000000..6d78dc06 --- /dev/null +++ b/wiki-information/functions/GetRestrictedAccountData.md @@ -0,0 +1,16 @@ +## Title: GetRestrictedAccountData + +**Content:** +Returns the cap on trial character level, money, and profession skill. +`rLevel, rMoney, profCap = GetRestrictedAccountData()` + +**Returns:** +- `rLevel` + - *number* - character level cap, currently 20 +- `rMoney` + - *number* - max amount of money in copper, currently 10000000 +- `profCap` + - *number* - profession level cap, currently 0 + +**Description:** +Only returns proper values while on a Starter Edition or inactive account. \ No newline at end of file diff --git a/wiki-information/functions/GetRewardSpell.md b/wiki-information/functions/GetRewardSpell.md new file mode 100644 index 00000000..cdd11f11 --- /dev/null +++ b/wiki-information/functions/GetRewardSpell.md @@ -0,0 +1,15 @@ +## Title: GetRewardSpell + +**Content:** +Returns the spell reward for the quest in the gossip window. +`texture, name, isTradeskillSpell, isSpellLearned = GetRewardSpell()` + +**Returns:** +- `texture`, `name`, `isTradeskillSpell`, `isSpellLearned` + - *texture* - icon of spell. + - *name* - name of spell. + - *isTradeskillSpell* - if spell received is a tradeskill or not. This will be true, for example, for quests that upgrade your secondary professions, like fishing quest from Nat Pagle. + - *isSpellLearned* - if you actually learn a spell and it will appear in your spellbook (true) or if it will be just cast on you (false). + +**Description:** +Just as almost any other quest gossip function, `GetRewardSpell()` returns data that refreshes only when you see the corresponding gossip page. Any subsequent calls will return the same data until the next update. You can watch updates for data returned by `GetRewardSpell()` by registering for `QUEST_DETAIL` and `QUEST_COMPLETE` events. This means that if, for example, you talk to some NPC and check details of a quest that offers a spell reward and then talk to another NPC and check the progress gossip page of a quest you've accepted previously that offers a spell reward too, this function will still return data of the spell from the first quest because the progress page does not show rewards and their data is not updated. \ No newline at end of file diff --git a/wiki-information/functions/GetRewardXP.md b/wiki-information/functions/GetRewardXP.md new file mode 100644 index 00000000..5b151dca --- /dev/null +++ b/wiki-information/functions/GetRewardXP.md @@ -0,0 +1,16 @@ +## Title: GetRewardXP + +**Content:** +Returns the experience reward for the quest in the gossip window. +`xp = GetRewardXP()` + +**Parameters:** +None + +**Returns:** +- `xp` + - *number* - Amount of experience points to be received upon completing the quest, including any bonuses to experience gain such as Rest and . + +**Description:** +This function is not related to your quest log. +The return values update when the `QUEST_DETAIL`, `QUEST_COMPLETE` events fire. \ No newline at end of file diff --git a/wiki-information/functions/GetRuneCooldown.md b/wiki-information/functions/GetRuneCooldown.md new file mode 100644 index 00000000..4b82d6e1 --- /dev/null +++ b/wiki-information/functions/GetRuneCooldown.md @@ -0,0 +1,30 @@ +## Title: GetRuneCooldown + +**Content:** +Returns the Death Knight's cooldown info for the specified rune. +`start, duration, runeReady = GetRuneCooldown(id)` + +**Parameters:** +- `id` + - *number* - The rune index, ranging between 1 and 6. + +**Returns:** +- `start` + - *number* - The value of `GetTime()` when the rune's cooldown began (or 0 if the rune is off cooldown). +- `duration` + - *number* - The duration of the rune's cooldown (regardless of whether or not it's on cooldown). +- `runeReady` + - *boolean* - Whether or not the rune is off cooldown. True if ready, false if not. + +**Usage:** +This will print the number of runes you have ready to cast. +```lua +local amount = 0 +for i = 1, 6 do + local start, duration, runeReady = GetRuneCooldown(i) + if runeReady then + amount = amount + 1 + end +end +print("Available Runes: " .. amount) +``` \ No newline at end of file diff --git a/wiki-information/functions/GetRuneType.md b/wiki-information/functions/GetRuneType.md new file mode 100644 index 00000000..82b3401d --- /dev/null +++ b/wiki-information/functions/GetRuneType.md @@ -0,0 +1,19 @@ +## Title: GetRuneType + +**Content:** +Gets the type of rune for a given rune ID. +`runeType = GetRuneType(id)` + +**Parameters:** +- `id` + - The rune's id. A number between 1 and 6 denoting which rune to be queried. + +**Returns:** +- `runeType` - The type of rune that it is. + - `1` : RUNETYPE_BLOOD + - `2` : RUNETYPE_CHROMATIC + - `3` : RUNETYPE_FROST + - `4` : RUNETYPE_DEATH + +**Note:** +"CHROMATIC" refers to Unholy runes. \ No newline at end of file diff --git a/wiki-information/functions/GetSavedInstanceChatLink.md b/wiki-information/functions/GetSavedInstanceChatLink.md new file mode 100644 index 00000000..9e3e7675 --- /dev/null +++ b/wiki-information/functions/GetSavedInstanceChatLink.md @@ -0,0 +1,34 @@ +## Title: GetSavedInstanceChatLink + +**Content:** +Retrieves the SavedInstanceChatLink to a specific instance. +`link = GetSavedInstanceChatLink(index)` + +**Parameters:** +- `index` + - The index of the instance you want to query. + +**Returns:** +- `link` + - If instance at index is linkable. +- `nil` + - If instance is not linkable (none at index). + +**Usage:** +```lua +local link = GetSavedInstanceChatLink(1) +if link then + print(link) +else + print("Linking is not available for this instance!") +end +``` + +**Miscellaneous:** +Result: + +Displays a link to the first instance in your Raid Information tab in the chat window, unless there is none available. + +**Description:** +Added in 4.0.1 +See also `GetSpellLink()`, `SavedInstanceChatLink` \ No newline at end of file diff --git a/wiki-information/functions/GetSavedInstanceEncounterInfo.md b/wiki-information/functions/GetSavedInstanceEncounterInfo.md new file mode 100644 index 00000000..fabcb04a --- /dev/null +++ b/wiki-information/functions/GetSavedInstanceEncounterInfo.md @@ -0,0 +1,32 @@ +## Title: GetSavedInstanceEncounterInfo + +**Content:** +Returns info about a specific encounter from a saved instance lockout. +`bossName, fileDataID, isKilled, unknown4 = GetSavedInstanceEncounterInfo(instanceIndex, encounterIndex)` + +**Parameters:** +- `instanceIndex` + - *number* - Index from 1 to `GetNumSavedInstances()` +- `encounterIndex` + - *number* - Index from 1 to the number of encounters in the instance. For multi-part raids, this includes bosses that are not in that raid section, so the first boss in the second wing of a Raid Finder raid could actually have an `encounterIndex` of '4'. + +**Returns:** +- `bossName` + - *string* - The localized name of the encounter in question +- `fileDataID` + - *number* - The ID number for a texture associated with the encounter, usually an achievement icon. If Blizzard hasn't designated one for the encounter, expect this return to be nil. +- `isKilled` + - *boolean* - True if you have killed/looted the boss since the last reset period +- `unknown4` + - *boolean* - Unused by Blizzard, has an unknown purpose, and seems to always be false + +**Usage:** +```lua +/dump GetSavedInstanceEncounterInfo(1,1) +-- => "Vigilant Kaathar", nil, true, false +``` + +**Reference:** +- `GetNumSavedInstances` - Counts number of instances this function applies to +- `GetLFGDungeonEncounterInfo` - A moderately similar function to this one, except it works off of dungeon IDs instead of saved instance indexes +- `GetSavedInstanceInfo` - A more generic function; it allows you to pull up information on the dungeon itself instead of the individual encounters \ No newline at end of file diff --git a/wiki-information/functions/GetSavedInstanceInfo.md b/wiki-information/functions/GetSavedInstanceInfo.md new file mode 100644 index 00000000..0304c738 --- /dev/null +++ b/wiki-information/functions/GetSavedInstanceInfo.md @@ -0,0 +1,47 @@ +## Title: GetSavedInstanceInfo + +**Content:** +Returns instance lock info. +`name, lockoutId, reset, difficultyId, locked, extended, instanceIDMostSig, isRaid, maxPlayers, difficultyName, numEncounters, encounterProgress, extendDisabled, instanceId = GetSavedInstanceInfo(index)` + +**Parameters:** +- `index` + - *number* - index of the saved instance, from 1 to `GetNumSavedInstances()` + +**Returns:** +1. `name` + - *string* - the name of the instance +2. `lockoutId` + - *number* - the ID of the instance lockout +3. `reset` + - *number* - the number of seconds remaining until the instance resets +4. `difficultyId` + - *number* : DifficultyID +5. `locked` + - *boolean* - true if the instance is currently locked, false for a historic entry +6. `extended` + - *boolean* - shows true if the ID has been extended +7. `instanceIDMostSig` + - *number* - unknown +8. `isRaid` + - *boolean* - shows true if it is a raid +9. `maxPlayers` + - *number* - shows the max players +10. `difficultyName` + - *string* - shows a localized string i.e. 10 Player (Heroic) +11. `numEncounters` + - *number* - number of boss encounters in this instance +12. `encounterProgress` + - *number* - farthest boss encounter in this instance for player +13. `extendDisabled` + - *boolean* - returns whether this instance cannot be disabled +14. `instanceId` + - *number* : InstanceID + +**Reference:** +- `GetInstanceLockTimeRemaining` - Older, more limited version of this function +- `GetNumSavedInstances` - Counts number of instances this function applies to +- `GetSavedInstanceEncounterInfo` - A more specific function; this lets you check up on the individual encounters within a given saved instance +- `GetSavedWorldBossInfo` - A similar function to this, except for the player's saved world boss lockout data +- `GetLFGDungeonInfo` - A moderately similar function to this function, except it works off of dungeon IDs instead of saved instance indexes. It can also return Raid Finder instance info, unlike this function. +- `GetRFDungeonInfo` - Nearly identical to `GetLFGDungeonInfo`, except it uses Raid Finder indexes instead of dungeon IDs \ No newline at end of file diff --git a/wiki-information/functions/GetScenariosChoiceOrder.md b/wiki-information/functions/GetScenariosChoiceOrder.md new file mode 100644 index 00000000..75630e55 --- /dev/null +++ b/wiki-information/functions/GetScenariosChoiceOrder.md @@ -0,0 +1,17 @@ +## Title: GetScenariosChoiceOrder + +**Content:** +Returns an ordered list of all available scenario IDs. +`allScenarios = GetScenariosChoiceOrder()` + +**Parameters:** +- `allScenarios` + - *table* - If provided, this table will be wiped and populated with return values; otherwise, a new table will be created for the return value. + +**Returns:** +- `allScenarios` + - *table* - an array containing LFG dungeon IDs of specific scenarios. Not all of these may be level-appropriate. + +**Reference:** +- `GetLFGDungeonInfo` +- `GetRandomScenarioInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetSchoolString.md b/wiki-information/functions/GetSchoolString.md new file mode 100644 index 00000000..082b7198 --- /dev/null +++ b/wiki-information/functions/GetSchoolString.md @@ -0,0 +1,13 @@ +## Title: GetSchoolString + +**Content:** +Returns the name of the specified damage school mask. +`school = GetSchoolString(schoolMask)` + +**Parameters:** +- `schoolMask` + - *number* - bitfield mask of damage types. + +**Returns:** +- `school` + - *string* - localized school name (e.g. "Frostfire"), or "Unknown" if the school combination isn't named. \ No newline at end of file diff --git a/wiki-information/functions/GetScreenDPIScale.md b/wiki-information/functions/GetScreenDPIScale.md new file mode 100644 index 00000000..e249abd3 --- /dev/null +++ b/wiki-information/functions/GetScreenDPIScale.md @@ -0,0 +1,9 @@ +## Title: GetScreenDPIScale + +**Content:** +Needs summary. +`scale = GetScreenDPIScale()` + +**Returns:** +- `scale` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetScreenHeight.md b/wiki-information/functions/GetScreenHeight.md new file mode 100644 index 00000000..dd96e539 --- /dev/null +++ b/wiki-information/functions/GetScreenHeight.md @@ -0,0 +1,21 @@ +## Title: GetScreenHeight + +**Content:** +Returns the height of the window measured at UIParent scale (effectively the same as `UIParent:GetHeight()`). +`screenHeight = GetScreenHeight()` + +**Returns:** +- `screenHeight` + - *number* - Height of window at UIParent scale + +**Usage:** +```lua +-- Note that the return value does not match the screen resolution set in the Video Options, but will instead represent a dimension with the same aspect ratio. +DEFAULT_CHAT_FRAME:AddMessage( ( GetScreenWidth() * UIParent:GetEffectiveScale() ).."x"..( GetScreenHeight() * UIParent:GetEffectiveScale() ) ) +``` + +**Example Use Case:** +This function can be used to dynamically adjust UI elements based on the screen height. For instance, if you are developing a custom UI addon and need to position elements relative to the screen height, you can use `GetScreenHeight()` to get the current height and adjust your elements accordingly. + +**Addons Using This Function:** +Many large addons, such as ElvUI and Bartender4, use this function to ensure their UI elements are correctly scaled and positioned according to the user's screen resolution and UI scale settings. This helps maintain a consistent and visually appealing interface across different screen sizes and resolutions. \ No newline at end of file diff --git a/wiki-information/functions/GetScreenResolutions.md b/wiki-information/functions/GetScreenResolutions.md new file mode 100644 index 00000000..e92e0832 --- /dev/null +++ b/wiki-information/functions/GetScreenResolutions.md @@ -0,0 +1,41 @@ +## Title: GetScreenResolutions + +**Content:** +Returns a list of available preset windowed screen resolutions. +`resolution1, resolution2, resolution3, ... = GetScreenResolutions()` + +**Returns:** +- `resolutionN` + - *string* - An available screen resolution as ___x___ (width .. "x" .. height). + +**Description:** +Returns the list that appears in the resolution dropdown only while windowed mode is applied. +Unaffected by full screen or manually changing the window size. + +**Usage:** +Prints a list of preset windowed resolutions. +```lua +local resolutions = {GetScreenResolutions()} +for i, entry in ipairs(resolutions) do + print("Resolution" .. i .. ": " .. entry) +end +--[[ + Resolution 1: 800x600 + Resolution 2: 1024x760 + Resolution 3: 1280x1024 + ... +--]] +``` + +Gets the most-recently chosen preset as width and height. +```lua +local current = GetCurrentResolution() +if current then + local width, height = string.match(select(current, GetScreenResolutions()), "(%d+)x(%d+)") + print(width, height) -- 1920, 1080 +end +``` + +**Reference:** +- `GetCurrentResolution()` +- `gxWindowedResolution` \ No newline at end of file diff --git a/wiki-information/functions/GetScreenWidth.md b/wiki-information/functions/GetScreenWidth.md new file mode 100644 index 00000000..1b8c6688 --- /dev/null +++ b/wiki-information/functions/GetScreenWidth.md @@ -0,0 +1,15 @@ +## Title: GetScreenWidth + +**Content:** +Returns the width of the window measured at UIParent scale (effectively the same as `UIParent:GetWidth()`). +`screenWidth = GetScreenWidth()` + +**Returns:** +- `screenWidth` + - *number* - Width of window at UIParent scale + +**Usage:** +```lua +-- Note that the return value does not match the screen resolution set in the Video Options, but will instead represent a dimension with the same aspect ratio. +DEFAULT_CHAT_FRAME:AddMessage( ( GetScreenWidth() * UIParent:GetEffectiveScale() ).."x"..( GetScreenHeight() * UIParent:GetEffectiveScale() ) ) +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSecondsUntilParentalControlsKick.md b/wiki-information/functions/GetSecondsUntilParentalControlsKick.md new file mode 100644 index 00000000..95cbd35b --- /dev/null +++ b/wiki-information/functions/GetSecondsUntilParentalControlsKick.md @@ -0,0 +1,9 @@ +## Title: GetSecondsUntilParentalControlsKick + +**Content:** +Needs summary. +`remaining = GetSecondsUntilParentalControlsKick()` + +**Returns:** +- `remaining` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetSelectedBattlefield.md b/wiki-information/functions/GetSelectedBattlefield.md new file mode 100644 index 00000000..b90d29f2 --- /dev/null +++ b/wiki-information/functions/GetSelectedBattlefield.md @@ -0,0 +1,9 @@ +## Title: GetSelectedBattlefield + +**Content:** +Returns the currently selected battlefield at the battlemaster. +`selectedIndex = GetSelectedBattlefield()` + +**Returns:** +- `selectedIndex` + - *number* - The selected battlefield instance index. The zeroth index is "First Available". \ No newline at end of file diff --git a/wiki-information/functions/GetSelectedSkill.md b/wiki-information/functions/GetSelectedSkill.md new file mode 100644 index 00000000..54a8f47d --- /dev/null +++ b/wiki-information/functions/GetSelectedSkill.md @@ -0,0 +1,9 @@ +## Title: GetSelectedSkill + +**Content:** +Returns the currently selected skill line. +`skillIndex = GetSelectedSkill()` + +**Returns:** +- `skillIndex` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetSelectedStablePet.md b/wiki-information/functions/GetSelectedStablePet.md new file mode 100644 index 00000000..d9ba480e --- /dev/null +++ b/wiki-information/functions/GetSelectedStablePet.md @@ -0,0 +1,9 @@ +## Title: GetSelectedStablePet + +**Content:** +Gets the index of the currently selected pet in the stable. +`selectedPet = GetSelectedStablePet()` + +**Returns:** +- `selectedPet` + - *number* - The index of the currently selected pet slot, 0 being the current pet, 1 and 2 being the left and right slots, and -1 for when no pet is selected. \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailCOD.md b/wiki-information/functions/GetSendMailCOD.md new file mode 100644 index 00000000..e725dbf9 --- /dev/null +++ b/wiki-information/functions/GetSendMailCOD.md @@ -0,0 +1,12 @@ +## Title: GetSendMailCOD + +**Content:** +Returns the Cash-On-Delivery cost of the outgoing message. +`amount = GetSendMailCOD()` + +**Returns:** +- `amount` + - *number* - COD cost in copper. + +**Reference:** +- `SEND_MAIL_COD_CHANGED` \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailItem.md b/wiki-information/functions/GetSendMailItem.md new file mode 100644 index 00000000..4f1f7561 --- /dev/null +++ b/wiki-information/functions/GetSendMailItem.md @@ -0,0 +1,43 @@ +## Title: GetSendMailItem + +**Content:** +Returns info for an item attached in the outgoing message. +`name, itemID, texture, count, quality = GetSendMailItem(index)` + +**Parameters:** +- `index` + - *number* - The index of the attachment to query, in the range of + +**Returns:** +- `name` + - *string* - The localized name of the item +- `itemID` + - *number* - Numeric ID of the item. +- `texture` + - *string* - The icon texture for the item +- `count` + - *number* - The number of items in the stack +- `quality` + - *number* - The quality index of the item (0-6) + +**Usage:** +The following code will loop over all the items currently attached to the send mail frame, and print information about them to the chat frame: +```lua +for i = 1, ATTACHMENTS_MAX_SEND do + local name, itemID, texture, count, quality = GetSendMailItem(i) + if name then + -- Construct an inline texture sequence: + print("You are sending", "|T"..texture..":0|t", name, "x", count) + end +end +``` + +**Description:** +Requires that the mailbox window is open. +ATTACHMENTS_MAX_SEND is defined in Constants.lua, and currently (Jan 2014) has a value of 12. Using this variable instead of a hardcoded 12 is recommended in case Blizzard changes the maximum number of items that may be attached to a single message. +As of 2.3.3 this function is bugged and the quality is always returned as -1. If you need to know the item's quality, get a link for the item using `GetSendMailItemLink`, and pass the link to `GetItemInfo`. + +**Reference:** +- `GetSendMailItemLink` +- `GetInboxItem` +- `GetInboxItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailItemLink.md b/wiki-information/functions/GetSendMailItemLink.md new file mode 100644 index 00000000..25747f79 --- /dev/null +++ b/wiki-information/functions/GetSendMailItemLink.md @@ -0,0 +1,32 @@ +## Title: GetSendMailItemLink + +**Content:** +Returns the item link of an item attached in the outgoing message. +`itemLink = GetSendMailItemLink(attachment)` + +**Parameters:** +- `attachment` + - *number* - The index of the attachment to query, in the range of + +**Returns:** +- `itemLink` + - *itemLink* - The item link for the specified item + +**Description:** +`ATTACHMENTS_MAX_SEND` is defined in `Constants.lua`, and currently (Jan 2014) has a value of 12. Using this variable instead of a hardcoded 12 is recommended in case Blizzard changes the maximum number of items that may be attached to a sent message. + +There is no API function to get the total number of items attached to a sent message. If your addon needs to know how many attachment slots are filled, you must loop over all the slots and count them yourself: +```lua +local total = 0 +for i = 1, ATTACHMENTS_MAX_SEND do + if GetSendMailItemLink(i) then + total = total + 1 + end +end +print("Attachment slots used:", total, "of", ATTACHMENTS_MAX_SEND) +``` + +**Reference:** +- `GetSendMailItem` +- `GetInboxItem` +- `GetInboxItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailPrice.md b/wiki-information/functions/GetSendMailPrice.md new file mode 100644 index 00000000..85964d6c --- /dev/null +++ b/wiki-information/functions/GetSendMailPrice.md @@ -0,0 +1,9 @@ +## Title: GetSendMailPrice + +**Content:** +Gets the cost for sending mail. +`sendPrice = GetSendMailPrice()` + +**Returns:** +- `sendPrice` + - *number* - The price in copper. \ No newline at end of file diff --git a/wiki-information/functions/GetServerExpansionLevel.md b/wiki-information/functions/GetServerExpansionLevel.md new file mode 100644 index 00000000..d69053d4 --- /dev/null +++ b/wiki-information/functions/GetServerExpansionLevel.md @@ -0,0 +1,55 @@ +## Title: GetServerExpansionLevel + +**Content:** +Returns the expansion level currently active on the server. +`serverExpansionLevel = GetServerExpansionLevel()` + +**Returns:** +- `serverExpansionLevel` + - *number* + - `NUM_LE_EXPANSION_LEVELS` + - **Value** + - **Enum** + - **Description** + - `LE_EXPANSION_LEVEL_CURRENT` + - 0 + - `LE_EXPANSION_CLASSIC` + - Vanilla / Classic Era + - 1 + - `LE_EXPANSION_BURNING_CRUSADE` + - The Burning Crusade + - 2 + - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` + - Wrath of the Lich King + - 3 + - `LE_EXPANSION_CATACLYSM` + - Cataclysm + - 4 + - `LE_EXPANSION_MISTS_OF_PANDARIA` + - Mists of Pandaria + - 5 + - `LE_EXPANSION_WARLORDS_OF_DRAENOR` + - Warlords of Draenor + - 6 + - `LE_EXPANSION_LEGION` + - Legion + - 7 + - `LE_EXPANSION_BATTLE_FOR_AZEROTH` + - Battle for Azeroth + - 8 + - `LE_EXPANSION_SHADOWLANDS` + - Shadowlands + - 9 + - `LE_EXPANSION_DRAGONFLIGHT` + - Dragonflight + - 10 + - `LE_EXPANSION_11_0` + +**Description:** +This does not update on pre-patch and only when the expansion actually launches; requires a client restart to update, if still in-game. + +**Usage:** +Before and after the Shadowlands global launch on November 23, 2020, at 3:00 p.m. PST. +```lua +/dump GetServerExpansionLevel() -- 7 -> 8 +``` \ No newline at end of file diff --git a/wiki-information/functions/GetServerTime.md b/wiki-information/functions/GetServerTime.md new file mode 100644 index 00000000..644febe8 --- /dev/null +++ b/wiki-information/functions/GetServerTime.md @@ -0,0 +1,31 @@ +## Title: GetServerTime + +**Content:** +Returns the server's Unix time. +`timestamp = GetServerTime()` + +**Returns:** +- `timestamp` + - *number* - Time in seconds since the epoch. + +**Description:** +The server's Unix timestamp is more preferable over `time()` since it's guaranteed to be synchronized between clients. The local machine's clock could possibly have been manually changed and might also be off by a few seconds if not recently synced. +Adjustments to the local system clock while the client is open may result in this function returning incorrect timestamps. +Unix time is unrelated to your time zone, making it useful for tracking and sorting timestamps. + +**Miscellaneous:** +When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. +```lua +-- unix time +time() -- 1596157547 +GetServerTime() -- 1596157549 +-- local time, same as `date(nil, time())` +date() -- "Fri Jul 31 03:05:47 2020" +-- realm time +GetGameTime() -- 20, 4 +C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 +C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) +``` + +**Reference:** +- `GetTime()` - local machine uptime. \ No newline at end of file diff --git a/wiki-information/functions/GetSessionTime.md b/wiki-information/functions/GetSessionTime.md new file mode 100644 index 00000000..285d4430 --- /dev/null +++ b/wiki-information/functions/GetSessionTime.md @@ -0,0 +1,17 @@ +## Title: GetSessionTime + +**Content:** +Returns the time since you opened the game client. +`sessionTime = GetSessionTime()` + +**Returns:** +- `sessionTime` + - *number* - Time in seconds since you started the game client. + +**Description:** +Used on the Korean locale to warn against excessive gameplay time. + +**Reference:** +- `GetTime()` - local machine uptime. +- References: + - [GitHub Commit](https://github.com/Gethe/wow-ui-source/commit/3770c879e4a0db9f4f37e835a77d69eb0ec66efb#diff-54f1522769d9602c5cdd7b482d137f70R446) \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftForm.md b/wiki-information/functions/GetShapeshiftForm.md new file mode 100644 index 00000000..ee920248 --- /dev/null +++ b/wiki-information/functions/GetShapeshiftForm.md @@ -0,0 +1,37 @@ +## Title: GetShapeshiftForm + +**Content:** +Returns the zero-based index of current form/stance. +`index = GetShapeshiftForm()` + +**Parameters:** +- `flag` + - *boolean?* - True if return value is to be compared to a macro's conditional statement. This makes it always return zero for Presences and Auras. False or nil returns an index based on which button to highlight on the shapeshift/stance bar left to right starting at 1. + +**Returns:** +- `index` + - *number* - one of the following: + - **All** + - `0` - humanoid form + - **Druid** + - `Bear Form` + - `Cat Form` + - `Travel Form / Aquatic Form / Flight Form` (all 3 location-dependent versions of Travel Form count as Form 3) + - The first known of: `Moonkin Form`, `Treant Form`, `Stag Form` (in order) + - The second known of: `Moonkin Form`, `Treant Form`, `Stag Form` (in order) + - The third known of: `Moonkin Form`, `Treant Form`, `Stag Form` (in order) + - *Note:* The last 3 are ordered. For example, if you know Stag Form only, it is form 4. If you know both Treant and Stag, Treant is 4 and Stag is 5. If you know all 3, Moonkin is 4, Treant 5, and Stag 6. + - **Priest** + - `Shadowform` + - **Rogue** + - `Stealth` + - `Vanish / Shadow Dance` (for Subtlety rogues, both Vanish and Shadow Dance return as Form 1) + - **Shaman** + - `Ghost Wolf` + - **Warrior** + - `Battle Stance` + - `Defensive Stance` + - `Berserker Stance` + +**Description:** +For some classes, the return value is nil during the loading process. You need to wait until `UPDATE_SHAPESHIFT_FORMS` fires to get correct return values. \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftFormCooldown.md b/wiki-information/functions/GetShapeshiftFormCooldown.md new file mode 100644 index 00000000..8fa2a25b --- /dev/null +++ b/wiki-information/functions/GetShapeshiftFormCooldown.md @@ -0,0 +1,28 @@ +## Title: GetShapeshiftFormCooldown + +**Content:** +Returns cooldown information for a specified form. +`startTime, duration, isActive = GetShapeshiftFormCooldown(index)` + +**Parameters:** +- `index` + - *number* - Index of the desired form + +**Returns:** +- `startTime` + - *number* - Cooldown start time (per GetTime) in seconds. +- `duration` + - *number* - Cooldown duration in seconds. +- `isActive` + - *boolean* - Returns 1 if the cooldown is running, nil if it isn't + +**Usage:** +Displays the seconds remaining on the shapeshift form at index 1 or "Not Active" if there's no cooldown on that form. +```lua +local startTime, duration, isActive = GetShapeshiftFormCooldown(1) +if isActive then + print("Not Active") +else + print(string.format("Form 1 has %f seconds remaining", startTime + duration - GetTime())) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftFormID.md b/wiki-information/functions/GetShapeshiftFormID.md new file mode 100644 index 00000000..4a6e1eb4 --- /dev/null +++ b/wiki-information/functions/GetShapeshiftFormID.md @@ -0,0 +1,38 @@ +## Title: GetShapeshiftFormID + +**Content:** +Returns the ID of the form or stance the player is currently in. +`index = GetShapeshiftFormID()` + +**Returns:** +- `index` + - *number* - one of the following: + - **All** + - `nil` = humanoid form + - **Druid** + - Aquatic Form - 4 + - Bear Form - 5 (BEAR_FORM constant) + - Cat Form - 1 (CAT_FORM constant) + - Flight Form - 29 + - Moonkin Form - 31 - 35 (MOONKIN_FORM constant) (different races seem to have different numbers) + - Swift Flight Form - 27 + - Travel Form - 3 + - Tree of Life - 2 + - Treant Form - 36 + - **Monk** + - Stance of the Fierce Tiger - 24 + - Stance of the Sturdy Ox - 23 + - Stance of the Wise Serpent - 20 + - **Rogue** + - Stealth - 30 + - **Shaman** + - Ghost Wolf - 16 + - **Warlock** + - Metamorphosis - 22 + - **Warrior** + - Battle Stance - 17 + - Berserker Stance - 19 + - Defensive Stance - 18 + +**Description:** +Similar to the function `GetShapeshiftForm(flag)`, except the values returned are constant and not dependent on forms available to the unit or current class. \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftFormInfo.md b/wiki-information/functions/GetShapeshiftFormInfo.md new file mode 100644 index 00000000..5395319a --- /dev/null +++ b/wiki-information/functions/GetShapeshiftFormInfo.md @@ -0,0 +1,22 @@ +## Title: GetShapeshiftFormInfo + +**Content:** +Returns info for an available form or stance. +`icon, active, castable, spellID = GetShapeshiftFormInfo(index)` + +**Parameters:** +- `index` + - *number* - index, ascending from 1 to `GetNumShapeshiftForms()` + +**Returns:** +- `icon` + - *string* - Path to icon texture +- `active` + - *boolean* - 1 if this shapeshift is currently active, nil otherwise +- `castable` + - *boolean* - 1 if this shapeshift form may be entered, nil otherwise +- `spellID` + - *number* - ID of the spell that activates this ability + +**Description:** +As well as druid shapeshifting, warrior stances, paladin auras, hunter aspects, death knight presences, and shadowform use this API. \ No newline at end of file diff --git a/wiki-information/functions/GetSheathState.md b/wiki-information/functions/GetSheathState.md new file mode 100644 index 00000000..692470bd --- /dev/null +++ b/wiki-information/functions/GetSheathState.md @@ -0,0 +1,20 @@ +## Title: GetSheathState + +**Content:** +Returns which type of weapon the player currently has unsheathed. +`sheathState = GetSheathState()` + +**Returns:** +- `sheathState` + - *number* - Currently unsheathed weapon type: + - `Value` + - `Weapon` + - `1` + - None + - `2` + - Melee + - `3` + - Ranged + +**Reference:** +ToggleSheath \ No newline at end of file diff --git a/wiki-information/functions/GetShieldBlock.md b/wiki-information/functions/GetShieldBlock.md new file mode 100644 index 00000000..132c2e1e --- /dev/null +++ b/wiki-information/functions/GetShieldBlock.md @@ -0,0 +1,21 @@ +## Title: GetShieldBlock + +**Content:** +Returns the percentage of damage blocked by your shield. +`shieldBlock = GetShieldBlock()` + +**Returns:** +- `shieldBlock` + - *number* - the percentage of damage reduced by your shield + +**Usage:** +```lua +/dump GetShieldBlock() -- 31 +``` +This means that your shield blocks 31% of damage. This matches the in-game tooltip: "Your block stops 31% of incoming damage." + +**Description:** +All blocked attacks are reduced by 30%. It can be increased to 31% by a +1% Shield Block Value meta-gem. + +**Reference:** +- `GetBlockChance` \ No newline at end of file diff --git a/wiki-information/functions/GetSkillLineInfo.md b/wiki-information/functions/GetSkillLineInfo.md new file mode 100644 index 00000000..b06bc10d --- /dev/null +++ b/wiki-information/functions/GetSkillLineInfo.md @@ -0,0 +1,45 @@ +## Title: GetSkillLineInfo + +**Content:** +Returns information on a skill line/header. +```lua +skillName, header, isExpanded, skillRank, numTempPoints, skillModifier, skillMaxRank, isAbandonable, stepCost, rankCost, minLevel, skillCostType, skillDescription = GetSkillLineInfo(index) +``` + +**Parameters:** +- `index` + - *number* - The index of a line in the skills window, can be a header or skill line. Indices can change depending on collapsed/expanded headers. + +**Returns:** +1. `skillName` + - *string* - Name of the skill line. +2. `header` + - *number* - Returns 1 if the line is a header, nil otherwise. +3. `isExpanded` + - *number* - Returns 1 if the line is a header and expanded, nil otherwise. +4. `skillRank` + - *number* - The current rank for the skill, 0 if not applicable. +5. `numTempPoints` + - *number* - Temporary points for the current skill. +6. `skillModifier` + - *number* - Skill modifier value for the current skill. +7. `skillMaxRank` + - *number* - The maximum rank for the current skill. If this is 1 the skill is a proficiency. +8. `isAbandonable` + - *number* - Returns 1 if this skill can be unlearned, nil otherwise. +9. `stepCost` + - *number* - Returns 1 if skill can be learned, nil otherwise. +10. `rankCost` + - *number* - Returns 1 if skill can be trained, nil otherwise. +11. `minLevel` + - *number* - Minimum level required to learn this skill. +12. `skillCostType` + - *number* +13. `skillDescription` + - *string* - Localized skill description text + +**Usage:** +Prints the player's skill lines. +```lua +/run for i = 1, GetNumSkillLines() do print(i, GetSkillLineInfo(i)) end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketItemBoundTradeable.md b/wiki-information/functions/GetSocketItemBoundTradeable.md new file mode 100644 index 00000000..23223a0f --- /dev/null +++ b/wiki-information/functions/GetSocketItemBoundTradeable.md @@ -0,0 +1,16 @@ +## Title: GetSocketItemBoundTradeable + +**Content:** +Returns true if the item currently being socketed can be traded to other eligible players (BoP boss loot). +`isBoundTradeable = GetSocketItemBoundTradeable()` + +**Returns:** +- `isBoundTradeable` + - *boolean* - 1 if the item selected for socketing is BoP but can currently be traded to other eligible players, nil otherwise. + +**Description:** +Bind-on-pickup items looted in dungeon and raid instances can be traded with other players present during the encounter the items dropped from within a limited timeframe. +If you socket gems into a BoP item within its tradable period, the item will cease being tradable. + +**Reference:** +- `GetSocketItemRefundable` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketItemInfo.md b/wiki-information/functions/GetSocketItemInfo.md new file mode 100644 index 00000000..63143988 --- /dev/null +++ b/wiki-information/functions/GetSocketItemInfo.md @@ -0,0 +1,29 @@ +## Title: GetSocketItemInfo + +**Content:** +Returns info for the item currently being socketed. +`itemName, iconPathName, itemQuality = GetSocketItemInfo()` + +**Returns:** +- `itemName` + - *string* - Localized name of the item currently being socketed, or nil if the socketing UI is not open. +- `iconPathName` + - *string* - Virtual path name (i.e. `Interface\\Icons\\inv_belt_52`) for the icon displayed in the character window (PaperDollFrame) for this item, or nil if the socketing UI is not open. +- `itemQuality` + - *number* - 0) Socketing UI not currently open, 1) Common, 2) Uncommon, 3) Rare, 4) Epic, etc. (the colors correlate to the color of the font used by the game when it draws the item's name). + +**Usage:** +```lua +-- from Blizzard_ItemSocketingUI.lua +local name, icon, quality = GetSocketItemInfo(); +local sname, sicon, squality = tostring(name), tostring(icon), tostring(quality) +print("name:" .. sname .. " icon:" .. sicon .. " quality:" .. squality) +``` + +**Miscellaneous:** +Result: + +Simple print statement displaying the values returned. In this example, I used Merlin's Robe (item id:47604): +``` +name:Merlin's Robe icon:Interface\\Icons\\INV_Chest_Cloth_64 quality:4 +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketItemRefundable.md b/wiki-information/functions/GetSocketItemRefundable.md new file mode 100644 index 00000000..0282ed17 --- /dev/null +++ b/wiki-information/functions/GetSocketItemRefundable.md @@ -0,0 +1,16 @@ +## Title: GetSocketItemRefundable + +**Content:** +Returns whether the item currently being socketed is refundable. +`isRefundable = GetSocketItemRefundable()` + +**Returns:** +- `isRefundable` + - *boolean* - 1 if the item selected for socketing can be returned to a merchant for a refund. + +**Description:** +Items purchased with non-gold currencies can sometimes be sold back to a merchant for a full refund within a limited time frame. +The item remains refundable if you socket gems into it; however, any socketed gems will not be refunded upon selling the item back to a vendor. + +**Reference:** +- `GetSocketItemBoundTradeable` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketTypes.md b/wiki-information/functions/GetSocketTypes.md new file mode 100644 index 00000000..85dde39a --- /dev/null +++ b/wiki-information/functions/GetSocketTypes.md @@ -0,0 +1,28 @@ +## Title: GetSocketTypes + +**Content:** +Returns the type (color) of a socket in the item. + +**Parameters:** +- `Index` + - *Number* - The 1-based index of the socket for which to get information. + +**Returns:** +- `SocketType` + - *String* - The type of the socket at position Index. The value could be any of these (apparently unlocalized) strings: + - `"Red"` - Red socket + - `"Yellow"` - Yellow socket + - `"Blue"` - Blue socket + - `"Meta"` - Meta socket + - `"Socket"` - Prismatic socket + +**Usage:** +```lua +local SocketCount = GetNumSockets() +for i = 1, SocketCount do + print(GetSocketInfo(i)) +end +``` + +**Description:** +This function is only useful if the item socketing window is currently visible. \ No newline at end of file diff --git a/wiki-information/functions/GetSoundEntryCount.md b/wiki-information/functions/GetSoundEntryCount.md new file mode 100644 index 00000000..f7428718 --- /dev/null +++ b/wiki-information/functions/GetSoundEntryCount.md @@ -0,0 +1,16 @@ +## Title: GetSoundEntryCount + +**Content:** +Returns the number of sound entries a sound kit contains. +`entryCount = GetSoundEntryCount(soundKit)` + +**Parameters:** +- `soundKit` + - *number* - A sound kit ID. + +**Returns:** +- `entryCount` + - *number?* - The number of sound entries this sound kit contains. + +**Description:** +A sound entry typically refers to a distinct sound file that will be sampled when the sound kit is played. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellAutocast.md b/wiki-information/functions/GetSpellAutocast.md new file mode 100644 index 00000000..a10e4207 --- /dev/null +++ b/wiki-information/functions/GetSpellAutocast.md @@ -0,0 +1,33 @@ +## Title: GetSpellAutocast + +**Content:** +Returns true if a (pet) spell is autocastable. +`autocastable, autostate = GetSpellAutocast("spellName" or spellId, bookType)` + +**Parameters:** +- `spellName` + - *string* - the name of the spell. +- `spellId` + - *number* - the offset (position) of the spell in the spellbook. SpellId can change when you learn new spells. +- `bookType` + - *string* - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet"). + +**Returns:** +- `autocastable` + - *number* - whether a spell is autocastable. + - Returns 1 if the spell is autocastable, nil otherwise. +- `autostate` + - *number* - whether a spell is currently set to autocast. + - Returns 1 if the spell is currently set for autocast, nil otherwise. + +**Description:** +As of patch 3.0.3, the only auto-castable spells exist in the pet spellbook (BOOKTYPE_PET). +Both return values will be nil in the following conditions: +- The spell is not autocastable +- The spell does not exist (or you don't know it) + +**Example Usage:** +This function can be used in macros or addons to check if a pet spell is set to autocast and to manage pet abilities more effectively. For instance, a hunter might use this to ensure their pet's Growl ability is set to autocast when tanking. + +**Addons:** +Large addons like PetTracker might use this function to display or manage pet abilities, ensuring that the pet's autocast settings are correctly configured for optimal performance in various situations. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBaseCooldown.md b/wiki-information/functions/GetSpellBaseCooldown.md new file mode 100644 index 00000000..b1db1264 --- /dev/null +++ b/wiki-information/functions/GetSpellBaseCooldown.md @@ -0,0 +1,21 @@ +## Title: GetSpellBaseCooldown + +**Content:** +Gives the (unmodified) cooldown and global cooldown of an ability in milliseconds. +`cooldownMS, gcdMS = GetSpellBaseCooldown(spellid)` + +**Parameters:** +- `spellid` + - *number* - The spellid of your ability. + +**Returns:** +- `cooldownMS` + - *number* - Millisecond duration of the spell's cooldown (if any other than the global cooldown) +- `gcdMS` + - *number* - Millisecond duration of the spell's global cooldown (if any) + +**Notes and Caveats:** +Polling the second return value will discover if a particular spell is subject to GCD. + +**Reference:** +`GetSpellCooldown` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBonusDamage.md b/wiki-information/functions/GetSpellBonusDamage.md new file mode 100644 index 00000000..cd2045d7 --- /dev/null +++ b/wiki-information/functions/GetSpellBonusDamage.md @@ -0,0 +1,20 @@ +## Title: GetSpellBonusDamage + +**Content:** +Returns the raw spell damage bonus for the specified spell tree. +`bonusDamage = GetSpellBonusDamage(school)` + +**Parameters:** +- `school` + - *number* - the spell tree: + - 1: Physical + - 2: Holy + - 3: Fire + - 4: Nature + - 5: Frost + - 6: Shadow + - 7: Arcane + +**Returns:** +- `bonusDamage` + - *number* - The raw spell damage bonus of the player for that spell tree \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBonusHealing.md b/wiki-information/functions/GetSpellBonusHealing.md new file mode 100644 index 00000000..51daf812 --- /dev/null +++ b/wiki-information/functions/GetSpellBonusHealing.md @@ -0,0 +1,9 @@ +## Title: GetSpellBonusHealing + +**Content:** +Returns the raw spell healing bonus. +`bonusHealing = GetSpellBonusHealing()` + +**Returns:** +- `bonusHealing` + - *number* - The healing spell power of the player \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBookItemInfo.md b/wiki-information/functions/GetSpellBookItemInfo.md new file mode 100644 index 00000000..8c406d03 --- /dev/null +++ b/wiki-information/functions/GetSpellBookItemInfo.md @@ -0,0 +1,65 @@ +## Title: GetSpellBookItemInfo + +**Content:** +Returns info for a spellbook item. +`spellType, id = GetSpellBookItemInfo(spellName)` +`spellType, id = GetSpellBookItemInfo(index, bookType)` + +**Parameters:** +- `spellName` + - *string* - Requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Returns:** +- `spellType` + - *string* - The type of the spell: +- `id` + - *number* + - For `SPELL` and `FUTURESPELL`, the SpellID used in `GetSpellInfo()` + - For `PETACTION`, the ActionID used in `C_ActionBar.HasPetActionButtons()`; furthermore, the SpellID can be obtained by applying the bitmask `0xFFFFFF`. + - For `FLYOUT`, the FlyoutID used in `GetFlyoutInfo()` + +**Description:** +Related API: `GetSpellBookItemName` + +**Usage:** +Prints all spells in the spellbook for the player, except the profession tab ones. +```lua +local spellFunc = { + SPELL = GetSpellInfo, + FUTURESPELL = GetSpellInfo, + FLYOUT = GetFlyoutInfo, +} +for i = 1, GetNumSpellTabs() do + local _, _, offset, numSlots = GetSpellTabInfo(i) + for j = offset+1, offset+numSlots do + local spellType, id = GetSpellBookItemInfo(j, BOOKTYPE_SPELL) + local spellName = spellFunc[id] + print(i, j, spellType, id, spellName) + end +end +``` + +Prints all pet spells. +```lua +for i = 1, HasPetSpells() do + local spellType, id = GetSpellBookItemInfo(i, BOOKTYPE_PET) + local spellID = bit.band(0xFFFFFF, id) + -- not sure what the non-spell IDs are + local spellName = spellID > 100 and GetSpellInfo(spellID) or GetSpellBookItemName(i, BOOKTYPE_PET) + local hasActionButton = C_ActionBar.HasPetActionButtons(id) + print(i, spellType, id, spellID, spellName, hasActionButton) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBookItemName.md b/wiki-information/functions/GetSpellBookItemName.md new file mode 100644 index 00000000..f002e050 --- /dev/null +++ b/wiki-information/functions/GetSpellBookItemName.md @@ -0,0 +1,85 @@ +## Title: GetSpellBookItemName + +**Content:** +Returns the name of a spellbook item. +```lua +spellName, spellSubName, spellID = GetSpellBookItemName(spellName) +spellName, spellSubName, spellID = GetSpellBookItemName(index, bookType) +``` + +**Parameters:** +- `spellName` + - *string* - Requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Returns:** +- `spellName` + - *string* - Name of the spell as it appears in the spell book, e.g. "Lesser Heal" +- `spellSubName` + - *string* - The spell rank or sub type, e.g. "Grand Master", "Racial Passive". This can be an empty string. Note: for the Enchanting trade skill at rank Apprentice, the returned string contains a trailing space, i.e. "Apprentice ". This might be the case for other trade skills and ranks also. Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad()` +- `spellID` + - *number* + +**Description:** +- **Related API** + - `GetSpellBookItemInfo` +- This function will return nested flyout spells, but the names returned may not be functional (a hunter will see "Call " instead of "Call Pet 1" but "/cast Call " will not function in a macro or from the command line). Use care with the results returned. +- Spell book information is first available after the `SPELLS_CHANGED` event fires. + +**Usage:** +Prints all spells in the spellbook for the player, except the profession tab ones. +```lua +for i = 1, GetNumSpellTabs() do + local offset, numSlots = select(3, GetSpellTabInfo(i)) + for j = offset+1, offset+numSlots do + print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) + end +end +``` + +Prints the spells shown in the profession tab. +```lua +for _, i in pairs{GetProfessions()} do + local offset, numSlots = select(3, GetSpellTabInfo(i)) + for j = offset+1, offset+numSlots do + print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) + end +end +-- Example output: +-- 7, 126, "Tailoring", "", 3908 +-- 8, 128, "Engineering", "", 4036 +-- 6, 122, "Cooking", "", 2550 +-- 6, 123, "Cooking Fire", "", 81 +``` + +Prints the spells shown in the pet tab. +```lua +local numSpells, petToken = HasPetSpells() -- nil if pet does not have spellbook, 'petToken' will usually be 'PET' +for i=1, numSpells do + local petSpellName, petSubType, unmaskedSpellId = GetSpellBookItemName(i, "pet") + print("petSpellName", petSpellName) -- like "Dash" + print("petSubType", petSubType) -- like "Basic Ability" or "Pet Stance" + print("unmaskedId", unmaskedSpellId) -- don't have to apply the 0xFFFFFF mask like you do for GetSpellBookItemInfo +end +``` + +Note that not all spells available from the API are shown in the spellbook. +```lua +local i = 1 +while GetSpellBookItemName(i, BOOKTYPE_SPELL) do + print(i, GetSpellBookItemName(i, BOOKTYPE_SPELL)) + i = i + 1 +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBookItemTexture.md b/wiki-information/functions/GetSpellBookItemTexture.md new file mode 100644 index 00000000..4aa924d3 --- /dev/null +++ b/wiki-information/functions/GetSpellBookItemTexture.md @@ -0,0 +1,31 @@ +## Title: GetSpellBookItemTexture + +**Content:** +Returns the icon texture of a spellbook item. +```lua +icon = GetSpellBookItemTexture(spell) +icon = GetSpellBookItemTexture(index, bookType) +``` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant Values:** + - `BOOKTYPE_SPELL` + - *"spell"* - The General, Class, Specs, and Professions tabs + - `BOOKTYPE_PET` + - *"pet"* - The Pet tab + +**Returns:** +- `icon` + - *number : FileID* - Icon fileId for the queried entry, or nil if the queried item does not exist. + +**Reference:** +- `GetSpellBookItemInfo` +- `GetSpellBookItemName` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCharges.md b/wiki-information/functions/GetSpellCharges.md new file mode 100644 index 00000000..d64ccb78 --- /dev/null +++ b/wiki-information/functions/GetSpellCharges.md @@ -0,0 +1,44 @@ +## Title: GetSpellCharges + +**Content:** +Returns information about the charges of a charge-accumulating player ability. +```lua +currentCharges, maxCharges, cooldownStart, cooldownDuration, chargeModRate = GetSpellCharges(spell) +currentCharges, maxCharges, cooldownStart, cooldownDuration, chargeModRate = GetSpellCharges(index, bookType) +``` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - `"spell"` - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - `"pet"` - The Pet tab + +**Returns:** +- `currentCharges` + - *number* - The number of charges of the ability currently available. +- `maxCharges` + - *number* - The maximum number of charges the ability may have available. +- `cooldownStart` + - *number* - Time (per GetTime) at which the last charge cooldown began, or 2^32 / 1000 - cooldownDuration if the spell is not currently recharging. +- `cooldownDuration` + - *number* - Time (in seconds) required to gain a charge. +- `chargeModRate` + - *number* - The rate at which the charge cooldown widget's animation should be updated. + +**Description:** +Abilities like can be used by the player rapidly, and then slowly accumulate charges over time. The `cooldownStart` and `cooldownDuration` return values indicate the cooldown timer for acquiring the next charge (when `currentCharges` is less than `maxCharges`). +If the queried spell does not accumulate charges over time (e.g. or ), this function does not return any values. +Targeted dispels like or hold one hidden charge which may be queried with `GetSpellCharges`. The spells will immediately—or after a few in-game ticks—regain their charge if cast on a friendly unit that could not be dispelled. This may cause sporadic behavior when tracking cooldowns, because upon raising `SPELL_UPDATE_COOLDOWN`, the function API `GetSpellCooldown` will momentarily return that the spell is on its full cooldown duration. + +**Reference:** +- `GetActionCharges(slot)` - Referring to a button on an action bar. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCooldown.md b/wiki-information/functions/GetSpellCooldown.md new file mode 100644 index 00000000..e42f73ec --- /dev/null +++ b/wiki-information/functions/GetSpellCooldown.md @@ -0,0 +1,61 @@ +## Title: GetSpellCooldown + +**Content:** +Returns the cooldown info of a spell. +`start, duration, enabled, modRate = GetSpellCooldown(spell)` +`= GetSpellCooldown(index, bookType)` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - `"spell"` - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - `"pet"` - The Pet tab + +**Returns:** +- `startTime` + - *number* - The time when the cooldown started (as returned by GetTime()); zero if no cooldown; current time if (enabled == 0). +- `duration` + - *number* - Cooldown duration in seconds, 0 if spell is ready to be cast. +- `enabled` + - *number* - 0 if the spell is active (Stealth, Shadowmeld, Presence of Mind, etc) and the cooldown will begin as soon as the spell is used/cancelled; 1 otherwise. +- `modRate` + - *number* - The rate at which the cooldown widget's animation should be updated. + +**Description:** +- **Related Events** + - `SPELL_UPDATE_COOLDOWN` +- **Details:** + - To check the Global Cooldown, you can use the spell ID 61304. This is a dummy spell specifically for the GCD. + - The enabled return value allows addons to easily check if the player has used a buff-providing spell (such as Presence of Mind or Nature's Swiftness) without searching through the player's buffs. + - Values returned by this function are not updated immediately when `UNIT_SPELLCAST_SUCCEEDED` event is raised. + +**Usage:** +The following snippet checks the state of cooldown. On English clients, you could also use "Presence of Mind" in place of 12043, which is the spell's ID. +```lua +local start, duration, enabled, modRate = GetSpellCooldown(12043) +if enabled == 0 then + print("Presence of Mind is currently active, use it and wait " .. duration .. " seconds for the next one.") +elseif (start > 0 and duration > 0) then + local cdLeft = start + duration - GetTime() + print("Presence of Mind is cooling down, wait " .. cdLeft .. " seconds for the next one.") +else + print("Presence of Mind is ready.") +end +``` + +**Example Use Case:** +- **Checking Spell Cooldowns:** This function is commonly used in addons to monitor the cooldown status of spells, allowing players to optimize their spell usage and rotations. + +**Addons Using This Function:** +- **WeakAuras:** This popular addon uses `GetSpellCooldown` to display cooldown timers for spells, helping players track their abilities more effectively. +- **ElvUI:** This comprehensive UI replacement addon uses `GetSpellCooldown` to manage and display cooldown information on action bars and other UI elements. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCount.md b/wiki-information/functions/GetSpellCount.md new file mode 100644 index 00000000..7703a547 --- /dev/null +++ b/wiki-information/functions/GetSpellCount.md @@ -0,0 +1,27 @@ +## Title: GetSpellCount + +**Content:** +Returns the number of times a spell can be cast. Generally used for spells limited by the number of available item reagents. +`numCasts = GetSpellCount(spell)` +`numCasts = GetSpellCount(index, bookType)` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Returns:** +- `numCasts` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCritChance.md b/wiki-information/functions/GetSpellCritChance.md new file mode 100644 index 00000000..df34b793 --- /dev/null +++ b/wiki-information/functions/GetSpellCritChance.md @@ -0,0 +1,40 @@ +## Title: GetSpellCritChance + +**Content:** +Returns the critical hit chance for the specified spell school. +`critChance = GetSpellCritChance(school)` + +**Parameters:** +- `school` + - *number* - the spell school to retrieve the crit chance for. Note: does not seem to be in Blizzard API Documentation. + - 1 for Physical + - 2 for Holy + - 3 for Fire + - 4 for Nature + - 5 for Frost + - 6 for Shadow + - 7 for Arcane + +**Returns:** +- `critChance` + - *number* - An unformatted floating point figure representing the critical hit chance for the specified school. + +**Usage:** +The following function, called with no arguments, will return the same spell crit value as shown on the Character pane of the default UI. The figure returned is formatted as a floating-point figure out to two decimal places. +```lua +function GetRealSpellCrit() + local holySchool = 2; + local minCrit = GetSpellCritChance(holySchool); + local spellCrit; + this.spellCrit = {}; + this.spellCrit = minCrit; + for i = (holySchool + 1), 7 do + spellCrit = GetSpellCritChance(i); + minCrit = min(minCrit, spellCrit); + this.spellCrit = spellCrit; + end + minCrit = format("%.2f%%", minCrit); + return minCrit; +end +``` +The above function is essentially a straight copy of the function from the Paper Doll LUA file in the default UI. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellDescription.md b/wiki-information/functions/GetSpellDescription.md new file mode 100644 index 00000000..e81eb4a8 --- /dev/null +++ b/wiki-information/functions/GetSpellDescription.md @@ -0,0 +1,25 @@ +## Title: GetSpellDescription + +**Content:** +Returns the spell description. +`desc = GetSpellDescription(spellID)` + +**Parameters:** +- `spellID` + - *number* - Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad`. + +**Returns:** +- `desc` + - *string* + +**Usage:** +```lua +GetSpellDescription(11366) +-- > "Hurls an immense fiery boulder that causes 141 Fire damage." +``` + +**Example Use Case:** +This function can be used in addons that need to display or log spell descriptions. For instance, an addon that provides detailed tooltips for spells might use `GetSpellDescription` to fetch and display the spell's effect. + +**Addons Using This Function:** +- **WeakAuras**: This popular addon for creating custom visual alerts uses `GetSpellDescription` to provide detailed information about spells in its configuration options, allowing users to understand the effects of spells they are tracking. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellHitModifier.md b/wiki-information/functions/GetSpellHitModifier.md new file mode 100644 index 00000000..ef484811 --- /dev/null +++ b/wiki-information/functions/GetSpellHitModifier.md @@ -0,0 +1,16 @@ +## Title: GetSpellHitModifier + +**Content:** +Returns the amount of Spell Hit %, not from Spell Hit Rating, that your character has. +`hitMod = GetSpellHitModifier()` + +**Returns:** +- `hitMod` + - *number* - hit modifier (e.g. 16 for 16%) + +**Usage:** +Returns the Spell Hit Chance displayed in the paperdoll. +`/dump GetCombatRatingBonus(CR_HIT_SPELL) + GetSpellHitModifier();` + +**Reference:** +GetHitModifier() \ No newline at end of file diff --git a/wiki-information/functions/GetSpellInfo.md b/wiki-information/functions/GetSpellInfo.md new file mode 100644 index 00000000..86be9938 --- /dev/null +++ b/wiki-information/functions/GetSpellInfo.md @@ -0,0 +1,64 @@ +## Title: GetSpellInfo + +**Content:** +Returns spell info. +```lua +name, rank, icon, castTime, minRange, maxRange, spellID, originalIcon = GetSpellInfo(spell) +name, rank, icon, castTime, minRange, maxRange, spellID, originalIcon = GetSpellInfo(index, bookType) +``` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Returns:** +- `name` + - *string* - The localized name of the spell. +- `rank` + - *string* - Always returns nil. Refer to GetSpellSubtext() for retrieving the rank of spells on Classic. +- `icon` + - *number : FileID* - The spell icon texture. +- `castTime` + - *number* - Cast time in milliseconds, or 0 for instant spells. +- `minRange` + - *number* - Minimum range of the spell, or 0 if not applicable. +- `maxRange` + - *number* - Maximum range of the spell, or 0 if not applicable. +- `spellID` + - *number* - The ID of the spell. +- `originalIcon` + - *number : FileID* - The original icon texture for this spell. + +**Description:** +The player's form or stance may affect return values on relevant spells, such as a warlock's Corruption spell transforming to Doom while Metamorphosis is active. +When dealing with base spells that have been overridden by another spell, the icon return will represent the icon of the overriding spell, and originalIcon the icon of the base spell. +For example, if a Rogue has learned Gloomblade, then any queries for Backstab will yield Gloomblade's icon as the icon return, and the original icon for Backstab would be exposed through the originalIcon return value. + +**Usage:** +```lua +/dump GetSpellInfo(2061) -- "Flash Heal", nil, 135907, 1352, 0, 40, 2061 +``` +Some spell data - such as subtext and description - are load on demand. You can use `SpellMixin:ContinueOnSpellLoad()` to asynchronously query the data. +```lua +local spell = Spell:CreateFromSpellID(139) +spell:ContinueOnSpellLoad(function() + local name = spell:GetSpellName() + local desc = spell:GetSpellDescription() + print(name, desc) -- "Renew", "Fill the target with faith in the light, healing for 295 over 15 sec." +end) +``` + +**Reference:** +Battle for Azeroth Addon Changes by Ythisens, 24 Apr 2018 \ No newline at end of file diff --git a/wiki-information/functions/GetSpellLink.md b/wiki-information/functions/GetSpellLink.md new file mode 100644 index 00000000..582abd5d --- /dev/null +++ b/wiki-information/functions/GetSpellLink.md @@ -0,0 +1,45 @@ +## Title: GetSpellLink + +**Content:** +Returns the hyperlink for a spell. +`link, spellId = GetSpellLink(spell)` +`link, spellId = GetSpellLink(index, bookType)` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Returns:** +- `link` + - *string* : spellLink +- `spellID` + - *number* + +**Usage:** +- Prints a clickable spell link, for Flash Heal. + ```lua + /run print(GetSpellLink(2061)) + ``` +- Dumps an (escaped) spell link. + ```lua + /dump GetSpellLink(2061) + -- "|cff71d5ff|Hspell:2061:0|h|h|r", 2061 + ``` +- Dumps the first spell from your spell book. + ```lua + /dump GetSpellLink(1, BOOKTYPE_SPELL) + -- "|cff71d5ff|Hspell:6603:0|h|h|r", 6603 + ``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellLossOfControlCooldown.md b/wiki-information/functions/GetSpellLossOfControlCooldown.md new file mode 100644 index 00000000..50d950e1 --- /dev/null +++ b/wiki-information/functions/GetSpellLossOfControlCooldown.md @@ -0,0 +1,29 @@ +## Title: GetSpellLossOfControlCooldown + +**Content:** +Returns information about a loss-of-control cooldown affecting a spell. +`start, duration = GetSpellLossOfControlCooldown(spellSlot or spellName or spellID)` + +**Parameters:** +- `spellSlot` + - *number* - spell book slot index, ascending from 1. +- `bookType` + - *string* - spell book type token, e.g. "spell" from player's spell book. +- or +- `spellName` + - *string* - name of a spell in the player's spell book. +- or +- `spellID` + - *number* - spell ID of a spell accessible to the player. + +**Returns:** +- `start` + - *number* - time at which the loss-of-control cooldown began, per GetTime. +- `duration` + - *number* - duration of the loss-of-control cooldown in seconds; 0 if the spell is not currently affected by a loss-of-control cooldown. + +**Description:** +If the spell is not affected by a loss-of-control cooldown, this function returns 0, 0. + +**Reference:** +GetActionLossOfControlCooldown \ No newline at end of file diff --git a/wiki-information/functions/GetSpellPenetration.md b/wiki-information/functions/GetSpellPenetration.md new file mode 100644 index 00000000..8168110a --- /dev/null +++ b/wiki-information/functions/GetSpellPenetration.md @@ -0,0 +1,9 @@ +## Title: GetSpellPenetration + +**Content:** +Returns your spell penetration rating. +`spellPen = GetSpellPenetration()` + +**Returns:** +- `spellPen` + - *number* - Your spell penetration rating. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellPowerCost.md b/wiki-information/functions/GetSpellPowerCost.md new file mode 100644 index 00000000..fc1c5fa1 --- /dev/null +++ b/wiki-information/functions/GetSpellPowerCost.md @@ -0,0 +1,58 @@ +## Title: GetSpellPowerCost + +**Content:** +Returns resource cost info for a spell. +`costs = GetSpellPowerCost(spell)` +`costs = GetSpellPowerCost(index, bookType)` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Returns:** +- `costs` + - *table* + - **Field** + - **Type** + - **Description** + - `minCost` + - *number* - minimum cost + - `cost` + - *number* - maximum cost + - `costPercent` + - *number* - percentual cost + - `costPerSec` + - *number* - The cost per second for channeled spells. + - `type` + - *Enum.PowerType* - Enum.PowerType + - `name` + - *string* - powerToken: "MANA", "RAGE", "FOCUS", "ENERGY", "HAPPINESS", "RUNES", "RUNIC_POWER", "SOUL_SHARDS", "HOLY_POWER", "STAGGER", "CHI", "FURY", "PAIN", "LUNAR_POWER", "INSANITY" + - `hasRequiredAura` + - *boolean* + - `requiredAuraID` + - *number* + +**Description:** +Returns an empty table if the spell has no resource cost. +Reflects resource discounts provided by auras. +`requiredAuraID` has a return value different than zero for 36 spells. Most are spellIDs associated with a hidden healing/damage modifier spec aura, one refers to , two seem to be connected to Helya; some are honor talents, and some don't refer to a valid aura spellID. This return value mostly exists for spells that change their cost depending on which spec the player is in. +Some spells may have costs composed of multiple resource types. In this case, the costs array contains multiple tables. For example, `GetSpellPowerCost("Rip")` returns: +```lua +{ + {type=3, name="ENERGY", cost=30, minCost=30, costPercent=0, costPerSec=0, hasRequiredAura=false, requiredAuraID=0}, + {type=4, name="COMBO_POINTS", cost=5, minCost=1, costPercent=0, costPerSec=0, hasRequiredAura=false, requiredAuraID=0} +} +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellTabInfo.md b/wiki-information/functions/GetSpellTabInfo.md new file mode 100644 index 00000000..fec54e05 --- /dev/null +++ b/wiki-information/functions/GetSpellTabInfo.md @@ -0,0 +1,74 @@ +## Title: GetSpellTabInfo + +**Content:** +Returns info for the specified spellbook tab. +`name, texture, offset, numSlots, isGuild, offspecID = GetSpellTabInfo(tabIndex)` + +**Parameters:** +- `tabIndex` + - *number* - The index of the tab, ascending from 1. + +**Returns:** +- `name` + - *string* - The name of the spell line (General, Shadow, Fury, etc.) +- `texture` + - *string* - The texture path for the spell line's icon +- `offset` + - *number* - Number of spell book entries before this tab (one less than index of the first spell book item in this tab) +- `numSlots` + - *number* - The number of spell entries in this tab. +- `isGuild` + - *boolean* - true for Guild Perks, false otherwise +- `offspecID` + - *number* - 0 if the tab contains spells you can cast (general/specialization/trade skill/etc); or specialization ID of the specialization this tab is showing the spells of. + +**Description:** +GetNumSpellTabs returns the number of class-skill tabs available to your character. +Due to flyouts, more spellbook item indices may be used by a tab than suggested by the offset/numEntries values. +Professions are tabs, too: GetProfessions returns tab indices that contain profession spells, beyond the range specified by GetNumSpellTabs. + +**Usage:** +Prints all spells in the spellbook for the player, except the profession tab ones. +```lua +for i = 1, GetNumSpellTabs() do + local offset, numSlots = select(3, GetSpellTabInfo(i)) + for j = offset+1, offset+numSlots do + print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) + end +end +``` + +Prints the spells shown in the profession tab. +```lua +for _, i in pairs{GetProfessions()} do + local offset, numSlots = select(3, GetSpellTabInfo(i)) + for j = offset+1, offset+numSlots do + print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) + end +end +-- Example output: +-- 7, 126, "Tailoring", "", 3908 +-- 8, 128, "Engineering", "", 4036 +-- 6, 122, "Cooking", "", 2550 +-- 6, 123, "Cooking Fire", "", 81 +``` + +Prints the spells shown in the pet tab. +```lua +local numSpells, petToken = HasPetSpells() -- nil if pet does not have spellbook, 'petToken' will usually be 'PET' +for i=1, numSpells do + local petSpellName, petSubType, unmaskedSpellId = GetSpellBookItemName(i,"pet") + print("petSpellName", petSpellName) -- like "Dash" + print("petSubType", petSubType) -- like "Basic Ability" or "Pet Stance" + print("unmaskedId", unmaskedSpellId) -- don't have to apply the 0xFFFFFF mask like you do for GetSpellBookItemInfo +end +``` + +Note that not all spells available from the API are shown in the spellbook. +```lua +local i = 1 +while GetSpellBookItemName(i, BOOKTYPE_SPELL) do + print(i, GetSpellBookItemName(i, BOOKTYPE_SPELL)) + i = i + 1 +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellTexture.md b/wiki-information/functions/GetSpellTexture.md new file mode 100644 index 00000000..37a1611c --- /dev/null +++ b/wiki-information/functions/GetSpellTexture.md @@ -0,0 +1,31 @@ +## Title: GetSpellTexture + +**Content:** +Returns the icon texture of a spell. +```lua +icon = GetSpellTexture(spell) +icon = GetSpellTexture(index, bookType) +``` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - `"spell"` - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - `"pet"` - The Pet tab + +**Returns:** +- `icon` + - *number (fileID)* - icon texture used by the spell. + +**Reference:** +- `GetSpellBookItemTexture` \ No newline at end of file diff --git a/wiki-information/functions/GetStablePetFoodTypes.md b/wiki-information/functions/GetStablePetFoodTypes.md new file mode 100644 index 00000000..9d949eff --- /dev/null +++ b/wiki-information/functions/GetStablePetFoodTypes.md @@ -0,0 +1,22 @@ +## Title: GetStablePetFoodTypes + +**Content:** +Returns the food types the specified stabled pet can eat. +```lua +local PetFoodList = { GetStablePetFoodTypes(index) } +``` + +**Parameters:** +- `index` + - *number* - The stable slot index of the pet: 0 for the current pet, 1 for the pet in the left slot, and 2 for the pet in the right slot. + +**Returns:** +A list of the pet food type names, see `GetPetFoodTypes()`. + +Possible Food Type Names: +- Meat +- Fish +- Fruit +- Fungus +- Bread +- Cheese \ No newline at end of file diff --git a/wiki-information/functions/GetStablePetInfo.md b/wiki-information/functions/GetStablePetInfo.md new file mode 100644 index 00000000..984af7b1 --- /dev/null +++ b/wiki-information/functions/GetStablePetInfo.md @@ -0,0 +1,21 @@ +## Title: GetStablePetInfo + +**Content:** +Returns info for a specific stabled pet. +`petIcon, petName, petLevel, petType, petTalents = GetStablePetInfo(index)` + +**Parameters:** +- `index` + - *number* - The index of the pet slot, 1 through 5 are the hunter's active pets, 6 through 25 are the hunter's stabled pets. + +**Returns:** +- `petIcon` + - *string* - The path to texture to use as the icon for the pet, see `GetPetIcon()`. +- `petName` + - *string* - The pet name, see `UnitName()`. +- `petLevel` + - *number* - The pet level, see `UnitLevel()`. +- `petType` + - *string* - The localized pet family, see `UnitCreatureFamily()`. +- `petTalents` + - *string* - The pet's talent group. \ No newline at end of file diff --git a/wiki-information/functions/GetStatistic.md b/wiki-information/functions/GetStatistic.md new file mode 100644 index 00000000..38f5724a --- /dev/null +++ b/wiki-information/functions/GetStatistic.md @@ -0,0 +1,42 @@ +## Title: GetStatistic + +**Content:** +Returns a character statistic. +`value, skip, id = GetStatistic(category)` + +**Parameters:** +- `category` + - *number* - AchievementID of a statistic or statistic category. +- `index` + - *number* - Entry within a statistic category, if applicable. + +**Returns:** +- `value` + - *string* - Value of the statistic as displayed in-game. +- `skip` + - *boolean* - Prevents a statistic from being shown in the default UI. +- `id` + - *string* - Unknown. + +**Description:** +Using the achievementID's of actual Achievements, as opposed to statistics, generates strange results. More testing is needed. +Wrapping the returned value with `tonumber()` is necessary to do comparisons using math operators. + +**Usage:** +Here is a function that will take any statistic title (like Battlegrounds played) and will return the statistic ID for that statistic, so it can be used in other functions. +```lua +function GetStatisticId(StatisticTitle) + for _, CategoryId in pairs(GetStatisticsCategoryList()) do + for i = 1, GetCategoryNumAchievements(CategoryId) do + local IDNumber, Name = GetAchievementInfo(CategoryId, i) + if Name == StatisticTitle then + return IDNumber + end + end + end + return -1 +end +``` + +**Reference:** +- 2013-09-09, Blizzard_AchievementUI.lua, version 5.4.0.17359, near line 1957, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/GetStatisticsCategoryList.md b/wiki-information/functions/GetStatisticsCategoryList.md new file mode 100644 index 00000000..db9c7d06 --- /dev/null +++ b/wiki-information/functions/GetStatisticsCategoryList.md @@ -0,0 +1,19 @@ +## Title: GetStatisticsCategoryList + +**Content:** +Returns the list of statistic categories. +`categories = GetStatisticsCategoryList()` + +**Returns:** +- `categories` + - *table* - list of all the categories + +**Usage:** +The snippet below prints info about the category IDs. +```lua +local categories = GetStatisticsCategoryList() +for i, id in next(categories) do + local key, parent = GetCategoryInfo(id) + print("The key %d has the parent %d", key, parent) +end +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSubZoneText.md b/wiki-information/functions/GetSubZoneText.md new file mode 100644 index 00000000..71bebfa2 --- /dev/null +++ b/wiki-information/functions/GetSubZoneText.md @@ -0,0 +1,19 @@ +## Title: GetSubZoneText + +**Content:** +Returns the subzone name. +`subzone = GetSubZoneText()` + +**Returns:** +- `subzone` + - *string* - Subzone name or an empty string (if not in a subzone). + +**Usage:** +Returns the subzone name where the player is currently located. If not in a subzone, it returns an empty string. +```lua +/run print("Current SubZone: " .. GetSubZoneText()) +``` + +**Description:** +Related Events +- `ZONE_CHANGED_INDOORS` \ No newline at end of file diff --git a/wiki-information/functions/GetSuggestedGroupNum.md b/wiki-information/functions/GetSuggestedGroupNum.md new file mode 100644 index 00000000..026443af --- /dev/null +++ b/wiki-information/functions/GetSuggestedGroupNum.md @@ -0,0 +1,13 @@ +## Title: C_QuestLog.GetSuggestedGroupSize + +**Content:** +Returns the suggested number of players for a quest. +`suggestedGroupSize = C_QuestLog.GetSuggestedGroupSize(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `suggestedGroupSize` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetSummonFriendCooldown.md b/wiki-information/functions/GetSummonFriendCooldown.md new file mode 100644 index 00000000..ab75b416 --- /dev/null +++ b/wiki-information/functions/GetSummonFriendCooldown.md @@ -0,0 +1,19 @@ +## Title: GetSummonFriendCooldown + +**Content:** +Returns the cooldown info of the RaF Summon Friend ability. +`start, duration = GetSummonFriendCooldown()` + +**Returns:** +- `start` + - *number* - The value of `GetTime()` at the moment the cooldown began, 0 if the ability is ready +- `duration` + - *number* - The length of the cooldown in seconds, 0 if the ability is ready + +**Usage:** +The snippet below prints the remaining time of the cooldown in seconds. +```lua +local start, duration = GetSummonFriendCooldown() +local timeleft = start + duration - GetTime() +print(timeleft) +``` \ No newline at end of file diff --git a/wiki-information/functions/GetSuperTrackedQuestID.md b/wiki-information/functions/GetSuperTrackedQuestID.md new file mode 100644 index 00000000..32946f55 --- /dev/null +++ b/wiki-information/functions/GetSuperTrackedQuestID.md @@ -0,0 +1,9 @@ +## Title: C_SuperTrack.GetSuperTrackedQuestID + +**Content:** +Returns the quest ID currently being tracked, if set. Replaces `GetSuperTrackedQuestID`. +`questID = C_SuperTrack.GetSuperTrackedQuestID()` + +**Returns:** +- `questID` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetTalentGroupRole.md b/wiki-information/functions/GetTalentGroupRole.md new file mode 100644 index 00000000..9afd3cfc --- /dev/null +++ b/wiki-information/functions/GetTalentGroupRole.md @@ -0,0 +1,19 @@ +## Title: GetTalentGroupRole + +**Content:** +Returns the currently selected role for a player talent group (primary or secondary). +`role = GetTalentGroupRole(groupIndex)` + +**Parameters:** +- `groupIndex` + - *number* - Ranging from 1 to 2 (primary/secondary talent group). To get the current one use `GetActiveTalentGroup()` + +**Returns:** +- `role` + - *string* - Can be `DAMAGER`, `TANK`, or `HEALER` + +**Example Usage:** +This function can be used to determine the role of a player in a specific talent group, which can be useful for addons that manage group compositions or provide role-specific information. + +**Addons:** +Large addons like "ElvUI" and "DBM (Deadly Boss Mods)" use this function to adjust their settings and alerts based on the player's role in a specific talent group. For example, DBM might change its warnings and alerts depending on whether the player is a tank, healer, or damage dealer. \ No newline at end of file diff --git a/wiki-information/functions/GetTalentInfo.md b/wiki-information/functions/GetTalentInfo.md new file mode 100644 index 00000000..9ca739db --- /dev/null +++ b/wiki-information/functions/GetTalentInfo.md @@ -0,0 +1,72 @@ +## Title: GetTalentInfo + +**Content:** +For the Dragonflight version, see Dragonflight Talent System. +For the Wrath version, see API GetTalentInfo/Wrath. +For the WoW Classic version, see API GetTalentInfo/Classic. +Returns info for the specified talent. +```lua +talentID, name, texture, selected, available, spellID, unknown, row, column, known, grantedByAura = GetTalentInfo(tier, column, specGroupIndex) +talentID, name, texture, selected, available, spellID, unknown, row, column, known, grantedByAura = GetTalentInfoByID(talentID, specGroupIndex) +talentID, name, texture, selected, available, spellID, unknown, row, column, known, grantedByAura = GetTalentInfoBySpecialization(specIndex, tier, column) +``` + +**Parameters:** + +*GetTalentInfo:* +- `tier` + - *number* - Talent tier from 1 to MAX_TALENT_TIERS +- `column` + - *number* - Talent column from 1 to NUM_TALENT_COLUMNS +- `specGroupIndex` + - *number* - Index of active specialization group (GetActiveSpecGroup) +- `isInspect` + - *boolean?* - If non-nil, returns information based on inspectedUnit/classId. +- `inspectUnit` + - *string? : UnitId* - Inspected unit; if nil, the selected/available return values will always be false. + +*GetTalentInfoByID:* +- `talentID` + - *number* - Talent ID. +- `specGroupIndex` + - *number* +- `isInspect` + - *boolean?* +- `inspectUnit` + - *string? : UnitId* + +*GetTalentInfoBySpecialization:* +- `specIndex` + - *number* - Index of the specialization, ascending from 1 to GetNumSpecializations(). +- `tier` + - *number* +- `column` + - *number* + +**Returns:** +1. `talentID` + - *number* - Talent ID. +2. `name` + - *string* - Talent name. +3. `texture` + - *number : FileID* +4. `selected` + - *boolean* - true if the talent is chosen, false otherwise. +5. `available` + - *boolean* - true if the talent tier is chosen, or if it is level-appropriate for the player and the player has no talents selected in that tier, false otherwise. +6. `spellID` + - *number* - Spell ID that is added to the spellbook. +7. `unknown` + - *any* +8. `row` + - *number* - The row the talent is from. This will be the same as the tier argument given. +9. `column` + - *number* - The column the talent is from. This will be the same as the column argument given. +10. `known` + - *boolean* - true if the talent is active, false otherwise. +11. `grantedByAura` + - *boolean* - true if the talent is granted by an aura (i.e., an effect on an item), false otherwise. Legion's Class Soul rings used this rather than selected. + +**Reference:** +- `IsPlayerSpell` +- `IsSpellKnown` \ No newline at end of file diff --git a/wiki-information/functions/GetTalentPrereqs.md b/wiki-information/functions/GetTalentPrereqs.md new file mode 100644 index 00000000..6663e199 --- /dev/null +++ b/wiki-information/functions/GetTalentPrereqs.md @@ -0,0 +1,29 @@ +## Title: GetTalentPrereqs + +**Content:** +Returns the tier and column of a talent's prerequisite, and if the talent is learnable. +`tier, column, isLearnable = GetTalentPrereqs(tabIndex, talentIndex [, isInspect, isPet, talentGroup])` + +**Parameters:** +- `tabIndex` + - *number* - Ranging from 1 to `GetNumTalentTabs()` +- `talentIndex` + - *number* - Ranging from 1 to `GetNumTalents(tabIndex)` +- `isInspect` + - *boolean?* - Whether the talent is for the currently inspected player. +- `isPet` + - *boolean?* +- `talentGroup` + - *number?* - Probably the dual spec group index. + +**Returns:** +- `tier` + - *number* - The row/tier that the prerequisite talent sits on. +- `column` + - *number* - The column that the prerequisite talent sits on. +- `isLearnable` + - *number* - Returns 1 if you have learned the prerequisite talents, nil otherwise. + +**Description:** +The `talentIndex` is counted as if it were a tree, meaning that the leftmost talent in the topmost row is number 1 followed by the one immediately to the right as number 2. If there are no more talents to the right, then it continues from the leftmost talent on the next row. +If you check a talent with no prerequisites, the function returns nil. \ No newline at end of file diff --git a/wiki-information/functions/GetTalentTabInfo.md b/wiki-information/functions/GetTalentTabInfo.md new file mode 100644 index 00000000..a9a7daae --- /dev/null +++ b/wiki-information/functions/GetTalentTabInfo.md @@ -0,0 +1,31 @@ +## Title: GetTalentTabInfo + +**Content:** +Returns information for a talent tab (tree). +`name, texture, pointsSpent, fileName = GetTalentTabInfo(index)` + +**Parameters:** +- `index` + - *number* - Ranging from 1 to `GetNumTalentTabs()` +- `isInspect` + - *boolean?* - Optional, will return talent tab info for the current inspect target if true (see `NotifyInspect`). +- `isPet` + - *boolean?* - Optional, will return talent tab info for the players' pet if true. +- `talentGroup` + - *number?* - Optional talent group to query for Dual Talent Specialization. Defaults to 1 for the primary specialization. + +**Returns:** +- `name` + - *string* +- `texture` + - *string* - This is always nil on Classic. +- `pointsSpent` + - *number* - Number of points put into the tab. +- `fileName` + - *string* - File name of the background image. + +**Usage:** +An example of how to use the `fileName` return value would be: +```lua +string.format("Interface\\TalentFrame\\%s-TopLeft", fileName) +``` \ No newline at end of file diff --git a/wiki-information/functions/GetTaxiBenchmarkMode.md b/wiki-information/functions/GetTaxiBenchmarkMode.md new file mode 100644 index 00000000..4b757694 --- /dev/null +++ b/wiki-information/functions/GetTaxiBenchmarkMode.md @@ -0,0 +1,9 @@ +## Title: GetTaxiBenchmarkMode + +**Content:** +Needs summary. +`benchMode = GetTaxiBenchmarkMode()` + +**Returns:** +- `benchMode` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GetTaxiMapID.md b/wiki-information/functions/GetTaxiMapID.md new file mode 100644 index 00000000..01a765e2 --- /dev/null +++ b/wiki-information/functions/GetTaxiMapID.md @@ -0,0 +1,9 @@ +## Title: GetTaxiMapID + +**Content:** +Returns the UIMapID for the current taxi map while the flight path window is open. +`local taxiMapID = GetTaxiMapID()` + +**Returns:** +- `taxiMapID` + - *number* - UiMapID for current taxi map. \ No newline at end of file diff --git a/wiki-information/functions/GetText.md b/wiki-information/functions/GetText.md new file mode 100644 index 00000000..efa5b2f7 --- /dev/null +++ b/wiki-information/functions/GetText.md @@ -0,0 +1,30 @@ +## Title: GetText + +**Content:** +Returns localized text depending on the specified gender. +`text = GetText(token)` + +**Parameters:** +- `token` + - *string* - Reputation index +- `gender` + - *number* - Gender ID +- `ordinal` + - *unknown* + +**Returns:** +- `text` + - *string* - The localized text + +**Usage:** +- This should return `FACTION_STANDING_LABEL1` + ```lua + /dump GetText("FACTION_STANDING_LABEL1") -- "Hated" + ``` +- This should return `FACTION_STANDING_LABEL1_FEMALE` + ```lua + /dump GetText("FACTION_STANDING_LABEL1", 3) -- "Hated" + ``` + +**Reference:** +- `getglobal` \ No newline at end of file diff --git a/wiki-information/functions/GetThreatStatusColor.md b/wiki-information/functions/GetThreatStatusColor.md new file mode 100644 index 00000000..1b7bb819 --- /dev/null +++ b/wiki-information/functions/GetThreatStatusColor.md @@ -0,0 +1,50 @@ +## Title: GetThreatStatusColor + +**Content:** +Returns the color for a threat status. +`r, g, b = GetThreatStatusColor(status)` + +**Parameters:** +- `status` + - *number* - Usually the return of `UnitThreatSituation` + +**Returns:** +- `r` + - *number* - a value between 0 and 1 for the red content of the color +- `g` + - *number* - a value between 0 and 1 for the green content of the color +- `b` + - *number* - a value between 0 and 1 for the blue content of the color + +**Description:** +Usually returns one of the following: +- 1: 1.00, 1.00, 0.47 (yellow) +- 2: 1.00, 0.60, 0.00 (orange) +- 3: 1.00, 0.00, 0.00 (red) + +Other values observed in the wild, but these situations do not occur in the default UI: +- 0: 0.69, 0.69, 0.69 (grey) +- 4 to 4294967294: 1.00, 0.00, 1.00 (magenta) +- 4294967295: 1.00, 1.00, 1.00 (white) + +**Usage:** +Prints a description of the player's threat situation to the chat frame, colored appropriately. e.g. +```lua +local statustxts = { "low on threat", "overnuking", "losing threat", "tanking securely" } +local status = UnitThreatSituation("player", "target") -- returns nil, 0, 1, 2 or 3 +if (status) then + local r, g, b = GetThreatStatusColor(status) + print(status .. ": You are " .. statustxts[status + 1] .. ".", r, g, b) +else + print("nil: You are not on their threat table.") +end +``` +Results in one of the following: +- 0: You are low on threat. +- 1: You are overnuking. +- 2: You are losing threat. +- 3: You are tanking securely. +- nil: You are not on their threat table. + +**Reference:** +[API UnitDetailedThreatSituation](https://wowpedia.fandom.com/wiki/API_UnitDetailedThreatSituation) \ No newline at end of file diff --git a/wiki-information/functions/GetTickTime.md b/wiki-information/functions/GetTickTime.md new file mode 100644 index 00000000..11445bcf --- /dev/null +++ b/wiki-information/functions/GetTickTime.md @@ -0,0 +1,13 @@ +## Title: GetTickTime + +**Content:** +Returns the time in seconds since the end of the previous frame and the start of the current frame. +`elapsed = GetTickTime()` + +**Returns:** +- `elapsed` + - *number* - The time in seconds since the last frame. + +**Description:** +Multiple calls to this function within the same frame will all return the same value. +The value returned from this function appears to be identical to the value passed to OnUpdate scripts executed at the end of the current frame as the elapsed parameter. \ No newline at end of file diff --git a/wiki-information/functions/GetTime.md b/wiki-information/functions/GetTime.md new file mode 100644 index 00000000..32d16ec9 --- /dev/null +++ b/wiki-information/functions/GetTime.md @@ -0,0 +1,19 @@ +## Title: GetTime + +**Content:** +Returns the system uptime of your computer in seconds, with millisecond precision. +`seconds = GetTime()` + +**Returns:** +- `seconds` + - *number* - The current system uptime in seconds, e.g. 60123.558 + +**Description:** +This value is only updated once per rendered frame. Finer-grained timers are available using `GetTimePreciseSec()` or `debugprofilestop()`. +It is possible for this function to return identical values across consecutive frames if a low-resolution timing method is in use while running at a high framerate. + +**Reference:** +- `time()`, `date()` +- `GetGameTime()` +- `GetTimePreciseSec()` +- `CVar timingMethod` \ No newline at end of file diff --git a/wiki-information/functions/GetTimePreciseSec.md b/wiki-information/functions/GetTimePreciseSec.md new file mode 100644 index 00000000..1c72aedc --- /dev/null +++ b/wiki-information/functions/GetTimePreciseSec.md @@ -0,0 +1,28 @@ +## Title: GetTimePreciseSec + +**Content:** +Returns a monotonic timestamp in seconds, with millisecond precision. +`seconds = GetTimePreciseSec()` + +**Returns:** +- `seconds` + - *number* - The number of seconds that have elapsed since this timer was started. + +**Description:** +The first call to this function will always return zero. Subsequent calls will return the number of seconds that have elapsed since the first call until the client is restarted. +Unlike `GetTime()`, the value returned by this function is not cached once per frame and may change on each call. + +**Usage:** +```lua +print("Start time:", GetTimePreciseSec()); +for _ = 1, 2^26 do + -- Busy loop to make some time pass. +end +print("End time:", GetTimePreciseSec()); +-- Output: +-- "Start time:", 0 +-- "End time:", 0.3624231 +``` + +**Reference:** +- `GetTime()` \ No newline at end of file diff --git a/wiki-information/functions/GetTitleName.md b/wiki-information/functions/GetTitleName.md new file mode 100644 index 00000000..b5386126 --- /dev/null +++ b/wiki-information/functions/GetTitleName.md @@ -0,0 +1,26 @@ +## Title: GetTitleName + +**Content:** +Returns the name of a player title. +`name, playerTitle = GetTitleName(titleId)` + +**Parameters:** +- `titleId` + - *number* - Ranging from 1 to GetNumTitles. Not necessarily an index as there can be missing/skipped IDs in between. + +**Returns:** +- `name` + - *string* - Name of the title. +- `playerTitle` + - *boolean* - Seems to be true for all existing titles. + +**Description:** +If the name has a trailing space, then the title is prefixed, otherwise it's suffixed. +```lua +/dump GetTitleName(2) -- "Corporal " → "Corporal Bob" (prefix) +/dump GetTitleName(36) -- "Champion of the Naaru" → "Alice, Champion of the Naaru" (suffix) +``` + +**Reference:** +- `GetCurrentTitle` +- `IsTitleKnown` \ No newline at end of file diff --git a/wiki-information/functions/GetTitleText.md b/wiki-information/functions/GetTitleText.md new file mode 100644 index 00000000..66ca19e7 --- /dev/null +++ b/wiki-information/functions/GetTitleText.md @@ -0,0 +1,12 @@ +## Title: GetTitleText + +**Content:** +Returns the name of the quest at the quest giver. +`title = GetTitleText()` + +**Returns:** +- `title` + - *string* - name of the offered quest, e.g. "Inside the Frozen Citadel". + +**Description:** +Quest title is updated when the `QUEST_DETAIL` event fires. \ No newline at end of file diff --git a/wiki-information/functions/GetTotalAchievementPoints.md b/wiki-information/functions/GetTotalAchievementPoints.md new file mode 100644 index 00000000..fb141551 --- /dev/null +++ b/wiki-information/functions/GetTotalAchievementPoints.md @@ -0,0 +1,9 @@ +## Title: GetTotalAchievementPoints + +**Content:** +Returns the total number of achievement points earned. +`points = GetTotalAchievementPoints()` + +**Returns:** +- `points` + - *number* - Total points earned \ No newline at end of file diff --git a/wiki-information/functions/GetTotemCannotDismiss.md b/wiki-information/functions/GetTotemCannotDismiss.md new file mode 100644 index 00000000..781db8bf --- /dev/null +++ b/wiki-information/functions/GetTotemCannotDismiss.md @@ -0,0 +1,13 @@ +## Title: GetTotemCannotDismiss + +**Content:** +Needs summary. +`cannotDismiss = GetTotemCannotDismiss(slot)` + +**Parameters:** +- `slot` + - *number* + +**Returns:** +- `cannotDismiss` + - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/GetTotemTimeLeft.md b/wiki-information/functions/GetTotemTimeLeft.md new file mode 100644 index 00000000..4cc80e64 --- /dev/null +++ b/wiki-information/functions/GetTotemTimeLeft.md @@ -0,0 +1,24 @@ +## Title: GetTotemTimeLeft + +**Content:** +Returns active time remaining (in seconds) before a totem (or ghoul) disappears. +`seconds = GetTotemTimeLeft(slot)` + +**Parameters:** +- `slot` + - *number* - Which totem to query: + - 1 - Fire (or Death Knight's ghoul) + - 2 - Earth + - 3 - Water + - 4 - Air + +**Returns:** +- `seconds` + - *number* - Time remaining before the totem/ghoul is automatically destroyed + +**Description:** +Totem functions are also used for ghouls summoned by a Death Knight (if the ghoul is not made a controllable pet by Raise Dead rank 2). + +**Reference:** +- `GetTime` +- `GetTotemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetTrackedAchievements.md b/wiki-information/functions/GetTrackedAchievements.md new file mode 100644 index 00000000..5b03c78a --- /dev/null +++ b/wiki-information/functions/GetTrackedAchievements.md @@ -0,0 +1,17 @@ +## Title: GetTrackedAchievements + +**Content:** +Returns the currently tracked achievements. +`id1, id2, ..., idn = GetTrackedAchievements()` + +**Returns:** +- `id1, id2, ..., idn` + - *number* - achievementId(s) of achievements you are currently tracking. + +**Description:** +Returns up to 10 tracked achievements. + +**Reference:** +- `AddTrackedAchievement` +- `GetNumTrackedAchievements` +- `RemoveTrackedAchievement` \ No newline at end of file diff --git a/wiki-information/functions/GetTrackingInfo.md b/wiki-information/functions/GetTrackingInfo.md new file mode 100644 index 00000000..b7777c14 --- /dev/null +++ b/wiki-information/functions/GetTrackingInfo.md @@ -0,0 +1,40 @@ +## Title: GetTrackingInfo + +**Content:** +Returns tracking info by index. +`name, texture, active, category, nested = GetTrackingInfo(id)` + +**Parameters:** +- `id` + - *number* - tracking type index, ascending from 1 to `GetNumTrackingTypes()`. + +**Returns:** +- `name` + - *string* - Track name. +- `texture` + - *number* - fileID for the Track texture. +- `active` + - *boolean* - If the track is active, it will return 1 but otherwise nil. +- `category` + - *string* - Track category, returns "spell" if the tracking method is a spell in the spellbook or "other" if it's a static tracking method. +- `nested` + - *number* - Nesting level, returns -1 for items at the root level, TOWNSFOLK for items in the Townsfolk dropdown, and HUNTER_TRACKING for Hunter tracking spells. + +**Usage:** +Gathers information for the first option on the tracking list and lists it in the default chatframe: +```lua +local name, texture, active, category = GetTrackingInfo(1); +DEFAULT_CHAT_FRAME:AddMessage(name.." ("..category..")"); +``` + +Lists all tracking methods, name and category in the default chatframe: +```lua +local count = GetNumTrackingTypes(); +for i=1,count do + local name, texture, active, category = GetTrackingInfo(i); + DEFAULT_CHAT_FRAME:AddMessage(name.." ("..category..")"); +end +``` + +**Description:** +If the player has tracking spells, those will only be accessible to this function after the player's spellbook has been loaded from the server: consider waiting for `PLAYER_LOGIN` before querying. \ No newline at end of file diff --git a/wiki-information/functions/GetTrackingTexture.md b/wiki-information/functions/GetTrackingTexture.md new file mode 100644 index 00000000..db949d44 --- /dev/null +++ b/wiki-information/functions/GetTrackingTexture.md @@ -0,0 +1,9 @@ +## Title: GetTrackingTexture + +**Content:** +Returns the texture of the active tracking buff. +`icon = GetTrackingTexture()` + +**Returns:** +- `icon` + - *number : FileID* - The texture of the active tracking buff, or nil if none. \ No newline at end of file diff --git a/wiki-information/functions/GetTradePlayerItemInfo.md b/wiki-information/functions/GetTradePlayerItemInfo.md new file mode 100644 index 00000000..c86a8308 --- /dev/null +++ b/wiki-information/functions/GetTradePlayerItemInfo.md @@ -0,0 +1,23 @@ +## Title: GetTradePlayerItemInfo + +**Content:** +Returns information about a trade item. +`name, texture, numItems, quality, enchantment, canLoseTransmog = GetTradePlayerItemInfo(id)` + +**Parameters:** +- `id` + - *number* - The trade slot index to query. + +**Returns:** +- `name` + - *string* - The name of the item. +- `texture` + - *number : FileDataID* - The icon associated with the item. +- `numItems` + - *number* - For stackable items, the number of items in the stack. +- `quality` + - *Enum.ItemQuality* - The quality of the item. +- `enchantment` + - *string* - The name of any applied enchantment. +- `canLoseTransmog` + - *boolean* - true if trading this item will cause the player to lose the ability to transmogrify its appearance. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillDescription.md b/wiki-information/functions/GetTradeSkillDescription.md new file mode 100644 index 00000000..20c7d710 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillDescription.md @@ -0,0 +1,13 @@ +## Title: GetTradeSkillDescription + +**Content:** +Returns the description for a recipe. +`description = GetTradeSkillDescription(index)` + +**Parameters:** +- `recipeID` + - *number* + +**Returns:** +- `description` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillInfo.md b/wiki-information/functions/GetTradeSkillInfo.md new file mode 100644 index 00000000..bd3206ad --- /dev/null +++ b/wiki-information/functions/GetTradeSkillInfo.md @@ -0,0 +1,49 @@ +## Title: GetTradeSkillInfo + +**Content:** +Retrieves information about a specific trade skill. +`skillName, skillType, numAvailable, isExpanded, altVerb, numSkillUps, indentLevel, showProgressBar, currentRank, maxRank, startingRank = GetTradeSkillInfo(skillIndex)` + +**Parameters:** +- `skillIndex` + - *number* - The id of the skill you want to query. + +**Returns:** +- `skillName` + - *string* - The name of the skill, e.g. "Copper Breastplate" or "Daggers", if the skillIndex references a heading. +- `skillType` + - *string* - "header", if the skillIndex references a heading; "subheader", if the skillIndex references a subheader for things like the cooking specialties; or a string indicating the difficulty to craft the item ("trivial", "easy", "medium", "optimal", "difficult"). +- `numAvailable` + - *number* - The number of items the player can craft with their available trade goods. +- `isExpanded` + - *boolean* - Returns if the header of the skillIndex is expanded in the crafting window or not. +- `altVerb` + - *string* - If not nil, a verb other than "Create" which describes the trade skill action (i.e., for Enchanting, this returns "Enchant"). If nil, the expected verb is "Create." +- `numSkillUps` + - *number* - The number of skill ups that the player can receive by crafting this item. +- `indentLevel` + - *number* - 0 or 1, indicates whether this skill should be indented beneath its header. Used for specialty subheaders and their recipes. +- `showProgressBar` + - *boolean* - Indicates if a sub-progress bar must be displayed with the specialty current and max ranks. In the normal UI, those values are only shown when the mouse is over the sub-header. +- `currentRank` + - *number* - The current rank for the specialty if `showProgressBar` is true. +- `maxRank` + - *number* - The maximum rank for the specialty if `showProgressBar` is true. +- `startingRank` + - *number* - The starting rank where the specialty is available. It is used as the starting value of the progress bar. + +**Usage:** +```lua +local name, type; +for i = 1, GetNumTradeSkills() do + name, type, _, _, _, _ = GetTradeSkillInfo(i); + if (name and type ~= "header") then + DEFAULT_CHAT_FRAME:AddMessage("Found: " .. name); + end +end +``` + +**Miscellaneous:** +Result: + +Displays all items the player is able to craft in the chat windows. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillInvSlotFilter.md b/wiki-information/functions/GetTradeSkillInvSlotFilter.md new file mode 100644 index 00000000..8065b472 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillInvSlotFilter.md @@ -0,0 +1,11 @@ +## Title: GetTradeSkillInvSlotFilter + +**Content:** +`isVisible = GetTradeSkillInvSlotFilter(slotIndex)` + +**Return values:** +- `isVisible` + - Whether the slot for `slotIndex` is visible (1) or not (nil). + +**Reference:** +- `SetTradeSkillInvSlotFilter` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillItemLink.md b/wiki-information/functions/GetTradeSkillItemLink.md new file mode 100644 index 00000000..91433475 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillItemLink.md @@ -0,0 +1,27 @@ +## Title: GetTradeSkillItemLink + +**Content:** +Gets the link string for a trade skill item. +`link = GetTradeSkillItemLink(skillId)` + +**Parameters:** +- `skillId` + - *number* - The Id specifying which trade skill's link to get. Trade Skill window must be open for this to work. Indexes start at 1 which is the general category of the tradeskill, if you have selected a sub-group of trade skills then 1 will be the name of that sub-group. + +**Example:** +Trade Blacksmithing: (window is open, all categories shown) +- **Index** | **Name** +- 1 | Daggers +- 2 | Heatseeker +- 3 | One-handed Swords +- 4 | Frostguard + +Trade Blacksmithing: (window is open, only trade items are shown) +- **Index** | **Name** +- 1 | Trade Items +- 2 | Elemental Sharpening Stone +- 3 | Thorium Shield Spike + +**Returns:** +- `link` + - *string* - An item link string (color coded with href) which can be included in chat messages to represent the item which the trade skill creates. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillItemStats.md b/wiki-information/functions/GetTradeSkillItemStats.md new file mode 100644 index 00000000..f840768b --- /dev/null +++ b/wiki-information/functions/GetTradeSkillItemStats.md @@ -0,0 +1,47 @@ +## Title: GetTradeSkillItemStats + +**Content:** +Gets the link string for a trade skill item. +`itemStats = GetTradeSkillItemStats(skillId)` + +**Parameters:** +- `(index)` + - `index` + - *number* - The row of the tradeskill listbox containing the item. The indices include the category headers. The tradeskill window doesn't have to be open, but the tradeskill and indices reflect the last state of the tradeskill window. The indices change if you expand or collapse headings (i.e. they exactly reflect the line number of the item as it is currently displayed in the tradeskill window). + +**Example:** +Trade Blacksmithing: (window is open, all categories shown) +- `Index` | `Name` +- `1` | `- Daggers` +- `2` | `Deadly Bronze Poniard` +- `3` | `Pearl-handled Dagger` +- `4` | `Big Bronze Knife` +- `5` | `- One-Handed Axes` + +Trade Blacksmithing: (window is open, only trade items are shown) +- `Index` | `Name` +- `1` | `- Trade Items` +- `2` | `Elemental Sharpening Stone` +- `3` | `Thorium Shield Spike` + +**Returns:** +- `itemStats` + - *table of string* + +**Usage:** +```lua +itemStats = {GetTradeSkillItemStats(2)} -- Get item stats for Deadly Bronze Poniard (see above) +itemStats = {GetTradeSkillItemStats(2)} -- Get item stats for Deadly Bronze Poniard (see above) +``` + +**Miscellaneous:** +**Result:** +```lua +itemStats = { "Uncommon", "Binds when equipped", "One-Hand", "|cffff2020Dagger|r", "16 - 30 Damage", "Speed 18", "+4 Strength", "Level 25", "Requires Level 20" } +``` + +**Notes and Caveats:** +The curly braces around the function call are critical, if you forget those your result will be: +```lua +itemStats = "Uncommon" +``` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillLine.md b/wiki-information/functions/GetTradeSkillLine.md new file mode 100644 index 00000000..3a2d2ed3 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillLine.md @@ -0,0 +1,19 @@ +## Title: GetTradeSkillLine + +**Content:** +Returns information about the current tradeskill. +`tradeskillName, currentLevel, maxLevel, skillLineModifier = GetTradeSkillLine()` + +**Returns:** +- `tradeskillName` + - *string* - Name of the current tradeskill +- `currentLevel` + - *number* - Current skill level in the current tradeskill +- `maxLevel` + - *number* - Current maximum skill level for the current tradeskill (based on Journeyman, Expert etc.) +- `skillLineModifier` + - *number* - Skill modifier from racial abilities etc. + +**Description:** +This function returns information about the current tradeskill, which is the one currently visible in the Trade Skill frame. If the Trade Skill frame isn't open then 'UNKNOWN' is returned for 'tradeSkillName' and zero for all other values. +Based on use of the function in Blizzard's code, 'tradeSkillName' appears to be a localized name for the tradeskill. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillListLink.md b/wiki-information/functions/GetTradeSkillListLink.md new file mode 100644 index 00000000..a683525d --- /dev/null +++ b/wiki-information/functions/GetTradeSkillListLink.md @@ -0,0 +1,9 @@ +## Title: GetTradeSkillListLink + +**Content:** +Returns the hyperlink for the currently opened tradeskill. +`link = GetTradeSkillListLink()` + +**Returns:** +- `link` + - *string?* : tradeLink \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillNumMade.md b/wiki-information/functions/GetTradeSkillNumMade.md new file mode 100644 index 00000000..e6fc66c5 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillNumMade.md @@ -0,0 +1,15 @@ +## Title: GetTradeSkillNumMade + +**Content:** +Get the number of items made in each use of a tradeskill. +`minMade, maxMade = GetTradeSkillNumMade(skillId)` + +**Parameters:** +- `skillId` + - *number* - Which tradeskill to query. + +**Returns:** +- `minMade` + - *number* - The minimum number of items that will be made. +- `maxMade` + - *number* - The maximum number of items that will be made. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillNumReagents.md b/wiki-information/functions/GetTradeSkillNumReagents.md new file mode 100644 index 00000000..8dd67085 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillNumReagents.md @@ -0,0 +1,31 @@ +## Title: GetTradeSkillNumReagents + +**Content:** +Returns the number of distinct reagents required by the specified recipe. +`numReagents = GetTradeSkillNumReagents(tradeSkillRecipeId)` + +**Parameters:** +- `tradeSkillRecipeId` + - *number* - The id of the trade skill recipe. + +**Returns:** +- `reagentCount` + - *number* - The number of distinct reagents required to create the item. + +**Usage:** +```lua +local numReagents = GetTradeSkillNumReagents(id); +local totalReagents = 0; +for i = 1, numReagents, 1 do + local reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(id, i); + totalReagents = totalReagents + reagentCount; +end; +``` + +**Miscellaneous:** +Result: +Calculates the total number of items required by the recipe. + +**Description:** +If a recipe calls for 2 copper tubes, 1 malachite, and 2 blasting powders, `GetTradeSkillNumReagents` would return 3. If it required 5 linen cloths, the result would be 1. +Once you know how many distinct reagents you need, you can use `GetTradeSkillReagentInfo` to find out how many of each one are required. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillReagentInfo.md b/wiki-information/functions/GetTradeSkillReagentInfo.md new file mode 100644 index 00000000..4e54d3d4 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillReagentInfo.md @@ -0,0 +1,35 @@ +## Title: GetTradeSkillReagentInfo + +**Content:** +Returns information on reagents for the specified trade skill. +`reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(tradeSkillRecipeId, reagentId)` + +**Parameters:** +- `tradeSkillRecipeId` + - The Id of the tradeskill recipe +- `reagentId` + - The Id of the reagent (from 1 to x, where x is the result of calling GetTradeSkillNumReagents) + +**Returns:** +- `reagentName` + - *string* - The name of the reagent. +- `reagentTexture` + - *string* - The texture for the reagent's icon. +- `reagentCount` + - *number* - The quantity of this reagent required to make one of these items. +- `playerReagentCount` + - *number* - The quantity of this reagent in the player's inventory. + +**Usage:** +```lua +local numReagents = GetTradeSkillNumReagents(id); +local totalReagents = 0; +for i=1, numReagents, 1 do + local reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(id, i); + totalReagents = totalReagents + reagentCount; +end; +``` + +**Miscellaneous:** +- **Result:** + - Calculates the total number of items required by the recipe. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillReagentItemLink.md b/wiki-information/functions/GetTradeSkillReagentItemLink.md new file mode 100644 index 00000000..1ffe0bcb --- /dev/null +++ b/wiki-information/functions/GetTradeSkillReagentItemLink.md @@ -0,0 +1,18 @@ +## Title: GetTradeSkillReagentItemLink + +**Content:** +Gets the link string for a trade skill reagent. +`link = GetTradeSkillReagentItemLink(skillId, reagentId)` + +**Parameters:** +- `skillId` + - *number* - The Id specifying which trade skill's reagent to link. +- `reagentId` + - *number* - The Id specifying which of the skill's reagents to link. + +**Returns:** +- `link` + - *string* - An item link string (color coded with href) which can be included in chat messages to represent the reagent required for the trade skill. + +**Description:** +This function is broken on 5.2.0 build 16650 and always returns nil. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillRecipeLink.md b/wiki-information/functions/GetTradeSkillRecipeLink.md new file mode 100644 index 00000000..9f5f16c8 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillRecipeLink.md @@ -0,0 +1,28 @@ +## Title: GetTradeSkillRecipeLink + +**Content:** +Returns the EnchantLink for a trade skill. +`link = GetTradeSkillRecipeLink(index)` + +**Parameters:** +- `index` + - *number* - The row of the tradeskill listbox containing the item. The indices include the category headers. The tradeskill window doesn't have to be open, but the tradeskill and indices reflect the last state of the tradeskill window. The indices change if you expand or collapse headings (i.e. they exactly reflect the line number of the item as it is currently displayed in the tradeskill window). + +**Returns:** +- `link` + - *string* - An EnchantLink (color coded with href) which can be included in chat messages to show the reagents and the items the trade skill creates. + +**Usage:** +Trade Blacksmithing: (window is open, all categories shown) +- **Index** | **Name** +- 1 | - Daggers +- 2 | Deadly Bronze Poniard +- 3 | Pearl-handled Dagger +- 4 | Big Bronze Knife +- 5 | - One-Handed Axes + +Trade Blacksmithing: (window is open, only trade items are shown) +- **Index** | **Name** +- 1 | - Trade Items +- 2 | Elemental Sharpening Stone +- 3 | Thorium Shield Spike \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillSelectionIndex.md b/wiki-information/functions/GetTradeSkillSelectionIndex.md new file mode 100644 index 00000000..2c9cf339 --- /dev/null +++ b/wiki-information/functions/GetTradeSkillSelectionIndex.md @@ -0,0 +1,20 @@ +## Title: GetTradeSkillSelectionIndex + +**Content:** +Returns the index of the currently selected trade skill. +`local tradeSkillIndex = GetTradeSkillSelectionIndex()` + +**Returns:** +- `tradeSkillIndex` + - *number* - The index of the currently selected trade skill, or 0 if none selected. + +**Usage:** +```lua +if ( GetTradeSkillSelectionIndex() > 1 ) then + TradeSkillFrame_SetSelection(GetTradeSkillSelectionIndex()); +else + if ( GetNumTradeSkills() > 0 ) then + TradeSkillFrame_SetSelection(GetFirstTradeSkill()); + end; +end; +``` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillSubClassFilter.md b/wiki-information/functions/GetTradeSkillSubClassFilter.md new file mode 100644 index 00000000..a895444d --- /dev/null +++ b/wiki-information/functions/GetTradeSkillSubClassFilter.md @@ -0,0 +1,11 @@ +## Title: GetTradeSkillSubClassFilter + +**Content:** +`isVisible = GetTradeSkillSubClassFilter(filterIndex)` + +**Returns:** +- `isVisible` + - *boolean* - Whether items corresponding to `filterIndex` are visible (1) or not (nil). + +**Reference:** +- `SetTradeSkillSubClassFilter` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeTargetItemInfo.md b/wiki-information/functions/GetTradeTargetItemInfo.md new file mode 100644 index 00000000..b7579019 --- /dev/null +++ b/wiki-information/functions/GetTradeTargetItemInfo.md @@ -0,0 +1,29 @@ +## Title: GetTradeTargetItemInfo + +**Content:** +Returns item info for the other player in the trade window. +`name, texture, quantity, quality, isUsable, enchant = GetTradeTargetItemInfo(index)` + +**Parameters:** +- `index` + - *number* - the slot (1-7) to retrieve info from + +**Returns:** +- `name` + - *string* - Name of the item +- `texture` + - *string* - Name of the item's texture +- `quantity` + - *number* - Returns how many is in the stack +- `quality` + - *number* - The item's quality (0-6) +- `isUsable` + - *number* - True if the player can use this item +- `enchant` + - *string* - enchant being applied (no trade slot) + +**Example Usage:** +This function can be used to display information about the items the other player has placed in the trade window. For instance, an addon could use this to show detailed information about the items being traded, such as their quality and usability. + +**Addons:** +Large addons like TradeSkillMaster (TSM) use this function to manage and display trade information, ensuring that users have all the necessary details about the items being traded. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeskillRepeatCount.md b/wiki-information/functions/GetTradeskillRepeatCount.md new file mode 100644 index 00000000..9b25b414 --- /dev/null +++ b/wiki-information/functions/GetTradeskillRepeatCount.md @@ -0,0 +1,12 @@ +## Title: GetTradeskillRepeatCount + +**Content:** +Returns the number of times the current item is being crafted. +`local repeatCount = GetTradeskillRepeatCount()` + +**Returns:** +- `repeatCount` + - *number* - The number of times the current tradeskill item is being crafted. + +**Description:** +The repeat count is initially set by the optional repeat parameter of `DoTradeSkill`. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceAbilityReq.md b/wiki-information/functions/GetTrainerServiceAbilityReq.md new file mode 100644 index 00000000..8959d7c7 --- /dev/null +++ b/wiki-information/functions/GetTrainerServiceAbilityReq.md @@ -0,0 +1,17 @@ +## Title: GetTrainerServiceAbilityReq + +**Content:** +Returns the name of a requirement for training a skill and if the player meets the requirement. +`ability, hasReq = GetTrainerServiceAbilityReq(trainerIndex, reqIndex)` + +**Parameters:** +- `trainerIndex` + - *number* - Index of the trainer service to retrieve information about. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) +- `reqIndex` + - *number* - Index of the requirement to retrieve information about. + +**Returns:** +- `ability` + - *string* - The name of the required ability. Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad`. +- `hasReq` + - *boolean* - Flag for if the player meets the requirement. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceDescription.md b/wiki-information/functions/GetTrainerServiceDescription.md new file mode 100644 index 00000000..8999a934 --- /dev/null +++ b/wiki-information/functions/GetTrainerServiceDescription.md @@ -0,0 +1,20 @@ +## Title: GetTrainerServiceDescription + +**Content:** +Returns the description of a specific trainer service. +`serviceDescription = GetTrainerServiceDescription(index)` + +**Parameters:** +- `index` + - *number* - The index of the specific trainer service. + +**Returns:** +- `serviceDescription` + - *string* - The description of a specific trainer service. Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad`. + +**Usage:** +Prints the description of the trainer service with index 3, in the chat window: +```lua +print(GetTrainerServiceDescription(3)) +-- Output: "Permanently enchant a weapon to often deal 20 Nature damage to an enemy damaged by your spells or struck by your melee attacks. Cannot be applied to items higher than level 136." +``` \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceItemLink.md b/wiki-information/functions/GetTrainerServiceItemLink.md new file mode 100644 index 00000000..0ee82399 --- /dev/null +++ b/wiki-information/functions/GetTrainerServiceItemLink.md @@ -0,0 +1,16 @@ +## Title: GetTrainerServiceItemLink + +**Content:** +Returns an item link for a trainer service. +`link = GetTrainerServiceItemLink(index)` + +**Parameters:** +- `index` + - *number* - Index of the trainer service to get a link for. + +**Returns:** +- `link` + - *string* : ItemLink - The item link for the given trainer service. + +**Description:** +Indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceLevelReq.md b/wiki-information/functions/GetTrainerServiceLevelReq.md new file mode 100644 index 00000000..f7d3ead7 --- /dev/null +++ b/wiki-information/functions/GetTrainerServiceLevelReq.md @@ -0,0 +1,13 @@ +## Title: GetTrainerServiceLevelReq + +**Content:** +Returns the required level to learn a skill from the trainer. +`reqLevel = GetTrainerServiceLevelReq(id)` + +**Parameters:** +- `id` + - *number* - Index of the trainer service to retrieve information about. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) + +**Returns:** +- `reqLevel` + - *number* - The required level (for pet or player) to learn the skill. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceSkillLine.md b/wiki-information/functions/GetTrainerServiceSkillLine.md new file mode 100644 index 00000000..b5af00e8 --- /dev/null +++ b/wiki-information/functions/GetTrainerServiceSkillLine.md @@ -0,0 +1,13 @@ +## Title: GetTrainerServiceSkillLine + +**Content:** +Gets the name of the skill at the specified line from the current trainer. +`local skillLine = GetTrainerServiceSkillLine(index)` + +**Parameters:** +- `index` + - *number* - Index of the trainer service to get the name of. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) + +**Returns:** +- `skillLine` + - *string* - The name of the skill on the specified line. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceSkillReq.md b/wiki-information/functions/GetTrainerServiceSkillReq.md new file mode 100644 index 00000000..09ce9a37 --- /dev/null +++ b/wiki-information/functions/GetTrainerServiceSkillReq.md @@ -0,0 +1,31 @@ +## Title: GetTrainerServiceSkillReq + +**Content:** +Returns the name of the required skill and the amount needed in that skill. +`skillName, skillLevel, hasReq = GetTrainerServiceSkillReq(index)` + +**Parameters:** +- `index` + - the number of the selection in the trainer window + +**Returns:** +- `skillName` + - The name of the skill. +- `skillLevel` + - The required level needed for the skill. +- `hasReq` + - 1 or nil. Seems to be 1 for skills that you cannot learn, nil for skills you have learned already. + +**Usage:** +```lua +local selection = GetTrainerSelectionIndex() + +local skillName, skillAmt = GetTrainerServiceSkillReq(selection) +DEFAULT_CHAT_FRAME:AddMessage('Skill Name: ' .. skillName) +DEFAULT_CHAT_FRAME:AddMessage('Skill Amount Required: ' .. skillLevel) +``` +If you had an engineering trainer open, with a skill you knew already the output would be: +``` +Skill Name: Engineering +Skill Amount Required: 375 +``` \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceTypeFilter.md b/wiki-information/functions/GetTrainerServiceTypeFilter.md new file mode 100644 index 00000000..4f7d6ff1 --- /dev/null +++ b/wiki-information/functions/GetTrainerServiceTypeFilter.md @@ -0,0 +1,16 @@ +## Title: GetTrainerServiceTypeFilter + +**Content:** +Returns the status of a skill filter in the trainer window. +`status = GetTrainerServiceTypeFilter(type)` + +**Parameters:** +- `type` + - *string* - Possible values: + - `"available"` + - `"unavailable"` + - `"used"` (already known) + +**Returns:** +- `status` + - *boolean* - true if currently displaying trainer services of the specified type, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetUICameraInfo.md b/wiki-information/functions/GetUICameraInfo.md new file mode 100644 index 00000000..12888ab7 --- /dev/null +++ b/wiki-information/functions/GetUICameraInfo.md @@ -0,0 +1,31 @@ +## Title: GetUICameraInfo + +**Content:** +Needs summary. +`posX, posY, posZ, lookAtX, lookAtY, lookAtZ, animID, animVariation, animFrame, useModelCenter = GetUICameraInfo(uiCameraID)` + +**Parameters:** +- `uiCameraID` + - *number* + +**Returns:** +- `posX` + - *number* +- `posY` + - *number* +- `posZ` + - *number* +- `lookAtX` + - *number* +- `lookAtY` + - *number* +- `lookAtZ` + - *number* +- `animID` + - *number* +- `animVariation` + - *number* +- `animFrame` + - *number* +- `useModelCenter` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GetUnitHealthModifier.md b/wiki-information/functions/GetUnitHealthModifier.md new file mode 100644 index 00000000..71825c99 --- /dev/null +++ b/wiki-information/functions/GetUnitHealthModifier.md @@ -0,0 +1,19 @@ +## Title: GetUnitHealthModifier + +**Content:** +Needs summary. +`healthMod = GetUnitHealthModifier(unit)` + +**Parameters:** +- `unit` + - *string* - UnitToken + +**Returns:** +- `healthMod` + - *number* + +**Example Usage:** +This function can be used to retrieve the health modifier for a specific unit, which can be useful in calculating the effective health of a unit after considering various buffs, debuffs, and other modifiers. + +**Addons Usage:** +Large addons like "Recount" or "Details! Damage Meter" might use this function to accurately track and display the health of units during combat, taking into account any modifiers that affect health. \ No newline at end of file diff --git a/wiki-information/functions/GetUnitMaxHealthModifier.md b/wiki-information/functions/GetUnitMaxHealthModifier.md new file mode 100644 index 00000000..6ece2fc2 --- /dev/null +++ b/wiki-information/functions/GetUnitMaxHealthModifier.md @@ -0,0 +1,26 @@ +## Title: GetUnitMaxHealthModifier + +**Content:** +Needs summary. +`maxhealthMod = GetUnitMaxHealthModifier(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `maxhealthMod` + - *number* + +**Example Usage:** +This function can be used to determine the maximum health modifier for a specific unit, which can be useful in scenarios where you need to calculate or display the modified maximum health of a unit in your addon. + +**Example:** +```lua +local unit = "player" +local maxHealthModifier = GetUnitMaxHealthModifier(unit) +print("The max health modifier for the player is: " .. maxHealthModifier) +``` + +**Addons:** +Large addons like **WeakAuras** and **ElvUI** might use this function to dynamically adjust health displays or to trigger specific events based on changes in a unit's maximum health. \ No newline at end of file diff --git a/wiki-information/functions/GetUnitPowerModifier.md b/wiki-information/functions/GetUnitPowerModifier.md new file mode 100644 index 00000000..12eb77d4 --- /dev/null +++ b/wiki-information/functions/GetUnitPowerModifier.md @@ -0,0 +1,19 @@ +## Title: GetUnitPowerModifier + +**Content:** +Needs summary. +`powerMod = GetUnitPowerModifier(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `powerMod` + - *number* + +**Example Usage:** +This function can be used to retrieve the power modifier for a specific unit, which can be useful in scenarios where you need to calculate the effective power of a unit after considering any modifiers. + +**Addons Usage:** +Large addons like WeakAuras might use this function to display or calculate the effective power of units in custom auras or triggers. \ No newline at end of file diff --git a/wiki-information/functions/GetUnitSpeed.md b/wiki-information/functions/GetUnitSpeed.md new file mode 100644 index 00000000..763210f9 --- /dev/null +++ b/wiki-information/functions/GetUnitSpeed.md @@ -0,0 +1,29 @@ +## Title: GetUnitSpeed + +**Content:** +Returns the movement speed of the unit. +`currentSpeed, runSpeed, flightSpeed, swimSpeed = GetUnitSpeed(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit to query the speed of. + +**Returns:** +- `currentSpeed` + - *number* - current movement speed in yards per second (normal running: 7; an epic ground mount: 14) +- `runSpeed` + - *number* - the maximum speed on the ground, in yards per second (including talents such as Pursuit of Justice and ground mounts) +- `flightSpeed` + - *number* - the maximum speed while flying, in yards per second (the unit needs to be on a flying mount to get the flying speed) +- `swimSpeed` + - *number* - the maximum speed while swimming, in yards per second (not tested but it should be as the flying mount) + +**Usage:** +The following snippet prints your current movement speed in percent: +```lua +/script print(string.format("Current speed: %d%%", GetUnitSpeed("player") / 7 * 100)) +``` + +**Description:** +As of 4.2, `runSpeed`, `flightSpeed`, and `swimSpeed` returns were added. It seems you can also get the target unit's speed (not tested on the opposite faction). +A constant exists: `BASE_MOVEMENT_SPEED` which is equal to 7 (as of patch 4.2). \ No newline at end of file diff --git a/wiki-information/functions/GetUnspentTalentPoints.md b/wiki-information/functions/GetUnspentTalentPoints.md new file mode 100644 index 00000000..47ad64cb --- /dev/null +++ b/wiki-information/functions/GetUnspentTalentPoints.md @@ -0,0 +1,27 @@ +## Title: GetUnspentTalentPoints + +**Content:** +Returns the number of unspent talent points the player, the player's pet, or an inspected unit. +`talentPoints = GetUnspentTalentPoints(isInspected, isPet, talentGroup)` + +**Parameters:** +- `isInspected` + - *Boolean* - If true, returns the information for the inspected unit instead of the player. +- `isPet` + - *Boolean* - If true, returns the information for the pet instead of the player (only valid for hunter with a pet active). +- `talentGroup` + - *Number* - The index of the talent group (1 for primary / 2 for secondary). + +**Returns:** +- `talentPoints` + - *Number* - number of unspent talent points. + +**Usage:** +```lua +-- Get the unspent talent points for player's active spec +local talentGroup = GetActiveTalentGroup(false, false) +local talentPoints = GetUnspentTalentPoints(false, false, talentGroup) +``` + +**Notes and Caveats:** +This function returns 0 if an invalid combination of parameters is used (asking for pet talent for a non-hunter, asking for isInspect when no unit was inspected). \ No newline at end of file diff --git a/wiki-information/functions/GetVehicleUIIndicator.md b/wiki-information/functions/GetVehicleUIIndicator.md new file mode 100644 index 00000000..98e7ef4e --- /dev/null +++ b/wiki-information/functions/GetVehicleUIIndicator.md @@ -0,0 +1,24 @@ +## Title: GetVehicleUIIndicator + +**Content:** +Needs summary. +`backgroundTextureID, numSeatIndicators = GetVehicleUIIndicator(vehicleIndicatorID)` + +**Parameters:** +- `vehicleIndicatorID` + - *number* + +**Returns:** +- `backgroundTextureID` + - *number* : fileID +- `numSeatIndicators` + - *number* + +**Description:** +This function is used to retrieve information about the UI indicators for a vehicle in World of Warcraft. The `backgroundTextureID` is the file ID of the background texture for the vehicle UI, and `numSeatIndicators` is the number of seat indicators available for the vehicle. + +**Example Usage:** +This function can be used in custom UI addons to display vehicle information. For example, an addon could use this function to get the background texture and seat indicators for a vehicle and then display them in a custom UI frame. + +**Addons:** +Large addons like **ElvUI** and **Bartender4** might use this function to customize the vehicle UI elements, providing a more integrated and visually appealing experience for players when they are using vehicles in the game. \ No newline at end of file diff --git a/wiki-information/functions/GetVehicleUIIndicatorSeat.md b/wiki-information/functions/GetVehicleUIIndicatorSeat.md new file mode 100644 index 00000000..672b98f2 --- /dev/null +++ b/wiki-information/functions/GetVehicleUIIndicatorSeat.md @@ -0,0 +1,19 @@ +## Title: GetVehicleUIIndicatorSeat + +**Content:** +Needs summary. +`virtualSeatIndex, xPos, yPos = GetVehicleUIIndicatorSeat(vehicleIndicatorID, indicatorSeatIndex)` + +**Parameters:** +- `vehicleIndicatorID` + - *number* +- `indicatorSeatIndex` + - *number* + +**Returns:** +- `virtualSeatIndex` + - *number* +- `xPos` + - *number* +- `yPos` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetWatchedFactionInfo.md b/wiki-information/functions/GetWatchedFactionInfo.md new file mode 100644 index 00000000..00e0c4c1 --- /dev/null +++ b/wiki-information/functions/GetWatchedFactionInfo.md @@ -0,0 +1,19 @@ +## Title: GetWatchedFactionInfo + +**Content:** +Returns info for the currently watched faction. +`name, standing, min, max, value, factionID = GetWatchedFactionInfo()` + +**Returns:** +- `name` + - *string* - The name of the faction currently being watched, nil if no faction is being watched. +- `standing` + - *number* - The StandingId with the faction. +- `min` + - *number* - The minimum bound for the current standing, for instance 21000 for Revered. +- `max` + - *number* - The maximum bound for the current standing, for instance 42000 for Revered. +- `value` + - *number* - The current faction level, within the bounds. +- `factionID` + - *number* (FactionID) - Unique numeric identifier for the faction. \ No newline at end of file diff --git a/wiki-information/functions/GetWeaponEnchantInfo.md b/wiki-information/functions/GetWeaponEnchantInfo.md new file mode 100644 index 00000000..96e827af --- /dev/null +++ b/wiki-information/functions/GetWeaponEnchantInfo.md @@ -0,0 +1,34 @@ +## Title: GetWeaponEnchantInfo + +**Content:** +Returns info for temporary weapon enchantments (e.g. sharpening stones). +`hasMainHandEnchant, mainHandExpiration, mainHandCharges, mainHandEnchantID, hasOffHandEnchant, offHandExpiration, offHandCharges, offHandEnchantID, hasRangedEnchant, rangedExpiration, rangedCharges, rangedEnchantID = GetWeaponEnchantInfo()` + +**Returns:** +- `hasMainHandEnchant` + - *boolean* - true if the weapon in the main hand slot has a temporary enchant, false otherwise +- `mainHandExpiration` + - *number* - time remaining for the main hand enchant, as thousandths of seconds +- `mainHandCharges` + - *number* - the number of charges remaining on the main hand enchant +- `mainHandEnchantID` + - *number* - ID of the main hand enchant (new in 6.0) +- `hasOffHandEnchant` + - *boolean* - true if the weapon in the secondary (off) hand slot has a temporary enchant, false otherwise +- `offHandExpiration` + - *number* - time remaining for the off hand enchant, as thousandths of seconds +- `offHandCharges` + - *number* - the number of charges remaining on the off hand enchant +- `offHandEnchantID` + - *number* - ID of the off hand enchant (new in 6.0) +- `hasRangedEnchant` + - *boolean* - true if the weapon in the ranged hand slot has a temporary enchant, false otherwise (only on cataclysm/4.x) +- `rangedExpiration` + - *number* - time remaining for the ranged enchant, as thousandths of seconds (only on cataclysm/4.x) +- `rangedCharges` + - *number* - the number of charges remaining on the ranged enchant (only on cataclysm/4.x) +- `rangedEnchantID` + - *number* - ID of the ranged enchant (only on cataclysm/4.x) + +**Reference:** +`UNIT_INVENTORY_CHANGED` fires when (among other things) the player's temporary enchants, and thus the return values from this function, change. \ No newline at end of file diff --git a/wiki-information/functions/GetWebTicket.md b/wiki-information/functions/GetWebTicket.md new file mode 100644 index 00000000..554a47b5 --- /dev/null +++ b/wiki-information/functions/GetWebTicket.md @@ -0,0 +1,8 @@ +## Title: GetWebTicket + +**Content:** +Requests updated GM ticket status information. +`GetWebTicket()` + +**Reference:** +`UPDATE_WEB_TICKET` if a ticket exists; event arguments supply ticket information. \ No newline at end of file diff --git a/wiki-information/functions/GetXPExhaustion.md b/wiki-information/functions/GetXPExhaustion.md new file mode 100644 index 00000000..99b461f5 --- /dev/null +++ b/wiki-information/functions/GetXPExhaustion.md @@ -0,0 +1,12 @@ +## Title: GetXPExhaustion + +**Content:** +Returns the amount of current rested XP for the character. +`exhaustion = GetXPExhaustion()` + +**Returns:** +- `exhaustion` + - *number* - The exhaustion threshold. Returns nil if player is not rested. + +**Description:** +This is the total and not the amount added. For example, if this says 5000 then the next 5000 XP gained from mobs will occur at double rate. The game actually gives double XP for mobs while rested as an add on. An example, a mob worth 98 XP is killed, XP gained is 98 + 98 rested XP bonus which reduces your 5000 by 196. If you take 1/2 the number then this is the XP bonus you are eligible for. i.e., you will get +2500 rested bonus for earning 2500 XP from mobs for a total XP gain of 5000 during that time. When you hit 0 the bonus is small, for example, say you have 20 left and you kill a mob worth 98 then you get 98 + 10 rested bonus and go to the 'normal' non-rested state. So if you rest in an inn and get this up to 2 then you will receive +1 bonus XP from your next mob and not double XP from the mob. \ No newline at end of file diff --git a/wiki-information/functions/GetZonePVPInfo.md b/wiki-information/functions/GetZonePVPInfo.md new file mode 100644 index 00000000..d4814c28 --- /dev/null +++ b/wiki-information/functions/GetZonePVPInfo.md @@ -0,0 +1,39 @@ +## Title: GetZonePVPInfo + +**Content:** +Returns PVP info for the current zone. +`pvpType, isFFA, faction = GetZonePVPInfo()` + +**Returns:** +- `pvpType` + - *string* - One of the following values: + - `"arena"` if you are in an arena + - `"friendly"` if the zone is controlled by the faction the player belongs to. + - `"contested"` if the zone is contested (PvP server only) + - `"hostile"` if the zone is controlled by the opposing faction. + - `"sanctuary"` if the zone is a sanctuary and does not allow pvp combat (2.0.x). + - `"combat"` if it is a combat zone where players are automatically flagged for PvP combat (3.0.x). Currently applies only to the Wintergrasp zone. + - `nil`, if the zone is none of the above. Happens inside instances, including battlegrounds, and on PvE servers when the zone would otherwise be `"contested"`. +- `isFFA` + - *boolean* - true if in a free-for-all arena. +- `faction` + - *string* - the name of the faction controlling the zone if `pvpType` is `"friendly"` or `"hostile"`. + +**Usage:** +```lua +local zone = GetRealZoneText().." - "..tostring(GetSubZoneText()) +local pvpType, isFFA, faction = GetZonePVPInfo() +local str +if pvpType == "friendly" or pvpType == "hostile" then + str = " is controlled by "..faction.." ("..pvpType..")" +elseif pvpType == "sanctuary" then + str = " is a PvP-free sanctuary." +elseif isFFA then + str = " is a free-for-all arena." +else + str = " is a contested zone." +end +print(zone..str) +-- Example output: Stormwind City - War Room is controlled by Alliance (friendly) +-- Example output: Alterac Valley - Dun Baldar Pass is a contested zone. +``` \ No newline at end of file diff --git a/wiki-information/functions/GetZoneText.md b/wiki-information/functions/GetZoneText.md new file mode 100644 index 00000000..20fc611d --- /dev/null +++ b/wiki-information/functions/GetZoneText.md @@ -0,0 +1,25 @@ +## Title: GetZoneText + +**Content:** +Returns the name of the zone the player is in. +`zoneName = GetZoneText()` + +**Returns:** +- `zoneName` + - *string* - Localized zone name. + +**Description:** +The `ZONE_CHANGED_NEW_AREA` event is triggered when the main area changes (such as exiting or leaving a major city). +If you want more detail, `ZONE_CHANGED` is also triggered every time you move between sub-sections of an area, (such as going from Shattrath's center to Lower City, etc). +There is `ZONE_CHANGED_INDOORS` for specialized cases. + +**Usage:** +Returns the name of the zone the player is currently in. +```lua +/run print("Current Zone: " .. GetZoneText()) +``` + +**Reference:** +- `GetSubZoneText()` +- `GetRealZoneText()` +- `GetMinimapZoneText()` \ No newline at end of file diff --git a/wiki-information/functions/GuildControlDelRank.md b/wiki-information/functions/GuildControlDelRank.md new file mode 100644 index 00000000..875d2f60 --- /dev/null +++ b/wiki-information/functions/GuildControlDelRank.md @@ -0,0 +1,16 @@ +## Title: GuildControlDelRank + +**Content:** +Deletes a guild rank. +`GuildControlDelRank(index)` + +**Parameters:** +- `index` + - *number* - must be between 1 and the value returned by `GuildControlGetNumRanks()`. + +**Returns:** +- `nil` + - If the rank cannot be deleted, a message will be sent to the default chat window. + +**Description:** +The index rank must be unused - no guild members may currently have that rank or any lower rank (having a higher index value). \ No newline at end of file diff --git a/wiki-information/functions/GuildControlGetRankFlags.md b/wiki-information/functions/GuildControlGetRankFlags.md new file mode 100644 index 00000000..62dfa2c2 --- /dev/null +++ b/wiki-information/functions/GuildControlGetRankFlags.md @@ -0,0 +1,59 @@ +## Title: GuildControlGetRankFlags + +**Content:** +Returns information about the currently selected guild rank. +```lua +guildchat_listen, guildchat_speak, officerchat_listen, officerchat_speak, promote, demote, invite_member, remove_member, set_motd, edit_public_note, view_officer_note, edit_officer_note, modify_guild_info, _, withdraw_repair, withdraw_gold, create_guild_event, authenticator, modify_bank_tabs, remove_guild_event = GuildControlGetRankFlags() +``` + +**Returns:** +If no rank has been selected via `GuildControlSetRank`, the function will return false for all flags. +- `guildchat_listen` + - *Boolean* - true if players of the rank can listen to guild chat. +- `guildchat_speak` + - *Boolean* - true if players of the rank can speak in guild chat. +- `officerchat_listen` + - *Boolean* - true if players of the rank can listen to officer chat. +- `officerchat_speak` + - *Boolean* - true if players of the rank can speak in officer chat. +- `promote` + - *Boolean* - true if players of the rank promote lower ranked players. +- `demote` + - *Boolean* - true if players of the rank demote lower ranked players. +- `invite_member` + - *Boolean* - true if players of the rank invite new players to the guild. +- `remove_member` + - *Boolean* - true if players of the rank remove players from the guild. +- `set_motd` + - *Boolean* - true if players of the rank can edit guild message of the day. +- `edit_public_note` + - *Boolean* - true if players of the rank can edit public notes. +- `view_officer_note` + - *Boolean* - true if players of the rank can view officer notes. +- `edit_officer_note` + - *Boolean* - true if players of the rank can edit officer notes. +- `modify_guild_info` + - *Boolean* - true if players of the rank modify guild information. +- `withdraw_repair` + - *Boolean* - true if players of the rank are allowed to repair using guild bank. +- `withdraw_gold` + - *Boolean* - true if players of the rank are allowed to withdraw gold from the guild bank. +- `create_guild_event` + - *Boolean* - true if players of the rank can create guild events on the calendar. +- `authenticator` + - *Boolean* - true if players must have an authenticator attached to the account to be promoted to this rank. +- `modify_bank_tabs` + - *Boolean* - true if players of the rank can change bank tab labels. +- `remove_guild_event` + - *Boolean* - true if players of the rank can remove guild events on the calendar. + +**Usage:** +```lua +local _, _, playerrank = GetGuildInfo("player") +GuildControlSetRank(playerrank + 1) +local guildchat_listen, guildchat_speak, officerchat_listen, officerchat_speak, ... = GuildControlGetRankFlags() +``` + +**Notes and Caveats:** +- The 14th return value is obsolete and should be ignored. +- "modify_bank_tabs" and "remove_guild_event" were added in Patch 4.1. Another flag, "recruitment", exists as label text for the next flag in line, but is not yet returned by this function. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlGetRankName.md b/wiki-information/functions/GuildControlGetRankName.md new file mode 100644 index 00000000..0179e45e --- /dev/null +++ b/wiki-information/functions/GuildControlGetRankName.md @@ -0,0 +1,16 @@ +## Title: GuildControlGetRankName + +**Content:** +Returns a guild rank name by index. +`GuildControlGetRankName(index)` + +**Parameters:** +- `index` + - *number* - the rank index + +**Returns:** +- `rankName` + - *string* - the name of the rank at index. + +**Description:** +`index` must be between 1 and `GuildControlGetNumRanks()`. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlSaveRank.md b/wiki-information/functions/GuildControlSaveRank.md new file mode 100644 index 00000000..488d5af6 --- /dev/null +++ b/wiki-information/functions/GuildControlSaveRank.md @@ -0,0 +1,13 @@ +## Title: GuildControlSaveRank + +**Content:** +Saves the current rank name. +`GuildControlSaveRank(name)` + +**Parameters:** +- `name` + - *string* - the name of this rank + +**Description:** +Saves the current flags, set using `GuildControlSetRankFlag()`, to the current rank. +Entering a name different from that of the rank set with `GuildControlSetRank()` will change the name of the current rank to the entered name. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlSetRank.md b/wiki-information/functions/GuildControlSetRank.md new file mode 100644 index 00000000..6994f6b1 --- /dev/null +++ b/wiki-information/functions/GuildControlSetRank.md @@ -0,0 +1,12 @@ +## Title: GuildControlSetRank + +**Content:** +Selects a guild rank. +`GuildControlSetRank(rankOrder)` + +**Parameters:** +- `rankOrder` + - *number* - index of the rank to select, between 1 and `GuildControlGetNumRanks()`. + +**Description:** +Calling this API sets the rank to return/edit flags for using `GuildControlGetRankFlags()` and `GuildControlSetRankFlag()`. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlSetRankFlag.md b/wiki-information/functions/GuildControlSetRankFlag.md new file mode 100644 index 00000000..36ca446c --- /dev/null +++ b/wiki-information/functions/GuildControlSetRankFlag.md @@ -0,0 +1,86 @@ +## Title: GuildControlSetRankFlag + +**Content:** +Sets guild rank permissions. +`GuildControlSetRankFlag(index, enabled)` + +**Parameters:** +- `index` + - *number* - the flag index, between 1 and GuildControlGetNumRanks(). +- `enabled` + - *boolean* - whether the flag is enabled or disabled. + +**Description:** +Calling this API changes the value of the current rank flags. These changes are not saved until a call to `GuildControlSaveRank()` is made. + +**Flag indices:** +- **GUILDCONTROL_OPTION** + - **Index** + - **GlobalString** + - **Name** + - **Description** + - `1` + - `GUILDCONTROL_OPTION1` + - Guildchat Listen + - `2` + - `GUILDCONTROL_OPTION2` + - Guildchat Speak + - `3` + - `GUILDCONTROL_OPTION3` + - Officerchat Listen + - `4` + - `GUILDCONTROL_OPTION4` + - Officerchat Speak + - `5` + - `GUILDCONTROL_OPTION5` + - Promote + - `6` + - `GUILDCONTROL_OPTION6` + - Demote + - `7` + - `GUILDCONTROL_OPTION7` + - Invite Member + - `8` + - `GUILDCONTROL_OPTION8` + - Remove Member + - `9` + - `GUILDCONTROL_OPTION9` + - Set MOTD + - `10` + - `GUILDCONTROL_OPTION10` + - Edit Public Note + - `11` + - `GUILDCONTROL_OPTION11` + - View Officer Note + - `12` + - `GUILDCONTROL_OPTION12` + - Edit Officer Note + - `13` + - `GUILDCONTROL_OPTION13` + - Modify Guild Info + - `14` + - `GUILDCONTROL_OPTION14` + - Create Guild Event + - `15` + - `GUILDCONTROL_OPTION15` + - Guild Bank Repair + - Use guild funds for repairs + - `16` + - `GUILDCONTROL_OPTION16` + - Withdraw Gold + - Withdraw gold from the guild bank + - `17` + - `GUILDCONTROL_OPTION17` + - Create Guild Event + - `18` + - `GUILDCONTROL_OPTION18` + - Requires Authenticator + - `19` + - `GUILDCONTROL_OPTION19` + - Modify Bank Tabs + - `20` + - `GUILDCONTROL_OPTION20` + - Remove Guild Event + - `21` + - `GUILDCONTROL_OPTION21` + - Recruitment \ No newline at end of file diff --git a/wiki-information/functions/GuildDemote.md b/wiki-information/functions/GuildDemote.md new file mode 100644 index 00000000..dc0b2502 --- /dev/null +++ b/wiki-information/functions/GuildDemote.md @@ -0,0 +1,9 @@ +## Title: GuildDemote + +**Content:** +Demotes the specified player in the guild. +`GuildDemote(playername)` + +**Parameters:** +- `playername` + - *string* - The name of the player to demote \ No newline at end of file diff --git a/wiki-information/functions/GuildDisband.md b/wiki-information/functions/GuildDisband.md new file mode 100644 index 00000000..2f0eca30 --- /dev/null +++ b/wiki-information/functions/GuildDisband.md @@ -0,0 +1,9 @@ +## Title: GuildDisband + +**Content:** +Disbands the guild; no warning is given. +`GuildDisband()` + +**Description:** +Triggers `PLAYER_GUILD_UPDATE` if successful. +Only available to the guild leader. \ No newline at end of file diff --git a/wiki-information/functions/GuildInvite.md b/wiki-information/functions/GuildInvite.md new file mode 100644 index 00000000..ebadbb98 --- /dev/null +++ b/wiki-information/functions/GuildInvite.md @@ -0,0 +1,9 @@ +## Title: GuildInvite + +**Content:** +Invites a player to the guild. +`GuildInvite(playername)` + +**Parameters:** +- `playername` + - *string* - The name of the player to invite \ No newline at end of file diff --git a/wiki-information/functions/GuildPromote.md b/wiki-information/functions/GuildPromote.md new file mode 100644 index 00000000..df7c2424 --- /dev/null +++ b/wiki-information/functions/GuildPromote.md @@ -0,0 +1,9 @@ +## Title: GuildPromote + +**Content:** +Promotes the specified player in the guild. +`GuildPromote(playername)` + +**Parameters:** +- `playername` + - *string* - The name of the player to promote. \ No newline at end of file diff --git a/wiki-information/functions/GuildRosterSetOfficerNote.md b/wiki-information/functions/GuildRosterSetOfficerNote.md new file mode 100644 index 00000000..42dcdb7b --- /dev/null +++ b/wiki-information/functions/GuildRosterSetOfficerNote.md @@ -0,0 +1,28 @@ +## Title: GuildRosterSetOfficerNote + +**Content:** +Sets the officer note of a guild member. +`GuildRosterSetOfficerNote(index, Text)` + +**Parameters:** +- `(index, "Text")` + - `index` + - The position a member is in the guild roster. This can be found by counting from the top down to the member or by selecting the member and using the `GetGuildRosterSelection()` function. + - `Text` + - Text to be set to the officer note of the index. + +**Usage:** +```lua +GuildRosterSetOfficerNote(GetGuildRosterSelection(), "My Officer Note") +``` + +**Description:** +Color can be added to public notes, officer notes, guild info, and guild MOTD using UI Escape Sequences: +```lua +GuildRosterSetOfficerNote(GetGuildRosterSelection(), "|cFFFF0000This Looks Red!") +``` +or +```lua +/script GuildRosterSetOfficerNote(GetGuildRosterSelection(), "\\124cFFFF0000This Looks Red!") +``` +for in-game text editing. \ No newline at end of file diff --git a/wiki-information/functions/GuildRosterSetPublicNote.md b/wiki-information/functions/GuildRosterSetPublicNote.md new file mode 100644 index 00000000..b9f7f893 --- /dev/null +++ b/wiki-information/functions/GuildRosterSetPublicNote.md @@ -0,0 +1,22 @@ +## Title: GuildRosterSetPublicNote + +**Content:** +Sets the public note of a guild member. +`GuildRosterSetPublicNote(index, Text)` + +**Parameters:** +- `index` + - The position a member is in the guild roster. This can be found by counting from the top down to the member or by selecting the member and using the `GetGuildRosterSelection()` function. +- `Text` + - Text to be set to the public note of the index. + +**Usage:** +```lua +GuildRosterSetPublicNote(GetGuildRosterSelection(), "My Public Note") +``` + +**Example Use Case:** +This function can be used by guild management addons to automate the process of setting public notes for guild members. For instance, an addon could update public notes to reflect members' roles or achievements within the guild. + +**Addons Using This Function:** +Large guild management addons like "Guild Roster Manager" (GRM) use this function to allow guild officers to set and update public notes for members directly from the addon interface. This helps in maintaining organized and informative guild rosters. \ No newline at end of file diff --git a/wiki-information/functions/GuildSetLeader.md b/wiki-information/functions/GuildSetLeader.md new file mode 100644 index 00000000..60f1d050 --- /dev/null +++ b/wiki-information/functions/GuildSetLeader.md @@ -0,0 +1,12 @@ +## Title: GuildSetLeader + +**Content:** +Transfers guild leadership to another player. +`GuildSetLeader(name)` + +**Parameters:** +- `name` + - *string* - name of the character you wish to promote to Guild Leader. + +**Description:** +Some restrictions apply: you must be the current guild leader, the character being promoted must be in your guild, and, possibly, online. \ No newline at end of file diff --git a/wiki-information/functions/GuildSetMOTD.md b/wiki-information/functions/GuildSetMOTD.md new file mode 100644 index 00000000..e143f17e --- /dev/null +++ b/wiki-information/functions/GuildSetMOTD.md @@ -0,0 +1,17 @@ +## Title: GuildSetMOTD + +**Content:** +Sets the guild message of the day. +`GuildSetMOTD(message)` + +**Parameters:** +- `message` : *String* - The message to set - the message is limited to 127 characters (English client - I did not test this on other clients). + +**Example Usage:** +```lua +-- Set the guild message of the day to "Welcome to the guild!" +GuildSetMOTD("Welcome to the guild!") +``` + +**Additional Information:** +This function is commonly used in guild management addons to automate or simplify the process of updating the guild message of the day. For example, an addon might use this function to set a daily tip or announcement for guild members. \ No newline at end of file diff --git a/wiki-information/functions/GuildUninvite.md b/wiki-information/functions/GuildUninvite.md new file mode 100644 index 00000000..a7f4be47 --- /dev/null +++ b/wiki-information/functions/GuildUninvite.md @@ -0,0 +1,9 @@ +## Title: GuildUninvite + +**Content:** +Removes a player from the guild. +`GuildUninvite(name)` + +**Parameters:** +- `name` + - *string* - The name of the guild member \ No newline at end of file diff --git a/wiki-information/functions/HasAction.md b/wiki-information/functions/HasAction.md new file mode 100644 index 00000000..15115ad1 --- /dev/null +++ b/wiki-information/functions/HasAction.md @@ -0,0 +1,15 @@ +## Title: HasAction + +**Content:** +Returns true if an action slot is occupied. +`hasAction = HasAction(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - ActionSlot: The tested action slot. + +**Returns:** +- `hasAction` + - *boolean* - Flag + - `true`, if the slot contains an action + - `false`, if the slot is empty \ No newline at end of file diff --git a/wiki-information/functions/HasDualWieldPenalty.md b/wiki-information/functions/HasDualWieldPenalty.md new file mode 100644 index 00000000..a4f7c2ec --- /dev/null +++ b/wiki-information/functions/HasDualWieldPenalty.md @@ -0,0 +1,9 @@ +## Title: HasDualWieldPenalty + +**Content:** +Needs summary. +`hasPenalty = HasDualWieldPenalty()` + +**Returns:** +- `hasPenalty` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/HasFullControl.md b/wiki-information/functions/HasFullControl.md new file mode 100644 index 00000000..d38e34bc --- /dev/null +++ b/wiki-information/functions/HasFullControl.md @@ -0,0 +1,9 @@ +## Title: HasFullControl + +**Content:** +Checks whether you have full control over your character (i.e. you are not feared, etc). +`hasControl = HasFullControl` + +**Returns:** +- `hasControl` + - *boolean* - Whether the player has full control \ No newline at end of file diff --git a/wiki-information/functions/HasIgnoreDualWieldWeapon.md b/wiki-information/functions/HasIgnoreDualWieldWeapon.md new file mode 100644 index 00000000..0143e276 --- /dev/null +++ b/wiki-information/functions/HasIgnoreDualWieldWeapon.md @@ -0,0 +1,9 @@ +## Title: HasIgnoreDualWieldWeapon + +**Content:** +Needs summary. +`result = HasIgnoreDualWieldWeapon()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/HasInspectHonorData.md b/wiki-information/functions/HasInspectHonorData.md new file mode 100644 index 00000000..84227d3d --- /dev/null +++ b/wiki-information/functions/HasInspectHonorData.md @@ -0,0 +1,9 @@ +## Title: HasInspectHonorData + +**Content:** +Determine if the inspected unit's honor data has been loaded. +`hasData = HasInspectHonorData()` + +**Returns:** +- `hasData` + - *boolean* - whether the currently inspected unit's honor data has been loaded. \ No newline at end of file diff --git a/wiki-information/functions/HasKey.md b/wiki-information/functions/HasKey.md new file mode 100644 index 00000000..3f492c7b --- /dev/null +++ b/wiki-information/functions/HasKey.md @@ -0,0 +1,9 @@ +## Title: HasKey + +**Content:** +Returns whether or not the player has a key ring. +`hasKeyring = HasKey()` + +**Returns:** +- `hasKeyring` + - *boolean* - true if the player has a key ring, nil otherwise \ No newline at end of file diff --git a/wiki-information/functions/HasLFGRestrictions.md b/wiki-information/functions/HasLFGRestrictions.md new file mode 100644 index 00000000..643e4123 --- /dev/null +++ b/wiki-information/functions/HasLFGRestrictions.md @@ -0,0 +1,13 @@ +## Title: HasLFGRestrictions + +**Content:** +Returns whether the player is in a random party formed by the dungeon finder system. +`isRestricted = HasLFGRestrictions()` + +**Returns:** +- `isRestricted` + - *boolean* - 1 if the current party is subject to LFG restrictions, nil otherwise. + +**Description:** +Parties formed by the dungeon finder are restricted unless all 5 party members joined the dungeon finder as a party. +The Party Leader of such parties is referred to as "Dungeon Guide" by the default UI, and may not alter the loot system or arbitrarily remove people from the party. \ No newline at end of file diff --git a/wiki-information/functions/HasNoReleaseAura.md b/wiki-information/functions/HasNoReleaseAura.md new file mode 100644 index 00000000..a27bb960 --- /dev/null +++ b/wiki-information/functions/HasNoReleaseAura.md @@ -0,0 +1,13 @@ +## Title: HasNoReleaseAura + +**Content:** +Needs summary. +`hasCannotReleaseEffect, longestDuration, hasUntilCancelledDuration = HasNoReleaseAura()` + +**Returns:** +- `hasCannotReleaseEffect` + - *boolean* +- `longestDuration` + - *number* +- `hasUntilCancelledDuration` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/HasPetSpells.md b/wiki-information/functions/HasPetSpells.md new file mode 100644 index 00000000..eeb9e3a2 --- /dev/null +++ b/wiki-information/functions/HasPetSpells.md @@ -0,0 +1,14 @@ +## Title: HasPetSpells + +**Content:** +Returns the number of available abilities for the player's combat pet. +`hasPetSpells, petToken = HasPetSpells()` + +**Returns:** +- `numSpells` + - *number* - The number of pet abilities available, or nil if you do not have a pet with a spell book. +- `petToken` + - *string* - Pet type, can be "DEMON" or "PET". + +**Description:** +This `numSpells` return value is not the number that are on the pet bar, but the number of entries in the pet's spell book. \ No newline at end of file diff --git a/wiki-information/functions/HasPetUI.md b/wiki-information/functions/HasPetUI.md new file mode 100644 index 00000000..e5ac013f --- /dev/null +++ b/wiki-information/functions/HasPetUI.md @@ -0,0 +1,29 @@ +## Title: HasPetUI + +**Content:** +Returns true if the player currently has an active (hunter) pet out. +`hasUI, isHunterPet = HasPetUI()` + +**Returns:** +- `hasUI` + - *boolean* - True if the player has a pet User Interface, False if he does not. +- `isHunterPet` + - *boolean* - True if the pet is a hunter pet, False if it is not. + +**Usage:** +```lua +local hasUI, isHunterPet = HasPetUI(); +if hasUI then + if isHunterPet then + DoHunterPetStuff(); -- For hunters + else + DoMinionStuff(); -- For Warlock minions + end +end +``` + +**Example Use Case:** +This function can be used to determine if a player has a pet UI active and whether the pet is a hunter pet or another type of minion. This is particularly useful for addons that need to differentiate between hunter pets and other types of pets, such as warlock minions, to execute specific code based on the type of pet. + +**Addon Usage:** +Large addons like **ElvUI** and **Bartender4** use this function to manage pet action bars and pet-related UI elements. For example, ElvUI uses it to show or hide pet action bars based on whether the player has a pet out and if it is a hunter pet. \ No newline at end of file diff --git a/wiki-information/functions/HasWandEquipped.md b/wiki-information/functions/HasWandEquipped.md new file mode 100644 index 00000000..60343a9a --- /dev/null +++ b/wiki-information/functions/HasWandEquipped.md @@ -0,0 +1,8 @@ +## Title: HasWandEquipped + +**Content:** +Returns true if a wand is equipped. + +**Returns:** +- `HasWandEquipped` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/InActiveBattlefield.md b/wiki-information/functions/InActiveBattlefield.md new file mode 100644 index 00000000..078347d0 --- /dev/null +++ b/wiki-information/functions/InActiveBattlefield.md @@ -0,0 +1,13 @@ +## Title: InActiveBattlefield + +**Content:** +Returns whether you are currently in a battleground/battlefield. +`inBattlefield = InActiveBattlefield()` + +**Returns:** +- `inBattlefield` + - *boolean* - true if the player is in an active battlefield, false otherwise. + +**Reference:** +- `IsInInstance` +- `UnitInBattleground` \ No newline at end of file diff --git a/wiki-information/functions/InCinematic.md b/wiki-information/functions/InCinematic.md new file mode 100644 index 00000000..e097cfdf --- /dev/null +++ b/wiki-information/functions/InCinematic.md @@ -0,0 +1,25 @@ +## Title: InCinematic + +**Content:** +Returns true during simple in-game cinematics where only the camera moves, like the race intro cinematics. +`inCinematic = InCinematic()` + +**Returns:** +- `inCinematic` + - *boolean* + +**Usage:** +Prints what type of cinematic is playing on `CINEMATIC_START`. +```lua +local function OnEvent(self, event, ...) + if InCinematic() then + print("simple cinematic") + elseif IsInCinematicScene() then + print("fancy in-game cutscene") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("CINEMATIC_START") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/functions/InCombatLockdown.md b/wiki-information/functions/InCombatLockdown.md new file mode 100644 index 00000000..14c8020b --- /dev/null +++ b/wiki-information/functions/InCombatLockdown.md @@ -0,0 +1,27 @@ +## Title: InCombatLockdown + +**Content:** +Returns true if the combat lockdown restrictions are active. +`inLockdown = InCombatLockdown()` + +**Returns:** +- `inLockdown` + - *boolean* - true if lockdown restrictions are currently in effect, false otherwise. + +**Description:** +Combat lockdown begins after the `PLAYER_REGEN_DISABLED` event fires, and ends before the `PLAYER_REGEN_ENABLED` event fires. + +**Restrictions:** +While in combat: +- Programmatic modification of macros or bindings is not allowed. +- Some actions can't be performed on "Protected" frames, their parents, or any frame they are anchored to. These include, but are not restricted to: + - Hiding the frame using the `Hide` widget method. + - Showing the frame using the `Show` widget method. + - Changing the frame's attributes (custom attributes are used by Blizzard secure templates to set up their behavior). + - Moving the frame by resetting the frame's points or anchors (movements initiated by the user are still allowed while in combat). + +**Example Usage:** +This function is often used in addons to check if the player is in combat before attempting to perform actions that are restricted during combat. For instance, an addon that modifies the user interface might use `InCombatLockdown` to ensure it doesn't try to change protected frames while the player is in combat. + +**Addons Using This Function:** +Many large addons, such as ElvUI and Bartender4, use `InCombatLockdown` to manage their behavior during combat. These addons often need to modify the user interface, and they use this function to avoid performing restricted actions while the player is in combat. \ No newline at end of file diff --git a/wiki-information/functions/InRepairMode.md b/wiki-information/functions/InRepairMode.md new file mode 100644 index 00000000..1d246eca --- /dev/null +++ b/wiki-information/functions/InRepairMode.md @@ -0,0 +1,9 @@ +## Title: InRepairMode + +**Content:** +Returns true if the cursor is in repair mode. +`inRepairMode = InRepairMode()` + +**Returns:** +- `inRepairMode` + - *boolean* - Returns true if the cursor is in repair mode. \ No newline at end of file diff --git a/wiki-information/functions/InboxItemCanDelete.md b/wiki-information/functions/InboxItemCanDelete.md new file mode 100644 index 00000000..c9f2c34d --- /dev/null +++ b/wiki-information/functions/InboxItemCanDelete.md @@ -0,0 +1,18 @@ +## Title: InboxItemCanDelete + +**Content:** +Returns true if a message can be deleted, false if it can be returned to sender. +`canDelete = InboxItemCanDelete(index)` + +**Parameters:** +- `index` + - *number* - the index of the message (1 is the first message) + +**Returns:** +- `canDelete` + - *Flag* - false if a mailed item or money is returnable, true otherwise. + +**Description:** +InboxItemCanDelete() is used by Blizzard's MailFrame.lua to determine whether a mail message is returnable, and thus whether it should put a "Return" button on the message frame or a "Delete" button. This is true when the message has been sent by the Auction House or an NPC, or has been bounced back (returned) from a player character. It will be false when it is an original message from a player character. + +This function should not be confused with whether DeleteInboxItem will succeed or not; despite its name, InboxItemCanDelete is not checking for whether you are allowed to delete a message. For safety, assume that DeleteInboxItem will succeed whenever it is passed a valid index, regardless of whether the message contains any item or money. It is Blizzard's MailFrame.lua that provides confirmation boxes for deleting messages that still have an item or money attached. \ No newline at end of file diff --git a/wiki-information/functions/InitiateRolePoll.md b/wiki-information/functions/InitiateRolePoll.md new file mode 100644 index 00000000..c0d70688 --- /dev/null +++ b/wiki-information/functions/InitiateRolePoll.md @@ -0,0 +1,23 @@ +## Title: InitiateRolePoll + +**Content:** +Starts a role check. +`result = InitiateRolePoll()` + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +```lua +-- Initiates a role poll in a group or raid +local result = InitiateRolePoll() +if result then + print("Role poll initiated successfully.") +else + print("Failed to initiate role poll.") +end +``` + +**Description:** +The `InitiateRolePoll` function is used to start a role check in a group or raid. This is typically used in dungeons or raids to ensure that all members have selected their roles (tank, healer, or damage dealer) before proceeding. This function returns a boolean value indicating whether the role poll was successfully initiated. \ No newline at end of file diff --git a/wiki-information/functions/InitiateTrade.md b/wiki-information/functions/InitiateTrade.md new file mode 100644 index 00000000..0c7961cd --- /dev/null +++ b/wiki-information/functions/InitiateTrade.md @@ -0,0 +1,28 @@ +## Title: InitiateTrade + +**Content:** +Opens a trade with the specified unit. +`InitiateTrade(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The player to trade with. + +**Reference:** +- `TRADE_ACCEPT_UPDATE` +- `TRADE_CLOSED` +- `TRADE_MONEY_CHANGED` +- `TRADE_PLAYER_ITEM_CHANGED` +- `TRADE_REPLACE_ENCHANT` +- `TRADE_REQUEST` +- `TRADE_REQUEST_CANCEL` + +**Example Usage:** +```lua +-- Initiates a trade with the target player +local targetUnit = "target" +InitiateTrade(targetUnit) +``` + +**Additional Information:** +This function is commonly used in addons that facilitate trading between players, such as auction house addons or inventory management addons. For example, the popular addon "TradeSkillMaster" might use this function to automate trading processes. \ No newline at end of file diff --git a/wiki-information/functions/InviteUnit.md b/wiki-information/functions/InviteUnit.md new file mode 100644 index 00000000..d4a90aeb --- /dev/null +++ b/wiki-information/functions/InviteUnit.md @@ -0,0 +1,16 @@ +## Title: InviteUnit + +**Content:** +Invite a player to join your party. +`InviteUnit(playerName)` + +**Parameters:** +- `playerName` + - *string* - The name of the player you would like to invite to a group. + +**Description:** +Do not prehook this function in Classic Wrath as the LFG/Group Finder uses it directly. Only Secure Hook it. + +**Reference:** +- `UninviteUnit` +- `InviteToGroup` \ No newline at end of file diff --git a/wiki-information/functions/Is64BitClient.md b/wiki-information/functions/Is64BitClient.md new file mode 100644 index 00000000..bdd7f1e5 --- /dev/null +++ b/wiki-information/functions/Is64BitClient.md @@ -0,0 +1,24 @@ +## Title: Is64BitClient + +**Content:** +Needs summary. +`is64Bit = Is64BitClient()` + +**Returns:** +- `is64Bit` + - *boolean* + +**Example Usage:** +This function can be used to determine if the World of Warcraft client is running in a 64-bit environment. This can be useful for addons that need to optimize performance or compatibility based on the architecture of the client. + +**Example:** +```lua +if Is64BitClient() then + print("Running on a 64-bit client.") +else + print("Running on a 32-bit client.") +end +``` + +**Addons:** +Many performance-intensive addons, such as WeakAuras, might use this function to adjust their behavior based on the client's architecture to ensure optimal performance. \ No newline at end of file diff --git a/wiki-information/functions/IsAccountSecured.md b/wiki-information/functions/IsAccountSecured.md new file mode 100644 index 00000000..be7001ea --- /dev/null +++ b/wiki-information/functions/IsAccountSecured.md @@ -0,0 +1,12 @@ +## Title: IsAccountSecured + +**Content:** +Returns if the account has been secured with Blizzard Mobile Authenticator. +`isSecured = IsAccountSecured()` + +**Returns:** +- `isSecured` + - *boolean* + +**Reference:** +- 2018-01-16, ContainerFrame.lua, version 7.3.5.25864, near line 692, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/IsAchievementEligible.md b/wiki-information/functions/IsAchievementEligible.md new file mode 100644 index 00000000..7d9de2a7 --- /dev/null +++ b/wiki-information/functions/IsAchievementEligible.md @@ -0,0 +1,16 @@ +## Title: IsAchievementEligible + +**Content:** +Indicates whether the specified achievement is eligible to be completed. +`eligible = IsAchievementEligible(achievementID)` + +**Parameters:** +- `achievementID` + - *number* - ID of the achievement to query. + +**Returns:** +- `eligible` + - *boolean* + +**Description:** +This function is used in the watch frame to determine whether a tracked achievement should be shown in red text (not eligible) or normal colors (eligible). \ No newline at end of file diff --git a/wiki-information/functions/IsActionInRange.md b/wiki-information/functions/IsActionInRange.md new file mode 100644 index 00000000..177a3e06 --- /dev/null +++ b/wiki-information/functions/IsActionInRange.md @@ -0,0 +1,25 @@ +## Title: IsActionInRange + +**Content:** +Returns true if the specified action is in range. +`inRange = IsActionInRange(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - The action slot to test. + +**Returns:** +- `inRange` + - *boolean* - `nil` if the slot has no action, or if the action cannot be used on the current target, or if range does not apply; `false` if the action is out of range, and `true` otherwise. + +**Reference:** +- `IsSpellInRange` +- `IsItemInRange` +- `CheckInteractDistance` +- `ActionHasRange` + +**Example Usage:** +This function can be used in macros or addons to determine if a specific action (like a spell or ability) can be used on the current target. For instance, an addon could use this to display a warning if the player is out of range for their primary attack. + +**Addons:** +Many combat-related addons, such as WeakAuras and Bartender4, use this function to provide feedback on action availability and range. For example, WeakAuras might use it to trigger visual alerts when an ability is out of range. \ No newline at end of file diff --git a/wiki-information/functions/IsActiveBattlefieldArena.md b/wiki-information/functions/IsActiveBattlefieldArena.md new file mode 100644 index 00000000..f8b8b510 --- /dev/null +++ b/wiki-information/functions/IsActiveBattlefieldArena.md @@ -0,0 +1,14 @@ +## Title: IsActiveBattlefieldArena + +**Content:** +Returns true if the player is inside a (rated) arena. +`isArena, isRegistered = IsActiveBattlefieldArena()` + +**Returns:** +- `isArena` + - *boolean* - If the player is inside an arena. +- `isRegistered` + - *boolean* - If the player is playing a rated arena match. + +**Description:** +If you are in the waiting room and/or countdown is going on, it will return false. \ No newline at end of file diff --git a/wiki-information/functions/IsAddOnLoadOnDemand.md b/wiki-information/functions/IsAddOnLoadOnDemand.md new file mode 100644 index 00000000..e34d6751 --- /dev/null +++ b/wiki-information/functions/IsAddOnLoadOnDemand.md @@ -0,0 +1,23 @@ +## Title: IsAddOnLoadOnDemand + +**Content:** +Returns true if the specified addon is load-on-demand. +`loadDemand = IsAddOnLoadOnDemand(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `loadDemand` + - *boolean* - True if the specified addon is loaded on demand. + +**Usage:** +Loads every LoD addon. +```lua +for i = 1, GetNumAddOns() do + if IsAddOnLoadOnDemand(i) then + LoadAddOn(i) + end +end +``` \ No newline at end of file diff --git a/wiki-information/functions/IsAddOnLoaded.md b/wiki-information/functions/IsAddOnLoaded.md new file mode 100644 index 00000000..fbfc5be4 --- /dev/null +++ b/wiki-information/functions/IsAddOnLoaded.md @@ -0,0 +1,15 @@ +## Title: IsAddOnLoaded + +**Content:** +Returns true if the specified addon is loaded. +`loaded, finished = IsAddOnLoaded(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `loaded` + - *boolean* - True if the addon has been, or is being loaded. +- `finished` + - *boolean* - True if the addon has finished loading and ADDON_LOADED has been fired for this addon. \ No newline at end of file diff --git a/wiki-information/functions/IsAllowedToUserTeleport.md b/wiki-information/functions/IsAllowedToUserTeleport.md new file mode 100644 index 00000000..2d88e07e --- /dev/null +++ b/wiki-information/functions/IsAllowedToUserTeleport.md @@ -0,0 +1,15 @@ +## Title: IsAllowedToUserTeleport + +**Content:** +Returns whether the player can teleport to/from an LFG instance. +`allowedToTeleport = IsAllowedToUserTeleport()` + +**Returns:** +- `allowedToTeleport` + - *boolean* - true if the player can teleport to/from an LFG instance, false otherwise. + +**Description:** +The player cannot teleport out of the solo scenarios introduced in Patch 5.2. + +**Reference:** +LFGTeleport \ No newline at end of file diff --git a/wiki-information/functions/IsAltKeyDown.md b/wiki-information/functions/IsAltKeyDown.md new file mode 100644 index 00000000..e8c87cd7 --- /dev/null +++ b/wiki-information/functions/IsAltKeyDown.md @@ -0,0 +1,30 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/functions/IsAttackAction.md b/wiki-information/functions/IsAttackAction.md new file mode 100644 index 00000000..96cb425e --- /dev/null +++ b/wiki-information/functions/IsAttackAction.md @@ -0,0 +1,13 @@ +## Title: IsAttackAction + +**Content:** +Returns true if an action is the "Auto Attack" action. +`isAttack = IsAttackAction(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - The action slot to test. + +**Returns:** +- `isAttack` + - *Flag* - `nil` if the specified slot is not an attack action, or is empty. `1` if the slot is an attack action and should flash red during combat. \ No newline at end of file diff --git a/wiki-information/functions/IsAttackSpell.md b/wiki-information/functions/IsAttackSpell.md new file mode 100644 index 00000000..c9e78eb5 --- /dev/null +++ b/wiki-information/functions/IsAttackSpell.md @@ -0,0 +1,13 @@ +## Title: IsAttackSpell + +**Content:** +Returns true if a spellbook item is the "Auto Attack" spell. +`isAttack = IsAttackSpell(spellName)` + +**Parameters:** +- `spellName` + - *string* - The spell name to test. + +**Returns:** +- `isAttack` + - *Flag* - Returns 1 if the spell is the "Attack" spell, nil otherwise \ No newline at end of file diff --git a/wiki-information/functions/IsAutoRepeatAction.md b/wiki-information/functions/IsAutoRepeatAction.md new file mode 100644 index 00000000..400d30aa --- /dev/null +++ b/wiki-information/functions/IsAutoRepeatAction.md @@ -0,0 +1,22 @@ +## Title: IsAutoRepeatAction + +**Content:** +Returns true if an action is currently auto-repeating (e.g. Shoot for wand and Auto Shot for Hunters). +`isRepeating = IsAutoRepeatAction(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - The action slot to query. + +**Returns:** +- `isRepeating` + - *boolean* - true if the action in the slot is currently auto-repeating, false if it is not auto-repeating or the slot is empty. + +**Reference:** +- `IsAutoRepeatSpell` + +**Example Usage:** +This function can be used to check if a Hunter's Auto Shot or a Mage's wand attack is currently active. For instance, an addon could use this to display an indicator when auto-repeating actions are active. + +**Addon Usage:** +Large addons like WeakAuras might use this function to create custom alerts or visual effects when auto-repeating actions are active, enhancing the player's awareness during combat. \ No newline at end of file diff --git a/wiki-information/functions/IsBattlePayItem.md b/wiki-information/functions/IsBattlePayItem.md new file mode 100644 index 00000000..1c117a69 --- /dev/null +++ b/wiki-information/functions/IsBattlePayItem.md @@ -0,0 +1,15 @@ +## Title: IsBattlePayItem + +**Content:** +Returns whether an item was purchased from the in-game store. +`isPayItem = IsBattlePayItem(bag, slot)` + +**Parameters:** +- `bag` + - *number (bagID)* - container ID, e.g. 0 for backpack. +- `slot` + - *number* - slot index within the container, ascending from 1. + +**Returns:** +- `isPayItem` + - *boolean* - true if the item was purchased from the in-game store, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsCemeterySelectionAvailable.md b/wiki-information/functions/IsCemeterySelectionAvailable.md new file mode 100644 index 00000000..a5b4f80b --- /dev/null +++ b/wiki-information/functions/IsCemeterySelectionAvailable.md @@ -0,0 +1,9 @@ +## Title: IsCemeterySelectionAvailable + +**Content:** +Needs summary. +`result = IsCemeterySelectionAvailable()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsConsumableAction.md b/wiki-information/functions/IsConsumableAction.md new file mode 100644 index 00000000..8bf83ecf --- /dev/null +++ b/wiki-information/functions/IsConsumableAction.md @@ -0,0 +1,20 @@ +## Title: IsConsumableAction + +**Content:** +Returns true if an action is a consumable, i.e. it has a count. +`isTrue = IsConsumableAction(slotID)` + +**Parameters:** +- `slotID` + - *ActionSlot* - The tested action slot. + +**Returns:** +- `isTrue` + - *Boolean* - True if the action in the specified slot is linked to a consumable, e.g. a potion action. False if the action is not consumable or if the action is empty. + +**Description:** +Most consumable actions have a small number displayed in the bottom right corner of their action icon. +However, in Classic, spells requiring a reagent may return true to `IsConsumableAction()` but false to both `IsItemAction` and `IsStackableAction`; such spells do not display a number. + +**Details:** +Currently, thrown weapons show up with a count of 1. In WoW 2.0, throwing weapons have durability and can be repaired, so this is likely a bug. \ No newline at end of file diff --git a/wiki-information/functions/IsConsumableItem.md b/wiki-information/functions/IsConsumableItem.md new file mode 100644 index 00000000..01cedfcc --- /dev/null +++ b/wiki-information/functions/IsConsumableItem.md @@ -0,0 +1,13 @@ +## Title: IsConsumableItem + +**Content:** +Returns whether an item is consumed when used. +`isConsumable = IsConsumableItem(itemID or itemLink or itemName)` + +**Parameters:** +- `item` + - *Mixed* - An item ID (number), item link, or item name (string) to query. + +**Returns:** +- `isConsumable` + - *boolean* - 1 if the item is consumed when used, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsControlKeyDown.md b/wiki-information/functions/IsControlKeyDown.md new file mode 100644 index 00000000..67a6196b --- /dev/null +++ b/wiki-information/functions/IsControlKeyDown.md @@ -0,0 +1,31 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +Related Events: +- `MODIFIER_STATE_CHANGED` + +Related API: +- `IsModifiedClick` +- `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/functions/IsCurrentAction.md b/wiki-information/functions/IsCurrentAction.md new file mode 100644 index 00000000..17cadce8 --- /dev/null +++ b/wiki-information/functions/IsCurrentAction.md @@ -0,0 +1,19 @@ +## Title: IsCurrentAction + +**Content:** +Returns true if the specified action is currently being used. +`isCurrent = IsCurrentAction(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - action slot ID to query. + +**Returns:** +- `isCurrent` + - *boolean* - 1 if the action in the slot is currently executing, nil otherwise. + +**Example Usage:** +This function can be used to check if a specific action (like a spell or ability) is currently being executed by the player. For instance, it can be useful in creating custom action bar addons to highlight or indicate the currently active action. + +**Addon Usage:** +Many action bar addons, such as Bartender4 and Dominos, use this function to manage and display the state of action buttons, ensuring that the user interface accurately reflects the player's current actions. \ No newline at end of file diff --git a/wiki-information/functions/IsCurrentSpell.md b/wiki-information/functions/IsCurrentSpell.md new file mode 100644 index 00000000..b88fd558 --- /dev/null +++ b/wiki-information/functions/IsCurrentSpell.md @@ -0,0 +1,14 @@ +## Title: IsCurrentSpell + +**Content:** +Returns true if the specified spell ID is currently being casted or queued. +If the spell is current, then the action bar indicates its slot with a highlighted frame. +`isCurrent = IsCurrentSpell(spellID)` + +**Parameters:** +- `spellID` + - *number* - spell ID to query. + +**Returns:** +- `isCurrent` + - *boolean* - true if currently being casted or queued, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsDebugBuild.md b/wiki-information/functions/IsDebugBuild.md new file mode 100644 index 00000000..f0d7d5d4 --- /dev/null +++ b/wiki-information/functions/IsDebugBuild.md @@ -0,0 +1,9 @@ +## Title: IsDebugBuild + +**Content:** +Needs summary. +`isDebugBuild = IsDebugBuild()` + +**Returns:** +- `isDebugBuild` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsDualWielding.md b/wiki-information/functions/IsDualWielding.md new file mode 100644 index 00000000..1960e94c --- /dev/null +++ b/wiki-information/functions/IsDualWielding.md @@ -0,0 +1,9 @@ +## Title: IsDualWielding + +**Content:** +Returns if your character is Dual wielding. +`isDualWield = IsDualWielding()` + +**Returns:** +- `isDualWield` + - *boolean* - True if wielding more than 1 weapon (or whenever a weapon is equipped in Off-Hand), false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsEquippableItem.md b/wiki-information/functions/IsEquippableItem.md new file mode 100644 index 00000000..41c1cbed --- /dev/null +++ b/wiki-information/functions/IsEquippableItem.md @@ -0,0 +1,36 @@ +## Title: IsEquippableItem + +**Content:** +Returns true if an item is equipable by the player. +`result = IsEquippableItem(itemId or itemName or itemLink)` + +**Parameters:** +- `(itemId or "itemName" or "itemLink")` + - `itemId` + - *number* - The numeric ID of the item. e.g., 12345 + - `itemName` + - *string* - The Name of the Item, e.g., "Heavy Silk Bandage" + - `itemLink` + - *string* - The itemLink, when Shift-Clicking items. + +**Returns:** +- `result` + - 1 if equip-able, nil otherwise. + +**Usage:** +On a Druid: +```lua +/dump IsEquippableItem("Heavy Silk Bandage") +1 +/dump IsEquippableItem("Moonkin Form") +1 +/dump IsEquippableItem("Some Non-Equipable Item") +nil +``` + +**Example Use Case:** +This function can be used in an addon to filter out items that the player cannot equip, which is useful for inventory management addons or loot distribution systems. + +**Addons Using This Function:** +- **Bagnon**: A popular inventory management addon that uses this function to determine which items can be equipped by the player, helping to organize the player's bags more efficiently. +- **Pawn**: An addon that helps players decide which gear is better for their character. It uses this function to ensure that only equippable items are considered in its calculations. \ No newline at end of file diff --git a/wiki-information/functions/IsEquippedAction.md b/wiki-information/functions/IsEquippedAction.md new file mode 100644 index 00000000..19ffa4e5 --- /dev/null +++ b/wiki-information/functions/IsEquippedAction.md @@ -0,0 +1,13 @@ +## Title: IsEquippedAction + +**Content:** +Returns true if the specified action slot is an equipped item. +`isEquipped = IsEquippedAction(slotID)` + +**Parameters:** +- `slotID` + - *number (actionSlot)* - Action slot to query. + +**Returns:** +- `isEquipped` + - *boolean* - true if the specified action slot contains a currently equipped item, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsEquippedItem.md b/wiki-information/functions/IsEquippedItem.md new file mode 100644 index 00000000..3efbc8b2 --- /dev/null +++ b/wiki-information/functions/IsEquippedItem.md @@ -0,0 +1,15 @@ +## Title: IsEquippedItem + +**Content:** +Determines if an item is equipped. +`isEquipped = IsEquippedItem(itemID or itemName)` + +**Parameters:** +- `itemId` + - *number* - identifier for each unique item +- `itemname` + - *string* - localized name of an item + +**Returns:** +- `isEquipped` + - *boolean* - is item equipped \ No newline at end of file diff --git a/wiki-information/functions/IsEquippedItemType.md b/wiki-information/functions/IsEquippedItemType.md new file mode 100644 index 00000000..0401daa4 --- /dev/null +++ b/wiki-information/functions/IsEquippedItemType.md @@ -0,0 +1,22 @@ +## Title: IsEquippedItemType + +**Content:** +Returns true if an item of a given type is equipped. +`isEquipped = IsEquippedItemType(type)` + +**Parameters:** +- `type` + - *string (ItemType)* - any valid inventory type, item class, or item subclass + +**Returns:** +- `isEquipped` + - *boolean* - is an item of the given type equipped + +**Usage:** +```lua +if IsEquippedItemType("Shields") then + DEFAULT_CHAT_FRAME:AddMessage("I have a shield") +end +``` +**Result:** +Outputs "I have a shield" to the default chat window if the player has a shield equipped. \ No newline at end of file diff --git a/wiki-information/functions/IsEuropeanNumbers.md b/wiki-information/functions/IsEuropeanNumbers.md new file mode 100644 index 00000000..3e2be4b9 --- /dev/null +++ b/wiki-information/functions/IsEuropeanNumbers.md @@ -0,0 +1,9 @@ +## Title: IsEuropeanNumbers + +**Content:** +Needs summary. +`enabled = IsEuropeanNumbers()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsExpansionTrial.md b/wiki-information/functions/IsExpansionTrial.md new file mode 100644 index 00000000..82f7157e --- /dev/null +++ b/wiki-information/functions/IsExpansionTrial.md @@ -0,0 +1,15 @@ +## Title: IsExpansionTrial + +**Content:** +Needs summary. +`isExpansionTrialAccount = IsExpansionTrial()` + +**Returns:** +- `isExpansionTrialAccount` + - *boolean* + +**Example Usage:** +This function can be used to check if the current account is an expansion trial account. This might be useful for addons that need to adjust their functionality based on the type of account being used. + +**Addons:** +Many large addons, such as ElvUI or WeakAuras, might use this function to tailor their features or display certain messages based on whether the user is on an expansion trial account. \ No newline at end of file diff --git a/wiki-information/functions/IsFactionInactive.md b/wiki-information/functions/IsFactionInactive.md new file mode 100644 index 00000000..bb77c1b6 --- /dev/null +++ b/wiki-information/functions/IsFactionInactive.md @@ -0,0 +1,17 @@ +## Title: IsFactionInactive + +**Content:** +Returns true if the specified faction is marked inactive. +`inactive = IsFactionInactive(index)` + +**Parameters:** +- `index` + - *number* - index of the faction within the faction list, ascending from 1. + +**Returns:** +- `inactive` + - *boolean* - 1 if the faction is flagged as inactive, nil otherwise. + +**Reference:** +- `SetFactionInactive` +- `SetFactionActive` \ No newline at end of file diff --git a/wiki-information/functions/IsFalling.md b/wiki-information/functions/IsFalling.md new file mode 100644 index 00000000..635f8952 --- /dev/null +++ b/wiki-information/functions/IsFalling.md @@ -0,0 +1,13 @@ +## Title: IsFalling + +**Content:** +Returns true if the specified unit is currently falling. +`falling = IsFalling()` + +**Parameters:** +- `unit` + - *string?* : UnitToken - A unitID to query. Defaults to player if omitted. + +**Returns:** +- `falling` + - *boolean* - true if the unit is currently falling, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsFishingLoot.md b/wiki-information/functions/IsFishingLoot.md new file mode 100644 index 00000000..3a41e812 --- /dev/null +++ b/wiki-information/functions/IsFishingLoot.md @@ -0,0 +1,20 @@ +## Title: IsFishingLoot + +**Content:** +This function is only for determining if the loot window is related to fishing. + +**Returns:** +- `isTrue` + - *boolean* - is it true + +**Usage:** +This will identify that the loot window should display the fish graphic, then play the sound and update the image. +```lua +if IsFishingLoot() then + PlaySound("FISHING REEL IN") + LootFramePortraitOverlay:SetTexture("Interface\\LootFrame\\FishingLoot-Icon") +end +``` + +**Example Use Case:** +- **Fishing Addons:** Many fishing-related addons, such as Fishing Buddy, use this function to customize the loot window when the player is fishing. This enhances the user experience by providing visual and audio feedback specific to fishing activities. \ No newline at end of file diff --git a/wiki-information/functions/IsFlyableArea.md b/wiki-information/functions/IsFlyableArea.md new file mode 100644 index 00000000..1a67e4ea --- /dev/null +++ b/wiki-information/functions/IsFlyableArea.md @@ -0,0 +1,16 @@ +## Title: IsFlyableArea + +**Content:** +Returns true if the current zone is a flyable area. +`flyable = IsFlyableArea()` + +**Returns:** +- `flyable` + - *boolean* + +**Description:** +This function corresponds to the flyable macro conditional. +This function will return false if the player is located in an indoors area where mounts typically cannot be used. + +**Reference:** +- `IsAdvancedFlyableArea()` \ No newline at end of file diff --git a/wiki-information/functions/IsFlying.md b/wiki-information/functions/IsFlying.md new file mode 100644 index 00000000..a16aa3e1 --- /dev/null +++ b/wiki-information/functions/IsFlying.md @@ -0,0 +1,13 @@ +## Title: IsFlying + +**Content:** +Returns true if the character is currently on a flying mount. +`flying = IsFlying()` + +**Parameters:** +- `unit` + - *string?* : UnitToken + +**Returns:** +- `flying` + - *boolean* - True if the character is currently flying, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsGMClient.md b/wiki-information/functions/IsGMClient.md new file mode 100644 index 00000000..a2c96021 --- /dev/null +++ b/wiki-information/functions/IsGMClient.md @@ -0,0 +1,9 @@ +## Title: IsGMClient + +**Content:** +Returns true if the client downloaded has the GM MPQs attached, returns false otherwise. +`isGM = IsGMClient()` + +**Returns:** +- `isGM` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsGUIDInGroup.md b/wiki-information/functions/IsGUIDInGroup.md new file mode 100644 index 00000000..4787b853 --- /dev/null +++ b/wiki-information/functions/IsGUIDInGroup.md @@ -0,0 +1,28 @@ +## Title: IsGUIDInGroup + +**Content:** +Returns whether or not the unit with the given GUID is in your group. +`inGroup = IsGUIDInGroup(UnitGUID, )` + +**Parameters:** +- `guid` + - *string* : WOWGUID +- `groupType` + - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. + - **Value** + - **Enum** + - **Description** + - `1` + - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. + - `2` + - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder + +**Returns:** +- `inGroup` + - *bool* - True if the given GUID is in your group, considering groupType if provided, otherwise false. + +**Description:** +- **Related API** + - `UnitGUID` +- **Related Event** + - `GROUP_ROSTER_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/IsGuildLeader.md b/wiki-information/functions/IsGuildLeader.md new file mode 100644 index 00000000..4c3b2777 --- /dev/null +++ b/wiki-information/functions/IsGuildLeader.md @@ -0,0 +1,9 @@ +## Title: IsGuildLeader + +**Content:** +Returns true if the player is the guild master. +`isGuildLeader = IsGuildLeader()` + +**Returns:** +- `isGuildLeader` + - *boolean* - true if the player is the guild master, otherwise false. \ No newline at end of file diff --git a/wiki-information/functions/IsInCinematicScene.md b/wiki-information/functions/IsInCinematicScene.md new file mode 100644 index 00000000..84bab990 --- /dev/null +++ b/wiki-information/functions/IsInCinematicScene.md @@ -0,0 +1,25 @@ +## Title: IsInCinematicScene + +**Content:** +Returns true during in-game cinematics/cutscenes involving NPC actors and scenescripts. +`inCinematicScene = IsInCinematicScene()` + +**Returns:** +- `inCinematicScene` + - *boolean* + +**Usage:** +Prints what type of cinematic is playing on `CINEMATIC_START`. +```lua +local function OnEvent(self, event, ...) + if InCinematic() then + print("simple cinematic") + elseif IsInCinematicScene() then + print("fancy in-game cutscene") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("CINEMATIC_START") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/functions/IsInGroup.md b/wiki-information/functions/IsInGroup.md new file mode 100644 index 00000000..c6f777f3 --- /dev/null +++ b/wiki-information/functions/IsInGroup.md @@ -0,0 +1,24 @@ +## Title: IsInGroup + +**Content:** +Returns true if the player is in a group. +`inGroup = IsInGroup()` + +**Parameters:** +- `groupType` + - *number?* - If omitted, checks if you're in any type of group. + - If omitted, defaults to INSTANCE if applicable, HOME otherwise. + - **Value** + - **Enum** + - **Description** + - `1` + - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. + - `2` + - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder + +**Returns:** +- `inGroup` + - *boolean* - Returns true if the player is in the `groupType` group if specified, or in any type of group. + +**Description:** +It is possible for a character to belong to a home group at the same time they are in an instance group (LFR or Flex). To distinguish between a party and a raid, use `IsInRaid()`. \ No newline at end of file diff --git a/wiki-information/functions/IsInGuild.md b/wiki-information/functions/IsInGuild.md new file mode 100644 index 00000000..bebee865 --- /dev/null +++ b/wiki-information/functions/IsInGuild.md @@ -0,0 +1,22 @@ +## Title: IsInGuild + +**Content:** +Lets you know whether you are in a guild. +`inGuild = IsInGuild()` + +**Returns:** +- `inGuild` + - *boolean* + +**Usage:** +```lua +if IsInGuild() then + SendChatMessage("Hi Guild!", "GUILD") +end +``` + +**Example Use Case:** +This function can be used to check if the player is currently in a guild before performing guild-specific actions, such as sending a message to the guild chat. + +**Addons Using This Function:** +Many addons that provide guild management features or enhance guild communication, such as "Guild Roster Manager" or "GreenWall," use this function to ensure that the player is in a guild before executing guild-related functionalities. \ No newline at end of file diff --git a/wiki-information/functions/IsInGuildGroup.md b/wiki-information/functions/IsInGuildGroup.md new file mode 100644 index 00000000..3680c320 --- /dev/null +++ b/wiki-information/functions/IsInGuildGroup.md @@ -0,0 +1,12 @@ +## Title: IsInGuildGroup + +**Content:** +Returns whether or not you are in a guild party. +`inGuildGroup = IsInGuildGroup()` + +**Parameters:** +None + +**Returns:** +- `inGuildGroup` + - *boolean* - True if you are in a valid guild group, otherwise false. \ No newline at end of file diff --git a/wiki-information/functions/IsInInstance.md b/wiki-information/functions/IsInInstance.md new file mode 100644 index 00000000..099b0aa7 --- /dev/null +++ b/wiki-information/functions/IsInInstance.md @@ -0,0 +1,20 @@ +## Title: IsInInstance + +**Content:** +Returns true if the player is in an instance, and the type of instance. +`inInstance, instanceType = IsInInstance()` + +**Returns:** +- `inInstance` + - *boolean* - Whether the player is in an instance; nil otherwise. +- `instanceType` + - *string* - The instance type: + - `"none"` when outside an instance + - `"pvp"` when in a battleground + - `"arena"` when in an arena + - `"party"` when in a 5-man instance + - `"raid"` when in a raid instance + - `"scenario"` when in a scenario + +**Description:** +This function returns correct results immediately upon `PLAYER_ENTERING_WORLD`. \ No newline at end of file diff --git a/wiki-information/functions/IsInLFGDungeon.md b/wiki-information/functions/IsInLFGDungeon.md new file mode 100644 index 00000000..12f9ff4f --- /dev/null +++ b/wiki-information/functions/IsInLFGDungeon.md @@ -0,0 +1,9 @@ +## Title: IsInLFGDungeon + +**Miscellaneous:** +Returns true if the player is in an LFD instance. +`isInLFDInstance = IsInLFGDungeon()` + +**Returns:** +- `isInLFDInstance` + - *boolean* - Whether the player is in a LFD instance; nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsInRaid.md b/wiki-information/functions/IsInRaid.md new file mode 100644 index 00000000..bc78c52a --- /dev/null +++ b/wiki-information/functions/IsInRaid.md @@ -0,0 +1,18 @@ +## Title: IsInRaid + +**Content:** +Returns true if the player is in a raid. +`isInRaid = IsInRaid()` + +**Parameters:** +- `groupType` + - *number?* - To check for a specific type of group, provide one of: + - `LE_PARTY_CATEGORY_HOME` : checks for home-realm parties. + - `LE_PARTY_CATEGORY_INSTANCE` : checks for instance-specific groups. + +**Returns:** +- `isInRaid` + - *boolean* - true if the player is currently in a `groupType` raid group (if `groupType` was not specified, true if in any type of raid), false otherwise. + +**Description:** +This returns true in arenas if `groupType` is `LE_PARTY_CATEGORY_INSTANCE` or is unspecified. \ No newline at end of file diff --git a/wiki-information/functions/IsIndoors.md b/wiki-information/functions/IsIndoors.md new file mode 100644 index 00000000..720310e5 --- /dev/null +++ b/wiki-information/functions/IsIndoors.md @@ -0,0 +1,15 @@ +## Title: IsIndoors + +**Content:** +Returns true if the character is currently indoors. +`indoors = IsIndoors()` + +**Returns:** +- `indoors` + - *boolean* + +**Description:** +This function corresponds to the indoors macro conditional. + +**Reference:** +- `IsOutdoors()` \ No newline at end of file diff --git a/wiki-information/functions/IsItemInRange.md b/wiki-information/functions/IsItemInRange.md new file mode 100644 index 00000000..a27b75f4 --- /dev/null +++ b/wiki-information/functions/IsItemInRange.md @@ -0,0 +1,22 @@ +## Title: IsItemInRange + +**Content:** +Returns whether the item is in usable range of the unit. +`inRange = IsItemInRange(item)` + +**Parameters:** +- `item` + - *number|string* : Item ID, Link or Name - If using an item name, requires the item to be in your inventory. Item IDs and links don't have this requirement. +- `unit` + - *string?* : UnitId - Defaults to "target" + +**Returns:** +- `inRange` + - *boolean* - Whether the item is in range; Returns nil if there is no unit targeted or the item ID is invalid. + +**Usage:** +Prints if you are within 4 yards range of the target by checking the item range. +`/dump IsItemInRange(90175)` + +**Reference:** +- [DeadlyBossMods Usage](https://github.com/DeadlyBossMods/DeadlyBossMods/blob/9.0.21/DBM-Core/DBM-RangeCheck.lua#L57) \ No newline at end of file diff --git a/wiki-information/functions/IsLeftAltKeyDown.md b/wiki-information/functions/IsLeftAltKeyDown.md new file mode 100644 index 00000000..13bd91d9 --- /dev/null +++ b/wiki-information/functions/IsLeftAltKeyDown.md @@ -0,0 +1,36 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` + +**Example Use Case:** +This function can be used in macros or scripts where specific actions need to be performed only when certain modifier keys are held down. For instance, in a custom addon, you might want to trigger a special ability or open a specific interface panel only when the user holds down the control and shift keys simultaneously. + +**Addons Using This Function:** +Many large addons, such as **WeakAuras** and **ElvUI**, use this function to provide enhanced user interactions. For example, WeakAuras might use it to allow users to modify the behavior of their auras based on modifier keys, while ElvUI could use it to offer additional customization options when certain keys are pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsLeftControlKeyDown.md b/wiki-information/functions/IsLeftControlKeyDown.md new file mode 100644 index 00000000..5df1ce6d --- /dev/null +++ b/wiki-information/functions/IsLeftControlKeyDown.md @@ -0,0 +1,45 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown()` +- `IsControlKeyDown()` +- `IsLeftControlKeyDown()` +- `IsRightControlKeyDown()` +- `IsShiftKeyDown()` +- `IsLeftShiftKeyDown()` +- `IsRightShiftKeyDown()` +- `IsAltKeyDown()` +- `IsLeftAltKeyDown()` +- `IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` + +**Example Use Case:** +This function can be used in macros or scripts to check if a modifier key (like Ctrl, Shift, or Alt) is being held down. This is useful for creating complex keybindings or conditional logic in addons. + +**Addons Using This Function:** +Many large addons, such as WeakAuras and Bartender4, use this function to provide advanced keybinding options and conditional displays based on modifier keys. For example, WeakAuras might use it to show or hide certain auras when a modifier key is pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsLeftShiftKeyDown.md b/wiki-information/functions/IsLeftShiftKeyDown.md new file mode 100644 index 00000000..e8c87cd7 --- /dev/null +++ b/wiki-information/functions/IsLeftShiftKeyDown.md @@ -0,0 +1,30 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/functions/IsMacClient.md b/wiki-information/functions/IsMacClient.md new file mode 100644 index 00000000..14dd805a --- /dev/null +++ b/wiki-information/functions/IsMacClient.md @@ -0,0 +1,9 @@ +## Title: IsMacClient + +**Content:** +Returns true if on a Mac client. +`isMac = IsMacClient()` + +**Returns:** +- `isMac` + - *boolean* - true (1?) if the game is running on a mac client, false (nil?) otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsMetaKeyDown.md b/wiki-information/functions/IsMetaKeyDown.md new file mode 100644 index 00000000..287dedd0 --- /dev/null +++ b/wiki-information/functions/IsMetaKeyDown.md @@ -0,0 +1,9 @@ +## Title: IsMetaKeyDown + +**Content:** +Needs summary. +`down = IsMetaKeyDown()` + +**Returns:** +- `down` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsModifiedClick.md b/wiki-information/functions/IsModifiedClick.md new file mode 100644 index 00000000..e93847b8 --- /dev/null +++ b/wiki-information/functions/IsModifiedClick.md @@ -0,0 +1,36 @@ +## Title: IsModifiedClick + +**Content:** +Returns true if the modifier key needed for an action is pressed. +`isHeld = IsModifiedClick()` + +**Parameters:** +- `action` + - *string?* - The action to check for. Actions defined by Blizzard: + - `AUTOLOOTTOGGLE` + - `CHATLINK` + - `COMPAREITEMS` + - `DRESSUP` + - `FOCUSCAST` + - `OPENALLBAGS` + - `PICKUPACTION` + - `QUESTWATCHTOGGLE` + - `SELFCAST` + - `SHOWITEMFLYOUT` + - `SOCKETITEM` + - `SPLITSTACK` + - `STICKYCAMERA` + - `TOKENWATCHTOGGLE` + +**Returns:** +- `isHeld` + - *boolean* - true if the modifier is being held, false otherwise + +**Description:** +Despite the name, this function does not have anything to do with mouse buttons and can be used at any time to check the state of a modifier key; it is not limited to use in click-related scripts. +This function can be called with no argument to check whether *any* modifier key is pressed; in this case it behaves just like `IsModifierKeyDown`. + +**Reference:** +- `GetModifiedClick` +- `SetModifiedClick` +- `IsModifierKeyDown` \ No newline at end of file diff --git a/wiki-information/functions/IsModifierKeyDown.md b/wiki-information/functions/IsModifierKeyDown.md new file mode 100644 index 00000000..fc735df0 --- /dev/null +++ b/wiki-information/functions/IsModifierKeyDown.md @@ -0,0 +1,36 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` + +**Example Use Case:** +This function can be used in scenarios where you need to check if a user is holding down a modifier key (like Ctrl, Shift, or Alt) to perform specific actions, such as multi-selecting items in an inventory or triggering special abilities in a game. + +**Addons Using This Function:** +Many large addons, such as ElvUI and WeakAuras, use this function to enhance user interactions. For example, ElvUI might use it to allow users to drag UI elements while holding down a modifier key, and WeakAuras could use it to display additional information or options when a modifier key is pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsMounted.md b/wiki-information/functions/IsMounted.md new file mode 100644 index 00000000..bb193f35 --- /dev/null +++ b/wiki-information/functions/IsMounted.md @@ -0,0 +1,9 @@ +## Title: IsMounted + +**Content:** +Returns true if the character is currently mounted. +`mounted = IsMounted()` + +**Returns:** +- `mounted` + - *boolean* - true if the character is currently mounted \ No newline at end of file diff --git a/wiki-information/functions/IsMouseButtonDown.md b/wiki-information/functions/IsMouseButtonDown.md new file mode 100644 index 00000000..d6f61431 --- /dev/null +++ b/wiki-information/functions/IsMouseButtonDown.md @@ -0,0 +1,14 @@ +## Title: IsMouseButtonDown + +**Content:** +Returns whether a mouse button is being held down. +`isDown = IsMouseButtonDown()` + +**Parameters:** +- `button` + - *string?* - Name of the button. If not passed, then it returns if any mouse button is pressed. + - Possible values: `LeftButton`, `RightButton`, `MiddleButton`, `Button4`, `Button5` + +**Returns:** +- `isDown` + - *boolean* - Returns whether the given mouse button is held down. \ No newline at end of file diff --git a/wiki-information/functions/IsMouselooking.md b/wiki-information/functions/IsMouselooking.md new file mode 100644 index 00000000..4171acae --- /dev/null +++ b/wiki-information/functions/IsMouselooking.md @@ -0,0 +1,12 @@ +## Title: IsMouselooking + +**Content:** +Returns true if the player is currently in mouselook mode. +`IsMouselooking()` + +**Returns:** +- `isMouseLooking` + - *boolean* + +**Description:** +In 1.10, a Mouselook mode was added to the UI. \ No newline at end of file diff --git a/wiki-information/functions/IsMovieLocal.md b/wiki-information/functions/IsMovieLocal.md new file mode 100644 index 00000000..989a82df --- /dev/null +++ b/wiki-information/functions/IsMovieLocal.md @@ -0,0 +1,13 @@ +## Title: IsMovieLocal + +**Content:** +Needs summary. +`isLocal = IsMovieLocal(movieId)` + +**Parameters:** +- `movieId` + - *number* + +**Returns:** +- `isLocal` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsMoviePlayable.md b/wiki-information/functions/IsMoviePlayable.md new file mode 100644 index 00000000..302512b7 --- /dev/null +++ b/wiki-information/functions/IsMoviePlayable.md @@ -0,0 +1,26 @@ +## Title: IsMoviePlayable + +**Content:** +Returns true if the specified movie exists and can be played. +`playable = IsMoviePlayable(movieID)` + +**Parameters:** +- `movieID` + - *number* + +**Returns:** +- `playable` + - *boolean* + +**Example Usage:** +```lua +local movieID = 1 -- Example movie ID +if IsMoviePlayable(movieID) then + print("The movie is playable.") +else + print("The movie is not playable.") +end +``` + +**Description:** +The `IsMoviePlayable` function is used to check if a specific in-game cinematic or movie can be played. This can be useful for addons that manage or display in-game cinematics, ensuring that the movie exists before attempting to play it. \ No newline at end of file diff --git a/wiki-information/functions/IsOnGlueScreen.md b/wiki-information/functions/IsOnGlueScreen.md new file mode 100644 index 00000000..0b75173a --- /dev/null +++ b/wiki-information/functions/IsOnGlueScreen.md @@ -0,0 +1,12 @@ +## Title: IsOnGlueScreen + +**Content:** +Returns whether the game is currently showing a GlueXML screen (i.e. no character is logged in). +`isOnGlueScreen = IsOnGlueScreen()` + +**Returns:** +- `isOnGlueScreen` + - *boolean* - false if a character is logged in; true otherwise. + +**Description:** +This function will always return false if called by an AddOn -- addons only run when a character is logged in. \ No newline at end of file diff --git a/wiki-information/functions/IsOnTournamentRealm.md b/wiki-information/functions/IsOnTournamentRealm.md new file mode 100644 index 00000000..596ba7e0 --- /dev/null +++ b/wiki-information/functions/IsOnTournamentRealm.md @@ -0,0 +1,9 @@ +## Title: IsOnTournamentRealm + +**Content:** +Needs summary. +`result = IsOnTournamentRealm()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsOutOfBounds.md b/wiki-information/functions/IsOutOfBounds.md new file mode 100644 index 00000000..437877e8 --- /dev/null +++ b/wiki-information/functions/IsOutOfBounds.md @@ -0,0 +1,12 @@ +## Title: IsOutOfBounds + +**Content:** +Returns true if the player is currently outside of map boundaries. +`oob = IsOutOfBounds()` + +**Returns:** +- `oob` + - *boolean* - True if the player's character is currently outside of the map, false otherwise. + +**Description:** +Players may end up outside of a map's bounds (and therefore dead) both as a consequence of geometry errors and normal world design: for instance, falling off the Eye of the Storm, or being dropped off the top of Icecrown Citadel by the Lich King's val'kyrs. \ No newline at end of file diff --git a/wiki-information/functions/IsOutdoors.md b/wiki-information/functions/IsOutdoors.md new file mode 100644 index 00000000..b4f84802 --- /dev/null +++ b/wiki-information/functions/IsOutdoors.md @@ -0,0 +1,15 @@ +## Title: IsOutdoors + +**Content:** +Returns true if the character is currently outdoors. +`outdoors = IsOutdoors()` + +**Returns:** +- `outdoors` + - *boolean* + +**Description:** +This function corresponds to the outdoors macro conditional. + +**Reference:** +- `IsIndoors()` \ No newline at end of file diff --git a/wiki-information/functions/IsPVPTimerRunning.md b/wiki-information/functions/IsPVPTimerRunning.md new file mode 100644 index 00000000..1c438a63 --- /dev/null +++ b/wiki-information/functions/IsPVPTimerRunning.md @@ -0,0 +1,9 @@ +## Title: IsPVPTimerRunning + +**Content:** +Needs summary. +`isRunning = IsPVPTimerRunning()` + +**Returns:** +- `isRunning` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPassiveSpell.md b/wiki-information/functions/IsPassiveSpell.md new file mode 100644 index 00000000..bac15895 --- /dev/null +++ b/wiki-information/functions/IsPassiveSpell.md @@ -0,0 +1,27 @@ +## Title: IsPassiveSpell + +**Content:** +Returns true if the specified spell is a passive ability. +`isPassive = IsPassiveSpell(spellId or index, bookType)` + +**Parameters:** +- `spellId` + - *number* - spell ID to query. +- `index` + - *number* - spellbook slot index, ascending from 1. +- `bookType` + - *string* - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet"). "spell" is linked to your General Spellbook tab. + +**Returns:** +- `isPassive` + - *Flag* : 1 if the spell is passive, nil otherwise. + +**Description:** +With my Human Paladin, here are the "spells" I found to be Passive: +- Block (Passive) +- Diplomacy (Racial Passive) +- Dodge (Passive) +- Mace Specialization (Passive) +- Parry (Passive) +- Sword Specialization (Passive) +- The Human Spirit (Racial Passive) \ No newline at end of file diff --git a/wiki-information/functions/IsPetAttackActive.md b/wiki-information/functions/IsPetAttackActive.md new file mode 100644 index 00000000..a3a88470 --- /dev/null +++ b/wiki-information/functions/IsPetAttackActive.md @@ -0,0 +1,9 @@ +## Title: IsPetAttackActive + +**Content:** +Returns true if the pet is currently auto attacking. +`isActive = IsPetAttackActive()` + +**Returns:** +- `isActive` + - *boolean* - true if the pet is currently auto attacking \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerAttacking.md b/wiki-information/functions/IsPlayerAttacking.md new file mode 100644 index 00000000..3e3edd2a --- /dev/null +++ b/wiki-information/functions/IsPlayerAttacking.md @@ -0,0 +1,19 @@ +## Title: IsPlayerAttacking + +**Content:** +Returns if the player is melee attacking the specified unit. +`isAttacking = IsPlayerAttacking(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `isAttacking` + - *boolean* + +**Example Usage:** +This function can be used in a combat addon to check if the player is currently attacking a specific unit. For instance, it can be used to trigger certain abilities or actions only when the player is actively engaged in melee combat with a target. + +**Addon Usage:** +Large addons like "WeakAuras" might use this function to create custom triggers for auras or notifications based on whether the player is attacking a specific unit. This can help players optimize their combat performance by providing real-time feedback and alerts. \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerInGuildFromGUID.md b/wiki-information/functions/IsPlayerInGuildFromGUID.md new file mode 100644 index 00000000..35ef6a87 --- /dev/null +++ b/wiki-information/functions/IsPlayerInGuildFromGUID.md @@ -0,0 +1,13 @@ +## Title: IsPlayerInGuildFromGUID + +**Content:** +Needs summary. +`IsInGuild = IsPlayerInGuildFromGUID(playerGUID)` + +**Parameters:** +- `playerGUID` + - *string* + +**Returns:** +- `IsInGuild` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerInWorld.md b/wiki-information/functions/IsPlayerInWorld.md new file mode 100644 index 00000000..fc8e6642 --- /dev/null +++ b/wiki-information/functions/IsPlayerInWorld.md @@ -0,0 +1,9 @@ +## Title: IsPlayerInWorld + +**Content:** +Needs summary. +`result = IsPlayerInWorld()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerMoving.md b/wiki-information/functions/IsPlayerMoving.md new file mode 100644 index 00000000..5d8e3edd --- /dev/null +++ b/wiki-information/functions/IsPlayerMoving.md @@ -0,0 +1,9 @@ +## Title: IsPlayerMoving + +**Content:** +Needs summary. +`result = IsPlayerMoving()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerSpell.md b/wiki-information/functions/IsPlayerSpell.md new file mode 100644 index 00000000..bfd680f1 --- /dev/null +++ b/wiki-information/functions/IsPlayerSpell.md @@ -0,0 +1,32 @@ +## Title: IsPlayerSpell + +**Content:** +Returns whether the player has learned a particular spell. +`isKnown = IsPlayerSpell(spellID)` + +**Parameters:** +- `spellID` + - *number* - Spell ID of the spell to query, e.g. 1953 for Blink. + +**Returns:** +- `isKnown` + - *boolean* - true if the player can cast this spell (or a different spell that overrides this spell), false otherwise. + +**Description:** +Spells can be permanently or temporarily overridden by other spells as a result of procs, talents, or other spell mechanics, e.g. +- `Wrath` is overridden by `Starfire` while in Solar Eclipse. +- `Freezing Trap` replaces trap spells by ranged variants. +- `Metamorphosis` replaces a permanent base spell. +- `Demonbolt` replaces with different spells. + +Querying the base (replaced) spell will also return true if any of its overrides are currently active. +Querying an overriding spell may or may not return true even if that spell is currently known, depending on the particular spell. + +**Reference:** +- `GetSpellInfo` + +**Example Usage:** +This function can be used to check if a player has learned a specific spell before attempting to cast it or display it in a UI element. For instance, an addon could use `IsPlayerSpell` to determine if a player has learned a particular talent or ability and then update the UI accordingly. + +**Addon Usage:** +Large addons like WeakAuras use `IsPlayerSpell` to dynamically update auras and notifications based on the player's current abilities and talents. This ensures that the addon only shows relevant information and triggers for spells the player can actually use. \ No newline at end of file diff --git a/wiki-information/functions/IsPublicBuild.md b/wiki-information/functions/IsPublicBuild.md new file mode 100644 index 00000000..5f26830f --- /dev/null +++ b/wiki-information/functions/IsPublicBuild.md @@ -0,0 +1,9 @@ +## Title: IsPublicBuild + +**Content:** +Needs summary. +`isPublicBuild = IsPublicBuild()` + +**Returns:** +- `isPublicBuild` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsQuestCompletable.md b/wiki-information/functions/IsQuestCompletable.md new file mode 100644 index 00000000..71314c4a --- /dev/null +++ b/wiki-information/functions/IsQuestCompletable.md @@ -0,0 +1,15 @@ +## Title: IsQuestCompletable + +**Content:** +Returns true if the displayed quest at a quest giver can be completed. +`isQuestCompletable = IsQuestCompletable()` + +**Returns:** +- `isQuestCompletable` + - *boolean* - true if the quest can be completed, false otherwise. + +**Example Usage:** +This function can be used in an addon to check if the player has met all the requirements to complete a quest when interacting with a quest giver. For instance, an addon could automatically highlight the "Complete Quest" button when `IsQuestCompletable()` returns true. + +**Addons Using This Function:** +Many quest-related addons, such as Questie, use this function to determine if a quest can be completed and to provide visual cues or automated actions for the player. \ No newline at end of file diff --git a/wiki-information/functions/IsQuestComplete.md b/wiki-information/functions/IsQuestComplete.md new file mode 100644 index 00000000..3696aa03 --- /dev/null +++ b/wiki-information/functions/IsQuestComplete.md @@ -0,0 +1,21 @@ +## Title: IsQuestComplete + +**Content:** +Returns whether the supplied quest in the quest log is complete. +`isComplete = IsQuestComplete(questID)` + +**Parameters:** +- `questID` + - *number* - The ID of the quest. + +**Returns:** +- `isComplete` + - *boolean* - true if the quest is both in the quest log and is complete, false otherwise. + +**Description:** +This function will only return true if the questID corresponds to a quest in the player's log. If the player has already completed the quest, this will return false. +This can return true even when the "isComplete" return of `GetQuestLogTitle` returns false, if the quest in question has no objectives to complete. + +**Reference:** +- `GetQuestLogTitle` +- `IsQuestFlaggedCompleted` \ No newline at end of file diff --git a/wiki-information/functions/IsQuestHardWatched.md b/wiki-information/functions/IsQuestHardWatched.md new file mode 100644 index 00000000..35be80bf --- /dev/null +++ b/wiki-information/functions/IsQuestHardWatched.md @@ -0,0 +1,20 @@ +## Title: C_QuestLog.GetQuestWatchType + +**Content:** +Returns the watchType associated with a given quest. +`watchType = C_QuestLog.GetQuestWatchType(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `watchType` + - *Enum.QuestWatchType?* + - `Value` + - `Field` + - `Description` + - `0` + - Automatic + - `1` + - Manual \ No newline at end of file diff --git a/wiki-information/functions/IsQuestWatched.md b/wiki-information/functions/IsQuestWatched.md new file mode 100644 index 00000000..35be80bf --- /dev/null +++ b/wiki-information/functions/IsQuestWatched.md @@ -0,0 +1,20 @@ +## Title: C_QuestLog.GetQuestWatchType + +**Content:** +Returns the watchType associated with a given quest. +`watchType = C_QuestLog.GetQuestWatchType(questID)` + +**Parameters:** +- `questID` + - *number* + +**Returns:** +- `watchType` + - *Enum.QuestWatchType?* + - `Value` + - `Field` + - `Description` + - `0` + - Automatic + - `1` + - Manual \ No newline at end of file diff --git a/wiki-information/functions/IsRangedWeapon.md b/wiki-information/functions/IsRangedWeapon.md new file mode 100644 index 00000000..4c2e4bc6 --- /dev/null +++ b/wiki-information/functions/IsRangedWeapon.md @@ -0,0 +1,9 @@ +## Title: IsRangedWeapon + +**Content:** +Needs summary. +`isRanged = IsRangedWeapon()` + +**Returns:** +- `isRanged` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsRecognizedName.md b/wiki-information/functions/IsRecognizedName.md new file mode 100644 index 00000000..b3cf904a --- /dev/null +++ b/wiki-information/functions/IsRecognizedName.md @@ -0,0 +1,51 @@ +## Title: IsRecognizedName + +**Content:** +Returns true if a given character name is recognized by the client. +`isRecognized = IsRecognizedName(text, includeBitfield, excludeBitfield)` + +**Parameters:** +- `text` + - *string* - Name of the character to test. +- `includeBitfield` + - *number* - Bitfield of filters that the name must match at least one of. +- `excludeBitfield` + - *number* - Bitfield of filters that the name must not match any of. + +**Returns:** +- `isRecognized` + - *boolean* - true if the character name is recognized by the client and passes the requested filters. + +**Miscellaneous:** +The filters used by this function are the same as the autocompletion flags used by `GetAutoCompleteResults()`. +- **AutocompleteFlag** + - **Global** + - **Value** + - **Description** + - `AUTOCOMPLETE_FLAG_NONE` + - `0x00000000` - Mask usable for including or excluding no results. + - `AUTOCOMPLETE_FLAG_IN_GROUP` + - `0x00000001` - Matches characters in your current party or raid. + - `AUTOCOMPLETE_FLAG_IN_GUILD` + - `0x00000002` - Matches characters in your current guild. + - `AUTOCOMPLETE_FLAG_FRIEND` + - `0x00000004` - Matches characters on your character-specific friends list. + - `AUTOCOMPLETE_FLAG_BNET` + - `0x00000008` - Matches characters on your Battle.net friends list. + - `AUTOCOMPLETE_FLAG_INTERACTED_WITH` + - `0x00000010` - Matches characters that the player has interacted with directly, such as exchanging whispers. + - `AUTOCOMPLETE_FLAG_ONLINE` + - `0x00000020` - Matches characters that are currently online. + - `AUTO_COMPLETE_IN_AOI` + - `0x00000040` - Matches characters in the local area of interest. + - `AUTO_COMPLETE_ACCOUNT_CHARACTER` + - `0x00000080` - Matches characters on any of the current players' Battle.net game accounts. + - `AUTOCOMPLETE_FLAG_ALL` + - `0xFFFFFFFF` - Mask usable for including or excluding all results. + +**Description:** +This function may return false for some filters if the player enters, exits, and re-enters the local area of interest of the tested character name. +When testing character names that are on the same Battle.net account, the character name must not include any realm identifier if the currently logged in character is on the same realm. + +**Reference:** +`GetAutoCompleteResults()` \ No newline at end of file diff --git a/wiki-information/functions/IsReferAFriendLinked.md b/wiki-information/functions/IsReferAFriendLinked.md new file mode 100644 index 00000000..27b9a0c2 --- /dev/null +++ b/wiki-information/functions/IsReferAFriendLinked.md @@ -0,0 +1,39 @@ +## Title: IsReferAFriendLinked + +**Content:** +Determines whether the given unit is linked to the player via the Recruit-A-Friend feature. +`isLinked = IsReferAFriendLinked(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `isLinked` + - *Flag* : 1 if the unit is RAF-linked to the player, nil otherwise. + +**Usage:** +```lua +function HasRecruitAFriendBonus() + local numPartyMembers = GetNumPartyMembers() + if numPartyMembers > 0 then + local memberID = 1 + while memberID <= numPartyMembers do + if GetPartyMember(memberID) == 1 then + local member = "party" .. memberID + if UnitIsVisible(member) and IsReferAFriendLinked(member) then + return true + end + end + memberID = memberID + 1 + end + end + return false +end +``` + +**Example Use Case:** +This function can be used to check if any party members are linked to the player via the Recruit-A-Friend feature, which can be useful for applying bonuses or special conditions in the game. + +**Addons:** +Large addons like "Zygor Guides" or "ElvUI" might use this function to provide additional features or bonuses to players who are linked via the Recruit-A-Friend system. For example, they might display special icons or provide additional information in the user interface to indicate the RAF status of party members. \ No newline at end of file diff --git a/wiki-information/functions/IsResting.md b/wiki-information/functions/IsResting.md new file mode 100644 index 00000000..c4cb6129 --- /dev/null +++ b/wiki-information/functions/IsResting.md @@ -0,0 +1,17 @@ +## Title: IsResting + +**Content:** +Returns true if the character is currently resting. +`resting = IsResting()` + +**Returns:** +- `resting` + - *boolean* - Whether the player is resting. + +**Description:** +You are Resting if you are in an Inn or a Major City like Ironforge or Orgrimmar. +While resting, the player will gain XP Bonus. + +**Reference:** +- [Rested](https://wowpedia.fandom.com/wiki/Rested) +- [Resting at the Official site](https://worldofwarcraft.com) \ No newline at end of file diff --git a/wiki-information/functions/IsRestrictedAccount.md b/wiki-information/functions/IsRestrictedAccount.md new file mode 100644 index 00000000..8c314a90 --- /dev/null +++ b/wiki-information/functions/IsRestrictedAccount.md @@ -0,0 +1,9 @@ +## Title: IsRestrictedAccount + +**Content:** +Needs summary. +`result = IsRestrictedAccount()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsRightAltKeyDown.md b/wiki-information/functions/IsRightAltKeyDown.md new file mode 100644 index 00000000..7955181c --- /dev/null +++ b/wiki-information/functions/IsRightAltKeyDown.md @@ -0,0 +1,45 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown()` +- `IsControlKeyDown()` +- `IsLeftControlKeyDown()` +- `IsRightControlKeyDown()` +- `IsShiftKeyDown()` +- `IsLeftShiftKeyDown()` +- `IsRightShiftKeyDown()` +- `IsAltKeyDown()` +- `IsLeftAltKeyDown()` +- `IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` + +**Example Use Case:** +This function can be used in addons to check if a user is holding down a specific modifier key combination, which can be useful for implementing custom keybindings or conditional behaviors based on user input. + +**Addons Using This Function:** +Many large addons, such as WeakAuras and Bartender4, use this function to provide advanced keybinding options and to allow users to create complex macros and conditional actions based on modifier keys. \ No newline at end of file diff --git a/wiki-information/functions/IsRightControlKeyDown.md b/wiki-information/functions/IsRightControlKeyDown.md new file mode 100644 index 00000000..4ba9da09 --- /dev/null +++ b/wiki-information/functions/IsRightControlKeyDown.md @@ -0,0 +1,39 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown()` +- `IsControlKeyDown()` +- `IsLeftControlKeyDown()` +- `IsRightControlKeyDown()` +- `IsShiftKeyDown()` +- `IsLeftShiftKeyDown()` +- `IsRightShiftKeyDown()` +- `IsAltKeyDown()` +- `IsLeftAltKeyDown()` +- `IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` \ No newline at end of file diff --git a/wiki-information/functions/IsRightMetaKeyDown.md b/wiki-information/functions/IsRightMetaKeyDown.md new file mode 100644 index 00000000..3d18b079 --- /dev/null +++ b/wiki-information/functions/IsRightMetaKeyDown.md @@ -0,0 +1,9 @@ +## Title: IsRightMetaKeyDown + +**Content:** +Needs summary. +`down = IsRightMetaKeyDown()` + +**Returns:** +- `down` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsRightShiftKeyDown.md b/wiki-information/functions/IsRightShiftKeyDown.md new file mode 100644 index 00000000..9afe55eb --- /dev/null +++ b/wiki-information/functions/IsRightShiftKeyDown.md @@ -0,0 +1,45 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown()` +- `IsControlKeyDown()` +- `IsLeftControlKeyDown()` +- `IsRightControlKeyDown()` +- `IsShiftKeyDown()` +- `IsLeftShiftKeyDown()` +- `IsRightShiftKeyDown()` +- `IsAltKeyDown()` +- `IsLeftAltKeyDown()` +- `IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +- **Related Events:** + - `MODIFIER_STATE_CHANGED` +- **Related API:** + - `IsModifiedClick` + - `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` + +**Example Use Case:** +This function can be used in addons to check if a user is holding down a specific modifier key combination, which can be useful for implementing custom keybindings or shortcuts. + +**Addons Using This Function:** +Many large addons, such as **ElvUI** and **WeakAuras**, use this function to provide enhanced user interactions and customizability by allowing users to set up actions that depend on modifier keys being pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsShiftKeyDown.md b/wiki-information/functions/IsShiftKeyDown.md new file mode 100644 index 00000000..3dd98a9a --- /dev/null +++ b/wiki-information/functions/IsShiftKeyDown.md @@ -0,0 +1,37 @@ +## Title: IsModifierKeyDown + +**Content:** +Returns true if a modifier key is currently pressed down. +`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` + +**Returns:** +- `isDown` + - *boolean* - True if the specified modifier key is pressed down. + +**Description:** +Related Events: +- `MODIFIER_STATE_CHANGED` + +Related API: +- `IsModifiedClick` +- `GetBindingByKey` + +**Usage:** +Prints if the left-ctrl and left-shift modifiers are pressed down. +```lua +local function OnEvent(self, event, ...) + if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then + print("hello") + end +end + +local f = CreateFrame("Frame") +f:RegisterEvent("MODIFIER_STATE_CHANGED") +f:SetScript("OnEvent", OnEvent) +``` + +**Example Use Case:** +This function can be used in scenarios where you need to check if a user is holding down a modifier key (like Ctrl, Shift, or Alt) to perform specific actions, such as multi-selecting items in an inventory or triggering special abilities in a game. + +**Addons Using This Function:** +Many large addons, such as ElvUI and WeakAuras, use this function to enhance user interactions. For example, WeakAuras might use it to allow users to configure custom keybindings for displaying or hiding certain UI elements based on modifier keys. \ No newline at end of file diff --git a/wiki-information/functions/IsSpellInRange.md b/wiki-information/functions/IsSpellInRange.md new file mode 100644 index 00000000..96a80cc3 --- /dev/null +++ b/wiki-information/functions/IsSpellInRange.md @@ -0,0 +1,46 @@ +## Title: IsSpellInRange + +**Content:** +Returns 1 if the player is in range to use the specified spell on the target unit, 0 otherwise. +`inRange = IsSpellInRange(spellName, unit)` +`inRange = IsSpellInRange(index, bookType, unit)` + +**Parameters:** +- `spellName` + - *string* - The localized spell name. The player must know the spell. +- `unit` + - *string : UnitId* - The unit to use as a target for the spell. + +**Spellbook args:** +- `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. +- `bookType` + - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + +**Constant:** +- `BOOKTYPE_SPELL` + - *"spell"* - The General, Class, Specs and Professions tabs +- `BOOKTYPE_PET` + - *"pet"* - The Pet tab + +**Returns:** +- `inRange` + - *number?* - 1 if the target is in range of the spell, 0 if the target is not in range of the spell, nil if the provided arguments were invalid or inapplicable. + +**Description:** +This takes into account talents, and can be used to determine the approximate distance to your raid members. +The function returns nil if: +- The spell cannot be cast on the unit. i.e. on a friendly unit, or on a hostile unit (such as a mind-controlled raid member) +- If the unit is not 'visible' (per UnitIsVisible) or does not exist (per UnitExists) +- The current player does not know this spell (so you cannot use 'Heal' to test 40 yard range for anyone other than a priest) +- The spell can only be cast on the player (i.e. a self-buff such as or ) + +**Usage:** +```lua +if IsSpellInRange("Flash Heal", "target") == 1 then + print("target is in healing range") +else + print("cannot heal target") +end +``` \ No newline at end of file diff --git a/wiki-information/functions/IsSpellKnown.md b/wiki-information/functions/IsSpellKnown.md new file mode 100644 index 00000000..4c7981ea --- /dev/null +++ b/wiki-information/functions/IsSpellKnown.md @@ -0,0 +1,23 @@ +## Title: IsSpellKnown + +**Content:** +Returns whether the player (or pet) knows the given spell. +`isKnown = IsSpellKnown(spellID)` + +**Parameters:** +- `spellID` + - *number* - the spell ID number +- `isPetSpell` + - *boolean?* - if true, will check if the currently active pet knows the spell; if false or omitted, will check if the player knows the spell + +**Returns:** +- `isKnown` + - *boolean* - whether the player (or pet) knows the given spell + +**Description:** +This function may return false when querying learned spells that are passive effects. Consider using `IsPlayerSpell` for these. +Returns false if querying a spell that has "replaced" a known spell, which returns true whether or not it's replaced (i.e. Retribution's Templar's Verdict (85256) will always be true and Final Verdict (336872) will be false whether or not you have the related legendary equipped). In these cases, use `IsSpellKnownOrOverridesKnown(spellID)` to check for spells like Final Verdict. + +**Reference:** +- `IsPlayerSpell` +- `IsSpellKnownOrOverridesKnown` \ No newline at end of file diff --git a/wiki-information/functions/IsStealthed.md b/wiki-information/functions/IsStealthed.md new file mode 100644 index 00000000..76b9af81 --- /dev/null +++ b/wiki-information/functions/IsStealthed.md @@ -0,0 +1,16 @@ +## Title: IsStealthed + +**Content:** +Returns true if the character is currently stealthed. +`stealthed = IsStealthed()` + +**Returns:** +- `stealthed` + - *boolean* - true if stealthed, otherwise false + +**Description:** +Stealth includes abilities like `Stealth`, `Prowl`, and `Shadowmeld`. + +**Reference:** +- `UPDATE_STEALTH` - Fires when a player enters or leaves stealth. +- Macro conditionals - `stealth` or `nostealth` may be used in macros or with a `SecureStateDriver`. \ No newline at end of file diff --git a/wiki-information/functions/IsSubmerged.md b/wiki-information/functions/IsSubmerged.md new file mode 100644 index 00000000..173e3165 --- /dev/null +++ b/wiki-information/functions/IsSubmerged.md @@ -0,0 +1,17 @@ +## Title: IsSubmerged + +**Content:** +Returns whether the player character is submerged in water. +`isSubmerged = IsSubmerged()` + +**Returns:** +- `isSwimming` + - *boolean* - 1 if the player is submerged, nil otherwise. + +**Description:** +This function is similar to `IsSwimming`, but also returns 1 when running at the bottom of a surface of water. +This function is available within the RestrictedEnvironment. + +**Reference:** +- `IsSwimming` +- `IsFlying` \ No newline at end of file diff --git a/wiki-information/functions/IsSwimming.md b/wiki-information/functions/IsSwimming.md new file mode 100644 index 00000000..f28572b9 --- /dev/null +++ b/wiki-information/functions/IsSwimming.md @@ -0,0 +1,18 @@ +## Title: IsSwimming + +**Content:** +Returns true if the character is currently swimming. +`isSwimming = IsSwimming()` + +**Returns:** +- `isSwimming` + - *boolean* - 1 if the player is swimming, nil otherwise. + +**Description:** +A swimming character's movement speed is based on their swim speed (per `GetUnitSpeed`). +In some locations and when affected by certain effects, player characters can run at the bottom of the ocean/lake/etc. In those cases, the player is not considered swimming (but is still submerged per `IsSubmerged`). +This function is available within the RestrictedEnvironment. + +**Reference:** +- `IsSubmerged` +- `IsFlying` \ No newline at end of file diff --git a/wiki-information/functions/IsTargetLoose.md b/wiki-information/functions/IsTargetLoose.md new file mode 100644 index 00000000..79f61dae --- /dev/null +++ b/wiki-information/functions/IsTargetLoose.md @@ -0,0 +1,9 @@ +## Title: IsTargetLoose + +**Content:** +Checks if the players' current target is a soft-targeted unit. +`isLoose = IsTargetLoose()` + +**Returns:** +- `isLoose` + - *boolean* - true if the current target unit is a soft-targeted unit. \ No newline at end of file diff --git a/wiki-information/functions/IsThreatWarningEnabled.md b/wiki-information/functions/IsThreatWarningEnabled.md new file mode 100644 index 00000000..bea7523e --- /dev/null +++ b/wiki-information/functions/IsThreatWarningEnabled.md @@ -0,0 +1,15 @@ +## Title: IsThreatWarningEnabled + +**Content:** +Returns true if threat warnings are currently enabled. +`enabled = IsThreatWarningEnabled()` + +**Returns:** +- `enabled` + - *boolean flag* - 1 if the warnings are enabled, nil if they are not. + +**Description:** +The warnings are controlled by the `threatWarning` CVar, which allows the player to specify in which situations the warnings should be active. This function takes into account the current situation. + +**Reference:** +ShowNumericThreat \ No newline at end of file diff --git a/wiki-information/functions/IsTitleKnown.md b/wiki-information/functions/IsTitleKnown.md new file mode 100644 index 00000000..491db0f1 --- /dev/null +++ b/wiki-information/functions/IsTitleKnown.md @@ -0,0 +1,13 @@ +## Title: IsTitleKnown + +**Content:** +Returns true if the character can use a player title. +`isKnown = IsTitleKnown(titleId)` + +**Parameters:** +- `titleId` + - *number* - Ranging from 1 to `GetNumTitles`. + +**Returns:** +- `isKnown` + - *boolean* - True if the character can use the specified player title. \ No newline at end of file diff --git a/wiki-information/functions/IsTrackedAchievement.md b/wiki-information/functions/IsTrackedAchievement.md new file mode 100644 index 00000000..48cc6ed3 --- /dev/null +++ b/wiki-information/functions/IsTrackedAchievement.md @@ -0,0 +1,13 @@ +## Title: IsTrackedAchievement + +**Content:** +Returns if an achievement is currently being tracked. +`tracked = GetAchievementNumCriteria(achievementID)` + +**Parameters:** +- `achievementID` + - Uniquely identifies each achievement + +**Returns:** +- `eligible` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsTradeskillTrainer.md b/wiki-information/functions/IsTradeskillTrainer.md new file mode 100644 index 00000000..83a61f13 --- /dev/null +++ b/wiki-information/functions/IsTradeskillTrainer.md @@ -0,0 +1,21 @@ +## Title: IsTradeskillTrainer + +**Content:** +Returns true if the training window is used for a profession trainer. +`isTradeskillTrainer = IsTradeskillTrainer()` + +**Returns:** +- `1` or `True` if the last open trainer skill list was for a trade skill (as opposed to class skills). + +**Usage:** +```lua +if (IsTradeskillTrainer()) then + message('This is a tradeskill trainer'); +end +``` + +**Example Use Case:** +This function can be used in an addon to determine if the player is interacting with a tradeskill trainer, allowing the addon to display relevant information or options specific to tradeskill training. + +**Addon Usage:** +Many large addons, such as TradeSkillMaster, use this function to enhance the user interface and provide additional functionality when interacting with tradeskill trainers. For example, TradeSkillMaster might use this function to automatically display crafting options or manage inventory related to tradeskills. \ No newline at end of file diff --git a/wiki-information/functions/IsTrainerServiceLearnSpell.md b/wiki-information/functions/IsTrainerServiceLearnSpell.md new file mode 100644 index 00000000..2f39d2e9 --- /dev/null +++ b/wiki-information/functions/IsTrainerServiceLearnSpell.md @@ -0,0 +1,18 @@ +## Title: IsTrainerServiceLearnSpell + +**Content:** +Returns the type of trainer spell in the trainer window. +`isLearnSpell, isPetLearnSpell = IsTrainerServiceLearnSpell(index)` + +**Parameters:** +- `index` + - *number* - The index of the spell in the trainer window. + +**Returns:** +- `isLearnSpell` + - *number* - Returns 1 if the spell is a class spell or a learnable profession spell, nil otherwise. +- `isPetLearnSpell` + - *number* - Returns 1 if a pet spell, nil otherwise. + +**Reference:** +- `GetTrainerServiceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/IsTrialAccount.md b/wiki-information/functions/IsTrialAccount.md new file mode 100644 index 00000000..9f2a0787 --- /dev/null +++ b/wiki-information/functions/IsTrialAccount.md @@ -0,0 +1,9 @@ +## Title: IsTrialAccount + +**Content:** +Returns whether the player is using a trial (free-to-play) account. +`isTrialAccount = IsTrialAccount()` + +**Returns:** +- `isTrialAccount` + - *boolean* - Returns true if on a free-to-play account \ No newline at end of file diff --git a/wiki-information/functions/IsUnitOnQuestByQuestID.md b/wiki-information/functions/IsUnitOnQuestByQuestID.md new file mode 100644 index 00000000..a4d36587 --- /dev/null +++ b/wiki-information/functions/IsUnitOnQuestByQuestID.md @@ -0,0 +1,21 @@ +## Title: C_QuestLog.IsUnitOnQuest + +**Content:** +Returns true if the unit is on the specified quest. +`isOnQuest = C_QuestLog.IsUnitOnQuest(unit, questID)` + +**Parameters:** +- `unit` + - *string* : UnitId +- `questID` + - *number* + +**Returns:** +- `isOnQuest` + - *boolean* + +**Example Usage:** +This function can be used to check if a player or any other unit (like a party member) is currently on a specific quest. For instance, it can be useful in group questing scenarios to ensure all members are on the same quest before proceeding. + +**Addons:** +Large addons like Questie or World Quest Tracker might use this function to verify quest status for players and party members, ensuring accurate tracking and display of quest progress. \ No newline at end of file diff --git a/wiki-information/functions/IsUsableAction.md b/wiki-information/functions/IsUsableAction.md new file mode 100644 index 00000000..a909d3dc --- /dev/null +++ b/wiki-information/functions/IsUsableAction.md @@ -0,0 +1,15 @@ +## Title: IsUsableAction + +**Content:** +Returns true if the character can currently use the specified action (sufficient mana, reagents and not on cooldown). +`isUsable, notEnoughMana = IsUsableAction(slot)` + +**Parameters:** +- `slot` + - *number* - Action slot to query + +**Returns:** +- `isUsable` + - *boolean* - true if the action is currently usable (does not check cooldown or range), false otherwise. +- `notEnoughMana` + - *boolean* - true if the action is unusable because the player does not have enough mana, rage, etc.; false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsUsableSpell.md b/wiki-information/functions/IsUsableSpell.md new file mode 100644 index 00000000..c8f0f613 --- /dev/null +++ b/wiki-information/functions/IsUsableSpell.md @@ -0,0 +1,53 @@ +## Title: IsUsableSpell + +**Content:** +Determines whether a spell can be used by the player character. +`usable, noMana = IsUsableSpell(spell)` +`usable, noMana = IsUsableSpell(index, bookType)` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant** + - **Value** + - **Description** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Returns:** +- `usable` + - *boolean* - True if the spell is usable, false otherwise. A spell might be un-usable for a variety of reasons, such as: + - The player hasn't learned the spell + - The player lacks required mana or reagents. + - Reactive conditions haven't been met. +- `noMana` + - *boolean* - True if the spell cannot be cast due to low mana, false otherwise. + +**Usage:** +The following code snippet will check if the spell 'Healing Touch' can be cast: +```lua +usable, nomana = IsUsableSpell("Curse of Elements"); +if (not usable) then + if (not nomana) then + message("The spell cannot be cast"); + else + message("You do not have enough mana to cast the spell"); + end +else + message("The spell may be cast"); +end +``` + +The following code snippet will check if the 20th spell in the player's spellbook is usable: +```lua +usable, nomana = IsUsableSpell(20, BOOKTYPE_SPELL); +print(GetSpellName(20, BOOKTYPE_SPELL) .. " is " .. (usable and "" or "not ") .. " usable."); +``` \ No newline at end of file diff --git a/wiki-information/functions/IsUsingFixedTimeStep.md b/wiki-information/functions/IsUsingFixedTimeStep.md new file mode 100644 index 00000000..6b656625 --- /dev/null +++ b/wiki-information/functions/IsUsingFixedTimeStep.md @@ -0,0 +1,9 @@ +## Title: IsUsingFixedTimeStep + +**Content:** +Needs summary. +`isUsingFixedTimeStep = IsUsingFixedTimeStep()` + +**Returns:** +- `isUsingFixedTimeStep` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsUsingGamepad.md b/wiki-information/functions/IsUsingGamepad.md new file mode 100644 index 00000000..85e7bdab --- /dev/null +++ b/wiki-information/functions/IsUsingGamepad.md @@ -0,0 +1,9 @@ +## Title: IsUsingGamepad + +**Content:** +Needs summary. +`down = IsUsingGamepad()` + +**Returns:** +- `down` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsUsingMouse.md b/wiki-information/functions/IsUsingMouse.md new file mode 100644 index 00000000..042c0d97 --- /dev/null +++ b/wiki-information/functions/IsUsingMouse.md @@ -0,0 +1,9 @@ +## Title: IsUsingMouse + +**Content:** +Needs summary. +`down = IsUsingMouse()` + +**Returns:** +- `down` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsVeteranTrialAccount.md b/wiki-information/functions/IsVeteranTrialAccount.md new file mode 100644 index 00000000..17c99c50 --- /dev/null +++ b/wiki-information/functions/IsVeteranTrialAccount.md @@ -0,0 +1,9 @@ +## Title: IsVeteranTrialAccount + +**Content:** +Needs summary. +`isVeteranTrialAccount = IsVeteranTrialAccount()` + +**Returns:** +- `isVeteranTrialAccount` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsWargame.md b/wiki-information/functions/IsWargame.md new file mode 100644 index 00000000..038af7f3 --- /dev/null +++ b/wiki-information/functions/IsWargame.md @@ -0,0 +1,9 @@ +## Title: IsWargame + +**Content:** +Returns whether the player is currently in a War Game. +`isWargame = IsWargame()` + +**Returns:** +- `isWargame` + - *boolean* - true if the player is currently inside a war game instance, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsXPUserDisabled.md b/wiki-information/functions/IsXPUserDisabled.md new file mode 100644 index 00000000..8bcc6327 --- /dev/null +++ b/wiki-information/functions/IsXPUserDisabled.md @@ -0,0 +1,9 @@ +## Title: IsXPUserDisabled + +**Content:** +Needs summary. +`isDisabled = C_PlayerInfo.IsXPUserDisabled()` + +**Returns:** +- `isDisabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetCreator.md b/wiki-information/functions/ItemTextGetCreator.md new file mode 100644 index 00000000..2ee1f5bf --- /dev/null +++ b/wiki-information/functions/ItemTextGetCreator.md @@ -0,0 +1,12 @@ +## Title: ItemTextGetCreator + +**Content:** +Returns the name of the character who created the item text. +`creatorName = ItemTextGetCreator()` + +**Returns:** +- `creatorName` + - *string* - If this item text was created by a player (i.e. Saved mail message) then return their name, otherwise return nil. + +**Description:** +This is available once the `ITEM_TEXT_BEGIN` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetItem.md b/wiki-information/functions/ItemTextGetItem.md new file mode 100644 index 00000000..a34bdb64 --- /dev/null +++ b/wiki-information/functions/ItemTextGetItem.md @@ -0,0 +1,12 @@ +## Title: ItemTextGetItem + +**Content:** +Returns the item name that the item text belongs to. +`textName = ItemTextGetItem()` + +**Returns:** +- `textName` + - *string* - The name of the item text which is being viewed. + +**Description:** +This is available once the `ITEM_TEXT_BEGIN` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetMaterial.md b/wiki-information/functions/ItemTextGetMaterial.md new file mode 100644 index 00000000..471fe193 --- /dev/null +++ b/wiki-information/functions/ItemTextGetMaterial.md @@ -0,0 +1,13 @@ +## Title: ItemTextGetMaterial + +**Content:** +Returns the material texture for the item text. +`materialName = ItemTextGetMaterial()` + +**Returns:** +- `materialName` + - *string* - The name of the material to use for displaying the item text. If nil then the material is "Parchment". + +**Description:** +This is used once the `ITEM_TEXT_READY` event has been received for a page. +See `FrameXML/ItemTextFrame.lua` for examples of how the material is used to select a set of textures. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetPage.md b/wiki-information/functions/ItemTextGetPage.md new file mode 100644 index 00000000..502a7201 --- /dev/null +++ b/wiki-information/functions/ItemTextGetPage.md @@ -0,0 +1,13 @@ +## Title: ItemTextGetPage + +**Content:** +Returns the page number of the currently displayed page. +`pageNum = ItemTextGetPage()` + +**Returns:** +- `pageNum` + - *number* - The page number of the currently displayed page, starting at 1. + +**Description:** +This is used once the `ITEM_TEXT_READY` event has been received for a page. +Note that there is no function to return the total number of pages of the text, it must be found by iterating through until `ItemTextHasNextPage` returns nil. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetText.md b/wiki-information/functions/ItemTextGetText.md new file mode 100644 index 00000000..655d38af --- /dev/null +++ b/wiki-information/functions/ItemTextGetText.md @@ -0,0 +1,12 @@ +## Title: ItemTextGetText + +**Content:** +Returns the contents of the currently displayed page. +`pageBody = ItemTextGetText()` + +**Returns:** +- `pageBody` + - *string* - The body of the current page. + +**Description:** +This is available once the `ITEM_TEXT_READY` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextHasNextPage.md b/wiki-information/functions/ItemTextHasNextPage.md new file mode 100644 index 00000000..3498885b --- /dev/null +++ b/wiki-information/functions/ItemTextHasNextPage.md @@ -0,0 +1,12 @@ +## Title: ItemTextHasNextPage + +**Content:** +Returns true if there is a page after the current page. +`hasNext = ItemTextHasNextPage()` + +**Returns:** +- `hasNext` + - *Flag* - Returns 1 if there is a page following the currently displayed one, nil otherwise. + +**Description:** +This is available once the `ITEM_TEXT_READY` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextNextPage.md b/wiki-information/functions/ItemTextNextPage.md new file mode 100644 index 00000000..7767c002 --- /dev/null +++ b/wiki-information/functions/ItemTextNextPage.md @@ -0,0 +1,10 @@ +## Title: ItemTextNextPage + +**Content:** +Moves to the next page of the item text. +`ItemTextNextPage()` + +**Description:** +This simply requests the next page, you will receive an `ITEM_TEXT_READY` event when the new page is ready. +Try only to call this after receiving an `ITEM_TEXT_READY` event for the current page, and don't call it IN the event handler for that event, things get a little odd (Looks like a synchronization issue in the client) and your page cache might get corrupted. +Does nothing if called while viewing the last page. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextPrevPage.md b/wiki-information/functions/ItemTextPrevPage.md new file mode 100644 index 00000000..4fec2d0e --- /dev/null +++ b/wiki-information/functions/ItemTextPrevPage.md @@ -0,0 +1,10 @@ +## Title: ItemTextPrevPage + +**Content:** +Moves to the previous page of the item text. +`ItemTextPrevPage()` + +**Description:** +This simply requests the previous page, you will receive an `ITEM_TEXT_READY` event when the new page is ready. +Try only to call this after receiving an `ITEM_TEXT_READY` event for the current page, and don't call it IN the event handler for that event, things get a little odd (Looks like a synchronization issue in the client) and your page cache might get corrupted. +Does nothing if called while viewing the first page. \ No newline at end of file diff --git a/wiki-information/functions/JoinBattlefield.md b/wiki-information/functions/JoinBattlefield.md new file mode 100644 index 00000000..af6d89d7 --- /dev/null +++ b/wiki-information/functions/JoinBattlefield.md @@ -0,0 +1,42 @@ +## Title: JoinBattlefield + +**Content:** +Joins the battleground queue solo or as a group. +`JoinBattlefield(index)` + +**Parameters:** +- `index` + - *number* - Which battlefield instance to queue for (0 for first available), or which arena bracket to queue for. +- `asGroup` + - *boolean* - If true-equivalent, the player's group is queued for the battlefield, otherwise, only the player is queued. +- `isRated` + - *boolean* - If true-equivalent, and queueing for an arena bracket, the group is queued for a rated match as opposed to a skirmish. + +**Description:** +The function requests the player to be added to a queue for a particular instance of the currently selected battleground type, as set by `RequestBattlegroundInstanceInfo(index)`. You CANNOT queue immediately after a `RequestBattlegroundInstanceInfo` call, and must instead capture the event that indicates that the instance list is available. + +**Details:** +When the Arena Battlemaster window is open, index 1 is 2vs2, index 2 is 3vs3 and index 3 is 5vs5. + +**Usage:** +The following code creates a utility function, `JoinBattlegroundType`, which allows you to queue for the first available instance of a specific battleground type. +```lua +do + local f, aG, iR = CreateFrame("FRAME"); + f:SetScript("OnEvent", function(self, event) + JoinBattlefield(0, aG, iR); + self:UnregisterEvent("PVPQUEUE_ANYWHERE_SHOW"); + end); + function JoinBattlegroundType(index, asGroup, isRated) + if f:IsEventRegistered("PVPQUEUE_ANYWHERE_SHOW") then + error("A join battleground request is already being processed"); + end + f:RegisterEvent("PVPQUEUE_ANYWHERE_SHOW"); + aG, iR = asGroup, isRated; + RequestBattlegroundInstanceInfo(index); + end +end +``` + +**Reference:** +- `CanJoinBattlefieldAsGroup` \ No newline at end of file diff --git a/wiki-information/functions/JoinChannelByName.md b/wiki-information/functions/JoinChannelByName.md new file mode 100644 index 00000000..bb772015 --- /dev/null +++ b/wiki-information/functions/JoinChannelByName.md @@ -0,0 +1,32 @@ +## Title: JoinChannelByName + +**Content:** +Joins the specified chat channel. +`type, name = JoinChannelByName(channelName)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel to join. You can't use the "-" character in `channelName`. +- `password` + - *string?* - The channel password, `nil` if none. +- `frameID` + - *number?* - The chat frame ID number to add the channel to. Use `Frame:GetID()` to retrieve it for chat frame objects. +- `hasVoice` + - *boolean* - Enable voice chat for this channel. + +**Returns:** +- `type` + - *number* - The type of channel. 0 for an undefined channel, 1 for the zone General channel, etc. +- `name` + - *string?* - The name of the channel. + +**Usage:** +```lua +local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1); +``` + +**Example Use Case:** +This function can be used to programmatically join a custom chat channel in World of Warcraft. For instance, an addon could use this to automatically join a guild's custom chat channel upon login. + +**Addon Usage:** +Large addons like Prat or Chatter, which enhance the chat interface, might use this function to manage custom chat channels, ensuring users are automatically joined to specific channels for better communication and coordination. \ No newline at end of file diff --git a/wiki-information/functions/JoinPermanentChannel.md b/wiki-information/functions/JoinPermanentChannel.md new file mode 100644 index 00000000..551284b9 --- /dev/null +++ b/wiki-information/functions/JoinPermanentChannel.md @@ -0,0 +1,33 @@ +## Title: JoinPermanentChannel + +**Content:** +Joins the specified chat channel; the channel will be rejoined after relogging. +Joins the channel with the specified name. A player can be in a maximum of 10 chat channels. In contrast to `API_JoinTemporaryChannel`, the channel will be re-joined after relogging. +`type, name = JoinPermanentChannel(channelName)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel to join. You can't use the "-" character in `channelName` (patch 1.9). +- `password` + - *string?* - The channel password, nil if none. +- `frameID` + - *number?* - The chat frame ID number to add the channel to. Use `Frame:GetID()` to retrieve it for chat frame objects. +- `hasVoice` + - *number?* - (1/nil) Enable voice chat for this channel. + +**Returns:** +- `type` + - *number* - The type of channel. 0 for an undefined channel, 1 for the zone General channel, etc. +- `name` + - *string* - The name of the channel (seems to be nil for most channels). + +**Usage:** +```lua +JoinPermanentChannel("Mammoth", "thesane", ChatFrame1:GetID(), 1); +``` + +**Example Use Case:** +This function can be used to join a custom chat channel that you want to persist across game sessions. For instance, a guild might use a specific channel for officer communications that they want to automatically rejoin every time they log in. + +**Addons Using This API:** +Many chat-related addons, such as Prat and Chatter, use this API to manage custom chat channels and ensure users are automatically rejoined to important channels after relogging. \ No newline at end of file diff --git a/wiki-information/functions/JoinSkirmish.md b/wiki-information/functions/JoinSkirmish.md new file mode 100644 index 00000000..ea05ab06 --- /dev/null +++ b/wiki-information/functions/JoinSkirmish.md @@ -0,0 +1,16 @@ +## Title: JoinSkirmish + +**Content:** +Queue for an arena either solo or as a group. +`JoinSkirmish(arenaID, joinAsGroup)` + +**Parameters:** +- `arenaID` + - *number* +- `joinAsGroup` + - *boolean?* + +**Description:** +Value arenaIDs: +- 4 = 2vs2 +- 5 = 3vs3 \ No newline at end of file diff --git a/wiki-information/functions/JoinTemporaryChannel.md b/wiki-information/functions/JoinTemporaryChannel.md new file mode 100644 index 00000000..95b7ab45 --- /dev/null +++ b/wiki-information/functions/JoinTemporaryChannel.md @@ -0,0 +1,33 @@ +## Title: JoinTemporaryChannel + +**Content:** +Joins the specified chat channel; the channel will be left on logout. +Joins the channel with the specified name. A player can be in a maximum of 10 chat channels. In contrast to `API_JoinPermanentChannel`, the channel will be left at logout. +`type, name = JoinTemporaryChannel(channelName)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel to join. You can't use the "-" character in `channelName` (patch 1.9). +- `password` + - *string?* - The channel password, `nil` if none. +- `frameID` + - *number?* - The chat frame ID number to add the channel to. Use `Frame:GetID()` to retrieve it for chat frame objects. +- `hasVoice` + - *number* - (1/nil) Enable voice chat for this channel. + +**Returns:** +- `type` + - *number* - The type of channel. 0 for an undefined channel, 1 for the zone General channel, etc. +- `name` + - *string* - The name of the channel (seems to be `nil` for most channels). + +**Usage:** +```lua +JoinTemporaryChannel("Mammoth", "thesane", ChatFrame1:GetID(), 1); +``` + +**Example Use Case:** +This function can be used in an addon to temporarily join a custom chat channel for event coordination or group activities. For instance, a raid leader might use this to create a temporary channel for organizing a raid without cluttering the permanent channel list. + +**Addons Using This API:** +Large addons like Deadly Boss Mods (DBM) might use this function to create temporary channels for sharing raid warnings and alerts among raid members. \ No newline at end of file diff --git a/wiki-information/functions/JumpOrAscendStart.md b/wiki-information/functions/JumpOrAscendStart.md new file mode 100644 index 00000000..31900b84 --- /dev/null +++ b/wiki-information/functions/JumpOrAscendStart.md @@ -0,0 +1,8 @@ +## Title: JumpOrAscendStart + +**Content:** +Makes the character jump or swim/fly upwards. +`JumpOrAscendStart()` + +**Description:** +This function is called when the jump key is pushed down. \ No newline at end of file diff --git a/wiki-information/functions/KBArticle_BeginLoading.md b/wiki-information/functions/KBArticle_BeginLoading.md new file mode 100644 index 00000000..58ce4813 --- /dev/null +++ b/wiki-information/functions/KBArticle_BeginLoading.md @@ -0,0 +1,31 @@ +## Title: KBArticle_BeginLoading + +**Content:** +Starts the article load process. +`KBArticle_BeginLoading(id, searchType)` + +**Parameters:** +- `(id, searchType)` + - `id` + - *number* - The article's ID + - `searchType` + - *number* - Search type for the loading process. + +**Returns:** +- `nil` + +**Description:** +The `searchType` can be either 1 or 2. 1 is used if the search text is empty, 2 otherwise. + +**Usage:** +```lua +function KnowledgeBaseArticleListItem_OnClick() + local searchText = KnowledgeBaseFrameEditBox:GetText(); + local searchType = 2; + if (searchText == KBASE_DEFAULT_SEARCH_TEXT or searchText == "") then + searchType = 1; + end + KBArticle_BeginLoading(this.articleId, searchType); +end +``` +From Blizzard's KnowledgeBaseFrame.lua (l. 529 ff.) \ No newline at end of file diff --git a/wiki-information/functions/KBArticle_GetData.md b/wiki-information/functions/KBArticle_GetData.md new file mode 100644 index 00000000..0742269f --- /dev/null +++ b/wiki-information/functions/KBArticle_GetData.md @@ -0,0 +1,27 @@ +## Title: KBArticle_GetData + +**Content:** +Returns data for the current article. +`id, subject, subjectAlt, text, keywords, languageId, isHot = KBArticle_GetData()` + +**Parameters:** +- `()` + +**Returns:** +- `id` + - *number* - The article id +- `subject` + - *string* - The localized title. +- `subjectAlt` + - *string* - The English title. +- `text` + - *string* - The article itself +- `keywords` + - *string* - Some keywords for the article. May be nil. +- `languageId` + - *number* - The language ID for the article. +- `isHot` + - *boolean* - Flag for the "hot" status. + +**Description:** +Only works if `KBArticle_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBArticle_IsLoaded.md b/wiki-information/functions/KBArticle_IsLoaded.md new file mode 100644 index 00000000..e50078c5 --- /dev/null +++ b/wiki-information/functions/KBArticle_IsLoaded.md @@ -0,0 +1,12 @@ +## Title: KBArticle_IsLoaded + +**Content:** +Determine if the article is loaded. +`loaded = KBArticle_IsLoaded()` + +**Returns:** +- `loaded` + - *boolean* - True if the article is loaded. + +**Description:** +Normally returns true after `KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS` fires. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_BeginLoading.md b/wiki-information/functions/KBSetup_BeginLoading.md new file mode 100644 index 00000000..6b69ed92 --- /dev/null +++ b/wiki-information/functions/KBSetup_BeginLoading.md @@ -0,0 +1,26 @@ +## Title: KBSetup_BeginLoading + +**Content:** +Starts the loading of articles. +`KBSetup_BeginLoading(articlesPerPage, currentPage)` + +**Parameters:** +- `articlesPerPage` + - *number* - Number of articles shown on one page. +- `currentPage` + - *number* - The current page (starts at 1). + +**Returns:** +- `nil` + +**Usage:** +In `KnowledgeBaseFrame_OnShow()`: +```lua +KBSetup_BeginLoading(KBASE_NUM_ARTICLES_PER_PAGE, KBASE_CURRENT_PAGE) +``` +From Blizzard's `KnowledgeBaseFrame.lua` (l. 51) + +**Description:** +This will start the article loading process and return immediately. +When all articles are loaded, the event `KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS` is fired. +If an error occurs in the loading process, the event `KNOWLEDGE_BASE_SETUP_LOAD_FAILURE` is fired. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetArticleHeaderCount.md b/wiki-information/functions/KBSetup_GetArticleHeaderCount.md new file mode 100644 index 00000000..bd73fa87 --- /dev/null +++ b/wiki-information/functions/KBSetup_GetArticleHeaderCount.md @@ -0,0 +1,23 @@ +## Title: KBSetup_GetArticleHeaderCount + +**Content:** +Returns the number of articles for the current page. +`count = KBSetup_GetArticleHeaderCount()` + +**Parameters:** +- `()` + +**Returns:** +- `count` + - *number* - The number of articles for the current page. + +**Usage:** +```lua +local count = KBSetup_GetArticleHeaderCount() +for i = 1, count do + -- do something with the article +end +``` + +**Description:** +This will count the "most asked" articles, not the number of articles for the active query. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetArticleHeaderData.md b/wiki-information/functions/KBSetup_GetArticleHeaderData.md new file mode 100644 index 00000000..6eac1578 --- /dev/null +++ b/wiki-information/functions/KBSetup_GetArticleHeaderData.md @@ -0,0 +1,30 @@ +## Title: KBSetup_GetArticleHeaderData + +**Content:** +Returns header information about an article. +`id, title, isHot, isNew = KBSetup_GetArticleHeaderData(index)` + +**Parameters:** +- `index` + - *number* - The article's index for that page. + +**Returns:** +- `id` + - *number* - The article's id. +- `title` + - *string* - The article's title. +- `isHot` + - *boolean* - Show the "hot" symbol or not. +- `isNew` + - *boolean* - Show the "new" symbol or not. + +**Usage:** +```lua +local id, title, isHot, isNew = KBSetup_GetArticleHeaderData(1) +if isNew then + ChatFrame1:AddMessage("The article " .. id .. "(" .. title .. ") is new.", 1.0, 1.0, 1.0) +end +``` + +**Description:** +This will work on the "most asked" articles, not the articles of the active query. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetCategoryCount.md b/wiki-information/functions/KBSetup_GetCategoryCount.md new file mode 100644 index 00000000..43f396c9 --- /dev/null +++ b/wiki-information/functions/KBSetup_GetCategoryCount.md @@ -0,0 +1,15 @@ +## Title: KBSetup_GetCategoryCount + +**Content:** +Returns the number of categories. +`count = KBSetup_GetCategoryCount()` + +**Parameters:** +- `()` + +**Returns:** +- `count` + - *number* - Number of categories. + +**Description:** +This is only available when `KBSetup_IsLoaded()` is true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetCategoryData.md b/wiki-information/functions/KBSetup_GetCategoryData.md new file mode 100644 index 00000000..4886379a --- /dev/null +++ b/wiki-information/functions/KBSetup_GetCategoryData.md @@ -0,0 +1,18 @@ +## Title: KBSetup_GetCategoryData + +**Content:** +Returns information about a category. +`id, caption = KBSetup_GetCategoryData(index)` + +**Parameters:** +- `index` + - *number* - Range from 1 to `KBSetup_GetCategoryCount()` + +**Returns:** +- `id` + - *number* - The category's id. +- `caption` + - *string* - The category caption. + +**Description:** +Seems to only work if `KBSetup_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetLanguageCount.md b/wiki-information/functions/KBSetup_GetLanguageCount.md new file mode 100644 index 00000000..45d71456 --- /dev/null +++ b/wiki-information/functions/KBSetup_GetLanguageCount.md @@ -0,0 +1,16 @@ +## Title: KBSetup_GetLanguageCount + +**Content:** +Returns the number of languages in the knowledge base. +`count = KBSetup_GetLanguageCount()` + +**Parameters:** +- `()` + +**Returns:** +- `count` + - *integer* - The number of the available languages. + +**Description:** +Seems to only work if `KBSetup_IsLoaded()` returns true. +On an EU client, this function returns 4 (enUS, deDE, frFR, esES). \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetLanguageData.md b/wiki-information/functions/KBSetup_GetLanguageData.md new file mode 100644 index 00000000..35f5a77e --- /dev/null +++ b/wiki-information/functions/KBSetup_GetLanguageData.md @@ -0,0 +1,18 @@ +## Title: KBSetup_GetLanguageData + +**Content:** +Returns information about a language. +`id, caption = KBSetup_GetLanguageData(index)` + +**Parameters:** +- `index` + - *number* - Range from 1 to `KBSetup_GetLanguageCount()` + +**Returns:** +- `id` + - *number* - The internal language ID. +- `caption` + - *string* - The (localized?) name of the language. + +**Description:** +Seems to only work if `KBSetup_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetSubCategoryCount.md b/wiki-information/functions/KBSetup_GetSubCategoryCount.md new file mode 100644 index 00000000..e6b4dde7 --- /dev/null +++ b/wiki-information/functions/KBSetup_GetSubCategoryCount.md @@ -0,0 +1,16 @@ +## Title: KBSetup_GetSubCategoryCount + +**Content:** +Returns the number of subcategories in a category. +`count = KBSetup_GetSubCategoryCount(category)` + +**Parameters:** +- `category` + - *number* - The category's index. + +**Returns:** +- `count` + - *number* - Number of subcategories. + +**Description:** +This is only available when `KBSetup_IsLoaded()` is true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetSubCategoryData.md b/wiki-information/functions/KBSetup_GetSubCategoryData.md new file mode 100644 index 00000000..54ed6b9d --- /dev/null +++ b/wiki-information/functions/KBSetup_GetSubCategoryData.md @@ -0,0 +1,22 @@ +## Title: KBSetup_GetSubCategoryData + +**Content:** +Returns information about a subcategory. +`id, caption = KBSetup_GetSubCategoryData(category, index)` + +**Parameters:** +- `(category, index)` + - `category` + - *Integer* - The category's index. + - `index` + - *number* - Range from 1 to `KBSetup_GetSubCategoryCount(category)` + +**Returns:** +- `id, caption` + - `id` + - *number* - The category's id. + - `caption` + - *string* - The category caption. + +**Description:** +Only works if `KBSetup_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetTotalArticleCount.md b/wiki-information/functions/KBSetup_GetTotalArticleCount.md new file mode 100644 index 00000000..5abebb8d --- /dev/null +++ b/wiki-information/functions/KBSetup_GetTotalArticleCount.md @@ -0,0 +1,23 @@ +## Title: KBSetup_GetTotalArticleCount + +**Content:** +Returns the number of articles. +`count = KBSetup_GetTotalArticleCount()` + +**Parameters:** +- `()` + +**Returns:** +- `count` + - *number* - The number of articles. + +**Usage:** +```lua +local count = KBSetup_GetTotalArticleCount() +for i = 1, count do + -- do something with the article +end +``` + +**Description:** +This will count the "most asked" articles, not the number of articles for the active query. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_IsLoaded.md b/wiki-information/functions/KBSetup_IsLoaded.md new file mode 100644 index 00000000..2d304112 --- /dev/null +++ b/wiki-information/functions/KBSetup_IsLoaded.md @@ -0,0 +1,23 @@ +## Title: KBSetup_IsLoaded + +**Content:** +Determine if the article list is loaded. +`loaded = KBSetup_IsLoaded()` + +**Parameters:** +- `()` - No parameters. + +**Returns:** +- `loaded` + - *boolean* - True if the article list is loaded. + +**Usage:** +```lua +function KnowledgeBaseFrame_Search(resetCurrentPage) + if ( not KBSetup_IsLoaded() ) then + return; + end + -- ... +end +``` +From Blizzard's KnowledgeBaseFrame.lua (l. 217 ff.) \ No newline at end of file diff --git a/wiki-information/functions/KBSystem_GetMOTD.md b/wiki-information/functions/KBSystem_GetMOTD.md new file mode 100644 index 00000000..7aa691cb --- /dev/null +++ b/wiki-information/functions/KBSystem_GetMOTD.md @@ -0,0 +1,12 @@ +## Title: KBSystem_GetMOTD + +**Content:** +Returns the server message of the day. +`motd = KBSystem_GetMOTD()` + +**Parameters:** +- `()` + +**Returns:** +- `motd` + - *string* - The message of the day. \ No newline at end of file diff --git a/wiki-information/functions/KBSystem_GetServerNotice.md b/wiki-information/functions/KBSystem_GetServerNotice.md new file mode 100644 index 00000000..5f73ce43 --- /dev/null +++ b/wiki-information/functions/KBSystem_GetServerNotice.md @@ -0,0 +1,12 @@ +## Title: KBSystem_GetServerNotice + +**Content:** +Returns the current server notice. +`notice = KBSystem_GetServerNotice()` + +**Returns:** +- `notice` + - *string?* - The server notice if there is one; nil otherwise. + +**Reference:** +- `KNOWLEDGE_BASE_SERVER_MESSAGE` - Indicates the server notice has changed. \ No newline at end of file diff --git a/wiki-information/functions/KBSystem_GetServerStatus.md b/wiki-information/functions/KBSystem_GetServerStatus.md new file mode 100644 index 00000000..c7d1264a --- /dev/null +++ b/wiki-information/functions/KBSystem_GetServerStatus.md @@ -0,0 +1,15 @@ +## Title: KBSystem_GetServerStatus + +**Content:** +Returns the current server status. +`status = KBSystem_GetServerStatus()` + +**Parameters:** +- `()` + +**Returns:** +- `status` + - *string* - The server status message. May be nil. + +**Description:** +This function is not used in Blizzard's knowledge base. \ No newline at end of file diff --git a/wiki-information/functions/KeyRingButtonIDToInvSlotID.md b/wiki-information/functions/KeyRingButtonIDToInvSlotID.md new file mode 100644 index 00000000..a73cc6a9 --- /dev/null +++ b/wiki-information/functions/KeyRingButtonIDToInvSlotID.md @@ -0,0 +1,13 @@ +## Title: KeyRingButtonIDToInvSlotID + +**Content:** +Map a keyring button to an inventory slot button for use in inventory functions. +`invSlot = KeyRingButtonIDToInvSlotID(buttonID)` + +**Parameters:** +- `buttonID` + - *number* - key ring button ID. + +**Returns:** +- `invSlot` + - *number* - an inventory slot ID. \ No newline at end of file diff --git a/wiki-information/functions/LFGTeleport.md b/wiki-information/functions/LFGTeleport.md new file mode 100644 index 00000000..6104f23b --- /dev/null +++ b/wiki-information/functions/LFGTeleport.md @@ -0,0 +1,18 @@ +## Title: LFGTeleport + +**Content:** +Teleports the player to or from a LFG dungeon. +`LFGTeleport(toSafety)` + +**Parameters:** +- `toSafety` + - *boolean* - false to teleport to the dungeon, true to teleport to where you were before you were teleported to the dungeon. + +**Usage:** +`/run LFGTeleport(IsInLFGDungeon())` + +**Example Use Case:** +This function can be used to quickly teleport in and out of a dungeon when you are in a Looking For Group (LFG) instance. For example, if you need to quickly leave the dungeon to repair your gear or restock on supplies, you can use this function to teleport out and then back in. + +**Addons:** +Many popular addons like Deadly Boss Mods (DBM) and ElvUI use this function to provide quick access buttons for players to teleport in and out of LFG dungeons, enhancing the user experience by providing convenient shortcuts. \ No newline at end of file diff --git a/wiki-information/functions/LearnTalent.md b/wiki-information/functions/LearnTalent.md new file mode 100644 index 00000000..566d4a8e --- /dev/null +++ b/wiki-information/functions/LearnTalent.md @@ -0,0 +1,22 @@ +## Title: LearnTalent + +**Content:** +Learns the specified talent. +`success = LearnTalent(talentID)` + +**Parameters:** +- `talentID` + - *number* + +**Returns:** +- `success` + - *boolean* - Returns false when e.g. in combat. + +**Usage:** +Learns holy priest's talent. +```lua +/run LearnTalent(19753) +``` + +**Reference:** +- `LearnPvpTalent()` \ No newline at end of file diff --git a/wiki-information/functions/LeaveChannelByName.md b/wiki-information/functions/LeaveChannelByName.md new file mode 100644 index 00000000..5f47f09e --- /dev/null +++ b/wiki-information/functions/LeaveChannelByName.md @@ -0,0 +1,20 @@ +## Title: LeaveChannelByName + +**Content:** +Leaves the channel with the specified name. +`LeaveChannelByName(channelName)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel to leave. + +**Usage:** +```lua +LeaveChannelByName("Trade"); +``` + +**Example Use Case:** +This function can be used in an addon or script to programmatically leave a specific chat channel, such as the Trade channel, which can be useful for reducing chat spam or focusing on other channels. + +**Addons Using This Function:** +Many chat management addons, such as Prat or Chatter, may use this function to allow users to customize their chat experience by automatically leaving certain channels based on user preferences. \ No newline at end of file diff --git a/wiki-information/functions/ListChannelByName.md b/wiki-information/functions/ListChannelByName.md new file mode 100644 index 00000000..2d4caba1 --- /dev/null +++ b/wiki-information/functions/ListChannelByName.md @@ -0,0 +1,9 @@ +## Title: ListChannelByName + +**Content:** +Prints the list of members in the specified channel. +`ListChannelByName(channel)` + +**Parameters:** +- `channel` + - *number|string* - Channel number or case-insensitive channel name from which to list the members, e.g. "trade - city". \ No newline at end of file diff --git a/wiki-information/functions/LoadAddOn.md b/wiki-information/functions/LoadAddOn.md new file mode 100644 index 00000000..e7a1b315 --- /dev/null +++ b/wiki-information/functions/LoadAddOn.md @@ -0,0 +1,81 @@ +## Title: LoadAddOn + +**Content:** +Loads the specified LoadOnDemand addon. +`loaded, reason = LoadAddOn(name)` + +**Parameters:** +- `name` + - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. + +**Returns:** +- `loaded` + - *boolean* - If the AddOn is successfully loaded or was already loaded. +- `reason` + - *string?* - Locale-independent reason why the AddOn could not be loaded e.g. "DISABLED", otherwise returns nil if the addon was loaded. + +**Description:** +Requires the addon to have the LoadOnDemand TOC field specified. +``` +## LoadOnDemand: 1 +``` +LoadOnDemand addons are useful for reducing loading screen times by loading only when necessary, like with the different DeadlyBossMods addons/submodules. + +**Related Events:** +- `ADDON_LOADED` + +**Reasons:** +These have corresponding global strings when prefixed with "ADDON_": +- `ADDON_BANNED` = "Banned" -- Addon is banned by the client +- `ADDON_CORRUPT` = "Corrupt" -- The addon's file(s) are corrupt +- `ADDON_DEMAND_LOADED` = "Only loadable on demand" +- `ADDON_DISABLED` = "Disabled" -- Addon is disabled on the character select screen +- `ADDON_INCOMPATIBLE` = "Incompatible" -- The addon is not compatible with the current TOC version +- `ADDON_INSECURE` = "Insecure" +- `ADDON_INTERFACE_VERSION` = "Out of date" +- `ADDON_MISSING` = "Missing" -- The addon is physically not there +- `ADDON_NOT_AVAILABLE` = "Not Available" +- `ADDON_UNKNOWN_ERROR` = "Unknown load problem" +- `ADDON_DEP_BANNED` = "Dependency banned" -- Addon's dependency is banned by the client +- `ADDON_DEP_CORRUPT` = "Dependency corrupt" -- The addon's dependency cannot load because its file(s) are corrupt +- `ADDON_DEP_DEMAND_LOADED` = "Dependency only loadable on demand" +- `ADDON_DEP_DISABLED` = "Dependency disabled" -- The addon cannot load without its dependency enabled +- `ADDON_DEP_INCOMPATIBLE` = "Dependency incompatible" -- The addon cannot load if its dependency cannot load +- `ADDON_DEP_INSECURE` = "Dependency insecure" +- `ADDON_DEP_INTERFACE_VERSION` = "Dependency out of date" +- `ADDON_DEP_MISSING` = "Dependency missing" -- The addon's dependency is physically not there + +**Usage:** +Attempts to load a LoadOnDemand addon. If the addon is disabled, it will try to enable it first. +```lua +local function TryLoadAddOn(name) + local loaded, reason = LoadAddOn(name) + if not loaded then + if reason == "DISABLED" then + EnableAddOn(name, true) -- enable for all characters on the realm + LoadAddOn(name) + else + local failed_msg = format("%s - %s", reason, _G) + error(ADDON_LOAD_FAILED:format(name, failed_msg)) + end + end +end +TryLoadAddOn("SomeAddOn") +-- Couldn't load SomeAddOn: MISSING - Missing +``` + +Manually loads and shows the Blizzard Achievement UI addon. +```lua +/run LoadAddOn("Blizzard_AchievementUI"); AchievementFrame_ToggleAchievementFrame(); +``` + +**Reference:** +- `IsAddOnLoaded()` +- `UIParentLoadAddOn()` + +**Example Use Case:** +This function can be used to dynamically load addons that are not required at the start of the game, thereby reducing initial load times. For example, DeadlyBossMods (DBM) uses LoadOnDemand to load specific boss modules only when the player enters the relevant dungeon or raid. + +**Large Addons Using This Function:** +- **DeadlyBossMods (DBM):** Uses LoadOnDemand to load specific boss encounter modules only when needed, reducing the overall memory footprint and load times. +- **Auctioneer:** Loads additional modules for advanced auction house functionalities only when the auction house interface is opened. \ No newline at end of file diff --git a/wiki-information/functions/LoadBindings.md b/wiki-information/functions/LoadBindings.md new file mode 100644 index 00000000..2ccd6c12 --- /dev/null +++ b/wiki-information/functions/LoadBindings.md @@ -0,0 +1,18 @@ +## Title: LoadBindings + +**Content:** +Loads default, account, or character-specific key bindings. +`LoadBindings(bindingSet)` + +**Parameters:** +- `bindingSet` + - *number* - Which binding set to load; one of the following three numeric constants: + - `DEFAULT_BINDINGS` (0) + - `ACCOUNT_BINDINGS` (1) + - `CHARACTER_BINDINGS` (2) + +**Reference:** +- `UPDATE_BINDINGS` when the binding set has been loaded. + +**Description:** +The file it reads from is `WTF\Account\ACCOUNTNAME\bindings-cache.wtf`. \ No newline at end of file diff --git a/wiki-information/functions/LoadURLIndex.md b/wiki-information/functions/LoadURLIndex.md new file mode 100644 index 00000000..91e38911 --- /dev/null +++ b/wiki-information/functions/LoadURLIndex.md @@ -0,0 +1,11 @@ +## Title: LoadURLIndex + +**Content:** +Needs summary. +`LoadURLIndex(index)` + +**Parameters:** +- `index` + - *number* +- `param` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/LoggingChat.md b/wiki-information/functions/LoggingChat.md new file mode 100644 index 00000000..21660b25 --- /dev/null +++ b/wiki-information/functions/LoggingChat.md @@ -0,0 +1,30 @@ +## Title: LoggingChat + +**Content:** +Gets or sets whether logging chat to `Logs\WoWChatLog.txt` is enabled. +`isLogging = LoggingChat()` + +**Parameters:** +- `newState` + - *boolean* - toggles chat logging + +**Returns:** +- `isLogging` + - *boolean* - current state of logging + +**Usage:** +```lua +if (LoggingChat()) then + print("Chat is already being logged") +else + print("Chat is not being logged - starting it!") + LoggingChat(1) + print("Chat is now being logged to Logs\\WOWChatLog.txt") +end +``` + +**Example Use Case:** +This function can be used in an addon to ensure that chat logs are being recorded for later review or debugging purposes. For instance, a guild management addon might use this to log all guild chat for administrative review. + +**Addons Using This Function:** +While specific large addons using this function are not well-documented, any addon that requires chat logging for analysis or record-keeping, such as raid logging tools or guild management addons, might utilize this function to ensure chat is being logged. \ No newline at end of file diff --git a/wiki-information/functions/LoggingCombat.md b/wiki-information/functions/LoggingCombat.md new file mode 100644 index 00000000..c1f4323e --- /dev/null +++ b/wiki-information/functions/LoggingCombat.md @@ -0,0 +1,42 @@ +## Title: LoggingCombat + +**Content:** +Gets or sets whether logging combat to `Logs\WoWCombatLog.txt` is enabled. +`isLogging = LoggingCombat()` + +**Parameters:** +- `newState` + - *boolean* - Toggles combat logging + +**Returns:** +- `isLogging` + - *false* - You are not logging + - *true* - You are logging + - When spammed, may return `nil` instead of `true` or `false`. + +**Usage:** +```lua +if (LoggingCombat()) then + DEFAULT_CHAT_FRAME:AddMessage("Combat is already being logged"); +else + DEFAULT_CHAT_FRAME:AddMessage("Combat is not being logged - starting it!"); + LoggingCombat(1); +end + +if (LoggingCombat()) then + DEFAULT_CHAT_FRAME:AddMessage("Combat is already being logged"); +else + DEFAULT_CHAT_FRAME:AddMessage("Combat is not being logged - starting it!"); + LoggingCombat(1); +end +``` + +**Example #2:** +Create a new macro and paste the following (one-line): +```lua +/script local a=LoggingCombat(LoggingCombat()==nil); UIErrorsFrame:AddMessage("CombatLogging is now "..tostring(a and "ON" or "OFF"),1,0,0); +``` +Drag the macro-button to an action bar or key bind it and you have a one-click/keypress toggle. + +**Description:** +If no parameter is passed in, `LoggingCombat` only returns the current state. \ No newline at end of file diff --git a/wiki-information/functions/Logout.md b/wiki-information/functions/Logout.md new file mode 100644 index 00000000..998ddeec --- /dev/null +++ b/wiki-information/functions/Logout.md @@ -0,0 +1,10 @@ +## Title: Logout + +**Content:** +Logs the player out of the game. +`Logout()` + +**Reference:** +- `PLAYER_CAMPING` +- See also: + - `CancelLogout` \ No newline at end of file diff --git a/wiki-information/functions/LootSlot.md b/wiki-information/functions/LootSlot.md new file mode 100644 index 00000000..a771c842 --- /dev/null +++ b/wiki-information/functions/LootSlot.md @@ -0,0 +1,25 @@ +## Title: LootSlot + +**Content:** +Loots the specified slot; can require confirmation with `ConfirmLootSlot`. +`LootSlot(slot)` + +**Parameters:** +- `slot` + - *number* - the loot slot. + +**Returns:** +- unknown + +**Usage:** +```lua +LootSlot(1) +-- if slot 1 contains an item that must be confirmed, then +ConfirmLootSlot(1) +-- must be called after. +``` + +**Miscellaneous:** +Result: + +This function is called whenever a LootButton is clicked (or auto looted). \ No newline at end of file diff --git a/wiki-information/functions/LootSlotHasItem.md b/wiki-information/functions/LootSlotHasItem.md new file mode 100644 index 00000000..5baea012 --- /dev/null +++ b/wiki-information/functions/LootSlotHasItem.md @@ -0,0 +1,37 @@ +## Title: LootSlotHasItem + +**Content:** +Returns whether a loot slot contains an item. +`isLootItem = LootSlotHasItem(lootSlot)` + +**Parameters:** +- `lootSlot` + - *number* - index of the loot slot, ascending from 1 to `GetNumLootItems()` + +**Returns:** +- `isLootItem` + - *boolean* - true if the loot slot contains an item rather than coin. + +**Usage:** +Iterate through the items in the currently opened loot window and display them in the chat frame, side by side. +```lua +local itemLinkText +for i = 1, GetNumLootItems() do + if (LootSlotHasItem(i)) then + local iteminfo = GetLootSlotLink(i) + if itemLinkText == nil then + itemLinkText = iteminfo + else + itemLinkText = itemLinkText .. ", " .. iteminfo + end + end +end +print(itemLinkText) +``` + +**Example Use Case:** +This function can be used in addons that manage loot distribution, such as auto-looting systems or loot tracking addons. For example, an addon could use this function to filter out coin slots and only process item slots for further actions like auto-looting specific items or displaying item links in the chat. + +**Addons Using This Function:** +- **LootMaster:** This addon uses `LootSlotHasItem` to determine which slots contain items and then processes those items for master looting purposes. +- **AutoLootPlus:** This addon uses the function to enhance the auto-looting experience by filtering out coin slots and focusing on item slots, allowing for more efficient looting. \ No newline at end of file diff --git a/wiki-information/functions/MouselookStart.md b/wiki-information/functions/MouselookStart.md new file mode 100644 index 00000000..1bb0da88 --- /dev/null +++ b/wiki-information/functions/MouselookStart.md @@ -0,0 +1,9 @@ +## Title: MouselookStart + +**Content:** +Enters mouse look mode; alters the character's movement/facing direction. +`MouselookStart()` + +**Reference:** +- `IsMouselooking` +- `MouselookStop` \ No newline at end of file diff --git a/wiki-information/functions/MouselookStop.md b/wiki-information/functions/MouselookStop.md new file mode 100644 index 00000000..94d2ef81 --- /dev/null +++ b/wiki-information/functions/MouselookStop.md @@ -0,0 +1,9 @@ +## Title: MouselookStop + +**Content:** +Exits mouse look mode. +`MouselookStop()` + +**Reference:** +- `IsMouselooking` +- `MouselookStart` \ No newline at end of file diff --git a/wiki-information/functions/MoveBackwardStart.md b/wiki-information/functions/MoveBackwardStart.md new file mode 100644 index 00000000..aaeb08b3 --- /dev/null +++ b/wiki-information/functions/MoveBackwardStart.md @@ -0,0 +1,12 @@ +## Title: MoveBackwardStart + +**Content:** +The player begins moving backward at the specified time. +`MoveBackwardStart(startTime)` + +**Parameters:** +- `startTime` + - *number* - Begin moving backward at this time, per `GetTime * 1000`. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveBackwardStop.md b/wiki-information/functions/MoveBackwardStop.md new file mode 100644 index 00000000..ef84a417 --- /dev/null +++ b/wiki-information/functions/MoveBackwardStop.md @@ -0,0 +1,12 @@ +## Title: MoveBackwardStop + +**Content:** +The player stops moving backward at the specified time. +`MoveBackwardStop(startTime)` + +**Parameters:** +- `stopTime` + - *number* - Stop moving backward at this time, per `GetTime * 1000`. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveForwardStart.md b/wiki-information/functions/MoveForwardStart.md new file mode 100644 index 00000000..581cb8b4 --- /dev/null +++ b/wiki-information/functions/MoveForwardStart.md @@ -0,0 +1,12 @@ +## Title: MoveForwardStart + +**Content:** +The player begins moving forward at the specified time. +`MoveForwardStart(startTime)` + +**Parameters:** +- `startTime` + - *number* - Begin moving forward at this time, per GetTime * 1000. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveForwardStop.md b/wiki-information/functions/MoveForwardStop.md new file mode 100644 index 00000000..516c87bd --- /dev/null +++ b/wiki-information/functions/MoveForwardStop.md @@ -0,0 +1,12 @@ +## Title: MoveForwardStop + +**Content:** +The player stops moving forward at the specified time. +`MoveForwardStop(startTime)` + +**Parameters:** +- `stopTime` + - Stop moving forward at this time, per `GetTime * 1000`. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewDownStart.md b/wiki-information/functions/MoveViewDownStart.md new file mode 100644 index 00000000..ecf797af --- /dev/null +++ b/wiki-information/functions/MoveViewDownStart.md @@ -0,0 +1,24 @@ +## Title: MoveViewDownStart + +**Content:** +Starts rotating the camera downward. +`MoveViewDownStart(speed)` + +**Parameters:** +- `speed` + - *number* - Speed at which to begin rotating. + +**Returns:** +Nothing + +**Usage:** +```lua +MoveViewDownStart(25/tonumber(GetCVar("cameraPitchMoveSpeed"))) -- rotate camera down at 25 degrees/second +``` + +**Description:** +Speed is a multiplier on the CVar 'cameraPitchMoveSpeed', which is in degrees/second. +If speed is omitted, it is assumed to be 1.0. +Negative numbers go the opposite way, a speed of 0.0 will stop it. +This is not canceled by moving your character or interacting with the camera. +Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewDownStop.md b/wiki-information/functions/MoveViewDownStop.md new file mode 100644 index 00000000..ed432a6f --- /dev/null +++ b/wiki-information/functions/MoveViewDownStop.md @@ -0,0 +1,8 @@ +## Title: MoveViewDownStop + +**Content:** +Stops rotating the camera downward. +`MoveViewDownStop()` + +**Description:** +Equivalent to `MoveViewDownStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewInStart.md b/wiki-information/functions/MoveViewInStart.md new file mode 100644 index 00000000..9227bb00 --- /dev/null +++ b/wiki-information/functions/MoveViewInStart.md @@ -0,0 +1,24 @@ +## Title: MoveViewInStart + +**Content:** +Begins zooming the camera in. +`MoveViewInStart(speed)` + +**Parameters:** +- `speed` + - *number* - Speed at which to begin zooming. + +**Returns:** +Nothing + +**Usage:** +```lua +MoveViewInStart(5/tonumber(GetCVar("cameraZoomSpeed"))) -- zoom the camera in at 5 increments/second +``` + +**Description:** +Speed is a multiplier on the CVar 'cameraZoomSpeed', which is in increments/second. A zoom increment appears to be about a yard from the character. +If speed is omitted, it is assumed to be 1.0. +Negative numbers go the opposite way, a speed of 0.0 will stop it. +This is not canceled by moving your character, but is canceled by using the mousewheel to zoom. +Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you zoom both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewInStop.md b/wiki-information/functions/MoveViewInStop.md new file mode 100644 index 00000000..7b9302a7 --- /dev/null +++ b/wiki-information/functions/MoveViewInStop.md @@ -0,0 +1,8 @@ +## Title: MoveViewInStop + +**Content:** +Stops zooming the camera in. +`MoveViewInStop()` + +**Description:** +Equivalent to `MoveViewInStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewLeftStart.md b/wiki-information/functions/MoveViewLeftStart.md new file mode 100644 index 00000000..88445ba9 --- /dev/null +++ b/wiki-information/functions/MoveViewLeftStart.md @@ -0,0 +1,24 @@ +## Title: MoveViewLeftStart + +**Content:** +Starts rotating the camera to the left. +`MoveViewLeftStart(speed)` + +**Parameters:** +- `speed` + - *number* - Speed at which to begin rotating. + +**Returns:** +Nothing + +**Usage:** +```lua +MoveViewLeftStart(90/tonumber(GetCVar("cameraYawMoveSpeed"))) -- rotate camera to the left at 90 degrees/second +``` + +**Description:** +Speed is a multiplier on the CVar 'cameraYawMoveSpeed', which is in degrees/second. +If speed is omitted, it is assumed to be 1.0. +Negative numbers go the opposite way, a speed of 0.0 will stop it. +This is not canceled by moving your character or interacting with the camera. +Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewLeftStop.md b/wiki-information/functions/MoveViewLeftStop.md new file mode 100644 index 00000000..f9b172cb --- /dev/null +++ b/wiki-information/functions/MoveViewLeftStop.md @@ -0,0 +1,8 @@ +## Title: MoveViewLeftStop + +**Content:** +Stops rotating the camera to the left. +`MoveViewLeftStop()` + +**Description:** +Equivalent to `MoveViewLeftStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewOutStart.md b/wiki-information/functions/MoveViewOutStart.md new file mode 100644 index 00000000..6b83ed85 --- /dev/null +++ b/wiki-information/functions/MoveViewOutStart.md @@ -0,0 +1,24 @@ +## Title: MoveViewOutStart + +**Content:** +Begins zooming the camera out. +`MoveViewOutStart(speed)` + +**Parameters:** +- `speed` + - *number* - Speed at which to begin zooming. + +**Returns:** +Nothing + +**Usage:** +```lua +MoveViewOutStart(5/tonumber(GetCVar("cameraZoomSpeed"))) -- zoom the camera out at 5 increments/second +``` + +**Description:** +Speed is a multiplier on the CVar 'cameraZoomSpeed', which is in increments/second. A zoom increment appears to be about a yard from the character. +If speed is omitted, it is assumed to be 1.0. +Negative numbers go the opposite way, a speed of 0.0 will stop it. +This is not canceled by moving your character, but is canceled by using the mousewheel to zoom. +Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you zoom both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewOutStop.md b/wiki-information/functions/MoveViewOutStop.md new file mode 100644 index 00000000..d1808680 --- /dev/null +++ b/wiki-information/functions/MoveViewOutStop.md @@ -0,0 +1,8 @@ +## Title: MoveViewOutStop + +**Content:** +Stops zooming the camera out. +`MoveViewOutStop()` + +**Description:** +Equivalent to `MoveViewOutStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewRightStart.md b/wiki-information/functions/MoveViewRightStart.md new file mode 100644 index 00000000..25be7dc6 --- /dev/null +++ b/wiki-information/functions/MoveViewRightStart.md @@ -0,0 +1,24 @@ +## Title: MoveViewRightStart + +**Content:** +Starts rotating the camera to the right. +`MoveViewRightStart(speed)` + +**Parameters:** +- `speed` + - *number* - Speed at which to begin rotating. + +**Returns:** +Nothing + +**Usage:** +```lua +MoveViewRightStart(90/tonumber(GetCVar("cameraYawMoveSpeed"))) -- rotate camera to the right at 90 degrees/second +``` + +**Description:** +Speed is a multiplier on the CVar 'cameraYawMoveSpeed', which is in degrees/second. +If speed is omitted, it is assumed to be 1.0. +Negative numbers go the opposite way, a speed of 0.0 will stop it. +This is not canceled by moving your character or interacting with the camera. +Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewRightStop.md b/wiki-information/functions/MoveViewRightStop.md new file mode 100644 index 00000000..200df198 --- /dev/null +++ b/wiki-information/functions/MoveViewRightStop.md @@ -0,0 +1,14 @@ +## Title: MoveViewRightStop + +**Content:** +Stops rotating the camera to the right. +`MoveViewRightStop()` + +**Parameters:** +- None + +**Returns:** +- Nothing + +**Description:** +Equivalent to `MoveViewRightStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewUpStart.md b/wiki-information/functions/MoveViewUpStart.md new file mode 100644 index 00000000..c149480d --- /dev/null +++ b/wiki-information/functions/MoveViewUpStart.md @@ -0,0 +1,24 @@ +## Title: MoveViewUpStart + +**Content:** +Starts rotating the camera upward. +`MoveViewUpStart(speed)` + +**Parameters:** +- `speed` + - *number* - Speed at which to begin rotating. + +**Returns:** +Nothing + +**Usage:** +```lua +MoveViewUpStart(25/tonumber(GetCVar("cameraPitchMoveSpeed"))) -- rotate camera up at 25 degrees/second +``` + +**Description:** +Speed is a multiplier on the CVar 'cameraPitchMoveSpeed', which is in degrees/second. +If speed is omitted, it is assumed to be 1.0. +Negative numbers go the opposite way, a speed of 0.0 will stop it. +This is not canceled by moving your character or interacting with the camera. +Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewUpStop.md b/wiki-information/functions/MoveViewUpStop.md new file mode 100644 index 00000000..ffadb179 --- /dev/null +++ b/wiki-information/functions/MoveViewUpStop.md @@ -0,0 +1,14 @@ +## Title: MoveViewUpStop + +**Content:** +Stops rotating the camera upward. +`MoveViewUpStop()` + +**Parameters:** +None + +**Returns:** +Nothing + +**Description:** +Equivalent to `MoveViewUpStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MuteSoundFile.md b/wiki-information/functions/MuteSoundFile.md new file mode 100644 index 00000000..2b1ba65d --- /dev/null +++ b/wiki-information/functions/MuteSoundFile.md @@ -0,0 +1,53 @@ +## Title: MuteSoundFile + +**Content:** +Mutes a sound file. +`MuteSoundFile(sound)` + +**Parameters:** +- `sound` + - *number|string* - FileID of a game sound or file path to an addon sound. + +**Usage:** +Plays the Sound/Spells/LevelUp.ogg sound +```lua +/run PlaySoundFile(569593) +``` +Mutes it, the sound won't play +```lua +/run MuteSoundFile(569593); PlaySoundFile(569593) +``` +Unmutes it and plays it +```lua +/run UnmuteSoundFile(569593); PlaySoundFile(569593) +``` +Addon example: +Mutes the fizzle sounds. +```lua +local sounds = { + 569772, -- sound/spells/fizzle/fizzleholya.ogg + 569773, -- sound/spells/fizzle/fizzlefirea.ogg + 569774, -- sound/spells/fizzle/fizzlenaturea.ogg + 569775, -- sound/spells/fizzle/fizzlefrosta.ogg + 569776, -- sound/spells/fizzle/fizzleshadowa.ogg +} +for _, fdid in pairs(sounds) do + MuteSoundFile(fdid) +end +``` + +**Description:** +Muted sound settings only persist through relogging and /reload. They have to be muted again after restarting the game client. +This works on all internal game sounds, addon sounds, and sounds played manually by `PlaySoundFile()`. +There is no API to replace sound files. + +**Miscellaneous:** +- **File Data IDs** + - By file name/path, e.g. `Spells/LevelUp,type:ogg` in [wow.tools](https://wow.tools) + - By SoundKitID, e.g. `skit:888` in [wow.tools](https://wow.tools) + - By sound kit name with [wow.tools](https://wow.tools/files/sounds.php) +- **Sound Kit Names/IDs** + - From the sounds tab for an NPC, for example [Waveblade Shaman](https://www.wowhead.com/npc=154304/waveblade-shaman#sounds) + - By sound kit name with [Wowhead Sounds](https://www.wowhead.com/sounds) and `SoundKitName.db2` + - IDs used by the FrameXML are defined in the `SOUNDKIT` table + - The full list of IDs can be found in `SoundKitEntry.db2` \ No newline at end of file diff --git a/wiki-information/functions/NoPlayTime.md b/wiki-information/functions/NoPlayTime.md new file mode 100644 index 00000000..44c75d61 --- /dev/null +++ b/wiki-information/functions/NoPlayTime.md @@ -0,0 +1,26 @@ +## Title: NoPlayTime + +**Content:** +Returns true if the account is considered "unhealthy" for players on Chinese realms. +`isUnhealthy = NoPlayTime()` + +**Returns:** +- `isUnhealthy` + - *boolean?* - 1 if the account is "unhealthy", nil if not. + +**Usage:** +```lua +if NoPlayTime() then + print(string.format(PLAYTIME_UNHEALTHY, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) +else + print("You are not limited by NoPlayTime.") +end +``` + +**Description:** +Only relevant on Chinese realms. +The time left is stored on your account, and will display the same amount on every character. + +**Reference:** +- `GetBillingTimeRested` - The remaining time until this restriction comes into effect +- `PartialPlayTime` - A form of limited restriction (-50% to xp and currency) that is presumably removed from the game \ No newline at end of file diff --git a/wiki-information/functions/NotWhileDeadError.md b/wiki-information/functions/NotWhileDeadError.md new file mode 100644 index 00000000..c2514bfe --- /dev/null +++ b/wiki-information/functions/NotWhileDeadError.md @@ -0,0 +1,8 @@ +## Title: NotWhileDeadError + +**Content:** +Generates an error message saying you cannot do that while dead. +`NotWhileDeadError()` + +**Reference:** +- `UI_ERROR_MESSAGE`: "You can't do that when you're dead." \ No newline at end of file diff --git a/wiki-information/functions/NotifyInspect.md b/wiki-information/functions/NotifyInspect.md new file mode 100644 index 00000000..79502a8c --- /dev/null +++ b/wiki-information/functions/NotifyInspect.md @@ -0,0 +1,17 @@ +## Title: NotifyInspect + +**Content:** +Requests another player's inventory and talent info before inspecting. +`NotifyInspect(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to inspect. + +**Description:** +Triggers `INSPECT_READY` when information is asynchronously available. +Requires an eligible unit within range, confirmed with `CanInspect()` and `CheckInteractDistance()`. +The client continues checking equipment and talent changes until halted by `ClearInspectPlayer()`. + +**Reference:** +- `RequestInspectHonorData()` - Classic only function for PvP statistics. \ No newline at end of file diff --git a/wiki-information/functions/NumTaxiNodes.md b/wiki-information/functions/NumTaxiNodes.md new file mode 100644 index 00000000..0ba16792 --- /dev/null +++ b/wiki-information/functions/NumTaxiNodes.md @@ -0,0 +1,17 @@ +## Title: NumTaxiNodes + +**Content:** +Returns the number of flight paths on the taxi map. +`numNodes = NumTaxiNodes()` + +**Returns:** +- `numNodes` + - *number* - total number of flight points on the currently open taxi map; 0 if the taxi map is not open. + +**Description:** +Taxi information is only available while the taxi map is open -- between the `TAXIMAP_OPENED` and `TAXIMAP_CLOSED` events. + +**Reference:** +- `TaxiNodeName` +- `TaxiNodePosition` +- `TakeTaxiNode` \ No newline at end of file diff --git a/wiki-information/functions/OfferPetition.md b/wiki-information/functions/OfferPetition.md new file mode 100644 index 00000000..3ca59804 --- /dev/null +++ b/wiki-information/functions/OfferPetition.md @@ -0,0 +1,19 @@ +## Title: OfferPetition + +**Content:** +Offers a petition to your target. +`OfferPetition()` + +**Usage:** +You can efficiently ask for petition signatures with a macro like this one: +```lua +#showtooltip +/use item:5863 +/run local s,t={},UnitName("target")for i=1,GetNumPetitionNames()do s=1 end if GetPetitionInfo()and t and not sthen OfferPetition()end +``` + +**Example Use Case:** +This function can be used when you need to gather signatures for a guild charter or arena team charter. By using the provided macro, you can streamline the process of offering the petition to your target, making it easier to collect the necessary signatures. + +**Addons:** +While not commonly used in large addons, this function is particularly useful for players who are forming new guilds or arena teams and need to gather signatures quickly and efficiently. \ No newline at end of file diff --git a/wiki-information/functions/PartialPlayTime.md b/wiki-information/functions/PartialPlayTime.md new file mode 100644 index 00000000..9dadf8c9 --- /dev/null +++ b/wiki-information/functions/PartialPlayTime.md @@ -0,0 +1,32 @@ +## Title: PartialPlayTime + +**Content:** +Returns true if the account is considered "tired" for players on Chinese realms. +`isTired = NoPlayTime()` + +**Returns:** +- `isTired` + - *boolean?* - 1 if the account is "tired", nil if not. See details below for clarification. Returns nil for EU and US accounts. + +**Usage:** +Based on the official function, changed a bit to output the text in the chat rather than the tooltip on your avatar: +```lua +if PartialPlayTime() then + print(string.format(PLAYTIME_TIRED, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) +elseif NoPlayTime() then + print(string.format(PLAYTIME_UNHEALTHY, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) +else + print("You are not limited by PartialPlayTime nor NoPlayTime.") +end +``` + +**Description:** +Only relevant on Chinese realms. +When you reach 3 hours remaining you will get "tired", reducing both the amount of money and experience that you receive by 50%. +If you play for 5 hours you will get "unhealthy", and won't be able to turn in quests, receive experience or loot. +The time left is stored on your account, and will display the same amount on every character. +The time will decay as you stay logged out. + +**Reference:** +- `GetBillingTimeRested` +- `NoPlayTime` \ No newline at end of file diff --git a/wiki-information/functions/PetAbandon.md b/wiki-information/functions/PetAbandon.md new file mode 100644 index 00000000..7691095b --- /dev/null +++ b/wiki-information/functions/PetAbandon.md @@ -0,0 +1,9 @@ +## Title: PetAbandon + +**Content:** +Permanently abandons your pet. +`PetAbandon()` + +**Description:** +Opposed to abandoning via pet portrait menu, THERE IS NO CONFIRMATION before abandoning the pet. +Use with caution. \ No newline at end of file diff --git a/wiki-information/functions/PetAggressiveMode.md b/wiki-information/functions/PetAggressiveMode.md new file mode 100644 index 00000000..2d8828bc --- /dev/null +++ b/wiki-information/functions/PetAggressiveMode.md @@ -0,0 +1,11 @@ +## Title: PetAggressiveMode + +**Content:** +Switches your pet to aggressive mode; does nothing. +`PetAggressiveMode()` + +**Description:** +Set your pet in aggressive mode. Requires a button press. + +**Reference:** +[PetAssistMode](#PetAssistMode) \ No newline at end of file diff --git a/wiki-information/functions/PetAttack.md b/wiki-information/functions/PetAttack.md new file mode 100644 index 00000000..36696f6e --- /dev/null +++ b/wiki-information/functions/PetAttack.md @@ -0,0 +1,5 @@ +## Title: PetAttack + +**Content:** +Instruct your pet to attack your target. +`PetAttack()` \ No newline at end of file diff --git a/wiki-information/functions/PetCanBeAbandoned.md b/wiki-information/functions/PetCanBeAbandoned.md new file mode 100644 index 00000000..8d7ef080 --- /dev/null +++ b/wiki-information/functions/PetCanBeAbandoned.md @@ -0,0 +1,22 @@ +## Title: PetCanBeAbandoned + +**Content:** +Returns true if the pet can be abandoned. +`canAbandon = PetCanBeAbandoned()` + +**Returns:** +- `canAbandon` + - *boolean* - true if the player's pet can be abandoned. + +**Usage:** +```lua +if (PetCanBeAbandoned()) then + PetAbandon(); +end +``` + +**Example Use Case:** +This function can be used in a script or addon to check if a player's pet can be abandoned before attempting to abandon it. This is useful in scenarios where you want to ensure that the pet can be safely abandoned without causing errors or unexpected behavior. + +**Addon Example:** +In large addons like "PetTracker," this function might be used to manage pet collections, ensuring that pets can be abandoned when necessary to make room for new ones. \ No newline at end of file diff --git a/wiki-information/functions/PetCanBeRenamed.md b/wiki-information/functions/PetCanBeRenamed.md new file mode 100644 index 00000000..5fe29fcf --- /dev/null +++ b/wiki-information/functions/PetCanBeRenamed.md @@ -0,0 +1,16 @@ +## Title: PetCanBeRenamed + +**Content:** +Returns true if the pet can be renamed. +`canRename = PetCanBeRenamed()` + +**Returns:** +- `canRename` + - *boolean* - true if the player's pet can be renamed. + +**Usage:** +```lua +if (PetCanBeRenamed()) then + PetRename("Fuzzy Wuzzy"); +end +``` \ No newline at end of file diff --git a/wiki-information/functions/PetDefensiveMode.md b/wiki-information/functions/PetDefensiveMode.md new file mode 100644 index 00000000..f17d8f92 --- /dev/null +++ b/wiki-information/functions/PetDefensiveMode.md @@ -0,0 +1,17 @@ +## Title: PetDefensiveMode + +**Content:** +Set your pet in defensive mode. +`PetDefensiveMode()` + +**Example Usage:** +```lua +-- Set the player's pet to defensive mode +PetDefensiveMode() +``` + +**Description:** +The `PetDefensiveMode` function is used to set the player's pet into defensive mode. In this mode, the pet will automatically attack any enemy that attacks the player or the pet itself. This is useful for ensuring that the pet actively participates in combat without requiring manual commands for each enemy. + +**Common Addons Using This Function:** +Many pet management addons, such as PetTracker and Z-Perl UnitFrames, utilize this function to provide enhanced control over pet behavior, allowing players to easily switch their pet's stance based on the situation. \ No newline at end of file diff --git a/wiki-information/functions/PetFollow.md b/wiki-information/functions/PetFollow.md new file mode 100644 index 00000000..82eb7142 --- /dev/null +++ b/wiki-information/functions/PetFollow.md @@ -0,0 +1,11 @@ +## Title: PetFollow + +**Content:** +Instruct your pet to follow you. +`PetFollow()` + +**Example Usage:** +This function can be used in macros or scripts to command your pet to follow you, which is particularly useful in combat situations where you need to reposition your pet quickly. + +**Addons:** +Many pet management addons, such as PetTracker, use this function to provide enhanced control over pet behavior, ensuring that pets follow the player when needed. \ No newline at end of file diff --git a/wiki-information/functions/PetPassiveMode.md b/wiki-information/functions/PetPassiveMode.md new file mode 100644 index 00000000..46a578d7 --- /dev/null +++ b/wiki-information/functions/PetPassiveMode.md @@ -0,0 +1,11 @@ +## Title: PetPassiveMode + +**Content:** +Set your pet into passive mode. +`PetPassiveMode()` + +**Example Usage:** +This function can be used in macros or scripts to ensure that your pet does not attack any targets unless explicitly commanded. For example, in a macro, you might use it to prevent your pet from attacking while you are setting up a strategy or positioning yourself in a PvP scenario. + +**Addons:** +Many pet management addons, such as PetTracker, might use this function to provide better control over pet behavior, ensuring that pets do not engage in combat when not desired. \ No newline at end of file diff --git a/wiki-information/functions/PetRename.md b/wiki-information/functions/PetRename.md new file mode 100644 index 00000000..87689324 --- /dev/null +++ b/wiki-information/functions/PetRename.md @@ -0,0 +1,13 @@ +## Title: PetRename + +**Content:** +Renames your pet. +`PetRename(name)` + +**Parameters:** +- `name` + - *string* - The new name of the pet + +**Description:** +Only hunters and frost mages can rename their pets. +Each pet can be renamed once. Using this function when the pet has already been renamed results in an error message. \ No newline at end of file diff --git a/wiki-information/functions/PetStopAttack.md b/wiki-information/functions/PetStopAttack.md new file mode 100644 index 00000000..8313bb40 --- /dev/null +++ b/wiki-information/functions/PetStopAttack.md @@ -0,0 +1,11 @@ +## Title: PetStopAttack + +**Content:** +Stops the pet from attacking. +`PetStopAttack()` + +**Description:** +This function is not called by FrameXML, and is only effective if called by addons while not in combat. + +**Reference:** +[PetAttack](#petattack) \ No newline at end of file diff --git a/wiki-information/functions/PetWait.md b/wiki-information/functions/PetWait.md new file mode 100644 index 00000000..04405c99 --- /dev/null +++ b/wiki-information/functions/PetWait.md @@ -0,0 +1,14 @@ +## Title: PetWait + +**Content:** +Instruct your pet to remain still. +`PetWait()` + +**Example Usage:** +The `PetWait` function can be used in macros or scripts to control your pet's behavior, particularly useful for hunters and warlocks who rely on their pets for combat and utility. + +**Example Macro:** +```lua +/cast [@pet,exists] PetWait +``` +This macro will instruct your pet to stay in its current position if it exists. \ No newline at end of file diff --git a/wiki-information/functions/PickupAction.md b/wiki-information/functions/PickupAction.md new file mode 100644 index 00000000..7da19755 --- /dev/null +++ b/wiki-information/functions/PickupAction.md @@ -0,0 +1,16 @@ +## Title: PickupAction + +**Content:** +Places an action onto the cursor. +`PickupAction(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - The action slot to pick the action up from. + +**Returns:** +- `nil` + +**Description:** +If the slot is empty, nothing happens, otherwise the action from the slot is placed on the cursor, and the slot is filled with whatever action was currently being drag-and-dropped (The slot is emptied if the cursor was empty). +If you wish to empty the cursor without putting the item into another slot, try `ClearCursor`. \ No newline at end of file diff --git a/wiki-information/functions/PickupBagFromSlot.md b/wiki-information/functions/PickupBagFromSlot.md new file mode 100644 index 00000000..01229596 --- /dev/null +++ b/wiki-information/functions/PickupBagFromSlot.md @@ -0,0 +1,13 @@ +## Title: PickupBagFromSlot + +**Content:** +Picks up the bag from the specified slot, placing it in the cursor. +`PickupBagFromSlot(slot)` + +**Parameters:** +- `slot` + - *InventorySlotID* - the slot containing the bag. + +**Description:** +Valid slot numbers are 20-23, numbered from left to right starting after the backpack. +`inventoryID`, the result of `ContainerIDtoInventoryID(BagID)`, can help to compute the slot number and bag numbers can be viewed in the InventorySlotID page. \ No newline at end of file diff --git a/wiki-information/functions/PickupCompanion.md b/wiki-information/functions/PickupCompanion.md new file mode 100644 index 00000000..ae0e8823 --- /dev/null +++ b/wiki-information/functions/PickupCompanion.md @@ -0,0 +1,19 @@ +## Title: PickupCompanion + +**Content:** +Places a mount onto the cursor. +`PickupCompanion(type, index)` + +**Parameters:** +- `type` + - *string* - companion type, either "MOUNT" or "CRITTER". +- `index` + - *number* - index of the companion of the specified type to place on the cursor, ascending from 1. + +**Description:** +You should only use this function to pick up mounts; for critters, this function has been superseded by `C_PetJournal.PickupPet`, and instead places an unusable spell on the cursor. + +**Reference:** +- `GetCursorInfo` +- `GetCompanionInfo` +- `C_PetJournal.PickupPet` \ No newline at end of file diff --git a/wiki-information/functions/PickupContainerItem.md b/wiki-information/functions/PickupContainerItem.md new file mode 100644 index 00000000..1e785106 --- /dev/null +++ b/wiki-information/functions/PickupContainerItem.md @@ -0,0 +1,67 @@ +## Title: PickupContainerItem + +**Content:** +Wildcard function usually called when a player left clicks on a slot in their bags. Functionality includes picking up the item from a specific bag slot, putting the item into a specific bag slot, and applying enchants (including poisons and sharpening stones) to the item in a specific bag slot, except if one of the Modifier Keys is pressed. +`PickupContainerItem(bagID, slot)` + +**Parameters:** +- `bagID` + - *number* - id of the bag the slot is located in. +- `slot` + - *number* - slot inside the bag (top left slot is 1, slot to the right of it is 2). + +**Description:** +The function behaves differently depending on what is currently on the cursor: +- If the cursor currently has nothing, calling this will pick up an item from your backpack. +- If the cursor currently contains an item (check with `CursorHasItem()`), calling this will place the item currently on the cursor into the specified bag slot. If there is already an item in that bag slot, the two items will be exchanged. +- If the cursor is set to a spell (typically enchanting and poisons, check with `SpellIsTargeting()`), calling this specifies that you want to cast the spell on the item in that bag slot. + +Trying to pickup the same item twice in the same "time tick" does not work (client seems to flag the item as "locked" and waits for the server to sync). This is only a problem if you might move a single item multiple times (i.e., if you are changing your character's equipped armor, you are not likely to move a single piece of armor more than once). If you might move an object multiple times in rapid succession, you can check the item's 'locked' flag by calling `GetContainerItemInfo`. If you want to do this, you should leverage `OnUpdate` to help you. Avoid constantly checking the lock status inside a tight loop. If you do, you risk getting into a race condition. Once the repeat loop starts running, the client will not get any communication from the server until it finishes. However, it will not finish until the server tells it that the item is unlocked. Here is some sample code that illustrates the problem. + +```lua +function DangerousSwapItems(bag1, slot1, bag2, slot2) + ClearCursor() + repeat + local _, _, locked1 = GetContainerItemInfo(bag1, slot1) + local _, _, locked2 = GetContainerItemInfo(bag2, slot2) + --[[ DANGER! At this point, locked1 and locked2 will not change. They will not change + until the server tells us that the items in question have become unlocked, and that + will not happen until we finish this call stack (i.e. return from this function, + then his caller, then his caller, all the way up our lua code). ]] + until not (locked1 or locked2) + PickupContainerItem(bag1, slot1) + PickupContainerItem(bag2, slot2) +end + +DangerousSwapItems(1, 1, 1, 2) +DangerousSwapItems(1, 2, 1, 3) --DANGER! Item in (1, 2) is likely still locked, and this function will never return! +``` + +A potentially better way to do this is to use coroutines: + +```lua +function SaferSwapItems(bag1, slot1, bag2, slot2) + ClearCursor() + repeat + local _, _, locked1 = GetContainerItemInfo(bag1, slot1) + local _, _, locked2 = GetContainerItemInfo(bag2, slot2) + if locked1 or locked2 then + coroutine.yield() + end + until not (locked1 or locked2) + PickupContainerItem(bag1, slot1) + PickupContainerItem(bag2, slot2) +end + +co = coroutine.create(SaferSwapItems) + +function OnUpdate() + coroutine.resume(co) -- We should actually look at the return value from resume, because + -- it will be false when the coroutine is actually finished +end +``` + +You can also use the event `ITEM_LOCK_CHANGED` instead of `OnUpdate`. + +**Reference:** +- `GetContainerItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/PickupCurrency.md b/wiki-information/functions/PickupCurrency.md new file mode 100644 index 00000000..20e2a54b --- /dev/null +++ b/wiki-information/functions/PickupCurrency.md @@ -0,0 +1,9 @@ +## Title: PickupCurrency + +**Content:** +Picks up a currency to the cursor. +`PickupCurrency(type)` + +**Parameters:** +- `type` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/PickupInventoryItem.md b/wiki-information/functions/PickupInventoryItem.md new file mode 100644 index 00000000..18f399d2 --- /dev/null +++ b/wiki-information/functions/PickupInventoryItem.md @@ -0,0 +1,22 @@ +## Title: PickupInventoryItem + +**Content:** +Picks up / interacts with an equipment slot. +`PickupInventoryItem(slotId)` + +**Parameters:** +- `slotId` + - *number* : InventorySlotId + +**Description:** +If the cursor is empty, then it will attempt to pick up the item in the `slotId`. +If the cursor has an item, then it will attempt to equip the item to the `slotId` and place the previous `slotId` item (if any) where the item on cursor originated. +If the cursor is in repair or spell-casting mode, it will attempt the action on the `slotId`. +You can use `GetInventorySlotInfo` to get the `slotId`: + +**Usage:** +```lua +/script PickupInventoryItem(GetInventorySlotInfo("MainHandSlot")) +/script PickupInventoryItem(GetInventorySlotInfo("SecondaryHandSlot")) +``` +The above attempts a main hand/off-hand weapon swap. It will pick up the weapon from the main hand and then pick up the weapon from the off-hand, attempting to equip the main hand weapon to off-hand and sending the off-hand to main hand if possible. \ No newline at end of file diff --git a/wiki-information/functions/PickupItem.md b/wiki-information/functions/PickupItem.md new file mode 100644 index 00000000..92c9bddb --- /dev/null +++ b/wiki-information/functions/PickupItem.md @@ -0,0 +1,32 @@ +## Title: PickupItem + +**Content:** +Place the item on the cursor. +`PickupItem(itemID or itemString or itemName or itemLink)` + +**Parameters:** +- `(itemId or "itemString" or "itemName" or "itemLink")` + - `itemId` + - *number* - The numeric ID of the item. i.e., 12345 + - `itemString` + - *string* - The full item ID in string format, e.g., `"item:12345:0:0:0:0:0:0:0"`. Also supports partial itemStrings, by filling up any missing `:x` value with `:0`, e.g., `"item:12345:0:0:0"` + - `itemName` + - *string* - The Name of the Item, e.g., `"Hearthstone"`. The item must have been equipped, in your bags, or in your bank once in this session for this to work. + - `itemLink` + - *string* - The itemLink, when Shift-Clicking items. + +**Usage:** +```lua +PickupItem(6948) +PickupItem("item:6948") +PickupItem("Hearthstone") +PickupItem(GetContainerItemLink(0, 1)) +``` +Common usage: +```lua +PickupItem(link) +``` + +**Miscellaneous:** +Result: +Picks up the Hearthstone. The 4th example picks up the item in backpack slot 1. \ No newline at end of file diff --git a/wiki-information/functions/PickupMacro.md b/wiki-information/functions/PickupMacro.md new file mode 100644 index 00000000..e2aa8a6c --- /dev/null +++ b/wiki-information/functions/PickupMacro.md @@ -0,0 +1,21 @@ +## Title: PickupMacro + +**Content:** +Places a macro onto the cursor. +`PickupMacro(index or name)` + +**Parameters:** +- `index` + - *number* - The position of the macro in the macro window, from left to right and top to bottom. Slots 1-120 are used for general macros, and 121-138 for character-specific macros. +- `name` + - *string* - The name of the macro, case insensitive. + +**Usage:** +- Picks up the first character macro. + ```lua + PickupMacro(121) + ``` +- The macro named "Reload" is placed on the cursor. If there is no such named macro then nothing happens. + ```lua + PickupMacro("Reload") + ``` \ No newline at end of file diff --git a/wiki-information/functions/PickupMerchantItem.md b/wiki-information/functions/PickupMerchantItem.md new file mode 100644 index 00000000..a6dc2455 --- /dev/null +++ b/wiki-information/functions/PickupMerchantItem.md @@ -0,0 +1,17 @@ +## Title: PickupMerchantItem + +**Content:** +Places a merchant item onto the cursor. If the cursor already has an item, it will be sold. +`PickupMerchantItem(index)` + +Interesting thing is this function can be used to drop an item to the merchant as well. This will happen if the cursor already holds an item from the player's bag: +```lua +PickupContainerItem(bag, slot) +PickupMerchantItem(0) +``` + +As of patch 2.3, using this function to sell stacks of items does not work; instead, it fails silently. Selling unstacked items works, so unstacking and selling items one by one is an alternative. Blizzard is aware of this issue: [Blizzard Forum](http://forums.worldofwarcraft.com/thread.html?topicId=2855994059#12) + +**Parameters:** +- `index` + - *number* - The index of the item in the merchant's inventory. \ No newline at end of file diff --git a/wiki-information/functions/PickupPetAction.md b/wiki-information/functions/PickupPetAction.md new file mode 100644 index 00000000..530a7dc0 --- /dev/null +++ b/wiki-information/functions/PickupPetAction.md @@ -0,0 +1,12 @@ +## Title: PickupPetAction + +**Content:** +Places a pet action onto the cursor. +`PickupPetAction(petActionSlot)` + +**Parameters:** +- `petActionSlot` + - *number* - The pet action slot to pick the action up from (1-10). + +**Description:** +If the slot is empty, nothing happens, otherwise the action from the slot is placed on the cursor, and the slot is filled with whatever action was currently being drag-and-dropped (The slot is emptied if the cursor was empty). \ No newline at end of file diff --git a/wiki-information/functions/PickupPetSpell.md b/wiki-information/functions/PickupPetSpell.md new file mode 100644 index 00000000..f4229ad3 --- /dev/null +++ b/wiki-information/functions/PickupPetSpell.md @@ -0,0 +1,21 @@ +## Title: PickupPetSpell + +**Content:** +Picks up a Combat Pet spell. +`PickupPetSpell(spellID)` + +**Parameters:** +- `spellID` + - *number* - Used in PlayerTalentFrame + +**Usage:** +For Cunning combat pet: Boar's Speed +```lua +/run PickupPetSpell(19596) +``` + +**Description:** +The usage error mentions a nonexisting function `Usage: PickupPetActionByID(spellID)` + +**Reference:** +`PickupSpell` \ No newline at end of file diff --git a/wiki-information/functions/PickupPlayerMoney.md b/wiki-information/functions/PickupPlayerMoney.md new file mode 100644 index 00000000..4360a274 --- /dev/null +++ b/wiki-information/functions/PickupPlayerMoney.md @@ -0,0 +1,13 @@ +## Title: PickupPlayerMoney + +**Content:** +Picks up an amount of money from the player onto the cursor. +`PickupPlayerMoney(copper)` + +**Parameters:** +- `copper` + - *number* - The amount of money, in copper, to place on the cursor. + +**Reference:** +- `PickupTradeMoney` +- `AddTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/PickupSpell.md b/wiki-information/functions/PickupSpell.md new file mode 100644 index 00000000..ccb1df9d --- /dev/null +++ b/wiki-information/functions/PickupSpell.md @@ -0,0 +1,36 @@ +## Title: PickupSpell + +**Content:** +Places a spell onto the cursor. +`PickupSpell(spellID)` + +**Parameters:** +- `spellID` + - *number* - spell ID of the spell to pick up. + +**Description:** +This function will put a spell on the mouse cursor. + +**Reference:** +- `PickupAction` +- `PickupPetAction` +- `PickupBagFromSlot` +- `PickupContainerItem` +- `PickupInventoryItem` +- `PickupItem` +- `PickupMacro` +- `PickupMerchantItem` +- `PickupPlayerMoney` +- `PickupStablePet` +- `PickupTradeMoney` +- `ClearCursor` + +**Example Usage:** +```lua +-- Example of how to use PickupSpell +local spellID = 116 -- Frostbolt for Mages +PickupSpell(spellID) +``` + +**Common Addon Usage:** +Many addons that manage action bars or spell books, such as Bartender4 or Dominos, use `PickupSpell` to allow users to drag and drop spells onto their action bars. \ No newline at end of file diff --git a/wiki-information/functions/PickupSpellBookItem.md b/wiki-information/functions/PickupSpellBookItem.md new file mode 100644 index 00000000..0a174777 --- /dev/null +++ b/wiki-information/functions/PickupSpellBookItem.md @@ -0,0 +1,37 @@ +## Title: PickupSpellBookItem + +**Content:** +Picks up a skill from the spellbook so that it can subsequently be placed on an action bar. +```lua +PickupSpellBookItem(spell) +PickupSpellBookItem(index, bookType) +``` + +**Parameters:** +- `spell` + - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. +- **Spellbook args** + - `index` + - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. + - `bookType` + - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. + - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". + - **Constant Values:** + - `BOOKTYPE_SPELL` + - "spell" - The General, Class, Specs, and Professions tabs + - `BOOKTYPE_PET` + - "pet" - The Pet tab + +**Usage:** +The following sequence of macro commands places the Cat Form ability into the current action bar's first slot. +```lua +/run PickupSpellBookItem("Cat Form") +/click ActionButton1 +/run ClearCursor() +``` + +**Example Use Case:** +This function is particularly useful for creating macros that automate the placement of spells and abilities on action bars. For instance, a player might use this function to quickly set up their action bars after resetting their UI or switching specializations. + +**Addons:** +Many popular addons, such as Bartender4 and Dominos, use this function to allow players to customize their action bars by dragging and dropping spells from the spellbook. These addons enhance the default UI by providing more flexible and user-friendly ways to manage action bars. \ No newline at end of file diff --git a/wiki-information/functions/PickupStablePet.md b/wiki-information/functions/PickupStablePet.md new file mode 100644 index 00000000..9e9a694d --- /dev/null +++ b/wiki-information/functions/PickupStablePet.md @@ -0,0 +1,9 @@ +## Title: PickupStablePet + +**Content:** +Attaches a pet in your stable to your cursor. +`PickupStablePet(index)` + +**Parameters:** +- `index` + - *number* - 1 for the pet in the slot on the left, and 2 for the pet in the slot on the right. \ No newline at end of file diff --git a/wiki-information/functions/PickupTradeMoney.md b/wiki-information/functions/PickupTradeMoney.md new file mode 100644 index 00000000..b535702e --- /dev/null +++ b/wiki-information/functions/PickupTradeMoney.md @@ -0,0 +1,14 @@ +## Title: PickupTradeMoney + +**Content:** +Places an amount of money from the player's trade offer onto the cursor. +`PickupTradeMoney(copper)` + +**Parameters:** +- `copper` + - *number* - amount of money, in copper, to pick up. + +**Reference:** +- `PickupPlayerMoney` +- `AddTradeMoney` +- `SetTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/PlaceAction.md b/wiki-information/functions/PlaceAction.md new file mode 100644 index 00000000..61e8f764 --- /dev/null +++ b/wiki-information/functions/PlaceAction.md @@ -0,0 +1,16 @@ +## Title: PlaceAction + +**Content:** +Places an action onto into the specified action slot. +`PlaceAction(actionSlot)` + +**Parameters:** +- `actionSlot` + - *number* - The action slot to place the action into. + +**Description:** +If the cursor is empty, nothing happens, otherwise the action from the cursor is placed in the slot. If the slot was empty then the cursor becomes empty, otherwise the action from the slot is picked up and placed onto the cursor. +If an action is placed on the cursor use `API_PutItemInBackpack` to remove the action from the cursor without placing it in an action slot. + +**Important:** +You can crash your client if you send an invalid slot number. \ No newline at end of file diff --git a/wiki-information/functions/PlayMusic.md b/wiki-information/functions/PlayMusic.md new file mode 100644 index 00000000..ec7fb8ec --- /dev/null +++ b/wiki-information/functions/PlayMusic.md @@ -0,0 +1,28 @@ +## Title: PlayMusic + +**Content:** +Plays the specified sound file on loop to the "Music" sound channel. +`willPlay = PlayMusic(sound)` + +**Parameters:** +- `sound` + - *number|string* - FileDataID of a game sound or file path to an addon sound. + +**Returns:** +- `willPlay` + - *boolean* - Seems to always return true even for invalid file paths or FileDataIDs. + +**Usage:** +Plays Stormstout Brew from the Mists of Pandaria Soundtrack +```lua +-- by file path (dropped in 8.2.0) +PlayMusic("sound/music/pandaria/mus_50_toast_b_03.mp3") +-- by FileDataID 642878 (added support in 8.2.0) +PlayMusic(642878) +``` + +**Description:** +If any of the built-in music is playing when you call this function (e.g. Stormwind background music), it will fade out. +The playback loops until it is stopped with `StopMusic()`, when the user interface is reloaded, or upon logout. Playing a different sound file will also cause the current song to stop playing. It cannot be paused. +OggVorbis (.ogg) files are supported since World of Warcraft uses the FMOD sound engine. +You can find a full list here: [WoW Tools - Sound/Music](https://wow.tools/files/#search=sound/music) \ No newline at end of file diff --git a/wiki-information/functions/PlaySound.md b/wiki-information/functions/PlaySound.md new file mode 100644 index 00000000..126f14b4 --- /dev/null +++ b/wiki-information/functions/PlaySound.md @@ -0,0 +1,76 @@ +## Title: PlaySound + +**Content:** +Plays the specified sound by SoundKitID. +`willPlay, soundHandle = PlaySound(soundKitID)` + +**Parameters:** +- `soundKitID` + - *number* - Sound Kit ID in SoundKitEntry.db2. Sounds used in FrameXML are defined in the SOUNDKIT table. +- `channel` + - *string? = SFX* - The sound channel. + - **Channel** + - **Toggle CVar** + - **Volume CVar** + - **Master** + - `Sound_EnableAllSound` - Default: 1 + - `Sound_MasterVolume` - Default: 1.0 (master volume, 0.0 to 1.0) + - **Music** + - `Sound_EnableMusic` - Default: 1 (Enables music) + - `Sound_MusicVolume` - Default: 0.4 + - **SFX (Effects)** + - `Sound_EnableSFX` - Default: 1 + - `Sound_SFXVolume` - Default: 1.0 (sound volume, 0.0 to 1.0) + - **Ambience** + - `Sound_EnableAmbience` - Default: 1 (Enable Ambience) + - `Sound_AmbienceVolume` - Default: 0.6 + - **Dialog** + - `Sound_EnableDialog` - Default: 1 (all dialog) + - `Sound_DialogVolume` - Default: 1.0 (Dialog Volume, 0.0 to 1.0) + - **Talking Head** + - Volume sliders in the interface options +- `forceNoDuplicates` + - *boolean? = true* - Allows duplicate sounds if false. +- `runFinishCallback` + - *boolean? = false* - Fires SOUNDKIT_FINISHED when the sound has finished playing, arg1 will be soundHandle. + +**Returns:** +- `willPlay` + - *boolean* - true if the sound will be played, nil otherwise (prevented by a muted sound channel, for instance). +- `soundHandle` + - *number* - identifier for the queued playback. + +**Usage:** +Plays the ready check sound file (sound/interface/levelup2.ogg) +```lua +PlaySound(SOUNDKIT.READY_CHECK) -- by SOUNDKIT key +PlaySound(8960) -- by SoundKitID +PlaySoundFile(567478) -- by FileDataID +``` + +**Description:** +Sound Kit IDs are used to play a set of random sounds. For example, the human female NPC greeting sound kit refers to 5 different sounds. +```lua +/run PlaySound(5980) -- will play one of these sounds +/run PlaySoundFile(552133) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting01.ogg +/run PlaySoundFile(552141) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting02.ogg +/run PlaySoundFile(552137) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting03.ogg +/run PlaySoundFile(552142) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting04.ogg +/run PlaySoundFile(552144) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting05.ogg +``` + +**Miscellaneous:** +Finding Sound IDs: +- **File Data IDs** + - By file name/path, e.g. Spells/LevelUp, type:ogg in wow.tools + - By SoundKitID, e.g. skit:888 in wow.tools + - By sound kit name with [wow.tools](https://wow.tools/files/sounds.php) +- **Sound Kit Names/IDs** + - From the sounds tab for an NPC, for example [Waveblade Shaman](https://www.wowhead.com/npc=154304/waveblade-shaman#sounds) + - By sound kit name with [Wowhead Sounds](https://www.wowhead.com/sounds) and SoundKitName.db2 + - IDs used by the FrameXML are defined in the SOUNDKIT table + - The full list of IDs can be found in SoundKitEntry.db2 + +**Reference:** +- `PlaySoundFile` - Accepts FileDataIDs and addon file paths. +- `StopSound` \ No newline at end of file diff --git a/wiki-information/functions/PlaySoundFile.md b/wiki-information/functions/PlaySoundFile.md new file mode 100644 index 00000000..521715dd --- /dev/null +++ b/wiki-information/functions/PlaySoundFile.md @@ -0,0 +1,72 @@ +## Title: PlaySoundFile + +**Content:** +Plays the specified sound by FileDataID or addon file path. +`willPlay, soundHandle = PlaySoundFile(sound)` + +**Parameters:** +- `sound` + - *number|string* - Either a FileDataID, or the path to a sound file from an addon. + - The file must exist prior to logging in or reloading. Both .ogg and .mp3 formats are accepted. +- `channel` + - *string?* = SFX - The sound channel. + - **Channel** + - **Toggle CVar** + - **Volume CVar** + - **Master** + - `Sound_EnableAllSound` (Sound) Default: 1 + - `Sound_MasterVolume` (Sound) Default: 1.0 master volume (0.0 to 1.0) + - **Music** + - `Sound_EnableMusic` (Sound) Default: 1 Enables music + - `Sound_MusicVolume` Default: 0.4 + - **SFX (Effects)** + - `Sound_EnableSFX` (Sound) Default: 1 + - `Sound_SFXVolume` (Sound) Default: 1.0 sound volume (0.0 to 1.0) + - **Ambience** + - `Sound_EnableAmbience` (Sound) Default: 1 Enable Ambience + - `Sound_AmbienceVolume` Default: 0.6 + - **Dialog** + - `Sound_EnableDialog` (Sound) Default: 1 all dialog + - `Sound_DialogVolume` (Sound) Default: 1.0 Dialog Volume (0.0 to 1.0) + - **Talking Head** + - Volume sliders in the interface options + +**Returns:** +- `willPlay` + - *boolean* - true if the sound will be played, nil otherwise (prevented by a muted sound channel, for instance). +- `soundHandle` + - *number* - identifier for the queued playback. + +**Usage:** +- Plays a sound file included with your addon and ignores any sound setting except the master volume slider: + ```lua + -- Both slash / or escaped backslashes \\ can be used as file separators. + PlaySoundFile("Interface\\AddOns\\MyAddOn\\mysound.ogg", "Master") + ``` +- Plays the level up sound: + ```lua + -- by file path (dropped in 8.2.0) + PlaySoundFile("Sound/Spells/LevelUp.ogg") + -- by FileDataID 569593 (added support in 8.2.0) + PlaySoundFile(569593) + -- by SoundKitID 888 (SoundKitName LEVELUP) + PlaySound(888) + ``` + +**Miscellaneous:** +- **File Data IDs** + - By file name/path, e.g. `Spells/LevelUp,type:ogg` in wow.tools + - By SoundKitID, e.g. `skit:888` in wow.tools + - By sound kit name with [wow.tools](https://wow.tools/files/sounds.php) +- **Sound Kit Names/IDs** + - From the sounds tab for an NPC, for example [Waveblade Shaman](https://www.wowhead.com/npc=154304/waveblade-shaman#sounds) + - By sound kit name with [Wowhead Sounds](https://www.wowhead.com/sounds) and `SoundKitName.db2` + - IDs used by the FrameXML are defined in the `SOUNDKIT` table + - The full list of IDs can be found in `SoundKitEntry.db2` + +**Reference:** +- `PlaySound` - Plays a sound by SoundKitID +- `StopSound` +- `MuteSoundFile` - Mutes a sound +- `UnmuteSoundFile` +- `PlaySoundFile` macros - Listing of audio files shipped with the game \ No newline at end of file diff --git a/wiki-information/functions/PlayerCanTeleport.md b/wiki-information/functions/PlayerCanTeleport.md new file mode 100644 index 00000000..77741e41 --- /dev/null +++ b/wiki-information/functions/PlayerCanTeleport.md @@ -0,0 +1,9 @@ +## Title: PlayerCanTeleport + +**Content:** +Needs summary. +`canTeleport = PlayerCanTeleport()` + +**Returns:** +- `canTeleport` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/PlayerEffectiveAttackPower.md b/wiki-information/functions/PlayerEffectiveAttackPower.md new file mode 100644 index 00000000..ee50ad0c --- /dev/null +++ b/wiki-information/functions/PlayerEffectiveAttackPower.md @@ -0,0 +1,13 @@ +## Title: PlayerEffectiveAttackPower + +**Content:** +Needs summary. +`mainHandAttackPower, offHandAttackPower, rangedAttackPower = PlayerEffectiveAttackPower()` + +**Returns:** +- `mainHandAttackPower` + - *number* +- `offHandAttackPower` + - *number* +- `rangedAttackPower` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/PlayerHasToy.md b/wiki-information/functions/PlayerHasToy.md new file mode 100644 index 00000000..f27a4f9a --- /dev/null +++ b/wiki-information/functions/PlayerHasToy.md @@ -0,0 +1,26 @@ +## Title: PlayerHasToy + +**Content:** +Determines if player has a specific toy in their toybox. +`hasToy = PlayerHasToy(itemId)` + +**Parameters:** +- `itemId` + - *number* - itemId of a toy. + +**Returns:** +- `hasToy` + - *boolean* - True if player has itemId in their toybox, false if not. + +**Usage:** +```lua +if PlayerHasToy(92738) then + print('Remember to wear your Safari Hat!'); +end +``` + +**Example Use Case:** +This function can be used in addons or macros to check if a player has a specific toy before attempting to use it or reminding the player to use it. For instance, an addon could use this function to ensure that a player has a necessary toy for a particular event or activity. + +**Addons Using This Function:** +Many toy management addons, such as "ToyBoxEnhanced," use this function to manage and organize the player's toy collection, providing features like search, categorization, and usage tracking. \ No newline at end of file diff --git a/wiki-information/functions/PlayerIsPVPInactive.md b/wiki-information/functions/PlayerIsPVPInactive.md new file mode 100644 index 00000000..711afa15 --- /dev/null +++ b/wiki-information/functions/PlayerIsPVPInactive.md @@ -0,0 +1,19 @@ +## Title: PlayerIsPVPInactive + +**Content:** +Needs summary. +`result = PlayerIsPVPInactive(unit)` + +**Parameters:** +- `unit` + - *string* - UnitToken + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +This function can be used to determine if a player is currently inactive in PvP. For instance, it can be useful in addons that manage PvP status or track player activity in battlegrounds and arenas. + +**Addon Usage:** +Large addons like "Gladius" (an arena unit frame addon) might use this function to check if an opponent is inactive in PvP, allowing the addon to provide more accurate information about the status of enemy players. \ No newline at end of file diff --git a/wiki-information/functions/PostAuction.md b/wiki-information/functions/PostAuction.md new file mode 100644 index 00000000..3661af64 --- /dev/null +++ b/wiki-information/functions/PostAuction.md @@ -0,0 +1,26 @@ +## Title: PostAuction + +**Content:** +Starts the auction you have created in the Create Auction panel. +`PostAuction(minBid, buyoutPrice, runTime, stackSize, numStacks)` + +**Parameters:** +- `minBid` + - *number* - The minimum bid price for this auction in copper. +- `buyoutPrice` + - *number* - The buyout price for this auction in copper. +- `runTime` + - *number* - The duration for which the auction should be posted. See details for more information. +- `stackSize` + - *number* - The size of each stack to be posted. +- `numStacks` + - *number* - The number of stacks to post. + +**Description:** +Values that may be supplied for the `runTime` parameter can be found in the table below. + +| Value | Duration | +|-------|-----------| +| 1 | 2 hours | +| 2 | 8 hours | +| 3 | 24 hours | \ No newline at end of file diff --git a/wiki-information/functions/PreloadMovie.md b/wiki-information/functions/PreloadMovie.md new file mode 100644 index 00000000..99660c4f --- /dev/null +++ b/wiki-information/functions/PreloadMovie.md @@ -0,0 +1,9 @@ +## Title: PreloadMovie + +**Content:** +Needs summary. +`PreloadMovie(movieId)` + +**Parameters:** +- `movieId` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/ProcessExceptionClient.md b/wiki-information/functions/ProcessExceptionClient.md new file mode 100644 index 00000000..bf965be9 --- /dev/null +++ b/wiki-information/functions/ProcessExceptionClient.md @@ -0,0 +1,13 @@ +## Title: ProcessExceptionClient + +**Content:** +Generates textual error logs for any current Lua error. +`ProcessExceptionClient(description)` + +**Parameters:** +- `description` + - *string* - The description of the error being processed. + +**Description:** +This function is invoked by the default global error handler to trigger the generation of textual error logs when a Lua error occurs in a secure execution path. +The `luaErrorExceptions` console variable must be enabled for this function to have any effect. \ No newline at end of file diff --git a/wiki-information/functions/PromoteToLeader.md b/wiki-information/functions/PromoteToLeader.md new file mode 100644 index 00000000..8b0edb51 --- /dev/null +++ b/wiki-information/functions/PromoteToLeader.md @@ -0,0 +1,24 @@ +## Title: PromoteToLeader + +**Content:** +Promotes a unit to group leader. +`PromoteToLeader(unitId or playerName)` + +**Parameters:** +- `unitId` + - *UnitId* - The unit to promote. +- `playername` + - *PlayerName* - The full name of the player to promote. + +**Usage:** +If you have a character named "Character", to promote him to leader you can type in-game: +```lua +/script PromoteToLeader("Character"); +``` + +**Example Use Case:** +This function is particularly useful in raid or party management addons where leadership roles need to be dynamically assigned based on certain conditions or user inputs. For instance, an addon that automates raid management might use this function to promote a designated raid leader when the raid is formed. + +**Addons Using This Function:** +- **ElvUI**: A comprehensive UI replacement addon that includes raid management features. It might use `PromoteToLeader` to facilitate quick leadership changes during raids. +- **DBM (Deadly Boss Mods)**: A popular addon for raid encounters that could use this function to promote a player to leader for better coordination during boss fights. \ No newline at end of file diff --git a/wiki-information/functions/PutItemInBackpack.md b/wiki-information/functions/PutItemInBackpack.md new file mode 100644 index 00000000..7f9e7abf --- /dev/null +++ b/wiki-information/functions/PutItemInBackpack.md @@ -0,0 +1,14 @@ +## Title: PutItemInBackpack + +**Content:** +Places the item on the cursor into the player's backpack. +`PutItemInBackpack()` + +**Description:** +If there is already a partial stack of the item in the backpack, it will attempt to stack them together. + +**Example Usage:** +This function can be used in macros or addons to automate the process of moving items from the cursor to the backpack. For instance, if a player is gathering items and wants to ensure they are always placed in the backpack, this function can be called after picking up each item. + +**Addon Usage:** +Many inventory management addons, such as Bagnon or ArkInventory, might use this function to streamline item organization and ensure that items are placed in the correct bags. \ No newline at end of file diff --git a/wiki-information/functions/PutItemInBag.md b/wiki-information/functions/PutItemInBag.md new file mode 100644 index 00000000..ced98d10 --- /dev/null +++ b/wiki-information/functions/PutItemInBag.md @@ -0,0 +1,22 @@ +## Title: PutItemInBag + +**Content:** +Places the item on the cursor into the specified bag. +`hadItem = PutItemInBag(inventoryID)` + +**Parameters:** +- `inventoryID` + - *number?* : InventorySlotId - Values from `CONTAINER_BAG_OFFSET + 1` to `CONTAINER_BAG_OFFSET + NUM_TOTAL_EQUIPPED_BAG_SLOTS` correspond to the player's bag slots, right-to-left from the first bag after the backpack. + +**Returns:** +- `hadItem` + - *boolean?* - True if the cursor had an item. + +**Description:** +Puts the item on the cursor into the specified bag on the main bar, if it's a bag. Otherwise, attempts to place the item inside the bag in that slot. Note that to place an item in the backpack, you must use `PutItemInBackpack`. + +**Usage:** +The following puts the item on the cursor (if it's not a bag) into the first bag (not including the backpack) starting from the right. +```lua +PutItemInBag(CONTAINER_BAG_OFFSET + 1) +``` \ No newline at end of file diff --git a/wiki-information/functions/QueryAuctionItems.md b/wiki-information/functions/QueryAuctionItems.md new file mode 100644 index 00000000..bddd1cd9 --- /dev/null +++ b/wiki-information/functions/QueryAuctionItems.md @@ -0,0 +1,52 @@ +## Title: QueryAuctionItems + +**Content:** +Queries the server for information about current auctions, only when `CanSendAuctionQuery()` is true. +`QueryAuctionItems(text, minLevel, maxLevel, page, usable, rarity, getAll, exactMatch, filterData)` + +**Parameters:** +- `text` + - *string* - A part of the item's name, or an empty string; limited to 63 bytes. +- `minLevel` + - *number?* - Minimum usable level requirement for items +- `maxLevel` + - *number?* - Maximum usable level requirement for items +- `page` + - *number* - What page in the auction house this shows up. Note that pages start at 0. +- `usable` + - *boolean* - Restricts items to those usable by the current character. +- `rarity` + - *Enum.ItemQuality?* - Restricts the quality of the items found. +- `getAll` + - *boolean* - Download the entire auction house as one single page; see other details below. +- `exactMatch` + - *boolean* - Will only items whose whole name is the same as searchString be found. +- `filterData` + - *table?* + - `Field` + - `Type` + - `Description` + - `classID` + - *number* - ItemType + - `subClassID` + - *number?* - Depends on the ItemType + - `inventoryType` + - *Enum.InventoryType?* + +**Description:** +Queries appear to be throttled at 0.3 seconds normally, or 15 minutes with getAll mode. The return values from `CanSendAuctionQuery()` indicate when each mode is permitted. +getAll mode might disconnect players with low bandwidth. Also see relevant details on client-to-server traffic in `GetAuctionItemInfo()`. +text longer than 63 bytes might disconnect the player. +If any of the entered arguments is of the wrong type, the search assumes a nil value. +No effect if the auction house window is not open. +In 4.0.1, getAll mode only fetches up to 42554 items. This is usually adequate, but high-population realms might have more. + +**Usage:** +Searches for rare items between levels 10 and 19: +```lua +QueryAuctionItems("", 10, 19, 0, nil, nil, false, false, nil) +``` +Searches for anything with the word "Nobles" in it, such as the Darkmoon card deck: +```lua +/script QueryAuctionItems("Nobles", nil, nil, 0, false, nil, false, false, nil) +``` \ No newline at end of file diff --git a/wiki-information/functions/QuestChooseRewardError.md b/wiki-information/functions/QuestChooseRewardError.md new file mode 100644 index 00000000..df3ef8c4 --- /dev/null +++ b/wiki-information/functions/QuestChooseRewardError.md @@ -0,0 +1,8 @@ +## Title: QuestChooseRewardError + +**Content:** +Throws an error when the quest reward method doesn't work. +`QuestChooseRewardError()` + +**Description:** +Fires a `UI_ERROR_MESSAGE ERR_QUEST_MUST_CHOOSE` error. \ No newline at end of file diff --git a/wiki-information/functions/QuestIsDaily.md b/wiki-information/functions/QuestIsDaily.md new file mode 100644 index 00000000..f80b3746 --- /dev/null +++ b/wiki-information/functions/QuestIsDaily.md @@ -0,0 +1,18 @@ +## Title: QuestIsDaily + +**Content:** +Returns true if the offered quest is a daily quest. +`isDaily = QuestIsDaily()` + +**Returns:** +- `isDaily` + - *boolean* - 1 if the offered quest is a daily, nil otherwise + +**Reference:** +- `QuestIsWeekly` + +**Example Usage:** +This function can be used to determine if a quest is a daily quest, which can be useful for addons that track daily quest completion or manage daily quest logs. + +**Addon Usage:** +Many quest tracking addons, such as "Questie" or "World Quest Tracker," may use this function to filter and display daily quests separately from other types of quests. \ No newline at end of file diff --git a/wiki-information/functions/QuestLogPushQuest.md b/wiki-information/functions/QuestLogPushQuest.md new file mode 100644 index 00000000..06b47efc --- /dev/null +++ b/wiki-information/functions/QuestLogPushQuest.md @@ -0,0 +1,42 @@ +## Title: QuestLogPushQuest + +**Content:** +Shares the current quest in the quest log with other players. +`QuestLogPushQuest()` + +**Usage:** +```lua +local i = 0; +while (GetQuestLogTitle(i+1) ~= nil) do + i = i + 1; + local title, level, tag, header = GetQuestLogTitle(i); + if (not header) then + SelectQuestLogEntry(i); + if (GetQuestLogPushable()) then + QuestLogPushQuest(); + DEFAULT_CHAT_FRAME:AddMessage(string.format("Attempting to share %s with your group...", title, level)); + return; + end + end +end +local i = 0; +while (GetQuestLogTitle(i+1) ~= nil) do + i = i + 1; + local title, level, tag, header = GetQuestLogTitle(i); + if (not header) then + SelectQuestLogEntry(i); + if (GetQuestLogPushable()) then + QuestLogPushQuest(); + DEFAULT_CHAT_FRAME:AddMessage(string.format("Attempting to share %s with your group...", title, level)); + return; + end + end +end +``` + +**Miscellaneous:** +Result: +Finds and shares the first sharable quest in your quest log. + +**Description:** +The system only attempts to push the quest to grouped players and will fail if a recipient does not qualify for the quest (too low level or hasn't completed prior chain-quests), currently is on the quest or has already completed it. \ No newline at end of file diff --git a/wiki-information/functions/QuestPOIGetIconInfo.md b/wiki-information/functions/QuestPOIGetIconInfo.md new file mode 100644 index 00000000..33bd4ed9 --- /dev/null +++ b/wiki-information/functions/QuestPOIGetIconInfo.md @@ -0,0 +1,35 @@ +## Title: QuestPOIGetIconInfo + +**Content:** +Returns WorldMap POI icon information for the given quest. +`completed, posX, posY, objective = QuestPOIGetIconInfo(questId)` + +**Parameters:** +- `questId` + - *number* - you can get this from the quest link or from `GetQuestLogTitle(questLogIndex)`. + +**Returns:** +- `completed` + - *boolean* - is the quest completed (the icon is a question mark). +- `posX` + - *number* (between 0 and 1 inclusive) - the X position where the icon is shown on the map. +- `posY` + - *number* (between 0 and 1 inclusive) - the Y position where the icon is shown on the map. +- `objective` + - *number* - which is sometimes negative and doesn't appear to have anything to do with the quest's actual objectives. + +**Usage:** +```lua +local playerX, playerY = GetPlayerMapPosition("player") +local _, questX, questY = QuestPOIGetIconInfo(12345) +local diffX, diffY = abs(playerX - questX), abs(playerY - questY) +local distanceToTarget = math.sqrt(math.pow(diffX, 2) + math.pow(diffY, 2)) +print("You are ", floor(distanceToTarget * 100), " clicks from the target location.") +``` + +**Example Use Case:** +This function can be used to determine the distance between the player's current position and the quest objective on the map. This can be particularly useful for addons that provide navigation assistance or quest tracking features. + +**Addons Using This Function:** +- **TomTom**: A popular navigation addon that provides waypoints and directional arrows to guide players to their destinations. It uses functions like `QuestPOIGetIconInfo` to fetch quest objective locations and display them on the map. +- **QuestHelper**: An addon that helps players complete quests by showing the optimal path and locations of quest objectives. It utilizes this function to gather information about where to direct the player. \ No newline at end of file diff --git a/wiki-information/functions/Quit.md b/wiki-information/functions/Quit.md new file mode 100644 index 00000000..cdadd0b0 --- /dev/null +++ b/wiki-information/functions/Quit.md @@ -0,0 +1,12 @@ +## Title: Quit + +**Content:** +Quits the game. +`Quit()` + +**Reference:** +- `PLAYER_QUITING` + +**See also:** +- `Logout` +- `CancelLogout` \ No newline at end of file diff --git a/wiki-information/functions/RandomRoll.md b/wiki-information/functions/RandomRoll.md new file mode 100644 index 00000000..c83f9a6b --- /dev/null +++ b/wiki-information/functions/RandomRoll.md @@ -0,0 +1,21 @@ +## Title: RandomRoll + +**Content:** +Performs a random roll between two values. +`RandomRoll(low, high)` + +**Parameters:** +- `low` + - *number* - lowest number (default 1) +- `high` + - *number* - highest number (default 100) + +**Usage:** +```lua +RandomRoll(1, 10) +-- Yield: rolls. (1-10) +``` + +**Description:** +If only `low` is provided, it is taken as the highest number. +Does the same as `/random low high`. \ No newline at end of file diff --git a/wiki-information/functions/RejectProposal.md b/wiki-information/functions/RejectProposal.md new file mode 100644 index 00000000..80febb21 --- /dev/null +++ b/wiki-information/functions/RejectProposal.md @@ -0,0 +1,9 @@ +## Title: RejectProposal + +**Content:** +Declines a LFG invite and leaves the queue. +`RejectProposal()` + +**Reference:** +- `GetLFGProposal` +- `AcceptProposal` \ No newline at end of file diff --git a/wiki-information/functions/RemoveChatWindowChannel.md b/wiki-information/functions/RemoveChatWindowChannel.md new file mode 100644 index 00000000..b59a76ad --- /dev/null +++ b/wiki-information/functions/RemoveChatWindowChannel.md @@ -0,0 +1,20 @@ +## Title: RemoveChatWindowChannel + +**Content:** +Removes the specified chat channel from a chat window. +`RemoveChatWindowChannel(windowId, channelName)` + +**Parameters:** +- `windowId` + - *number* - index of the chat window/frame (ascending from 1) to remove the channel from. +- `channelName` + - *string* - name of the chat channel to remove from the frame. + +**Description:** +Chat output architecture has changed since release; calling this function alone is no longer sufficient to block a channel from a particular frame in the default UI. Use `ChatFrame_RemoveChannel(chatFrame, "channelName")` instead, like so: +```lua +ChatFrame_RemoveChannel(ChatWindow1, "Trade"); -- DEFAULT_CHAT_FRAME works well, too +``` + +**Reference:** +- `AddChatWindowChannel` \ No newline at end of file diff --git a/wiki-information/functions/RemoveChatWindowMessages.md b/wiki-information/functions/RemoveChatWindowMessages.md new file mode 100644 index 00000000..93873a47 --- /dev/null +++ b/wiki-information/functions/RemoveChatWindowMessages.md @@ -0,0 +1,15 @@ +## Title: RemoveChatWindowMessages + +**Content:** +Removes the specified chat message type from a chat window. +`RemoveChatWindowMessages(index, messageGroup)` + +**Parameters:** +- `index` + - *number* - chat window index, ascending from 1. +- `messageGroup` + - *string* - message type the chat window should no longer receive, e.g. "EMOTE", "SAY", "RAID". + +**Reference:** +- `AddChatWindowMessages` +- `GetChatWindowMessages` \ No newline at end of file diff --git a/wiki-information/functions/RemoveQuestWatch.md b/wiki-information/functions/RemoveQuestWatch.md new file mode 100644 index 00000000..26eb418d --- /dev/null +++ b/wiki-information/functions/RemoveQuestWatch.md @@ -0,0 +1,9 @@ +## Title: RemoveQuestWatch + +**Content:** +Removes a quest from being watched. +`RemoveQuestWatch(questIndex)` + +**Parameters:** +- `questIndex` + - *number* - The index of the quest in the quest log. \ No newline at end of file diff --git a/wiki-information/functions/RemoveTrackedAchievement.md b/wiki-information/functions/RemoveTrackedAchievement.md new file mode 100644 index 00000000..bcc96854 --- /dev/null +++ b/wiki-information/functions/RemoveTrackedAchievement.md @@ -0,0 +1,20 @@ +## Title: RemoveTrackedAchievement + +**Content:** +Untracks an achievement from the WatchFrame. +`RemoveTrackedAchievement(achievementId)` + +**Parameters:** +- `achievementID` + - *number* - ID of the achievement to add to tracking. + +**Reference:** +- `TRACKED_ACHIEVEMENT_UPDATE` +- See also: + - `AddTrackedAchievement` + - `GetTrackedAchievements` + - `GetNumTrackedAchievements` + +**Description:** +A maximum of `WATCHFRAME_MAXACHIEVEMENTS` (10 as of 5.4.8) tracked achievements can be displayed by the WatchFrame at a time. +You may need to manually update the AchievementUI and WatchFrame after calling this function. \ No newline at end of file diff --git a/wiki-information/functions/RenamePetition.md b/wiki-information/functions/RenamePetition.md new file mode 100644 index 00000000..b0fc69fd --- /dev/null +++ b/wiki-information/functions/RenamePetition.md @@ -0,0 +1,9 @@ +## Title: RenamePetition + +**Content:** +Renames the current petition. +`RenamePetition(name)` + +**Parameters:** +- `name` + - *string* - The new name of the group being created by the petition \ No newline at end of file diff --git a/wiki-information/functions/RepairAllItems.md b/wiki-information/functions/RepairAllItems.md new file mode 100644 index 00000000..9c71f787 --- /dev/null +++ b/wiki-information/functions/RepairAllItems.md @@ -0,0 +1,31 @@ +## Title: RepairAllItems + +**Content:** +Repairs all equipped and inventory items. +`RepairAllItems()` + +**Parameters:** +- `guildBankRepair` + - *boolean?* - true to use guild funds to repair, otherwise uses player funds. + +**Reference:** +- `CanGuildBankRepair` + +**Example Usage:** +```lua +-- Check if the player can use guild funds to repair +if CanGuildBankRepair() then + -- Repair using guild funds + RepairAllItems(true) +else + -- Repair using player funds + RepairAllItems(false) +end +``` + +**Description:** +The `RepairAllItems` function is used to repair all equipped and inventory items of the player. It can optionally use guild funds if the player has the necessary permissions. This function is commonly used in addons that manage inventory and equipment, ensuring that the player's gear is always in top condition. + +**Addons Using This Function:** +- **ElvUI**: A comprehensive UI replacement addon that includes an auto-repair feature, which can automatically repair items using either player or guild funds based on user settings. +- **AutoRepair**: A lightweight addon specifically designed to automatically repair items when visiting a vendor capable of repairs. It can be configured to use guild funds if available. \ No newline at end of file diff --git a/wiki-information/functions/ReplaceEnchant.md b/wiki-information/functions/ReplaceEnchant.md new file mode 100644 index 00000000..379a7cb8 --- /dev/null +++ b/wiki-information/functions/ReplaceEnchant.md @@ -0,0 +1,8 @@ +## Title: ReplaceEnchant + +**Content:** +Confirms the "Replace Enchant" dialog. +`ReplaceEnchant()` + +**Description:** +When the player attempts to apply an enchant or weapon buff to an item which already has one, the game presents the "Replace Enchant" dialog. This method confirms that dialog allowing the application of the enchant/buff to continue. \ No newline at end of file diff --git a/wiki-information/functions/ReplaceGuildMaster.md b/wiki-information/functions/ReplaceGuildMaster.md new file mode 100644 index 00000000..dbf76a87 --- /dev/null +++ b/wiki-information/functions/ReplaceGuildMaster.md @@ -0,0 +1,9 @@ +## Title: ReplaceGuildMaster + +**Content:** +Impeaches the current Guild Master. +`ReplaceGuildMaster()` + +**Reference:** +`CanReplaceGuildMaster` +New in 4.3: Inactive Guild Leader Replacement \ No newline at end of file diff --git a/wiki-information/functions/ReplaceTradeEnchant.md b/wiki-information/functions/ReplaceTradeEnchant.md new file mode 100644 index 00000000..f7f5870f --- /dev/null +++ b/wiki-information/functions/ReplaceTradeEnchant.md @@ -0,0 +1,11 @@ +## Title: ReplaceTradeEnchant + +**Content:** +Confirms that an enchant applied to the trade frame should replace an existing enchant. +`ReplaceTradeEnchant()` + +**Example Usage:** +This function can be used in scenarios where a player is trading an item that already has an enchantment, and the player wants to replace the existing enchantment with a new one. For instance, if a player is trading a weapon that has a lower-level enchantment and wants to apply a higher-level enchantment before completing the trade, this function would confirm the replacement. + +**Addons:** +While there are no specific large addons that are known to use this function directly, it could be utilized in custom trading or enchanting addons where managing enchantments during trades is necessary. \ No newline at end of file diff --git a/wiki-information/functions/RepopMe.md b/wiki-information/functions/RepopMe.md new file mode 100644 index 00000000..e6646f69 --- /dev/null +++ b/wiki-information/functions/RepopMe.md @@ -0,0 +1,8 @@ +## Title: RepopMe + +**Content:** +Releases your ghost to the graveyard when dead. +`RepopMe()` + +**Description:** +This is the "Release Spirit" button. \ No newline at end of file diff --git a/wiki-information/functions/ReportBug.md b/wiki-information/functions/ReportBug.md new file mode 100644 index 00000000..d501cd12 --- /dev/null +++ b/wiki-information/functions/ReportBug.md @@ -0,0 +1,9 @@ +## Title: ReportBug + +**Content:** +Needs summary. +`ReportBug(description)` + +**Parameters:** +- `description` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/ReportPlayerIsPVPAFK.md b/wiki-information/functions/ReportPlayerIsPVPAFK.md new file mode 100644 index 00000000..14037534 --- /dev/null +++ b/wiki-information/functions/ReportPlayerIsPVPAFK.md @@ -0,0 +1,9 @@ +## Title: ReportPlayerIsPVPAFK + +**Content:** +Needs summary. +`ReportPlayerIsPVPAFK(unit)` + +**Parameters:** +- `unit` + - *string* - UnitToken \ No newline at end of file diff --git a/wiki-information/functions/ReportSuggestion.md b/wiki-information/functions/ReportSuggestion.md new file mode 100644 index 00000000..65be19ad --- /dev/null +++ b/wiki-information/functions/ReportSuggestion.md @@ -0,0 +1,9 @@ +## Title: ReportSuggestion + +**Content:** +Needs summary. +`ReportSuggestion(description)` + +**Parameters:** +- `description` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/RequestBattlefieldScoreData.md b/wiki-information/functions/RequestBattlefieldScoreData.md new file mode 100644 index 00000000..1d250c41 --- /dev/null +++ b/wiki-information/functions/RequestBattlefieldScoreData.md @@ -0,0 +1,8 @@ +## Title: RequestBattlefieldScoreData + +**Content:** +Requests the latest battlefield score data from the server. +`RequestBattlefieldScoreData()` + +**Reference:** +`UPDATE_BATTLEFIELD_SCORE` fires when updated (altered) data is available. \ No newline at end of file diff --git a/wiki-information/functions/RequestBattlegroundInstanceInfo.md b/wiki-information/functions/RequestBattlegroundInstanceInfo.md new file mode 100644 index 00000000..b865a496 --- /dev/null +++ b/wiki-information/functions/RequestBattlegroundInstanceInfo.md @@ -0,0 +1,18 @@ +## Title: RequestBattlegroundInstanceInfo + +**Content:** +Requests the available instances of a battleground. +`RequestBattlegroundInstanceInfo(index)` + +**Parameters:** +- `index` + - *number* - Index of the battleground type to request instance information for; valid indices start from 1 and go up to `GetNumBattlegroundTypes()`. + +**Reference:** +- `PVPQUEUE_ANYWHERE_SHOW` is fired when the requested information becomes available. +- **See Also:** + - `GetNumBattlefields` + - `GetBattlefieldInfo` + +**Description:** +Calling `JoinBattlefield` after calling this function, but before `PVPQUEUE_ANYWHERE_SHOW`, will fail silently; you must wait for the instance list to become available before you can queue for an instance. \ No newline at end of file diff --git a/wiki-information/functions/RequestInspectHonorData.md b/wiki-information/functions/RequestInspectHonorData.md new file mode 100644 index 00000000..3ea10a90 --- /dev/null +++ b/wiki-information/functions/RequestInspectHonorData.md @@ -0,0 +1,18 @@ +## Title: RequestInspectHonorData + +**Content:** +Requests PvP participation information for the currently inspected target. +`RequestInspectHonorData()` + +**Reference:** +`INSPECT_HONOR_UPDATE` fires when the requested information is available. + +See also: +- `HasInspectHonorData` +- `GetInspectArenaData` + +**Example Usage:** +This function can be used in an addon to fetch and display the PvP participation details of another player when inspecting them. For instance, an addon could use this to show the honor points, battleground statistics, and other PvP-related data of the inspected player. + +**Addon Usage:** +Large addons like "Details! Damage Meter" or "ElvUI" might use this function to provide detailed PvP statistics and enhance the inspection features, allowing players to see comprehensive PvP data of others in their UI. \ No newline at end of file diff --git a/wiki-information/functions/RequestInviteFromUnit.md b/wiki-information/functions/RequestInviteFromUnit.md new file mode 100644 index 00000000..207f13dc --- /dev/null +++ b/wiki-information/functions/RequestInviteFromUnit.md @@ -0,0 +1,9 @@ +## Title: RequestInviteFromUnit + +**Content:** +Attempt to request an invite into the target party. +`RequestInviteFromUnit(targetName)` + +**Parameters:** +- `targetName` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/RequestRaidInfo.md b/wiki-information/functions/RequestRaidInfo.md new file mode 100644 index 00000000..d9128028 --- /dev/null +++ b/wiki-information/functions/RequestRaidInfo.md @@ -0,0 +1,15 @@ +## Title: RequestRaidInfo + +**Content:** +Requests which instances the player is saved to. +`RequestRaidInfo()` + +**Reference:** +- `UPDATE_INSTANCE_INFO` + - When your query has finished processing on the server and the raid info is available. + +**Example Usage:** +This function can be used in an addon to check which raid instances a player is currently saved to. For example, an addon could call `RequestRaidInfo()` and then listen for the `UPDATE_INSTANCE_INFO` event to update a UI element displaying the player's raid lockouts. + +**Addon Usage:** +Many raid management addons, such as "SavedInstances," use this function to track and display the raid lockout status of all characters on an account. This helps players manage their raid schedules and avoid missing out on loot opportunities. \ No newline at end of file diff --git a/wiki-information/functions/RequestRatedInfo.md b/wiki-information/functions/RequestRatedInfo.md new file mode 100644 index 00000000..54021732 --- /dev/null +++ b/wiki-information/functions/RequestRatedInfo.md @@ -0,0 +1,9 @@ +## Title: RequestRatedInfo + +**Content:** +Requests information about the player's rated PvP stats from the server. +`RequestRatedInfo()` + +**Description:** +Triggers `PVP_RATED_STATS_UPDATE` when the client receives a reply from the server. +FrameXML (counterintuitively) uses the event to update player's PvP currencies and random/holiday battleground rewards. \ No newline at end of file diff --git a/wiki-information/functions/RequestTimePlayed.md b/wiki-information/functions/RequestTimePlayed.md new file mode 100644 index 00000000..a2818262 --- /dev/null +++ b/wiki-information/functions/RequestTimePlayed.md @@ -0,0 +1,8 @@ +## Title: RequestTimePlayed + +**Content:** +Requests a summary of time played. +`RequestTimePlayed()` + +**Reference:** +`TIME_PLAYED_MSG` event will be fired when the answer has arrived. \ No newline at end of file diff --git a/wiki-information/functions/ResetCursor.md b/wiki-information/functions/ResetCursor.md new file mode 100644 index 00000000..87df9c75 --- /dev/null +++ b/wiki-information/functions/ResetCursor.md @@ -0,0 +1,14 @@ +## Title: ResetCursor + +**Content:** +Resets mouse cursor. +`ResetCursor()` + +**Parameters:** +- None + +**Returns:** +- None + +**Description:** +Function resets mouse cursor into its default shape, if it has been previously altered by `SetCursor(cursor)`. Calling `ResetCursor()` is equivalent to calling `SetCursor(nil)`. \ No newline at end of file diff --git a/wiki-information/functions/ResetTutorials.md b/wiki-information/functions/ResetTutorials.md new file mode 100644 index 00000000..5f1cc4aa --- /dev/null +++ b/wiki-information/functions/ResetTutorials.md @@ -0,0 +1,14 @@ +## Title: ResetTutorials + +**Content:** +Starts with the first tutorial again +`ResetTutorials()` + +**Parameters:** +- Nothing + +**Returns:** +- Nothing + +**Description:** +Using this function will immediately display the first tutorial, even if you don't have them enabled. \ No newline at end of file diff --git a/wiki-information/functions/ResistancePercent.md b/wiki-information/functions/ResistancePercent.md new file mode 100644 index 00000000..c17a9cf7 --- /dev/null +++ b/wiki-information/functions/ResistancePercent.md @@ -0,0 +1,21 @@ +## Title: ResistancePercent + +**Content:** +Needs summary. +`resistance = ResistancePercent(resistance, casterLevel)` + +**Parameters:** +- `resistance` + - *number* +- `casterLevel` + - *number* + +**Returns:** +- `resistance` + - *number* + +**Example Usage:** +This function can be used to calculate the percentage of resistance a character has against a specific type of damage, taking into account the caster's level. This can be useful in determining how much damage will be mitigated in combat scenarios. + +**Usage in Addons:** +While specific large addons using this function are not documented, it is likely used in combat analysis and optimization addons to provide players with detailed information about their resistance stats and how they affect incoming damage. \ No newline at end of file diff --git a/wiki-information/functions/RespondInstanceLock.md b/wiki-information/functions/RespondInstanceLock.md new file mode 100644 index 00000000..130cacb0 --- /dev/null +++ b/wiki-information/functions/RespondInstanceLock.md @@ -0,0 +1,9 @@ +## Title: RespondInstanceLock + +**Content:** +Needs summary. +`RespondInstanceLock(acceptLock)` + +**Parameters:** +- `acceptLock` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ResurrectGetOfferer.md b/wiki-information/functions/ResurrectGetOfferer.md new file mode 100644 index 00000000..c809afe6 --- /dev/null +++ b/wiki-information/functions/ResurrectGetOfferer.md @@ -0,0 +1,9 @@ +## Title: ResurrectGetOfferer + +**Content:** +Needs summary. +`name = ResurrectGetOfferer()` + +**Returns:** +- `name` + - *string* \ No newline at end of file diff --git a/wiki-information/functions/ResurrectHasSickness.md b/wiki-information/functions/ResurrectHasSickness.md new file mode 100644 index 00000000..bb7565be --- /dev/null +++ b/wiki-information/functions/ResurrectHasSickness.md @@ -0,0 +1,9 @@ +## Title: ResurrectHasSickness + +**Content:** +Needs summary. +`result = ResurrectHasSickness()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ResurrectHasTimer.md b/wiki-information/functions/ResurrectHasTimer.md new file mode 100644 index 00000000..abdd14c9 --- /dev/null +++ b/wiki-information/functions/ResurrectHasTimer.md @@ -0,0 +1,9 @@ +## Title: ResurrectHasTimer + +**Content:** +Needs summary. +`result = ResurrectHasTimer()` + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/RetrieveCorpse.md b/wiki-information/functions/RetrieveCorpse.md new file mode 100644 index 00000000..f112fb26 --- /dev/null +++ b/wiki-information/functions/RetrieveCorpse.md @@ -0,0 +1,9 @@ +## Title: RetrieveCorpse + +**Content:** +Resurrects when the player is standing near its corpse. +`RetrieveCorpse()` + +**Description:** +This is the "Accept" button one sees after running back to their body. +Requires there to be no active resurrection timer penalty. \ No newline at end of file diff --git a/wiki-information/functions/RollOnLoot.md b/wiki-information/functions/RollOnLoot.md new file mode 100644 index 00000000..d0321c3f --- /dev/null +++ b/wiki-information/functions/RollOnLoot.md @@ -0,0 +1,30 @@ +## Title: RollOnLoot + +**Content:** +Rolls or passes on loot. +`RollOnLoot(rollID)` + +**Parameters:** +- `rollID` + - *number* - The number increases with every roll you have in a party. Maximum value is unknown. +- `rollType` + - *number?* - 0 or nil to pass, 1 to roll Need, 2 to roll Greed, or 3 to roll Disenchant. + +**Usage:** +The code snippet below will display a message when you roll or pass on a roll. This could easily be changed to record how many times you roll on loot. +```lua +hooksecurefunc("RollOnLoot", function(rollID, rollType) + if (rollType and rollType > 0) then + DEFAULT_CHAT_FRAME:AddMessage("You rolled on the item with id: " .. rollID ); + else + DEFAULT_CHAT_FRAME:AddMessage("You passed on the item with id: " .. rollID ); + end +end) +``` + +**Example Use Case:** +This function can be used in addons that manage loot distribution in parties or raids. For instance, an addon could track the number of times a player rolls Need, Greed, or Disenchant on items to provide statistics or enforce loot rules. + +**Addons Using This Function:** +- **LootMaster:** This addon uses `RollOnLoot` to manage and automate loot distribution in raids, ensuring fair distribution based on predefined rules. +- **EPGP Lootmaster:** Utilizes `RollOnLoot` to integrate with the EPGP (Effort Points/Gear Points) system, allowing players to roll on loot while keeping track of their points. \ No newline at end of file diff --git a/wiki-information/functions/RunBinding.md b/wiki-information/functions/RunBinding.md new file mode 100644 index 00000000..d592ace3 --- /dev/null +++ b/wiki-information/functions/RunBinding.md @@ -0,0 +1,22 @@ +## Title: RunBinding + +**Content:** +Executes a key binding. +`RunBinding(command)` + +**Parameters:** +- `command` + - *string* - Name of the key binding to be executed +- `up` + - *string?* - If "up", the binding is run as if the key was released. + +**Usage:** +The call below toggles the display of the FPS counter, as if CTRL+R was pressed. +```lua +RunBinding("TOGGLEFPS"); +``` + +**Description:** +The `command` argument must match one of the (usually capitalized) binding names in a Bindings.xml file. This can be a name that appears in the Blizzard FrameXML Bindings.xml, or one that is specified in an AddOn. +`RunBinding` cannot be used to call a Protected Function from insecure execution paths. +By default, the key binding is executed as if the key was pressed down, in other words, the `keystate` variable will have value "down" during the binding's execution. By specifying the optional second argument (the actual string "up"), the binding is instead executed as if the key was released, in other words, the `keystate` variable will have value "up" during the binding's execution. \ No newline at end of file diff --git a/wiki-information/functions/RunMacro.md b/wiki-information/functions/RunMacro.md new file mode 100644 index 00000000..65e75614 --- /dev/null +++ b/wiki-information/functions/RunMacro.md @@ -0,0 +1,12 @@ +## Title: RunMacro + +**Content:** +Executes a macro. +`RunMacro(macroID or macroName)` + +**Parameters:** +- `macroID` + - *number* - the position of the macro in the macro frame. Starting at the top left macro with 1, counting from left to right and top to bottom. The IDs of the first page (all characters) range from 1-36, the second page 37-54. +- OR +- `macroName` + - *string* - the name of the macro as it is displayed in the macro frame \ No newline at end of file diff --git a/wiki-information/functions/RunMacroText.md b/wiki-information/functions/RunMacroText.md new file mode 100644 index 00000000..bddac16f --- /dev/null +++ b/wiki-information/functions/RunMacroText.md @@ -0,0 +1,30 @@ +## Title: RunMacroText + +**Content:** +Executes a string as if it was a macro. +`RunMacroText(macro)` + +**Parameters:** +- `macro` + - *string* - the string is interpreted as a macro and then executed + +**Usage:** +This creates an invisible button in the middle of the screen, that prints Hello World! every time it is clicked with the left button. +```lua +-- Create the macro to use +local myMacro = [=[ +/run print("Hello") +/run print("World!") +]=] +-- Create the secure frame to activate the macro +local frame = CreateFrame("Button", nil, UIParent, "SecureActionButtonTemplate"); +frame:SetPoint("CENTER") +frame:SetSize(100, 100); +frame:SetAttribute("type", "macro") +frame:SetAttribute("macrotext", myMacro); +frame:RegisterForClicks("LeftButtonUp"); +``` + +**Description:** +Macros are executed via the client repeatedly firing the EXECUTE_CHAT_LINE event. +The maximum macro length via this method is 1023 characters. \ No newline at end of file diff --git a/wiki-information/functions/RunScript.md b/wiki-information/functions/RunScript.md new file mode 100644 index 00000000..3cec46a5 --- /dev/null +++ b/wiki-information/functions/RunScript.md @@ -0,0 +1,31 @@ +## Title: RunScript + +**Content:** +Executes a string of Lua code. +`RunScript(script)` + +**Parameters:** +- `script` + - *string* - The code which is to be executed. + +**Usage:** +To define a function dynamically you could do: +```lua +local retExpr = '\"Hello \" .. UnitName(\"target\")'; +RunScript("function My_GetGreeting() return " .. retExpr .. ";end"); +``` + +**Miscellaneous:** +Result: + +The `My_GetGreeting()` function will be defined to return "Hello" followed by the name of your target. + +**Description:** +This function is NOT recommended for general use within addons for a number of reasons: +1. It'll do whatever you tell it, that includes calling functions, setting variables, whatever. +2. Errors in the script string produce the error popup (at least, they produce the `UI_ERROR_MESSAGE` event). + +On the other hand, it's invaluable if you need to run code that is input by the player at run-time, or do self-generating code. + +**Reference:** +The standard Lua function API `loadstring`, which can overcome all of the problems of `RunScript` described above. \ No newline at end of file diff --git a/wiki-information/functions/SaveBindings.md b/wiki-information/functions/SaveBindings.md new file mode 100644 index 00000000..28e889e3 --- /dev/null +++ b/wiki-information/functions/SaveBindings.md @@ -0,0 +1,34 @@ +## Title: SaveBindings + +**Content:** +Saves account or character specific key bindings. +`SaveBindings(which)` + +**Parameters:** +- `which` + - *number* - Whether the key bindings should be saved as account or character specific. + - `Value` + - `Constant` + - `Description` + - `0` + - `DEFAULT_BINDINGS` + - `1` + - `ACCOUNT_BINDINGS` + - `2` + - `CHARACTER_BINDINGS` + +**Description:** +Bindings are stored in `WTF\Account\ACCOUNTNAME\bindings-cache.wtf`. +Triggers `UPDATE_BINDINGS`. + +**Reference:** +- `GetCurrentBindingSet` + +**Example Usage:** +```lua +-- Save current key bindings as character-specific +SaveBindings(2) +``` + +**Addons Using This Function:** +Many large addons that manage custom key bindings, such as Bartender4 and ElvUI, use this function to save user-defined key bindings either globally or per character. This allows users to have different key bindings for different characters or a consistent set across all characters. \ No newline at end of file diff --git a/wiki-information/functions/SaveView.md b/wiki-information/functions/SaveView.md new file mode 100644 index 00000000..703b6cde --- /dev/null +++ b/wiki-information/functions/SaveView.md @@ -0,0 +1,19 @@ +## Title: SaveView + +**Content:** +Saves a camera angle. The last position loaded is stored in the CVar `cameraView`. +`SaveView(viewIndex)` + +**Parameters:** +- `viewIndex` + - *number* - The index (2-5) to save the camera angle to. (1 is reserved for first person view) + +**Description:** +Saved views are preserved across sessions. +Use `ResetView(viewIndex)` to reset a view to its default. +The last position loaded is stored in the CVar `cameraView`. +The game's camera following style is not applied while you are in a saved view. (See: [Camera Following Style Problem/Bug](https://us.forums.blizzard.com/en/wow/t/camera-following-style-problembug/442862/17)) + +**Miscellaneous:** +Fixed: A bug in 3.0-patches causes SaveView variables not to load the first time you load a character after entering the game. +Reloading the UI, or reloading the character from the character selection screen, will fix this bug. Source \ No newline at end of file diff --git a/wiki-information/functions/Screenshot.md b/wiki-information/functions/Screenshot.md new file mode 100644 index 00000000..423a5b11 --- /dev/null +++ b/wiki-information/functions/Screenshot.md @@ -0,0 +1,19 @@ +## Title: Screenshot + +**Content:** +Takes a screenshot. +`Screenshot()` + +**Description:** +- **Name:** Saves a file with the following format: `WoWScrnShot_MMDDYY_HHMMSS.jpg` +- **Path:** `"...\\World of Warcraft\\_retail_\\Screenshots"` +- **Format:** The format is controlled by CVar `screenshotFormat` which can be set to `"jpeg"` (default), `"png"` or `"tga"`. + +**Usage:** +`/run Screenshot()` + +### Example Use Case: +This function can be used to programmatically take a screenshot in-game, which can be useful for addons that need to capture the screen at specific moments, such as for automated documentation or bug reporting tools. + +### Addons: +Many large addons, such as WeakAuras, might use this function to capture screenshots when certain events occur, helping players to document their gameplay or share specific moments with others. \ No newline at end of file diff --git a/wiki-information/functions/SearchLFGGetNumResults.md b/wiki-information/functions/SearchLFGGetNumResults.md new file mode 100644 index 00000000..6faeef63 --- /dev/null +++ b/wiki-information/functions/SearchLFGGetNumResults.md @@ -0,0 +1,16 @@ +## Title: SearchLFGGetNumResults + +**Content:** +Returns how many players are listed in the raid browser for the selected LFG id. +`numResults, totalResults = SearchLFGGetNumResults()` + +**Returns:** +- `numResults` + - *number* - Amount of players listed in Raid Browser (displayed?) +- `totalResults` + - *number* - Total amount of players listed in Raid Browser + +**Reference:** +- `SearchLFGGetResults()` +- `SearchLFGGetPartyResults()` +- `SearchLFGJoin()` \ No newline at end of file diff --git a/wiki-information/functions/SearchLFGJoin.md b/wiki-information/functions/SearchLFGJoin.md new file mode 100644 index 00000000..1bb621fb --- /dev/null +++ b/wiki-information/functions/SearchLFGJoin.md @@ -0,0 +1,21 @@ +## Title: SearchLFGJoin + +**Content:** +Allows a player to join Raid Browser list. +`SearchLFGJoin(typeID, lfgID)` + +**Parameters:** +- `typeID` + - *number* - LFG typeid +- `lfgID` + - *number* - ID of LFG dungeon + +**Reference:** +- `SearchLFGGetResults()` +- `SearchLFGGetPartyResults()` + +**Example Usage:** +This function can be used to programmatically add a player to the Raid Browser list for a specific dungeon or raid. For instance, an addon could use this function to automate the process of joining the LFG queue for a specific raid. + +**Addons:** +Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to enhance their LFG functionalities, such as automatically joining specific raid queues based on user preferences or raid schedules. \ No newline at end of file diff --git a/wiki-information/functions/SecureCmdOptionParse.md b/wiki-information/functions/SecureCmdOptionParse.md new file mode 100644 index 00000000..67395806 --- /dev/null +++ b/wiki-information/functions/SecureCmdOptionParse.md @@ -0,0 +1,23 @@ +## Title: SecureCmdOptionParse + +**Content:** +Evaluates macro conditionals without the need of a macro. +`result, target = SecureCmdOptionParse(options)` + +**Parameters:** +- `options` + - *string* - a secure command options string to be parsed, e.g. "ALT is held down; CTRL is held down, but ALT is not; neither ALT nor CTRL is held down". + +**Returns:** +- `result` + - *string* - value of the first satisfied clause in options, or no return (nil) if none of the conditions in options are satisfied. +- `target` + - *string* - the target of the first satisfied clause in options (using either the target=... or @... conditional), nil if the clause does not explicitly specify a target, or no return (nil) if none of the conditions in options are satisfied. + +**Description:** +Note that item links cannot be part of options string as they contain square brackets, which get interpreted by the parser as conditions. +This function is available in the RestrictedEnvironment, and is used to evaluate the options for secure macro commands. + +**Reference:** +- Secure command options +- SecureStateDriver \ No newline at end of file diff --git a/wiki-information/functions/SelectGossipActiveQuest.md b/wiki-information/functions/SelectGossipActiveQuest.md new file mode 100644 index 00000000..9a120260 --- /dev/null +++ b/wiki-information/functions/SelectGossipActiveQuest.md @@ -0,0 +1,12 @@ +## Title: SelectGossipActiveQuest + +**Content:** +Selects an active quest from a gossip list. +`SelectGossipActiveQuest(index)` + +**Parameters:** +- `index` + - *number* - Index of the active quest to select, from 1 to `GetNumGossipActiveQuests()`; order corresponds to the order of return values from `GetGossipActiveQuests()`. + +**Reference:** +`QUEST_PROGRESS` is fired when the details of the quest are available. \ No newline at end of file diff --git a/wiki-information/functions/SelectGossipAvailableQuest.md b/wiki-information/functions/SelectGossipAvailableQuest.md new file mode 100644 index 00000000..439584a8 --- /dev/null +++ b/wiki-information/functions/SelectGossipAvailableQuest.md @@ -0,0 +1,12 @@ +## Title: SelectGossipAvailableQuest + +**Content:** +Selects an available quest from a gossip list. +`SelectGossipAvailableQuest(index)` + +**Parameters:** +- `index` + - *number* - Index of the available quest to select, from 1 to `GetNumGossipAvailableQuests()`; order corresponds to the order of return values from `GetGossipAvailableQuests()`. + +**Reference:** +`QUEST_PROGRESS` is fired when the details of the quest are available. \ No newline at end of file diff --git a/wiki-information/functions/SelectGossipOption.md b/wiki-information/functions/SelectGossipOption.md new file mode 100644 index 00000000..67f5763d --- /dev/null +++ b/wiki-information/functions/SelectGossipOption.md @@ -0,0 +1,9 @@ +## Title: SelectGossipOption + +**Content:** +Selects a gossip (conversation) option. +`SelectGossipOption(index)` + +**Parameters:** +- `index` + - *number* - Index of the gossip option to select, from 1 to `GetNumGossipOptions()`; order corresponds to the order of return values from `GetGossipOptions()`. \ No newline at end of file diff --git a/wiki-information/functions/SelectQuestLogEntry.md b/wiki-information/functions/SelectQuestLogEntry.md new file mode 100644 index 00000000..7d8a71fd --- /dev/null +++ b/wiki-information/functions/SelectQuestLogEntry.md @@ -0,0 +1,13 @@ +## Title: SelectQuestLogEntry + +**Content:** +Makes a quest in the quest log the currently selected quest. +`SelectQuestLogEntry(questIndex)` + +**Parameters:** +- `questIndex` + - *number* - quest log entry index to select, ascending from 1. + +**Description:** +This function is called whenever the user clicks on a quest name in the quest log. +It is necessary to call this function to allow other API functions that do not take a questIndex argument to return information about specific quests. \ No newline at end of file diff --git a/wiki-information/functions/SelectTrainerService.md b/wiki-information/functions/SelectTrainerService.md new file mode 100644 index 00000000..941e810b --- /dev/null +++ b/wiki-information/functions/SelectTrainerService.md @@ -0,0 +1,12 @@ +## Title: SelectTrainerService + +**Content:** +Notifies the server that a trainer service has been selected. +`SelectTrainerService(index)` + +**Parameters:** +- `index` + - *number* - Index of the trainer service being selected. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) + +**Returns:** +- `nil` \ No newline at end of file diff --git a/wiki-information/functions/SelectedRealmName.md b/wiki-information/functions/SelectedRealmName.md new file mode 100644 index 00000000..5cce17d9 --- /dev/null +++ b/wiki-information/functions/SelectedRealmName.md @@ -0,0 +1,12 @@ +## Title: SelectedRealmName + +**Content:** +Returns the realm name that will be used in Recruit-a-Friend invitations. +`selectedRealmName = SelectedRealmName()` + +**Returns:** +- `selectedRealmName` + - *string* - realm name, e.g. "Die Aldor". + +**Description:** +Generally the player character's own realm. \ No newline at end of file diff --git a/wiki-information/functions/SendChatMessage.md b/wiki-information/functions/SendChatMessage.md new file mode 100644 index 00000000..cd8ae223 --- /dev/null +++ b/wiki-information/functions/SendChatMessage.md @@ -0,0 +1,102 @@ +## Title: SendChatMessage + +**Content:** +Sends a chat message. +`SendChatMessage(msg)` + +**Parameters:** +- `msg` + - *string* - The message to be sent. Large messages are truncated to max 255 characters, and only valid chat message characters are permitted. +- `chatType` + - *string?* - The type of message to be sent, e.g. "PARTY". If omitted, this defaults to "SAY". +- `languageID` + - *number?* - The languageID used for the message. Only works with chatTypes "SAY" and "YELL", and only if not in a group. If omitted the default language will be used: Orcish for the Horde and Common for the Alliance, as returned by `GetDefaultLanguage()`. +- `target` + - *string|number?* - The player name or channel number receiving the message for "WHISPER" or "CHANNEL" chatTypes. + +**Miscellaneous:** +- HW - denotes if the chatType requires a hardware event when in the outdoor world, i.e. not in an instance/battleground. +- `chatType` + - `Command` + - `HW` + - `Description` + - `"SAY"` + - `/s, /say` + - ✔️ + - Chat message to nearby players + - `"EMOTE"` + - `/e, /emote` + - Custom text emote to nearby players (See `DoEmote` for normal emotes) + - `"YELL"` + - `/y, /yell` + - ✔️ + - Chat message to far away players + - `"PARTY"` + - `/p, /party` + - Chat message to party members + - `"RAID"` + - `/ra, /raid` + - Chat message to raid members + - `"RAID_WARNING"` + - `/rw` + - Audible warning message to raid members + - `"INSTANCE_CHAT"` + - `/i, /instance` + - Chat message to the instance group (Dungeon finder / Battlegrounds / Arena) + - `"GUILD"` + - `/g, /guild` + - Chat message to guild members + - `"OFFICER"` + - `/o, /officer` + - Chat message to guild officers + - `"WHISPER"` + - `/w, /whisper/t, /tell` + - Whisper to a specific other player, use player name as target argument + - `"CHANNEL"` + - `/1, /2, ...` + - ✔️ + - Chat message to a specific global/custom chat channel, use channel number as target argument + - `"AFK"` + - `/afk` + - Not a real channel; Sets your AFK message. Send an empty message to clear AFK status. + - `"DND"` + - `/dnd` + - Not a real channel; Sets your DND message. Send an empty message to clear DND status. + - `"VOICE_TEXT"` + - Sends text-to-speech to the in-game voice chat. + +**Description:** +Fires `CHAT_MSG_*` events, e.g. `CHAT_MSG_SAY` and `CHAT_MSG_CHANNEL`. +- `"RAID_WARNING"` is accessible to raid leaders/assistants, or to all members of a party (when not in a raid). +- `"WHISPER"` works across all realms in a region, it's not restricted to connected realms and you don't need to have interacted with the recipient before. + +**Usage:** +- Sends a message, defaults to "SAY". + ```lua + SendChatMessage("Hello world") + ``` +- Sends a /yell message. + ```lua + SendChatMessage("For the Horde!", "YELL") + DoEmote("FORTHEHORDE") + ``` +- Sends a message to General Chat which is usually on channel index 1. + ```lua + SendChatMessage("Hello friends", "CHANNEL", nil, 1) + ``` +- Whispers your target. + ```lua + SendChatMessage("My, you're a tall one!", "WHISPER", nil, UnitName("target")) + ``` +- Sets your /dnd message. + ```lua + SendChatMessage("Grabbing a beer", "DND") + ``` +- Speaks in Thalassian, provided your character knows the language. + ```lua + SendChatMessage("Ugh, I hate Thunder Bluff! You can't find a good burger anywhere.", "SAY", 10) + ``` +- Sends a message to an instance group, raid, or party. + ```lua + SendChatMessage("Hello there o/", IsInGroup(LE_PARTY_CATEGORY_INSTANCE) and "INSTANCE_CHAT" or IsInRaid() and "RAID" or "PARTY") + ``` \ No newline at end of file diff --git a/wiki-information/functions/SendMail.md b/wiki-information/functions/SendMail.md new file mode 100644 index 00000000..14641c2b --- /dev/null +++ b/wiki-information/functions/SendMail.md @@ -0,0 +1,22 @@ +## Title: SendMail + +**Content:** +Sends in-game mail. +`SendMail(recipient, subject)` + +**Parameters:** +- `recipient` + - *string* - Intended recipient of the mail. +- `subject` + - *string* - Subject of the mail. Cannot be an empty string or nil, but may be whitespace, e.g. " ". +- `body` + - *string?* - Body of the mail. + +**Description:** +Triggers `MAIL_SEND_SUCCESS` if mail was sent to the recipient's inbox, or `MAIL_FAILED` otherwise. Repeated calls to `SendMail()` are ignored until one of these events fire. + +**Usage:** +Assuming a friendly player named Bob exists on your server: +```lua +SendMail("Bob", "Hey Bob", "Hows it going, Bob?") +``` \ No newline at end of file diff --git a/wiki-information/functions/SendSystemMessage.md b/wiki-information/functions/SendSystemMessage.md new file mode 100644 index 00000000..6405d400 --- /dev/null +++ b/wiki-information/functions/SendSystemMessage.md @@ -0,0 +1,9 @@ +## Title: SendSystemMessage + +**Content:** +Prints a yellow `CHAT_MSG_SYSTEM` message. +`SendSystemMessage(msg)` + +**Parameters:** +- `msg` + - *string* - The message to be sent. Fires `CHAT_MSG_SYSTEM`. \ No newline at end of file diff --git a/wiki-information/functions/SetAbandonQuest.md b/wiki-information/functions/SetAbandonQuest.md new file mode 100644 index 00000000..df833ad2 --- /dev/null +++ b/wiki-information/functions/SetAbandonQuest.md @@ -0,0 +1,27 @@ +## Title: SetAbandonQuest + +**Content:** +Selects the currently selected quest to be abandoned. +`SetAbandonQuest()` + +**Description:** +Quests are selected by calling `SelectQuestLogEntry()`. +After calling this function, you can abandon the quest by calling `AbandonQuest()`. + +**Reference:** +`GetAbandonQuestName()` + +**Example Usage:** +```lua +-- Select the quest log entry for the quest you want to abandon +SelectQuestLogEntry(questIndex) + +-- Set the quest to be abandoned +SetAbandonQuest() + +-- Abandon the quest +AbandonQuest() +``` + +**Additional Information:** +This function is often used in addons that manage quest logs, such as Questie, to provide users with the ability to abandon quests directly from the addon interface. \ No newline at end of file diff --git a/wiki-information/functions/SetAchievementComparisonUnit.md b/wiki-information/functions/SetAchievementComparisonUnit.md new file mode 100644 index 00000000..f1b9fe8b --- /dev/null +++ b/wiki-information/functions/SetAchievementComparisonUnit.md @@ -0,0 +1,21 @@ +## Title: SetAchievementComparisonUnit + +**Content:** +Sets the unit to be compared to. +`success = SetAchievementComparisonUnit(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `success` + - *boolean* - Returns true/false depending on whether the unit is valid. + +**Reference:** +- `INSPECT_ACHIEVEMENT_READY`, when your query has finished processing on the server and new information is available + +**See also:** +- `ClearAchievementComparisonUnit` +- `GetAchievementComparisonInfo` +- `GetNumComparisonCompletedAchievements` \ No newline at end of file diff --git a/wiki-information/functions/SetActionBarToggles.md b/wiki-information/functions/SetActionBarToggles.md new file mode 100644 index 00000000..5bed68cf --- /dev/null +++ b/wiki-information/functions/SetActionBarToggles.md @@ -0,0 +1,20 @@ +## Title: SetActionBarToggles + +**Content:** +Sets the visible state for each action bar. +`SetActionBarToggles(bottomLeftState, bottomRightState, sideRightState, sideRight2State, alwaysShow)` + +**Parameters:** +- `bottomLeftState` + - *Flag* - 1 if the left-hand bottom action bar is to be shown, 0 or nil otherwise. +- `bottomRightState` + - *Flag* - 1 if the right-hand bottom action bar is to be shown, 0 or nil otherwise. +- `sideRightState` + - *Flag* - 1 if the first (outer) right side action bar is to be shown, 0 or nil otherwise. +- `sideRight2State` + - *Flag* - 1 if the second (inner) right side action bar is to be shown, 0 or nil otherwise. +- `alwaysShow` + - *Flag* - 1 if the bars are always shown, 0 or nil otherwise. + +**Description:** +Note that this doesn't actually change the action bar states directly, it simply registers the desired states for the next time the game is loaded. The states during play are in the variables `SHOW_MULTI_ACTIONBAR_1`, `SHOW_MULTI_ACTIONBAR_2`, `SHOW_MULTI_ACTIONBAR_3`, `SHOW_MULTI_ACTIONBAR_4`, and reflected by calling `MultiActionBar_Update()`. \ No newline at end of file diff --git a/wiki-information/functions/SetActiveTalentGroup.md b/wiki-information/functions/SetActiveTalentGroup.md new file mode 100644 index 00000000..11aba72a --- /dev/null +++ b/wiki-information/functions/SetActiveTalentGroup.md @@ -0,0 +1,24 @@ +## Title: SetActiveTalentGroup + +**Content:** +Sets the active talent group of the player. This is the 5-second cast that occurs when clicking the Activate These Talents button in the talent pane. +`SetActiveTalentGroup(groupIndex);` + +**Parameters:** +- `groupIndex` + - *number* - Ranging from 1 to 2 (primary/secondary talent group). To get the current one use `GetActiveTalentGroup()` + +**Notes and Caveats:** +Nothing will happen if the `groupIndex` is the currently active talent group. + +**Usage:** +The following line will toggle between the player's talent groups: +```lua +SetActiveTalentGroup(3 - GetActiveTalentGroup()) +``` + +**Example Use Case:** +This function can be used in macros or addons to allow players to quickly switch between their primary and secondary talent specializations without manually opening the talent pane. + +**Addon Usage:** +Large addons like "ElvUI" or "Bartender4" might use this function to provide users with an easy way to switch talent groups through their custom interfaces. For example, they could add a button to the UI that, when clicked, automatically switches the player's talent group. \ No newline at end of file diff --git a/wiki-information/functions/SetAllowDangerousScripts.md b/wiki-information/functions/SetAllowDangerousScripts.md new file mode 100644 index 00000000..7b1908b6 --- /dev/null +++ b/wiki-information/functions/SetAllowDangerousScripts.md @@ -0,0 +1,9 @@ +## Title: SetAllowDangerousScripts + +**Content:** +Needs summary. +`SetAllowDangerousScripts()` + +**Parameters:** +- `allowed` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/SetAllowLowLevelRaid.md b/wiki-information/functions/SetAllowLowLevelRaid.md new file mode 100644 index 00000000..8aabc99a --- /dev/null +++ b/wiki-information/functions/SetAllowLowLevelRaid.md @@ -0,0 +1,9 @@ +## Title: SetAllowLowLevelRaid + +**Content:** +Needs summary. +`SetAllowLowLevelRaid()` + +**Parameters:** +- `allow` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/SetAutoDeclineGuildInvites.md b/wiki-information/functions/SetAutoDeclineGuildInvites.md new file mode 100644 index 00000000..1f086141 --- /dev/null +++ b/wiki-information/functions/SetAutoDeclineGuildInvites.md @@ -0,0 +1,19 @@ +## Title: SetAutoDeclineGuildInvites + +**Content:** +Sets whether guild invites should be automatically declined. +`SetAutoDeclineGuildInvites(decline)` + +**Parameters:** +- `decline` + - *boolean* - True if guild invitations should be automatically declined, false if invitations should be shown to the user. + +**Reference:** +- `DISABLE_DECLINE_GUILD_INVITE`, if guild invitations will now be shown to the user +- `ENABLE_DECLINE_GUILD_INVITE`, if guild invitations will now be declined automatically + +See also: +- `GetAutoDeclineGuildInvites` + +**Description:** +Blizzard's code always passes in a string value, but the function accepts both strings and numbers, just like `SetCVar`, and its counterpart `GetAutoDeclineGuildInvites` returns numeric values, just like `GetCVar`. \ No newline at end of file diff --git a/wiki-information/functions/SetBattlefieldScoreFaction.md b/wiki-information/functions/SetBattlefieldScoreFaction.md new file mode 100644 index 00000000..ed4308b7 --- /dev/null +++ b/wiki-information/functions/SetBattlefieldScoreFaction.md @@ -0,0 +1,9 @@ +## Title: SetBattlefieldScoreFaction + +**Content:** +Sets the faction to show on the battlefield scoreboard. +`SetBattlefieldScoreFaction()` + +**Parameters:** +- `faction` + - *number* - `nil` = All, `0` = Horde, `1` = Alliance \ No newline at end of file diff --git a/wiki-information/functions/SetBinding.md b/wiki-information/functions/SetBinding.md new file mode 100644 index 00000000..18a1221e --- /dev/null +++ b/wiki-information/functions/SetBinding.md @@ -0,0 +1,46 @@ +## Title: SetBinding + +**Content:** +Sets a key binding to an action. +`ok = SetBinding(key)` + +**Parameters:** +- `key` + - *string* - Any binding string accepted by World of Warcraft. For example: `"ALT-CTRL-F"`, `"SHIFT-T"`, `"W"`, `"BUTTON4"`. +- `command` + - *string?* - Any name attribute value of a Bindings.xml-defined binding, or an action command string, or nil to unbind all bindings from key. For example: + - `"SITORSTAND"`: a Bindings.xml-defined binding to toggle between sitting and standing + - `"CLICK PlayerFrame:LeftButton"`: Fire a left-click on the PlayerFrame. + - `"SPELL Bloodrage"`: Cast Bloodrage. + - `"ITEM Hearthstone"`: Use Hearthstone. + - `"MACRO Foo"`: Run a macro called "Foo". + - `"MACRO 1"`: Run a macro with index 1. +- `mode` + - *number?* - 1 if the binding should be saved to the currently loaded binding set (default), or 2 if to the alternative. + +**Returns:** +- `ok` + - *boolean* - 1 if the binding has been changed successfully, nil otherwise. + +**Usage:** +```lua +-- Remove all bindings from the right mouse button. +SetBinding("BUTTON2"); + +-- Restore the default binding for the right mouse button. +SetBinding("BUTTON2", "TURNORACTION"); +``` + +**Description:** +There are two binding sets: per-account and per-character bindings; of which one may be presently loaded (LoadBindings). You may look up which one is currently loaded using `GetCurrentBindingSet()`. +A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. +The Key Bindings UI will update immediately should this function succeed. However, bindings are not saved without an explicit `SaveBindings()` call. Unless saved, bindings will reset on next log-in / bindings load. +A list of default FrameXML bindings.xml-defined actions is available: `BindingID`. +The Addon API doesn't know what the default binding is for any single action. You can set them all to their defaults by calling `LoadBindings(DEFAULT_BINDINGS)`; this is an all-or-nothing action. +If you set bindings using this API, they will be permanently saved to the current set. If you want more control of what bindings are loaded, you may want to use `SetOverrideBindingClick` to enable them for each login session. + +**Reference:** +- `API SetBindingSpell` +- `API SetBindingItem` +- `API SetBindingMacro` +- `API SetBindingClick` \ No newline at end of file diff --git a/wiki-information/functions/SetBindingClick.md b/wiki-information/functions/SetBindingClick.md new file mode 100644 index 00000000..9d07fd1e --- /dev/null +++ b/wiki-information/functions/SetBindingClick.md @@ -0,0 +1,38 @@ +## Title: SetBindingClick + +**Content:** +Sets a binding to click the specified Button widget. +`ok = SetBindingClick(key, buttonName)` + +**Parameters:** +- `key` + - *string* - Any binding string accepted by World of Warcraft. For example: "ALT-CTRL-F", "SHIFT-T", "W", "BUTTON4". +- `buttonName` + - *string* - Name of the button you wish to click. +- `button` + - *string* - Value of the button argument you wish to pass to the OnClick handler with the click; "LeftButton" by default. + +**Returns:** +- `ok` + - *boolean* - 1 if the binding has been changed successfully, nil otherwise. + +**Description:** +This function is functionally equivalent to the following statement. +`ok = SetBinding("key", "CLICK " .. buttonName .. (button and (":" .. button) or ""));` +A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. +You must use SetBinding to unbind a key. + +**Reference:** +`SetBinding` + +**Example Usage:** +```lua +-- Bind the "F" key to click a button named "MyButton" +SetBindingClick("F", "MyButton") + +-- Bind the "SHIFT-G" key to click a button named "AnotherButton" with the right mouse button +SetBindingClick("SHIFT-G", "AnotherButton", "RightButton") +``` + +**Addons Using This Function:** +Many large addons, such as Bartender4 and ElvUI, use `SetBindingClick` to allow users to customize their key bindings for various UI elements and actions. This function is essential for creating flexible and user-friendly interfaces where players can bind keys to specific buttons or actions dynamically. \ No newline at end of file diff --git a/wiki-information/functions/SetBindingItem.md b/wiki-information/functions/SetBindingItem.md new file mode 100644 index 00000000..408addf9 --- /dev/null +++ b/wiki-information/functions/SetBindingItem.md @@ -0,0 +1,24 @@ +## Title: SetBindingItem + +**Content:** +Sets a binding to use a specified item. +`ok = SetBindingItem(key, item)` + +**Parameters:** +- `key` + - *string* - Any binding string accepted by World of Warcraft. For example: `"ALT-CTRL-F"`, `"SHIFT-T"`, `"W"`, `"BUTTON4"`. +- `item` + - *string* - Item name (or item string) you want the binding to use. For example: `"Hearthstone"`, `"item:6948"` + +**Returns:** +- `ok` + - *boolean* - 1 if the binding has been changed successfully, nil otherwise. + +**Description:** +This function is functionally equivalent to the following statement. +`ok = SetBinding("key", "ITEM " .. item);` +A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. +You must use SetBinding to unbind a key. + +**Reference:** +[SetBinding](SetBinding) \ No newline at end of file diff --git a/wiki-information/functions/SetBindingMacro.md b/wiki-information/functions/SetBindingMacro.md new file mode 100644 index 00000000..cffb00ed --- /dev/null +++ b/wiki-information/functions/SetBindingMacro.md @@ -0,0 +1,42 @@ +## Title: SetBindingMacro + +**Content:** +Sets a binding to click the specified button object. +`ok = SetBindingMacro(key, macroName or macroId)` + +**Parameters:** +- `("key", "macroName")` or `("key", macroId)` + - `key` + - *string* - Any binding string accepted by World of Warcraft. For example: `"ALT-CTRL-F"`, `"SHIFT-T"`, `"W"`, `"BUTTON4"`. + - `macroName` + - *string* - Name of the macro you wish to execute. + - `macroId` + - *number* - Index of the macro you wish to execute. + +**Returns:** +- `ok` + - *boolean* - 1 if the binding has been changed successfully, nil otherwise. + +**Description:** +This function is functionally equivalent to the following statement. +`ok = SetBinding("key", "MACRO " .. macroName);` +A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. +You must use SetBinding to unbind a key. + +**Reference:** +- `SetBinding` + +**Example Usage:** +```lua +-- Bind the "SHIFT-T" key to a macro named "MyMacro" +local success = SetBindingMacro("SHIFT-T", "MyMacro") +if success then + print("Binding set successfully!") +else + print("Failed to set binding.") +end +``` + +**Addons Using This Function:** +- **Bartender4**: A popular action bar replacement addon that allows users to customize their action bars and key bindings extensively. It uses `SetBindingMacro` to allow users to bind macros to specific keys directly through its interface. +- **ElvUI**: A comprehensive UI replacement addon that provides extensive customization options, including key bindings for macros. It leverages `SetBindingMacro` to manage these bindings efficiently. \ No newline at end of file diff --git a/wiki-information/functions/SetBindingSpell.md b/wiki-information/functions/SetBindingSpell.md new file mode 100644 index 00000000..c0c4ecae --- /dev/null +++ b/wiki-information/functions/SetBindingSpell.md @@ -0,0 +1,39 @@ +## Title: SetBindingSpell + +**Content:** +Sets a binding to cast the specified spell. +`ok = SetBindingSpell(key, spell)` + +**Parameters:** +- `key` + - *string* - Any binding string accepted by World of Warcraft. For example: "ALT-CTRL-F", "SHIFT-T", "W", "BUTTON4". +- `spell` + - *string* - Name of the spell you wish to cast when the binding is pressed. + +**Returns:** +- `ok` + - *boolean* - 1 if the binding has been changed successfully, nil otherwise. + +**Description:** +This function is functionally equivalent to the following statement. +`ok = SetBinding("key", "SPELL " .. spell);` +A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. +You must use SetBinding to unbind a key. + +**Reference:** +- `SetBinding` + +**Example Usage:** +```lua +-- Bind the spell "Fireball" to the key "SHIFT-F" +local success = SetBindingSpell("SHIFT-F", "Fireball") +if success then + print("Binding set successfully!") +else + print("Failed to set binding.") +end +``` + +**Addons Using This Function:** +- **Bartender4**: A popular action bar replacement addon that allows users to customize their action bars and key bindings extensively. It uses `SetBindingSpell` to allow users to bind spells directly to keys through its configuration interface. +- **ElvUI**: A comprehensive UI replacement addon that includes features for key binding management. It uses `SetBindingSpell` to facilitate the binding of spells to keys as part of its key binding setup process. \ No newline at end of file diff --git a/wiki-information/functions/SetCemeteryPreference.md b/wiki-information/functions/SetCemeteryPreference.md new file mode 100644 index 00000000..c92b0d10 --- /dev/null +++ b/wiki-information/functions/SetCemeteryPreference.md @@ -0,0 +1,9 @@ +## Title: SetCemeteryPreference + +**Content:** +Needs summary. +`SetCemeteryPreference(cemetaryID)` + +**Parameters:** +- `cemetaryID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/SetChannelPassword.md b/wiki-information/functions/SetChannelPassword.md new file mode 100644 index 00000000..d71d6608 --- /dev/null +++ b/wiki-information/functions/SetChannelPassword.md @@ -0,0 +1,22 @@ +## Title: SetChannelPassword + +**Content:** +Changes the password of the current channel. +`SetChannelPassword(channelName, password)` + +**Parameters:** +- `channelName` + - *string* - The name of the channel. +- `password` + - *any* - The password to assign to the channel. + +**Usage:** +```lua +SetChannelPassword("Sembiance", "secretpassword"); +``` + +**Example Use Case:** +This function can be used in a scenario where you are managing a private chat channel and need to update its password for security reasons. For instance, if you are running a guild event and want to ensure only authorized members can join the channel, you can change the password periodically. + +**Addons:** +Large addons like "Prat" (a popular chat enhancement addon) might use this function to provide users with the ability to manage their chat channels more effectively, including setting and changing passwords for private channels. \ No newline at end of file diff --git a/wiki-information/functions/SetConsoleKey.md b/wiki-information/functions/SetConsoleKey.md new file mode 100644 index 00000000..da30a8c0 --- /dev/null +++ b/wiki-information/functions/SetConsoleKey.md @@ -0,0 +1,15 @@ +## Title: SetConsoleKey + +**Content:** +Sets the console key (normally ~). +`SetConsoleKey(key)` + +**Parameters:** +- `key` + - *string* - The character to bind to opening the console overlay, or `nil` to disable the console binding. + +**Description:** +The console is only accessible when WoW is started with the `-console` parameter. This function does nothing if the parameter wasn't used. +The console key is not saved by the WoW client, and will revert to the default ` (backtick) key when WoW is restarted. +Unlike the `SetBinding` function, you can only provide the values of keys that represent standard ASCII characters; no modifiers are allowed. For instance, `SetConsoleKey("CTRL-F")` won't work, but `SetConsoleKey("F")` will. In addition, non-alphabetic keys that require modifiers to access, such as `!` using ⇧ Shift+1, cannot be used. +The console key overrides all other key bindings in WoW, regardless of context. This means that if you set it to `F`, you'll be unable to type the `F` character in chat until you restart WoW. \ No newline at end of file diff --git a/wiki-information/functions/SetCurrencyBackpack.md b/wiki-information/functions/SetCurrencyBackpack.md new file mode 100644 index 00000000..83dcd117 --- /dev/null +++ b/wiki-information/functions/SetCurrencyBackpack.md @@ -0,0 +1,15 @@ +## Title: SetCurrencyBackpack + +**Content:** +Alters the backpack tracking state of a currency. +`SetCurrencyBackpack(id, backpack)` + +**Parameters:** +- `id` + - *Number* - Index of the currency in the currency list to alter tracking of. +- `backpack` + - *Number* - 1 to track; 0 to clear tracking. + +**Notes and Caveats:** +This function affects the `isWatched` return value of `GetCurrencyListInfo`. +Information about watched currencies is accessible using `GetBackpackCurrencyListInfo`. \ No newline at end of file diff --git a/wiki-information/functions/SetCurrencyUnused.md b/wiki-information/functions/SetCurrencyUnused.md new file mode 100644 index 00000000..6a73673e --- /dev/null +++ b/wiki-information/functions/SetCurrencyUnused.md @@ -0,0 +1,15 @@ +## Title: SetCurrencyUnused + +**Content:** +Marks/unmarks a currency as unused. +`SetCurrencyUnused(id, unused)` + +**Parameters:** +- `id` + - *Number* - Index of the currency in the currency list to alter unused status of. +- `unused` + - *Number* - 1 to mark the currency as unused; 0 to mark the currency as used. + +**Notes and Caveats:** +When a currency is marked as unused, it is placed under the "Unused" header in the currency list; this is always the last header in the list. This alters the currency's index in the currency list. +The `isUnused` return value of `GetCurrencyListInfo` can be used to get the current state. \ No newline at end of file diff --git a/wiki-information/functions/SetCurrentTitle.md b/wiki-information/functions/SetCurrentTitle.md new file mode 100644 index 00000000..36d7f181 --- /dev/null +++ b/wiki-information/functions/SetCurrentTitle.md @@ -0,0 +1,24 @@ +## Title: SetCurrentTitle + +**Content:** +Sets the player's displayed title. +`SetCurrentTitle(titleId)` + +**Parameters:** +- `titleId` + - *number* : TitleId - ID of the title you want to set. The identifiers are global and therefore do not depend on which titles you have learned. 0, invalid or unlearned IDs clear your title. + +**Description:** +The last indexed value (currently 143) returns nil and removes the player's name completely (not available to players). +`GetTitleName` can be used to find the name associated with the TitleId. + +**Usage:** +This sets the title "Elder" if your character had earned the title, otherwise it removes any active title. +```lua +SetCurrentTitle(43) +``` + +Sets a random title from the available ones. +```lua +/run local t = {} for i = 1, GetNumTitles() do if IsTitleKnown(i) then tinsert(t, i) end end SetCurrentTitle(t[math.random(#t)]) +``` \ No newline at end of file diff --git a/wiki-information/functions/SetCursor.md b/wiki-information/functions/SetCursor.md new file mode 100644 index 00000000..cd89058b --- /dev/null +++ b/wiki-information/functions/SetCursor.md @@ -0,0 +1,18 @@ +## Title: SetCursor + +**Content:** +Sets the current cursor texture. +`changed = SetCursor(cursor)` + +**Parameters:** +- `cursor` + - *string* - cursor to switch to; either a built-in cursor identifier (like "ATTACK_CURSOR"), path to a cursor texture (e.g. "Interface/Cursor/Taxi"), or `nil` to reset to a default cursor. + +**Returns:** +- `changed` + - *boolean* - always 1. + +**Description:** +If the cursor is hovering over WorldFrame, the SetCursor function will have no effect - cursor is locked to reflect what the player is currently pointing at. +Texture paths may be suffixed by ".crosshair" to offset the position of the texture such that it will be centered on the cursor. +If called with an invalid argument, the cursor is replaced by a black square. \ No newline at end of file diff --git a/wiki-information/functions/SetDungeonDifficultyID.md b/wiki-information/functions/SetDungeonDifficultyID.md new file mode 100644 index 00000000..3c4300c4 --- /dev/null +++ b/wiki-information/functions/SetDungeonDifficultyID.md @@ -0,0 +1,20 @@ +## Title: SetDungeonDifficultyID + +**Content:** +Sets the player's dungeon difficulty. +`SetDungeonDifficultyID(difficultyIndex)` + +**Parameters:** +- `difficultyIndex` + - *number* + - `1` → 5 Player + - `2` → 5 Player (Heroic) + - `8` → Challenge Mode + +**Description:** +When the change occurs, a message will be displayed in the default chat frame. +The above arguments are also returned from `GetDungeonDifficultyID()`. + +**Reference:** +- `GetDungeonDifficultyID` + - `difficultyIndex` \ No newline at end of file diff --git a/wiki-information/functions/SetFactionActive.md b/wiki-information/functions/SetFactionActive.md new file mode 100644 index 00000000..765461ac --- /dev/null +++ b/wiki-information/functions/SetFactionActive.md @@ -0,0 +1,13 @@ +## Title: SetFactionActive + +**Content:** +Flags the specified faction as active in the reputation window. +`SetFactionActive(index)` + +**Parameters:** +- `index` + - *number* - The index of the faction to mark active, ascending from 1. + +**Reference:** +- `IsFactionInactive` +- `SetFactionInactive` \ No newline at end of file diff --git a/wiki-information/functions/SetFactionInactive.md b/wiki-information/functions/SetFactionInactive.md new file mode 100644 index 00000000..40e419b8 --- /dev/null +++ b/wiki-information/functions/SetFactionInactive.md @@ -0,0 +1,13 @@ +## Title: SetFactionInactive + +**Content:** +Flags the specified faction as inactive in the reputation window. +`SetFactionInactive(index)` + +**Parameters:** +- `index` + - *number* - The index of the faction to mark inactive, ascending from 1. + +**Reference:** +- `IsFactionInactive` +- `SetFactionActive` \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankTabInfo.md b/wiki-information/functions/SetGuildBankTabInfo.md new file mode 100644 index 00000000..facd9695 --- /dev/null +++ b/wiki-information/functions/SetGuildBankTabInfo.md @@ -0,0 +1,16 @@ +## Title: SetGuildBankTabInfo + +**Content:** +Sets the name and icon of a guild bank tab. +`SetGuildBankTabInfo(tab, name, icon)` + +**Parameters:** +- `tab` + - *number* - Bank Tab to edit. +- `name` + - *string* - New tab name. +- `icon` + - *number* - FileID of the new icon texture. + +**Reference:** +- `GetGuildBankTabInfo()` \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankTabPermissions.md b/wiki-information/functions/SetGuildBankTabPermissions.md new file mode 100644 index 00000000..5f59cce0 --- /dev/null +++ b/wiki-information/functions/SetGuildBankTabPermissions.md @@ -0,0 +1,20 @@ +## Title: SetGuildBankTabPermissions + +**Content:** +Modifies the permissions for a guild bank tab. +`SetGuildBankTabPermissions(tab, index, enabled)` + +**Parameters:** +- `tab` + - *number* - Bank Tab to edit. +- `index` + - *number* - Index of Permission to edit. +- `enabled` + - *boolean* - true or false to Enable or Disable permission. + +**Description:** +Use `GuildControlSetRank()` to set what rank you are editing permissions for. Will not save until `GuildControlSaveRank()` is called. + +Current Known Index Values: +- 1 = View Tab +- 2 = Deposit Item \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankText.md b/wiki-information/functions/SetGuildBankText.md new file mode 100644 index 00000000..ff3a00f4 --- /dev/null +++ b/wiki-information/functions/SetGuildBankText.md @@ -0,0 +1,22 @@ +## Title: SetGuildBankText + +**Content:** +Modifies info text for a tab. +`SetGuildBankText(tab, infoText)` + +**Parameters:** +- `tab` + - *number* - Bank Tab to edit. +- `infoText` + - *string* - Text to set, at most 2047 characters + +**Description:** +Although the function accepts up to 2047 characters, the standard interface displays only 500. + +**Reference:** +- `GetGuildBankText` + +**External Resources:** +- GitHub FrameXML +- GetheGlobe "wut?" Tool +- Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankWithdrawGoldLimit.md b/wiki-information/functions/SetGuildBankWithdrawGoldLimit.md new file mode 100644 index 00000000..9ac4564f --- /dev/null +++ b/wiki-information/functions/SetGuildBankWithdrawGoldLimit.md @@ -0,0 +1,12 @@ +## Title: SetGuildBankWithdrawGoldLimit + +**Content:** +Sets the gold withdraw limit for the guild bank. +`SetGuildBankWithdrawGoldLimit(amount)` + +**Parameters:** +- `amount` + - *number* - the amount of gold to withdraw per day + +**Description:** +Sets the value of the Gold Withdrawal field for the current rank (used for repairs and direct withdrawals). These changes are not saved until a call to `GuildControlSaveRank()` is made. In order to actually withdraw or use guild repairs, the flags for those actions must be set using `GuildControlSetRankFlag()`. \ No newline at end of file diff --git a/wiki-information/functions/SetGuildInfoText.md b/wiki-information/functions/SetGuildInfoText.md new file mode 100644 index 00000000..11343bb8 --- /dev/null +++ b/wiki-information/functions/SetGuildInfoText.md @@ -0,0 +1,9 @@ +## Title: SetGuildInfoText + +**Content:** +Sets the guild info text. +`SetGuildInfoText(text)` + +**Parameters:** +- `text` + - *string* - The text to set as the guild info. \ No newline at end of file diff --git a/wiki-information/functions/SetGuildRosterShowOffline.md b/wiki-information/functions/SetGuildRosterShowOffline.md new file mode 100644 index 00000000..47a6497f --- /dev/null +++ b/wiki-information/functions/SetGuildRosterShowOffline.md @@ -0,0 +1,33 @@ +## Title: SetGuildRosterShowOffline + +**Content:** +Sets the show offline guild members flag. +`SetGuildRosterShowOffline(enabled)` + +**Parameters:** +- `enabled` + - *boolean* - True includes all guild members; false filters out offline guild members. + +**Description:** +Triggers `GUILD_ROSTER_UPDATE` if filtering mode has changed -- facilitating a customary call to `GuildRoster()` if this event is registered. + +**Usage:** +```lua +-- Fetch updated info when required +local f = CreateFrame("Frame") +f:RegisterEvent("GUILD_ROSTER_UPDATE") +f:HookScript("OnEvent", function(event) + if (event == "GUILD_ROSTER_UPDATE") then + GuildRoster() + end +end) + +-- At some point later in your code... +SetGuildRosterShowOffline(false) +``` + +**Example Use Case:** +This function can be used in an addon to manage the display of guild members, ensuring that only online members are shown in the guild roster. This can be particularly useful for guild management addons that need to provide a clean and relevant list of active members. + +**Addons Using This Function:** +Large guild management addons like "Guild Roster Manager" use this function to toggle the visibility of offline members, providing a more streamlined interface for guild officers and members. \ No newline at end of file diff --git a/wiki-information/functions/SetInWorldUIVisibility.md b/wiki-information/functions/SetInWorldUIVisibility.md new file mode 100644 index 00000000..e1ed1766 --- /dev/null +++ b/wiki-information/functions/SetInWorldUIVisibility.md @@ -0,0 +1,12 @@ +## Title: SetInWorldUIVisibility + +**Content:** +Allows nameplates to be shown even while the UI is hidden. +`SetInWorldUIVisibility(visible)` + +**Parameters:** +- `visible` + - *boolean* + +**Description:** +Requires hiding the UI first with Alt-Z and then calling `SetInWorldUIVisibility(true)` in order for nameplates to appear. \ No newline at end of file diff --git a/wiki-information/functions/SetLFGComment.md b/wiki-information/functions/SetLFGComment.md new file mode 100644 index 00000000..107e8880 --- /dev/null +++ b/wiki-information/functions/SetLFGComment.md @@ -0,0 +1,12 @@ +## Title: SetLFGComment + +**Content:** +Sets the comment in the LFG browser. +`SetLFGComment(comment)` + +**Parameters:** +- `comment` + - *string* - The comment you want to use in the LFG interface. + +**Returns:** +- none \ No newline at end of file diff --git a/wiki-information/functions/SetLegacyRaidDifficultyID.md b/wiki-information/functions/SetLegacyRaidDifficultyID.md new file mode 100644 index 00000000..662f26f7 --- /dev/null +++ b/wiki-information/functions/SetLegacyRaidDifficultyID.md @@ -0,0 +1,11 @@ +## Title: SetLegacyRaidDifficultyID + +**Content:** +Needs summary. +`SetLegacyRaidDifficultyID(difficultyID)` + +**Parameters:** +- `difficultyID` + - *number* +- `force` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/SetLootThreshold.md b/wiki-information/functions/SetLootThreshold.md new file mode 100644 index 00000000..c566954a --- /dev/null +++ b/wiki-information/functions/SetLootThreshold.md @@ -0,0 +1,34 @@ +## Title: SetLootThreshold + +**Content:** +Sets the loot quality threshold for group/master loot. +`SetLootThreshold(threshold)` + +**Parameters:** +- `threshold` + - *number* - The loot quality to start using the current loot method with. + - **Value** + - **Description** + - `2` + - Uncommon + - `3` + - Rare + - `4` + - Epic + - `5` + - Legendary + - `6` + - Artifact + +**Description:** +This function throws an error with Poor (0) or Common (1) qualities, but it is possible to set these lower thresholds using `SetLootMethod()` with "master" as the first argument and 0 or 1 as the third. e.g. `SetLootMethod("master","player",1)` +Calling this while the loot method is changing will revert to the original loot method. To account for this, use `C_Timer.After()` to delay setting the threshold until a moment later. e.g. `C_Timer.After(1, function() SetLootMethod(2) end)` + +**Usage:** +If you are the party/raid leader, this script sets the loot threshold to Uncommon items or better and causes everyone to see a chat notice to this effect. +```lua +/run SetLootThreshold(2) +``` + +**Reference:** +`PARTY_LOOT_METHOD_CHANGED` \ No newline at end of file diff --git a/wiki-information/functions/SetMacroSpell.md b/wiki-information/functions/SetMacroSpell.md new file mode 100644 index 00000000..fd11434f --- /dev/null +++ b/wiki-information/functions/SetMacroSpell.md @@ -0,0 +1,23 @@ +## Title: SetMacroSpell + +**Content:** +Changes the spell used for dynamic feedback for a macro. +`SetMacroSpell(index, spell)` or `SetMacroSpell(name, spell)` + +**Parameters:** +- `index` + - *number* - Index of the macro, using the values 1-36 for the first page and 37-54 for the second. +- `name` + - *string* - Name of a macro. +- `spell` + - *string* - Localized name of a spell to assign. +- `target` + - *string* : UnitId - The unit to assign (for range indication). + +**Description:** +When assigned to an action button, macros can provide dynamic feedback such as range indication, cooldown, and charges/quantity remaining. +Normally, this dynamic feedback corresponds to the action that the macro will take; however, this function directs the macro to provide feedback based on a particular spell instead. +This only changes the visual cues appearing on the action buttons, but not the actual logic. Clicking an action button executes the macro as written. + +**Reference:** +`SetMacroItem` \ No newline at end of file diff --git a/wiki-information/functions/SetModifiedClick.md b/wiki-information/functions/SetModifiedClick.md new file mode 100644 index 00000000..aaffec75 --- /dev/null +++ b/wiki-information/functions/SetModifiedClick.md @@ -0,0 +1,21 @@ +## Title: SetModifiedClick + +**Content:** +Assigns the given modifier key to the given action. +`SetModifiedClick(action, key)` + +**Parameters:** +- `action` + - *string* - The action to set a key for. Actions defined by Blizzard: + - `AUTOLOOTTOGGLE`, `CHATLINK`, `COMPAREITEMS`, `DRESSUP`, `FOCUSCAST`, `OPENALLBAGS`, `PICKUPACTION`, `QUESTWATCHTOGGLE`, `SELFCAST`, `SHOWITEMFLYOUT`, `SOCKETITEM`, `SPLITSTACK`, `STICKYCAMERA`, `TOKENWATCHTOGGLE` +- `key` + - *string* - The key to assign. Must be one of: + - `ALT`, `CTRL`, `SHIFT`, `NONE` + +**Description:** +The game only provides user options for changing the `AUTOLOOTTOGGLE`, `FOCUSCAST`, and `SELFCAST` modifiers. All other modifiers are set to "SHIFT" by default, except for `DRESSUP` and `SOCKETITEM`, which are set to "CTRL". +An additional modifier `SHOWMULTICASTFLYOUT` exists, but was only used in the shaman totem UI, which was removed from the game in Patch 4.0.1. + +**Reference:** +- `IsModifiedClick` +- `SetModifiedClick` \ No newline at end of file diff --git a/wiki-information/functions/SetMoveEnabled.md b/wiki-information/functions/SetMoveEnabled.md new file mode 100644 index 00000000..62213568 --- /dev/null +++ b/wiki-information/functions/SetMoveEnabled.md @@ -0,0 +1,5 @@ +## Title: SetMoveEnabled + +**Content:** +Needs summary. +`SetMoveEnabled()` \ No newline at end of file diff --git a/wiki-information/functions/SetMultiCastSpell.md b/wiki-information/functions/SetMultiCastSpell.md new file mode 100644 index 00000000..820b1463 --- /dev/null +++ b/wiki-information/functions/SetMultiCastSpell.md @@ -0,0 +1,38 @@ +## Title: SetMultiCastSpell + +**Content:** +Sets the totem spell for a specific totem bar slot. +`SetMultiCastSpell(actionID, spellID)` + +**Parameters:** +- `actionID` + - *number* - The totem bar slot number. + - Call of the... + - Totem slot + - Fire + - Earth + - Water + - Air + - Elements + - 133 + - 134 + - 135 + - 136 + - Ancestors + - 137 + - 138 + - 139 + - 140 + - Spirits + - 141 + - 142 + - 143 + - 144 +- `spellId` + - *number* - The global spell number, found on Wowhead or through COMBAT_LOG_EVENT. + +**Usage:** +`SetMultiCastSpell(134, 2484)` + +**Result:** +Sets on . \ No newline at end of file diff --git a/wiki-information/functions/SetOptOutOfLoot.md b/wiki-information/functions/SetOptOutOfLoot.md new file mode 100644 index 00000000..b8518389 --- /dev/null +++ b/wiki-information/functions/SetOptOutOfLoot.md @@ -0,0 +1,18 @@ +## Title: SetOptOutOfLoot + +**Content:** +Sets whether to automatically pass on all loot. +`SetOptOutOfLoot(optOut)` + +**Parameters:** +- `optOut` + - *boolean* - 1 to make the player pass on all loot, nil otherwise. + +**Reference:** +- `GetOptOutOfLoot` + +**Example Usage:** +This function can be used in a scenario where a player wants to ensure they do not receive any loot, perhaps during a raid where they are not interested in the drops or to avoid conflicts over loot distribution. + +**Addon Usage:** +Large addons like "ElvUI" or "DBM" might use this function to provide users with an option to automatically pass on loot, streamlining the looting process during raids or dungeons. \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBinding.md b/wiki-information/functions/SetOverrideBinding.md new file mode 100644 index 00000000..207b341a --- /dev/null +++ b/wiki-information/functions/SetOverrideBinding.md @@ -0,0 +1,34 @@ +## Title: SetOverrideBinding + +**Content:** +Sets an override key binding. +`SetOverrideBinding(owner, isPriority, key, command)` + +**Parameters:** +- `owner` + - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. +- `isPriority` + - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. +- `key` + - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" +- `command` + - *String/nil* - Any name attribute value of a Bindings.xml-defined binding, or an action command string; nil to remove an override binding. For example: + - `"SITORSTAND"` : a Bindings.xml-defined binding to toggle between sitting and standing + - `"CLICK PlayerFrame:LeftButton"` : Fire a left-click on the PlayerFrame. + - `"SPELL Bloodrage"` : Cast Bloodrage. + - `"ITEM Hearthstone"` : Use Hearthstone. + - `"MACRO Foo"` : Run a macro called "Foo" + - `"MACRO 1"` : Run a macro with index 1. +- `mode` + - *number* - 1 if the binding should be saved to the currently loaded binding set (default), or 2 if to the alternative. + +**Description:** +Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. +Override bindings are never saved, and will be wiped by an interface reload. + +**Reference:** +- `SetOverrideBindingSpell` +- `SetOverrideBindingItem` +- `SetOverrideBindingMacro` +- `SetOverrideBindingClick` +- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingClick.md b/wiki-information/functions/SetOverrideBindingClick.md new file mode 100644 index 00000000..9c602d1c --- /dev/null +++ b/wiki-information/functions/SetOverrideBindingClick.md @@ -0,0 +1,38 @@ +## Title: SetOverrideBindingClick + +**Content:** +Sets an override binding that performs a button click. +`SetOverrideBindingClick(owner, isPriority, key, buttonName)` + +**Parameters:** +- `owner` + - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. +- `isPriority` + - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. +- `key` + - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" +- `buttonName` + - *string* - Name of the button widget this binding should fire a click event for. +- `mouseClick` + - *string* - Mouse button name argument passed to the OnClick handlers. + +**Description:** +Override bindings take precedence over the normal `SetBinding` bindings. Priority override bindings take precedence over non-priority override bindings. +Override bindings are never saved, and will be wiped by an interface reload. +You cannot use this function to clear an override binding; use `SetOverrideBinding` instead. + +**Reference:** +- `SetOverrideBinding` +- `SetOverrideBindingSpell` +- `SetOverrideBindingItem` +- `SetOverrideBindingMacro` +- `ClearOverrideBindings` + +**Example Usage:** +```lua +-- Example of setting an override binding to click a button named "MyButton" when the "Q" key is pressed +SetOverrideBindingClick(MyFrame, true, "Q", "MyButton") +``` + +**Addons Using This Function:** +Many large addons, such as Bartender4 and ElvUI, use this function to provide custom key bindings for their action bars and other interactive elements. This allows users to have more flexible and dynamic control over their UI interactions. \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingItem.md b/wiki-information/functions/SetOverrideBindingItem.md new file mode 100644 index 00000000..0a4e4c0f --- /dev/null +++ b/wiki-information/functions/SetOverrideBindingItem.md @@ -0,0 +1,27 @@ +## Title: SetOverrideBindingItem + +**Content:** +Creates an override binding that uses an item when triggered. +`SetOverrideBindingItem(owner, isPriority, key, item)` + +**Parameters:** +- `owner` + - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. +- `isPriority` + - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. +- `key` + - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" +- `item` + - *string* - Name or item link of the item to use when binding is triggered. + +**Description:** +Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. +Override bindings are never saved, and will be wiped by an interface reload. +You cannot use this function to clear an override binding; use SetOverrideBinding instead. + +**Reference:** +- `SetOverrideBinding` +- `SetOverrideBindingSpell` +- `SetOverrideBindingClick` +- `SetOverrideBindingMacro` +- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingMacro.md b/wiki-information/functions/SetOverrideBindingMacro.md new file mode 100644 index 00000000..c109134a --- /dev/null +++ b/wiki-information/functions/SetOverrideBindingMacro.md @@ -0,0 +1,27 @@ +## Title: SetOverrideBindingMacro + +**Content:** +Creates an override binding that runs a macro. +`SetOverrideBindingMacro(owner, isPriority, key, macro)` + +**Parameters:** +- `owner` + - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. +- `isPriority` + - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. +- `key` + - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" +- `macro` + - *string* - Name or index of the macro to run. + +**Description:** +Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. +Override bindings are never saved, and will be wiped by an interface reload. +You cannot use this function to clear an override binding; use SetOverrideBinding instead. + +**Reference:** +- `SetOverrideBinding` +- `SetOverrideBindingSpell` +- `SetOverrideBindingItem` +- `SetOverrideBindingClick` +- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingSpell.md b/wiki-information/functions/SetOverrideBindingSpell.md new file mode 100644 index 00000000..ec84ecb6 --- /dev/null +++ b/wiki-information/functions/SetOverrideBindingSpell.md @@ -0,0 +1,27 @@ +## Title: SetOverrideBindingSpell + +**Content:** +Creates an override binding that casts a spell. +`SetOverrideBindingSpell(owner, isPriority, key, spell)` + +**Parameters:** +- `owner` + - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. +- `isPriority` + - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. +- `key` + - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5". +- `spell` + - *string* - Name of the spell you want to cast when this binding is triggered. + +**Description:** +Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. +Override bindings are never saved, and will be wiped by an interface reload. +You cannot use this function to clear an override binding; use SetOverrideBinding instead. + +**Reference:** +- `SetOverrideBinding` +- `SetOverrideBindingClick` +- `SetOverrideBindingItem` +- `SetOverrideBindingMacro` +- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetPVP.md b/wiki-information/functions/SetPVP.md new file mode 100644 index 00000000..8d006d8c --- /dev/null +++ b/wiki-information/functions/SetPVP.md @@ -0,0 +1,13 @@ +## Title: SetPVP + +**Content:** +Sets the player's PvP flag. +`SetPVP(flag)` + +**Parameters:** +- `flag` + - *number* + +**Description:** +`TogglePVP()` is equivalent to `SetPVP(not GetPVPDesired())`. +This setting is different from war mode. \ No newline at end of file diff --git a/wiki-information/functions/SetPVPRoles.md b/wiki-information/functions/SetPVPRoles.md new file mode 100644 index 00000000..d88e668b --- /dev/null +++ b/wiki-information/functions/SetPVPRoles.md @@ -0,0 +1,18 @@ +## Title: SetPVPRoles + +**Content:** +Sets which roles the player is willing to perform in PvP battlegrounds. +`SetPVPRoles(tank, healer, dps)` + +**Parameters:** +- `tank` + - *boolean* - true if the player is willing to tank, false otherwise. +- `healer` + - *boolean* - true if the player is willing to heal, false otherwise. +- `dps` + - *boolean* - true if the player is willing to deal damage, false otherwise. + +**Reference:** +- `PVP_ROLE_UPDATE` +- See also: + - `GetPVPRoles` \ No newline at end of file diff --git a/wiki-information/functions/SetPendingReportPetTarget.md b/wiki-information/functions/SetPendingReportPetTarget.md new file mode 100644 index 00000000..bd79334b --- /dev/null +++ b/wiki-information/functions/SetPendingReportPetTarget.md @@ -0,0 +1,13 @@ +## Title: C_ReportSystem.SetPendingReportPetTarget + +**Content:** +Report a pet for an inappropriate name. +`set = C_ReportSystem.SetPendingReportPetTarget()` + +**Parameters:** +- `target` + - *string?* : UnitId - defaults to "target". + +**Returns:** +- `set` + - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/SetPendingReportTarget.md b/wiki-information/functions/SetPendingReportTarget.md new file mode 100644 index 00000000..0ce8043c --- /dev/null +++ b/wiki-information/functions/SetPendingReportTarget.md @@ -0,0 +1,20 @@ +## Title: C_ReportSystem.SetPendingReportTarget + +**Content:** +Populates the reporting window with details about a target player. +`set = C_ReportSystem.SetPendingReportTarget()` +`set = C_ReportSystem.SetPendingReportTargetByGuid()` + +**Parameters:** + +*SetPendingReportTarget:* +- `target` + - *string?* : UnitId - defaults to "target" + +*SetPendingReportTargetByGuid:* +- `guid` + - *string?* : GUID + +**Returns:** +- `set` + - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/SetPetStablePaperdoll.md b/wiki-information/functions/SetPetStablePaperdoll.md new file mode 100644 index 00000000..a1b097d7 --- /dev/null +++ b/wiki-information/functions/SetPetStablePaperdoll.md @@ -0,0 +1,15 @@ +## Title: SetPetStablePaperdoll + +**Content:** +Sets the paperdoll model in the pet stable to a new player model. +`SetPetStablePaperdoll(modelObject)` + +**Parameters:** +- `modelObject` + - *PlayerModel* - The model of the pet to display. + +**Returns:** +- None + +**Description:** +This method does not cause the model to be shown. The model still needs its `Show()` method called afterward. \ No newline at end of file diff --git a/wiki-information/functions/SetPortraitTexture.md b/wiki-information/functions/SetPortraitTexture.md new file mode 100644 index 00000000..371803d4 --- /dev/null +++ b/wiki-information/functions/SetPortraitTexture.md @@ -0,0 +1,26 @@ +## Title: SetPortraitTexture + +**Content:** +Sets a texture to a unit's 2D portrait. +`SetPortraitTexture(textureObject, unitToken)` + +**Parameters:** +- `textureObject` + - *Texture* - The texture object to set the portrait on. +- `unitToken` + - *string* - UnitToken representing the unit whose portrait is to be set. +- `disableMasking` + - *boolean?* - Optional parameter, defaults to `false`. + +**Usage:** +```lua +local f = CreateFrame("Frame") +f:SetPoint("CENTER") +f:SetSize(64, 64) +f.tex = f:CreateTexture() +f.tex:SetAllPoints(f) +SetPortraitTexture(f.tex, "player") +``` + +**Example Use Case:** +This function is commonly used in creating custom unit frames or UI elements that display character portraits. For instance, many unit frame addons like "Shadowed Unit Frames" or "PitBull Unit Frames" use this function to set the portrait textures for player, target, and party frames. \ No newline at end of file diff --git a/wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md b/wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md new file mode 100644 index 00000000..6ddeb377 --- /dev/null +++ b/wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md @@ -0,0 +1,11 @@ +## Title: SetPortraitTextureFromCreatureDisplayID + +**Content:** +Needs summary. +`SetPortraitTextureFromCreatureDisplayID(textureObject, creatureDisplayID)` + +**Parameters:** +- `textureObject` + - *widget* : Texture +- `creatureDisplayID` + - *number* : CreatureDisplayID \ No newline at end of file diff --git a/wiki-information/functions/SetPortraitToTexture.md b/wiki-information/functions/SetPortraitToTexture.md new file mode 100644 index 00000000..122707c5 --- /dev/null +++ b/wiki-information/functions/SetPortraitToTexture.md @@ -0,0 +1,28 @@ +## Title: SetPortraitToTexture + +**Content:** +Applies a circular mask to a texture, making it resemble a portrait. +`SetPortraitToTexture(texture, path)` + +**Parameters:** +- `texture` + - *Texture* +- `path` + - *string|number* : fileID + +**Description:** +This function only accepts texture assets that have dimensions of 64x64 or smaller. Larger textures will raise a "Texture is not 64x64 pixels" error. +For larger textures, consider instead using MaskTexture objects which do not suffer from this same limitation. + +**Usage:** +```lua +local f = CreateFrame("Frame") +f:SetPoint("CENTER") +f:SetSize(64, 64) +f.tex = f:CreateTexture() +f.tex:SetAllPoints(f) +SetPortraitToTexture(f.tex, "interface/icons/inv_mushroom_11") +``` + +**Reference:** +- MaskTexture \ No newline at end of file diff --git a/wiki-information/functions/SetRaidDifficultyID.md b/wiki-information/functions/SetRaidDifficultyID.md new file mode 100644 index 00000000..91ee4a33 --- /dev/null +++ b/wiki-information/functions/SetRaidDifficultyID.md @@ -0,0 +1,24 @@ +## Title: SetRaidDifficultyID + +**Content:** +Sets the raid difficulty. +`SetRaidDifficultyID(difficultyIndex)` + +**Parameters:** +- `difficultyIndex` + - *number* + - 3 → 10 Player + - 4 → 25 Player + - 5 → 10 Player (Heroic) + - 6 → 25 Player (Heroic) + - 14 → Normal + - 15 → Heroic + - 16 → Mythic + +**Description:** +When the change occurs, a message will be displayed in the default chat frame. +Example: `/script SetRaidDifficultyID(16);` sets the raid difficulty to Mythic + +**Reference:** +- `GetRaidDifficultyID` +- `difficultyIndex` \ No newline at end of file diff --git a/wiki-information/functions/SetRaidTarget.md b/wiki-information/functions/SetRaidTarget.md new file mode 100644 index 00000000..434fbfe0 --- /dev/null +++ b/wiki-information/functions/SetRaidTarget.md @@ -0,0 +1,48 @@ +## Title: SetRaidTarget + +**Content:** +Assigns a raid target icon to a unit. +`SetRaidTarget(unit, index)` + +**Parameters:** +- `unit` + - *string* : UnitId +- `index` + - *number* - Raid target index to assign to the specified unit: + - `Value` + - `Icon` + - `1` - Yellow 4-point Star + - `2` - Orange Circle + - `3` - Purple Diamond + - `4` - Green Triangle + - `5` - White Crescent Moon + - `6` - Blue Square + - `7` - Red "X" Cross + - `8` - White Skull + +**Description:** +The icons are only visible to your group. In a 5-man party, all party members may assign raid icons. In a raid, only the raid leader and the assistants may do so. +This API toggles the icon if it's already assigned to the unit. +Units can only be assigned one icon at a time; and each icon can only be assigned to one unit at a time. + +**Related API:** +- `GetRaidTargetIndex` + +**Related Events:** +- `RAID_TARGET_UPDATE` + +**Related FrameXML:** +- `SetRaidTargetIcon` + +**Usage:** +To set a skull over your current target: +```lua +/run SetRaidTarget("target", 8) +``` +Without toggling behavior: +```lua +/run if GetRaidTargetIndex("target") ~= 8 then SetRaidTarget("target", 8) end +``` + +**Reference:** +- `RaidFlag` \ No newline at end of file diff --git a/wiki-information/functions/SetScreenResolution.md b/wiki-information/functions/SetScreenResolution.md new file mode 100644 index 00000000..c16496ff --- /dev/null +++ b/wiki-information/functions/SetScreenResolution.md @@ -0,0 +1,27 @@ +## Title: SetScreenResolution + +**Content:** +Returns the index of the current resolution in effect +`SetScreenResolution()` + +**Parameters:** +- `index` + - *number?* - This value specifies the new screen resolution, it must be the index of one of the values yielded by `GetScreenResolutions()`. Passing `nil` will default this argument to 1, the lowest resolution available. + +**Usage:** +This sets the screen to 1024x768, if available: +```lua +local resolutions = {GetScreenResolutions()} +for i, entry in resolutions do + if entry == '1024x768' then + SetScreenResolution(i) + break + end +end +``` + +**Example Use Case:** +This function can be used in addons or scripts that need to change the screen resolution programmatically, such as during the initial setup of a game environment or when providing users with a custom settings interface. + +**Addons:** +While not commonly used in large addons due to the potential disruption of changing screen resolution, it might be found in configuration tools or setup wizards that aim to optimize the game settings for the user's hardware. \ No newline at end of file diff --git a/wiki-information/functions/SetSelectedBattlefield.md b/wiki-information/functions/SetSelectedBattlefield.md new file mode 100644 index 00000000..850160bf --- /dev/null +++ b/wiki-information/functions/SetSelectedBattlefield.md @@ -0,0 +1,9 @@ +## Title: SetSelectedBattlefield + +**Content:** +Selects a battlefield instance at the battlemaster. +`SetSelectedBattlefield(index)` + +**Parameters:** +- `index` + - *number* - The index in the battlemaster listing. \ No newline at end of file diff --git a/wiki-information/functions/SetSelectedSkill.md b/wiki-information/functions/SetSelectedSkill.md new file mode 100644 index 00000000..80219119 --- /dev/null +++ b/wiki-information/functions/SetSelectedSkill.md @@ -0,0 +1,9 @@ +## Title: SetSelectedSkill + +**Content:** +Selects a skill line in the skill window. +`SetSelectedSkill(index)` + +**Parameters:** +- `index` + - *number* - The index of a line in the skills window. Does nothing when used on a header. \ No newline at end of file diff --git a/wiki-information/functions/SetSuperTrackedQuestID.md b/wiki-information/functions/SetSuperTrackedQuestID.md new file mode 100644 index 00000000..aca9ceb6 --- /dev/null +++ b/wiki-information/functions/SetSuperTrackedQuestID.md @@ -0,0 +1,9 @@ +## Title: C_SuperTrack.SetSuperTrackedQuestID + +**Content:** +Changes the quest ID actively being tracked. Replaces `SetSuperTrackedQuestID`. +`C_SuperTrack.SetSuperTrackedQuestID(questID)` + +**Parameters:** +- `questID` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/SetTalentGroupRole.md b/wiki-information/functions/SetTalentGroupRole.md new file mode 100644 index 00000000..121bde5e --- /dev/null +++ b/wiki-information/functions/SetTalentGroupRole.md @@ -0,0 +1,23 @@ +## Title: SetTalentGroupRole + +**Content:** +Sets the role for a player talent group (primary or secondary). +`SetTalentGroupRole(groupIndex, role)` + +**Parameters:** +- `groupIndex` + - *number* - Ranging from 1 to 2 (primary/secondary talent group). To get the current one use `GetActiveTalentGroup()` +- `role` + - *string* - Can be `DAMAGER`, `TANK`, or `HEALER`. If an invalid role is given, it defaults to `DAMAGER`. + +**Example Usage:** +```lua +-- Set the primary talent group to the role of TANK +SetTalentGroupRole(1, "TANK") + +-- Set the secondary talent group to the role of HEALER +SetTalentGroupRole(2, "HEALER") +``` + +**Additional Information:** +This function is particularly useful in addons that manage talent builds and roles, such as `Talent Set Manager` or `Action Bar Saver`. These addons often allow players to quickly switch between different talent setups and corresponding roles, optimizing their performance for different types of content (e.g., dungeons, raids, PvP). \ No newline at end of file diff --git a/wiki-information/functions/SetTaxiMap.md b/wiki-information/functions/SetTaxiMap.md new file mode 100644 index 00000000..d7f771e1 --- /dev/null +++ b/wiki-information/functions/SetTaxiMap.md @@ -0,0 +1,12 @@ +## Title: SetTaxiMap + +**Content:** +Sets the texture to use for the taxi map. +`SetTaxiMap(texture)` + +**Parameters:** +- `texture` + - *string* - The path to the texture to use for the taxi map. + +**Returns:** +- `nil` \ No newline at end of file diff --git a/wiki-information/functions/SetTracking.md b/wiki-information/functions/SetTracking.md new file mode 100644 index 00000000..62c58cd6 --- /dev/null +++ b/wiki-information/functions/SetTracking.md @@ -0,0 +1,23 @@ +## Title: SetTracking + +**Content:** +Sets a minimap tracking method. +`SetTracking(id, enabled)` + +**Parameters:** +- `id` + - The id of the tracking you would like to change. The id is assigned by the client, 1 is the first tracking method available on the tracking list, 2 is the next and so on. To get information about a specific id, use `GetTrackingInfo`. +- `enabled` + - *boolean* - flag if the specified tracking id is to be enabled or disabled. + +**Usage:** +Enables the first tracking method on the list: +```lua +SetTracking(1, true) +``` + +**Example Use Case:** +This function can be used in addons that manage or enhance the minimap tracking features. For instance, an addon that automatically switches tracking types based on the player's current activities (e.g., switching to herb tracking when the player is in a zone with many herbs). + +**Addons Using This Function:** +Many popular addons like "GatherMate2" use this function to help players track resources more efficiently by automatically enabling and disabling tracking types based on the player's needs. \ No newline at end of file diff --git a/wiki-information/functions/SetTradeMoney.md b/wiki-information/functions/SetTradeMoney.md new file mode 100644 index 00000000..b54c38a3 --- /dev/null +++ b/wiki-information/functions/SetTradeMoney.md @@ -0,0 +1,19 @@ +## Title: SetTradeMoney + +**Content:** +Sets the amount of money offered as part of the player's trade offer. +`SetTradeMoney(copper)` + +**Parameters:** +- `copper` + - *number* - Amount of money, in copper, to offer for trade. + +**Usage:** +The following will put 1 gold into the trade window: +```lua +SetTradeMoney(1 * 100 * 100); +``` + +**Reference:** +- `PickupTradeMoney` +- `AddTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/SetTradeSkillItemLevelFilter.md b/wiki-information/functions/SetTradeSkillItemLevelFilter.md new file mode 100644 index 00000000..8da883b4 --- /dev/null +++ b/wiki-information/functions/SetTradeSkillItemLevelFilter.md @@ -0,0 +1,42 @@ +## Title: SetTradeSkillItemLevelFilter + +**Content:** +Sets a filter on the open recipe list window based on minimum level to use. +`nil = SetTradeSkillItemLevelFilter(minLevel, maxLevel)` + +**Parameters:** +- `minLevel` + - *number* - minimum level to pass filter +- `maxLevel` + - *number* - maximum level to pass filter + +**Usage:** +```lua +CloseTradeSkill(); +CastSpellByName("Alchemy"); +SetTradeSkillItemLevelFilter(35, 36); +minLevel, maxLevel = GetTradeSkillItemLevelFilter(); +print(type(minLevel), minLevel, type(maxLevel), maxLevel) +-- Result +-- number 35 number 36 +-- And the recipe list window will be filtered thus: +-- Elixir +-- Elixir of Detect Undead +-- Elixir of Greater Water Breathing +-- Potion +-- Dreamless Sleep Potion +-- Superior Healing Potion +-- Miscellaneous +-- Philosopher's Stone +-- Each of these items require level 35 to use except the Elixir of Detect Undead which requires level 36. +``` + +**Description:** +Opening a new tradeskill window resets the filter to 0, 0. Closing and re-opening the same tradeskill's window does not reset the filter. +- `minLevel` + - 0 removes the lower end of the filter. + - -1 seems to do nothing. + - 1 for Inscription filters out inks, and all First Aid skills. +- `maxLevel` + - 0 removes the higher end of the filter. + - -1 seems to filter everything out. \ No newline at end of file diff --git a/wiki-information/functions/SetTradeSkillSubClassFilter.md b/wiki-information/functions/SetTradeSkillSubClassFilter.md new file mode 100644 index 00000000..8e980ea5 --- /dev/null +++ b/wiki-information/functions/SetTradeSkillSubClassFilter.md @@ -0,0 +1,23 @@ +## Title: SetTradeSkillSubClassFilter + +**Content:** +Sets the subclass filter. +`SetTradeSkillSubClassFilter(slotIndex, onOff{, exclusive})` + +**Parameters:** +- `slotIndex` + - The index of the specific slot +- `onOff` + - On = 1, Off = 0 +- `exclusive` (Optional) + - Sets if the slot is the only slot to be selected. If not set it's handled as Off. On = 1, Off = 0 + +**Usage:** +Sets the filter to select slotIndex 3 and 5. First slotIndex have to be exclusive enabled. +```lua +SetTradeSkillSubClassFilter(3, 1, 1); +SetTradeSkillSubClassFilter(5, 1); +``` + +**Reference:** +- `GetTradeSkillSubClassFilter` \ No newline at end of file diff --git a/wiki-information/functions/SetTrainerServiceTypeFilter.md b/wiki-information/functions/SetTrainerServiceTypeFilter.md new file mode 100644 index 00000000..d89fb3d4 --- /dev/null +++ b/wiki-information/functions/SetTrainerServiceTypeFilter.md @@ -0,0 +1,30 @@ +## Title: SetTrainerServiceTypeFilter + +**Content:** +Sets the status of a skill filter in the trainer window. +`SetTrainerServiceTypeFilter(type, status)` + +**Parameters:** +- `type` + - *string* - filter to set the status for: + - `"available"` (can learn) + - `"unavailable"` (can't learn) + - `"used"` (already known) +- `status` + - *Flag* - 1 to show, 0 to hide items matching the specified filter. (Note that this is likely a bug as GetTrainerServiceTypeFilter returns a boolean now.) +- `exclusive` + - *?* - ? + +**Example Usage:** +```lua +-- Show only the skills that are available to learn +SetTrainerServiceTypeFilter("available", 1) +-- Hide the skills that are already known +SetTrainerServiceTypeFilter("used", 0) +``` + +**Description:** +This function is used to control the visibility of different types of skills in the trainer window. It allows you to filter skills based on whether they are available to learn, unavailable, or already known. This can be particularly useful for customizing the trainer interface to show only relevant skills. + +**Usage in Addons:** +Large addons like TradeSkillMaster (TSM) may use this function to filter out skills that are not relevant to the user, thereby providing a cleaner and more focused interface. For example, TSM might hide skills that are already known to avoid cluttering the trainer window. \ No newline at end of file diff --git a/wiki-information/functions/SetTurnEnabled.md b/wiki-information/functions/SetTurnEnabled.md new file mode 100644 index 00000000..ba614ec7 --- /dev/null +++ b/wiki-information/functions/SetTurnEnabled.md @@ -0,0 +1,5 @@ +## Title: SetTurnEnabled + +**Content:** +Needs summary. +`SetTurnEnabled()` \ No newline at end of file diff --git a/wiki-information/functions/SetUIVisibility.md b/wiki-information/functions/SetUIVisibility.md new file mode 100644 index 00000000..c87e71f5 --- /dev/null +++ b/wiki-information/functions/SetUIVisibility.md @@ -0,0 +1,9 @@ +## Title: SetUIVisibility + +**Content:** +Needs summary. +`SetUIVisibility(visible)` + +**Parameters:** +- `visible` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/SetUnitCursorTexture.md b/wiki-information/functions/SetUnitCursorTexture.md new file mode 100644 index 00000000..af83f6ea --- /dev/null +++ b/wiki-information/functions/SetUnitCursorTexture.md @@ -0,0 +1,26 @@ +## Title: SetUnitCursorTexture + +**Content:** +Needs summary. +`hasCursor = SetUnitCursorTexture(textureObject, unit)` + +**Parameters:** +- `textureObject` + - *Unknown* +- `unit` + - *string* +- `style` + - *Enum.CursorStyle?* + - `Value` + - `Field` + - `Description` + - `0` + - Mouse + - `1` + - Crosshair +- `includeLowPriority` + - *boolean?* + +**Returns:** +- `hasCursor` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/SetView.md b/wiki-information/functions/SetView.md new file mode 100644 index 00000000..33bd406d --- /dev/null +++ b/wiki-information/functions/SetView.md @@ -0,0 +1,14 @@ +## Title: SetView + +**Content:** +Sets the camera to a predefined camera position (1-5). +`SetView(viewIndex)` + +**Parameters:** +- `viewIndex` + - *number* - The view index (1-5) to return to (1 is always first person, and cannot be saved with SaveView) + +**Description:** +If SaveView has not previously been used on the view index, then your camera will be set to a preset position and angle. +The first view index defaults to first person. +The last position loaded is stored in the CVar `cameraView`. \ No newline at end of file diff --git a/wiki-information/functions/SetWatchedFactionIndex.md b/wiki-information/functions/SetWatchedFactionIndex.md new file mode 100644 index 00000000..db43e1e9 --- /dev/null +++ b/wiki-information/functions/SetWatchedFactionIndex.md @@ -0,0 +1,12 @@ +## Title: SetWatchedFactionIndex + +**Content:** +Watches a faction in the reputation window. +`SetWatchedFactionIndex(index)` + +**Parameters:** +- `index` + - *number* - The index of the faction to watch, ascending from 1; out-of-range values will clear the watched faction. + +**Reference:** +- `GetWatchedFactionInfo` \ No newline at end of file diff --git a/wiki-information/functions/SetupFullscreenScale.md b/wiki-information/functions/SetupFullscreenScale.md new file mode 100644 index 00000000..07cd73fa --- /dev/null +++ b/wiki-information/functions/SetupFullscreenScale.md @@ -0,0 +1,9 @@ +## Title: SetupFullscreenScale + +**Content:** +Sizes a frame to take up the entire screen regardless of screen resolution. +`SetupFullscreenScale(frame)` + +**Parameters:** +- `frame` + - The frame to manipulate. \ No newline at end of file diff --git a/wiki-information/functions/ShiftQuestWatches.md b/wiki-information/functions/ShiftQuestWatches.md new file mode 100644 index 00000000..55f1aa9e --- /dev/null +++ b/wiki-information/functions/ShiftQuestWatches.md @@ -0,0 +1,12 @@ +## Title: ShiftQuestWatches + +**Content:** +Exchanges the order of two watched quests. +`ShiftQuestWatches(id1, id2)` + +**Parameters:** +- `id1`, `id2` + - *Number* - Indices of the quest watches (ascending from 1 to the number of currently watched quests) to exchange positions of. + +**Description:** +Related API: `SortQuestWatches` \ No newline at end of file diff --git a/wiki-information/functions/ShowBossFrameWhenUninteractable.md b/wiki-information/functions/ShowBossFrameWhenUninteractable.md new file mode 100644 index 00000000..c68e7eee --- /dev/null +++ b/wiki-information/functions/ShowBossFrameWhenUninteractable.md @@ -0,0 +1,19 @@ +## Title: ShowBossFrameWhenUninteractable + +**Content:** +Needs summary. +`show = ShowBossFrameWhenUninteractable(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `show` + - *boolean* + +**Example Usage:** +This function can be used to determine whether the boss frame should be shown for a given unit when it is uninteractable. This can be useful in scenarios where you need to manage UI elements based on the interactability of boss units. + +**Addons:** +While specific large addons using this function are not well-documented, it is likely used in raid and boss encounter addons to manage the display of boss frames dynamically based on the unit's state. \ No newline at end of file diff --git a/wiki-information/functions/ShowCloak.md b/wiki-information/functions/ShowCloak.md new file mode 100644 index 00000000..e0561b75 --- /dev/null +++ b/wiki-information/functions/ShowCloak.md @@ -0,0 +1,18 @@ +## Title: ShowCloak + +**Content:** +Enables or disables display of your cloak. +`ShowCloak(flag)` + +**Parameters:** +- `flag` + - *boolean* - whether the cloak should be shown + +**Usage:** +Toggles displaying your cloak. +```lua +/run ShowCloak(not ShowingCloak()) +``` + +**Reference:** +- `ShowingCloak()` \ No newline at end of file diff --git a/wiki-information/functions/ShowHelm.md b/wiki-information/functions/ShowHelm.md new file mode 100644 index 00000000..bf7ee0f7 --- /dev/null +++ b/wiki-information/functions/ShowHelm.md @@ -0,0 +1,18 @@ +## Title: ShowHelm + +**Content:** +Enables or disables display of your helm. +`ShowHelm(flag)` + +**Parameters:** +- `flag` + - *boolean* - whether the helm should be shown + +**Usage:** +Toggles displaying your helm. +```lua +/run ShowHelm(not ShowingHelm()) +``` + +**Reference:** +- `ShowingHelm()` \ No newline at end of file diff --git a/wiki-information/functions/ShowQuestComplete.md b/wiki-information/functions/ShowQuestComplete.md new file mode 100644 index 00000000..5ee8831c --- /dev/null +++ b/wiki-information/functions/ShowQuestComplete.md @@ -0,0 +1,15 @@ +## Title: ShowQuestComplete + +**Content:** +Shows the completion dialog for a complete, auto-completable quest. +`ShowQuestComplete(questID)` + +**Parameters:** +- `questID` + - *number* - id of the quest which is complete and auto-completable. + +**Reference:** +- `QUEST_COMPLETE`, when completion/reward information is available. + +**Description:** +Auto-completable quests can be turned in anywhere in the world, instead of requiring interaction with a specific NPC. \ No newline at end of file diff --git a/wiki-information/functions/ShowRepairCursor.md b/wiki-information/functions/ShowRepairCursor.md new file mode 100644 index 00000000..cb610126 --- /dev/null +++ b/wiki-information/functions/ShowRepairCursor.md @@ -0,0 +1,17 @@ +## Title: ShowRepairCursor + +**Content:** +Puts the cursor in repair mode. +`ShowRepairCursor()` + +**Parameters:** +- None + +**Returns:** +- `nil` + +**Example Usage:** +This function can be used in an addon to change the cursor to repair mode when interacting with a repair vendor or when the player wants to repair items in their inventory. + +**Addons Using This Function:** +Many inventory management addons, such as Bagnon or ArkInventory, may use this function to facilitate the repair process directly from the inventory interface. \ No newline at end of file diff --git a/wiki-information/functions/ShowingCloak.md b/wiki-information/functions/ShowingCloak.md new file mode 100644 index 00000000..4b1a761d --- /dev/null +++ b/wiki-information/functions/ShowingCloak.md @@ -0,0 +1,18 @@ +## Title: ShowingCloak + +**Content:** +Returns if the player is showing his cloak. +`isShowingCloak = ShowingCloak()` + +**Returns:** +- `isShowingCloak` + - *boolean* + +**Usage:** +Toggles displaying your cloak. +```lua +/run ShowCloak(not ShowingCloak()) +``` + +**Reference:** +- `ShowCloak()` \ No newline at end of file diff --git a/wiki-information/functions/ShowingHelm.md b/wiki-information/functions/ShowingHelm.md new file mode 100644 index 00000000..78cbce5a --- /dev/null +++ b/wiki-information/functions/ShowingHelm.md @@ -0,0 +1,18 @@ +## Title: ShowingHelm + +**Content:** +Returns if the player is showing his helm. +`isShowingHelm = ShowingHelm()` + +**Returns:** +- `isShowingHelm` + - *boolean* + +**Usage:** +Toggles displaying your helm. +```lua +/run ShowHelm(not ShowingHelm()) +``` + +**Reference:** +`ShowHelm()` \ No newline at end of file diff --git a/wiki-information/functions/SitStandOrDescendStart.md b/wiki-information/functions/SitStandOrDescendStart.md new file mode 100644 index 00000000..4e461595 --- /dev/null +++ b/wiki-information/functions/SitStandOrDescendStart.md @@ -0,0 +1,8 @@ +## Title: SitStandOrDescendStart + +**Content:** +Makes the player sit, stand, or descend (while swimming or flying). +`SitStandOrDescendStart()` + +**Description:** +You can use `DoEmote("STAND")` / `DoEmote("SIT")` to accomplish what this API did prior to being protected. \ No newline at end of file diff --git a/wiki-information/functions/SortAuctionSetSort.md b/wiki-information/functions/SortAuctionSetSort.md new file mode 100644 index 00000000..cdc3f7c8 --- /dev/null +++ b/wiki-information/functions/SortAuctionSetSort.md @@ -0,0 +1,24 @@ +## Title: SortAuctionSetSort + +**Content:** +Sets the column by which the auction house sorts query results. This applies after the next search query or call to `SortAuctionApplySort(type)` +`SortAuctionSetSort(type, column, reverse)` + +**Parameters:** +- `type` + - *string* - One of the following: + - `"list"` - For items up for purchase, the "Browse" tab. + - `"bidder"` - For items the player has bid on, the "Bids" tab. + - `"owner"` - For items the player has posted, the "Auctions" tab. +- `column` + - *string* - One of the following: + - `"quality"` - The rarity of the item. + - `"level"` - The minimum required level (if any). Only applies to "list" and "bidder" type views. + - `"status"` - When the type is "list" this is the seller's name. For the "owner" type it is the high bidder's name. + - `"duration"` - The amount of time left in the auction. + - `"bid"` - The current bid amount for an auction. + - `"name"` - The name of the item. This is a hidden column. + - `"buyout"` - Buyout for the auction. This is a hidden column. + - `"unitprice"` - Per-item (not per-stack) buyout price. This is a hidden and undocumented column. +- `reverse` + - *boolean* - Should the sort order be reversed. \ No newline at end of file diff --git a/wiki-information/functions/SortQuestWatches.md b/wiki-information/functions/SortQuestWatches.md new file mode 100644 index 00000000..ac4283a2 --- /dev/null +++ b/wiki-information/functions/SortQuestWatches.md @@ -0,0 +1,9 @@ +## Title: SortQuestWatches + +**Content:** +Sorts watched quests by proximity to the player character. +`changed = SortQuestWatches()` + +**Returns:** +- `changed` + - *boolean* - true if any change to the order of watched quests was made, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/SpellCanTargetUnit.md b/wiki-information/functions/SpellCanTargetUnit.md new file mode 100644 index 00000000..890c1512 --- /dev/null +++ b/wiki-information/functions/SpellCanTargetUnit.md @@ -0,0 +1,16 @@ +## Title: SpellCanTargetUnit + +**Content:** +Returns true if the spell awaiting target selection can be cast on the unit. +`canTarget = SpellCanTargetUnit(unitId)` + +**Parameters:** +- `unitId` + - *string (UnitId)* - The unit to check. + +**Returns:** +- `canTarget` + - *boolean* - Whether the spell can target the given unit. + +**Description:** +This will check for range, but not for LOS (Line of Sight). \ No newline at end of file diff --git a/wiki-information/functions/SpellGetVisibilityInfo.md b/wiki-information/functions/SpellGetVisibilityInfo.md new file mode 100644 index 00000000..1d2e6a2e --- /dev/null +++ b/wiki-information/functions/SpellGetVisibilityInfo.md @@ -0,0 +1,22 @@ +## Title: SpellGetVisibilityInfo + +**Content:** +Checks if the spell should be visible, depending on spellId and raid combat status. +`hasCustom, alwaysShowMine, showForMySpec = SpellGetVisibilityInfo(spellId, visType)` + +**Parameters:** +- `spellId` + - *number* - The ID of the spell to check. +- `visType` + - *string* - either "RAID_INCOMBAT" if in combat, "RAID_OUTOFCOMBAT" otherwise. + +**Returns:** +- `hasCustom` + - *boolean* - whether the spell visibility should be customized, if false it means always display. +- `alwaysShowMine` + - *boolean* - whether to show the spell if cast by the player/player's pet/vehicle (e.g. the Paladin Forbearance debuff). +- `showForMySpec` + - *boolean* - whether to show the spell for the current specialization of the player. + +**Description:** +This is used by Blizzard's compact frame until 8.2.5, for whether it should be shown in the raid UI. \ No newline at end of file diff --git a/wiki-information/functions/SpellIsTargeting.md b/wiki-information/functions/SpellIsTargeting.md new file mode 100644 index 00000000..0548fec4 --- /dev/null +++ b/wiki-information/functions/SpellIsTargeting.md @@ -0,0 +1,9 @@ +## Title: SpellIsTargeting + +**Content:** +Returns true if a spell is about to be cast and is waiting for the player to select a target. +`isTargeting = SpellIsTargeting()` + +**Returns:** +- `isTargeting` + - *boolean* - 1 if a spell is about to be cast, waiting for the player to select a target; nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/SpellStopCasting.md b/wiki-information/functions/SpellStopCasting.md new file mode 100644 index 00000000..51ad869c --- /dev/null +++ b/wiki-information/functions/SpellStopCasting.md @@ -0,0 +1,27 @@ +## Title: SpellStopCasting + +**Content:** +Stops the current spellcast. +`stopped = SpellStopCasting()` + +**Returns:** +- `stopped` + - *boolean* - 1 if a spell was being cast, nil otherwise. + +**Example Usage:** +```lua +-- Example of stopping a spell cast +local wasCasting = SpellStopCasting() +if wasCasting then + print("Spell casting was stopped.") +else + print("No spell was being cast.") +end +``` + +**Description:** +The `SpellStopCasting` function is useful in scenarios where you need to interrupt a spell cast, such as when a player needs to move or switch to a different action quickly. This function is often used in macros and addons to enhance gameplay efficiency. + +**Addons Using This Function:** +- **Quartz**: A popular casting bar addon that uses `SpellStopCasting` to manage and display the player's casting bar, ensuring accurate representation of spell interruptions. +- **WeakAuras**: A powerful and flexible framework for displaying highly customizable graphics on your screen to indicate buffs, debuffs, and other relevant information. It can use `SpellStopCasting` to trigger alerts or animations when a spell cast is interrupted. \ No newline at end of file diff --git a/wiki-information/functions/SpellStopTargeting.md b/wiki-information/functions/SpellStopTargeting.md new file mode 100644 index 00000000..5969a22e --- /dev/null +++ b/wiki-information/functions/SpellStopTargeting.md @@ -0,0 +1,8 @@ +## Title: SpellStopTargeting + +**Content:** +Cancels the spell awaiting target selection. +`SpellStopTargeting()` + +**Description:** +Also cancels some types of weapon buffs when they ask for confirmation. For example, if you attempt to apply a poison to a weapon that already has a poison, the game will ask you to confirm the replacement. You can accept the replacement with `ReplaceEnchant()` or cancel the replacement with `SpellStopTargeting()`. \ No newline at end of file diff --git a/wiki-information/functions/SpellTargetUnit.md b/wiki-information/functions/SpellTargetUnit.md new file mode 100644 index 00000000..4e708996 --- /dev/null +++ b/wiki-information/functions/SpellTargetUnit.md @@ -0,0 +1,21 @@ +## Title: SpellTargetUnit + +**Content:** +Casts the spell awaiting target selection on the unit. +`SpellTargetUnit(unitId)` + +**Parameters:** +- `unitId` + - *string* : UnitId - The unit you wish to cast the spell on. + +**Example Usage:** +```lua +-- Assuming you have a spell ready to be cast and you want to target the player +SpellTargetUnit("player") +``` + +**Description:** +The `SpellTargetUnit` function is used to cast a spell that is currently awaiting target selection on a specified unit. This is particularly useful in macros or scripts where you need to automate spell casting on specific units. + +**Usage in Addons:** +Many large addons, such as HealBot and Clique, use `SpellTargetUnit` to facilitate quick and efficient healing or buffing by allowing players to cast spells on units directly through their custom interfaces. This function helps streamline the process of targeting and casting spells, making gameplay smoother and more efficient. \ No newline at end of file diff --git a/wiki-information/functions/SplitContainerItem.md b/wiki-information/functions/SplitContainerItem.md new file mode 100644 index 00000000..63ce6c58 --- /dev/null +++ b/wiki-information/functions/SplitContainerItem.md @@ -0,0 +1,17 @@ +## Title: SplitContainerItem + +**Content:** +Places part of a stack of items from a container onto the cursor. +`SplitContainerItem(bagID, slot, count)` + +**Parameters:** +- `bagID` + - *number* - id of the bag the slot is located in. +- `slot` + - *number* - slot inside the bag (top left slot is 1, slot to the right of it is 2). +- `count` + - *number* - Quantity to pick up. + +**Description:** +This function always puts the requested item(s) on the cursor (unlike `PickupContainerItem()` which can pick up items, place items, or cast spells on items based on what's already on the cursor). +Passing a larger count than is in the requested bag and slot will pick up nothing. \ No newline at end of file diff --git a/wiki-information/functions/StablePet.md b/wiki-information/functions/StablePet.md new file mode 100644 index 00000000..aebfa192 --- /dev/null +++ b/wiki-information/functions/StablePet.md @@ -0,0 +1,11 @@ +## Title: StablePet + +**Content:** +Puts your current pet in the stable if there is room. +`StablePet()` + +**Example Usage:** +This function can be used in macros or scripts to automate the process of stabling your current pet, which is particularly useful for hunters who frequently switch between pets. + +**Addons:** +Large addons like "PetTracker" might use this function to manage pet stabling automatically based on certain conditions or user preferences. \ No newline at end of file diff --git a/wiki-information/functions/StartAuction.md b/wiki-information/functions/StartAuction.md new file mode 100644 index 00000000..b1644b0a --- /dev/null +++ b/wiki-information/functions/StartAuction.md @@ -0,0 +1,30 @@ +## Title: StartAuction + +**Content:** +Starts the auction you have created in the Create Auction panel. +`StartAuction(minBid, buyoutPrice, runTime, stackSize, numStacks)` + +The item is that which has been put into the AuctionSellItemButton. That's the slot in the 'create auction' panel. +The minBid and buyoutPrice are in copper. However, I can't figure out how to go below 1 silver. So putting in '50' or '10' or '1' will always make the auction do '1 silver'. But '102' will make it do '1 silver 2 copper'. +runTime may be one of the following: 1, 2, 3 for 12, 24, and 48 hours. + +**Examples:** +- `StartAuction(1,1,1)` - Start at 1 silver, buyout 1 silver, time 12 hours +- `StartAuction(1,10,1)` - Start at 1 silver, buyout 1 silver, time 12 hours +- `StartAuction(1,100,1)` - Start at 1 silver, buyout 1 silver, time 12 hours +- `StartAuction(1,1000,1)` - Start at 1 silver, buyout 10 silver, time 12 hours +- `StartAuction(1,10000,2)` - Start at 1 silver, buyout 1 gold, time 24 hours +- `StartAuction(101,150,3)` - Start at 1 silver 1 copper, buyout at 1 silver 50 copper, time 48 hours + +**Usage Example:** +1. Go to the auction house. +2. Right-click on the auctioneer. +3. Click on the 'auction' tab. +4. Drag an item to the slot in the 'Create Auction' panel. +5. Type the following into the chat window: + - `/script StartAuction(1,150,1)` + +This should create an auction starting at 1 silver, buyout at 1 silver 50 copper, with an auction time of 12 hours. It should say 'Auction Created' in the chat window. Now if you go to browse the auctions, your items should show up. + +**Description:** +As of Patch 4.0, `StartAuction()` requires a hardware event. This change does not show up in any patch documentation. \ No newline at end of file diff --git a/wiki-information/functions/StartDuel.md b/wiki-information/functions/StartDuel.md new file mode 100644 index 00000000..301f6454 --- /dev/null +++ b/wiki-information/functions/StartDuel.md @@ -0,0 +1,21 @@ +## Title: StartDuel + +**Content:** +Challenges the specified player to a duel. +`StartDuel(unit)` +`StartDuel(name)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit id of the unit. +- `name` + - *string* - The name of the unit. +- `exactMatch` + - *boolean?* - true to check only units whose name exactly matches the name given; false to allow partial matches. + +**Description:** +`StartDuel("player")` is an apparent special case, creating a mouse cursor to select someone else to duel against. + +**Reference:** +- `AcceptDuel()` +- `CancelDuel()` \ No newline at end of file diff --git a/wiki-information/functions/StopMusic.md b/wiki-information/functions/StopMusic.md new file mode 100644 index 00000000..fc3e166d --- /dev/null +++ b/wiki-information/functions/StopMusic.md @@ -0,0 +1,9 @@ +## Title: StopMusic + +**Content:** +Stops the currently playing music. +`StopMusic()` + +**Description:** +This does not affect the built-in zone music, only music files that are played with `PlayMusic`. +Before Patch 2.2, this function would fade the currently playing music out. After Patch 2.2, it stops it immediately without a fade. \ No newline at end of file diff --git a/wiki-information/functions/StopSound.md b/wiki-information/functions/StopSound.md new file mode 100644 index 00000000..f48a1d1f --- /dev/null +++ b/wiki-information/functions/StopSound.md @@ -0,0 +1,11 @@ +## Title: StopSound + +**Content:** +Stops playing the specified sound. +`StopSound(soundHandle)` + +**Parameters:** +- `soundHandle` + - *number* - Playing sound handle, as returned by PlaySound or PlaySoundFile. +- `fadeoutTime` + - *number?* - In milliseconds. \ No newline at end of file diff --git a/wiki-information/functions/StopTradeSkillRepeat.md b/wiki-information/functions/StopTradeSkillRepeat.md new file mode 100644 index 00000000..74927d71 --- /dev/null +++ b/wiki-information/functions/StopTradeSkillRepeat.md @@ -0,0 +1,8 @@ +## Title: StopTradeSkillRepeat + +**Content:** +Stops the trade skill creation queue (e.g., when the user presses Create All or specifies a number of crafts in a profession tab). +`StopTradeSkillRepeat()` + +**Notes and Caveats:** +This function will not interrupt the current cast. It will stop the queue once the current cast finishes. \ No newline at end of file diff --git a/wiki-information/functions/StrafeLeftStart.md b/wiki-information/functions/StrafeLeftStart.md new file mode 100644 index 00000000..140c08a3 --- /dev/null +++ b/wiki-information/functions/StrafeLeftStart.md @@ -0,0 +1,12 @@ +## Title: StrafeLeftStart + +**Content:** +The player begins strafing left at the specified time. +`StrafeLeftStart(startTime)` + +**Parameters:** +- `startTime` + - Begin strafing left at this time. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StrafeLeftStop.md b/wiki-information/functions/StrafeLeftStop.md new file mode 100644 index 00000000..901caa83 --- /dev/null +++ b/wiki-information/functions/StrafeLeftStop.md @@ -0,0 +1,12 @@ +## Title: StrafeLeftStop + +**Content:** +The player stops strafing left at the specified time. +`StrafeLeftStop(startTime)` + +**Parameters:** +- `stopTime` + - Stop strafing left at this time, per GetTime * 1000. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StrafeRightStart.md b/wiki-information/functions/StrafeRightStart.md new file mode 100644 index 00000000..48bc15d6 --- /dev/null +++ b/wiki-information/functions/StrafeRightStart.md @@ -0,0 +1,12 @@ +## Title: StrafeRightStart + +**Content:** +The player begins strafing right at the specified time. +`StrafeRightStart(startTime)` + +**Parameters:** +- `startTime` + - *number* - Begin strafing right at this time, per GetTime * 1000. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StrafeRightStop.md b/wiki-information/functions/StrafeRightStop.md new file mode 100644 index 00000000..0400eea5 --- /dev/null +++ b/wiki-information/functions/StrafeRightStop.md @@ -0,0 +1,12 @@ +## Title: StrafeRightStop + +**Content:** +The player stops strafing right at the specified time. +`StrafeRightStop(startTime)` + +**Parameters:** +- `stopTime` + - Stop strafing right at this time, per GetTime * 1000. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StripHyperlinks.md b/wiki-information/functions/StripHyperlinks.md new file mode 100644 index 00000000..773e8071 --- /dev/null +++ b/wiki-information/functions/StripHyperlinks.md @@ -0,0 +1,24 @@ +## Title: StripHyperlinks + +**Content:** +Strips text of UI escape sequence markup. +`stripped = StripHyperlinks(text)` + +**Parameters:** +- `text` + - *string* - The text to be stripped of markup. +- `maintainColor` + - *boolean?* - If true, preserve color escape sequences. +- `maintainBrackets` + - *boolean?* +- `stripNewlines` + - *boolean?* - If true, strip all line break sequences. +- `maintainAtlases` + - *boolean?* - If true, preserve atlas texture escape sequences. + +**Returns:** +- `stripped` + - *string* - The stripped text. + +**Description:** +This function is used by the Addon compartment to strip markup from addon titles prior to sorting. \ No newline at end of file diff --git a/wiki-information/functions/Stuck.md b/wiki-information/functions/Stuck.md new file mode 100644 index 00000000..e5fb7597 --- /dev/null +++ b/wiki-information/functions/Stuck.md @@ -0,0 +1,9 @@ +## Title: Stuck + +**Content:** +Notifies the game engine that the player is stuck. +`Stuck()` + +**Description:** +Starts casting a 10-second spell that kills the player, allowing their ghost to teleport to a graveyard. +This function is accessible via the Customer Support panel, in the "Character Stuck!" section. \ No newline at end of file diff --git a/wiki-information/functions/SummonFriend.md b/wiki-information/functions/SummonFriend.md new file mode 100644 index 00000000..64595169 --- /dev/null +++ b/wiki-information/functions/SummonFriend.md @@ -0,0 +1,19 @@ +## Title: SummonFriend + +**Content:** +Summons a player using the RaF system. +`SummonFriend(guid, name)` + +**Parameters:** +- `guid` + - *string* : GUID - The guid of the player. +- `name` + - *string* - The name of the player. + +**Usage:** +Summons the current target if the target is a recruited friend. +`SummonFriend(UnitGUID("target"), UnitName("target"))` + +**Reference:** +- `CanSummonFriend` +- `GetSummonFriendCooldown` \ No newline at end of file diff --git a/wiki-information/functions/SupportsClipCursor.md b/wiki-information/functions/SupportsClipCursor.md new file mode 100644 index 00000000..080ab849 --- /dev/null +++ b/wiki-information/functions/SupportsClipCursor.md @@ -0,0 +1,9 @@ +## Title: SupportsClipCursor + +**Content:** +Needs summary. +`supportsClipCursor = SupportsClipCursor()` + +**Returns:** +- `supportsClipCursor` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/SwapRaidSubgroup.md b/wiki-information/functions/SwapRaidSubgroup.md new file mode 100644 index 00000000..4a405bba --- /dev/null +++ b/wiki-information/functions/SwapRaidSubgroup.md @@ -0,0 +1,21 @@ +## Title: SwapRaidSubgroup + +**Content:** +Swaps two raid members into different groups. +`SwapRaidSubgroup(index1, index2)` + +**Parameters:** +- `index1` + - *number* - ID of first raid member (1 to MAX_RAID_MEMBERS) +- `index2` + - *number* - ID of second raid member (1 to MAX_RAID_MEMBERS) + +**Reference:** +- `SetRaidSubgroup` + +**Example Usage:** +This function can be used in a raid management addon to quickly reorganize raid groups. For instance, if a raid leader wants to swap a healer and a DPS between groups for better group composition, they can use this function to automate the process. + +**Addons Using This Function:** +- **ElvUI**: A popular UI overhaul addon that includes raid management features. It uses `SwapRaidSubgroup` to allow raid leaders to easily manage and swap raid members between groups. +- **oRA3**: A raid management addon that provides additional raid leader tools, including the ability to swap raid members between groups using this function. \ No newline at end of file diff --git a/wiki-information/functions/TakeInboxItem.md b/wiki-information/functions/TakeInboxItem.md new file mode 100644 index 00000000..ee7488f6 --- /dev/null +++ b/wiki-information/functions/TakeInboxItem.md @@ -0,0 +1,20 @@ +## Title: TakeInboxItem + +**Content:** +Takes the attached item from the mailbox message. +`TakeInboxItem(index, itemIndex)` + +**Parameters:** +- `index` + - the index of the mailbox message you want to take the item attachment from. +- `itemIndex` + - The index of the item to take (1-ATTACHMENTS_MAX_RECEIVE(16)) + +**Returns:** +Always returns nil. (note: please confirm) As the request is done to the server asynchronously and might fail, then if knowing whether the action was successful is important, you will need to check afterward that it was. + +**Usage:** +`TakeInboxItem(1, 1)` + +**Description:** +Sends a request to the server to take an item attachment from a mail message. Note that this is only a request to the server, and the action might fail. Possible reasons for failure include that the user's bags are full, that they already have the maximum number of the item they are allowed to have (e.g., a unique item), or that a prior `TakeInboxItem()` request is still being processed by the server. There may be other reasons for failure. Would attempt to take the attachment from the first message in the Inbox and place it in the next available container slot. \ No newline at end of file diff --git a/wiki-information/functions/TakeInboxMoney.md b/wiki-information/functions/TakeInboxMoney.md new file mode 100644 index 00000000..d7301c9e --- /dev/null +++ b/wiki-information/functions/TakeInboxMoney.md @@ -0,0 +1,22 @@ +## Title: TakeInboxMoney + +**Content:** +Take the attached money from the mailbox message at index. +`TakeInboxMoney(index)` + +**Parameters:** +- `index` + - *number* - a number representing a message in the inbox + +**Usage:** +```lua +for i = GetInboxNumItems(), 1, -1 do + TakeInboxMoney(i); -- BUG IN CHINA GAME. if number > 1, takeInboxMoney(N) = InboxMoney(1); +end; +``` + +**Example Use Case:** +This function can be used in an addon that automates the process of collecting gold from mailbox messages, such as an auction house addon that retrieves earnings from sold items. + +**Addon Usage:** +Large addons like "TradeSkillMaster" use similar functions to automate mailbox operations, ensuring that users can efficiently manage their auction house transactions by quickly collecting gold and items from their mailbox. \ No newline at end of file diff --git a/wiki-information/functions/TakeTaxiNode.md b/wiki-information/functions/TakeTaxiNode.md new file mode 100644 index 00000000..ab283992 --- /dev/null +++ b/wiki-information/functions/TakeTaxiNode.md @@ -0,0 +1,9 @@ +## Title: TakeTaxiNode + +**Content:** +Travels to the specified flight path node. +`TakeTaxiNode(index)` + +**Parameters:** +- `index` + - *number* - Taxi node index to begin travelling to, ascending from 1 to `NumTaxiNodes()`. \ No newline at end of file diff --git a/wiki-information/functions/TargetDirectionEnemy.md b/wiki-information/functions/TargetDirectionEnemy.md new file mode 100644 index 00000000..4fce5416 --- /dev/null +++ b/wiki-information/functions/TargetDirectionEnemy.md @@ -0,0 +1,11 @@ +## Title: TargetDirectionEnemy + +**Content:** +Needs summary. +`TargetDirectionEnemy(facing)` + +**Parameters:** +- `facing` + - *number* +- `coneAngle` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/TargetDirectionFriend.md b/wiki-information/functions/TargetDirectionFriend.md new file mode 100644 index 00000000..2e131b53 --- /dev/null +++ b/wiki-information/functions/TargetDirectionFriend.md @@ -0,0 +1,11 @@ +## Title: TargetDirectionFriend + +**Content:** +Needs summary. +`TargetDirectionFriend(facing)` + +**Parameters:** +- `facing` + - *number* +- `coneAngle` + - *number?* \ No newline at end of file diff --git a/wiki-information/functions/TargetLastEnemy.md b/wiki-information/functions/TargetLastEnemy.md new file mode 100644 index 00000000..50c5c17b --- /dev/null +++ b/wiki-information/functions/TargetLastEnemy.md @@ -0,0 +1,5 @@ +## Title: TargetLastEnemy + +**Content:** +Targets the previously targeted enemy. +`TargetLastEnemy()` \ No newline at end of file diff --git a/wiki-information/functions/TargetLastTarget.md b/wiki-information/functions/TargetLastTarget.md new file mode 100644 index 00000000..fde27f28 --- /dev/null +++ b/wiki-information/functions/TargetLastTarget.md @@ -0,0 +1,8 @@ +## Title: TargetLastTarget + +**Content:** +Selects the last target as the current target. +`TargetLastTarget()` + +**Description:** +Targets the player's last target. It will select a dead character or mob's corpse if that was the last live character or mob targeted. Can distinguish between two mobs of the same name and level. \ No newline at end of file diff --git a/wiki-information/functions/TargetNearest.md b/wiki-information/functions/TargetNearest.md new file mode 100644 index 00000000..ea6f16c5 --- /dev/null +++ b/wiki-information/functions/TargetNearest.md @@ -0,0 +1,9 @@ +## Title: TargetNearest + +**Content:** +Needs summary. +`TargetNearest()` + +**Parameters:** +- `reverse` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestEnemy.md b/wiki-information/functions/TargetNearestEnemy.md new file mode 100644 index 00000000..9a307127 --- /dev/null +++ b/wiki-information/functions/TargetNearestEnemy.md @@ -0,0 +1,13 @@ +## Title: TargetNearestEnemy + +**Content:** +Selects the nearest enemy as the current target. +`TargetNearestEnemy()` + +**Parameters:** +- `reverse` + - *boolean* - true to cycle backwards; false to cycle forwards. + +**Description:** +This is bound to the tab key by default. +This function only works if initiated by a hardware event. \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestEnemyPlayer.md b/wiki-information/functions/TargetNearestEnemyPlayer.md new file mode 100644 index 00000000..171eedd4 --- /dev/null +++ b/wiki-information/functions/TargetNearestEnemyPlayer.md @@ -0,0 +1,9 @@ +## Title: TargetNearestEnemyPlayer + +**Content:** +Needs summary. +`TargetNearestEnemyPlayer()` + +**Parameters:** +- `reverse` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestFriend.md b/wiki-information/functions/TargetNearestFriend.md new file mode 100644 index 00000000..39b60d19 --- /dev/null +++ b/wiki-information/functions/TargetNearestFriend.md @@ -0,0 +1,25 @@ +## Title: TargetNearestFriend + +**Content:** +Targets the nearest friendly unit. +`TargetNearestFriend()` + +**Parameters:** +- `reverse` + - *boolean* - if true, reverses the order of targeting units. + +**Example Usage:** +```lua +-- Target the nearest friendly unit +TargetNearestFriend() + +-- Target the nearest friendly unit in reverse order +TargetNearestFriend(true) +``` + +**Description:** +This function is useful in scenarios where you need to quickly target a friendly unit, such as in PvP or PvE situations where healing or buffing allies is critical. By using the `reverse` parameter, you can cycle through friendly units in the opposite order, which can be helpful in crowded environments. + +**Addons Using This Function:** +- **HealBot**: A popular healing addon that uses this function to quickly target friendly units for healing spells. +- **Clique**: An addon that allows for click-casting on unit frames, which may use this function to target friendly units efficiently. \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestFriendPlayer.md b/wiki-information/functions/TargetNearestFriendPlayer.md new file mode 100644 index 00000000..8e7362a3 --- /dev/null +++ b/wiki-information/functions/TargetNearestFriendPlayer.md @@ -0,0 +1,9 @@ +## Title: TargetNearestFriendPlayer + +**Content:** +Needs summary. +`TargetNearestFriendPlayer()` + +**Parameters:** +- `reverse` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestPartyMember.md b/wiki-information/functions/TargetNearestPartyMember.md new file mode 100644 index 00000000..89bad2b9 --- /dev/null +++ b/wiki-information/functions/TargetNearestPartyMember.md @@ -0,0 +1,9 @@ +## Title: TargetNearestPartyMember + +**Content:** +Needs summary. +`TargetNearestPartyMember()` + +**Parameters:** +- `reverse` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestRaidMember.md b/wiki-information/functions/TargetNearestRaidMember.md new file mode 100644 index 00000000..57cb6290 --- /dev/null +++ b/wiki-information/functions/TargetNearestRaidMember.md @@ -0,0 +1,9 @@ +## Title: TargetNearestRaidMember + +**Content:** +Needs summary. +`TargetNearestRaidMember()` + +**Parameters:** +- `reverse` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetPriorityHighlightStart.md b/wiki-information/functions/TargetPriorityHighlightStart.md new file mode 100644 index 00000000..f48df35d --- /dev/null +++ b/wiki-information/functions/TargetPriorityHighlightStart.md @@ -0,0 +1,9 @@ +## Title: TargetPriorityHighlightStart + +**Content:** +Needs summary. +`TargetPriorityHighlightStart()` + +**Parameters:** +- `useStartDelay` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetTotem.md b/wiki-information/functions/TargetTotem.md new file mode 100644 index 00000000..01f615d6 --- /dev/null +++ b/wiki-information/functions/TargetTotem.md @@ -0,0 +1,9 @@ +## Title: TargetTotem + +**Content:** +Needs summary. +`TargetTotem(slot)` + +**Parameters:** +- `slot` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/TargetUnit.md b/wiki-information/functions/TargetUnit.md new file mode 100644 index 00000000..c02687c3 --- /dev/null +++ b/wiki-information/functions/TargetUnit.md @@ -0,0 +1,11 @@ +## Title: TargetUnit + +**Content:** +Targets the specified unit. +`TargetUnit()` + +**Parameters:** +- `name` + - *string?* +- `exactMatch` + - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetDestX.md b/wiki-information/functions/TaxiGetDestX.md new file mode 100644 index 00000000..0d68e99f --- /dev/null +++ b/wiki-information/functions/TaxiGetDestX.md @@ -0,0 +1,16 @@ +## Title: TaxiGetDestX + +**Content:** +Returns the horizontal position of the destination node of a given route to the destination. +`local dX = TaxiGetDestX(destinationIndex, routeIndex)` + +**Parameters:** +- `(destinationIndex, routeIndex)` + - `destinationIndex` + - *number* - The final destination taxi node. + - `routeIndex` + - *number* - The index of the route to get the source from. + +**Returns:** +- `dX` + - *number* - The horizontal position of the destination node for the route. \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetDestY.md b/wiki-information/functions/TaxiGetDestY.md new file mode 100644 index 00000000..18cf7634 --- /dev/null +++ b/wiki-information/functions/TaxiGetDestY.md @@ -0,0 +1,15 @@ +## Title: TaxiGetDestY + +**Content:** +Returns the vertical position of the destination node of a given route to the destination. +`local dY = TaxiGetDestY(destinationIndex, routeIndex)` + +**Parameters:** +- `destinationIndex` + - *number* - The final destination taxi node. +- `routeIndex` + - *number* - The index of the route to get the source from. + +**Returns:** +- `dY` + - *number* - The vertical position of the destination node for the route. \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetSrcX.md b/wiki-information/functions/TaxiGetSrcX.md new file mode 100644 index 00000000..37bbba20 --- /dev/null +++ b/wiki-information/functions/TaxiGetSrcX.md @@ -0,0 +1,16 @@ +## Title: TaxiGetSrcX + +**Content:** +Returns the horizontal position of the source node of a given route to the destination. +`local sX = TaxiGetSrcX(destinationIndex, routeIndex)` + +**Parameters:** +- `(destinationIndex, routeIndex)` + - `destinationIndex` + - *number* - The final destination taxi node. + - `routeIndex` + - *number* - The index of the route to get the source from. + +**Returns:** +- `sX` + - *number* - The horizontal position of the source node. \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetSrcY.md b/wiki-information/functions/TaxiGetSrcY.md new file mode 100644 index 00000000..669f2144 --- /dev/null +++ b/wiki-information/functions/TaxiGetSrcY.md @@ -0,0 +1,16 @@ +## Title: TaxiGetSrcY + +**Content:** +Returns the vertical position of the source node of a given route to the destination. +`local sY = TaxiGetSrcY(destinationIndex, routeIndex)` + +**Parameters:** +- `(destinationIndex, routeIndex)` + - `destinationIndex` + - *number* - The final destination taxi node. + - `routeIndex` + - *number* - The index of the route to get the source from. + +**Returns:** +- `sY` + - *number* - The vertical position of the source node. \ No newline at end of file diff --git a/wiki-information/functions/TaxiNodeCost.md b/wiki-information/functions/TaxiNodeCost.md new file mode 100644 index 00000000..3ce2fbee --- /dev/null +++ b/wiki-information/functions/TaxiNodeCost.md @@ -0,0 +1,33 @@ +## Title: TaxiNodeCost + +**Content:** +Returns the cost of the flight path in copper. +`cost = TaxiNodeCost(slot)` + +**Parameters:** +- `slot` + - *number* - 1 ascending to NumTaxiNodes(), out of bound numbers triggers lua error. + +**Returns:** +- `cost` + - *number* - returns the cost in copper, 0 if destination is undiscovered, free or current node. + +**Usage:** +The following example will print the name and cost for each flight point that is not free. +```lua +for i = 1, NumTaxiNodes() do + if (TaxiNodeCost(i) > 0) then + print(format("Flight to %s costs: %s", TaxiNodeName(i), GetCoinText(TaxiNodeCost(i), " "))) + end +end +``` + +**Description:** +Taxi information is only available while the taxi map is open -- between the TAXIMAP_OPENED and TAXIMAP_CLOSED events. +"invalid taxi node slot" is an error triggered by out-of-bound slot (0 or NumTaxiNodes() < slot) or if there is no taxi map open. +For some reason, this returns the original cost of the given slot, not taking into account any reductions you get due to faction. + +**Reference:** +- `NumTaxiNodes()` +- `TaxiNodeGetType(slot)` +- `TaxiNodeName(slot)` \ No newline at end of file diff --git a/wiki-information/functions/TaxiNodeGetType.md b/wiki-information/functions/TaxiNodeGetType.md new file mode 100644 index 00000000..e96fbd55 --- /dev/null +++ b/wiki-information/functions/TaxiNodeGetType.md @@ -0,0 +1,19 @@ +## Title: TaxiNodeGetType + +**Content:** +Returns the type of a flight path node. +`type = TaxiNodeGetType(index)` + +**Parameters:** +- `index` + - *number* - Taxi map node index, ascending from 1 to NumTaxiNodes(). + +**Returns:** +- `type` + - *string* - "CURRENT" for the player's current position, "REACHABLE" for nodes that can be travelled to, "DISTANT" for nodes that can't be travelled to, and "NONE" if the index is out of bounds. + +**Description:** +Taxi information is only available while the taxi map is open -- between the TAXIMAP_OPENED and TAXIMAP_CLOSED events. + +**Reference:** +- `TaxiNodeName` \ No newline at end of file diff --git a/wiki-information/functions/TaxiNodeName.md b/wiki-information/functions/TaxiNodeName.md new file mode 100644 index 00000000..e1102007 --- /dev/null +++ b/wiki-information/functions/TaxiNodeName.md @@ -0,0 +1,16 @@ +## Title: TaxiNodeName + +**Content:** +Returns the name of a flight path node. +`name = TaxiNodeName(index)` + +**Parameters:** +- `index` + - *number* - Index of the taxi map node, ascending from 1 to `NumTaxiNodes()` + +**Returns:** +- `name` + - *string* - name of the specified flight point, or "INVALID" if the index is out of bounds. + +**Description:** +Taxi information is only available while the taxi map is open -- between the `TAXIMAP_OPENED` and `TAXIMAP_CLOSED` events. \ No newline at end of file diff --git a/wiki-information/functions/TimeoutResurrect.md b/wiki-information/functions/TimeoutResurrect.md new file mode 100644 index 00000000..84920efd --- /dev/null +++ b/wiki-information/functions/TimeoutResurrect.md @@ -0,0 +1,12 @@ +## Title: TimeoutResurrect + +**Content:** +Signals the client that an offer to resurrect the player has expired. +`TimeoutResurrect()` + +**Description:** +Called when the timeout timer on resurrection StaticPopups expires. Prior to patch 5.4.0, `DeclineResurrect` was used for both timed out and declined resurrection requests. + +**Reference:** +- `AcceptResurrect` +- `DeclineResurrect` \ No newline at end of file diff --git a/wiki-information/functions/ToggleAutoRun.md b/wiki-information/functions/ToggleAutoRun.md new file mode 100644 index 00000000..0159c607 --- /dev/null +++ b/wiki-information/functions/ToggleAutoRun.md @@ -0,0 +1,11 @@ +## Title: ToggleAutoRun + +**Content:** +Turns auto-run on or off. +`ToggleAutoRun()` + +**Example Usage:** +This function can be used in macros or scripts to toggle the auto-run feature in the game. For instance, you could create a macro to start or stop auto-running without needing to press the default keybind. + +**Addons:** +Many large addons, such as Bartender4, use similar functions to provide enhanced control over character movement and actions. While `ToggleAutoRun` itself might not be directly used, understanding how to control character movement programmatically is essential for creating comprehensive UI and control addons. \ No newline at end of file diff --git a/wiki-information/functions/TogglePVP.md b/wiki-information/functions/TogglePVP.md new file mode 100644 index 00000000..99d334b6 --- /dev/null +++ b/wiki-information/functions/TogglePVP.md @@ -0,0 +1,9 @@ +## Title: TogglePVP + +**Content:** +Toggles the player's PvP flag on or off. +`TogglePVP()` + +**Description:** +`TogglePVP()` is equivalent to `SetPVP(not GetPVPDesired())`. +This setting is different from war mode. \ No newline at end of file diff --git a/wiki-information/functions/ToggleRun.md b/wiki-information/functions/ToggleRun.md new file mode 100644 index 00000000..74bd6fd5 --- /dev/null +++ b/wiki-information/functions/ToggleRun.md @@ -0,0 +1,9 @@ +## Title: ToggleRun + +**Content:** +Toggle between running and walking. +`ToggleRun(theTime)` + +**Parameters:** +- `theTime` + - Toggle between running and walking at the specified time, per GetTime * 1000. \ No newline at end of file diff --git a/wiki-information/functions/ToggleSelfHighlight.md b/wiki-information/functions/ToggleSelfHighlight.md new file mode 100644 index 00000000..a0c23699 --- /dev/null +++ b/wiki-information/functions/ToggleSelfHighlight.md @@ -0,0 +1,9 @@ +## Title: ToggleSelfHighlight + +**Content:** +Needs summary. +`enabled = ToggleSelfHighlight()` + +**Returns:** +- `enabled` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ToggleSheath.md b/wiki-information/functions/ToggleSheath.md new file mode 100644 index 00000000..2350bb2b --- /dev/null +++ b/wiki-information/functions/ToggleSheath.md @@ -0,0 +1,9 @@ +## Title: ToggleSheath + +**Content:** +Toggles sheathed or unsheathed weapons. +`ToggleSheath()` + +**Reference:** +- `UNIT_MODEL_CHANGED` → "unitTarget" +- See also: `GetSheathState` \ No newline at end of file diff --git a/wiki-information/functions/TurnLeftStart.md b/wiki-information/functions/TurnLeftStart.md new file mode 100644 index 00000000..7f8a33ef --- /dev/null +++ b/wiki-information/functions/TurnLeftStart.md @@ -0,0 +1,12 @@ +## Title: TurnLeftStart + +**Content:** +Turns the player left at the specified time. +`TurnLeftStart(startTime)` + +**Parameters:** +- `startTime` + - *number* - Begin turning left at this time, per `GetTime * 1000`. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/TurnLeftStop.md b/wiki-information/functions/TurnLeftStop.md new file mode 100644 index 00000000..a97b2063 --- /dev/null +++ b/wiki-information/functions/TurnLeftStop.md @@ -0,0 +1,12 @@ +## Title: TurnLeftStop + +**Content:** +The player stops turning left at the specified time. +`TurnLeftStop(stopTime)` + +**Parameters:** +- `stopTime` + - Stop turning left at this time, per GetTime * 1000. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/TurnOrActionStart.md b/wiki-information/functions/TurnOrActionStart.md new file mode 100644 index 00000000..f5c2aa87 --- /dev/null +++ b/wiki-information/functions/TurnOrActionStart.md @@ -0,0 +1,11 @@ +## Title: TurnOrActionStart + +**Content:** +Starts a "right click" in the 3D game world. +`TurnOrActionStart()` + +**Description:** +This function is called when right-clicking in the 3D world. +Calling this function clears the "mouseover" unit. +When used alone, puts you into a "mouseturn" mode until `TurnOrActionStop` is called. +**IMPORTANT:** The normal restrictions regarding hardware event initiations still apply to anything this function might do. \ No newline at end of file diff --git a/wiki-information/functions/TurnOrActionStop.md b/wiki-information/functions/TurnOrActionStop.md new file mode 100644 index 00000000..b192f8b4 --- /dev/null +++ b/wiki-information/functions/TurnOrActionStop.md @@ -0,0 +1,10 @@ +## Title: TurnOrActionStop + +**Content:** +Stops a "right click" in the 3D game world. +`TurnOrActionStop()` + +**Description:** +This function is called when right-clicking in the 3D world. Most useful, it can initiate an attack on the selected unit if no move occurs. When used alone, it can cancel a "mouseturn" started by a call to `TurnOrActionStart`. + +**IMPORTANT:** The normal restrictions regarding hardware event initiations still apply to anything this function might do. \ No newline at end of file diff --git a/wiki-information/functions/TurnRightStart.md b/wiki-information/functions/TurnRightStart.md new file mode 100644 index 00000000..ad861652 --- /dev/null +++ b/wiki-information/functions/TurnRightStart.md @@ -0,0 +1,12 @@ +## Title: TurnRightStart + +**Content:** +Turns the player right at the specified time. +`TurnRightStart(startTime)` + +**Parameters:** +- `startTime` + - *number* - Begin turning right at this time, per GetTime * 1000 + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/TurnRightStop.md b/wiki-information/functions/TurnRightStop.md new file mode 100644 index 00000000..99008b35 --- /dev/null +++ b/wiki-information/functions/TurnRightStop.md @@ -0,0 +1,12 @@ +## Title: TurnRightStop + +**Content:** +The player stops turning right at the specified time. +`TurnRightStop(startTime)` + +**Parameters:** +- `stopTime` + - Stop turning right at this time, per `GetTime * 1000`. + +**Description:** +As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/UninviteUnit.md b/wiki-information/functions/UninviteUnit.md new file mode 100644 index 00000000..947b12c7 --- /dev/null +++ b/wiki-information/functions/UninviteUnit.md @@ -0,0 +1,14 @@ +## Title: UninviteUnit + +**Content:** +Removes a player from the group if you're the leader, or initiates a vote to kick. +`UninviteUnit(name)` + +**Parameters:** +- `name` + - *string* - Name of the player to remove from the group. When removing cross-server players, it is important to include the server name: "Ygramul-Emerald Dream". +- `reason` + - *string?* - Used when initiating a kick vote against the player. + +**Description:** +If you're in a Dungeon Finder group and call `UninviteUnit` without providing a reason, the `VOTE_KICK_REASON_NEEDED` event will fire to notify you that a reason is required to initiate a kick vote. \ No newline at end of file diff --git a/wiki-information/functions/UnitAffectingCombat.md b/wiki-information/functions/UnitAffectingCombat.md new file mode 100644 index 00000000..884e73bd --- /dev/null +++ b/wiki-information/functions/UnitAffectingCombat.md @@ -0,0 +1,22 @@ +## Title: UnitAffectingCombat + +**Content:** +Returns true if the unit is in combat. +`affectingCombat = UnitAffectingCombat(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit to check. + +**Returns:** +- `affectingCombat` + - *boolean* - Returns true if the unit is in combat or has aggro, false otherwise. + +**Description:** +- Returns true when initiating combat. +- Returns true if aggroed, even if the enemy doesn't land a blow. +- For hunters, it returns true shortly after the pet enters combat. +- If using a timed spell such as aimed shot, it returns true when the spell fires (not during charge up). +- Returns to false on death. +- Returns false if the unit being checked for aggro is out of range, or in another zone. +- Returns false if a unit is proximity-aggroed. It won't return true until it either attacks or is attacked. \ No newline at end of file diff --git a/wiki-information/functions/UnitArmor.md b/wiki-information/functions/UnitArmor.md new file mode 100644 index 00000000..1e1b1853 --- /dev/null +++ b/wiki-information/functions/UnitArmor.md @@ -0,0 +1,38 @@ +## Title: UnitArmor + +**Content:** +Returns the armor stats for the unit. +```lua +base, effectiveArmor, armor, bonusArmor = UnitArmor(unit) -- retail +base, effectiveArmor, armor, posBuff, negBuff = UnitArmor(unit) -- classic +``` + +**Parameters:** +- `unit` + - *string* : UnitToken - Only works for "player" and "pet". Works for "target" with Hunter's Beast Lore. + +**Returns:** +- `base` + - *number* - The unit's base armor. +- `effectiveArmor` + - *number* - The unit's effective armor. +- `armor` + - *number* +- `bonusArmor` (Retail) + - *number* +- `posBuff` (Classic) + - *number* - Amount of armor increase due to positive buffs +- `negBuff` (Classic) + - *number* - Amount of armor reduction due to negative buffs (a negative number) + +**Usage:** +```lua +local base, effectiveArmor = UnitArmor("player") +print(format("Your current armor is %d (%d base)", effectiveArmor, base)) +``` + +**Example Use Case:** +This function can be used to display a player's current armor stats in a custom UI or addon, helping players understand their defensive capabilities. + +**Addons Using This Function:** +- **Details! Damage Meter**: This popular addon uses `UnitArmor` to calculate and display detailed statistics about a player's defensive stats, helping players optimize their gear and buffs. \ No newline at end of file diff --git a/wiki-information/functions/UnitAttackBothHands.md b/wiki-information/functions/UnitAttackBothHands.md new file mode 100644 index 00000000..668036ba --- /dev/null +++ b/wiki-information/functions/UnitAttackBothHands.md @@ -0,0 +1,19 @@ +## Title: UnitAttackBothHands + +**Content:** +Returns information about the unit's melee attacks. +`mainBase, mainMod, offBase, offMod = UnitAttackBothHands(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - Tested with "player" and "target". + +**Returns:** +- `mainBase` + - *number* - The unit's base main hand weapon skill (not rating). +- `mainMod` + - *number* - Any modifier to the unit's main hand weapon skill (not rating). +- `offBase` + - *number* - The unit's base offhand weapon skill (not rating) (equal to unarmed weapon skill if unit doesn't dual wield). +- `offMod` + - *number* - Any modifier to the unit's offhand weapon skill (not rating). \ No newline at end of file diff --git a/wiki-information/functions/UnitAttackPower.md b/wiki-information/functions/UnitAttackPower.md new file mode 100644 index 00000000..833a53d7 --- /dev/null +++ b/wiki-information/functions/UnitAttackPower.md @@ -0,0 +1,25 @@ +## Title: UnitAttackPower + +**Content:** +Returns the unit's melee attack power and modifiers. +`base, posBuff, negBuff = UnitAttackPower(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit to get information from. (Does not work for "target" - Possibly only "player" and "pet") + +**Returns:** +- `base` + - *number* - The unit's base attack power +- `posBuff` + - *number* - The total effect of positive buffs to attack power. +- `negBuff` + - *number* - The total effect of negative buffs to the attack power (a negative number) + +**Usage:** +Displays the player's current attack power in the default chat window. +```lua +local base, posBuff, negBuff = UnitAttackPower("player") +local effective = base + posBuff + negBuff +print("Your current attack power: "..effective) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitAttackSpeed.md b/wiki-information/functions/UnitAttackSpeed.md new file mode 100644 index 00000000..2c5196f9 --- /dev/null +++ b/wiki-information/functions/UnitAttackSpeed.md @@ -0,0 +1,15 @@ +## Title: UnitAttackSpeed + +**Content:** +Returns the unit's melee attack speed for each hand. +`mainSpeed, offSpeed = UnitAttackSpeed(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit to get information from. (Verified for "player" and "target") + +**Returns:** +- `mainSpeed` + - *number* - The unit's base main hand attack speed (seconds) +- `offSpeed` + - *number* - The unit's offhand attack speed (seconds) - nil if the unit has no offhand weapon. \ No newline at end of file diff --git a/wiki-information/functions/UnitAura.md b/wiki-information/functions/UnitAura.md new file mode 100644 index 00000000..93435cde --- /dev/null +++ b/wiki-information/functions/UnitAura.md @@ -0,0 +1,184 @@ +## Title: UnitAura + +**Content:** +Returns the buffs/debuffs for the unit. +```lua +name, icon, count, dispelType, duration, expirationTime, source, isStealable, nameplateShowPersonal, +spellId, canApplyAura, isBossDebuff, castByPlayer, nameplateShowAll, timeMod, ... + = UnitAura(unit, index) + = UnitBuff(unit, index) + = UnitDebuff(unit, index) +``` + +**Parameters:** +- `unit` + - *string* : UnitId +- `index` + - *number* - Index of an aura to query. +- `filter` + - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". + +**Miscellaneous:** +- `UnitBuff()` is an alias for `UnitAura(unit, index, "HELPFUL")`, returning only buffs. +- `UnitDebuff()` is an alias for `UnitAura(unit, index, "HARMFUL")`, returning only debuffs. + +**Filter Descriptions:** +- `"HELPFUL"`: Buffs +- `"HARMFUL"`: Debuffs +- `"PLAYER"`: Auras Debuffs applied by the player +- `"RAID"`: Buffs the player can apply and debuffs the player can dispel +- `"CANCELABLE"`: Buffs that can be cancelled with `/cancelaura` or `CancelUnitBuff()` +- `"NOT_CANCELABLE"`: Buffs that cannot be cancelled +- `"INCLUDE_NAME_PLATE_ONLY"`: Auras that should be shown on nameplates +- `"MAW"`: Torghast Anima Powers + +**Aura Util:** + +**ForEachAura:** +```lua +AuraUtil.ForEachAura(unit, filter, func) +``` +This is recommended for iterating over auras. For example, to print all buffs: +```lua +AuraUtil.ForEachAura("player", "HELPFUL", nil, function(name, icon, ...) + print(name, icon, ...) +end) +``` +The callback function should return true once it's fine to stop processing further auras. +```lua +local function foo(name, icon, _, _, _, _, _, _, _, spellId, ...) + if spellId == 21562 then -- Power Word: Fortitude + -- do stuff + return true + end +end +AuraUtil.ForEachAura("player", "HELPFUL", nil, foo) +``` + +**FindAuraByName:** +```lua +AuraUtil.FindAuraByName(name, unit) +``` +Finds the first aura that matches the name, but note that: +- Aura names are not unique, this will only find the first match. +- Aura names are localized, what works in one locale might not work in another. +```lua +/dump AuraUtil.FindAuraByName("Power Word: Fortitude", "player") +``` +Remember to specify the "HARMFUL" filter for debuffs. +```lua +/dump AuraUtil.FindAuraByName("Weakened Soul", "player", "HARMFUL") +``` + +**Returns:** +Returns nil when there is no aura for that index or when the aura doesn't pass the filter. +1. `name` + - *string* - The localized name of the aura, otherwise nil if there is no aura for the index. +2. `icon` + - *number* : FileID - The icon texture. +3. `count` + - *number* - The amount of stacks, otherwise 0. +4. `dispelType` + - *string?* - The locale-independent magic type of the aura: Curse, Disease, Magic, Poison, otherwise nil. +5. `duration` + - *number* - The full duration of the aura in seconds. +6. `expirationTime` + - *number* - Time the aura expires compared to `GetTime()`, e.g. to get the remaining duration: `expirationTime - GetTime()` +7. `source` + - *string* : UnitId - The unit that applied the aura. +8. `isStealable` + - *boolean* - If the aura may be stolen. +9. `nameplateShowPersonal` + - *boolean* - If the aura should be shown on the player/pet/vehicle nameplate. +10. `spellId` + - *number* - The spell ID for e.g. `GetSpellInfo()` +11. `canApplyAura` + - *boolean* - If the player can apply the aura. +12. `isBossDebuff` + - *boolean* - If the aura was cast by a boss. +13. `castByPlayer` + - *boolean* - If the aura was applied by a player. +14. `nameplateShowAll` + - *boolean* - If the aura should be shown on nameplates. +15. `timeMod` + - *number* - The scaling factor used for displaying time left. +16. `shouldConsolidate` + - *boolean* - Whether to consolidate auras, only exists in Classic Era/Wrath. +17. `...` + - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + +**Description:** +- `UnitBuff()` will ignore any "HARMFUL" filter, and vice versa `UnitDebuff()` will ignore any "HELPFUL" filter. +- Filters can be mutually exclusive, e.g. "HELPFUL|HARMFUL" will always return nothing. +- On retail, a unit can have an unlimited amount of buffs/debuffs. +- The debuff limit is at 16 for Classic Era and 40 for BCC. + +**Related Events:** +- `UNIT_AURA` + +**World Buffs:** +If the unit has the buff, then the world buffs can be selected from the return values. For example: +```lua +select(20, UnitBuff("player", index)) +``` + +**Buff Types and Descriptions:** +- `Fengus' Ferocity` + - *number* - Duration +- `Mol'dar's Moxie` + - *number* - Duration +- `Slip'kik's Savvy` + - *number* - Duration +- `Rallying Cry of the Dragonslayer` + - *number* - Duration +- `Warchief's Blessing` + - *number* - Duration +- `Spirit of Zandalar` + - *number* - Duration +- `Songflower Serenade` + - *number* - Duration +- `Sayge's Fortune` + - *number* - Duration of the chosen buff +- `Sayge's Fortune` + - *number* - spellID of the chosen buff +- `Boon of Blackfathom` + - *number* - Duration +- `Spark of Inspiration` + - *number* - Duration +- `Fervor of the Temple Explorer` + - *number* - Duration + +**Usage:** +Prints the third aura on the target. +```lua +/dump UnitAura("target", 3) +``` +Returns: +- `"Power Word: Fortitude"` -- name +- `135987` -- icon +- `0` -- count +- `"Magic"` -- dispelType +- `3600` -- duration +- `112994.871` -- expirationTime +- `"player"` -- source +- `false` -- isStealable +- `false` -- nameplateShowPersonal +- `21562` -- spellID +- `true` -- canApplyAura +- `false` -- isBossDebuff +- `true` -- castByPlayer +- `false` -- nameplateShowAll +- `1` -- timeMod +- `5` -- attribute1: Stamina increased by 5% +- `0` -- attribute2: Magic damage taken reduced by 0% (Thorghast Enchanted Shroud power) + +The following are equivalent. Prints the first debuff applied by the player on the target. +```lua +/dump UnitAura("target", 1, "PLAYER|HARMFUL") +/dump UnitDebuff("target", 1, "PLAYER") +``` + +`GetPlayerAuraBySpellID()` is useful for checking only a specific aura on the player character. +```lua +/dump GetPlayerAuraBySpellID(21562) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitBuff.md b/wiki-information/functions/UnitBuff.md new file mode 100644 index 00000000..50ddb602 --- /dev/null +++ b/wiki-information/functions/UnitBuff.md @@ -0,0 +1,185 @@ +## Title: UnitAura + +**Content:** +Returns the buffs/debuffs for the unit. +```lua +name, icon, count, dispelType, duration, expirationTime, source, isStealable, nameplateShowPersonal, +spellId, canApplyAura, isBossDebuff, castByPlayer, nameplateShowAll, timeMod, ... + = UnitAura(unit, index) + = UnitBuff(unit, index) + = UnitDebuff(unit, index) +``` + +**Parameters:** +- `unit` + - *string* : UnitId +- `index` + - *number* - Index of an aura to query. +- `filter` + - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". + +**Miscellaneous:** +- `UnitBuff()` is an alias for `UnitAura(unit, index, "HELPFUL")`, returning only buffs. +- `UnitDebuff()` is an alias for `UnitAura(unit, index, "HARMFUL")`, returning only debuffs. + +**Filter Descriptions:** +- `"HELPFUL"`: Buffs +- `"HARMFUL"`: Debuffs +- `"PLAYER"`: Auras/Debuffs applied by the player +- `"RAID"`: Buffs the player can apply and debuffs the player can dispel +- `"CANCELABLE"`: Buffs that can be cancelled with `/cancelaura` or `CancelUnitBuff()` +- `"NOT_CANCELABLE"`: Buffs that cannot be cancelled +- `"INCLUDE_NAME_PLATE_ONLY"`: Auras that should be shown on nameplates +- `"MAW"`: Torghast Anima Powers + +**Aura Util:** + +- **ForEachAura:** + ```lua + AuraUtil.ForEachAura(unit, filter, func) + ``` + This is recommended for iterating over auras. For example, to print all buffs: + ```lua + AuraUtil.ForEachAura("player", "HELPFUL", nil, function(name, icon, ...) + print(name, icon, ...) + end) + ``` + The callback function should return true once it's fine to stop processing further auras. + ```lua + local function foo(name, icon, _, _, _, _, _, _, _, spellId, ...) + if spellId == 21562 then -- Power Word: Fortitude + -- do stuff + return true + end + end + AuraUtil.ForEachAura("player", "HELPFUL", nil, foo) + ``` + +- **FindAuraByName:** + ```lua + AuraUtil.FindAuraByName(name, unit) + ``` + Finds the first aura that matches the name, but note that: + - Aura names are not unique, this will only find the first match. + - Aura names are localized, what works in one locale might not work in another. + ```lua + /dump AuraUtil.FindAuraByName("Power Word: Fortitude", "player") + ``` + Remember to specify the "HARMFUL" filter for debuffs. + ```lua + /dump AuraUtil.FindAuraByName("Weakened Soul", "player", "HARMFUL") + ``` + +**Returns:** +Returns nil when there is no aura for that index or when the aura doesn't pass the filter. +1. `name` + - *string* - The localized name of the aura, otherwise nil if there is no aura for the index. +2. `icon` + - *number* : FileID - The icon texture. +3. `count` + - *number* - The amount of stacks, otherwise 0. +4. `dispelType` + - *string?* - The locale-independent magic type of the aura: Curse, Disease, Magic, Poison, otherwise nil. +5. `duration` + - *number* - The full duration of the aura in seconds. +6. `expirationTime` + - *number* - Time the aura expires compared to `GetTime()`, e.g. to get the remaining duration: `expirationTime - GetTime()` +7. `source` + - *string* : UnitId - The unit that applied the aura. +8. `isStealable` + - *boolean* - If the aura may be stolen. +9. `nameplateShowPersonal` + - *boolean* - If the aura should be shown on the player/pet/vehicle nameplate. +10. `spellId` + - *number* - The spell ID for e.g. `GetSpellInfo()` +11. `canApplyAura` + - *boolean* - If the player can apply the aura. +12. `isBossDebuff` + - *boolean* - If the aura was cast by a boss. +13. `castByPlayer` + - *boolean* - If the aura was applied by a player. +14. `nameplateShowAll` + - *boolean* - If the aura should be shown on nameplates. +15. `timeMod` + - *number* - The scaling factor used for displaying time left. +16. `shouldConsolidate` + - *boolean* - Whether to consolidate auras, only exists in Classic Era/Wrath. +17. `...` + - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + +**Description:** +- `UnitBuff()` will ignore any "HARMFUL" filter, and vice versa `UnitDebuff()` will ignore any "HELPFUL" filter. +- Filters can be mutually exclusive, e.g. "HELPFUL|HARMFUL" will always return nothing. +- On retail, a unit can have an unlimited amount of buffs/debuffs. +- The debuff limit is at 16 for Classic Era and 40 for BCC. + +**Related Events:** +- `UNIT_AURA` + +**World Buffs:** +If the unit has the buff, then the world buffs can be selected from the return values. For example: +```lua +select(20, UnitBuff("player", index)) +``` +- `Buff` +- `Type` +- `Description` + - `Fengus' Ferocity` + - *number* - Duration + - `Mol'dar's Moxie` + - *number* - Duration + - `Slip'kik's Savvy` + - *number* - Duration + - `Rallying Cry of the Dragonslayer` + - *number* - Duration + - `Warchief's Blessing` + - *number* - Duration + - `Spirit of Zandalar` + - *number* - Duration + - `Songflower Serenade` + - *number* - Duration + - `Sayge's Fortune` + - *number* - Duration of the chosen buff + - `Sayge's Fortune` + - *number* - spellID of the chosen buff + - `Boon of Blackfathom` + - *number* - Duration + - `Spark of Inspiration` + - *number* - Duration + - `Fervor of the Temple Explorer` + - *number* - Duration + +**Usage:** +Prints the third aura on the target. +```lua +/dump UnitAura("target", 3) +``` +Returns: +```lua +"Power Word: Fortitude", -- name +135987, -- icon +0, -- count +"Magic", -- dispelType +3600, -- duration +112994.871, -- expirationTime +"player", -- source +false, -- isStealable +false, -- nameplateShowPersonal +21562, -- spellID +true, -- canApplyAura +false, -- isBossDebuff +true, -- castByPlayer +false, -- nameplateShowAll +1, -- timeMod +5, -- attribute1: Stamina increased by 5% +0 -- attribute2: Magic damage taken reduced by 0% (Thorghast Enchanted Shroud power) +``` +The following are equivalent. Prints the first debuff applied by the player on the target. +```lua +/dump UnitAura("target", 1, "PLAYER|HARMFUL") +/dump UnitDebuff("target", 1, "PLAYER") +``` +`GetPlayerAuraBySpellID()` is useful for checking only a specific aura on the player character. +```lua +/dump GetPlayerAuraBySpellID(21562) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitCanAssist.md b/wiki-information/functions/UnitCanAssist.md new file mode 100644 index 00000000..8c09273a --- /dev/null +++ b/wiki-information/functions/UnitCanAssist.md @@ -0,0 +1,31 @@ +## Title: UnitCanAssist + +**Content:** +Indicates whether the first unit can assist the second unit. +`canAssist = UnitCanAssist(unitToAssist, unitToBeAssisted)` + +**Parameters:** +- `unitToAssist` + - *UnitId* - the unit that would assist (e.g., "player" or "target") +- `unitToBeAssisted` + - *UnitId* - the unit that would be assisted (e.g., "player" or "target") + +**Returns:** +- `canAssist` + - *boolean* - 1 if the unitToAssist can assist the unitToBeAssisted, nil otherwise. + +**Usage:** +```lua +if (UnitCanAssist("player", "target")) then + DEFAULT_CHAT_FRAME:AddMessage("You can assist the target.") +else + DEFAULT_CHAT_FRAME:AddMessage("You cannot assist the target.") +end +``` + +**Miscellaneous:** +Result: +A message indicating whether the player can assist the current target is displayed in the default chat frame. + +**Reference:** +- `UnitCanCooperate` \ No newline at end of file diff --git a/wiki-information/functions/UnitCanAttack.md b/wiki-information/functions/UnitCanAttack.md new file mode 100644 index 00000000..44b2c403 --- /dev/null +++ b/wiki-information/functions/UnitCanAttack.md @@ -0,0 +1,32 @@ +## Title: UnitCanAttack + +**Content:** +Returns true if the first unit can attack the second. +`canAttack = UnitCanAttack(unit1, unit2)` + +**Parameters:** +- `unit1` + - *string* : UnitId +- `unit2` + - *string* : UnitId - The unit to compare with the first unit. + +**Returns:** +- `canAttack` + - *boolean* + +**Example Usage:** +```lua +local playerCanAttackTarget = UnitCanAttack("player", "target") +if playerCanAttackTarget then + print("You can attack the target!") +else + print("You cannot attack the target.") +end +``` + +**Description:** +This function is commonly used in combat-related addons to determine if a player can engage a specific target. For example, PvP addons might use this to check if a player can attack an enemy player, while PvE addons might use it to determine if a player can attack a specific NPC. + +**Addons Using This Function:** +- **Gladius**: A popular PvP addon that uses this function to determine if arena opponents can be attacked. +- **TidyPlates**: A nameplate addon that uses this function to change the appearance of nameplates based on whether the unit can be attacked. \ No newline at end of file diff --git a/wiki-information/functions/UnitCanCooperate.md b/wiki-information/functions/UnitCanCooperate.md new file mode 100644 index 00000000..bd6f53c2 --- /dev/null +++ b/wiki-information/functions/UnitCanCooperate.md @@ -0,0 +1,15 @@ +## Title: UnitCanCooperate + +**Content:** +Returns true if the first unit can cooperate with the second. +`cancooperate = UnitCanCooperate(unit1, unit2)` + +**Parameters:** +- `unit1` + - *string* : UnitId +- `unit2` + - *string* : UnitId - The unit to compare with the first unit. + +**Returns:** +- `cancooperate` + - *boolean* - True if the first unit can cooperate with the second. \ No newline at end of file diff --git a/wiki-information/functions/UnitCastingInfo.md b/wiki-information/functions/UnitCastingInfo.md new file mode 100644 index 00000000..8ca8c10e --- /dev/null +++ b/wiki-information/functions/UnitCastingInfo.md @@ -0,0 +1,51 @@ +## Title: UnitCastingInfo + +**Content:** +Returns information about the spell currently being cast by the specified unit. +`name, text, texture, startTimeMS, endTimeMS, isTradeSkill, castID, notInterruptible, spellId = UnitCastingInfo(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `name` + - *string* - The name of the spell, or nil if no spell is being cast. +- `text` + - *string* - The name to be displayed. +- `texture` + - *string* - The texture path associated with the spell icon. +- `startTimeMS` + - *number* - Specifies when casting began in milliseconds (corresponds to GetTime()*1000). +- `endTimeMS` + - *number* - Specifies when casting will end in milliseconds (corresponds to GetTime()*1000). +- `isTradeSkill` + - *boolean* - Specifies if the cast is a tradeskill. +- `castID` + - *string* : GUID - The unique identifier for this spell cast, for example Cast-3-3890-1159-21205-8936-00014B7E7F. +- `notInterruptible` + - *boolean* - if true, indicates that this cast cannot be interrupted with abilities like or . In default UI those spells have shield frame around their icons on enemy cast bars. Always returns nil in Classic. +- `spellId` + - *number* - The spell's unique identifier. (Added in 7.2.5) + +**Description:** +For channeled spells, `displayName` is "Channeling". So far `displayName` is observed to be the same as `name` in any other contexts. +This function may not return anything when the target is channeling spell post its warm-up period, you should use `UnitChannelInfo` in that case. It takes the same arguments and returns similar values specific to channeling spells. +In Classic, the alternative `CastingInfo()` is similar to `UnitCastingInfo("player")`. + +**Related Events:** +- `UNIT_SPELLCAST_START` +- `UNIT_SPELLCAST_STOP` + +**Related API:** +- `CastingInfo (Classic)` + +**Usage:** +The following snippet prints the amount of time remaining before the player's current spell finishes casting. +```lua +local spell, _, _, _, endTime = UnitCastingInfo("player") +if spell then + local finish = endTimeMS/1000 - GetTime() + print(spell .. " will be finished casting in " .. finish .. " seconds.") +end +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitChannelInfo.md b/wiki-information/functions/UnitChannelInfo.md new file mode 100644 index 00000000..1dca5e19 --- /dev/null +++ b/wiki-information/functions/UnitChannelInfo.md @@ -0,0 +1,52 @@ +## Title: UnitChannelInfo + +**Content:** +Returns information about the spell currently being channeled by the specified unit. +`name, displayName, textureID, startTimeMs, endTimeMs, isTradeskill, notInterruptible, spellID, isEmpowered, numEmpowerStages = UnitChannelInfo(unitToken)` + +**Parameters:** +- `unitToken` + - *string* : UnitId + +**Returns:** +- `name` + - *string* - The name of the spell, or nil if no spell is being channeled. +- `displayName` + - *string* - The name to be displayed. +- `textureID` + - *string* - The texture path associated with the spell icon. +- `startTimeMs` + - *number* - Specifies when channeling began, in milliseconds (corresponds to GetTime()*1000). +- `endTimeMs` + - *number* - Specifies when channeling will end, in milliseconds (corresponds to GetTime()*1000). +- `isTradeskill` + - *boolean* - Specifies if the cast is a tradeskill. +- `notInterruptible` + - *boolean* - if true, indicates that this channeling cannot be interrupted with abilities like or . In default UI those spells have shield frame around their icons on enemy channeling bars. Always returns nil in Classic. +- `spellID` + - *number* - The spell's unique identifier. +- `isEmpowered` + - *boolean* +- `numEmpowerStages` + - *number* + +**Description:** +Related Events: +- `UNIT_SPELLCAST_CHANNEL_START` +- `UNIT_SPELLCAST_CHANNEL_STOP` + +Related API: +- `ChannelInfo` (Classic) + +**Usage:** +The following snippet prints the amount of time remaining before the player's current spell finishes channeling. +```lua +local spell, _, _, _, endTimeMS = UnitChannelInfo("player") +if spell then + local finish = endTimeMS/1000 - GetTime() + print(spell .. ' will be finished channeling in ' .. finish .. ' seconds.') +end +``` + +**Reference:** +- slouken 2006-10-06. Re: Expansion Changes - Concise List. Archived from the original \ No newline at end of file diff --git a/wiki-information/functions/UnitCharacterPoints.md b/wiki-information/functions/UnitCharacterPoints.md new file mode 100644 index 00000000..3168b2e3 --- /dev/null +++ b/wiki-information/functions/UnitCharacterPoints.md @@ -0,0 +1,13 @@ +## Title: UnitCharacterPoints + +**Content:** +Returns the number of unspent talent points of the player. +`talentPoints = UnitCharacterPoints(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - Only works on the player unit. + +**Returns:** +- `talentPoints` + - *number* - The quantity of unspent talent points the unit has available. \ No newline at end of file diff --git a/wiki-information/functions/UnitClass.md b/wiki-information/functions/UnitClass.md new file mode 100644 index 00000000..9769d927 --- /dev/null +++ b/wiki-information/functions/UnitClass.md @@ -0,0 +1,43 @@ +## Title: UnitClass + +**Content:** +Returns the class of the unit. +```lua +className, classFilename, classId = UnitClass(unit) +classFilename, classId = UnitClassBase(unit) +``` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Values:** +| ID | className (enUS) | classFile | Description | +|-----|------------------|--------------|----------------------| +| 1 | Warrior | WARRIOR | | +| 2 | Paladin | PALADIN | | +| 3 | Hunter | HUNTER | | +| 4 | Rogue | ROGUE | | +| 5 | Priest | PRIEST | | +| 6 | Death Knight | DEATHKNIGHT | Added in 3.0.2 | +| 7 | Shaman | SHAMAN | | +| 8 | Mage | MAGE | | +| 9 | Warlock | WARLOCK | | +| 10 | Monk | MONK | Added in 5.0.4 | +| 11 | Druid | DRUID | | +| 12 | Demon Hunter | DEMONHUNTER | Added in 7.0.3 | +| 13 | Evoker | EVOKER | Added in 10.0.0 | + +**Returns:** +- `className` + - *string* - Localized name, e.g. "Warrior" or "Guerrier". +- `classFilename` + - *string* - Locale-independent name, e.g. "WARRIOR". +- `classId` + - *number* : ClassId + +**Usage:** +```lua +/dump UnitClass("target") -- "Mage", "MAGE", 8 +/dump UnitClassBase("target") -- "MAGE", 8 +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitClassBase.md b/wiki-information/functions/UnitClassBase.md new file mode 100644 index 00000000..e7989a70 --- /dev/null +++ b/wiki-information/functions/UnitClassBase.md @@ -0,0 +1,43 @@ +## Title: UnitClass + +**Content:** +Returns the class of the unit. +```lua +className, classFilename, classId = UnitClass(unit) +classFilename, classId = UnitClassBase(unit) +``` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Values:** +| ID | className (enUS) | classFile | Description | +|-----|------------------|--------------|---------------| +| 1 | Warrior | WARRIOR | | +| 2 | Paladin | PALADIN | | +| 3 | Hunter | HUNTER | | +| 4 | Rogue | ROGUE | | +| 5 | Priest | PRIEST | | +| 6 | Death Knight | DEATHKNIGHT | Added in 3.0.2| +| 7 | Shaman | SHAMAN | | +| 8 | Mage | MAGE | | +| 9 | Warlock | WARLOCK | | +| 10 | Monk | MONK | Added in 5.0.4| +| 11 | Druid | DRUID | | +| 12 | Demon Hunter | DEMONHUNTER | Added in 7.0.3| +| 13 | Evoker | EVOKER | Added in 10.0.0| + +**Returns:** +- `className` + - *string* - Localized name, e.g. "Warrior" or "Guerrier". +- `classFilename` + - *string* - Locale-independent name, e.g. "WARRIOR". +- `classId` + - *number* : ClassId + +**Usage:** +```lua +/dump UnitClass("target") -- "Mage", "MAGE", 8 +/dump UnitClassBase("target") -- "MAGE", 8 +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitClassification.md b/wiki-information/functions/UnitClassification.md new file mode 100644 index 00000000..cd48afe1 --- /dev/null +++ b/wiki-information/functions/UnitClassification.md @@ -0,0 +1,26 @@ +## Title: UnitClassification + +**Content:** +Returns the classification of the specified unit (e.g., "elite" or "worldboss"). +`classification = UnitClassification(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `classification` + - *string* - the unit's classification: "worldboss", "rareelite", "elite", "rare", "normal", "trivial", or "minus" + - Note that "trivial" is for low-level targets that would not reward experience or honor (UnitIsTrivial() would return '1'), whereas "minus" is for mobs that show a miniature version of the v-key health plates. + +**Usage:** +```lua +if ( UnitClassification("target") == "worldboss" ) then + -- If unit is a world boss show skull regardless of level + TargetLevelText:Hide(); + TargetHighLevelTexture:Show(); +end +``` + +**Result:** +If the target is a world boss, then the level isn't shown in the target frame, instead a special high level texture is shown. \ No newline at end of file diff --git a/wiki-information/functions/UnitControllingVehicle.md b/wiki-information/functions/UnitControllingVehicle.md new file mode 100644 index 00000000..b334a4c5 --- /dev/null +++ b/wiki-information/functions/UnitControllingVehicle.md @@ -0,0 +1,19 @@ +## Title: UnitControllingVehicle + +**Content:** +Needs summary. +`controllingVehicle = UnitControllingVehicle(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `controllingVehicle` + - *boolean* + +**Example Usage:** +This function can be used to determine if a specific unit is currently controlling a vehicle. This is particularly useful in scenarios where vehicle mechanics are involved, such as certain battlegrounds or quests. + +**Addons:** +Large addons like Deadly Boss Mods (DBM) might use this function to provide alerts or warnings when a player is controlling a vehicle during a boss encounter or specific event. \ No newline at end of file diff --git a/wiki-information/functions/UnitCreatureFamily.md b/wiki-information/functions/UnitCreatureFamily.md new file mode 100644 index 00000000..d310e286 --- /dev/null +++ b/wiki-information/functions/UnitCreatureFamily.md @@ -0,0 +1,111 @@ +## Title: UnitCreatureFamily + +**Content:** +Returns the creature type of the unit (e.g. Crab). +`creatureFamily = UnitCreatureFamily(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - unit you wish to query. + +**Returns:** +- `creatureFamily` + - *string* - localized name of the creature family (e.g., "Crab" or "Wolf"). Known return values include: + - **enUS** + - **deDE** + - **Creature Type** + - Aqiri + - Aqir + - Beast + - Basilisk + - Bat + - Bear + - Beetle + - Bird of Prey + - Blood Beast + - Boar + - Camel + - Carapid + - Carrion Bird + - Cat + - Chimaera + - Clefthoof + - Core Hound + - Courser + - Crab + - Crocolisk + - Devilsaur + - Direhorn + - Dragonhawk + - Feathermane + - Fox + - Gorilla + - Gruffhorn + - Hound + - Hydra + - Hyena + - Lesser Dragonkin + - Lizard + - Mammoth + - Mechanical + - Monkey + - Moth + - Oxen + - Pterrordax + - Raptor + - Ravager + - Ray + - Riverbeast + - Rodent + - Scalehide + - Scorpid + - Serpent + - Shale Beast + - Spider + - Spirit Beast + - Sporebat + - Stag + - Stone Hound + - Tallstrider + - Toad + - Turtle + - Warp Stalker + - Wasp + - Water Strider + - Waterfowl + - Wind Serpent + - Wolf + - Worm + - Demon + - Fel Imp + - Felguard + - Felhunter + - Imp + - Incubus + - Observer + - Shivarra + - Succubus + - Void Lord + - Voidwalker + - Wrathguard + - Elemental + - Fire Elemental + - Storm Elemental + - Water Elemental + - Undead + - Abomination + - Ghoul + - Mechanical + - Remote Control + +**Description:** +Does not work on all creatures, since the family's primary function is to determine what abilities the unit will have if a player is able to control it. However, it does work on almost all Beasts, even if they are not tameable by Hunters. +Returns nil if the creature doesn't belong to a family that includes a tameable creature. + +**Usage:** +Displays a message if the target is a type of bear. +```lua +if ( UnitCreatureFamily("target") == "Bear" ) then + message("It's a godless killing machine! Run for your lives!"); +end +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitCreatureType.md b/wiki-information/functions/UnitCreatureType.md new file mode 100644 index 00000000..aac19ac1 --- /dev/null +++ b/wiki-information/functions/UnitCreatureType.md @@ -0,0 +1,49 @@ +## Title: UnitCreatureType + +**Content:** +Returns the creature classification type of the unit (e.g. Beast). +`creatureType = UnitCreatureType(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit to query creature type of. + +**Returns:** +- `creatureType` + - *string* - the localized creature type of the unit, or nil if the unit does not exist, or if the unit's creature type isn't available. + +**Description:** +The default Blizzard UI displays an empty string instead of "Not specified" for units with that creature type. Warcraft Wiki refers to these units as "Uncategorized". + +Known return values include: +- enUS +- deDE +- esES +- esMX +- frFR +- itIT +- ptBR +- ruRU +- koKR +- zhCN +- zhTW + +| enUS | deDE | esES | esMX | frFR | itIT | ptBR | ruRU | koKR | zhCN | zhTW | +|--------------|-----------------|--------------|--------------|----------------|--------------|--------------|---------------------|------------|------------|------------| +| Aberration | Wildtier | Bestia | Bestia | Bête | Bestia | Fera | Животное | 야수 | 野兽 | 野兽 | +| Critter | Kleintier | Alma | Alma | Bestiole | Animale | Bicho | Существо | 동물 | 小动物 | 小动物 | +| Demon | Dämon | Demonio | Demonio | Démon | Demone | Demônio | Демон | 악마 | 恶魔 | 恶魔 | +| Dragonkin | Drachkin | Dragon | Dragón | Draconien | Dragoide | Dracônico | Дракон | 용족 | 龙类 | 龙类 | +| Elemental | Elementar | Elemental | Elemental | Élémentaire | Elementale | Elemental | Элементаль | 정령 | 元素生物 | 元素生物 | +| Gas Cloud | Gaswolke | Nube de Gas | Nube de Gas | Nuage de gaz | Nube di Gas | Gasoso | Газовое облако | 가스 | 气体云 | 气体云 | +| Giant | Riese | Gigante | Gigante | Géant | Gigante | Gigante | Великан | 거인 | 巨人 | 巨人 | +| Humanoid | Humanoid | Humanoide | Humanoide | Humanoïde | Umanoide | Humanoide | Гуманоид | 인간형 | 人型生物 | 人型生物 | +| Mechanical | Mechanisch | Mecánico | Mecánico | Machine | Meccanico | Mecânico | Механизм | 기계 | 机械 | 机械 | +| Non-combat Pet | Haustier | Mascota no combatiente | Mascota mansa | Familier pacifique | Animale Non combattente | Mascote não-combatente | Спутник | 애완동물 | 非战斗宠物 | 非战斗宠物 | +| Not specified | Nicht spezifiziert | No especificado | Sin especificar | Non spécifié | Non Specificato | Não especificado | Не указано | 기타 | 未指定 | 不明 | +| Totem | Totem | Tótem | Totém | Totem | Totem | Totem | Тотем | 토템 | 图腾 | 图腾 | +| Undead | Untoter | No-muerto | No-muerto | Mort-vivant | Non Morto | Renegado | Нежить | 언데드 | 亡灵 | 不死族 | +| Wild Pet | Ungezähmtes Tier | Mascotte sauvage | | | | | | | | | + +**Reference:** +[LibBabble-CreatureType-3.0](https://www.wowace.com/projects/libbabble-creaturetype-3-0) \ No newline at end of file diff --git a/wiki-information/functions/UnitDamage.md b/wiki-information/functions/UnitDamage.md new file mode 100644 index 00000000..6b9d1688 --- /dev/null +++ b/wiki-information/functions/UnitDamage.md @@ -0,0 +1,28 @@ +## Title: UnitDamage + +**Content:** +Returns the damage stats for the unit. +`minDamage, maxDamage, offhandMinDamage, offhandMaxDamage, posBuff, negBuff, percent = UnitDamage(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - Likely only works for "player" and "pet". Possibly for "target". + +**Returns:** +- `minDamage` + - *number* - The unit's minimum melee damage. +- `maxDamage` + - *number* - The unit's maximum melee damage. +- `offhandMinDamage` + - *number* - The unit's minimum offhand melee damage. +- `offhandMaxDamage` + - *number* - The unit's maximum offhand melee damage. +- `posBuff` + - *number* - positive physical Bonus (should be >= 0) +- `negBuff` + - *number* - negative physical Bonus (should be <= 0) +- `percent` + - *number* - percentage modifier (usually 1; 0.9 for warriors in defensive stance) + +**Description:** +Doesn't seem to return usable values for mobs, NPCs. The method returns 7 values, only some of which appear to be useful. \ No newline at end of file diff --git a/wiki-information/functions/UnitDebuff.md b/wiki-information/functions/UnitDebuff.md new file mode 100644 index 00000000..df1d1071 --- /dev/null +++ b/wiki-information/functions/UnitDebuff.md @@ -0,0 +1,184 @@ +## Title: UnitAura + +**Content:** +Returns the buffs/debuffs for the unit. +```lua +name, icon, count, dispelType, duration, expirationTime, source, isStealable, nameplateShowPersonal, +spellId, canApplyAura, isBossDebuff, castByPlayer, nameplateShowAll, timeMod, ... + = UnitAura(unit, index) + = UnitBuff(unit, index) + = UnitDebuff(unit, index) +``` + +**Parameters:** +- `unit` + - *string* : UnitId +- `index` + - *number* - Index of an aura to query. +- `filter` + - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". + +**Miscellaneous:** +- `UnitBuff()` is an alias for `UnitAura(unit, index, "HELPFUL")`, returning only buffs. +- `UnitDebuff()` is an alias for `UnitAura(unit, index, "HARMFUL")`, returning only debuffs. + +**Filter Descriptions:** +- `"HELPFUL"`: Buffs +- `"HARMFUL"`: Debuffs +- `"PLAYER"`: Auras/Debuffs applied by the player +- `"RAID"`: Buffs the player can apply and debuffs the player can dispel +- `"CANCELABLE"`: Buffs that can be cancelled with `/cancelaura` or `CancelUnitBuff()` +- `"NOT_CANCELABLE"`: Buffs that cannot be cancelled +- `"INCLUDE_NAME_PLATE_ONLY"`: Auras that should be shown on nameplates +- `"MAW"`: Torghast Anima Powers + +**Aura Util:** + +**ForEachAura:** +```lua +AuraUtil.ForEachAura(unit, filter, func) +``` +This is recommended for iterating over auras. For example, to print all buffs: +```lua +AuraUtil.ForEachAura("player", "HELPFUL", nil, function(name, icon, ...) + print(name, icon, ...) +end) +``` +The callback function should return true once it's fine to stop processing further auras. +```lua +local function foo(name, icon, _, _, _, _, _, _, _, spellId, ...) + if spellId == 21562 then -- Power Word: Fortitude + -- do stuff + return true + end +end +AuraUtil.ForEachAura("player", "HELPFUL", nil, foo) +``` + +**FindAuraByName:** +```lua +AuraUtil.FindAuraByName(name, unit) +``` +Finds the first aura that matches the name, but note that: +- Aura names are not unique, this will only find the first match. +- Aura names are localized, what works in one locale might not work in another. +```lua +/dump AuraUtil.FindAuraByName("Power Word: Fortitude", "player") +``` +Remember to specify the "HARMFUL" filter for debuffs. +```lua +/dump AuraUtil.FindAuraByName("Weakened Soul", "player", "HARMFUL") +``` + +**Returns:** +Returns nil when there is no aura for that index or when the aura doesn't pass the filter. +1. `name` + - *string* - The localized name of the aura, otherwise nil if there is no aura for the index. +2. `icon` + - *number* : FileID - The icon texture. +3. `count` + - *number* - The amount of stacks, otherwise 0. +4. `dispelType` + - *string?* - The locale-independent magic type of the aura: Curse, Disease, Magic, Poison, otherwise nil. +5. `duration` + - *number* - The full duration of the aura in seconds. +6. `expirationTime` + - *number* - Time the aura expires compared to `GetTime()`, e.g. to get the remaining duration: `expirationTime - GetTime()` +7. `source` + - *string* : UnitId - The unit that applied the aura. +8. `isStealable` + - *boolean* - If the aura may be stolen. +9. `nameplateShowPersonal` + - *boolean* - If the aura should be shown on the player/pet/vehicle nameplate. +10. `spellId` + - *number* - The spell ID for e.g. `GetSpellInfo()` +11. `canApplyAura` + - *boolean* - If the player can apply the aura. +12. `isBossDebuff` + - *boolean* - If the aura was cast by a boss. +13. `castByPlayer` + - *boolean* - If the aura was applied by a player. +14. `nameplateShowAll` + - *boolean* - If the aura should be shown on nameplates. +15. `timeMod` + - *number* - The scaling factor used for displaying time left. +16. `shouldConsolidate` + - *boolean* - Whether to consolidate auras, only exists in Classic Era/Wrath. +17. `...` + - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. + +**Description:** +- `UnitBuff()` will ignore any HARMFUL filter, and vice versa `UnitDebuff()` will ignore any HELPFUL filter. +- Filters can be mutually exclusive, e.g. "HELPFUL|HARMFUL" will always return nothing. +- On retail, a unit can have an unlimited amount of buffs/debuffs. +- The debuff limit is at 16 for Classic Era and 40 for BCC. + +**Related Events:** +- `UNIT_AURA` + +**World Buffs:** +If the unit has the buff, then the world buffs can be selected from the return values. For example: +```lua +select(20, UnitBuff("player", index)) +``` + +**Buff Types and Descriptions:** +- `Fengus' Ferocity` + - *number* - Duration +- `Mol'dar's Moxie` + - *number* - Duration +- `Slip'kik's Savvy` + - *number* - Duration +- `Rallying Cry of the Dragonslayer` + - *number* - Duration +- `Warchief's Blessing` + - *number* - Duration +- `Spirit of Zandalar` + - *number* - Duration +- `Songflower Serenade` + - *number* - Duration +- `Sayge's Fortune` + - *number* - Duration of the chosen buff +- `Sayge's Fortune` + - *number* - spellID of the chosen buff +- `Boon of Blackfathom` + - *number* - Duration +- `Spark of Inspiration` + - *number* - Duration +- `Fervor of the Temple Explorer` + - *number* - Duration + +**Usage:** +Prints the third aura on the target. +```lua +/dump UnitAura("target", 3) +``` +Returns: +- `"Power Word: Fortitude"` -- name +- `135987` -- icon +- `0` -- count +- `"Magic"` -- dispelType +- `3600` -- duration +- `112994.871` -- expirationTime +- `"player"` -- source +- `false` -- isStealable +- `false` -- nameplateShowPersonal +- `21562` -- spellID +- `true` -- canApplyAura +- `false` -- isBossDebuff +- `true` -- castByPlayer +- `false` -- nameplateShowAll +- `1` -- timeMod +- `5` -- attribute1: Stamina increased by 5% +- `0` -- attribute2: Magic damage taken reduced by 0% (Thorghast Enchanted Shroud power) + +The following are equivalent. Prints the first debuff applied by the player on the target. +```lua +/dump UnitAura("target", 1, "PLAYER|HARMFUL") +/dump UnitDebuff("target", 1, "PLAYER") +``` + +`GetPlayerAuraBySpellID()` is useful for checking only a specific aura on the player character. +```lua +/dump GetPlayerAuraBySpellID(21562) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitDetailedThreatSituation.md b/wiki-information/functions/UnitDetailedThreatSituation.md new file mode 100644 index 00000000..ee21931b --- /dev/null +++ b/wiki-information/functions/UnitDetailedThreatSituation.md @@ -0,0 +1,75 @@ +## Title: UnitDetailedThreatSituation + +**Content:** +Returns detailed info for the threat status of one unit against another. +`isTanking, status, scaledPercentage, rawPercentage, rawThreat = UnitDetailedThreatSituation(unit, mobGUID)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The player or pet whose threat to request. +- `mobGUID` + - *string* : UnitToken - The NPC whose threat table to query. + +**Returns:** +- `isTanking` + - *boolean* - Returns true if the unit is the primary threat target of the mobUnit, returns false otherwise. +- `status` + - *number* - Threat status of the unit on the mobUnit. +- `scaledPercentage` + - *number* - The unit's threat percentage against mobUnit. At 100% the unit will become the primary target. This value is also scaled the closer the unit is to the mobUnit. +- `rawPercentage` + - *number* - The unit's threat percentage against mobUnit relative to the threat of mobUnit's primary target. Can be greater than 100, up to 255. Stops updating when you become the primary target. +- `threatValue` + - *number* - The unit's total threat value on the mobUnit. + +**Status Values:** +- `status` + - `Value` + - `High Threat` + - `Primary Target` + - `Description` + - `nil` + - Unit is not on (any) mobUnit's threat table. + - `0` + - ❌ + - ❌ + - Unit has less than 100% threat for mobUnit. The default UI shows no indicator. + - `1` + - ✔️ + - ❌ + - Unit has higher than 100% threat for mobUnit, but isn't the primary target. The default UI shows a yellow indicator. + - `2` + - ❌ + - ✔️ + - Unit is the primary target for mobUnit, but another unit has higher than 100% threat. The default UI shows an orange indicator. + - `3` + - ✔️ + - ✔️ + - Unit is the primary target for mobUnit and no other unit has higher than 100% threat. The default UI shows a red indicator. + +**Description:** +From wowprogramming.com's API reference: +"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 self-buff, a priest's 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 unit and mobUnit is only returned if the unit has threat against the mobUnit in question. In addition, no threat data is provided if a unit's pet is attacking an NPC but the unit himself has taken no action, even though the pet has threat against the NPC.)" +When mobs are socially pulled (i.e. they aggro indirectly, as a result of another nearby mob being pulled), 'status' often sets to 0 instead of 3, despite the player having aggro. + +**Usage:** +- `/dump UnitDetailedThreatSituation("player", "target")` + - You have 100% threat on the targeted NPC. + - `true, 3, 100, 100, 15` + - You have partial threat on the targeted NPC: 66% threat on the mobUnit, 73% threat relative to the primary target, threat value amount of 25. + - `false, 0, 66.363632202148, 73, 25` + +**Reference:** +- `UnitThreatSituation()` +- `GetThreatStatusColor()` +- `UNIT_THREAT_SITUATION_UPDATE` +- `UNIT_THREAT_LIST_UPDATE` +- `threatShowNumeric` + +**External Resources:** +- [Wowhead Classic WoW Threat Guide by Ragorism](https://classic.wowhead.com/guides/classic-wow-threat-guide) \ No newline at end of file diff --git a/wiki-information/functions/UnitDistanceSquared.md b/wiki-information/functions/UnitDistanceSquared.md new file mode 100644 index 00000000..41714910 --- /dev/null +++ b/wiki-information/functions/UnitDistanceSquared.md @@ -0,0 +1,22 @@ +## Title: UnitDistanceSquared + +**Content:** +Returns the squared distance to a unit in your group. +`distanceSquared, checkedDistance = UnitDistanceSquared(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit id of a player in your group. + +**Returns:** +- `distanceSquared` + - *number* - the squared distance to that unit +- `checkedDistance` + - *boolean* - true if the distance result is valid, false otherwise (e.g., unit not found or not in your group) + +**Example Usage:** +This function can be used in scenarios where you need to determine the distance between players in a group, such as in raid addons to check if players are within a certain range for buffs or abilities. + +**Addons Using This Function:** +- **Deadly Boss Mods (DBM):** Uses this function to determine if players are within range of each other for certain boss mechanics. +- **WeakAuras:** Can use this function to create custom auras that trigger based on the distance between group members. \ No newline at end of file diff --git a/wiki-information/functions/UnitEffectiveLevel.md b/wiki-information/functions/UnitEffectiveLevel.md new file mode 100644 index 00000000..af7e64b6 --- /dev/null +++ b/wiki-information/functions/UnitEffectiveLevel.md @@ -0,0 +1,19 @@ +## Title: UnitEffectiveLevel + +**Content:** +Returns the unit's effective (scaled) level. +`level = UnitEffectiveLevel(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `level` + - *number* + +**Description:** +When inebriated, the apparent level of hostile units is lowered by up to 5. + +**Reference:** +[UnitLevel](#) \ No newline at end of file diff --git a/wiki-information/functions/UnitExists.md b/wiki-information/functions/UnitExists.md new file mode 100644 index 00000000..bb147a68 --- /dev/null +++ b/wiki-information/functions/UnitExists.md @@ -0,0 +1,23 @@ +## Title: UnitExists + +**Content:** +Returns true if the unit exists. +`exists = UnitExists(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `exists` + - *boolean* - true if the unit exists and is in the current zone, or false if not + +**Usage:** +The snippet below prints a message describing what the player is targeting. +```lua +if UnitExists("target") then + print("You're targeting a " .. UnitName("target")) +else + print("You have no target") +end +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitFactionGroup.md b/wiki-information/functions/UnitFactionGroup.md new file mode 100644 index 00000000..4097bd92 --- /dev/null +++ b/wiki-information/functions/UnitFactionGroup.md @@ -0,0 +1,31 @@ +## Title: UnitFactionGroup + +**Content:** +Returns the faction (Horde/Alliance) a unit belongs to. +`englishFaction, localizedFaction = UnitFactionGroup(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `englishFaction` + - *string* - Unit's faction name in English, i.e. "Alliance", "Horde", "Neutral" or nil. +- `localizedFaction` + - *string* - Unit's faction name in the client's locale or nil. + +**Description:** +The function may not return correct results until after the `PLAYER_ENTERING_WORLD` event for units other than "player". +Note that for NPCs, the function will only return Alliance/Horde for factions closely allied with either side. Goblins, for instance, return nil,nil. +Pandaren player characters on the Wandering Isle return "Neutral", "". + +**Example Usage:** +```lua +local englishFaction, localizedFaction = UnitFactionGroup("player") +print("Faction in English: ", englishFaction) +print("Faction in Localized: ", localizedFaction) +``` + +**Addons Using This Function:** +- **Recount**: Uses `UnitFactionGroup` to differentiate between factions when displaying damage and healing statistics. +- **Details! Damage Meter**: Utilizes this function to provide faction-specific data breakdowns in battlegrounds and world PvP scenarios. \ No newline at end of file diff --git a/wiki-information/functions/UnitFullName.md b/wiki-information/functions/UnitFullName.md new file mode 100644 index 00000000..aaffbbc1 --- /dev/null +++ b/wiki-information/functions/UnitFullName.md @@ -0,0 +1,63 @@ +## Title: UnitName + +**Content:** +Returns the name and realm of the unit. +```lua +name, realm = UnitName(unit) +name, realm = UnitFullName(unit) +name, realm = UnitNameUnmodified(unit) +``` + +**Parameters:** +- `unit` + - *string* : UnitId - For example "player" or "target" + +**Returns:** +- `name` + - *string?* - The name of the unit. Returns nil if the unit doesn't exist, e.g. the player has no target selected. +- `realm` + - *string?* - The normalized realm the unit is from, e.g. "DarkmoonFaire". Returns nil if the unit is from the same realm. + +**Description:** +Will return globalstring `UNKNOWNOBJECT` "Unknown Entity" if called before the unit in question has been fully loaded into the world. +The unit name will change if the unit is under the effects of or a similar effect, but `UnitNameUnmodified()` is unaffected by this. + +**Usage:** +Prints your character's name. +```lua +/dump UnitName("player") -- "Leeroy", nil +``` +Prints the name and realm of your target (if different). +```lua +/dump UnitName("target") -- "Thegnome", "DarkmoonFaire" +``` +`UnitFullName()` is equivalent with `UnitName()` except it will always return realm if used with the "player" UnitId. +```lua +/dump UnitFullName("player") -- "Leeroy", "MoonGuard" +/dump UnitFullName("target") -- "Leeroy", nil +``` + +**Miscellaneous:** +`GetUnitName(unit, showServerName)` can return the combined unit and realm name. +- If `showServerName` is true and the queried unit is from a different server, then the return value will include the unit's name appended by a dash and the normalized realm name. +- If `showServerName` is false, then `FOREIGN_SERVER_LABEL` " (*)" will be appended to units from coalesced realms. Units from the player's own realm or Connected Realms get no additional suffix. + +Examples: +- Unit is from the same realm. + ```lua + /dump GetUnitName("target", true) -- "Nephertiri" + /dump GetUnitName("target", false) -- "Nephertiri" + ``` +- Unit is from a different realm but the same Connected Realm (`LE_REALM_RELATION_VIRTUAL`). + ```lua + /dump GetUnitName("target", true) -- "Standron-EarthenRing" + /dump GetUnitName("target", false) -- "Standron" + ``` +- Unit is from a different, non-connected realm (`LE_REALM_RELATION_COALESCED`). + ```lua + /dump GetUnitName("target", true) -- "Celturio-Quel'Thalas" + /dump GetUnitName("target", false) -- "Celturio (*)" + ``` + +**Reference:** +- `Ambiguate()` \ No newline at end of file diff --git a/wiki-information/functions/UnitGUID.md b/wiki-information/functions/UnitGUID.md new file mode 100644 index 00000000..b27da71f --- /dev/null +++ b/wiki-information/functions/UnitGUID.md @@ -0,0 +1,42 @@ +## Title: UnitGUID + +**Content:** +Returns the GUID of the unit. +`guid = UnitGUID(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - For example "player" or "target" + +**Returns:** +- `guid` + - *string?* : GUID - A string containing (hexadecimal) values, delimited with hyphens. Returns nil if the unit does not exist. + +**Usage:** +Prints the target's GUID, in this case a creature. +```lua +/dump UnitName("target"), UnitGUID("target") +> "Hogger", "Creature-0-1465-0-2105-448-000043F59F" +``` +Prints the npc/player ID of a unit, if applicable. +```lua +local unitLink = "|cffffff00|Hunit:%s|h|h|r" +local function ParseGUID(unit) + local guid = UnitGUID(unit) + local name = UnitName(unit) + if guid then + local link = unitLink:format(guid, name) -- clickable link + local unit_type = strsplit("-", guid) + if unit_type == "Creature" or unit_type == "Vehicle" then + local _, _, server_id, instance_id, zone_uid, npc_id, spawn_uid = strsplit("-", guid) + print(format("%s is a creature with NPC ID %d", link, npc_id)) + elseif unit_type == "Player" then + local _, server_id, player_id = strsplit("-", guid) + print(format("%s is a player with ID %s", link, player_id)) + end + end +end +``` + +**Reference:** +- `GetPlayerInfoByGUID()` \ No newline at end of file diff --git a/wiki-information/functions/UnitGetAvailableRoles.md b/wiki-information/functions/UnitGetAvailableRoles.md new file mode 100644 index 00000000..b6af4e08 --- /dev/null +++ b/wiki-information/functions/UnitGetAvailableRoles.md @@ -0,0 +1,20 @@ +## Title: UnitGetAvailableRoles + +**Content:** +Returns the recommended roles for a specified unit. +`tank, heal, dps = UnitGetAvailableRoles(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `tank` + - *boolean* - Whether the unit can perform as a tank +- `heal` + - *boolean* - Whether the unit can perform as a healer +- `dps` + - *boolean* - Whether the unit can perform as a dps + +**Notes and Caveats:** +Although the Group Finder allows every class to pick any role, for some there is a warning that it is not recommended (e.g., healer as a Warrior). This function returns results based on the same logic. \ No newline at end of file diff --git a/wiki-information/functions/UnitGetIncomingHeals.md b/wiki-information/functions/UnitGetIncomingHeals.md new file mode 100644 index 00000000..7aa737ee --- /dev/null +++ b/wiki-information/functions/UnitGetIncomingHeals.md @@ -0,0 +1,26 @@ +## Title: UnitGetIncomingHeals + +**Content:** +Returns the predicted heals cast on the specified unit. +`heal = UnitGetIncomingHeals(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken +- `healerGUID` + - *string?* : UnitToken - Only predict incoming heals from a single UnitId. + +**Returns:** +- `heal` + - *number* - Predicted increase in health from incoming heals. + +**Description:** +For Classic, this function is only partially functional. The returned value only predicts healing from direct spell casts; heal-over-time effects and channeled casts are not factored into any predictions. + +**Reference:** +- `UnitHealth` +- `UnitHealthMax` +- `UnitGetTotalAbsorbs` + +**References:** +- [WoWUIBugs Issue #163](https://github.com/Stanzilla/WoWUIBugs/issues/163) \ No newline at end of file diff --git a/wiki-information/functions/UnitGroupRolesAssigned.md b/wiki-information/functions/UnitGroupRolesAssigned.md new file mode 100644 index 00000000..af4ca70c --- /dev/null +++ b/wiki-information/functions/UnitGroupRolesAssigned.md @@ -0,0 +1,13 @@ +## Title: UnitGroupRolesAssigned + +**Content:** +Returns the assigned role in a group formed via the Dungeon Finder Tool. +`role = UnitGroupRolesAssigned(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `role` + - *string* - TANK, HEALER, DAMAGER, NONE \ No newline at end of file diff --git a/wiki-information/functions/UnitHPPerStamina.md b/wiki-information/functions/UnitHPPerStamina.md new file mode 100644 index 00000000..55c57f2f --- /dev/null +++ b/wiki-information/functions/UnitHPPerStamina.md @@ -0,0 +1,19 @@ +## Title: UnitHPPerStamina + +**Content:** +Needs summary. +`hp = UnitHPPerStamina(unit)` + +**Parameters:** +- `unit` + - *string* - UnitToken + +**Returns:** +- `hp` + - *number* + +**Example Usage:** +This function can be used to determine the amount of health points (HP) a unit gains per point of stamina. This can be useful for addons that need to calculate or display health-related statistics. + +**Addons:** +While specific large addons using this function are not documented, it is likely used in various unit frame and combat-related addons to provide detailed health metrics. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasIncomingResurrection.md b/wiki-information/functions/UnitHasIncomingResurrection.md new file mode 100644 index 00000000..664fc9c7 --- /dev/null +++ b/wiki-information/functions/UnitHasIncomingResurrection.md @@ -0,0 +1,16 @@ +## Title: UnitHasIncomingResurrection + +**Content:** +Returns true if the unit is currently being resurrected. +`isBeingResurrected = UnitHasIncomingResurrection(unitID or UnitName)` + +**Parameters:** +- `unitID` + - *string* - either the unitID ("player", "target", "party3", etc) or unit's name ("Bob" or "Bob-Llane") + +**Returns:** +- `isBeingResurrected` + - *boolean* - Returns true if the unit is being resurrected by any means, be it spell, item, or some other method. Returns nil/false otherwise. + +**Description:** +This returns nil/false if the cast is completed and the unit has not yet accepted the resurrection. It is only true if the cast is in progress and the cast is some method of resurrection. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasLFGDeserter.md b/wiki-information/functions/UnitHasLFGDeserter.md new file mode 100644 index 00000000..f39e768b --- /dev/null +++ b/wiki-information/functions/UnitHasLFGDeserter.md @@ -0,0 +1,13 @@ +## Title: UnitHasLFGDeserter + +**Content:** +Returns whether the unit is currently unable to use the dungeon finder due to leaving a group prematurely. +`isDeserter = UnitHasLFGDeserter(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - the unit that would assist (e.g., "player" or "target") + +**Returns:** +- `isDeserter` + - *boolean* - true if the unit is currently an LFG deserter (and hence unable to use the dungeon finder), false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasLFGRandomCooldown.md b/wiki-information/functions/UnitHasLFGRandomCooldown.md new file mode 100644 index 00000000..ae20b810 --- /dev/null +++ b/wiki-information/functions/UnitHasLFGRandomCooldown.md @@ -0,0 +1,16 @@ +## Title: UnitHasLFGRandomCooldown + +**Content:** +Returns whether the unit is currently under the effects of the random dungeon cooldown. +`hasRandomCooldown = UnitHasLFGRandomCooldown(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - the unit that would assist (e.g., "player" or "target") + +**Returns:** +- `hasRandomCooldown` + - *boolean* - true if the unit is currently unable to queue for random dungeons due to the random cooldown, false otherwise. + +**Description:** +Players may also be prevented from using the dungeon finder entirely, as part of the dungeon finder deserter effect. Use `UnitHasLFGDeserter("unit")` to query that. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasRelicSlot.md b/wiki-information/functions/UnitHasRelicSlot.md new file mode 100644 index 00000000..eaf4f931 --- /dev/null +++ b/wiki-information/functions/UnitHasRelicSlot.md @@ -0,0 +1,19 @@ +## Title: UnitHasRelicSlot + +**Content:** +Needs summary. +`hasRelicSlot = UnitHasRelicSlot(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `hasRelicSlot` + - *boolean* + +**Example Usage:** +This function can be used to determine if a specific unit has a relic slot. This is particularly useful for addons that manage or display information about equipment slots. + +**Addons Using This Function:** +- **Pawn**: An addon that helps players find upgrades for their gear. It uses this function to check if a unit has a relic slot to provide accurate gear suggestions. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasVehiclePlayerFrameUI.md b/wiki-information/functions/UnitHasVehiclePlayerFrameUI.md new file mode 100644 index 00000000..818d4c96 --- /dev/null +++ b/wiki-information/functions/UnitHasVehiclePlayerFrameUI.md @@ -0,0 +1,29 @@ +## Title: UnitHasVehiclePlayerFrameUI + +**Content:** +Needs summary. +`hasVehicleUI = UnitHasVehiclePlayerFrameUI()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `hasVehicleUI` + - *boolean* + +**Example Usage:** +This function can be used to determine if a unit (such as a player) currently has a vehicle UI. This is useful in scenarios where the UI needs to adapt based on whether the player is controlling a vehicle. + +**Example:** +```lua +local unit = "player" +if UnitHasVehiclePlayerFrameUI(unit) then + print("Player is in a vehicle.") +else + print("Player is not in a vehicle.") +end +``` + +**Addons:** +Large addons like **ElvUI** and **Bartender4** use this function to adjust the user interface when the player enters or exits a vehicle, ensuring that the vehicle's abilities and controls are properly displayed. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasVehicleUI.md b/wiki-information/functions/UnitHasVehicleUI.md new file mode 100644 index 00000000..e0e6eb90 --- /dev/null +++ b/wiki-information/functions/UnitHasVehicleUI.md @@ -0,0 +1,19 @@ +## Title: UnitHasVehicleUI + +**Content:** +Needs summary. +`hasVehicleUI = UnitHasVehicleUI()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `hasVehicleUI` + - *boolean* + +**Example Usage:** +This function can be used to determine if a unit is currently using a vehicle UI. This is particularly useful in scenarios where the player's interface changes due to vehicle control, such as in certain quests or battlegrounds. + +**Addons Usage:** +Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** may use this function to adjust the UI dynamically when the player enters or exits a vehicle, ensuring that the interface remains functional and informative. \ No newline at end of file diff --git a/wiki-information/functions/UnitHealth.md b/wiki-information/functions/UnitHealth.md new file mode 100644 index 00000000..724bd2f7 --- /dev/null +++ b/wiki-information/functions/UnitHealth.md @@ -0,0 +1,25 @@ +## Title: UnitHealth + +**Content:** +Returns the current health of the unit. +`health = UnitHealth(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken +- `usePredicted` + - *boolean?* = true + +**Returns:** +- `health` + - *number* - Returns 0 if the unit is dead or does not exist. + +**Description:** +Related Events: +- `UNIT_HEALTH` + +Available after: +- `PLAYER_ENTERING_WORLD` (on login) + +**Reference:** +- Kaivax 2020-02-18. UI API Change for UnitHealth. \ No newline at end of file diff --git a/wiki-information/functions/UnitHealthMax.md b/wiki-information/functions/UnitHealthMax.md new file mode 100644 index 00000000..922b9246 --- /dev/null +++ b/wiki-information/functions/UnitHealthMax.md @@ -0,0 +1,30 @@ +## Title: UnitHealthMax + +**Content:** +Returns the maximum health of the unit. +`maxHealth = UnitHealthMax(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `maxHealth` + - *number* - Returns 0 if the unit does not exist. + +**Description:** +- **Related Events:** + - `UNIT_MAXHEALTH` +- **Available after:** + - `PLAYER_ENTERING_WORLD` (on login) + +**Example Usage:** +```lua +local unit = "player" +local maxHealth = UnitHealthMax(unit) +print("Maximum Health of the player: ", maxHealth) +``` + +**Common Addon Usage:** +- **Deadly Boss Mods (DBM):** Uses `UnitHealthMax` to determine the maximum health of bosses and players to provide accurate health percentage displays during encounters. +- **Recount:** Utilizes `UnitHealthMax` to track and display the maximum health of units for detailed combat analysis and reporting. \ No newline at end of file diff --git a/wiki-information/functions/UnitInAnyGroup.md b/wiki-information/functions/UnitInAnyGroup.md new file mode 100644 index 00000000..0b6199e9 --- /dev/null +++ b/wiki-information/functions/UnitInAnyGroup.md @@ -0,0 +1,13 @@ +## Title: UnitInAnyGroup + +**Content:** +Returns whether or not the targeted unit is in a Group of any type. Instance, raid, party, etc. +`inGroup = UnitInAnyGroup(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit token of the unit to check group status for. Always returns false if no unit is provided. + +**Returns:** +- `inGroup` + - *boolean* - True if the target is in a group, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitInBattleground.md b/wiki-information/functions/UnitInBattleground.md new file mode 100644 index 00000000..081fe401 --- /dev/null +++ b/wiki-information/functions/UnitInBattleground.md @@ -0,0 +1,32 @@ +## Title: UnitInBattleground + +**Content:** +Returns the unit index if the unit is in your battleground. +`position = UnitInBattleground(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `position` + - *number* - The position in the battleground raid of the specified unit, `nil` if outside of the battleground, and 0 if `unit` is `player` and player is the last person left standing inside of a finished battleground. + +**Usage:** +```lua +local position = UnitInBattleground("player"); +ChatFrame1:AddMessage('Position in battleground raid: ' .. (position or "(?)")); +``` + +**Miscellaneous:** +Result: + +Prints the player's position number in the battleground raid. e.g. (depending on number left in battleground raid when call is made) +- Position in battleground raid: (?) +- Position in battleground raid: 0 +- Position in battleground raid: 12 + +**Description:** +- Returns `nil` if outside of a battleground. +- Returns `0` if you are the last person inside of a battleground after the match is over, and everybody else has left. +- Returns 1-#, where # is the maximum number of players allowed in the battleground raid. \ No newline at end of file diff --git a/wiki-information/functions/UnitInParty.md b/wiki-information/functions/UnitInParty.md new file mode 100644 index 00000000..d9444b71 --- /dev/null +++ b/wiki-information/functions/UnitInParty.md @@ -0,0 +1,33 @@ +## Title: UnitInParty + +**Content:** +Returns true if the unit is a member of your party. +`inParty = UnitInParty(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `inParty` + - *boolean* - if the unit is in your party + +**Usage:** +```lua +if UnitInParty("target") then + print("Your target is in your party.") +else + print("Your target is not in your party.") +end +``` + +**Description:** +- Pets are not considered to be part of your party (but see `UnitPlayerOrPetInParty`). +- Battleground raid/party members are also not considered to be part of your party. +- `UnitInParty("player")` returns nil when you are not in a party. +- As of 2.0.3, `UnitInParty("player")` always returns 1, even when you are not in a party. +- `UnitInParty("player")` should return nil. (since patch 1.11.2, always returned 1 before) +- Use `GetNumPartyMembers` and `GetNumRaidMembers` to determine if you are in a party or raid. + +**Reference:** +- `UnitInRaid` \ No newline at end of file diff --git a/wiki-information/functions/UnitInPartyIsAI.md b/wiki-information/functions/UnitInPartyIsAI.md new file mode 100644 index 00000000..a671ebde --- /dev/null +++ b/wiki-information/functions/UnitInPartyIsAI.md @@ -0,0 +1,19 @@ +## Title: UnitInPartyIsAI + +**Content:** +Needs summary. +`result = UnitInPartyIsAI()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +This function can be used to determine if a unit in the party is controlled by AI. This is particularly useful in scenarios where you need to differentiate between player-controlled characters and AI-controlled characters, such as in certain PvE or PvP contexts. + +**Addons:** +Large addons like Deadly Boss Mods (DBM) might use this function to adjust strategies or warnings based on whether party members are AI-controlled, ensuring more accurate and relevant alerts during encounters. \ No newline at end of file diff --git a/wiki-information/functions/UnitInPhase.md b/wiki-information/functions/UnitInPhase.md new file mode 100644 index 00000000..7602b464 --- /dev/null +++ b/wiki-information/functions/UnitInPhase.md @@ -0,0 +1,16 @@ +## Title: UnitInPhase + +**Content:** +Returns if a unit is in the same phase. +`inPhase = UnitInPhase(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `inPhase` + - *boolean* + +**Reference:** +- `UNIT_PHASE` \ No newline at end of file diff --git a/wiki-information/functions/UnitInRaid.md b/wiki-information/functions/UnitInRaid.md new file mode 100644 index 00000000..459db124 --- /dev/null +++ b/wiki-information/functions/UnitInRaid.md @@ -0,0 +1,34 @@ +## Title: UnitInRaid + +**Content:** +Returns the index if the unit is in your raid group. +`index = UnitInRaid(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `index` + - *number* - same number in the raid UnitId, feed into `GetRaidRosterInfo` + +**Description:** +Pets are not considered to be part of your raid group. + +**Reference:** +- `UnitInParty()` + +**Example Usage:** +```lua +local unit = "player" +local raidIndex = UnitInRaid(unit) +if raidIndex then + print("Player is in the raid at index:", raidIndex) +else + print("Player is not in the raid.") +end +``` + +**Usage in Addons:** +- **DBM (Deadly Boss Mods):** This function is used to determine if a player is in a raid group to enable or disable raid-specific features and warnings. +- **ElvUI:** Utilizes this function to adjust UI elements based on whether the player is in a raid group, such as displaying raid frames. \ No newline at end of file diff --git a/wiki-information/functions/UnitInRange.md b/wiki-information/functions/UnitInRange.md new file mode 100644 index 00000000..b9bd47bf --- /dev/null +++ b/wiki-information/functions/UnitInRange.md @@ -0,0 +1,18 @@ +## Title: UnitInRange + +**Content:** +Returns true if the unit is within 40 yards range (25 yards for Evokers). +`inRange, checkedRange = UnitInRange(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `inRange` + - *boolean* - true if the unit is within 40 (25 for Evokers) yards of the player +- `checkedRange` + - *boolean* - true if a range check was actually performed; false if the information about distance to the queried unit is unavailable. + +**Note:** +UnitInRange("player") will return false, false outside of a group. \ No newline at end of file diff --git a/wiki-information/functions/UnitInSubgroup.md b/wiki-information/functions/UnitInSubgroup.md new file mode 100644 index 00000000..be6ebf54 --- /dev/null +++ b/wiki-information/functions/UnitInSubgroup.md @@ -0,0 +1,22 @@ +## Title: UnitInSubgroup + +**Content:** +Needs summary. +`inSubgroup = UnitInSubgroup()` + +**Parameters:** +- `unit` + - *string?* : UnitId +- `overridePartyType` + - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. + - `Value` + - `Enum` + - `Description` + - `1` + - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. + - `2` + - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder + +**Returns:** +- `inSubgroup` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitInVehicle.md b/wiki-information/functions/UnitInVehicle.md new file mode 100644 index 00000000..a8bdbfd0 --- /dev/null +++ b/wiki-information/functions/UnitInVehicle.md @@ -0,0 +1,19 @@ +## Title: UnitInVehicle + +**Content:** +Checks whether a specified unit is within a vehicle. +`inVehicle = UnitInVehicle(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `inVehicle` + - *boolean* + +**Example Usage:** +This function can be used to determine if a player or NPC is currently in a vehicle. This is particularly useful in scenarios where vehicle mechanics are involved, such as certain quests or battlegrounds. + +**Addons:** +Many large addons, such as Deadly Boss Mods (DBM), use this function to track player status during encounters that involve vehicles. This helps in providing accurate alerts and timers based on whether players are in or out of vehicles. \ No newline at end of file diff --git a/wiki-information/functions/UnitInVehicleControlSeat.md b/wiki-information/functions/UnitInVehicleControlSeat.md new file mode 100644 index 00000000..848aba3d --- /dev/null +++ b/wiki-information/functions/UnitInVehicleControlSeat.md @@ -0,0 +1,30 @@ +## Title: UnitInVehicleControlSeat + +**Content:** +Needs summary. +`inVehicle = UnitInVehicleControlSeat()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `inVehicle` + - *boolean* + +**Description:** +The `UnitInVehicleControlSeat` function checks if a specified unit is in the control seat of a vehicle. This can be useful in scenarios where you need to determine if a player or NPC is controlling a vehicle, such as in vehicle-based quests or battlegrounds. + +**Example Usage:** +```lua +local unit = "player" +if UnitInVehicleControlSeat(unit) then + print(unit .. " is in the control seat of a vehicle.") +else + print(unit .. " is not in the control seat of a vehicle.") +end +``` + +**Addons Using This Function:** +- **DBM (Deadly Boss Mods):** This addon may use `UnitInVehicleControlSeat` to track player status in vehicle-based encounters to provide accurate alerts and timers. +- **WeakAuras:** This powerful and flexible framework for displaying customizable graphics on your screen may use this function to create auras that trigger based on vehicle control status. \ No newline at end of file diff --git a/wiki-information/functions/UnitInVehicleHidesPetFrame.md b/wiki-information/functions/UnitInVehicleHidesPetFrame.md new file mode 100644 index 00000000..d7223de6 --- /dev/null +++ b/wiki-information/functions/UnitInVehicleHidesPetFrame.md @@ -0,0 +1,13 @@ +## Title: UnitInVehicleHidesPetFrame + +**Content:** +Needs summary. +`hidesPet = UnitInVehicleHidesPetFrame()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `hidesPet` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsAFK.md b/wiki-information/functions/UnitIsAFK.md new file mode 100644 index 00000000..38651733 --- /dev/null +++ b/wiki-information/functions/UnitIsAFK.md @@ -0,0 +1,28 @@ +## Title: UnitIsAFK + +**Content:** +Returns true if a friendly unit is AFK (Away from keyboard). +`isAFK = UnitIsAFK(unit)` + +**Parameters:** +- `unit` + - The UnitId to return AFK status of. A nil value throws an error. + +**Returns:** +- `isAFK` + - *boolean* - true if unit is AFK, false otherwise. An invalid or nonexistent unit value also returns false. + +**Usage:** +If the player is AFK, the following script outputs "You are AFK" to the default chat window. +```lua +if UnitIsAFK("player") then + DEFAULT_CHAT_FRAME:AddMessage("You are AFK"); +end +``` + +If the player is AFK, the following script outputs "You are AFK" to the default chat window. +```lua +if UnitIsAFK("player") then + DEFAULT_CHAT_FRAME:AddMessage("You are AFK"); +end +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsCharmed.md b/wiki-information/functions/UnitIsCharmed.md new file mode 100644 index 00000000..081776fb --- /dev/null +++ b/wiki-information/functions/UnitIsCharmed.md @@ -0,0 +1,13 @@ +## Title: UnitIsCharmed + +**Content:** +Returns true if the unit is charmed. +`isTrue = UnitIsCharmed(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `isTrue` + - *boolean* - true if the unit is charmed, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsCivilian.md b/wiki-information/functions/UnitIsCivilian.md new file mode 100644 index 00000000..69fc3476 --- /dev/null +++ b/wiki-information/functions/UnitIsCivilian.md @@ -0,0 +1,13 @@ +## Title: UnitIsCivilian + +**Content:** +Determine whether a unit is a civilian (low-level enemy faction NPC that counts as a dishonorable kill). +`isCivilian = UnitIsCivilian(unit)` + +**Parameters:** +- `unit` + - *string* - Only works on enemy faction NPCs. + +**Returns:** +- `isCivilian` + - *boolean* - Returns true if the unit is a civilian, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsConnected.md b/wiki-information/functions/UnitIsConnected.md new file mode 100644 index 00000000..519f1891 --- /dev/null +++ b/wiki-information/functions/UnitIsConnected.md @@ -0,0 +1,19 @@ +## Title: UnitIsConnected + +**Content:** +Returns true if the unit is connected to the game (i.e. not offline). +`isOnline = UnitIsConnected(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `isConnected` + - *boolean* + +**Example Usage:** +This function can be used to check if a player in your party or raid is currently online. For instance, in a raid management addon, you might use this to determine which players are available for an encounter. + +**Addons Using This Function:** +Many raid management and unit frame addons, such as ElvUI and Grid, use `UnitIsConnected` to display the online/offline status of players. This helps raid leaders and players to quickly identify who is available and who is not. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsControlling.md b/wiki-information/functions/UnitIsControlling.md new file mode 100644 index 00000000..df46709b --- /dev/null +++ b/wiki-information/functions/UnitIsControlling.md @@ -0,0 +1,19 @@ +## Title: UnitIsControlling + +**Content:** +Needs summary. +`isControlling = UnitIsControlling(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `isControlling` + - *boolean* + +**Example Usage:** +This function can be used to determine if a unit is currently controlling another unit, which can be useful in scenarios where you need to check if a player or NPC is controlling a pet or a vehicle. + +**Addons:** +Large addons like **ElvUI** and **WeakAuras** might use this function to track and display control status of units for better UI customization and alerting players about control changes. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsCorpse.md b/wiki-information/functions/UnitIsCorpse.md new file mode 100644 index 00000000..ec01a388 --- /dev/null +++ b/wiki-information/functions/UnitIsCorpse.md @@ -0,0 +1,19 @@ +## Title: UnitIsCorpse + +**Content:** +Needs summary. +`result = UnitIsCorpse()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +This function can be used to determine if a specific unit is a corpse. For instance, in an addon that manages resurrection spells, you could use `UnitIsCorpse` to check if a player unit is a corpse before attempting to cast a resurrection spell. + +**Addons Using This Function:** +Many raid and party management addons, such as Deadly Boss Mods (DBM) and HealBot, use this function to manage player states and automate certain actions based on whether a unit is dead or alive. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsDND.md b/wiki-information/functions/UnitIsDND.md new file mode 100644 index 00000000..c7412cde --- /dev/null +++ b/wiki-information/functions/UnitIsDND.md @@ -0,0 +1,21 @@ +## Title: UnitIsDND + +**Content:** +Returns true if a unit is DND (Do not disturb). +`isDND = UnitIsDND(unit)` + +**Parameters:** +- `unit` + - The UnitId to return DND status of. + +**Returns:** +- `isDND` + - 1 if unit is DND, nil otherwise. + +**Usage:** +If the player is DND, the following script outputs "You are DND" to the default chat window. +```lua +if UnitIsDND("player") then + DEFAULT_CHAT_FRAME:AddMessage("You are DND"); +end +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsDead.md b/wiki-information/functions/UnitIsDead.md new file mode 100644 index 00000000..8e9f734d --- /dev/null +++ b/wiki-information/functions/UnitIsDead.md @@ -0,0 +1,20 @@ +## Title: UnitIsDead + +**Content:** +Returns true if the unit is dead. +`isDead = UnitIsDead(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `isDead` + - *boolean* + +**Description:** +See `UnitIsDeadOrGhost` for details. + +**Reference:** +- `UnitIsDeadOrGhost` +- `UnitIsGhost` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsDeadOrGhost.md b/wiki-information/functions/UnitIsDeadOrGhost.md new file mode 100644 index 00000000..cc8cd91e --- /dev/null +++ b/wiki-information/functions/UnitIsDeadOrGhost.md @@ -0,0 +1,22 @@ +## Title: UnitIsDeadOrGhost + +**Content:** +Returns true if the unit is dead or in ghost form. +`isDeadOrGhost = UnitIsDeadOrGhost(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `isDeadOrGhost` + - *boolean* + +**Description:** +Effectively combines UnitIsDead and UnitIsGhost, returning true if either of those functions would return true. +Does not work for despawned pet units. (A pet is "despawned" once its corpse is no longer targetable in the game world, or its action bar is no longer visible on its owner's screen.) +Returns false for priests who are currently in form, having died once and are about to die again. + +**Reference:** +- `UnitIsDead` +- `UnitIsGhost` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsEnemy.md b/wiki-information/functions/UnitIsEnemy.md new file mode 100644 index 00000000..a06dc08d --- /dev/null +++ b/wiki-information/functions/UnitIsEnemy.md @@ -0,0 +1,21 @@ +## Title: UnitIsEnemy + +**Content:** +Returns true if the specified units are hostile to each other. +`isEnemy = UnitIsEnemy(unit1, unit2)` + +**Parameters:** +- `unit1` + - *string* : UnitId +- `unit2` + - *string* : UnitId - The unit to compare with the first unit. + +**Returns:** +- `isEnemy` + - *boolean* + +**Example Usage:** +This function can be used in a PvP addon to determine if a player is targeting an enemy unit. For instance, an addon could use `UnitIsEnemy("player", "target")` to check if the player's current target is an enemy and then display a warning or change the UI accordingly. + +**Addons Using This Function:** +Many PvP-oriented addons, such as Gladius, use `UnitIsEnemy` to determine if the units in the arena are enemies and to update the UI elements to reflect the status of the opponents. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsFeignDeath.md b/wiki-information/functions/UnitIsFeignDeath.md new file mode 100644 index 00000000..ee5a8e73 --- /dev/null +++ b/wiki-information/functions/UnitIsFeignDeath.md @@ -0,0 +1,18 @@ +## Title: UnitIsFeignDeath + +**Content:** +Returns true if the unit (must be a group member) is feigning death. +`isFeign = UnitIsFeignDeath(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `isFeign` + - *boolean* - Returns true if the checked unit is feigning death, false otherwise. + +**Description:** +Only provides valid data for friendly units. +Does not work for the player character. Use `UnitAura` instead: +`isFeign = UnitAura("player", "Feign Death") ~= nil` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsFriend.md b/wiki-information/functions/UnitIsFriend.md new file mode 100644 index 00000000..10c36d47 --- /dev/null +++ b/wiki-information/functions/UnitIsFriend.md @@ -0,0 +1,21 @@ +## Title: UnitIsFriend + +**Content:** +Returns true if the specified units are friendly to each other. +`isFriend = UnitIsFriend(unit1, unit2)` + +**Parameters:** +- `unit1` + - *string* : UnitId +- `unit2` + - *string* : UnitId - The unit to compare with the first unit. + +**Returns:** +- `isFriend` + - *boolean* + +**Example Usage:** +This function can be used in a variety of scenarios, such as determining if a player can cast beneficial spells on another unit or if two units are part of the same faction. + +**Addons:** +Many large addons, such as HealBot and Grid, use `UnitIsFriend` to determine if a unit is friendly and thus eligible for healing or other beneficial actions. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGameObject.md b/wiki-information/functions/UnitIsGameObject.md new file mode 100644 index 00000000..3def6281 --- /dev/null +++ b/wiki-information/functions/UnitIsGameObject.md @@ -0,0 +1,19 @@ +## Title: UnitIsGameObject + +**Content:** +Needs summary. +`result = UnitIsGameObject()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +This function can be used to determine if a given unit is a game object. For instance, in a custom addon, you might want to check if a target is a game object before performing certain actions. + +**Additional Information:** +This function is often used in addons that interact with the game world objects, such as gathering nodes, chests, or other interactable objects. Large addons like GatherMate2 might use this function to differentiate between units and game objects when tracking resource nodes on the map. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGhost.md b/wiki-information/functions/UnitIsGhost.md new file mode 100644 index 00000000..266f1cbe --- /dev/null +++ b/wiki-information/functions/UnitIsGhost.md @@ -0,0 +1,20 @@ +## Title: UnitIsGhost + +**Content:** +Returns true if the unit is in ghost form. +`isGhost = UnitIsGhost(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `isGhost` + - *boolean* + +**Description:** +See `UnitIsDeadOrGhost` for details. + +**Reference:** +- `UnitIsDeadOrGhost` +- `UnitIsDead` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGroupAssistant.md b/wiki-information/functions/UnitIsGroupAssistant.md new file mode 100644 index 00000000..e22fdaa4 --- /dev/null +++ b/wiki-information/functions/UnitIsGroupAssistant.md @@ -0,0 +1,21 @@ +## Title: UnitIsGroupAssistant + +**Content:** +Returns whether the unit is an assistant in your current group. +`isAssistant = UnitIsGroupAssistant(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `isAssistant` + - *boolean* - true if the unit is a raid assistant in your current group, false otherwise. + +**Description:** +Group leaders and assistants can invite players to the group, set main tanks, world markers, etc. +This function returns true only for players promoted to group assistants, either explicitly or via the "make everyone an assistant" option. It'll return false for the group leader. + +**Reference:** +- `UnitIsGroupLeader` +- `IsEveryoneAssistant` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGroupLeader.md b/wiki-information/functions/UnitIsGroupLeader.md new file mode 100644 index 00000000..f886bc1d --- /dev/null +++ b/wiki-information/functions/UnitIsGroupLeader.md @@ -0,0 +1,22 @@ +## Title: UnitIsGroupLeader + +**Content:** +Returns whether the unit is the leader of a party or raid. +`isLeader = UnitIsGroupLeader(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId +- `partyCategory` + - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. + - **Value** + - **Enum** + - **Description** + - `1` + - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. + - `2` + - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder + +**Returns:** +- `isLeader` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsInMyGuild.md b/wiki-information/functions/UnitIsInMyGuild.md new file mode 100644 index 00000000..af650163 --- /dev/null +++ b/wiki-information/functions/UnitIsInMyGuild.md @@ -0,0 +1,13 @@ +## Title: UnitIsInMyGuild + +**Content:** +Needs summary. +`result = UnitIsInMyGuild(unit)` + +**Parameters:** +- `unit` + - *string* + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsInteractable.md b/wiki-information/functions/UnitIsInteractable.md new file mode 100644 index 00000000..1452992f --- /dev/null +++ b/wiki-information/functions/UnitIsInteractable.md @@ -0,0 +1,19 @@ +## Title: UnitIsInteractable + +**Content:** +Needs summary. +`result = UnitIsInteractable()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +This function can be used to determine if a unit (such as an NPC or another player) is interactable. For instance, it can be useful in scenarios where you need to check if a quest giver or vendor is available for interaction. + +**Addons Usage:** +Large addons like "ElvUI" and "Questie" might use this function to enhance user interaction with NPCs, ensuring that the UI elements are only shown when the NPCs are interactable. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsOtherPlayersPet.md b/wiki-information/functions/UnitIsOtherPlayersPet.md new file mode 100644 index 00000000..5c47d71e --- /dev/null +++ b/wiki-information/functions/UnitIsOtherPlayersPet.md @@ -0,0 +1,29 @@ +## Title: UnitIsOtherPlayersPet + +**Content:** +Needs summary. +`result = UnitIsOtherPlayersPet()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `result` + - *boolean* + +**Example Usage:** +This function can be used to determine if a given unit is a pet controlled by another player. This can be useful in addons that need to differentiate between player-controlled pets and other types of units. + +**Example:** +```lua +local unit = "target" +if UnitIsOtherPlayersPet(unit) then + print(unit .. " is another player's pet.") +else + print(unit .. " is not another player's pet.") +end +``` + +**Addons:** +Large addons like "Recount" or "Details! Damage Meter" might use this function to filter out pets controlled by other players when calculating damage statistics. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md b/wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md new file mode 100644 index 00000000..77deeabc --- /dev/null +++ b/wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md @@ -0,0 +1,15 @@ +## Title: UnitIsOwnerOrControllerOfUnit + +**Content:** +Needs summary. +`unitIsOwnerOrControllerOfUnit = UnitIsOwnerOrControllerOfUnit(controllingUnit, controlledUnit)` + +**Parameters:** +- `controllingUnit` + - *string* +- `controlledUnit` + - *string* + +**Returns:** +- `unitIsOwnerOrControllerOfUnit` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPVPFreeForAll.md b/wiki-information/functions/UnitIsPVPFreeForAll.md new file mode 100644 index 00000000..7a0332c8 --- /dev/null +++ b/wiki-information/functions/UnitIsPVPFreeForAll.md @@ -0,0 +1,13 @@ +## Title: UnitIsPVPFreeForAll + +**Content:** +Returns true if the unit is flagged for free-for-all PVP (e.g. in a world arena). +`isFreeForAll = UnitIsPVPFreeForAll(unit)` + +**Parameters:** +- `unitId` + - *string* : UnitId - The unit to check + +**Returns:** +- `isFreeForAll` + - *boolean* - Whether the unit is flagged for free-for-all PVP \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPVPSanctuary.md b/wiki-information/functions/UnitIsPVPSanctuary.md new file mode 100644 index 00000000..929b290d --- /dev/null +++ b/wiki-information/functions/UnitIsPVPSanctuary.md @@ -0,0 +1,13 @@ +## Title: UnitIsPVPSanctuary + +**Content:** +Needs summary. +`result = UnitIsPVPSanctuary()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `result` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPlayer.md b/wiki-information/functions/UnitIsPlayer.md new file mode 100644 index 00000000..18865335 --- /dev/null +++ b/wiki-information/functions/UnitIsPlayer.md @@ -0,0 +1,19 @@ +## Title: UnitIsPlayer + +**Content:** +Returns true if the unit is a player character. +`isPlayer = UnitIsPlayer(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `isPlayer` + - *boolean* - true if the unit is a player, false otherwise. + +**Example Usage:** +This function can be used in addons to check if a target or focus is a player. For instance, in a PvP addon, you might want to display different information if the target is a player versus an NPC. + +**Addons Using This Function:** +Many large addons, such as "Recount" and "Details! Damage Meter," use this function to differentiate between player and NPC units when tracking combat statistics. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPossessed.md b/wiki-information/functions/UnitIsPossessed.md new file mode 100644 index 00000000..b6a56e12 --- /dev/null +++ b/wiki-information/functions/UnitIsPossessed.md @@ -0,0 +1,13 @@ +## Title: UnitIsPossessed + +**Content:** +Returns true if the unit is currently under control of another (e.g. Mind Control). +`isTrue = UnitIsPossessed(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `isTrue` + - *boolean* - true if the unit is possessed, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsRaidOfficer.md b/wiki-information/functions/UnitIsRaidOfficer.md new file mode 100644 index 00000000..5992f6cc --- /dev/null +++ b/wiki-information/functions/UnitIsRaidOfficer.md @@ -0,0 +1,29 @@ +## Title: UnitIsRaidOfficer + +**Content:** +Needs summary. +`result = UnitIsRaidOfficer()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `result` + - *boolean* + +**Description:** +The `UnitIsRaidOfficer` function checks if a specified unit is a raid officer. This can be useful in scenarios where you need to determine if a player has raid officer privileges, such as managing raid groups or accessing certain raid functionalities. + +**Example Usage:** +```lua +local unit = "player" +if UnitIsRaidOfficer(unit) then + print(unit .. " is a raid officer.") +else + print(unit .. " is not a raid officer.") +end +``` + +**Addons Using This Function:** +Many raid management addons, such as "Deadly Boss Mods" (DBM) and "BigWigs", may use this function to check for raid officer status to enable or disable certain features or commands that are restricted to raid officers. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsSameServer.md b/wiki-information/functions/UnitIsSameServer.md new file mode 100644 index 00000000..a98829a7 --- /dev/null +++ b/wiki-information/functions/UnitIsSameServer.md @@ -0,0 +1,16 @@ +## Title: UnitIsSameServer + +**Content:** +Returns true if the unit is from the same (connected) realm. +`sameServer = UnitIsSameServer(unit)` + +**Parameters:** +- `unit` + - *string* - UnitId + +**Returns:** +- `sameServer` + - *boolean* - 1 if the specified unit is from the player's realm (or a Connected Realm linked to the player's own realm), nil otherwise. + +**Reference:** +- `UnitRealmRelationship` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsTapDenied.md b/wiki-information/functions/UnitIsTapDenied.md new file mode 100644 index 00000000..ff3fe147 --- /dev/null +++ b/wiki-information/functions/UnitIsTapDenied.md @@ -0,0 +1,38 @@ +## Title: UnitIsTapDenied + +**Content:** +Indicates a mob is no longer eligible for tap. +`unitIsTapDenied = UnitIsTapDenied(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `unitIsTapDenied` + - *boolean* + +**Usage:** +The following code in FrameXML grays out the target frame when the target is tap denied: +```lua +function TargetFrame_CheckFaction (self) + if ( not UnitPlayerControlled(self.unit) and UnitIsTapDenied(self.unit) ) then + self.nameBackground:SetVertexColor(0.5, 0.5, 0.5); + if ( self.portrait ) then + self.portrait:SetVertexColor(0.5, 0.5, 0.5); + end + else + self.nameBackground:SetVertexColor(UnitSelectionColor(self.unit)); + if ( self.portrait ) then + self.portrait:SetVertexColor(1.0, 1.0, 1.0); + end + end + -- the function continues with activities not relevant to this example +end +``` + +**Example Use Case:** +This function is particularly useful in scenarios where you need to visually indicate to the player that a mob is no longer eligible for them to gain credit for a kill. For instance, in a custom UI addon, you might want to change the appearance of the target frame to show that the mob is tap denied, similar to how the default UI does it. + +**Addons Using This Function:** +Many popular addons that modify the unit frames, such as ElvUI and Shadowed Unit Frames, use this function to provide visual feedback to the player about the tap status of their target. This helps players quickly identify whether they can gain credit for attacking a mob or not. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsTrivial.md b/wiki-information/functions/UnitIsTrivial.md new file mode 100644 index 00000000..54df1efd --- /dev/null +++ b/wiki-information/functions/UnitIsTrivial.md @@ -0,0 +1,17 @@ +## Title: UnitIsTrivial + +**Content:** +Returns true if the unit is trivial (i.e. "grey" to the player). +`isTrivial = UnitIsTrivial(unit)` + +**Parameters:** +- `unit` + - *string* - UnitToken + +**Returns:** +- `isTrivial` + - *boolean* - True if the unit is comparatively too low level to provide experience or honor; otherwise false. + +**Description:** +At level 60, units level 47 and under are trivial. +Trivial units continue to give loot, quest credit, and (reduced) faction rep. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsUnconscious.md b/wiki-information/functions/UnitIsUnconscious.md new file mode 100644 index 00000000..c16aae29 --- /dev/null +++ b/wiki-information/functions/UnitIsUnconscious.md @@ -0,0 +1,19 @@ +## Title: UnitIsUnconscious + +**Content:** +Needs summary. +`isUnconscious = UnitIsUnconscious(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `isUnconscious` + - *boolean* + +**Example Usage:** +This function can be used to check if a specific unit (player, NPC, etc.) is unconscious. This can be particularly useful in scenarios where you need to handle unconscious states differently, such as in custom UI elements or combat scripts. + +**Addons:** +While there are no specific large addons known to use this function extensively, it can be a useful utility in various custom scripts and smaller addons that need to manage unit states. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsUnit.md b/wiki-information/functions/UnitIsUnit.md new file mode 100644 index 00000000..81df0468 --- /dev/null +++ b/wiki-information/functions/UnitIsUnit.md @@ -0,0 +1,26 @@ +## Title: UnitIsUnit + +**Content:** +Returns true if the specified units are the same unit. +`isSame = UnitIsUnit(unit1, unit2)` + +**Parameters:** +- `unit1` + - *string* : UnitId - The first unit to query (e.g. "party1", "pet", "player") +- `unit2` + - *string* : UnitId - The second unit to compare it to (e.g. "target") + +**Returns:** +- `isSame` + - *boolean* - 1 if the two units are the same entity, nil otherwise. + +**Usage:** +```lua +if ( UnitIsUnit("targettarget", "player") ) then + message("Look at me, I have aggro from " .. UnitName("target") .. "!"); +end; +``` + +**Miscellaneous:** +Result: +Displays a message if your target is targeting you. \ No newline at end of file diff --git a/wiki-information/functions/UnitLevel.md b/wiki-information/functions/UnitLevel.md new file mode 100644 index 00000000..7726ddf1 --- /dev/null +++ b/wiki-information/functions/UnitLevel.md @@ -0,0 +1,34 @@ +## Title: UnitLevel + +**Content:** +Returns the level of the unit. +`level = UnitLevel(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - For example "player" or "target" + +**Returns:** +- `level` + - *number* - The unit level. Returns -1 for boss units or hostile units 10 levels above the player (Level ??). + +**Description:** +- When calling `UnitLevel("player")` on `PLAYER_LEVEL_UP` it might be incorrect, check the payload instead to be sure. +- When inebriated, the apparent level of hostile units is lowered by up to 5. + +**Related API:** +- `UnitEffectiveLevel` + +**Related Events:** +- `PLAYER_LEVEL_UP` +- `PLAYER_LEVEL_CHANGED` + +**Example Usage:** +```lua +local playerLevel = UnitLevel("player") +print("Player level is: " .. playerLevel) +``` + +**Usage in Addons:** +- **Recount**: Uses `UnitLevel` to determine the level of units for accurate damage and healing statistics. +- **Details! Damage Meter**: Utilizes `UnitLevel` to provide detailed combat logs and performance metrics based on the level of units involved in combat. \ No newline at end of file diff --git a/wiki-information/functions/UnitName.md b/wiki-information/functions/UnitName.md new file mode 100644 index 00000000..aaffbbc1 --- /dev/null +++ b/wiki-information/functions/UnitName.md @@ -0,0 +1,63 @@ +## Title: UnitName + +**Content:** +Returns the name and realm of the unit. +```lua +name, realm = UnitName(unit) +name, realm = UnitFullName(unit) +name, realm = UnitNameUnmodified(unit) +``` + +**Parameters:** +- `unit` + - *string* : UnitId - For example "player" or "target" + +**Returns:** +- `name` + - *string?* - The name of the unit. Returns nil if the unit doesn't exist, e.g. the player has no target selected. +- `realm` + - *string?* - The normalized realm the unit is from, e.g. "DarkmoonFaire". Returns nil if the unit is from the same realm. + +**Description:** +Will return globalstring `UNKNOWNOBJECT` "Unknown Entity" if called before the unit in question has been fully loaded into the world. +The unit name will change if the unit is under the effects of or a similar effect, but `UnitNameUnmodified()` is unaffected by this. + +**Usage:** +Prints your character's name. +```lua +/dump UnitName("player") -- "Leeroy", nil +``` +Prints the name and realm of your target (if different). +```lua +/dump UnitName("target") -- "Thegnome", "DarkmoonFaire" +``` +`UnitFullName()` is equivalent with `UnitName()` except it will always return realm if used with the "player" UnitId. +```lua +/dump UnitFullName("player") -- "Leeroy", "MoonGuard" +/dump UnitFullName("target") -- "Leeroy", nil +``` + +**Miscellaneous:** +`GetUnitName(unit, showServerName)` can return the combined unit and realm name. +- If `showServerName` is true and the queried unit is from a different server, then the return value will include the unit's name appended by a dash and the normalized realm name. +- If `showServerName` is false, then `FOREIGN_SERVER_LABEL` " (*)" will be appended to units from coalesced realms. Units from the player's own realm or Connected Realms get no additional suffix. + +Examples: +- Unit is from the same realm. + ```lua + /dump GetUnitName("target", true) -- "Nephertiri" + /dump GetUnitName("target", false) -- "Nephertiri" + ``` +- Unit is from a different realm but the same Connected Realm (`LE_REALM_RELATION_VIRTUAL`). + ```lua + /dump GetUnitName("target", true) -- "Standron-EarthenRing" + /dump GetUnitName("target", false) -- "Standron" + ``` +- Unit is from a different, non-connected realm (`LE_REALM_RELATION_COALESCED`). + ```lua + /dump GetUnitName("target", true) -- "Celturio-Quel'Thalas" + /dump GetUnitName("target", false) -- "Celturio (*)" + ``` + +**Reference:** +- `Ambiguate()` \ No newline at end of file diff --git a/wiki-information/functions/UnitNameUnmodified.md b/wiki-information/functions/UnitNameUnmodified.md new file mode 100644 index 00000000..aaffbbc1 --- /dev/null +++ b/wiki-information/functions/UnitNameUnmodified.md @@ -0,0 +1,63 @@ +## Title: UnitName + +**Content:** +Returns the name and realm of the unit. +```lua +name, realm = UnitName(unit) +name, realm = UnitFullName(unit) +name, realm = UnitNameUnmodified(unit) +``` + +**Parameters:** +- `unit` + - *string* : UnitId - For example "player" or "target" + +**Returns:** +- `name` + - *string?* - The name of the unit. Returns nil if the unit doesn't exist, e.g. the player has no target selected. +- `realm` + - *string?* - The normalized realm the unit is from, e.g. "DarkmoonFaire". Returns nil if the unit is from the same realm. + +**Description:** +Will return globalstring `UNKNOWNOBJECT` "Unknown Entity" if called before the unit in question has been fully loaded into the world. +The unit name will change if the unit is under the effects of or a similar effect, but `UnitNameUnmodified()` is unaffected by this. + +**Usage:** +Prints your character's name. +```lua +/dump UnitName("player") -- "Leeroy", nil +``` +Prints the name and realm of your target (if different). +```lua +/dump UnitName("target") -- "Thegnome", "DarkmoonFaire" +``` +`UnitFullName()` is equivalent with `UnitName()` except it will always return realm if used with the "player" UnitId. +```lua +/dump UnitFullName("player") -- "Leeroy", "MoonGuard" +/dump UnitFullName("target") -- "Leeroy", nil +``` + +**Miscellaneous:** +`GetUnitName(unit, showServerName)` can return the combined unit and realm name. +- If `showServerName` is true and the queried unit is from a different server, then the return value will include the unit's name appended by a dash and the normalized realm name. +- If `showServerName` is false, then `FOREIGN_SERVER_LABEL` " (*)" will be appended to units from coalesced realms. Units from the player's own realm or Connected Realms get no additional suffix. + +Examples: +- Unit is from the same realm. + ```lua + /dump GetUnitName("target", true) -- "Nephertiri" + /dump GetUnitName("target", false) -- "Nephertiri" + ``` +- Unit is from a different realm but the same Connected Realm (`LE_REALM_RELATION_VIRTUAL`). + ```lua + /dump GetUnitName("target", true) -- "Standron-EarthenRing" + /dump GetUnitName("target", false) -- "Standron" + ``` +- Unit is from a different, non-connected realm (`LE_REALM_RELATION_COALESCED`). + ```lua + /dump GetUnitName("target", true) -- "Celturio-Quel'Thalas" + /dump GetUnitName("target", false) -- "Celturio (*)" + ``` + +**Reference:** +- `Ambiguate()` \ No newline at end of file diff --git a/wiki-information/functions/UnitOnTaxi.md b/wiki-information/functions/UnitOnTaxi.md new file mode 100644 index 00000000..9818c43a --- /dev/null +++ b/wiki-information/functions/UnitOnTaxi.md @@ -0,0 +1,13 @@ +## Title: UnitOnTaxi + +**Content:** +Returns true if the unit is on a flight path. +`onTaxi = UnitOnTaxi(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `onTaxi` + - *boolean* - Whether the unit is on a taxi. \ No newline at end of file diff --git a/wiki-information/functions/UnitPVPName.md b/wiki-information/functions/UnitPVPName.md new file mode 100644 index 00000000..711928a0 --- /dev/null +++ b/wiki-information/functions/UnitPVPName.md @@ -0,0 +1,17 @@ +## Title: UnitPVPName + +**Content:** +Returns the unit's name with title (e.g. "Bob the Explorer"). +`titleName = UnitPVPName(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit to retrieve the name and title of. + +**Returns:** +- `titleName` + - *string* - The unit's combined title and name, e.g. "Playername, the Insane", or nil if the unit is out of range. + +**Description:** +This function retrieves information about all titles; at the time it was added, titles were exclusively gained through PvP rankings. +Note that `titleName` can be nil if the unit is not currently visible to the client. \ No newline at end of file diff --git a/wiki-information/functions/UnitPVPRank.md b/wiki-information/functions/UnitPVPRank.md new file mode 100644 index 00000000..95958caa --- /dev/null +++ b/wiki-information/functions/UnitPVPRank.md @@ -0,0 +1,48 @@ +## Title: UnitPVPRank + +**Content:** +Returns the specified unit's PvP rank ID. +`rankID = UnitPVPRank(unit)` + +**Parameters:** +- `unit` + - *string* + +**Values:** +Dishonorable ranks like "Pariah" exist but were never used in Vanilla. + +**Rank ID:** +- **Alliance / Horde / Rank Number** + - 0 / 0 / 1 + - Pariah / Pariah / -4 + - Outlaw / Outlaw / -3 + - Exiled / Exiled / -2 + - Dishonored / Dishonored / -1 + - Private / Scout / 1 + - Corporal / Grunt / 2 + - Sergeant / Sergeant / 3 + - Master Sergeant / Senior Sergeant / 4 + - Sergeant Major / First Sergeant / 5 + - Knight / Stone Guard / 6 + - Knight-Lieutenant / Blood Guard / 7 + - Knight-Captain / Legionnaire / 8 + - Knight-Champion / Centurion / 9 + - Lieutenant Commander / Champion / 10 + - Commander / Lieutenant General / 11 + - Marshal / General / 12 + - Field Marshal / Warlord / 13 + - Grand Marshal / High Warlord / 14 + +**Returns:** +- `rankID` + - *number* - Starts at 5 (not at 1) for the first rank. Returns 0 if the unit has no rank. Can be used in `GetPVPRankInfo()` for rank information. + +**Usage:** +```lua +local rankID = UnitPVPRank("target") +local rankName, rankNumber = GetPVPRankInfo(rankID) +if rankName then + print(format("%s is rank ID %d, rank number %d (%s)", UnitName("target"), rankID, rankNumber, rankName)) +end +-- Output example: Koribli is rank ID 12, rank number 8 (Knight-Captain) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitPlayerControlled.md b/wiki-information/functions/UnitPlayerControlled.md new file mode 100644 index 00000000..e6bacc8d --- /dev/null +++ b/wiki-information/functions/UnitPlayerControlled.md @@ -0,0 +1,28 @@ +## Title: UnitPlayerControlled + +**Content:** +Returns true if the unit is controlled by a player. +`UnitIsPlayerControlled = UnitPlayerControlled(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `UnitIsPlayerControlled` + - *boolean* - Returns true if the "unit" is controlled by a player. Returns false if the "unit" is an NPC. + +**Usage:** +```lua +if (UnitPlayerControlled("target")) then + DEFAULT_CHAT_FRAME:AddMessage("Your selected target is a player.", 1, 1, 0) +else + DEFAULT_CHAT_FRAME:AddMessage("Your selected target is an NPC.", 1, 1, 0) +end +``` + +**Example Use Case:** +This function can be used in addons to determine if the player's current target is another player or an NPC. For instance, in PvP-focused addons, this check can be used to apply specific logic or display different information based on whether the target is a player or an NPC. + +**Addons Using This Function:** +Many large addons, such as "Recount" and "Details! Damage Meter," use this function to differentiate between player-controlled units and NPCs when tracking combat statistics and displaying detailed combat logs. \ No newline at end of file diff --git a/wiki-information/functions/UnitPlayerOrPetInParty.md b/wiki-information/functions/UnitPlayerOrPetInParty.md new file mode 100644 index 00000000..9d35ca46 --- /dev/null +++ b/wiki-information/functions/UnitPlayerOrPetInParty.md @@ -0,0 +1,16 @@ +## Title: UnitPlayerOrPetInParty + +**Content:** +Returns true if a different unit or pet is a member of the party. +`inMyParty = UnitPlayerOrPetInParty(unit)` + +**Parameters:** +- `unit` + - *string* - The unit to check for party membership. + +**Returns:** +- `inMyParty` + - *boolean* - 1 if the unit is another player or another player's pet in your party, nil otherwise. + +**Description:** +This function returns nil if the unit is the player, or the player's pet. \ No newline at end of file diff --git a/wiki-information/functions/UnitPlayerOrPetInRaid.md b/wiki-information/functions/UnitPlayerOrPetInRaid.md new file mode 100644 index 00000000..fec1722f --- /dev/null +++ b/wiki-information/functions/UnitPlayerOrPetInRaid.md @@ -0,0 +1,27 @@ +## Title: UnitPlayerOrPetInRaid + +**Content:** +Returns true if a different unit or pet is a member of the raid. +`inRaid = UnitPlayerOrPetInRaid(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `inRaid` + - *boolean* + +**Description:** +Returns nil for player and pet as of 3.0.2 + +**Usage:** +```lua +local TargetInRaid = UnitPlayerOrPetInRaid("target") +local TargetInRaid = UnitPlayerOrPetInRaid("target") +``` + +**Miscellaneous:** +Result: +- `TargetInRaid = 1` - If your target is in your raid group. +- `TargetInRaid = nil` - If your target is not in raid group. \ No newline at end of file diff --git a/wiki-information/functions/UnitPosition.md b/wiki-information/functions/UnitPosition.md new file mode 100644 index 00000000..88ac12d2 --- /dev/null +++ b/wiki-information/functions/UnitPosition.md @@ -0,0 +1,30 @@ +## Title: UnitPosition + +**Content:** +Returns the position of a unit in the current world area. +`positionX, positionY, positionZ, mapID = UnitPosition(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit for which the position is returned. Does not work with all unit types. Works with "player", "partyN" or "raidN" as unit type. In particular, it does not work on pets or any unit not in your group. + +**Returns:** +- `positionX` + - *number* - Y value of the unit's position in yards, relative to the instance +- `positionY` + - *number* - X value of the unit's position in yards, relative to the instance +- `positionZ` + - *number* - Always 0. A placeholder for the Z coordinate +- `mapID` + - *number* : InstanceID + +**Usage:** +Returns the distance in yards between 2 units in the same raid, or nil if they're not in the same instance or are in a raid/dungeon/competitive instance. +```lua +function ComputeDistance(unit1, unit2) + local y1, x1, _, instance1 = UnitPosition(unit1) + local y2, x2, _, instance2 = UnitPosition(unit2) + return instance1 == instance2 and ((x2 - x1) ^ 2 + (y2 - y1) ^ 2) ^ 0.5 +end +``` +It's important to note that since this number is being measured from the center of the two units, and spell ranges are calculated from the edge of their hitbox, you will need to subtract 3 yards if you're using this function for measuring spell distance between players. \ No newline at end of file diff --git a/wiki-information/functions/UnitPower.md b/wiki-information/functions/UnitPower.md new file mode 100644 index 00000000..56013c1e --- /dev/null +++ b/wiki-information/functions/UnitPower.md @@ -0,0 +1,69 @@ +## Title: UnitPower + +**Content:** +Returns the current power resource of the unit. +`power = UnitPower(unitToken)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `powerType` + - *Enum.PowerType?* - Type of resource (mana/rage/energy/etc) to query +- `unmodified` + - *boolean?* - Return the higher precision internal value (for graphical use only) + +**Values:** +### Enum.PowerType +| Value | Field | Description | +|-------|-------|-------------| +| -2 | HealthCost | | +| -1 | None | | +| 0 | Mana | Mana will range from 0 to the maximum mana a unit has. Player mana pools are of a fixed size for all specializations except Arcane Mages, whose mastery increases their maximum mana. Players naturally regenerate mana at a constant rate dependent on their specialization, both in and out of combat, and some abilities and effects can directly generate mana. This is the default power type for most non-player units, although there are exceptions. | +| 1 | Rage | Rage is used by Warriors and Druids in bear form. Rage ranges from 0 to 100, but may be increased via player talents. Rage is generated by abilities and, for some specializations, taking damage or dealing damage with auto-attacks. Rage will decay to 0 while out of combat. | +| 2 | Focus | Focus is used by Hunters and their pets. Focus ranges from 0 to 100, though this can be increased by spec passives. It has a relatively slow passive regeneration rate, but certain abilities will generate focus directly. | +| 3 | Energy | Energy is used by Rogues, Monks, and Druids in cat form. Energy ranges from 0 to 100, but may be increased via player talents and spec passives. Energy regenerates rapidly. | +| 4 | ComboPoints | Combo Points are used by Rogues and Druids in cat form. Combo Points range from 0 to 5, but can be increased up to 6 by the Rogue talent or to 10 by the Rogue talent. Combo Points are generated by abilities, talents, and passives, and are consumed by Finishing Moves to increase their potency. Combo Points will decay to 0 while out of combat. This value was previously used for hunter pets' happiness, which was deprecated in Cataclysm. | +| 5 | Runes | Runes are used as a power type for Death Knights. Deathknights have 6 runes available. As of , Deathknights no longer have different types of runes, and instead all 6 runes can be used for any ability which consumes them. Up to 3 runes can be regenerating at a time, with the other 3, if depleted, effectively having a recharge time of up to twice the normal rune recharge time. Rune recharge rate can be accelerated through , or runes can be instantly activated by or , as well as a number of talents and set bonuses. | +| 6 | RunicPower | Runic Power is used by Death Knights. Runic Power ranges from 0 to 100, though it can be increased by talents and set bonuses. It is gained by spending runes on abilities, or directly by certain abilities, talents, and passive effects. Runic Power is spent on a limited set of damaging abilities, many of which help regenerate additional runes. Runic Power will decay to 0 while out of combat. | +| 7 | SoulShards | are collected by Warlocks, and range from 0 to 5, represented the number of filled Soul Shards. As of , this resources is now used by all 3 Warlock specializations. Soul Shards will naturally regenerate or decay as needed while out of combat until they reach 3 out of 5 filled. As of Patch 7.2.5, if the "unmodified" boolean argument to UnitPower is provided, the values returned for Soul Shards will range instead from 0 to 50, with each 10 representing a filled Soul Shard. This is to account for the ability of Warlock_talents#Destruction warlocks to generate fractional Soul Shards in increments of 1/10th, similar to how Burning Embers functioned in prior expansions. | +| 8 | LunarPower | Astral Power is used by Druids in moonkin form. Astral power goes from 0 to 100. Astral power will decay to 0 while out of combat. | +| 9 | HolyPower | Holy Power is used by Retribution Paladins. Holy Power ranges from 0 to 5, and will decay to 0 while out of combat. | +| 10 | Alternate | New power type since Cataclysm. Known uses: sound level on Atramedes, corruption level on Cho'gall, consumption level while in Iso'rath. | +| 11 | Maelstrom | The new Shaman resource in Legion, used by both Enhancement and Elemental shamans. Maelstrom ranges from 0 to 100 for Elemental and 0 to 150 for Enhancement, though it can be increased by talents and artifact traits. Maelstrom will decay to 0 while out of combat. | +| 12 | Chi | Chi is used by Windwalker Monks. Chi ranges from 0 to 5, and will decay to 0 while out of combat. | +| 13 | Insanity | Insanity is used by Shadow Priests. Insanity is generated by most Shadow Priest abilities, and will be consumed at an ever-increasing rate while the priest is in , until it reaches 0 and the priest leaves Voidform (or dies horribly if is active). Insanity will decay to 0 while out of combat even if the priests is not in . | +| 14 | Obsolete | Burning Embers were used by Destruction Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 1 to 3 (4 with , representing number of completely filled Burning Embers. If a third argument "true" is included with UnitPower or UnitPowerMax, the value would instead range from 0 to 30 (40 with ), representing the individual segments in each Ember. Each Ember had 10 segments, and most effects that generate Embers generate 1 segment per effect (for example, a cast of Incinerate generates one segment, so 10 casts generates a full Ember). As of , this power type is now obsolete. | +| 15 | Obsolete2 | was used by Demonology Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 0 to 1000. As of , this power type is now obsolete. | +| 16 | ArcaneCharges | Arcane Mage resource. Arcane Charges range from 0 to 5. They are generated by casting and , and consumed by , though a number of abilities benefit from having charges without consuming them. Arcane Charges will decay to 0 while out of combat. | +| 17 | Fury | Havoc Demon Hunter. Fury is generated by , as well as a number of talents, and consumed by most Havoc abilities. Fury ranges from 0 to 100, though artifact traits can increase this to up to 170. Fury will decay to 0 while out of combat. | +| 18 | Pain | Vengeance Demon Hunter. Pain is generated by several Vengeance abilities (ex. , ), and consumed by several others (ex. , ), predominantly for defensive purposes. A small amount of Pain is also generated when the Demon Hunter takes damage. Pain ranges from 0 to 100, and will decay to 0 while out of combat. | +| 19 | Essence | Essence is used by Evokers. It ranges from 0 to 6, and will regenerate passively over time. | +| 20 | RuneBlood | Added in 10.0.0 | +| 21 | RuneFrost | Added in 10.0.0 | +| 22 | RuneUnholy | Added in 10.0.0 | +| 23 | AlternateQuest | Added in 10.1.0 | +| 24 | AlternateEncounter | Added in 10.1.0 | +| 25 | AlternateMount | is used for Dragonriding. It ranges from 0 to a variable maximum of 3-6, depending on dragon traits, and regenerates slowly while grounded, or from effects while flying. | +| 26 | NumPowerTypes | | + +**Returns:** +- `power` + - *number* - the unit's current power level + +**Description:** +If no type is specified, UnitPower returns the current primary type, e.g., energy for a druid in cat form. +You can determine the current primary power type via `UnitPowerType()` + +**Related Events:** +- `UNIT_POWER_UPDATE` +- `UNIT_POWER_FREQUENT` + +**Related API:** +- `UnitPowerType` +- `UnitPowerMax` + +**Usage:** +Prints the current amount of mana for the player. +```lua +/dump UnitPower("player", Enum.PowerType.Mana) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitPowerDisplayMod.md b/wiki-information/functions/UnitPowerDisplayMod.md new file mode 100644 index 00000000..72bcd3ec --- /dev/null +++ b/wiki-information/functions/UnitPowerDisplayMod.md @@ -0,0 +1,100 @@ +## Title: UnitPowerDisplayMod + +**Content:** +Needs summary. +`displayMod = UnitPowerDisplayMod(powerType)` + +**Parameters:** +- `powerType` + - *Enum.PowerType* + - **Value** + - **Field** + - **Description** + - `-2` + - *HealthCost* + - `-1` + - *None* + - `0` + - *Mana* + - Mana will range from 0 to the maximum mana a unit has. Player mana pools are of a fixed size for all specializations except Arcane Mages, whose mastery increases their maximum mana. Players naturally regenerate mana at a constant rate dependent on their specialization, both in and out of combat, and some abilities and effects can directly generate mana. This is the default power type for most non-player units, although there are exceptions. + - `1` + - *Rage* + - Rage is used by Warriors and Druids in bear form. Rage ranges from 0 to 100, but may be increased via player talents. Rage is generated by abilities and, for some specializations, taking damage or dealing damage with auto-attacks. Rage will decay to 0 while out of combat. + - `2` + - *Focus* + - Focus is used by Hunters and their pets. Focus ranges from 0 to 100, though this can be increased by spec passives. It has a relatively slow passive regeneration rate, but certain abilities will generate focus directly. + - `3` + - *Energy* + - Energy is used by Rogues, Monks, and Druids in cat form. Energy ranges from 0 to 100, but may be increased via player talents and spec passives. Energy regenerates rapidly. + - `4` + - *ComboPoints* + - Combo Points are used by Rogues and Druids in cat form. Combo Points range from 0 to 5, but can be increased up to 6 by the Rogue talent or to 10 by the Rogue talent. Combo Points are generated by abilities, talents, and passives, and are consumed by Finishing Moves to increase their potency. Combo Points will decay to 0 while out of combat. This value was previously used for hunter pets' happiness, which was deprecated in Cataclysm. + - `5` + - *Runes* + - Runes are used as a power type for Death Knights. Deathknights have 6 runes available. As of , Deathknights no longer have different types of runes, and instead all 6 runes can be used for any ability which consumes them. Up to 3 runes can be regenerating at a time, with the other 3, if depleted, effectively having a recharge time of up to twice the normal rune recharge time. Rune recharge rate can be accelerated through , or runes can be instantly activated by or , as well as a number of talents and set bonuses. + - `6` + - *RunicPower* + - Runic Power is used by Death Knights. Runic Power ranges from 0 to 100, though it can be increased by talents and set bonuses. It is gained by spending runes on abilities, or directly by certain abilities, talents, and passive effects. Runic Power is spent on a limited set of damaging abilities, many of which help regenerate additional runes. Runic Power will decay to 0 while out of combat. + - `7` + - *SoulShards* + - are collected by Warlocks, and range from 0 to 5, represented the number of filled Soul Shards. As of , this resources is now used by all 3 Warlock specializations. Soul Shards will naturally regenerate or decay as needed while out of combat until they reach 3 out of 5 filled. As of Patch 7.2.5, if the "unmodified" boolean argument to UnitPower is provided, the values returned for Soul Shards will range instead from 0 to 50, with each 10 representing a filled Soul Shard. This is to account for the ability of Warlock_talents#Destruction warlocks to generate fractional Soul Shards in increments of 1/10th, similar to how Burning Embers functioned in prior expansions. + - `8` + - *LunarPower* + - Astral Power is used by Druids in moonkin form. Astral power goes from 0 to 100. Astral power will decay to 0 while out of combat. + - `9` + - *HolyPower* + - Holy Power is used by Retribution Paladins. Holy Power ranges from 0 to 5, and will decay to 0 while out of combat. + - `10` + - *Alternate* + - New power type since Cataclysm. Known uses: sound level on Atramedes, corruption level on Cho'gall, consumption level while in Iso'rath. + - `11` + - *Maelstrom* + - The new Shaman resource in Legion, used by both Enhancement and Elemental shamans. Maelstrom ranges from 0 to 100 for Elemental and 0 to 150 for Enhancement, though it can be increased by talents and artifact traits. Maelstrom will decay to 0 while out of combat. + - `12` + - *Chi* + - Chi is used by Windwalker Monks. Chi ranges from 0 to 5, and will decay to 0 while out of combat. + - `13` + - *Insanity* + - Insanity is used by Shadow Priests. Insanity is generated by most Shadow Priest abilities, and will be consumed at an ever-increasing rate while the priest is in , until it reaches 0 and the priest leaves Voidform (or dies horribly if is active). Insanity will decay to 0 while out of combat even if the priests is not in . + - `14` + - *Obsolete* + - Burning Embers were used by Destruction Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 1 to 3 (4 with , representing number of completely filled Burning Embers. If a third argument "true" is included with UnitPower or UnitPowerMax, the value would instead range from 0 to 30 (40 with ), representing the individual segments in each Ember. Each Ember had 10 segments, and most effects that generate Embers generate 1 segment per effect (for example, a cast of Incinerate generates one segment, so 10 casts generates a full Ember). As of , this power type is now obsolete. + - `15` + - *Obsolete2* + - was used by Demonology Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 0 to 1000. As of , this power type is now obsolete. + - `16` + - *ArcaneCharges* + - Arcane Mage resource. Arcane Charges range from 0 to 5. They are generated by casting and , and consumed by , though a number of abilities benefit from having charges without consuming them. Arcane Charges will decay to 0 while out of combat. + - `17` + - *Fury* + - Havoc Demon Hunter. Fury is generated by , as well as a number of talents, and consumed by most Havoc abilities. Fury ranges from 0 to 100, though artifact traits can increase this to up to 170. Fury will decay to 0 while out of combat. + - `18` + - *Pain* + - Vengeance Demon Hunter. Pain is generated by several Vengeance abilities (ex. , ), and consumed by several others (ex. , ), predominantly for defensive purposes. A small amount of Pain is also generated when the Demon Hunter takes damage. Pain ranges from 0 to 100, and will decay to 0 while out of combat. + - `19` + - *Essence* + - Essence is used by Evokers. It ranges from 0 to 6, and will regenerate passively over time. + - `20` + - *RuneBlood* + - Added in 10.0.0 + - `21` + - *RuneFrost* + - Added in 10.0.0 + - `22` + - *RuneUnholy* + - Added in 10.0.0 + - `23` + - *AlternateQuest* + - Added in 10.1.0 + - `24` + - *AlternateEncounter* + - Added in 10.1.0 + - `25` + - *AlternateMount* + - is used for Dragonriding. It ranges from 0 to a variable maximum of 3-6, depending on dragon traits, and regenerates slowly while grounded, or from effects while flying. + - `26` + - *NumPowerTypes* + +**Returns:** +- `displayMod` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/UnitPowerMax.md b/wiki-information/functions/UnitPowerMax.md new file mode 100644 index 00000000..b054281c --- /dev/null +++ b/wiki-information/functions/UnitPowerMax.md @@ -0,0 +1,116 @@ +## Title: UnitPowerMax + +**Content:** +Returns the maximum power resource of the unit. +`maxPower = UnitPowerMax(unitToken)` + +**Parameters:** +- `unitToken` + - *string* : UnitId +- `powerType` + - *Enum.PowerType?* - Type of resource (mana/rage/energy/etc) to query +- `unmodified` + - *boolean?* - Return the higher precision internal value (for graphical use only) + +**Enum.PowerType:** +- `Value` +- `Field` +- `Description` + - `-2` + - HealthCost + - `-1` + - None + - `0` + - Mana + - Mana will range from 0 to the maximum mana a unit has. Player mana pools are of a fixed size for all specializations except Arcane Mages, whose mastery increases their maximum mana. Players naturally regenerate mana at a constant rate dependent on their specialization, both in and out of combat, and some abilities and effects can directly generate mana. This is the default power type for most non-player units, although there are exceptions. + - `1` + - Rage + - Rage is used by Warriors and Druids in bear form. Rage ranges from 0 to 100, but may be increased via player talents. Rage is generated by abilities and, for some specializations, taking damage or dealing damage with auto-attacks. Rage will decay to 0 while out of combat. + - `2` + - Focus + - Focus is used by Hunters and their pets. Focus ranges from 0 to 100, though this can be increased by spec passives. It has a relatively slow passive regeneration rate, but certain abilities will generate focus directly. + - `3` + - Energy + - Energy is used by Rogues, Monks, and Druids in cat form. Energy ranges from 0 to 100, but may be increased via player talents and spec passives. Energy regenerates rapidly. + - `4` + - ComboPoints + - Combo Points are used by Rogues and Druids in cat form. Combo Points range from 0 to 5, but can be increased up to 6 by the Rogue talent or to 10 by the Rogue talent. Combo Points are generated by abilities, talents, and passives, and are consumed by Finishing Moves to increase their potency. Combo Points will decay to 0 while out of combat. This value was previously used for hunter pets' happiness, which was deprecated in Cataclysm. + - `5` + - Runes + - Runes are used as a power type for Death Knights. Deathknights have 6 runes available. As of , Deathknights no longer have different types of runes, and instead all 6 runes can be used for any ability which consumes them. Up to 3 runes can be regenerating at a time, with the other 3, if depleted, effectively having a recharge time of up to twice the normal rune recharge time. Rune recharge rate can be accelerated through , or runes can be instantly activated by or , as well as a number of talents and set bonuses. + - `6` + - RunicPower + - Runic Power is used by Death Knights. Runic Power ranges from 0 to 100, though it can be increased by talents and set bonuses. It is gained by spending runes on abilities, or directly by certain abilities, talents, and passive effects. Runic Power is spent on a limited set of damaging abilities, many of which help regenerate additional runes. Runic Power will decay to 0 while out of combat. + - `7` + - SoulShards + - are collected by Warlocks, and range from 0 to 5, represented the number of filled Soul Shards. As of , this resources is now used by all 3 Warlock specializations. Soul Shards will naturally regenerate or decay as needed while out of combat until they reach 3 out of 5 filled. As of Patch 7.2.5, if the "unmodified" boolean argument to UnitPower is provided, the values returned for Soul Shards will range instead from 0 to 50, with each 10 representing a filled Soul Shard. This is to account for the ability of Warlock_talents#Destruction warlocks to generate fractional Soul Shards in increments of 1/10th, similar to how Burning Embers functioned in prior expansions. + - `8` + - LunarPower + - Astral Power is used by Druids in moonkin form. Astral power goes from 0 to 100. Astral power will decay to 0 while out of combat. + - `9` + - HolyPower + - Holy Power is used by Retribution Paladins. Holy Power ranges from 0 to 5, and will decay to 0 while out of combat. + - `10` + - Alternate + - New power type since Cataclysm. Known uses: sound level on Atramedes, corruption level on Cho'gall, consumption level while in Iso'rath. + - `11` + - Maelstrom + - The new Shaman resource in Legion, used by both Enhancement and Elemental shamans. Maelstrom ranges from 0 to 100 for Elemental and 0 to 150 for Enhancement, though it can be increased by talents and artifact traits. Maelstrom will decay to 0 while out of combat. + - `12` + - Chi + - Chi is used by Windwalker Monks. Chi ranges from 0 to 5, and will decay to 0 while out of combat. + - `13` + - Insanity + - Insanity is used by Shadow Priests. Insanity is generated by most Shadow Priest abilities, and will be consumed at an ever-increasing rate while the priest is in , until it reaches 0 and the priest leaves Voidform (or dies horribly if is active). Insanity will decay to 0 while out of combat even if the priests is not in . + - `14` + - Obsolete + - Burning Embers were used by Destruction Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 1 to 3 (4 with , representing number of completely filled Burning Embers. If a third argument "true" is included with UnitPower or UnitPowerMax, the value would instead range from 0 to 30 (40 with ), representing the individual segments in each Ember. Each Ember had 10 segments, and most effects that generate Embers generate 1 segment per effect (for example, a cast of Incinerate generates one segment, so 10 casts generates a full Ember). As of , this power type is now obsolete. + - `15` + - Obsolete2 + - was used by Demonology Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 0 to 1000. As of , this power type is now obsolete. + - `16` + - ArcaneCharges + - Arcane Mage resource. Arcane Charges range from 0 to 5. They are generated by casting and , and consumed by , though a number of abilities benefit from having charges without consuming them. Arcane Charges will decay to 0 while out of combat. + - `17` + - Fury + - Havoc Demon Hunter. Fury is generated by , as well as a number of talents, and consumed by most Havoc abilities. Fury ranges from 0 to 100, though artifact traits can increase this to up to 170. Fury will decay to 0 while out of combat. + - `18` + - Pain + - Vengeance Demon Hunter. Pain is generated by several Vengeance abilities (ex. , ), and consumed by several others (ex. , ), predominantly for defensive purposes. A small amount of Pain is also generated when the Demon Hunter takes damage. Pain ranges from 0 to 100, and will decay to 0 while out of combat. + - `19` + - Essence + - Essence is used by Evokers. It ranges from 0 to 6, and will regenerate passively over time. + - `20` + - RuneBlood + - Added in 10.0.0 + - `21` + - RuneFrost + - Added in 10.0.0 + - `22` + - RuneUnholy + - Added in 10.0.0 + - `23` + - AlternateQuest + - Added in 10.1.0 + - `24` + - AlternateEncounter + - Added in 10.1.0 + - `25` + - AlternateMount + - is used for Dragonriding. It ranges from 0 to a variable maximum of 3-6, depending on dragon traits, and regenerates slowly while grounded, or from effects while flying. + - `26` + - NumPowerTypes + +**Returns:** +- `maxPower` + - *number* - The unit's maximum amount of the queried resource. + +**Description:** +If no type is specified, UnitPowerMax returns the current primary type, e.g., energy for a druid in cat form. +You can determine the current primary power type via UnitPowerType() + +**Usage:** +Prints the maximum amount of mana for the player. +```lua +/dump UnitPowerMax("player", Enum.PowerType.Mana) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitPowerType.md b/wiki-information/functions/UnitPowerType.md new file mode 100644 index 00000000..3b7be531 --- /dev/null +++ b/wiki-information/functions/UnitPowerType.md @@ -0,0 +1,70 @@ +## Title: UnitPowerType + +**Content:** +Returns a number corresponding to the power type (e.g., mana, rage, or energy) of the specified unit. +`powerType, powerTypeToken, rgbX, rgbY, rgbZ = UnitPowerType(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit whose power type to query. +- `index` + - *number?* = 0 - Optional value for classes with multiple powerTypes. If not specified, information about the first (currently active) power type will be returned. + +**Returns:** +- `powerType` + - *Enum.PowerType* - the ID corresponding to the unit's queried power type. +- `powerToken` + - *string* - also the power type: + - "MANA" + - "RAGE" + - "FOCUS" + - "ENERGY" + - "HAPPINESS" + - "RUNES" + - "RUNIC_POWER" + - "SOUL_SHARDS" + - "ECLIPSE" + - "HOLY_POWER" + - "AMMOSLOT" (vehicles, 3.1) + - "FUEL" (vehicles, 3.1) + - "STAGGER" (vehicles, 5.1) + - "CHI" + - "INSANITY" + - "ARCANE_CHARGES" + - "FURY" + - "PAIN" +- `rgbX` + - *number* - Alternative red component for this power type, see details. Nil for most of the standard power types. +- `rgbY` + - *number* - Alternative green component for this power type, see details. Nil for most of the standard power types. +- `rgbZ` + - *number* - Alternative blue component for this power type, see details. Nil for most of the standard power types. + +**Usage:** +The following snippet displays the player's current mana/rage/energy/etc in the default chat frame. +```lua +local t = { [0] = "mana", [1] = "rage", [2] = "focus", [3] = "energy", [4] = "happiness", [5] = "runes", [6] = "runic power", [7] = "soul shards", [8] = "eclipse", [9] = "holy power"} +print(UnitName("player") .. "'s " .. t[UnitPowerType("player")] .. ": " .. UnitPower("player")) +``` + +**Description:** +Colors of all typical power types are stored in the `PowerBarColor` global table. Some special types may implement their own color as returned by the 3rd to 5th return values of `UnitPowerType`. For most of the standard power types, they return nil however. FrameXML implements it the following way (with a fallback to "MANA"): +```lua +local powerType, powerToken, altR, altG, altB = UnitPowerType(UnitId); +local info = PowerBarColor[powerToken]; + +if ( info ) then + -- The PowerBarColor takes priority + r, g, b = info.r, info.g, info.b; +elseif ( not altR ) then + -- Couldn't find a power token entry. Default to indexing by power type or just mana if we don't have that either. + info = PowerBarColor[powerType] or PowerBarColor["MANA"]; + r, g, b = info.r, info.g, info.b; +else + r, g, b = altR, altG, altB; +end +``` + +**Reference:** +- `UnitPower` +- `UnitPowerMax` \ No newline at end of file diff --git a/wiki-information/functions/UnitRace.md b/wiki-information/functions/UnitRace.md new file mode 100644 index 00000000..1a1f323e --- /dev/null +++ b/wiki-information/functions/UnitRace.md @@ -0,0 +1,73 @@ +## Title: UnitRace + +**Content:** +Returns the race of the unit. +`localizedRaceName, englishRaceName, raceID = UnitRace(name)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Values:** +The table below lists observed race IDs alongside the race name and the locale-independent string identifier for the race ("clientFileString"). +Note: This list is up to date as of patch 9.0.1 + +| ID | Race.raceName (enUS) | Race.clientFileString | Faction.name (enUS) | Faction.groupTag | +|-----|-----------------------|-----------------------|---------------------|------------------| +| 1 | Human | Human | Alliance | Alliance | +| 2 | Orc | Orc | Horde | Horde | +| 3 | Dwarf | Dwarf | Alliance | Alliance | +| 4 | Night Elf | NightElf | Alliance | Alliance | +| 5 | Undead | Scourge | Horde | Horde | +| 6 | Tauren | Tauren | Horde | Horde | +| 7 | Gnome | Gnome | Alliance | Alliance | +| 8 | Troll | Troll | Horde | Horde | +| 9 | Goblin | Goblin | Horde | Horde | +| 10 | Blood Elf | BloodElf | Horde | Horde | +| 11 | Draenei | Draenei | Alliance | Alliance | +| 12 | Fel Orc | FelOrc | Alliance | Alliance | +| 13 | Naga | Naga_ | Alliance | Alliance | +| 14 | Broken | Broken | Alliance | Alliance | +| 15 | Skeleton | Skeleton | Alliance | Alliance | +| 16 | Vrykul | Vrykul | Alliance | Alliance | +| 17 | Tuskarr | Tuskarr | Alliance | Alliance | +| 18 | Forest Troll | ForestTroll | Alliance | Alliance | +| 19 | Taunka | Taunka | Alliance | Alliance | +| 20 | Northrend Skeleton | NorthrendSkeleton | Alliance | Alliance | +| 21 | Ice Troll | IceTroll | Alliance | Alliance | +| 22 | Worgen | Worgen | Alliance | Alliance | +| 23 | Gilnean | Human | Alliance | Alliance | +| 24 | Pandaren | Pandaren | Neutral | | +| 25 | Pandaren | Pandaren | Alliance | Alliance | +| 26 | Pandaren | Pandaren | Horde | Horde | +| 27 | Nightborne | Nightborne | Horde | Horde | +| 28 | Highmountain Tauren | HighmountainTauren | Horde | Horde | +| 29 | Void Elf | VoidElf | Alliance | Alliance | +| 30 | Lightforged Draenei | LightforgedDraenei | Alliance | Alliance | +| 31 | Zandalari Troll | ZandalariTroll | Horde | Horde | +| 32 | Kul Tiran | KulTiran | Alliance | Alliance | +| 33 | Human | ThinHuman | Alliance | Alliance | +| 34 | Dark Iron Dwarf | DarkIronDwarf | Alliance | Alliance | +| 35 | Vulpera | Vulpera | Horde | Horde | +| 36 | Mag'har Orc | MagharOrc | Horde | Horde | +| 37 | Mechagnome | Mechagnome | Alliance | Alliance | +| 52 | Dracthyr | Dracthyr | Alliance | Alliance | +| 70 | Dracthyr | Dracthyr | Horde | Horde | + +**Returns:** +- `localizedRaceName` + - *string* - Localized race name, suitable for use in user interfaces. +- `englishRaceName` + - *string* - Localization-independent race name, suitable for use as table keys. +- `raceID` + - *number* - RaceId. Localization-independent raceID. + +**Usage:** +The following command prints your character's name and race to chat: +```lua +/run print(UnitName("player").." is a "..UnitRace("player")) +``` + +**Reference:** +- `UnitClass()` +- `C_CreatureInfo.GetRaceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/UnitRangedAttack.md b/wiki-information/functions/UnitRangedAttack.md new file mode 100644 index 00000000..d22c94e1 --- /dev/null +++ b/wiki-information/functions/UnitRangedAttack.md @@ -0,0 +1,26 @@ +## Title: UnitRangedAttack + +**Content:** +Returns the unit's ranged attack and modifier. +`base, modifier = UnitRangedAttack(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - Likely only works for "player" and "pet" + +**Returns:** +- `base` + - *number* - The unit's base ranged attack number (0 if no ranged weapon is equipped) +- `modifier` + - *number* - The total effect of all modifiers (positive and negative) to ranged attack. + +**Usage:** +```lua +local base, modifier = UnitRangedAttack("player"); +local effective = base + modifier; +message(effective); +``` + +**Miscellaneous:** +Result: +Displays a message containing your effective ranged attack skill (Weapon Skill). \ No newline at end of file diff --git a/wiki-information/functions/UnitRangedAttackPower.md b/wiki-information/functions/UnitRangedAttackPower.md new file mode 100644 index 00000000..f2c1482a --- /dev/null +++ b/wiki-information/functions/UnitRangedAttackPower.md @@ -0,0 +1,25 @@ +## Title: UnitRangedAttackPower + +**Content:** +Returns the ranged attack power of the unit. +`attackPower, posBuff, negBuff = UnitRangedAttackPower(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - Likely only works for "player" and "pet" + +**Returns:** +- `attackPower` + - *number* - The unit's base ranged attack power (seems to give a positive number even if no ranged weapon equipped) +- `posBuff` + - *number* - The total effect of positive buffs to ranged attack power. +- `negBuff` + - *number* - The total effect of negative buffs to the ranged attack power (a negative number) + +**Usage:** +Shows your current ranged attack power. +```lua +local base, posBuff, negBuff = UnitRangedAttackPower("player"); +local effective = base + posBuff + negBuff; +print("Your current ranged attack power: " .. effective); +``` \ No newline at end of file diff --git a/wiki-information/functions/UnitRangedDamage.md b/wiki-information/functions/UnitRangedDamage.md new file mode 100644 index 00000000..ba345bae --- /dev/null +++ b/wiki-information/functions/UnitRangedDamage.md @@ -0,0 +1,37 @@ +## Title: UnitRangedDamage + +**Content:** +Returns the ranged attack speed and damage of the unit. +`speed, minDamage, maxDamage, posBuff, negBuff, percent = UnitRangedDamage(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit to get information from. (Likely only works for "player" and "pet" -- unconfirmed) + +**Returns:** +- `speed` + - *number* - The unit's ranged weapon speed (0 if no ranged weapon equipped). +- `minDamage` + - *number* - The unit's minimum ranged damage. +- `maxDamage` + - *number* - The unit's maximum ranged damage. +- `posBuff` + - *number* - The unit's positive Bonus on ranged attacks (includes Spelldamage increases) +- `negBuff` + - *number* - The unit's negative Bonus on ranged attacks +- `percent` + - *number* - percentage modifier (usually 1) + +**Usage:** +Calculates your average damage per second. +```lua +local speed, lowDmg, hiDmg = UnitRangedDamage("player"); +local avgDmg = (lowDmg + hiDmg) / 2; +local avgDps = avgDmg / speed; +``` + +**Example Use Case:** +This function can be used to calculate the average damage per second (DPS) for a player's ranged weapon. This is particularly useful for hunters or any class that relies on ranged attacks to optimize their damage output. + +**Addons:** +Large addons like Recount or Details! Damage Meter might use this function to provide detailed statistics on a player's ranged damage output, helping players to analyze and improve their performance in combat. \ No newline at end of file diff --git a/wiki-information/functions/UnitReaction.md b/wiki-information/functions/UnitReaction.md new file mode 100644 index 00000000..bdc197c7 --- /dev/null +++ b/wiki-information/functions/UnitReaction.md @@ -0,0 +1,32 @@ +## Title: UnitReaction + +**Content:** +Returns the reaction of the specified unit to another unit. +`reaction = UnitReaction(unit, otherUnit)` + +**Parameters:** +- `unit` + - *string* : UnitId +- `otherUnit` + - *string* : UnitId - The unit to compare with the first unit. + +**Returns:** +- `reaction` + - *number* - the level of the reaction of unit towards otherUnit - this is a number between 1 and 8. + - Hated + - Hostile + - Unfriendly + - Neutral + - Friendly + - Honored + - Revered + - Exalted + - Values other than 2, 4, or 5 are only returned when the first unit is an NPC in a reputation faction and the second is you or your pet. + +**Description:** +This works even with factions that aren't listed in the reputation tab of your character window or Armory profile. +When you're Horde, the reaction of Alliance reputation-faction NPCs to you and your pet is 1. The same is true of Horde NPCs if you're Alliance. +Reaction of and to a pet is the same as for its owner. +This doesn't change when a mob becomes aggressive towards a player. I had to use the negative result of API UnitIsFriend. +Does not work across continents (or zones?)! If you query UnitReaction for a raid (or party)-member across continents, it won't return the correct value (I guess it returns nil, but I have yet to confirm that). I think it only returns correct values for units that are in 'inspect-range'. +In Blizzard Code, UnitReaction is only used between the player and a Non Player Controlled target. \ No newline at end of file diff --git a/wiki-information/functions/UnitRealmRelationship.md b/wiki-information/functions/UnitRealmRelationship.md new file mode 100644 index 00000000..dd3c1298 --- /dev/null +++ b/wiki-information/functions/UnitRealmRelationship.md @@ -0,0 +1,19 @@ +## Title: UnitRealmRelationship + +**Content:** +Returns information about the player's relation to the specified unit's realm. +`realmRelationship = UnitRealmRelationship(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `realmRelationship` + - *number* - if the specified unit is a player, one of: + - `LE_REALM_RELATION_SAME = 1` - unit and player are from the same realm. + - `LE_REALM_RELATION_COALESCED = 2` - unit and player are coalesced from unconnected realms. + - `LE_REALM_RELATION_VIRTUAL = 3` - unit and player are from Connected Realms. + +**Reference:** +`UnitName` \ No newline at end of file diff --git a/wiki-information/functions/UnitResistance.md b/wiki-information/functions/UnitResistance.md new file mode 100644 index 00000000..e0f8fed9 --- /dev/null +++ b/wiki-information/functions/UnitResistance.md @@ -0,0 +1,40 @@ +## Title: UnitResistance + +**Content:** +Gets information about a unit's resistance. +`base, total, bonus, minus = UnitResistance(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId - The unit to check +- `resistanceIndex` + - *number* - The index of the resistance type to check + - `0` - (Physical) - Armor rating + - `1` - (Holy) + - `2` - (Fire) + - `3` - (Nature) + - `4` - (Frost) + - `5` - (Shadow) + - `6` - (Arcane) + +**Returns:** +- `base` + - *number* - The base resistance +- `total` + - *number* - The current total value after all modifiers +- `bonus` + - *number* - The bonus resistance modifier total from gear and buffs +- `minus` + - *number* - The negative resistance modifier total from gear and buffs + +**Usage:** +```lua +/script SendChatMessage("My base armor is " .. UnitResistance("player", 0)); +/script _, total, _, _ = UnitResistance("player", 0); SendChatMessage("My total armor is " .. total); +``` + +**Example Use Case:** +This function can be used to display a player's resistance values in the chat, which can be useful for debugging or sharing information with other players. + +**Addons:** +Many large addons, such as ElvUI and WeakAuras, use this function to display or track resistance values for various purposes, including creating custom UI elements or triggering alerts based on resistance thresholds. \ No newline at end of file diff --git a/wiki-information/functions/UnitSelectionColor.md b/wiki-information/functions/UnitSelectionColor.md new file mode 100644 index 00000000..8a1a7812 --- /dev/null +++ b/wiki-information/functions/UnitSelectionColor.md @@ -0,0 +1,30 @@ +## Title: UnitSelectionColor + +**Content:** +Returns the color of the outline and circle underneath the unit. +`red, green, blue, alpha = UnitSelectionColor(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The unit whose selection color should be returned. +- `useExtendedColors` + - *boolean? = false* - If true, a more appropriate color of the unit's selection will be returned. For instance, if used on a dead hostile target, the default return will be red (hostile), but the extended return will be grey (dead). + +**Returns:** +- `red` + - *number* - A number between 0 and 1. +- `green` + - *number* - A number between 0 and 1. +- `blue` + - *number* - A number between 0 and 1. +- `alpha` + - *number* - A number between 0 and 1. + +**Usage:** +```lua +0, 0, 0.99999779462814, 0.99999779462814 = UnitSelectionColor("player") +0, 0.99999779462814, 0, 0.99999779462814 = UnitSelectionColor("target") -- a friendly npc in target +``` + +**Reference:** +API UnitSelectionType \ No newline at end of file diff --git a/wiki-information/functions/UnitSetRole.md b/wiki-information/functions/UnitSetRole.md new file mode 100644 index 00000000..cac87409 --- /dev/null +++ b/wiki-information/functions/UnitSetRole.md @@ -0,0 +1,18 @@ +## Title: UnitSetRole + +**Content:** +Sets a unit's role in the group. +`result = UnitSetRole(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken +- `roleStr` + - *string?* : + +**Returns:** +- `result` + - *boolean* + +**Description:** +It's not possible to assign roles to classes that are not capable of fulfilling that role. \ No newline at end of file diff --git a/wiki-information/functions/UnitSex.md b/wiki-information/functions/UnitSex.md new file mode 100644 index 00000000..9d7cbf02 --- /dev/null +++ b/wiki-information/functions/UnitSex.md @@ -0,0 +1,32 @@ +## Title: UnitSex + +**Content:** +Returns the gender of the unit. +`gender = UnitSex(unit)` + +**Parameters:** +- `unit` + - *string* : UnitId + +**Returns:** +- `sex` + - *number?* + - **ID** - **Gender** + - 1 - Neutrum / Unknown + - 2 - Male + - 3 - Female + +**Usage:** +```lua +local genders = {"unknown", "male", "female"} +if UnitExists("target") then + print("The target is " .. genders[UnitSex("target")]) +end +``` + +**Description:** +Most non-humanoid mobs/creatures will appear as Neutrum/Unknown. +Player characters currently appear as either Male or Female. + +**Reference:** +- `C_PlayerInfo.GetSex()` \ No newline at end of file diff --git a/wiki-information/functions/UnitShouldDisplayName.md b/wiki-information/functions/UnitShouldDisplayName.md new file mode 100644 index 00000000..43ca46f9 --- /dev/null +++ b/wiki-information/functions/UnitShouldDisplayName.md @@ -0,0 +1,19 @@ +## Title: UnitShouldDisplayName + +**Content:** +Needs summary. +`shouldDisplay = UnitShouldDisplayName(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `shouldDisplay` + - *boolean* + +**Example Usage:** +This function can be used to determine if a unit's name should be displayed in the game. For instance, it can be useful in custom nameplate addons to decide whether to show or hide the name of a unit based on certain conditions. + +**Addons:** +Many nameplate addons, such as "TidyPlates" and "Plater", might use this function to enhance the customization of nameplate displays based on user settings or specific in-game conditions. \ No newline at end of file diff --git a/wiki-information/functions/UnitStat.md b/wiki-information/functions/UnitStat.md new file mode 100644 index 00000000..b0d5b097 --- /dev/null +++ b/wiki-information/functions/UnitStat.md @@ -0,0 +1,40 @@ +## Title: UnitStat + +**Content:** +Returns the basic attributes for a unit (strength, agility, stamina, intellect). +`currentStat, effectiveStat, statPositiveBuff, statNegativeBuff = UnitStat(unit, statID)` + +**Parameters:** +- `unit` + - *string* : UnitToken - Only works for "player" and "pet". Will work on "target" as long as it is equal to "player". +- `statID` + - *number* - An internal id corresponding to one of the stats. + - 1: `LE_UNIT_STAT_STRENGTH` + - 2: `LE_UNIT_STAT_AGILITY` + - 3: `LE_UNIT_STAT_STAMINA` + - 4: `LE_UNIT_STAT_INTELLECT` + - 5: `LE_UNIT_STAT_SPIRIT` (not available anymore in 9.0.5) + +**Returns:** +- `currentStat` + - *number* - The unit's stat. Seems to always return the same as effectiveStat, regardless of values of pos/negBuff. +- `effectiveStat` + - *number* - The unit's current stat, as displayed in the paper doll frame. +- `statPositiveBuff` + - *number* - Any positive buffs applied to the stat, including gear. +- `statNegativeBuff` + - *number* - Any negative buffs applied to the stat. + +**Usage:** +Shows your current strength. +```lua +local stat, effectiveStat, posBuff, negBuff = UnitStat("player", 1); +DEFAULT_CHAT_FRAME:AddMessage("Your current Strength is " .. stat); +``` + +**Example Use Case:** +This function can be used in addons that need to display or manipulate the player's stats. For example, an addon that provides detailed character statistics or a custom UI element showing the player's current attributes. + +**Addons Using This Function:** +- **ElvUI**: A popular UI overhaul addon that uses `UnitStat` to display character stats in its custom character frame. +- **Details! Damage Meter**: Uses `UnitStat` to provide detailed breakdowns of player performance, including how stats affect damage output. \ No newline at end of file diff --git a/wiki-information/functions/UnitSwitchToVehicleSeat.md b/wiki-information/functions/UnitSwitchToVehicleSeat.md new file mode 100644 index 00000000..8177ea45 --- /dev/null +++ b/wiki-information/functions/UnitSwitchToVehicleSeat.md @@ -0,0 +1,17 @@ +## Title: UnitSwitchToVehicleSeat + +**Content:** +Needs summary. +`UnitSwitchToVehicleSeat(unit, virtualSeatIndex)` + +**Parameters:** +- `unit` + - *string* : UnitToken +- `virtualSeatIndex` + - *number* + +**Example Usage:** +This function can be used to switch a unit to a different seat in a multi-passenger vehicle. For instance, in a battleground or raid scenario where players are using a vehicle with multiple seats, this function can be called to move a player from one seat to another. + +**Addons:** +Large addons like Deadly Boss Mods (DBM) or ElvUI might use this function to manage vehicle seats during encounters or to provide better UI management for vehicle-based mechanics. \ No newline at end of file diff --git a/wiki-information/functions/UnitTargetsVehicleInRaidUI.md b/wiki-information/functions/UnitTargetsVehicleInRaidUI.md new file mode 100644 index 00000000..fec9fda9 --- /dev/null +++ b/wiki-information/functions/UnitTargetsVehicleInRaidUI.md @@ -0,0 +1,19 @@ +## Title: UnitTargetsVehicleInRaidUI + +**Content:** +Needs summary. +`targetsVehicle = UnitTargetsVehicleInRaidUI()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `targetsVehicle` + - *boolean* + +**Example Usage:** +This function can be used to determine if a specific unit is targeting a vehicle in the raid UI. This can be particularly useful in raid encounters where managing vehicle control is crucial. + +**Addon Usage:** +Large addons like Deadly Boss Mods (DBM) might use this function to track vehicle targeting during complex raid encounters to provide timely alerts and warnings to players. \ No newline at end of file diff --git a/wiki-information/functions/UnitThreatPercentageOfLead.md b/wiki-information/functions/UnitThreatPercentageOfLead.md new file mode 100644 index 00000000..27250c6c --- /dev/null +++ b/wiki-information/functions/UnitThreatPercentageOfLead.md @@ -0,0 +1,25 @@ +## Title: UnitThreatPercentageOfLead + +**Content:** +Needs summary. +`percentage = UnitThreatPercentageOfLead(unit, mobGUID)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The player or pet whose threat to request. +- `mobGUID` + - *string* : UnitToken - The NPC whose threat table to query. + +**Returns:** +- `percentage` + - *number* + +**Reference:** +- `UnitDetailedThreatSituation()` +- `threatShowNumeric` + +**Example Usage:** +This function can be used to determine the threat percentage of a player or pet relative to the lead threat holder on a specific NPC. This is particularly useful in raid and dungeon scenarios to manage aggro and ensure that tanks maintain threat over DPS players. + +**Addon Usage:** +Large addons like **ThreatClassic2** use this function to provide detailed threat meters for players, helping them manage their threat levels during encounters. This is crucial for maintaining proper aggro distribution and preventing DPS players from pulling threat off the tank. \ No newline at end of file diff --git a/wiki-information/functions/UnitThreatSituation.md b/wiki-information/functions/UnitThreatSituation.md new file mode 100644 index 00000000..e3d1b523 --- /dev/null +++ b/wiki-information/functions/UnitThreatSituation.md @@ -0,0 +1,70 @@ +## Title: UnitThreatSituation + +**Content:** +Returns the threat status of the specified unit to another unit. +`status = UnitThreatSituation(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken - The player or pet whose threat to request. +- `mobGUID` + - *string?* : UnitToken - The NPC whose threat table to query. + - If omitted, returned values reflect whichever NPC unit the player unit has the highest threat against. + +**Returns:** +- `status` + - *number?* - The threat status of the unit on the mobUnit. "High threat" means a unit has 100% threat or higher, "Primary Target" means the unit is the current target of the mob. + - `Value` + - `High Threat` + - `Primary Target` + - `Description` + - `nil` + - Unit is not on (any) mobUnit's threat table. + - `0` + - ❌ + - ❌ + - Unit has less than 100% threat for mobUnit. The default UI shows no indicator. + - `1` + - ✅ + - ❌ + - Unit has higher than 100% threat for mobUnit, but isn't the primary target. The default UI shows a yellow indicator. + - `2` + - ❌ + - ✅ + - Unit is the primary target for mobUnit, but another unit has higher than 100% threat. The default UI shows an orange indicator. + - `3` + - ✅ + - ✅ + - Unit is the primary target for mobUnit and no other unit has higher than 100% threat. The default UI shows a red indicator. + +**Description:** +Threat information for a pair of unit and mobUnit is only returned if the unit has threat against the mobUnit in question. In addition, no threat data is provided if a unit's pet is attacking an NPC but the unit himself has taken no action, even though the pet has threat against the NPC. + +**Usage:** +Prints your threat status for your target if it exists. If the target does not exist or the player is not on the target's threat table, prints your threat status for any other units. +```lua +local statusText = { + [0] = "(0) low on threat", + [1] = "(1) high threat", + [2] = "(2) primary target but not on high threat", + [3] = "(3) primary target and high threat", +} +local statusTarget = UnitThreatSituation("player", "target") +if UnitExists("target") then + local msg = statusText[statusTarget] or "not on the target's threat table" + print("Your threat situation for target unit: "..msg) +end +if not statusTarget then + -- not in any target unit's threat table, look if on other threat tables + local statusAny = UnitThreatSituation("player") + local msg = statusText[statusAny] or "not on any threat table" + print("Your threat situation for any unit: "..msg) +end +``` +> "Your threat situation for target unit: (3) primary target and high threat" + +**Reference:** +- `UnitDetailedThreatSituation()` +- `GetThreatStatusColor()` +- [WoW Programming API Reference](http://wowprogramming.com/docs/api/UnitThreatSituation.html) +- Kaivax 2020-06-12. PTR Patch Notes - WoW Classic Version 1.13.5. \ No newline at end of file diff --git a/wiki-information/functions/UnitTrialBankedLevels.md b/wiki-information/functions/UnitTrialBankedLevels.md new file mode 100644 index 00000000..03dbd3a7 --- /dev/null +++ b/wiki-information/functions/UnitTrialBankedLevels.md @@ -0,0 +1,17 @@ +## Title: UnitTrialBankedLevels + +**Content:** +Needs summary. +`bankedLevels, xpIntoCurrentLevel, xpForNextLevel = UnitTrialBankedLevels(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `bankedLevels` + - *number* +- `xpIntoCurrentLevel` + - *number* +- `xpForNextLevel` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/UnitTrialXP.md b/wiki-information/functions/UnitTrialXP.md new file mode 100644 index 00000000..661a99d7 --- /dev/null +++ b/wiki-information/functions/UnitTrialXP.md @@ -0,0 +1,26 @@ +## Title: UnitTrialXP + +**Content:** +Needs summary. +`xp = UnitTrialXP(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `xp` + - *number* + +**Example Usage:** +This function can be used to retrieve the experience points (XP) of a trial character. For instance, if you want to display the current XP of a trial character in your addon, you can use this function. + +**Example Code:** +```lua +local unit = "player" -- or any other unit token +local xp = UnitTrialXP(unit) +print("Current XP for unit:", xp) +``` + +**Addons Using This Function:** +While specific large addons using this function are not well-documented, it is likely used in addons that manage or display character statistics, especially those that cater to trial characters. \ No newline at end of file diff --git a/wiki-information/functions/UnitUsingVehicle.md b/wiki-information/functions/UnitUsingVehicle.md new file mode 100644 index 00000000..63c9bafa --- /dev/null +++ b/wiki-information/functions/UnitUsingVehicle.md @@ -0,0 +1,13 @@ +## Title: UnitUsingVehicle + +**Content:** +Returns true if the unit is currently in a vehicle. +`inVehicle = UnitUsingVehicle(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `inVehicle` + - *boolean* - true if the unit is using a vehicle, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitVehicleSeatCount.md b/wiki-information/functions/UnitVehicleSeatCount.md new file mode 100644 index 00000000..1234acfe --- /dev/null +++ b/wiki-information/functions/UnitVehicleSeatCount.md @@ -0,0 +1,19 @@ +## Title: UnitVehicleSeatCount + +**Content:** +Needs summary. +`count = UnitVehicleSeatCount(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `count` + - *number* + +**Example Usage:** +This function can be used to determine the number of seats available in a vehicle unit. For instance, in a battleground or raid scenario where players might use multi-passenger mounts or vehicles, this function can help manage and allocate seats to team members. + +**Addons:** +Large addons like Deadly Boss Mods (DBM) or ElvUI might use this function to provide information about vehicle seats during encounters or to enhance the user interface with vehicle-related data. \ No newline at end of file diff --git a/wiki-information/functions/UnitVehicleSeatInfo.md b/wiki-information/functions/UnitVehicleSeatInfo.md new file mode 100644 index 00000000..9ef0038f --- /dev/null +++ b/wiki-information/functions/UnitVehicleSeatInfo.md @@ -0,0 +1,23 @@ +## Title: UnitVehicleSeatInfo + +**Content:** +Needs summary. +`controlType, occupantName, serverName, ejectable, canSwitchSeats = UnitVehicleSeatInfo(unit, virtualSeatIndex)` + +**Parameters:** +- `unit` + - *string* : UnitToken +- `virtualSeatIndex` + - *number* + +**Returns:** +- `controlType` + - *string* +- `occupantName` + - *string* +- `serverName` + - *string* +- `ejectable` + - *boolean* +- `canSwitchSeats` + - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitVehicleSkin.md b/wiki-information/functions/UnitVehicleSkin.md new file mode 100644 index 00000000..10b01581 --- /dev/null +++ b/wiki-information/functions/UnitVehicleSkin.md @@ -0,0 +1,13 @@ +## Title: UnitVehicleSkin + +**Content:** +Needs summary. +`skin = UnitVehicleSkin()` + +**Parameters:** +- `unit` + - *string?* : UnitToken = WOWGUID_NULL + +**Returns:** +- `skin` + - *number* : fileID \ No newline at end of file diff --git a/wiki-information/functions/UnitXP.md b/wiki-information/functions/UnitXP.md new file mode 100644 index 00000000..91f84d12 --- /dev/null +++ b/wiki-information/functions/UnitXP.md @@ -0,0 +1,35 @@ +## Title: UnitXP + +**Content:** +Returns the current XP of the unit; only works on the player. +`xp = UnitXP(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `xp` + - *number* - Returns the current XP points of the unit. + +**Description:** +This does not work for hunter pets, use `GetPetExperience()` for that. + +**Related Events:** +- `PLAYER_XP_UPDATE` + +**Related API:** +- `UnitXPMax` + +**Usage:** +```lua +local xp = UnitXP("player") +local nextXP = UnitXPMax("player") +print(string.format("Your XP is currently at %.1f%%", xp / nextXP * 100)) +``` + +**Example Use Case:** +This function can be used in an addon to track the player's experience points and display progress towards the next level. For instance, an addon could use this to create a custom XP bar or to notify the player when they are close to leveling up. + +**Addons Using This API:** +Many leveling and UI enhancement addons, such as "ElvUI" and "Titan Panel," use `UnitXP` to display the player's current experience points and progress towards the next level. \ No newline at end of file diff --git a/wiki-information/functions/UnitXPMax.md b/wiki-information/functions/UnitXPMax.md new file mode 100644 index 00000000..5ad657c5 --- /dev/null +++ b/wiki-information/functions/UnitXPMax.md @@ -0,0 +1,26 @@ +## Title: UnitXPMax + +**Content:** +Returns the maximum XP of the unit; only works on the player. +`nextXP = UnitXPMax(unit)` + +**Parameters:** +- `unit` + - *string* : UnitToken + +**Returns:** +- `nextXP` + - *number* - Returns the max XP points of the "unit". + +**Usage:** +```lua +local xp = UnitXP("player") +local nextXP = UnitXPMax("player") +print(string.format("Your XP is currently at %.1f%%", xp / nextXP * 100)) +``` + +**Example Use Case:** +This function can be used to create an experience bar for the player in a custom UI addon. By knowing the current XP and the maximum XP, you can calculate the percentage of XP the player has gained towards the next level. + +**Addons Using This Function:** +Many popular addons like "ElvUI" and "Bartender4" use this function to display the player's experience bar, showing progress towards the next level. \ No newline at end of file diff --git a/wiki-information/functions/UnmuteSoundFile.md b/wiki-information/functions/UnmuteSoundFile.md new file mode 100644 index 00000000..ba806c5a --- /dev/null +++ b/wiki-information/functions/UnmuteSoundFile.md @@ -0,0 +1,23 @@ +## Title: UnmuteSoundFile + +**Content:** +Unmutes a sound file. +`UnmuteSoundFile(sound)` + +**Parameters:** +- `sound` + - *number|string* - FileID of a game sound or file path to an addon sound. + +**Usage:** +Plays the Sound/Spells/LevelUp.ogg sound +```lua +/run PlaySoundFile(569593) +``` +Mutes it, the sound won't play +```lua +/run MuteSoundFile(569593); PlaySoundFile(569593) +``` +Unmutes it and plays it +```lua +/run UnmuteSoundFile(569593); PlaySoundFile(569593) +``` \ No newline at end of file diff --git a/wiki-information/functions/UnstablePet.md b/wiki-information/functions/UnstablePet.md new file mode 100644 index 00000000..cd5d4dfa --- /dev/null +++ b/wiki-information/functions/UnstablePet.md @@ -0,0 +1,9 @@ +## Title: UnstablePet + +**Content:** +Unstables a pet. +`UnstablePet(index)` + +**Parameters:** +- `index` + - *number* \ No newline at end of file diff --git a/wiki-information/functions/UpdateWindow.md b/wiki-information/functions/UpdateWindow.md new file mode 100644 index 00000000..592d38b3 --- /dev/null +++ b/wiki-information/functions/UpdateWindow.md @@ -0,0 +1,11 @@ +## Title: UpdateWindow + +**Content:** +When in windowed mode, updates the window. This also aligns it to the top of the screen and increases the size to max windowed size. +`UpdateWindow()` + +**Example Usage:** +This function can be used in scenarios where the game needs to be programmatically switched to windowed mode and aligned properly. For instance, an addon might call `UpdateWindow()` after changing the display settings to ensure the window is correctly positioned and sized. + +**Addons:** +While there are no specific large addons known to use this function directly, it could be useful in custom scripts or smaller addons that manage display settings or provide custom UI adjustments. \ No newline at end of file diff --git a/wiki-information/functions/UseAction.md b/wiki-information/functions/UseAction.md new file mode 100644 index 00000000..bb42f684 --- /dev/null +++ b/wiki-information/functions/UseAction.md @@ -0,0 +1,31 @@ +## Title: UseAction + +**Content:** +Perform the action in the specified action slot. +`UseAction(slot)` + +**Parameters:** +- `slot` + - *number* - The action slot to use. +- `checkCursor` + - *Flag (optional)* - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one. +- `onSelf` + - *Flag (optional)* - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error. + +**Reference:** +- `GetActionInfo` + +**Example Usage:** +```lua +-- Use the action in slot 1 +UseAction(1) + +-- Use the action in slot 1, ensuring it replaces the current action if something is on the cursor +UseAction(1, 1) + +-- Use the action in slot 1 on the player +UseAction(1, nil, 1) +``` + +**Addons:** +Many large addons, such as Bartender4 and Dominos, use `UseAction` to manage and execute actions from custom action bars. These addons provide enhanced customization and functionality for action bars, allowing players to configure their UI to better suit their playstyle. \ No newline at end of file diff --git a/wiki-information/functions/UseContainerItem.md b/wiki-information/functions/UseContainerItem.md new file mode 100644 index 00000000..41a6a4d5 --- /dev/null +++ b/wiki-information/functions/UseContainerItem.md @@ -0,0 +1,36 @@ +## Title: UseContainerItem + +**Content:** +Uses an item from a container depending on the situation. +`UseContainerItem(bagID, slot)` + +**Parameters:** +- `bagID` + - *number* - The bag id, where the item to use is located +- `slot` + - *number* - The slot in the bag, where the item to use is located +- `target` + - *string? : UnitId* - The unit the item should be used on. If omitted, defaults to "target" if the item must target someone. +- `reagentBankAccessible` + - *boolean?* - This indicates, for cases where no target is given, if the item reagent bank is accessible (so bank frame is shown and switched to the reagent bank tab). + +**Description:** +Slots in the bags are listed from left to right, top to bottom. A 16 slot bag has the following slot numbers: +1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 + +A 6 slot bag has the following slot numbers: +1, 2, 3, 4, 5, 6 + +This function is protected, though may still be called in the following situations: +- When the (Guild/Reagent) Bank is open: Move the item to/from the (Guild/Reagent) Bank. +- When the Merchant frame is open: Sell the item. +- When the Mail frame is open and on the "Send Mail" tab: Add the item to the attachments. +- When the item is equippable: Equip the item. +- When the slot is empty: Do nothing. +- When the item is a locked Lockbox: Show an error message that says it's locked. +- When the item is a container (Clam Shell, Unlocked Lockbox, etc.): Open the Loot frame and show the contents. +- When the item is a book: Open the book's Gossip frame for reading. +- When the item is not a usable item: Do nothing. +- When the item starts a quest: Open the quest Gossip frame for reading. +- When the Trade frame is open: Add the item to the list of items to be traded. +- When the Auctions tab is open: Add item for auction pricing and submission. \ No newline at end of file diff --git a/wiki-information/functions/UseInventoryItem.md b/wiki-information/functions/UseInventoryItem.md new file mode 100644 index 00000000..00e2301a --- /dev/null +++ b/wiki-information/functions/UseInventoryItem.md @@ -0,0 +1,22 @@ +## Title: UseInventoryItem + +**Content:** +Use an item in a specific inventory slot. + +**Miscellaneous:** +Syntax: +`UseInventoryItem(slotID)` + +**Parameters:** +- `slotID` + - The inventory slot ID + - You can get the slot ID by using `GetInventorySlotInfo(slot)` + +**Returns:** +Always nil. + +**Usage:** +```lua +/script UseInventoryItem(GetInventorySlotInfo("Trinket0Slot")); +``` +After patch 1.6, you can't auto-use items anymore. Addons can no longer activate items without the press of a button. In order to use `UseInventoryItem(GetInventorySlotInfo("Trinket0Slot"))`, you will have to call it from a button, keypress, or icon as you do with spells. \ No newline at end of file diff --git a/wiki-information/functions/UseItemByName.md b/wiki-information/functions/UseItemByName.md new file mode 100644 index 00000000..9ba5d15b --- /dev/null +++ b/wiki-information/functions/UseItemByName.md @@ -0,0 +1,27 @@ +## Title: UseItemByName + +**Content:** +Uses the specified item. +`UseItemByName(name)` + +**Parameters:** +- `name` + - *string* - name of the item to use. +- `target` + - *string? : UnitId* - The unit to use the item on, defaults to "target" for items that can be used on others. + +**Reference:** +- `UseContainerItem` +- `UseInventoryItem` + +**Example Usage:** +```lua +-- Use a health potion on the player +UseItemByName("Health Potion") + +-- Use a bandage on the target +UseItemByName("Heavy Runecloth Bandage", "target") +``` + +**Addons:** +Many large addons, such as **WeakAuras** and **ElvUI**, use `UseItemByName` to automate item usage based on specific conditions or user actions. For example, WeakAuras can trigger the use of a specific item when certain conditions are met, such as low health or a specific buff/debuff being present. \ No newline at end of file diff --git a/wiki-information/functions/UseToy.md b/wiki-information/functions/UseToy.md new file mode 100644 index 00000000..9df81663 --- /dev/null +++ b/wiki-information/functions/UseToy.md @@ -0,0 +1,19 @@ +## Title: UseToy + +**Content:** +Use a toy in the player's toybox. +`UseToy(itemId)` + +**Parameters:** +- `itemId` + - *number* - itemId of a toy. + +**Usage:** +```lua +if PlayerHasToy(92738) then + UseToy(92738); +end +``` + +**Reference:** +- `UseToyByName()` \ No newline at end of file diff --git a/wiki-information/functions/UseToyByName.md b/wiki-information/functions/UseToyByName.md new file mode 100644 index 00000000..a33194d8 --- /dev/null +++ b/wiki-information/functions/UseToyByName.md @@ -0,0 +1,19 @@ +## Title: UseToyByName + +**Content:** +Use a toy in the player's toybox. +`UseToyByName(name)` + +**Parameters:** +- `name` + - *string* - (localized?) name of a toy. + +**Usage:** +```lua +if PlayerHasToy(92738) then + UseToyByName('Safari Hat'); +end +``` + +**Reference:** +- `UseToy()` \ No newline at end of file diff --git a/wiki-information/functions/addframetext.md b/wiki-information/functions/addframetext.md new file mode 100644 index 00000000..0c6386d5 --- /dev/null +++ b/wiki-information/functions/addframetext.md @@ -0,0 +1,13 @@ +## Title: addframetext + +**Content:** +Appends a string to the debug frame text buffer for crash reporting. +`addframetext(text)` + +**Parameters:** +- `text` + - *string* - A string to log in the frame text buffer. + +**Description:** +The frame text buffer is included as part of crash dumps generated by the client. +The frame text buffer is not cleared every frame. Instead, the client will keep accumulating strings into the buffer across multiple frames until it reaches a fixed capacity, at which point the buffer is then cleared. \ No newline at end of file diff --git a/wiki-information/functions/debuglocals.md b/wiki-information/functions/debuglocals.md new file mode 100644 index 00000000..81487b8c --- /dev/null +++ b/wiki-information/functions/debuglocals.md @@ -0,0 +1,62 @@ +## Title: debuglocals + +**Content:** +Returns a string dump of all local variables and upvalues at a given stack level. +`locals = debuglocals()` + +**Parameters:** +- `level` + - *number* - The stack level to inspect. Defaults to 1 (the calling function). + +**Returns:** +- `locals` + - *string?* - A string dump of all local variables, temporaries, and upvalues. + +**Description:** +This function will return no values if called outside of the execution of the global error handler function. + +**Usage:** +The following snippet demonstrates example output for a variety of values. Note that this snippet may not work as-is if you have an error handling addon installed, as these typically hijack and replace the ability to change the global error handler. +```lua +local Upvalue = "banana" +seterrorhandler(function() + local Number = 1.23456 + local String = "foo" + local NamedFrame = { = ChatFrame1 } + local Table = { + 1, + 2, + foo = "bar", + { + "debuglocals should only inspect at-most one level of tables; this shouldn't be printed", + }, + } + local Thread = coroutine.create(function() end) + local Boolean = true + local Nil = nil + local Temp = Upvalue + print(debuglocals()) +end) +error("") +``` +Example output: +``` +Number = 1.234560 +String = "foo" +NamedFrame = ChatFrame1 { + 0 = +} +Table = { + 1 = 1 + 2 = 2 + 3 =
{ + } + foo = "bar" +} +Thread = +Boolean = true +Nil = nil +Temp = "banana" +(*temporary) = defined @Interface\FrameXML\UIParent.lua:5234 +Upvalue = "banana" +``` \ No newline at end of file diff --git a/wiki-information/functions/debugprofilestart.md b/wiki-information/functions/debugprofilestart.md new file mode 100644 index 00000000..de48fb68 --- /dev/null +++ b/wiki-information/functions/debugprofilestart.md @@ -0,0 +1,11 @@ +## Title: debugprofilestart + +**Content:** +Starts a timer for profiling during debugging. +`debugprofilestart()` + +Note that the timer does not actually need to be started. This is more of a global "reset" of the timer. +Since it is global, it is probably best to never call this function. Rather just call `debugprofilestop()` 2 times and compare the difference. + +**Reference:** +- `debugprofilestop` \ No newline at end of file diff --git a/wiki-information/functions/debugprofilestop.md b/wiki-information/functions/debugprofilestop.md new file mode 100644 index 00000000..f7624b87 --- /dev/null +++ b/wiki-information/functions/debugprofilestop.md @@ -0,0 +1,32 @@ +## Title: debugprofilestop + +**Content:** +Returns the time in milliseconds since the last call to `debugprofilestart()`. +`elapsedMilliseconds = debugprofilestop()` + +**Returns:** +- `elapsedMilliseconds` + - *number* - Time since profiling was started in milliseconds. + +**Description:** +Debug profiling provides a high-precision timer that can be used to profile code. +Calling this function, despite its name, does NOT stop the timer. It simply returns the time since the previous `debugprofilestart()` call! + +Note that if you are simply using this to profile your own code, it is preferable to NOT keep re-starting the timer since it will interfere with other addons doing the same. Instead, do this: +```lua +local beginTime = debugprofilestop() +-- do lots of stuff +-- that takes lots of time + +local timeUsed = debugprofilestop() - beginTime +print("I used " .. timeUsed .. " milliseconds!") +``` + +**Reference:** +- `debugprofilestart` + +**Example Use Case:** +This function is particularly useful for addon developers who need to measure the performance of their code. For instance, if you are developing an addon that processes a large amount of data, you can use `debugprofilestop()` to measure how long the processing takes and optimize accordingly. + +**Addons Using This Function:** +Many performance monitoring addons, such as "Details! Damage Meter" and "WeakAuras," use `debugprofilestop()` to measure the execution time of various functions and scripts to ensure they run efficiently. \ No newline at end of file diff --git a/wiki-information/functions/debugstack.md b/wiki-information/functions/debugstack.md new file mode 100644 index 00000000..16990489 --- /dev/null +++ b/wiki-information/functions/debugstack.md @@ -0,0 +1,76 @@ +## Title: debugstack + +**Content:** +Returns a string representation of the current calling stack. +`description = debugstack( ]])` + +**Parameters:** +- `coroutine` + - *Thread* - The thread with the stack to examine (default - the calling thread) +- `start` + - *number* - the stack depth at which to start the stack trace (default 1 - the function calling debugstack, or the top of coroutine's stack) +- `count1` + - *number* - the number of functions to output at the top of the stack (default 12) +- `count2` + - *number* - the number of functions to output at the bottom of the stack (default 10) + +**Returns:** +- `description` + - *string* - a multi-line string showing what the current call stack looks like + - If there are more than count1+count2 calls in the stack, they are separated by a "..." line. + - Long lines may become truncated. + - The string ends with an extra newline character. + +**Usage:** +Assume the following example file, "file.lua": +```lua +1: function a() +2: error("Boom!"); +3: end +4: +5: function b() a(); end +6: +7: function c() b(); end +8: +9: function d() c(); end +10: +11: function e() d(); end +12: +13: function f() e(); end +14: +15: function errhandler(msg) +16: print (msg .. "\nCall stack: \n" .. debugstack(2, 3, 2)); +17: end +18: +19: xpcall(f, errhandler); +``` +This would output something along the following: +``` +file.lua:2: Boom! +Call stack: +file.lua:2: in function a +file.lua:5: in function b +file.lua:7: in function c +... +file.lua:13: in function f +file.lua:19 +``` + +Example 2: +Combining debugstack with a strmatch can enable you to get the current line of a function call. +```lua +1: function debugprint(msg) +2: local line = strmatch(debugstack(2),":(%d):"); +3: print("Debug Print on Line "..line.." with message: "..msg); +4: end +5: +6: function doSomething() +7: debugprint("We tried to do something."); +8: end +``` +This would return the following output from print: +``` +Debug Print on Line 7 with message: We tried to do something. +``` + +This is a WoW API modified version of Lua's `debug.traceback()` function. \ No newline at end of file diff --git a/wiki-information/functions/forceinsecure.md b/wiki-information/functions/forceinsecure.md new file mode 100644 index 00000000..2d1b15be --- /dev/null +++ b/wiki-information/functions/forceinsecure.md @@ -0,0 +1,14 @@ +## Title: forceinsecure + +**Content:** +Taints the current execution path. +`forceinsecure()` + +**Description:** +The `forceinsecure` function is used to mark the current execution path as insecure. This is typically used in the context of World of Warcraft's secure execution environment to indicate that certain actions or code paths should not be trusted or allowed to perform secure operations. + +**Example Usage:** +This function is often used in the development of addons to ensure that certain code paths are marked as insecure, preventing them from performing actions that require a secure environment. For example, an addon might use `forceinsecure` to mark a function that handles user input as insecure to prevent it from being used to perform secure actions like casting spells or using items. + +**Addons:** +Large addons like **ElvUI** and **WeakAuras** may use `forceinsecure` to manage secure and insecure code paths, ensuring that user interactions and custom scripts do not interfere with secure operations within the game. This helps maintain the integrity and security of the game's execution environment while allowing for extensive customization and functionality. \ No newline at end of file diff --git a/wiki-information/functions/geterrorhandler.md b/wiki-information/functions/geterrorhandler.md new file mode 100644 index 00000000..50b1ee21 --- /dev/null +++ b/wiki-information/functions/geterrorhandler.md @@ -0,0 +1,21 @@ +## Title: geterrorhandler + +**Content:** +Returns the currently set error handler. +`handler = geterrorhandler()` + +**Returns:** +- `handler` + - *function* - The current error handler. Receives a message as an argument, normally a string that is the second return value from `pcall()`. + +**Usage:** +```lua +local myError = "Something went horribly wrong!" +geterrorhandler()(myError) +``` + +**Example Use Case:** +The `geterrorhandler` function can be used to retrieve the current error handler function, which can then be invoked with a custom error message. This is useful for debugging or logging errors in a controlled manner. + +**Addons Using This Function:** +Many large addons, such as WeakAuras and ElvUI, use custom error handlers to manage and log errors gracefully without disrupting the user experience. They might use `geterrorhandler` to ensure that their custom error handling logic is in place or to temporarily replace the default error handler during critical operations. \ No newline at end of file diff --git a/wiki-information/functions/hooksecurefunc.md b/wiki-information/functions/hooksecurefunc.md new file mode 100644 index 00000000..31899cd9 --- /dev/null +++ b/wiki-information/functions/hooksecurefunc.md @@ -0,0 +1,38 @@ +## Title: hooksecurefunc + +**Content:** +Securely posthooks the specified function. The hook will be called with the same arguments after the original call is performed. +`hooksecurefunc(functionName, hookfunc)` + +**Parameters:** +- `table` + - *Optional Table* - Table to hook the `functionName` key in; if omitted, defaults to the global table (`_G`). +- `functionName` + - *string* - name of the function being hooked. +- `hookfunc` + - *function* - your hook function. + +**Usage:** +The following calls hook `CastSpellByName` and `GameTooltip:SetUnitBuff` without compromising their secure status. When those functions are called, the hook prints their argument list into the default chat frame. +```lua +hooksecurefunc("CastSpellByName", print); -- Hooks the global CastSpellByName +hooksecurefunc(GameTooltip, "SetUnitBuff", print); -- Hooks GameTooltip.SetUnitBuff +``` + +**Description:** +This is the only safe way to hook functions that execute protected functionality. +`hookfunc` is invoked after the original function, and receives the same parameters; return values from `hookfunc` are discarded. +After this function is used on a function, `setfenv()` throws an error when attempted on that function. +You cannot "unhook" a function that is hooked with this function except by a UI reload. Calling `hooksecurefunc()` multiple times only adds more hooks to be called. +Also note that using `hooksecurefunc()` may not always produce the expected result. Keep in mind that it actually replaces the original function with a new one (the function reference changes). For example, if you try to hook the global function `MacroFrame_OnHide` (after the macro frame has been displayed), your function will not be called when the macro frame is closed. It's simply because in `Blizzard_MacroUI.xml` the `OnHide` function call is registered like this: +```xml + +``` +The function ID called when the frame is hidden is the former one, before you hooked `MacroFrame_OnHide`. The workaround is to hook a function called by `MacroFrame_OnHide`: +```lua +hooksecurefunc(MacroPopupFrame, "Hide", MyFunction) +``` +If you want to securely hook a frame's script handler, use `Frame:HookScript`: +```lua +MacroPopupFrame:HookScript("OnHide", MyFunction) +``` \ No newline at end of file diff --git a/wiki-information/functions/issecure.md b/wiki-information/functions/issecure.md new file mode 100644 index 00000000..66b8db6b --- /dev/null +++ b/wiki-information/functions/issecure.md @@ -0,0 +1,13 @@ +## Title: issecure + +**Content:** +Returns true if the current execution path is secure. +`secure = issecure()` + +**Returns:** +- `secure` + - *boolean* - true if the current path is secure (and able to call protected functions), false otherwise. + +**Description:** +This function will return false if called from any (insecure) addon code. +Certain API functions (and FrameXML functions that check this function's return value) cannot be called from tainted execution paths. \ No newline at end of file diff --git a/wiki-information/functions/issecurevariable.md b/wiki-information/functions/issecurevariable.md new file mode 100644 index 00000000..55a6a3a4 --- /dev/null +++ b/wiki-information/functions/issecurevariable.md @@ -0,0 +1,22 @@ +## Title: issecurevariable + +**Content:** +Returns true if the specified variable is secure. +`isSecure, taint = issecurevariable(variable)` + +**Parameters:** +- `table` + - *table?* - table to check the key in; if omitted, defaults to the globals table (_G). +- `variable` + - *string* - string key to check the taint of. Numbers will be converted to a string; other types will throw an error. + +**Returns:** +- `isSecure` + - *boolean* - true if the table key is secure, false if it is tainted. +- `taint` + - *string?* - name of the addon that tainted the table field; an empty string if tainted by a macro; nil if secure. + +**Description:** +Also returns true, nil for keys that have never been used/defined, because nothing has tainted them yet. +If `table == nil`, and table has a metatable with `__index`, this function will return whether the metatable's `__index` is tainted. You must remove the metatable to check whether the table itself is tainted. +Cannot be used to check the taint of local variables, or non-string table keys. \ No newline at end of file diff --git a/wiki-information/functions/pcallwithenv.md b/wiki-information/functions/pcallwithenv.md new file mode 100644 index 00000000..c31a682f --- /dev/null +++ b/wiki-information/functions/pcallwithenv.md @@ -0,0 +1,28 @@ +## Title: pcallwithenv + +**Content:** +Calls a function in protected mode with a temporarily replaced function environment. +`ok, ... = pcallwithenv(func, env, ...)` + +**Parameters:** +- `func` + - *string* - The function to be called. +- `env` + - *table* - A custom environment table to apply to the function prior to calling. +- `...` + - *Variable* - Arguments to supply to the function. + +**Returns:** +- `ok` + - *boolean* - True if the function was called without error. +- `...` + - *Variable* - Either a singular error value or all of the return values of the called function. + +**Description:** +This function will temporarily replace the existing environment on the supplied function before the call, and will restore the original environment after the call has completed. +This function will raise an error if the function to be called has an existing environment whose metatable has an `__environment` field set. +If this function is called insecurely and the supplied function is a Lua function, the supplied function will be irrevocably tainted. This will result in all future calls to the function tainting execution. + +**Reference:** +- `pcall` +- `setfenv` \ No newline at end of file diff --git a/wiki-information/functions/scrub.md b/wiki-information/functions/scrub.md new file mode 100644 index 00000000..b64779a3 --- /dev/null +++ b/wiki-information/functions/scrub.md @@ -0,0 +1,13 @@ +## Title: scrub + +**Content:** +Returns the argument list with non-number/boolean/string values changed to nil. +`... = scrub(...)` + +**Parameters:** +- `...` + - *any* - The values to be scrubbed. + +**Returns:** +- `...` + - *boolean|number|string|nil* - The scrubbed list of arguments. \ No newline at end of file diff --git a/wiki-information/functions/securecall.md b/wiki-information/functions/securecall.md new file mode 100644 index 00000000..ce929a67 --- /dev/null +++ b/wiki-information/functions/securecall.md @@ -0,0 +1,23 @@ +## Title: securecall + +**Content:** +Calls the specified function without propagating taint to the caller. +```lua +... = securecall(func or functionName, ...) +... = securecallfunction(func, ...) +``` + +**Parameters:** +- `func` + - *function|string* - A direct reference of the function to be called, or for `securecall` a string name of a function to be resolved through a global lookup. +- `...` + - Additional arguments to supply to the function. + +**Returns:** +- `...` + - The return values of the called function. + +**Description:** +If `securecall` is called from a secure execution path, the execution path will remain secure when `securecall` returns, even if the called function is tainted, or accesses tainted variables. +Errors that occur within the called function are not propagated to the caller; if an error occurs, `securecall` triggers the default error handler, and then returns control to the caller with no return values. +For `securecallfunction`, no attempt is made to perform a global lookup based on the supplied function argument. \ No newline at end of file diff --git a/wiki-information/functions/securecallfunction.md b/wiki-information/functions/securecallfunction.md new file mode 100644 index 00000000..f3e2237e --- /dev/null +++ b/wiki-information/functions/securecallfunction.md @@ -0,0 +1,21 @@ +## Title: securecall + +**Content:** +Calls the specified function without propagating taint to the caller. +`... = securecall(func or functionName, ...)` +`... = securecallfunction(func, ...)` + +**Parameters:** +- `func` + - *function|string* - A direct reference of the function to be called, or for securecall a string name of a function to be resolved through a global lookup. +- `...` + - Additional arguments to supply to the function. + +**Returns:** +- `...` + - The return values of the called function. + +**Description:** +If `securecall` is called from a secure execution path, the execution path will remain secure when `securecall` returns, even if the called function is tainted, or accesses tainted variables. +Errors that occur within the called function are not propagated to the caller; if an error occurs, `securecall` triggers the default error handler, and then returns control to the caller with no return values. +For `securecallfunction`, no attempt is made to perform a global lookup based on the supplied function argument. \ No newline at end of file diff --git a/wiki-information/functions/secureexecuterange.md b/wiki-information/functions/secureexecuterange.md new file mode 100644 index 00000000..d84a643c --- /dev/null +++ b/wiki-information/functions/secureexecuterange.md @@ -0,0 +1,51 @@ +## Title: secureexecuterange + +**Content:** +Calls a function for each pair within a table without propagating taint to the caller. +`secureexecuterange(tbl, func, ...)` + +**Parameters:** +- `tbl` + - *table* - The table to be traversed. +- `func` + - *function* - The function to be called for each pair. +- `...` + - Additional arguments to supply to the invoked function. + +**Description:** +The supplied function will be called with the key and value of each pair within the table as the first two arguments, followed by any additional user-supplied arguments. + +Execution of the supplied function will be tainted in the following scenarios: +- If the initial state of execution was insecure. +- If the table pair currently being processed was insecurely inserted. +- If the supplied function was created by insecure code. + +If execution is tainted during the processing of a single pair, the taint does not propagate to the processing of any remaining pairs within the supplied table. + +Errors that occur during the execution of the supplied function are discarded, and do not propagate to the caller. Additionally, errors do not prevent the function from being called for all remaining pairs within the supplied table so as to prevent insecure code from potentially changing the flow of execution. + +**Example Implementation:** +The implementation of this function would, if not provided natively by the client, be effectively similar to the snippet below. This example aims to demonstrate how error handling and taint is processed with regards to individual pairs within the table. + +```lua +local function secureexecutenext(tbl, prev, func, ...) + local key, value = next(tbl, prev) + if key ~= nil then + pcall(func, key, value, ...) -- Errors are silently discarded! + end + return key +end + +function secureexecuterange(tbl, func, ...) + local key = nil + repeat + key = securecallfunction(secureexecutenext, tbl, key, func, ...) + until key == nil +end +``` + +**Example Usage:** +This function can be used in scenarios where you need to iterate over a table and perform operations on each key-value pair without risking taint propagation or error interruption. For instance, it can be used in secure environment setups where maintaining the integrity of the execution state is crucial. + +**Addons Usage:** +Large addons that handle secure execution of code, such as those managing UI elements or secure templates, might use this function to ensure that their operations do not inadvertently taint the global execution environment. For example, addons like ElvUI or Bartender4, which deal with secure handling of action bars and UI elements, could leverage this function to safely iterate over configuration tables. \ No newline at end of file diff --git a/wiki-information/functions/seterrorhandler.md b/wiki-information/functions/seterrorhandler.md new file mode 100644 index 00000000..5972e096 --- /dev/null +++ b/wiki-information/functions/seterrorhandler.md @@ -0,0 +1,21 @@ +## Title: seterrorhandler + +**Content:** +Sets the error handler to the given function. +`seterrorhandler(errFunc)` + +**Parameters:** +- `errFunc` + - *function* - The function to call when an error occurs. The function is passed a single argument containing the error message. + +**Usage:** +If you wanted to print all errors to your chat frame, you could do: +```lua +seterrorhandler(print); +``` +Alternatively, the following would also perform the same task: +```lua +seterrorhandler(function(msg) + print(msg); +end); +``` \ No newline at end of file From ef2a5ce6c553498759a77709e50a1ef05be5c787 Mon Sep 17 00:00:00 2001 From: Logon Date: Mon, 3 Jun 2024 23:29:58 +0200 Subject: [PATCH 06/18] Testing --- .../{AbandonQuest.md => AbandonQuest.lua} | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) rename wiki-information/functions/{AbandonQuest.md => AbandonQuest.lua} (97%) diff --git a/wiki-information/functions/AbandonQuest.md b/wiki-information/functions/AbandonQuest.lua similarity index 97% rename from wiki-information/functions/AbandonQuest.md rename to wiki-information/functions/AbandonQuest.lua index 9632cec0..5b4c1be7 100644 --- a/wiki-information/functions/AbandonQuest.md +++ b/wiki-information/functions/AbandonQuest.lua @@ -1,8 +1,8 @@ -## Title: AbandonQuest - -**Content:** -Abandons the quest specified by `SetAbandonQuest()` -`AbandonQuest()` - -**Description:** +## Title: AbandonQuest + +**Content:** +Abandons the quest specified by `SetAbandonQuest()` +`AbandonQuest()` + +**Description:** Calling `SetAbandonQuest()` triggers a dialog to confirm the user's intention, and the dialog calls `AbandonQuest()` when the user clicks "accept". \ No newline at end of file From e4bcf815cc626b66e31df2f34451b0a7dff92b15 Mon Sep 17 00:00:00 2001 From: Logon Date: Mon, 3 Jun 2024 23:33:21 +0200 Subject: [PATCH 07/18] Change back to markdown --- .../{AbandonQuest.lua => AbandonQuest.md} | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) rename wiki-information/functions/{AbandonQuest.lua => AbandonQuest.md} (97%) diff --git a/wiki-information/functions/AbandonQuest.lua b/wiki-information/functions/AbandonQuest.md similarity index 97% rename from wiki-information/functions/AbandonQuest.lua rename to wiki-information/functions/AbandonQuest.md index 5b4c1be7..9632cec0 100644 --- a/wiki-information/functions/AbandonQuest.lua +++ b/wiki-information/functions/AbandonQuest.md @@ -1,8 +1,8 @@ -## Title: AbandonQuest - -**Content:** -Abandons the quest specified by `SetAbandonQuest()` -`AbandonQuest()` - -**Description:** +## Title: AbandonQuest + +**Content:** +Abandons the quest specified by `SetAbandonQuest()` +`AbandonQuest()` + +**Description:** Calling `SetAbandonQuest()` triggers a dialog to confirm the user's intention, and the dialog calls `AbandonQuest()` when the user clicks "accept". \ No newline at end of file From 5de446ce4c78739b7b879283a77ccd39df847a7a Mon Sep 17 00:00:00 2001 From: Logon Date: Mon, 8 Jul 2024 16:14:32 +0200 Subject: [PATCH 08/18] Uncomment the init code --- QuestieDB.lua | 2 ++ 1 file changed, 2 insertions(+) diff --git a/QuestieDB.lua b/QuestieDB.lua index 8420e0b4..5cb1c7bb 100644 --- a/QuestieDB.lua +++ b/QuestieDB.lua @@ -102,6 +102,8 @@ SlashCmdList["QuestieDB"] = function(args) print("Localized math.floor", time1, "ms") print("Modulus to floor", time2, "ms") end + collectgarbage() end + SLASH_QuestieDB1 = "/QuestieDB" SLASH_QuestieDB2 = "/qdb" From b6563f6667473328186c2da1032e296b8a423ebd Mon Sep 17 00:00:00 2001 From: Logon Date: Wed, 25 Sep 2024 22:18:32 +0200 Subject: [PATCH 09/18] feat: initial generate translation trie and HTML files This change introduces a new feature to generate a translation trie and HTML files for the localized strings in the project. The key changes include: - Added a new script `generate_translation_trie.lua` that creates a trie data structure from the translation strings and writes the translations to HTML files with segmentation support. - Updated the `main.lua` script to call the new `Compile_translations_to_html` function from `generate_translation_trie.lua`. - Added a `run.sh` script to execute the main script and a `Dockerfile` to build a Docker container for the project. - Updated the `CLI_Helpers.lua` script to handle file paths with backslashes correctly when loading script files. - Refactored the `l10n.lua` script to improve the handling of localization data. These changes improve the localization capabilities of the project by providing a more efficient way to manage and display the translated strings. --- .generate_database_lua/Dockerfile | 13 ++ .generate_database_lua/createStatic.lua | 170 ++++++++++++++ .generate_database_lua/docker-compose.yml | 9 + .../generate_translation_trie.lua | 183 +++++++++++++++ .generate_database_lua/helpers.lua | 219 ++++++++++++++++++ .generate_database_lua/main.lua | 100 ++++++++ .generate_database_lua/run.sh | 19 ++ Database/l10n/l10n.lua | 20 +- cli/CLI_Helpers.lua | 6 +- 9 files changed, 730 insertions(+), 9 deletions(-) create mode 100644 .generate_database_lua/Dockerfile create mode 100644 .generate_database_lua/createStatic.lua create mode 100644 .generate_database_lua/docker-compose.yml create mode 100644 .generate_database_lua/generate_translation_trie.lua create mode 100644 .generate_database_lua/helpers.lua create mode 100644 .generate_database_lua/main.lua create mode 100644 .generate_database_lua/run.sh diff --git a/.generate_database_lua/Dockerfile b/.generate_database_lua/Dockerfile new file mode 100644 index 00000000..a20ef736 --- /dev/null +++ b/.generate_database_lua/Dockerfile @@ -0,0 +1,13 @@ +FROM nickblah/lua:5.1-luarocks + +RUN apt-get update && apt-get install -y git gcc +# Install OpenSSL for LuaSec +RUN apt-get install -y libssl-dev + +RUN luarocks install bit32 +RUN luarocks install argparse +RUN luarocks install luafilesystem +RUN luarocks install luasocket +RUN luarocks install luasec + +RUN apt-get update && apt-get install -y wget \ No newline at end of file diff --git a/.generate_database_lua/createStatic.lua b/.generate_database_lua/createStatic.lua new file mode 100644 index 00000000..fc905bc4 --- /dev/null +++ b/.generate_database_lua/createStatic.lua @@ -0,0 +1,170 @@ +-- Allow accessing private fields +---@diagnostic disable: invisible +require("cli.dump") +local argparse = require("argparse") +local helpers = require(".helpers") + +require("cli.Addon_Meta") +require("cli.CLI_Helpers") + +assert(Is_CLI, "This function should only be called from the CLI environment") + +local f = string.format + +Is_Create_Static = true + +function DumpDatabase(version) + local lowerVersion = version:lower() + local capitalizedVersion = lowerVersion:gsub("^%l", string.upper) + print(f("\n\27[36mCompiling %s database...\27[0m", capitalizedVersion)) + + -- Reset data objects, load the files and set wow version + LibQuestieDBTable = AddonInitializeVersion(capitalizedVersion) + + -- Drain all the timers + C_Timer.drainTimerList() + + local itemOverride = {} + local npcOverride = {} + local objectOverride = {} + local questOverride = {} + + local Corrections = LibQuestieDBTable.Corrections + + Corrections.DumpFunctions.testDumpFunctions() + + do + CLI_Helpers.loadFile(f(".generate_database/_data/%sItemDB.lua", lowerVersion)) + itemOverride = loadstring(QuestieDB.itemData)() + LibQuestieDBTable.Item.LoadOverrideData(false, true) + local itemMeta = Corrections.ItemMeta + for itemId, corrections in pairs(LibQuestieDBTable.Item.override) do + if not itemOverride[itemId] then + itemOverride[itemId] = {} + end + for key, correction in pairs(corrections) do + local correctionIndex = itemMeta.itemKeys[key] + itemOverride[itemId][correctionIndex] = correction + end + end + end + + do + CLI_Helpers.loadFile(f(".generate_database/_data/%sNpcDB.lua", lowerVersion)) + npcOverride = loadstring(QuestieDB.npcData)() + LibQuestieDBTable.Npc.LoadOverrideData(false, true) + local npcMeta = Corrections.NpcMeta + for npcId, corrections in pairs(LibQuestieDBTable.Npc.override) do + if not npcOverride[npcId] then + npcOverride[npcId] = {} + end + for key, correction in pairs(corrections) do + local correctionIndex = npcMeta.npcKeys[key] + npcOverride[npcId][correctionIndex] = correction + end + end + end + + do + CLI_Helpers.loadFile(f(".generate_database/_data/%sObjectDB.lua", lowerVersion)) + objectOverride = loadstring(QuestieDB.objectData)() + LibQuestieDBTable.Object.LoadOverrideData(false, true) + local objectMeta = Corrections.ObjectMeta + for objectId, corrections in pairs(LibQuestieDBTable.Object.override) do + if not objectOverride[objectId] then + objectOverride[objectId] = {} + end + for key, correction in pairs(corrections) do + local correctionIndex = objectMeta.objectKeys[key] + objectOverride[objectId][correctionIndex] = correction + end + end + end + + do + CLI_Helpers.loadFile(f(".generate_database/_data/%sQuestDB.lua", lowerVersion)) + questOverride = loadstring(QuestieDB.questData)() + LibQuestieDBTable.Quest.LoadOverrideData(false, true) + local questMeta = Corrections.QuestMeta + for questId, corrections in pairs(LibQuestieDBTable.Quest.override) do + if not questOverride[questId] then + questOverride[questId] = {} + end + for key, correction in pairs(corrections) do + local correctionIndex = questMeta.questKeys[key] + questOverride[questId][correctionIndex] = correction + end + end + end + + -- Write all the overrides to disk + ---@diagnostic disable-next-line: param-type-mismatch + -- local file = io.open(f(".generate_database/_data/output/Item/%s/ItemData.lua-table", capitalizedVersion), "w") + print("Dumping item overrides") + -- assert(file, "Failed to open file for writing") + local itemData = helpers.dumpData(itemOverride, Corrections.ItemMeta.itemKeys, Corrections.ItemMeta.dumpFuncs, Corrections.ItemMeta.combine) + ---@diagnostic disable-next-line: undefined-field + -- file:write(itemData) + ---@diagnostic disable-next-line: undefined-field + -- file:close() + + -- ---@diagnostic disable-next-line: param-type-mismatch + -- file = io.open(f(".generate_database/_data/output/Quest/%s/QuestData.lua-table", capitalizedVersion), "w") + -- print("Dumping quest overrides") + -- assert(file, "Failed to open file for writing") + -- local questData = helpers.dumpData(questOverride, Corrections.QuestMeta.questKeys, Corrections.QuestMeta.dumpFuncs) + -- ---@diagnostic disable-next-line: undefined-field + -- file:write(questData) + -- ---@diagnostic disable-next-line: undefined-field + -- file:close() + + -- ---@diagnostic disable-next-line: param-type-mismatch + -- file = io.open(f(".generate_database/_data/output/Npc/%s/NpcData.lua-table", capitalizedVersion), "w") + -- print("Dumping npc overrides") + -- assert(file, "Failed to open file for writing") + -- local npcData = helpers.dumpData(npcOverride, Corrections.NpcMeta.npcKeys, Corrections.NpcMeta.dumpFuncs, Corrections.NpcMeta.combine) + -- ---@diagnostic disable-next-line: undefined-field + -- file:write(npcData) + -- ---@diagnostic disable-next-line: undefined-field + -- file:close() + + -- ---@diagnostic disable-next-line: param-type-mismatch + -- file = io.open(f(".generate_database/_data/output/Object/%s/ObjectData.lua-table", capitalizedVersion), "w") + -- print("Dumping object overrides") + -- assert(file, "Failed to open file for writing") + -- local objectData = helpers.dumpData(objectOverride, Corrections.ObjectMeta.objectKeys, Corrections.ObjectMeta.dumpFuncs) + -- ---@diagnostic disable-next-line: undefined-field + -- file:write(objectData) + -- ---@diagnostic disable-next-line: undefined-field + -- file:close() + + print(f("\n\27[32m%s corrections dumped successfully\27[0m", capitalizedVersion)) +end + +-- local validVersions = { +-- ["era"] = true, +-- ["tbc"] = true, +-- ["wotlk"] = true, +-- } +-- local versionString = "" +-- for version in pairs(validVersions) do +-- local v = string.gsub(version, "^%l", string.upper) +-- versionString = versionString .. v .. "/" +-- end +-- -- Add all +-- versionString = versionString .. "All" + +-- local parser = argparse("createStatic", "createStatic.lua Era") +-- parser:argument("version", f("Game version, %s.", versionString)) + +-- local args = parser:parse() + +-- if args.version and validVersions[args.version:lower()] then +-- DumpDatabase(args.version) +-- elseif args.version and args.version:lower() == "all" then +-- for version in pairs(validVersions) do +-- DumpDatabase(version) +-- end +-- else +-- print("No version specified") +-- end diff --git a/.generate_database_lua/docker-compose.yml b/.generate_database_lua/docker-compose.yml new file mode 100644 index 00000000..e3bb49d5 --- /dev/null +++ b/.generate_database_lua/docker-compose.yml @@ -0,0 +1,9 @@ +version: '3' + +services: + lua_2: + #image: nickblah/lua:5.1-luarocks + build: . + command: sh /QuestieDB/.generate_database_lua/run.sh + volumes: + - '../:/QuestieDB' diff --git a/.generate_database_lua/generate_translation_trie.lua b/.generate_database_lua/generate_translation_trie.lua new file mode 100644 index 00000000..a852747b --- /dev/null +++ b/.generate_database_lua/generate_translation_trie.lua @@ -0,0 +1,183 @@ +require("cli.dump") + +-- Define the maximum number of translations per file +local MAX_TRANSLATIONS_PER_FILE = 35 +local SEGMENT_SIZE = 4000 +local REDUCE_SEGMENT_SIZE = math.max(math.min(SEGMENT_SIZE * 0.05, 100), 10) +print("Max translations per file: " .. MAX_TRANSLATIONS_PER_FILE) +print("Segment size: " .. SEGMENT_SIZE, "Reduced segment size: " .. SEGMENT_SIZE - REDUCE_SEGMENT_SIZE) + +-- Function to sanitize translation strings by replacing special characters with HTML entities +local function sanitize_translation(str) + str = string.gsub(str, "&", "&") + str = string.gsub(str, "<", "<") + str = string.gsub(str, ">", ">") + return str +end + +-- Function to create directories recursively using os.execute +local function mkdir(path) + os.execute("mkdir -p " .. path) +end + +-- Function to split a string into segments based on maximum characters per segment +local function split_into_segments(str, max_chars) + local segments = {} + local total_segments = math.ceil(#str / max_chars) + + -- Loop through the string and create segments + for i = 1, total_segments do + local start_pos = (i - 1) * max_chars + 1 + local end_pos = math.min(i * max_chars, #str) + local segment = string.sub(str, start_pos, end_pos) + -- Add segment number prefix for all segments except the first one + if i > 1 then + segment = tostring(i) .. segment + end + table.insert(segments, segment) + end + + -- Add total segments count to the first segment + segments[1] = total_segments .. segments[1] + + return segments +end + +-- Function to write translations to an HTML file with segmentation +local function write_html_file(key_path, translations) + -- Define the file path + local filename = key_path .. ".html" + + -- Open the file for writing + local file, err = io.open(filename, "w") + if not file then + print("Error opening file " .. filename .. ": " .. err) + return + end + + -- Write the HTML structure + file:write("\n") + for _, translation in ipairs(translations) do + -- Check if the translation needs to be segmented + if #translation > SEGMENT_SIZE - REDUCE_SEGMENT_SIZE then + print("Splitting translation into segments", translation) + -- Split the translation into segments + local segments = split_into_segments(translation, SEGMENT_SIZE - REDUCE_SEGMENT_SIZE) + -- Write each segment as a separate paragraph + for _, segment in ipairs(segments) do + file:write("

" .. sanitize_translation(segment) .. "

\n") + end + else + -- Write the translation as a single paragraph + file:write("

" .. sanitize_translation(translation) .. "

\n") + end + end + file:write("\n") + file:close() +end + +-- Function to create a branch in the trie structure +local function create_branch(strings, stringIndex) + local branch = {} + -- Process each string in the input array + for i = 1, #strings do + local string = strings[i] + local cleanedString = string.gsub(string, "%s", "") + -- Remove all numbers from the string + -- cleanedString = string.gsub(cleanedString, "%d+", "") + cleanedString = string.gsub(cleanedString, "%p", "") + cleanedString = string.gsub(cleanedString, "%c", "") + + -- Get the character at the current index + -- local char = string.sub(string.lower(cleanedString), stringIndex, stringIndex) + local char = string.sub(cleanedString, stringIndex, stringIndex) + + if char == "" then + error(string.format("%s: %d out of range, increase MAX_TRANSLATIONS_PER_FILE", string, stringIndex)) + end + + -- Create a new branch for the character if it doesn't exist + if not branch[char] then + branch[char] = {} + end + table.insert(branch[char], string) + end + + -- Recursively create branches for child nodes if needed + for char, child in pairs(branch) do + if #child > MAX_TRANSLATIONS_PER_FILE then + branch[char] = create_branch(child, stringIndex + 1) + end + end + + return branch +end + +-- Function to create trie folders and write translations to HTML files +local function create_trie_folders(trie, current_path) + print("Current path: " .. current_path) + for key, value in pairs(trie) do + local new_path = current_path .. "/" .. key + if type(value) == "table" then + -- If the number of translations is greater than the maximum or there are no translations + if #value > MAX_TRANSLATIONS_PER_FILE or #value == 0 then + mkdir(new_path) + -- print("Continuing recursion for: " .. new_path) + create_trie_folders(value, new_path) + else + print("Writing HTML file for: " .. new_path) + write_html_file(new_path, value) + end + end + end +end + +-- Main function to compile translations to HTML +function Compile_translations_to_html(strings) + -- Initialize the trie + local success, trie + repeat + success, trie = pcall(create_branch, strings, 1) + if not success then + MAX_TRANSLATIONS_PER_FILE = MAX_TRANSLATIONS_PER_FILE + 1 + print(trie) + print("Shortest word does not fit! - increasing MAX_TRANSLATIONS_PER_FILE to: " .. MAX_TRANSLATIONS_PER_FILE) + end + until success + + -- Create the root folder + local root_folder = "translations" + mkdir(root_folder) + + -- Create trie folders and write translations + create_trie_folders(trie, root_folder) + + -- DevTools_Dump(trie) + -- Dump the trie to a lua file + -- local lines = {} + local function dump_trie(trie, indent) + local lines = {} + local indent_str = string.rep(" ", indent) + if type(trie) == "table" then + for char, value in pairs(trie) do + if type(value) == "table" then + table.insert(lines, indent_str .. "['" .. char .. "'] = {") + table.insert(lines, dump_trie(value, indent + 1)) + table.insert(lines, indent_str .. "},") + else + table.insert(lines, indent_str .. "\"" .. value .. "\",") + end + end + else + table.insert(lines, indent_str .. "[\"" .. trie .. "\"]") + end + return table.concat(lines, "\n") + end + + local lua_file = io.open(root_folder .. "/trie.lua", "w") + if lua_file ~= nil then + local dump_str = dump_trie(trie, 1) + lua_file:write("local trie = {\n" .. dump_str .. "\n}") + lua_file:close() + end +end diff --git a/.generate_database_lua/helpers.lua b/.generate_database_lua/helpers.lua new file mode 100644 index 00000000..7b47659e --- /dev/null +++ b/.generate_database_lua/helpers.lua @@ -0,0 +1,219 @@ +-- helpers.lua +local lfs = require("lfs") + +-- Require the necessary LuaSocket modules +local http = require("socket.http") +local https = require("ssl.https") +local ltn12 = require("ltn12") + +--- Get the script directory. +---@return string The directory containing the script. +local function get_script_dir() + local script_path = debug.getinfo(1, "S").source:sub(2) + return script_path:match("(.*/)") +end + +--- Get the project directory path. +---@return string The project directory path. +local function get_project_dir_path() + return get_script_dir() .. ".." +end + +--- Get the data directory path for a given entity type and expansion. +---@param entity_type string The type of entity (e.g., "Quest", "Item"). +---@param expansion string The expansion name (e.g., "Era", "Tbc", "Wotlk"). +---@return string The data directory path. +local function get_data_dir_path(entity_type, expansion) + local path = get_project_dir_path() .. "/Database/" .. entity_type .. "/" .. expansion + -- Does path not exist, l10n has this issue... + if not lfs.attributes(path, "mode") then + print("Path " .. path .. " does not exist, trying lowercase") + path = get_project_dir_path() .. "/Database/" .. entity_type:lower() .. "/" .. expansion + end + return path +end + +--- Find the addon name. +---@return string The addon name. +local function find_addon_name() + local current_dir = lfs.currentdir() + local previous_dir = nil + local addon_dir = nil + local max_level = 20 + local level = 0 + + while level < max_level do + local dir_name = current_dir:match("([^/]+)$") + local parent_dir = current_dir:match("^(.*)/[^/]+$") + if type(dir_name) == "nil" then + addon_dir = previous_dir + break + elseif dir_name:lower() == "addons" and parent_dir:match("([^/]+)$"):lower() == "interface" then + addon_dir = previous_dir + break + else + previous_dir = current_dir + current_dir = parent_dir + level = level + 1 + end + end + + if not addon_dir then + print("Could not find the Addons folder, defaulting to 'QuestieDB'.") + return "QuestieDB" + else + print("Found Addons folder: " .. addon_dir) + end + + return addon_dir +end + +--- Read expansion data from a Lua file. +---@param expansion string The expansion name (e.g., "Era", "Tbc", "Wotlk"). +---@param entity_type string The type of entity (e.g., "Quest", "Item"). +---@return string|nil The content of the Lua file, or nil if not found. +local function read_expansion_data(expansion, entity_type) + local path = get_data_dir_path(entity_type, expansion) + print("Reading " .. expansion .. " lua " .. entity_type:lower() .. " data from " .. path) + local file_path = path .. "/" .. entity_type:sub(1, 1):upper() .. entity_type:sub(2):lower() .. "Data.lua-table" + + if not lfs.attributes(file_path, "mode") then + file_path = path .. "/" .. entity_type:lower() .. "Data.lua-table" + if not lfs.attributes(file_path, "mode") then + print("File not found: " .. file_path) + return nil + end + end + + local file, err = io.open(file_path, "r") + if not file then + print("File not found: " .. path) + return nil + end + + local data = file:read("*all") + file:close() + + -- Perform any necessary replacements on the data string + data = data:gsub("&", "and"):gsub("<", "|"):gsub(">", "|") + return data +end + +--- Download a raw text file from a URL and return its contents as a string. +-- @param url string The URL of the text file to download. +-- @return string|nil The contents of the text file, or nil if the download fails. +local function download_text_file(url) + local response_body = {} + local res, code, response_headers = https.request { + url = url, + sink = ltn12.sink.table(response_body), + } + + if res == 1 and code == 200 then + -- Concatenate the table into a single string + return table.concat(response_body) + else + print("Failed to download file: HTTP response code " .. tostring(code)) + return nil + end +end + +---Dumps the data for Item, Quest, Npc, Object into a string +---@param tbl table> @ Table that will be dumped, Item, Quest, Npc, Object +---@param dataKeys ItemDBKeys|QuestDBKeys|NpcDBKeys|ObjectDBKeys @ Contains name of data as keys and their index as value +---@param dumpFunctions table @ Contains the functions that will be used to dump the data +---@param combineFunc function? @ Function that will be used to combine the data, if nil the data will not be combined +---@return string,table[] @ Returns the dumped data as a string and a table of the dumped data +local function dumpData(tbl, dataKeys, dumpFunctions, combineFunc) + -- sort tbl by key + local sortedKeys = {} + for key in pairs(tbl) do + sortedKeys[#sortedKeys + 1] = key + end + table.sort(sortedKeys) + + local nrDataKeys = 0 + local reversedKeys = {} + for key, id in pairs(dataKeys) do + reversedKeys[id] = key + nrDataKeys = nrDataKeys + 1 + end + + local allResultsTbl = {} + local allResults = { "{\n", } + for sortKeyIndex = 1, #sortedKeys do + local sortKey = sortedKeys[sortKeyIndex] + + -- print(sortKey) + local value = tbl[sortKey] + + local resulttable = {} + for i = 1, nrDataKeys do + resulttable[i] = "nil" + end + + for key = 1, nrDataKeys do + -- The name of the key e.g. "objectDrops" + local dataName = dataKeys[key] == nil and reversedKeys[key] or key + -- The id of the key e.g. "3"-(objectDrops) + local dataKey = type(key) == "number" and key or dataKeys[key] + + -- print(key, dataName, dataKey) + + -- Get the data from the table + local data = value[key] + + -- Because we build it with nil we have to check for nil here, if the value is nil we just print nil + if data ~= "nil" and data ~= nil then + local dumpFunction = dumpFunctions[dataName] + if dumpFunction then + local dumpedData = dumpFunction(data) + resulttable[dataKey] = dumpedData + else + error("No dump function for key: " .. "dataName" .. " (" .. tostring(dataName) .. ")" .. " dataKey: " .. tostring(dataKey)) + end + else + resulttable[dataKey] = "nil" + end + end + -- DevTools_Dump({resulttable}) + + -- If a combine funnction exist we run it here + assert(#resulttable == nrDataKeys, "resulttable length is not equal to dataKeys length, combine will fail") + if combineFunc then + combineFunc(resulttable) + end + -- DevTools_Dump({resulttable}) + + -- Concat the data into a string + local data = table.concat(resulttable, ",") + + allResultsTbl[sortKey] = data + + -- Remove trailing nil + repeat + local count = 0 + data, count = string.gsub(data, ",nil$", "") + until count == 0 + + -- Add the data to the result + allResults[#allResults + 1] = " [" .. sortKey .. "] = {" + allResults[#allResults + 1] = data + allResults[#allResults + 1] = ",},\n" + end + allResults[#allResults + 1] = "}" + -- return result .. "}" + return table.concat(allResults), allResultsTbl +end + +---@class helpers +local return_table = { + get_project_dir_path = get_project_dir_path, + get_data_dir_path = get_data_dir_path, + find_addon_name = find_addon_name, + read_expansion_data = read_expansion_data, + dumpData = dumpData, + download_text_file = download_text_file, +} +-- Expose functions +return return_table diff --git a/.generate_database_lua/main.lua b/.generate_database_lua/main.lua new file mode 100644 index 00000000..5c807711 --- /dev/null +++ b/.generate_database_lua/main.lua @@ -0,0 +1,100 @@ +-- main.lua +-- Prepend your script's directory to the package.path +local script_path = debug.getinfo(1, "S").source:sub(2) +local script_dir = script_path:match("(.*/)") +package.path = script_dir .. "?.lua;" .. package.path + +local helpers = require("helpers") +require("cli.CLI_Helpers") + +-- Main function to demonstrate the usage of helper functions +local function main() + -- Get the project directory path + local project_dir = helpers.get_project_dir_path() + print("Project Directory Path: " .. project_dir) + + -- Get the data directory path for a specific entity type and expansion + local entity_type = "Quest" + local expansion = "Wotlk" + local data_dir = helpers.get_data_dir_path(entity_type, expansion) + print("Data Directory Path for " .. entity_type .. " in " .. expansion .. ": " .. data_dir) + + -- Find the addon name + local addon_name = helpers.find_addon_name() + print("Addon Name: " .. addon_name) + + -- Read expansion data + local expansion_data = helpers.read_expansion_data(expansion, entity_type) + if expansion_data then + local lines = 4 + local count = 0 + for line in expansion_data:gmatch(" [^\n]+") do + print(line) + count = count + 1 + if count >= lines then + break + end + end + else + print("No data found for " .. entity_type .. " in " .. expansion) + end + + -- Download a file from a URL + local url = "https://raw.githubusercontent.com/Questie/Questie/master/Database/Classic/classicItemDB.lua" + local data = helpers.download_text_file(url) + if data then + print("Downloaded data from URL: ") + local lines = 4 + local count = 0 + for line in data:gmatch(" [^\n]+") do + print(line) + count = count + 1 + if count >= lines then + break + end + end + else + print("Failed to download data from URL: " .. url) + end + + -- Write data to a file + -- Write data to a file + local output_dir = ".generate_database/_data" + local output_file = output_dir .. "/eraItemDB.lua" + + -- Write the data to the file + local file, err = io.open(output_file, "w") + if not file then + print("Error opening file for writing: " .. err) + else + file:write(data) + file:close() + print("Data written to file: " .. output_file) + end +end + + +require("cli.Addon_Meta") +local translations = {} +QuestieLoader = { + ImportModule = function() + return { translations = translations, } + end, +} + +CLI_Helpers.loadTOC(".generate_database_lua/translations.toc") + + +local single_translation = {} +for key, value in pairs(translations) do + local translation = string.gsub(key, "\n", "
") + translation = string.gsub(translation, '"', '\\"') + table.insert(single_translation, translation) +end + +require("generate_translation_trie") + +Compile_translations_to_html(single_translation) + +-- Run the main function +-- main() diff --git a/.generate_database_lua/run.sh b/.generate_database_lua/run.sh new file mode 100644 index 00000000..743969e3 --- /dev/null +++ b/.generate_database_lua/run.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +echo "Current directory: $(pwd)" +echo "$(which $1) is the lua executable" + +# First argument points to lua executable set "lua" if not set +if [ -z "$1" ]; then + LUA=lua +else + LUA=$1 +fi + +# Needed for the docker container but not action but it doesn't hurt the run if it fails +cd /QuestieDB + + + +$LUA ./.generate_database_lua/main.lua +# $LUA ./.generate_database_lua/generate_translation_trie.lua \ No newline at end of file diff --git a/Database/l10n/l10n.lua b/Database/l10n/l10n.lua index d50ee3dc..badcb5ae 100644 --- a/Database/l10n/l10n.lua +++ b/Database/l10n/l10n.lua @@ -9,9 +9,7 @@ local l10n = LibQuestieDB.CreateDatabaseInTable(LibQuestieDB.l10n, "l10n", {}) l10n.currentLocale = GetLocale() -- Set this to nil to use the locale of the client -- Override locale -l10n.currentLocale = "ptBR" - -GLOBl10n = l10n +-- l10n.currentLocale = "ptBR" -- Order Item, Npc, Object, Quest -- "enUS": "", # English (US) # Yes EN is empty @@ -45,20 +43,28 @@ local indexToLocale = { local localeToIndex = {} local localeToPattern = {} do + -- Populate the localeToIndex table with locale as key and its index as value + -- This helps in quickly finding the index of a given locale for k, v in pairs(indexToLocale) do localeToIndex[v] = k end + -- Function to create a pattern string for a given locale + -- This pattern is used to extract the localized string from a concatenated string of all locales local function createPatternForLocale(locale) - local patternString = "^" - local repeatPattern = ".-" - local capturePattern = "(.-)" + local patternString = "^" -- Start of the string + local repeatPattern = ".-" -- Non-greedy match for any character sequence + local capturePattern = "(.-)" -- Non-greedy match for any character sequence, to be captured for i = 1, localeToIndex[locale] do - patternString = patternString .. (i == localeToIndex[locale] and capturePattern or repeatPattern) .. (i == #indexToLocale and "$" or specialChar) + -- Append the appropriate pattern based on the current index + patternString = patternString .. (i == localeToIndex[locale] and capturePattern or repeatPattern) + patternString = patternString .. (i == #indexToLocale and "$" or specialChar) end return patternString end + -- Populate the localeToPattern table with locale as key and its pattern as value + -- This pattern is used to extract the localized string for the given locale for i = 1, #indexToLocale do localeToPattern[indexToLocale[i]] = createPatternForLocale(indexToLocale[i]) end diff --git a/cli/CLI_Helpers.lua b/cli/CLI_Helpers.lua index 874fb5d9..567fc247 100644 --- a/cli/CLI_Helpers.lua +++ b/cli/CLI_Helpers.lua @@ -68,8 +68,10 @@ function CLI_Helpers.loadTOC(file) local xmlFilePath = line:match("^(.*)/.-%.xml$") .. "/" -- print(xmlFilePath) for xmlFile in string.gmatch(filetext, " Date: Thu, 26 Sep 2024 12:50:59 +0200 Subject: [PATCH 10/18] Remove these... --- wiki-information/events/ACHIEVEMENT_EARNED.md | 13 - .../events/ACHIEVEMENT_PLAYER_NAME.md | 11 - .../events/ACHIEVEMENT_SEARCH_UPDATED.md | 10 - wiki-information/events/ACTIONBAR_HIDEGRID.md | 10 - .../events/ACTIONBAR_PAGE_CHANGED.md | 10 - wiki-information/events/ACTIONBAR_SHOWGRID.md | 10 - .../events/ACTIONBAR_SHOW_BOTTOMLEFT.md | 27 --- .../events/ACTIONBAR_SLOT_CHANGED.md | 14 -- .../events/ACTIONBAR_UPDATE_COOLDOWN.md | 10 - .../events/ACTIONBAR_UPDATE_STATE.md | 10 - .../events/ACTIONBAR_UPDATE_USABLE.md | 10 - .../events/ACTION_WILL_BIND_ITEM.md | 10 - wiki-information/events/ACTIVATE_GLYPH.md | 11 - .../events/ACTIVE_TALENT_GROUP_CHANGED.md | 13 - .../events/ADAPTER_LIST_CHANGED.md | 10 - wiki-information/events/ADDONS_UNLOADING.md | 11 - .../events/ADDON_ACTION_BLOCKED.md | 13 - .../events/ADDON_ACTION_FORBIDDEN.md | 13 - wiki-information/events/ADDON_LOADED.md | 17 -- .../events/ADVENTURE_MAP_CLOSE.md | 10 - wiki-information/events/ADVENTURE_MAP_OPEN.md | 11 - .../events/ADVENTURE_MAP_QUEST_UPDATE.md | 11 - .../events/ADVENTURE_MAP_UPDATE_INSETS.md | 10 - .../events/ADVENTURE_MAP_UPDATE_POIS.md | 10 - wiki-information/events/AJ_DUNGEON_ACTION.md | 11 - wiki-information/events/AJ_OPEN.md | 10 - wiki-information/events/AJ_PVE_LFG_ACTION.md | 10 - wiki-information/events/AJ_PVP_ACTION.md | 11 - wiki-information/events/AJ_PVP_LFG_ACTION.md | 10 - wiki-information/events/AJ_PVP_RBG_ACTION.md | 10 - .../events/AJ_PVP_SKIRMISH_ACTION.md | 10 - wiki-information/events/AJ_QUEST_LOG_OPEN.md | 13 - wiki-information/events/AJ_RAID_ACTION.md | 11 - wiki-information/events/AJ_REFRESH_DISPLAY.md | 11 - .../events/AJ_REWARD_DATA_RECEIVED.md | 10 - .../events/ALERT_REGIONAL_CHAT_DISABLED.md | 10 - .../ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md | 10 - wiki-information/events/AREA_POIS_UPDATED.md | 10 - .../events/AREA_SPIRIT_HEALER_IN_RANGE.md | 10 - .../events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md | 10 - .../events/ARENA_COOLDOWNS_UPDATE.md | 11 - .../ARENA_CROWD_CONTROL_SPELL_UPDATE.md | 13 - .../events/ARENA_OPPONENT_UPDATE.md | 13 - .../events/ARENA_SEASON_WORLD_STATE.md | 10 - .../events/ARENA_TEAM_ROSTER_UPDATE.md | 11 - wiki-information/events/ARENA_TEAM_UPDATE.md | 10 - .../events/AUCTION_BIDDER_LIST_UPDATE.md | 10 - .../events/AUCTION_HOUSE_CLOSED.md | 13 - .../events/AUCTION_HOUSE_DISABLED.md | 10 - .../events/AUCTION_HOUSE_POST_ERROR.md | 10 - .../events/AUCTION_HOUSE_POST_WARNING.md | 10 - .../events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md | 10 - wiki-information/events/AUCTION_HOUSE_SHOW.md | 10 - .../events/AUCTION_ITEM_LIST_UPDATE.md | 13 - .../events/AUCTION_MULTISELL_FAILURE.md | 10 - .../events/AUCTION_MULTISELL_START.md | 11 - .../events/AUCTION_MULTISELL_UPDATE.md | 13 - .../events/AUCTION_OWNED_LIST_UPDATE.md | 14 -- wiki-information/events/AUTOFOLLOW_BEGIN.md | 11 - wiki-information/events/AUTOFOLLOW_END.md | 10 - .../events/AVATAR_LIST_UPDATED.md | 17 -- ..._EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md | 11 - .../events/AZERITE_EMPOWERED_ITEM_LOOTED.md | 11 - ...ZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md | 11 - .../events/AZERITE_ESSENCE_ACTIVATED.md | 21 -- .../AZERITE_ESSENCE_ACTIVATION_FAILED.md | 21 -- .../events/AZERITE_ESSENCE_CHANGED.md | 13 - .../events/AZERITE_ESSENCE_FORGE_CLOSE.md | 10 - .../events/AZERITE_ESSENCE_FORGE_OPEN.md | 10 - .../AZERITE_ESSENCE_MILESTONE_UNLOCKED.md | 11 - .../events/AZERITE_ESSENCE_UPDATE.md | 11 - .../AZERITE_ITEM_ENABLED_STATE_CHANGED.md | 11 - .../events/AZERITE_ITEM_EXPERIENCE_CHANGED.md | 15 -- .../AZERITE_ITEM_POWER_LEVEL_CHANGED.md | 26 -- wiki-information/events/BAG_CLOSED.md | 11 - .../events/BAG_NEW_ITEMS_UPDATED.md | 10 - wiki-information/events/BAG_OPEN.md | 11 - .../BAG_OVERFLOW_WITH_FULL_INVENTORY.md | 10 - .../events/BAG_SLOT_FLAGS_UPDATED.md | 11 - wiki-information/events/BAG_UPDATE.md | 14 -- .../events/BAG_UPDATE_COOLDOWN.md | 10 - wiki-information/events/BAG_UPDATE_DELAYED.md | 10 - wiki-information/events/BANKFRAME_CLOSED.md | 13 - wiki-information/events/BANKFRAME_OPENED.md | 10 - .../events/BANK_BAG_SLOT_FLAGS_UPDATED.md | 11 - .../events/BARBER_SHOP_APPEARANCE_APPLIED.md | 10 - .../BARBER_SHOP_CAMERA_VALUES_UPDATED.md | 10 - wiki-information/events/BARBER_SHOP_CLOSE.md | 10 - .../events/BARBER_SHOP_COST_UPDATE.md | 10 - ...BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md | 10 - wiki-information/events/BARBER_SHOP_OPEN.md | 10 - wiki-information/events/BARBER_SHOP_RESULT.md | 11 - .../events/BATTLEFIELDS_CLOSED.md | 10 - wiki-information/events/BATTLEFIELDS_SHOW.md | 13 - .../events/BATTLEFIELD_AUTO_QUEUE.md | 10 - .../events/BATTLEFIELD_AUTO_QUEUE_EJECT.md | 10 - .../events/BATTLEFIELD_QUEUE_TIMEOUT.md | 10 - .../events/BATTLEGROUND_OBJECTIVES_UPDATE.md | 10 - .../events/BATTLEGROUND_POINTS_UPDATE.md | 10 - .../events/BATTLETAG_INVITE_SHOW.md | 11 - .../events/BATTLE_PET_CURSOR_CLEAR.md | 14 -- .../events/BEHAVIORAL_NOTIFICATION.md | 13 - wiki-information/events/BIND_ENCHANT.md | 10 - .../events/BLACK_MARKET_BID_RESULT.md | 13 - wiki-information/events/BLACK_MARKET_CLOSE.md | 10 - .../events/BLACK_MARKET_ITEM_UPDATE.md | 10 - wiki-information/events/BLACK_MARKET_OPEN.md | 10 - .../events/BLACK_MARKET_OUTBID.md | 13 - .../events/BLACK_MARKET_UNAVAILABLE.md | 10 - wiki-information/events/BLACK_MARKET_WON.md | 13 - .../events/BN_BLOCK_FAILED_TOO_MANY.md | 11 - .../events/BN_BLOCK_LIST_UPDATED.md | 10 - wiki-information/events/BN_CHAT_MSG_ADDON.md | 17 -- .../events/BN_CHAT_WHISPER_UNDELIVERABLE.md | 11 - wiki-information/events/BN_CONNECTED.md | 11 - .../events/BN_CUSTOM_MESSAGE_CHANGED.md | 11 - .../events/BN_CUSTOM_MESSAGE_LOADED.md | 10 - wiki-information/events/BN_DISCONNECTED.md | 13 - .../events/BN_FRIEND_ACCOUNT_OFFLINE.md | 13 - .../events/BN_FRIEND_ACCOUNT_ONLINE.md | 13 - .../events/BN_FRIEND_INFO_CHANGED.md | 11 - .../events/BN_FRIEND_INVITE_ADDED.md | 11 - .../BN_FRIEND_INVITE_LIST_INITIALIZED.md | 11 - .../events/BN_FRIEND_INVITE_REMOVED.md | 10 - .../events/BN_FRIEND_LIST_SIZE_CHANGED.md | 11 - wiki-information/events/BN_INFO_CHANGED.md | 10 - .../events/BN_REQUEST_FOF_SUCCEEDED.md | 10 - wiki-information/events/BOSS_KILL.md | 13 - .../events/CALENDAR_ACTION_PENDING.md | 11 - .../events/CALENDAR_CLOSE_EVENT.md | 10 - .../events/CALENDAR_EVENT_ALARM.md | 15 -- wiki-information/events/CALENDAR_NEW_EVENT.md | 11 - .../events/CALENDAR_OPEN_EVENT.md | 26 -- .../events/CALENDAR_UPDATE_ERROR.md | 11 - .../CALENDAR_UPDATE_ERROR_WITH_COUNT.md | 13 - .../CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md | 13 - .../events/CALENDAR_UPDATE_EVENT.md | 10 - .../events/CALENDAR_UPDATE_EVENT_LIST.md | 10 - .../events/CALENDAR_UPDATE_GUILD_EVENTS.md | 10 - .../events/CALENDAR_UPDATE_INVITE_LIST.md | 11 - .../events/CALENDAR_UPDATE_PENDING_INVITES.md | 10 - wiki-information/events/CANCEL_GLYPH_CAST.md | 14 -- wiki-information/events/CANCEL_LOOT_ROLL.md | 11 - wiki-information/events/CANCEL_SUMMON.md | 10 - .../events/CAPTUREFRAMES_FAILED.md | 10 - .../events/CAPTUREFRAMES_SUCCEEDED.md | 10 - .../events/CEMETERY_PREFERENCE_UPDATED.md | 10 - .../events/CHANNEL_COUNT_UPDATE.md | 13 - .../events/CHANNEL_FLAGS_UPDATED.md | 11 - .../events/CHANNEL_INVITE_REQUEST.md | 13 - wiki-information/events/CHANNEL_LEFT.md | 13 - .../events/CHANNEL_PASSWORD_REQUEST.md | 11 - .../events/CHANNEL_ROSTER_UPDATE.md | 13 - wiki-information/events/CHANNEL_UI_UPDATE.md | 10 - .../CHARACTER_ITEM_FIXUP_NOTIFICATION.md | 11 - .../events/CHARACTER_POINTS_CHANGED.md | 13 - .../CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md | 43 ---- .../events/CHAT_DISABLED_CHANGED.md | 11 - .../events/CHAT_DISABLED_CHANGE_FAILED.md | 11 - .../events/CHAT_MSG_ACHIEVEMENT.md | 43 ---- wiki-information/events/CHAT_MSG_ADDON.md | 33 --- .../events/CHAT_MSG_ADDON_LOGGED.md | 27 --- wiki-information/events/CHAT_MSG_AFK.md | 43 ---- .../events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md | 43 ---- .../events/CHAT_MSG_BG_SYSTEM_HORDE.md | 43 ---- .../events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md | 43 ---- wiki-information/events/CHAT_MSG_BN.md | 43 ---- .../events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md | 43 ---- .../CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md | 43 ---- ...AT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md | 43 ---- .../CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md | 43 ---- .../events/CHAT_MSG_BN_WHISPER.md | 43 ---- .../events/CHAT_MSG_BN_WHISPER_INFORM.md | 43 ---- .../CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md | 43 ---- wiki-information/events/CHAT_MSG_CHANNEL.md | 43 ---- .../events/CHAT_MSG_CHANNEL_JOIN.md | 43 ---- .../events/CHAT_MSG_CHANNEL_LEAVE.md | 43 ---- .../events/CHAT_MSG_CHANNEL_LIST.md | 43 ---- .../events/CHAT_MSG_CHANNEL_NOTICE.md | 43 ---- .../events/CHAT_MSG_CHANNEL_NOTICE_USER.md | 43 ---- .../events/CHAT_MSG_COMBAT_FACTION_CHANGE.md | 43 ---- .../events/CHAT_MSG_COMBAT_HONOR_GAIN.md | 43 ---- .../events/CHAT_MSG_COMBAT_MISC_INFO.md | 43 ---- .../events/CHAT_MSG_COMBAT_XP_GAIN.md | 43 ---- .../events/CHAT_MSG_COMMUNITIES_CHANNEL.md | 43 ---- wiki-information/events/CHAT_MSG_CURRENCY.md | 43 ---- wiki-information/events/CHAT_MSG_DND.md | 43 ---- wiki-information/events/CHAT_MSG_EMOTE.md | 51 ---- wiki-information/events/CHAT_MSG_FILTERED.md | 43 ---- wiki-information/events/CHAT_MSG_GUILD.md | 43 ---- .../events/CHAT_MSG_GUILD_ACHIEVEMENT.md | 43 ---- .../events/CHAT_MSG_GUILD_ITEM_LOOTED.md | 43 ---- wiki-information/events/CHAT_MSG_IGNORED.md | 43 ---- .../events/CHAT_MSG_INSTANCE_CHAT.md | 43 ---- .../events/CHAT_MSG_INSTANCE_CHAT_LEADER.md | 43 ---- wiki-information/events/CHAT_MSG_LOOT.md | 46 ---- wiki-information/events/CHAT_MSG_MONEY.md | 43 ---- .../events/CHAT_MSG_MONSTER_EMOTE.md | 49 ---- .../events/CHAT_MSG_MONSTER_PARTY.md | 49 ---- .../events/CHAT_MSG_MONSTER_SAY.md | 49 ---- .../events/CHAT_MSG_MONSTER_WHISPER.md | 49 ---- .../events/CHAT_MSG_MONSTER_YELL.md | 49 ---- wiki-information/events/CHAT_MSG_OFFICER.md | 43 ---- wiki-information/events/CHAT_MSG_OPENING.md | 43 ---- wiki-information/events/CHAT_MSG_PARTY.md | 51 ---- .../events/CHAT_MSG_PARTY_LEADER.md | 43 ---- .../events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md | 43 ---- .../events/CHAT_MSG_PET_BATTLE_INFO.md | 43 ---- wiki-information/events/CHAT_MSG_PET_INFO.md | 43 ---- wiki-information/events/CHAT_MSG_RAID.md | 50 ---- .../events/CHAT_MSG_RAID_BOSS_EMOTE.md | 43 ---- .../events/CHAT_MSG_RAID_BOSS_WHISPER.md | 43 ---- .../events/CHAT_MSG_RAID_LEADER.md | 43 ---- .../events/CHAT_MSG_RAID_WARNING.md | 43 ---- .../events/CHAT_MSG_RESTRICTED.md | 43 ---- wiki-information/events/CHAT_MSG_SAY.md | 51 ---- wiki-information/events/CHAT_MSG_SKILL.md | 45 ---- wiki-information/events/CHAT_MSG_SYSTEM.md | 48 ---- .../events/CHAT_MSG_TARGETICONS.md | 44 ---- .../events/CHAT_MSG_TEXT_EMOTE.md | 43 ---- .../events/CHAT_MSG_TRADESKILLS.md | 43 ---- .../events/CHAT_MSG_VOICE_TEXT.md | 43 ---- wiki-information/events/CHAT_MSG_WHISPER.md | 51 ---- .../events/CHAT_MSG_WHISPER_INFORM.md | 43 ---- wiki-information/events/CHAT_MSG_YELL.md | 51 ---- .../events/CHAT_SERVER_DISCONNECTED.md | 11 - .../events/CHAT_SERVER_RECONNECTED.md | 10 - wiki-information/events/CINEMATIC_START.md | 15 -- wiki-information/events/CINEMATIC_STOP.md | 13 - .../events/CLASS_TRIAL_TIMER_START.md | 10 - .../events/CLASS_TRIAL_UPGRADE_COMPLETE.md | 10 - wiki-information/events/CLEAR_BOSS_EMOTES.md | 10 - .../events/CLIENT_SCENE_CLOSED.md | 10 - .../events/CLIENT_SCENE_OPENED.md | 18 -- wiki-information/events/CLOSE_INBOX_ITEM.md | 11 - wiki-information/events/CLOSE_TABARD_FRAME.md | 10 - wiki-information/events/CLUB_ADDED.md | 11 - wiki-information/events/CLUB_ERROR.md | 98 -------- .../CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md | 11 - .../events/CLUB_INVITATION_ADDED_FOR_SELF.md | 172 ------------- .../CLUB_INVITATION_REMOVED_FOR_SELF.md | 11 - wiki-information/events/CLUB_MEMBER_ADDED.md | 13 - .../events/CLUB_MEMBER_PRESENCE_UPDATED.md | 31 --- .../events/CLUB_MEMBER_REMOVED.md | 13 - .../events/CLUB_MEMBER_ROLE_UPDATED.md | 15 -- .../events/CLUB_MEMBER_UPDATED.md | 13 - wiki-information/events/CLUB_MESSAGE_ADDED.md | 23 -- .../events/CLUB_MESSAGE_HISTORY_RECEIVED.md | 34 --- .../events/CLUB_MESSAGE_UPDATED.md | 23 -- wiki-information/events/CLUB_REMOVED.md | 11 - .../events/CLUB_REMOVED_MESSAGE.md | 24 -- .../events/CLUB_SELF_MEMBER_ROLE_UPDATED.md | 13 - .../events/CLUB_STREAMS_LOADED.md | 11 - wiki-information/events/CLUB_STREAM_ADDED.md | 13 - .../events/CLUB_STREAM_REMOVED.md | 13 - .../events/CLUB_STREAM_SUBSCRIBED.md | 13 - .../events/CLUB_STREAM_UNSUBSCRIBED.md | 13 - .../events/CLUB_STREAM_UPDATED.md | 13 - .../events/CLUB_TICKETS_RECEIVED.md | 11 - .../events/CLUB_TICKET_CREATED.md | 140 ----------- .../events/CLUB_TICKET_RECEIVED.md | 11 - wiki-information/events/CLUB_UPDATED.md | 11 - wiki-information/events/COMBAT_LOG_EVENT.md | 220 ----------------- .../events/COMBAT_LOG_EVENT_UNFILTERED.md | 228 ------------------ .../events/COMBAT_RATING_UPDATE.md | 10 - wiki-information/events/COMBAT_TEXT_UPDATE.md | 37 --- .../events/COMMENTATOR_ENTER_WORLD.md | 10 - .../events/COMMENTATOR_HISTORY_FLUSHED.md | 10 - .../COMMENTATOR_IMMEDIATE_FOV_UPDATE.md | 11 - .../events/COMMENTATOR_MAP_UPDATE.md | 10 - ...COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md | 13 - .../events/COMMENTATOR_PLAYER_UPDATE.md | 10 - .../events/COMMENTATOR_RESET_SETTINGS.md | 10 - .../events/COMMENTATOR_TEAMS_SWAPPED.md | 11 - .../events/COMMENTATOR_TEAM_NAME_UPDATE.md | 11 - .../events/COMMUNITIES_STREAM_CURSOR_CLEAR.md | 10 - .../COMPACT_UNIT_FRAME_PROFILES_LOADED.md | 10 - wiki-information/events/COMPANION_LEARNED.md | 10 - .../events/COMPANION_UNLEARNED.md | 10 - wiki-information/events/COMPANION_UPDATE.md | 20 -- wiki-information/events/CONFIRM_BEFORE_USE.md | 10 - wiki-information/events/CONFIRM_BINDER.md | 11 - wiki-information/events/CONFIRM_LOOT_ROLL.md | 18 -- .../events/CONFIRM_PET_UNLEARN.md | 11 - wiki-information/events/CONFIRM_SUMMON.md | 13 - .../events/CONFIRM_TALENT_WIPE.md | 13 - wiki-information/events/CONFIRM_XP_LOSS.md | 16 -- wiki-information/events/CONSOLE_CLEAR.md | 10 - .../events/CONSOLE_COLORS_CHANGED.md | 10 - .../events/CONSOLE_FONT_SIZE_CHANGED.md | 10 - wiki-information/events/CONSOLE_LOG.md | 11 - wiki-information/events/CONSOLE_MESSAGE.md | 13 - wiki-information/events/CORPSE_IN_INSTANCE.md | 10 - wiki-information/events/CORPSE_IN_RANGE.md | 10 - .../events/CORPSE_OUT_OF_RANGE.md | 10 - wiki-information/events/CRAFT_CLOSE.md | 10 - wiki-information/events/CRAFT_SHOW.md | 10 - wiki-information/events/CRAFT_UPDATE.md | 10 - wiki-information/events/CRITERIA_COMPLETE.md | 11 - wiki-information/events/CRITERIA_EARNED.md | 13 - wiki-information/events/CRITERIA_UPDATE.md | 13 - .../events/CURRENCY_DISPLAY_UPDATE.md | 19 -- .../events/CURRENT_SPELL_CAST_CHANGED.md | 11 - wiki-information/events/CURSOR_CHANGED.md | 40 --- wiki-information/events/CURSOR_UPDATE.md | 10 - wiki-information/events/CVAR_UPDATE.md | 13 - .../events/DELETE_ITEM_CONFIRM.md | 17 -- .../events/DISABLE_DECLINE_GUILD_INVITE.md | 10 - .../events/DISABLE_LOW_LEVEL_RAID.md | 10 - .../events/DISABLE_TAXI_BENCHMARK.md | 10 - wiki-information/events/DISABLE_XP_GAIN.md | 10 - .../events/DISPLAY_SIZE_CHANGED.md | 10 - wiki-information/events/DUEL_FINISHED.md | 10 - wiki-information/events/DUEL_INBOUNDS.md | 10 - wiki-information/events/DUEL_OUTOFBOUNDS.md | 10 - wiki-information/events/DUEL_REQUESTED.md | 11 - .../events/DYNAMIC_GOSSIP_POI_UPDATED.md | 19 -- .../events/ENABLE_DECLINE_GUILD_INVITE.md | 10 - .../events/ENABLE_LOW_LEVEL_RAID.md | 10 - .../events/ENABLE_TAXI_BENCHMARK.md | 10 - wiki-information/events/ENABLE_XP_GAIN.md | 10 - wiki-information/events/ENCOUNTER_END.md | 19 -- wiki-information/events/ENCOUNTER_START.md | 17 -- .../events/END_BOUND_TRADEABLE.md | 11 - .../ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md | 10 - .../events/ENTITLEMENT_DELIVERED.md | 33 --- .../events/EQUIPMENT_SETS_CHANGED.md | 10 - .../events/EQUIPMENT_SWAP_FINISHED.md | 13 - .../events/EQUIPMENT_SWAP_PENDING.md | 10 - wiki-information/events/EQUIP_BIND_CONFIRM.md | 11 - .../events/EQUIP_BIND_REFUNDABLE_CONFIRM.md | 11 - .../events/EQUIP_BIND_TRADEABLE_CONFIRM.md | 11 - wiki-information/events/EXECUTE_CHAT_LINE.md | 11 - .../events/FIRST_FRAME_RENDERED.md | 10 - .../events/FORBIDDEN_NAME_PLATE_CREATED.md | 11 - .../events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md | 11 - .../FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md | 11 - wiki-information/events/FRIENDLIST_UPDATE.md | 21 -- .../events/GAME_PAD_ACTIVE_CHANGED.md | 11 - .../events/GAME_PAD_CONFIGS_CHANGED.md | 10 - wiki-information/events/GAME_PAD_CONNECTED.md | 10 - .../events/GAME_PAD_DISCONNECTED.md | 10 - .../events/GAME_PAD_POWER_CHANGED.md | 20 -- wiki-information/events/GDF_SIM_COMPLETE.md | 10 - wiki-information/events/GENERIC_ERROR.md | 11 - .../events/GET_ITEM_INFO_RECEIVED.md | 15 -- wiki-information/events/GLOBAL_MOUSE_DOWN.md | 11 - wiki-information/events/GLOBAL_MOUSE_UP.md | 11 - wiki-information/events/GLUE_CONSOLE_LOG.md | 11 - .../events/GLUE_SCREENSHOT_FAILED.md | 10 - wiki-information/events/GM_PLAYER_INFO.md | 13 - wiki-information/events/GOSSIP_CLOSED.md | 10 - wiki-information/events/GOSSIP_CONFIRM.md | 15 -- .../events/GOSSIP_CONFIRM_CANCEL.md | 10 - wiki-information/events/GOSSIP_ENTER_CODE.md | 11 - wiki-information/events/GOSSIP_SHOW.md | 14 -- wiki-information/events/GROUP_FORMED.md | 13 - .../events/GROUP_INVITE_CONFIRMATION.md | 10 - wiki-information/events/GROUP_JOINED.md | 13 - wiki-information/events/GROUP_LEFT.md | 13 - .../events/GROUP_ROSTER_UPDATE.md | 10 - .../events/GUILDBANKBAGSLOTS_CHANGED.md | 10 - .../events/GUILDBANKFRAME_CLOSED.md | 10 - .../events/GUILDBANKFRAME_OPENED.md | 10 - .../events/GUILDBANKLOG_UPDATE.md | 10 - .../events/GUILDBANK_ITEM_LOCK_CHANGED.md | 10 - .../events/GUILDBANK_TEXT_CHANGED.md | 11 - .../events/GUILDBANK_UPDATE_MONEY.md | 10 - .../events/GUILDBANK_UPDATE_TABS.md | 10 - .../events/GUILDBANK_UPDATE_TEXT.md | 11 - .../events/GUILDBANK_UPDATE_WITHDRAWMONEY.md | 10 - wiki-information/events/GUILDTABARD_UPDATE.md | 10 - .../events/GUILD_EVENT_LOG_UPDATE.md | 10 - .../events/GUILD_INVITE_CANCEL.md | 10 - .../events/GUILD_INVITE_REQUEST.md | 35 --- wiki-information/events/GUILD_MOTD.md | 11 - .../events/GUILD_PARTY_STATE_UPDATED.md | 11 - wiki-information/events/GUILD_RANKS_UPDATE.md | 10 - .../events/GUILD_REGISTRAR_CLOSED.md | 10 - .../events/GUILD_REGISTRAR_SHOW.md | 10 - .../events/GUILD_RENAME_REQUIRED.md | 11 - .../events/GUILD_ROSTER_UPDATE.md | 15 -- wiki-information/events/GX_RESTARTED.md | 10 - wiki-information/events/HEARTHSTONE_BOUND.md | 10 - wiki-information/events/HEIRLOOMS_UPDATED.md | 15 -- .../HEIRLOOM_UPGRADE_TARGETING_CHANGED.md | 11 - wiki-information/events/HIDE_SUBTITLE.md | 10 - wiki-information/events/IGNORELIST_UPDATE.md | 10 - .../events/INCOMING_RESURRECT_CHANGED.md | 11 - .../events/INITIAL_CLUBS_LOADED.md | 10 - .../events/INITIAL_HOTFIXES_APPLIED.md | 10 - .../events/INSPECT_ACHIEVEMENT_READY.md | 15 -- .../events/INSPECT_HONOR_UPDATE.md | 10 - wiki-information/events/INSPECT_READY.md | 14 -- .../events/INSTANCE_BOOT_START.md | 10 - wiki-information/events/INSTANCE_BOOT_STOP.md | 10 - .../events/INSTANCE_ENCOUNTER_ADD_TIMER.md | 11 - .../events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md | 10 - .../INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md | 11 - .../INSTANCE_ENCOUNTER_OBJECTIVE_START.md | 13 - .../INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md | 13 - .../events/INSTANCE_GROUP_SIZE_CHANGED.md | 10 - .../events/INSTANCE_LOCK_START.md | 10 - wiki-information/events/INSTANCE_LOCK_STOP.md | 10 - .../events/INSTANCE_LOCK_WARNING.md | 10 - .../events/INVENTORY_SEARCH_UPDATE.md | 10 - wiki-information/events/ISLAND_COMPLETED.md | 13 - .../events/ITEM_DATA_LOAD_RESULT.md | 13 - wiki-information/events/ITEM_LOCKED.md | 13 - wiki-information/events/ITEM_LOCK_CHANGED.md | 19 -- wiki-information/events/ITEM_PUSH.md | 13 - .../events/ITEM_RESTORATION_BUTTON_STATUS.md | 10 - wiki-information/events/ITEM_TEXT_BEGIN.md | 10 - wiki-information/events/ITEM_TEXT_CLOSED.md | 10 - wiki-information/events/ITEM_TEXT_READY.md | 10 - .../events/ITEM_TEXT_TRANSLATION.md | 11 - wiki-information/events/ITEM_UNLOCKED.md | 13 - .../events/ITEM_UPGRADE_FAILED.md | 10 - .../events/ITEM_UPGRADE_MASTER_CLOSED.md | 13 - .../events/ITEM_UPGRADE_MASTER_OPENED.md | 10 - .../events/ITEM_UPGRADE_MASTER_SET_ITEM.md | 14 -- .../KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md | 10 - .../KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md | 13 - .../KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md | 10 - .../KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md | 10 - .../events/KNOWLEDGE_BASE_SERVER_MESSAGE.md | 13 - .../KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md | 10 - .../KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md | 10 - .../KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md | 10 - .../events/LANGUAGE_LIST_CHANGED.md | 10 - .../events/LEARNED_SPELL_IN_TAB.md | 15 -- .../events/LFG_BOOT_PROPOSAL_UPDATE.md | 10 - .../events/LFG_COMPLETION_REWARD.md | 10 - .../LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md | 13 - .../events/LFG_INVALID_ERROR_MESSAGE.md | 15 -- .../events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md | 11 - .../events/LFG_LIST_AVAILABILITY_UPDATE.md | 10 - .../events/LFG_LIST_ENTRY_CREATION_FAILED.md | 10 - .../events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md | 10 - ...LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md | 10 - .../events/LFG_LIST_SEARCH_FAILED.md | 11 - .../LFG_LIST_SEARCH_RESULTS_RECEIVED.md | 10 - .../events/LFG_LIST_SEARCH_RESULT_UPDATED.md | 11 - .../events/LFG_LOCK_INFO_RECEIVED.md | 13 - wiki-information/events/LFG_OFFER_CONTINUE.md | 15 -- .../events/LFG_OPEN_FROM_GOSSIP.md | 11 - wiki-information/events/LFG_PROPOSAL_DONE.md | 10 - .../events/LFG_PROPOSAL_FAILED.md | 10 - wiki-information/events/LFG_PROPOSAL_SHOW.md | 10 - .../events/LFG_PROPOSAL_SUCCEEDED.md | 10 - .../events/LFG_PROPOSAL_UPDATE.md | 10 - .../events/LFG_QUEUE_STATUS_UPDATE.md | 10 - .../events/LFG_READY_CHECK_DECLINED.md | 11 - .../events/LFG_READY_CHECK_HIDE.md | 10 - .../events/LFG_READY_CHECK_PLAYER_IS_READY.md | 11 - .../events/LFG_READY_CHECK_SHOW.md | 11 - .../events/LFG_READY_CHECK_UPDATE.md | 10 - .../events/LFG_ROLE_CHECK_DECLINED.md | 10 - .../events/LFG_ROLE_CHECK_HIDE.md | 10 - .../events/LFG_ROLE_CHECK_ROLE_CHOSEN.md | 17 -- .../events/LFG_ROLE_CHECK_SHOW.md | 11 - .../events/LFG_ROLE_CHECK_UPDATE.md | 10 - wiki-information/events/LFG_ROLE_UPDATE.md | 10 - wiki-information/events/LFG_UPDATE.md | 13 - .../events/LFG_UPDATE_RANDOM_INFO.md | 10 - .../events/LOADING_SCREEN_DISABLED.md | 10 - .../events/LOADING_SCREEN_ENABLED.md | 10 - .../events/LOCALPLAYER_PET_RENAMED.md | 10 - wiki-information/events/LOC_RESULT.md | 11 - wiki-information/events/LOGOUT_CANCEL.md | 10 - wiki-information/events/LOOT_BIND_CONFIRM.md | 11 - wiki-information/events/LOOT_CLOSED.md | 14 -- .../events/LOOT_HISTORY_AUTO_SHOW.md | 13 - .../events/LOOT_HISTORY_FULL_UPDATE.md | 10 - .../events/LOOT_HISTORY_ROLL_CHANGED.md | 13 - .../events/LOOT_HISTORY_ROLL_COMPLETE.md | 10 - .../events/LOOT_ITEM_AVAILABLE.md | 13 - wiki-information/events/LOOT_ITEM_ROLL_WON.md | 19 -- wiki-information/events/LOOT_OPENED.md | 13 - wiki-information/events/LOOT_READY.md | 15 -- .../events/LOOT_ROLLS_COMPLETE.md | 11 - wiki-information/events/LOOT_SLOT_CHANGED.md | 11 - wiki-information/events/LOOT_SLOT_CLEARED.md | 11 - .../events/LOSS_OF_CONTROL_ADDED.md | 11 - .../LOSS_OF_CONTROL_COMMENTATOR_ADDED.md | 13 - .../LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md | 11 - .../events/LOSS_OF_CONTROL_UPDATE.md | 10 - wiki-information/events/LUA_WARNING.md | 13 - .../events/MACRO_ACTION_BLOCKED.md | 11 - .../events/MACRO_ACTION_FORBIDDEN.md | 11 - wiki-information/events/MAIL_CLOSED.md | 10 - wiki-information/events/MAIL_FAILED.md | 11 - wiki-information/events/MAIL_INBOX_UPDATE.md | 15 -- .../events/MAIL_LOCK_SEND_ITEMS.md | 13 - .../events/MAIL_SEND_INFO_UPDATE.md | 10 - wiki-information/events/MAIL_SEND_SUCCESS.md | 10 - wiki-information/events/MAIL_SHOW.md | 10 - wiki-information/events/MAIL_SUCCESS.md | 11 - .../events/MAIL_UNLOCK_SEND_ITEMS.md | 10 - .../events/MAP_EXPLORATION_UPDATED.md | 10 - .../events/MAX_EXPANSION_LEVEL_UPDATED.md | 10 - ...MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md | 11 - wiki-information/events/MERCHANT_CLOSED.md | 10 - .../MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md | 11 - .../events/MERCHANT_FILTER_ITEM_UPDATE.md | 11 - wiki-information/events/MERCHANT_SHOW.md | 10 - wiki-information/events/MERCHANT_UPDATE.md | 10 - wiki-information/events/MINIMAP_PING.md | 15 -- .../events/MINIMAP_UPDATE_TRACKING.md | 10 - .../events/MINIMAP_UPDATE_ZOOM.md | 13 - .../events/MIN_EXPANSION_LEVEL_UPDATED.md | 10 - wiki-information/events/MIRROR_TIMER_PAUSE.md | 13 - wiki-information/events/MIRROR_TIMER_START.md | 21 -- wiki-information/events/MIRROR_TIMER_STOP.md | 11 - .../events/MODIFIER_STATE_CHANGED.md | 30 --- wiki-information/events/MOUNT_CURSOR_CLEAR.md | 13 - wiki-information/events/MUTELIST_UPDATE.md | 10 - wiki-information/events/NAME_PLATE_CREATED.md | 38 --- .../events/NAME_PLATE_UNIT_ADDED.md | 11 - .../events/NAME_PLATE_UNIT_REMOVED.md | 11 - wiki-information/events/NEW_AUCTION_UPDATE.md | 13 - wiki-information/events/NEW_RECIPE_LEARNED.md | 15 -- wiki-information/events/NEW_TOY_ADDED.md | 15 -- wiki-information/events/NEW_WMO_CHUNK.md | 10 - .../events/NOTCHED_DISPLAY_MODE_CHANGED.md | 10 - .../events/NOTIFY_CHAT_SUPPRESSED.md | 10 - .../events/NOTIFY_PVP_AFK_RESULT.md | 15 -- wiki-information/events/OBJECT_ENTERED_AOI.md | 11 - wiki-information/events/OBJECT_LEFT_AOI.md | 11 - .../events/OBLITERUM_FORGE_CLOSE.md | 10 - .../OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md | 10 - .../events/OBLITERUM_FORGE_SHOW.md | 10 - .../events/OPEN_MASTER_LOOT_LIST.md | 10 - wiki-information/events/OPEN_REPORT_PLAYER.md | 35 --- wiki-information/events/OPEN_TABARD_FRAME.md | 10 - .../events/PARTY_INVITE_CANCEL.md | 10 - .../events/PARTY_INVITE_REQUEST.md | 25 -- .../events/PARTY_LEADER_CHANGED.md | 10 - .../events/PARTY_LOOT_METHOD_CHANGED.md | 10 - .../events/PARTY_MEMBER_DISABLE.md | 11 - .../events/PARTY_MEMBER_ENABLE.md | 11 - .../events/PENDING_AZERITE_ESSENCE_CHANGED.md | 11 - wiki-information/events/PETITION_CLOSED.md | 10 - wiki-information/events/PETITION_SHOW.md | 10 - wiki-information/events/PET_ATTACK_START.md | 10 - wiki-information/events/PET_ATTACK_STOP.md | 10 - wiki-information/events/PET_BAR_HIDEGRID.md | 10 - wiki-information/events/PET_BAR_SHOWGRID.md | 10 - wiki-information/events/PET_BAR_UPDATE.md | 19 -- .../events/PET_BAR_UPDATE_COOLDOWN.md | 10 - .../events/PET_BAR_UPDATE_USABLE.md | 10 - .../events/PET_BATTLE_ABILITY_CHANGED.md | 15 -- .../events/PET_BATTLE_ACTION_SELECTED.md | 10 - .../events/PET_BATTLE_AURA_APPLIED.md | 15 -- .../events/PET_BATTLE_AURA_CANCELED.md | 15 -- .../events/PET_BATTLE_AURA_CHANGED.md | 15 -- .../events/PET_BATTLE_CAPTURED.md | 16 -- wiki-information/events/PET_BATTLE_CLOSE.md | 14 -- .../events/PET_BATTLE_FINAL_ROUND.md | 14 -- .../events/PET_BATTLE_HEALTH_CHANGED.md | 15 -- .../events/PET_BATTLE_LEVEL_CHANGED.md | 15 -- .../events/PET_BATTLE_MAX_HEALTH_CHANGED.md | 15 -- .../events/PET_BATTLE_OPENING_DONE.md | 13 - .../events/PET_BATTLE_OPENING_START.md | 13 - wiki-information/events/PET_BATTLE_OVER.md | 13 - .../events/PET_BATTLE_OVERRIDE_ABILITY.md | 11 - .../events/PET_BATTLE_PET_CHANGED.md | 14 -- .../PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md | 11 - .../events/PET_BATTLE_PET_ROUND_RESULTS.md | 11 - .../events/PET_BATTLE_PET_TYPE_CHANGED.md | 15 -- .../events/PET_BATTLE_PVP_DUEL_REQUESTED.md | 11 - .../PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md | 10 - .../PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md | 10 - .../PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md | 10 - .../events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md | 10 - .../events/PET_BATTLE_QUEUE_STATUS.md | 10 - .../events/PET_BATTLE_XP_CHANGED.md | 18 -- wiki-information/events/PET_DISMISS_START.md | 11 - .../events/PET_FORCE_NAME_DECLENSION.md | 21 -- .../events/PET_SPELL_POWER_UPDATE.md | 10 - wiki-information/events/PET_STABLE_CLOSED.md | 10 - wiki-information/events/PET_STABLE_SHOW.md | 10 - wiki-information/events/PET_STABLE_UPDATE.md | 10 - .../events/PET_STABLE_UPDATE_PAPERDOLL.md | 10 - wiki-information/events/PET_UI_CLOSE.md | 10 - wiki-information/events/PET_UI_UPDATE.md | 10 - .../events/PLAYERBANKBAGSLOTS_CHANGED.md | 10 - .../events/PLAYERBANKSLOTS_CHANGED.md | 11 - wiki-information/events/PLAYER_ALIVE.md | 13 - .../events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md | 19 -- wiki-information/events/PLAYER_CAMPING.md | 10 - .../events/PLAYER_CONTROL_GAINED.md | 10 - .../events/PLAYER_CONTROL_LOST.md | 10 - .../events/PLAYER_DAMAGE_DONE_MODS.md | 11 - wiki-information/events/PLAYER_DEAD.md | 10 - .../events/PLAYER_DIFFICULTY_CHANGED.md | 10 - .../events/PLAYER_ENTERING_BATTLEGROUND.md | 10 - .../events/PLAYER_ENTERING_WORLD.md | 30 --- .../events/PLAYER_ENTER_COMBAT.md | 14 -- .../events/PLAYER_EQUIPMENT_CHANGED.md | 18 -- .../events/PLAYER_FARSIGHT_FOCUS_CHANGED.md | 10 - .../events/PLAYER_FLAGS_CHANGED.md | 14 -- .../events/PLAYER_FOCUS_CHANGED.md | 10 - .../events/PLAYER_GAINS_VEHICLE_DATA.md | 13 - .../events/PLAYER_GUILD_UPDATE.md | 11 - .../events/PLAYER_LEAVE_COMBAT.md | 10 - .../events/PLAYER_LEAVING_WORLD.md | 10 - .../events/PLAYER_LEVEL_CHANGED.md | 15 -- wiki-information/events/PLAYER_LEVEL_UP.md | 27 --- wiki-information/events/PLAYER_LOGIN.md | 17 -- wiki-information/events/PLAYER_LOGOUT.md | 14 -- .../events/PLAYER_LOSES_VEHICLE_DATA.md | 11 - wiki-information/events/PLAYER_MONEY.md | 16 -- .../events/PLAYER_MOUNT_DISPLAY_CHANGED.md | 10 - .../events/PLAYER_PVP_KILLS_CHANGED.md | 11 - .../events/PLAYER_PVP_RANK_CHANGED.md | 11 - wiki-information/events/PLAYER_QUITING.md | 14 -- .../events/PLAYER_REGEN_DISABLED.md | 14 -- .../events/PLAYER_REGEN_ENABLED.md | 14 -- .../events/PLAYER_REPORT_SUBMITTED.md | 11 - .../events/PLAYER_ROLES_ASSIGNED.md | 10 - wiki-information/events/PLAYER_SKINNED.md | 11 - .../events/PLAYER_STARTED_LOOKING.md | 10 - .../events/PLAYER_STARTED_MOVING.md | 10 - .../events/PLAYER_STARTED_TURNING.md | 10 - .../events/PLAYER_STOPPED_LOOKING.md | 10 - .../events/PLAYER_STOPPED_MOVING.md | 10 - .../events/PLAYER_STOPPED_TURNING.md | 10 - .../events/PLAYER_TALENT_UPDATE.md | 13 - .../events/PLAYER_TARGET_CHANGED.md | 10 - .../events/PLAYER_TARGET_SET_ATTACKING.md | 16 -- .../events/PLAYER_TOTEM_UPDATE.md | 11 - wiki-information/events/PLAYER_TRADE_MONEY.md | 10 - .../events/PLAYER_TRIAL_XP_UPDATE.md | 11 - wiki-information/events/PLAYER_UNGHOST.md | 18 -- .../events/PLAYER_UPDATE_RESTING.md | 10 - wiki-information/events/PLAYER_XP_UPDATE.md | 11 - wiki-information/events/PLAY_MOVIE.md | 14 -- wiki-information/events/PORTRAITS_UPDATED.md | 10 - .../events/PVP_RATED_STATS_UPDATE.md | 10 - wiki-information/events/PVP_TIMER_UPDATE.md | 11 - .../events/PVP_WORLDSTATE_UPDATE.md | 10 - wiki-information/events/QUEST_ACCEPTED.md | 13 - .../events/QUEST_ACCEPT_CONFIRM.md | 13 - wiki-information/events/QUEST_AUTOCOMPLETE.md | 15 -- wiki-information/events/QUEST_BOSS_EMOTE.md | 17 -- wiki-information/events/QUEST_COMPLETE.md | 10 - wiki-information/events/QUEST_DETAIL.md | 15 -- wiki-information/events/QUEST_FINISHED.md | 10 - wiki-information/events/QUEST_GREETING.md | 10 - wiki-information/events/QUEST_ITEM_UPDATE.md | 10 - wiki-information/events/QUEST_LOG_UPDATE.md | 19 -- wiki-information/events/QUEST_PROGRESS.md | 10 - wiki-information/events/QUEST_REMOVED.md | 13 - .../events/QUEST_SESSION_CREATED.md | 10 - .../events/QUEST_SESSION_DESTROYED.md | 10 - .../QUEST_SESSION_ENABLED_STATE_CHANGED.md | 11 - .../events/QUEST_SESSION_JOINED.md | 14 -- wiki-information/events/QUEST_SESSION_LEFT.md | 14 -- .../events/QUEST_SESSION_MEMBER_CONFIRM.md | 10 - .../QUEST_SESSION_MEMBER_START_RESPONSE.md | 13 - .../events/QUEST_SESSION_NOTIFICATION.md | 124 ---------- wiki-information/events/QUEST_TURNED_IN.md | 15 -- .../events/QUEST_WATCH_LIST_CHANGED.md | 13 - wiki-information/events/QUEST_WATCH_UPDATE.md | 14 -- .../events/QUICK_TICKET_SYSTEM_STATUS.md | 10 - .../events/QUICK_TICKET_THROTTLE_CHANGED.md | 10 - .../events/RAF_ENTITLEMENT_DELIVERED.md | 41 ---- wiki-information/events/RAID_BOSS_EMOTE.md | 17 -- wiki-information/events/RAID_BOSS_WHISPER.md | 17 -- .../events/RAID_INSTANCE_WELCOME.md | 17 -- wiki-information/events/RAID_ROSTER_UPDATE.md | 10 - wiki-information/events/RAID_TARGET_UPDATE.md | 15 -- wiki-information/events/RAISED_AS_GHOUL.md | 10 - wiki-information/events/READY_CHECK.md | 13 - .../events/READY_CHECK_CONFIRM.md | 13 - .../events/READY_CHECK_FINISHED.md | 11 - .../events/RECEIVED_ACHIEVEMENT_LIST.md | 10 - .../RECEIVED_ACHIEVEMENT_MEMBER_LIST.md | 11 - wiki-information/events/REPLACE_ENCHANT.md | 13 - .../events/REPORT_PLAYER_RESULT.md | 50 ---- .../events/REQUEST_CEMETERY_LIST_RESPONSE.md | 11 - .../events/REQUIRED_GUILD_RENAME_RESULT.md | 11 - .../RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md | 10 - .../RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md | 10 - wiki-information/events/RESURRECT_REQUEST.md | 11 - .../events/ROLE_CHANGED_INFORM.md | 17 -- wiki-information/events/ROLE_POLL_BEGIN.md | 11 - wiki-information/events/RUNE_POWER_UPDATE.md | 13 - wiki-information/events/RUNE_TYPE_UPDATE.md | 11 - .../events/SAVED_VARIABLES_TOO_LARGE.md | 19 -- wiki-information/events/SCREENSHOT_FAILED.md | 10 - wiki-information/events/SCREENSHOT_STARTED.md | 10 - .../events/SCREENSHOT_SUCCEEDED.md | 10 - wiki-information/events/SEARCH_DB_LOADED.md | 10 - .../events/SECURE_TRANSFER_CANCEL.md | 14 -- .../SECURE_TRANSFER_CONFIRM_SEND_MAIL.md | 21 -- .../SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md | 21 -- .../events/SELF_RES_SPELL_CHANGED.md | 10 - .../events/SEND_MAIL_COD_CHANGED.md | 10 - .../events/SEND_MAIL_MONEY_CHANGED.md | 10 - .../events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md | 10 - .../SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md | 11 - .../events/SHOW_LOOT_TOAST_UPGRADE.md | 23 -- .../events/SHOW_PVP_FACTION_LOOT_TOAST.md | 23 -- .../events/SHOW_RATED_PVP_REWARD_TOAST.md | 23 -- .../events/SIMPLE_BROWSER_WEB_ERROR.md | 11 - .../events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md | 10 - .../events/SIMPLE_CHECKOUT_CLOSED.md | 10 - .../events/SKILL_LINES_CHANGED.md | 13 - .../events/SOCIAL_ITEM_RECEIVED.md | 10 - wiki-information/events/SOCKET_INFO_ACCEPT.md | 10 - wiki-information/events/SOCKET_INFO_CLOSE.md | 10 - .../events/SOCKET_INFO_FAILURE.md | 10 - .../events/SOCKET_INFO_REFUNDABLE_CONFIRM.md | 10 - .../events/SOCKET_INFO_SUCCESS.md | 10 - wiki-information/events/SOCKET_INFO_UPDATE.md | 10 - wiki-information/events/SOUNDKIT_FINISHED.md | 11 - .../events/SOUND_DEVICE_UPDATE.md | 7 - wiki-information/events/SPELLS_CHANGED.md | 16 -- .../SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md | 11 - .../SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md | 11 - .../events/SPELL_ACTIVATION_OVERLAY_HIDE.md | 11 - .../events/SPELL_ACTIVATION_OVERLAY_SHOW.md | 23 -- .../events/SPELL_CONFIRMATION_PROMPT.md | 26 -- .../events/SPELL_CONFIRMATION_TIMEOUT.md | 13 - .../events/SPELL_DATA_LOAD_RESULT.md | 16 -- .../events/SPELL_POWER_CHANGED.md | 13 - wiki-information/events/SPELL_TEXT_UPDATE.md | 11 - .../events/SPELL_UPDATE_CHARGES.md | 10 - .../events/SPELL_UPDATE_COOLDOWN.md | 23 -- wiki-information/events/SPELL_UPDATE_ICON.md | 13 - .../events/SPELL_UPDATE_USABLE.md | 20 -- .../events/START_AUTOREPEAT_SPELL.md | 10 - wiki-information/events/START_LOOT_ROLL.md | 15 -- wiki-information/events/START_TIMER.md | 15 -- .../events/STOP_AUTOREPEAT_SPELL.md | 10 - wiki-information/events/STOP_MOVIE.md | 10 - wiki-information/events/STREAMING_ICON.md | 15 -- .../events/STREAM_VIEW_MARKER_UPDATED.md | 15 -- .../events/SUPER_TRACKED_QUEST_CHANGED.md | 11 - wiki-information/events/SYSMSG.md | 17 -- .../events/TABARD_CANSAVE_CHANGED.md | 10 - .../events/TABARD_SAVE_PENDING.md | 10 - .../events/TALENTS_INVOLUNTARILY_RESET.md | 11 - .../events/TASK_PROGRESS_UPDATE.md | 10 - wiki-information/events/TAXIMAP_CLOSED.md | 10 - wiki-information/events/TAXIMAP_OPENED.md | 21 -- wiki-information/events/TIME_PLAYED_MSG.md | 13 - wiki-information/events/TOGGLE_CONSOLE.md | 11 - wiki-information/events/TOKEN_AUCTION_SOLD.md | 10 - .../events/TOKEN_BUY_CONFIRM_REQUIRED.md | 10 - wiki-information/events/TOKEN_BUY_RESULT.md | 11 - .../events/TOKEN_CAN_VETERAN_BUY_UPDATE.md | 11 - .../events/TOKEN_DISTRIBUTIONS_UPDATED.md | 11 - .../events/TOKEN_MARKET_PRICE_UPDATED.md | 11 - .../events/TOKEN_REDEEM_BALANCE_UPDATED.md | 10 - .../events/TOKEN_REDEEM_CONFIRM_REQUIRED.md | 11 - .../events/TOKEN_REDEEM_FRAME_SHOW.md | 10 - .../events/TOKEN_REDEEM_GAME_TIME_UPDATED.md | 10 - .../events/TOKEN_REDEEM_RESULT.md | 13 - .../events/TOKEN_SELL_CONFIRM_REQUIRED.md | 10 - wiki-information/events/TOKEN_SELL_RESULT.md | 11 - .../events/TOKEN_STATUS_CHANGED.md | 10 - wiki-information/events/TOYS_UPDATED.md | 15 -- .../TRACKED_ACHIEVEMENT_LIST_CHANGED.md | 13 - .../events/TRACKED_ACHIEVEMENT_UPDATE.md | 17 -- .../events/TRADE_ACCEPT_UPDATE.md | 16 -- wiki-information/events/TRADE_CLOSED.md | 10 - .../events/TRADE_MONEY_CHANGED.md | 10 - .../events/TRADE_PLAYER_ITEM_CHANGED.md | 14 -- .../events/TRADE_POTENTIAL_BIND_ENCHANT.md | 11 - .../events/TRADE_REPLACE_ENCHANT.md | 13 - wiki-information/events/TRADE_REQUEST.md | 11 - .../events/TRADE_REQUEST_CANCEL.md | 13 - wiki-information/events/TRADE_SHOW.md | 10 - wiki-information/events/TRADE_SKILL_CLOSE.md | 10 - .../events/TRADE_SKILL_DATA_SOURCE_CHANGED.md | 10 - .../TRADE_SKILL_DATA_SOURCE_CHANGING.md | 10 - .../events/TRADE_SKILL_DETAILS_UPDATE.md | 10 - .../events/TRADE_SKILL_LIST_UPDATE.md | 10 - .../events/TRADE_SKILL_NAME_UPDATE.md | 10 - wiki-information/events/TRADE_SKILL_SHOW.md | 10 - wiki-information/events/TRADE_SKILL_UPDATE.md | 10 - .../events/TRADE_TARGET_ITEM_CHANGED.md | 11 - wiki-information/events/TRADE_UPDATE.md | 10 - wiki-information/events/TRAINER_CLOSED.md | 10 - .../events/TRAINER_DESCRIPTION_UPDATE.md | 10 - .../TRAINER_SERVICE_INFO_NAME_UPDATE.md | 10 - wiki-information/events/TRAINER_SHOW.md | 10 - wiki-information/events/TRAINER_UPDATE.md | 10 - .../events/TRANSMOG_OUTFITS_CHANGED.md | 10 - .../events/TRIAL_CAP_REACHED_MONEY.md | 10 - wiki-information/events/TUTORIAL_TRIGGER.md | 13 - .../events/TWITTER_LINK_RESULT.md | 15 -- .../events/TWITTER_POST_RESULT.md | 11 - .../events/TWITTER_STATUS_UPDATE.md | 15 -- .../events/UI_MODEL_SCENE_INFO_UPDATED.md | 10 - wiki-information/events/UI_SCALE_CHANGED.md | 10 - wiki-information/events/UNIT_ATTACK.md | 11 - wiki-information/events/UNIT_ATTACK_POWER.md | 11 - wiki-information/events/UNIT_ATTACK_SPEED.md | 11 - wiki-information/events/UNIT_AURA.md | 135 ----------- .../events/UNIT_CHEAT_TOGGLE_EVENT.md | 10 - .../events/UNIT_CLASSIFICATION_CHANGED.md | 11 - wiki-information/events/UNIT_COMBAT.md | 19 -- wiki-information/events/UNIT_CONNECTION.md | 13 - wiki-information/events/UNIT_DAMAGE.md | 14 -- wiki-information/events/UNIT_DEFENSE.md | 11 - wiki-information/events/UNIT_DISPLAYPOWER.md | 11 - .../events/UNIT_ENTERED_VEHICLE.md | 23 -- .../events/UNIT_ENTERING_VEHICLE.md | 23 -- .../events/UNIT_EXITED_VEHICLE.md | 11 - .../events/UNIT_EXITING_VEHICLE.md | 11 - wiki-information/events/UNIT_FACTION.md | 11 - wiki-information/events/UNIT_FLAGS.md | 11 - wiki-information/events/UNIT_HAPPINESS.md | 11 - wiki-information/events/UNIT_HEALTH.md | 15 -- .../events/UNIT_HEALTH_FREQUENT.md | 15 -- .../events/UNIT_HEAL_PREDICTION.md | 11 - .../events/UNIT_INVENTORY_CHANGED.md | 20 -- wiki-information/events/UNIT_LEVEL.md | 11 - wiki-information/events/UNIT_MANA.md | 11 - wiki-information/events/UNIT_MAXHEALTH.md | 15 -- wiki-information/events/UNIT_MAXPOWER.md | 13 - wiki-information/events/UNIT_MODEL_CHANGED.md | 11 - wiki-information/events/UNIT_NAME_UPDATE.md | 11 - .../events/UNIT_OTHER_PARTY_CHANGED.md | 13 - wiki-information/events/UNIT_PET.md | 11 - .../events/UNIT_PET_EXPERIENCE.md | 11 - .../events/UNIT_PET_TRAINING_POINTS.md | 11 - wiki-information/events/UNIT_PHASE.md | 14 -- .../events/UNIT_PORTRAIT_UPDATE.md | 11 - .../events/UNIT_POWER_BAR_HIDE.md | 11 - .../events/UNIT_POWER_BAR_SHOW.md | 11 - .../events/UNIT_POWER_BAR_TIMER_UPDATE.md | 11 - .../events/UNIT_POWER_FREQUENT.md | 20 -- wiki-information/events/UNIT_POWER_UPDATE.md | 25 -- .../events/UNIT_QUEST_LOG_CHANGED.md | 11 - wiki-information/events/UNIT_RANGEDDAMAGE.md | 11 - .../events/UNIT_RANGED_ATTACK_POWER.md | 11 - wiki-information/events/UNIT_RESISTANCES.md | 11 - .../events/UNIT_SPELLCAST_CHANNEL_START.md | 15 -- .../events/UNIT_SPELLCAST_CHANNEL_STOP.md | 15 -- .../events/UNIT_SPELLCAST_CHANNEL_UPDATE.md | 15 -- .../events/UNIT_SPELLCAST_DELAYED.md | 15 -- .../events/UNIT_SPELLCAST_FAILED.md | 15 -- .../events/UNIT_SPELLCAST_FAILED_QUIET.md | 15 -- .../events/UNIT_SPELLCAST_INTERRUPTED.md | 15 -- .../events/UNIT_SPELLCAST_SENT.md | 20 -- .../events/UNIT_SPELLCAST_START.md | 15 -- .../events/UNIT_SPELLCAST_STOP.md | 15 -- .../events/UNIT_SPELLCAST_SUCCEEDED.md | 15 -- wiki-information/events/UNIT_SPELL_HASTE.md | 11 - wiki-information/events/UNIT_STATS.md | 11 - wiki-information/events/UNIT_TARGET.md | 14 -- .../events/UNIT_TARGETABLE_CHANGED.md | 11 - .../events/UNIT_THREAT_LIST_UPDATE.md | 14 -- .../events/UNIT_THREAT_SITUATION_UPDATE.md | 11 - .../events/UPDATE_ACTIVE_BATTLEFIELD.md | 10 - .../events/UPDATE_ALL_UI_WIDGETS.md | 10 - .../events/UPDATE_BATTLEFIELD_SCORE.md | 10 - .../events/UPDATE_BATTLEFIELD_STATUS.md | 11 - wiki-information/events/UPDATE_BINDINGS.md | 10 - .../events/UPDATE_BONUS_ACTIONBAR.md | 10 - wiki-information/events/UPDATE_CHAT_COLOR.md | 17 -- .../events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md | 13 - .../events/UPDATE_CHAT_WINDOWS.md | 10 - wiki-information/events/UPDATE_EXHAUSTION.md | 10 - wiki-information/events/UPDATE_FACTION.md | 10 - .../events/UPDATE_FLOATING_CHAT_WINDOWS.md | 10 - .../events/UPDATE_INSTANCE_INFO.md | 10 - .../events/UPDATE_INVENTORY_ALERTS.md | 10 - .../events/UPDATE_INVENTORY_DURABILITY.md | 10 - wiki-information/events/UPDATE_LFG_LIST.md | 13 - wiki-information/events/UPDATE_MACROS.md | 10 - .../events/UPDATE_MASTER_LOOT_LIST.md | 10 - .../events/UPDATE_MOUSEOVER_UNIT.md | 14 -- .../events/UPDATE_MULTI_CAST_ACTIONBAR.md | 10 - .../events/UPDATE_OVERRIDE_ACTIONBAR.md | 10 - .../events/UPDATE_PENDING_MAIL.md | 16 -- wiki-information/events/UPDATE_POSSESS_BAR.md | 10 - .../events/UPDATE_SHAPESHIFT_COOLDOWN.md | 10 - .../events/UPDATE_SHAPESHIFT_FORM.md | 10 - .../events/UPDATE_SHAPESHIFT_FORMS.md | 10 - .../events/UPDATE_SHAPESHIFT_USABLE.md | 10 - wiki-information/events/UPDATE_STEALTH.md | 13 - .../events/UPDATE_TRADESKILL_RECAST.md | 10 - wiki-information/events/UPDATE_UI_WIDGET.md | 149 ------------ .../events/UPDATE_VEHICLE_ACTIONBAR.md | 10 - wiki-information/events/UPDATE_WEB_TICKET.md | 21 -- wiki-information/events/USE_BIND_CONFIRM.md | 10 - wiki-information/events/USE_GLYPH.md | 11 - .../events/USE_NO_REFUND_CONFIRM.md | 10 - wiki-information/events/VARIABLES_LOADED.md | 18 -- wiki-information/events/VEHICLE_ANGLE_SHOW.md | 11 - .../events/VEHICLE_ANGLE_UPDATE.md | 13 - .../events/VEHICLE_PASSENGERS_CHANGED.md | 10 - wiki-information/events/VEHICLE_POWER_SHOW.md | 11 - wiki-information/events/VEHICLE_UPDATE.md | 10 - .../VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md | 10 - ...VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md | 10 - .../events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md | 13 - .../VOICE_CHAT_AUDIO_CAPTURE_STARTED.md | 10 - .../VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md | 10 - .../events/VOICE_CHAT_CHANNEL_ACTIVATED.md | 11 - .../events/VOICE_CHAT_CHANNEL_DEACTIVATED.md | 11 - ...VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md | 13 - .../events/VOICE_CHAT_CHANNEL_JOINED.md | 91 ------- ...HAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md | 15 -- .../events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md | 13 - ...OICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md | 15 -- .../VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md | 13 - ...HAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md | 15 -- ...CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md | 15 -- .../VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md | 13 - ...CE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md | 15 -- ...T_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md | 15 -- .../VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md | 17 -- ...OICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md | 15 -- .../VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md | 13 - .../events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md | 13 - .../events/VOICE_CHAT_CHANNEL_REMOVED.md | 11 - ...VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md | 13 - .../VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md | 13 - .../VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md | 13 - .../VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md | 19 -- .../events/VOICE_CHAT_CONNECTION_SUCCESS.md | 10 - .../events/VOICE_CHAT_DEAFENED_CHANGED.md | 11 - wiki-information/events/VOICE_CHAT_ERROR.md | 44 ---- .../VOICE_CHAT_INPUT_DEVICES_UPDATED.md | 10 - wiki-information/events/VOICE_CHAT_LOGIN.md | 42 ---- wiki-information/events/VOICE_CHAT_LOGOUT.md | 42 ---- .../events/VOICE_CHAT_MUTED_CHANGED.md | 11 - .../VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md | 10 - .../VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md | 33 --- ...E_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md | 11 - .../events/VOICE_CHAT_SILENCED_CHANGED.md | 11 - ...CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md | 10 - ...HAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md | 10 - .../events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md | 63 ----- .../VOICE_CHAT_TTS_PLAYBACK_FINISHED.md | 24 -- .../events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md | 26 -- .../VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md | 30 --- .../events/VOICE_CHAT_TTS_VOICES_UPDATE.md | 10 - .../events/VOID_DEPOSIT_WARNING.md | 13 - wiki-information/events/VOID_STORAGE_CLOSE.md | 10 - .../events/VOID_STORAGE_CONTENTS_UPDATE.md | 10 - .../events/VOID_STORAGE_DEPOSIT_UPDATE.md | 11 - wiki-information/events/VOID_STORAGE_OPEN.md | 10 - .../events/VOID_STORAGE_UPDATE.md | 10 - wiki-information/events/VOID_TRANSFER_DONE.md | 10 - .../events/VOID_TRANSFER_SUCCESS.md | 10 - wiki-information/events/WARFRONT_COMPLETED.md | 13 - wiki-information/events/WARGAME_REQUESTED.md | 17 -- wiki-information/events/WEAR_EQUIPMENT_SET.md | 11 - wiki-information/events/WHO_LIST_UPDATE.md | 13 - wiki-information/events/WORLD_PVP_QUEUE.md | 10 - .../events/WORLD_STATE_TIMER_START.md | 11 - .../events/WORLD_STATE_TIMER_STOP.md | 11 - .../events/WOW_MOUSE_NOT_FOUND.md | 10 - wiki-information/events/ZONE_CHANGED.md | 31 --- .../events/ZONE_CHANGED_INDOORS.md | 30 --- .../events/ZONE_CHANGED_NEW_AREA.md | 33 --- wiki-information/functions/AbandonQuest.md | 8 - wiki-information/functions/AbandonSkill.md | 20 -- wiki-information/functions/AcceptArenaTeam.md | 15 -- .../functions/AcceptBattlefieldPort.md | 11 - wiki-information/functions/AcceptDuel.md | 9 - wiki-information/functions/AcceptGroup.md | 22 -- wiki-information/functions/AcceptGuild.md | 11 - wiki-information/functions/AcceptProposal.md | 15 -- wiki-information/functions/AcceptQuest.md | 12 - wiki-information/functions/AcceptResurrect.md | 19 -- wiki-information/functions/AcceptSockets.md | 18 -- .../AcceptSpellConfirmationPrompt.md | 17 -- wiki-information/functions/AcceptTrade.md | 20 -- wiki-information/functions/AcceptXPLoss.md | 12 - wiki-information/functions/ActionHasRange.md | 16 -- .../functions/AddChatWindowChannel.md | 21 -- .../functions/AddChatWindowMessages.md | 16 -- wiki-information/functions/AddQuestWatch.md | 14 -- .../functions/AddTrackedAchievement.md | 20 -- wiki-information/functions/AddTradeMoney.md | 9 - wiki-information/functions/Ambiguate.md | 50 ---- .../functions/AreDangerousScriptsAllowed.md | 9 - .../functions/ArenaTeamDisband.md | 16 -- .../functions/ArenaTeamInviteByName.md | 11 - wiki-information/functions/ArenaTeamLeave.md | 9 - wiki-information/functions/ArenaTeamRoster.md | 13 - .../functions/ArenaTeamSetLeaderByName.md | 11 - .../functions/ArenaTeamUninviteByName.md | 11 - wiki-information/functions/AscendStop.md | 20 -- wiki-information/functions/AssistUnit.md | 23 -- wiki-information/functions/AttackTarget.md | 11 - .../functions/AutoEquipCursorItem.md | 17 -- .../functions/AutoStoreGuildBankItem.md | 11 - wiki-information/functions/BNConnected.md | 9 - wiki-information/functions/BNGetFOFInfo.md | 21 -- .../functions/BNGetFriendGameAccountInfo.md | 77 ------ .../functions/BNGetFriendIndex.md | 13 - wiki-information/functions/BNGetFriendInfo.md | 76 ------ .../functions/BNGetFriendInfoByID.md | 77 ------ .../functions/BNGetFriendInviteInfo.md | 21 -- .../functions/BNGetGameAccountInfo.md | 70 ------ .../functions/BNGetGameAccountInfoByGUID.md | 106 -------- wiki-information/functions/BNGetInfo.md | 21 -- .../functions/BNGetNumFriendGameAccounts.md | 16 -- wiki-information/functions/BNGetNumFriends.md | 21 -- wiki-information/functions/BNSendGameData.md | 22 -- wiki-information/functions/BNSendWhisper.md | 13 - wiki-information/functions/BNSetAFK.md | 13 - .../functions/BNSetCustomMessage.md | 24 -- wiki-information/functions/BNSetDND.md | 13 - wiki-information/functions/BNSetFriendNote.md | 11 - .../functions/BankButtonIDToInvSlotID.md | 15 -- wiki-information/functions/BeginTrade.md | 10 - .../functions/BreakUpLargeNumbers.md | 30 --- wiki-information/functions/BuyGuildCharter.md | 24 -- wiki-information/functions/BuyMerchantItem.md | 31 --- wiki-information/functions/BuyStableSlot.md | 11 - .../functions/BuyTrainerService.md | 24 -- wiki-information/functions/BuybackItem.md | 29 --- ...countInfo.GetIDFromBattleNetAccountGUID.md | 13 - ..._AccountInfo.IsGUIDBattleNetAccountType.md | 13 - ...AccountInfo.IsGUIDRelatedToLocalAccount.md | 30 --- .../C_AchievementInfo.GetRewardItemID.md | 13 - ...ievementInfo.GetSupercedingAchievements.md | 20 -- .../C_AchievementInfo.IsValidAchievement.md | 19 -- .../C_AchievementInfo.SetPortraitTexture.md | 9 - .../C_ActionBar.FindPetActionButtons.md | 26 -- .../C_ActionBar.FindSpellActionButtons.md | 13 - .../C_ActionBar.GetPetActionPetBarIndices.md | 19 -- .../C_ActionBar.HasPetActionButtons.md | 13 - .../C_ActionBar.HasPetActionPetBarIndices.md | 13 - .../C_ActionBar.HasSpellActionButtons.md | 13 - .../C_ActionBar.IsAutoCastPetAction.md | 13 - .../C_ActionBar.IsEnabledAutoCastPetAction.md | 13 - .../functions/C_ActionBar.IsHarmfulAction.md | 21 -- .../functions/C_ActionBar.IsHelpfulAction.md | 21 -- .../C_ActionBar.IsOnBarOrSpecialBar.md | 19 -- ...ctionBar.ShouldOverrideBarShowHealthBar.md | 9 - ..._ActionBar.ShouldOverrideBarShowManaBar.md | 9 - .../C_ActionBar.ToggleAutoCastPetAction.md | 9 - .../functions/C_AddOns.DisableAddOn.md | 25 -- .../functions/C_AddOns.DisableAllAddOns.md | 24 -- .../functions/C_AddOns.DoesAddOnExist.md | 28 --- .../functions/C_AddOns.EnableAddOn.md | 25 -- .../functions/C_AddOns.EnableAllAddOns.md | 9 - .../C_AddOns.GetAddOnDependencies.md | 13 - .../functions/C_AddOns.GetAddOnEnableState.md | 39 --- .../functions/C_AddOns.GetAddOnInfo.md | 57 ----- .../functions/C_AddOns.GetAddOnMetadata.md | 18 -- .../C_AddOns.GetAddOnOptionalDependencies.md | 13 - .../functions/C_AddOns.GetNumAddOns.md | 9 - .../functions/C_AddOns.IsAddOnLoadOnDemand.md | 26 -- .../functions/C_AddOns.IsAddOnLoadable.md | 19 -- .../functions/C_AddOns.IsAddOnLoaded.md | 15 -- .../C_AddOns.IsAddonVersionCheckEnabled.md | 9 - .../functions/C_AddOns.LoadAddOn.md | 18 -- .../C_AddOns.SetAddonVersionCheck.md | 9 - .../C_AreaPoiInfo.GetAreaPOIForMap.md | 13 - .../functions/C_AreaPoiInfo.GetAreaPOIInfo.md | 53 ---- .../C_AreaPoiInfo.GetAreaPOITimeLeft.md | 13 - .../functions/C_AreaPoiInfo.IsAreaPOITimed.md | 18 -- .../C_AzeriteEmpoweredItem.CanSelectPower.md | 18 -- ...redItem.CloseAzeriteEmpoweredItemRespec.md | 17 -- ...dItem.ConfirmAzeriteEmpoweredItemRespec.md | 9 - .../C_AzeriteEmpoweredItem.GetAllTierInfo.md | 37 --- ...iteEmpoweredItem.GetAllTierInfoByItemID.md | 31 --- ...dItem.GetAzeriteEmpoweredItemRespecCost.md | 9 - .../C_AzeriteEmpoweredItem.GetPowerInfo.md | 20 -- .../C_AzeriteEmpoweredItem.GetPowerText.md | 33 --- ...C_AzeriteEmpoweredItem.GetSpecsForPower.md | 20 -- ...iteEmpoweredItem.HasAnyUnselectedPowers.md | 19 -- .../C_AzeriteEmpoweredItem.HasBeenViewed.md | 19 -- ...iteEmpoweredItem.IsAzeriteEmpoweredItem.md | 25 -- ...mpoweredItem.IsAzeriteEmpoweredItemByID.md | 25 -- ...dItem.IsAzeritePreviewSourceDisplayable.md | 15 -- ...eEmpoweredItem.IsHeartOfAzerothEquipped.md | 15 -- ...teEmpoweredItem.IsPowerAvailableForSpec.md | 15 -- .../C_AzeriteEmpoweredItem.IsPowerSelected.md | 15 -- .../C_AzeriteEmpoweredItem.SelectPower.md | 21 -- ...C_AzeriteEmpoweredItem.SetHasBeenViewed.md | 9 - .../C_AzeriteEssence.ActivateEssence.md | 11 - .../C_AzeriteEssence.CanActivateEssence.md | 21 -- .../C_AzeriteEssence.CanDeactivateEssence.md | 19 -- .../functions/C_AzeriteEssence.CanOpenUI.md | 9 - ...teEssence.ClearPendingActivationEssence.md | 17 -- .../functions/C_AzeriteEssence.CloseForge.md | 11 - .../C_AzeriteEssence.GetEssenceHyperlink.md | 15 -- .../C_AzeriteEssence.GetEssenceInfo.md | 29 --- .../functions/C_AzeriteEssence.GetEssences.md | 31 --- .../C_AzeriteEssence.GetMilestoneEssence.md | 19 -- .../C_AzeriteEssence.GetMilestoneInfo.md | 41 ---- .../C_AzeriteEssence.GetMilestoneSpell.md | 13 - .../C_AzeriteEssence.GetMilestones.md | 37 --- ...C_AzeriteEssence.GetNumUnlockedEssences.md | 9 - .../C_AzeriteEssence.GetNumUsableEssences.md | 9 - ...riteEssence.GetPendingActivationEssence.md | 9 - ...iteEssence.HasNeverActivatedAnyEssences.md | 9 - ...riteEssence.HasPendingActivationEssence.md | 9 - .../functions/C_AzeriteEssence.IsAtForge.md | 9 - ...riteEssence.SetPendingActivationEssence.md | 9 - .../C_AzeriteEssence.UnlockMilestone.md | 9 - .../C_AzeriteItem.FindActiveAzeriteItem.md | 9 - .../C_AzeriteItem.GetAzeriteItemXPInfo.md | 15 -- .../functions/C_AzeriteItem.GetPowerLevel.md | 27 --- .../C_AzeriteItem.GetUnlimitedPowerLevel.md | 19 -- .../C_AzeriteItem.HasActiveAzeriteItem.md | 9 - .../functions/C_AzeriteItem.IsAzeriteItem.md | 20 -- .../C_AzeriteItem.IsAzeriteItemAtMaxLevel.md | 9 - .../C_AzeriteItem.IsAzeriteItemByID.md | 20 -- .../C_AzeriteItem.IsAzeriteItemEnabled.md | 13 - ...AzeriteItem.IsUnlimitedLevelingUnlocked.md | 9 - .../C_BarberShop.ApplyCustomizationChoices.md | 9 - .../functions/C_BarberShop.Cancel.md | 11 - .../C_BarberShop.ClearPreviewChoices.md | 9 - ...C_BarberShop.GetAvailableCustomizations.md | 95 -------- .../C_BarberShop.GetCurrentCameraZoom.md | 9 - .../C_BarberShop.GetCurrentCharacterData.md | 50 ---- .../functions/C_BarberShop.GetCurrentCost.md | 9 - .../C_BarberShop.GetViewingChrModel.md | 9 - .../functions/C_BarberShop.HasAnyChanges.md | 9 - .../C_BarberShop.IsViewingAlteredForm.md | 9 - .../C_BarberShop.IsViewingNativeSex.md | 9 - .../C_BarberShop.IsViewingVisibleSex.md | 13 - ...C_BarberShop.PreviewCustomizationChoice.md | 17 -- ...arberShop.RandomizeCustomizationChoices.md | 11 - .../C_BarberShop.ResetCameraRotation.md | 11 - .../C_BarberShop.ResetCustomizationChoices.md | 11 - .../functions/C_BarberShop.RotateCamera.md | 9 - .../C_BarberShop.SetCameraDistanceOffset.md | 9 - .../C_BarberShop.SetCameraZoomLevel.md | 17 -- .../C_BarberShop.SetCustomizationChoice.md | 17 -- .../C_BarberShop.SetModelDressState.md | 9 - .../functions/C_BarberShop.SetSelectedSex.md | 9 - .../C_BarberShop.SetViewingAlteredForm.md | 9 - .../C_BarberShop.SetViewingChrModel.md | 9 - .../C_BarberShop.SetViewingShapeshiftForm.md | 9 - .../functions/C_BarberShop.ZoomCamera.md | 9 - .../C_BattleNet.GetAccountInfoByGUID.md | 142 ----------- .../C_BattleNet.GetAccountInfoByID.md | 129 ---------- .../C_BattleNet.GetFriendAccountInfo.md | 130 ---------- .../C_BattleNet.GetFriendGameAccountInfo.md | 111 --------- .../C_BattleNet.GetFriendNumGameAccounts.md | 16 -- .../C_BattleNet.GetGameAccountInfoByGUID.md | 98 -------- .../C_BattleNet.GetGameAccountInfoByID.md | 109 --------- ...vioralMessaging.SendNotificationReceipt.md | 13 - wiki-information/functions/C_CVar.GetCVar.md | 17 -- .../functions/C_CVar.GetCVarBitfield.md | 19 -- .../functions/C_CVar.GetCVarBool.md | 14 -- .../functions/C_CVar.GetCVarDefault.md | 14 -- .../functions/C_CVar.GetCVarInfo.md | 25 -- .../functions/C_CVar.RegisterCVar.md | 14 -- .../functions/C_CVar.ResetTestCVars.md | 20 -- wiki-information/functions/C_CVar.SetCVar.md | 21 -- .../functions/C_CVar.SetCVarBitfield.md | 21 -- .../functions/C_Calendar.AddEvent.md | 21 -- .../functions/C_Calendar.AreNamesReady.md | 9 - .../functions/C_Calendar.CanAddEvent.md | 9 - .../functions/C_Calendar.CanSendInvite.md | 9 - .../functions/C_Calendar.CloseEvent.md | 11 - .../C_Calendar.ContextMenuEventCanComplain.md | 17 -- .../C_Calendar.ContextMenuEventCanEdit.md | 17 -- .../C_Calendar.ContextMenuEventCanRemove.md | 17 -- .../C_Calendar.ContextMenuEventClipboard.md | 9 - .../C_Calendar.ContextMenuEventComplain.md | 11 - .../C_Calendar.ContextMenuEventCopy.md | 11 - ...alendar.ContextMenuEventGetCalendarType.md | 9 - .../C_Calendar.ContextMenuEventPaste.md | 11 - .../C_Calendar.ContextMenuEventRemove.md | 5 - .../C_Calendar.ContextMenuEventSignUp.md | 14 -- .../C_Calendar.ContextMenuGetEventIndex.md | 19 -- .../C_Calendar.ContextMenuInviteAvailable.md | 8 - .../C_Calendar.ContextMenuInviteDecline.md | 5 - .../C_Calendar.ContextMenuInviteRemove.md | 11 - .../C_Calendar.ContextMenuInviteTentative.md | 5 - .../C_Calendar.ContextMenuSelectEvent.md | 13 - .../C_Calendar.CreateCommunitySignUpEvent.md | 5 - ...C_Calendar.CreateGuildAnnouncementEvent.md | 17 -- .../C_Calendar.CreateGuildSignUpEvent.md | 5 - .../functions/C_Calendar.CreatePlayerEvent.md | 8 - .../functions/C_Calendar.EventAvailable.md | 11 - .../functions/C_Calendar.EventCanEdit.md | 9 - .../C_Calendar.EventClearAutoApprove.md | 5 - .../functions/C_Calendar.EventClearLocked.md | 5 - .../C_Calendar.EventClearModerator.md | 9 - .../functions/C_Calendar.EventDecline.md | 11 - .../C_Calendar.EventGetCalendarType.md | 9 - .../functions/C_Calendar.EventGetClubId.md | 9 - .../functions/C_Calendar.EventGetInvite.md | 70 ------ .../C_Calendar.EventGetInviteResponseTime.md | 29 --- .../C_Calendar.EventGetInviteSortCriterion.md | 11 - .../C_Calendar.EventGetSelectedInvite.md | 25 -- .../C_Calendar.EventGetStatusOptions.md | 42 ---- .../functions/C_Calendar.EventGetTextures.md | 44 ---- .../functions/C_Calendar.EventGetTypes.md | 9 - .../C_Calendar.EventGetTypesDisplayOrdered.md | 32 --- .../C_Calendar.EventHasPendingInvite.md | 9 - .../C_Calendar.EventHaveSettingsChanged.md | 9 - .../functions/C_Calendar.EventInvite.md | 14 -- .../functions/C_Calendar.EventRemoveInvite.md | 16 -- .../C_Calendar.EventRemoveInviteByGuid.md | 15 -- .../functions/C_Calendar.EventSelectInvite.md | 9 - .../C_Calendar.EventSetAutoApprove.md | 5 - .../functions/C_Calendar.EventSetClubId.md | 9 - .../functions/C_Calendar.EventSetDate.md | 17 -- .../C_Calendar.EventSetDescription.md | 9 - .../C_Calendar.EventSetInviteStatus.md | 32 --- .../functions/C_Calendar.EventSetLocked.md | 14 -- .../functions/C_Calendar.EventSetModerator.md | 9 - .../functions/C_Calendar.EventSetTextureID.md | 9 - .../functions/C_Calendar.EventSetTime.md | 15 -- .../functions/C_Calendar.EventSetTitle.md | 13 - .../functions/C_Calendar.EventSetType.md | 30 --- .../functions/C_Calendar.EventSignUp.md | 17 -- .../functions/C_Calendar.EventSortInvites.md | 11 - .../functions/C_Calendar.EventTentative.md | 5 - .../C_Calendar.GetClubCalendarEvents.md | 107 -------- .../functions/C_Calendar.GetDayEvent.md | 145 ----------- .../C_Calendar.GetDefaultGuildFilter.md | 18 -- .../functions/C_Calendar.GetEventIndex.md | 19 -- .../functions/C_Calendar.GetEventIndexInfo.md | 27 --- .../functions/C_Calendar.GetEventInfo.md | 140 ----------- .../C_Calendar.GetFirstPendingInvite.md | 15 -- .../functions/C_Calendar.GetGuildEventInfo.md | 59 ----- .../C_Calendar.GetGuildEventSelectionInfo.md | 23 -- .../functions/C_Calendar.GetHolidayInfo.md | 46 ---- .../functions/C_Calendar.GetMaxCreateDate.md | 28 --- .../functions/C_Calendar.GetMinDate.md | 28 --- .../functions/C_Calendar.GetMonthInfo.md | 27 --- .../functions/C_Calendar.GetNextClubId.md | 9 - .../functions/C_Calendar.GetNumDayEvents.md | 15 -- .../functions/C_Calendar.GetNumGuildEvents.md | 9 - .../functions/C_Calendar.GetNumInvites.md | 9 - .../C_Calendar.GetNumPendingInvites.md | 9 - .../functions/C_Calendar.GetRaidInfo.md | 49 ---- .../functions/C_Calendar.IsActionPending.md | 9 - .../functions/C_Calendar.IsEventOpen.md | 9 - .../C_Calendar.MassInviteCommunity.md | 15 -- .../functions/C_Calendar.MassInviteGuild.md | 22 -- .../functions/C_Calendar.OpenCalendar.md | 9 - .../functions/C_Calendar.OpenEvent.md | 17 -- .../functions/C_Calendar.RemoveEvent.md | 11 - .../functions/C_Calendar.SetAbsMonth.md | 11 - .../functions/C_Calendar.SetMonth.md | 9 - .../functions/C_Calendar.SetNextClubId.md | 9 - .../functions/C_Calendar.UpdateEvent.md | 8 - .../C_CameraDefaults.GetCameraFOVDefaults.md | 19 -- .../C_ChatBubbles.GetAllChatBubbles.md | 16 -- .../functions/C_ChatInfo.CanReportPlayer.md | 13 - ...C_ChatInfo.GetChannelInfoFromIdentifier.md | 40 --- .../C_ChatInfo.GetChannelRosterInfo.md | 21 -- .../C_ChatInfo.GetChannelShortcut.md | 18 -- ...ChatInfo.GetChannelShortcutForChannelID.md | 18 -- .../C_ChatInfo.GetChatLineSenderGUID.md | 13 - .../C_ChatInfo.GetChatLineSenderName.md | 13 - .../functions/C_ChatInfo.GetChatLineText.md | 13 - .../functions/C_ChatInfo.GetChatTypeName.md | 19 -- .../C_ChatInfo.GetNumActiveChannels.md | 9 - ...tInfo.GetRegisteredAddonMessagePrefixes.md | 19 -- ...ChatInfo.IsAddonMessagePrefixRegistered.md | 23 -- .../C_ChatInfo.IsChatLineCensored.md | 13 - .../C_ChatInfo.IsPartyChannelType.md | 29 --- .../functions/C_ChatInfo.IsValidChatLine.md | 13 - .../C_ChatInfo.RegisterAddonMessagePrefix.md | 28 --- .../functions/C_ChatInfo.ReportPlayer.md | 44 ---- .../functions/C_ChatInfo.SendAddonMessage.md | 153 ------------ .../C_ChatInfo.SendAddonMessageLogged.md | 153 ------------ ...ChatInfo.SwapChatChannelsByChannelIndex.md | 11 - .../functions/C_ChatInfo.UncensorChatLine.md | 9 - .../functions/C_Club.AcceptInvitation.md | 9 - .../C_Club.AddClubStreamChatChannel.md | 17 -- .../C_Club.AdvanceStreamViewMarker.md | 11 - .../functions/C_Club.AssignMemberRole.md | 25 -- ...esolvePlayerLocationFromClubMessageData.md | 19 -- ...C_Club.ClearAutoAdvanceStreamViewMarker.md | 5 - .../C_Club.ClearClubPresenceSubscription.md | 5 - .../C_Club.CompareBattleNetDisplayName.md | 17 -- .../functions/C_Club.CreateClub.md | 30 --- .../functions/C_Club.CreateStream.md | 18 -- .../functions/C_Club.CreateTicket.md | 20 -- .../functions/C_Club.DeclineInvitation.md | 9 - .../functions/C_Club.DestroyClub.md | 12 - .../functions/C_Club.DestroyMessage.md | 21 -- .../functions/C_Club.DestroyStream.md | 14 -- .../functions/C_Club.DestroyTicket.md | 14 -- ...Club.DoesAnyCommunityHaveUnreadMessages.md | 9 - wiki-information/functions/C_Club.EditClub.md | 24 -- .../functions/C_Club.EditMessage.md | 22 -- .../functions/C_Club.EditStream.md | 20 -- wiki-information/functions/C_Club.Flush.md | 5 - .../functions/C_Club.FocusCommunityStreams.md | 5 - .../functions/C_Club.FocusStream.md | 21 -- .../functions/C_Club.GetAssignableRoles.md | 27 --- .../functions/C_Club.GetAvatarIdList.md | 24 -- .../functions/C_Club.GetClubInfo.md | 55 ----- .../functions/C_Club.GetClubMembers.md | 29 --- .../functions/C_Club.GetClubPrivileges.md | 103 -------- ..._Club.GetClubStreamNotificationSettings.md | 31 --- .../C_Club.GetCommunityNameResultText.md | 55 ----- ...C_Club.GetInfoFromLastCommunityChatLine.md | 149 ------------ .../C_Club.GetInvitationCandidates.md | 43 ---- .../functions/C_Club.GetInvitationInfo.md | 183 -------------- .../functions/C_Club.GetInvitationsForClub.md | 132 ---------- .../functions/C_Club.GetInvitationsForSelf.md | 179 -------------- .../functions/C_Club.GetMemberInfo.md | 122 ---------- .../functions/C_Club.GetMemberInfoForSelf.md | 123 ---------- .../functions/C_Club.GetMessageInfo.md | 163 ------------- .../functions/C_Club.GetMessageRanges.md | 34 --- .../functions/C_Club.GetMessagesBefore.md | 165 ------------- .../functions/C_Club.GetMessagesInRange.md | 159 ------------ .../functions/C_Club.GetStreamInfo.md | 44 ---- .../functions/C_Club.GetStreamViewMarker.md | 15 -- .../functions/C_Club.GetStreams.md | 68 ------ .../functions/C_Club.GetSubscribedClubs.md | 52 ---- .../functions/C_Club.GetTickets.md | 141 ----------- .../functions/C_Club.IsAccountMuted.md | 13 - .../functions/C_Club.IsBeginningOfStream.md | 28 --- .../functions/C_Club.IsEnabled.md | 9 - .../functions/C_Club.IsRestricted.md | 16 -- .../functions/C_Club.IsSubscribedToStream.md | 21 -- .../functions/C_Club.KickMember.md | 14 -- .../functions/C_Club.LeaveClub.md | 9 - .../functions/C_Club.RedeemTicket.md | 9 - .../C_Club.RequestInvitationsForClub.md | 12 - .../C_Club.RequestMoreMessagesBefore.md | 30 --- .../functions/C_Club.RequestTicket.md | 9 - .../functions/C_Club.RequestTickets.md | 12 - .../functions/C_Club.RevokeInvitation.md | 14 -- .../C_Club.SendBattleTagFriendRequest.md | 17 -- .../functions/C_Club.SendInvitation.md | 14 -- .../functions/C_Club.SendMessage.md | 13 - .../C_Club.SetAutoAdvanceStreamViewMarker.md | 14 -- .../functions/C_Club.SetAvatarTexture.md | 25 -- .../functions/C_Club.SetClubMemberNote.md | 16 -- .../C_Club.SetClubPresenceSubscription.md | 12 - ..._Club.SetClubStreamNotificationSettings.md | 17 -- .../functions/C_Club.SetCommunityID.md | 9 - .../functions/C_Club.SetFavorite.md | 11 - .../C_Club.SetSocialQueueingEnabled.md | 25 -- .../functions/C_Club.ShouldAllowClubType.md | 20 -- .../functions/C_Club.UnfocusAllStreams.md | 9 - .../functions/C_Club.UnfocusStream.md | 27 --- .../functions/C_Club.ValidateText.md | 58 ----- .../C_Commentator.AddPlayerOverrideName.md | 11 - .../C_Commentator.AddTrackedDefensiveAuras.md | 9 - .../C_Commentator.AddTrackedOffensiveAuras.md | 9 - .../C_Commentator.AreTeamsSwapped.md | 9 - .../C_Commentator.AssignPlayerToTeam.md | 11 - .../C_Commentator.AssignPlayersToTeam.md | 11 - ...or.AssignPlayersToTeamInCurrentInstance.md | 11 - .../C_Commentator.CanUseCommentatorCheats.md | 9 - .../C_Commentator.ClearCameraTarget.md | 8 - .../C_Commentator.ClearFollowTarget.md | 5 - .../C_Commentator.ClearLookAtTarget.md | 9 - .../functions/C_Commentator.EnterInstance.md | 6 - .../functions/C_Commentator.ExitInstance.md | 11 - .../C_Commentator.FindSpectatedUnit.md | 17 -- ...mmentator.FindTeamNameInCurrentInstance.md | 13 - .../C_Commentator.FindTeamNameInDirectory.md | 19 -- .../C_Commentator.FlushCommentatorHistory.md | 5 - .../functions/C_Commentator.FollowPlayer.md | 19 -- .../functions/C_Commentator.FollowUnit.md | 9 - .../C_Commentator.ForceFollowTransition.md | 6 - ...C_Commentator.GetAdditionalCameraWeight.md | 11 - ...ntator.GetAdditionalCameraWeightByToken.md | 19 -- ...C_Commentator.GetAllPlayerOverrideNames.md | 16 -- .../functions/C_Commentator.GetCamera.md | 21 -- .../C_Commentator.GetCameraCollision.md | 9 - .../C_Commentator.GetCameraPosition.md | 13 - .../C_Commentator.GetCommentatorHistory.md | 52 ---- .../C_Commentator.GetCurrentMapID.md | 9 - .../C_Commentator.GetDampeningPercent.md | 9 - ...stanceBeforeForcedHorizontalConvergence.md | 9 - ...GetDurationToForceHorizontalConvergence.md | 9 - .../C_Commentator.GetExcludeDistance.md | 9 - .../C_Commentator.GetHardlockWeight.md | 9 - ...tor.GetHorizontalAngleThresholdToSmooth.md | 9 - .../C_Commentator.GetIndirectSpellID.md | 13 - .../C_Commentator.GetInstanceInfo.md | 23 -- .../C_Commentator.GetLookAtLerpAmount.md | 9 - .../functions/C_Commentator.GetMapInfo.md | 19 -- .../C_Commentator.GetMatchDuration.md | 9 - .../C_Commentator.GetMaxNumPlayersPerTeam.md | 9 - .../functions/C_Commentator.GetMaxNumTeams.md | 9 - .../functions/C_Commentator.GetMode.md | 9 - ...ntator.GetMsToHoldForHorizontalMovement.md | 9 - ...mentator.GetMsToHoldForVerticalMovement.md | 9 - ...mmentator.GetMsToSmoothHorizontalChange.md | 9 - ...Commentator.GetMsToSmoothVerticalChange.md | 9 - .../functions/C_Commentator.GetNumMaps.md | 9 - .../functions/C_Commentator.GetNumPlayers.md | 13 - .../C_Commentator.GetOrCreateSeries.md | 28 --- .../C_Commentator.GetPlayerAuraInfo.md | 21 -- .../C_Commentator.GetPlayerAuraInfoByUnit.md | 19 -- .../C_Commentator.GetPlayerCooldownInfo.md | 30 --- ...Commentator.GetPlayerCooldownInfoByUnit.md | 19 -- ...C_Commentator.GetPlayerCrowdControlInfo.md | 19 -- ...entator.GetPlayerCrowdControlInfoByUnit.md | 17 -- .../functions/C_Commentator.GetPlayerData.md | 42 ---- .../C_Commentator.GetPlayerFlagInfo.md | 24 -- .../C_Commentator.GetPlayerFlagInfoByUnit.md | 22 -- .../C_Commentator.GetPlayerOverrideName.md | 13 - .../C_Commentator.GetPlayerSpellCharges.md | 23 -- ...Commentator.GetPlayerSpellChargesByUnit.md | 21 -- .../C_Commentator.GetPositionLerpAmount.md | 9 - ...ommentator.GetSmoothFollowTransitioning.md | 9 - .../C_Commentator.GetSoftlockWeight.md | 9 - .../functions/C_Commentator.GetSpeedFactor.md | 12 - .../C_Commentator.GetStartLocation.md | 13 - .../functions/C_Commentator.GetTeamColor.md | 19 -- .../C_Commentator.GetTeamColorByUnit.md | 20 -- .../C_Commentator.GetTimeLeftInMatch.md | 9 - .../C_Commentator.GetTrackedSpellID.md | 13 - .../C_Commentator.GetTrackedSpells.md | 26 -- .../C_Commentator.GetTrackedSpellsByUnit.md | 29 --- .../functions/C_Commentator.GetUnitData.md | 38 --- .../functions/C_Commentator.GetWargameInfo.md | 19 -- .../C_Commentator.HasTrackedAuras.md | 15 -- .../C_Commentator.IsSmartCameraLocked.md | 9 - .../functions/C_Commentator.IsSpectating.md | 9 - .../C_Commentator.IsTrackedDefensiveAura.md | 13 - .../C_Commentator.IsTrackedOffensiveAura.md | 13 - .../functions/C_Commentator.IsTrackedSpell.md | 34 --- .../C_Commentator.IsTrackedSpellByUnit.md | 31 --- .../C_Commentator.IsUsingSmartCamera.md | 9 - .../functions/C_Commentator.LookAtPlayer.md | 13 - .../C_Commentator.RemoveAllOverrideNames.md | 19 -- .../C_Commentator.RemovePlayerOverrideName.md | 9 - ...C_Commentator.RequestPlayerCooldownInfo.md | 11 - .../functions/C_Commentator.ResetFoVTarget.md | 5 - .../C_Commentator.ResetSeriesScores.md | 11 - .../functions/C_Commentator.ResetSettings.md | 5 - .../C_Commentator.ResetTrackedAuras.md | 6 - ...C_Commentator.SetAdditionalCameraWeight.md | 13 - ...ntator.SetAdditionalCameraWeightByToken.md | 20 -- .../C_Commentator.SetBlocklistedAuras.md | 9 - .../C_Commentator.SetBlocklistedCooldowns.md | 25 -- .../functions/C_Commentator.SetCamera.md | 21 -- .../C_Commentator.SetCameraCollision.md | 9 - .../C_Commentator.SetCameraPosition.md | 15 -- .../C_Commentator.SetCheatsEnabled.md | 9 - .../C_Commentator.SetCommentatorHistory.md | 52 ---- ...stanceBeforeForcedHorizontalConvergence.md | 9 - ...SetDurationToForceHorizontalConvergence.md | 9 - .../C_Commentator.SetExcludeDistance.md | 9 - .../C_Commentator.SetFollowCameraSpeeds.md | 11 - .../C_Commentator.SetHardlockWeight.md | 9 - ...tor.SetHorizontalAngleThresholdToSmooth.md | 9 - .../C_Commentator.SetLookAtLerpAmount.md | 9 - .../C_Commentator.SetMapAndInstanceIndex.md | 11 - .../C_Commentator.SetMouseDisabled.md | 9 - .../functions/C_Commentator.SetMoveSpeed.md | 9 - ...ntator.SetMsToHoldForHorizontalMovement.md | 9 - ...mentator.SetMsToHoldForVerticalMovement.md | 9 - ...mmentator.SetMsToSmoothHorizontalChange.md | 9 - ...Commentator.SetMsToSmoothVerticalChange.md | 9 - .../C_Commentator.SetPositionLerpAmount.md | 9 - ...Commentator.SetRequestedDebuffCooldowns.md | 12 - ...mentator.SetRequestedDefensiveCooldowns.md | 11 - ...mentator.SetRequestedOffensiveCooldowns.md | 11 - .../functions/C_Commentator.SetSeriesScore.md | 21 -- .../C_Commentator.SetSeriesScores.md | 15 -- .../C_Commentator.SetSmartCameraLocked.md | 9 - ...ommentator.SetSmoothFollowTransitioning.md | 9 - .../C_Commentator.SetSoftlockWeight.md | 9 - .../functions/C_Commentator.SetSpeedFactor.md | 9 - .../C_Commentator.SetTargetHeightOffset.md | 9 - .../C_Commentator.SetUseSmartCamera.md | 9 - .../C_Commentator.SnapCameraLookAtPoint.md | 14 -- .../functions/C_Commentator.StartWargame.md | 17 -- .../functions/C_Commentator.SwapTeamSides.md | 21 -- .../functions/C_Commentator.ToggleCheats.md | 5 - .../functions/C_Commentator.UpdateMapInfo.md | 9 - .../C_Commentator.UpdatePlayerInfo.md | 5 - .../functions/C_Commentator.ZoomIn.md | 5 - .../functions/C_Commentator.ZoomOut.md | 5 - .../functions/C_Console.GetAllCommands.md | 76 ------ .../functions/C_Console.GetColorFromType.md | 28 --- .../functions/C_Console.GetFontHeight.md | 9 - .../C_Console.PrintAllMatchingCommands.md | 15 -- .../functions/C_Console.SetFontHeight.md | 9 - ...eScriptCollection.GetCollectionDataByID.md | 20 -- ...ScriptCollection.GetCollectionDataByTag.md | 20 -- .../C_ConsoleScriptCollection.GetElements.md | 20 -- ...C_ConsoleScriptCollection.GetScriptData.md | 28 --- .../C_Container.ContainerIDToInventoryID.md | 34 --- ...C_Container.ContainerRefundItemPurchase.md | 13 - .../functions/C_Container.GetBagName.md | 13 - .../functions/C_Container.GetBagSlotFlag.md | 26 -- .../C_Container.GetContainerFreeSlots.md | 19 -- .../C_Container.GetContainerItemCooldown.md | 25 -- .../C_Container.GetContainerItemDurability.md | 17 -- .../C_Container.GetContainerItemID.md | 25 -- .../C_Container.GetContainerItemInfo.md | 46 ---- .../C_Container.GetContainerItemLink.md | 25 -- ...tainer.GetContainerItemPurchaseCurrency.md | 28 --- ..._Container.GetContainerItemPurchaseInfo.md | 30 --- ..._Container.GetContainerItemPurchaseItem.md | 28 --- .../C_Container.GetContainerItemQuestInfo.md | 24 -- .../C_Container.GetContainerNumFreeSlots.md | 18 -- .../C_Container.GetContainerNumSlots.md | 26 -- .../C_Container.GetInsertItemsLeftToRight.md | 9 - .../functions/C_Container.GetItemCooldown.md | 17 -- .../C_Container.IsContainerFiltered.md | 19 -- .../C_Container.PickupContainerItem.md | 11 - .../C_Container.SetBagPortraitTexture.md | 11 - .../functions/C_Container.SetBagSlotFlag.md | 32 --- .../C_Container.SetInsertItemsLeftToRight.md | 9 - .../functions/C_Container.SetItemSearch.md | 9 - .../C_Container.ShowContainerSellCursor.md | 11 - .../C_Container.SocketContainerItem.md | 21 -- .../C_Container.SplitContainerItem.md | 13 - .../functions/C_Container.UseContainerItem.md | 15 -- .../functions/C_CreatureInfo.GetClassInfo.md | 70 ------ .../C_CreatureInfo.GetFactionInfo.md | 20 -- .../functions/C_CreatureInfo.GetRaceInfo.md | 28 --- .../C_CurrencyInfo.GetBasicCurrencyInfo.md | 31 --- ...C_CurrencyInfo.GetCurrencyContainerInfo.md | 30 --- .../C_CurrencyInfo.GetCurrencyInfo.md | 67 ----- .../C_CurrencyInfo.GetCurrencyInfoFromLink.md | 61 ----- .../C_CurrencyInfo.GetCurrencyListLink.md | 13 - .../C_CurrencyInfo.IsCurrencyContainer.md | 15 -- .../C_Cursor.DropCursorCommunitiesStream.md | 5 - .../C_Cursor.GetCursorCommunitiesStream.md | 11 - .../functions/C_Cursor.GetCursorItem.md | 12 - .../C_Cursor.SetCursorCommunitiesStream.md | 11 - .../C_DateAndTime.AdjustTimeByDays.md | 37 --- .../C_DateAndTime.AdjustTimeByMinutes.md | 37 --- .../C_DateAndTime.CompareCalendarTime.md | 32 --- .../C_DateAndTime.GetCalendarTimeFromEpoch.md | 35 --- .../C_DateAndTime.GetCurrentCalendarTime.md | 47 ---- ...C_DateAndTime.GetSecondsUntilDailyReset.md | 9 - ..._DateAndTime.GetSecondsUntilWeeklyReset.md | 9 - .../C_DateAndTime.GetServerTimeLocal.md | 23 -- .../C_DeathInfo.GetCorpseMapPosition.md | 19 -- .../C_DeathInfo.GetDeathReleasePosition.md | 13 - .../C_DeathInfo.GetGraveyardsForMap.md | 28 --- .../C_DeathInfo.GetSelfResurrectOptions.md | 33 --- .../C_DeathInfo.UseSelfResurrectOption.md | 20 -- .../C_Engraving.AddCategoryFilter.md | 9 - .../C_Engraving.AddExclusiveCategoryFilter.md | 9 - .../functions/C_Engraving.CastRune.md | 9 - .../C_Engraving.ClearCategoryFilter.md | 9 - .../C_Engraving.EnableEquippedFilter.md | 9 - .../C_Engraving.GetCurrentRuneCast.md | 26 -- .../C_Engraving.GetEngravingModeEnabled.md | 9 - .../C_Engraving.GetExclusiveCategoryFilter.md | 9 - .../functions/C_Engraving.GetNumRunesKnown.md | 15 -- .../C_Engraving.GetRuneCategories.md | 16 -- .../C_Engraving.GetRuneForEquipmentSlot.md | 30 --- .../C_Engraving.GetRuneForInventorySlot.md | 32 --- .../C_Engraving.GetRunesForCategory.md | 32 --- .../C_Engraving.HasCategoryFilter.md | 13 - .../C_Engraving.IsEngravingEnabled.md | 9 - .../C_Engraving.IsEquipmentSlotEngravable.md | 13 - .../C_Engraving.IsEquippedFilterEnabled.md | 9 - .../C_Engraving.IsInventorySlotEngravable.md | 15 -- ...nventorySlotEngravableByCurrentRuneCast.md | 15 -- .../functions/C_Engraving.IsKnownRuneSpell.md | 13 - .../functions/C_Engraving.IsRuneEquipped.md | 13 - .../C_Engraving.SetEngravingModeEnabled.md | 9 - .../functions/C_Engraving.SetSearchFilter.md | 9 - ...C_EquipmentSet.AssignSpecToEquipmentSet.md | 17 -- .../C_EquipmentSet.CanUseEquipmentSets.md | 9 - .../C_EquipmentSet.CreateEquipmentSet.md | 23 -- .../C_EquipmentSet.DeleteEquipmentSet.md | 9 - ...mentSet.EquipmentSetContainsLockedItems.md | 13 - ...quipmentSet.GetEquipmentSetAssignedSpec.md | 13 - .../C_EquipmentSet.GetEquipmentSetForSpec.md | 13 - .../C_EquipmentSet.GetEquipmentSetID.md | 13 - .../C_EquipmentSet.GetEquipmentSetIDs.md | 9 - .../C_EquipmentSet.GetEquipmentSetInfo.md | 32 --- .../C_EquipmentSet.GetIgnoredSlots.md | 13 - .../functions/C_EquipmentSet.GetItemIDs.md | 31 --- .../C_EquipmentSet.GetItemLocations.md | 23 -- .../C_EquipmentSet.GetNumEquipmentSets.md | 9 - .../C_EquipmentSet.IgnoreSlotForSave.md | 9 - .../C_EquipmentSet.IsSlotIgnoredForSave.md | 19 -- .../C_EquipmentSet.ModifyEquipmentSet.md | 13 - .../C_EquipmentSet.PickupEquipmentSet.md | 9 - .../C_EquipmentSet.SaveEquipmentSet.md | 14 -- ...C_EquipmentSet.UnassignEquipmentSetSpec.md | 9 - .../C_EquipmentSet.UnignoreSlotForSave.md | 9 - .../C_EquipmentSet.UseEquipmentSet.md | 17 -- .../functions/C_EventUtils.IsEventValid.md | 13 - .../C_EventUtils.NotifySettingsLoaded.md | 9 - .../functions/C_FriendList.AddFriend.md | 15 -- .../functions/C_FriendList.AddIgnore.md | 18 -- .../functions/C_FriendList.AddOrDelIgnore.md | 9 - .../C_FriendList.AddOrRemoveFriend.md | 14 -- .../functions/C_FriendList.DelIgnore.md | 13 - .../C_FriendList.DelIgnoreByIndex.md | 9 - .../functions/C_FriendList.GetFriendInfo.md | 69 ------ .../C_FriendList.GetFriendInfoByIndex.md | 69 ------ .../functions/C_FriendList.GetIgnoreName.md | 13 - .../functions/C_FriendList.GetNumFriends.md | 9 - .../functions/C_FriendList.GetNumIgnores.md | 9 - .../C_FriendList.GetNumOnlineFriends.md | 9 - .../C_FriendList.GetNumWhoResults.md | 15 -- .../C_FriendList.GetSelectedFriend.md | 12 - .../C_FriendList.GetSelectedIgnore.md | 9 - .../functions/C_FriendList.GetWhoInfo.md | 43 ---- .../functions/C_FriendList.IsFriend.md | 13 - .../functions/C_FriendList.IsIgnored.md | 13 - .../functions/C_FriendList.IsIgnoredByGuid.md | 13 - .../functions/C_FriendList.IsOnIgnoredList.md | 13 - .../functions/C_FriendList.RemoveFriend.md | 13 - .../C_FriendList.RemoveFriendByIndex.md | 9 - .../functions/C_FriendList.SendWho.md | 46 ---- .../functions/C_FriendList.SetFriendNotes.md | 15 -- .../C_FriendList.SetFriendNotesByIndex.md | 11 - .../C_FriendList.SetSelectedFriend.md | 12 - .../C_FriendList.SetSelectedIgnore.md | 9 - .../functions/C_FriendList.SetWhoToUi.md | 14 -- .../functions/C_FriendList.ShowFriends.md | 11 - .../functions/C_FriendList.SortWho.md | 24 -- .../C_FunctionContainers.CreateCallback.md | 37 --- .../functions/C_GamePad.AddSDLMapping.md | 20 -- .../functions/C_GamePad.ApplyConfigs.md | 5 - .../C_GamePad.AxisIndexToConfigName.md | 19 -- .../C_GamePad.ButtonBindingToIndex.md | 19 -- .../C_GamePad.ButtonIndexToBinding.md | 19 -- .../C_GamePad.ButtonIndexToConfigName.md | 13 - .../functions/C_GamePad.ClearLedColor.md | 6 - .../functions/C_GamePad.DeleteConfig.md | 16 -- .../functions/C_GamePad.GetActiveDeviceID.md | 9 - .../functions/C_GamePad.GetAllConfigIDs.md | 16 -- .../functions/C_GamePad.GetAllDeviceIDs.md | 9 - .../C_GamePad.GetCombinedDeviceID.md | 9 - .../functions/C_GamePad.GetConfig.md | 109 --------- .../C_GamePad.GetDeviceMappedState.md | 41 ---- .../functions/C_GamePad.GetDeviceRawState.md | 30 --- .../functions/C_GamePad.GetLedColor.md | 9 - .../functions/C_GamePad.GetPowerLevel.md | 28 --- .../functions/C_GamePad.IsEnabled.md | 15 -- .../functions/C_GamePad.SetConfig.md | 103 -------- .../functions/C_GamePad.SetLedColor.md | 9 - .../functions/C_GamePad.SetVibration.md | 19 -- .../C_GamePad.StickIndexToConfigName.md | 13 - .../functions/C_GamePad.StopVibration.md | 19 -- .../C_GameRules.IsSelfFoundAllowed.md | 9 - .../functions/C_GossipInfo.CloseGossip.md | 11 - .../functions/C_GossipInfo.ForceGossip.md | 12 - .../functions/C_GossipInfo.GetActiveQuests.md | 30 --- .../C_GossipInfo.GetAvailableQuests.md | 34 --- ...nfo.GetCompletedOptionDescriptionString.md | 9 - ...ipInfo.GetCustomGossipDescriptionString.md | 9 - .../C_GossipInfo.GetFriendshipReputation.md | 38 --- ...GossipInfo.GetFriendshipReputationRanks.md | 20 -- .../C_GossipInfo.GetNumActiveQuests.md | 12 - .../C_GossipInfo.GetNumAvailableQuests.md | 15 -- .../functions/C_GossipInfo.GetOptions.md | 94 -------- .../C_GossipInfo.GetPoiForUiMapID.md | 13 - .../functions/C_GossipInfo.GetPoiInfo.md | 26 -- .../functions/C_GossipInfo.GetText.md | 12 - .../C_GossipInfo.SelectActiveQuest.md | 15 -- .../C_GossipInfo.SelectAvailableQuest.md | 15 -- .../functions/C_GossipInfo.SelectOption.md | 35 --- .../C_GossipInfo.SelectOptionByIndex.md | 19 -- .../C_GuildInfo.CanEditOfficerNote.md | 15 -- .../C_GuildInfo.CanSpeakInGuildChat.md | 15 -- .../C_GuildInfo.CanViewOfficerNote.md | 9 - .../C_GuildInfo.GetGuildRankOrder.md | 13 - .../C_GuildInfo.GetGuildTabardInfo.md | 33 --- .../C_GuildInfo.GuildControlGetRankFlags.md | 83 ------- .../functions/C_GuildInfo.GuildRoster.md | 12 - .../functions/C_GuildInfo.IsGuildOfficer.md | 9 - ..._GuildInfo.IsGuildRankAssignmentAllowed.md | 15 -- .../C_GuildInfo.MemberExistsByName.md | 13 - .../C_GuildInfo.QueryGuildMembersForRecipe.md | 17 -- .../functions/C_GuildInfo.RemoveFromGuild.md | 18 -- .../C_GuildInfo.SetGuildRankOrder.md | 11 - .../functions/C_GuildInfo.SetNote.md | 16 -- ..._Heirloom.CanHeirloomUpgradeFromPending.md | 18 -- .../functions/C_Heirloom.GetHeirloomInfo.md | 37 --- .../C_Heirloom.GetHeirloomItemIDs.md | 9 - ...erfaceFileManifest.GetInterfaceArtFiles.md | 12 - .../functions/C_Item.DoesItemExist.md | 27 --- .../functions/C_Item.DoesItemExistByID.md | 19 -- .../functions/C_Item.GetCurrentItemLevel.md | 20 -- .../functions/C_Item.GetItemGUID.md | 13 - .../functions/C_Item.GetItemID.md | 19 -- .../functions/C_Item.GetItemIDForItemInfo.md | 25 -- .../functions/C_Item.GetItemIcon.md | 31 --- .../functions/C_Item.GetItemIconByID.md | 31 --- .../functions/C_Item.GetItemInventoryType.md | 163 ------------- .../C_Item.GetItemInventoryTypeByID.md | 163 ------------- .../functions/C_Item.GetItemLink.md | 13 - .../functions/C_Item.GetItemMaxStackSize.md | 19 -- .../C_Item.GetItemMaxStackSizeByID.md | 19 -- .../functions/C_Item.GetItemName.md | 28 --- .../functions/C_Item.GetItemNameByID.md | 37 --- .../functions/C_Item.GetItemQuality.md | 52 ---- .../functions/C_Item.GetItemQualityByID.md | 62 ----- .../functions/C_Item.GetStackCount.md | 19 -- wiki-information/functions/C_Item.IsBound.md | 13 - .../functions/C_Item.IsItemDataCached.md | 19 -- .../functions/C_Item.IsItemDataCachedByID.md | 19 -- wiki-information/functions/C_Item.IsLocked.md | 19 -- wiki-information/functions/C_Item.LockItem.md | 16 -- .../functions/C_Item.LockItemByGUID.md | 16 -- .../functions/C_Item.RequestLoadItemData.md | 17 -- .../C_Item.RequestLoadItemDataByID.md | 17 -- .../functions/C_Item.UnlockItem.md | 16 -- .../functions/C_Item.UnlockItemByGUID.md | 16 -- .../C_ItemSocketInfo.CompleteSocketing.md | 11 - .../C_ItemUpgrade.GetItemHyperlink.md | 9 - .../C_KeyBindings.GetBindingIndex.md | 13 - .../C_KeyBindings.GetCustomBindingType.md | 18 -- .../C_LFGInfo.CanPlayerUseGroupFinder.md | 11 - .../functions/C_LFGInfo.CanPlayerUseLFD.md | 11 - .../functions/C_LFGInfo.CanPlayerUseLFR.md | 11 - .../functions/C_LFGInfo.CanPlayerUsePVP.md | 11 - .../C_LFGInfo.CanPlayerUsePremadeGroup.md | 11 - .../C_LFGInfo.ConfirmLfgExpandSearch.md | 14 -- .../C_LFGInfo.GetAllEntriesForCategory.md | 30 --- .../functions/C_LFGInfo.GetLFDLockStates.md | 24 -- ...C_LFGInfo.GetRoleCheckDifficultyDetails.md | 11 - .../functions/C_LFGInfo.HideNameFromUI.md | 40 --- .../C_LFGInfo.IsGroupFinderEnabled.md | 9 - .../C_LFGInfo.IsInLFGFollowerDungeon.md | 9 - .../functions/C_LFGInfo.IsLFDEnabled.md | 9 - .../C_LFGInfo.IsLFGFollowerDungeon.md | 13 - .../functions/C_LFGInfo.IsLFREnabled.md | 9 - .../C_LFGInfo.IsPremadeGroupEnabled.md | 9 - .../functions/C_LFGList.ApplyToGroup.md | 21 -- .../C_LFGList.CanActiveEntryUseAutoAccept.md | 9 - .../C_LFGList.CanCreateQuestGroup.md | 19 -- .../C_LFGList.ClearApplicationTextFields.md | 5 - .../C_LFGList.ClearCreationTextFields.md | 17 -- .../functions/C_LFGList.ClearSearchResults.md | 5 - .../C_LFGList.ClearSearchTextFields.md | 6 - ...ist.CopyActiveEntryInfoToCreationFields.md | 14 -- .../functions/C_LFGList.CreateListing.md | 29 --- ...FGList.DoesEntryTitleMatchPrebuiltTitle.md | 28 --- .../functions/C_LFGList.GetActiveEntryInfo.md | 52 ---- .../C_LFGList.GetActivityFullName.md | 17 -- .../C_LFGList.GetActivityGroupInfo.md | 21 -- .../functions/C_LFGList.GetActivityInfo.md | 70 ------ .../C_LFGList.GetActivityInfoExpensive.md | 13 - .../C_LFGList.GetActivityInfoTable.md | 78 ------ ...List.GetApplicantDungeonScoreForListing.md | 28 --- .../functions/C_LFGList.GetApplicantInfo.md | 48 ---- .../C_LFGList.GetApplicantMemberInfo.md | 46 ---- .../C_LFGList.GetApplicantMemberStats.md | 37 --- ...ist.GetApplicantPvpRatingInfoForListing.md | 28 --- .../functions/C_LFGList.GetApplicants.md | 23 -- .../C_LFGList.GetAvailableActivities.md | 17 -- .../C_LFGList.GetAvailableActivityGroups.md | 15 -- .../C_LFGList.GetAvailableCategories.md | 13 - .../functions/C_LFGList.GetCategoryInfo.md | 19 -- .../C_LFGList.GetFilteredSearchResults.md | 11 - .../C_LFGList.GetKeystoneForActivity.md | 19 -- .../functions/C_LFGList.GetLfgCategoryInfo.md | 32 --- .../functions/C_LFGList.GetRoles.md | 17 -- .../C_LFGList.GetSearchResultInfo.md | 109 --------- .../functions/C_LFGList.GetSearchResults.md | 11 - .../functions/C_LFGList.HasActiveEntryInfo.md | 9 - .../C_LFGList.HasSearchResultInfo.md | 13 - .../functions/C_LFGList.InviteApplicant.md | 12 - .../C_LFGList.IsPlayerAuthenticatedForLFG.md | 19 -- .../functions/C_LFGList.RemoveListing.md | 14 -- .../C_LFGList.RequestAvailableActivities.md | 11 - .../functions/C_LFGList.SetRoles.md | 21 -- .../functions/C_LFGList.SetSearchToQuestID.md | 9 - .../functions/C_LFGList.UpdateListing.md | 41 ---- .../C_LFGList.ValidateRequiredDungeonScore.md | 19 -- ...st.ValidateRequiredPvpRatingForActivity.md | 21 -- .../C_Loot.IsLegacyLootModeEnabled.md | 9 - .../functions/C_LootHistory.GetItem.md | 23 -- .../functions/C_LootHistory.GetPlayerInfo.md | 23 -- ...ossOfControl.GetActiveLossOfControlData.md | 51 ---- ...ontrol.GetActiveLossOfControlDataByUnit.md | 52 ---- ...Control.GetActiveLossOfControlDataCount.md | 18 -- ...l.GetActiveLossOfControlDataCountByUnit.md | 20 -- .../functions/C_Mail.HasInboxMoney.md | 19 -- .../functions/C_Mail.IsCommandPending.md | 9 - .../functions/C_Map.GetAreaInfo.md | 16 -- .../functions/C_Map.GetBestMapForUnit.md | 29 --- .../functions/C_Map.GetBountySetIDForMap.md | 13 - .../functions/C_Map.GetFallbackWorldMapID.md | 10 - .../C_Map.GetMapArtBackgroundAtlas.md | 23 -- .../C_Map.GetMapArtHelpTextPosition.md | 26 -- .../functions/C_Map.GetMapArtID.md | 19 -- .../functions/C_Map.GetMapArtLayerTextures.md | 32 --- .../functions/C_Map.GetMapArtLayers.md | 30 --- .../functions/C_Map.GetMapBannersForMap.md | 24 -- .../functions/C_Map.GetMapChildrenInfo.md | 109 --------- .../functions/C_Map.GetMapDisplayInfo.md | 19 -- .../functions/C_Map.GetMapGroupID.md | 19 -- .../functions/C_Map.GetMapGroupMembersInfo.md | 22 -- .../C_Map.GetMapHighlightInfoAtPosition.md | 31 --- .../functions/C_Map.GetMapInfo.md | 100 -------- .../functions/C_Map.GetMapInfoAtPosition.md | 99 -------- .../functions/C_Map.GetMapLevels.md | 19 -- .../functions/C_Map.GetMapLinksForMap.md | 26 -- .../functions/C_Map.GetMapPosFromWorldPos.md | 19 -- .../functions/C_Map.GetMapRectOnMap.md | 21 -- .../functions/C_Map.GetPlayerMapPosition.md | 32 --- .../functions/C_Map.GetWorldPosFromMapPos.md | 29 --- wiki-information/functions/C_Map.MapHasArt.md | 19 -- .../functions/C_Map.RequestPreloadMap.md | 9 - ...rationInfo.GetExploredAreaIDsAtPosition.md | 15 -- ...pExplorationInfo.GetExploredMapTextures.md | 47 ---- .../C_MerchantFrame.GetBuybackItemID.md | 13 - .../C_Minimap.GetNumTrackingTypes.md | 9 - .../C_Minimap.GetObjectIconTextureCoords.md | 19 -- .../C_Minimap.GetPOITextureCoords.md | 19 -- .../functions/C_Minimap.GetTrackingInfo.md | 23 -- .../functions/C_Minimap.SetTracking.md | 11 - .../C_ModelInfo.AddActiveModelScene.md | 14 -- .../C_ModelInfo.AddActiveModelSceneActor.md | 14 -- .../C_ModelInfo.ClearActiveModelScene.md | 12 - .../C_ModelInfo.ClearActiveModelSceneActor.md | 12 - ...lInfo.GetModelSceneActorDisplayInfoByID.md | 30 --- .../C_ModelInfo.GetModelSceneActorInfoByID.md | 38 --- ...C_ModelInfo.GetModelSceneCameraInfoByID.md | 52 ---- .../C_ModelInfo.GetModelSceneInfoByID.md | 42 ---- .../functions/C_MountJournal.ClearFanfare.md | 9 - .../C_MountJournal.ClearRecentFanfares.md | 5 - .../functions/C_MountJournal.Dismiss.md | 12 - ...rnal.GetAllCreatureDisplayIDsForMountID.md | 13 - ...tJournal.GetCollectedDragonridingMounts.md | 23 -- ..._MountJournal.GetCollectedFilterSetting.md | 20 -- ...GetDisplayedMountAllCreatureDisplayInfo.md | 126 ---------- .../C_MountJournal.GetDisplayedMountID.md | 26 -- .../C_MountJournal.GetDisplayedMountInfo.md | 63 ----- ...MountJournal.GetDisplayedMountInfoExtra.md | 62 ----- .../functions/C_MountJournal.GetIsFavorite.md | 15 -- ...rnal.GetMountAllCreatureDisplayInfoByID.md | 64 ----- .../C_MountJournal.GetMountFromItem.md | 19 -- .../C_MountJournal.GetMountFromSpell.md | 19 -- .../functions/C_MountJournal.GetMountIDs.md | 9 - .../C_MountJournal.GetMountInfoByID.md | 63 ----- .../C_MountJournal.GetMountInfoExtraByID.md | 62 ----- .../functions/C_MountJournal.GetMountLink.md | 19 -- .../C_MountJournal.GetMountUsabilityByID.md | 23 -- .../C_MountJournal.GetNumDisplayedMounts.md | 12 - .../functions/C_MountJournal.GetNumMounts.md | 15 -- ...MountJournal.GetNumMountsNeedingFanfare.md | 9 - .../C_MountJournal.IsSourceChecked.md | 19 -- .../functions/C_MountJournal.IsTypeChecked.md | 19 -- .../C_MountJournal.IsUsingDefaultFilters.md | 9 - .../C_MountJournal.IsValidSourceFilter.md | 19 -- .../C_MountJournal.IsValidTypeFilter.md | 19 -- .../functions/C_MountJournal.NeedsFanfare.md | 13 - .../functions/C_MountJournal.Pickup.md | 27 --- .../C_MountJournal.SetAllSourceFilters.md | 9 - .../C_MountJournal.SetAllTypeFilters.md | 9 - ..._MountJournal.SetCollectedFilterSetting.md | 23 -- .../C_MountJournal.SetDefaultFilters.md | 17 -- .../functions/C_MountJournal.SetIsFavorite.md | 14 -- .../functions/C_MountJournal.SetSearch.md | 9 - .../C_MountJournal.SetSourceFilter.md | 26 -- .../functions/C_MountJournal.SetTypeFilter.md | 11 - .../functions/C_MountJournal.SummonByID.md | 20 -- .../C_NamePlate.GetNamePlateForUnit.md | 47 ---- .../functions/C_NamePlate.GetNamePlates.md | 46 ---- ...NamePlate.SetNamePlateEnemyClickThrough.md | 9 - ...e.SetNamePlateEnemyPreferredClickInsets.md | 15 -- .../C_NamePlate.SetNamePlateEnemySize.md | 11 - ...ePlate.SetNamePlateFriendlyClickThrough.md | 9 - ...etNamePlateFriendlyPreferredClickInsets.md | 15 -- .../C_NamePlate.SetNamePlateFriendlySize.md | 17 -- ..._NamePlate.SetNamePlateSelfClickThrough.md | 9 - ...te.SetNamePlateSelfPreferredClickInsets.md | 15 -- .../C_NamePlate.SetNamePlateSelfSize.md | 22 -- .../C_NamePlate.SetTargetClampingInsets.md | 11 - .../functions/C_NewItems.ClearAll.md | 9 - .../functions/C_NewItems.IsNewItem.md | 19 -- .../functions/C_NewItems.RemoveNewItem.md | 14 -- .../C_PaperDollInfo.GetArmorEffectiveness.md | 21 -- ...Info.GetArmorEffectivenessAgainstTarget.md | 13 - .../C_PaperDollInfo.GetMinItemLevel.md | 15 -- .../C_PaperDollInfo.OffhandHasShield.md | 9 - .../C_PaperDollInfo.OffhandHasWeapon.md | 9 - .../C_PartyInfo.ConfirmLeaveParty.md | 9 - .../C_PartyInfo.GetActiveCategories.md | 9 - ...Info.GetInviteConfirmationInvalidQueues.md | 13 - .../C_PartyInfo.IsCrossFactionParty.md | 19 -- .../functions/C_PartyInfo.IsPartyFull.md | 29 --- .../C_PetJournal.ClearSearchFilter.md | 14 -- .../functions/C_PetJournal.FindPetIDByName.md | 15 -- .../C_PetJournal.GetNumCollectedInfo.md | 15 -- .../C_PetJournal.GetNumPetSources.md | 14 -- .../functions/C_PetJournal.GetNumPetTypes.md | 14 -- .../functions/C_PetJournal.GetNumPets.md | 11 - .../C_PetJournal.GetNumPetsInJournal.md | 15 -- .../C_PetJournal.GetOwnedBattlePetString.md | 13 - .../C_PetJournal.GetPetCooldownByGUID.md | 20 -- .../C_PetJournal.GetPetInfoByIndex.md | 72 ------ .../C_PetJournal.GetPetInfoByPetID.md | 38 --- .../C_PetJournal.GetPetInfoBySpeciesID.md | 28 --- .../C_PetJournal.GetPetLoadOutInfo.md | 25 -- .../C_PetJournal.GetPetSortParameter.md | 12 - .../C_PetJournal.GetPetSummonInfo.md | 27 --- .../C_PetJournal.GetSummonedPetGUID.md | 15 -- .../functions/C_PetJournal.IsFilterChecked.md | 18 -- .../C_PetJournal.IsPetSourceChecked.md | 18 -- .../C_PetJournal.IsPetTypeChecked.md | 18 -- .../functions/C_PetJournal.PetIsFavorite.md | 13 - .../functions/C_PetJournal.PetIsRevoked.md | 17 -- .../functions/C_PetJournal.PetIsSummonable.md | 13 - .../functions/C_PetJournal.PickupPet.md | 17 -- .../C_PetJournal.SetAllPetSourcesChecked.md | 14 -- .../C_PetJournal.SetAllPetTypesChecked.md | 14 -- .../functions/C_PetJournal.SetFavorite.md | 13 - .../C_PetJournal.SetFilterChecked.md | 16 -- .../C_PetJournal.SetPetLoadOutInfo.md | 24 -- .../C_PetJournal.SetPetSortParameter.md | 25 -- .../C_PetJournal.SetPetSourceChecked.md | 16 -- .../C_PetJournal.SetPetTypeFilter.md | 16 -- .../functions/C_PetJournal.SetSearchFilter.md | 12 - .../functions/C_PetJournal.SummonPetByGUID.md | 29 --- .../functions/C_PlayerInfo.CanUseItem.md | 19 -- .../functions/C_PlayerInfo.GUIDIsPlayer.md | 16 -- .../C_PlayerInfo.GetAlternateFormInfo.md | 11 - .../functions/C_PlayerInfo.GetClass.md | 17 -- .../functions/C_PlayerInfo.GetDisplayID.md | 9 - .../functions/C_PlayerInfo.GetName.md | 27 --- .../C_PlayerInfo.GetNativeDisplayID.md | 9 - ...rInfo.GetPetStableCreatureDisplayInfoID.md | 13 - .../C_PlayerInfo.GetPlayerCharacterData.md | 50 ---- .../functions/C_PlayerInfo.GetRace.md | 27 --- .../functions/C_PlayerInfo.GetSex.md | 35 --- .../C_PlayerInfo.HasVisibleInvSlot.md | 19 -- .../functions/C_PlayerInfo.IsConnected.md | 22 -- .../C_PlayerInfo.IsDisplayRaceNative.md | 9 - .../functions/C_PlayerInfo.IsMirrorImage.md | 9 - .../C_PlayerInfo.IsPlayerNPERestricted.md | 9 - .../C_PlayerInfo.IsSelfFoundActive.md | 9 - .../C_PlayerInfo.UnitIsSameServer.md | 22 -- ...ayerInteractionManager.ClearInteraction.md | 77 ------ ...eractionManager.ConfirmationInteraction.md | 77 ------ ...C_PlayerInteractionManager.InteractUnit.md | 23 -- ...ctionManager.IsInteractingWithNpcOfType.md | 81 ------- ...layerInteractionManager.IsReplacingUnit.md | 9 - ...nteractionManager.IsValidNPCInteraction.md | 81 ------- .../C_PvP.GetArenaCrowdControlInfo.md | 23 -- .../C_PvP.GetBattlefieldVehicleInfo.md | 40 --- .../functions/C_PvP.GetBattlefieldVehicles.md | 38 --- .../functions/C_PvP.GetRandomBGRewards.md | 33 --- wiki-information/functions/C_PvP.IsInBrawl.md | 9 - wiki-information/functions/C_PvP.IsPVPMap.md | 9 - .../functions/C_PvP.IsRatedMap.md | 15 -- .../C_PvP.RequestCrowdControlSpell.md | 9 - ...QuestInfoSystem.GetQuestRewardSpellInfo.md | 56 ----- .../C_QuestInfoSystem.GetQuestRewardSpells.md | 13 - ...nfoSystem.GetQuestShouldToastCompletion.md | 19 -- .../C_QuestInfoSystem.HasQuestRewardSpells.md | 13 - .../C_QuestLog.GetMapForQuestPOIs.md | 9 - .../functions/C_QuestLog.GetMaxNumQuests.md | 9 - .../C_QuestLog.GetMaxNumQuestsCanAccept.md | 9 - .../functions/C_QuestLog.GetQuestInfo.md | 20 -- .../C_QuestLog.GetQuestObjectives.md | 31 --- .../functions/C_QuestLog.GetQuestsOnMap.md | 32 --- .../functions/C_QuestLog.IsOnQuest.md | 13 - .../C_QuestLog.IsQuestFlaggedCompleted.md | 20 -- .../C_QuestLog.SetMapForQuestPOIs.md | 9 - .../C_QuestLog.ShouldShowQuestRewards.md | 19 -- .../functions/C_QuestSession.CanStart.md | 13 - .../functions/C_QuestSession.CanStop.md | 13 - .../functions/C_QuestSession.Exists.md | 12 - ...QuestSession.GetAvailableSessionCommand.md | 23 -- .../C_QuestSession.GetPendingCommand.md | 23 -- ...stSession.GetProposedMaxLevelForSession.md | 9 - .../C_QuestSession.GetSessionBeginDetails.md | 22 -- .../C_QuestSession.GetSuperTrackedQuest.md | 12 - .../functions/C_QuestSession.HasJoined.md | 12 - .../C_QuestSession.HasPendingCommand.md | 12 - .../C_QuestSession.RequestSessionStart.md | 9 - .../C_QuestSession.RequestSessionStop.md | 9 - ...C_QuestSession.SendSessionBeginResponse.md | 15 -- .../C_QuestSession.SetQuestIsSuperTracked.md | 17 -- .../C_RaidLocks.IsEncounterComplete.md | 23 -- .../C_ReportSystem.CanReportPlayer.md | 13 - ...ReportSystem.CanReportPlayerForLanguage.md | 19 -- ...tSystem.GetMajorCategoriesForReportType.md | 39 --- .../C_ReportSystem.GetMajorCategoryString.md | 20 -- ...CategoriesForReportTypeAndMajorCategory.md | 59 ----- .../C_ReportSystem.GetMinorCategoryString.md | 46 ---- .../C_ReportSystem.InitiateReportPlayer.md | 33 --- .../C_ReportSystem.OpenReportPlayerDialog.md | 35 --- .../C_ReportSystem.ReportServerLag.md | 17 -- .../C_ReportSystem.ReportStuckInCombat.md | 18 -- .../functions/C_ReportSystem.SendReport.md | 11 - .../C_ReportSystem.SendReportPlayer.md | 11 - ..._ReportSystem.SetPendingReportPetTarget.md | 13 - .../C_ReportSystem.SetPendingReportTarget.md | 20 -- ...portSystem.SetPendingReportTargetByGuid.md | 20 -- .../C_Reputation.GetFactionParagonInfo.md | 36 --- .../C_Reputation.IsFactionParagon.md | 18 -- ....RequestFactionParagonPreloadRewardData.md | 9 - .../C_Reputation.SetWatchedFaction.md | 9 - ...imations.GetAllScriptedAnimationEffects.md | 102 -------- .../functions/C_Seasons.GetActiveSeason.md | 23 -- .../functions/C_Seasons.HasActiveSeason.md | 12 - .../functions/C_Social.GetLastItem.md | 19 -- .../functions/C_Social.GetLastScreenshot.md | 9 - .../C_Social.GetNumCharactersPerMedia.md | 9 - .../C_Social.GetScreenshotByIndex.md | 24 -- .../functions/C_Social.GetTweetLength.md | 13 - .../functions/C_Social.IsSocialEnabled.md | 9 - .../functions/C_Social.TwitterCheckStatus.md | 5 - .../functions/C_Social.TwitterConnect.md | 5 - .../functions/C_Social.TwitterDisconnect.md | 5 - .../C_Social.TwitterGetMSTillCanPost.md | 9 - .../functions/C_Social.TwitterPostMessage.md | 12 - ...ictions.AcknowledgeRegionalChatDisabled.md | 5 - .../C_SocialRestrictions.IsChatDisabled.md | 9 - .../functions/C_SocialRestrictions.IsMuted.md | 9 - .../C_SocialRestrictions.IsSilenced.md | 9 - .../C_SocialRestrictions.IsSquelched.md | 9 - .../C_SocialRestrictions.SetChatDisabled.md | 9 - .../functions/C_Sound.GetSoundScaledVolume.md | 13 - .../functions/C_Sound.IsPlaying.md | 19 -- .../functions/C_Sound.PlayItemSound.md | 22 -- .../functions/C_Spell.DoesSpellExist.md | 16 -- .../functions/C_Spell.IsSpellDataCached.md | 29 --- .../functions/C_Spell.RequestLoadSpellData.md | 12 - .../C_SpellBook.GetSpellLinkFromSpellID.md | 21 -- .../C_StableInfo.GetNumActivePets.md | 12 - .../C_StableInfo.GetNumStablePets.md | 12 - ...ublic.DoesGroupHavePurchaseableProducts.md | 13 - .../C_StorePublic.HasPurchaseableProducts.md | 9 - ...torePublic.IsDisabledByParentalControls.md | 9 - .../functions/C_StorePublic.IsEnabled.md | 9 - .../functions/C_SummonInfo.CancelSummon.md | 11 - .../functions/C_SummonInfo.ConfirmSummon.md | 11 - .../C_SummonInfo.GetSummonConfirmAreaName.md | 9 - .../C_SummonInfo.GetSummonConfirmSummoner.md | 12 - .../C_SummonInfo.GetSummonConfirmTimeLeft.md | 9 - .../functions/C_SummonInfo.GetSummonReason.md | 9 - ...monInfo.IsSummonSkippingStartExperience.md | 9 - .../functions/C_System.GetFrameStack.md | 9 - ...SystemVisibilityManager.IsSystemVisible.md | 18 -- .../C_TTSSettings.GetChannelEnabled.md | 40 --- ...C_TTSSettings.GetCharacterSettingsSaved.md | 9 - .../C_TTSSettings.GetChatTypeEnabled.md | 13 - .../functions/C_TTSSettings.GetSetting.md | 21 -- .../functions/C_TTSSettings.GetSpeechRate.md | 9 - .../C_TTSSettings.GetSpeechVolume.md | 9 - .../C_TTSSettings.GetVoiceOptionID.md | 20 -- .../C_TTSSettings.GetVoiceOptionName.md | 20 -- ..._TTSSettings.MarkCharacterSettingsSaved.md | 6 - .../C_TTSSettings.SetChannelEnabled.md | 38 --- .../C_TTSSettings.SetChannelKeyEnabled.md | 11 - .../C_TTSSettings.SetChatTypeEnabled.md | 11 - .../C_TTSSettings.SetDefaultSettings.md | 6 - .../functions/C_TTSSettings.SetSetting.md | 19 -- .../functions/C_TTSSettings.SetSpeechRate.md | 9 - .../C_TTSSettings.SetSpeechVolume.md | 9 - .../functions/C_TTSSettings.SetVoiceOption.md | 17 -- .../C_TTSSettings.SetVoiceOptionName.md | 33 --- .../C_TTSSettings.ShouldOverrideMessage.md | 15 -- ...askQuest.DoesMapShowTaskQuestObjectives.md | 13 - .../C_TaskQuest.GetQuestInfoByQuestID.md | 25 -- .../functions/C_TaskQuest.GetQuestLocation.md | 17 -- .../C_TaskQuest.GetQuestProgressBarInfo.md | 27 --- .../C_TaskQuest.GetQuestTimeLeftMinutes.md | 21 -- .../C_TaskQuest.GetQuestTimeLeftSeconds.md | 21 -- .../functions/C_TaskQuest.GetQuestZoneID.md | 13 - .../C_TaskQuest.GetQuestsForPlayerByMapID.md | 39 --- .../functions/C_TaskQuest.GetThreatQuests.md | 23 -- ...C_TaskQuest.GetUIWidgetSetIDFromQuestID.md | 13 - .../functions/C_TaskQuest.IsActive.md | 19 -- .../C_TaskQuest.RequestPreloadRewardData.md | 9 - .../functions/C_TaxiMap.GetAllTaxiNodes.md | 45 ---- .../functions/C_TaxiMap.GetTaxiNodesForMap.md | 38 --- .../C_Texture.ClearTitleIconTexture.md | 9 - .../functions/C_Texture.GetAtlasElementID.md | 19 -- .../functions/C_Texture.GetAtlasID.md | 19 -- .../functions/C_Texture.GetAtlasInfo.md | 71 ------ .../C_Texture.GetFilenameFromFileDataID.md | 16 -- .../C_Texture.GetTitleIconTexture.md | 31 --- .../C_Texture.IsTitleIconTextureReady.md | 24 -- .../C_Texture.SetTitleIconTexture.md | 22 -- wiki-information/functions/C_Timer.After.md | 32 --- .../functions/C_Timer.NewTicker.md | 50 ---- .../functions/C_Timer.NewTimer.md | 50 ---- .../functions/C_ToyBox.GetNumToys.md | 9 - .../functions/C_ToyBox.GetToyFromIndex.md | 13 - .../functions/C_ToyBox.GetToyInfo.md | 23 -- .../functions/C_ToyBox.GetToyLink.md | 20 -- .../functions/C_ToyBoxInfo.ClearFanfare.md | 9 - .../functions/C_ToyBoxInfo.NeedsFanfare.md | 13 - .../functions/C_Traits.CanPurchaseRank.md | 21 -- .../functions/C_Traits.CanRefundRank.md | 15 -- .../C_Traits.CascadeRepurchaseRanks.md | 16 -- .../C_Traits.ClearCascadeRepurchaseHistory.md | 9 - .../functions/C_Traits.CommitConfig.md | 16 -- .../C_Traits.ConfigHasStagedChanges.md | 13 - .../C_Traits.GenerateImportString.md | 62 ----- .../C_Traits.GenerateInspectImportString.md | 19 -- .../functions/C_Traits.GetConditionInfo.md | 70 ------ .../C_Traits.GetConfigIDBySystemID.md | 19 -- .../functions/C_Traits.GetConfigIDByTreeID.md | 13 - .../functions/C_Traits.GetConfigInfo.md | 42 ---- .../functions/C_Traits.GetConfigsByType.md | 20 -- .../functions/C_Traits.GetDefinitionInfo.md | 44 ---- .../functions/C_Traits.GetEntryInfo.md | 52 ---- ...C_Traits.GetLoadoutSerializationVersion.md | 13 - .../functions/C_Traits.GetNodeCost.md | 22 -- .../functions/C_Traits.GetNodeInfo.md | 121 ---------- .../C_Traits.GetStagedChangesCost.md | 20 -- .../functions/C_Traits.GetStagedPurchases.md | 13 - .../C_Traits.GetTraitCurrencyInfo.md | 52 ---- .../functions/C_Traits.GetTraitDescription.md | 15 -- .../functions/C_Traits.GetTraitSystemFlags.md | 26 -- .../C_Traits.GetTraitSystemWidgetSetID.md | 13 - .../functions/C_Traits.GetTreeCurrencyInfo.md | 28 --- .../functions/C_Traits.GetTreeHash.md | 18 -- .../functions/C_Traits.GetTreeInfo.md | 33 --- .../functions/C_Traits.GetTreeNodes.md | 19 -- .../functions/C_Traits.HasValidInspectData.md | 9 - .../functions/C_Traits.IsReadyForCommit.md | 9 - .../functions/C_Traits.PurchaseRank.md | 18 -- .../functions/C_Traits.RefundAllRanks.md | 34 --- .../functions/C_Traits.RefundRank.md | 23 -- .../functions/C_Traits.ResetTree.md | 35 --- .../functions/C_Traits.ResetTreeByCurrency.md | 20 -- .../functions/C_Traits.RollbackConfig.md | 13 - .../functions/C_Traits.SetSelection.md | 23 -- .../functions/C_Traits.StageConfig.md | 30 --- .../functions/C_UI.DoesAnyDisplayHaveNotch.md | 9 - .../C_UI.GetTopLeftNotchSafeRegion.md | 15 -- .../C_UI.GetTopRightNotchSafeRegion.md | 15 -- wiki-information/functions/C_UI.Reload.md | 15 -- .../C_UI.ShouldUIParentAvoidNotch.md | 9 - .../functions/C_UIColor.GetColors.md | 19 -- .../C_UIWidgetManager.GetAllWidgetsBySetID.md | 78 ------ ...idgetManager.GetBelowMinimapWidgetSetID.md | 19 -- ...etBulletTextListWidgetVisualizationInfo.md | 86 ------- ...er.GetCaptureBarWidgetVisualizationInfo.md | 162 ------------- ...oubleIconAndTextWidgetVisualizationInfo.md | 135 ----------- ...tDoubleStatusBarWidgetVisualizationInfo.md | 171 ------------- ...zontalCurrenciesWidgetVisualizationInfo.md | 145 ----------- ...r.GetIconAndTextWidgetVisualizationInfo.md | 138 ----------- ...extAndBackgroundWidgetVisualizationInfo.md | 105 -------- ...extAndCurrenciesWidgetVisualizationInfo.md | 171 ------------- ...iesAndBackgroundWidgetVisualizationInfo.md | 119 --------- ...dResourceTrackerWidgetVisualizationInfo.md | 145 ----------- ...ger.GetStatusBarWidgetVisualizationInfo.md | 214 ---------------- ...GetTextWithStateWidgetVisualizationInfo.md | 203 ---------------- ...er.GetTextureWithStateVisualizationInfo.md | 41 ---- ...UIWidgetManager.GetTopCenterWidgetSetID.md | 33 --- .../C_UnitAuras.AddPrivateAuraAnchor.md | 58 ----- .../C_UnitAuras.AddPrivateAuraAppliedSound.md | 26 -- .../functions/C_UnitAuras.AuraIsPrivate.md | 19 -- ...C_UnitAuras.GetAuraDataByAuraInstanceID.md | 65 ----- .../C_UnitAuras.GetAuraDataByIndex.md | 81 ------- .../C_UnitAuras.GetAuraDataBySlot.md | 64 ----- .../C_UnitAuras.GetAuraDataBySpellName.md | 89 ------- .../functions/C_UnitAuras.GetAuraSlots.md | 43 ---- .../C_UnitAuras.GetBuffDataByIndex.md | 87 ------- .../C_UnitAuras.GetCooldownAuraBySpellID.md | 16 -- .../C_UnitAuras.GetDebuffDataByIndex.md | 90 ------- .../C_UnitAuras.GetPlayerAuraBySpellID.md | 66 ----- ...UnitAuras.IsAuraFilteredOutByInstanceID.md | 28 --- .../C_UnitAuras.RemovePrivateAuraAnchor.md | 9 - ...UnitAuras.RemovePrivateAuraAppliedSound.md | 9 - ...C_UnitAuras.SetPrivateWarningTextAnchor.md | 24 -- .../functions/C_UnitAuras.WantsAlteredForm.md | 13 - .../functions/C_UserFeedback.SubmitBug.md | 32 --- .../C_UserFeedback.SubmitSuggestion.md | 30 --- ...C_VideoOptions.GetCurrentGameWindowSize.md | 9 - ...C_VideoOptions.GetDefaultGameWindowSize.md | 13 - .../C_VideoOptions.GetGameWindowSizes.md | 15 -- .../C_VideoOptions.GetGxAdapterInfo.md | 18 -- .../C_VideoOptions.SetGameWindowSize.md | 11 - .../functions/C_VoiceChat.ActivateChannel.md | 9 - ..._VoiceChat.ActivateChannelTranscription.md | 9 - .../C_VoiceChat.BeginLocalCapture.md | 21 -- .../C_VoiceChat.CanPlayerUseVoiceChat.md | 9 - .../functions/C_VoiceChat.CreateChannel.md | 42 ---- .../C_VoiceChat.DeactivateChannel.md | 9 - ...oiceChat.DeactivateChannelTranscription.md | 9 - .../functions/C_VoiceChat.EndLocalCapture.md | 18 -- .../C_VoiceChat.GetActiveChannelID.md | 9 - .../C_VoiceChat.GetActiveChannelType.md | 9 - .../C_VoiceChat.GetAvailableInputDevices.md | 25 -- .../C_VoiceChat.GetAvailableOutputDevices.md | 26 -- .../functions/C_VoiceChat.GetChannel.md | 71 ------ .../C_VoiceChat.GetChannelForChannelType.md | 56 ----- ..._VoiceChat.GetChannelForCommunityStream.md | 75 ------ .../C_VoiceChat.GetCommunicationMode.md | 17 -- ...GetCurrentVoiceChatConnectionStatusCode.md | 62 ----- .../functions/C_VoiceChat.GetInputVolume.md | 9 - ...t.GetLocalPlayerActiveChannelMemberInfo.md | 25 -- .../C_VoiceChat.GetLocalPlayerMemberID.md | 13 - .../C_VoiceChat.GetMasterVolumeScale.md | 9 - .../functions/C_VoiceChat.GetMemberGUID.md | 15 -- .../functions/C_VoiceChat.GetMemberID.md | 15 -- .../functions/C_VoiceChat.GetMemberInfo.md | 31 --- .../functions/C_VoiceChat.GetMemberName.md | 24 -- .../functions/C_VoiceChat.GetMemberVolume.md | 27 --- .../functions/C_VoiceChat.GetOutputVolume.md | 9 - .../C_VoiceChat.GetPTTButtonPressedState.md | 9 - .../functions/C_VoiceChat.GetProcesses.md | 78 ------ .../C_VoiceChat.GetPushToTalkBinding.md | 9 - .../C_VoiceChat.GetRemoteTtsVoices.md | 16 -- .../functions/C_VoiceChat.GetTtsVoices.md | 16 -- .../C_VoiceChat.GetVADSensitivity.md | 9 - .../C_VoiceChat.IsChannelJoinPending.md | 31 --- .../functions/C_VoiceChat.IsDeafened.md | 9 - .../functions/C_VoiceChat.IsEnabled.md | 9 - .../functions/C_VoiceChat.IsLoggedIn.md | 9 - .../C_VoiceChat.IsMemberLocalPlayer.md | 15 -- .../functions/C_VoiceChat.IsMemberMuted.md | 27 --- .../C_VoiceChat.IsMemberMutedForAll.md | 16 -- .../functions/C_VoiceChat.IsMemberSilenced.md | 15 -- .../functions/C_VoiceChat.IsMuted.md | 9 - .../C_VoiceChat.IsParentalDisabled.md | 9 - .../functions/C_VoiceChat.IsParentalMuted.md | 9 - .../C_VoiceChat.IsPlayerUsingVoice.md | 13 - .../functions/C_VoiceChat.IsSilenced.md | 9 - .../C_VoiceChat.IsSpeakForMeActive.md | 9 - .../C_VoiceChat.IsSpeakForMeAllowed.md | 9 - .../functions/C_VoiceChat.IsTranscribing.md | 9 - .../C_VoiceChat.IsTranscriptionAllowed.md | 9 - .../C_VoiceChat.IsVoiceChatConnected.md | 9 - .../functions/C_VoiceChat.LeaveChannel.md | 9 - .../functions/C_VoiceChat.Login.md | 38 --- .../functions/C_VoiceChat.Logout.md | 63 ----- .../C_VoiceChat.MarkChannelsDiscovered.md | 8 - ...stJoinAndActivateCommunityStreamChannel.md | 11 - ...iceChat.RequestJoinChannelByChannelType.md | 37 --- .../C_VoiceChat.SetCommunicationMode.md | 17 -- .../functions/C_VoiceChat.SetDeafened.md | 9 - .../functions/C_VoiceChat.SetInputDevice.md | 9 - .../functions/C_VoiceChat.SetInputVolume.md | 9 - .../C_VoiceChat.SetMasterVolumeScale.md | 9 - .../functions/C_VoiceChat.SetMemberMuted.md | 19 -- .../functions/C_VoiceChat.SetMemberVolume.md | 14 -- .../functions/C_VoiceChat.SetMuted.md | 9 - .../functions/C_VoiceChat.SetOutputDevice.md | 9 - .../functions/C_VoiceChat.SetOutputVolume.md | 9 - .../C_VoiceChat.SetPortraitTexture.md | 19 -- .../C_VoiceChat.SetPushToTalkBinding.md | 9 - .../C_VoiceChat.SetVADSensitivity.md | 9 - .../C_VoiceChat.ShouldDiscoverChannels.md | 12 - .../C_VoiceChat.SpeakRemoteTextSample.md | 9 - .../functions/C_VoiceChat.SpeakText.md | 41 ---- .../functions/C_VoiceChat.StopSpeakingText.md | 5 - .../functions/C_VoiceChat.ToggleDeafened.md | 5 - .../C_VoiceChat.ToggleMemberMuted.md | 9 - .../functions/C_VoiceChat.ToggleMuted.md | 5 - .../functions/C_XMLUtil.GetTemplateInfo.md | 38 --- .../functions/C_XMLUtil.GetTemplates.md | 24 -- .../functions/CalculateStringEditDistance.md | 30 --- wiki-information/functions/CallCompanion.md | 28 --- .../functions/CameraOrSelectOrMoveStart.md | 10 - .../functions/CameraOrSelectOrMoveStop.md | 14 -- wiki-information/functions/CameraZoomIn.md | 13 - wiki-information/functions/CanAbandonQuest.md | 16 -- wiki-information/functions/CanBeRaidTarget.md | 22 -- .../functions/CanChangePlayerDifficulty.md | 11 - wiki-information/functions/CanDualWield.md | 73 ------ wiki-information/functions/CanEditMOTD.md | 9 - .../functions/CanEjectPassengerFromSeat.md | 13 - wiki-information/functions/CanGrantLevel.md | 24 -- wiki-information/functions/CanGuildDemote.md | 15 -- wiki-information/functions/CanGuildInvite.md | 9 - wiki-information/functions/CanGuildPromote.md | 22 -- wiki-information/functions/CanInspect.md | 21 -- .../functions/CanJoinBattlefieldAsGroup.md | 21 -- wiki-information/functions/CanLootUnit.md | 15 -- .../functions/CanMerchantRepair.md | 9 - .../functions/CanReplaceGuildMaster.md | 13 - .../functions/CanSendAuctionQuery.md | 15 -- .../functions/CanShowAchievementUI.md | 14 -- .../functions/CanShowResetInstances.md | 9 - wiki-information/functions/CanSummonFriend.md | 23 -- .../functions/CanSwitchVehicleSeat.md | 9 - .../functions/CanUpgradeExpansion.md | 9 - wiki-information/functions/CancelDuel.md | 18 -- .../functions/CancelItemTempEnchantment.md | 15 -- wiki-information/functions/CancelLogout.md | 8 - .../functions/CancelPendingEquip.md | 12 - .../functions/CancelPreloadingMovie.md | 9 - .../functions/CancelShapeshiftForm.md | 9 - .../functions/CancelTrackingBuff.md | 11 - wiki-information/functions/CancelTrade.md | 11 - wiki-information/functions/CancelUnitBuff.md | 16 -- .../functions/CaseAccentInsensitiveParse.md | 35 --- wiki-information/functions/CastPetAction.md | 11 - .../functions/CastShapeshiftForm.md | 21 -- wiki-information/functions/CastSpell.md | 31 --- wiki-information/functions/CastSpellByName.md | 14 -- wiki-information/functions/CastingInfo.md | 34 --- .../functions/ChangeActionBarPage.md | 13 - wiki-information/functions/ChangeChatColor.md | 24 -- wiki-information/functions/ChannelBan.md | 14 -- wiki-information/functions/ChannelInfo.md | 26 -- wiki-information/functions/ChannelInvite.md | 14 -- wiki-information/functions/ChannelKick.md | 14 -- wiki-information/functions/CheckInbox.md | 9 - .../functions/CheckInteractDistance.md | 38 --- .../functions/CheckTalentMasterDist.md | 9 - .../functions/ClassicExpansionAtLeast.md | 13 - wiki-information/functions/ClearCursor.md | 22 -- .../functions/ClearOverrideBindings.md | 12 - wiki-information/functions/ClearSendMail.md | 20 -- wiki-information/functions/ClearTarget.md | 9 - .../functions/ClickSendMailItemButton.md | 11 - wiki-information/functions/ClickStablePet.md | 18 -- wiki-information/functions/CloseItemText.md | 8 - wiki-information/functions/CloseLoot.md | 15 -- wiki-information/functions/ClosePetition.md | 8 - wiki-information/functions/CloseSocketInfo.md | 8 - .../functions/ClosestUnitPosition.md | 17 -- .../functions/CollapseFactionHeader.md | 12 - .../functions/CollapseQuestHeader.md | 31 --- .../functions/CollapseSkillHeader.md | 12 - .../functions/CollapseTrainerSkillLine.md | 25 -- .../functions/CombatLogAdvanceEntry.md | 40 --- .../functions/CombatLogGetCurrentEntry.md | 10 - .../functions/CombatLogGetCurrentEventInfo.md | 47 ---- .../functions/CombatLogSetCurrentEntry.md | 47 ---- .../functions/CombatLog_Object_IsA.md | 64 ----- .../functions/CombatTextSetActiveUnit.md | 17 -- wiki-information/functions/CompleteQuest.md | 10 - .../functions/ConfirmAcceptQuest.md | 8 - wiki-information/functions/ConfirmLootRoll.md | 30 --- wiki-information/functions/ConfirmLootSlot.md | 12 - .../functions/ConfirmPetUnlearn.md | 9 - .../functions/ConfirmReadyCheck.md | 12 - .../functions/ConsoleAddMessage.md | 9 - wiki-information/functions/ConsoleExec.md | 12 - .../functions/ConsoleGetAllCommands.md | 64 ----- .../functions/ConsoleGetColorFromType.md | 28 --- .../functions/ConsoleGetFontHeight.md | 9 - .../ConsolePrintAllMatchingCommands.md | 9 - .../functions/ConsoleSetFontHeight.md | 9 - .../functions/ContainerIDToInventoryID.md | 37 --- wiki-information/functions/ConvertToParty.md | 8 - wiki-information/functions/ConvertToRaid.md | 8 - wiki-information/functions/CopyToClipboard.md | 28 --- wiki-information/functions/CreateFont.md | 28 --- wiki-information/functions/CreateFrame.md | 105 -------- wiki-information/functions/CreateMacro.md | 36 --- wiki-information/functions/CreateWindow.md | 16 -- .../functions/CursorCanGoInSlot.md | 13 - wiki-information/functions/CursorHasItem.md | 12 - wiki-information/functions/CursorHasMacro.md | 9 - wiki-information/functions/CursorHasMoney.md | 15 -- wiki-information/functions/CursorHasSpell.md | 9 - .../functions/DeathRecap_GetEvents.md | 51 ---- .../functions/DeathRecap_HasEvents.md | 13 - .../functions/DeclineArenaTeam.md | 15 -- .../functions/DeclineChannelInvite.md | 13 - wiki-information/functions/DeclineGroup.md | 22 -- wiki-information/functions/DeclineGuild.md | 11 - wiki-information/functions/DeclineName.md | 37 --- wiki-information/functions/DeclineQuest.md | 11 - .../functions/DeclineResurrect.md | 11 - .../DeclineSpellConfirmationPrompt.md | 22 -- .../functions/DeleteCursorItem.md | 8 - wiki-information/functions/DeleteInboxItem.md | 16 -- wiki-information/functions/DeleteMacro.md | 38 --- wiki-information/functions/DescendStop.md | 11 - wiki-information/functions/DestroyTotem.md | 12 - wiki-information/functions/DisableAddOn.md | 42 ---- .../functions/DismissCompanion.md | 9 - wiki-information/functions/Dismount.md | 18 -- .../functions/DisplayChannelOwner.md | 9 - wiki-information/functions/DoReadyCheck.md | 24 -- wiki-information/functions/DoTradeSkill.md | 23 -- .../DoesCurrentLocaleSellExpansionLevels.md | 9 - wiki-information/functions/DoesSpellExist.md | 16 -- wiki-information/functions/DropItemOnUnit.md | 20 -- wiki-information/functions/EditMacro.md | 33 --- .../functions/EjectPassengerFromSeat.md | 9 - wiki-information/functions/EnableAddOn.md | 41 ---- wiki-information/functions/EnumerateFrames.md | 33 --- .../functions/EnumerateServerChannels.md | 9 - wiki-information/functions/EquipCursorItem.md | 19 -- wiki-information/functions/EquipItemByName.md | 19 -- .../functions/EquipPendingItem.md | 12 - .../functions/ExpandCurrencyList.md | 15 -- .../functions/ExpandFactionHeader.md | 22 -- .../functions/ExpandQuestHeader.md | 31 --- .../functions/ExpandSkillHeader.md | 25 -- .../functions/ExpandTradeSkillSubClass.md | 29 --- .../functions/ExpandTrainerSkillLine.md | 26 -- .../functions/FactionToggleAtWar.md | 12 - .../functions/FillLocalizedClassList.md | 63 ----- .../functions/FindBaseSpellByID.md | 16 -- .../functions/FindSpellOverrideByID.md | 16 -- wiki-information/functions/FlashClientIcon.md | 15 -- wiki-information/functions/FlipCameraYaw.md | 12 - wiki-information/functions/FocusUnit.md | 9 - wiki-information/functions/FollowUnit.md | 14 -- wiki-information/functions/ForceGossip.md | 9 - wiki-information/functions/ForceQuit.md | 11 - wiki-information/functions/FrameXML_Debug.md | 16 -- .../functions/GMRequestPlayerInfo.md | 13 - wiki-information/functions/GMSubmitBug.md | 15 -- .../functions/GMSubmitSuggestion.md | 19 -- .../functions/GetAbandonQuestItems.md | 9 - .../functions/GetAbandonQuestName.md | 16 -- .../functions/GetAccountExpansionLevel.md | 55 ----- .../functions/GetAchievementCategory.md | 24 -- .../functions/GetAchievementComparisonInfo.md | 28 --- .../functions/GetAchievementCriteriaInfo.md | 210 ---------------- .../GetAchievementCriteriaInfoByID.md | 117 --------- .../functions/GetAchievementLink.md | 13 - .../functions/GetAchievementNumCriteria.md | 16 -- .../functions/GetActionBarPage.md | 15 -- .../functions/GetActionBarToggles.md | 15 -- .../functions/GetActionCharges.md | 28 --- .../functions/GetActionCooldown.md | 32 --- wiki-information/functions/GetActionCount.md | 42 ---- wiki-information/functions/GetActionInfo.md | 31 --- .../GetActionLossOfControlCooldown.md | 20 -- wiki-information/functions/GetActionText.md | 14 -- .../functions/GetActionTexture.md | 14 -- .../functions/GetActiveTalentGroup.md | 15 -- .../functions/GetAddOnCPUUsage.md | 36 --- .../functions/GetAddOnDependencies.md | 13 - .../functions/GetAddOnEnableState.md | 21 -- wiki-information/functions/GetAddOnInfo.md | 44 ---- .../functions/GetAddOnMemoryUsage.md | 32 --- .../functions/GetAddOnMetadata.md | 18 -- .../functions/GetAllowLowLevelRaid.md | 9 - .../functions/GetArenaTeamIndexBySize.md | 17 -- .../functions/GetArenaTeamRosterInfo.md | 33 --- .../functions/GetArmorPenetration.md | 9 - wiki-information/functions/GetAtlasInfo.md | 71 ------ .../functions/GetAttackPowerForStat.md | 20 -- .../functions/GetAuctionItemBattlePetInfo.md | 27 --- .../functions/GetAuctionItemInfo.md | 76 ------ .../functions/GetAuctionItemLink.md | 19 -- .../functions/GetAuctionItemSubClasses.md | 39 --- .../functions/GetAutoCompleteRealms.md | 18 -- .../functions/GetAutoCompleteResults.md | 48 ---- .../functions/GetAutoDeclineGuildInvites.md | 12 - .../functions/GetAvailableBandwidth.md | 9 - .../functions/GetAvailableLocales.md | 19 -- .../functions/GetAverageItemLevel.md | 35 --- .../functions/GetBackgroundLoadingStatus.md | 9 - .../functions/GetBackpackCurrencyInfo.md | 19 -- wiki-information/functions/GetBankSlotCost.md | 25 -- .../GetBattlefieldEstimatedWaitTime.md | 9 - .../functions/GetBattlefieldFlagPosition.md | 18 -- .../GetBattlefieldInstanceExpiration.md | 9 - .../functions/GetBattlefieldInstanceInfo.md | 13 - .../GetBattlefieldInstanceRunTime.md | 9 - .../functions/GetBattlefieldPortExpiration.md | 13 - .../functions/GetBattlefieldScore.md | 64 ----- .../functions/GetBattlefieldStatInfo.md | 45 ---- .../functions/GetBattlefieldStatus.md | 48 ---- .../functions/GetBattlefieldTimeWaited.md | 21 -- .../functions/GetBattlefieldWinner.md | 17 -- .../functions/GetBattlegroundInfo.md | 37 --- .../functions/GetBattlegroundPoints.md | 19 -- .../functions/GetBestFlexRaidChoice.md | 14 -- wiki-information/functions/GetBestRFChoice.md | 24 -- .../functions/GetBillingTimeRested.md | 30 --- wiki-information/functions/GetBindLocation.md | 20 -- wiki-information/functions/GetBinding.md | 39 --- .../functions/GetBindingAction.md | 27 --- wiki-information/functions/GetBindingByKey.md | 20 -- wiki-information/functions/GetBindingKey.md | 36 --- wiki-information/functions/GetBindingText.md | 23 -- wiki-information/functions/GetBlockChance.md | 16 -- .../functions/GetBonusBarOffset.md | 42 ---- wiki-information/functions/GetBuildInfo.md | 54 ----- .../functions/GetButtonMetatable.md | 12 - .../functions/GetBuybackItemInfo.md | 26 -- wiki-information/functions/GetCVarInfo.md | 25 -- wiki-information/functions/GetCameraZoom.md | 12 - wiki-information/functions/GetCategoryList.md | 13 - .../functions/GetCategoryNumAchievements.md | 32 --- .../functions/GetCemeteryPreference.md | 9 - wiki-information/functions/GetChannelList.md | 24 -- wiki-information/functions/GetChannelName.md | 22 -- .../functions/GetChatWindowInfo.md | 40 --- .../functions/GetChatWindowMessages.md | 17 -- wiki-information/functions/GetClassInfo.md | 68 ------ .../functions/GetClassicExpansionLevel.md | 9 - wiki-information/functions/GetClickFrame.md | 18 -- .../GetClientDisplayExpansionLevel.md | 50 ---- wiki-information/functions/GetCoinIcon.md | 21 -- wiki-information/functions/GetCoinText.md | 51 ---- .../functions/GetCoinTextureString.md | 51 ---- wiki-information/functions/GetCombatRating.md | 89 ------- .../functions/GetCombatRatingBonus.md | 87 ------- wiki-information/functions/GetComboPoints.md | 35 --- .../functions/GetCompanionCooldown.md | 19 -- .../functions/GetCompanionInfo.md | 39 --- .../functions/GetComparisonStatistic.md | 13 - .../functions/GetContainerFreeSlots.md | 21 -- .../functions/GetContainerItemCooldown.md | 21 -- .../functions/GetContainerItemDurability.md | 26 -- .../functions/GetContainerItemID.md | 15 -- .../functions/GetContainerItemInfo.md | 46 ---- .../functions/GetContainerItemLink.md | 24 -- .../functions/GetContainerNumFreeSlots.md | 18 -- .../functions/GetContainerNumSlots.md | 17 -- .../functions/GetCorpseRecoveryDelay.md | 9 - .../functions/GetCraftDescription.md | 23 -- .../functions/GetCraftDisplaySkillLine.md | 19 -- wiki-information/functions/GetCraftInfo.md | 23 -- .../functions/GetCraftItemLink.md | 18 -- wiki-information/functions/GetCraftName.md | 9 - .../functions/GetCraftNumReagents.md | 13 - .../functions/GetCraftReagentInfo.md | 21 -- .../functions/GetCraftReagentItemLink.md | 19 -- .../functions/GetCraftRecipeLink.md | 17 -- .../functions/GetCraftSkillLine.md | 16 -- .../functions/GetCraftSpellFocus.md | 13 - wiki-information/functions/GetCritChance.md | 16 -- wiki-information/functions/GetCurrencyInfo.md | 35 --- wiki-information/functions/GetCurrencyLink.md | 18 -- .../functions/GetCurrencyListInfo.md | 41 ---- .../functions/GetCurrencyListSize.md | 13 - .../functions/GetCurrentBindingSet.md | 16 -- .../GetCurrentCombatTextEventInfo.md | 11 - .../functions/GetCurrentEventID.md | 9 - .../functions/GetCurrentGraphicsAPI.md | 12 - .../functions/GetCurrentRegion.md | 38 --- .../functions/GetCurrentRegionName.md | 15 -- .../functions/GetCurrentResolution.md | 21 -- wiki-information/functions/GetCurrentTitle.md | 9 - wiki-information/functions/GetCursorDelta.md | 15 -- wiki-information/functions/GetCursorInfo.md | 49 ---- wiki-information/functions/GetCursorMoney.md | 9 - .../functions/GetCursorPosition.md | 29 --- .../functions/GetDeathRecapLink.md | 17 -- .../functions/GetDefaultLanguage.md | 15 -- wiki-information/functions/GetDefaultScale.md | 18 -- .../functions/GetDetailedItemLevelInfo.md | 30 --- .../functions/GetDifficultyInfo.md | 37 --- wiki-information/functions/GetDodgeChance.md | 16 -- .../functions/GetDodgeChanceFromAttribute.md | 9 - .../functions/GetDownloadedPercentage.md | 9 - .../functions/GetDungeonDifficultyID.md | 15 -- .../functions/GetEditBoxMetatable.md | 12 - wiki-information/functions/GetEventTime.md | 19 -- .../functions/GetExpansionDisplayInfo.md | 64 ----- .../functions/GetExpansionLevel.md | 53 ---- .../functions/GetExpansionTrialInfo.md | 11 - wiki-information/functions/GetExpertise.md | 19 -- .../functions/GetExpertisePercent.md | 14 -- wiki-information/functions/GetFactionInfo.md | 104 -------- .../functions/GetFactionInfoByID.md | 103 -------- .../functions/GetFileIDFromPath.md | 27 --- .../functions/GetFileStreamingStatus.md | 9 - .../functions/GetFirstBagBankSlotIndex.md | 12 - .../functions/GetFirstTradeSkill.md | 12 - wiki-information/functions/GetFontInfo.md | 52 ---- .../functions/GetFontStringMetatable.md | 12 - wiki-information/functions/GetFonts.md | 16 -- .../functions/GetFrameCPUUsage.md | 24 -- .../functions/GetFrameMetatable.md | 12 - wiki-information/functions/GetFramerate.md | 20 -- .../functions/GetFramesRegisteredForEvent.md | 35 --- .../functions/GetFunctionCPUUsage.md | 20 -- wiki-information/functions/GetGameTime.md | 44 ---- wiki-information/functions/GetGlyphLink.md | 31 --- .../functions/GetGlyphSocketInfo.md | 23 -- .../functions/GetGossipActiveQuests.md | 30 --- .../functions/GetGossipAvailableQuests.md | 33 --- .../functions/GetGossipOptions.md | 14 -- wiki-information/functions/GetGossipText.md | 18 -- wiki-information/functions/GetGraphicsAPIs.md | 24 -- .../functions/GetGuildBankItemInfo.md | 23 -- .../functions/GetGuildBankItemLink.md | 15 -- .../functions/GetGuildBankMoney.md | 21 -- .../functions/GetGuildBankTabInfo.md | 28 --- .../functions/GetGuildBankTabPermissions.md | 37 --- .../functions/GetGuildBankTransaction.md | 33 --- .../GetGuildBankWithdrawGoldLimit.md | 33 --- .../functions/GetGuildBankWithdrawMoney.md | 12 - wiki-information/functions/GetGuildInfo.md | 36 --- .../functions/GetGuildRosterInfo.md | 58 ----- .../functions/GetGuildRosterLastOnline.md | 39 --- .../functions/GetGuildRosterMOTD.md | 9 - .../functions/GetGuildRosterShowOffline.md | 9 - .../functions/GetGuildTabardFiles.md | 19 -- wiki-information/functions/GetHaste.md | 17 -- wiki-information/functions/GetHitModifier.md | 18 -- .../functions/GetHomePartyInfo.md | 13 - .../functions/GetInboxHeaderInfo.md | 41 ---- .../functions/GetInboxInvoiceInfo.md | 28 --- wiki-information/functions/GetInboxItem.md | 54 ----- .../functions/GetInboxItemLink.md | 36 --- .../functions/GetInboxNumItems.md | 17 -- .../functions/GetInspectArenaData.md | 25 -- .../functions/GetInspectHonorData.md | 22 -- .../functions/GetInspectPVPRankProgress.md | 13 - .../functions/GetInstanceBootTimeRemaining.md | 9 - wiki-information/functions/GetInstanceInfo.md | 30 --- .../functions/GetInstanceLockTimeRemaining.md | 23 -- .../GetInstanceLockTimeRemainingEncounter.md | 21 -- .../functions/GetInventoryAlertStatus.md | 27 --- .../functions/GetInventoryItemBroken.md | 15 -- .../functions/GetInventoryItemCooldown.md | 19 -- .../functions/GetInventoryItemCount.md | 30 --- .../functions/GetInventoryItemDurability.md | 19 -- .../functions/GetInventoryItemGems.md | 13 - .../functions/GetInventoryItemID.md | 29 --- .../functions/GetInventoryItemLink.md | 24 -- .../functions/GetInventoryItemQuality.md | 15 -- .../functions/GetInventoryItemTexture.md | 15 -- .../functions/GetInventoryItemsForSlot.md | 72 ------ .../functions/GetInventorySlotInfo.md | 31 --- .../functions/GetInviteConfirmationInfo.md | 38 --- .../functions/GetInviteReferralInfo.md | 36 --- .../functions/GetItemClassInfo.md | 29 --- wiki-information/functions/GetItemCooldown.md | 54 ----- wiki-information/functions/GetItemCount.md | 36 --- wiki-information/functions/GetItemFamily.md | 90 ------- wiki-information/functions/GetItemGem.md | 27 --- wiki-information/functions/GetItemIcon.md | 16 -- wiki-information/functions/GetItemInfo.md | 86 ------- .../functions/GetItemInfoInstant.md | 45 ---- .../functions/GetItemQualityColor.md | 49 ---- wiki-information/functions/GetItemSpecInfo.md | 23 -- wiki-information/functions/GetItemSpell.md | 25 -- wiki-information/functions/GetItemStats.md | 43 ---- .../functions/GetItemSubClassInfo.md | 50 ---- .../functions/GetLFGBootProposal.md | 32 --- .../functions/GetLFGDeserterExpiration.md | 27 --- .../functions/GetLFGDungeonEncounterInfo.md | 31 --- .../functions/GetLFGDungeonInfo.md | 63 ----- .../functions/GetLFGDungeonNumEncounters.md | 20 -- .../GetLFGDungeonRewardCapBarInfo.md | 32 --- wiki-information/functions/GetLFGRoles.md | 15 -- .../functions/GetLanguageByIndex.md | 74 ------ .../functions/GetLatestThreeSenders.md | 9 - wiki-information/functions/GetLocale.md | 35 --- wiki-information/functions/GetLootInfo.md | 30 --- wiki-information/functions/GetLootMethod.md | 13 - .../functions/GetLootRollItemInfo.md | 48 ---- .../functions/GetLootRollItemLink.md | 19 -- wiki-information/functions/GetLootSlotInfo.md | 38 --- wiki-information/functions/GetLootSlotLink.md | 29 --- wiki-information/functions/GetLootSlotType.md | 34 --- .../functions/GetLootSourceInfo.md | 37 --- .../functions/GetLootThreshold.md | 15 -- wiki-information/functions/GetMacroBody.md | 25 -- .../functions/GetMacroIndexByName.md | 19 -- wiki-information/functions/GetMacroInfo.md | 17 -- wiki-information/functions/GetMacroSpell.md | 33 --- wiki-information/functions/GetManaRegen.md | 14 -- .../functions/GetMasterLootCandidate.md | 22 -- .../functions/GetMaxBattlefieldID.md | 12 - .../functions/GetMaxLevelForExpansionLevel.md | 44 ---- .../functions/GetMaximumExpansionLevel.md | 35 --- wiki-information/functions/GetMeleeHaste.md | 17 -- .../functions/GetMerchantItemCostInfo.md | 20 -- .../functions/GetMerchantItemCostItem.md | 24 -- .../functions/GetMerchantItemID.md | 19 -- .../functions/GetMerchantItemInfo.md | 46 ---- .../functions/GetMerchantItemLink.md | 19 -- .../functions/GetMerchantItemMaxStack.md | 13 - .../functions/GetMerchantNumItems.md | 12 - .../functions/GetMinimapZoneText.md | 16 -- .../functions/GetMinimumExpansionLevel.md | 50 ---- .../functions/GetMirrorTimerInfo.md | 32 --- .../functions/GetMirrorTimerProgress.md | 16 -- .../functions/GetModifiedClick.md | 35 --- wiki-information/functions/GetMoney.md | 50 ---- .../functions/GetMouseButtonClicked.md | 13 - wiki-information/functions/GetMouseFocus.md | 18 -- .../functions/GetMultiCastTotemSpells.md | 50 ---- wiki-information/functions/GetNetStats.md | 26 -- .../functions/GetNextAchievement.md | 13 - .../functions/GetNextStableSlotCost.md | 9 - .../functions/GetNormalizedRealmName.md | 37 --- .../functions/GetNumActiveQuests.md | 15 -- wiki-information/functions/GetNumAddOns.md | 23 -- .../functions/GetNumAuctionItems.md | 32 --- .../functions/GetNumAvailableQuests.md | 15 -- wiki-information/functions/GetNumBankSlots.md | 14 -- .../functions/GetNumBattlefieldStats.md | 9 - .../functions/GetNumBattlefields.md | 15 -- .../functions/GetNumBattlegroundTypes.md | 12 - wiki-information/functions/GetNumBindings.md | 9 - .../functions/GetNumBuybackItems.md | 12 - wiki-information/functions/GetNumClasses.md | 12 - .../functions/GetNumCompanions.md | 20 -- .../GetNumComparisonCompletedAchievements.md | 25 -- .../functions/GetNumCompletedAchievements.md | 18 -- wiki-information/functions/GetNumCrafts.md | 18 -- .../functions/GetNumDeclensionSets.md | 20 -- .../functions/GetNumExpansions.md | 9 - wiki-information/functions/GetNumFactions.md | 9 - .../functions/GetNumFlexRaidDungeons.md | 15 -- wiki-information/functions/GetNumFrames.md | 12 - .../functions/GetNumGlyphSockets.md | 13 - .../functions/GetNumGossipActiveQuests.md | 16 -- .../functions/GetNumGossipAvailableQuests.md | 16 -- .../functions/GetNumGossipOptions.md | 16 -- .../functions/GetNumGroupMembers.md | 26 -- .../functions/GetNumGuildMembers.md | 40 --- wiki-information/functions/GetNumLanguages.md | 20 -- wiki-information/functions/GetNumLootItems.md | 9 - wiki-information/functions/GetNumMacros.md | 11 - .../functions/GetNumPetitionNames.md | 9 - .../functions/GetNumQuestChoices.md | 14 -- .../functions/GetNumQuestItems.md | 9 - .../functions/GetNumQuestLeaderBoards.md | 16 -- .../functions/GetNumQuestLogChoices.md | 15 -- .../functions/GetNumQuestLogEntries.md | 24 -- .../functions/GetNumQuestLogRewards.md | 12 - .../functions/GetNumQuestRewards.md | 14 -- .../functions/GetNumQuestWatches.md | 9 - .../functions/GetNumRewardCurrencies.md | 15 -- .../functions/GetNumSavedInstances.md | 18 -- .../functions/GetNumSkillLines.md | 28 --- wiki-information/functions/GetNumSockets.md | 22 -- wiki-information/functions/GetNumSpellTabs.md | 12 - .../functions/GetNumStableSlots.md | 9 - .../functions/GetNumSubgroupMembers.md | 26 -- .../functions/GetNumTalentGroups.md | 19 -- .../functions/GetNumTalentTabs.md | 13 - wiki-information/functions/GetNumTalents.md | 17 -- wiki-information/functions/GetNumTitles.md | 9 - .../functions/GetNumTrackedAchievements.md | 20 -- .../functions/GetNumTradeSkills.md | 15 -- wiki-information/functions/GetOSLocale.md | 25 -- .../functions/GetObjectIconTextureCoords.md | 22 -- wiki-information/functions/GetOptOutOfLoot.md | 12 - .../functions/GetOwnerAuctionItems.md | 12 - wiki-information/functions/GetPVPDesired.md | 9 - .../functions/GetPVPLastWeekStats.md | 15 -- .../functions/GetPVPLifetimeStats.md | 19 -- wiki-information/functions/GetPVPRankInfo.md | 41 ---- .../functions/GetPVPRankProgress.md | 9 - wiki-information/functions/GetPVPRoles.md | 17 -- .../functions/GetPVPSessionStats.md | 21 -- .../functions/GetPVPThisWeekStats.md | 11 - wiki-information/functions/GetPVPTimer.md | 29 --- .../functions/GetPVPYesterdayStats.md | 11 - wiki-information/functions/GetParryChance.md | 16 -- .../functions/GetParryChanceFromAttribute.md | 9 - .../functions/GetPartyAssignment.md | 31 --- .../functions/GetPersonalRatedInfo.md | 36 --- .../functions/GetPetActionCooldown.md | 32 --- .../functions/GetPetActionInfo.md | 32 --- .../functions/GetPetActionSlotUsable.md | 13 - .../functions/GetPetExperience.md | 21 -- wiki-information/functions/GetPetFoodTypes.md | 29 --- wiki-information/functions/GetPetHappiness.md | 33 --- wiki-information/functions/GetPetLoyalty.md | 9 - .../functions/GetPetSpellBonusDamage.md | 9 - .../functions/GetPetTrainingPoints.md | 11 - wiki-information/functions/GetPetitionInfo.md | 24 -- .../functions/GetPhysicalScreenSize.md | 11 - wiki-information/functions/GetPlayerFacing.md | 12 - .../functions/GetPlayerInfoByGUID.md | 36 --- wiki-information/functions/GetPossessInfo.md | 24 -- .../functions/GetPreviousAchievement.md | 13 - .../functions/GetProfessionInfo.md | 34 --- .../functions/GetQuestBackgroundMaterial.md | 12 - .../functions/GetQuestCurrencyInfo.md | 48 ---- .../functions/GetQuestFactionGroup.md | 20 -- .../functions/GetQuestGreenRange.md | 13 - wiki-information/functions/GetQuestID.md | 16 -- .../functions/GetQuestIndexForTimer.md | 13 - .../functions/GetQuestIndexForWatch.md | 16 -- .../functions/GetQuestItemInfo.md | 45 ---- .../functions/GetQuestItemLink.md | 29 --- wiki-information/functions/GetQuestLink.md | 14 -- .../functions/GetQuestLogGroupNum.md | 9 - .../functions/GetQuestLogIndexByID.md | 21 -- .../functions/GetQuestLogItemLink.md | 23 -- .../functions/GetQuestLogLeaderBoard.md | 39 --- .../functions/GetQuestLogPushable.md | 32 --- .../functions/GetQuestLogQuestText.md | 15 -- .../functions/GetQuestLogRequiredMoney.md | 19 -- .../GetQuestLogRewardCurrencyInfo.md | 53 ---- .../functions/GetQuestLogRewardInfo.md | 31 --- .../functions/GetQuestLogRewardMoney.md | 17 -- .../functions/GetQuestLogRewardSpell.md | 34 --- .../GetQuestLogSpecialItemCooldown.md | 17 -- .../functions/GetQuestLogSpecialItemInfo.md | 19 -- .../functions/GetQuestLogTimeLeft.md | 9 - .../functions/GetQuestLogTitle.md | 61 ----- .../functions/GetQuestResetTime.md | 30 --- wiki-information/functions/GetQuestReward.md | 12 - .../functions/GetQuestSortIndex.md | 17 -- wiki-information/functions/GetQuestTagInfo.md | 52 ---- wiki-information/functions/GetQuestTimers.md | 37 --- .../functions/GetQuestsCompleted.md | 63 ----- .../functions/GetRFDungeonInfo.md | 70 ------ .../functions/GetRaidDifficultyID.md | 16 -- .../functions/GetRaidRosterInfo.md | 40 --- .../functions/GetRaidTargetIndex.md | 42 ---- .../functions/GetRangedCritChance.md | 12 - wiki-information/functions/GetRangedHaste.md | 16 -- wiki-information/functions/GetRealZoneText.md | 29 --- wiki-information/functions/GetRealmID.md | 15 -- wiki-information/functions/GetRealmName.md | 37 --- .../functions/GetRepairAllCost.md | 16 -- wiki-information/functions/GetRestState.md | 31 --- .../functions/GetRestrictedAccountData.md | 16 -- wiki-information/functions/GetRewardSpell.md | 15 -- wiki-information/functions/GetRewardXP.md | 16 -- wiki-information/functions/GetRuneCooldown.md | 30 --- wiki-information/functions/GetRuneType.md | 19 -- .../functions/GetSavedInstanceChatLink.md | 34 --- .../GetSavedInstanceEncounterInfo.md | 32 --- .../functions/GetSavedInstanceInfo.md | 47 ---- .../functions/GetScenariosChoiceOrder.md | 17 -- wiki-information/functions/GetSchoolString.md | 13 - .../functions/GetScreenDPIScale.md | 9 - wiki-information/functions/GetScreenHeight.md | 21 -- .../functions/GetScreenResolutions.md | 41 ---- wiki-information/functions/GetScreenWidth.md | 15 -- .../GetSecondsUntilParentalControlsKick.md | 9 - .../functions/GetSelectedBattlefield.md | 9 - .../functions/GetSelectedSkill.md | 9 - .../functions/GetSelectedStablePet.md | 9 - wiki-information/functions/GetSendMailCOD.md | 12 - wiki-information/functions/GetSendMailItem.md | 43 ---- .../functions/GetSendMailItemLink.md | 32 --- .../functions/GetSendMailPrice.md | 9 - .../functions/GetServerExpansionLevel.md | 55 ----- wiki-information/functions/GetServerTime.md | 31 --- wiki-information/functions/GetSessionTime.md | 17 -- .../functions/GetShapeshiftForm.md | 37 --- .../functions/GetShapeshiftFormCooldown.md | 28 --- .../functions/GetShapeshiftFormID.md | 38 --- .../functions/GetShapeshiftFormInfo.md | 22 -- wiki-information/functions/GetSheathState.md | 20 -- wiki-information/functions/GetShieldBlock.md | 21 -- .../functions/GetSkillLineInfo.md | 45 ---- .../functions/GetSocketItemBoundTradeable.md | 16 -- .../functions/GetSocketItemInfo.md | 29 --- .../functions/GetSocketItemRefundable.md | 16 -- wiki-information/functions/GetSocketTypes.md | 28 --- .../functions/GetSoundEntryCount.md | 16 -- .../functions/GetSpellAutocast.md | 33 --- .../functions/GetSpellBaseCooldown.md | 21 -- .../functions/GetSpellBonusDamage.md | 20 -- .../functions/GetSpellBonusHealing.md | 9 - .../functions/GetSpellBookItemInfo.md | 65 ----- .../functions/GetSpellBookItemName.md | 85 ------- .../functions/GetSpellBookItemTexture.md | 31 --- wiki-information/functions/GetSpellCharges.md | 44 ---- .../functions/GetSpellCooldown.md | 61 ----- wiki-information/functions/GetSpellCount.md | 27 --- .../functions/GetSpellCritChance.md | 40 --- .../functions/GetSpellDescription.md | 25 -- .../functions/GetSpellHitModifier.md | 16 -- wiki-information/functions/GetSpellInfo.md | 64 ----- wiki-information/functions/GetSpellLink.md | 45 ---- .../GetSpellLossOfControlCooldown.md | 29 --- .../functions/GetSpellPenetration.md | 9 - .../functions/GetSpellPowerCost.md | 58 ----- wiki-information/functions/GetSpellTabInfo.md | 74 ------ wiki-information/functions/GetSpellTexture.md | 31 --- .../functions/GetStablePetFoodTypes.md | 22 -- .../functions/GetStablePetInfo.md | 21 -- wiki-information/functions/GetStatistic.md | 42 ---- .../functions/GetStatisticsCategoryList.md | 19 -- wiki-information/functions/GetSubZoneText.md | 19 -- .../functions/GetSuggestedGroupNum.md | 13 - .../functions/GetSummonFriendCooldown.md | 19 -- .../functions/GetSuperTrackedQuestID.md | 9 - .../functions/GetTalentGroupRole.md | 19 -- wiki-information/functions/GetTalentInfo.md | 72 ------ .../functions/GetTalentPrereqs.md | 29 --- .../functions/GetTalentTabInfo.md | 31 --- .../functions/GetTaxiBenchmarkMode.md | 9 - wiki-information/functions/GetTaxiMapID.md | 9 - wiki-information/functions/GetText.md | 30 --- .../functions/GetThreatStatusColor.md | 50 ---- wiki-information/functions/GetTickTime.md | 13 - wiki-information/functions/GetTime.md | 19 -- .../functions/GetTimePreciseSec.md | 28 --- wiki-information/functions/GetTitleName.md | 26 -- wiki-information/functions/GetTitleText.md | 12 - .../functions/GetTotalAchievementPoints.md | 9 - .../functions/GetTotemCannotDismiss.md | 13 - .../functions/GetTotemTimeLeft.md | 24 -- .../functions/GetTrackedAchievements.md | 17 -- wiki-information/functions/GetTrackingInfo.md | 40 --- .../functions/GetTrackingTexture.md | 9 - .../functions/GetTradePlayerItemInfo.md | 23 -- .../functions/GetTradeSkillDescription.md | 13 - .../functions/GetTradeSkillInfo.md | 49 ---- .../functions/GetTradeSkillInvSlotFilter.md | 11 - .../functions/GetTradeSkillItemLink.md | 27 --- .../functions/GetTradeSkillItemStats.md | 47 ---- .../functions/GetTradeSkillLine.md | 19 -- .../functions/GetTradeSkillListLink.md | 9 - .../functions/GetTradeSkillNumMade.md | 15 -- .../functions/GetTradeSkillNumReagents.md | 31 --- .../functions/GetTradeSkillReagentInfo.md | 35 --- .../functions/GetTradeSkillReagentItemLink.md | 18 -- .../functions/GetTradeSkillRecipeLink.md | 28 --- .../functions/GetTradeSkillSelectionIndex.md | 20 -- .../functions/GetTradeSkillSubClassFilter.md | 11 - .../functions/GetTradeTargetItemInfo.md | 29 --- .../functions/GetTradeskillRepeatCount.md | 12 - .../functions/GetTrainerServiceAbilityReq.md | 17 -- .../functions/GetTrainerServiceDescription.md | 20 -- .../functions/GetTrainerServiceItemLink.md | 16 -- .../functions/GetTrainerServiceLevelReq.md | 13 - .../functions/GetTrainerServiceSkillLine.md | 13 - .../functions/GetTrainerServiceSkillReq.md | 31 --- .../functions/GetTrainerServiceTypeFilter.md | 16 -- wiki-information/functions/GetUICameraInfo.md | 31 --- .../functions/GetUnitHealthModifier.md | 19 -- .../functions/GetUnitMaxHealthModifier.md | 26 -- .../functions/GetUnitPowerModifier.md | 19 -- wiki-information/functions/GetUnitSpeed.md | 29 --- .../functions/GetUnspentTalentPoints.md | 27 --- .../functions/GetVehicleUIIndicator.md | 24 -- .../functions/GetVehicleUIIndicatorSeat.md | 19 -- .../functions/GetWatchedFactionInfo.md | 19 -- .../functions/GetWeaponEnchantInfo.md | 34 --- wiki-information/functions/GetWebTicket.md | 8 - wiki-information/functions/GetXPExhaustion.md | 12 - wiki-information/functions/GetZonePVPInfo.md | 39 --- wiki-information/functions/GetZoneText.md | 25 -- .../functions/GuildControlDelRank.md | 16 -- .../functions/GuildControlGetRankFlags.md | 59 ----- .../functions/GuildControlGetRankName.md | 16 -- .../functions/GuildControlSaveRank.md | 13 - .../functions/GuildControlSetRank.md | 12 - .../functions/GuildControlSetRankFlag.md | 86 ------- wiki-information/functions/GuildDemote.md | 9 - wiki-information/functions/GuildDisband.md | 9 - wiki-information/functions/GuildInvite.md | 9 - wiki-information/functions/GuildPromote.md | 9 - .../functions/GuildRosterSetOfficerNote.md | 28 --- .../functions/GuildRosterSetPublicNote.md | 22 -- wiki-information/functions/GuildSetLeader.md | 12 - wiki-information/functions/GuildSetMOTD.md | 17 -- wiki-information/functions/GuildUninvite.md | 9 - wiki-information/functions/HasAction.md | 15 -- .../functions/HasDualWieldPenalty.md | 9 - wiki-information/functions/HasFullControl.md | 9 - .../functions/HasIgnoreDualWieldWeapon.md | 9 - .../functions/HasInspectHonorData.md | 9 - wiki-information/functions/HasKey.md | 9 - .../functions/HasLFGRestrictions.md | 13 - .../functions/HasNoReleaseAura.md | 13 - wiki-information/functions/HasPetSpells.md | 14 -- wiki-information/functions/HasPetUI.md | 29 --- wiki-information/functions/HasWandEquipped.md | 8 - .../functions/InActiveBattlefield.md | 13 - wiki-information/functions/InCinematic.md | 25 -- .../functions/InCombatLockdown.md | 27 --- wiki-information/functions/InRepairMode.md | 9 - .../functions/InboxItemCanDelete.md | 18 -- .../functions/InitiateRolePoll.md | 23 -- wiki-information/functions/InitiateTrade.md | 28 --- wiki-information/functions/InviteUnit.md | 16 -- wiki-information/functions/Is64BitClient.md | 24 -- .../functions/IsAccountSecured.md | 12 - .../functions/IsAchievementEligible.md | 16 -- wiki-information/functions/IsActionInRange.md | 25 -- .../functions/IsActiveBattlefieldArena.md | 14 -- .../functions/IsAddOnLoadOnDemand.md | 23 -- wiki-information/functions/IsAddOnLoaded.md | 15 -- .../functions/IsAllowedToUserTeleport.md | 15 -- wiki-information/functions/IsAltKeyDown.md | 30 --- wiki-information/functions/IsAttackAction.md | 13 - wiki-information/functions/IsAttackSpell.md | 13 - .../functions/IsAutoRepeatAction.md | 22 -- wiki-information/functions/IsBattlePayItem.md | 15 -- .../functions/IsCemeterySelectionAvailable.md | 9 - .../functions/IsConsumableAction.md | 20 -- .../functions/IsConsumableItem.md | 13 - .../functions/IsControlKeyDown.md | 31 --- wiki-information/functions/IsCurrentAction.md | 19 -- wiki-information/functions/IsCurrentSpell.md | 14 -- wiki-information/functions/IsDebugBuild.md | 9 - wiki-information/functions/IsDualWielding.md | 9 - .../functions/IsEquippableItem.md | 36 --- .../functions/IsEquippedAction.md | 13 - wiki-information/functions/IsEquippedItem.md | 15 -- .../functions/IsEquippedItemType.md | 22 -- .../functions/IsEuropeanNumbers.md | 9 - .../functions/IsExpansionTrial.md | 15 -- .../functions/IsFactionInactive.md | 17 -- wiki-information/functions/IsFalling.md | 13 - wiki-information/functions/IsFishingLoot.md | 20 -- wiki-information/functions/IsFlyableArea.md | 16 -- wiki-information/functions/IsFlying.md | 13 - wiki-information/functions/IsGMClient.md | 9 - wiki-information/functions/IsGUIDInGroup.md | 28 --- wiki-information/functions/IsGuildLeader.md | 9 - .../functions/IsInCinematicScene.md | 25 -- wiki-information/functions/IsInGroup.md | 24 -- wiki-information/functions/IsInGuild.md | 22 -- wiki-information/functions/IsInGuildGroup.md | 12 - wiki-information/functions/IsInInstance.md | 20 -- wiki-information/functions/IsInLFGDungeon.md | 9 - wiki-information/functions/IsInRaid.md | 18 -- wiki-information/functions/IsIndoors.md | 15 -- wiki-information/functions/IsItemInRange.md | 22 -- .../functions/IsLeftAltKeyDown.md | 36 --- .../functions/IsLeftControlKeyDown.md | 45 ---- .../functions/IsLeftShiftKeyDown.md | 30 --- wiki-information/functions/IsMacClient.md | 9 - wiki-information/functions/IsMetaKeyDown.md | 9 - wiki-information/functions/IsModifiedClick.md | 36 --- .../functions/IsModifierKeyDown.md | 36 --- wiki-information/functions/IsMounted.md | 9 - .../functions/IsMouseButtonDown.md | 14 -- wiki-information/functions/IsMouselooking.md | 12 - wiki-information/functions/IsMovieLocal.md | 13 - wiki-information/functions/IsMoviePlayable.md | 26 -- wiki-information/functions/IsOnGlueScreen.md | 12 - .../functions/IsOnTournamentRealm.md | 9 - wiki-information/functions/IsOutOfBounds.md | 12 - wiki-information/functions/IsOutdoors.md | 15 -- .../functions/IsPVPTimerRunning.md | 9 - wiki-information/functions/IsPassiveSpell.md | 27 --- .../functions/IsPetAttackActive.md | 9 - .../functions/IsPlayerAttacking.md | 19 -- .../functions/IsPlayerInGuildFromGUID.md | 13 - wiki-information/functions/IsPlayerInWorld.md | 9 - wiki-information/functions/IsPlayerMoving.md | 9 - wiki-information/functions/IsPlayerSpell.md | 32 --- wiki-information/functions/IsPublicBuild.md | 9 - .../functions/IsQuestCompletable.md | 15 -- wiki-information/functions/IsQuestComplete.md | 21 -- .../functions/IsQuestHardWatched.md | 20 -- wiki-information/functions/IsQuestWatched.md | 20 -- wiki-information/functions/IsRangedWeapon.md | 9 - .../functions/IsRecognizedName.md | 51 ---- .../functions/IsReferAFriendLinked.md | 39 --- wiki-information/functions/IsResting.md | 17 -- .../functions/IsRestrictedAccount.md | 9 - .../functions/IsRightAltKeyDown.md | 45 ---- .../functions/IsRightControlKeyDown.md | 39 --- .../functions/IsRightMetaKeyDown.md | 9 - .../functions/IsRightShiftKeyDown.md | 45 ---- wiki-information/functions/IsShiftKeyDown.md | 37 --- wiki-information/functions/IsSpellInRange.md | 46 ---- wiki-information/functions/IsSpellKnown.md | 23 -- wiki-information/functions/IsStealthed.md | 16 -- wiki-information/functions/IsSubmerged.md | 17 -- wiki-information/functions/IsSwimming.md | 18 -- wiki-information/functions/IsTargetLoose.md | 9 - .../functions/IsThreatWarningEnabled.md | 15 -- wiki-information/functions/IsTitleKnown.md | 13 - .../functions/IsTrackedAchievement.md | 13 - .../functions/IsTradeskillTrainer.md | 21 -- .../functions/IsTrainerServiceLearnSpell.md | 18 -- wiki-information/functions/IsTrialAccount.md | 9 - .../functions/IsUnitOnQuestByQuestID.md | 21 -- wiki-information/functions/IsUsableAction.md | 15 -- wiki-information/functions/IsUsableSpell.md | 53 ---- .../functions/IsUsingFixedTimeStep.md | 9 - wiki-information/functions/IsUsingGamepad.md | 9 - wiki-information/functions/IsUsingMouse.md | 9 - .../functions/IsVeteranTrialAccount.md | 9 - wiki-information/functions/IsWargame.md | 9 - .../functions/IsXPUserDisabled.md | 9 - .../functions/ItemTextGetCreator.md | 12 - wiki-information/functions/ItemTextGetItem.md | 12 - .../functions/ItemTextGetMaterial.md | 13 - wiki-information/functions/ItemTextGetPage.md | 13 - wiki-information/functions/ItemTextGetText.md | 12 - .../functions/ItemTextHasNextPage.md | 12 - .../functions/ItemTextNextPage.md | 10 - .../functions/ItemTextPrevPage.md | 10 - wiki-information/functions/JoinBattlefield.md | 42 ---- .../functions/JoinChannelByName.md | 32 --- .../functions/JoinPermanentChannel.md | 33 --- wiki-information/functions/JoinSkirmish.md | 16 -- .../functions/JoinTemporaryChannel.md | 33 --- .../functions/JumpOrAscendStart.md | 8 - .../functions/KBArticle_BeginLoading.md | 31 --- .../functions/KBArticle_GetData.md | 27 --- .../functions/KBArticle_IsLoaded.md | 12 - .../functions/KBSetup_BeginLoading.md | 26 -- .../KBSetup_GetArticleHeaderCount.md | 23 -- .../functions/KBSetup_GetArticleHeaderData.md | 30 --- .../functions/KBSetup_GetCategoryCount.md | 15 -- .../functions/KBSetup_GetCategoryData.md | 18 -- .../functions/KBSetup_GetLanguageCount.md | 16 -- .../functions/KBSetup_GetLanguageData.md | 18 -- .../functions/KBSetup_GetSubCategoryCount.md | 16 -- .../functions/KBSetup_GetSubCategoryData.md | 22 -- .../functions/KBSetup_GetTotalArticleCount.md | 23 -- .../functions/KBSetup_IsLoaded.md | 23 -- .../functions/KBSystem_GetMOTD.md | 12 - .../functions/KBSystem_GetServerNotice.md | 12 - .../functions/KBSystem_GetServerStatus.md | 15 -- .../functions/KeyRingButtonIDToInvSlotID.md | 13 - wiki-information/functions/LFGTeleport.md | 18 -- wiki-information/functions/LearnTalent.md | 22 -- .../functions/LeaveChannelByName.md | 20 -- .../functions/ListChannelByName.md | 9 - wiki-information/functions/LoadAddOn.md | 81 ------- wiki-information/functions/LoadBindings.md | 18 -- wiki-information/functions/LoadURLIndex.md | 11 - wiki-information/functions/LoggingChat.md | 30 --- wiki-information/functions/LoggingCombat.md | 42 ---- wiki-information/functions/Logout.md | 10 - wiki-information/functions/LootSlot.md | 25 -- wiki-information/functions/LootSlotHasItem.md | 37 --- wiki-information/functions/MouselookStart.md | 9 - wiki-information/functions/MouselookStop.md | 9 - .../functions/MoveBackwardStart.md | 12 - .../functions/MoveBackwardStop.md | 12 - .../functions/MoveForwardStart.md | 12 - wiki-information/functions/MoveForwardStop.md | 12 - .../functions/MoveViewDownStart.md | 24 -- .../functions/MoveViewDownStop.md | 8 - wiki-information/functions/MoveViewInStart.md | 24 -- wiki-information/functions/MoveViewInStop.md | 8 - .../functions/MoveViewLeftStart.md | 24 -- .../functions/MoveViewLeftStop.md | 8 - .../functions/MoveViewOutStart.md | 24 -- wiki-information/functions/MoveViewOutStop.md | 8 - .../functions/MoveViewRightStart.md | 24 -- .../functions/MoveViewRightStop.md | 14 -- wiki-information/functions/MoveViewUpStart.md | 24 -- wiki-information/functions/MoveViewUpStop.md | 14 -- wiki-information/functions/MuteSoundFile.md | 53 ---- wiki-information/functions/NoPlayTime.md | 26 -- .../functions/NotWhileDeadError.md | 8 - wiki-information/functions/NotifyInspect.md | 17 -- wiki-information/functions/NumTaxiNodes.md | 17 -- wiki-information/functions/OfferPetition.md | 19 -- wiki-information/functions/PartialPlayTime.md | 32 --- wiki-information/functions/PetAbandon.md | 9 - .../functions/PetAggressiveMode.md | 11 - wiki-information/functions/PetAttack.md | 5 - .../functions/PetCanBeAbandoned.md | 22 -- wiki-information/functions/PetCanBeRenamed.md | 16 -- .../functions/PetDefensiveMode.md | 17 -- wiki-information/functions/PetFollow.md | 11 - wiki-information/functions/PetPassiveMode.md | 11 - wiki-information/functions/PetRename.md | 13 - wiki-information/functions/PetStopAttack.md | 11 - wiki-information/functions/PetWait.md | 14 -- wiki-information/functions/PickupAction.md | 16 -- .../functions/PickupBagFromSlot.md | 13 - wiki-information/functions/PickupCompanion.md | 19 -- .../functions/PickupContainerItem.md | 67 ----- wiki-information/functions/PickupCurrency.md | 9 - .../functions/PickupInventoryItem.md | 22 -- wiki-information/functions/PickupItem.md | 32 --- wiki-information/functions/PickupMacro.md | 21 -- .../functions/PickupMerchantItem.md | 17 -- wiki-information/functions/PickupPetAction.md | 12 - wiki-information/functions/PickupPetSpell.md | 21 -- .../functions/PickupPlayerMoney.md | 13 - wiki-information/functions/PickupSpell.md | 36 --- .../functions/PickupSpellBookItem.md | 37 --- wiki-information/functions/PickupStablePet.md | 9 - .../functions/PickupTradeMoney.md | 14 -- wiki-information/functions/PlaceAction.md | 16 -- wiki-information/functions/PlayMusic.md | 28 --- wiki-information/functions/PlaySound.md | 76 ------ wiki-information/functions/PlaySoundFile.md | 72 ------ .../functions/PlayerCanTeleport.md | 9 - .../functions/PlayerEffectiveAttackPower.md | 13 - wiki-information/functions/PlayerHasToy.md | 26 -- .../functions/PlayerIsPVPInactive.md | 19 -- wiki-information/functions/PostAuction.md | 26 -- wiki-information/functions/PreloadMovie.md | 9 - .../functions/ProcessExceptionClient.md | 13 - wiki-information/functions/PromoteToLeader.md | 24 -- .../functions/PutItemInBackpack.md | 14 -- wiki-information/functions/PutItemInBag.md | 22 -- .../functions/QueryAuctionItems.md | 52 ---- .../functions/QuestChooseRewardError.md | 8 - wiki-information/functions/QuestIsDaily.md | 18 -- .../functions/QuestLogPushQuest.md | 42 ---- .../functions/QuestPOIGetIconInfo.md | 35 --- wiki-information/functions/Quit.md | 12 - wiki-information/functions/RandomRoll.md | 21 -- wiki-information/functions/RejectProposal.md | 9 - .../functions/RemoveChatWindowChannel.md | 20 -- .../functions/RemoveChatWindowMessages.md | 15 -- .../functions/RemoveQuestWatch.md | 9 - .../functions/RemoveTrackedAchievement.md | 20 -- wiki-information/functions/RenamePetition.md | 9 - wiki-information/functions/RepairAllItems.md | 31 --- wiki-information/functions/ReplaceEnchant.md | 8 - .../functions/ReplaceGuildMaster.md | 9 - .../functions/ReplaceTradeEnchant.md | 11 - wiki-information/functions/RepopMe.md | 8 - wiki-information/functions/ReportBug.md | 9 - .../functions/ReportPlayerIsPVPAFK.md | 9 - .../functions/ReportSuggestion.md | 9 - .../functions/RequestBattlefieldScoreData.md | 8 - .../RequestBattlegroundInstanceInfo.md | 18 -- .../functions/RequestInspectHonorData.md | 18 -- .../functions/RequestInviteFromUnit.md | 9 - wiki-information/functions/RequestRaidInfo.md | 15 -- .../functions/RequestRatedInfo.md | 9 - .../functions/RequestTimePlayed.md | 8 - wiki-information/functions/ResetCursor.md | 14 -- wiki-information/functions/ResetTutorials.md | 14 -- .../functions/ResistancePercent.md | 21 -- .../functions/RespondInstanceLock.md | 9 - .../functions/ResurrectGetOfferer.md | 9 - .../functions/ResurrectHasSickness.md | 9 - .../functions/ResurrectHasTimer.md | 9 - wiki-information/functions/RetrieveCorpse.md | 9 - wiki-information/functions/RollOnLoot.md | 30 --- wiki-information/functions/RunBinding.md | 22 -- wiki-information/functions/RunMacro.md | 12 - wiki-information/functions/RunMacroText.md | 30 --- wiki-information/functions/RunScript.md | 31 --- wiki-information/functions/SaveBindings.md | 34 --- wiki-information/functions/SaveView.md | 19 -- wiki-information/functions/Screenshot.md | 19 -- .../functions/SearchLFGGetNumResults.md | 16 -- wiki-information/functions/SearchLFGJoin.md | 21 -- .../functions/SecureCmdOptionParse.md | 23 -- .../functions/SelectGossipActiveQuest.md | 12 - .../functions/SelectGossipAvailableQuest.md | 12 - .../functions/SelectGossipOption.md | 9 - .../functions/SelectQuestLogEntry.md | 13 - .../functions/SelectTrainerService.md | 12 - .../functions/SelectedRealmName.md | 12 - wiki-information/functions/SendChatMessage.md | 102 -------- wiki-information/functions/SendMail.md | 22 -- .../functions/SendSystemMessage.md | 9 - wiki-information/functions/SetAbandonQuest.md | 27 --- .../functions/SetAchievementComparisonUnit.md | 21 -- .../functions/SetActionBarToggles.md | 20 -- .../functions/SetActiveTalentGroup.md | 24 -- .../functions/SetAllowDangerousScripts.md | 9 - .../functions/SetAllowLowLevelRaid.md | 9 - .../functions/SetAutoDeclineGuildInvites.md | 19 -- .../functions/SetBattlefieldScoreFaction.md | 9 - wiki-information/functions/SetBinding.md | 46 ---- wiki-information/functions/SetBindingClick.md | 38 --- wiki-information/functions/SetBindingItem.md | 24 -- wiki-information/functions/SetBindingMacro.md | 42 ---- wiki-information/functions/SetBindingSpell.md | 39 --- .../functions/SetCemeteryPreference.md | 9 - .../functions/SetChannelPassword.md | 22 -- wiki-information/functions/SetConsoleKey.md | 15 -- .../functions/SetCurrencyBackpack.md | 15 -- .../functions/SetCurrencyUnused.md | 15 -- wiki-information/functions/SetCurrentTitle.md | 24 -- wiki-information/functions/SetCursor.md | 18 -- .../functions/SetDungeonDifficultyID.md | 20 -- .../functions/SetFactionActive.md | 13 - .../functions/SetFactionInactive.md | 13 - .../functions/SetGuildBankTabInfo.md | 16 -- .../functions/SetGuildBankTabPermissions.md | 20 -- .../functions/SetGuildBankText.md | 22 -- .../SetGuildBankWithdrawGoldLimit.md | 12 - .../functions/SetGuildInfoText.md | 9 - .../functions/SetGuildRosterShowOffline.md | 33 --- .../functions/SetInWorldUIVisibility.md | 12 - wiki-information/functions/SetLFGComment.md | 12 - .../functions/SetLegacyRaidDifficultyID.md | 11 - .../functions/SetLootThreshold.md | 34 --- wiki-information/functions/SetMacroSpell.md | 23 -- .../functions/SetModifiedClick.md | 21 -- wiki-information/functions/SetMoveEnabled.md | 5 - .../functions/SetMultiCastSpell.md | 38 --- wiki-information/functions/SetOptOutOfLoot.md | 18 -- .../functions/SetOverrideBinding.md | 34 --- .../functions/SetOverrideBindingClick.md | 38 --- .../functions/SetOverrideBindingItem.md | 27 --- .../functions/SetOverrideBindingMacro.md | 27 --- .../functions/SetOverrideBindingSpell.md | 27 --- wiki-information/functions/SetPVP.md | 13 - wiki-information/functions/SetPVPRoles.md | 18 -- .../functions/SetPendingReportPetTarget.md | 13 - .../functions/SetPendingReportTarget.md | 20 -- .../functions/SetPetStablePaperdoll.md | 15 -- .../functions/SetPortraitTexture.md | 26 -- ...SetPortraitTextureFromCreatureDisplayID.md | 11 - .../functions/SetPortraitToTexture.md | 28 --- .../functions/SetRaidDifficultyID.md | 24 -- wiki-information/functions/SetRaidTarget.md | 48 ---- .../functions/SetScreenResolution.md | 27 --- .../functions/SetSelectedBattlefield.md | 9 - .../functions/SetSelectedSkill.md | 9 - .../functions/SetSuperTrackedQuestID.md | 9 - .../functions/SetTalentGroupRole.md | 23 -- wiki-information/functions/SetTaxiMap.md | 12 - wiki-information/functions/SetTracking.md | 23 -- wiki-information/functions/SetTradeMoney.md | 19 -- .../functions/SetTradeSkillItemLevelFilter.md | 42 ---- .../functions/SetTradeSkillSubClassFilter.md | 23 -- .../functions/SetTrainerServiceTypeFilter.md | 30 --- wiki-information/functions/SetTurnEnabled.md | 5 - wiki-information/functions/SetUIVisibility.md | 9 - .../functions/SetUnitCursorTexture.md | 26 -- wiki-information/functions/SetView.md | 14 -- .../functions/SetWatchedFactionIndex.md | 12 - .../functions/SetupFullscreenScale.md | 9 - .../functions/ShiftQuestWatches.md | 12 - .../ShowBossFrameWhenUninteractable.md | 19 -- wiki-information/functions/ShowCloak.md | 18 -- wiki-information/functions/ShowHelm.md | 18 -- .../functions/ShowQuestComplete.md | 15 -- .../functions/ShowRepairCursor.md | 17 -- wiki-information/functions/ShowingCloak.md | 18 -- wiki-information/functions/ShowingHelm.md | 18 -- .../functions/SitStandOrDescendStart.md | 8 - .../functions/SortAuctionSetSort.md | 24 -- .../functions/SortQuestWatches.md | 9 - .../functions/SpellCanTargetUnit.md | 16 -- .../functions/SpellGetVisibilityInfo.md | 22 -- .../functions/SpellIsTargeting.md | 9 - .../functions/SpellStopCasting.md | 27 --- .../functions/SpellStopTargeting.md | 8 - wiki-information/functions/SpellTargetUnit.md | 21 -- .../functions/SplitContainerItem.md | 17 -- wiki-information/functions/StablePet.md | 11 - wiki-information/functions/StartAuction.md | 30 --- wiki-information/functions/StartDuel.md | 21 -- wiki-information/functions/StopMusic.md | 9 - wiki-information/functions/StopSound.md | 11 - .../functions/StopTradeSkillRepeat.md | 8 - wiki-information/functions/StrafeLeftStart.md | 12 - wiki-information/functions/StrafeLeftStop.md | 12 - .../functions/StrafeRightStart.md | 12 - wiki-information/functions/StrafeRightStop.md | 12 - wiki-information/functions/StripHyperlinks.md | 24 -- wiki-information/functions/Stuck.md | 9 - wiki-information/functions/SummonFriend.md | 19 -- .../functions/SupportsClipCursor.md | 9 - .../functions/SwapRaidSubgroup.md | 21 -- wiki-information/functions/TakeInboxItem.md | 20 -- wiki-information/functions/TakeInboxMoney.md | 22 -- wiki-information/functions/TakeTaxiNode.md | 9 - .../functions/TargetDirectionEnemy.md | 11 - .../functions/TargetDirectionFriend.md | 11 - wiki-information/functions/TargetLastEnemy.md | 5 - .../functions/TargetLastTarget.md | 8 - wiki-information/functions/TargetNearest.md | 9 - .../functions/TargetNearestEnemy.md | 13 - .../functions/TargetNearestEnemyPlayer.md | 9 - .../functions/TargetNearestFriend.md | 25 -- .../functions/TargetNearestFriendPlayer.md | 9 - .../functions/TargetNearestPartyMember.md | 9 - .../functions/TargetNearestRaidMember.md | 9 - .../functions/TargetPriorityHighlightStart.md | 9 - wiki-information/functions/TargetTotem.md | 9 - wiki-information/functions/TargetUnit.md | 11 - wiki-information/functions/TaxiGetDestX.md | 16 -- wiki-information/functions/TaxiGetDestY.md | 15 -- wiki-information/functions/TaxiGetSrcX.md | 16 -- wiki-information/functions/TaxiGetSrcY.md | 16 -- wiki-information/functions/TaxiNodeCost.md | 33 --- wiki-information/functions/TaxiNodeGetType.md | 19 -- wiki-information/functions/TaxiNodeName.md | 16 -- .../functions/TimeoutResurrect.md | 12 - wiki-information/functions/ToggleAutoRun.md | 11 - wiki-information/functions/TogglePVP.md | 9 - wiki-information/functions/ToggleRun.md | 9 - .../functions/ToggleSelfHighlight.md | 9 - wiki-information/functions/ToggleSheath.md | 9 - wiki-information/functions/TurnLeftStart.md | 12 - wiki-information/functions/TurnLeftStop.md | 12 - .../functions/TurnOrActionStart.md | 11 - .../functions/TurnOrActionStop.md | 10 - wiki-information/functions/TurnRightStart.md | 12 - wiki-information/functions/TurnRightStop.md | 12 - wiki-information/functions/UninviteUnit.md | 14 -- .../functions/UnitAffectingCombat.md | 22 -- wiki-information/functions/UnitArmor.md | 38 --- .../functions/UnitAttackBothHands.md | 19 -- wiki-information/functions/UnitAttackPower.md | 25 -- wiki-information/functions/UnitAttackSpeed.md | 15 -- wiki-information/functions/UnitAura.md | 184 -------------- wiki-information/functions/UnitBuff.md | 185 -------------- wiki-information/functions/UnitCanAssist.md | 31 --- wiki-information/functions/UnitCanAttack.md | 32 --- .../functions/UnitCanCooperate.md | 15 -- wiki-information/functions/UnitCastingInfo.md | 51 ---- wiki-information/functions/UnitChannelInfo.md | 52 ---- .../functions/UnitCharacterPoints.md | 13 - wiki-information/functions/UnitClass.md | 43 ---- wiki-information/functions/UnitClassBase.md | 43 ---- .../functions/UnitClassification.md | 26 -- .../functions/UnitControllingVehicle.md | 19 -- .../functions/UnitCreatureFamily.md | 111 --------- .../functions/UnitCreatureType.md | 49 ---- wiki-information/functions/UnitDamage.md | 28 --- wiki-information/functions/UnitDebuff.md | 184 -------------- .../functions/UnitDetailedThreatSituation.md | 75 ------ .../functions/UnitDistanceSquared.md | 22 -- .../functions/UnitEffectiveLevel.md | 19 -- wiki-information/functions/UnitExists.md | 23 -- .../functions/UnitFactionGroup.md | 31 --- wiki-information/functions/UnitFullName.md | 63 ----- wiki-information/functions/UnitGUID.md | 42 ---- .../functions/UnitGetAvailableRoles.md | 20 -- .../functions/UnitGetIncomingHeals.md | 26 -- .../functions/UnitGroupRolesAssigned.md | 13 - .../functions/UnitHPPerStamina.md | 19 -- .../functions/UnitHasIncomingResurrection.md | 16 -- .../functions/UnitHasLFGDeserter.md | 13 - .../functions/UnitHasLFGRandomCooldown.md | 16 -- .../functions/UnitHasRelicSlot.md | 19 -- .../functions/UnitHasVehiclePlayerFrameUI.md | 29 --- .../functions/UnitHasVehicleUI.md | 19 -- wiki-information/functions/UnitHealth.md | 25 -- wiki-information/functions/UnitHealthMax.md | 30 --- wiki-information/functions/UnitInAnyGroup.md | 13 - .../functions/UnitInBattleground.md | 32 --- wiki-information/functions/UnitInParty.md | 33 --- wiki-information/functions/UnitInPartyIsAI.md | 19 -- wiki-information/functions/UnitInPhase.md | 16 -- wiki-information/functions/UnitInRaid.md | 34 --- wiki-information/functions/UnitInRange.md | 18 -- wiki-information/functions/UnitInSubgroup.md | 22 -- wiki-information/functions/UnitInVehicle.md | 19 -- .../functions/UnitInVehicleControlSeat.md | 30 --- .../functions/UnitInVehicleHidesPetFrame.md | 13 - wiki-information/functions/UnitIsAFK.md | 28 --- wiki-information/functions/UnitIsCharmed.md | 13 - wiki-information/functions/UnitIsCivilian.md | 13 - wiki-information/functions/UnitIsConnected.md | 19 -- .../functions/UnitIsControlling.md | 19 -- wiki-information/functions/UnitIsCorpse.md | 19 -- wiki-information/functions/UnitIsDND.md | 21 -- wiki-information/functions/UnitIsDead.md | 20 -- .../functions/UnitIsDeadOrGhost.md | 22 -- wiki-information/functions/UnitIsEnemy.md | 21 -- .../functions/UnitIsFeignDeath.md | 18 -- wiki-information/functions/UnitIsFriend.md | 21 -- .../functions/UnitIsGameObject.md | 19 -- wiki-information/functions/UnitIsGhost.md | 20 -- .../functions/UnitIsGroupAssistant.md | 21 -- .../functions/UnitIsGroupLeader.md | 22 -- wiki-information/functions/UnitIsInMyGuild.md | 13 - .../functions/UnitIsInteractable.md | 19 -- .../functions/UnitIsOtherPlayersPet.md | 29 --- .../UnitIsOwnerOrControllerOfUnit.md | 15 -- .../functions/UnitIsPVPFreeForAll.md | 13 - .../functions/UnitIsPVPSanctuary.md | 13 - wiki-information/functions/UnitIsPlayer.md | 19 -- wiki-information/functions/UnitIsPossessed.md | 13 - .../functions/UnitIsRaidOfficer.md | 29 --- .../functions/UnitIsSameServer.md | 16 -- wiki-information/functions/UnitIsTapDenied.md | 38 --- wiki-information/functions/UnitIsTrivial.md | 17 -- .../functions/UnitIsUnconscious.md | 19 -- wiki-information/functions/UnitIsUnit.md | 26 -- wiki-information/functions/UnitLevel.md | 34 --- wiki-information/functions/UnitName.md | 63 ----- .../functions/UnitNameUnmodified.md | 63 ----- wiki-information/functions/UnitOnTaxi.md | 13 - wiki-information/functions/UnitPVPName.md | 17 -- wiki-information/functions/UnitPVPRank.md | 48 ---- .../functions/UnitPlayerControlled.md | 28 --- .../functions/UnitPlayerOrPetInParty.md | 16 -- .../functions/UnitPlayerOrPetInRaid.md | 27 --- wiki-information/functions/UnitPosition.md | 30 --- wiki-information/functions/UnitPower.md | 69 ------ .../functions/UnitPowerDisplayMod.md | 100 -------- wiki-information/functions/UnitPowerMax.md | 116 --------- wiki-information/functions/UnitPowerType.md | 70 ------ wiki-information/functions/UnitRace.md | 73 ------ .../functions/UnitRangedAttack.md | 26 -- .../functions/UnitRangedAttackPower.md | 25 -- .../functions/UnitRangedDamage.md | 37 --- wiki-information/functions/UnitReaction.md | 32 --- .../functions/UnitRealmRelationship.md | 19 -- wiki-information/functions/UnitResistance.md | 40 --- .../functions/UnitSelectionColor.md | 30 --- wiki-information/functions/UnitSetRole.md | 18 -- wiki-information/functions/UnitSex.md | 32 --- .../functions/UnitShouldDisplayName.md | 19 -- wiki-information/functions/UnitStat.md | 40 --- .../functions/UnitSwitchToVehicleSeat.md | 17 -- .../functions/UnitTargetsVehicleInRaidUI.md | 19 -- .../functions/UnitThreatPercentageOfLead.md | 25 -- .../functions/UnitThreatSituation.md | 70 ------ .../functions/UnitTrialBankedLevels.md | 17 -- wiki-information/functions/UnitTrialXP.md | 26 -- .../functions/UnitUsingVehicle.md | 13 - .../functions/UnitVehicleSeatCount.md | 19 -- .../functions/UnitVehicleSeatInfo.md | 23 -- wiki-information/functions/UnitVehicleSkin.md | 13 - wiki-information/functions/UnitXP.md | 35 --- wiki-information/functions/UnitXPMax.md | 26 -- wiki-information/functions/UnmuteSoundFile.md | 23 -- wiki-information/functions/UnstablePet.md | 9 - wiki-information/functions/UpdateWindow.md | 11 - wiki-information/functions/UseAction.md | 31 --- .../functions/UseContainerItem.md | 36 --- .../functions/UseInventoryItem.md | 22 -- wiki-information/functions/UseItemByName.md | 27 --- wiki-information/functions/UseToy.md | 19 -- wiki-information/functions/UseToyByName.md | 19 -- wiki-information/functions/addframetext.md | 13 - wiki-information/functions/debuglocals.md | 62 ----- .../functions/debugprofilestart.md | 11 - .../functions/debugprofilestop.md | 32 --- wiki-information/functions/debugstack.md | 76 ------ wiki-information/functions/forceinsecure.md | 14 -- wiki-information/functions/geterrorhandler.md | 21 -- wiki-information/functions/hooksecurefunc.md | 38 --- wiki-information/functions/issecure.md | 13 - .../functions/issecurevariable.md | 22 -- wiki-information/functions/pcallwithenv.md | 28 --- wiki-information/functions/scrub.md | 13 - wiki-information/functions/securecall.md | 23 -- .../functions/securecallfunction.md | 21 -- .../functions/secureexecuterange.md | 51 ---- wiki-information/functions/seterrorhandler.md | 21 -- 3512 files changed, 74971 deletions(-) delete mode 100644 wiki-information/events/ACHIEVEMENT_EARNED.md delete mode 100644 wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md delete mode 100644 wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md delete mode 100644 wiki-information/events/ACTIONBAR_HIDEGRID.md delete mode 100644 wiki-information/events/ACTIONBAR_PAGE_CHANGED.md delete mode 100644 wiki-information/events/ACTIONBAR_SHOWGRID.md delete mode 100644 wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md delete mode 100644 wiki-information/events/ACTIONBAR_SLOT_CHANGED.md delete mode 100644 wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md delete mode 100644 wiki-information/events/ACTIONBAR_UPDATE_STATE.md delete mode 100644 wiki-information/events/ACTIONBAR_UPDATE_USABLE.md delete mode 100644 wiki-information/events/ACTION_WILL_BIND_ITEM.md delete mode 100644 wiki-information/events/ACTIVATE_GLYPH.md delete mode 100644 wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md delete mode 100644 wiki-information/events/ADAPTER_LIST_CHANGED.md delete mode 100644 wiki-information/events/ADDONS_UNLOADING.md delete mode 100644 wiki-information/events/ADDON_ACTION_BLOCKED.md delete mode 100644 wiki-information/events/ADDON_ACTION_FORBIDDEN.md delete mode 100644 wiki-information/events/ADDON_LOADED.md delete mode 100644 wiki-information/events/ADVENTURE_MAP_CLOSE.md delete mode 100644 wiki-information/events/ADVENTURE_MAP_OPEN.md delete mode 100644 wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md delete mode 100644 wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md delete mode 100644 wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md delete mode 100644 wiki-information/events/AJ_DUNGEON_ACTION.md delete mode 100644 wiki-information/events/AJ_OPEN.md delete mode 100644 wiki-information/events/AJ_PVE_LFG_ACTION.md delete mode 100644 wiki-information/events/AJ_PVP_ACTION.md delete mode 100644 wiki-information/events/AJ_PVP_LFG_ACTION.md delete mode 100644 wiki-information/events/AJ_PVP_RBG_ACTION.md delete mode 100644 wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md delete mode 100644 wiki-information/events/AJ_QUEST_LOG_OPEN.md delete mode 100644 wiki-information/events/AJ_RAID_ACTION.md delete mode 100644 wiki-information/events/AJ_REFRESH_DISPLAY.md delete mode 100644 wiki-information/events/AJ_REWARD_DATA_RECEIVED.md delete mode 100644 wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md delete mode 100644 wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md delete mode 100644 wiki-information/events/AREA_POIS_UPDATED.md delete mode 100644 wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md delete mode 100644 wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md delete mode 100644 wiki-information/events/ARENA_COOLDOWNS_UPDATE.md delete mode 100644 wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md delete mode 100644 wiki-information/events/ARENA_OPPONENT_UPDATE.md delete mode 100644 wiki-information/events/ARENA_SEASON_WORLD_STATE.md delete mode 100644 wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md delete mode 100644 wiki-information/events/ARENA_TEAM_UPDATE.md delete mode 100644 wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md delete mode 100644 wiki-information/events/AUCTION_HOUSE_CLOSED.md delete mode 100644 wiki-information/events/AUCTION_HOUSE_DISABLED.md delete mode 100644 wiki-information/events/AUCTION_HOUSE_POST_ERROR.md delete mode 100644 wiki-information/events/AUCTION_HOUSE_POST_WARNING.md delete mode 100644 wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md delete mode 100644 wiki-information/events/AUCTION_HOUSE_SHOW.md delete mode 100644 wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md delete mode 100644 wiki-information/events/AUCTION_MULTISELL_FAILURE.md delete mode 100644 wiki-information/events/AUCTION_MULTISELL_START.md delete mode 100644 wiki-information/events/AUCTION_MULTISELL_UPDATE.md delete mode 100644 wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md delete mode 100644 wiki-information/events/AUTOFOLLOW_BEGIN.md delete mode 100644 wiki-information/events/AUTOFOLLOW_END.md delete mode 100644 wiki-information/events/AVATAR_LIST_UPDATED.md delete mode 100644 wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md delete mode 100644 wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md delete mode 100644 wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md delete mode 100644 wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md delete mode 100644 wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md delete mode 100644 wiki-information/events/AZERITE_ESSENCE_CHANGED.md delete mode 100644 wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md delete mode 100644 wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md delete mode 100644 wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md delete mode 100644 wiki-information/events/AZERITE_ESSENCE_UPDATE.md delete mode 100644 wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md delete mode 100644 wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md delete mode 100644 wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md delete mode 100644 wiki-information/events/BAG_CLOSED.md delete mode 100644 wiki-information/events/BAG_NEW_ITEMS_UPDATED.md delete mode 100644 wiki-information/events/BAG_OPEN.md delete mode 100644 wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md delete mode 100644 wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md delete mode 100644 wiki-information/events/BAG_UPDATE.md delete mode 100644 wiki-information/events/BAG_UPDATE_COOLDOWN.md delete mode 100644 wiki-information/events/BAG_UPDATE_DELAYED.md delete mode 100644 wiki-information/events/BANKFRAME_CLOSED.md delete mode 100644 wiki-information/events/BANKFRAME_OPENED.md delete mode 100644 wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md delete mode 100644 wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md delete mode 100644 wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md delete mode 100644 wiki-information/events/BARBER_SHOP_CLOSE.md delete mode 100644 wiki-information/events/BARBER_SHOP_COST_UPDATE.md delete mode 100644 wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md delete mode 100644 wiki-information/events/BARBER_SHOP_OPEN.md delete mode 100644 wiki-information/events/BARBER_SHOP_RESULT.md delete mode 100644 wiki-information/events/BATTLEFIELDS_CLOSED.md delete mode 100644 wiki-information/events/BATTLEFIELDS_SHOW.md delete mode 100644 wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md delete mode 100644 wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md delete mode 100644 wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md delete mode 100644 wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md delete mode 100644 wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md delete mode 100644 wiki-information/events/BATTLETAG_INVITE_SHOW.md delete mode 100644 wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md delete mode 100644 wiki-information/events/BEHAVIORAL_NOTIFICATION.md delete mode 100644 wiki-information/events/BIND_ENCHANT.md delete mode 100644 wiki-information/events/BLACK_MARKET_BID_RESULT.md delete mode 100644 wiki-information/events/BLACK_MARKET_CLOSE.md delete mode 100644 wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md delete mode 100644 wiki-information/events/BLACK_MARKET_OPEN.md delete mode 100644 wiki-information/events/BLACK_MARKET_OUTBID.md delete mode 100644 wiki-information/events/BLACK_MARKET_UNAVAILABLE.md delete mode 100644 wiki-information/events/BLACK_MARKET_WON.md delete mode 100644 wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md delete mode 100644 wiki-information/events/BN_BLOCK_LIST_UPDATED.md delete mode 100644 wiki-information/events/BN_CHAT_MSG_ADDON.md delete mode 100644 wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md delete mode 100644 wiki-information/events/BN_CONNECTED.md delete mode 100644 wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md delete mode 100644 wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md delete mode 100644 wiki-information/events/BN_DISCONNECTED.md delete mode 100644 wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md delete mode 100644 wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md delete mode 100644 wiki-information/events/BN_FRIEND_INFO_CHANGED.md delete mode 100644 wiki-information/events/BN_FRIEND_INVITE_ADDED.md delete mode 100644 wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md delete mode 100644 wiki-information/events/BN_FRIEND_INVITE_REMOVED.md delete mode 100644 wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md delete mode 100644 wiki-information/events/BN_INFO_CHANGED.md delete mode 100644 wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md delete mode 100644 wiki-information/events/BOSS_KILL.md delete mode 100644 wiki-information/events/CALENDAR_ACTION_PENDING.md delete mode 100644 wiki-information/events/CALENDAR_CLOSE_EVENT.md delete mode 100644 wiki-information/events/CALENDAR_EVENT_ALARM.md delete mode 100644 wiki-information/events/CALENDAR_NEW_EVENT.md delete mode 100644 wiki-information/events/CALENDAR_OPEN_EVENT.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_ERROR.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_EVENT.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md delete mode 100644 wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md delete mode 100644 wiki-information/events/CANCEL_GLYPH_CAST.md delete mode 100644 wiki-information/events/CANCEL_LOOT_ROLL.md delete mode 100644 wiki-information/events/CANCEL_SUMMON.md delete mode 100644 wiki-information/events/CAPTUREFRAMES_FAILED.md delete mode 100644 wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md delete mode 100644 wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md delete mode 100644 wiki-information/events/CHANNEL_COUNT_UPDATE.md delete mode 100644 wiki-information/events/CHANNEL_FLAGS_UPDATED.md delete mode 100644 wiki-information/events/CHANNEL_INVITE_REQUEST.md delete mode 100644 wiki-information/events/CHANNEL_LEFT.md delete mode 100644 wiki-information/events/CHANNEL_PASSWORD_REQUEST.md delete mode 100644 wiki-information/events/CHANNEL_ROSTER_UPDATE.md delete mode 100644 wiki-information/events/CHANNEL_UI_UPDATE.md delete mode 100644 wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md delete mode 100644 wiki-information/events/CHARACTER_POINTS_CHANGED.md delete mode 100644 wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md delete mode 100644 wiki-information/events/CHAT_DISABLED_CHANGED.md delete mode 100644 wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md delete mode 100644 wiki-information/events/CHAT_MSG_ACHIEVEMENT.md delete mode 100644 wiki-information/events/CHAT_MSG_ADDON.md delete mode 100644 wiki-information/events/CHAT_MSG_ADDON_LOGGED.md delete mode 100644 wiki-information/events/CHAT_MSG_AFK.md delete mode 100644 wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md delete mode 100644 wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md delete mode 100644 wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md delete mode 100644 wiki-information/events/CHAT_MSG_BN.md delete mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md delete mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md delete mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md delete mode 100644 wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md delete mode 100644 wiki-information/events/CHAT_MSG_BN_WHISPER.md delete mode 100644 wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md delete mode 100644 wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md delete mode 100644 wiki-information/events/CHAT_MSG_CHANNEL.md delete mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md delete mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md delete mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_LIST.md delete mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md delete mode 100644 wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md delete mode 100644 wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md delete mode 100644 wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md delete mode 100644 wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md delete mode 100644 wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md delete mode 100644 wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md delete mode 100644 wiki-information/events/CHAT_MSG_CURRENCY.md delete mode 100644 wiki-information/events/CHAT_MSG_DND.md delete mode 100644 wiki-information/events/CHAT_MSG_EMOTE.md delete mode 100644 wiki-information/events/CHAT_MSG_FILTERED.md delete mode 100644 wiki-information/events/CHAT_MSG_GUILD.md delete mode 100644 wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md delete mode 100644 wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md delete mode 100644 wiki-information/events/CHAT_MSG_IGNORED.md delete mode 100644 wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md delete mode 100644 wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md delete mode 100644 wiki-information/events/CHAT_MSG_LOOT.md delete mode 100644 wiki-information/events/CHAT_MSG_MONEY.md delete mode 100644 wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md delete mode 100644 wiki-information/events/CHAT_MSG_MONSTER_PARTY.md delete mode 100644 wiki-information/events/CHAT_MSG_MONSTER_SAY.md delete mode 100644 wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md delete mode 100644 wiki-information/events/CHAT_MSG_MONSTER_YELL.md delete mode 100644 wiki-information/events/CHAT_MSG_OFFICER.md delete mode 100644 wiki-information/events/CHAT_MSG_OPENING.md delete mode 100644 wiki-information/events/CHAT_MSG_PARTY.md delete mode 100644 wiki-information/events/CHAT_MSG_PARTY_LEADER.md delete mode 100644 wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md delete mode 100644 wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md delete mode 100644 wiki-information/events/CHAT_MSG_PET_INFO.md delete mode 100644 wiki-information/events/CHAT_MSG_RAID.md delete mode 100644 wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md delete mode 100644 wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md delete mode 100644 wiki-information/events/CHAT_MSG_RAID_LEADER.md delete mode 100644 wiki-information/events/CHAT_MSG_RAID_WARNING.md delete mode 100644 wiki-information/events/CHAT_MSG_RESTRICTED.md delete mode 100644 wiki-information/events/CHAT_MSG_SAY.md delete mode 100644 wiki-information/events/CHAT_MSG_SKILL.md delete mode 100644 wiki-information/events/CHAT_MSG_SYSTEM.md delete mode 100644 wiki-information/events/CHAT_MSG_TARGETICONS.md delete mode 100644 wiki-information/events/CHAT_MSG_TEXT_EMOTE.md delete mode 100644 wiki-information/events/CHAT_MSG_TRADESKILLS.md delete mode 100644 wiki-information/events/CHAT_MSG_VOICE_TEXT.md delete mode 100644 wiki-information/events/CHAT_MSG_WHISPER.md delete mode 100644 wiki-information/events/CHAT_MSG_WHISPER_INFORM.md delete mode 100644 wiki-information/events/CHAT_MSG_YELL.md delete mode 100644 wiki-information/events/CHAT_SERVER_DISCONNECTED.md delete mode 100644 wiki-information/events/CHAT_SERVER_RECONNECTED.md delete mode 100644 wiki-information/events/CINEMATIC_START.md delete mode 100644 wiki-information/events/CINEMATIC_STOP.md delete mode 100644 wiki-information/events/CLASS_TRIAL_TIMER_START.md delete mode 100644 wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md delete mode 100644 wiki-information/events/CLEAR_BOSS_EMOTES.md delete mode 100644 wiki-information/events/CLIENT_SCENE_CLOSED.md delete mode 100644 wiki-information/events/CLIENT_SCENE_OPENED.md delete mode 100644 wiki-information/events/CLOSE_INBOX_ITEM.md delete mode 100644 wiki-information/events/CLOSE_TABARD_FRAME.md delete mode 100644 wiki-information/events/CLUB_ADDED.md delete mode 100644 wiki-information/events/CLUB_ERROR.md delete mode 100644 wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md delete mode 100644 wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md delete mode 100644 wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md delete mode 100644 wiki-information/events/CLUB_MEMBER_ADDED.md delete mode 100644 wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md delete mode 100644 wiki-information/events/CLUB_MEMBER_REMOVED.md delete mode 100644 wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md delete mode 100644 wiki-information/events/CLUB_MEMBER_UPDATED.md delete mode 100644 wiki-information/events/CLUB_MESSAGE_ADDED.md delete mode 100644 wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md delete mode 100644 wiki-information/events/CLUB_MESSAGE_UPDATED.md delete mode 100644 wiki-information/events/CLUB_REMOVED.md delete mode 100644 wiki-information/events/CLUB_REMOVED_MESSAGE.md delete mode 100644 wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md delete mode 100644 wiki-information/events/CLUB_STREAMS_LOADED.md delete mode 100644 wiki-information/events/CLUB_STREAM_ADDED.md delete mode 100644 wiki-information/events/CLUB_STREAM_REMOVED.md delete mode 100644 wiki-information/events/CLUB_STREAM_SUBSCRIBED.md delete mode 100644 wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md delete mode 100644 wiki-information/events/CLUB_STREAM_UPDATED.md delete mode 100644 wiki-information/events/CLUB_TICKETS_RECEIVED.md delete mode 100644 wiki-information/events/CLUB_TICKET_CREATED.md delete mode 100644 wiki-information/events/CLUB_TICKET_RECEIVED.md delete mode 100644 wiki-information/events/CLUB_UPDATED.md delete mode 100644 wiki-information/events/COMBAT_LOG_EVENT.md delete mode 100644 wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md delete mode 100644 wiki-information/events/COMBAT_RATING_UPDATE.md delete mode 100644 wiki-information/events/COMBAT_TEXT_UPDATE.md delete mode 100644 wiki-information/events/COMMENTATOR_ENTER_WORLD.md delete mode 100644 wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md delete mode 100644 wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md delete mode 100644 wiki-information/events/COMMENTATOR_MAP_UPDATE.md delete mode 100644 wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md delete mode 100644 wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md delete mode 100644 wiki-information/events/COMMENTATOR_RESET_SETTINGS.md delete mode 100644 wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md delete mode 100644 wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md delete mode 100644 wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md delete mode 100644 wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md delete mode 100644 wiki-information/events/COMPANION_LEARNED.md delete mode 100644 wiki-information/events/COMPANION_UNLEARNED.md delete mode 100644 wiki-information/events/COMPANION_UPDATE.md delete mode 100644 wiki-information/events/CONFIRM_BEFORE_USE.md delete mode 100644 wiki-information/events/CONFIRM_BINDER.md delete mode 100644 wiki-information/events/CONFIRM_LOOT_ROLL.md delete mode 100644 wiki-information/events/CONFIRM_PET_UNLEARN.md delete mode 100644 wiki-information/events/CONFIRM_SUMMON.md delete mode 100644 wiki-information/events/CONFIRM_TALENT_WIPE.md delete mode 100644 wiki-information/events/CONFIRM_XP_LOSS.md delete mode 100644 wiki-information/events/CONSOLE_CLEAR.md delete mode 100644 wiki-information/events/CONSOLE_COLORS_CHANGED.md delete mode 100644 wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md delete mode 100644 wiki-information/events/CONSOLE_LOG.md delete mode 100644 wiki-information/events/CONSOLE_MESSAGE.md delete mode 100644 wiki-information/events/CORPSE_IN_INSTANCE.md delete mode 100644 wiki-information/events/CORPSE_IN_RANGE.md delete mode 100644 wiki-information/events/CORPSE_OUT_OF_RANGE.md delete mode 100644 wiki-information/events/CRAFT_CLOSE.md delete mode 100644 wiki-information/events/CRAFT_SHOW.md delete mode 100644 wiki-information/events/CRAFT_UPDATE.md delete mode 100644 wiki-information/events/CRITERIA_COMPLETE.md delete mode 100644 wiki-information/events/CRITERIA_EARNED.md delete mode 100644 wiki-information/events/CRITERIA_UPDATE.md delete mode 100644 wiki-information/events/CURRENCY_DISPLAY_UPDATE.md delete mode 100644 wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md delete mode 100644 wiki-information/events/CURSOR_CHANGED.md delete mode 100644 wiki-information/events/CURSOR_UPDATE.md delete mode 100644 wiki-information/events/CVAR_UPDATE.md delete mode 100644 wiki-information/events/DELETE_ITEM_CONFIRM.md delete mode 100644 wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md delete mode 100644 wiki-information/events/DISABLE_LOW_LEVEL_RAID.md delete mode 100644 wiki-information/events/DISABLE_TAXI_BENCHMARK.md delete mode 100644 wiki-information/events/DISABLE_XP_GAIN.md delete mode 100644 wiki-information/events/DISPLAY_SIZE_CHANGED.md delete mode 100644 wiki-information/events/DUEL_FINISHED.md delete mode 100644 wiki-information/events/DUEL_INBOUNDS.md delete mode 100644 wiki-information/events/DUEL_OUTOFBOUNDS.md delete mode 100644 wiki-information/events/DUEL_REQUESTED.md delete mode 100644 wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md delete mode 100644 wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md delete mode 100644 wiki-information/events/ENABLE_LOW_LEVEL_RAID.md delete mode 100644 wiki-information/events/ENABLE_TAXI_BENCHMARK.md delete mode 100644 wiki-information/events/ENABLE_XP_GAIN.md delete mode 100644 wiki-information/events/ENCOUNTER_END.md delete mode 100644 wiki-information/events/ENCOUNTER_START.md delete mode 100644 wiki-information/events/END_BOUND_TRADEABLE.md delete mode 100644 wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md delete mode 100644 wiki-information/events/ENTITLEMENT_DELIVERED.md delete mode 100644 wiki-information/events/EQUIPMENT_SETS_CHANGED.md delete mode 100644 wiki-information/events/EQUIPMENT_SWAP_FINISHED.md delete mode 100644 wiki-information/events/EQUIPMENT_SWAP_PENDING.md delete mode 100644 wiki-information/events/EQUIP_BIND_CONFIRM.md delete mode 100644 wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md delete mode 100644 wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md delete mode 100644 wiki-information/events/EXECUTE_CHAT_LINE.md delete mode 100644 wiki-information/events/FIRST_FRAME_RENDERED.md delete mode 100644 wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md delete mode 100644 wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md delete mode 100644 wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md delete mode 100644 wiki-information/events/FRIENDLIST_UPDATE.md delete mode 100644 wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md delete mode 100644 wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md delete mode 100644 wiki-information/events/GAME_PAD_CONNECTED.md delete mode 100644 wiki-information/events/GAME_PAD_DISCONNECTED.md delete mode 100644 wiki-information/events/GAME_PAD_POWER_CHANGED.md delete mode 100644 wiki-information/events/GDF_SIM_COMPLETE.md delete mode 100644 wiki-information/events/GENERIC_ERROR.md delete mode 100644 wiki-information/events/GET_ITEM_INFO_RECEIVED.md delete mode 100644 wiki-information/events/GLOBAL_MOUSE_DOWN.md delete mode 100644 wiki-information/events/GLOBAL_MOUSE_UP.md delete mode 100644 wiki-information/events/GLUE_CONSOLE_LOG.md delete mode 100644 wiki-information/events/GLUE_SCREENSHOT_FAILED.md delete mode 100644 wiki-information/events/GM_PLAYER_INFO.md delete mode 100644 wiki-information/events/GOSSIP_CLOSED.md delete mode 100644 wiki-information/events/GOSSIP_CONFIRM.md delete mode 100644 wiki-information/events/GOSSIP_CONFIRM_CANCEL.md delete mode 100644 wiki-information/events/GOSSIP_ENTER_CODE.md delete mode 100644 wiki-information/events/GOSSIP_SHOW.md delete mode 100644 wiki-information/events/GROUP_FORMED.md delete mode 100644 wiki-information/events/GROUP_INVITE_CONFIRMATION.md delete mode 100644 wiki-information/events/GROUP_JOINED.md delete mode 100644 wiki-information/events/GROUP_LEFT.md delete mode 100644 wiki-information/events/GROUP_ROSTER_UPDATE.md delete mode 100644 wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md delete mode 100644 wiki-information/events/GUILDBANKFRAME_CLOSED.md delete mode 100644 wiki-information/events/GUILDBANKFRAME_OPENED.md delete mode 100644 wiki-information/events/GUILDBANKLOG_UPDATE.md delete mode 100644 wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md delete mode 100644 wiki-information/events/GUILDBANK_TEXT_CHANGED.md delete mode 100644 wiki-information/events/GUILDBANK_UPDATE_MONEY.md delete mode 100644 wiki-information/events/GUILDBANK_UPDATE_TABS.md delete mode 100644 wiki-information/events/GUILDBANK_UPDATE_TEXT.md delete mode 100644 wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md delete mode 100644 wiki-information/events/GUILDTABARD_UPDATE.md delete mode 100644 wiki-information/events/GUILD_EVENT_LOG_UPDATE.md delete mode 100644 wiki-information/events/GUILD_INVITE_CANCEL.md delete mode 100644 wiki-information/events/GUILD_INVITE_REQUEST.md delete mode 100644 wiki-information/events/GUILD_MOTD.md delete mode 100644 wiki-information/events/GUILD_PARTY_STATE_UPDATED.md delete mode 100644 wiki-information/events/GUILD_RANKS_UPDATE.md delete mode 100644 wiki-information/events/GUILD_REGISTRAR_CLOSED.md delete mode 100644 wiki-information/events/GUILD_REGISTRAR_SHOW.md delete mode 100644 wiki-information/events/GUILD_RENAME_REQUIRED.md delete mode 100644 wiki-information/events/GUILD_ROSTER_UPDATE.md delete mode 100644 wiki-information/events/GX_RESTARTED.md delete mode 100644 wiki-information/events/HEARTHSTONE_BOUND.md delete mode 100644 wiki-information/events/HEIRLOOMS_UPDATED.md delete mode 100644 wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md delete mode 100644 wiki-information/events/HIDE_SUBTITLE.md delete mode 100644 wiki-information/events/IGNORELIST_UPDATE.md delete mode 100644 wiki-information/events/INCOMING_RESURRECT_CHANGED.md delete mode 100644 wiki-information/events/INITIAL_CLUBS_LOADED.md delete mode 100644 wiki-information/events/INITIAL_HOTFIXES_APPLIED.md delete mode 100644 wiki-information/events/INSPECT_ACHIEVEMENT_READY.md delete mode 100644 wiki-information/events/INSPECT_HONOR_UPDATE.md delete mode 100644 wiki-information/events/INSPECT_READY.md delete mode 100644 wiki-information/events/INSTANCE_BOOT_START.md delete mode 100644 wiki-information/events/INSTANCE_BOOT_STOP.md delete mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md delete mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md delete mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md delete mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md delete mode 100644 wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md delete mode 100644 wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md delete mode 100644 wiki-information/events/INSTANCE_LOCK_START.md delete mode 100644 wiki-information/events/INSTANCE_LOCK_STOP.md delete mode 100644 wiki-information/events/INSTANCE_LOCK_WARNING.md delete mode 100644 wiki-information/events/INVENTORY_SEARCH_UPDATE.md delete mode 100644 wiki-information/events/ISLAND_COMPLETED.md delete mode 100644 wiki-information/events/ITEM_DATA_LOAD_RESULT.md delete mode 100644 wiki-information/events/ITEM_LOCKED.md delete mode 100644 wiki-information/events/ITEM_LOCK_CHANGED.md delete mode 100644 wiki-information/events/ITEM_PUSH.md delete mode 100644 wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md delete mode 100644 wiki-information/events/ITEM_TEXT_BEGIN.md delete mode 100644 wiki-information/events/ITEM_TEXT_CLOSED.md delete mode 100644 wiki-information/events/ITEM_TEXT_READY.md delete mode 100644 wiki-information/events/ITEM_TEXT_TRANSLATION.md delete mode 100644 wiki-information/events/ITEM_UNLOCKED.md delete mode 100644 wiki-information/events/ITEM_UPGRADE_FAILED.md delete mode 100644 wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md delete mode 100644 wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md delete mode 100644 wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md delete mode 100644 wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md delete mode 100644 wiki-information/events/LANGUAGE_LIST_CHANGED.md delete mode 100644 wiki-information/events/LEARNED_SPELL_IN_TAB.md delete mode 100644 wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md delete mode 100644 wiki-information/events/LFG_COMPLETION_REWARD.md delete mode 100644 wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md delete mode 100644 wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md delete mode 100644 wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md delete mode 100644 wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md delete mode 100644 wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md delete mode 100644 wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md delete mode 100644 wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md delete mode 100644 wiki-information/events/LFG_LIST_SEARCH_FAILED.md delete mode 100644 wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md delete mode 100644 wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md delete mode 100644 wiki-information/events/LFG_LOCK_INFO_RECEIVED.md delete mode 100644 wiki-information/events/LFG_OFFER_CONTINUE.md delete mode 100644 wiki-information/events/LFG_OPEN_FROM_GOSSIP.md delete mode 100644 wiki-information/events/LFG_PROPOSAL_DONE.md delete mode 100644 wiki-information/events/LFG_PROPOSAL_FAILED.md delete mode 100644 wiki-information/events/LFG_PROPOSAL_SHOW.md delete mode 100644 wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md delete mode 100644 wiki-information/events/LFG_PROPOSAL_UPDATE.md delete mode 100644 wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md delete mode 100644 wiki-information/events/LFG_READY_CHECK_DECLINED.md delete mode 100644 wiki-information/events/LFG_READY_CHECK_HIDE.md delete mode 100644 wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md delete mode 100644 wiki-information/events/LFG_READY_CHECK_SHOW.md delete mode 100644 wiki-information/events/LFG_READY_CHECK_UPDATE.md delete mode 100644 wiki-information/events/LFG_ROLE_CHECK_DECLINED.md delete mode 100644 wiki-information/events/LFG_ROLE_CHECK_HIDE.md delete mode 100644 wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md delete mode 100644 wiki-information/events/LFG_ROLE_CHECK_SHOW.md delete mode 100644 wiki-information/events/LFG_ROLE_CHECK_UPDATE.md delete mode 100644 wiki-information/events/LFG_ROLE_UPDATE.md delete mode 100644 wiki-information/events/LFG_UPDATE.md delete mode 100644 wiki-information/events/LFG_UPDATE_RANDOM_INFO.md delete mode 100644 wiki-information/events/LOADING_SCREEN_DISABLED.md delete mode 100644 wiki-information/events/LOADING_SCREEN_ENABLED.md delete mode 100644 wiki-information/events/LOCALPLAYER_PET_RENAMED.md delete mode 100644 wiki-information/events/LOC_RESULT.md delete mode 100644 wiki-information/events/LOGOUT_CANCEL.md delete mode 100644 wiki-information/events/LOOT_BIND_CONFIRM.md delete mode 100644 wiki-information/events/LOOT_CLOSED.md delete mode 100644 wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md delete mode 100644 wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md delete mode 100644 wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md delete mode 100644 wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md delete mode 100644 wiki-information/events/LOOT_ITEM_AVAILABLE.md delete mode 100644 wiki-information/events/LOOT_ITEM_ROLL_WON.md delete mode 100644 wiki-information/events/LOOT_OPENED.md delete mode 100644 wiki-information/events/LOOT_READY.md delete mode 100644 wiki-information/events/LOOT_ROLLS_COMPLETE.md delete mode 100644 wiki-information/events/LOOT_SLOT_CHANGED.md delete mode 100644 wiki-information/events/LOOT_SLOT_CLEARED.md delete mode 100644 wiki-information/events/LOSS_OF_CONTROL_ADDED.md delete mode 100644 wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md delete mode 100644 wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md delete mode 100644 wiki-information/events/LOSS_OF_CONTROL_UPDATE.md delete mode 100644 wiki-information/events/LUA_WARNING.md delete mode 100644 wiki-information/events/MACRO_ACTION_BLOCKED.md delete mode 100644 wiki-information/events/MACRO_ACTION_FORBIDDEN.md delete mode 100644 wiki-information/events/MAIL_CLOSED.md delete mode 100644 wiki-information/events/MAIL_FAILED.md delete mode 100644 wiki-information/events/MAIL_INBOX_UPDATE.md delete mode 100644 wiki-information/events/MAIL_LOCK_SEND_ITEMS.md delete mode 100644 wiki-information/events/MAIL_SEND_INFO_UPDATE.md delete mode 100644 wiki-information/events/MAIL_SEND_SUCCESS.md delete mode 100644 wiki-information/events/MAIL_SHOW.md delete mode 100644 wiki-information/events/MAIL_SUCCESS.md delete mode 100644 wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md delete mode 100644 wiki-information/events/MAP_EXPLORATION_UPDATED.md delete mode 100644 wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md delete mode 100644 wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md delete mode 100644 wiki-information/events/MERCHANT_CLOSED.md delete mode 100644 wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md delete mode 100644 wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md delete mode 100644 wiki-information/events/MERCHANT_SHOW.md delete mode 100644 wiki-information/events/MERCHANT_UPDATE.md delete mode 100644 wiki-information/events/MINIMAP_PING.md delete mode 100644 wiki-information/events/MINIMAP_UPDATE_TRACKING.md delete mode 100644 wiki-information/events/MINIMAP_UPDATE_ZOOM.md delete mode 100644 wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md delete mode 100644 wiki-information/events/MIRROR_TIMER_PAUSE.md delete mode 100644 wiki-information/events/MIRROR_TIMER_START.md delete mode 100644 wiki-information/events/MIRROR_TIMER_STOP.md delete mode 100644 wiki-information/events/MODIFIER_STATE_CHANGED.md delete mode 100644 wiki-information/events/MOUNT_CURSOR_CLEAR.md delete mode 100644 wiki-information/events/MUTELIST_UPDATE.md delete mode 100644 wiki-information/events/NAME_PLATE_CREATED.md delete mode 100644 wiki-information/events/NAME_PLATE_UNIT_ADDED.md delete mode 100644 wiki-information/events/NAME_PLATE_UNIT_REMOVED.md delete mode 100644 wiki-information/events/NEW_AUCTION_UPDATE.md delete mode 100644 wiki-information/events/NEW_RECIPE_LEARNED.md delete mode 100644 wiki-information/events/NEW_TOY_ADDED.md delete mode 100644 wiki-information/events/NEW_WMO_CHUNK.md delete mode 100644 wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md delete mode 100644 wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md delete mode 100644 wiki-information/events/NOTIFY_PVP_AFK_RESULT.md delete mode 100644 wiki-information/events/OBJECT_ENTERED_AOI.md delete mode 100644 wiki-information/events/OBJECT_LEFT_AOI.md delete mode 100644 wiki-information/events/OBLITERUM_FORGE_CLOSE.md delete mode 100644 wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md delete mode 100644 wiki-information/events/OBLITERUM_FORGE_SHOW.md delete mode 100644 wiki-information/events/OPEN_MASTER_LOOT_LIST.md delete mode 100644 wiki-information/events/OPEN_REPORT_PLAYER.md delete mode 100644 wiki-information/events/OPEN_TABARD_FRAME.md delete mode 100644 wiki-information/events/PARTY_INVITE_CANCEL.md delete mode 100644 wiki-information/events/PARTY_INVITE_REQUEST.md delete mode 100644 wiki-information/events/PARTY_LEADER_CHANGED.md delete mode 100644 wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md delete mode 100644 wiki-information/events/PARTY_MEMBER_DISABLE.md delete mode 100644 wiki-information/events/PARTY_MEMBER_ENABLE.md delete mode 100644 wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md delete mode 100644 wiki-information/events/PETITION_CLOSED.md delete mode 100644 wiki-information/events/PETITION_SHOW.md delete mode 100644 wiki-information/events/PET_ATTACK_START.md delete mode 100644 wiki-information/events/PET_ATTACK_STOP.md delete mode 100644 wiki-information/events/PET_BAR_HIDEGRID.md delete mode 100644 wiki-information/events/PET_BAR_SHOWGRID.md delete mode 100644 wiki-information/events/PET_BAR_UPDATE.md delete mode 100644 wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md delete mode 100644 wiki-information/events/PET_BAR_UPDATE_USABLE.md delete mode 100644 wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md delete mode 100644 wiki-information/events/PET_BATTLE_ACTION_SELECTED.md delete mode 100644 wiki-information/events/PET_BATTLE_AURA_APPLIED.md delete mode 100644 wiki-information/events/PET_BATTLE_AURA_CANCELED.md delete mode 100644 wiki-information/events/PET_BATTLE_AURA_CHANGED.md delete mode 100644 wiki-information/events/PET_BATTLE_CAPTURED.md delete mode 100644 wiki-information/events/PET_BATTLE_CLOSE.md delete mode 100644 wiki-information/events/PET_BATTLE_FINAL_ROUND.md delete mode 100644 wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md delete mode 100644 wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md delete mode 100644 wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md delete mode 100644 wiki-information/events/PET_BATTLE_OPENING_DONE.md delete mode 100644 wiki-information/events/PET_BATTLE_OPENING_START.md delete mode 100644 wiki-information/events/PET_BATTLE_OVER.md delete mode 100644 wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md delete mode 100644 wiki-information/events/PET_BATTLE_PET_CHANGED.md delete mode 100644 wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md delete mode 100644 wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md delete mode 100644 wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md delete mode 100644 wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md delete mode 100644 wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md delete mode 100644 wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md delete mode 100644 wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md delete mode 100644 wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md delete mode 100644 wiki-information/events/PET_BATTLE_QUEUE_STATUS.md delete mode 100644 wiki-information/events/PET_BATTLE_XP_CHANGED.md delete mode 100644 wiki-information/events/PET_DISMISS_START.md delete mode 100644 wiki-information/events/PET_FORCE_NAME_DECLENSION.md delete mode 100644 wiki-information/events/PET_SPELL_POWER_UPDATE.md delete mode 100644 wiki-information/events/PET_STABLE_CLOSED.md delete mode 100644 wiki-information/events/PET_STABLE_SHOW.md delete mode 100644 wiki-information/events/PET_STABLE_UPDATE.md delete mode 100644 wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md delete mode 100644 wiki-information/events/PET_UI_CLOSE.md delete mode 100644 wiki-information/events/PET_UI_UPDATE.md delete mode 100644 wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md delete mode 100644 wiki-information/events/PLAYERBANKSLOTS_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_ALIVE.md delete mode 100644 wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md delete mode 100644 wiki-information/events/PLAYER_CAMPING.md delete mode 100644 wiki-information/events/PLAYER_CONTROL_GAINED.md delete mode 100644 wiki-information/events/PLAYER_CONTROL_LOST.md delete mode 100644 wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md delete mode 100644 wiki-information/events/PLAYER_DEAD.md delete mode 100644 wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md delete mode 100644 wiki-information/events/PLAYER_ENTERING_WORLD.md delete mode 100644 wiki-information/events/PLAYER_ENTER_COMBAT.md delete mode 100644 wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_FLAGS_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_FOCUS_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md delete mode 100644 wiki-information/events/PLAYER_GUILD_UPDATE.md delete mode 100644 wiki-information/events/PLAYER_LEAVE_COMBAT.md delete mode 100644 wiki-information/events/PLAYER_LEAVING_WORLD.md delete mode 100644 wiki-information/events/PLAYER_LEVEL_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_LEVEL_UP.md delete mode 100644 wiki-information/events/PLAYER_LOGIN.md delete mode 100644 wiki-information/events/PLAYER_LOGOUT.md delete mode 100644 wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md delete mode 100644 wiki-information/events/PLAYER_MONEY.md delete mode 100644 wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_PVP_RANK_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_QUITING.md delete mode 100644 wiki-information/events/PLAYER_REGEN_DISABLED.md delete mode 100644 wiki-information/events/PLAYER_REGEN_ENABLED.md delete mode 100644 wiki-information/events/PLAYER_REPORT_SUBMITTED.md delete mode 100644 wiki-information/events/PLAYER_ROLES_ASSIGNED.md delete mode 100644 wiki-information/events/PLAYER_SKINNED.md delete mode 100644 wiki-information/events/PLAYER_STARTED_LOOKING.md delete mode 100644 wiki-information/events/PLAYER_STARTED_MOVING.md delete mode 100644 wiki-information/events/PLAYER_STARTED_TURNING.md delete mode 100644 wiki-information/events/PLAYER_STOPPED_LOOKING.md delete mode 100644 wiki-information/events/PLAYER_STOPPED_MOVING.md delete mode 100644 wiki-information/events/PLAYER_STOPPED_TURNING.md delete mode 100644 wiki-information/events/PLAYER_TALENT_UPDATE.md delete mode 100644 wiki-information/events/PLAYER_TARGET_CHANGED.md delete mode 100644 wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md delete mode 100644 wiki-information/events/PLAYER_TOTEM_UPDATE.md delete mode 100644 wiki-information/events/PLAYER_TRADE_MONEY.md delete mode 100644 wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md delete mode 100644 wiki-information/events/PLAYER_UNGHOST.md delete mode 100644 wiki-information/events/PLAYER_UPDATE_RESTING.md delete mode 100644 wiki-information/events/PLAYER_XP_UPDATE.md delete mode 100644 wiki-information/events/PLAY_MOVIE.md delete mode 100644 wiki-information/events/PORTRAITS_UPDATED.md delete mode 100644 wiki-information/events/PVP_RATED_STATS_UPDATE.md delete mode 100644 wiki-information/events/PVP_TIMER_UPDATE.md delete mode 100644 wiki-information/events/PVP_WORLDSTATE_UPDATE.md delete mode 100644 wiki-information/events/QUEST_ACCEPTED.md delete mode 100644 wiki-information/events/QUEST_ACCEPT_CONFIRM.md delete mode 100644 wiki-information/events/QUEST_AUTOCOMPLETE.md delete mode 100644 wiki-information/events/QUEST_BOSS_EMOTE.md delete mode 100644 wiki-information/events/QUEST_COMPLETE.md delete mode 100644 wiki-information/events/QUEST_DETAIL.md delete mode 100644 wiki-information/events/QUEST_FINISHED.md delete mode 100644 wiki-information/events/QUEST_GREETING.md delete mode 100644 wiki-information/events/QUEST_ITEM_UPDATE.md delete mode 100644 wiki-information/events/QUEST_LOG_UPDATE.md delete mode 100644 wiki-information/events/QUEST_PROGRESS.md delete mode 100644 wiki-information/events/QUEST_REMOVED.md delete mode 100644 wiki-information/events/QUEST_SESSION_CREATED.md delete mode 100644 wiki-information/events/QUEST_SESSION_DESTROYED.md delete mode 100644 wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md delete mode 100644 wiki-information/events/QUEST_SESSION_JOINED.md delete mode 100644 wiki-information/events/QUEST_SESSION_LEFT.md delete mode 100644 wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md delete mode 100644 wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md delete mode 100644 wiki-information/events/QUEST_SESSION_NOTIFICATION.md delete mode 100644 wiki-information/events/QUEST_TURNED_IN.md delete mode 100644 wiki-information/events/QUEST_WATCH_LIST_CHANGED.md delete mode 100644 wiki-information/events/QUEST_WATCH_UPDATE.md delete mode 100644 wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md delete mode 100644 wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md delete mode 100644 wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md delete mode 100644 wiki-information/events/RAID_BOSS_EMOTE.md delete mode 100644 wiki-information/events/RAID_BOSS_WHISPER.md delete mode 100644 wiki-information/events/RAID_INSTANCE_WELCOME.md delete mode 100644 wiki-information/events/RAID_ROSTER_UPDATE.md delete mode 100644 wiki-information/events/RAID_TARGET_UPDATE.md delete mode 100644 wiki-information/events/RAISED_AS_GHOUL.md delete mode 100644 wiki-information/events/READY_CHECK.md delete mode 100644 wiki-information/events/READY_CHECK_CONFIRM.md delete mode 100644 wiki-information/events/READY_CHECK_FINISHED.md delete mode 100644 wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md delete mode 100644 wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md delete mode 100644 wiki-information/events/REPLACE_ENCHANT.md delete mode 100644 wiki-information/events/REPORT_PLAYER_RESULT.md delete mode 100644 wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md delete mode 100644 wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md delete mode 100644 wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md delete mode 100644 wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md delete mode 100644 wiki-information/events/RESURRECT_REQUEST.md delete mode 100644 wiki-information/events/ROLE_CHANGED_INFORM.md delete mode 100644 wiki-information/events/ROLE_POLL_BEGIN.md delete mode 100644 wiki-information/events/RUNE_POWER_UPDATE.md delete mode 100644 wiki-information/events/RUNE_TYPE_UPDATE.md delete mode 100644 wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md delete mode 100644 wiki-information/events/SCREENSHOT_FAILED.md delete mode 100644 wiki-information/events/SCREENSHOT_STARTED.md delete mode 100644 wiki-information/events/SCREENSHOT_SUCCEEDED.md delete mode 100644 wiki-information/events/SEARCH_DB_LOADED.md delete mode 100644 wiki-information/events/SECURE_TRANSFER_CANCEL.md delete mode 100644 wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md delete mode 100644 wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md delete mode 100644 wiki-information/events/SELF_RES_SPELL_CHANGED.md delete mode 100644 wiki-information/events/SEND_MAIL_COD_CHANGED.md delete mode 100644 wiki-information/events/SEND_MAIL_MONEY_CHANGED.md delete mode 100644 wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md delete mode 100644 wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md delete mode 100644 wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md delete mode 100644 wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md delete mode 100644 wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md delete mode 100644 wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md delete mode 100644 wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md delete mode 100644 wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md delete mode 100644 wiki-information/events/SKILL_LINES_CHANGED.md delete mode 100644 wiki-information/events/SOCIAL_ITEM_RECEIVED.md delete mode 100644 wiki-information/events/SOCKET_INFO_ACCEPT.md delete mode 100644 wiki-information/events/SOCKET_INFO_CLOSE.md delete mode 100644 wiki-information/events/SOCKET_INFO_FAILURE.md delete mode 100644 wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md delete mode 100644 wiki-information/events/SOCKET_INFO_SUCCESS.md delete mode 100644 wiki-information/events/SOCKET_INFO_UPDATE.md delete mode 100644 wiki-information/events/SOUNDKIT_FINISHED.md delete mode 100644 wiki-information/events/SOUND_DEVICE_UPDATE.md delete mode 100644 wiki-information/events/SPELLS_CHANGED.md delete mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md delete mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md delete mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md delete mode 100644 wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md delete mode 100644 wiki-information/events/SPELL_CONFIRMATION_PROMPT.md delete mode 100644 wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md delete mode 100644 wiki-information/events/SPELL_DATA_LOAD_RESULT.md delete mode 100644 wiki-information/events/SPELL_POWER_CHANGED.md delete mode 100644 wiki-information/events/SPELL_TEXT_UPDATE.md delete mode 100644 wiki-information/events/SPELL_UPDATE_CHARGES.md delete mode 100644 wiki-information/events/SPELL_UPDATE_COOLDOWN.md delete mode 100644 wiki-information/events/SPELL_UPDATE_ICON.md delete mode 100644 wiki-information/events/SPELL_UPDATE_USABLE.md delete mode 100644 wiki-information/events/START_AUTOREPEAT_SPELL.md delete mode 100644 wiki-information/events/START_LOOT_ROLL.md delete mode 100644 wiki-information/events/START_TIMER.md delete mode 100644 wiki-information/events/STOP_AUTOREPEAT_SPELL.md delete mode 100644 wiki-information/events/STOP_MOVIE.md delete mode 100644 wiki-information/events/STREAMING_ICON.md delete mode 100644 wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md delete mode 100644 wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md delete mode 100644 wiki-information/events/SYSMSG.md delete mode 100644 wiki-information/events/TABARD_CANSAVE_CHANGED.md delete mode 100644 wiki-information/events/TABARD_SAVE_PENDING.md delete mode 100644 wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md delete mode 100644 wiki-information/events/TASK_PROGRESS_UPDATE.md delete mode 100644 wiki-information/events/TAXIMAP_CLOSED.md delete mode 100644 wiki-information/events/TAXIMAP_OPENED.md delete mode 100644 wiki-information/events/TIME_PLAYED_MSG.md delete mode 100644 wiki-information/events/TOGGLE_CONSOLE.md delete mode 100644 wiki-information/events/TOKEN_AUCTION_SOLD.md delete mode 100644 wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md delete mode 100644 wiki-information/events/TOKEN_BUY_RESULT.md delete mode 100644 wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md delete mode 100644 wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md delete mode 100644 wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md delete mode 100644 wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md delete mode 100644 wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md delete mode 100644 wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md delete mode 100644 wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md delete mode 100644 wiki-information/events/TOKEN_REDEEM_RESULT.md delete mode 100644 wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md delete mode 100644 wiki-information/events/TOKEN_SELL_RESULT.md delete mode 100644 wiki-information/events/TOKEN_STATUS_CHANGED.md delete mode 100644 wiki-information/events/TOYS_UPDATED.md delete mode 100644 wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md delete mode 100644 wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md delete mode 100644 wiki-information/events/TRADE_ACCEPT_UPDATE.md delete mode 100644 wiki-information/events/TRADE_CLOSED.md delete mode 100644 wiki-information/events/TRADE_MONEY_CHANGED.md delete mode 100644 wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md delete mode 100644 wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md delete mode 100644 wiki-information/events/TRADE_REPLACE_ENCHANT.md delete mode 100644 wiki-information/events/TRADE_REQUEST.md delete mode 100644 wiki-information/events/TRADE_REQUEST_CANCEL.md delete mode 100644 wiki-information/events/TRADE_SHOW.md delete mode 100644 wiki-information/events/TRADE_SKILL_CLOSE.md delete mode 100644 wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md delete mode 100644 wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md delete mode 100644 wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md delete mode 100644 wiki-information/events/TRADE_SKILL_LIST_UPDATE.md delete mode 100644 wiki-information/events/TRADE_SKILL_NAME_UPDATE.md delete mode 100644 wiki-information/events/TRADE_SKILL_SHOW.md delete mode 100644 wiki-information/events/TRADE_SKILL_UPDATE.md delete mode 100644 wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md delete mode 100644 wiki-information/events/TRADE_UPDATE.md delete mode 100644 wiki-information/events/TRAINER_CLOSED.md delete mode 100644 wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md delete mode 100644 wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md delete mode 100644 wiki-information/events/TRAINER_SHOW.md delete mode 100644 wiki-information/events/TRAINER_UPDATE.md delete mode 100644 wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md delete mode 100644 wiki-information/events/TRIAL_CAP_REACHED_MONEY.md delete mode 100644 wiki-information/events/TUTORIAL_TRIGGER.md delete mode 100644 wiki-information/events/TWITTER_LINK_RESULT.md delete mode 100644 wiki-information/events/TWITTER_POST_RESULT.md delete mode 100644 wiki-information/events/TWITTER_STATUS_UPDATE.md delete mode 100644 wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md delete mode 100644 wiki-information/events/UI_SCALE_CHANGED.md delete mode 100644 wiki-information/events/UNIT_ATTACK.md delete mode 100644 wiki-information/events/UNIT_ATTACK_POWER.md delete mode 100644 wiki-information/events/UNIT_ATTACK_SPEED.md delete mode 100644 wiki-information/events/UNIT_AURA.md delete mode 100644 wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md delete mode 100644 wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md delete mode 100644 wiki-information/events/UNIT_COMBAT.md delete mode 100644 wiki-information/events/UNIT_CONNECTION.md delete mode 100644 wiki-information/events/UNIT_DAMAGE.md delete mode 100644 wiki-information/events/UNIT_DEFENSE.md delete mode 100644 wiki-information/events/UNIT_DISPLAYPOWER.md delete mode 100644 wiki-information/events/UNIT_ENTERED_VEHICLE.md delete mode 100644 wiki-information/events/UNIT_ENTERING_VEHICLE.md delete mode 100644 wiki-information/events/UNIT_EXITED_VEHICLE.md delete mode 100644 wiki-information/events/UNIT_EXITING_VEHICLE.md delete mode 100644 wiki-information/events/UNIT_FACTION.md delete mode 100644 wiki-information/events/UNIT_FLAGS.md delete mode 100644 wiki-information/events/UNIT_HAPPINESS.md delete mode 100644 wiki-information/events/UNIT_HEALTH.md delete mode 100644 wiki-information/events/UNIT_HEALTH_FREQUENT.md delete mode 100644 wiki-information/events/UNIT_HEAL_PREDICTION.md delete mode 100644 wiki-information/events/UNIT_INVENTORY_CHANGED.md delete mode 100644 wiki-information/events/UNIT_LEVEL.md delete mode 100644 wiki-information/events/UNIT_MANA.md delete mode 100644 wiki-information/events/UNIT_MAXHEALTH.md delete mode 100644 wiki-information/events/UNIT_MAXPOWER.md delete mode 100644 wiki-information/events/UNIT_MODEL_CHANGED.md delete mode 100644 wiki-information/events/UNIT_NAME_UPDATE.md delete mode 100644 wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md delete mode 100644 wiki-information/events/UNIT_PET.md delete mode 100644 wiki-information/events/UNIT_PET_EXPERIENCE.md delete mode 100644 wiki-information/events/UNIT_PET_TRAINING_POINTS.md delete mode 100644 wiki-information/events/UNIT_PHASE.md delete mode 100644 wiki-information/events/UNIT_PORTRAIT_UPDATE.md delete mode 100644 wiki-information/events/UNIT_POWER_BAR_HIDE.md delete mode 100644 wiki-information/events/UNIT_POWER_BAR_SHOW.md delete mode 100644 wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md delete mode 100644 wiki-information/events/UNIT_POWER_FREQUENT.md delete mode 100644 wiki-information/events/UNIT_POWER_UPDATE.md delete mode 100644 wiki-information/events/UNIT_QUEST_LOG_CHANGED.md delete mode 100644 wiki-information/events/UNIT_RANGEDDAMAGE.md delete mode 100644 wiki-information/events/UNIT_RANGED_ATTACK_POWER.md delete mode 100644 wiki-information/events/UNIT_RESISTANCES.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_DELAYED.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_FAILED.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_SENT.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_START.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_STOP.md delete mode 100644 wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md delete mode 100644 wiki-information/events/UNIT_SPELL_HASTE.md delete mode 100644 wiki-information/events/UNIT_STATS.md delete mode 100644 wiki-information/events/UNIT_TARGET.md delete mode 100644 wiki-information/events/UNIT_TARGETABLE_CHANGED.md delete mode 100644 wiki-information/events/UNIT_THREAT_LIST_UPDATE.md delete mode 100644 wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md delete mode 100644 wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md delete mode 100644 wiki-information/events/UPDATE_ALL_UI_WIDGETS.md delete mode 100644 wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md delete mode 100644 wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md delete mode 100644 wiki-information/events/UPDATE_BINDINGS.md delete mode 100644 wiki-information/events/UPDATE_BONUS_ACTIONBAR.md delete mode 100644 wiki-information/events/UPDATE_CHAT_COLOR.md delete mode 100644 wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md delete mode 100644 wiki-information/events/UPDATE_CHAT_WINDOWS.md delete mode 100644 wiki-information/events/UPDATE_EXHAUSTION.md delete mode 100644 wiki-information/events/UPDATE_FACTION.md delete mode 100644 wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md delete mode 100644 wiki-information/events/UPDATE_INSTANCE_INFO.md delete mode 100644 wiki-information/events/UPDATE_INVENTORY_ALERTS.md delete mode 100644 wiki-information/events/UPDATE_INVENTORY_DURABILITY.md delete mode 100644 wiki-information/events/UPDATE_LFG_LIST.md delete mode 100644 wiki-information/events/UPDATE_MACROS.md delete mode 100644 wiki-information/events/UPDATE_MASTER_LOOT_LIST.md delete mode 100644 wiki-information/events/UPDATE_MOUSEOVER_UNIT.md delete mode 100644 wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md delete mode 100644 wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md delete mode 100644 wiki-information/events/UPDATE_PENDING_MAIL.md delete mode 100644 wiki-information/events/UPDATE_POSSESS_BAR.md delete mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md delete mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_FORM.md delete mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md delete mode 100644 wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md delete mode 100644 wiki-information/events/UPDATE_STEALTH.md delete mode 100644 wiki-information/events/UPDATE_TRADESKILL_RECAST.md delete mode 100644 wiki-information/events/UPDATE_UI_WIDGET.md delete mode 100644 wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md delete mode 100644 wiki-information/events/UPDATE_WEB_TICKET.md delete mode 100644 wiki-information/events/USE_BIND_CONFIRM.md delete mode 100644 wiki-information/events/USE_GLYPH.md delete mode 100644 wiki-information/events/USE_NO_REFUND_CONFIRM.md delete mode 100644 wiki-information/events/VARIABLES_LOADED.md delete mode 100644 wiki-information/events/VEHICLE_ANGLE_SHOW.md delete mode 100644 wiki-information/events/VEHICLE_ANGLE_UPDATE.md delete mode 100644 wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md delete mode 100644 wiki-information/events/VEHICLE_POWER_SHOW.md delete mode 100644 wiki-information/events/VEHICLE_UPDATE.md delete mode 100644 wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md delete mode 100644 wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md delete mode 100644 wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md delete mode 100644 wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_ERROR.md delete mode 100644 wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_LOGIN.md delete mode 100644 wiki-information/events/VOICE_CHAT_LOGOUT.md delete mode 100644 wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md delete mode 100644 wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md delete mode 100644 wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md delete mode 100644 wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md delete mode 100644 wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md delete mode 100644 wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md delete mode 100644 wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md delete mode 100644 wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md delete mode 100644 wiki-information/events/VOID_DEPOSIT_WARNING.md delete mode 100644 wiki-information/events/VOID_STORAGE_CLOSE.md delete mode 100644 wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md delete mode 100644 wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md delete mode 100644 wiki-information/events/VOID_STORAGE_OPEN.md delete mode 100644 wiki-information/events/VOID_STORAGE_UPDATE.md delete mode 100644 wiki-information/events/VOID_TRANSFER_DONE.md delete mode 100644 wiki-information/events/VOID_TRANSFER_SUCCESS.md delete mode 100644 wiki-information/events/WARFRONT_COMPLETED.md delete mode 100644 wiki-information/events/WARGAME_REQUESTED.md delete mode 100644 wiki-information/events/WEAR_EQUIPMENT_SET.md delete mode 100644 wiki-information/events/WHO_LIST_UPDATE.md delete mode 100644 wiki-information/events/WORLD_PVP_QUEUE.md delete mode 100644 wiki-information/events/WORLD_STATE_TIMER_START.md delete mode 100644 wiki-information/events/WORLD_STATE_TIMER_STOP.md delete mode 100644 wiki-information/events/WOW_MOUSE_NOT_FOUND.md delete mode 100644 wiki-information/events/ZONE_CHANGED.md delete mode 100644 wiki-information/events/ZONE_CHANGED_INDOORS.md delete mode 100644 wiki-information/events/ZONE_CHANGED_NEW_AREA.md delete mode 100644 wiki-information/functions/AbandonQuest.md delete mode 100644 wiki-information/functions/AbandonSkill.md delete mode 100644 wiki-information/functions/AcceptArenaTeam.md delete mode 100644 wiki-information/functions/AcceptBattlefieldPort.md delete mode 100644 wiki-information/functions/AcceptDuel.md delete mode 100644 wiki-information/functions/AcceptGroup.md delete mode 100644 wiki-information/functions/AcceptGuild.md delete mode 100644 wiki-information/functions/AcceptProposal.md delete mode 100644 wiki-information/functions/AcceptQuest.md delete mode 100644 wiki-information/functions/AcceptResurrect.md delete mode 100644 wiki-information/functions/AcceptSockets.md delete mode 100644 wiki-information/functions/AcceptSpellConfirmationPrompt.md delete mode 100644 wiki-information/functions/AcceptTrade.md delete mode 100644 wiki-information/functions/AcceptXPLoss.md delete mode 100644 wiki-information/functions/ActionHasRange.md delete mode 100644 wiki-information/functions/AddChatWindowChannel.md delete mode 100644 wiki-information/functions/AddChatWindowMessages.md delete mode 100644 wiki-information/functions/AddQuestWatch.md delete mode 100644 wiki-information/functions/AddTrackedAchievement.md delete mode 100644 wiki-information/functions/AddTradeMoney.md delete mode 100644 wiki-information/functions/Ambiguate.md delete mode 100644 wiki-information/functions/AreDangerousScriptsAllowed.md delete mode 100644 wiki-information/functions/ArenaTeamDisband.md delete mode 100644 wiki-information/functions/ArenaTeamInviteByName.md delete mode 100644 wiki-information/functions/ArenaTeamLeave.md delete mode 100644 wiki-information/functions/ArenaTeamRoster.md delete mode 100644 wiki-information/functions/ArenaTeamSetLeaderByName.md delete mode 100644 wiki-information/functions/ArenaTeamUninviteByName.md delete mode 100644 wiki-information/functions/AscendStop.md delete mode 100644 wiki-information/functions/AssistUnit.md delete mode 100644 wiki-information/functions/AttackTarget.md delete mode 100644 wiki-information/functions/AutoEquipCursorItem.md delete mode 100644 wiki-information/functions/AutoStoreGuildBankItem.md delete mode 100644 wiki-information/functions/BNConnected.md delete mode 100644 wiki-information/functions/BNGetFOFInfo.md delete mode 100644 wiki-information/functions/BNGetFriendGameAccountInfo.md delete mode 100644 wiki-information/functions/BNGetFriendIndex.md delete mode 100644 wiki-information/functions/BNGetFriendInfo.md delete mode 100644 wiki-information/functions/BNGetFriendInfoByID.md delete mode 100644 wiki-information/functions/BNGetFriendInviteInfo.md delete mode 100644 wiki-information/functions/BNGetGameAccountInfo.md delete mode 100644 wiki-information/functions/BNGetGameAccountInfoByGUID.md delete mode 100644 wiki-information/functions/BNGetInfo.md delete mode 100644 wiki-information/functions/BNGetNumFriendGameAccounts.md delete mode 100644 wiki-information/functions/BNGetNumFriends.md delete mode 100644 wiki-information/functions/BNSendGameData.md delete mode 100644 wiki-information/functions/BNSendWhisper.md delete mode 100644 wiki-information/functions/BNSetAFK.md delete mode 100644 wiki-information/functions/BNSetCustomMessage.md delete mode 100644 wiki-information/functions/BNSetDND.md delete mode 100644 wiki-information/functions/BNSetFriendNote.md delete mode 100644 wiki-information/functions/BankButtonIDToInvSlotID.md delete mode 100644 wiki-information/functions/BeginTrade.md delete mode 100644 wiki-information/functions/BreakUpLargeNumbers.md delete mode 100644 wiki-information/functions/BuyGuildCharter.md delete mode 100644 wiki-information/functions/BuyMerchantItem.md delete mode 100644 wiki-information/functions/BuyStableSlot.md delete mode 100644 wiki-information/functions/BuyTrainerService.md delete mode 100644 wiki-information/functions/BuybackItem.md delete mode 100644 wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md delete mode 100644 wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md delete mode 100644 wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md delete mode 100644 wiki-information/functions/C_AchievementInfo.GetRewardItemID.md delete mode 100644 wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md delete mode 100644 wiki-information/functions/C_AchievementInfo.IsValidAchievement.md delete mode 100644 wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md delete mode 100644 wiki-information/functions/C_ActionBar.FindPetActionButtons.md delete mode 100644 wiki-information/functions/C_ActionBar.FindSpellActionButtons.md delete mode 100644 wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md delete mode 100644 wiki-information/functions/C_ActionBar.HasPetActionButtons.md delete mode 100644 wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md delete mode 100644 wiki-information/functions/C_ActionBar.HasSpellActionButtons.md delete mode 100644 wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md delete mode 100644 wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md delete mode 100644 wiki-information/functions/C_ActionBar.IsHarmfulAction.md delete mode 100644 wiki-information/functions/C_ActionBar.IsHelpfulAction.md delete mode 100644 wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md delete mode 100644 wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md delete mode 100644 wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md delete mode 100644 wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md delete mode 100644 wiki-information/functions/C_AddOns.DisableAddOn.md delete mode 100644 wiki-information/functions/C_AddOns.DisableAllAddOns.md delete mode 100644 wiki-information/functions/C_AddOns.DoesAddOnExist.md delete mode 100644 wiki-information/functions/C_AddOns.EnableAddOn.md delete mode 100644 wiki-information/functions/C_AddOns.EnableAllAddOns.md delete mode 100644 wiki-information/functions/C_AddOns.GetAddOnDependencies.md delete mode 100644 wiki-information/functions/C_AddOns.GetAddOnEnableState.md delete mode 100644 wiki-information/functions/C_AddOns.GetAddOnInfo.md delete mode 100644 wiki-information/functions/C_AddOns.GetAddOnMetadata.md delete mode 100644 wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md delete mode 100644 wiki-information/functions/C_AddOns.GetNumAddOns.md delete mode 100644 wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md delete mode 100644 wiki-information/functions/C_AddOns.IsAddOnLoadable.md delete mode 100644 wiki-information/functions/C_AddOns.IsAddOnLoaded.md delete mode 100644 wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md delete mode 100644 wiki-information/functions/C_AddOns.LoadAddOn.md delete mode 100644 wiki-information/functions/C_AddOns.SetAddonVersionCheck.md delete mode 100644 wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md delete mode 100644 wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md delete mode 100644 wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md delete mode 100644 wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md delete mode 100644 wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.ActivateEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.CanOpenUI.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.CloseForge.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetEssences.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetMilestones.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.IsAtForge.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md delete mode 100644 wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md delete mode 100644 wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md delete mode 100644 wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md delete mode 100644 wiki-information/functions/C_AzeriteItem.GetPowerLevel.md delete mode 100644 wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md delete mode 100644 wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md delete mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md delete mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md delete mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md delete mode 100644 wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md delete mode 100644 wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md delete mode 100644 wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md delete mode 100644 wiki-information/functions/C_BarberShop.Cancel.md delete mode 100644 wiki-information/functions/C_BarberShop.ClearPreviewChoices.md delete mode 100644 wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md delete mode 100644 wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md delete mode 100644 wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md delete mode 100644 wiki-information/functions/C_BarberShop.GetCurrentCost.md delete mode 100644 wiki-information/functions/C_BarberShop.GetViewingChrModel.md delete mode 100644 wiki-information/functions/C_BarberShop.HasAnyChanges.md delete mode 100644 wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md delete mode 100644 wiki-information/functions/C_BarberShop.IsViewingNativeSex.md delete mode 100644 wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md delete mode 100644 wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md delete mode 100644 wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md delete mode 100644 wiki-information/functions/C_BarberShop.ResetCameraRotation.md delete mode 100644 wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md delete mode 100644 wiki-information/functions/C_BarberShop.RotateCamera.md delete mode 100644 wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md delete mode 100644 wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md delete mode 100644 wiki-information/functions/C_BarberShop.SetCustomizationChoice.md delete mode 100644 wiki-information/functions/C_BarberShop.SetModelDressState.md delete mode 100644 wiki-information/functions/C_BarberShop.SetSelectedSex.md delete mode 100644 wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md delete mode 100644 wiki-information/functions/C_BarberShop.SetViewingChrModel.md delete mode 100644 wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md delete mode 100644 wiki-information/functions/C_BarberShop.ZoomCamera.md delete mode 100644 wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md delete mode 100644 wiki-information/functions/C_BattleNet.GetAccountInfoByID.md delete mode 100644 wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md delete mode 100644 wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md delete mode 100644 wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md delete mode 100644 wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md delete mode 100644 wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md delete mode 100644 wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md delete mode 100644 wiki-information/functions/C_CVar.GetCVar.md delete mode 100644 wiki-information/functions/C_CVar.GetCVarBitfield.md delete mode 100644 wiki-information/functions/C_CVar.GetCVarBool.md delete mode 100644 wiki-information/functions/C_CVar.GetCVarDefault.md delete mode 100644 wiki-information/functions/C_CVar.GetCVarInfo.md delete mode 100644 wiki-information/functions/C_CVar.RegisterCVar.md delete mode 100644 wiki-information/functions/C_CVar.ResetTestCVars.md delete mode 100644 wiki-information/functions/C_CVar.SetCVar.md delete mode 100644 wiki-information/functions/C_CVar.SetCVarBitfield.md delete mode 100644 wiki-information/functions/C_Calendar.AddEvent.md delete mode 100644 wiki-information/functions/C_Calendar.AreNamesReady.md delete mode 100644 wiki-information/functions/C_Calendar.CanAddEvent.md delete mode 100644 wiki-information/functions/C_Calendar.CanSendInvite.md delete mode 100644 wiki-information/functions/C_Calendar.CloseEvent.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventComplain.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventCopy.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventPaste.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventRemove.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md delete mode 100644 wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md delete mode 100644 wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md delete mode 100644 wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md delete mode 100644 wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md delete mode 100644 wiki-information/functions/C_Calendar.CreatePlayerEvent.md delete mode 100644 wiki-information/functions/C_Calendar.EventAvailable.md delete mode 100644 wiki-information/functions/C_Calendar.EventCanEdit.md delete mode 100644 wiki-information/functions/C_Calendar.EventClearAutoApprove.md delete mode 100644 wiki-information/functions/C_Calendar.EventClearLocked.md delete mode 100644 wiki-information/functions/C_Calendar.EventClearModerator.md delete mode 100644 wiki-information/functions/C_Calendar.EventDecline.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetCalendarType.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetClubId.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetInvite.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetSelectedInvite.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetStatusOptions.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetTextures.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetTypes.md delete mode 100644 wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md delete mode 100644 wiki-information/functions/C_Calendar.EventHasPendingInvite.md delete mode 100644 wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md delete mode 100644 wiki-information/functions/C_Calendar.EventInvite.md delete mode 100644 wiki-information/functions/C_Calendar.EventRemoveInvite.md delete mode 100644 wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md delete mode 100644 wiki-information/functions/C_Calendar.EventSelectInvite.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetAutoApprove.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetClubId.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetDate.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetDescription.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetInviteStatus.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetLocked.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetModerator.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetTextureID.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetTime.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetTitle.md delete mode 100644 wiki-information/functions/C_Calendar.EventSetType.md delete mode 100644 wiki-information/functions/C_Calendar.EventSignUp.md delete mode 100644 wiki-information/functions/C_Calendar.EventSortInvites.md delete mode 100644 wiki-information/functions/C_Calendar.EventTentative.md delete mode 100644 wiki-information/functions/C_Calendar.GetClubCalendarEvents.md delete mode 100644 wiki-information/functions/C_Calendar.GetDayEvent.md delete mode 100644 wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md delete mode 100644 wiki-information/functions/C_Calendar.GetEventIndex.md delete mode 100644 wiki-information/functions/C_Calendar.GetEventIndexInfo.md delete mode 100644 wiki-information/functions/C_Calendar.GetEventInfo.md delete mode 100644 wiki-information/functions/C_Calendar.GetFirstPendingInvite.md delete mode 100644 wiki-information/functions/C_Calendar.GetGuildEventInfo.md delete mode 100644 wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md delete mode 100644 wiki-information/functions/C_Calendar.GetHolidayInfo.md delete mode 100644 wiki-information/functions/C_Calendar.GetMaxCreateDate.md delete mode 100644 wiki-information/functions/C_Calendar.GetMinDate.md delete mode 100644 wiki-information/functions/C_Calendar.GetMonthInfo.md delete mode 100644 wiki-information/functions/C_Calendar.GetNextClubId.md delete mode 100644 wiki-information/functions/C_Calendar.GetNumDayEvents.md delete mode 100644 wiki-information/functions/C_Calendar.GetNumGuildEvents.md delete mode 100644 wiki-information/functions/C_Calendar.GetNumInvites.md delete mode 100644 wiki-information/functions/C_Calendar.GetNumPendingInvites.md delete mode 100644 wiki-information/functions/C_Calendar.GetRaidInfo.md delete mode 100644 wiki-information/functions/C_Calendar.IsActionPending.md delete mode 100644 wiki-information/functions/C_Calendar.IsEventOpen.md delete mode 100644 wiki-information/functions/C_Calendar.MassInviteCommunity.md delete mode 100644 wiki-information/functions/C_Calendar.MassInviteGuild.md delete mode 100644 wiki-information/functions/C_Calendar.OpenCalendar.md delete mode 100644 wiki-information/functions/C_Calendar.OpenEvent.md delete mode 100644 wiki-information/functions/C_Calendar.RemoveEvent.md delete mode 100644 wiki-information/functions/C_Calendar.SetAbsMonth.md delete mode 100644 wiki-information/functions/C_Calendar.SetMonth.md delete mode 100644 wiki-information/functions/C_Calendar.SetNextClubId.md delete mode 100644 wiki-information/functions/C_Calendar.UpdateEvent.md delete mode 100644 wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md delete mode 100644 wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md delete mode 100644 wiki-information/functions/C_ChatInfo.CanReportPlayer.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChannelShortcut.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChatLineText.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetChatTypeName.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md delete mode 100644 wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md delete mode 100644 wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md delete mode 100644 wiki-information/functions/C_ChatInfo.IsChatLineCensored.md delete mode 100644 wiki-information/functions/C_ChatInfo.IsPartyChannelType.md delete mode 100644 wiki-information/functions/C_ChatInfo.IsValidChatLine.md delete mode 100644 wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md delete mode 100644 wiki-information/functions/C_ChatInfo.ReportPlayer.md delete mode 100644 wiki-information/functions/C_ChatInfo.SendAddonMessage.md delete mode 100644 wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md delete mode 100644 wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md delete mode 100644 wiki-information/functions/C_ChatInfo.UncensorChatLine.md delete mode 100644 wiki-information/functions/C_Club.AcceptInvitation.md delete mode 100644 wiki-information/functions/C_Club.AddClubStreamChatChannel.md delete mode 100644 wiki-information/functions/C_Club.AdvanceStreamViewMarker.md delete mode 100644 wiki-information/functions/C_Club.AssignMemberRole.md delete mode 100644 wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md delete mode 100644 wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md delete mode 100644 wiki-information/functions/C_Club.ClearClubPresenceSubscription.md delete mode 100644 wiki-information/functions/C_Club.CompareBattleNetDisplayName.md delete mode 100644 wiki-information/functions/C_Club.CreateClub.md delete mode 100644 wiki-information/functions/C_Club.CreateStream.md delete mode 100644 wiki-information/functions/C_Club.CreateTicket.md delete mode 100644 wiki-information/functions/C_Club.DeclineInvitation.md delete mode 100644 wiki-information/functions/C_Club.DestroyClub.md delete mode 100644 wiki-information/functions/C_Club.DestroyMessage.md delete mode 100644 wiki-information/functions/C_Club.DestroyStream.md delete mode 100644 wiki-information/functions/C_Club.DestroyTicket.md delete mode 100644 wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md delete mode 100644 wiki-information/functions/C_Club.EditClub.md delete mode 100644 wiki-information/functions/C_Club.EditMessage.md delete mode 100644 wiki-information/functions/C_Club.EditStream.md delete mode 100644 wiki-information/functions/C_Club.Flush.md delete mode 100644 wiki-information/functions/C_Club.FocusCommunityStreams.md delete mode 100644 wiki-information/functions/C_Club.FocusStream.md delete mode 100644 wiki-information/functions/C_Club.GetAssignableRoles.md delete mode 100644 wiki-information/functions/C_Club.GetAvatarIdList.md delete mode 100644 wiki-information/functions/C_Club.GetClubInfo.md delete mode 100644 wiki-information/functions/C_Club.GetClubMembers.md delete mode 100644 wiki-information/functions/C_Club.GetClubPrivileges.md delete mode 100644 wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md delete mode 100644 wiki-information/functions/C_Club.GetCommunityNameResultText.md delete mode 100644 wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md delete mode 100644 wiki-information/functions/C_Club.GetInvitationCandidates.md delete mode 100644 wiki-information/functions/C_Club.GetInvitationInfo.md delete mode 100644 wiki-information/functions/C_Club.GetInvitationsForClub.md delete mode 100644 wiki-information/functions/C_Club.GetInvitationsForSelf.md delete mode 100644 wiki-information/functions/C_Club.GetMemberInfo.md delete mode 100644 wiki-information/functions/C_Club.GetMemberInfoForSelf.md delete mode 100644 wiki-information/functions/C_Club.GetMessageInfo.md delete mode 100644 wiki-information/functions/C_Club.GetMessageRanges.md delete mode 100644 wiki-information/functions/C_Club.GetMessagesBefore.md delete mode 100644 wiki-information/functions/C_Club.GetMessagesInRange.md delete mode 100644 wiki-information/functions/C_Club.GetStreamInfo.md delete mode 100644 wiki-information/functions/C_Club.GetStreamViewMarker.md delete mode 100644 wiki-information/functions/C_Club.GetStreams.md delete mode 100644 wiki-information/functions/C_Club.GetSubscribedClubs.md delete mode 100644 wiki-information/functions/C_Club.GetTickets.md delete mode 100644 wiki-information/functions/C_Club.IsAccountMuted.md delete mode 100644 wiki-information/functions/C_Club.IsBeginningOfStream.md delete mode 100644 wiki-information/functions/C_Club.IsEnabled.md delete mode 100644 wiki-information/functions/C_Club.IsRestricted.md delete mode 100644 wiki-information/functions/C_Club.IsSubscribedToStream.md delete mode 100644 wiki-information/functions/C_Club.KickMember.md delete mode 100644 wiki-information/functions/C_Club.LeaveClub.md delete mode 100644 wiki-information/functions/C_Club.RedeemTicket.md delete mode 100644 wiki-information/functions/C_Club.RequestInvitationsForClub.md delete mode 100644 wiki-information/functions/C_Club.RequestMoreMessagesBefore.md delete mode 100644 wiki-information/functions/C_Club.RequestTicket.md delete mode 100644 wiki-information/functions/C_Club.RequestTickets.md delete mode 100644 wiki-information/functions/C_Club.RevokeInvitation.md delete mode 100644 wiki-information/functions/C_Club.SendBattleTagFriendRequest.md delete mode 100644 wiki-information/functions/C_Club.SendInvitation.md delete mode 100644 wiki-information/functions/C_Club.SendMessage.md delete mode 100644 wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md delete mode 100644 wiki-information/functions/C_Club.SetAvatarTexture.md delete mode 100644 wiki-information/functions/C_Club.SetClubMemberNote.md delete mode 100644 wiki-information/functions/C_Club.SetClubPresenceSubscription.md delete mode 100644 wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md delete mode 100644 wiki-information/functions/C_Club.SetCommunityID.md delete mode 100644 wiki-information/functions/C_Club.SetFavorite.md delete mode 100644 wiki-information/functions/C_Club.SetSocialQueueingEnabled.md delete mode 100644 wiki-information/functions/C_Club.ShouldAllowClubType.md delete mode 100644 wiki-information/functions/C_Club.UnfocusAllStreams.md delete mode 100644 wiki-information/functions/C_Club.UnfocusStream.md delete mode 100644 wiki-information/functions/C_Club.ValidateText.md delete mode 100644 wiki-information/functions/C_Commentator.AddPlayerOverrideName.md delete mode 100644 wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md delete mode 100644 wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md delete mode 100644 wiki-information/functions/C_Commentator.AreTeamsSwapped.md delete mode 100644 wiki-information/functions/C_Commentator.AssignPlayerToTeam.md delete mode 100644 wiki-information/functions/C_Commentator.AssignPlayersToTeam.md delete mode 100644 wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md delete mode 100644 wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md delete mode 100644 wiki-information/functions/C_Commentator.ClearCameraTarget.md delete mode 100644 wiki-information/functions/C_Commentator.ClearFollowTarget.md delete mode 100644 wiki-information/functions/C_Commentator.ClearLookAtTarget.md delete mode 100644 wiki-information/functions/C_Commentator.EnterInstance.md delete mode 100644 wiki-information/functions/C_Commentator.ExitInstance.md delete mode 100644 wiki-information/functions/C_Commentator.FindSpectatedUnit.md delete mode 100644 wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md delete mode 100644 wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md delete mode 100644 wiki-information/functions/C_Commentator.FlushCommentatorHistory.md delete mode 100644 wiki-information/functions/C_Commentator.FollowPlayer.md delete mode 100644 wiki-information/functions/C_Commentator.FollowUnit.md delete mode 100644 wiki-information/functions/C_Commentator.ForceFollowTransition.md delete mode 100644 wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md delete mode 100644 wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md delete mode 100644 wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md delete mode 100644 wiki-information/functions/C_Commentator.GetCamera.md delete mode 100644 wiki-information/functions/C_Commentator.GetCameraCollision.md delete mode 100644 wiki-information/functions/C_Commentator.GetCameraPosition.md delete mode 100644 wiki-information/functions/C_Commentator.GetCommentatorHistory.md delete mode 100644 wiki-information/functions/C_Commentator.GetCurrentMapID.md delete mode 100644 wiki-information/functions/C_Commentator.GetDampeningPercent.md delete mode 100644 wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md delete mode 100644 wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md delete mode 100644 wiki-information/functions/C_Commentator.GetExcludeDistance.md delete mode 100644 wiki-information/functions/C_Commentator.GetHardlockWeight.md delete mode 100644 wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md delete mode 100644 wiki-information/functions/C_Commentator.GetIndirectSpellID.md delete mode 100644 wiki-information/functions/C_Commentator.GetInstanceInfo.md delete mode 100644 wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md delete mode 100644 wiki-information/functions/C_Commentator.GetMapInfo.md delete mode 100644 wiki-information/functions/C_Commentator.GetMatchDuration.md delete mode 100644 wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md delete mode 100644 wiki-information/functions/C_Commentator.GetMaxNumTeams.md delete mode 100644 wiki-information/functions/C_Commentator.GetMode.md delete mode 100644 wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md delete mode 100644 wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md delete mode 100644 wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md delete mode 100644 wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md delete mode 100644 wiki-information/functions/C_Commentator.GetNumMaps.md delete mode 100644 wiki-information/functions/C_Commentator.GetNumPlayers.md delete mode 100644 wiki-information/functions/C_Commentator.GetOrCreateSeries.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerData.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerOverrideName.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md delete mode 100644 wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.GetPositionLerpAmount.md delete mode 100644 wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md delete mode 100644 wiki-information/functions/C_Commentator.GetSoftlockWeight.md delete mode 100644 wiki-information/functions/C_Commentator.GetSpeedFactor.md delete mode 100644 wiki-information/functions/C_Commentator.GetStartLocation.md delete mode 100644 wiki-information/functions/C_Commentator.GetTeamColor.md delete mode 100644 wiki-information/functions/C_Commentator.GetTeamColorByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md delete mode 100644 wiki-information/functions/C_Commentator.GetTrackedSpellID.md delete mode 100644 wiki-information/functions/C_Commentator.GetTrackedSpells.md delete mode 100644 wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.GetUnitData.md delete mode 100644 wiki-information/functions/C_Commentator.GetWargameInfo.md delete mode 100644 wiki-information/functions/C_Commentator.HasTrackedAuras.md delete mode 100644 wiki-information/functions/C_Commentator.IsSmartCameraLocked.md delete mode 100644 wiki-information/functions/C_Commentator.IsSpectating.md delete mode 100644 wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md delete mode 100644 wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md delete mode 100644 wiki-information/functions/C_Commentator.IsTrackedSpell.md delete mode 100644 wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md delete mode 100644 wiki-information/functions/C_Commentator.IsUsingSmartCamera.md delete mode 100644 wiki-information/functions/C_Commentator.LookAtPlayer.md delete mode 100644 wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md delete mode 100644 wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md delete mode 100644 wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md delete mode 100644 wiki-information/functions/C_Commentator.ResetFoVTarget.md delete mode 100644 wiki-information/functions/C_Commentator.ResetSeriesScores.md delete mode 100644 wiki-information/functions/C_Commentator.ResetSettings.md delete mode 100644 wiki-information/functions/C_Commentator.ResetTrackedAuras.md delete mode 100644 wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md delete mode 100644 wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md delete mode 100644 wiki-information/functions/C_Commentator.SetBlocklistedAuras.md delete mode 100644 wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md delete mode 100644 wiki-information/functions/C_Commentator.SetCamera.md delete mode 100644 wiki-information/functions/C_Commentator.SetCameraCollision.md delete mode 100644 wiki-information/functions/C_Commentator.SetCameraPosition.md delete mode 100644 wiki-information/functions/C_Commentator.SetCheatsEnabled.md delete mode 100644 wiki-information/functions/C_Commentator.SetCommentatorHistory.md delete mode 100644 wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md delete mode 100644 wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md delete mode 100644 wiki-information/functions/C_Commentator.SetExcludeDistance.md delete mode 100644 wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md delete mode 100644 wiki-information/functions/C_Commentator.SetHardlockWeight.md delete mode 100644 wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md delete mode 100644 wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md delete mode 100644 wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md delete mode 100644 wiki-information/functions/C_Commentator.SetMouseDisabled.md delete mode 100644 wiki-information/functions/C_Commentator.SetMoveSpeed.md delete mode 100644 wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md delete mode 100644 wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md delete mode 100644 wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md delete mode 100644 wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md delete mode 100644 wiki-information/functions/C_Commentator.SetPositionLerpAmount.md delete mode 100644 wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md delete mode 100644 wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md delete mode 100644 wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md delete mode 100644 wiki-information/functions/C_Commentator.SetSeriesScore.md delete mode 100644 wiki-information/functions/C_Commentator.SetSeriesScores.md delete mode 100644 wiki-information/functions/C_Commentator.SetSmartCameraLocked.md delete mode 100644 wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md delete mode 100644 wiki-information/functions/C_Commentator.SetSoftlockWeight.md delete mode 100644 wiki-information/functions/C_Commentator.SetSpeedFactor.md delete mode 100644 wiki-information/functions/C_Commentator.SetTargetHeightOffset.md delete mode 100644 wiki-information/functions/C_Commentator.SetUseSmartCamera.md delete mode 100644 wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md delete mode 100644 wiki-information/functions/C_Commentator.StartWargame.md delete mode 100644 wiki-information/functions/C_Commentator.SwapTeamSides.md delete mode 100644 wiki-information/functions/C_Commentator.ToggleCheats.md delete mode 100644 wiki-information/functions/C_Commentator.UpdateMapInfo.md delete mode 100644 wiki-information/functions/C_Commentator.UpdatePlayerInfo.md delete mode 100644 wiki-information/functions/C_Commentator.ZoomIn.md delete mode 100644 wiki-information/functions/C_Commentator.ZoomOut.md delete mode 100644 wiki-information/functions/C_Console.GetAllCommands.md delete mode 100644 wiki-information/functions/C_Console.GetColorFromType.md delete mode 100644 wiki-information/functions/C_Console.GetFontHeight.md delete mode 100644 wiki-information/functions/C_Console.PrintAllMatchingCommands.md delete mode 100644 wiki-information/functions/C_Console.SetFontHeight.md delete mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md delete mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md delete mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetElements.md delete mode 100644 wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md delete mode 100644 wiki-information/functions/C_Container.ContainerIDToInventoryID.md delete mode 100644 wiki-information/functions/C_Container.ContainerRefundItemPurchase.md delete mode 100644 wiki-information/functions/C_Container.GetBagName.md delete mode 100644 wiki-information/functions/C_Container.GetBagSlotFlag.md delete mode 100644 wiki-information/functions/C_Container.GetContainerFreeSlots.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemCooldown.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemDurability.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemID.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemInfo.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemLink.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md delete mode 100644 wiki-information/functions/C_Container.GetContainerItemQuestInfo.md delete mode 100644 wiki-information/functions/C_Container.GetContainerNumFreeSlots.md delete mode 100644 wiki-information/functions/C_Container.GetContainerNumSlots.md delete mode 100644 wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md delete mode 100644 wiki-information/functions/C_Container.GetItemCooldown.md delete mode 100644 wiki-information/functions/C_Container.IsContainerFiltered.md delete mode 100644 wiki-information/functions/C_Container.PickupContainerItem.md delete mode 100644 wiki-information/functions/C_Container.SetBagPortraitTexture.md delete mode 100644 wiki-information/functions/C_Container.SetBagSlotFlag.md delete mode 100644 wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md delete mode 100644 wiki-information/functions/C_Container.SetItemSearch.md delete mode 100644 wiki-information/functions/C_Container.ShowContainerSellCursor.md delete mode 100644 wiki-information/functions/C_Container.SocketContainerItem.md delete mode 100644 wiki-information/functions/C_Container.SplitContainerItem.md delete mode 100644 wiki-information/functions/C_Container.UseContainerItem.md delete mode 100644 wiki-information/functions/C_CreatureInfo.GetClassInfo.md delete mode 100644 wiki-information/functions/C_CreatureInfo.GetFactionInfo.md delete mode 100644 wiki-information/functions/C_CreatureInfo.GetRaceInfo.md delete mode 100644 wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md delete mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md delete mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md delete mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md delete mode 100644 wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md delete mode 100644 wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md delete mode 100644 wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md delete mode 100644 wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md delete mode 100644 wiki-information/functions/C_Cursor.GetCursorItem.md delete mode 100644 wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md delete mode 100644 wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md delete mode 100644 wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md delete mode 100644 wiki-information/functions/C_DateAndTime.CompareCalendarTime.md delete mode 100644 wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md delete mode 100644 wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md delete mode 100644 wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md delete mode 100644 wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md delete mode 100644 wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md delete mode 100644 wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md delete mode 100644 wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md delete mode 100644 wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md delete mode 100644 wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md delete mode 100644 wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md delete mode 100644 wiki-information/functions/C_Engraving.AddCategoryFilter.md delete mode 100644 wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md delete mode 100644 wiki-information/functions/C_Engraving.CastRune.md delete mode 100644 wiki-information/functions/C_Engraving.ClearCategoryFilter.md delete mode 100644 wiki-information/functions/C_Engraving.EnableEquippedFilter.md delete mode 100644 wiki-information/functions/C_Engraving.GetCurrentRuneCast.md delete mode 100644 wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md delete mode 100644 wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md delete mode 100644 wiki-information/functions/C_Engraving.GetNumRunesKnown.md delete mode 100644 wiki-information/functions/C_Engraving.GetRuneCategories.md delete mode 100644 wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md delete mode 100644 wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md delete mode 100644 wiki-information/functions/C_Engraving.GetRunesForCategory.md delete mode 100644 wiki-information/functions/C_Engraving.HasCategoryFilter.md delete mode 100644 wiki-information/functions/C_Engraving.IsEngravingEnabled.md delete mode 100644 wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md delete mode 100644 wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md delete mode 100644 wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md delete mode 100644 wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md delete mode 100644 wiki-information/functions/C_Engraving.IsKnownRuneSpell.md delete mode 100644 wiki-information/functions/C_Engraving.IsRuneEquipped.md delete mode 100644 wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md delete mode 100644 wiki-information/functions/C_Engraving.SetSearchFilter.md delete mode 100644 wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md delete mode 100644 wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md delete mode 100644 wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md delete mode 100644 wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md delete mode 100644 wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetItemIDs.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetItemLocations.md delete mode 100644 wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md delete mode 100644 wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md delete mode 100644 wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md delete mode 100644 wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md delete mode 100644 wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md delete mode 100644 wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md delete mode 100644 wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md delete mode 100644 wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md delete mode 100644 wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md delete mode 100644 wiki-information/functions/C_EventUtils.IsEventValid.md delete mode 100644 wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md delete mode 100644 wiki-information/functions/C_FriendList.AddFriend.md delete mode 100644 wiki-information/functions/C_FriendList.AddIgnore.md delete mode 100644 wiki-information/functions/C_FriendList.AddOrDelIgnore.md delete mode 100644 wiki-information/functions/C_FriendList.AddOrRemoveFriend.md delete mode 100644 wiki-information/functions/C_FriendList.DelIgnore.md delete mode 100644 wiki-information/functions/C_FriendList.DelIgnoreByIndex.md delete mode 100644 wiki-information/functions/C_FriendList.GetFriendInfo.md delete mode 100644 wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md delete mode 100644 wiki-information/functions/C_FriendList.GetIgnoreName.md delete mode 100644 wiki-information/functions/C_FriendList.GetNumFriends.md delete mode 100644 wiki-information/functions/C_FriendList.GetNumIgnores.md delete mode 100644 wiki-information/functions/C_FriendList.GetNumOnlineFriends.md delete mode 100644 wiki-information/functions/C_FriendList.GetNumWhoResults.md delete mode 100644 wiki-information/functions/C_FriendList.GetSelectedFriend.md delete mode 100644 wiki-information/functions/C_FriendList.GetSelectedIgnore.md delete mode 100644 wiki-information/functions/C_FriendList.GetWhoInfo.md delete mode 100644 wiki-information/functions/C_FriendList.IsFriend.md delete mode 100644 wiki-information/functions/C_FriendList.IsIgnored.md delete mode 100644 wiki-information/functions/C_FriendList.IsIgnoredByGuid.md delete mode 100644 wiki-information/functions/C_FriendList.IsOnIgnoredList.md delete mode 100644 wiki-information/functions/C_FriendList.RemoveFriend.md delete mode 100644 wiki-information/functions/C_FriendList.RemoveFriendByIndex.md delete mode 100644 wiki-information/functions/C_FriendList.SendWho.md delete mode 100644 wiki-information/functions/C_FriendList.SetFriendNotes.md delete mode 100644 wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md delete mode 100644 wiki-information/functions/C_FriendList.SetSelectedFriend.md delete mode 100644 wiki-information/functions/C_FriendList.SetSelectedIgnore.md delete mode 100644 wiki-information/functions/C_FriendList.SetWhoToUi.md delete mode 100644 wiki-information/functions/C_FriendList.ShowFriends.md delete mode 100644 wiki-information/functions/C_FriendList.SortWho.md delete mode 100644 wiki-information/functions/C_FunctionContainers.CreateCallback.md delete mode 100644 wiki-information/functions/C_GamePad.AddSDLMapping.md delete mode 100644 wiki-information/functions/C_GamePad.ApplyConfigs.md delete mode 100644 wiki-information/functions/C_GamePad.AxisIndexToConfigName.md delete mode 100644 wiki-information/functions/C_GamePad.ButtonBindingToIndex.md delete mode 100644 wiki-information/functions/C_GamePad.ButtonIndexToBinding.md delete mode 100644 wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md delete mode 100644 wiki-information/functions/C_GamePad.ClearLedColor.md delete mode 100644 wiki-information/functions/C_GamePad.DeleteConfig.md delete mode 100644 wiki-information/functions/C_GamePad.GetActiveDeviceID.md delete mode 100644 wiki-information/functions/C_GamePad.GetAllConfigIDs.md delete mode 100644 wiki-information/functions/C_GamePad.GetAllDeviceIDs.md delete mode 100644 wiki-information/functions/C_GamePad.GetCombinedDeviceID.md delete mode 100644 wiki-information/functions/C_GamePad.GetConfig.md delete mode 100644 wiki-information/functions/C_GamePad.GetDeviceMappedState.md delete mode 100644 wiki-information/functions/C_GamePad.GetDeviceRawState.md delete mode 100644 wiki-information/functions/C_GamePad.GetLedColor.md delete mode 100644 wiki-information/functions/C_GamePad.GetPowerLevel.md delete mode 100644 wiki-information/functions/C_GamePad.IsEnabled.md delete mode 100644 wiki-information/functions/C_GamePad.SetConfig.md delete mode 100644 wiki-information/functions/C_GamePad.SetLedColor.md delete mode 100644 wiki-information/functions/C_GamePad.SetVibration.md delete mode 100644 wiki-information/functions/C_GamePad.StickIndexToConfigName.md delete mode 100644 wiki-information/functions/C_GamePad.StopVibration.md delete mode 100644 wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md delete mode 100644 wiki-information/functions/C_GossipInfo.CloseGossip.md delete mode 100644 wiki-information/functions/C_GossipInfo.ForceGossip.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetActiveQuests.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetAvailableQuests.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetOptions.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetPoiInfo.md delete mode 100644 wiki-information/functions/C_GossipInfo.GetText.md delete mode 100644 wiki-information/functions/C_GossipInfo.SelectActiveQuest.md delete mode 100644 wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md delete mode 100644 wiki-information/functions/C_GossipInfo.SelectOption.md delete mode 100644 wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md delete mode 100644 wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md delete mode 100644 wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md delete mode 100644 wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md delete mode 100644 wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md delete mode 100644 wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md delete mode 100644 wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md delete mode 100644 wiki-information/functions/C_GuildInfo.GuildRoster.md delete mode 100644 wiki-information/functions/C_GuildInfo.IsGuildOfficer.md delete mode 100644 wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md delete mode 100644 wiki-information/functions/C_GuildInfo.MemberExistsByName.md delete mode 100644 wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md delete mode 100644 wiki-information/functions/C_GuildInfo.RemoveFromGuild.md delete mode 100644 wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md delete mode 100644 wiki-information/functions/C_GuildInfo.SetNote.md delete mode 100644 wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md delete mode 100644 wiki-information/functions/C_Heirloom.GetHeirloomInfo.md delete mode 100644 wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md delete mode 100644 wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md delete mode 100644 wiki-information/functions/C_Item.DoesItemExist.md delete mode 100644 wiki-information/functions/C_Item.DoesItemExistByID.md delete mode 100644 wiki-information/functions/C_Item.GetCurrentItemLevel.md delete mode 100644 wiki-information/functions/C_Item.GetItemGUID.md delete mode 100644 wiki-information/functions/C_Item.GetItemID.md delete mode 100644 wiki-information/functions/C_Item.GetItemIDForItemInfo.md delete mode 100644 wiki-information/functions/C_Item.GetItemIcon.md delete mode 100644 wiki-information/functions/C_Item.GetItemIconByID.md delete mode 100644 wiki-information/functions/C_Item.GetItemInventoryType.md delete mode 100644 wiki-information/functions/C_Item.GetItemInventoryTypeByID.md delete mode 100644 wiki-information/functions/C_Item.GetItemLink.md delete mode 100644 wiki-information/functions/C_Item.GetItemMaxStackSize.md delete mode 100644 wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md delete mode 100644 wiki-information/functions/C_Item.GetItemName.md delete mode 100644 wiki-information/functions/C_Item.GetItemNameByID.md delete mode 100644 wiki-information/functions/C_Item.GetItemQuality.md delete mode 100644 wiki-information/functions/C_Item.GetItemQualityByID.md delete mode 100644 wiki-information/functions/C_Item.GetStackCount.md delete mode 100644 wiki-information/functions/C_Item.IsBound.md delete mode 100644 wiki-information/functions/C_Item.IsItemDataCached.md delete mode 100644 wiki-information/functions/C_Item.IsItemDataCachedByID.md delete mode 100644 wiki-information/functions/C_Item.IsLocked.md delete mode 100644 wiki-information/functions/C_Item.LockItem.md delete mode 100644 wiki-information/functions/C_Item.LockItemByGUID.md delete mode 100644 wiki-information/functions/C_Item.RequestLoadItemData.md delete mode 100644 wiki-information/functions/C_Item.RequestLoadItemDataByID.md delete mode 100644 wiki-information/functions/C_Item.UnlockItem.md delete mode 100644 wiki-information/functions/C_Item.UnlockItemByGUID.md delete mode 100644 wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md delete mode 100644 wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md delete mode 100644 wiki-information/functions/C_KeyBindings.GetBindingIndex.md delete mode 100644 wiki-information/functions/C_KeyBindings.GetCustomBindingType.md delete mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md delete mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md delete mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md delete mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md delete mode 100644 wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md delete mode 100644 wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md delete mode 100644 wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md delete mode 100644 wiki-information/functions/C_LFGInfo.GetLFDLockStates.md delete mode 100644 wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md delete mode 100644 wiki-information/functions/C_LFGInfo.HideNameFromUI.md delete mode 100644 wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md delete mode 100644 wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md delete mode 100644 wiki-information/functions/C_LFGInfo.IsLFDEnabled.md delete mode 100644 wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md delete mode 100644 wiki-information/functions/C_LFGInfo.IsLFREnabled.md delete mode 100644 wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md delete mode 100644 wiki-information/functions/C_LFGList.ApplyToGroup.md delete mode 100644 wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md delete mode 100644 wiki-information/functions/C_LFGList.CanCreateQuestGroup.md delete mode 100644 wiki-information/functions/C_LFGList.ClearApplicationTextFields.md delete mode 100644 wiki-information/functions/C_LFGList.ClearCreationTextFields.md delete mode 100644 wiki-information/functions/C_LFGList.ClearSearchResults.md delete mode 100644 wiki-information/functions/C_LFGList.ClearSearchTextFields.md delete mode 100644 wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md delete mode 100644 wiki-information/functions/C_LFGList.CreateListing.md delete mode 100644 wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md delete mode 100644 wiki-information/functions/C_LFGList.GetActiveEntryInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetActivityFullName.md delete mode 100644 wiki-information/functions/C_LFGList.GetActivityGroupInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetActivityInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md delete mode 100644 wiki-information/functions/C_LFGList.GetActivityInfoTable.md delete mode 100644 wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md delete mode 100644 wiki-information/functions/C_LFGList.GetApplicantInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetApplicantMemberStats.md delete mode 100644 wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md delete mode 100644 wiki-information/functions/C_LFGList.GetApplicants.md delete mode 100644 wiki-information/functions/C_LFGList.GetAvailableActivities.md delete mode 100644 wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md delete mode 100644 wiki-information/functions/C_LFGList.GetAvailableCategories.md delete mode 100644 wiki-information/functions/C_LFGList.GetCategoryInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetFilteredSearchResults.md delete mode 100644 wiki-information/functions/C_LFGList.GetKeystoneForActivity.md delete mode 100644 wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetRoles.md delete mode 100644 wiki-information/functions/C_LFGList.GetSearchResultInfo.md delete mode 100644 wiki-information/functions/C_LFGList.GetSearchResults.md delete mode 100644 wiki-information/functions/C_LFGList.HasActiveEntryInfo.md delete mode 100644 wiki-information/functions/C_LFGList.HasSearchResultInfo.md delete mode 100644 wiki-information/functions/C_LFGList.InviteApplicant.md delete mode 100644 wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md delete mode 100644 wiki-information/functions/C_LFGList.RemoveListing.md delete mode 100644 wiki-information/functions/C_LFGList.RequestAvailableActivities.md delete mode 100644 wiki-information/functions/C_LFGList.SetRoles.md delete mode 100644 wiki-information/functions/C_LFGList.SetSearchToQuestID.md delete mode 100644 wiki-information/functions/C_LFGList.UpdateListing.md delete mode 100644 wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md delete mode 100644 wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md delete mode 100644 wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md delete mode 100644 wiki-information/functions/C_LootHistory.GetItem.md delete mode 100644 wiki-information/functions/C_LootHistory.GetPlayerInfo.md delete mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md delete mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md delete mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md delete mode 100644 wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md delete mode 100644 wiki-information/functions/C_Mail.HasInboxMoney.md delete mode 100644 wiki-information/functions/C_Mail.IsCommandPending.md delete mode 100644 wiki-information/functions/C_Map.GetAreaInfo.md delete mode 100644 wiki-information/functions/C_Map.GetBestMapForUnit.md delete mode 100644 wiki-information/functions/C_Map.GetBountySetIDForMap.md delete mode 100644 wiki-information/functions/C_Map.GetFallbackWorldMapID.md delete mode 100644 wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md delete mode 100644 wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md delete mode 100644 wiki-information/functions/C_Map.GetMapArtID.md delete mode 100644 wiki-information/functions/C_Map.GetMapArtLayerTextures.md delete mode 100644 wiki-information/functions/C_Map.GetMapArtLayers.md delete mode 100644 wiki-information/functions/C_Map.GetMapBannersForMap.md delete mode 100644 wiki-information/functions/C_Map.GetMapChildrenInfo.md delete mode 100644 wiki-information/functions/C_Map.GetMapDisplayInfo.md delete mode 100644 wiki-information/functions/C_Map.GetMapGroupID.md delete mode 100644 wiki-information/functions/C_Map.GetMapGroupMembersInfo.md delete mode 100644 wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md delete mode 100644 wiki-information/functions/C_Map.GetMapInfo.md delete mode 100644 wiki-information/functions/C_Map.GetMapInfoAtPosition.md delete mode 100644 wiki-information/functions/C_Map.GetMapLevels.md delete mode 100644 wiki-information/functions/C_Map.GetMapLinksForMap.md delete mode 100644 wiki-information/functions/C_Map.GetMapPosFromWorldPos.md delete mode 100644 wiki-information/functions/C_Map.GetMapRectOnMap.md delete mode 100644 wiki-information/functions/C_Map.GetPlayerMapPosition.md delete mode 100644 wiki-information/functions/C_Map.GetWorldPosFromMapPos.md delete mode 100644 wiki-information/functions/C_Map.MapHasArt.md delete mode 100644 wiki-information/functions/C_Map.RequestPreloadMap.md delete mode 100644 wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md delete mode 100644 wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md delete mode 100644 wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md delete mode 100644 wiki-information/functions/C_Minimap.GetNumTrackingTypes.md delete mode 100644 wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md delete mode 100644 wiki-information/functions/C_Minimap.GetPOITextureCoords.md delete mode 100644 wiki-information/functions/C_Minimap.GetTrackingInfo.md delete mode 100644 wiki-information/functions/C_Minimap.SetTracking.md delete mode 100644 wiki-information/functions/C_ModelInfo.AddActiveModelScene.md delete mode 100644 wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md delete mode 100644 wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md delete mode 100644 wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md delete mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md delete mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md delete mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md delete mode 100644 wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md delete mode 100644 wiki-information/functions/C_MountJournal.ClearFanfare.md delete mode 100644 wiki-information/functions/C_MountJournal.ClearRecentFanfares.md delete mode 100644 wiki-information/functions/C_MountJournal.Dismiss.md delete mode 100644 wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md delete mode 100644 wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md delete mode 100644 wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md delete mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md delete mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountID.md delete mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md delete mode 100644 wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md delete mode 100644 wiki-information/functions/C_MountJournal.GetIsFavorite.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountFromItem.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountFromSpell.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountIDs.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountInfoByID.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountLink.md delete mode 100644 wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md delete mode 100644 wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md delete mode 100644 wiki-information/functions/C_MountJournal.GetNumMounts.md delete mode 100644 wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md delete mode 100644 wiki-information/functions/C_MountJournal.IsSourceChecked.md delete mode 100644 wiki-information/functions/C_MountJournal.IsTypeChecked.md delete mode 100644 wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md delete mode 100644 wiki-information/functions/C_MountJournal.IsValidSourceFilter.md delete mode 100644 wiki-information/functions/C_MountJournal.IsValidTypeFilter.md delete mode 100644 wiki-information/functions/C_MountJournal.NeedsFanfare.md delete mode 100644 wiki-information/functions/C_MountJournal.Pickup.md delete mode 100644 wiki-information/functions/C_MountJournal.SetAllSourceFilters.md delete mode 100644 wiki-information/functions/C_MountJournal.SetAllTypeFilters.md delete mode 100644 wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md delete mode 100644 wiki-information/functions/C_MountJournal.SetDefaultFilters.md delete mode 100644 wiki-information/functions/C_MountJournal.SetIsFavorite.md delete mode 100644 wiki-information/functions/C_MountJournal.SetSearch.md delete mode 100644 wiki-information/functions/C_MountJournal.SetSourceFilter.md delete mode 100644 wiki-information/functions/C_MountJournal.SetTypeFilter.md delete mode 100644 wiki-information/functions/C_MountJournal.SummonByID.md delete mode 100644 wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md delete mode 100644 wiki-information/functions/C_NamePlate.GetNamePlates.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md delete mode 100644 wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md delete mode 100644 wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md delete mode 100644 wiki-information/functions/C_NewItems.ClearAll.md delete mode 100644 wiki-information/functions/C_NewItems.IsNewItem.md delete mode 100644 wiki-information/functions/C_NewItems.RemoveNewItem.md delete mode 100644 wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md delete mode 100644 wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md delete mode 100644 wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md delete mode 100644 wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md delete mode 100644 wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md delete mode 100644 wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md delete mode 100644 wiki-information/functions/C_PartyInfo.GetActiveCategories.md delete mode 100644 wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md delete mode 100644 wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md delete mode 100644 wiki-information/functions/C_PartyInfo.IsPartyFull.md delete mode 100644 wiki-information/functions/C_PetJournal.ClearSearchFilter.md delete mode 100644 wiki-information/functions/C_PetJournal.FindPetIDByName.md delete mode 100644 wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md delete mode 100644 wiki-information/functions/C_PetJournal.GetNumPetSources.md delete mode 100644 wiki-information/functions/C_PetJournal.GetNumPetTypes.md delete mode 100644 wiki-information/functions/C_PetJournal.GetNumPets.md delete mode 100644 wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md delete mode 100644 wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md delete mode 100644 wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md delete mode 100644 wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md delete mode 100644 wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md delete mode 100644 wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md delete mode 100644 wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md delete mode 100644 wiki-information/functions/C_PetJournal.GetPetSortParameter.md delete mode 100644 wiki-information/functions/C_PetJournal.GetPetSummonInfo.md delete mode 100644 wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md delete mode 100644 wiki-information/functions/C_PetJournal.IsFilterChecked.md delete mode 100644 wiki-information/functions/C_PetJournal.IsPetSourceChecked.md delete mode 100644 wiki-information/functions/C_PetJournal.IsPetTypeChecked.md delete mode 100644 wiki-information/functions/C_PetJournal.PetIsFavorite.md delete mode 100644 wiki-information/functions/C_PetJournal.PetIsRevoked.md delete mode 100644 wiki-information/functions/C_PetJournal.PetIsSummonable.md delete mode 100644 wiki-information/functions/C_PetJournal.PickupPet.md delete mode 100644 wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md delete mode 100644 wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md delete mode 100644 wiki-information/functions/C_PetJournal.SetFavorite.md delete mode 100644 wiki-information/functions/C_PetJournal.SetFilterChecked.md delete mode 100644 wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md delete mode 100644 wiki-information/functions/C_PetJournal.SetPetSortParameter.md delete mode 100644 wiki-information/functions/C_PetJournal.SetPetSourceChecked.md delete mode 100644 wiki-information/functions/C_PetJournal.SetPetTypeFilter.md delete mode 100644 wiki-information/functions/C_PetJournal.SetSearchFilter.md delete mode 100644 wiki-information/functions/C_PetJournal.SummonPetByGUID.md delete mode 100644 wiki-information/functions/C_PlayerInfo.CanUseItem.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetClass.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetDisplayID.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetName.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetRace.md delete mode 100644 wiki-information/functions/C_PlayerInfo.GetSex.md delete mode 100644 wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md delete mode 100644 wiki-information/functions/C_PlayerInfo.IsConnected.md delete mode 100644 wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md delete mode 100644 wiki-information/functions/C_PlayerInfo.IsMirrorImage.md delete mode 100644 wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md delete mode 100644 wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md delete mode 100644 wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md delete mode 100644 wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md delete mode 100644 wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md delete mode 100644 wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md delete mode 100644 wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md delete mode 100644 wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md delete mode 100644 wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md delete mode 100644 wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md delete mode 100644 wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md delete mode 100644 wiki-information/functions/C_PvP.GetBattlefieldVehicles.md delete mode 100644 wiki-information/functions/C_PvP.GetRandomBGRewards.md delete mode 100644 wiki-information/functions/C_PvP.IsInBrawl.md delete mode 100644 wiki-information/functions/C_PvP.IsPVPMap.md delete mode 100644 wiki-information/functions/C_PvP.IsRatedMap.md delete mode 100644 wiki-information/functions/C_PvP.RequestCrowdControlSpell.md delete mode 100644 wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md delete mode 100644 wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md delete mode 100644 wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md delete mode 100644 wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md delete mode 100644 wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md delete mode 100644 wiki-information/functions/C_QuestLog.GetMaxNumQuests.md delete mode 100644 wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md delete mode 100644 wiki-information/functions/C_QuestLog.GetQuestInfo.md delete mode 100644 wiki-information/functions/C_QuestLog.GetQuestObjectives.md delete mode 100644 wiki-information/functions/C_QuestLog.GetQuestsOnMap.md delete mode 100644 wiki-information/functions/C_QuestLog.IsOnQuest.md delete mode 100644 wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md delete mode 100644 wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md delete mode 100644 wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md delete mode 100644 wiki-information/functions/C_QuestSession.CanStart.md delete mode 100644 wiki-information/functions/C_QuestSession.CanStop.md delete mode 100644 wiki-information/functions/C_QuestSession.Exists.md delete mode 100644 wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md delete mode 100644 wiki-information/functions/C_QuestSession.GetPendingCommand.md delete mode 100644 wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md delete mode 100644 wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md delete mode 100644 wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md delete mode 100644 wiki-information/functions/C_QuestSession.HasJoined.md delete mode 100644 wiki-information/functions/C_QuestSession.HasPendingCommand.md delete mode 100644 wiki-information/functions/C_QuestSession.RequestSessionStart.md delete mode 100644 wiki-information/functions/C_QuestSession.RequestSessionStop.md delete mode 100644 wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md delete mode 100644 wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md delete mode 100644 wiki-information/functions/C_RaidLocks.IsEncounterComplete.md delete mode 100644 wiki-information/functions/C_ReportSystem.CanReportPlayer.md delete mode 100644 wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md delete mode 100644 wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md delete mode 100644 wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md delete mode 100644 wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md delete mode 100644 wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md delete mode 100644 wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md delete mode 100644 wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md delete mode 100644 wiki-information/functions/C_ReportSystem.ReportServerLag.md delete mode 100644 wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md delete mode 100644 wiki-information/functions/C_ReportSystem.SendReport.md delete mode 100644 wiki-information/functions/C_ReportSystem.SendReportPlayer.md delete mode 100644 wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md delete mode 100644 wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md delete mode 100644 wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md delete mode 100644 wiki-information/functions/C_Reputation.GetFactionParagonInfo.md delete mode 100644 wiki-information/functions/C_Reputation.IsFactionParagon.md delete mode 100644 wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md delete mode 100644 wiki-information/functions/C_Reputation.SetWatchedFaction.md delete mode 100644 wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md delete mode 100644 wiki-information/functions/C_Seasons.GetActiveSeason.md delete mode 100644 wiki-information/functions/C_Seasons.HasActiveSeason.md delete mode 100644 wiki-information/functions/C_Social.GetLastItem.md delete mode 100644 wiki-information/functions/C_Social.GetLastScreenshot.md delete mode 100644 wiki-information/functions/C_Social.GetNumCharactersPerMedia.md delete mode 100644 wiki-information/functions/C_Social.GetScreenshotByIndex.md delete mode 100644 wiki-information/functions/C_Social.GetTweetLength.md delete mode 100644 wiki-information/functions/C_Social.IsSocialEnabled.md delete mode 100644 wiki-information/functions/C_Social.TwitterCheckStatus.md delete mode 100644 wiki-information/functions/C_Social.TwitterConnect.md delete mode 100644 wiki-information/functions/C_Social.TwitterDisconnect.md delete mode 100644 wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md delete mode 100644 wiki-information/functions/C_Social.TwitterPostMessage.md delete mode 100644 wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md delete mode 100644 wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md delete mode 100644 wiki-information/functions/C_SocialRestrictions.IsMuted.md delete mode 100644 wiki-information/functions/C_SocialRestrictions.IsSilenced.md delete mode 100644 wiki-information/functions/C_SocialRestrictions.IsSquelched.md delete mode 100644 wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md delete mode 100644 wiki-information/functions/C_Sound.GetSoundScaledVolume.md delete mode 100644 wiki-information/functions/C_Sound.IsPlaying.md delete mode 100644 wiki-information/functions/C_Sound.PlayItemSound.md delete mode 100644 wiki-information/functions/C_Spell.DoesSpellExist.md delete mode 100644 wiki-information/functions/C_Spell.IsSpellDataCached.md delete mode 100644 wiki-information/functions/C_Spell.RequestLoadSpellData.md delete mode 100644 wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md delete mode 100644 wiki-information/functions/C_StableInfo.GetNumActivePets.md delete mode 100644 wiki-information/functions/C_StableInfo.GetNumStablePets.md delete mode 100644 wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md delete mode 100644 wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md delete mode 100644 wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md delete mode 100644 wiki-information/functions/C_StorePublic.IsEnabled.md delete mode 100644 wiki-information/functions/C_SummonInfo.CancelSummon.md delete mode 100644 wiki-information/functions/C_SummonInfo.ConfirmSummon.md delete mode 100644 wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md delete mode 100644 wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md delete mode 100644 wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md delete mode 100644 wiki-information/functions/C_SummonInfo.GetSummonReason.md delete mode 100644 wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md delete mode 100644 wiki-information/functions/C_System.GetFrameStack.md delete mode 100644 wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetChannelEnabled.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetSetting.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetSpeechRate.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetSpeechVolume.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md delete mode 100644 wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md delete mode 100644 wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetChannelEnabled.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetDefaultSettings.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetSetting.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetSpeechRate.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetSpeechVolume.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetVoiceOption.md delete mode 100644 wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md delete mode 100644 wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md delete mode 100644 wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetQuestLocation.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetQuestZoneID.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetThreatQuests.md delete mode 100644 wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md delete mode 100644 wiki-information/functions/C_TaskQuest.IsActive.md delete mode 100644 wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md delete mode 100644 wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md delete mode 100644 wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md delete mode 100644 wiki-information/functions/C_Texture.ClearTitleIconTexture.md delete mode 100644 wiki-information/functions/C_Texture.GetAtlasElementID.md delete mode 100644 wiki-information/functions/C_Texture.GetAtlasID.md delete mode 100644 wiki-information/functions/C_Texture.GetAtlasInfo.md delete mode 100644 wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md delete mode 100644 wiki-information/functions/C_Texture.GetTitleIconTexture.md delete mode 100644 wiki-information/functions/C_Texture.IsTitleIconTextureReady.md delete mode 100644 wiki-information/functions/C_Texture.SetTitleIconTexture.md delete mode 100644 wiki-information/functions/C_Timer.After.md delete mode 100644 wiki-information/functions/C_Timer.NewTicker.md delete mode 100644 wiki-information/functions/C_Timer.NewTimer.md delete mode 100644 wiki-information/functions/C_ToyBox.GetNumToys.md delete mode 100644 wiki-information/functions/C_ToyBox.GetToyFromIndex.md delete mode 100644 wiki-information/functions/C_ToyBox.GetToyInfo.md delete mode 100644 wiki-information/functions/C_ToyBox.GetToyLink.md delete mode 100644 wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md delete mode 100644 wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md delete mode 100644 wiki-information/functions/C_Traits.CanPurchaseRank.md delete mode 100644 wiki-information/functions/C_Traits.CanRefundRank.md delete mode 100644 wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md delete mode 100644 wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md delete mode 100644 wiki-information/functions/C_Traits.CommitConfig.md delete mode 100644 wiki-information/functions/C_Traits.ConfigHasStagedChanges.md delete mode 100644 wiki-information/functions/C_Traits.GenerateImportString.md delete mode 100644 wiki-information/functions/C_Traits.GenerateInspectImportString.md delete mode 100644 wiki-information/functions/C_Traits.GetConditionInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetConfigIDBySystemID.md delete mode 100644 wiki-information/functions/C_Traits.GetConfigIDByTreeID.md delete mode 100644 wiki-information/functions/C_Traits.GetConfigInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetConfigsByType.md delete mode 100644 wiki-information/functions/C_Traits.GetDefinitionInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetEntryInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md delete mode 100644 wiki-information/functions/C_Traits.GetNodeCost.md delete mode 100644 wiki-information/functions/C_Traits.GetNodeInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetStagedChangesCost.md delete mode 100644 wiki-information/functions/C_Traits.GetStagedPurchases.md delete mode 100644 wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetTraitDescription.md delete mode 100644 wiki-information/functions/C_Traits.GetTraitSystemFlags.md delete mode 100644 wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md delete mode 100644 wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetTreeHash.md delete mode 100644 wiki-information/functions/C_Traits.GetTreeInfo.md delete mode 100644 wiki-information/functions/C_Traits.GetTreeNodes.md delete mode 100644 wiki-information/functions/C_Traits.HasValidInspectData.md delete mode 100644 wiki-information/functions/C_Traits.IsReadyForCommit.md delete mode 100644 wiki-information/functions/C_Traits.PurchaseRank.md delete mode 100644 wiki-information/functions/C_Traits.RefundAllRanks.md delete mode 100644 wiki-information/functions/C_Traits.RefundRank.md delete mode 100644 wiki-information/functions/C_Traits.ResetTree.md delete mode 100644 wiki-information/functions/C_Traits.ResetTreeByCurrency.md delete mode 100644 wiki-information/functions/C_Traits.RollbackConfig.md delete mode 100644 wiki-information/functions/C_Traits.SetSelection.md delete mode 100644 wiki-information/functions/C_Traits.StageConfig.md delete mode 100644 wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md delete mode 100644 wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md delete mode 100644 wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md delete mode 100644 wiki-information/functions/C_UI.Reload.md delete mode 100644 wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md delete mode 100644 wiki-information/functions/C_UIColor.GetColors.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md delete mode 100644 wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md delete mode 100644 wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md delete mode 100644 wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md delete mode 100644 wiki-information/functions/C_UnitAuras.AuraIsPrivate.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetAuraSlots.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md delete mode 100644 wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md delete mode 100644 wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md delete mode 100644 wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md delete mode 100644 wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md delete mode 100644 wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md delete mode 100644 wiki-information/functions/C_UnitAuras.WantsAlteredForm.md delete mode 100644 wiki-information/functions/C_UserFeedback.SubmitBug.md delete mode 100644 wiki-information/functions/C_UserFeedback.SubmitSuggestion.md delete mode 100644 wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md delete mode 100644 wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md delete mode 100644 wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md delete mode 100644 wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md delete mode 100644 wiki-information/functions/C_VideoOptions.SetGameWindowSize.md delete mode 100644 wiki-information/functions/C_VoiceChat.ActivateChannel.md delete mode 100644 wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md delete mode 100644 wiki-information/functions/C_VoiceChat.BeginLocalCapture.md delete mode 100644 wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md delete mode 100644 wiki-information/functions/C_VoiceChat.CreateChannel.md delete mode 100644 wiki-information/functions/C_VoiceChat.DeactivateChannel.md delete mode 100644 wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md delete mode 100644 wiki-information/functions/C_VoiceChat.EndLocalCapture.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetActiveChannelID.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetActiveChannelType.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetChannel.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetCommunicationMode.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetInputVolume.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetMemberGUID.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetMemberID.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetMemberInfo.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetMemberName.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetMemberVolume.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetOutputVolume.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetProcesses.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetTtsVoices.md delete mode 100644 wiki-information/functions/C_VoiceChat.GetVADSensitivity.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsDeafened.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsEnabled.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsLoggedIn.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsMemberMuted.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsMemberSilenced.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsMuted.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsParentalDisabled.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsParentalMuted.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsSilenced.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsTranscribing.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md delete mode 100644 wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md delete mode 100644 wiki-information/functions/C_VoiceChat.LeaveChannel.md delete mode 100644 wiki-information/functions/C_VoiceChat.Login.md delete mode 100644 wiki-information/functions/C_VoiceChat.Logout.md delete mode 100644 wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md delete mode 100644 wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md delete mode 100644 wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetCommunicationMode.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetDeafened.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetInputDevice.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetInputVolume.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetMemberMuted.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetMemberVolume.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetMuted.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetOutputDevice.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetOutputVolume.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetPortraitTexture.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md delete mode 100644 wiki-information/functions/C_VoiceChat.SetVADSensitivity.md delete mode 100644 wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md delete mode 100644 wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md delete mode 100644 wiki-information/functions/C_VoiceChat.SpeakText.md delete mode 100644 wiki-information/functions/C_VoiceChat.StopSpeakingText.md delete mode 100644 wiki-information/functions/C_VoiceChat.ToggleDeafened.md delete mode 100644 wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md delete mode 100644 wiki-information/functions/C_VoiceChat.ToggleMuted.md delete mode 100644 wiki-information/functions/C_XMLUtil.GetTemplateInfo.md delete mode 100644 wiki-information/functions/C_XMLUtil.GetTemplates.md delete mode 100644 wiki-information/functions/CalculateStringEditDistance.md delete mode 100644 wiki-information/functions/CallCompanion.md delete mode 100644 wiki-information/functions/CameraOrSelectOrMoveStart.md delete mode 100644 wiki-information/functions/CameraOrSelectOrMoveStop.md delete mode 100644 wiki-information/functions/CameraZoomIn.md delete mode 100644 wiki-information/functions/CanAbandonQuest.md delete mode 100644 wiki-information/functions/CanBeRaidTarget.md delete mode 100644 wiki-information/functions/CanChangePlayerDifficulty.md delete mode 100644 wiki-information/functions/CanDualWield.md delete mode 100644 wiki-information/functions/CanEditMOTD.md delete mode 100644 wiki-information/functions/CanEjectPassengerFromSeat.md delete mode 100644 wiki-information/functions/CanGrantLevel.md delete mode 100644 wiki-information/functions/CanGuildDemote.md delete mode 100644 wiki-information/functions/CanGuildInvite.md delete mode 100644 wiki-information/functions/CanGuildPromote.md delete mode 100644 wiki-information/functions/CanInspect.md delete mode 100644 wiki-information/functions/CanJoinBattlefieldAsGroup.md delete mode 100644 wiki-information/functions/CanLootUnit.md delete mode 100644 wiki-information/functions/CanMerchantRepair.md delete mode 100644 wiki-information/functions/CanReplaceGuildMaster.md delete mode 100644 wiki-information/functions/CanSendAuctionQuery.md delete mode 100644 wiki-information/functions/CanShowAchievementUI.md delete mode 100644 wiki-information/functions/CanShowResetInstances.md delete mode 100644 wiki-information/functions/CanSummonFriend.md delete mode 100644 wiki-information/functions/CanSwitchVehicleSeat.md delete mode 100644 wiki-information/functions/CanUpgradeExpansion.md delete mode 100644 wiki-information/functions/CancelDuel.md delete mode 100644 wiki-information/functions/CancelItemTempEnchantment.md delete mode 100644 wiki-information/functions/CancelLogout.md delete mode 100644 wiki-information/functions/CancelPendingEquip.md delete mode 100644 wiki-information/functions/CancelPreloadingMovie.md delete mode 100644 wiki-information/functions/CancelShapeshiftForm.md delete mode 100644 wiki-information/functions/CancelTrackingBuff.md delete mode 100644 wiki-information/functions/CancelTrade.md delete mode 100644 wiki-information/functions/CancelUnitBuff.md delete mode 100644 wiki-information/functions/CaseAccentInsensitiveParse.md delete mode 100644 wiki-information/functions/CastPetAction.md delete mode 100644 wiki-information/functions/CastShapeshiftForm.md delete mode 100644 wiki-information/functions/CastSpell.md delete mode 100644 wiki-information/functions/CastSpellByName.md delete mode 100644 wiki-information/functions/CastingInfo.md delete mode 100644 wiki-information/functions/ChangeActionBarPage.md delete mode 100644 wiki-information/functions/ChangeChatColor.md delete mode 100644 wiki-information/functions/ChannelBan.md delete mode 100644 wiki-information/functions/ChannelInfo.md delete mode 100644 wiki-information/functions/ChannelInvite.md delete mode 100644 wiki-information/functions/ChannelKick.md delete mode 100644 wiki-information/functions/CheckInbox.md delete mode 100644 wiki-information/functions/CheckInteractDistance.md delete mode 100644 wiki-information/functions/CheckTalentMasterDist.md delete mode 100644 wiki-information/functions/ClassicExpansionAtLeast.md delete mode 100644 wiki-information/functions/ClearCursor.md delete mode 100644 wiki-information/functions/ClearOverrideBindings.md delete mode 100644 wiki-information/functions/ClearSendMail.md delete mode 100644 wiki-information/functions/ClearTarget.md delete mode 100644 wiki-information/functions/ClickSendMailItemButton.md delete mode 100644 wiki-information/functions/ClickStablePet.md delete mode 100644 wiki-information/functions/CloseItemText.md delete mode 100644 wiki-information/functions/CloseLoot.md delete mode 100644 wiki-information/functions/ClosePetition.md delete mode 100644 wiki-information/functions/CloseSocketInfo.md delete mode 100644 wiki-information/functions/ClosestUnitPosition.md delete mode 100644 wiki-information/functions/CollapseFactionHeader.md delete mode 100644 wiki-information/functions/CollapseQuestHeader.md delete mode 100644 wiki-information/functions/CollapseSkillHeader.md delete mode 100644 wiki-information/functions/CollapseTrainerSkillLine.md delete mode 100644 wiki-information/functions/CombatLogAdvanceEntry.md delete mode 100644 wiki-information/functions/CombatLogGetCurrentEntry.md delete mode 100644 wiki-information/functions/CombatLogGetCurrentEventInfo.md delete mode 100644 wiki-information/functions/CombatLogSetCurrentEntry.md delete mode 100644 wiki-information/functions/CombatLog_Object_IsA.md delete mode 100644 wiki-information/functions/CombatTextSetActiveUnit.md delete mode 100644 wiki-information/functions/CompleteQuest.md delete mode 100644 wiki-information/functions/ConfirmAcceptQuest.md delete mode 100644 wiki-information/functions/ConfirmLootRoll.md delete mode 100644 wiki-information/functions/ConfirmLootSlot.md delete mode 100644 wiki-information/functions/ConfirmPetUnlearn.md delete mode 100644 wiki-information/functions/ConfirmReadyCheck.md delete mode 100644 wiki-information/functions/ConsoleAddMessage.md delete mode 100644 wiki-information/functions/ConsoleExec.md delete mode 100644 wiki-information/functions/ConsoleGetAllCommands.md delete mode 100644 wiki-information/functions/ConsoleGetColorFromType.md delete mode 100644 wiki-information/functions/ConsoleGetFontHeight.md delete mode 100644 wiki-information/functions/ConsolePrintAllMatchingCommands.md delete mode 100644 wiki-information/functions/ConsoleSetFontHeight.md delete mode 100644 wiki-information/functions/ContainerIDToInventoryID.md delete mode 100644 wiki-information/functions/ConvertToParty.md delete mode 100644 wiki-information/functions/ConvertToRaid.md delete mode 100644 wiki-information/functions/CopyToClipboard.md delete mode 100644 wiki-information/functions/CreateFont.md delete mode 100644 wiki-information/functions/CreateFrame.md delete mode 100644 wiki-information/functions/CreateMacro.md delete mode 100644 wiki-information/functions/CreateWindow.md delete mode 100644 wiki-information/functions/CursorCanGoInSlot.md delete mode 100644 wiki-information/functions/CursorHasItem.md delete mode 100644 wiki-information/functions/CursorHasMacro.md delete mode 100644 wiki-information/functions/CursorHasMoney.md delete mode 100644 wiki-information/functions/CursorHasSpell.md delete mode 100644 wiki-information/functions/DeathRecap_GetEvents.md delete mode 100644 wiki-information/functions/DeathRecap_HasEvents.md delete mode 100644 wiki-information/functions/DeclineArenaTeam.md delete mode 100644 wiki-information/functions/DeclineChannelInvite.md delete mode 100644 wiki-information/functions/DeclineGroup.md delete mode 100644 wiki-information/functions/DeclineGuild.md delete mode 100644 wiki-information/functions/DeclineName.md delete mode 100644 wiki-information/functions/DeclineQuest.md delete mode 100644 wiki-information/functions/DeclineResurrect.md delete mode 100644 wiki-information/functions/DeclineSpellConfirmationPrompt.md delete mode 100644 wiki-information/functions/DeleteCursorItem.md delete mode 100644 wiki-information/functions/DeleteInboxItem.md delete mode 100644 wiki-information/functions/DeleteMacro.md delete mode 100644 wiki-information/functions/DescendStop.md delete mode 100644 wiki-information/functions/DestroyTotem.md delete mode 100644 wiki-information/functions/DisableAddOn.md delete mode 100644 wiki-information/functions/DismissCompanion.md delete mode 100644 wiki-information/functions/Dismount.md delete mode 100644 wiki-information/functions/DisplayChannelOwner.md delete mode 100644 wiki-information/functions/DoReadyCheck.md delete mode 100644 wiki-information/functions/DoTradeSkill.md delete mode 100644 wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md delete mode 100644 wiki-information/functions/DoesSpellExist.md delete mode 100644 wiki-information/functions/DropItemOnUnit.md delete mode 100644 wiki-information/functions/EditMacro.md delete mode 100644 wiki-information/functions/EjectPassengerFromSeat.md delete mode 100644 wiki-information/functions/EnableAddOn.md delete mode 100644 wiki-information/functions/EnumerateFrames.md delete mode 100644 wiki-information/functions/EnumerateServerChannels.md delete mode 100644 wiki-information/functions/EquipCursorItem.md delete mode 100644 wiki-information/functions/EquipItemByName.md delete mode 100644 wiki-information/functions/EquipPendingItem.md delete mode 100644 wiki-information/functions/ExpandCurrencyList.md delete mode 100644 wiki-information/functions/ExpandFactionHeader.md delete mode 100644 wiki-information/functions/ExpandQuestHeader.md delete mode 100644 wiki-information/functions/ExpandSkillHeader.md delete mode 100644 wiki-information/functions/ExpandTradeSkillSubClass.md delete mode 100644 wiki-information/functions/ExpandTrainerSkillLine.md delete mode 100644 wiki-information/functions/FactionToggleAtWar.md delete mode 100644 wiki-information/functions/FillLocalizedClassList.md delete mode 100644 wiki-information/functions/FindBaseSpellByID.md delete mode 100644 wiki-information/functions/FindSpellOverrideByID.md delete mode 100644 wiki-information/functions/FlashClientIcon.md delete mode 100644 wiki-information/functions/FlipCameraYaw.md delete mode 100644 wiki-information/functions/FocusUnit.md delete mode 100644 wiki-information/functions/FollowUnit.md delete mode 100644 wiki-information/functions/ForceGossip.md delete mode 100644 wiki-information/functions/ForceQuit.md delete mode 100644 wiki-information/functions/FrameXML_Debug.md delete mode 100644 wiki-information/functions/GMRequestPlayerInfo.md delete mode 100644 wiki-information/functions/GMSubmitBug.md delete mode 100644 wiki-information/functions/GMSubmitSuggestion.md delete mode 100644 wiki-information/functions/GetAbandonQuestItems.md delete mode 100644 wiki-information/functions/GetAbandonQuestName.md delete mode 100644 wiki-information/functions/GetAccountExpansionLevel.md delete mode 100644 wiki-information/functions/GetAchievementCategory.md delete mode 100644 wiki-information/functions/GetAchievementComparisonInfo.md delete mode 100644 wiki-information/functions/GetAchievementCriteriaInfo.md delete mode 100644 wiki-information/functions/GetAchievementCriteriaInfoByID.md delete mode 100644 wiki-information/functions/GetAchievementLink.md delete mode 100644 wiki-information/functions/GetAchievementNumCriteria.md delete mode 100644 wiki-information/functions/GetActionBarPage.md delete mode 100644 wiki-information/functions/GetActionBarToggles.md delete mode 100644 wiki-information/functions/GetActionCharges.md delete mode 100644 wiki-information/functions/GetActionCooldown.md delete mode 100644 wiki-information/functions/GetActionCount.md delete mode 100644 wiki-information/functions/GetActionInfo.md delete mode 100644 wiki-information/functions/GetActionLossOfControlCooldown.md delete mode 100644 wiki-information/functions/GetActionText.md delete mode 100644 wiki-information/functions/GetActionTexture.md delete mode 100644 wiki-information/functions/GetActiveTalentGroup.md delete mode 100644 wiki-information/functions/GetAddOnCPUUsage.md delete mode 100644 wiki-information/functions/GetAddOnDependencies.md delete mode 100644 wiki-information/functions/GetAddOnEnableState.md delete mode 100644 wiki-information/functions/GetAddOnInfo.md delete mode 100644 wiki-information/functions/GetAddOnMemoryUsage.md delete mode 100644 wiki-information/functions/GetAddOnMetadata.md delete mode 100644 wiki-information/functions/GetAllowLowLevelRaid.md delete mode 100644 wiki-information/functions/GetArenaTeamIndexBySize.md delete mode 100644 wiki-information/functions/GetArenaTeamRosterInfo.md delete mode 100644 wiki-information/functions/GetArmorPenetration.md delete mode 100644 wiki-information/functions/GetAtlasInfo.md delete mode 100644 wiki-information/functions/GetAttackPowerForStat.md delete mode 100644 wiki-information/functions/GetAuctionItemBattlePetInfo.md delete mode 100644 wiki-information/functions/GetAuctionItemInfo.md delete mode 100644 wiki-information/functions/GetAuctionItemLink.md delete mode 100644 wiki-information/functions/GetAuctionItemSubClasses.md delete mode 100644 wiki-information/functions/GetAutoCompleteRealms.md delete mode 100644 wiki-information/functions/GetAutoCompleteResults.md delete mode 100644 wiki-information/functions/GetAutoDeclineGuildInvites.md delete mode 100644 wiki-information/functions/GetAvailableBandwidth.md delete mode 100644 wiki-information/functions/GetAvailableLocales.md delete mode 100644 wiki-information/functions/GetAverageItemLevel.md delete mode 100644 wiki-information/functions/GetBackgroundLoadingStatus.md delete mode 100644 wiki-information/functions/GetBackpackCurrencyInfo.md delete mode 100644 wiki-information/functions/GetBankSlotCost.md delete mode 100644 wiki-information/functions/GetBattlefieldEstimatedWaitTime.md delete mode 100644 wiki-information/functions/GetBattlefieldFlagPosition.md delete mode 100644 wiki-information/functions/GetBattlefieldInstanceExpiration.md delete mode 100644 wiki-information/functions/GetBattlefieldInstanceInfo.md delete mode 100644 wiki-information/functions/GetBattlefieldInstanceRunTime.md delete mode 100644 wiki-information/functions/GetBattlefieldPortExpiration.md delete mode 100644 wiki-information/functions/GetBattlefieldScore.md delete mode 100644 wiki-information/functions/GetBattlefieldStatInfo.md delete mode 100644 wiki-information/functions/GetBattlefieldStatus.md delete mode 100644 wiki-information/functions/GetBattlefieldTimeWaited.md delete mode 100644 wiki-information/functions/GetBattlefieldWinner.md delete mode 100644 wiki-information/functions/GetBattlegroundInfo.md delete mode 100644 wiki-information/functions/GetBattlegroundPoints.md delete mode 100644 wiki-information/functions/GetBestFlexRaidChoice.md delete mode 100644 wiki-information/functions/GetBestRFChoice.md delete mode 100644 wiki-information/functions/GetBillingTimeRested.md delete mode 100644 wiki-information/functions/GetBindLocation.md delete mode 100644 wiki-information/functions/GetBinding.md delete mode 100644 wiki-information/functions/GetBindingAction.md delete mode 100644 wiki-information/functions/GetBindingByKey.md delete mode 100644 wiki-information/functions/GetBindingKey.md delete mode 100644 wiki-information/functions/GetBindingText.md delete mode 100644 wiki-information/functions/GetBlockChance.md delete mode 100644 wiki-information/functions/GetBonusBarOffset.md delete mode 100644 wiki-information/functions/GetBuildInfo.md delete mode 100644 wiki-information/functions/GetButtonMetatable.md delete mode 100644 wiki-information/functions/GetBuybackItemInfo.md delete mode 100644 wiki-information/functions/GetCVarInfo.md delete mode 100644 wiki-information/functions/GetCameraZoom.md delete mode 100644 wiki-information/functions/GetCategoryList.md delete mode 100644 wiki-information/functions/GetCategoryNumAchievements.md delete mode 100644 wiki-information/functions/GetCemeteryPreference.md delete mode 100644 wiki-information/functions/GetChannelList.md delete mode 100644 wiki-information/functions/GetChannelName.md delete mode 100644 wiki-information/functions/GetChatWindowInfo.md delete mode 100644 wiki-information/functions/GetChatWindowMessages.md delete mode 100644 wiki-information/functions/GetClassInfo.md delete mode 100644 wiki-information/functions/GetClassicExpansionLevel.md delete mode 100644 wiki-information/functions/GetClickFrame.md delete mode 100644 wiki-information/functions/GetClientDisplayExpansionLevel.md delete mode 100644 wiki-information/functions/GetCoinIcon.md delete mode 100644 wiki-information/functions/GetCoinText.md delete mode 100644 wiki-information/functions/GetCoinTextureString.md delete mode 100644 wiki-information/functions/GetCombatRating.md delete mode 100644 wiki-information/functions/GetCombatRatingBonus.md delete mode 100644 wiki-information/functions/GetComboPoints.md delete mode 100644 wiki-information/functions/GetCompanionCooldown.md delete mode 100644 wiki-information/functions/GetCompanionInfo.md delete mode 100644 wiki-information/functions/GetComparisonStatistic.md delete mode 100644 wiki-information/functions/GetContainerFreeSlots.md delete mode 100644 wiki-information/functions/GetContainerItemCooldown.md delete mode 100644 wiki-information/functions/GetContainerItemDurability.md delete mode 100644 wiki-information/functions/GetContainerItemID.md delete mode 100644 wiki-information/functions/GetContainerItemInfo.md delete mode 100644 wiki-information/functions/GetContainerItemLink.md delete mode 100644 wiki-information/functions/GetContainerNumFreeSlots.md delete mode 100644 wiki-information/functions/GetContainerNumSlots.md delete mode 100644 wiki-information/functions/GetCorpseRecoveryDelay.md delete mode 100644 wiki-information/functions/GetCraftDescription.md delete mode 100644 wiki-information/functions/GetCraftDisplaySkillLine.md delete mode 100644 wiki-information/functions/GetCraftInfo.md delete mode 100644 wiki-information/functions/GetCraftItemLink.md delete mode 100644 wiki-information/functions/GetCraftName.md delete mode 100644 wiki-information/functions/GetCraftNumReagents.md delete mode 100644 wiki-information/functions/GetCraftReagentInfo.md delete mode 100644 wiki-information/functions/GetCraftReagentItemLink.md delete mode 100644 wiki-information/functions/GetCraftRecipeLink.md delete mode 100644 wiki-information/functions/GetCraftSkillLine.md delete mode 100644 wiki-information/functions/GetCraftSpellFocus.md delete mode 100644 wiki-information/functions/GetCritChance.md delete mode 100644 wiki-information/functions/GetCurrencyInfo.md delete mode 100644 wiki-information/functions/GetCurrencyLink.md delete mode 100644 wiki-information/functions/GetCurrencyListInfo.md delete mode 100644 wiki-information/functions/GetCurrencyListSize.md delete mode 100644 wiki-information/functions/GetCurrentBindingSet.md delete mode 100644 wiki-information/functions/GetCurrentCombatTextEventInfo.md delete mode 100644 wiki-information/functions/GetCurrentEventID.md delete mode 100644 wiki-information/functions/GetCurrentGraphicsAPI.md delete mode 100644 wiki-information/functions/GetCurrentRegion.md delete mode 100644 wiki-information/functions/GetCurrentRegionName.md delete mode 100644 wiki-information/functions/GetCurrentResolution.md delete mode 100644 wiki-information/functions/GetCurrentTitle.md delete mode 100644 wiki-information/functions/GetCursorDelta.md delete mode 100644 wiki-information/functions/GetCursorInfo.md delete mode 100644 wiki-information/functions/GetCursorMoney.md delete mode 100644 wiki-information/functions/GetCursorPosition.md delete mode 100644 wiki-information/functions/GetDeathRecapLink.md delete mode 100644 wiki-information/functions/GetDefaultLanguage.md delete mode 100644 wiki-information/functions/GetDefaultScale.md delete mode 100644 wiki-information/functions/GetDetailedItemLevelInfo.md delete mode 100644 wiki-information/functions/GetDifficultyInfo.md delete mode 100644 wiki-information/functions/GetDodgeChance.md delete mode 100644 wiki-information/functions/GetDodgeChanceFromAttribute.md delete mode 100644 wiki-information/functions/GetDownloadedPercentage.md delete mode 100644 wiki-information/functions/GetDungeonDifficultyID.md delete mode 100644 wiki-information/functions/GetEditBoxMetatable.md delete mode 100644 wiki-information/functions/GetEventTime.md delete mode 100644 wiki-information/functions/GetExpansionDisplayInfo.md delete mode 100644 wiki-information/functions/GetExpansionLevel.md delete mode 100644 wiki-information/functions/GetExpansionTrialInfo.md delete mode 100644 wiki-information/functions/GetExpertise.md delete mode 100644 wiki-information/functions/GetExpertisePercent.md delete mode 100644 wiki-information/functions/GetFactionInfo.md delete mode 100644 wiki-information/functions/GetFactionInfoByID.md delete mode 100644 wiki-information/functions/GetFileIDFromPath.md delete mode 100644 wiki-information/functions/GetFileStreamingStatus.md delete mode 100644 wiki-information/functions/GetFirstBagBankSlotIndex.md delete mode 100644 wiki-information/functions/GetFirstTradeSkill.md delete mode 100644 wiki-information/functions/GetFontInfo.md delete mode 100644 wiki-information/functions/GetFontStringMetatable.md delete mode 100644 wiki-information/functions/GetFonts.md delete mode 100644 wiki-information/functions/GetFrameCPUUsage.md delete mode 100644 wiki-information/functions/GetFrameMetatable.md delete mode 100644 wiki-information/functions/GetFramerate.md delete mode 100644 wiki-information/functions/GetFramesRegisteredForEvent.md delete mode 100644 wiki-information/functions/GetFunctionCPUUsage.md delete mode 100644 wiki-information/functions/GetGameTime.md delete mode 100644 wiki-information/functions/GetGlyphLink.md delete mode 100644 wiki-information/functions/GetGlyphSocketInfo.md delete mode 100644 wiki-information/functions/GetGossipActiveQuests.md delete mode 100644 wiki-information/functions/GetGossipAvailableQuests.md delete mode 100644 wiki-information/functions/GetGossipOptions.md delete mode 100644 wiki-information/functions/GetGossipText.md delete mode 100644 wiki-information/functions/GetGraphicsAPIs.md delete mode 100644 wiki-information/functions/GetGuildBankItemInfo.md delete mode 100644 wiki-information/functions/GetGuildBankItemLink.md delete mode 100644 wiki-information/functions/GetGuildBankMoney.md delete mode 100644 wiki-information/functions/GetGuildBankTabInfo.md delete mode 100644 wiki-information/functions/GetGuildBankTabPermissions.md delete mode 100644 wiki-information/functions/GetGuildBankTransaction.md delete mode 100644 wiki-information/functions/GetGuildBankWithdrawGoldLimit.md delete mode 100644 wiki-information/functions/GetGuildBankWithdrawMoney.md delete mode 100644 wiki-information/functions/GetGuildInfo.md delete mode 100644 wiki-information/functions/GetGuildRosterInfo.md delete mode 100644 wiki-information/functions/GetGuildRosterLastOnline.md delete mode 100644 wiki-information/functions/GetGuildRosterMOTD.md delete mode 100644 wiki-information/functions/GetGuildRosterShowOffline.md delete mode 100644 wiki-information/functions/GetGuildTabardFiles.md delete mode 100644 wiki-information/functions/GetHaste.md delete mode 100644 wiki-information/functions/GetHitModifier.md delete mode 100644 wiki-information/functions/GetHomePartyInfo.md delete mode 100644 wiki-information/functions/GetInboxHeaderInfo.md delete mode 100644 wiki-information/functions/GetInboxInvoiceInfo.md delete mode 100644 wiki-information/functions/GetInboxItem.md delete mode 100644 wiki-information/functions/GetInboxItemLink.md delete mode 100644 wiki-information/functions/GetInboxNumItems.md delete mode 100644 wiki-information/functions/GetInspectArenaData.md delete mode 100644 wiki-information/functions/GetInspectHonorData.md delete mode 100644 wiki-information/functions/GetInspectPVPRankProgress.md delete mode 100644 wiki-information/functions/GetInstanceBootTimeRemaining.md delete mode 100644 wiki-information/functions/GetInstanceInfo.md delete mode 100644 wiki-information/functions/GetInstanceLockTimeRemaining.md delete mode 100644 wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md delete mode 100644 wiki-information/functions/GetInventoryAlertStatus.md delete mode 100644 wiki-information/functions/GetInventoryItemBroken.md delete mode 100644 wiki-information/functions/GetInventoryItemCooldown.md delete mode 100644 wiki-information/functions/GetInventoryItemCount.md delete mode 100644 wiki-information/functions/GetInventoryItemDurability.md delete mode 100644 wiki-information/functions/GetInventoryItemGems.md delete mode 100644 wiki-information/functions/GetInventoryItemID.md delete mode 100644 wiki-information/functions/GetInventoryItemLink.md delete mode 100644 wiki-information/functions/GetInventoryItemQuality.md delete mode 100644 wiki-information/functions/GetInventoryItemTexture.md delete mode 100644 wiki-information/functions/GetInventoryItemsForSlot.md delete mode 100644 wiki-information/functions/GetInventorySlotInfo.md delete mode 100644 wiki-information/functions/GetInviteConfirmationInfo.md delete mode 100644 wiki-information/functions/GetInviteReferralInfo.md delete mode 100644 wiki-information/functions/GetItemClassInfo.md delete mode 100644 wiki-information/functions/GetItemCooldown.md delete mode 100644 wiki-information/functions/GetItemCount.md delete mode 100644 wiki-information/functions/GetItemFamily.md delete mode 100644 wiki-information/functions/GetItemGem.md delete mode 100644 wiki-information/functions/GetItemIcon.md delete mode 100644 wiki-information/functions/GetItemInfo.md delete mode 100644 wiki-information/functions/GetItemInfoInstant.md delete mode 100644 wiki-information/functions/GetItemQualityColor.md delete mode 100644 wiki-information/functions/GetItemSpecInfo.md delete mode 100644 wiki-information/functions/GetItemSpell.md delete mode 100644 wiki-information/functions/GetItemStats.md delete mode 100644 wiki-information/functions/GetItemSubClassInfo.md delete mode 100644 wiki-information/functions/GetLFGBootProposal.md delete mode 100644 wiki-information/functions/GetLFGDeserterExpiration.md delete mode 100644 wiki-information/functions/GetLFGDungeonEncounterInfo.md delete mode 100644 wiki-information/functions/GetLFGDungeonInfo.md delete mode 100644 wiki-information/functions/GetLFGDungeonNumEncounters.md delete mode 100644 wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md delete mode 100644 wiki-information/functions/GetLFGRoles.md delete mode 100644 wiki-information/functions/GetLanguageByIndex.md delete mode 100644 wiki-information/functions/GetLatestThreeSenders.md delete mode 100644 wiki-information/functions/GetLocale.md delete mode 100644 wiki-information/functions/GetLootInfo.md delete mode 100644 wiki-information/functions/GetLootMethod.md delete mode 100644 wiki-information/functions/GetLootRollItemInfo.md delete mode 100644 wiki-information/functions/GetLootRollItemLink.md delete mode 100644 wiki-information/functions/GetLootSlotInfo.md delete mode 100644 wiki-information/functions/GetLootSlotLink.md delete mode 100644 wiki-information/functions/GetLootSlotType.md delete mode 100644 wiki-information/functions/GetLootSourceInfo.md delete mode 100644 wiki-information/functions/GetLootThreshold.md delete mode 100644 wiki-information/functions/GetMacroBody.md delete mode 100644 wiki-information/functions/GetMacroIndexByName.md delete mode 100644 wiki-information/functions/GetMacroInfo.md delete mode 100644 wiki-information/functions/GetMacroSpell.md delete mode 100644 wiki-information/functions/GetManaRegen.md delete mode 100644 wiki-information/functions/GetMasterLootCandidate.md delete mode 100644 wiki-information/functions/GetMaxBattlefieldID.md delete mode 100644 wiki-information/functions/GetMaxLevelForExpansionLevel.md delete mode 100644 wiki-information/functions/GetMaximumExpansionLevel.md delete mode 100644 wiki-information/functions/GetMeleeHaste.md delete mode 100644 wiki-information/functions/GetMerchantItemCostInfo.md delete mode 100644 wiki-information/functions/GetMerchantItemCostItem.md delete mode 100644 wiki-information/functions/GetMerchantItemID.md delete mode 100644 wiki-information/functions/GetMerchantItemInfo.md delete mode 100644 wiki-information/functions/GetMerchantItemLink.md delete mode 100644 wiki-information/functions/GetMerchantItemMaxStack.md delete mode 100644 wiki-information/functions/GetMerchantNumItems.md delete mode 100644 wiki-information/functions/GetMinimapZoneText.md delete mode 100644 wiki-information/functions/GetMinimumExpansionLevel.md delete mode 100644 wiki-information/functions/GetMirrorTimerInfo.md delete mode 100644 wiki-information/functions/GetMirrorTimerProgress.md delete mode 100644 wiki-information/functions/GetModifiedClick.md delete mode 100644 wiki-information/functions/GetMoney.md delete mode 100644 wiki-information/functions/GetMouseButtonClicked.md delete mode 100644 wiki-information/functions/GetMouseFocus.md delete mode 100644 wiki-information/functions/GetMultiCastTotemSpells.md delete mode 100644 wiki-information/functions/GetNetStats.md delete mode 100644 wiki-information/functions/GetNextAchievement.md delete mode 100644 wiki-information/functions/GetNextStableSlotCost.md delete mode 100644 wiki-information/functions/GetNormalizedRealmName.md delete mode 100644 wiki-information/functions/GetNumActiveQuests.md delete mode 100644 wiki-information/functions/GetNumAddOns.md delete mode 100644 wiki-information/functions/GetNumAuctionItems.md delete mode 100644 wiki-information/functions/GetNumAvailableQuests.md delete mode 100644 wiki-information/functions/GetNumBankSlots.md delete mode 100644 wiki-information/functions/GetNumBattlefieldStats.md delete mode 100644 wiki-information/functions/GetNumBattlefields.md delete mode 100644 wiki-information/functions/GetNumBattlegroundTypes.md delete mode 100644 wiki-information/functions/GetNumBindings.md delete mode 100644 wiki-information/functions/GetNumBuybackItems.md delete mode 100644 wiki-information/functions/GetNumClasses.md delete mode 100644 wiki-information/functions/GetNumCompanions.md delete mode 100644 wiki-information/functions/GetNumComparisonCompletedAchievements.md delete mode 100644 wiki-information/functions/GetNumCompletedAchievements.md delete mode 100644 wiki-information/functions/GetNumCrafts.md delete mode 100644 wiki-information/functions/GetNumDeclensionSets.md delete mode 100644 wiki-information/functions/GetNumExpansions.md delete mode 100644 wiki-information/functions/GetNumFactions.md delete mode 100644 wiki-information/functions/GetNumFlexRaidDungeons.md delete mode 100644 wiki-information/functions/GetNumFrames.md delete mode 100644 wiki-information/functions/GetNumGlyphSockets.md delete mode 100644 wiki-information/functions/GetNumGossipActiveQuests.md delete mode 100644 wiki-information/functions/GetNumGossipAvailableQuests.md delete mode 100644 wiki-information/functions/GetNumGossipOptions.md delete mode 100644 wiki-information/functions/GetNumGroupMembers.md delete mode 100644 wiki-information/functions/GetNumGuildMembers.md delete mode 100644 wiki-information/functions/GetNumLanguages.md delete mode 100644 wiki-information/functions/GetNumLootItems.md delete mode 100644 wiki-information/functions/GetNumMacros.md delete mode 100644 wiki-information/functions/GetNumPetitionNames.md delete mode 100644 wiki-information/functions/GetNumQuestChoices.md delete mode 100644 wiki-information/functions/GetNumQuestItems.md delete mode 100644 wiki-information/functions/GetNumQuestLeaderBoards.md delete mode 100644 wiki-information/functions/GetNumQuestLogChoices.md delete mode 100644 wiki-information/functions/GetNumQuestLogEntries.md delete mode 100644 wiki-information/functions/GetNumQuestLogRewards.md delete mode 100644 wiki-information/functions/GetNumQuestRewards.md delete mode 100644 wiki-information/functions/GetNumQuestWatches.md delete mode 100644 wiki-information/functions/GetNumRewardCurrencies.md delete mode 100644 wiki-information/functions/GetNumSavedInstances.md delete mode 100644 wiki-information/functions/GetNumSkillLines.md delete mode 100644 wiki-information/functions/GetNumSockets.md delete mode 100644 wiki-information/functions/GetNumSpellTabs.md delete mode 100644 wiki-information/functions/GetNumStableSlots.md delete mode 100644 wiki-information/functions/GetNumSubgroupMembers.md delete mode 100644 wiki-information/functions/GetNumTalentGroups.md delete mode 100644 wiki-information/functions/GetNumTalentTabs.md delete mode 100644 wiki-information/functions/GetNumTalents.md delete mode 100644 wiki-information/functions/GetNumTitles.md delete mode 100644 wiki-information/functions/GetNumTrackedAchievements.md delete mode 100644 wiki-information/functions/GetNumTradeSkills.md delete mode 100644 wiki-information/functions/GetOSLocale.md delete mode 100644 wiki-information/functions/GetObjectIconTextureCoords.md delete mode 100644 wiki-information/functions/GetOptOutOfLoot.md delete mode 100644 wiki-information/functions/GetOwnerAuctionItems.md delete mode 100644 wiki-information/functions/GetPVPDesired.md delete mode 100644 wiki-information/functions/GetPVPLastWeekStats.md delete mode 100644 wiki-information/functions/GetPVPLifetimeStats.md delete mode 100644 wiki-information/functions/GetPVPRankInfo.md delete mode 100644 wiki-information/functions/GetPVPRankProgress.md delete mode 100644 wiki-information/functions/GetPVPRoles.md delete mode 100644 wiki-information/functions/GetPVPSessionStats.md delete mode 100644 wiki-information/functions/GetPVPThisWeekStats.md delete mode 100644 wiki-information/functions/GetPVPTimer.md delete mode 100644 wiki-information/functions/GetPVPYesterdayStats.md delete mode 100644 wiki-information/functions/GetParryChance.md delete mode 100644 wiki-information/functions/GetParryChanceFromAttribute.md delete mode 100644 wiki-information/functions/GetPartyAssignment.md delete mode 100644 wiki-information/functions/GetPersonalRatedInfo.md delete mode 100644 wiki-information/functions/GetPetActionCooldown.md delete mode 100644 wiki-information/functions/GetPetActionInfo.md delete mode 100644 wiki-information/functions/GetPetActionSlotUsable.md delete mode 100644 wiki-information/functions/GetPetExperience.md delete mode 100644 wiki-information/functions/GetPetFoodTypes.md delete mode 100644 wiki-information/functions/GetPetHappiness.md delete mode 100644 wiki-information/functions/GetPetLoyalty.md delete mode 100644 wiki-information/functions/GetPetSpellBonusDamage.md delete mode 100644 wiki-information/functions/GetPetTrainingPoints.md delete mode 100644 wiki-information/functions/GetPetitionInfo.md delete mode 100644 wiki-information/functions/GetPhysicalScreenSize.md delete mode 100644 wiki-information/functions/GetPlayerFacing.md delete mode 100644 wiki-information/functions/GetPlayerInfoByGUID.md delete mode 100644 wiki-information/functions/GetPossessInfo.md delete mode 100644 wiki-information/functions/GetPreviousAchievement.md delete mode 100644 wiki-information/functions/GetProfessionInfo.md delete mode 100644 wiki-information/functions/GetQuestBackgroundMaterial.md delete mode 100644 wiki-information/functions/GetQuestCurrencyInfo.md delete mode 100644 wiki-information/functions/GetQuestFactionGroup.md delete mode 100644 wiki-information/functions/GetQuestGreenRange.md delete mode 100644 wiki-information/functions/GetQuestID.md delete mode 100644 wiki-information/functions/GetQuestIndexForTimer.md delete mode 100644 wiki-information/functions/GetQuestIndexForWatch.md delete mode 100644 wiki-information/functions/GetQuestItemInfo.md delete mode 100644 wiki-information/functions/GetQuestItemLink.md delete mode 100644 wiki-information/functions/GetQuestLink.md delete mode 100644 wiki-information/functions/GetQuestLogGroupNum.md delete mode 100644 wiki-information/functions/GetQuestLogIndexByID.md delete mode 100644 wiki-information/functions/GetQuestLogItemLink.md delete mode 100644 wiki-information/functions/GetQuestLogLeaderBoard.md delete mode 100644 wiki-information/functions/GetQuestLogPushable.md delete mode 100644 wiki-information/functions/GetQuestLogQuestText.md delete mode 100644 wiki-information/functions/GetQuestLogRequiredMoney.md delete mode 100644 wiki-information/functions/GetQuestLogRewardCurrencyInfo.md delete mode 100644 wiki-information/functions/GetQuestLogRewardInfo.md delete mode 100644 wiki-information/functions/GetQuestLogRewardMoney.md delete mode 100644 wiki-information/functions/GetQuestLogRewardSpell.md delete mode 100644 wiki-information/functions/GetQuestLogSpecialItemCooldown.md delete mode 100644 wiki-information/functions/GetQuestLogSpecialItemInfo.md delete mode 100644 wiki-information/functions/GetQuestLogTimeLeft.md delete mode 100644 wiki-information/functions/GetQuestLogTitle.md delete mode 100644 wiki-information/functions/GetQuestResetTime.md delete mode 100644 wiki-information/functions/GetQuestReward.md delete mode 100644 wiki-information/functions/GetQuestSortIndex.md delete mode 100644 wiki-information/functions/GetQuestTagInfo.md delete mode 100644 wiki-information/functions/GetQuestTimers.md delete mode 100644 wiki-information/functions/GetQuestsCompleted.md delete mode 100644 wiki-information/functions/GetRFDungeonInfo.md delete mode 100644 wiki-information/functions/GetRaidDifficultyID.md delete mode 100644 wiki-information/functions/GetRaidRosterInfo.md delete mode 100644 wiki-information/functions/GetRaidTargetIndex.md delete mode 100644 wiki-information/functions/GetRangedCritChance.md delete mode 100644 wiki-information/functions/GetRangedHaste.md delete mode 100644 wiki-information/functions/GetRealZoneText.md delete mode 100644 wiki-information/functions/GetRealmID.md delete mode 100644 wiki-information/functions/GetRealmName.md delete mode 100644 wiki-information/functions/GetRepairAllCost.md delete mode 100644 wiki-information/functions/GetRestState.md delete mode 100644 wiki-information/functions/GetRestrictedAccountData.md delete mode 100644 wiki-information/functions/GetRewardSpell.md delete mode 100644 wiki-information/functions/GetRewardXP.md delete mode 100644 wiki-information/functions/GetRuneCooldown.md delete mode 100644 wiki-information/functions/GetRuneType.md delete mode 100644 wiki-information/functions/GetSavedInstanceChatLink.md delete mode 100644 wiki-information/functions/GetSavedInstanceEncounterInfo.md delete mode 100644 wiki-information/functions/GetSavedInstanceInfo.md delete mode 100644 wiki-information/functions/GetScenariosChoiceOrder.md delete mode 100644 wiki-information/functions/GetSchoolString.md delete mode 100644 wiki-information/functions/GetScreenDPIScale.md delete mode 100644 wiki-information/functions/GetScreenHeight.md delete mode 100644 wiki-information/functions/GetScreenResolutions.md delete mode 100644 wiki-information/functions/GetScreenWidth.md delete mode 100644 wiki-information/functions/GetSecondsUntilParentalControlsKick.md delete mode 100644 wiki-information/functions/GetSelectedBattlefield.md delete mode 100644 wiki-information/functions/GetSelectedSkill.md delete mode 100644 wiki-information/functions/GetSelectedStablePet.md delete mode 100644 wiki-information/functions/GetSendMailCOD.md delete mode 100644 wiki-information/functions/GetSendMailItem.md delete mode 100644 wiki-information/functions/GetSendMailItemLink.md delete mode 100644 wiki-information/functions/GetSendMailPrice.md delete mode 100644 wiki-information/functions/GetServerExpansionLevel.md delete mode 100644 wiki-information/functions/GetServerTime.md delete mode 100644 wiki-information/functions/GetSessionTime.md delete mode 100644 wiki-information/functions/GetShapeshiftForm.md delete mode 100644 wiki-information/functions/GetShapeshiftFormCooldown.md delete mode 100644 wiki-information/functions/GetShapeshiftFormID.md delete mode 100644 wiki-information/functions/GetShapeshiftFormInfo.md delete mode 100644 wiki-information/functions/GetSheathState.md delete mode 100644 wiki-information/functions/GetShieldBlock.md delete mode 100644 wiki-information/functions/GetSkillLineInfo.md delete mode 100644 wiki-information/functions/GetSocketItemBoundTradeable.md delete mode 100644 wiki-information/functions/GetSocketItemInfo.md delete mode 100644 wiki-information/functions/GetSocketItemRefundable.md delete mode 100644 wiki-information/functions/GetSocketTypes.md delete mode 100644 wiki-information/functions/GetSoundEntryCount.md delete mode 100644 wiki-information/functions/GetSpellAutocast.md delete mode 100644 wiki-information/functions/GetSpellBaseCooldown.md delete mode 100644 wiki-information/functions/GetSpellBonusDamage.md delete mode 100644 wiki-information/functions/GetSpellBonusHealing.md delete mode 100644 wiki-information/functions/GetSpellBookItemInfo.md delete mode 100644 wiki-information/functions/GetSpellBookItemName.md delete mode 100644 wiki-information/functions/GetSpellBookItemTexture.md delete mode 100644 wiki-information/functions/GetSpellCharges.md delete mode 100644 wiki-information/functions/GetSpellCooldown.md delete mode 100644 wiki-information/functions/GetSpellCount.md delete mode 100644 wiki-information/functions/GetSpellCritChance.md delete mode 100644 wiki-information/functions/GetSpellDescription.md delete mode 100644 wiki-information/functions/GetSpellHitModifier.md delete mode 100644 wiki-information/functions/GetSpellInfo.md delete mode 100644 wiki-information/functions/GetSpellLink.md delete mode 100644 wiki-information/functions/GetSpellLossOfControlCooldown.md delete mode 100644 wiki-information/functions/GetSpellPenetration.md delete mode 100644 wiki-information/functions/GetSpellPowerCost.md delete mode 100644 wiki-information/functions/GetSpellTabInfo.md delete mode 100644 wiki-information/functions/GetSpellTexture.md delete mode 100644 wiki-information/functions/GetStablePetFoodTypes.md delete mode 100644 wiki-information/functions/GetStablePetInfo.md delete mode 100644 wiki-information/functions/GetStatistic.md delete mode 100644 wiki-information/functions/GetStatisticsCategoryList.md delete mode 100644 wiki-information/functions/GetSubZoneText.md delete mode 100644 wiki-information/functions/GetSuggestedGroupNum.md delete mode 100644 wiki-information/functions/GetSummonFriendCooldown.md delete mode 100644 wiki-information/functions/GetSuperTrackedQuestID.md delete mode 100644 wiki-information/functions/GetTalentGroupRole.md delete mode 100644 wiki-information/functions/GetTalentInfo.md delete mode 100644 wiki-information/functions/GetTalentPrereqs.md delete mode 100644 wiki-information/functions/GetTalentTabInfo.md delete mode 100644 wiki-information/functions/GetTaxiBenchmarkMode.md delete mode 100644 wiki-information/functions/GetTaxiMapID.md delete mode 100644 wiki-information/functions/GetText.md delete mode 100644 wiki-information/functions/GetThreatStatusColor.md delete mode 100644 wiki-information/functions/GetTickTime.md delete mode 100644 wiki-information/functions/GetTime.md delete mode 100644 wiki-information/functions/GetTimePreciseSec.md delete mode 100644 wiki-information/functions/GetTitleName.md delete mode 100644 wiki-information/functions/GetTitleText.md delete mode 100644 wiki-information/functions/GetTotalAchievementPoints.md delete mode 100644 wiki-information/functions/GetTotemCannotDismiss.md delete mode 100644 wiki-information/functions/GetTotemTimeLeft.md delete mode 100644 wiki-information/functions/GetTrackedAchievements.md delete mode 100644 wiki-information/functions/GetTrackingInfo.md delete mode 100644 wiki-information/functions/GetTrackingTexture.md delete mode 100644 wiki-information/functions/GetTradePlayerItemInfo.md delete mode 100644 wiki-information/functions/GetTradeSkillDescription.md delete mode 100644 wiki-information/functions/GetTradeSkillInfo.md delete mode 100644 wiki-information/functions/GetTradeSkillInvSlotFilter.md delete mode 100644 wiki-information/functions/GetTradeSkillItemLink.md delete mode 100644 wiki-information/functions/GetTradeSkillItemStats.md delete mode 100644 wiki-information/functions/GetTradeSkillLine.md delete mode 100644 wiki-information/functions/GetTradeSkillListLink.md delete mode 100644 wiki-information/functions/GetTradeSkillNumMade.md delete mode 100644 wiki-information/functions/GetTradeSkillNumReagents.md delete mode 100644 wiki-information/functions/GetTradeSkillReagentInfo.md delete mode 100644 wiki-information/functions/GetTradeSkillReagentItemLink.md delete mode 100644 wiki-information/functions/GetTradeSkillRecipeLink.md delete mode 100644 wiki-information/functions/GetTradeSkillSelectionIndex.md delete mode 100644 wiki-information/functions/GetTradeSkillSubClassFilter.md delete mode 100644 wiki-information/functions/GetTradeTargetItemInfo.md delete mode 100644 wiki-information/functions/GetTradeskillRepeatCount.md delete mode 100644 wiki-information/functions/GetTrainerServiceAbilityReq.md delete mode 100644 wiki-information/functions/GetTrainerServiceDescription.md delete mode 100644 wiki-information/functions/GetTrainerServiceItemLink.md delete mode 100644 wiki-information/functions/GetTrainerServiceLevelReq.md delete mode 100644 wiki-information/functions/GetTrainerServiceSkillLine.md delete mode 100644 wiki-information/functions/GetTrainerServiceSkillReq.md delete mode 100644 wiki-information/functions/GetTrainerServiceTypeFilter.md delete mode 100644 wiki-information/functions/GetUICameraInfo.md delete mode 100644 wiki-information/functions/GetUnitHealthModifier.md delete mode 100644 wiki-information/functions/GetUnitMaxHealthModifier.md delete mode 100644 wiki-information/functions/GetUnitPowerModifier.md delete mode 100644 wiki-information/functions/GetUnitSpeed.md delete mode 100644 wiki-information/functions/GetUnspentTalentPoints.md delete mode 100644 wiki-information/functions/GetVehicleUIIndicator.md delete mode 100644 wiki-information/functions/GetVehicleUIIndicatorSeat.md delete mode 100644 wiki-information/functions/GetWatchedFactionInfo.md delete mode 100644 wiki-information/functions/GetWeaponEnchantInfo.md delete mode 100644 wiki-information/functions/GetWebTicket.md delete mode 100644 wiki-information/functions/GetXPExhaustion.md delete mode 100644 wiki-information/functions/GetZonePVPInfo.md delete mode 100644 wiki-information/functions/GetZoneText.md delete mode 100644 wiki-information/functions/GuildControlDelRank.md delete mode 100644 wiki-information/functions/GuildControlGetRankFlags.md delete mode 100644 wiki-information/functions/GuildControlGetRankName.md delete mode 100644 wiki-information/functions/GuildControlSaveRank.md delete mode 100644 wiki-information/functions/GuildControlSetRank.md delete mode 100644 wiki-information/functions/GuildControlSetRankFlag.md delete mode 100644 wiki-information/functions/GuildDemote.md delete mode 100644 wiki-information/functions/GuildDisband.md delete mode 100644 wiki-information/functions/GuildInvite.md delete mode 100644 wiki-information/functions/GuildPromote.md delete mode 100644 wiki-information/functions/GuildRosterSetOfficerNote.md delete mode 100644 wiki-information/functions/GuildRosterSetPublicNote.md delete mode 100644 wiki-information/functions/GuildSetLeader.md delete mode 100644 wiki-information/functions/GuildSetMOTD.md delete mode 100644 wiki-information/functions/GuildUninvite.md delete mode 100644 wiki-information/functions/HasAction.md delete mode 100644 wiki-information/functions/HasDualWieldPenalty.md delete mode 100644 wiki-information/functions/HasFullControl.md delete mode 100644 wiki-information/functions/HasIgnoreDualWieldWeapon.md delete mode 100644 wiki-information/functions/HasInspectHonorData.md delete mode 100644 wiki-information/functions/HasKey.md delete mode 100644 wiki-information/functions/HasLFGRestrictions.md delete mode 100644 wiki-information/functions/HasNoReleaseAura.md delete mode 100644 wiki-information/functions/HasPetSpells.md delete mode 100644 wiki-information/functions/HasPetUI.md delete mode 100644 wiki-information/functions/HasWandEquipped.md delete mode 100644 wiki-information/functions/InActiveBattlefield.md delete mode 100644 wiki-information/functions/InCinematic.md delete mode 100644 wiki-information/functions/InCombatLockdown.md delete mode 100644 wiki-information/functions/InRepairMode.md delete mode 100644 wiki-information/functions/InboxItemCanDelete.md delete mode 100644 wiki-information/functions/InitiateRolePoll.md delete mode 100644 wiki-information/functions/InitiateTrade.md delete mode 100644 wiki-information/functions/InviteUnit.md delete mode 100644 wiki-information/functions/Is64BitClient.md delete mode 100644 wiki-information/functions/IsAccountSecured.md delete mode 100644 wiki-information/functions/IsAchievementEligible.md delete mode 100644 wiki-information/functions/IsActionInRange.md delete mode 100644 wiki-information/functions/IsActiveBattlefieldArena.md delete mode 100644 wiki-information/functions/IsAddOnLoadOnDemand.md delete mode 100644 wiki-information/functions/IsAddOnLoaded.md delete mode 100644 wiki-information/functions/IsAllowedToUserTeleport.md delete mode 100644 wiki-information/functions/IsAltKeyDown.md delete mode 100644 wiki-information/functions/IsAttackAction.md delete mode 100644 wiki-information/functions/IsAttackSpell.md delete mode 100644 wiki-information/functions/IsAutoRepeatAction.md delete mode 100644 wiki-information/functions/IsBattlePayItem.md delete mode 100644 wiki-information/functions/IsCemeterySelectionAvailable.md delete mode 100644 wiki-information/functions/IsConsumableAction.md delete mode 100644 wiki-information/functions/IsConsumableItem.md delete mode 100644 wiki-information/functions/IsControlKeyDown.md delete mode 100644 wiki-information/functions/IsCurrentAction.md delete mode 100644 wiki-information/functions/IsCurrentSpell.md delete mode 100644 wiki-information/functions/IsDebugBuild.md delete mode 100644 wiki-information/functions/IsDualWielding.md delete mode 100644 wiki-information/functions/IsEquippableItem.md delete mode 100644 wiki-information/functions/IsEquippedAction.md delete mode 100644 wiki-information/functions/IsEquippedItem.md delete mode 100644 wiki-information/functions/IsEquippedItemType.md delete mode 100644 wiki-information/functions/IsEuropeanNumbers.md delete mode 100644 wiki-information/functions/IsExpansionTrial.md delete mode 100644 wiki-information/functions/IsFactionInactive.md delete mode 100644 wiki-information/functions/IsFalling.md delete mode 100644 wiki-information/functions/IsFishingLoot.md delete mode 100644 wiki-information/functions/IsFlyableArea.md delete mode 100644 wiki-information/functions/IsFlying.md delete mode 100644 wiki-information/functions/IsGMClient.md delete mode 100644 wiki-information/functions/IsGUIDInGroup.md delete mode 100644 wiki-information/functions/IsGuildLeader.md delete mode 100644 wiki-information/functions/IsInCinematicScene.md delete mode 100644 wiki-information/functions/IsInGroup.md delete mode 100644 wiki-information/functions/IsInGuild.md delete mode 100644 wiki-information/functions/IsInGuildGroup.md delete mode 100644 wiki-information/functions/IsInInstance.md delete mode 100644 wiki-information/functions/IsInLFGDungeon.md delete mode 100644 wiki-information/functions/IsInRaid.md delete mode 100644 wiki-information/functions/IsIndoors.md delete mode 100644 wiki-information/functions/IsItemInRange.md delete mode 100644 wiki-information/functions/IsLeftAltKeyDown.md delete mode 100644 wiki-information/functions/IsLeftControlKeyDown.md delete mode 100644 wiki-information/functions/IsLeftShiftKeyDown.md delete mode 100644 wiki-information/functions/IsMacClient.md delete mode 100644 wiki-information/functions/IsMetaKeyDown.md delete mode 100644 wiki-information/functions/IsModifiedClick.md delete mode 100644 wiki-information/functions/IsModifierKeyDown.md delete mode 100644 wiki-information/functions/IsMounted.md delete mode 100644 wiki-information/functions/IsMouseButtonDown.md delete mode 100644 wiki-information/functions/IsMouselooking.md delete mode 100644 wiki-information/functions/IsMovieLocal.md delete mode 100644 wiki-information/functions/IsMoviePlayable.md delete mode 100644 wiki-information/functions/IsOnGlueScreen.md delete mode 100644 wiki-information/functions/IsOnTournamentRealm.md delete mode 100644 wiki-information/functions/IsOutOfBounds.md delete mode 100644 wiki-information/functions/IsOutdoors.md delete mode 100644 wiki-information/functions/IsPVPTimerRunning.md delete mode 100644 wiki-information/functions/IsPassiveSpell.md delete mode 100644 wiki-information/functions/IsPetAttackActive.md delete mode 100644 wiki-information/functions/IsPlayerAttacking.md delete mode 100644 wiki-information/functions/IsPlayerInGuildFromGUID.md delete mode 100644 wiki-information/functions/IsPlayerInWorld.md delete mode 100644 wiki-information/functions/IsPlayerMoving.md delete mode 100644 wiki-information/functions/IsPlayerSpell.md delete mode 100644 wiki-information/functions/IsPublicBuild.md delete mode 100644 wiki-information/functions/IsQuestCompletable.md delete mode 100644 wiki-information/functions/IsQuestComplete.md delete mode 100644 wiki-information/functions/IsQuestHardWatched.md delete mode 100644 wiki-information/functions/IsQuestWatched.md delete mode 100644 wiki-information/functions/IsRangedWeapon.md delete mode 100644 wiki-information/functions/IsRecognizedName.md delete mode 100644 wiki-information/functions/IsReferAFriendLinked.md delete mode 100644 wiki-information/functions/IsResting.md delete mode 100644 wiki-information/functions/IsRestrictedAccount.md delete mode 100644 wiki-information/functions/IsRightAltKeyDown.md delete mode 100644 wiki-information/functions/IsRightControlKeyDown.md delete mode 100644 wiki-information/functions/IsRightMetaKeyDown.md delete mode 100644 wiki-information/functions/IsRightShiftKeyDown.md delete mode 100644 wiki-information/functions/IsShiftKeyDown.md delete mode 100644 wiki-information/functions/IsSpellInRange.md delete mode 100644 wiki-information/functions/IsSpellKnown.md delete mode 100644 wiki-information/functions/IsStealthed.md delete mode 100644 wiki-information/functions/IsSubmerged.md delete mode 100644 wiki-information/functions/IsSwimming.md delete mode 100644 wiki-information/functions/IsTargetLoose.md delete mode 100644 wiki-information/functions/IsThreatWarningEnabled.md delete mode 100644 wiki-information/functions/IsTitleKnown.md delete mode 100644 wiki-information/functions/IsTrackedAchievement.md delete mode 100644 wiki-information/functions/IsTradeskillTrainer.md delete mode 100644 wiki-information/functions/IsTrainerServiceLearnSpell.md delete mode 100644 wiki-information/functions/IsTrialAccount.md delete mode 100644 wiki-information/functions/IsUnitOnQuestByQuestID.md delete mode 100644 wiki-information/functions/IsUsableAction.md delete mode 100644 wiki-information/functions/IsUsableSpell.md delete mode 100644 wiki-information/functions/IsUsingFixedTimeStep.md delete mode 100644 wiki-information/functions/IsUsingGamepad.md delete mode 100644 wiki-information/functions/IsUsingMouse.md delete mode 100644 wiki-information/functions/IsVeteranTrialAccount.md delete mode 100644 wiki-information/functions/IsWargame.md delete mode 100644 wiki-information/functions/IsXPUserDisabled.md delete mode 100644 wiki-information/functions/ItemTextGetCreator.md delete mode 100644 wiki-information/functions/ItemTextGetItem.md delete mode 100644 wiki-information/functions/ItemTextGetMaterial.md delete mode 100644 wiki-information/functions/ItemTextGetPage.md delete mode 100644 wiki-information/functions/ItemTextGetText.md delete mode 100644 wiki-information/functions/ItemTextHasNextPage.md delete mode 100644 wiki-information/functions/ItemTextNextPage.md delete mode 100644 wiki-information/functions/ItemTextPrevPage.md delete mode 100644 wiki-information/functions/JoinBattlefield.md delete mode 100644 wiki-information/functions/JoinChannelByName.md delete mode 100644 wiki-information/functions/JoinPermanentChannel.md delete mode 100644 wiki-information/functions/JoinSkirmish.md delete mode 100644 wiki-information/functions/JoinTemporaryChannel.md delete mode 100644 wiki-information/functions/JumpOrAscendStart.md delete mode 100644 wiki-information/functions/KBArticle_BeginLoading.md delete mode 100644 wiki-information/functions/KBArticle_GetData.md delete mode 100644 wiki-information/functions/KBArticle_IsLoaded.md delete mode 100644 wiki-information/functions/KBSetup_BeginLoading.md delete mode 100644 wiki-information/functions/KBSetup_GetArticleHeaderCount.md delete mode 100644 wiki-information/functions/KBSetup_GetArticleHeaderData.md delete mode 100644 wiki-information/functions/KBSetup_GetCategoryCount.md delete mode 100644 wiki-information/functions/KBSetup_GetCategoryData.md delete mode 100644 wiki-information/functions/KBSetup_GetLanguageCount.md delete mode 100644 wiki-information/functions/KBSetup_GetLanguageData.md delete mode 100644 wiki-information/functions/KBSetup_GetSubCategoryCount.md delete mode 100644 wiki-information/functions/KBSetup_GetSubCategoryData.md delete mode 100644 wiki-information/functions/KBSetup_GetTotalArticleCount.md delete mode 100644 wiki-information/functions/KBSetup_IsLoaded.md delete mode 100644 wiki-information/functions/KBSystem_GetMOTD.md delete mode 100644 wiki-information/functions/KBSystem_GetServerNotice.md delete mode 100644 wiki-information/functions/KBSystem_GetServerStatus.md delete mode 100644 wiki-information/functions/KeyRingButtonIDToInvSlotID.md delete mode 100644 wiki-information/functions/LFGTeleport.md delete mode 100644 wiki-information/functions/LearnTalent.md delete mode 100644 wiki-information/functions/LeaveChannelByName.md delete mode 100644 wiki-information/functions/ListChannelByName.md delete mode 100644 wiki-information/functions/LoadAddOn.md delete mode 100644 wiki-information/functions/LoadBindings.md delete mode 100644 wiki-information/functions/LoadURLIndex.md delete mode 100644 wiki-information/functions/LoggingChat.md delete mode 100644 wiki-information/functions/LoggingCombat.md delete mode 100644 wiki-information/functions/Logout.md delete mode 100644 wiki-information/functions/LootSlot.md delete mode 100644 wiki-information/functions/LootSlotHasItem.md delete mode 100644 wiki-information/functions/MouselookStart.md delete mode 100644 wiki-information/functions/MouselookStop.md delete mode 100644 wiki-information/functions/MoveBackwardStart.md delete mode 100644 wiki-information/functions/MoveBackwardStop.md delete mode 100644 wiki-information/functions/MoveForwardStart.md delete mode 100644 wiki-information/functions/MoveForwardStop.md delete mode 100644 wiki-information/functions/MoveViewDownStart.md delete mode 100644 wiki-information/functions/MoveViewDownStop.md delete mode 100644 wiki-information/functions/MoveViewInStart.md delete mode 100644 wiki-information/functions/MoveViewInStop.md delete mode 100644 wiki-information/functions/MoveViewLeftStart.md delete mode 100644 wiki-information/functions/MoveViewLeftStop.md delete mode 100644 wiki-information/functions/MoveViewOutStart.md delete mode 100644 wiki-information/functions/MoveViewOutStop.md delete mode 100644 wiki-information/functions/MoveViewRightStart.md delete mode 100644 wiki-information/functions/MoveViewRightStop.md delete mode 100644 wiki-information/functions/MoveViewUpStart.md delete mode 100644 wiki-information/functions/MoveViewUpStop.md delete mode 100644 wiki-information/functions/MuteSoundFile.md delete mode 100644 wiki-information/functions/NoPlayTime.md delete mode 100644 wiki-information/functions/NotWhileDeadError.md delete mode 100644 wiki-information/functions/NotifyInspect.md delete mode 100644 wiki-information/functions/NumTaxiNodes.md delete mode 100644 wiki-information/functions/OfferPetition.md delete mode 100644 wiki-information/functions/PartialPlayTime.md delete mode 100644 wiki-information/functions/PetAbandon.md delete mode 100644 wiki-information/functions/PetAggressiveMode.md delete mode 100644 wiki-information/functions/PetAttack.md delete mode 100644 wiki-information/functions/PetCanBeAbandoned.md delete mode 100644 wiki-information/functions/PetCanBeRenamed.md delete mode 100644 wiki-information/functions/PetDefensiveMode.md delete mode 100644 wiki-information/functions/PetFollow.md delete mode 100644 wiki-information/functions/PetPassiveMode.md delete mode 100644 wiki-information/functions/PetRename.md delete mode 100644 wiki-information/functions/PetStopAttack.md delete mode 100644 wiki-information/functions/PetWait.md delete mode 100644 wiki-information/functions/PickupAction.md delete mode 100644 wiki-information/functions/PickupBagFromSlot.md delete mode 100644 wiki-information/functions/PickupCompanion.md delete mode 100644 wiki-information/functions/PickupContainerItem.md delete mode 100644 wiki-information/functions/PickupCurrency.md delete mode 100644 wiki-information/functions/PickupInventoryItem.md delete mode 100644 wiki-information/functions/PickupItem.md delete mode 100644 wiki-information/functions/PickupMacro.md delete mode 100644 wiki-information/functions/PickupMerchantItem.md delete mode 100644 wiki-information/functions/PickupPetAction.md delete mode 100644 wiki-information/functions/PickupPetSpell.md delete mode 100644 wiki-information/functions/PickupPlayerMoney.md delete mode 100644 wiki-information/functions/PickupSpell.md delete mode 100644 wiki-information/functions/PickupSpellBookItem.md delete mode 100644 wiki-information/functions/PickupStablePet.md delete mode 100644 wiki-information/functions/PickupTradeMoney.md delete mode 100644 wiki-information/functions/PlaceAction.md delete mode 100644 wiki-information/functions/PlayMusic.md delete mode 100644 wiki-information/functions/PlaySound.md delete mode 100644 wiki-information/functions/PlaySoundFile.md delete mode 100644 wiki-information/functions/PlayerCanTeleport.md delete mode 100644 wiki-information/functions/PlayerEffectiveAttackPower.md delete mode 100644 wiki-information/functions/PlayerHasToy.md delete mode 100644 wiki-information/functions/PlayerIsPVPInactive.md delete mode 100644 wiki-information/functions/PostAuction.md delete mode 100644 wiki-information/functions/PreloadMovie.md delete mode 100644 wiki-information/functions/ProcessExceptionClient.md delete mode 100644 wiki-information/functions/PromoteToLeader.md delete mode 100644 wiki-information/functions/PutItemInBackpack.md delete mode 100644 wiki-information/functions/PutItemInBag.md delete mode 100644 wiki-information/functions/QueryAuctionItems.md delete mode 100644 wiki-information/functions/QuestChooseRewardError.md delete mode 100644 wiki-information/functions/QuestIsDaily.md delete mode 100644 wiki-information/functions/QuestLogPushQuest.md delete mode 100644 wiki-information/functions/QuestPOIGetIconInfo.md delete mode 100644 wiki-information/functions/Quit.md delete mode 100644 wiki-information/functions/RandomRoll.md delete mode 100644 wiki-information/functions/RejectProposal.md delete mode 100644 wiki-information/functions/RemoveChatWindowChannel.md delete mode 100644 wiki-information/functions/RemoveChatWindowMessages.md delete mode 100644 wiki-information/functions/RemoveQuestWatch.md delete mode 100644 wiki-information/functions/RemoveTrackedAchievement.md delete mode 100644 wiki-information/functions/RenamePetition.md delete mode 100644 wiki-information/functions/RepairAllItems.md delete mode 100644 wiki-information/functions/ReplaceEnchant.md delete mode 100644 wiki-information/functions/ReplaceGuildMaster.md delete mode 100644 wiki-information/functions/ReplaceTradeEnchant.md delete mode 100644 wiki-information/functions/RepopMe.md delete mode 100644 wiki-information/functions/ReportBug.md delete mode 100644 wiki-information/functions/ReportPlayerIsPVPAFK.md delete mode 100644 wiki-information/functions/ReportSuggestion.md delete mode 100644 wiki-information/functions/RequestBattlefieldScoreData.md delete mode 100644 wiki-information/functions/RequestBattlegroundInstanceInfo.md delete mode 100644 wiki-information/functions/RequestInspectHonorData.md delete mode 100644 wiki-information/functions/RequestInviteFromUnit.md delete mode 100644 wiki-information/functions/RequestRaidInfo.md delete mode 100644 wiki-information/functions/RequestRatedInfo.md delete mode 100644 wiki-information/functions/RequestTimePlayed.md delete mode 100644 wiki-information/functions/ResetCursor.md delete mode 100644 wiki-information/functions/ResetTutorials.md delete mode 100644 wiki-information/functions/ResistancePercent.md delete mode 100644 wiki-information/functions/RespondInstanceLock.md delete mode 100644 wiki-information/functions/ResurrectGetOfferer.md delete mode 100644 wiki-information/functions/ResurrectHasSickness.md delete mode 100644 wiki-information/functions/ResurrectHasTimer.md delete mode 100644 wiki-information/functions/RetrieveCorpse.md delete mode 100644 wiki-information/functions/RollOnLoot.md delete mode 100644 wiki-information/functions/RunBinding.md delete mode 100644 wiki-information/functions/RunMacro.md delete mode 100644 wiki-information/functions/RunMacroText.md delete mode 100644 wiki-information/functions/RunScript.md delete mode 100644 wiki-information/functions/SaveBindings.md delete mode 100644 wiki-information/functions/SaveView.md delete mode 100644 wiki-information/functions/Screenshot.md delete mode 100644 wiki-information/functions/SearchLFGGetNumResults.md delete mode 100644 wiki-information/functions/SearchLFGJoin.md delete mode 100644 wiki-information/functions/SecureCmdOptionParse.md delete mode 100644 wiki-information/functions/SelectGossipActiveQuest.md delete mode 100644 wiki-information/functions/SelectGossipAvailableQuest.md delete mode 100644 wiki-information/functions/SelectGossipOption.md delete mode 100644 wiki-information/functions/SelectQuestLogEntry.md delete mode 100644 wiki-information/functions/SelectTrainerService.md delete mode 100644 wiki-information/functions/SelectedRealmName.md delete mode 100644 wiki-information/functions/SendChatMessage.md delete mode 100644 wiki-information/functions/SendMail.md delete mode 100644 wiki-information/functions/SendSystemMessage.md delete mode 100644 wiki-information/functions/SetAbandonQuest.md delete mode 100644 wiki-information/functions/SetAchievementComparisonUnit.md delete mode 100644 wiki-information/functions/SetActionBarToggles.md delete mode 100644 wiki-information/functions/SetActiveTalentGroup.md delete mode 100644 wiki-information/functions/SetAllowDangerousScripts.md delete mode 100644 wiki-information/functions/SetAllowLowLevelRaid.md delete mode 100644 wiki-information/functions/SetAutoDeclineGuildInvites.md delete mode 100644 wiki-information/functions/SetBattlefieldScoreFaction.md delete mode 100644 wiki-information/functions/SetBinding.md delete mode 100644 wiki-information/functions/SetBindingClick.md delete mode 100644 wiki-information/functions/SetBindingItem.md delete mode 100644 wiki-information/functions/SetBindingMacro.md delete mode 100644 wiki-information/functions/SetBindingSpell.md delete mode 100644 wiki-information/functions/SetCemeteryPreference.md delete mode 100644 wiki-information/functions/SetChannelPassword.md delete mode 100644 wiki-information/functions/SetConsoleKey.md delete mode 100644 wiki-information/functions/SetCurrencyBackpack.md delete mode 100644 wiki-information/functions/SetCurrencyUnused.md delete mode 100644 wiki-information/functions/SetCurrentTitle.md delete mode 100644 wiki-information/functions/SetCursor.md delete mode 100644 wiki-information/functions/SetDungeonDifficultyID.md delete mode 100644 wiki-information/functions/SetFactionActive.md delete mode 100644 wiki-information/functions/SetFactionInactive.md delete mode 100644 wiki-information/functions/SetGuildBankTabInfo.md delete mode 100644 wiki-information/functions/SetGuildBankTabPermissions.md delete mode 100644 wiki-information/functions/SetGuildBankText.md delete mode 100644 wiki-information/functions/SetGuildBankWithdrawGoldLimit.md delete mode 100644 wiki-information/functions/SetGuildInfoText.md delete mode 100644 wiki-information/functions/SetGuildRosterShowOffline.md delete mode 100644 wiki-information/functions/SetInWorldUIVisibility.md delete mode 100644 wiki-information/functions/SetLFGComment.md delete mode 100644 wiki-information/functions/SetLegacyRaidDifficultyID.md delete mode 100644 wiki-information/functions/SetLootThreshold.md delete mode 100644 wiki-information/functions/SetMacroSpell.md delete mode 100644 wiki-information/functions/SetModifiedClick.md delete mode 100644 wiki-information/functions/SetMoveEnabled.md delete mode 100644 wiki-information/functions/SetMultiCastSpell.md delete mode 100644 wiki-information/functions/SetOptOutOfLoot.md delete mode 100644 wiki-information/functions/SetOverrideBinding.md delete mode 100644 wiki-information/functions/SetOverrideBindingClick.md delete mode 100644 wiki-information/functions/SetOverrideBindingItem.md delete mode 100644 wiki-information/functions/SetOverrideBindingMacro.md delete mode 100644 wiki-information/functions/SetOverrideBindingSpell.md delete mode 100644 wiki-information/functions/SetPVP.md delete mode 100644 wiki-information/functions/SetPVPRoles.md delete mode 100644 wiki-information/functions/SetPendingReportPetTarget.md delete mode 100644 wiki-information/functions/SetPendingReportTarget.md delete mode 100644 wiki-information/functions/SetPetStablePaperdoll.md delete mode 100644 wiki-information/functions/SetPortraitTexture.md delete mode 100644 wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md delete mode 100644 wiki-information/functions/SetPortraitToTexture.md delete mode 100644 wiki-information/functions/SetRaidDifficultyID.md delete mode 100644 wiki-information/functions/SetRaidTarget.md delete mode 100644 wiki-information/functions/SetScreenResolution.md delete mode 100644 wiki-information/functions/SetSelectedBattlefield.md delete mode 100644 wiki-information/functions/SetSelectedSkill.md delete mode 100644 wiki-information/functions/SetSuperTrackedQuestID.md delete mode 100644 wiki-information/functions/SetTalentGroupRole.md delete mode 100644 wiki-information/functions/SetTaxiMap.md delete mode 100644 wiki-information/functions/SetTracking.md delete mode 100644 wiki-information/functions/SetTradeMoney.md delete mode 100644 wiki-information/functions/SetTradeSkillItemLevelFilter.md delete mode 100644 wiki-information/functions/SetTradeSkillSubClassFilter.md delete mode 100644 wiki-information/functions/SetTrainerServiceTypeFilter.md delete mode 100644 wiki-information/functions/SetTurnEnabled.md delete mode 100644 wiki-information/functions/SetUIVisibility.md delete mode 100644 wiki-information/functions/SetUnitCursorTexture.md delete mode 100644 wiki-information/functions/SetView.md delete mode 100644 wiki-information/functions/SetWatchedFactionIndex.md delete mode 100644 wiki-information/functions/SetupFullscreenScale.md delete mode 100644 wiki-information/functions/ShiftQuestWatches.md delete mode 100644 wiki-information/functions/ShowBossFrameWhenUninteractable.md delete mode 100644 wiki-information/functions/ShowCloak.md delete mode 100644 wiki-information/functions/ShowHelm.md delete mode 100644 wiki-information/functions/ShowQuestComplete.md delete mode 100644 wiki-information/functions/ShowRepairCursor.md delete mode 100644 wiki-information/functions/ShowingCloak.md delete mode 100644 wiki-information/functions/ShowingHelm.md delete mode 100644 wiki-information/functions/SitStandOrDescendStart.md delete mode 100644 wiki-information/functions/SortAuctionSetSort.md delete mode 100644 wiki-information/functions/SortQuestWatches.md delete mode 100644 wiki-information/functions/SpellCanTargetUnit.md delete mode 100644 wiki-information/functions/SpellGetVisibilityInfo.md delete mode 100644 wiki-information/functions/SpellIsTargeting.md delete mode 100644 wiki-information/functions/SpellStopCasting.md delete mode 100644 wiki-information/functions/SpellStopTargeting.md delete mode 100644 wiki-information/functions/SpellTargetUnit.md delete mode 100644 wiki-information/functions/SplitContainerItem.md delete mode 100644 wiki-information/functions/StablePet.md delete mode 100644 wiki-information/functions/StartAuction.md delete mode 100644 wiki-information/functions/StartDuel.md delete mode 100644 wiki-information/functions/StopMusic.md delete mode 100644 wiki-information/functions/StopSound.md delete mode 100644 wiki-information/functions/StopTradeSkillRepeat.md delete mode 100644 wiki-information/functions/StrafeLeftStart.md delete mode 100644 wiki-information/functions/StrafeLeftStop.md delete mode 100644 wiki-information/functions/StrafeRightStart.md delete mode 100644 wiki-information/functions/StrafeRightStop.md delete mode 100644 wiki-information/functions/StripHyperlinks.md delete mode 100644 wiki-information/functions/Stuck.md delete mode 100644 wiki-information/functions/SummonFriend.md delete mode 100644 wiki-information/functions/SupportsClipCursor.md delete mode 100644 wiki-information/functions/SwapRaidSubgroup.md delete mode 100644 wiki-information/functions/TakeInboxItem.md delete mode 100644 wiki-information/functions/TakeInboxMoney.md delete mode 100644 wiki-information/functions/TakeTaxiNode.md delete mode 100644 wiki-information/functions/TargetDirectionEnemy.md delete mode 100644 wiki-information/functions/TargetDirectionFriend.md delete mode 100644 wiki-information/functions/TargetLastEnemy.md delete mode 100644 wiki-information/functions/TargetLastTarget.md delete mode 100644 wiki-information/functions/TargetNearest.md delete mode 100644 wiki-information/functions/TargetNearestEnemy.md delete mode 100644 wiki-information/functions/TargetNearestEnemyPlayer.md delete mode 100644 wiki-information/functions/TargetNearestFriend.md delete mode 100644 wiki-information/functions/TargetNearestFriendPlayer.md delete mode 100644 wiki-information/functions/TargetNearestPartyMember.md delete mode 100644 wiki-information/functions/TargetNearestRaidMember.md delete mode 100644 wiki-information/functions/TargetPriorityHighlightStart.md delete mode 100644 wiki-information/functions/TargetTotem.md delete mode 100644 wiki-information/functions/TargetUnit.md delete mode 100644 wiki-information/functions/TaxiGetDestX.md delete mode 100644 wiki-information/functions/TaxiGetDestY.md delete mode 100644 wiki-information/functions/TaxiGetSrcX.md delete mode 100644 wiki-information/functions/TaxiGetSrcY.md delete mode 100644 wiki-information/functions/TaxiNodeCost.md delete mode 100644 wiki-information/functions/TaxiNodeGetType.md delete mode 100644 wiki-information/functions/TaxiNodeName.md delete mode 100644 wiki-information/functions/TimeoutResurrect.md delete mode 100644 wiki-information/functions/ToggleAutoRun.md delete mode 100644 wiki-information/functions/TogglePVP.md delete mode 100644 wiki-information/functions/ToggleRun.md delete mode 100644 wiki-information/functions/ToggleSelfHighlight.md delete mode 100644 wiki-information/functions/ToggleSheath.md delete mode 100644 wiki-information/functions/TurnLeftStart.md delete mode 100644 wiki-information/functions/TurnLeftStop.md delete mode 100644 wiki-information/functions/TurnOrActionStart.md delete mode 100644 wiki-information/functions/TurnOrActionStop.md delete mode 100644 wiki-information/functions/TurnRightStart.md delete mode 100644 wiki-information/functions/TurnRightStop.md delete mode 100644 wiki-information/functions/UninviteUnit.md delete mode 100644 wiki-information/functions/UnitAffectingCombat.md delete mode 100644 wiki-information/functions/UnitArmor.md delete mode 100644 wiki-information/functions/UnitAttackBothHands.md delete mode 100644 wiki-information/functions/UnitAttackPower.md delete mode 100644 wiki-information/functions/UnitAttackSpeed.md delete mode 100644 wiki-information/functions/UnitAura.md delete mode 100644 wiki-information/functions/UnitBuff.md delete mode 100644 wiki-information/functions/UnitCanAssist.md delete mode 100644 wiki-information/functions/UnitCanAttack.md delete mode 100644 wiki-information/functions/UnitCanCooperate.md delete mode 100644 wiki-information/functions/UnitCastingInfo.md delete mode 100644 wiki-information/functions/UnitChannelInfo.md delete mode 100644 wiki-information/functions/UnitCharacterPoints.md delete mode 100644 wiki-information/functions/UnitClass.md delete mode 100644 wiki-information/functions/UnitClassBase.md delete mode 100644 wiki-information/functions/UnitClassification.md delete mode 100644 wiki-information/functions/UnitControllingVehicle.md delete mode 100644 wiki-information/functions/UnitCreatureFamily.md delete mode 100644 wiki-information/functions/UnitCreatureType.md delete mode 100644 wiki-information/functions/UnitDamage.md delete mode 100644 wiki-information/functions/UnitDebuff.md delete mode 100644 wiki-information/functions/UnitDetailedThreatSituation.md delete mode 100644 wiki-information/functions/UnitDistanceSquared.md delete mode 100644 wiki-information/functions/UnitEffectiveLevel.md delete mode 100644 wiki-information/functions/UnitExists.md delete mode 100644 wiki-information/functions/UnitFactionGroup.md delete mode 100644 wiki-information/functions/UnitFullName.md delete mode 100644 wiki-information/functions/UnitGUID.md delete mode 100644 wiki-information/functions/UnitGetAvailableRoles.md delete mode 100644 wiki-information/functions/UnitGetIncomingHeals.md delete mode 100644 wiki-information/functions/UnitGroupRolesAssigned.md delete mode 100644 wiki-information/functions/UnitHPPerStamina.md delete mode 100644 wiki-information/functions/UnitHasIncomingResurrection.md delete mode 100644 wiki-information/functions/UnitHasLFGDeserter.md delete mode 100644 wiki-information/functions/UnitHasLFGRandomCooldown.md delete mode 100644 wiki-information/functions/UnitHasRelicSlot.md delete mode 100644 wiki-information/functions/UnitHasVehiclePlayerFrameUI.md delete mode 100644 wiki-information/functions/UnitHasVehicleUI.md delete mode 100644 wiki-information/functions/UnitHealth.md delete mode 100644 wiki-information/functions/UnitHealthMax.md delete mode 100644 wiki-information/functions/UnitInAnyGroup.md delete mode 100644 wiki-information/functions/UnitInBattleground.md delete mode 100644 wiki-information/functions/UnitInParty.md delete mode 100644 wiki-information/functions/UnitInPartyIsAI.md delete mode 100644 wiki-information/functions/UnitInPhase.md delete mode 100644 wiki-information/functions/UnitInRaid.md delete mode 100644 wiki-information/functions/UnitInRange.md delete mode 100644 wiki-information/functions/UnitInSubgroup.md delete mode 100644 wiki-information/functions/UnitInVehicle.md delete mode 100644 wiki-information/functions/UnitInVehicleControlSeat.md delete mode 100644 wiki-information/functions/UnitInVehicleHidesPetFrame.md delete mode 100644 wiki-information/functions/UnitIsAFK.md delete mode 100644 wiki-information/functions/UnitIsCharmed.md delete mode 100644 wiki-information/functions/UnitIsCivilian.md delete mode 100644 wiki-information/functions/UnitIsConnected.md delete mode 100644 wiki-information/functions/UnitIsControlling.md delete mode 100644 wiki-information/functions/UnitIsCorpse.md delete mode 100644 wiki-information/functions/UnitIsDND.md delete mode 100644 wiki-information/functions/UnitIsDead.md delete mode 100644 wiki-information/functions/UnitIsDeadOrGhost.md delete mode 100644 wiki-information/functions/UnitIsEnemy.md delete mode 100644 wiki-information/functions/UnitIsFeignDeath.md delete mode 100644 wiki-information/functions/UnitIsFriend.md delete mode 100644 wiki-information/functions/UnitIsGameObject.md delete mode 100644 wiki-information/functions/UnitIsGhost.md delete mode 100644 wiki-information/functions/UnitIsGroupAssistant.md delete mode 100644 wiki-information/functions/UnitIsGroupLeader.md delete mode 100644 wiki-information/functions/UnitIsInMyGuild.md delete mode 100644 wiki-information/functions/UnitIsInteractable.md delete mode 100644 wiki-information/functions/UnitIsOtherPlayersPet.md delete mode 100644 wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md delete mode 100644 wiki-information/functions/UnitIsPVPFreeForAll.md delete mode 100644 wiki-information/functions/UnitIsPVPSanctuary.md delete mode 100644 wiki-information/functions/UnitIsPlayer.md delete mode 100644 wiki-information/functions/UnitIsPossessed.md delete mode 100644 wiki-information/functions/UnitIsRaidOfficer.md delete mode 100644 wiki-information/functions/UnitIsSameServer.md delete mode 100644 wiki-information/functions/UnitIsTapDenied.md delete mode 100644 wiki-information/functions/UnitIsTrivial.md delete mode 100644 wiki-information/functions/UnitIsUnconscious.md delete mode 100644 wiki-information/functions/UnitIsUnit.md delete mode 100644 wiki-information/functions/UnitLevel.md delete mode 100644 wiki-information/functions/UnitName.md delete mode 100644 wiki-information/functions/UnitNameUnmodified.md delete mode 100644 wiki-information/functions/UnitOnTaxi.md delete mode 100644 wiki-information/functions/UnitPVPName.md delete mode 100644 wiki-information/functions/UnitPVPRank.md delete mode 100644 wiki-information/functions/UnitPlayerControlled.md delete mode 100644 wiki-information/functions/UnitPlayerOrPetInParty.md delete mode 100644 wiki-information/functions/UnitPlayerOrPetInRaid.md delete mode 100644 wiki-information/functions/UnitPosition.md delete mode 100644 wiki-information/functions/UnitPower.md delete mode 100644 wiki-information/functions/UnitPowerDisplayMod.md delete mode 100644 wiki-information/functions/UnitPowerMax.md delete mode 100644 wiki-information/functions/UnitPowerType.md delete mode 100644 wiki-information/functions/UnitRace.md delete mode 100644 wiki-information/functions/UnitRangedAttack.md delete mode 100644 wiki-information/functions/UnitRangedAttackPower.md delete mode 100644 wiki-information/functions/UnitRangedDamage.md delete mode 100644 wiki-information/functions/UnitReaction.md delete mode 100644 wiki-information/functions/UnitRealmRelationship.md delete mode 100644 wiki-information/functions/UnitResistance.md delete mode 100644 wiki-information/functions/UnitSelectionColor.md delete mode 100644 wiki-information/functions/UnitSetRole.md delete mode 100644 wiki-information/functions/UnitSex.md delete mode 100644 wiki-information/functions/UnitShouldDisplayName.md delete mode 100644 wiki-information/functions/UnitStat.md delete mode 100644 wiki-information/functions/UnitSwitchToVehicleSeat.md delete mode 100644 wiki-information/functions/UnitTargetsVehicleInRaidUI.md delete mode 100644 wiki-information/functions/UnitThreatPercentageOfLead.md delete mode 100644 wiki-information/functions/UnitThreatSituation.md delete mode 100644 wiki-information/functions/UnitTrialBankedLevels.md delete mode 100644 wiki-information/functions/UnitTrialXP.md delete mode 100644 wiki-information/functions/UnitUsingVehicle.md delete mode 100644 wiki-information/functions/UnitVehicleSeatCount.md delete mode 100644 wiki-information/functions/UnitVehicleSeatInfo.md delete mode 100644 wiki-information/functions/UnitVehicleSkin.md delete mode 100644 wiki-information/functions/UnitXP.md delete mode 100644 wiki-information/functions/UnitXPMax.md delete mode 100644 wiki-information/functions/UnmuteSoundFile.md delete mode 100644 wiki-information/functions/UnstablePet.md delete mode 100644 wiki-information/functions/UpdateWindow.md delete mode 100644 wiki-information/functions/UseAction.md delete mode 100644 wiki-information/functions/UseContainerItem.md delete mode 100644 wiki-information/functions/UseInventoryItem.md delete mode 100644 wiki-information/functions/UseItemByName.md delete mode 100644 wiki-information/functions/UseToy.md delete mode 100644 wiki-information/functions/UseToyByName.md delete mode 100644 wiki-information/functions/addframetext.md delete mode 100644 wiki-information/functions/debuglocals.md delete mode 100644 wiki-information/functions/debugprofilestart.md delete mode 100644 wiki-information/functions/debugprofilestop.md delete mode 100644 wiki-information/functions/debugstack.md delete mode 100644 wiki-information/functions/forceinsecure.md delete mode 100644 wiki-information/functions/geterrorhandler.md delete mode 100644 wiki-information/functions/hooksecurefunc.md delete mode 100644 wiki-information/functions/issecure.md delete mode 100644 wiki-information/functions/issecurevariable.md delete mode 100644 wiki-information/functions/pcallwithenv.md delete mode 100644 wiki-information/functions/scrub.md delete mode 100644 wiki-information/functions/securecall.md delete mode 100644 wiki-information/functions/securecallfunction.md delete mode 100644 wiki-information/functions/secureexecuterange.md delete mode 100644 wiki-information/functions/seterrorhandler.md diff --git a/wiki-information/events/ACHIEVEMENT_EARNED.md b/wiki-information/events/ACHIEVEMENT_EARNED.md deleted file mode 100644 index 2bdc96a9..00000000 --- a/wiki-information/events/ACHIEVEMENT_EARNED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ACHIEVEMENT_EARNED - -**Title:** ACHIEVEMENT EARNED - -**Content:** -Fired when an achievement is gained. -`ACHIEVEMENT_EARNED: achievementID, alreadyEarned` - -**Payload:** -- `achievementID` - - *number* - The id of the achievement gained. -- `alreadyEarned` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md b/wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md deleted file mode 100644 index af7083c5..00000000 --- a/wiki-information/events/ACHIEVEMENT_PLAYER_NAME.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ACHIEVEMENT_PLAYER_NAME - -**Title:** ACHIEVEMENT PLAYER NAME - -**Content:** -Needs summary. -`ACHIEVEMENT_PLAYER_NAME: achievementID` - -**Payload:** -- `achievementID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md b/wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md deleted file mode 100644 index 63a9d38d..00000000 --- a/wiki-information/events/ACHIEVEMENT_SEARCH_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACHIEVEMENT_SEARCH_UPDATED - -**Title:** ACHIEVEMENT SEARCH UPDATED - -**Content:** -Needs summary. -`ACHIEVEMENT_SEARCH_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_HIDEGRID.md b/wiki-information/events/ACTIONBAR_HIDEGRID.md deleted file mode 100644 index 860cbd27..00000000 --- a/wiki-information/events/ACTIONBAR_HIDEGRID.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACTIONBAR_HIDEGRID - -**Title:** ACTIONBAR HIDEGRID - -**Content:** -Fired when the actionbar numbers disappear, typically when you finish dragging something to the actionbar. -`ACTIONBAR_HIDEGRID` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_PAGE_CHANGED.md b/wiki-information/events/ACTIONBAR_PAGE_CHANGED.md deleted file mode 100644 index fe16a9d5..00000000 --- a/wiki-information/events/ACTIONBAR_PAGE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACTIONBAR_PAGE_CHANGED - -**Title:** ACTIONBAR PAGE CHANGED - -**Content:** -Fired when the actionbar page changes, typically when you press the pageup or pagedown button. -`ACTIONBAR_PAGE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_SHOWGRID.md b/wiki-information/events/ACTIONBAR_SHOWGRID.md deleted file mode 100644 index d6e8d0c5..00000000 --- a/wiki-information/events/ACTIONBAR_SHOWGRID.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACTIONBAR_SHOWGRID - -**Title:** ACTIONBAR SHOWGRID - -**Content:** -Fired when the actionbar numbers appear, typically when you drag a spell to the actionbar. -`ACTIONBAR_SHOWGRID` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md b/wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md deleted file mode 100644 index 8f3e2bbe..00000000 --- a/wiki-information/events/ACTIONBAR_SHOW_BOTTOMLEFT.md +++ /dev/null @@ -1,27 +0,0 @@ -## Event: ACTIONBAR_SHOW_BOTTOMLEFT - -**Title:** ACTIONBAR SHOW BOTTOMLEFT - -**Content:** -Fires if the bottom-left multi-action bar must appear to hold a new ability. -`ACTIONBAR_SHOW_BOTTOMLEFT` - -**Payload:** -- `None` - -**Content Details:** -The first return value from GetActionBarToggles() changes from false to true before this event fires. -This event fires (if necessary) before SPELL_PUSHED_TO_ACTIONBAR. - -**Usage:** -```lua --- prevent the MultiBarBottomLeft from appearing when the event fires -ActionBarController:UnregisterEvent("ACTIONBAR_SHOW_BOTTOMLEFT") --- return the options to their previous state, for the next /reload -local frame = CreateFrame("Frame") -frame:RegisterEvent("ACTIONBAR_SHOW_BOTTOMLEFT") -frame:SetScript("OnEvent", function() - local __, bottomRight, sideRight, sideLeft = GetActionBarToggles() - SetActionBarToggles(false, bottomRight, sideRight, sideLeft) -end) -``` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_SLOT_CHANGED.md b/wiki-information/events/ACTIONBAR_SLOT_CHANGED.md deleted file mode 100644 index d0f9672e..00000000 --- a/wiki-information/events/ACTIONBAR_SLOT_CHANGED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: ACTIONBAR_SLOT_CHANGED - -**Title:** ACTIONBAR SLOT CHANGED - -**Content:** -Fired when any actionbar slot's contents change; typically the picking up and dropping of buttons. -`ACTIONBAR_SLOT_CHANGED: slot` - -**Payload:** -- `slot` - - *number* - -**Content Details:** -On 4/24/2006, Slouken stated "ACTIONBAR_SLOT_CHANGED is also sent whenever something changes whether or not the button should be dimmed. The first argument is the slot which changed." This means actions that affect the internal fields of action bar buttons also generate this event for the affected button(s). Examples include the Start and End of casting channeled spells, casting a new buff on yourself, and the cancellation or expiration of a buff on yourself. \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md b/wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md deleted file mode 100644 index 5fba2342..00000000 --- a/wiki-information/events/ACTIONBAR_UPDATE_COOLDOWN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACTIONBAR_UPDATE_COOLDOWN - -**Title:** ACTIONBAR UPDATE COOLDOWN - -**Content:** -Fired when the cooldown for an actionbar or inventory slot starts or stops. Also fires when you log into a new area. -`ACTIONBAR_UPDATE_COOLDOWN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_UPDATE_STATE.md b/wiki-information/events/ACTIONBAR_UPDATE_STATE.md deleted file mode 100644 index 17fbe9ec..00000000 --- a/wiki-information/events/ACTIONBAR_UPDATE_STATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACTIONBAR_UPDATE_STATE - -**Title:** ACTIONBAR UPDATE STATE - -**Content:** -Fired when the state of anything on the actionbar changes. This includes cooldown and disabling. -`ACTIONBAR_UPDATE_STATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIONBAR_UPDATE_USABLE.md b/wiki-information/events/ACTIONBAR_UPDATE_USABLE.md deleted file mode 100644 index 1678fcae..00000000 --- a/wiki-information/events/ACTIONBAR_UPDATE_USABLE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACTIONBAR_UPDATE_USABLE - -**Title:** ACTIONBAR UPDATE USABLE - -**Content:** -Fired when something in the actionbar or your inventory becomes usable (after eating or drinking a potion, or entering/leaving stealth; for example). This is affected by rage/mana/energy available, but not by range. -`ACTIONBAR_UPDATE_USABLE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTION_WILL_BIND_ITEM.md b/wiki-information/events/ACTION_WILL_BIND_ITEM.md deleted file mode 100644 index 97e7f33f..00000000 --- a/wiki-information/events/ACTION_WILL_BIND_ITEM.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ACTION_WILL_BIND_ITEM - -**Title:** ACTION WILL BIND ITEM - -**Content:** -Needs summary. -`ACTION_WILL_BIND_ITEM` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ACTIVATE_GLYPH.md b/wiki-information/events/ACTIVATE_GLYPH.md deleted file mode 100644 index ead178c2..00000000 --- a/wiki-information/events/ACTIVATE_GLYPH.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ACTIVATE_GLYPH - -**Title:** ACTIVATE GLYPH - -**Content:** -Fires after successfully applying a new glyph to an ability in the spell book. -`ACTIVATE_GLYPH: spellID` - -**Payload:** -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md b/wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md deleted file mode 100644 index 42f3ef66..00000000 --- a/wiki-information/events/ACTIVE_TALENT_GROUP_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ACTIVE_TALENT_GROUP_CHANGED - -**Title:** ACTIVE TALENT GROUP CHANGED - -**Content:** -Fired when a player switches changes which talent group (dual specialization) is active. -`ACTIVE_TALENT_GROUP_CHANGED: curr, prev` - -**Payload:** -- `curr` - - *number* - Index of the talent group that is now active. -- `prev` - - *number* - Index of the talent group that was active before changing. \ No newline at end of file diff --git a/wiki-information/events/ADAPTER_LIST_CHANGED.md b/wiki-information/events/ADAPTER_LIST_CHANGED.md deleted file mode 100644 index b0b7010d..00000000 --- a/wiki-information/events/ADAPTER_LIST_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ADAPTER_LIST_CHANGED - -**Title:** ADAPTER LIST CHANGED - -**Content:** -Needs summary. -`ADAPTER_LIST_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ADDONS_UNLOADING.md b/wiki-information/events/ADDONS_UNLOADING.md deleted file mode 100644 index 7ce8e0a2..00000000 --- a/wiki-information/events/ADDONS_UNLOADING.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ADDONS_UNLOADING - -**Title:** ADDONS UNLOADING - -**Content:** -Needs summary. -`ADDONS_UNLOADING: closingClient` - -**Payload:** -- `closingClient` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/ADDON_ACTION_BLOCKED.md b/wiki-information/events/ADDON_ACTION_BLOCKED.md deleted file mode 100644 index d26d3164..00000000 --- a/wiki-information/events/ADDON_ACTION_BLOCKED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ADDON_ACTION_BLOCKED - -**Title:** ADDON ACTION BLOCKED - -**Content:** -Fires when a protected function is being called from tainted code, e.g. taint from an addon. -`ADDON_ACTION_BLOCKED: isTainted, function` - -**Payload:** -- `isTainted` - - *string* -- `function` - - *string* \ No newline at end of file diff --git a/wiki-information/events/ADDON_ACTION_FORBIDDEN.md b/wiki-information/events/ADDON_ACTION_FORBIDDEN.md deleted file mode 100644 index cbc46736..00000000 --- a/wiki-information/events/ADDON_ACTION_FORBIDDEN.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ADDON_ACTION_FORBIDDEN - -**Title:** ADDON ACTION FORBIDDEN - -**Content:** -Fires when an AddOn tries use actions that are always forbidden (movement, targeting, etc.). -`ADDON_ACTION_FORBIDDEN: isTainted, function` - -**Payload:** -- `isTainted` - - *string* - Name of the AddOn that was last involved in the execution path. It's very possible that the name will not be the name of the addon that tried to call the protected function. -- `function` - - *string* - The protected function that was called. \ No newline at end of file diff --git a/wiki-information/events/ADDON_LOADED.md b/wiki-information/events/ADDON_LOADED.md deleted file mode 100644 index 40427955..00000000 --- a/wiki-information/events/ADDON_LOADED.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: ADDON_LOADED - -**Title:** ADDON LOADED - -**Content:** -Fires after an AddOn has been loaded. -`ADDON_LOADED: addOnName, containsBindings` - -**Payload:** -- `addOnName` - - *string* - The name of the addon. -- `containsBindings` - - *boolean* - -**Content Details:** -An addon is loaded after all .lua files have been run and SavedVariables have loaded. -If there was an out-of-memory error, this event fires before SAVED_VARIABLES_TOO_LARGE. Otherwise, when saving variables between game sessions, this is the first time an AddOn can access its saved variables. \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_CLOSE.md b/wiki-information/events/ADVENTURE_MAP_CLOSE.md deleted file mode 100644 index 58f52307..00000000 --- a/wiki-information/events/ADVENTURE_MAP_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ADVENTURE_MAP_CLOSE - -**Title:** ADVENTURE MAP CLOSE - -**Content:** -Needs summary. -`ADVENTURE_MAP_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_OPEN.md b/wiki-information/events/ADVENTURE_MAP_OPEN.md deleted file mode 100644 index dd55bf79..00000000 --- a/wiki-information/events/ADVENTURE_MAP_OPEN.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ADVENTURE_MAP_OPEN - -**Title:** ADVENTURE MAP OPEN - -**Content:** -Needs summary. -`ADVENTURE_MAP_OPEN: followerTypeID` - -**Payload:** -- `followerTypeID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md b/wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md deleted file mode 100644 index 783a33eb..00000000 --- a/wiki-information/events/ADVENTURE_MAP_QUEST_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ADVENTURE_MAP_QUEST_UPDATE - -**Title:** ADVENTURE MAP QUEST UPDATE - -**Content:** -Needs summary. -`ADVENTURE_MAP_QUEST_UPDATE: questID` - -**Payload:** -- `questID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md b/wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md deleted file mode 100644 index dea07151..00000000 --- a/wiki-information/events/ADVENTURE_MAP_UPDATE_INSETS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ADVENTURE_MAP_UPDATE_INSETS - -**Title:** ADVENTURE MAP UPDATE INSETS - -**Content:** -Needs summary. -`ADVENTURE_MAP_UPDATE_INSETS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md b/wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md deleted file mode 100644 index d3dd62d6..00000000 --- a/wiki-information/events/ADVENTURE_MAP_UPDATE_POIS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ADVENTURE_MAP_UPDATE_POIS - -**Title:** ADVENTURE MAP UPDATE POIS - -**Content:** -Needs summary. -`ADVENTURE_MAP_UPDATE_POIS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_DUNGEON_ACTION.md b/wiki-information/events/AJ_DUNGEON_ACTION.md deleted file mode 100644 index c7b190ec..00000000 --- a/wiki-information/events/AJ_DUNGEON_ACTION.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AJ_DUNGEON_ACTION - -**Title:** AJ DUNGEON ACTION - -**Content:** -Needs summary. -`AJ_DUNGEON_ACTION: lfgDungeonID` - -**Payload:** -- `lfgDungeonID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_OPEN.md b/wiki-information/events/AJ_OPEN.md deleted file mode 100644 index e2100fbe..00000000 --- a/wiki-information/events/AJ_OPEN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AJ_OPEN - -**Title:** AJ OPEN - -**Content:** -Needs summary. -`AJ_OPEN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVE_LFG_ACTION.md b/wiki-information/events/AJ_PVE_LFG_ACTION.md deleted file mode 100644 index 2ea43c59..00000000 --- a/wiki-information/events/AJ_PVE_LFG_ACTION.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AJ_PVE_LFG_ACTION - -**Title:** AJ PVE LFG ACTION - -**Content:** -Needs summary. -`AJ_PVE_LFG_ACTION` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_ACTION.md b/wiki-information/events/AJ_PVP_ACTION.md deleted file mode 100644 index 75fa821b..00000000 --- a/wiki-information/events/AJ_PVP_ACTION.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AJ_PVP_ACTION - -**Title:** AJ PVP ACTION - -**Content:** -Needs summary. -`AJ_PVP_ACTION: battleMasterListID` - -**Payload:** -- `battleMasterListID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_LFG_ACTION.md b/wiki-information/events/AJ_PVP_LFG_ACTION.md deleted file mode 100644 index bbbcffc0..00000000 --- a/wiki-information/events/AJ_PVP_LFG_ACTION.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AJ_PVP_LFG_ACTION - -**Title:** AJ PVP LFG ACTION - -**Content:** -Needs summary. -`AJ_PVP_LFG_ACTION` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_RBG_ACTION.md b/wiki-information/events/AJ_PVP_RBG_ACTION.md deleted file mode 100644 index eb54ed74..00000000 --- a/wiki-information/events/AJ_PVP_RBG_ACTION.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AJ_PVP_RBG_ACTION - -**Title:** AJ PVP RBG ACTION - -**Content:** -Needs summary. -`AJ_PVP_RBG_ACTION` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md b/wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md deleted file mode 100644 index f4a4b90e..00000000 --- a/wiki-information/events/AJ_PVP_SKIRMISH_ACTION.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AJ_PVP_SKIRMISH_ACTION - -**Title:** AJ PVP SKIRMISH ACTION - -**Content:** -Needs summary. -`AJ_PVP_SKIRMISH_ACTION` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AJ_QUEST_LOG_OPEN.md b/wiki-information/events/AJ_QUEST_LOG_OPEN.md deleted file mode 100644 index e099b586..00000000 --- a/wiki-information/events/AJ_QUEST_LOG_OPEN.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: AJ_QUEST_LOG_OPEN - -**Title:** AJ QUEST LOG OPEN - -**Content:** -Needs summary. -`AJ_QUEST_LOG_OPEN: questID, uiMapID` - -**Payload:** -- `questID` - - *number* -- `uiMapID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_RAID_ACTION.md b/wiki-information/events/AJ_RAID_ACTION.md deleted file mode 100644 index 6eb2ff63..00000000 --- a/wiki-information/events/AJ_RAID_ACTION.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AJ_RAID_ACTION - -**Title:** AJ RAID ACTION - -**Content:** -Needs summary. -`AJ_RAID_ACTION: lfgDungeonID` - -**Payload:** -- `lfgDungeonID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AJ_REFRESH_DISPLAY.md b/wiki-information/events/AJ_REFRESH_DISPLAY.md deleted file mode 100644 index 0a0db8f2..00000000 --- a/wiki-information/events/AJ_REFRESH_DISPLAY.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AJ_REFRESH_DISPLAY - -**Title:** AJ REFRESH DISPLAY - -**Content:** -Needs summary. -`AJ_REFRESH_DISPLAY: newAdventureNotice` - -**Payload:** -- `newAdventureNotice` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/AJ_REWARD_DATA_RECEIVED.md b/wiki-information/events/AJ_REWARD_DATA_RECEIVED.md deleted file mode 100644 index 9db375d3..00000000 --- a/wiki-information/events/AJ_REWARD_DATA_RECEIVED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AJ_REWARD_DATA_RECEIVED - -**Title:** AJ REWARD DATA RECEIVED - -**Content:** -Needs summary. -`AJ_REWARD_DATA_RECEIVED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md b/wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md deleted file mode 100644 index 13afb1fc..00000000 --- a/wiki-information/events/ALERT_REGIONAL_CHAT_DISABLED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ALERT_REGIONAL_CHAT_DISABLED - -**Title:** ALERT REGIONAL CHAT DISABLED - -**Content:** -Needs summary. -`ALERT_REGIONAL_CHAT_DISABLED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md b/wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md deleted file mode 100644 index 5b868655..00000000 --- a/wiki-information/events/ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED - -**Title:** ALTERNATIVE DEFAULT LANGUAGE CHANGED - -**Content:** -Needs summary. -`ALTERNATIVE_DEFAULT_LANGUAGE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AREA_POIS_UPDATED.md b/wiki-information/events/AREA_POIS_UPDATED.md deleted file mode 100644 index 0b401288..00000000 --- a/wiki-information/events/AREA_POIS_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AREA_POIS_UPDATED - -**Title:** AREA POIS UPDATED - -**Content:** -Needs summary. -`AREA_POIS_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md b/wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md deleted file mode 100644 index cff28d49..00000000 --- a/wiki-information/events/AREA_SPIRIT_HEALER_IN_RANGE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AREA_SPIRIT_HEALER_IN_RANGE - -**Title:** AREA SPIRIT HEALER IN RANGE - -**Content:** -Needs summary. -`AREA_SPIRIT_HEALER_IN_RANGE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md b/wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md deleted file mode 100644 index cd66b029..00000000 --- a/wiki-information/events/AREA_SPIRIT_HEALER_OUT_OF_RANGE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AREA_SPIRIT_HEALER_OUT_OF_RANGE - -**Title:** AREA SPIRIT HEALER OUT OF RANGE - -**Content:** -Needs summary. -`AREA_SPIRIT_HEALER_OUT_OF_RANGE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ARENA_COOLDOWNS_UPDATE.md b/wiki-information/events/ARENA_COOLDOWNS_UPDATE.md deleted file mode 100644 index c672c2ad..00000000 --- a/wiki-information/events/ARENA_COOLDOWNS_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ARENA_COOLDOWNS_UPDATE - -**Title:** ARENA COOLDOWNS UPDATE - -**Content:** -Needs summary. -`ARENA_COOLDOWNS_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md b/wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md deleted file mode 100644 index 2aaccd97..00000000 --- a/wiki-information/events/ARENA_CROWD_CONTROL_SPELL_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ARENA_CROWD_CONTROL_SPELL_UPDATE - -**Title:** ARENA CROWD CONTROL SPELL UPDATE - -**Content:** -Needs summary. -`ARENA_CROWD_CONTROL_SPELL_UPDATE: unitTarget, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/ARENA_OPPONENT_UPDATE.md b/wiki-information/events/ARENA_OPPONENT_UPDATE.md deleted file mode 100644 index 091753e5..00000000 --- a/wiki-information/events/ARENA_OPPONENT_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ARENA_OPPONENT_UPDATE - -**Title:** ARENA OPPONENT UPDATE - -**Content:** -Needs summary. -`ARENA_OPPONENT_UPDATE: unitToken, updateReason` - -**Payload:** -- `unitToken` - - *string* : UnitId -- `updateReason` - - *string* \ No newline at end of file diff --git a/wiki-information/events/ARENA_SEASON_WORLD_STATE.md b/wiki-information/events/ARENA_SEASON_WORLD_STATE.md deleted file mode 100644 index 78212859..00000000 --- a/wiki-information/events/ARENA_SEASON_WORLD_STATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ARENA_SEASON_WORLD_STATE - -**Title:** ARENA SEASON WORLD STATE - -**Content:** -Needs summary. -`ARENA_SEASON_WORLD_STATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md b/wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md deleted file mode 100644 index 1c62d101..00000000 --- a/wiki-information/events/ARENA_TEAM_ROSTER_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ARENA_TEAM_ROSTER_UPDATE - -**Title:** ARENA TEAM ROSTER UPDATE - -**Content:** -This event fires whenever an arena team is opened in the character sheet. It also fires (3 times) when an arena member leaves, joins, or gets kicked. It does NOT fire when an arena team member logs in or out. -`ARENA_TEAM_ROSTER_UPDATE: allowQuery` - -**Payload:** -- `allowQuery` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/ARENA_TEAM_UPDATE.md b/wiki-information/events/ARENA_TEAM_UPDATE.md deleted file mode 100644 index c64c0755..00000000 --- a/wiki-information/events/ARENA_TEAM_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ARENA_TEAM_UPDATE - -**Title:** ARENA TEAM UPDATE - -**Content:** -This events fires when a friendly player joins or leaves an arena match. This does NOT fire when an arena member joins the team, leaves, gets kicked, logs in/out. -`ARENA_TEAM_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md b/wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md deleted file mode 100644 index f440f499..00000000 --- a/wiki-information/events/AUCTION_BIDDER_LIST_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUCTION_BIDDER_LIST_UPDATE - -**Title:** AUCTION BIDDER LIST UPDATE - -**Content:** -Fires when information becomes available or changes for the list of auctions bid on by the player. -`AUCTION_BIDDER_LIST_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_CLOSED.md b/wiki-information/events/AUCTION_HOUSE_CLOSED.md deleted file mode 100644 index 9cfdb1ed..00000000 --- a/wiki-information/events/AUCTION_HOUSE_CLOSED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: AUCTION_HOUSE_CLOSED - -**Title:** AUCTION HOUSE CLOSED - -**Content:** -This event is fired when the auction interface is closed. -`AUCTION_HOUSE_CLOSED` - -**Payload:** -- `None` - -**Content Details:** -It appears to fire twice, but the reason is unknown. \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_DISABLED.md b/wiki-information/events/AUCTION_HOUSE_DISABLED.md deleted file mode 100644 index 6b10fa2a..00000000 --- a/wiki-information/events/AUCTION_HOUSE_DISABLED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUCTION_HOUSE_DISABLED - -**Title:** AUCTION HOUSE DISABLED - -**Content:** -Fired when the auction house is not operational. -`AUCTION_HOUSE_DISABLED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_POST_ERROR.md b/wiki-information/events/AUCTION_HOUSE_POST_ERROR.md deleted file mode 100644 index 330435b1..00000000 --- a/wiki-information/events/AUCTION_HOUSE_POST_ERROR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUCTION_HOUSE_POST_ERROR - -**Title:** AUCTION HOUSE POST ERROR - -**Content:** -Needs summary. -`AUCTION_HOUSE_POST_ERROR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_POST_WARNING.md b/wiki-information/events/AUCTION_HOUSE_POST_WARNING.md deleted file mode 100644 index 01943c34..00000000 --- a/wiki-information/events/AUCTION_HOUSE_POST_WARNING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUCTION_HOUSE_POST_WARNING - -**Title:** AUCTION HOUSE POST WARNING - -**Content:** -Needs summary. -`AUCTION_HOUSE_POST_WARNING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md b/wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md deleted file mode 100644 index 624a7d23..00000000 --- a/wiki-information/events/AUCTION_HOUSE_SCRIPT_DEPRECATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUCTION_HOUSE_SCRIPT_DEPRECATED - -**Title:** AUCTION HOUSE SCRIPT DEPRECATED - -**Content:** -Needs summary. -`AUCTION_HOUSE_SCRIPT_DEPRECATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_HOUSE_SHOW.md b/wiki-information/events/AUCTION_HOUSE_SHOW.md deleted file mode 100644 index 27162bae..00000000 --- a/wiki-information/events/AUCTION_HOUSE_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUCTION_HOUSE_SHOW - -**Title:** AUCTION HOUSE SHOW - -**Content:** -This event is fired when the auction interface is first displayed. This is generally done by right-clicking an auctioneer in a major city. -`AUCTION_HOUSE_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md b/wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md deleted file mode 100644 index 677a08bb..00000000 --- a/wiki-information/events/AUCTION_ITEM_LIST_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: AUCTION_ITEM_LIST_UPDATE - -**Title:** AUCTION ITEM LIST UPDATE - -**Content:** -This event is fired when the Auction list is updated. -`AUCTION_ITEM_LIST_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -Note that this is not only the case, if the list is completely changed but also if it is sorted (i.e. SortAuctionItems() is called). \ No newline at end of file diff --git a/wiki-information/events/AUCTION_MULTISELL_FAILURE.md b/wiki-information/events/AUCTION_MULTISELL_FAILURE.md deleted file mode 100644 index 5d6b049e..00000000 --- a/wiki-information/events/AUCTION_MULTISELL_FAILURE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUCTION_MULTISELL_FAILURE - -**Title:** AUCTION MULTISELL FAILURE - -**Content:** -Fired when listing of multiple stacks fails (or is aborted?). -`AUCTION_MULTISELL_FAILURE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AUCTION_MULTISELL_START.md b/wiki-information/events/AUCTION_MULTISELL_START.md deleted file mode 100644 index f47ba6e3..00000000 --- a/wiki-information/events/AUCTION_MULTISELL_START.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AUCTION_MULTISELL_START - -**Title:** AUCTION MULTISELL START - -**Content:** -Fired when the client begins listing of multiple stacks. -`AUCTION_MULTISELL_START: numRepetitions` - -**Payload:** -- `numRepetitions` - - *number* - total number of stacks the client has to list. \ No newline at end of file diff --git a/wiki-information/events/AUCTION_MULTISELL_UPDATE.md b/wiki-information/events/AUCTION_MULTISELL_UPDATE.md deleted file mode 100644 index 69e8610f..00000000 --- a/wiki-information/events/AUCTION_MULTISELL_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: AUCTION_MULTISELL_UPDATE - -**Title:** AUCTION MULTISELL UPDATE - -**Content:** -Fired when the client lists a stack as part of listing multiple stacks. -`AUCTION_MULTISELL_UPDATE: createdCount, totalToCreate` - -**Payload:** -- `createdCount` - - *number* - number of stacks listed so far. -- `totalToCreate` - - *number* - total number of stacks in the current mass-listing operation. \ No newline at end of file diff --git a/wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md b/wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md deleted file mode 100644 index d9eb5e20..00000000 --- a/wiki-information/events/AUCTION_OWNED_LIST_UPDATE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: AUCTION_OWNED_LIST_UPDATE - -**Title:** AUCTION OWNED LIST UPDATE - -**Content:** -Fired whenever new information about auctions posted by the current character is received. Often used to update the auction house auctions view after an auction is canceled or posted. -`AUCTION_OWNED_LIST_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -If the auctions you are looking for are not loaded automatically it is necessary to reopen the Auction House to trigger them being loaded. -So long as an event handler is registered for this event the owned auctions list should update automatically. \ No newline at end of file diff --git a/wiki-information/events/AUTOFOLLOW_BEGIN.md b/wiki-information/events/AUTOFOLLOW_BEGIN.md deleted file mode 100644 index 1fa873b9..00000000 --- a/wiki-information/events/AUTOFOLLOW_BEGIN.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AUTOFOLLOW_BEGIN - -**Title:** AUTOFOLLOW BEGIN - -**Content:** -Fired when you begin automatically following an ally -`AUTOFOLLOW_BEGIN: name` - -**Payload:** -- `name` - - *string* - The unit you are following. Not necessarily your target (in case of right-clicking a group member's portrait or using the "/follow" command). \ No newline at end of file diff --git a/wiki-information/events/AUTOFOLLOW_END.md b/wiki-information/events/AUTOFOLLOW_END.md deleted file mode 100644 index 2eb9e8c9..00000000 --- a/wiki-information/events/AUTOFOLLOW_END.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AUTOFOLLOW_END - -**Title:** AUTOFOLLOW END - -**Content:** -Fired when the player ceases following an ally -`AUTOFOLLOW_END` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AVATAR_LIST_UPDATED.md b/wiki-information/events/AVATAR_LIST_UPDATED.md deleted file mode 100644 index 0454baaa..00000000 --- a/wiki-information/events/AVATAR_LIST_UPDATED.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: AVATAR_LIST_UPDATED - -**Title:** AVATAR LIST UPDATED - -**Content:** -Needs summary. -`AVATAR_LIST_UPDATED: clubType` - -**Payload:** -- `clubType` - - *number* - Enum.ClubType - - *Enum.ClubType* - - *Value* - Field - Description - - 0 - BattleNet - - 1 - Character - - 2 - Guild - - 3 - Other \ No newline at end of file diff --git a/wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md b/wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md deleted file mode 100644 index 0c9c84b9..00000000 --- a/wiki-information/events/AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED - -**Title:** AZERITE EMPOWERED ITEM EQUIPPED STATUS CHANGED - -**Content:** -Needs summary. -`AZERITE_EMPOWERED_ITEM_EQUIPPED_STATUS_CHANGED: isHeartEquipped` - -**Payload:** -- `isHeartEquipped` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md b/wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md deleted file mode 100644 index 34fa2c50..00000000 --- a/wiki-information/events/AZERITE_EMPOWERED_ITEM_LOOTED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AZERITE_EMPOWERED_ITEM_LOOTED - -**Title:** AZERITE EMPOWERED ITEM LOOTED - -**Content:** -Needs summary. -`AZERITE_EMPOWERED_ITEM_LOOTED: "itemLink"` - -**Payload:** -- `itemLink` - - *string* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md b/wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md deleted file mode 100644 index d971b086..00000000 --- a/wiki-information/events/AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED - -**Title:** AZERITE EMPOWERED ITEM SELECTION UPDATED - -**Content:** -Needs summary. -`AZERITE_EMPOWERED_ITEM_SELECTION_UPDATED: azeriteEmpoweredItemLocation` - -**Payload:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin*🔗 \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md b/wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md deleted file mode 100644 index 3e73a82d..00000000 --- a/wiki-information/events/AZERITE_ESSENCE_ACTIVATED.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: AZERITE_ESSENCE_ACTIVATED - -**Title:** AZERITE ESSENCE ACTIVATED - -**Content:** -Fires when the player drops an ability onto the Heart of Azeroth window. -`AZERITE_ESSENCE_ACTIVATED: slot, essenceID` - -**Payload:** -- `slot` - - *Enum.AzeriteEssenceSlot* - - *Value* - - *Field* - - *Description* - - 0 - MainSlot - - 1 - PassiveOneSlot - - 2 - PassiveTwoSlot - - 3 - PassiveThreeSlot - - Added in 8.3.0 -- `essenceID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md b/wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md deleted file mode 100644 index ecad1a35..00000000 --- a/wiki-information/events/AZERITE_ESSENCE_ACTIVATION_FAILED.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: AZERITE_ESSENCE_ACTIVATION_FAILED - -**Title:** AZERITE ESSENCE ACTIVATION FAILED - -**Content:** -Fires when the player cannot drop an ability onto the Heart of Azeroth window. -`AZERITE_ESSENCE_ACTIVATION_FAILED: slot, essenceID` - -**Payload:** -- `slot` - - *Enum.AzeriteEssenceSlot* - - *Value* - - *Field* - - *Description* - - 0 - MainSlot - - 1 - PassiveOneSlot - - 2 - PassiveTwoSlot - - 3 - PassiveThreeSlot - - Added in 8.3.0 -- `essenceID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_CHANGED.md b/wiki-information/events/AZERITE_ESSENCE_CHANGED.md deleted file mode 100644 index 4853982d..00000000 --- a/wiki-information/events/AZERITE_ESSENCE_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: AZERITE_ESSENCE_CHANGED - -**Title:** AZERITE ESSENCE CHANGED - -**Content:** -Sent to the add on when the player adds a new ability to the list of abilities in the Heart of Azeroth window. The player must already be located at the Heart Forge and then right-click the new ability item in inventory. -`AZERITE_ESSENCE_CHANGED: essenceID, newRank` - -**Payload:** -- `essenceID` - - *number* -- `newRank` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md b/wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md deleted file mode 100644 index 28142edf..00000000 --- a/wiki-information/events/AZERITE_ESSENCE_FORGE_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AZERITE_ESSENCE_FORGE_CLOSE - -**Title:** AZERITE ESSENCE FORGE CLOSE - -**Content:** -Sent to the add on when player closes the Heart Forge window while in the Chamber of Heart. Does not trigger when the Heart of Azeroth window is closed out in the world. -`AZERITE_ESSENCE_FORGE_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md b/wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md deleted file mode 100644 index 15b06d08..00000000 --- a/wiki-information/events/AZERITE_ESSENCE_FORGE_OPEN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: AZERITE_ESSENCE_FORGE_OPEN - -**Title:** AZERITE ESSENCE FORGE OPEN - -**Content:** -Sent to the add on when player right-clicks on the Heart Forge to open it in the Chamber of Heart. Does not trigger when the Heart of Azeroth window is opened out in the world by shift-clicking the necklace. -`AZERITE_ESSENCE_FORGE_OPEN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md b/wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md deleted file mode 100644 index dd13ca0e..00000000 --- a/wiki-information/events/AZERITE_ESSENCE_MILESTONE_UNLOCKED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AZERITE_ESSENCE_MILESTONE_UNLOCKED - -**Title:** AZERITE ESSENCE MILESTONE UNLOCKED - -**Content:** -Needs summary. -`AZERITE_ESSENCE_MILESTONE_UNLOCKED: milestoneID` - -**Payload:** -- `milestoneID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ESSENCE_UPDATE.md b/wiki-information/events/AZERITE_ESSENCE_UPDATE.md deleted file mode 100644 index c9a333fd..00000000 --- a/wiki-information/events/AZERITE_ESSENCE_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AZERITE_ESSENCE_UPDATE - -**Title:** AZERITE ESSENCE UPDATE - -**Content:** -Sent to the add on upon changing character spec, if both specs have a power configured in the Heart of Azeroth. -If the necklace does not have a power assigned when the spec is activated, or when the necklace is first unlocked, this event will be sent following one or more AZERITE_ESSENCE_ACTIVATED messages. -`AZERITE_ESSENCE_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md b/wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md deleted file mode 100644 index e74dedde..00000000 --- a/wiki-information/events/AZERITE_ITEM_ENABLED_STATE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: AZERITE_ITEM_ENABLED_STATE_CHANGED - -**Title:** AZERITE ITEM ENABLED STATE CHANGED - -**Content:** -Needs summary. -`AZERITE_ITEM_ENABLED_STATE_CHANGED: enabled` - -**Payload:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md b/wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md deleted file mode 100644 index 65397764..00000000 --- a/wiki-information/events/AZERITE_ITEM_EXPERIENCE_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: AZERITE_ITEM_EXPERIENCE_CHANGED - -**Title:** AZERITE ITEM EXPERIENCE CHANGED - -**Content:** -Sent to the add on each time the Azerite progress bar moves, in other words, every time the player gains Azerite. -`AZERITE_ITEM_EXPERIENCE_CHANGED: azeriteItemLocation, oldExperienceAmount, newExperienceAmount` - -**Payload:** -- `azeriteItemLocation` - - *ItemLocationMixin*🔗 -- `oldExperienceAmount` - - *number* -- `newExperienceAmount` - - *number* \ No newline at end of file diff --git a/wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md b/wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md deleted file mode 100644 index a587d4ac..00000000 --- a/wiki-information/events/AZERITE_ITEM_POWER_LEVEL_CHANGED.md +++ /dev/null @@ -1,26 +0,0 @@ -## Event: AZERITE_ITEM_POWER_LEVEL_CHANGED - -**Title:** AZERITE ITEM POWER LEVEL CHANGED - -**Content:** -Sent to the add on each time the player's Heart of Azeroth gains a level. -`AZERITE_ITEM_POWER_LEVEL_CHANGED: azeriteItemLocation, oldPowerLevel, newPowerLevel, unlockedEmpoweredItemsInfo, azeriteItemID` - -**Payload:** -- `azeriteItemLocation` - - AzeriteItemLocation🔗 -- `oldPowerLevel` - - *number* -- `newPowerLevel` - - *number* -- `unlockedEmpoweredItemsInfo` - - UnlockedAzeriteEmpoweredItems - - Field - - Type - - Description - - unlockedItem - - AzeriteEmpoweredItemLocation🔗 - - tierIndex - - *number* - - azeriteItemID - - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_CLOSED.md b/wiki-information/events/BAG_CLOSED.md deleted file mode 100644 index fb379029..00000000 --- a/wiki-information/events/BAG_CLOSED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BAG_CLOSED - -**Title:** BAG CLOSED - -**Content:** -Fired when a bag is (re)moved from its bagslot. Fires both for player bags and bank bags. -`BAG_CLOSED: bagID` - -**Payload:** -- `bagID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_NEW_ITEMS_UPDATED.md b/wiki-information/events/BAG_NEW_ITEMS_UPDATED.md deleted file mode 100644 index ed7f08e0..00000000 --- a/wiki-information/events/BAG_NEW_ITEMS_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BAG_NEW_ITEMS_UPDATED - -**Title:** BAG NEW ITEMS UPDATED - -**Content:** -Needs summary. -`BAG_NEW_ITEMS_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BAG_OPEN.md b/wiki-information/events/BAG_OPEN.md deleted file mode 100644 index d374c7d3..00000000 --- a/wiki-information/events/BAG_OPEN.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BAG_OPEN - -**Title:** BAG OPEN - -**Content:** -Fired when a lootable container (not an equipped bag) is opened. -`BAG_OPEN: bagID` - -**Payload:** -- `bagID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md b/wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md deleted file mode 100644 index 7ed03630..00000000 --- a/wiki-information/events/BAG_OVERFLOW_WITH_FULL_INVENTORY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BAG_OVERFLOW_WITH_FULL_INVENTORY - -**Title:** BAG OVERFLOW WITH FULL INVENTORY - -**Content:** -Needs summary. -`BAG_OVERFLOW_WITH_FULL_INVENTORY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md b/wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md deleted file mode 100644 index 352910e7..00000000 --- a/wiki-information/events/BAG_SLOT_FLAGS_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BAG_SLOT_FLAGS_UPDATED - -**Title:** BAG SLOT FLAGS UPDATED - -**Content:** -Needs summary. -`BAG_SLOT_FLAGS_UPDATED: slot` - -**Payload:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BAG_UPDATE.md b/wiki-information/events/BAG_UPDATE.md deleted file mode 100644 index cbc5ebaa..00000000 --- a/wiki-information/events/BAG_UPDATE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: BAG_UPDATE - -**Title:** BAG UPDATE - -**Content:** -Fired when a bags inventory changes. -`BAG_UPDATE: bagID` - -**Payload:** -- `bagID` - - *number* - -**Content Details:** -Bag zero, the sixteen slot default backpack, may not fire on login. Upon login (or reloading the console) this event fires even for bank bags. When moving an item in your inventory, this fires multiple times: once each for the source and destination bag. If the bag involved is the default backpack, this event will also fire with a container ID of "-2" (twice if you are moving the item inside the same bag). \ No newline at end of file diff --git a/wiki-information/events/BAG_UPDATE_COOLDOWN.md b/wiki-information/events/BAG_UPDATE_COOLDOWN.md deleted file mode 100644 index 57246ab1..00000000 --- a/wiki-information/events/BAG_UPDATE_COOLDOWN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BAG_UPDATE_COOLDOWN - -**Title:** BAG UPDATE COOLDOWN - -**Content:** -Fired when a cooldown update call is sent to a bag -`BAG_UPDATE_COOLDOWN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BAG_UPDATE_DELAYED.md b/wiki-information/events/BAG_UPDATE_DELAYED.md deleted file mode 100644 index 13d86cff..00000000 --- a/wiki-information/events/BAG_UPDATE_DELAYED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BAG_UPDATE_DELAYED - -**Title:** BAG UPDATE DELAYED - -**Content:** -Fired after all applicable BAG_UPDATE events for a specific action have been fired. -`BAG_UPDATE_DELAYED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BANKFRAME_CLOSED.md b/wiki-information/events/BANKFRAME_CLOSED.md deleted file mode 100644 index 3637cf6d..00000000 --- a/wiki-information/events/BANKFRAME_CLOSED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BANKFRAME_CLOSED - -**Title:** BANKFRAME CLOSED - -**Content:** -Fired twice when the bank window is closed. -`BANKFRAME_CLOSED` - -**Payload:** -- `None` - -**Content Details:** -Only at the first one of them the bank data is still available (GetNumBankSlots(), GetContainerItemLink(), . \ No newline at end of file diff --git a/wiki-information/events/BANKFRAME_OPENED.md b/wiki-information/events/BANKFRAME_OPENED.md deleted file mode 100644 index ad64a992..00000000 --- a/wiki-information/events/BANKFRAME_OPENED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BANKFRAME_OPENED - -**Title:** BANKFRAME OPENED - -**Content:** -Fired when the bank frame is opened -`BANKFRAME_OPENED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md b/wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md deleted file mode 100644 index c4072886..00000000 --- a/wiki-information/events/BANK_BAG_SLOT_FLAGS_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BANK_BAG_SLOT_FLAGS_UPDATED - -**Title:** BANK BAG SLOT FLAGS UPDATED - -**Content:** -Needs summary. -`BANK_BAG_SLOT_FLAGS_UPDATED: slot` - -**Payload:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md b/wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md deleted file mode 100644 index b0d1d833..00000000 --- a/wiki-information/events/BARBER_SHOP_APPEARANCE_APPLIED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BARBER_SHOP_APPEARANCE_APPLIED - -**Title:** BARBER SHOP APPEARANCE APPLIED - -**Content:** -Needs summary. -`BARBER_SHOP_APPEARANCE_APPLIED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md b/wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md deleted file mode 100644 index d6fe73c8..00000000 --- a/wiki-information/events/BARBER_SHOP_CAMERA_VALUES_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BARBER_SHOP_CAMERA_VALUES_UPDATED - -**Title:** BARBER SHOP CAMERA VALUES UPDATED - -**Content:** -Needs summary. -`BARBER_SHOP_CAMERA_VALUES_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_CLOSE.md b/wiki-information/events/BARBER_SHOP_CLOSE.md deleted file mode 100644 index 5e48c8ef..00000000 --- a/wiki-information/events/BARBER_SHOP_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BARBER_SHOP_CLOSE - -**Title:** BARBER SHOP CLOSE - -**Content:** -Needs summary. -`BARBER_SHOP_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_COST_UPDATE.md b/wiki-information/events/BARBER_SHOP_COST_UPDATE.md deleted file mode 100644 index 772077be..00000000 --- a/wiki-information/events/BARBER_SHOP_COST_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BARBER_SHOP_COST_UPDATE - -**Title:** BARBER SHOP COST UPDATE - -**Content:** -Needs summary. -`BARBER_SHOP_COST_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md b/wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md deleted file mode 100644 index f5d6230b..00000000 --- a/wiki-information/events/BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE - -**Title:** BARBER SHOP FORCE CUSTOMIZATIONS UPDATE - -**Content:** -Fired when the available customizations or any data about them has changed. -`BARBER_SHOP_FORCE_CUSTOMIZATIONS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_OPEN.md b/wiki-information/events/BARBER_SHOP_OPEN.md deleted file mode 100644 index 62bce471..00000000 --- a/wiki-information/events/BARBER_SHOP_OPEN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BARBER_SHOP_OPEN - -**Title:** BARBER SHOP OPEN - -**Content:** -Needs summary. -`BARBER_SHOP_OPEN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BARBER_SHOP_RESULT.md b/wiki-information/events/BARBER_SHOP_RESULT.md deleted file mode 100644 index 9ecb2f33..00000000 --- a/wiki-information/events/BARBER_SHOP_RESULT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BARBER_SHOP_RESULT - -**Title:** BARBER SHOP RESULT - -**Content:** -Fires when the barber gave your toon a dashing new hairstyle (or failed the gender reassignment surgery). -`BARBER_SHOP_RESULT: success` - -**Payload:** -- `success` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELDS_CLOSED.md b/wiki-information/events/BATTLEFIELDS_CLOSED.md deleted file mode 100644 index 8073eaca..00000000 --- a/wiki-information/events/BATTLEFIELDS_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BATTLEFIELDS_CLOSED - -**Title:** BATTLEFIELDS CLOSED - -**Content:** -Fired when the battlegrounds signup window is closed. -`BATTLEFIELDS_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELDS_SHOW.md b/wiki-information/events/BATTLEFIELDS_SHOW.md deleted file mode 100644 index a3ca3526..00000000 --- a/wiki-information/events/BATTLEFIELDS_SHOW.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BATTLEFIELDS_SHOW - -**Title:** BATTLEFIELDS SHOW - -**Content:** -Fired when the battlegrounds signup window is opened. -`BATTLEFIELDS_SHOW: isArena, battleMasterListID` - -**Payload:** -- `isArena` - - *boolean?* -- `battleMasterListID` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md b/wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md deleted file mode 100644 index a6a152b4..00000000 --- a/wiki-information/events/BATTLEFIELD_AUTO_QUEUE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BATTLEFIELD_AUTO_QUEUE - -**Title:** BATTLEFIELD AUTO QUEUE - -**Content:** -Needs summary. -`BATTLEFIELD_AUTO_QUEUE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md b/wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md deleted file mode 100644 index 9e9bb58e..00000000 --- a/wiki-information/events/BATTLEFIELD_AUTO_QUEUE_EJECT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BATTLEFIELD_AUTO_QUEUE_EJECT - -**Title:** BATTLEFIELD AUTO QUEUE EJECT - -**Content:** -Needs summary. -`BATTLEFIELD_AUTO_QUEUE_EJECT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md b/wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md deleted file mode 100644 index ff7a393e..00000000 --- a/wiki-information/events/BATTLEFIELD_QUEUE_TIMEOUT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BATTLEFIELD_QUEUE_TIMEOUT - -**Title:** BATTLEFIELD QUEUE TIMEOUT - -**Content:** -Fired when a War Game request times out without a response. -`BATTLEFIELD_QUEUE_TIMEOUT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md b/wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md deleted file mode 100644 index 4d2fe840..00000000 --- a/wiki-information/events/BATTLEGROUND_OBJECTIVES_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BATTLEGROUND_OBJECTIVES_UPDATE - -**Title:** BATTLEGROUND OBJECTIVES UPDATE - -**Content:** -Needs summary. -`BATTLEGROUND_OBJECTIVES_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md b/wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md deleted file mode 100644 index bec428c0..00000000 --- a/wiki-information/events/BATTLEGROUND_POINTS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BATTLEGROUND_POINTS_UPDATE - -**Title:** BATTLEGROUND POINTS UPDATE - -**Content:** -Needs summary. -`BATTLEGROUND_POINTS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BATTLETAG_INVITE_SHOW.md b/wiki-information/events/BATTLETAG_INVITE_SHOW.md deleted file mode 100644 index 0bdb2a6b..00000000 --- a/wiki-information/events/BATTLETAG_INVITE_SHOW.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BATTLETAG_INVITE_SHOW - -**Title:** BATTLETAG INVITE SHOW - -**Content:** -Needs summary. -`BATTLETAG_INVITE_SHOW: name` - -**Payload:** -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md b/wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md deleted file mode 100644 index 8fff30c7..00000000 --- a/wiki-information/events/BATTLE_PET_CURSOR_CLEAR.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: BATTLE_PET_CURSOR_CLEAR - -**Title:** BATTLE PET CURSOR CLEAR - -**Content:** -Fires after the player is no longer dragging a battle pet ability. -`BATTLE_PET_CURSOR_CLEAR` - -**Payload:** -- `None` - -**Content Details:** -The ability might now be assigned to an action bar, unless the player cancelled the drag by right-clicking. -This refers to the icon of the pet itself for summoning it; not an ability during pet battles. \ No newline at end of file diff --git a/wiki-information/events/BEHAVIORAL_NOTIFICATION.md b/wiki-information/events/BEHAVIORAL_NOTIFICATION.md deleted file mode 100644 index bd1feabd..00000000 --- a/wiki-information/events/BEHAVIORAL_NOTIFICATION.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BEHAVIORAL_NOTIFICATION - -**Title:** BEHAVIORAL NOTIFICATION - -**Content:** -Needs summary. -`BEHAVIORAL_NOTIFICATION: notificationType, dbId` - -**Payload:** -- `notificationType` - - *string* -- `dbId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/BIND_ENCHANT.md b/wiki-information/events/BIND_ENCHANT.md deleted file mode 100644 index d3d01cdf..00000000 --- a/wiki-information/events/BIND_ENCHANT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BIND_ENCHANT - -**Title:** BIND ENCHANT - -**Content:** -Fired when Enchanting an unbound item. -`BIND_ENCHANT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_BID_RESULT.md b/wiki-information/events/BLACK_MARKET_BID_RESULT.md deleted file mode 100644 index c115f4cc..00000000 --- a/wiki-information/events/BLACK_MARKET_BID_RESULT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BLACK_MARKET_BID_RESULT - -**Title:** BLACK MARKET BID RESULT - -**Content:** -Needs summary. -`BLACK_MARKET_BID_RESULT: marketID, resultCode` - -**Payload:** -- `marketID` - - *number* -- `resultCode` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_CLOSE.md b/wiki-information/events/BLACK_MARKET_CLOSE.md deleted file mode 100644 index 3030e49d..00000000 --- a/wiki-information/events/BLACK_MARKET_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BLACK_MARKET_CLOSE - -**Title:** BLACK MARKET CLOSE - -**Content:** -Needs summary. -`BLACK_MARKET_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md b/wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md deleted file mode 100644 index 2f1ee801..00000000 --- a/wiki-information/events/BLACK_MARKET_ITEM_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BLACK_MARKET_ITEM_UPDATE - -**Title:** BLACK MARKET ITEM UPDATE - -**Content:** -Needs summary. -`BLACK_MARKET_ITEM_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_OPEN.md b/wiki-information/events/BLACK_MARKET_OPEN.md deleted file mode 100644 index df385fe4..00000000 --- a/wiki-information/events/BLACK_MARKET_OPEN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BLACK_MARKET_OPEN - -**Title:** BLACK MARKET OPEN - -**Content:** -Needs summary. -`BLACK_MARKET_OPEN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_OUTBID.md b/wiki-information/events/BLACK_MARKET_OUTBID.md deleted file mode 100644 index 3a9c786d..00000000 --- a/wiki-information/events/BLACK_MARKET_OUTBID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BLACK_MARKET_OUTBID - -**Title:** BLACK MARKET OUTBID - -**Content:** -Needs summary. -`BLACK_MARKET_OUTBID: marketID, itemID` - -**Payload:** -- `marketID` - - *number* -- `itemID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_UNAVAILABLE.md b/wiki-information/events/BLACK_MARKET_UNAVAILABLE.md deleted file mode 100644 index c7ea759e..00000000 --- a/wiki-information/events/BLACK_MARKET_UNAVAILABLE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BLACK_MARKET_UNAVAILABLE - -**Title:** BLACK MARKET UNAVAILABLE - -**Content:** -Needs summary. -`BLACK_MARKET_UNAVAILABLE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BLACK_MARKET_WON.md b/wiki-information/events/BLACK_MARKET_WON.md deleted file mode 100644 index 6b6c5e86..00000000 --- a/wiki-information/events/BLACK_MARKET_WON.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BLACK_MARKET_WON - -**Title:** BLACK MARKET WON - -**Content:** -Needs summary. -`BLACK_MARKET_WON: marketID, itemID` - -**Payload:** -- `marketID` - - *number* -- `itemID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md b/wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md deleted file mode 100644 index 4036a391..00000000 --- a/wiki-information/events/BN_BLOCK_FAILED_TOO_MANY.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_BLOCK_FAILED_TOO_MANY - -**Title:** BN BLOCK FAILED TOO MANY - -**Content:** -Needs summary. -`BN_BLOCK_FAILED_TOO_MANY: blockType` - -**Payload:** -- `blockType` - - *string* \ No newline at end of file diff --git a/wiki-information/events/BN_BLOCK_LIST_UPDATED.md b/wiki-information/events/BN_BLOCK_LIST_UPDATED.md deleted file mode 100644 index d4733667..00000000 --- a/wiki-information/events/BN_BLOCK_LIST_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BN_BLOCK_LIST_UPDATED - -**Title:** BN BLOCK LIST UPDATED - -**Content:** -Needs summary. -`BN_BLOCK_LIST_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_CHAT_MSG_ADDON.md b/wiki-information/events/BN_CHAT_MSG_ADDON.md deleted file mode 100644 index 6a7f5740..00000000 --- a/wiki-information/events/BN_CHAT_MSG_ADDON.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: BN_CHAT_MSG_ADDON - -**Title:** BN CHAT MSG ADDON - -**Content:** -Needs summary. -`BN_CHAT_MSG_ADDON: prefix, text, channel, senderID` - -**Payload:** -- `prefix` - - *string* -- `text` - - *string* -- `channel` - - *string* -- `senderID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md b/wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md deleted file mode 100644 index 03eea2ff..00000000 --- a/wiki-information/events/BN_CHAT_WHISPER_UNDELIVERABLE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_CHAT_WHISPER_UNDELIVERABLE - -**Title:** BN CHAT WHISPER UNDELIVERABLE - -**Content:** -Needs summary. -`BN_CHAT_WHISPER_UNDELIVERABLE: senderID` - -**Payload:** -- `senderID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_CONNECTED.md b/wiki-information/events/BN_CONNECTED.md deleted file mode 100644 index 10de5248..00000000 --- a/wiki-information/events/BN_CONNECTED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_CONNECTED - -**Title:** BN CONNECTED - -**Content:** -Needs summary. -`BN_CONNECTED: suppressNotification` - -**Payload:** -- `suppressNotification` - - *boolean?* - false \ No newline at end of file diff --git a/wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md b/wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md deleted file mode 100644 index 1e3052f7..00000000 --- a/wiki-information/events/BN_CUSTOM_MESSAGE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_CUSTOM_MESSAGE_CHANGED - -**Title:** BN CUSTOM MESSAGE CHANGED - -**Content:** -Needs summary. -`BN_CUSTOM_MESSAGE_CHANGED: id` - -**Payload:** -- `id` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md b/wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md deleted file mode 100644 index 8065de97..00000000 --- a/wiki-information/events/BN_CUSTOM_MESSAGE_LOADED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BN_CUSTOM_MESSAGE_LOADED - -**Title:** BN CUSTOM MESSAGE LOADED - -**Content:** -Needs summary. -`BN_CUSTOM_MESSAGE_LOADED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_DISCONNECTED.md b/wiki-information/events/BN_DISCONNECTED.md deleted file mode 100644 index 8816f3d9..00000000 --- a/wiki-information/events/BN_DISCONNECTED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BN_DISCONNECTED - -**Title:** BN DISCONNECTED - -**Content:** -Needs summary. -`BN_DISCONNECTED: result, suppressNotification` - -**Payload:** -- `result` - - *boolean* -- `suppressNotification` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md b/wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md deleted file mode 100644 index da366da8..00000000 --- a/wiki-information/events/BN_FRIEND_ACCOUNT_OFFLINE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BN_FRIEND_ACCOUNT_OFFLINE - -**Title:** BN FRIEND ACCOUNT OFFLINE - -**Content:** -Needs summary. -`BN_FRIEND_ACCOUNT_OFFLINE: friendId, isCompanionApp` - -**Payload:** -- `friendId` - - *number* -- `isCompanionApp` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md b/wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md deleted file mode 100644 index 0caf77e6..00000000 --- a/wiki-information/events/BN_FRIEND_ACCOUNT_ONLINE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BN_FRIEND_ACCOUNT_ONLINE - -**Title:** BN FRIEND ACCOUNT ONLINE - -**Content:** -Needs summary. -`BN_FRIEND_ACCOUNT_ONLINE: friendId, isCompanionApp` - -**Payload:** -- `friendId` - - *number* -- `isCompanionApp` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INFO_CHANGED.md b/wiki-information/events/BN_FRIEND_INFO_CHANGED.md deleted file mode 100644 index 9797d985..00000000 --- a/wiki-information/events/BN_FRIEND_INFO_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_FRIEND_INFO_CHANGED - -**Title:** BN FRIEND INFO CHANGED - -**Content:** -Needs summary. -`BN_FRIEND_INFO_CHANGED: friendIndex` - -**Payload:** -- `friendIndex` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INVITE_ADDED.md b/wiki-information/events/BN_FRIEND_INVITE_ADDED.md deleted file mode 100644 index 89209f7d..00000000 --- a/wiki-information/events/BN_FRIEND_INVITE_ADDED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_FRIEND_INVITE_ADDED - -**Title:** BN FRIEND INVITE ADDED - -**Content:** -Needs summary. -`BN_FRIEND_INVITE_ADDED: accountID` - -**Payload:** -- `accountID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md b/wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md deleted file mode 100644 index 1b14b022..00000000 --- a/wiki-information/events/BN_FRIEND_INVITE_LIST_INITIALIZED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_FRIEND_INVITE_LIST_INITIALIZED - -**Title:** BN FRIEND INVITE LIST INITIALIZED - -**Content:** -Needs summary. -`BN_FRIEND_INVITE_LIST_INITIALIZED: listSize` - -**Payload:** -- `listSize` - - *number* \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_INVITE_REMOVED.md b/wiki-information/events/BN_FRIEND_INVITE_REMOVED.md deleted file mode 100644 index 2891efaf..00000000 --- a/wiki-information/events/BN_FRIEND_INVITE_REMOVED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BN_FRIEND_INVITE_REMOVED - -**Title:** BN FRIEND INVITE REMOVED - -**Content:** -Needs summary. -`BN_FRIEND_INVITE_REMOVED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md b/wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md deleted file mode 100644 index 95a22fbe..00000000 --- a/wiki-information/events/BN_FRIEND_LIST_SIZE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: BN_FRIEND_LIST_SIZE_CHANGED - -**Title:** BN FRIEND LIST SIZE CHANGED - -**Content:** -Needs summary. -`BN_FRIEND_LIST_SIZE_CHANGED: accountID` - -**Payload:** -- `accountID` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/BN_INFO_CHANGED.md b/wiki-information/events/BN_INFO_CHANGED.md deleted file mode 100644 index e2504f75..00000000 --- a/wiki-information/events/BN_INFO_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BN_INFO_CHANGED - -**Title:** BN INFO CHANGED - -**Content:** -Needs summary. -`BN_INFO_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md b/wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md deleted file mode 100644 index f6a3ea47..00000000 --- a/wiki-information/events/BN_REQUEST_FOF_SUCCEEDED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: BN_REQUEST_FOF_SUCCEEDED - -**Title:** BN REQUEST FOF SUCCEEDED - -**Content:** -Needs summary. -`BN_REQUEST_FOF_SUCCEEDED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/BOSS_KILL.md b/wiki-information/events/BOSS_KILL.md deleted file mode 100644 index 8b0dec79..00000000 --- a/wiki-information/events/BOSS_KILL.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: BOSS_KILL - -**Title:** BOSS KILL - -**Content:** -Fired when a (raid) boss has been killed. -`BOSS_KILL: encounterID, encounterName` - -**Payload:** -- `encounterID` - - *number* -- `encounterName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_ACTION_PENDING.md b/wiki-information/events/CALENDAR_ACTION_PENDING.md deleted file mode 100644 index 1a09ed76..00000000 --- a/wiki-information/events/CALENDAR_ACTION_PENDING.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CALENDAR_ACTION_PENDING - -**Title:** CALENDAR ACTION PENDING - -**Content:** -Fired when the calendar API is busy or free -`CALENDAR_ACTION_PENDING: pending` - -**Payload:** -- `pending` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_CLOSE_EVENT.md b/wiki-information/events/CALENDAR_CLOSE_EVENT.md deleted file mode 100644 index e12fcec6..00000000 --- a/wiki-information/events/CALENDAR_CLOSE_EVENT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CALENDAR_CLOSE_EVENT - -**Title:** CALENDAR CLOSE EVENT - -**Content:** -Needs summary. -`CALENDAR_CLOSE_EVENT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_EVENT_ALARM.md b/wiki-information/events/CALENDAR_EVENT_ALARM.md deleted file mode 100644 index 5d96e876..00000000 --- a/wiki-information/events/CALENDAR_EVENT_ALARM.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: CALENDAR_EVENT_ALARM - -**Title:** CALENDAR EVENT ALARM - -**Content:** -Needs summary. -`CALENDAR_EVENT_ALARM: title, hour, minute` - -**Payload:** -- `title` - - *string* -- `hour` - - *number* -- `minute` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_NEW_EVENT.md b/wiki-information/events/CALENDAR_NEW_EVENT.md deleted file mode 100644 index 9a31d6be..00000000 --- a/wiki-information/events/CALENDAR_NEW_EVENT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CALENDAR_NEW_EVENT - -**Title:** CALENDAR NEW EVENT - -**Content:** -Needs summary. -`CALENDAR_NEW_EVENT: isCopy` - -**Payload:** -- `isCopy` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_OPEN_EVENT.md b/wiki-information/events/CALENDAR_OPEN_EVENT.md deleted file mode 100644 index 92f357a3..00000000 --- a/wiki-information/events/CALENDAR_OPEN_EVENT.md +++ /dev/null @@ -1,26 +0,0 @@ -## Event: CALENDAR_OPEN_EVENT - -**Title:** CALENDAR OPEN EVENT - -**Content:** -Fired after calling CalendarOpenEvent once the event data has been retrieved from the server -`CALENDAR_OPEN_EVENT: calendarType` - -**Payload:** -- `calendarType` - - *string* - CALENDARTYPE - - Value - - Description - - "PLAYER" - - Player-created event or invitation - - "GUILD_ANNOUNCEMENT" - - Guild announcement - - "GUILD_EVENT" - - Guild event - - "COMMUNITY_EVENT" - - "SYSTEM" - - Other server-provided event - - "HOLIDAY" - - Seasonal/holiday events - - "RAID_LOCKOUT" - - Instance lockouts \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_ERROR.md b/wiki-information/events/CALENDAR_UPDATE_ERROR.md deleted file mode 100644 index dced85ef..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_ERROR.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CALENDAR_UPDATE_ERROR - -**Title:** CALENDAR UPDATE ERROR - -**Content:** -Needs summary. -`CALENDAR_UPDATE_ERROR: errorReason` - -**Payload:** -- `errorReason` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md b/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md deleted file mode 100644 index bc05eb08..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_COUNT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CALENDAR_UPDATE_ERROR_WITH_COUNT - -**Title:** CALENDAR UPDATE ERROR WITH COUNT - -**Content:** -Needs summary. -`CALENDAR_UPDATE_ERROR_WITH_COUNT: errorReason, count` - -**Payload:** -- `errorReason` - - *string* -- `count` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md b/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md deleted file mode 100644 index eeed07d2..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME - -**Title:** CALENDAR UPDATE ERROR WITH PLAYER NAME - -**Content:** -Needs summary. -`CALENDAR_UPDATE_ERROR_WITH_PLAYER_NAME: errorReason, playerName` - -**Payload:** -- `errorReason` - - *string* -- `playerName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_EVENT.md b/wiki-information/events/CALENDAR_UPDATE_EVENT.md deleted file mode 100644 index 75c0c036..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_EVENT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CALENDAR_UPDATE_EVENT - -**Title:** CALENDAR UPDATE EVENT - -**Content:** -Needs summary. -`CALENDAR_UPDATE_EVENT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md b/wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md deleted file mode 100644 index fdd38719..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_EVENT_LIST.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CALENDAR_UPDATE_EVENT_LIST - -**Title:** CALENDAR UPDATE EVENT LIST - -**Content:** -Needs summary. -`CALENDAR_UPDATE_EVENT_LIST` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md b/wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md deleted file mode 100644 index b09d3588..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_GUILD_EVENTS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CALENDAR_UPDATE_GUILD_EVENTS - -**Title:** CALENDAR UPDATE GUILD EVENTS - -**Content:** -Needs summary. -`CALENDAR_UPDATE_GUILD_EVENTS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md b/wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md deleted file mode 100644 index 93b5ac97..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_INVITE_LIST.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CALENDAR_UPDATE_INVITE_LIST - -**Title:** CALENDAR UPDATE INVITE LIST - -**Content:** -Fired after CalendarEventSortInvites once the invite list has been sorted. -`CALENDAR_UPDATE_INVITE_LIST: hasCompleteList` - -**Payload:** -- `hasCompleteList` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md b/wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md deleted file mode 100644 index 18bcf388..00000000 --- a/wiki-information/events/CALENDAR_UPDATE_PENDING_INVITES.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CALENDAR_UPDATE_PENDING_INVITES - -**Title:** CALENDAR UPDATE PENDING INVITES - -**Content:** -Needs summary. -`CALENDAR_UPDATE_PENDING_INVITES` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CANCEL_GLYPH_CAST.md b/wiki-information/events/CANCEL_GLYPH_CAST.md deleted file mode 100644 index 704cb1e6..00000000 --- a/wiki-information/events/CANCEL_GLYPH_CAST.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: CANCEL_GLYPH_CAST - -**Title:** CANCEL GLYPH CAST - -**Content:** -Fires after interrupting a new glyph from applying to an ability in the spell book. -`CANCEL_GLYPH_CAST` - -**Payload:** -- `None` - -**Related Information:** -- USE_GLYPH - Fires if the user attempts to apply a new glyph -- ACTIVATE_GLYPH - Fires if the user did not interrupt the new glyph \ No newline at end of file diff --git a/wiki-information/events/CANCEL_LOOT_ROLL.md b/wiki-information/events/CANCEL_LOOT_ROLL.md deleted file mode 100644 index f6771153..00000000 --- a/wiki-information/events/CANCEL_LOOT_ROLL.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CANCEL_LOOT_ROLL - -**Title:** CANCEL LOOT ROLL - -**Content:** -Fired when a player cancels a roll on an item. -`CANCEL_LOOT_ROLL: rollID` - -**Payload:** -- `rollID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CANCEL_SUMMON.md b/wiki-information/events/CANCEL_SUMMON.md deleted file mode 100644 index 4f3ae0fb..00000000 --- a/wiki-information/events/CANCEL_SUMMON.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CANCEL_SUMMON - -**Title:** CANCEL SUMMON - -**Content:** -Needs summary. -`CANCEL_SUMMON` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CAPTUREFRAMES_FAILED.md b/wiki-information/events/CAPTUREFRAMES_FAILED.md deleted file mode 100644 index 211ad010..00000000 --- a/wiki-information/events/CAPTUREFRAMES_FAILED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CAPTUREFRAMES_FAILED - -**Title:** CAPTUREFRAMES FAILED - -**Content:** -Needs summary. -`CAPTUREFRAMES_FAILED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md b/wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md deleted file mode 100644 index 9bbdd900..00000000 --- a/wiki-information/events/CAPTUREFRAMES_SUCCEEDED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CAPTUREFRAMES_SUCCEEDED - -**Title:** CAPTUREFRAMES SUCCEEDED - -**Content:** -Needs summary. -`CAPTUREFRAMES_SUCCEEDED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md b/wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md deleted file mode 100644 index 618ed016..00000000 --- a/wiki-information/events/CEMETERY_PREFERENCE_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CEMETERY_PREFERENCE_UPDATED - -**Title:** CEMETERY PREFERENCE UPDATED - -**Content:** -Needs summary. -`CEMETERY_PREFERENCE_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_COUNT_UPDATE.md b/wiki-information/events/CHANNEL_COUNT_UPDATE.md deleted file mode 100644 index 025e49f3..00000000 --- a/wiki-information/events/CHANNEL_COUNT_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CHANNEL_COUNT_UPDATE - -**Title:** CHANNEL COUNT UPDATE - -**Content:** -Fired when number of players in a channel changes but only if this channel is visible in ChannelFrame (it mustn't be hidden by a collapsed category header). -`CHANNEL_COUNT_UPDATE: displayIndex, count` - -**Payload:** -- `displayIndex` - - *number* - channel id (item number in Blizzards ChannelFrame. See also `GetChannelDisplayInfo` -- `count` - - *number* - number of players in channel \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_FLAGS_UPDATED.md b/wiki-information/events/CHANNEL_FLAGS_UPDATED.md deleted file mode 100644 index 995ca714..00000000 --- a/wiki-information/events/CHANNEL_FLAGS_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CHANNEL_FLAGS_UPDATED - -**Title:** CHANNEL FLAGS UPDATED - -**Content:** -Fired when user changes selected channel in Blizzards ChannelFrame -`CHANNEL_FLAGS_UPDATED: displayIndex` - -**Payload:** -- `displayIndex` - - *number* - channel id (item number in Blizzards ChannelFrame. See also `GetChannelDisplayInfo` \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_INVITE_REQUEST.md b/wiki-information/events/CHANNEL_INVITE_REQUEST.md deleted file mode 100644 index 4d5fcfc0..00000000 --- a/wiki-information/events/CHANNEL_INVITE_REQUEST.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CHANNEL_INVITE_REQUEST - -**Title:** CHANNEL INVITE REQUEST - -**Content:** -Needs summary. -`CHANNEL_INVITE_REQUEST: channelID, name` - -**Payload:** -- `channelID` - - *string* -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_LEFT.md b/wiki-information/events/CHANNEL_LEFT.md deleted file mode 100644 index c55b76ea..00000000 --- a/wiki-information/events/CHANNEL_LEFT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CHANNEL_LEFT - -**Title:** CHANNEL LEFT - -**Content:** -Needs summary. -`CHANNEL_LEFT: chatChannelID, name` - -**Payload:** -- `chatChannelID` - - *number* -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_PASSWORD_REQUEST.md b/wiki-information/events/CHANNEL_PASSWORD_REQUEST.md deleted file mode 100644 index 0b21bc4f..00000000 --- a/wiki-information/events/CHANNEL_PASSWORD_REQUEST.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CHANNEL_PASSWORD_REQUEST - -**Title:** CHANNEL PASSWORD REQUEST - -**Content:** -Fired when user is asked for a password (normally after trying to join a channel without a password or with a wrong one) -`CHANNEL_PASSWORD_REQUEST: channelID` - -**Payload:** -- `channelID` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_ROSTER_UPDATE.md b/wiki-information/events/CHANNEL_ROSTER_UPDATE.md deleted file mode 100644 index 0f99ac14..00000000 --- a/wiki-information/events/CHANNEL_ROSTER_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CHANNEL_ROSTER_UPDATE - -**Title:** CHANNEL ROSTER UPDATE - -**Content:** -Fired when user changes selected channel in Blizzards ChannelFrame or number of players in currently selected channel changes -`CHANNEL_ROSTER_UPDATE: displayIndex, count` - -**Payload:** -- `displayIndex` - - *number* -- `count` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CHANNEL_UI_UPDATE.md b/wiki-information/events/CHANNEL_UI_UPDATE.md deleted file mode 100644 index 52f3f750..00000000 --- a/wiki-information/events/CHANNEL_UI_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CHANNEL_UI_UPDATE - -**Title:** CHANNEL UI UPDATE - -**Content:** -Fired when Channel UI should change (e.g. joining / leaving a channel causes this event to fire) -`CHANNEL_UI_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md b/wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md deleted file mode 100644 index 8a89e30f..00000000 --- a/wiki-information/events/CHARACTER_ITEM_FIXUP_NOTIFICATION.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CHARACTER_ITEM_FIXUP_NOTIFICATION - -**Title:** CHARACTER ITEM FIXUP NOTIFICATION - -**Content:** -Needs summary. -`CHARACTER_ITEM_FIXUP_NOTIFICATION: fixupVersion` - -**Payload:** -- `fixupVersion` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CHARACTER_POINTS_CHANGED.md b/wiki-information/events/CHARACTER_POINTS_CHANGED.md deleted file mode 100644 index a968b964..00000000 --- a/wiki-information/events/CHARACTER_POINTS_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CHARACTER_POINTS_CHANGED - -**Title:** CHARACTER POINTS CHANGED - -**Content:** -Fired when the player's available talent points change. -`CHARACTER_POINTS_CHANGED: change` - -**Payload:** -- `change` - - *number* - indicates number of talent points changed. - - -1 indicates one used (learning a talent) - - 1 indicates one gained (leveling) \ No newline at end of file diff --git a/wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md b/wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md deleted file mode 100644 index 02a7d2fa..00000000 --- a/wiki-information/events/CHAT_COMBAT_MSG_ARENA_POINTS_GAIN.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_COMBAT_MSG_ARENA_POINTS_GAIN - -**Title:** CHAT COMBAT MSG ARENA POINTS GAIN - -**Content:** -Needs summary. -`CHAT_COMBAT_MSG_ARENA_POINTS_GAIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_DISABLED_CHANGED.md b/wiki-information/events/CHAT_DISABLED_CHANGED.md deleted file mode 100644 index 7c27dc8f..00000000 --- a/wiki-information/events/CHAT_DISABLED_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CHAT_DISABLED_CHANGED - -**Title:** CHAT DISABLED CHANGED - -**Content:** -Needs summary. -`CHAT_DISABLED_CHANGED: disabled` - -**Payload:** -- `disabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md b/wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md deleted file mode 100644 index ee259940..00000000 --- a/wiki-information/events/CHAT_DISABLED_CHANGE_FAILED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CHAT_DISABLED_CHANGE_FAILED - -**Title:** CHAT DISABLED CHANGE FAILED - -**Content:** -Needs summary. -`CHAT_DISABLED_CHANGE_FAILED: disabled` - -**Payload:** -- `disabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_ACHIEVEMENT.md b/wiki-information/events/CHAT_MSG_ACHIEVEMENT.md deleted file mode 100644 index 01f853d8..00000000 --- a/wiki-information/events/CHAT_MSG_ACHIEVEMENT.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_ACHIEVEMENT - -**Title:** CHAT MSG ACHIEVEMENT - -**Content:** -Fired when a player in your vicinity completes an achievement. -`CHAT_MSG_ACHIEVEMENT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The body of the achievement broadcast, e.g. "%s has earned the achievement |cffffff00|Hachievement:964:Player-969-00225901:1:7:13:20:4294967295:4294967295:4294967295:4294967295|h|h|r!" -2. `playerName` - - *string* - Player who completed the achievement. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - Same as playerName -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - GUID of the player who completed the achievement. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_ADDON.md b/wiki-information/events/CHAT_MSG_ADDON.md deleted file mode 100644 index 1f8c8010..00000000 --- a/wiki-information/events/CHAT_MSG_ADDON.md +++ /dev/null @@ -1,33 +0,0 @@ -## Event: CHAT_MSG_ADDON - -**Title:** CHAT MSG ADDON - -**Content:** -Fires when the client receives an addon message. -`CHAT_MSG_ADDON: prefix, text, channel, sender, target, zoneChannelID, localID, name, instanceID` - -**Payload:** -- `prefix` - - *string* - The registered prefix as used in `C_ChatInfo.RegisterAddonMessagePrefix()` -- `text` - - *string* - The message body -- `channel` - - *string* - The addon channel's chat type, e.g. "PARTY" -- `sender` - - *string* - Player who initiated the message -- `target` - - *string* - The channel index and name, e.g. "4. test"; or for the "WHISPER" chat type, same as sender -- `zoneChannelID` - - *number* - Seems to be always 0 -- `localID` - - *number* - The channel index or 0 if not applicable. -- `name` - - *string* - The channel name or an empty string if not applicable. -- `instanceID` - - *number* - Seems to be always 0 - -**Content Details:** -Related API -C_ChatInfo.SendAddonMessage -Related Events -CHAT_MSG_ADDON_LOGGED \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_ADDON_LOGGED.md b/wiki-information/events/CHAT_MSG_ADDON_LOGGED.md deleted file mode 100644 index d1d18107..00000000 --- a/wiki-information/events/CHAT_MSG_ADDON_LOGGED.md +++ /dev/null @@ -1,27 +0,0 @@ -## Event: CHAT_MSG_ADDON_LOGGED - -**Title:** CHAT MSG ADDON LOGGED - -**Content:** -Fired when the client receives a message from C_ChatInfo.SendAddonMessageLogged() -`CHAT_MSG_ADDON_LOGGED: prefix, text, channel, sender, target, zoneChannelID, localID, name, instanceID` - -**Payload:** -- `prefix` - - *string* - The registered prefix as used in C_ChatInfo.RegisterAddonMessagePrefix() -- `text` - - *string* - The message body -- `channel` - - *string* - The addon channel's chat type, e.g. "PARTY" -- `sender` - - *string* - Player who initiated the message -- `target` - - *string* - The channel index and name, e.g. "4. test"; or for the "WHISPER" chat type, same as sender -- `zoneChannelID` - - *number* - Seems to be always 0 -- `localID` - - *number* - The channel index or 0 if not applicable. -- `name` - - *string* - The channel name or an empty string if not applicable. -- `instanceID` - - *number* - Seems to be always 0 \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_AFK.md b/wiki-information/events/CHAT_MSG_AFK.md deleted file mode 100644 index 4bc84373..00000000 --- a/wiki-information/events/CHAT_MSG_AFK.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_AFK - -**Title:** CHAT MSG AFK - -**Content:** -Fired when the client receives an AFK auto-response. -`CHAT_MSG_AFK: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The AFK auto-response message, or "AFK" if not set. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md b/wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md deleted file mode 100644 index f7ed44e8..00000000 --- a/wiki-information/events/CHAT_MSG_BG_SYSTEM_ALLIANCE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BG_SYSTEM_ALLIANCE - -**Title:** CHAT MSG BG SYSTEM ALLIANCE - -**Content:** -Fired for battleground-event messages that are in blue by default because they are about Alliance actions, e.g. assaulting a graveyard or capture point, or picking up a flag. -`CHAT_MSG_BG_SYSTEM_ALLIANCE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - e.g. "The Alliance has taken the Blacksmith!" -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md b/wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md deleted file mode 100644 index 1878d715..00000000 --- a/wiki-information/events/CHAT_MSG_BG_SYSTEM_HORDE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BG_SYSTEM_HORDE - -**Title:** CHAT MSG BG SYSTEM HORDE - -**Content:** -Fired for battleground-event messages that are in red by default because they are about Horde actions. -`CHAT_MSG_BG_SYSTEM_HORDE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - e.g. "The Horde has taken the Blacksmith!" -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md b/wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md deleted file mode 100644 index d00e6af9..00000000 --- a/wiki-information/events/CHAT_MSG_BG_SYSTEM_NEUTRAL.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BG_SYSTEM_NEUTRAL - -**Title:** CHAT MSG BG SYSTEM NEUTRAL - -**Content:** -Fired for battleground-event messages that are displayed in a faction-neutral color by default. -`CHAT_MSG_BG_SYSTEM_NEUTRAL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - e.g. "Let the battle for Warsong Gulch begin." -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN.md b/wiki-information/events/CHAT_MSG_BN.md deleted file mode 100644 index d9887c66..00000000 --- a/wiki-information/events/CHAT_MSG_BN.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN - -**Title:** CHAT MSG BN - -**Content:** -Needs summary. -`CHAT_MSG_BN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md deleted file mode 100644 index 40340a84..00000000 --- a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_ALERT.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN_INLINE_TOAST_ALERT - -**Title:** CHAT MSG BN INLINE TOAST ALERT - -**Content:** -Fires when a battle.net friend comes online / goes offline or a friend request is received/pending. -`CHAT_MSG_BN_INLINE_TOAST_ALERT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - e.g. "FRIEND_ONLINE" -2. `playerName` - - *string* - The (protected) string of the target player, e.g. "|Kq2|k" -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md deleted file mode 100644 index 30a9a40d..00000000 --- a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN_INLINE_TOAST_BROADCAST - -**Title:** CHAT MSG BN INLINE TOAST BROADCAST - -**Content:** -Needs summary. -`CHAT_MSG_BN_INLINE_TOAST_BROADCAST: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md deleted file mode 100644 index ed899363..00000000 --- a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM - -**Title:** CHAT MSG BN INLINE TOAST BROADCAST INFORM - -**Content:** -Fired when the Bnet Real ID Broadcast Message is changed or from BNSetCustomMessage. -`CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md b/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md deleted file mode 100644 index 84bf36b3..00000000 --- a/wiki-information/events/CHAT_MSG_BN_INLINE_TOAST_CONVERSATION.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN_INLINE_TOAST_CONVERSATION - -**Title:** CHAT MSG BN INLINE TOAST CONVERSATION - -**Content:** -This event seems to be deprecated. -`CHAT_MSG_BN_INLINE_TOAST_CONVERSATION: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_WHISPER.md b/wiki-information/events/CHAT_MSG_BN_WHISPER.md deleted file mode 100644 index bd057a20..00000000 --- a/wiki-information/events/CHAT_MSG_BN_WHISPER.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN_WHISPER - -**Title:** CHAT MSG BN WHISPER - -**Content:** -Fires when a battle.net friend whispers you. -`CHAT_MSG_BN_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - The protected string of the player whispering you, e.g. "|Kq2|k" -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - Empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md b/wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md deleted file mode 100644 index 7a3574c3..00000000 --- a/wiki-information/events/CHAT_MSG_BN_WHISPER_INFORM.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN_WHISPER_INFORM - -**Title:** CHAT MSG BN WHISPER INFORM - -**Content:** -Fires when you whisper a battle.net friend. -`CHAT_MSG_BN_WHISPER_INFORM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - The (protected) string of the target player, e.g. "|Kq2|k" -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - Empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md b/wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md deleted file mode 100644 index dbd7f94e..00000000 --- a/wiki-information/events/CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE - -**Title:** CHAT MSG BN WHISPER PLAYER OFFLINE - -**Content:** -Needs summary. -`CHAT_MSG_BN_WHISPER_PLAYER_OFFLINE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL.md b/wiki-information/events/CHAT_MSG_CHANNEL.md deleted file mode 100644 index 15165e4f..00000000 --- a/wiki-information/events/CHAT_MSG_CHANNEL.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_CHANNEL - -**Title:** CHAT MSG CHANNEL - -**Content:** -Fired when the client receives a channel message. -`CHAT_MSG_CHANNEL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - e.g. "Hello world!" -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md b/wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md deleted file mode 100644 index c3cd0ff5..00000000 --- a/wiki-information/events/CHAT_MSG_CHANNEL_JOIN.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_CHANNEL_JOIN - -**Title:** CHAT MSG CHANNEL JOIN - -**Content:** -Fired when someone joins a chat channel you are in. -`CHAT_MSG_CHANNEL_JOIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - Empty string. -- `playerName` - - *string* - Name of the player who just joined the channel. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - Empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md b/wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md deleted file mode 100644 index dae6f784..00000000 --- a/wiki-information/events/CHAT_MSG_CHANNEL_LEAVE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_CHANNEL_LEAVE - -**Title:** CHAT MSG CHANNEL LEAVE - -**Content:** -Fired when a player leaves a channel that you are currently inside. -`CHAT_MSG_CHANNEL_LEAVE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - Empty string. -- `playerName` - - *string* - Name of the player who just left the channel. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - Empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_LIST.md b/wiki-information/events/CHAT_MSG_CHANNEL_LIST.md deleted file mode 100644 index ae4e641f..00000000 --- a/wiki-information/events/CHAT_MSG_CHANNEL_LIST.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_CHANNEL_LIST - -**Title:** CHAT MSG CHANNEL LIST - -**Content:** -Fired when ListChannels (with /chatlist) or ListChannelByName is called, and the message is displayed in the chat frame. -`CHAT_MSG_CHANNEL_LIST: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The list of channels, e.g. " " -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md b/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md deleted file mode 100644 index ae87d8c4..00000000 --- a/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_CHANNEL_NOTICE - -**Title:** CHAT MSG CHANNEL NOTICE - -**Content:** -Fired when you enter or leave a chat channel (or a channel was recently throttled). -`CHAT_MSG_CHANNEL_NOTICE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - "YOU_CHANGED" if you joined a channel, or "YOU_LEFT" if you left, or "THROTTLED" if channel was throttled. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md b/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md deleted file mode 100644 index 64a4954f..00000000 --- a/wiki-information/events/CHAT_MSG_CHANNEL_NOTICE_USER.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_CHANNEL_NOTICE_USER - -**Title:** CHAT MSG CHANNEL NOTICE USER - -**Content:** -Fired when something changes in the channel like moderation enabled, user is kicked, announcements changed and so on. CHAT_*_NOTICE in GlobalStrings.lua has a full list of available types. -`CHAT_MSG_CHANNEL_NOTICE_USER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - "ANNOUNCEMENTS_OFF", "ANNOUNCEMENTS_ON", "BANNED", "OWNER_CHANGED", "INVALID_NAME", "INVITE", "MODERATION_OFF", "MODERATION_ON", "MUTED", "NOT_MEMBER", "NOT_MODERATED", "SET_MODERATOR", "UNSET_MODERATOR" -- `playerName` - - *string* - If arg5 has a value then this is the user affected (e.g. "Player Foo has been kicked by Bar"), if arg5 has no value then it's the person who caused the event (e.g. "Channel Moderation has been enabled by Bar") -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - Player that caused the event (e.g. "Player Foo has been kicked by Bar") -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md b/wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md deleted file mode 100644 index 2ce11917..00000000 --- a/wiki-information/events/CHAT_MSG_COMBAT_FACTION_CHANGE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_COMBAT_FACTION_CHANGE - -**Title:** CHAT MSG COMBAT FACTION CHANGE - -**Content:** -Fires when you gain reputation with a faction. -`CHAT_MSG_COMBAT_FACTION_CHANGE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - e.g. "Your reputation with Timbermaw Hold has very slightly increased." -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md b/wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md deleted file mode 100644 index d1a86a19..00000000 --- a/wiki-information/events/CHAT_MSG_COMBAT_HONOR_GAIN.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_COMBAT_HONOR_GAIN - -**Title:** CHAT MSG COMBAT HONOR GAIN - -**Content:** -Fires when the player gains any amount of honor, anything from an honorable kill to bonus honor awarded. -`CHAT_MSG_COMBAT_HONOR_GAIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - format: "%s dies, honorable kill Rank: %s (Estimated Honor Points: %d)" or "You have been awarded %d honor." -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md b/wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md deleted file mode 100644 index aabf2d10..00000000 --- a/wiki-information/events/CHAT_MSG_COMBAT_MISC_INFO.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_COMBAT_MISC_INFO - -**Title:** CHAT MSG COMBAT MISC INFO - -**Content:** -Fires when your equipment takes durability loss from death, and likely other situations as well. -`CHAT_MSG_COMBAT_MISC_INFO: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md b/wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md deleted file mode 100644 index 2b63a772..00000000 --- a/wiki-information/events/CHAT_MSG_COMBAT_XP_GAIN.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_COMBAT_XP_GAIN - -**Title:** CHAT MSG COMBAT XP GAIN - -**Content:** -Fires when you gain XP from killing a creature or finishing a quest. Does not fire if you gain no XP from killing a creature. -`CHAT_MSG_COMBAT_XP_GAIN: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - e.g. "Rockjaw Invader dies, you gain 44 experience." -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md b/wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md deleted file mode 100644 index 8cc739a9..00000000 --- a/wiki-information/events/CHAT_MSG_COMMUNITIES_CHANNEL.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_COMMUNITIES_CHANNEL - -**Title:** CHAT MSG COMMUNITIES CHANNEL - -**Content:** -Needs summary. -`CHAT_MSG_COMMUNITIES_CHANNEL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - Protected string. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_CURRENCY.md b/wiki-information/events/CHAT_MSG_CURRENCY.md deleted file mode 100644 index 65e562bc..00000000 --- a/wiki-information/events/CHAT_MSG_CURRENCY.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_CURRENCY - -**Title:** CHAT MSG CURRENCY - -**Content:** -Fires when you gain currency other than money (for example Chef's Awards or Champion's Seals). -`CHAT_MSG_CURRENCY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - e.g. "You receive currency: Chef's Award x1." -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_DND.md b/wiki-information/events/CHAT_MSG_DND.md deleted file mode 100644 index 10b00156..00000000 --- a/wiki-information/events/CHAT_MSG_DND.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_DND - -**Title:** CHAT MSG DND - -**Content:** -Fired when the client receives a Do-Not-Disturb auto-response. -`CHAT_MSG_DND: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The DND auto-response message, or "DND" if not set. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_EMOTE.md b/wiki-information/events/CHAT_MSG_EMOTE.md deleted file mode 100644 index 8a8a9b5c..00000000 --- a/wiki-information/events/CHAT_MSG_EMOTE.md +++ /dev/null @@ -1,51 +0,0 @@ -## Event: CHAT_MSG_EMOTE - -**Title:** CHAT MSG EMOTE - -**Content:** -Fires when a player uses a custom /emote. -`CHAT_MSG_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The custom emote text, e.g. "pickpockets you for 39 silver." -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_PARTY -- CHAT_MSG_RAID -- CHAT_MSG_SAY -- CHAT_MSG_YELL -- CHAT_MSG_WHISPER -- CHAT_MSG_MONSTER_EMOTE \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_FILTERED.md b/wiki-information/events/CHAT_MSG_FILTERED.md deleted file mode 100644 index 9fdbf319..00000000 --- a/wiki-information/events/CHAT_MSG_FILTERED.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_FILTERED - -**Title:** CHAT MSG FILTERED - -**Content:** -Needs summary. -`CHAT_MSG_FILTERED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_GUILD.md b/wiki-information/events/CHAT_MSG_GUILD.md deleted file mode 100644 index 1faa27e8..00000000 --- a/wiki-information/events/CHAT_MSG_GUILD.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_GUILD - -**Title:** CHAT MSG GUILD - -**Content:** -Fired when a message is sent or received in the Guild channel. -`CHAT_MSG_GUILD: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - e.g. "good morning :)" -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md b/wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md deleted file mode 100644 index ffdb017d..00000000 --- a/wiki-information/events/CHAT_MSG_GUILD_ACHIEVEMENT.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_GUILD_ACHIEVEMENT - -**Title:** CHAT MSG GUILD ACHIEVEMENT - -**Content:** -Fired when a guild member completes an achievement. -`CHAT_MSG_GUILD_ACHIEVEMENT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The full body of the achievement broadcast message. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md b/wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md deleted file mode 100644 index fcb398f0..00000000 --- a/wiki-information/events/CHAT_MSG_GUILD_ITEM_LOOTED.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_GUILD_ITEM_LOOTED - -**Title:** CHAT MSG GUILD ITEM LOOTED - -**Content:** -Needs summary. -`CHAT_MSG_GUILD_ITEM_LOOTED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_IGNORED.md b/wiki-information/events/CHAT_MSG_IGNORED.md deleted file mode 100644 index 2cdf5637..00000000 --- a/wiki-information/events/CHAT_MSG_IGNORED.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_IGNORED - -**Title:** CHAT MSG IGNORED - -**Content:** -Fired when you whisper a player that is ignoring you. -`CHAT_MSG_IGNORED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - Returns "ChatIgnoredHandler" -- `playerName` - - *string* - Character name of who you tried to message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md b/wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md deleted file mode 100644 index 89ea06fc..00000000 --- a/wiki-information/events/CHAT_MSG_INSTANCE_CHAT.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_INSTANCE_CHAT - -**Title:** CHAT MSG INSTANCE CHAT - -**Content:** -Fires for chat messages from groups formed by the dungeon finder, like in instances, raids, arenas and battlegrounds. -`CHAT_MSG_INSTANCE_CHAT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md b/wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md deleted file mode 100644 index a29fd87b..00000000 --- a/wiki-information/events/CHAT_MSG_INSTANCE_CHAT_LEADER.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_INSTANCE_CHAT_LEADER - -**Title:** CHAT MSG INSTANCE CHAT LEADER - -**Content:** -Fires for group leader messages from groups formed by the dungeon finder, like in instances, raids, arenas and battlegrounds. -`CHAT_MSG_INSTANCE_CHAT_LEADER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_LOOT.md b/wiki-information/events/CHAT_MSG_LOOT.md deleted file mode 100644 index d7874c23..00000000 --- a/wiki-information/events/CHAT_MSG_LOOT.md +++ /dev/null @@ -1,46 +0,0 @@ -## Event: CHAT_MSG_LOOT - -**Title:** CHAT MSG LOOT - -**Content:** -Fires when you or a group member loots an item or when someone selects need/greed/pass on an item. -`CHAT_MSG_LOOT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - e.g. "You receive loot: |cffffffff|Hitem:2589::::::::20:257::::::|h|h|rx2." -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Content Details:** -This also fires messages like "Person creates " via tradeskills, and "Person receives " via a trade window. See also CHAT_MSG_MONEY and CHAT_MSG_CURRENCY. \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONEY.md b/wiki-information/events/CHAT_MSG_MONEY.md deleted file mode 100644 index dfaca299..00000000 --- a/wiki-information/events/CHAT_MSG_MONEY.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_MONEY - -**Title:** CHAT MSG MONEY - -**Content:** -Fired when a unit loots money. -`CHAT_MSG_MONEY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - e.g. "You loot 4 Copper" -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md b/wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md deleted file mode 100644 index 79e3dbfe..00000000 --- a/wiki-information/events/CHAT_MSG_MONSTER_EMOTE.md +++ /dev/null @@ -1,49 +0,0 @@ -## Event: CHAT_MSG_MONSTER_EMOTE - -**Title:** CHAT MSG MONSTER EMOTE - -**Content:** -Fires when an NPC emotes. -`CHAT_MSG_MONSTER_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message body, such as "%s attempts to run away in fear!" -2. `playerName` - - *string* - Name of the NPC. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - If applicable, the player triggering the NPC emote. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_MONSTER_SAY -- CHAT_MSG_MONSTER_PARTY -- CHAT_MSG_MONSTER_YELL -- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_PARTY.md b/wiki-information/events/CHAT_MSG_MONSTER_PARTY.md deleted file mode 100644 index 17d6d7c0..00000000 --- a/wiki-information/events/CHAT_MSG_MONSTER_PARTY.md +++ /dev/null @@ -1,49 +0,0 @@ -## Event: CHAT_MSG_MONSTER_PARTY - -**Title:** CHAT MSG MONSTER PARTY - -**Content:** -Fires when a party member NPC speaks. -`CHAT_MSG_MONSTER_PARTY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the NPC. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - If applicable, the player triggering the NPC message. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_MONSTER_EMOTE -- CHAT_MSG_MONSTER_SAY -- CHAT_MSG_MONSTER_YELL -- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_SAY.md b/wiki-information/events/CHAT_MSG_MONSTER_SAY.md deleted file mode 100644 index 1213bfac..00000000 --- a/wiki-information/events/CHAT_MSG_MONSTER_SAY.md +++ /dev/null @@ -1,49 +0,0 @@ -## Event: CHAT_MSG_MONSTER_SAY - -**Title:** CHAT MSG MONSTER SAY - -**Content:** -Fires when a NPC speaks. -`CHAT_MSG_MONSTER_SAY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the NPC. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - If applicable, the player triggering the NPC message. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_MONSTER_EMOTE -- CHAT_MSG_MONSTER_PARTY -- CHAT_MSG_MONSTER_YELL -- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md b/wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md deleted file mode 100644 index 2402aa8d..00000000 --- a/wiki-information/events/CHAT_MSG_MONSTER_WHISPER.md +++ /dev/null @@ -1,49 +0,0 @@ -## Event: CHAT_MSG_MONSTER_WHISPER - -**Title:** CHAT MSG MONSTER WHISPER - -**Content:** -Fires when a NPC whispers an individual player. -`CHAT_MSG_MONSTER_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the NPC. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - Target of the whisper. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_MONSTER_EMOTE -- CHAT_MSG_MONSTER_SAY -- CHAT_MSG_MONSTER_PARTY -- CHAT_MSG_MONSTER_YELL \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_MONSTER_YELL.md b/wiki-information/events/CHAT_MSG_MONSTER_YELL.md deleted file mode 100644 index bb1d958a..00000000 --- a/wiki-information/events/CHAT_MSG_MONSTER_YELL.md +++ /dev/null @@ -1,49 +0,0 @@ -## Event: CHAT_MSG_MONSTER_YELL - -**Title:** CHAT MSG MONSTER YELL - -**Content:** -Fires when an NPC yells, such as a raid boss or in Alterac Valley. -`CHAT_MSG_MONSTER_YELL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the NPC. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - If applicable, the player triggering the NPC message. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_MONSTER_EMOTE -- CHAT_MSG_MONSTER_SAY -- CHAT_MSG_MONSTER_PARTY -- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_OFFICER.md b/wiki-information/events/CHAT_MSG_OFFICER.md deleted file mode 100644 index bdd1c065..00000000 --- a/wiki-information/events/CHAT_MSG_OFFICER.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_OFFICER - -**Title:** CHAT MSG OFFICER - -**Content:** -Fired when a message is sent or received in the Guild Officer channel. -`CHAT_MSG_OFFICER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_OPENING.md b/wiki-information/events/CHAT_MSG_OPENING.md deleted file mode 100644 index e0b93a75..00000000 --- a/wiki-information/events/CHAT_MSG_OPENING.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_OPENING - -**Title:** CHAT MSG OPENING - -**Content:** -Needs summary. -`CHAT_MSG_OPENING: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PARTY.md b/wiki-information/events/CHAT_MSG_PARTY.md deleted file mode 100644 index 1f6d84af..00000000 --- a/wiki-information/events/CHAT_MSG_PARTY.md +++ /dev/null @@ -1,51 +0,0 @@ -## Event: CHAT_MSG_PARTY - -**Title:** CHAT MSG PARTY - -**Content:** -Fires when a player speaks in /party chat. -`CHAT_MSG_PARTY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_EMOTE -- CHAT_MSG_RAID -- CHAT_MSG_SAY -- CHAT_MSG_YELL -- CHAT_MSG_WHISPER -- CHAT_MSG_MONSTER_PARTY \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PARTY_LEADER.md b/wiki-information/events/CHAT_MSG_PARTY_LEADER.md deleted file mode 100644 index 83089624..00000000 --- a/wiki-information/events/CHAT_MSG_PARTY_LEADER.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_PARTY_LEADER - -**Title:** CHAT MSG PARTY LEADER - -**Content:** -Fired when a message is sent or received by the party leader. -`CHAT_MSG_PARTY_LEADER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md b/wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md deleted file mode 100644 index d33e7c1c..00000000 --- a/wiki-information/events/CHAT_MSG_PET_BATTLE_COMBAT_LOG.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_PET_BATTLE_COMBAT_LOG - -**Title:** CHAT MSG PET BATTLE COMBAT LOG - -**Content:** -Needs summary. -`CHAT_MSG_PET_BATTLE_COMBAT_LOG: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md b/wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md deleted file mode 100644 index 1fe2e0b9..00000000 --- a/wiki-information/events/CHAT_MSG_PET_BATTLE_INFO.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_PET_BATTLE_INFO - -**Title:** CHAT MSG PET BATTLE INFO - -**Content:** -Needs summary. -`CHAT_MSG_PET_BATTLE_INFO: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_PET_INFO.md b/wiki-information/events/CHAT_MSG_PET_INFO.md deleted file mode 100644 index 9fedc9c7..00000000 --- a/wiki-information/events/CHAT_MSG_PET_INFO.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_PET_INFO - -**Title:** CHAT MSG PET INFO - -**Content:** -Needs summary. -`CHAT_MSG_PET_INFO: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID.md b/wiki-information/events/CHAT_MSG_RAID.md deleted file mode 100644 index 4db27356..00000000 --- a/wiki-information/events/CHAT_MSG_RAID.md +++ /dev/null @@ -1,50 +0,0 @@ -## Event: CHAT_MSG_RAID - -**Title:** CHAT MSG RAID - -**Content:** -Fires when a player speaks in /raid chat. -`CHAT_MSG_RAID: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_EMOTE -- CHAT_MSG_PARTY -- CHAT_MSG_SAY -- CHAT_MSG_YELL -- CHAT_MSG_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md b/wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md deleted file mode 100644 index 9b89bed5..00000000 --- a/wiki-information/events/CHAT_MSG_RAID_BOSS_EMOTE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_RAID_BOSS_EMOTE - -**Title:** CHAT MSG RAID BOSS EMOTE - -**Content:** -Needs summary. -`CHAT_MSG_RAID_BOSS_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the boss. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - Name of the targeted player. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md b/wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md deleted file mode 100644 index 55d4b5ab..00000000 --- a/wiki-information/events/CHAT_MSG_RAID_BOSS_WHISPER.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_RAID_BOSS_WHISPER - -**Title:** CHAT MSG RAID BOSS WHISPER - -**Content:** -Needs summary. -`CHAT_MSG_RAID_BOSS_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_LEADER.md b/wiki-information/events/CHAT_MSG_RAID_LEADER.md deleted file mode 100644 index d57044fb..00000000 --- a/wiki-information/events/CHAT_MSG_RAID_LEADER.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_RAID_LEADER - -**Title:** CHAT MSG RAID LEADER - -**Content:** -Fired when a message is sent or received from the raid leader. -`CHAT_MSG_RAID_LEADER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RAID_WARNING.md b/wiki-information/events/CHAT_MSG_RAID_WARNING.md deleted file mode 100644 index 0f903e58..00000000 --- a/wiki-information/events/CHAT_MSG_RAID_WARNING.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_RAID_WARNING - -**Title:** CHAT MSG RAID WARNING - -**Content:** -Fired when a warning message is sent or received from the raid leader. -`CHAT_MSG_RAID_WARNING: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_RESTRICTED.md b/wiki-information/events/CHAT_MSG_RESTRICTED.md deleted file mode 100644 index ac42a6a2..00000000 --- a/wiki-information/events/CHAT_MSG_RESTRICTED.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_RESTRICTED - -**Title:** CHAT MSG RESTRICTED - -**Content:** -Needs summary. -`CHAT_MSG_RESTRICTED: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_SAY.md b/wiki-information/events/CHAT_MSG_SAY.md deleted file mode 100644 index 7d62a935..00000000 --- a/wiki-information/events/CHAT_MSG_SAY.md +++ /dev/null @@ -1,51 +0,0 @@ -## Event: CHAT_MSG_SAY - -**Title:** CHAT MSG SAY - -**Content:** -Fires when a player sends a chat message with /say. -`CHAT_MSG_SAY: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_EMOTE -- CHAT_MSG_PARTY -- CHAT_MSG_RAID -- CHAT_MSG_YELL -- CHAT_MSG_WHISPER -- CHAT_MSG_MONSTER_SAY \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_SKILL.md b/wiki-information/events/CHAT_MSG_SKILL.md deleted file mode 100644 index 2d4410d9..00000000 --- a/wiki-information/events/CHAT_MSG_SKILL.md +++ /dev/null @@ -1,45 +0,0 @@ -## Event: CHAT_MSG_SKILL - -**Title:** CHAT MSG SKILL - -**Content:** -Fired when some chat messages about skills are displayed. -`CHAT_MSG_SKILL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - Some possible GlobalStrings: - - ERR_SKILL_GAINED_S (e.g. "You have gained the Blacksmithing skill.") - - ERR_SKILL_UP_SI (e.g. "Your skill in Cooking has increased to 221.") -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_SYSTEM.md b/wiki-information/events/CHAT_MSG_SYSTEM.md deleted file mode 100644 index 5350687f..00000000 --- a/wiki-information/events/CHAT_MSG_SYSTEM.md +++ /dev/null @@ -1,48 +0,0 @@ -## Event: CHAT_MSG_SYSTEM - -**Title:** CHAT MSG SYSTEM - -**Content:** -Fired when a system chat message (they are displayed in yellow) is received. -`CHAT_MSG_SYSTEM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - Some possible GlobalStrings: - - ERR_LEARN_RECIPE_S (e.g. "You have learned how to create a new item: Bristle Whisker Catfish.") - - MARKED_AFK_MESSAGE (e.g. "You are now AFK: Away from Keyboard") -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Content Details:** -Be very careful with assuming when the event is actually sent. For example, "Quest accepted: Quest Title" is sent before the quest log updates, so at the time of the event the player's quest log does not yet contain the quest. Similarly, "Quest Title completed." is sent before the quest is removed from the quest log, so at the time of the event the player's quest log still contains the quest. \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_TARGETICONS.md b/wiki-information/events/CHAT_MSG_TARGETICONS.md deleted file mode 100644 index ddc535da..00000000 --- a/wiki-information/events/CHAT_MSG_TARGETICONS.md +++ /dev/null @@ -1,44 +0,0 @@ -## Event: CHAT_MSG_TARGETICONS - -**Title:** CHAT MSG TARGETICONS - -**Content:** -Fired when a raid target icon is set. This is used by the chat filter, if the player is watching raid icons in chat output (in the Filters right-click menu, under Other, look for Target Icons). -`CHAT_MSG_TARGETICONS: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The formatted message to be displayed in the chat window. - - Formatted from the TARGET_ICON_SET globalstring: "|Hplayer:%s|h|h sets |TInterface\\TargetingFrame\\UI-RaidTargetingIcon_%d:0|t on %s." -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to PlayerLocation:CreateFromChatLineID() -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with C_ChatInfo.ReplaceIconAndGroupExpressions() \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_TEXT_EMOTE.md b/wiki-information/events/CHAT_MSG_TEXT_EMOTE.md deleted file mode 100644 index f0ea820c..00000000 --- a/wiki-information/events/CHAT_MSG_TEXT_EMOTE.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_TEXT_EMOTE - -**Title:** CHAT MSG TEXT EMOTE - -**Content:** -Fired for emotes with an emote token. /dance, /healme, etc. -`CHAT_MSG_TEXT_EMOTE: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - e.g. "You threaten Rabbit with the wrath of doom." -- `playerName` - - *string* - Name of the person who emoted. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_TRADESKILLS.md b/wiki-information/events/CHAT_MSG_TRADESKILLS.md deleted file mode 100644 index cfd6e252..00000000 --- a/wiki-information/events/CHAT_MSG_TRADESKILLS.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_TRADESKILLS - -**Title:** CHAT MSG TRADESKILLS - -**Content:** -Needs summary. -`CHAT_MSG_TRADESKILLS: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_VOICE_TEXT.md b/wiki-information/events/CHAT_MSG_VOICE_TEXT.md deleted file mode 100644 index 922d5374..00000000 --- a/wiki-information/events/CHAT_MSG_VOICE_TEXT.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_VOICE_TEXT - -**Title:** CHAT MSG VOICE TEXT - -**Content:** -Needs summary. -`CHAT_MSG_VOICE_TEXT: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the user that initiated the chat message. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_WHISPER.md b/wiki-information/events/CHAT_MSG_WHISPER.md deleted file mode 100644 index 6956cdb3..00000000 --- a/wiki-information/events/CHAT_MSG_WHISPER.md +++ /dev/null @@ -1,51 +0,0 @@ -## Event: CHAT_MSG_WHISPER - -**Title:** CHAT MSG WHISPER - -**Content:** -Fired when a whisper is received from another player. -`CHAT_MSG_WHISPER: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the player sending a whisper, e.g. "Arthas-Silvermoon" -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_EMOTE -- CHAT_MSG_PARTY -- CHAT_MSG_RAID -- CHAT_MSG_SAY -- CHAT_MSG_YELL -- CHAT_MSG_MONSTER_WHISPER \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_WHISPER_INFORM.md b/wiki-information/events/CHAT_MSG_WHISPER_INFORM.md deleted file mode 100644 index 36552e8f..00000000 --- a/wiki-information/events/CHAT_MSG_WHISPER_INFORM.md +++ /dev/null @@ -1,43 +0,0 @@ -## Event: CHAT_MSG_WHISPER_INFORM - -**Title:** CHAT MSG WHISPER INFORM - -**Content:** -Fires when you send a whisper. -`CHAT_MSG_WHISPER_INFORM: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -- `text` - - *string* - The chat message payload. -- `playerName` - - *string* - Name of the player who was sent the whisper. -- `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -- `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -- `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -- `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -- `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -- `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -- `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -- `languageID` - - *number* - LanguageID -- `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -- `guid` - - *string* - Sender's Unit GUID. -- `bnSenderID` - - *number* - ID of the Battle.net friend. -- `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -- `isSubtitle` - - *boolean* -- `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -- `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` \ No newline at end of file diff --git a/wiki-information/events/CHAT_MSG_YELL.md b/wiki-information/events/CHAT_MSG_YELL.md deleted file mode 100644 index 83c1a03d..00000000 --- a/wiki-information/events/CHAT_MSG_YELL.md +++ /dev/null @@ -1,51 +0,0 @@ -## Event: CHAT_MSG_YELL - -**Title:** CHAT MSG YELL - -**Content:** -Fires when a player /yells. -`CHAT_MSG_YELL: text, playerName, languageName, channelName, playerName2, specialFlags, zoneChannelID, channelIndex, channelBaseName, languageID, lineID, guid, bnSenderID, isMobile, isSubtitle, hideSenderInLetterbox, supressRaidIcons` - -**Payload:** -1. `text` - - *string* - The chat message payload. -2. `playerName` - - *string* - Name of the user that initiated the chat message. -3. `languageName` - - *string* - Localized name of the language if applicable, e.g. "Common" or "Thalassian" -4. `channelName` - - *string* - Channel name with channelIndex, e.g. "2. Trade - City" -5. `playerName2` - - *string* - The target name when there are two users involved, otherwise the same as playerName or an empty string. -6. `specialFlags` - - *string* - User flags if applicable, possible values are: "GM", "DEV", "AFK", "DND", "COM" -7. `zoneChannelID` - - *number* - The static ID of the zone channel, e.g. 1 for General, 2 for Trade and 22 for LocalDefense. -8. `channelIndex` - - *number* - Channel index, this usually is related to the order in which you joined each channel. -9. `channelBaseName` - - *string* - Channel name without the number, e.g. "Trade - City" -10. `languageID` - - *number* - LanguageID -11. `lineID` - - *number* - Unique chat lineID for differentiating/reporting chat messages. Can be passed to `PlayerLocation:CreateFromChatLineID()` -12. `guid` - - *string* - Sender's Unit GUID. -13. `bnSenderID` - - *number* - ID of the Battle.net friend. -14. `isMobile` - - *boolean* - If the sender is using the Blizzard Battle.net Mobile app. -15. `isSubtitle` - - *boolean* -16. `hideSenderInLetterbox` - - *boolean* - Whether this chat message is meant to show in the CinematicFrame only. -17. `supressRaidIcons` - - *boolean* - Whether Target marker expressions like {rt7} and {diamond} should not be rendered with `C_ChatInfo.ReplaceIconAndGroupExpressions()` - -**Related Information:** -- CHAT_MSG_EMOTE -- CHAT_MSG_PARTY -- CHAT_MSG_RAID -- CHAT_MSG_SAY -- CHAT_MSG_WHISPER -- CHAT_MSG_MONSTER_YELL \ No newline at end of file diff --git a/wiki-information/events/CHAT_SERVER_DISCONNECTED.md b/wiki-information/events/CHAT_SERVER_DISCONNECTED.md deleted file mode 100644 index 9f0af8a9..00000000 --- a/wiki-information/events/CHAT_SERVER_DISCONNECTED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CHAT_SERVER_DISCONNECTED - -**Title:** CHAT SERVER DISCONNECTED - -**Content:** -Needs summary. -`CHAT_SERVER_DISCONNECTED: isInitialMessage` - -**Payload:** -- `isInitialMessage` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/CHAT_SERVER_RECONNECTED.md b/wiki-information/events/CHAT_SERVER_RECONNECTED.md deleted file mode 100644 index 25eaa22e..00000000 --- a/wiki-information/events/CHAT_SERVER_RECONNECTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CHAT_SERVER_RECONNECTED - -**Title:** CHAT SERVER RECONNECTED - -**Content:** -Needs summary. -`CHAT_SERVER_RECONNECTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CINEMATIC_START.md b/wiki-information/events/CINEMATIC_START.md deleted file mode 100644 index bf3a2dc1..00000000 --- a/wiki-information/events/CINEMATIC_START.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: CINEMATIC_START - -**Title:** CINEMATIC START - -**Content:** -Fires for an in-game cinematic/cutscene. -`CINEMATIC_START: canBeCancelled` - -**Payload:** -- `canBeCancelled` - - *boolean* - This unintuitively indicates whether it's a "real" cinematic, otherwise it's a vehicle cinematic which requires canceling in a different way. - -**Related Information:** -CINEMATIC_STOP -InCinematic(), IsInCinematicScene() \ No newline at end of file diff --git a/wiki-information/events/CINEMATIC_STOP.md b/wiki-information/events/CINEMATIC_STOP.md deleted file mode 100644 index 3b1aab9a..00000000 --- a/wiki-information/events/CINEMATIC_STOP.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CINEMATIC_STOP - -**Title:** CINEMATIC STOP - -**Content:** -Fires after an in-game cinematic/cutscene. -`CINEMATIC_STOP` - -**Payload:** -- `None` - -**Related Information:** -CINEMATIC_START \ No newline at end of file diff --git a/wiki-information/events/CLASS_TRIAL_TIMER_START.md b/wiki-information/events/CLASS_TRIAL_TIMER_START.md deleted file mode 100644 index 2a2b7adb..00000000 --- a/wiki-information/events/CLASS_TRIAL_TIMER_START.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CLASS_TRIAL_TIMER_START - -**Title:** CLASS TRIAL TIMER START - -**Content:** -Needs summary. -`CLASS_TRIAL_TIMER_START` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md b/wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md deleted file mode 100644 index dddbdca1..00000000 --- a/wiki-information/events/CLASS_TRIAL_UPGRADE_COMPLETE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CLASS_TRIAL_UPGRADE_COMPLETE - -**Title:** CLASS TRIAL UPGRADE COMPLETE - -**Content:** -Needs summary. -`CLASS_TRIAL_UPGRADE_COMPLETE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CLEAR_BOSS_EMOTES.md b/wiki-information/events/CLEAR_BOSS_EMOTES.md deleted file mode 100644 index 00b72e03..00000000 --- a/wiki-information/events/CLEAR_BOSS_EMOTES.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CLEAR_BOSS_EMOTES - -**Title:** CLEAR BOSS EMOTES - -**Content:** -Needs summary. -`CLEAR_BOSS_EMOTES` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CLIENT_SCENE_CLOSED.md b/wiki-information/events/CLIENT_SCENE_CLOSED.md deleted file mode 100644 index 335f8044..00000000 --- a/wiki-information/events/CLIENT_SCENE_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CLIENT_SCENE_CLOSED - -**Title:** CLIENT SCENE CLOSED - -**Content:** -Needs summary. -`CLIENT_SCENE_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CLIENT_SCENE_OPENED.md b/wiki-information/events/CLIENT_SCENE_OPENED.md deleted file mode 100644 index a0c8e48e..00000000 --- a/wiki-information/events/CLIENT_SCENE_OPENED.md +++ /dev/null @@ -1,18 +0,0 @@ -## Event: CLIENT_SCENE_OPENED - -**Title:** CLIENT SCENE OPENED - -**Content:** -Needs summary. -`CLIENT_SCENE_OPENED: sceneType` - -**Payload:** -- `sceneType` - - *Enum.ClientSceneType* - - *Value* - - *Field* - - *Description* - - 0 - - DefaultSceneType - - 1 - - MinigameSceneType \ No newline at end of file diff --git a/wiki-information/events/CLOSE_INBOX_ITEM.md b/wiki-information/events/CLOSE_INBOX_ITEM.md deleted file mode 100644 index 2e14ec7f..00000000 --- a/wiki-information/events/CLOSE_INBOX_ITEM.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLOSE_INBOX_ITEM - -**Title:** CLOSE INBOX ITEM - -**Content:** -Needs summary. -`CLOSE_INBOX_ITEM: mailIndex` - -**Payload:** -- `mailIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CLOSE_TABARD_FRAME.md b/wiki-information/events/CLOSE_TABARD_FRAME.md deleted file mode 100644 index 9779a624..00000000 --- a/wiki-information/events/CLOSE_TABARD_FRAME.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CLOSE_TABARD_FRAME - -**Title:** CLOSE TABARD FRAME - -**Content:** -Fired when the guild dress frame is closed. -`CLOSE_TABARD_FRAME` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CLUB_ADDED.md b/wiki-information/events/CLUB_ADDED.md deleted file mode 100644 index f5fbd3aa..00000000 --- a/wiki-information/events/CLUB_ADDED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_ADDED - -**Title:** CLUB ADDED - -**Content:** -Needs summary. -`CLUB_ADDED: clubId` - -**Payload:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_ERROR.md b/wiki-information/events/CLUB_ERROR.md deleted file mode 100644 index 8640d7da..00000000 --- a/wiki-information/events/CLUB_ERROR.md +++ /dev/null @@ -1,98 +0,0 @@ -## Event: CLUB_ERROR - -**Title:** CLUB ERROR - -**Content:** -Needs summary. -`CLUB_ERROR: action, error, clubType` - -**Payload:** -- `action` - - *number* - Enum.ClubActionType -- `error` - - *number* - Enum.ClubErrorType -- `clubType` - - *number* - Enum.ClubType - - *Enum.ClubActionType* - - Value - - Field - - Description - - 0 - - ErrorClubActionSubscribe - - 1 - - ErrorClubActionCreate - - 2 - - ErrorClubActionEdit - - 3 - - ErrorClubActionDestroy - - 4 - - ErrorClubActionLeave - - 5 - - ErrorClubActionCreateTicket - - 6 - - ErrorClubActionDestroyTicket - - 7 - - ErrorClubActionRedeemTicket - - 8 - - ErrorClubActionGetTicket - - 9 - - ErrorClubActionGetTickets - - 10 - - ErrorClubActionGetBans - - 11 - - ErrorClubActionGetInvitations - - 12 - - ErrorClubActionRevokeInvitation - - 13 - - ErrorClubActionAcceptInvitation - - 14 - - ErrorClubActionDeclineInvitation - - 15 - - ErrorClubActionCreateStream - - 16 - - ErrorClubActionEditStream - - 17 - - ErrorClubActionDestroyStream - - 18 - - ErrorClubActionInviteMember - - 19 - - ErrorClubActionEditMember - - 20 - - ErrorClubActionEditMemberNote - - 21 - - ErrorClubActionKickMember - - 22 - - ErrorClubActionAddBan - - 23 - - ErrorClubActionRemoveBan - - 24 - - ErrorClubActionCreateMessage - - 25 - - ErrorClubActionEditMessage - - 26 - - ErrorClubActionDestroyMessage - - *Enum.ClubErrorType* - - Value - - Field - - Description - - 0 - - ErrorCommunitiesNone - - 1 - - ErrorCommunitiesUnknown - - 2 - - ErrorCommunitiesNeutralFaction - - 3 - - ErrorCommunitiesUnknownRealm - - ... - - *Enum.ClubType* - - Value - - Field - - Description - - 0 - - BattleNet - - 1 - - Character - - 2 - - Guild - - 3 - - Other \ No newline at end of file diff --git a/wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md b/wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md deleted file mode 100644 index 45915687..00000000 --- a/wiki-information/events/CLUB_INVITATIONS_RECEIVED_FOR_CLUB.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_INVITATIONS_RECEIVED_FOR_CLUB - -**Title:** CLUB INVITATIONS RECEIVED FOR CLUB - -**Content:** -Needs summary. -`CLUB_INVITATIONS_RECEIVED_FOR_CLUB: clubId` - -**Payload:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md b/wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md deleted file mode 100644 index 4901bfb4..00000000 --- a/wiki-information/events/CLUB_INVITATION_ADDED_FOR_SELF.md +++ /dev/null @@ -1,172 +0,0 @@ -## Event: CLUB_INVITATION_ADDED_FOR_SELF - -**Title:** CLUB INVITATION ADDED FOR SELF - -**Content:** -Needs summary. -`CLUB_INVITATION_ADDED_FOR_SELF: invitation` - -**Payload:** -- `invitation` - - *structure* - ClubSelfInvitationInfo - - `ClubSelfInvitationInfo` - - Field - - Type - - Description - - invitationId - - string - - club - - ClubInfo - - inviter - - ClubMemberInfo - - leaders - - ClubMemberInfo - - ClubInfo - - Field - - Type - - Description - - clubId - - string - - name - - string - - shortName - - string? - - description - - string - - broadcast - - string - - clubType - - Enum.ClubType - - avatarId - - number - - memberCount - - number? - - favoriteTimeStamp - - number? - - joinTime - - number? - - UNIX timestamp measured in microsecond precision. - - socialQueueingEnabled - - boolean? - - crossFaction - - boolean? - - Added in 9.2.5 - - Enum.ClubType - - Value - - Field - - Description - - 0 - - BattleNet - - 1 - - Character - - 2 - - Guild - - 3 - - Other - - ClubMemberInfo - - Field - - Type - - Description - - isSelf - - boolean - - memberId - - number - - name - - string? - - name may be encoded as a Kstring - - role - - Enum.ClubRoleIdentifier? - - presence - - Enum.ClubMemberPresence - - clubType - - Enum.ClubType? - - guid - - string? - - bnetAccountId - - number? - - memberNote - - string? - - officerNote - - string? - - classID - - number? - - race - - number? - - level - - number? - - zone - - string? - - achievementPoints - - number? - - profession1ID - - number? - - profession1Rank - - number? - - profession1Name - - string? - - profession2ID - - number? - - profession2Rank - - number? - - profession2Name - - string? - - lastOnlineYear - - number? - - lastOnlineMonth - - number? - - lastOnlineDay - - number? - - lastOnlineHour - - number? - - guildRank - - string? - - guildRankOrder - - number? - - isRemoteChat - - boolean? - - overallDungeonScore - - number? - - Added in 9.1.0 - - faction - - Enum.PvPFaction? - - Added in 9.2.5 - - Enum.ClubRoleIdentifier - - Value - - Field - - Description - - 1 - - Owner - - 2 - - Leader - - 3 - - Moderator - - 4 - - Member - - Enum.ClubMemberPresence - - Value - - Field - - Description - - 0 - - Unknown - - 1 - - Online - - 2 - - OnlineMobile - - 3 - - Offline - - 4 - - Away - - 5 - - Busy - - Enum.ClubType - - Value - - Field - - Description - - 0 - - BattleNet - - 1 - - Character - - 2 - - Guild - - 3 - - Other \ No newline at end of file diff --git a/wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md b/wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md deleted file mode 100644 index 595d1446..00000000 --- a/wiki-information/events/CLUB_INVITATION_REMOVED_FOR_SELF.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_INVITATION_REMOVED_FOR_SELF - -**Title:** CLUB INVITATION REMOVED FOR SELF - -**Content:** -Needs summary. -`CLUB_INVITATION_REMOVED_FOR_SELF: invitationId` - -**Payload:** -- `invitationId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_ADDED.md b/wiki-information/events/CLUB_MEMBER_ADDED.md deleted file mode 100644 index c4a4d407..00000000 --- a/wiki-information/events/CLUB_MEMBER_ADDED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_MEMBER_ADDED - -**Title:** CLUB MEMBER ADDED - -**Content:** -Needs summary. -`CLUB_MEMBER_ADDED: clubId, memberId` - -**Payload:** -- `clubId` - - *string* -- `memberId` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md b/wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md deleted file mode 100644 index 3f416d89..00000000 --- a/wiki-information/events/CLUB_MEMBER_PRESENCE_UPDATED.md +++ /dev/null @@ -1,31 +0,0 @@ -## Event: CLUB_MEMBER_PRESENCE_UPDATED - -**Title:** CLUB MEMBER PRESENCE UPDATED - -**Content:** -Needs summary. -`CLUB_MEMBER_PRESENCE_UPDATED: clubId, memberId, presence` - -**Payload:** -- `clubId` - - *string* -- `memberId` - - *number* -- `presence` - - *number* - Enum.ClubMemberPresence - - Enum.ClubMemberPresence - - Value - - Field - - Description - - 0 - - Unknown - - 1 - - Online - - 2 - - OnlineMobile - - 3 - - Offline - - 4 - - Away - - 5 - - Busy \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_REMOVED.md b/wiki-information/events/CLUB_MEMBER_REMOVED.md deleted file mode 100644 index acb07e2e..00000000 --- a/wiki-information/events/CLUB_MEMBER_REMOVED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_MEMBER_REMOVED - -**Title:** CLUB MEMBER REMOVED - -**Content:** -Needs summary. -`CLUB_MEMBER_REMOVED: clubId, memberId` - -**Payload:** -- `clubId` - - *string* -- `memberId` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md b/wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md deleted file mode 100644 index ebef9464..00000000 --- a/wiki-information/events/CLUB_MEMBER_ROLE_UPDATED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: CLUB_MEMBER_ROLE_UPDATED - -**Title:** CLUB MEMBER ROLE UPDATED - -**Content:** -Needs summary. -`CLUB_MEMBER_ROLE_UPDATED: clubId, memberId, roleId` - -**Payload:** -- `clubId` - - *string* -- `memberId` - - *number* -- `roleId` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MEMBER_UPDATED.md b/wiki-information/events/CLUB_MEMBER_UPDATED.md deleted file mode 100644 index 4fd1ab40..00000000 --- a/wiki-information/events/CLUB_MEMBER_UPDATED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_MEMBER_UPDATED - -**Title:** CLUB MEMBER UPDATED - -**Content:** -Needs summary. -`CLUB_MEMBER_UPDATED: clubId, memberId` - -**Payload:** -- `clubId` - - *string* -- `memberId` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_MESSAGE_ADDED.md b/wiki-information/events/CLUB_MESSAGE_ADDED.md deleted file mode 100644 index 77f800af..00000000 --- a/wiki-information/events/CLUB_MESSAGE_ADDED.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: CLUB_MESSAGE_ADDED - -**Title:** CLUB MESSAGE ADDED - -**Content:** -Needs summary. -`CLUB_MESSAGE_ADDED: clubId, streamId, messageId` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* -- `messageId` - - *structure* - ClubMessageIdentifier - - ClubMessageIdentifier - - Field - - Type - - Description - - epoch - - *number* - number of microseconds since the UNIX epoch - - position - - *number* - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md b/wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md deleted file mode 100644 index 30ce3cab..00000000 --- a/wiki-information/events/CLUB_MESSAGE_HISTORY_RECEIVED.md +++ /dev/null @@ -1,34 +0,0 @@ -## Event: CLUB_MESSAGE_HISTORY_RECEIVED - -**Title:** CLUB MESSAGE HISTORY RECEIVED - -**Content:** -Needs summary. -`CLUB_MESSAGE_HISTORY_RECEIVED: clubId, streamId, downloadedRange, contiguousRange` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* -- `downloadedRange` - - ClubMessageRange - Range of history messages received. -- `contiguousRange` - - ClubMessageRange - Range of contiguous messages that the received messages are in. -- Field - - Type - - Description - - oldestMessageId - - ClubMessageIdentifier - - newestMessageId - - ClubMessageIdentifier - - ClubMessageIdentifier - - Field - - Type - - Description - - epoch - - number - - number of microseconds since the UNIX epoch - - position - - number - - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/events/CLUB_MESSAGE_UPDATED.md b/wiki-information/events/CLUB_MESSAGE_UPDATED.md deleted file mode 100644 index 8b894fa7..00000000 --- a/wiki-information/events/CLUB_MESSAGE_UPDATED.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: CLUB_MESSAGE_UPDATED - -**Title:** CLUB MESSAGE UPDATED - -**Content:** -Needs summary. -`CLUB_MESSAGE_UPDATED: clubId, streamId, messageId` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* -- `messageId` - - *structure* - ClubMessageIdentifier - - ClubMessageIdentifier - - Field - - Type - - Description - - epoch - - *number* - number of microseconds since the UNIX epoch - - position - - *number* - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/events/CLUB_REMOVED.md b/wiki-information/events/CLUB_REMOVED.md deleted file mode 100644 index 9d6439a3..00000000 --- a/wiki-information/events/CLUB_REMOVED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_REMOVED - -**Title:** CLUB REMOVED - -**Content:** -Needs summary. -`CLUB_REMOVED: clubId` - -**Payload:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_REMOVED_MESSAGE.md b/wiki-information/events/CLUB_REMOVED_MESSAGE.md deleted file mode 100644 index 84b1173b..00000000 --- a/wiki-information/events/CLUB_REMOVED_MESSAGE.md +++ /dev/null @@ -1,24 +0,0 @@ -## Event: CLUB_REMOVED_MESSAGE - -**Title:** CLUB REMOVED MESSAGE - -**Content:** -Needs summary. -`CLUB_REMOVED_MESSAGE: clubName, clubRemovedReason` - -**Payload:** -- `clubName` - - *string* -- `clubRemovedReason` - - *number* - Enum.ClubRemovedReason - - Value - - Field - - Description - - 0 - - None - - 1 - - Banned - - 2 - - Removed - - 3 - - ClubDestroyed \ No newline at end of file diff --git a/wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md b/wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md deleted file mode 100644 index 01725bc2..00000000 --- a/wiki-information/events/CLUB_SELF_MEMBER_ROLE_UPDATED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_SELF_MEMBER_ROLE_UPDATED - -**Title:** CLUB SELF MEMBER ROLE UPDATED - -**Content:** -Needs summary. -`CLUB_SELF_MEMBER_ROLE_UPDATED: clubId, roleId` - -**Payload:** -- `clubId` - - *string* -- `roleId` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAMS_LOADED.md b/wiki-information/events/CLUB_STREAMS_LOADED.md deleted file mode 100644 index 5b06a9ee..00000000 --- a/wiki-information/events/CLUB_STREAMS_LOADED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_STREAMS_LOADED - -**Title:** CLUB STREAMS LOADED - -**Content:** -Needs summary. -`CLUB_STREAMS_LOADED: clubId` - -**Payload:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_ADDED.md b/wiki-information/events/CLUB_STREAM_ADDED.md deleted file mode 100644 index 19b953e0..00000000 --- a/wiki-information/events/CLUB_STREAM_ADDED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_STREAM_ADDED - -**Title:** CLUB STREAM ADDED - -**Content:** -Needs summary. -`CLUB_STREAM_ADDED: clubId, streamId` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_REMOVED.md b/wiki-information/events/CLUB_STREAM_REMOVED.md deleted file mode 100644 index c8662efa..00000000 --- a/wiki-information/events/CLUB_STREAM_REMOVED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_STREAM_REMOVED - -**Title:** CLUB STREAM REMOVED - -**Content:** -Needs summary. -`CLUB_STREAM_REMOVED: clubId, streamId` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_SUBSCRIBED.md b/wiki-information/events/CLUB_STREAM_SUBSCRIBED.md deleted file mode 100644 index b7983cb8..00000000 --- a/wiki-information/events/CLUB_STREAM_SUBSCRIBED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_STREAM_SUBSCRIBED - -**Title:** CLUB STREAM SUBSCRIBED - -**Content:** -Needs summary. -`CLUB_STREAM_SUBSCRIBED: clubId, streamId` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md b/wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md deleted file mode 100644 index 6bfc78db..00000000 --- a/wiki-information/events/CLUB_STREAM_UNSUBSCRIBED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_STREAM_UNSUBSCRIBED - -**Title:** CLUB STREAM UNSUBSCRIBED - -**Content:** -Needs summary. -`CLUB_STREAM_UNSUBSCRIBED: clubId, streamId` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_STREAM_UPDATED.md b/wiki-information/events/CLUB_STREAM_UPDATED.md deleted file mode 100644 index fb85b0e9..00000000 --- a/wiki-information/events/CLUB_STREAM_UPDATED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CLUB_STREAM_UPDATED - -**Title:** CLUB STREAM UPDATED - -**Content:** -Needs summary. -`CLUB_STREAM_UPDATED: clubId, streamId` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_TICKETS_RECEIVED.md b/wiki-information/events/CLUB_TICKETS_RECEIVED.md deleted file mode 100644 index e7b18a45..00000000 --- a/wiki-information/events/CLUB_TICKETS_RECEIVED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_TICKETS_RECEIVED - -**Title:** CLUB TICKETS RECEIVED - -**Content:** -Needs summary. -`CLUB_TICKETS_RECEIVED: clubId` - -**Payload:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_TICKET_CREATED.md b/wiki-information/events/CLUB_TICKET_CREATED.md deleted file mode 100644 index 54594989..00000000 --- a/wiki-information/events/CLUB_TICKET_CREATED.md +++ /dev/null @@ -1,140 +0,0 @@ -## Event: CLUB_TICKET_CREATED - -**Title:** CLUB TICKET CREATED - -**Content:** -Needs summary. -`CLUB_TICKET_CREATED: clubId, ticketInfo` - -**Payload:** -- `clubId` - - *string* -- `ticketInfo` - - *structure - ClubTicketInfo* - - *ClubTicketInfo* - - *Field* - - *Type* - - *Description* - - `ticketId` - - *string* - - `allowedRedeemCount` - - *number* - - `currentRedeemCount` - - *number* - - `creationTime` - - *number* - - *Creation time in microseconds since the UNIX epoch* - - `expirationTime` - - *number* - - *Expiration time in microseconds since the UNIX epoch* - - `defaultStreamId` - - *string?* - - `creator` - - *ClubMemberInfo* - - *ClubMemberInfo* - - *Field* - - *Type* - - *Description* - - `isSelf` - - *boolean* - - `memberId` - - *number* - - `name` - - *string?* - - *name may be encoded as a Kstring* - - `role` - - *Enum.ClubRoleIdentifier?* - - `presence` - - *Enum.ClubMemberPresence* - - `clubType` - - *Enum.ClubType?* - - `guid` - - *string?* - - `bnetAccountId` - - *number?* - - `memberNote` - - *string?* - - `officerNote` - - *string?* - - `classID` - - *number?* - - `race` - - *number?* - - `level` - - *number?* - - `zone` - - *string?* - - `achievementPoints` - - *number?* - - `profession1ID` - - *number?* - - `profession1Rank` - - *number?* - - `profession1Name` - - *string?* - - `profession2ID` - - *number?* - - `profession2Rank` - - *number?* - - `profession2Name` - - *string?* - - `lastOnlineYear` - - *number?* - - `lastOnlineMonth` - - *number?* - - `lastOnlineDay` - - *number?* - - `lastOnlineHour` - - *number?* - - `guildRank` - - *string?* - - `guildRankOrder` - - *number?* - - `isRemoteChat` - - *boolean?* - - `overallDungeonScore` - - *number?* - - *Added in 9.1.0* - - `faction` - - *Enum.PvPFaction?* - - *Added in 9.2.5* - - *Enum.ClubRoleIdentifier* - - *Value* - - *Field* - - *Description* - - `1` - - *Owner* - - `2` - - *Leader* - - `3` - - *Moderator* - - `4` - - *Member* - - *Enum.ClubMemberPresence* - - *Value* - - *Field* - - *Description* - - `0` - - *Unknown* - - `1` - - *Online* - - `2` - - *OnlineMobile* - - `3` - - *Offline* - - `4` - - *Away* - - `5` - - *Busy* - - *Enum.ClubType* - - *Value* - - *Field* - - *Description* - - `0` - - *BattleNet* - - `1` - - *Character* - - `2` - - *Guild* - - `3` - - *Other* \ No newline at end of file diff --git a/wiki-information/events/CLUB_TICKET_RECEIVED.md b/wiki-information/events/CLUB_TICKET_RECEIVED.md deleted file mode 100644 index af475989..00000000 --- a/wiki-information/events/CLUB_TICKET_RECEIVED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_TICKET_RECEIVED - -**Title:** CLUB TICKET RECEIVED - -**Content:** -Needs summary. -`CLUB_TICKET_RECEIVED: ticket` - -**Payload:** -- `ticket` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CLUB_UPDATED.md b/wiki-information/events/CLUB_UPDATED.md deleted file mode 100644 index 445b762d..00000000 --- a/wiki-information/events/CLUB_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CLUB_UPDATED - -**Title:** CLUB UPDATED - -**Content:** -Needs summary. -`CLUB_UPDATED: clubId` - -**Payload:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/events/COMBAT_LOG_EVENT.md b/wiki-information/events/COMBAT_LOG_EVENT.md deleted file mode 100644 index 57077829..00000000 --- a/wiki-information/events/COMBAT_LOG_EVENT.md +++ /dev/null @@ -1,220 +0,0 @@ -## Event: COMBAT_LOG_EVENT - -**Title:** COMBAT LOG EVENT - -**Content:** -Fires for Combat Log events such as a player casting a spell or an NPC taking damage. -COMBAT_LOG_EVENT only reflects the filtered events in the combat log window -COMBAT_LOG_EVENT_UNFILTERED (CLEU) is unfiltered, making it preferred for use by addons. -Both events have identical parameters. The event payload is returned from CombatLogGetCurrentEventInfo(), or from CombatLogGetCurrentEntry() if selected using CombatLogSetCurrentEntry(). - -**Parameters & Values:** -- `1st Param` - - *timestamp* - Unix Time in seconds with milliseconds precision, for example 1555749627.861. Similar to time() and can be passed as the second argument of date(). -- `2nd Param` - - *subevent* - The combat log event, for example SPELL_DAMAGE. -- `3rd Param` - - *hideCaster* - boolean - Returns true if the source unit is hidden (an empty string). -- `4th Param` - - *sourceGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". -- `5th Param` - - *sourceName* - string - Name of the unit. -- `6th Param` - - *sourceFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. -- `7th Param` - - *sourceRaidFlags* - number - Contains the raid flag bits for a unit's raid target icon. For example 64 (0x40): Unit is marked with . -- `8th Param` - - *destGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". -- `9th Param` - - *destName* - string - Name of the unit. -- `10th Param` - - *destFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. - -**Payload:** -- This comparison illustrates the difference between swing and spell events, e.g. the amount suffix parameter is on arg12 for SWING_DAMAGE and arg15 for SPELL_DAMAGE. -- `1617986084.18, "SWING_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 3, -1, 1, nil, nil, nil, true, false, false, false` -- `1617986113.264, "SPELL_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 585, "Smite", 2, 47, 19, 2, nil, nil, nil, false, false, false, false` -- `SWING_DAMAGE` - - *Idx* - - *Param* - - *Value* - - *self* - - ** - - *event* - - *"COMBAT_LOG_EVENT_UNFILTERED"* - - *1* - - *timestamp* - - *1617986084.18* - - *2* - - *subevent* - - *"SWING_DAMAGE"* - - *3* - - *hideCaster* - - *false* - - *4* - - *sourceGUID* - - *"Player-1096-06DF65C1"* - - *5* - - *sourceName* - - *"Xiaohuli"* - - *6* - - *sourceFlags* - - *1297* - - *7* - - *sourceRaidFlags* - - *0* - - *8* - - *destGUID* - - *"Creature-0-4253-0-160-94-000070569B"* - - *9* - - *destName* - - *"Cutpurse"* - - *10* - - *destFlags* - - *68168* - - *11* - - *destRaidFlags* - - *0* - - *12* - - *amount* - - *3* - - *13* - *overkill* - - *-1* - - *14* - - *school* - - *1* - - *15* - *resisted* - - *nil* - - *16* - *blocked* - - *nil* - - *17* - *absorbed* - - *nil* - - *18* - *critical* - - *true* - - *19* - *glancing* - - *false* - - *20* - *crushing* - - *false* - - *21* - *isOffHand* - - *false* -- `SPELL_DAMAGE` - - *Idx* - - *Param* - - *Value* - - *self* - - ** - - *event* - - *"COMBAT_LOG_EVENT_UNFILTERED"* - - *1* - - *timestamp* - - *1617986113.264* - - *2* - - *subevent* - - *"SPELL_DAMAGE"* - - *3* - - *hideCaster* - - *false* - - *4* - - *sourceGUID* - - *"Player-1096-06DF65C1"* - - *5* - - *sourceName* - - *"Xiaohuli"* - - *6* - - *sourceFlags* - - *1297* - - *7* - - *sourceRaidFlags* - - *0* - - *8* - - *destGUID* - - *"Creature-0-4253-0-160-94-000070569B"* - - *9* - - *destName* - - *"Cutpurse"* - - *10* - - *destFlags* - - *68168* - - *11* - - *destRaidFlags* - - *0* - - *12* - - *spellId* - - *585* - - *13* - *spellName* - - *"Smite"* - - *14* - *spellSchool* - - *2* - - *15* - *amount* - - *47* - - *16* - *overkill* - - *19* - - *17* - *school* - - *2* - - *18* - *resisted* - - *nil* - - *19* - *blocked* - - *nil* - - *20* - *absorbed* - - *nil* - - *21* - *critical* - - *false* - - *22* - *glancing* - - *false* - - *23* - *crushing* - - *false* - - *24* - *isOffHand* - - *false* - -**Usage:** -- Script: - - Prints all CLEU parameters. - ```lua - local function OnEvent(self, event) - print(CombatLogGetCurrentEventInfo()) - end - local f = CreateFrame("Frame") - f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") - f:SetScript("OnEvent", OnEvent) - ``` - - Displays your spell or melee critical hits. - ```lua - local playerGUID = UnitGUID("player") - local MSG_CRITICAL_HIT = "Your %s critically hit %s for %d damage!" - local f = CreateFrame("Frame") - f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") - f:SetScript("OnEvent", function(self, event) - local _, subevent, _, sourceGUID, _, _, _, _, destName = CombatLogGetCurrentEventInfo() - local spellId, amount, critical - if subevent == "SWING_DAMAGE" then - amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) - elseif subevent == "SPELL_DAMAGE" then - spellId, _, _, amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) - end - if critical and sourceGUID == playerGUID then - -- get the link of the spell or the MELEE globalstring - local action = spellId and GetSpellLink(spellId) or MELEE - print(MSG_CRITICAL_HIT:format(action, destName, amount)) - end - }) - ``` \ No newline at end of file diff --git a/wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md b/wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md deleted file mode 100644 index 47a675c9..00000000 --- a/wiki-information/events/COMBAT_LOG_EVENT_UNFILTERED.md +++ /dev/null @@ -1,228 +0,0 @@ -## Event: COMBAT_LOG_EVENT - -**Title:** COMBAT LOG EVENT - -**Content:** -Fires for Combat Log events such as a player casting a spell or an NPC taking damage. -COMBAT_LOG_EVENT only reflects the filtered events in the combat log window -COMBAT_LOG_EVENT_UNFILTERED (CLEU) is unfiltered, making it preferred for use by addons. -Both events have identical parameters. The event payload is returned from CombatLogGetCurrentEventInfo(), or from CombatLogGetCurrentEntry() if selected using CombatLogSetCurrentEntry(). - -**Parameters & Values:** -- `1st Param` - - *timestamp* - Unix Time in seconds with milliseconds precision, for example 1555749627.861. Similar to time() and can be passed as the second argument of date(). -- `2nd Param` - - *subevent* - The combat log event, for example SPELL_DAMAGE. -- `3rd Param` - - *hideCaster* - boolean - Returns true if the source unit is hidden (an empty string). -- `4th Param` - - *sourceGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". -- `5th Param` - - *sourceName* - string - Name of the unit. -- `6th Param` - - *sourceFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. -- `7th Param` - - *sourceRaidFlags* - number - Contains the raid flag bits for a unit's raid target icon. For example 64 (0x40): Unit is marked with . -- `8th Param` - - *destGUID* - string - Globally unique identifier for units (NPCs, players, pets, etc), for example "Creature-0-3113-0-47-94-00003AD5D7". -- `9th Param` - - *destName* - string - Name of the unit. -- `10th Param` - - *destFlags* - number - Contains the flag bits for a unit's type, controller, reaction and affiliation. For example 68168 (0x10A48): Unit is the current target, is an NPC, the controller is an NPC, reaction is hostile and affiliation is outsider. -- `11th Param` - - *destRaidFlags* - number - Contains the raid flag bits for a unit's raid target icon. For example 64 (0x40): Unit is marked with . - -**Payload:** -This comparison illustrates the difference between swing and spell events, e.g. the amount suffix parameter is on arg12 for SWING_DAMAGE and arg15 for SPELL_DAMAGE. -```lua -1617986084.18, "SWING_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 3, -1, 1, nil, nil, nil, true, false, false, false -1617986113.264, "SPELL_DAMAGE", false, "Player-1096-06DF65C1", "Xiaohuli", 1297, 0, "Creature-0-4253-0-160-94-000070569B", "Cutpurse", 68168, 0, 585, "Smite", 2, 47, 19, 2, nil, nil, nil, false, false, false, false -``` -- **SWING_DAMAGE** - - *Idx* - Param - - *Param* - Value - - *self* - - - *event* - "COMBAT_LOG_EVENT_UNFILTERED" - - *1* - *timestamp* - 1617986084.18 - - *2* - *subevent* - "SWING_DAMAGE" - - *3* - *hideCaster* - false - - *4* - *sourceGUID* - "Player-1096-06DF65C1" - - *5* - *sourceName* - "Xiaohuli" - - *6* - *sourceFlags* - 1297 - - *7* - *sourceRaidFlags* - 0 - - *8* - *destGUID* - "Creature-0-4253-0-160-94-000070569B" - - *9* - *destName* - "Cutpurse" - - *10* - *destFlags* - 68168 - - *11* - *destRaidFlags* - 0 - - *12* - *amount* - 3 - - *13* - *overkill* - -1 - - *14* - *school* - 1 - - *15* - *resisted* - nil - - *16* - *blocked* - nil - - *17* - *absorbed* - nil - - *18* - *critical* - true - - *19* - *glancing* - false - - *20* - *crushing* - false - - *21* - *isOffHand* - false - -- **SPELL_DAMAGE** - - *Idx* - Param - - *Param* - Value - - *self* - - - *event* - "COMBAT_LOG_EVENT_UNFILTERED" - - *1* - *timestamp* - 1617986113.264 - - *2* - *subevent* - "SPELL_DAMAGE" - - *3* - *hideCaster* - false - - *4* - *sourceGUID* - "Player-1096-06DF65C1" - - *5* - *sourceName* - "Xiaohuli" - - *6* - *sourceFlags* - 1297 - - *7* - *sourceRaidFlags* - 0 - - *8* - *destGUID* - "Creature-0-4253-0-160-94-000070569B" - - *9* - *destName* - "Cutpurse" - - *10* - *destFlags* - 68168 - - *11* - *destRaidFlags* - 0 - - *12* - *spellId* - 585 - - *13* - *spellName* - "Smite" - - *14* - *spellSchool* - 2 - - *15* - *amount* - 47 - - *16* - *overkill* - 19 - - *17* - *school* - 2 - - *18* - *resisted* - nil - - *19* - *blocked* - nil - - *20* - *absorbed* - nil - - *21* - *critical* - false - - *22* - *glancing* - false - - *23* - *crushing* - false - - *24* - *isOffHand* - false - -**Usage:** -Script: -Prints all CLEU parameters. -```lua -local function OnEvent(self, event) - print(CombatLogGetCurrentEventInfo()) -end -local f = CreateFrame("Frame") -f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") -f:SetScript("OnEvent", OnEvent) -``` -Displays your spell or melee critical hits. -```lua -local playerGUID = UnitGUID("player") -local MSG_CRITICAL_HIT = "Your %s critically hit %s for %d damage!" -local f = CreateFrame("Frame") -f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") -f:SetScript("OnEvent", function(self, event) - local _, subevent, _, sourceGUID, _, _, _, _, destName = CombatLogGetCurrentEventInfo() - local spellId, amount, critical - if subevent == "SWING_DAMAGE" then - amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) - elseif subevent == "SPELL_DAMAGE" then - spellId, _, _, amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) - end - if critical and sourceGUID == playerGUID then - -- get the link of the spell or the MELEE globalstring - local action = spellId and GetSpellLink(spellId) or MELEE - print(MSG_CRITICAL_HIT:format(action, destName, amount)) - end -end) -``` - -**Content Details:** -Event Trace: -For the new event trace tool added in Patch 9.1.0 the following script can be loaded. -```lua -local function LogEvent(self, event, ...) - if event == "COMBAT_LOG_EVENT_UNFILTERED" or event == "COMBAT_LOG_EVENT" then - self:LogEvent_Original(event, CombatLogGetCurrentEventInfo()) - elseif event == "COMBAT_TEXT_UPDATE" then - self:LogEvent_Original(event, (...), GetCurrentCombatTextEventInfo()) - else - self:LogEvent_Original(event, ...) - end -end -local function OnEventTraceLoaded() - EventTrace.LogEvent_Original = EventTrace.LogEvent - EventTrace.LogEvent = LogEvent -end -if EventTrace then - OnEventTraceLoaded() -else - local frame = CreateFrame("Frame") - frame:RegisterEvent("ADDON_LOADED") - frame:SetScript("OnEvent", function(self, event, ...) - if event == "ADDON_LOADED" and (...) == "Blizzard_EventTrace" then - OnEventTraceLoaded() - self:UnregisterAllEvents() - end - end) -end -``` -SPELL_ABSORBED: -This relatively new subevent fires in addition to SWING_MISSED / SPELL_MISSED which already have the "ABSORB" missType and same amount. It optionally includes the spell payload if triggered from what would be SPELL_DAMAGE. -```lua -timestamp, subevent, hideCaster, sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags, , casterGUID, casterName, casterFlags, casterRaidFlags, absorbSpellId, absorbSpellName, absorbSpellSchool, amount, critical -``` --- swing -```lua -1620562047.156, "SWING_MISSED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, "ABSORB", false, 13, false -1620562047.156, "SPELL_ABSORBED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 17, "Power Word: Shield", 2, 13, false --- spell -1620561974.121, "SPELL_MISSED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 83669, "Water Bolt", 16, "ABSORB", false, 15, false -1620561974.121, "SPELL_ABSORBED", false, "Creature-0-4234-0-138-44176-000016DAE1", "Bluegill Wanderer", 2632, 0, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 83669, "Water Bolt", 16, "Player-1096-06DF65C1", "Xiaohuli", 66833, 0, 17, "Power Word: Shield", 2, 15, false -``` -SWING_DAMAGE -Idx -Param -Value -self - -event -"COMBAT_LOG_EVENT_UNFILTERED" -1 -timestamp -1617986084.18 -2 -subevent -"SWING_DAMAGE" -3 -hideCaster -false -4 -sourceGUID -"Player-1096-06DF65C1" -5 -sourceName -"Xiaohuli" -6 -sourceFlags -1297 -7 -sourceRaidFlags -0 -8 -destGUID -"Creature-0-4253-0-160-94-00006FB363" -9 -destName -"Cutpurse" -10 -destFlags -68168 -11 -destRaidFlags -0 -12 -amount -3 -13 -overkill --1 -14 -school -1 -15 -resisted -nil -16 -blocked \ No newline at end of file diff --git a/wiki-information/events/COMBAT_RATING_UPDATE.md b/wiki-information/events/COMBAT_RATING_UPDATE.md deleted file mode 100644 index 11e74db7..00000000 --- a/wiki-information/events/COMBAT_RATING_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMBAT_RATING_UPDATE - -**Title:** COMBAT RATING UPDATE - -**Content:** -Needs summary. -`COMBAT_RATING_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMBAT_TEXT_UPDATE.md b/wiki-information/events/COMBAT_TEXT_UPDATE.md deleted file mode 100644 index 67721b37..00000000 --- a/wiki-information/events/COMBAT_TEXT_UPDATE.md +++ /dev/null @@ -1,37 +0,0 @@ -## Event: COMBAT_TEXT_UPDATE - -**Title:** COMBAT TEXT UPDATE - -**Content:** -Fired when the currently watched entity (as set by the CombatTextSetActiveUnit function) takes or avoids damage, receives heals, gains mana/energy/rage, etc. This event is used by Blizzard's floating combat text addon. -`COMBAT_TEXT_UPDATE: combatTextType` - -**Payload:** -- `combatTextType` - - *string* - Combat message type. Known values include - - "DAMAGE" - - "SPELL_DAMAGE" - - "DAMAGE_CRIT" - - "HEAL" - - "PERIODIC_HEAL" - - "HEAL_CRIT" - - "MISS" - - "DODGE" - - "PARRY" - - "BLOCK" - - "RESIST" - - "SPELL_RESISTED" - - "ABSORB" - - "SPELL_ABSORBED" - - "MANA" - - "ENERGY" - - "RAGE" - - "FOCUS" - - "SPELL_ACTIVE" - - "COMBO_POINTS" - - "AURA_START" - - "AURA_END" - - "AURA_START_HARMFUL" - - "AURA_END_HARMFUL" - - "HONOR_GAINED" - - "FACTION" \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_ENTER_WORLD.md b/wiki-information/events/COMMENTATOR_ENTER_WORLD.md deleted file mode 100644 index b6762af5..00000000 --- a/wiki-information/events/COMMENTATOR_ENTER_WORLD.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMMENTATOR_ENTER_WORLD - -**Title:** COMMENTATOR ENTER WORLD - -**Content:** -Fired when the character logs in and the server sends the greeting text. (e.g. "Scammers are trying harder than ever to phish for your account information!..."). This is not fired when reloading the UI. -`COMMENTATOR_ENTER_WORLD` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md b/wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md deleted file mode 100644 index 5c28bc08..00000000 --- a/wiki-information/events/COMMENTATOR_HISTORY_FLUSHED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMMENTATOR_HISTORY_FLUSHED - -**Title:** COMMENTATOR HISTORY FLUSHED - -**Content:** -Needs summary. -`COMMENTATOR_HISTORY_FLUSHED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md b/wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md deleted file mode 100644 index 531cc736..00000000 --- a/wiki-information/events/COMMENTATOR_IMMEDIATE_FOV_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: COMMENTATOR_IMMEDIATE_FOV_UPDATE - -**Title:** COMMENTATOR IMMEDIATE FOV UPDATE - -**Content:** -Needs summary. -`COMMENTATOR_IMMEDIATE_FOV_UPDATE: fov` - -**Payload:** -- `fov` - - *number* \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_MAP_UPDATE.md b/wiki-information/events/COMMENTATOR_MAP_UPDATE.md deleted file mode 100644 index 4b74d474..00000000 --- a/wiki-information/events/COMMENTATOR_MAP_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMMENTATOR_MAP_UPDATE - -**Title:** COMMENTATOR MAP UPDATE - -**Content:** -Needs summary. -`COMMENTATOR_MAP_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md b/wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md deleted file mode 100644 index 2909d43d..00000000 --- a/wiki-information/events/COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE - -**Title:** COMMENTATOR PLAYER NAME OVERRIDE UPDATE - -**Content:** -Needs summary. -`COMMENTATOR_PLAYER_NAME_OVERRIDE_UPDATE: nameToOverride, overrideName` - -**Payload:** -- `nameToOverride` - - *string* -- `overrideName` - - *string?* \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md b/wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md deleted file mode 100644 index ae0316ff..00000000 --- a/wiki-information/events/COMMENTATOR_PLAYER_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMMENTATOR_PLAYER_UPDATE - -**Title:** COMMENTATOR PLAYER UPDATE - -**Content:** -Needs summary. -`COMMENTATOR_PLAYER_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_RESET_SETTINGS.md b/wiki-information/events/COMMENTATOR_RESET_SETTINGS.md deleted file mode 100644 index a9351b8a..00000000 --- a/wiki-information/events/COMMENTATOR_RESET_SETTINGS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMMENTATOR_RESET_SETTINGS - -**Title:** COMMENTATOR RESET SETTINGS - -**Content:** -Needs summary. -`COMMENTATOR_RESET_SETTINGS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md b/wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md deleted file mode 100644 index db8fe7be..00000000 --- a/wiki-information/events/COMMENTATOR_TEAMS_SWAPPED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: COMMENTATOR_TEAMS_SWAPPED - -**Title:** COMMENTATOR TEAMS SWAPPED - -**Content:** -Needs summary. -`COMMENTATOR_TEAMS_SWAPPED: swapped` - -**Payload:** -- `swapped` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md b/wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md deleted file mode 100644 index 24aeb060..00000000 --- a/wiki-information/events/COMMENTATOR_TEAM_NAME_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: COMMENTATOR_TEAM_NAME_UPDATE - -**Title:** COMMENTATOR TEAM NAME UPDATE - -**Content:** -Needs summary. -`COMMENTATOR_TEAM_NAME_UPDATE: teamName` - -**Payload:** -- `teamName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md b/wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md deleted file mode 100644 index 4646ef2e..00000000 --- a/wiki-information/events/COMMUNITIES_STREAM_CURSOR_CLEAR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMMUNITIES_STREAM_CURSOR_CLEAR - -**Title:** COMMUNITIES STREAM CURSOR CLEAR - -**Content:** -Needs summary. -`COMMUNITIES_STREAM_CURSOR_CLEAR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md b/wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md deleted file mode 100644 index e09e908e..00000000 --- a/wiki-information/events/COMPACT_UNIT_FRAME_PROFILES_LOADED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMPACT_UNIT_FRAME_PROFILES_LOADED - -**Title:** COMPACT UNIT FRAME PROFILES LOADED - -**Content:** -Needs summary. -`COMPACT_UNIT_FRAME_PROFILES_LOADED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPANION_LEARNED.md b/wiki-information/events/COMPANION_LEARNED.md deleted file mode 100644 index dee57f18..00000000 --- a/wiki-information/events/COMPANION_LEARNED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMPANION_LEARNED - -**Title:** COMPANION LEARNED - -**Content:** -Needs summary. -`COMPANION_LEARNED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPANION_UNLEARNED.md b/wiki-information/events/COMPANION_UNLEARNED.md deleted file mode 100644 index 570691bd..00000000 --- a/wiki-information/events/COMPANION_UNLEARNED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: COMPANION_UNLEARNED - -**Title:** COMPANION UNLEARNED - -**Content:** -Needs summary. -`COMPANION_UNLEARNED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/COMPANION_UPDATE.md b/wiki-information/events/COMPANION_UPDATE.md deleted file mode 100644 index 6f7a6ece..00000000 --- a/wiki-information/events/COMPANION_UPDATE.md +++ /dev/null @@ -1,20 +0,0 @@ -## Event: COMPANION_UPDATE - -**Title:** COMPANION UPDATE - -**Content:** -Fired when companion info updates. -`COMPANION_UPDATE: companionType` - -**Payload:** -- `companionType` - - *string?* - -**Content Details:** -If the type is nil, the UI should update if it's visible, regardless of which type it's managing. If the type is non-nil, then it will be either "CRITTER" or "MOUNT" and that signifies that the active companion has changed and the UI should update if it's currently showing that type. -"Range" appears to be at least 40 yards. If you are in a major city, expect this event to fire constantly. -This event fires when any of the following conditions occur: -- You, or anyone within range, summons or dismisses a critter -- You, or anyone within range, mounts or dismounts -- Someone enters range with a critter summoned -- Someone enters range while mounted \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_BEFORE_USE.md b/wiki-information/events/CONFIRM_BEFORE_USE.md deleted file mode 100644 index 7c9b2930..00000000 --- a/wiki-information/events/CONFIRM_BEFORE_USE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CONFIRM_BEFORE_USE - -**Title:** CONFIRM BEFORE USE - -**Content:** -Needs summary. -`CONFIRM_BEFORE_USE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_BINDER.md b/wiki-information/events/CONFIRM_BINDER.md deleted file mode 100644 index 2d5da455..00000000 --- a/wiki-information/events/CONFIRM_BINDER.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CONFIRM_BINDER - -**Title:** CONFIRM BINDER - -**Content:** -Needs summary. -`CONFIRM_BINDER: areaName` - -**Payload:** -- `areaName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_LOOT_ROLL.md b/wiki-information/events/CONFIRM_LOOT_ROLL.md deleted file mode 100644 index e59d9780..00000000 --- a/wiki-information/events/CONFIRM_LOOT_ROLL.md +++ /dev/null @@ -1,18 +0,0 @@ -## Event: CONFIRM_LOOT_ROLL - -**Title:** CONFIRM LOOT ROLL - -**Content:** -Fires when you try to roll "need" or "greed" for and item which Binds on Pickup. -`CONFIRM_LOOT_ROLL: rollID, rollType, confirmReason` - -**Payload:** -- `rollID` - - *number* -- `rollType` - - *number* - 1=Need, 2=Greed, 3=Disenchant -- `confirmReason` - - *string* - -**Related Information:** -RollOnLoot() \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_PET_UNLEARN.md b/wiki-information/events/CONFIRM_PET_UNLEARN.md deleted file mode 100644 index b9774733..00000000 --- a/wiki-information/events/CONFIRM_PET_UNLEARN.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CONFIRM_PET_UNLEARN - -**Title:** CONFIRM PET UNLEARN - -**Content:** -Needs summary. -`CONFIRM_PET_UNLEARN: cost` - -**Payload:** -- `cost` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_SUMMON.md b/wiki-information/events/CONFIRM_SUMMON.md deleted file mode 100644 index e040008c..00000000 --- a/wiki-information/events/CONFIRM_SUMMON.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CONFIRM_SUMMON - -**Title:** CONFIRM SUMMON - -**Content:** -Needs summary. -`CONFIRM_SUMMON: summonReason, skippingStartExperience` - -**Payload:** -- `summonReason` - - *number* -- `skippingStartExperience` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_TALENT_WIPE.md b/wiki-information/events/CONFIRM_TALENT_WIPE.md deleted file mode 100644 index 990dd84b..00000000 --- a/wiki-information/events/CONFIRM_TALENT_WIPE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CONFIRM_TALENT_WIPE - -**Title:** CONFIRM TALENT WIPE - -**Content:** -Fires when the user selects the "Yes, I do." confirmation prompt after speaking to a class trainer and choosing to unlearn their talents. -`CONFIRM_TALENT_WIPE: cost, respecType` - -**Payload:** -- `cost` - - *number* - Cost in copper. -- `respecType` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CONFIRM_XP_LOSS.md b/wiki-information/events/CONFIRM_XP_LOSS.md deleted file mode 100644 index 705ad4b5..00000000 --- a/wiki-information/events/CONFIRM_XP_LOSS.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: CONFIRM_XP_LOSS - -**Title:** CONFIRM XP LOSS - -**Content:** -Fired when the player wants to revive at the spirit healer. A durability loss will be taken in exchange for resurrecting. -`CONFIRM_XP_LOSS` - -**Payload:** -- `None` - -**Content Details:** -History: Way back before WoW was released, you lost experience rather than durability when you resurrected at a spirit healer. - -**Related Information:** -AcceptXPLoss() \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_CLEAR.md b/wiki-information/events/CONSOLE_CLEAR.md deleted file mode 100644 index 675c08e6..00000000 --- a/wiki-information/events/CONSOLE_CLEAR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CONSOLE_CLEAR - -**Title:** CONSOLE CLEAR - -**Content:** -Needs summary. -`CONSOLE_CLEAR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_COLORS_CHANGED.md b/wiki-information/events/CONSOLE_COLORS_CHANGED.md deleted file mode 100644 index 02385e50..00000000 --- a/wiki-information/events/CONSOLE_COLORS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CONSOLE_COLORS_CHANGED - -**Title:** CONSOLE COLORS CHANGED - -**Content:** -Needs summary. -`CONSOLE_COLORS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md b/wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md deleted file mode 100644 index f0b75c90..00000000 --- a/wiki-information/events/CONSOLE_FONT_SIZE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CONSOLE_FONT_SIZE_CHANGED - -**Title:** CONSOLE FONT SIZE CHANGED - -**Content:** -Needs summary. -`CONSOLE_FONT_SIZE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_LOG.md b/wiki-information/events/CONSOLE_LOG.md deleted file mode 100644 index 0ca4f537..00000000 --- a/wiki-information/events/CONSOLE_LOG.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CONSOLE_LOG - -**Title:** CONSOLE LOG - -**Content:** -Needs summary. -`CONSOLE_LOG: message` - -**Payload:** -- `message` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CONSOLE_MESSAGE.md b/wiki-information/events/CONSOLE_MESSAGE.md deleted file mode 100644 index 7fa6bad5..00000000 --- a/wiki-information/events/CONSOLE_MESSAGE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CONSOLE_MESSAGE - -**Title:** CONSOLE MESSAGE - -**Content:** -Needs summary. -`CONSOLE_MESSAGE: message, colorType` - -**Payload:** -- `message` - - *string* -- `colorType` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CORPSE_IN_INSTANCE.md b/wiki-information/events/CORPSE_IN_INSTANCE.md deleted file mode 100644 index 86117d2d..00000000 --- a/wiki-information/events/CORPSE_IN_INSTANCE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CORPSE_IN_INSTANCE - -**Title:** CORPSE IN INSTANCE - -**Content:** -Needs summary. -`CORPSE_IN_INSTANCE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CORPSE_IN_RANGE.md b/wiki-information/events/CORPSE_IN_RANGE.md deleted file mode 100644 index aab693d6..00000000 --- a/wiki-information/events/CORPSE_IN_RANGE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CORPSE_IN_RANGE - -**Title:** CORPSE IN RANGE - -**Content:** -Fired when the player is in range of his body. -`CORPSE_IN_RANGE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CORPSE_OUT_OF_RANGE.md b/wiki-information/events/CORPSE_OUT_OF_RANGE.md deleted file mode 100644 index e81c227e..00000000 --- a/wiki-information/events/CORPSE_OUT_OF_RANGE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CORPSE_OUT_OF_RANGE - -**Title:** CORPSE OUT OF RANGE - -**Content:** -Fired when the player is out of range of his body. -`CORPSE_OUT_OF_RANGE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CRAFT_CLOSE.md b/wiki-information/events/CRAFT_CLOSE.md deleted file mode 100644 index d83e3a40..00000000 --- a/wiki-information/events/CRAFT_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CRAFT_CLOSE - -**Title:** CRAFT CLOSE - -**Content:** -Fired when a crafting skill window closes. -`CRAFT_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CRAFT_SHOW.md b/wiki-information/events/CRAFT_SHOW.md deleted file mode 100644 index 26b7c952..00000000 --- a/wiki-information/events/CRAFT_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CRAFT_SHOW - -**Title:** CRAFT SHOW - -**Content:** -Fired when a crafting skill window opens. -`CRAFT_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CRAFT_UPDATE.md b/wiki-information/events/CRAFT_UPDATE.md deleted file mode 100644 index 57a9edff..00000000 --- a/wiki-information/events/CRAFT_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CRAFT_UPDATE - -**Title:** CRAFT UPDATE - -**Content:** -Fired when a crafting event is updating. -`CRAFT_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CRITERIA_COMPLETE.md b/wiki-information/events/CRITERIA_COMPLETE.md deleted file mode 100644 index 812e3a49..00000000 --- a/wiki-information/events/CRITERIA_COMPLETE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CRITERIA_COMPLETE - -**Title:** CRITERIA COMPLETE - -**Content:** -Needs summary. -`CRITERIA_COMPLETE: criteriaID` - -**Payload:** -- `criteriaID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CRITERIA_EARNED.md b/wiki-information/events/CRITERIA_EARNED.md deleted file mode 100644 index c55de994..00000000 --- a/wiki-information/events/CRITERIA_EARNED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CRITERIA_EARNED - -**Title:** CRITERIA EARNED - -**Content:** -Needs summary. -`CRITERIA_EARNED: achievementID, description` - -**Payload:** -- `achievementID` - - *number* -- `description` - - *string* \ No newline at end of file diff --git a/wiki-information/events/CRITERIA_UPDATE.md b/wiki-information/events/CRITERIA_UPDATE.md deleted file mode 100644 index c432f406..00000000 --- a/wiki-information/events/CRITERIA_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CRITERIA_UPDATE - -**Title:** CRITERIA UPDATE - -**Content:** -Fired when the criteria for an achievement has changed. -`CRITERIA_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -Fires several times at once, presumably for different levels of achievements and yet-unknown feats of strength, but this has yet to be confirmed and there may be another use for this event. \ No newline at end of file diff --git a/wiki-information/events/CURRENCY_DISPLAY_UPDATE.md b/wiki-information/events/CURRENCY_DISPLAY_UPDATE.md deleted file mode 100644 index 2a342adc..00000000 --- a/wiki-information/events/CURRENCY_DISPLAY_UPDATE.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: CURRENCY_DISPLAY_UPDATE - -**Title:** CURRENCY DISPLAY UPDATE - -**Content:** -Needs summary. -`CURRENCY_DISPLAY_UPDATE: currencyType, quantity, quantityChange, quantityGainSource, quantityLostSource` - -**Payload:** -- `currencyType` - - *number?* -- `quantity` - - *number?* -- `quantityChange` - - *number?* -- `quantityGainSource` - - *number?* -- `quantityLostSource` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md b/wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md deleted file mode 100644 index 7f7efa92..00000000 --- a/wiki-information/events/CURRENT_SPELL_CAST_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: CURRENT_SPELL_CAST_CHANGED - -**Title:** CURRENT SPELL CAST CHANGED - -**Content:** -Fired when the spell being cast is changed. -`CURRENT_SPELL_CAST_CHANGED: cancelledCast` - -**Payload:** -- `cancelledCast` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/CURSOR_CHANGED.md b/wiki-information/events/CURSOR_CHANGED.md deleted file mode 100644 index 2ba8f1ee..00000000 --- a/wiki-information/events/CURSOR_CHANGED.md +++ /dev/null @@ -1,40 +0,0 @@ -## Event: CURSOR_CHANGED - -**Title:** CURSOR CHANGED - -**Content:** -Fires when the cursor changes. Includes information on the previous and new cursor type (e.g. item, money, spells). -`CURSOR_CHANGED: isDefault, newCursorType, oldCursorType, oldCursorVirtualID` - -**Payload:** -- `isDefault` - - *boolean* -- `newCursorType` - - *Enum.UICursorType* -- `oldCursorType` - - *Enum.UICursorType* - - *Value* - *Field* - *Description* - - 0 - Default - - 1 - Item - - 2 - Money - - 3 - Spell - - 4 - PetAction - - 5 - Merchant - - 6 - ActionBar - - 7 - Macro - - 9 - AmmoObsolete - - 10 - Pet - - 11 - GuildBank - - 12 - GuildBankMoney - - 13 - EquipmentSet - - 14 - Currency - - 15 - Flyout - - 16 - VoidItem - - 17 - BattlePet - - 18 - Mount - - 19 - Toy - - 20 - ConduitCollectionItem - - 21 - PerksProgramVendorItem - - Added in 10.0.5 -- `oldCursorVirtualID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/CURSOR_UPDATE.md b/wiki-information/events/CURSOR_UPDATE.md deleted file mode 100644 index 8eb7c1b4..00000000 --- a/wiki-information/events/CURSOR_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: CURSOR_UPDATE - -**Title:** CURSOR UPDATE - -**Content:** -Fired when the player right-clicks terrain, and on mouseover before UPDATE_MOUSEOVER_UNIT and on mouseout after UPDATE_MOUSEOVER_UNIT. This excludes doodads, player characters, and NPCs that lack interaction. -`CURSOR_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/CVAR_UPDATE.md b/wiki-information/events/CVAR_UPDATE.md deleted file mode 100644 index 3dd99ee1..00000000 --- a/wiki-information/events/CVAR_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: CVAR_UPDATE - -**Title:** CVAR UPDATE - -**Content:** -Fires when changing console variables with an optional argument to C_CVar.SetCVar(). -`CVAR_UPDATE: eventName, value` - -**Payload:** -- `eventName` - - *string* - The optional argument used with C_CVar.SetCVar(). -- `value` - - *string* - The new value of the console variable. \ No newline at end of file diff --git a/wiki-information/events/DELETE_ITEM_CONFIRM.md b/wiki-information/events/DELETE_ITEM_CONFIRM.md deleted file mode 100644 index f446c3f8..00000000 --- a/wiki-information/events/DELETE_ITEM_CONFIRM.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: DELETE_ITEM_CONFIRM - -**Title:** DELETE ITEM CONFIRM - -**Content:** -Fired when the player attempts to destroy an item. -`DELETE_ITEM_CONFIRM: itemName, qualityID, bonding, questWarn` - -**Payload:** -- `itemName` - - *string* -- `qualityID` - - *number* -- `bonding` - - *number* -- `questWarn` - - *number* \ No newline at end of file diff --git a/wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md b/wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md deleted file mode 100644 index bd6ba453..00000000 --- a/wiki-information/events/DISABLE_DECLINE_GUILD_INVITE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DISABLE_DECLINE_GUILD_INVITE - -**Title:** DISABLE DECLINE GUILD INVITE - -**Content:** -Needs summary. -`DISABLE_DECLINE_GUILD_INVITE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DISABLE_LOW_LEVEL_RAID.md b/wiki-information/events/DISABLE_LOW_LEVEL_RAID.md deleted file mode 100644 index 32e3fa64..00000000 --- a/wiki-information/events/DISABLE_LOW_LEVEL_RAID.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DISABLE_LOW_LEVEL_RAID - -**Title:** DISABLE LOW LEVEL RAID - -**Content:** -Fired when SetAllowLowLevelRaid is used to disable low-level raids on the character. -`DISABLE_LOW_LEVEL_RAID` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DISABLE_TAXI_BENCHMARK.md b/wiki-information/events/DISABLE_TAXI_BENCHMARK.md deleted file mode 100644 index 10fb6424..00000000 --- a/wiki-information/events/DISABLE_TAXI_BENCHMARK.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DISABLE_TAXI_BENCHMARK - -**Title:** DISABLE TAXI BENCHMARK - -**Content:** -Needs summary. -`DISABLE_TAXI_BENCHMARK` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DISABLE_XP_GAIN.md b/wiki-information/events/DISABLE_XP_GAIN.md deleted file mode 100644 index 96b467a7..00000000 --- a/wiki-information/events/DISABLE_XP_GAIN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DISABLE_XP_GAIN - -**Title:** DISABLE XP GAIN - -**Content:** -Needs summary. -`DISABLE_XP_GAIN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DISPLAY_SIZE_CHANGED.md b/wiki-information/events/DISPLAY_SIZE_CHANGED.md deleted file mode 100644 index 53acbcb3..00000000 --- a/wiki-information/events/DISPLAY_SIZE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DISPLAY_SIZE_CHANGED - -**Title:** DISPLAY SIZE CHANGED - -**Content:** -Needs summary. -`DISPLAY_SIZE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_FINISHED.md b/wiki-information/events/DUEL_FINISHED.md deleted file mode 100644 index 947f0fad..00000000 --- a/wiki-information/events/DUEL_FINISHED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DUEL_FINISHED - -**Title:** DUEL FINISHED - -**Content:** -Fired when a duel is finished. -`DUEL_FINISHED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_INBOUNDS.md b/wiki-information/events/DUEL_INBOUNDS.md deleted file mode 100644 index f3a71e91..00000000 --- a/wiki-information/events/DUEL_INBOUNDS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DUEL_INBOUNDS - -**Title:** DUEL INBOUNDS - -**Content:** -Fired when the player returns in bounds after being out of bounds during a duel. -`DUEL_INBOUNDS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_OUTOFBOUNDS.md b/wiki-information/events/DUEL_OUTOFBOUNDS.md deleted file mode 100644 index 1f9943ec..00000000 --- a/wiki-information/events/DUEL_OUTOFBOUNDS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: DUEL_OUTOFBOUNDS - -**Title:** DUEL OUTOFBOUNDS - -**Content:** -Fired when the player leaves the bounds of the duel -`DUEL_OUTOFBOUNDS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/DUEL_REQUESTED.md b/wiki-information/events/DUEL_REQUESTED.md deleted file mode 100644 index 8d533256..00000000 --- a/wiki-information/events/DUEL_REQUESTED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: DUEL_REQUESTED - -**Title:** DUEL REQUESTED - -**Content:** -Fired when the player is challenged to a duel. -`DUEL_REQUESTED: playerName` - -**Payload:** -- `playerName` - - *string* - opponent name \ No newline at end of file diff --git a/wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md b/wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md deleted file mode 100644 index 83554bab..00000000 --- a/wiki-information/events/DYNAMIC_GOSSIP_POI_UPDATED.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: DYNAMIC_GOSSIP_POI_UPDATED - -**Title:** DYNAMIC GOSSIP POI UPDATED - -**Content:** -Fired after asking guards in major cities for directions to a point of interest, causing the small red flag to be positioned on the world map and minimap (or to disappear when no longer needed). -`DYNAMIC_GOSSIP_POI_UPDATED` - -**Payload:** -- `None` - -**Content Details:** -Maps do not normally need to track this event if they have already acquired the GossipDataProvider or an equivalent -Custom replacements for GossipDataProvider could use this event to trigger RefreshAllData() - -**Related Information:** -- GossipDataProvider.lua where this event is used to update the world map, archived at townlong-yak. -- C_GossipInfo.GetGossipPoiForUiMapID - provides a pointer that may be passed to GetGossipPoiInfo() for a given uiMapID -- C_GossipInfo.GetGossipPoiInfo - provides information about where a given gossip pin (usually a red flag) should appear on the given uiMapID \ No newline at end of file diff --git a/wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md b/wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md deleted file mode 100644 index 9f59e857..00000000 --- a/wiki-information/events/ENABLE_DECLINE_GUILD_INVITE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ENABLE_DECLINE_GUILD_INVITE - -**Title:** ENABLE DECLINE GUILD INVITE - -**Content:** -Needs summary. -`ENABLE_DECLINE_GUILD_INVITE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ENABLE_LOW_LEVEL_RAID.md b/wiki-information/events/ENABLE_LOW_LEVEL_RAID.md deleted file mode 100644 index c8ece994..00000000 --- a/wiki-information/events/ENABLE_LOW_LEVEL_RAID.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ENABLE_LOW_LEVEL_RAID - -**Title:** ENABLE LOW LEVEL RAID - -**Content:** -Fired when SetAllowLowLevelRaid is used to enable low-level raids on the character. -`ENABLE_LOW_LEVEL_RAID` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ENABLE_TAXI_BENCHMARK.md b/wiki-information/events/ENABLE_TAXI_BENCHMARK.md deleted file mode 100644 index ff948905..00000000 --- a/wiki-information/events/ENABLE_TAXI_BENCHMARK.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ENABLE_TAXI_BENCHMARK - -**Title:** ENABLE TAXI BENCHMARK - -**Content:** -Needs summary. -`ENABLE_TAXI_BENCHMARK` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ENABLE_XP_GAIN.md b/wiki-information/events/ENABLE_XP_GAIN.md deleted file mode 100644 index c149eaf6..00000000 --- a/wiki-information/events/ENABLE_XP_GAIN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ENABLE_XP_GAIN - -**Title:** ENABLE XP GAIN - -**Content:** -Needs summary. -`ENABLE_XP_GAIN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ENCOUNTER_END.md b/wiki-information/events/ENCOUNTER_END.md deleted file mode 100644 index 2d35f3a1..00000000 --- a/wiki-information/events/ENCOUNTER_END.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: ENCOUNTER_END - -**Title:** ENCOUNTER END - -**Content:** -Fires at the end of an instanced encounter. -`ENCOUNTER_END: encounterID, encounterName, difficultyID, groupSize, success` - -**Payload:** -- `encounterID` - - *number* - ID for the specific encounter that ended. (Does not match the encounterIDs used in the Encounter Journal) -- `encounterName` - - *string* - Name of the encounter that ended -- `difficultyID` - - *number* - ID representing the difficulty of the encounter -- `groupSize` - - *number* - Group size for the encounter. For example, 5 for a Dungeon encounter, 20 for a Mythic raid. The number of raiders participating is reflected in "flex" raids. -- `success` - - *number* - 1 for a successful kill. 0 for a wipe \ No newline at end of file diff --git a/wiki-information/events/ENCOUNTER_START.md b/wiki-information/events/ENCOUNTER_START.md deleted file mode 100644 index 9e8abbff..00000000 --- a/wiki-information/events/ENCOUNTER_START.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: ENCOUNTER_START - -**Title:** ENCOUNTER START - -**Content:** -Fires at the start of an instanced encounter. -`ENCOUNTER_START: encounterID, encounterName, difficultyID, groupSize` - -**Payload:** -- `encounterID` - - *number* - ID for the specific encounter started. -- `encounterName` - - *string* - Name of the encounter started -- `difficultyID` - - *number* - ID representing the difficulty of the encounter -- `groupSize` - - *number* - Group size for the encounter. For example, 5 for a Dungeon encounter, 20 for a Mythic raid. The number of raiders participating is reflected in "flex" raids. \ No newline at end of file diff --git a/wiki-information/events/END_BOUND_TRADEABLE.md b/wiki-information/events/END_BOUND_TRADEABLE.md deleted file mode 100644 index d9ba53a7..00000000 --- a/wiki-information/events/END_BOUND_TRADEABLE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: END_BOUND_TRADEABLE - -**Title:** END BOUND TRADEABLE - -**Content:** -Needs summary. -`END_BOUND_TRADEABLE: reason` - -**Payload:** -- `reason` - - *string* \ No newline at end of file diff --git a/wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md b/wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md deleted file mode 100644 index fa1c8170..00000000 --- a/wiki-information/events/ENTERED_DIFFERENT_INSTANCE_FROM_PARTY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ENTERED_DIFFERENT_INSTANCE_FROM_PARTY - -**Title:** ENTERED DIFFERENT INSTANCE FROM PARTY - -**Content:** -Needs summary. -`ENTERED_DIFFERENT_INSTANCE_FROM_PARTY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ENTITLEMENT_DELIVERED.md b/wiki-information/events/ENTITLEMENT_DELIVERED.md deleted file mode 100644 index 695f0587..00000000 --- a/wiki-information/events/ENTITLEMENT_DELIVERED.md +++ /dev/null @@ -1,33 +0,0 @@ -## Event: ENTITLEMENT_DELIVERED - -**Title:** ENTITLEMENT DELIVERED - -**Content:** -Needs summary. -`ENTITLEMENT_DELIVERED: entitlementType, textureID, name, payloadID, showFancyToast` - -**Payload:** -- `entitlementType` - - *number* - Enum.WoWEntitlementType -- `textureID` - - *number* -- `name` - - *string* -- `payloadID` - - *number?* -- `showFancyToast` - - *boolean* - - Enum.WoWEntitlementType - | Value | Field | Description | - |-------|-------------|--------------| - | 0 | Item | | - | 1 | Mount | | - | 2 | Battlepet | | - | 3 | Toy | | - | 4 | Appearance | | - | 5 | AppearanceSet| | - | 6 | GameTime | | - | 7 | Title | | - | 8 | Illusion | | - | 9 | Invalid | | \ No newline at end of file diff --git a/wiki-information/events/EQUIPMENT_SETS_CHANGED.md b/wiki-information/events/EQUIPMENT_SETS_CHANGED.md deleted file mode 100644 index 5a961dda..00000000 --- a/wiki-information/events/EQUIPMENT_SETS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: EQUIPMENT_SETS_CHANGED - -**Title:** EQUIPMENT SETS CHANGED - -**Content:** -Fired when a new equipment set is created, an equipment set is deleted or an equipment set has changed. -`EQUIPMENT_SETS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/EQUIPMENT_SWAP_FINISHED.md b/wiki-information/events/EQUIPMENT_SWAP_FINISHED.md deleted file mode 100644 index c6859fae..00000000 --- a/wiki-information/events/EQUIPMENT_SWAP_FINISHED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: EQUIPMENT_SWAP_FINISHED - -**Title:** EQUIPMENT SWAP FINISHED - -**Content:** -Fired when an equipment set has finished equipping. -`EQUIPMENT_SWAP_FINISHED: result, setID` - -**Payload:** -- `result` - - *boolean* - True if the set change was successful -- `setID` - - *number?* - The ID of the set that was changed. \ No newline at end of file diff --git a/wiki-information/events/EQUIPMENT_SWAP_PENDING.md b/wiki-information/events/EQUIPMENT_SWAP_PENDING.md deleted file mode 100644 index cf36cfd1..00000000 --- a/wiki-information/events/EQUIPMENT_SWAP_PENDING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: EQUIPMENT_SWAP_PENDING - -**Title:** EQUIPMENT SWAP PENDING - -**Content:** -Needs summary. -`EQUIPMENT_SWAP_PENDING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/EQUIP_BIND_CONFIRM.md b/wiki-information/events/EQUIP_BIND_CONFIRM.md deleted file mode 100644 index e8bf090a..00000000 --- a/wiki-information/events/EQUIP_BIND_CONFIRM.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: EQUIP_BIND_CONFIRM - -**Title:** EQUIP BIND CONFIRM - -**Content:** -Fired when the player attempts to equip bind on equip loot. -`EQUIP_BIND_CONFIRM: slot` - -**Payload:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md b/wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md deleted file mode 100644 index e999fdbf..00000000 --- a/wiki-information/events/EQUIP_BIND_REFUNDABLE_CONFIRM.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: EQUIP_BIND_REFUNDABLE_CONFIRM - -**Title:** EQUIP BIND REFUNDABLE CONFIRM - -**Content:** -Needs summary. -`EQUIP_BIND_REFUNDABLE_CONFIRM: slot` - -**Payload:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md b/wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md deleted file mode 100644 index 9661b749..00000000 --- a/wiki-information/events/EQUIP_BIND_TRADEABLE_CONFIRM.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: EQUIP_BIND_TRADEABLE_CONFIRM - -**Title:** EQUIP BIND TRADEABLE CONFIRM - -**Content:** -Needs summary. -`EQUIP_BIND_TRADEABLE_CONFIRM: slot` - -**Payload:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/EXECUTE_CHAT_LINE.md b/wiki-information/events/EXECUTE_CHAT_LINE.md deleted file mode 100644 index d7eec219..00000000 --- a/wiki-information/events/EXECUTE_CHAT_LINE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: EXECUTE_CHAT_LINE - -**Title:** EXECUTE CHAT LINE - -**Content:** -Fired to execute macro commands. -`EXECUTE_CHAT_LINE: chatLine` - -**Payload:** -- `chatLine` - - *string* - The macro text body to execute. \ No newline at end of file diff --git a/wiki-information/events/FIRST_FRAME_RENDERED.md b/wiki-information/events/FIRST_FRAME_RENDERED.md deleted file mode 100644 index 092a18be..00000000 --- a/wiki-information/events/FIRST_FRAME_RENDERED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: FIRST_FRAME_RENDERED - -**Title:** FIRST FRAME RENDERED - -**Content:** -Needs summary. -`FIRST_FRAME_RENDERED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md b/wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md deleted file mode 100644 index f67c5e56..00000000 --- a/wiki-information/events/FORBIDDEN_NAME_PLATE_CREATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: FORBIDDEN_NAME_PLATE_CREATED - -**Title:** FORBIDDEN NAME PLATE CREATED - -**Content:** -Needs summary. -`FORBIDDEN_NAME_PLATE_CREATED: namePlateFrame` - -**Payload:** -- `namePlateFrame` - - *table* \ No newline at end of file diff --git a/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md b/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md deleted file mode 100644 index 464ca705..00000000 --- a/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_ADDED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: FORBIDDEN_NAME_PLATE_UNIT_ADDED - -**Title:** FORBIDDEN NAME PLATE UNIT ADDED - -**Content:** -Needs summary. -`FORBIDDEN_NAME_PLATE_UNIT_ADDED: unitToken` - -**Payload:** -- `unitToken` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md b/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md deleted file mode 100644 index 7898b059..00000000 --- a/wiki-information/events/FORBIDDEN_NAME_PLATE_UNIT_REMOVED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: FORBIDDEN_NAME_PLATE_UNIT_REMOVED - -**Title:** FORBIDDEN NAME PLATE UNIT REMOVED - -**Content:** -Needs summary. -`FORBIDDEN_NAME_PLATE_UNIT_REMOVED: unitToken` - -**Payload:** -- `unitToken` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/FRIENDLIST_UPDATE.md b/wiki-information/events/FRIENDLIST_UPDATE.md deleted file mode 100644 index 5e6cac97..00000000 --- a/wiki-information/events/FRIENDLIST_UPDATE.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: FRIENDLIST_UPDATE - -**Title:** FRIENDLIST UPDATE - -**Content:** -Needs summary. -`FRIENDLIST_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -Fired when... -- You log in -- Open the friends window (twice) -- Switch from the ignore list to the friend's list -- Switch from the guild, raid, or who tab back to the friends tab (twice) -- Add a friend -- Remove a friend -- Friend comes online -- Friend goes offline \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md b/wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md deleted file mode 100644 index 9d111e72..00000000 --- a/wiki-information/events/GAME_PAD_ACTIVE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GAME_PAD_ACTIVE_CHANGED - -**Title:** GAME PAD ACTIVE CHANGED - -**Content:** -Needs summary. -`GAME_PAD_ACTIVE_CHANGED: isActive` - -**Payload:** -- `isActive` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md b/wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md deleted file mode 100644 index ba62b206..00000000 --- a/wiki-information/events/GAME_PAD_CONFIGS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GAME_PAD_CONFIGS_CHANGED - -**Title:** GAME PAD CONFIGS CHANGED - -**Content:** -Fired when the stored configurations for gamepads are changed. -`GAME_PAD_CONFIGS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_CONNECTED.md b/wiki-information/events/GAME_PAD_CONNECTED.md deleted file mode 100644 index 5f864e88..00000000 --- a/wiki-information/events/GAME_PAD_CONNECTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GAME_PAD_CONNECTED - -**Title:** GAME PAD CONNECTED - -**Content:** -Fired when a gamepad is initially connected to the host system. -`GAME_PAD_CONNECTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_DISCONNECTED.md b/wiki-information/events/GAME_PAD_DISCONNECTED.md deleted file mode 100644 index 3814c6e6..00000000 --- a/wiki-information/events/GAME_PAD_DISCONNECTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GAME_PAD_DISCONNECTED - -**Title:** GAME PAD DISCONNECTED - -**Content:** -Fired when a gamepad is disconnected from the host system. -`GAME_PAD_DISCONNECTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GAME_PAD_POWER_CHANGED.md b/wiki-information/events/GAME_PAD_POWER_CHANGED.md deleted file mode 100644 index 59a3ba4a..00000000 --- a/wiki-information/events/GAME_PAD_POWER_CHANGED.md +++ /dev/null @@ -1,20 +0,0 @@ -## Event: GAME_PAD_POWER_CHANGED - -**Title:** GAME PAD POWER CHANGED - -**Content:** -Needs summary. -`GAME_PAD_POWER_CHANGED: powerLevel` - -**Payload:** -- `powerLevel` - - *GamePadPowerLevel* - - *Value* - - *Field* - - *Description* - - 0 - Critical - - 1 - Low - - 2 - Medium - - 3 - High - - 4 - Wired - - 5 - Unknown \ No newline at end of file diff --git a/wiki-information/events/GDF_SIM_COMPLETE.md b/wiki-information/events/GDF_SIM_COMPLETE.md deleted file mode 100644 index 36671e2e..00000000 --- a/wiki-information/events/GDF_SIM_COMPLETE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GDF_SIM_COMPLETE - -**Title:** GDF SIM COMPLETE - -**Content:** -Needs summary. -`GDF_SIM_COMPLETE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GENERIC_ERROR.md b/wiki-information/events/GENERIC_ERROR.md deleted file mode 100644 index 03c85b0d..00000000 --- a/wiki-information/events/GENERIC_ERROR.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GENERIC_ERROR - -**Title:** GENERIC ERROR - -**Content:** -Needs summary. -`GENERIC_ERROR: errorMessage` - -**Payload:** -- `errorMessage` - - *string* \ No newline at end of file diff --git a/wiki-information/events/GET_ITEM_INFO_RECEIVED.md b/wiki-information/events/GET_ITEM_INFO_RECEIVED.md deleted file mode 100644 index 4dc9aedf..00000000 --- a/wiki-information/events/GET_ITEM_INFO_RECEIVED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: GET_ITEM_INFO_RECEIVED - -**Title:** GET ITEM INFO RECEIVED - -**Content:** -Fired when GetItemInfo queries the server for an uncached item and the response has arrived. -`GET_ITEM_INFO_RECEIVED: itemID, success` - -**Payload:** -- `itemID` - - *number* - The Item ID of the received item info. -- `success` - - *boolean* - Returns true if the item was successfully queried from the server. - - Returns false if the item can't be queried from the server. - - Returns nil if the item doesn't exist. \ No newline at end of file diff --git a/wiki-information/events/GLOBAL_MOUSE_DOWN.md b/wiki-information/events/GLOBAL_MOUSE_DOWN.md deleted file mode 100644 index b095ac99..00000000 --- a/wiki-information/events/GLOBAL_MOUSE_DOWN.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GLOBAL_MOUSE_DOWN - -**Title:** GLOBAL MOUSE DOWN - -**Content:** -Fires whenever you press a mouse button. -`GLOBAL_MOUSE_DOWN: button` - -**Payload:** -- `button` - - *string* : LeftButton, RightButton, MiddleButton, Button4, Button5 \ No newline at end of file diff --git a/wiki-information/events/GLOBAL_MOUSE_UP.md b/wiki-information/events/GLOBAL_MOUSE_UP.md deleted file mode 100644 index 91066da0..00000000 --- a/wiki-information/events/GLOBAL_MOUSE_UP.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GLOBAL_MOUSE_UP - -**Title:** GLOBAL MOUSE UP - -**Content:** -Fires whenever a mouse button gets released. -`GLOBAL_MOUSE_UP: button` - -**Payload:** -- `button` - - *string* - LeftButton, RightButton, MiddleButton, Button4, Button5 \ No newline at end of file diff --git a/wiki-information/events/GLUE_CONSOLE_LOG.md b/wiki-information/events/GLUE_CONSOLE_LOG.md deleted file mode 100644 index cadb21ea..00000000 --- a/wiki-information/events/GLUE_CONSOLE_LOG.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GLUE_CONSOLE_LOG - -**Title:** GLUE CONSOLE LOG - -**Content:** -Needs summary. -`GLUE_CONSOLE_LOG: message` - -**Payload:** -- `message` - - *string* \ No newline at end of file diff --git a/wiki-information/events/GLUE_SCREENSHOT_FAILED.md b/wiki-information/events/GLUE_SCREENSHOT_FAILED.md deleted file mode 100644 index 52333b75..00000000 --- a/wiki-information/events/GLUE_SCREENSHOT_FAILED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GLUE_SCREENSHOT_FAILED - -**Title:** GLUE SCREENSHOT FAILED - -**Content:** -Needs summary. -`GLUE_SCREENSHOT_FAILED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GM_PLAYER_INFO.md b/wiki-information/events/GM_PLAYER_INFO.md deleted file mode 100644 index de26a41c..00000000 --- a/wiki-information/events/GM_PLAYER_INFO.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: GM_PLAYER_INFO - -**Title:** GM PLAYER INFO - -**Content:** -Needs summary. -`GM_PLAYER_INFO: name, info` - -**Payload:** -- `name` - - *string* -- `info` - - *string* \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_CLOSED.md b/wiki-information/events/GOSSIP_CLOSED.md deleted file mode 100644 index 58aebe02..00000000 --- a/wiki-information/events/GOSSIP_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GOSSIP_CLOSED - -**Title:** GOSSIP CLOSED - -**Content:** -Fired when you close the talk window for an npc. (Seems to be called twice) -`GOSSIP_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_CONFIRM.md b/wiki-information/events/GOSSIP_CONFIRM.md deleted file mode 100644 index 8cd6163d..00000000 --- a/wiki-information/events/GOSSIP_CONFIRM.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: GOSSIP_CONFIRM - -**Title:** GOSSIP CONFIRM - -**Content:** -Needs summary. -`GOSSIP_CONFIRM: gossipID, text, cost` - -**Payload:** -- `gossipID` - - *number* -- `text` - - *string* -- `cost` - - *number* \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_CONFIRM_CANCEL.md b/wiki-information/events/GOSSIP_CONFIRM_CANCEL.md deleted file mode 100644 index 0c3cee91..00000000 --- a/wiki-information/events/GOSSIP_CONFIRM_CANCEL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GOSSIP_CONFIRM_CANCEL - -**Title:** GOSSIP CONFIRM CANCEL - -**Content:** -Needs summary. -`GOSSIP_CONFIRM_CANCEL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_ENTER_CODE.md b/wiki-information/events/GOSSIP_ENTER_CODE.md deleted file mode 100644 index be0b1b1d..00000000 --- a/wiki-information/events/GOSSIP_ENTER_CODE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GOSSIP_ENTER_CODE - -**Title:** GOSSIP ENTER CODE - -**Content:** -Needs summary. -`GOSSIP_ENTER_CODE: gossipID` - -**Payload:** -- `gossipID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/GOSSIP_SHOW.md b/wiki-information/events/GOSSIP_SHOW.md deleted file mode 100644 index 5e7eca52..00000000 --- a/wiki-information/events/GOSSIP_SHOW.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: GOSSIP_SHOW - -**Title:** GOSSIP SHOW - -**Content:** -Fires when you talk to an npc. -`GOSSIP_SHOW: uiTextureKit` - -**Payload:** -- `uiTextureKit` - - *string?* - -**Content Details:** -This event typicaly fires when you are given several choices, including choosing to sell item, select available and active quests, just talk about something, or bind to a location. Even when the the only available choices are quests, this event is often used instead of QUEST_GREETING. \ No newline at end of file diff --git a/wiki-information/events/GROUP_FORMED.md b/wiki-information/events/GROUP_FORMED.md deleted file mode 100644 index ab98ab67..00000000 --- a/wiki-information/events/GROUP_FORMED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: GROUP_FORMED - -**Title:** GROUP FORMED - -**Content:** -Needs summary. -`GROUP_FORMED: category, partyGUID` - -**Payload:** -- `category` - - *number* -- `partyGUID` - - *string* \ No newline at end of file diff --git a/wiki-information/events/GROUP_INVITE_CONFIRMATION.md b/wiki-information/events/GROUP_INVITE_CONFIRMATION.md deleted file mode 100644 index 7cd1586a..00000000 --- a/wiki-information/events/GROUP_INVITE_CONFIRMATION.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GROUP_INVITE_CONFIRMATION - -**Title:** GROUP INVITE CONFIRMATION - -**Content:** -Needs summary. -`GROUP_INVITE_CONFIRMATION` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GROUP_JOINED.md b/wiki-information/events/GROUP_JOINED.md deleted file mode 100644 index a947a978..00000000 --- a/wiki-information/events/GROUP_JOINED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: GROUP_JOINED - -**Title:** GROUP JOINED - -**Content:** -Fired when the player enters a group. -`GROUP_JOINED: category, partyGUID` - -**Payload:** -- `category` - - *number* -- `partyGUID` - - *string* \ No newline at end of file diff --git a/wiki-information/events/GROUP_LEFT.md b/wiki-information/events/GROUP_LEFT.md deleted file mode 100644 index 6a2279df..00000000 --- a/wiki-information/events/GROUP_LEFT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: GROUP_LEFT - -**Title:** GROUP LEFT - -**Content:** -Needs summary. -`GROUP_LEFT: category, partyGUID` - -**Payload:** -- `category` - - *number* -- `partyGUID` - - *string* \ No newline at end of file diff --git a/wiki-information/events/GROUP_ROSTER_UPDATE.md b/wiki-information/events/GROUP_ROSTER_UPDATE.md deleted file mode 100644 index 228bffad..00000000 --- a/wiki-information/events/GROUP_ROSTER_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GROUP_ROSTER_UPDATE - -**Title:** GROUP ROSTER UPDATE - -**Content:** -Fired whenever a group or raid is formed or disbanded, players are leaving or joining the group or raid. -`GROUP_ROSTER_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md b/wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md deleted file mode 100644 index 8d834f81..00000000 --- a/wiki-information/events/GUILDBANKBAGSLOTS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANKBAGSLOTS_CHANGED - -**Title:** GUILDBANKBAGSLOTS CHANGED - -**Content:** -Fired when the guild-bank contents change. -`GUILDBANKBAGSLOTS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKFRAME_CLOSED.md b/wiki-information/events/GUILDBANKFRAME_CLOSED.md deleted file mode 100644 index 2dc38b04..00000000 --- a/wiki-information/events/GUILDBANKFRAME_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANKFRAME_CLOSED - -**Title:** GUILDBANKFRAME CLOSED - -**Content:** -Fired when the guild-bank frame is closed. -`GUILDBANKFRAME_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKFRAME_OPENED.md b/wiki-information/events/GUILDBANKFRAME_OPENED.md deleted file mode 100644 index 9628110d..00000000 --- a/wiki-information/events/GUILDBANKFRAME_OPENED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANKFRAME_OPENED - -**Title:** GUILDBANKFRAME OPENED - -**Content:** -Fired when the guild-bank frame is opened. -`GUILDBANKFRAME_OPENED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANKLOG_UPDATE.md b/wiki-information/events/GUILDBANKLOG_UPDATE.md deleted file mode 100644 index 86919409..00000000 --- a/wiki-information/events/GUILDBANKLOG_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANKLOG_UPDATE - -**Title:** GUILDBANKLOG UPDATE - -**Content:** -Fired when the guild-bank log is updated. -`GUILDBANKLOG_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md b/wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md deleted file mode 100644 index 8d4d4577..00000000 --- a/wiki-information/events/GUILDBANK_ITEM_LOCK_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANK_ITEM_LOCK_CHANGED - -**Title:** GUILDBANK ITEM LOCK CHANGED - -**Content:** -Needs summary. -`GUILDBANK_ITEM_LOCK_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_TEXT_CHANGED.md b/wiki-information/events/GUILDBANK_TEXT_CHANGED.md deleted file mode 100644 index 7534af02..00000000 --- a/wiki-information/events/GUILDBANK_TEXT_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GUILDBANK_TEXT_CHANGED - -**Title:** GUILDBANK TEXT CHANGED - -**Content:** -Needs summary. -`GUILDBANK_TEXT_CHANGED: guildBankTab` - -**Payload:** -- `guildBankTab` - - *number* \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_MONEY.md b/wiki-information/events/GUILDBANK_UPDATE_MONEY.md deleted file mode 100644 index 5c235133..00000000 --- a/wiki-information/events/GUILDBANK_UPDATE_MONEY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANK_UPDATE_MONEY - -**Title:** GUILDBANK UPDATE MONEY - -**Content:** -Needs summary. -`GUILDBANK_UPDATE_MONEY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_TABS.md b/wiki-information/events/GUILDBANK_UPDATE_TABS.md deleted file mode 100644 index 098ee965..00000000 --- a/wiki-information/events/GUILDBANK_UPDATE_TABS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANK_UPDATE_TABS - -**Title:** GUILDBANK UPDATE TABS - -**Content:** -Needs summary. -`GUILDBANK_UPDATE_TABS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_TEXT.md b/wiki-information/events/GUILDBANK_UPDATE_TEXT.md deleted file mode 100644 index 371d87c3..00000000 --- a/wiki-information/events/GUILDBANK_UPDATE_TEXT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GUILDBANK_UPDATE_TEXT - -**Title:** GUILDBANK UPDATE TEXT - -**Content:** -Needs summary. -`GUILDBANK_UPDATE_TEXT: guildBankTab` - -**Payload:** -- `guildBankTab` - - *number* \ No newline at end of file diff --git a/wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md b/wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md deleted file mode 100644 index d45b4fd9..00000000 --- a/wiki-information/events/GUILDBANK_UPDATE_WITHDRAWMONEY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDBANK_UPDATE_WITHDRAWMONEY - -**Title:** GUILDBANK UPDATE WITHDRAWMONEY - -**Content:** -Needs summary. -`GUILDBANK_UPDATE_WITHDRAWMONEY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILDTABARD_UPDATE.md b/wiki-information/events/GUILDTABARD_UPDATE.md deleted file mode 100644 index 593a4195..00000000 --- a/wiki-information/events/GUILDTABARD_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILDTABARD_UPDATE - -**Title:** GUILDTABARD UPDATE - -**Content:** -Needs summary. -`GUILDTABARD_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_EVENT_LOG_UPDATE.md b/wiki-information/events/GUILD_EVENT_LOG_UPDATE.md deleted file mode 100644 index 69d85100..00000000 --- a/wiki-information/events/GUILD_EVENT_LOG_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILD_EVENT_LOG_UPDATE - -**Title:** GUILD EVENT LOG UPDATE - -**Content:** -Needs summary. -`GUILD_EVENT_LOG_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_INVITE_CANCEL.md b/wiki-information/events/GUILD_INVITE_CANCEL.md deleted file mode 100644 index 1175ecf7..00000000 --- a/wiki-information/events/GUILD_INVITE_CANCEL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILD_INVITE_CANCEL - -**Title:** GUILD INVITE CANCEL - -**Content:** -Fired when the guild invitation is declined. -`GUILD_INVITE_CANCEL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_INVITE_REQUEST.md b/wiki-information/events/GUILD_INVITE_REQUEST.md deleted file mode 100644 index 5aacd83b..00000000 --- a/wiki-information/events/GUILD_INVITE_REQUEST.md +++ /dev/null @@ -1,35 +0,0 @@ -## Event: GUILD_INVITE_REQUEST - -**Title:** GUILD INVITE REQUEST - -**Content:** -Fires when you are invited to join a guild. -`GUILD_INVITE_REQUEST: inviter, guildName, guildAchievementPoints, oldGuildName, isNewGuild, tabardInfo` - -**Payload:** -- `inviter` - - *string* -- `guildName` - - *string* -- `guildAchievementPoints` - - *number* -- `oldGuildName` - - *string* -- `isNewGuild` - - *boolean?* -- `tabardInfo` - - *GuildTabardInfo* - - Field - - Type - - Description - - `backgroundColor` - - *ColorMixin* 📗 - - `borderColor` - - *ColorMixin* 📗 - - `emblemColor` - - *ColorMixin* 📗 - - `emblemFileID` - - *number* - - GuildEmblem.db2 - - `emblemStyle` - - *number* \ No newline at end of file diff --git a/wiki-information/events/GUILD_MOTD.md b/wiki-information/events/GUILD_MOTD.md deleted file mode 100644 index 32b76c2d..00000000 --- a/wiki-information/events/GUILD_MOTD.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GUILD_MOTD - -**Title:** GUILD MOTD - -**Content:** -Fired when the guild messages of the day is shown. -`GUILD_MOTD: motdText` - -**Payload:** -- `motdText` - - *string* \ No newline at end of file diff --git a/wiki-information/events/GUILD_PARTY_STATE_UPDATED.md b/wiki-information/events/GUILD_PARTY_STATE_UPDATED.md deleted file mode 100644 index 2f57c74a..00000000 --- a/wiki-information/events/GUILD_PARTY_STATE_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GUILD_PARTY_STATE_UPDATED - -**Title:** GUILD PARTY STATE UPDATED - -**Content:** -Needs summary. -`GUILD_PARTY_STATE_UPDATED: inGuildParty` - -**Payload:** -- `inGuildParty` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/GUILD_RANKS_UPDATE.md b/wiki-information/events/GUILD_RANKS_UPDATE.md deleted file mode 100644 index ca613d90..00000000 --- a/wiki-information/events/GUILD_RANKS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILD_RANKS_UPDATE - -**Title:** GUILD RANKS UPDATE - -**Content:** -Fired when any changes are made to ranks or rank permission flags. -`GUILD_RANKS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_REGISTRAR_CLOSED.md b/wiki-information/events/GUILD_REGISTRAR_CLOSED.md deleted file mode 100644 index 24cc6bb6..00000000 --- a/wiki-information/events/GUILD_REGISTRAR_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILD_REGISTRAR_CLOSED - -**Title:** GUILD REGISTRAR CLOSED - -**Content:** -Needs summary. -`GUILD_REGISTRAR_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_REGISTRAR_SHOW.md b/wiki-information/events/GUILD_REGISTRAR_SHOW.md deleted file mode 100644 index fc66a9ff..00000000 --- a/wiki-information/events/GUILD_REGISTRAR_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GUILD_REGISTRAR_SHOW - -**Title:** GUILD REGISTRAR SHOW - -**Content:** -Needs summary. -`GUILD_REGISTRAR_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/GUILD_RENAME_REQUIRED.md b/wiki-information/events/GUILD_RENAME_REQUIRED.md deleted file mode 100644 index cb983150..00000000 --- a/wiki-information/events/GUILD_RENAME_REQUIRED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: GUILD_RENAME_REQUIRED - -**Title:** GUILD RENAME REQUIRED - -**Content:** -Needs summary. -`GUILD_RENAME_REQUIRED: flagSet` - -**Payload:** -- `flagSet` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/GUILD_ROSTER_UPDATE.md b/wiki-information/events/GUILD_ROSTER_UPDATE.md deleted file mode 100644 index 1281faf0..00000000 --- a/wiki-information/events/GUILD_ROSTER_UPDATE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: GUILD_ROSTER_UPDATE - -**Title:** GUILD ROSTER UPDATE - -**Content:** -Fired when the client's guild info cache has been updated after a call to GuildRoster or after any data change in any of the guild's data, excluding the Guild Information window. -`GUILD_ROSTER_UPDATE: canRequestRosterUpdate` - -**Payload:** -- `canRequestRosterUpdate` - - *boolean* - -**Content Details:** -Related API -C_GuildInfo.GuildRoster • GetGuildRosterInfo \ No newline at end of file diff --git a/wiki-information/events/GX_RESTARTED.md b/wiki-information/events/GX_RESTARTED.md deleted file mode 100644 index 043ad616..00000000 --- a/wiki-information/events/GX_RESTARTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: GX_RESTARTED - -**Title:** GX RESTARTED - -**Content:** -Needs summary. -`GX_RESTARTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/HEARTHSTONE_BOUND.md b/wiki-information/events/HEARTHSTONE_BOUND.md deleted file mode 100644 index 1540ba44..00000000 --- a/wiki-information/events/HEARTHSTONE_BOUND.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: HEARTHSTONE_BOUND - -**Title:** HEARTHSTONE BOUND - -**Content:** -Needs summary. -`HEARTHSTONE_BOUND` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/HEIRLOOMS_UPDATED.md b/wiki-information/events/HEIRLOOMS_UPDATED.md deleted file mode 100644 index af2658f4..00000000 --- a/wiki-information/events/HEIRLOOMS_UPDATED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: HEIRLOOMS_UPDATED - -**Title:** HEIRLOOMS UPDATED - -**Content:** -Needs summary. -`HEIRLOOMS_UPDATED: itemID, updateReason, hideUntilLearned` - -**Payload:** -- `itemID` - - *number?* -- `updateReason` - - *string?* -- `hideUntilLearned` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md b/wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md deleted file mode 100644 index 9516d85f..00000000 --- a/wiki-information/events/HEIRLOOM_UPGRADE_TARGETING_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: HEIRLOOM_UPGRADE_TARGETING_CHANGED - -**Title:** HEIRLOOM UPGRADE TARGETING CHANGED - -**Content:** -Fires when heirloom buttons in the Heirloom Journal are clicked. -`HEIRLOOM_UPGRADE_TARGETING_CHANGED: pendingHeirloomUpgradeSpellcast` - -**Payload:** -- `pendingHeirloomUpgradeSpellcast` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/HIDE_SUBTITLE.md b/wiki-information/events/HIDE_SUBTITLE.md deleted file mode 100644 index 1aca0623..00000000 --- a/wiki-information/events/HIDE_SUBTITLE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: HIDE_SUBTITLE - -**Title:** HIDE SUBTITLE - -**Content:** -Needs summary. -`HIDE_SUBTITLE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/IGNORELIST_UPDATE.md b/wiki-information/events/IGNORELIST_UPDATE.md deleted file mode 100644 index 838491dd..00000000 --- a/wiki-information/events/IGNORELIST_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: IGNORELIST_UPDATE - -**Title:** IGNORELIST UPDATE - -**Content:** -Fires twice when a player is added or removed from the ignore list. -`IGNORELIST_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INCOMING_RESURRECT_CHANGED.md b/wiki-information/events/INCOMING_RESURRECT_CHANGED.md deleted file mode 100644 index bcc100cf..00000000 --- a/wiki-information/events/INCOMING_RESURRECT_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: INCOMING_RESURRECT_CHANGED - -**Title:** INCOMING RESURRECT CHANGED - -**Content:** -Needs summary. -`INCOMING_RESURRECT_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/INITIAL_CLUBS_LOADED.md b/wiki-information/events/INITIAL_CLUBS_LOADED.md deleted file mode 100644 index d25c47a1..00000000 --- a/wiki-information/events/INITIAL_CLUBS_LOADED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INITIAL_CLUBS_LOADED - -**Title:** INITIAL CLUBS LOADED - -**Content:** -Needs summary. -`INITIAL_CLUBS_LOADED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INITIAL_HOTFIXES_APPLIED.md b/wiki-information/events/INITIAL_HOTFIXES_APPLIED.md deleted file mode 100644 index 3025426a..00000000 --- a/wiki-information/events/INITIAL_HOTFIXES_APPLIED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INITIAL_HOTFIXES_APPLIED - -**Title:** INITIAL HOTFIXES APPLIED - -**Content:** -Needs summary. -`INITIAL_HOTFIXES_APPLIED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSPECT_ACHIEVEMENT_READY.md b/wiki-information/events/INSPECT_ACHIEVEMENT_READY.md deleted file mode 100644 index b7f98b26..00000000 --- a/wiki-information/events/INSPECT_ACHIEVEMENT_READY.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: INSPECT_ACHIEVEMENT_READY - -**Title:** INSPECT ACHIEVEMENT READY - -**Content:** -Information about the comparison unit has been downloaded and may now be acessed using GetAchievementComparisonInfo(). -`INSPECT_ACHIEVEMENT_READY: guid` - -**Payload:** -- `guid` - - *string* - Reference to the player character for whom achievement info is now ready - -**Related Information:** -- SetAchievementComparisonUnit -- GetNumComparisonCompletedAchievements \ No newline at end of file diff --git a/wiki-information/events/INSPECT_HONOR_UPDATE.md b/wiki-information/events/INSPECT_HONOR_UPDATE.md deleted file mode 100644 index 311be4b7..00000000 --- a/wiki-information/events/INSPECT_HONOR_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSPECT_HONOR_UPDATE - -**Title:** INSPECT HONOR UPDATE - -**Content:** -Needs summary. -`INSPECT_HONOR_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSPECT_READY.md b/wiki-information/events/INSPECT_READY.md deleted file mode 100644 index 5356e6bf..00000000 --- a/wiki-information/events/INSPECT_READY.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: INSPECT_READY - -**Title:** INSPECT READY - -**Content:** -Indicates inspect info is now ready. -`INSPECT_READY: inspecteeGUID` - -**Payload:** -- `inspecteeGUID` - - *string* - GUID of the unit being inspected. - -**Content Details:** -Follows NotifyInspect() once details are asynchronously downloaded. \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_BOOT_START.md b/wiki-information/events/INSTANCE_BOOT_START.md deleted file mode 100644 index 9492a665..00000000 --- a/wiki-information/events/INSTANCE_BOOT_START.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSTANCE_BOOT_START - -**Title:** INSTANCE BOOT START - -**Content:** -Fired when the countdown to boot a player from an instance starts. -`INSTANCE_BOOT_START` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_BOOT_STOP.md b/wiki-information/events/INSTANCE_BOOT_STOP.md deleted file mode 100644 index 18f101f1..00000000 --- a/wiki-information/events/INSTANCE_BOOT_STOP.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSTANCE_BOOT_STOP - -**Title:** INSTANCE BOOT STOP - -**Content:** -Fired when the countdown to boot a player from an instance stops. -`INSTANCE_BOOT_STOP` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md b/wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md deleted file mode 100644 index 47c0d65e..00000000 --- a/wiki-information/events/INSTANCE_ENCOUNTER_ADD_TIMER.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: INSTANCE_ENCOUNTER_ADD_TIMER - -**Title:** INSTANCE ENCOUNTER ADD TIMER - -**Content:** -Needs summary. -`INSTANCE_ENCOUNTER_ADD_TIMER: timeRemaining` - -**Payload:** -- `timeRemaining` - - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md b/wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md deleted file mode 100644 index d4ac00b8..00000000 --- a/wiki-information/events/INSTANCE_ENCOUNTER_ENGAGE_UNIT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSTANCE_ENCOUNTER_ENGAGE_UNIT - -**Title:** INSTANCE ENCOUNTER ENGAGE UNIT - -**Content:** -Needs summary. -`INSTANCE_ENCOUNTER_ENGAGE_UNIT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md deleted file mode 100644 index 195b1fdb..00000000 --- a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE - -**Title:** INSTANCE ENCOUNTER OBJECTIVE COMPLETE - -**Content:** -Needs summary. -`INSTANCE_ENCOUNTER_OBJECTIVE_COMPLETE: objectiveID` - -**Payload:** -- `objectiveID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md deleted file mode 100644 index a251d81c..00000000 --- a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_START.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: INSTANCE_ENCOUNTER_OBJECTIVE_START - -**Title:** INSTANCE ENCOUNTER OBJECTIVE START - -**Content:** -Needs summary. -`INSTANCE_ENCOUNTER_OBJECTIVE_START: objectiveID, objectiveProgress` - -**Payload:** -- `objectiveID` - - *number* -- `objectiveProgress` - - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md b/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md deleted file mode 100644 index d8d4fc14..00000000 --- a/wiki-information/events/INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE - -**Title:** INSTANCE ENCOUNTER OBJECTIVE UPDATE - -**Content:** -Needs summary. -`INSTANCE_ENCOUNTER_OBJECTIVE_UPDATE: objectiveID, objectiveProgress` - -**Payload:** -- `objectiveID` - - *number* -- `objectiveProgress` - - *number* \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md b/wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md deleted file mode 100644 index b8be954d..00000000 --- a/wiki-information/events/INSTANCE_GROUP_SIZE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSTANCE_GROUP_SIZE_CHANGED - -**Title:** INSTANCE GROUP SIZE CHANGED - -**Content:** -Needs summary. -`INSTANCE_GROUP_SIZE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_LOCK_START.md b/wiki-information/events/INSTANCE_LOCK_START.md deleted file mode 100644 index fb68a456..00000000 --- a/wiki-information/events/INSTANCE_LOCK_START.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSTANCE_LOCK_START - -**Title:** INSTANCE LOCK START - -**Content:** -Needs summary. -`INSTANCE_LOCK_START` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_LOCK_STOP.md b/wiki-information/events/INSTANCE_LOCK_STOP.md deleted file mode 100644 index d2692fcb..00000000 --- a/wiki-information/events/INSTANCE_LOCK_STOP.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSTANCE_LOCK_STOP - -**Title:** INSTANCE LOCK STOP - -**Content:** -Fired when quitting the game. -`INSTANCE_LOCK_STOP` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INSTANCE_LOCK_WARNING.md b/wiki-information/events/INSTANCE_LOCK_WARNING.md deleted file mode 100644 index c2897bf0..00000000 --- a/wiki-information/events/INSTANCE_LOCK_WARNING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INSTANCE_LOCK_WARNING - -**Title:** INSTANCE LOCK WARNING - -**Content:** -Needs summary. -`INSTANCE_LOCK_WARNING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/INVENTORY_SEARCH_UPDATE.md b/wiki-information/events/INVENTORY_SEARCH_UPDATE.md deleted file mode 100644 index d637fafd..00000000 --- a/wiki-information/events/INVENTORY_SEARCH_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: INVENTORY_SEARCH_UPDATE - -**Title:** INVENTORY SEARCH UPDATE - -**Content:** -Fired when the Inventory Search Box is updated. -`INVENTORY_SEARCH_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ISLAND_COMPLETED.md b/wiki-information/events/ISLAND_COMPLETED.md deleted file mode 100644 index 7250bb1b..00000000 --- a/wiki-information/events/ISLAND_COMPLETED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ISLAND_COMPLETED - -**Title:** ISLAND COMPLETED - -**Content:** -Needs summary. -`ISLAND_COMPLETED: mapID, winner` - -**Payload:** -- `mapID` - - *number* -- `winner` - - *number* \ No newline at end of file diff --git a/wiki-information/events/ITEM_DATA_LOAD_RESULT.md b/wiki-information/events/ITEM_DATA_LOAD_RESULT.md deleted file mode 100644 index f72c5bb8..00000000 --- a/wiki-information/events/ITEM_DATA_LOAD_RESULT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ITEM_DATA_LOAD_RESULT - -**Title:** ITEM DATA LOAD RESULT - -**Content:** -Fires when data is available in response to C_Item.RequestLoadItemData. -`ITEM_DATA_LOAD_RESULT: itemID, success` - -**Payload:** -- `itemID` - - *number* -- `success` - - *boolean* - True if the item was successfully queried from the server. \ No newline at end of file diff --git a/wiki-information/events/ITEM_LOCKED.md b/wiki-information/events/ITEM_LOCKED.md deleted file mode 100644 index 32dc553b..00000000 --- a/wiki-information/events/ITEM_LOCKED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ITEM_LOCKED - -**Title:** ITEM LOCKED - -**Content:** -Fires when an item gets "locked" in the inventory or a container. -`ITEM_LOCKED: bagOrSlotIndex, slotIndex` - -**Payload:** -- `bagOrSlotIndex` - - *number* -- `slotIndex` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/ITEM_LOCK_CHANGED.md b/wiki-information/events/ITEM_LOCK_CHANGED.md deleted file mode 100644 index b47f08de..00000000 --- a/wiki-information/events/ITEM_LOCK_CHANGED.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: ITEM_LOCK_CHANGED - -**Title:** ITEM LOCK CHANGED - -**Content:** -Fires when the "locked" status on a container or inventory item changes, usually from but not limited to Pickup functions to move items. -`ITEM_LOCK_CHANGED: bagOrSlotIndex, slotIndex` - -**Payload:** -- `bagOrSlotIndex` - - *number* - If slotIndex is nil: Equipment slot of item; otherwise bag of updated item. -- `slotIndex` - - *number?* - Slot of updated item. - -**Content Details:** -Usually fires in pairs when an item is swapping with another. -Empty slots do not lock. -GetContainerItemInfo and IsInventoryItemLocked can be used to query lock status. -This does NOT fire on ammo pickups. \ No newline at end of file diff --git a/wiki-information/events/ITEM_PUSH.md b/wiki-information/events/ITEM_PUSH.md deleted file mode 100644 index dae9d4c5..00000000 --- a/wiki-information/events/ITEM_PUSH.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ITEM_PUSH - -**Title:** ITEM PUSH - -**Content:** -Fired when an item is pushed onto the "inventory-stack". For instance when you manufacture something with your trade skills or pick something up. -`ITEM_PUSH: bagSlot, iconFileID` - -**Payload:** -- `bagSlot` - - *number* - the bag that has received the new item -- `iconFileID` - - *number* - the FileID of the item's icon \ No newline at end of file diff --git a/wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md b/wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md deleted file mode 100644 index e44f3647..00000000 --- a/wiki-information/events/ITEM_RESTORATION_BUTTON_STATUS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ITEM_RESTORATION_BUTTON_STATUS - -**Title:** ITEM RESTORATION BUTTON STATUS - -**Content:** -Needs summary. -`ITEM_RESTORATION_BUTTON_STATUS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_BEGIN.md b/wiki-information/events/ITEM_TEXT_BEGIN.md deleted file mode 100644 index 20b7a63c..00000000 --- a/wiki-information/events/ITEM_TEXT_BEGIN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ITEM_TEXT_BEGIN - -**Title:** ITEM TEXT BEGIN - -**Content:** -Fired when an items text begins displaying -`ITEM_TEXT_BEGIN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_CLOSED.md b/wiki-information/events/ITEM_TEXT_CLOSED.md deleted file mode 100644 index d1baef60..00000000 --- a/wiki-information/events/ITEM_TEXT_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ITEM_TEXT_CLOSED - -**Title:** ITEM TEXT CLOSED - -**Content:** -Fired when the items text has completed its viewing and is done. -`ITEM_TEXT_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_READY.md b/wiki-information/events/ITEM_TEXT_READY.md deleted file mode 100644 index 23304ad9..00000000 --- a/wiki-information/events/ITEM_TEXT_READY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ITEM_TEXT_READY - -**Title:** ITEM TEXT READY - -**Content:** -Fired when the item's text can continue and is ready to be scrolled. -`ITEM_TEXT_READY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_TEXT_TRANSLATION.md b/wiki-information/events/ITEM_TEXT_TRANSLATION.md deleted file mode 100644 index 3327a08a..00000000 --- a/wiki-information/events/ITEM_TEXT_TRANSLATION.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ITEM_TEXT_TRANSLATION - -**Title:** ITEM TEXT TRANSLATION - -**Content:** -Fired when an item is in the process of being translated. -`ITEM_TEXT_TRANSLATION: delay` - -**Payload:** -- `delay` - - *number* \ No newline at end of file diff --git a/wiki-information/events/ITEM_UNLOCKED.md b/wiki-information/events/ITEM_UNLOCKED.md deleted file mode 100644 index 7818df84..00000000 --- a/wiki-information/events/ITEM_UNLOCKED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ITEM_UNLOCKED - -**Title:** ITEM UNLOCKED - -**Content:** -Needs summary. -`ITEM_UNLOCKED: bagOrSlotIndex, slotIndex` - -**Payload:** -- `bagOrSlotIndex` - - *number* -- `slotIndex` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_FAILED.md b/wiki-information/events/ITEM_UPGRADE_FAILED.md deleted file mode 100644 index bf801828..00000000 --- a/wiki-information/events/ITEM_UPGRADE_FAILED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ITEM_UPGRADE_FAILED - -**Title:** ITEM UPGRADE FAILED - -**Content:** -Needs summary. -`ITEM_UPGRADE_FAILED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md b/wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md deleted file mode 100644 index ff205f70..00000000 --- a/wiki-information/events/ITEM_UPGRADE_MASTER_CLOSED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: ITEM_UPGRADE_MASTER_CLOSED - -**Title:** ITEM UPGRADE MASTER CLOSED - -**Content:** -Fires when closing the ItemUpgradeFrame. -`ITEM_UPGRADE_MASTER_CLOSED` - -**Payload:** -- `None` - -**Content Details:** -ITEM_UPGRADE_MASTER_SET_ITEM may also fire simultaneously, presumably as the slot is forced to clear \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md b/wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md deleted file mode 100644 index 0c561234..00000000 --- a/wiki-information/events/ITEM_UPGRADE_MASTER_OPENED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: ITEM_UPGRADE_MASTER_OPENED - -**Title:** ITEM UPGRADE MASTER OPENED - -**Content:** -Fires when opening the ItemUpgradeFrame. -`ITEM_UPGRADE_MASTER_OPENED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md b/wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md deleted file mode 100644 index dcf85a55..00000000 --- a/wiki-information/events/ITEM_UPGRADE_MASTER_SET_ITEM.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: ITEM_UPGRADE_MASTER_SET_ITEM - -**Title:** ITEM UPGRADE MASTER SET ITEM - -**Content:** -Fires after adding or removing items in the ItemUpgradeFrame used for item upgrading. -`ITEM_UPGRADE_MASTER_SET_ITEM` - -**Payload:** -- `None` - -**Content Details:** -Fires up to twice when the ItemUpgradeFrame closes; presumably forcing the slot clear. -Causes the frame to update its appearance using information provided in GetItemUpgradeItemInfo() \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md b/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md deleted file mode 100644 index 90cc1a55..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE - -**Title:** KNOWLEDGE BASE ARTICLE LOAD FAILURE - -**Content:** -Needs summary. -`KNOWLEDGE_BASE_ARTICLE_LOAD_FAILURE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md b/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md deleted file mode 100644 index e2913cb8..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS - -**Title:** KNOWLEDGE BASE ARTICLE LOAD SUCCESS - -**Content:** -Needs summary. -`KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS` - -**Payload:** -- `None` - -**Related Information:** -KBArticle_IsLoaded() \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md b/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md deleted file mode 100644 index 119143a8..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_FAILURE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: KNOWLEDGE_BASE_QUERY_LOAD_FAILURE - -**Title:** KNOWLEDGE BASE QUERY LOAD FAILURE - -**Content:** -Needs summary. -`KNOWLEDGE_BASE_QUERY_LOAD_FAILURE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md b/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md deleted file mode 100644 index 8e694fac..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS - -**Title:** KNOWLEDGE BASE QUERY LOAD SUCCESS - -**Content:** -Needs summary. -`KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md b/wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md deleted file mode 100644 index 12d8b031..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_SERVER_MESSAGE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: KNOWLEDGE_BASE_SERVER_MESSAGE - -**Title:** KNOWLEDGE BASE SERVER MESSAGE - -**Content:** -Indicates the server message has changed. -`KNOWLEDGE_BASE_SERVER_MESSAGE` - -**Payload:** -- `None` - -**Related Information:** -KBSystem GetServerNotice() \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md b/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md deleted file mode 100644 index 3cb17c6b..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_FAILURE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: KNOWLEDGE_BASE_SETUP_LOAD_FAILURE - -**Title:** KNOWLEDGE BASE SETUP LOAD FAILURE - -**Content:** -Needs summary. -`KNOWLEDGE_BASE_SETUP_LOAD_FAILURE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md b/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md deleted file mode 100644 index adeb57bd..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS - -**Title:** KNOWLEDGE BASE SETUP LOAD SUCCESS - -**Content:** -Needs summary. -`KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md b/wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md deleted file mode 100644 index 1987218c..00000000 --- a/wiki-information/events/KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED - -**Title:** KNOWLEDGE BASE SYSTEM MOTD UPDATED - -**Content:** -Needs summary. -`KNOWLEDGE_BASE_SYSTEM_MOTD_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LANGUAGE_LIST_CHANGED.md b/wiki-information/events/LANGUAGE_LIST_CHANGED.md deleted file mode 100644 index 10d8a10d..00000000 --- a/wiki-information/events/LANGUAGE_LIST_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LANGUAGE_LIST_CHANGED - -**Title:** LANGUAGE LIST CHANGED - -**Content:** -Needs summary. -`LANGUAGE_LIST_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LEARNED_SPELL_IN_TAB.md b/wiki-information/events/LEARNED_SPELL_IN_TAB.md deleted file mode 100644 index de9ba290..00000000 --- a/wiki-information/events/LEARNED_SPELL_IN_TAB.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: LEARNED_SPELL_IN_TAB - -**Title:** LEARNED SPELL IN TAB - -**Content:** -Fired when a new spell/ability is added to the spellbook. e.g. When training a new or a higher level spell/ability. -`LEARNED_SPELL_IN_TAB: spellID, skillInfoIndex, isGuildPerkSpell` - -**Payload:** -- `spellID` - - *number* -- `skillInfoIndex` - - *number* - Number of the tab which the spell/ability is added to. -- `isGuildPerkSpell` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md b/wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md deleted file mode 100644 index 8623626a..00000000 --- a/wiki-information/events/LFG_BOOT_PROPOSAL_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_BOOT_PROPOSAL_UPDATE - -**Title:** LFG BOOT PROPOSAL UPDATE - -**Content:** -Needs summary. -`LFG_BOOT_PROPOSAL_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_COMPLETION_REWARD.md b/wiki-information/events/LFG_COMPLETION_REWARD.md deleted file mode 100644 index 3a283979..00000000 --- a/wiki-information/events/LFG_COMPLETION_REWARD.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_COMPLETION_REWARD - -**Title:** LFG COMPLETION REWARD - -**Content:** -Fired when a random dungeon (picked by the Dungeon Finder) is completed. This event causes a window similar to the achievement alert to appear, with the details of your Dungeon Finder rewards. -`LFG_COMPLETION_REWARD` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md b/wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md deleted file mode 100644 index 7e5401c8..00000000 --- a/wiki-information/events/LFG_GROUP_DELISTED_LEADERSHIP_CHANGE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LFG_GROUP_DELISTED_LEADERSHIP_CHANGE - -**Title:** LFG GROUP DELISTED LEADERSHIP CHANGE - -**Content:** -Needs summary. -`LFG_GROUP_DELISTED_LEADERSHIP_CHANGE: listingName, automaticDelistTimeRemaining` - -**Payload:** -- `listingName` - - *string* -- `automaticDelistTimeRemaining` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md b/wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md deleted file mode 100644 index 63c7eb92..00000000 --- a/wiki-information/events/LFG_INVALID_ERROR_MESSAGE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: LFG_INVALID_ERROR_MESSAGE - -**Title:** LFG INVALID ERROR MESSAGE - -**Content:** -Needs summary. -`LFG_INVALID_ERROR_MESSAGE: reason, subReason1, subReason2` - -**Payload:** -- `reason` - - *number* -- `subReason1` - - *number* -- `subReason2` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md b/wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md deleted file mode 100644 index 666643f3..00000000 --- a/wiki-information/events/LFG_LIST_ACTIVE_ENTRY_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_LIST_ACTIVE_ENTRY_UPDATE - -**Title:** LFG LIST ACTIVE ENTRY UPDATE - -**Content:** -Needs summary. -`LFG_LIST_ACTIVE_ENTRY_UPDATE: created` - -**Payload:** -- `created` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md b/wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md deleted file mode 100644 index e3a9dc75..00000000 --- a/wiki-information/events/LFG_LIST_AVAILABILITY_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_LIST_AVAILABILITY_UPDATE - -**Title:** LFG LIST AVAILABILITY UPDATE - -**Content:** -Fires when opening the LFG frame to the Premade Groups window. -`LFG_LIST_AVAILABILITY_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md b/wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md deleted file mode 100644 index b65f6264..00000000 --- a/wiki-information/events/LFG_LIST_ENTRY_CREATION_FAILED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_LIST_ENTRY_CREATION_FAILED - -**Title:** LFG LIST ENTRY CREATION FAILED - -**Content:** -Needs summary. -`LFG_LIST_ENTRY_CREATION_FAILED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md b/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md deleted file mode 100644 index 5f5c9bea..00000000 --- a/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TIMEOUT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_LIST_ENTRY_EXPIRED_TIMEOUT - -**Title:** LFG LIST ENTRY EXPIRED TIMEOUT - -**Content:** -Needs summary. -`LFG_LIST_ENTRY_EXPIRED_TIMEOUT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md b/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md deleted file mode 100644 index 03b3b71e..00000000 --- a/wiki-information/events/LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS - -**Title:** LFG LIST ENTRY EXPIRED TOO MANY PLAYERS - -**Content:** -Needs summary. -`LFG_LIST_ENTRY_EXPIRED_TOO_MANY_PLAYERS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_SEARCH_FAILED.md b/wiki-information/events/LFG_LIST_SEARCH_FAILED.md deleted file mode 100644 index 174f1e10..00000000 --- a/wiki-information/events/LFG_LIST_SEARCH_FAILED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_LIST_SEARCH_FAILED - -**Title:** LFG LIST SEARCH FAILED - -**Content:** -Needs summary. -`LFG_LIST_SEARCH_FAILED: reason` - -**Payload:** -- `reason` - - *string?* \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md b/wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md deleted file mode 100644 index 5bf19cfb..00000000 --- a/wiki-information/events/LFG_LIST_SEARCH_RESULTS_RECEIVED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_LIST_SEARCH_RESULTS_RECEIVED - -**Title:** LFG LIST SEARCH RESULTS RECEIVED - -**Content:** -Needs summary. -`LFG_LIST_SEARCH_RESULTS_RECEIVED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md b/wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md deleted file mode 100644 index 5d65a9c0..00000000 --- a/wiki-information/events/LFG_LIST_SEARCH_RESULT_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_LIST_SEARCH_RESULT_UPDATED - -**Title:** LFG LIST SEARCH RESULT UPDATED - -**Content:** -Needs summary. -`LFG_LIST_SEARCH_RESULT_UPDATED: searchResultID` - -**Payload:** -- `searchResultID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_LOCK_INFO_RECEIVED.md b/wiki-information/events/LFG_LOCK_INFO_RECEIVED.md deleted file mode 100644 index d8ef9d88..00000000 --- a/wiki-information/events/LFG_LOCK_INFO_RECEIVED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LFG_LOCK_INFO_RECEIVED - -**Title:** LFG LOCK INFO RECEIVED - -**Content:** -Fires when opening the LFG frame to the Raid Finder window. -`LFG_LOCK_INFO_RECEIVED` - -**Payload:** -- `None` - -**Related Information:** -GetLFDChoiceLockedState() \ No newline at end of file diff --git a/wiki-information/events/LFG_OFFER_CONTINUE.md b/wiki-information/events/LFG_OFFER_CONTINUE.md deleted file mode 100644 index 71bdc009..00000000 --- a/wiki-information/events/LFG_OFFER_CONTINUE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: LFG_OFFER_CONTINUE - -**Title:** LFG OFFER CONTINUE - -**Content:** -Needs summary. -`LFG_OFFER_CONTINUE: name, lfgDungeonsID, typeID` - -**Payload:** -- `name` - - *string* -- `lfgDungeonsID` - - *number* -- `typeID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_OPEN_FROM_GOSSIP.md b/wiki-information/events/LFG_OPEN_FROM_GOSSIP.md deleted file mode 100644 index 3c000c9a..00000000 --- a/wiki-information/events/LFG_OPEN_FROM_GOSSIP.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_OPEN_FROM_GOSSIP - -**Title:** LFG OPEN FROM GOSSIP - -**Content:** -Fired when a gossip option is used to initiate a Looking-for-Dungeon interaction. -`LFG_OPEN_FROM_GOSSIP: dungeonID` - -**Payload:** -- `dungeonID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_DONE.md b/wiki-information/events/LFG_PROPOSAL_DONE.md deleted file mode 100644 index 6272fd3d..00000000 --- a/wiki-information/events/LFG_PROPOSAL_DONE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_PROPOSAL_DONE - -**Title:** LFG PROPOSAL DONE - -**Content:** -Needs summary. -`LFG_PROPOSAL_DONE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_FAILED.md b/wiki-information/events/LFG_PROPOSAL_FAILED.md deleted file mode 100644 index 6569f177..00000000 --- a/wiki-information/events/LFG_PROPOSAL_FAILED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_PROPOSAL_FAILED - -**Title:** LFG PROPOSAL FAILED - -**Content:** -Fired when someone decline or don't make a choice within time in the dungeon queue invite -`LFG_PROPOSAL_FAILED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_SHOW.md b/wiki-information/events/LFG_PROPOSAL_SHOW.md deleted file mode 100644 index fcdbbb6c..00000000 --- a/wiki-information/events/LFG_PROPOSAL_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_PROPOSAL_SHOW - -**Title:** LFG PROPOSAL SHOW - -**Content:** -Fired when a dungeon group was found and the dialog to accept or decline it appears. -`LFG_PROPOSAL_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md b/wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md deleted file mode 100644 index 526f7b7c..00000000 --- a/wiki-information/events/LFG_PROPOSAL_SUCCEEDED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_PROPOSAL_SUCCEEDED - -**Title:** LFG PROPOSAL SUCCEEDED - -**Content:** -Fired when everyone in the dungeon queue accepted the invite. -`LFG_PROPOSAL_SUCCEEDED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_PROPOSAL_UPDATE.md b/wiki-information/events/LFG_PROPOSAL_UPDATE.md deleted file mode 100644 index 1ec9765a..00000000 --- a/wiki-information/events/LFG_PROPOSAL_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_PROPOSAL_UPDATE - -**Title:** LFG PROPOSAL UPDATE - -**Content:** -Fired when someone either accepts or decline the dungeon queue invite. -`LFG_PROPOSAL_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md b/wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md deleted file mode 100644 index d7e58c1d..00000000 --- a/wiki-information/events/LFG_QUEUE_STATUS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_QUEUE_STATUS_UPDATE - -**Title:** LFG QUEUE STATUS UPDATE - -**Content:** -Needs summary. -`LFG_QUEUE_STATUS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_DECLINED.md b/wiki-information/events/LFG_READY_CHECK_DECLINED.md deleted file mode 100644 index 44633606..00000000 --- a/wiki-information/events/LFG_READY_CHECK_DECLINED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_READY_CHECK_DECLINED - -**Title:** LFG READY CHECK DECLINED - -**Content:** -Needs summary. -`LFG_READY_CHECK_DECLINED: name` - -**Payload:** -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_HIDE.md b/wiki-information/events/LFG_READY_CHECK_HIDE.md deleted file mode 100644 index eeb4e88a..00000000 --- a/wiki-information/events/LFG_READY_CHECK_HIDE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_READY_CHECK_HIDE - -**Title:** LFG READY CHECK HIDE - -**Content:** -Needs summary. -`LFG_READY_CHECK_HIDE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md b/wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md deleted file mode 100644 index 0a63f8dd..00000000 --- a/wiki-information/events/LFG_READY_CHECK_PLAYER_IS_READY.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_READY_CHECK_PLAYER_IS_READY - -**Title:** LFG READY CHECK PLAYER IS READY - -**Content:** -Needs summary. -`LFG_READY_CHECK_PLAYER_IS_READY: name` - -**Payload:** -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_SHOW.md b/wiki-information/events/LFG_READY_CHECK_SHOW.md deleted file mode 100644 index d3dfcfad..00000000 --- a/wiki-information/events/LFG_READY_CHECK_SHOW.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_READY_CHECK_SHOW - -**Title:** LFG READY CHECK SHOW - -**Content:** -Needs summary. -`LFG_READY_CHECK_SHOW: isRequeue` - -**Payload:** -- `isRequeue` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_READY_CHECK_UPDATE.md b/wiki-information/events/LFG_READY_CHECK_UPDATE.md deleted file mode 100644 index 9cd03ab9..00000000 --- a/wiki-information/events/LFG_READY_CHECK_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_READY_CHECK_UPDATE - -**Title:** LFG READY CHECK UPDATE - -**Content:** -Needs summary. -`LFG_READY_CHECK_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_DECLINED.md b/wiki-information/events/LFG_ROLE_CHECK_DECLINED.md deleted file mode 100644 index 7d537826..00000000 --- a/wiki-information/events/LFG_ROLE_CHECK_DECLINED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_ROLE_CHECK_DECLINED - -**Title:** LFG ROLE CHECK DECLINED - -**Content:** -Needs summary. -`LFG_ROLE_CHECK_DECLINED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_HIDE.md b/wiki-information/events/LFG_ROLE_CHECK_HIDE.md deleted file mode 100644 index 59f2f0c0..00000000 --- a/wiki-information/events/LFG_ROLE_CHECK_HIDE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_ROLE_CHECK_HIDE - -**Title:** LFG ROLE CHECK HIDE - -**Content:** -Needs summary. -`LFG_ROLE_CHECK_HIDE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md b/wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md deleted file mode 100644 index b7692e01..00000000 --- a/wiki-information/events/LFG_ROLE_CHECK_ROLE_CHOSEN.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: LFG_ROLE_CHECK_ROLE_CHOSEN - -**Title:** LFG ROLE CHECK ROLE CHOSEN - -**Content:** -Needs summary. -`LFG_ROLE_CHECK_ROLE_CHOSEN: name, isTank, isHealer, isDamage` - -**Payload:** -- `name` - - *string* -- `isTank` - - *boolean* -- `isHealer` - - *boolean* -- `isDamage` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_SHOW.md b/wiki-information/events/LFG_ROLE_CHECK_SHOW.md deleted file mode 100644 index e617ed5d..00000000 --- a/wiki-information/events/LFG_ROLE_CHECK_SHOW.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LFG_ROLE_CHECK_SHOW - -**Title:** LFG ROLE CHECK SHOW - -**Content:** -Needs summary. -`LFG_ROLE_CHECK_SHOW: isRequeue` - -**Payload:** -- `isRequeue` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_CHECK_UPDATE.md b/wiki-information/events/LFG_ROLE_CHECK_UPDATE.md deleted file mode 100644 index ec01c422..00000000 --- a/wiki-information/events/LFG_ROLE_CHECK_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_ROLE_CHECK_UPDATE - -**Title:** LFG ROLE CHECK UPDATE - -**Content:** -Needs summary. -`LFG_ROLE_CHECK_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_ROLE_UPDATE.md b/wiki-information/events/LFG_ROLE_UPDATE.md deleted file mode 100644 index 6542433d..00000000 --- a/wiki-information/events/LFG_ROLE_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_ROLE_UPDATE - -**Title:** LFG ROLE UPDATE - -**Content:** -Needs summary. -`LFG_ROLE_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LFG_UPDATE.md b/wiki-information/events/LFG_UPDATE.md deleted file mode 100644 index fe36c938..00000000 --- a/wiki-information/events/LFG_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LFG_UPDATE - -**Title:** LFG UPDATE - -**Content:** -When fired prompts the LFG UI to update the list of available LFG categories and objectives (i.e. new quests, zones, instances available to LFG). -`LFG_UPDATE` - -**Payload:** -- `None` - -**Related Information:** -GetLFGTypes() \ No newline at end of file diff --git a/wiki-information/events/LFG_UPDATE_RANDOM_INFO.md b/wiki-information/events/LFG_UPDATE_RANDOM_INFO.md deleted file mode 100644 index 5ec5132d..00000000 --- a/wiki-information/events/LFG_UPDATE_RANDOM_INFO.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LFG_UPDATE_RANDOM_INFO - -**Title:** LFG UPDATE RANDOM INFO - -**Content:** -Fires when opening the LFG frame to the Dungeon Finder window. This fires when opening the LFG tool for the first time in a play session. -`LFG_UPDATE_RANDOM_INFO` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LOADING_SCREEN_DISABLED.md b/wiki-information/events/LOADING_SCREEN_DISABLED.md deleted file mode 100644 index b845ae3b..00000000 --- a/wiki-information/events/LOADING_SCREEN_DISABLED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LOADING_SCREEN_DISABLED - -**Title:** LOADING SCREEN DISABLED - -**Content:** -Fired when loading screen disappears; when player is finished loading the new zone. -`LOADING_SCREEN_DISABLED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LOADING_SCREEN_ENABLED.md b/wiki-information/events/LOADING_SCREEN_ENABLED.md deleted file mode 100644 index 23599942..00000000 --- a/wiki-information/events/LOADING_SCREEN_ENABLED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LOADING_SCREEN_ENABLED - -**Title:** LOADING SCREEN ENABLED - -**Content:** -Fired when loading screen appears; when player is loading new zone. -`LOADING_SCREEN_ENABLED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LOCALPLAYER_PET_RENAMED.md b/wiki-information/events/LOCALPLAYER_PET_RENAMED.md deleted file mode 100644 index 56ae68ac..00000000 --- a/wiki-information/events/LOCALPLAYER_PET_RENAMED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LOCALPLAYER_PET_RENAMED - -**Title:** LOCALPLAYER PET RENAMED - -**Content:** -Needs summary. -`LOCALPLAYER_PET_RENAMED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LOC_RESULT.md b/wiki-information/events/LOC_RESULT.md deleted file mode 100644 index 82172d60..00000000 --- a/wiki-information/events/LOC_RESULT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LOC_RESULT - -**Title:** LOC RESULT - -**Content:** -Needs summary. -`LOC_RESULT: result` - -**Payload:** -- `result` - - *string* \ No newline at end of file diff --git a/wiki-information/events/LOGOUT_CANCEL.md b/wiki-information/events/LOGOUT_CANCEL.md deleted file mode 100644 index 18938932..00000000 --- a/wiki-information/events/LOGOUT_CANCEL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LOGOUT_CANCEL - -**Title:** LOGOUT CANCEL - -**Content:** -Needs summary. -`LOGOUT_CANCEL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LOOT_BIND_CONFIRM.md b/wiki-information/events/LOOT_BIND_CONFIRM.md deleted file mode 100644 index d392d104..00000000 --- a/wiki-information/events/LOOT_BIND_CONFIRM.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LOOT_BIND_CONFIRM - -**Title:** LOOT BIND CONFIRM - -**Content:** -Fired when the player attempts to take 'bind-on-pickup' loot -`LOOT_BIND_CONFIRM: lootSlot` - -**Payload:** -- `lootSlot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_CLOSED.md b/wiki-information/events/LOOT_CLOSED.md deleted file mode 100644 index 1dc5aeb0..00000000 --- a/wiki-information/events/LOOT_CLOSED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: LOOT_CLOSED - -**Title:** LOOT CLOSED - -**Content:** -Fired when a player ceases looting a corpse. Note that this will fire before the last CHAT_MSG_LOOT event for that loot. -`LOOT_CLOSED` - -**Payload:** -- `None` - -**Related Information:** -- `LOOT_OPENED` -- `LOOT_READY` \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md b/wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md deleted file mode 100644 index dbff4556..00000000 --- a/wiki-information/events/LOOT_HISTORY_AUTO_SHOW.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LOOT_HISTORY_AUTO_SHOW - -**Title:** LOOT HISTORY AUTO SHOW - -**Content:** -Needs summary. -`LOOT_HISTORY_AUTO_SHOW: rollID, isMasterLoot` - -**Payload:** -- `rollID` - - *number* -- `isMasterLoot` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md b/wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md deleted file mode 100644 index a773d89e..00000000 --- a/wiki-information/events/LOOT_HISTORY_FULL_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LOOT_HISTORY_FULL_UPDATE - -**Title:** LOOT HISTORY FULL UPDATE - -**Content:** -Needs summary. -`LOOT_HISTORY_FULL_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md b/wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md deleted file mode 100644 index d6311791..00000000 --- a/wiki-information/events/LOOT_HISTORY_ROLL_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LOOT_HISTORY_ROLL_CHANGED - -**Title:** LOOT HISTORY ROLL CHANGED - -**Content:** -Needs summary. -`LOOT_HISTORY_ROLL_CHANGED: historyIndex, playerIndex` - -**Payload:** -- `historyIndex` - - *number* -- `playerIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md b/wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md deleted file mode 100644 index a3bb1387..00000000 --- a/wiki-information/events/LOOT_HISTORY_ROLL_COMPLETE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LOOT_HISTORY_ROLL_COMPLETE - -**Title:** LOOT HISTORY ROLL COMPLETE - -**Content:** -Needs summary. -`LOOT_HISTORY_ROLL_COMPLETE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LOOT_ITEM_AVAILABLE.md b/wiki-information/events/LOOT_ITEM_AVAILABLE.md deleted file mode 100644 index 44341993..00000000 --- a/wiki-information/events/LOOT_ITEM_AVAILABLE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LOOT_ITEM_AVAILABLE - -**Title:** LOOT ITEM AVAILABLE - -**Content:** -Needs summary. -`LOOT_ITEM_AVAILABLE: itemTooltip, lootHandle` - -**Payload:** -- `itemTooltip` - - *string* -- `lootHandle` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_ITEM_ROLL_WON.md b/wiki-information/events/LOOT_ITEM_ROLL_WON.md deleted file mode 100644 index f0c6cde1..00000000 --- a/wiki-information/events/LOOT_ITEM_ROLL_WON.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: LOOT_ITEM_ROLL_WON - -**Title:** LOOT ITEM ROLL WON - -**Content:** -Needs summary. -`LOOT_ITEM_ROLL_WON: itemLink, rollQuantity, rollType, roll, upgraded` - -**Payload:** -- `itemLink` - - *string* -- `rollQuantity` - - *number* -- `rollType` - - *number* -- `roll` - - *number* -- `upgraded` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LOOT_OPENED.md b/wiki-information/events/LOOT_OPENED.md deleted file mode 100644 index 1af1e469..00000000 --- a/wiki-information/events/LOOT_OPENED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LOOT_OPENED - -**Title:** LOOT OPENED - -**Content:** -Fires when a corpse is looted, after LOOT_READY. -`LOOT_OPENED: autoLoot, isFromItem` - -**Payload:** -- `autoLoot` - - *boolean* - Equal to CVar autoLootDefault. -- `isFromItem` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/LOOT_READY.md b/wiki-information/events/LOOT_READY.md deleted file mode 100644 index d4cc00a7..00000000 --- a/wiki-information/events/LOOT_READY.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: LOOT_READY - -**Title:** LOOT READY - -**Content:** -This is fired when looting begins, but before the loot window is shown. Loot functions like GetNumLootItems will be available until LOOT_CLOSED is fired. -`LOOT_READY: autoloot` - -**Payload:** -- `autoloot` - - *boolean* - Equal to autoLootDefault. - -**Related Information:** -LOOT_OPENED -LOOT_CLOSED \ No newline at end of file diff --git a/wiki-information/events/LOOT_ROLLS_COMPLETE.md b/wiki-information/events/LOOT_ROLLS_COMPLETE.md deleted file mode 100644 index 2119b323..00000000 --- a/wiki-information/events/LOOT_ROLLS_COMPLETE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LOOT_ROLLS_COMPLETE - -**Title:** LOOT ROLLS COMPLETE - -**Content:** -Needs summary. -`LOOT_ROLLS_COMPLETE: lootHandle` - -**Payload:** -- `lootHandle` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_SLOT_CHANGED.md b/wiki-information/events/LOOT_SLOT_CHANGED.md deleted file mode 100644 index 7d108edc..00000000 --- a/wiki-information/events/LOOT_SLOT_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LOOT_SLOT_CHANGED - -**Title:** LOOT SLOT CHANGED - -**Content:** -Needs summary. -`LOOT_SLOT_CHANGED: lootSlot` - -**Payload:** -- `lootSlot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOOT_SLOT_CLEARED.md b/wiki-information/events/LOOT_SLOT_CLEARED.md deleted file mode 100644 index c5b3a0f5..00000000 --- a/wiki-information/events/LOOT_SLOT_CLEARED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LOOT_SLOT_CLEARED - -**Title:** LOOT SLOT CLEARED - -**Content:** -Fired when loot is removed from a corpse. -`LOOT_SLOT_CLEARED: lootSlot` - -**Payload:** -- `lootSlot` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_ADDED.md b/wiki-information/events/LOSS_OF_CONTROL_ADDED.md deleted file mode 100644 index c1c47ecc..00000000 --- a/wiki-information/events/LOSS_OF_CONTROL_ADDED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LOSS_OF_CONTROL_ADDED - -**Title:** LOSS OF CONTROL ADDED - -**Content:** -Needs summary. -`LOSS_OF_CONTROL_ADDED: effectIndex` - -**Payload:** -- `effectIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md b/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md deleted file mode 100644 index 156f8e48..00000000 --- a/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_ADDED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LOSS_OF_CONTROL_COMMENTATOR_ADDED - -**Title:** LOSS OF CONTROL COMMENTATOR ADDED - -**Content:** -Fired when a new active loss-of-control effect is added to a player. Only relevant for commentator mode. -`LOSS_OF_CONTROL_COMMENTATOR_ADDED: victim, effectIndex` - -**Payload:** -- `victim` - - *string* -- `effectIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md b/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md deleted file mode 100644 index 8c020ddb..00000000 --- a/wiki-information/events/LOSS_OF_CONTROL_COMMENTATOR_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: LOSS_OF_CONTROL_COMMENTATOR_UPDATE - -**Title:** LOSS OF CONTROL COMMENTATOR UPDATE - -**Content:** -Fired when the primary active loss-of-control effect is updated. Only relevant for commentator mode. -`LOSS_OF_CONTROL_COMMENTATOR_UPDATE: victim` - -**Payload:** -- `victim` - - *string* \ No newline at end of file diff --git a/wiki-information/events/LOSS_OF_CONTROL_UPDATE.md b/wiki-information/events/LOSS_OF_CONTROL_UPDATE.md deleted file mode 100644 index 689c139d..00000000 --- a/wiki-information/events/LOSS_OF_CONTROL_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: LOSS_OF_CONTROL_UPDATE - -**Title:** LOSS OF CONTROL UPDATE - -**Content:** -Needs summary. -`LOSS_OF_CONTROL_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/LUA_WARNING.md b/wiki-information/events/LUA_WARNING.md deleted file mode 100644 index 0cdf5735..00000000 --- a/wiki-information/events/LUA_WARNING.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: LUA_WARNING - -**Title:** LUA WARNING - -**Content:** -Needs summary. -`LUA_WARNING: warnType, warningText` - -**Payload:** -- `warnType` - - *number* -- `warningText` - - *string* \ No newline at end of file diff --git a/wiki-information/events/MACRO_ACTION_BLOCKED.md b/wiki-information/events/MACRO_ACTION_BLOCKED.md deleted file mode 100644 index 87245c81..00000000 --- a/wiki-information/events/MACRO_ACTION_BLOCKED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MACRO_ACTION_BLOCKED - -**Title:** MACRO ACTION BLOCKED - -**Content:** -(this event doesn't seem to be used anymore, use MACRO_ACTION_FORBIDDEN) -`MACRO_ACTION_BLOCKED: function` - -**Payload:** -- `function` - - *string* \ No newline at end of file diff --git a/wiki-information/events/MACRO_ACTION_FORBIDDEN.md b/wiki-information/events/MACRO_ACTION_FORBIDDEN.md deleted file mode 100644 index 5f1b492d..00000000 --- a/wiki-information/events/MACRO_ACTION_FORBIDDEN.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MACRO_ACTION_FORBIDDEN - -**Title:** MACRO ACTION FORBIDDEN - -**Content:** -Sent when a macro tries use actions that are always forbidden (movement, targeting, etc.). -`MACRO_ACTION_FORBIDDEN: function` - -**Payload:** -- `function` - - *string* - The name of the forbidden function, e.g. "ToggleRun()" \ No newline at end of file diff --git a/wiki-information/events/MAIL_CLOSED.md b/wiki-information/events/MAIL_CLOSED.md deleted file mode 100644 index 9ffd005c..00000000 --- a/wiki-information/events/MAIL_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MAIL_CLOSED - -**Title:** MAIL CLOSED - -**Content:** -Fired when the mailbox window is closed. -`MAIL_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_FAILED.md b/wiki-information/events/MAIL_FAILED.md deleted file mode 100644 index 25ca3b4e..00000000 --- a/wiki-information/events/MAIL_FAILED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MAIL_FAILED - -**Title:** MAIL FAILED - -**Content:** -Needs summary. -`MAIL_FAILED: itemID` - -**Payload:** -- `itemID` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/MAIL_INBOX_UPDATE.md b/wiki-information/events/MAIL_INBOX_UPDATE.md deleted file mode 100644 index 5c18a91a..00000000 --- a/wiki-information/events/MAIL_INBOX_UPDATE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: MAIL_INBOX_UPDATE - -**Title:** MAIL INBOX UPDATE - -**Content:** -This event is fired when the inbox changes in any way. -`MAIL_INBOX_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -- Fires when the inbox list is loaded while the frame is open -- Fires when mail item changes from new to read -- Fires when mail item is opened for the first time in a session \ No newline at end of file diff --git a/wiki-information/events/MAIL_LOCK_SEND_ITEMS.md b/wiki-information/events/MAIL_LOCK_SEND_ITEMS.md deleted file mode 100644 index 72cb8dab..00000000 --- a/wiki-information/events/MAIL_LOCK_SEND_ITEMS.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: MAIL_LOCK_SEND_ITEMS - -**Title:** MAIL LOCK SEND ITEMS - -**Content:** -Fired when you send an item that needs a confirmation (e.g. Heirlooms that are still refundable) -`MAIL_LOCK_SEND_ITEMS: attachSlot, itemLink` - -**Payload:** -- `attachSlot` - - *number* - Mail Slot -- `itemLink` - - *string* \ No newline at end of file diff --git a/wiki-information/events/MAIL_SEND_INFO_UPDATE.md b/wiki-information/events/MAIL_SEND_INFO_UPDATE.md deleted file mode 100644 index 0eceba4f..00000000 --- a/wiki-information/events/MAIL_SEND_INFO_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MAIL_SEND_INFO_UPDATE - -**Title:** MAIL SEND INFO UPDATE - -**Content:** -Fired when an item is dragged to or from the Send Item box in an outgoing mail message. -`MAIL_SEND_INFO_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_SEND_SUCCESS.md b/wiki-information/events/MAIL_SEND_SUCCESS.md deleted file mode 100644 index 37368a73..00000000 --- a/wiki-information/events/MAIL_SEND_SUCCESS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MAIL_SEND_SUCCESS - -**Title:** MAIL SEND SUCCESS - -**Content:** -Fired when a mail has been successfully sent to the mailbox of the recipient. -`MAIL_SEND_SUCCESS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_SHOW.md b/wiki-information/events/MAIL_SHOW.md deleted file mode 100644 index e57ef25f..00000000 --- a/wiki-information/events/MAIL_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MAIL_SHOW - -**Title:** MAIL SHOW - -**Content:** -Fired when the mailbox is first opened. -`MAIL_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MAIL_SUCCESS.md b/wiki-information/events/MAIL_SUCCESS.md deleted file mode 100644 index 17fcc57f..00000000 --- a/wiki-information/events/MAIL_SUCCESS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MAIL_SUCCESS - -**Title:** MAIL SUCCESS - -**Content:** -Needs summary. -`MAIL_SUCCESS: itemID` - -**Payload:** -- `itemID` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md b/wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md deleted file mode 100644 index 9e1eba6f..00000000 --- a/wiki-information/events/MAIL_UNLOCK_SEND_ITEMS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MAIL_UNLOCK_SEND_ITEMS - -**Title:** MAIL UNLOCK SEND ITEMS - -**Content:** -Fires when the mail confirmation is cancelled and the concerned item(s) need to be unlocked. -`MAIL_UNLOCK_SEND_ITEMS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MAP_EXPLORATION_UPDATED.md b/wiki-information/events/MAP_EXPLORATION_UPDATED.md deleted file mode 100644 index 6d6d7ac0..00000000 --- a/wiki-information/events/MAP_EXPLORATION_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MAP_EXPLORATION_UPDATED - -**Title:** MAP EXPLORATION UPDATED - -**Content:** -Needs summary. -`MAP_EXPLORATION_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md b/wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md deleted file mode 100644 index 2e89ee02..00000000 --- a/wiki-information/events/MAX_EXPANSION_LEVEL_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MAX_EXPANSION_LEVEL_UPDATED - -**Title:** MAX EXPANSION LEVEL UPDATED - -**Content:** -Needs summary. -`MAX_EXPANSION_LEVEL_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md b/wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md deleted file mode 100644 index 7d44cdaf..00000000 --- a/wiki-information/events/MAX_SPELL_START_RECOVERY_OFFSET_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MAX_SPELL_START_RECOVERY_OFFSET_CHANGED - -**Title:** MAX SPELL START RECOVERY OFFSET CHANGED - -**Content:** -Needs summary. -`MAX_SPELL_START_RECOVERY_OFFSET_CHANGED: clampedNewQueueWindowMs` - -**Payload:** -- `clampedNewQueueWindowMs` - - *number* \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_CLOSED.md b/wiki-information/events/MERCHANT_CLOSED.md deleted file mode 100644 index b5ae8029..00000000 --- a/wiki-information/events/MERCHANT_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MERCHANT_CLOSED - -**Title:** MERCHANT CLOSED - -**Content:** -Fired when a merchant frame closes. (Called twice). -`MERCHANT_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md b/wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md deleted file mode 100644 index 4afdc809..00000000 --- a/wiki-information/events/MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL - -**Title:** MERCHANT CONFIRM TRADE TIMER REMOVAL - -**Content:** -Needs summary. -`MERCHANT_CONFIRM_TRADE_TIMER_REMOVAL: itemLink` - -**Payload:** -- `itemLink` - - *string* \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md b/wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md deleted file mode 100644 index a2709788..00000000 --- a/wiki-information/events/MERCHANT_FILTER_ITEM_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MERCHANT_FILTER_ITEM_UPDATE - -**Title:** MERCHANT FILTER ITEM UPDATE - -**Content:** -Needs summary. -`MERCHANT_FILTER_ITEM_UPDATE: itemID` - -**Payload:** -- `itemID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_SHOW.md b/wiki-information/events/MERCHANT_SHOW.md deleted file mode 100644 index 37a77d5c..00000000 --- a/wiki-information/events/MERCHANT_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MERCHANT_SHOW - -**Title:** MERCHANT SHOW - -**Content:** -Fired when the merchant frame is shown. -`MERCHANT_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MERCHANT_UPDATE.md b/wiki-information/events/MERCHANT_UPDATE.md deleted file mode 100644 index bd0980e0..00000000 --- a/wiki-information/events/MERCHANT_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MERCHANT_UPDATE - -**Title:** MERCHANT UPDATE - -**Content:** -Fired when a merchant updates. -`MERCHANT_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MINIMAP_PING.md b/wiki-information/events/MINIMAP_PING.md deleted file mode 100644 index 214166e9..00000000 --- a/wiki-information/events/MINIMAP_PING.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: MINIMAP_PING - -**Title:** MINIMAP PING - -**Content:** -Fired when the minimap is pinged. -`MINIMAP_PING: unitTarget, y, x` - -**Payload:** -- `unitTarget` - - *string* : UnitId - Unit that created the ping (i.e. "player" or any of the group members) -- `y` - - *number* -- `x` - - *number* \ No newline at end of file diff --git a/wiki-information/events/MINIMAP_UPDATE_TRACKING.md b/wiki-information/events/MINIMAP_UPDATE_TRACKING.md deleted file mode 100644 index a2c046e3..00000000 --- a/wiki-information/events/MINIMAP_UPDATE_TRACKING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MINIMAP_UPDATE_TRACKING - -**Title:** MINIMAP UPDATE TRACKING - -**Content:** -Fired when the player selects a different tracking type from the menu attached to the mini map. -`MINIMAP_UPDATE_TRACKING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MINIMAP_UPDATE_ZOOM.md b/wiki-information/events/MINIMAP_UPDATE_ZOOM.md deleted file mode 100644 index 7a92bcc0..00000000 --- a/wiki-information/events/MINIMAP_UPDATE_ZOOM.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: MINIMAP_UPDATE_ZOOM - -**Title:** MINIMAP UPDATE ZOOM - -**Content:** -Fired when the minimap scaling factor is changed. This happens, generally, whenever the player moves indoors from outside, or vice versa. To test the player's location, compare the minimapZoom and minimapInsideZoom CVars with the current minimap zoom level (see Minimap:GetZoom). -`MINIMAP_UPDATE_ZOOM` - -**Payload:** -- `None` - -**Content Details:** -This event does not relate to the + and - minimap zoom buttons. \ No newline at end of file diff --git a/wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md b/wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md deleted file mode 100644 index 8db6a451..00000000 --- a/wiki-information/events/MIN_EXPANSION_LEVEL_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MIN_EXPANSION_LEVEL_UPDATED - -**Title:** MIN EXPANSION LEVEL UPDATED - -**Content:** -Needs summary. -`MIN_EXPANSION_LEVEL_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/MIRROR_TIMER_PAUSE.md b/wiki-information/events/MIRROR_TIMER_PAUSE.md deleted file mode 100644 index f749f746..00000000 --- a/wiki-information/events/MIRROR_TIMER_PAUSE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: MIRROR_TIMER_PAUSE - -**Title:** MIRROR TIMER PAUSE - -**Content:** -Fired when the mirror timer is paused. -`MIRROR_TIMER_PAUSE: timerName, paused` - -**Payload:** -- `timerName` - - *string* -- `paused` - - *number* - pause duration \ No newline at end of file diff --git a/wiki-information/events/MIRROR_TIMER_START.md b/wiki-information/events/MIRROR_TIMER_START.md deleted file mode 100644 index 6787a15f..00000000 --- a/wiki-information/events/MIRROR_TIMER_START.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: MIRROR_TIMER_START - -**Title:** MIRROR TIMER START - -**Content:** -Fired when some sort of timer starts. -`MIRROR_TIMER_START: timerName, value, maxValue, scale, paused, timerLabel` - -**Payload:** -- `timerName` - - *string* - e.g. "BREATH" -- `value` - - *number* - start-time in ms, e.g. 180000 -- `maxValue` - - *number* - max-time in ms, e.g. 180000 -- `scale` - - *number* - time added per second in seconds, for e.g. -1 -- `paused` - - *number* -- `timerLabel` - - *string* - e.g. "Breath" \ No newline at end of file diff --git a/wiki-information/events/MIRROR_TIMER_STOP.md b/wiki-information/events/MIRROR_TIMER_STOP.md deleted file mode 100644 index 08efd502..00000000 --- a/wiki-information/events/MIRROR_TIMER_STOP.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: MIRROR_TIMER_STOP - -**Title:** MIRROR TIMER STOP - -**Content:** -Fired when a mirror timer is stopped. -`MIRROR_TIMER_STOP: timerName` - -**Payload:** -- `timerName` - - *string* - e.g. "BREATH" \ No newline at end of file diff --git a/wiki-information/events/MODIFIER_STATE_CHANGED.md b/wiki-information/events/MODIFIER_STATE_CHANGED.md deleted file mode 100644 index 6b64ab44..00000000 --- a/wiki-information/events/MODIFIER_STATE_CHANGED.md +++ /dev/null @@ -1,30 +0,0 @@ -## Event: MODIFIER_STATE_CHANGED - -**Title:** MODIFIER STATE CHANGED - -**Content:** -Fired when shift/ctrl/alt keys are pressed or released. Does not fire when an EditBox has keyboard focus. -`MODIFIER_STATE_CHANGED: key, down` - -**Payload:** -- `key` - - *string* - LCTRL, RCTRL, LSHIFT, RSHIFT, LALT, RALT -- `down` - - *number* - 1 for pressed, 0 for released. - -**Content Details:** -Related API -IsModifierKeyDown - -**Usage:** -Prints when a modifier key is pressed down. -```lua -local function OnEvent(self, event, key, down) - if down == 1 then - print("pressed in", key) - end -end -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/events/MOUNT_CURSOR_CLEAR.md b/wiki-information/events/MOUNT_CURSOR_CLEAR.md deleted file mode 100644 index f50f246f..00000000 --- a/wiki-information/events/MOUNT_CURSOR_CLEAR.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: MOUNT_CURSOR_CLEAR - -**Title:** MOUNT CURSOR CLEAR - -**Content:** -Fires after the player is no longer dragging a mount ability. -`MOUNT_CURSOR_CLEAR` - -**Payload:** -- `None` - -**Content Details:** -The ability might now be assigned to an action bar, unless the player cancelled the drag by right-clicking. \ No newline at end of file diff --git a/wiki-information/events/MUTELIST_UPDATE.md b/wiki-information/events/MUTELIST_UPDATE.md deleted file mode 100644 index d180f8fd..00000000 --- a/wiki-information/events/MUTELIST_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: MUTELIST_UPDATE - -**Title:** MUTELIST UPDATE - -**Content:** -Needs summary. -`MUTELIST_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/NAME_PLATE_CREATED.md b/wiki-information/events/NAME_PLATE_CREATED.md deleted file mode 100644 index 9b53268d..00000000 --- a/wiki-information/events/NAME_PLATE_CREATED.md +++ /dev/null @@ -1,38 +0,0 @@ -## Event: NAME_PLATE_CREATED - -**Title:** NAME PLATE CREATED - -**Content:** -Needs summary. -`NAME_PLATE_CREATED: namePlateFrame` - -**Payload:** -- `namePlateFrame` - - *table* - - Field - - Type - - Description - - OnAdded - - function - - OnRemoved - - function - - OnOptionsUpdated - - function - - ApplyOffsets - - function - - GetAdditionalInsetPadding - - function - - GetPreferredInsets - - function - - OnSizeChanged - - function - - driverFrame - - NamePlateDriverFrame? - - UnitFrame - - Button? - - namePlateUnitToken - - string? - - e.g. "nameplate1" - - template - - string - - e.g. "NamePlateUnitFrameTemplate" \ No newline at end of file diff --git a/wiki-information/events/NAME_PLATE_UNIT_ADDED.md b/wiki-information/events/NAME_PLATE_UNIT_ADDED.md deleted file mode 100644 index 4c79891f..00000000 --- a/wiki-information/events/NAME_PLATE_UNIT_ADDED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: NAME_PLATE_UNIT_ADDED - -**Title:** NAME PLATE UNIT ADDED - -**Content:** -Fires when a nameplate is to be added. The event may sometimes fire before a nameplate is actually added. -`NAME_PLATE_UNIT_ADDED: unitToken` - -**Payload:** -- `unitToken` - - *string* : UnitId - The added unit in nameplateN format. \ No newline at end of file diff --git a/wiki-information/events/NAME_PLATE_UNIT_REMOVED.md b/wiki-information/events/NAME_PLATE_UNIT_REMOVED.md deleted file mode 100644 index c7d622f7..00000000 --- a/wiki-information/events/NAME_PLATE_UNIT_REMOVED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: NAME_PLATE_UNIT_REMOVED - -**Title:** NAME PLATE UNIT REMOVED - -**Content:** -Fires when a nameplate is to be removed. The event may sometimes fire before a nameplate is actually removed. -`NAME_PLATE_UNIT_REMOVED: unitToken` - -**Payload:** -- `unitToken` - - *string* : UnitId - The removed unit in nameplateN format. \ No newline at end of file diff --git a/wiki-information/events/NEW_AUCTION_UPDATE.md b/wiki-information/events/NEW_AUCTION_UPDATE.md deleted file mode 100644 index 0b84e4a0..00000000 --- a/wiki-information/events/NEW_AUCTION_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: NEW_AUCTION_UPDATE - -**Title:** NEW AUCTION UPDATE - -**Content:** -Fired when a user drags an item into the Auction Item box on the Auctions tab of the auction house window. -`NEW_AUCTION_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -You can retrieve information about the item for which an auction is being considered using `GetAuctionSellItemInfo()` \ No newline at end of file diff --git a/wiki-information/events/NEW_RECIPE_LEARNED.md b/wiki-information/events/NEW_RECIPE_LEARNED.md deleted file mode 100644 index 10bfe3ac..00000000 --- a/wiki-information/events/NEW_RECIPE_LEARNED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: NEW_RECIPE_LEARNED - -**Title:** NEW RECIPE LEARNED - -**Content:** -Needs summary. -`NEW_RECIPE_LEARNED: recipeID, recipeLevel, baseRecipeID` - -**Payload:** -- `recipeID` - - *number* -- `recipeLevel` - - *number?* -- `baseRecipeID` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/NEW_TOY_ADDED.md b/wiki-information/events/NEW_TOY_ADDED.md deleted file mode 100644 index 628d722c..00000000 --- a/wiki-information/events/NEW_TOY_ADDED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: NEW_TOY_ADDED - -**Title:** NEW TOY ADDED - -**Content:** -Fires when adding a new toy to the Toy Box. -`NEW_TOY_ADDED: itemID` - -**Payload:** -- `itemID` - - *number* - All possible values listed at ToyID. - -**Related Information:** -C_ToyBox.GetToyInfo(itemID) -TOYS_UPDATED \ No newline at end of file diff --git a/wiki-information/events/NEW_WMO_CHUNK.md b/wiki-information/events/NEW_WMO_CHUNK.md deleted file mode 100644 index 7c45943c..00000000 --- a/wiki-information/events/NEW_WMO_CHUNK.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: NEW_WMO_CHUNK - -**Title:** NEW WMO CHUNK - -**Content:** -Needs summary. -`NEW_WMO_CHUNK` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md b/wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md deleted file mode 100644 index 2a56543b..00000000 --- a/wiki-information/events/NOTCHED_DISPLAY_MODE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: NOTCHED_DISPLAY_MODE_CHANGED - -**Title:** NOTCHED DISPLAY MODE CHANGED - -**Content:** -Needs summary. -`NOTCHED_DISPLAY_MODE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md b/wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md deleted file mode 100644 index e51937cf..00000000 --- a/wiki-information/events/NOTIFY_CHAT_SUPPRESSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: NOTIFY_CHAT_SUPPRESSED - -**Title:** NOTIFY CHAT SUPPRESSED - -**Content:** -Needs summary. -`NOTIFY_CHAT_SUPPRESSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/NOTIFY_PVP_AFK_RESULT.md b/wiki-information/events/NOTIFY_PVP_AFK_RESULT.md deleted file mode 100644 index d57edeb8..00000000 --- a/wiki-information/events/NOTIFY_PVP_AFK_RESULT.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: NOTIFY_PVP_AFK_RESULT - -**Title:** NOTIFY PVP AFK RESULT - -**Content:** -Needs summary. -`NOTIFY_PVP_AFK_RESULT: offender, numBlackMarksOnOffender, numPlayersIHaveReported` - -**Payload:** -- `offender` - - *string* -- `numBlackMarksOnOffender` - - *number* -- `numPlayersIHaveReported` - - *number* \ No newline at end of file diff --git a/wiki-information/events/OBJECT_ENTERED_AOI.md b/wiki-information/events/OBJECT_ENTERED_AOI.md deleted file mode 100644 index aa04244f..00000000 --- a/wiki-information/events/OBJECT_ENTERED_AOI.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: OBJECT_ENTERED_AOI - -**Title:** OBJECT ENTERED AOI - -**Content:** -Needs summary. -`OBJECT_ENTERED_AOI: guid` - -**Payload:** -- `guid` - - *string* \ No newline at end of file diff --git a/wiki-information/events/OBJECT_LEFT_AOI.md b/wiki-information/events/OBJECT_LEFT_AOI.md deleted file mode 100644 index 64666ee0..00000000 --- a/wiki-information/events/OBJECT_LEFT_AOI.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: OBJECT_LEFT_AOI - -**Title:** OBJECT LEFT AOI - -**Content:** -Needs summary. -`OBJECT_LEFT_AOI: guid` - -**Payload:** -- `guid` - - *string* \ No newline at end of file diff --git a/wiki-information/events/OBLITERUM_FORGE_CLOSE.md b/wiki-information/events/OBLITERUM_FORGE_CLOSE.md deleted file mode 100644 index 77d01810..00000000 --- a/wiki-information/events/OBLITERUM_FORGE_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: OBLITERUM_FORGE_CLOSE - -**Title:** OBLITERUM FORGE CLOSE - -**Content:** -Needs summary. -`OBLITERUM_FORGE_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md b/wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md deleted file mode 100644 index 3af47b06..00000000 --- a/wiki-information/events/OBLITERUM_FORGE_PENDING_ITEM_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: OBLITERUM_FORGE_PENDING_ITEM_CHANGED - -**Title:** OBLITERUM FORGE PENDING ITEM CHANGED - -**Content:** -Needs summary. -`OBLITERUM_FORGE_PENDING_ITEM_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/OBLITERUM_FORGE_SHOW.md b/wiki-information/events/OBLITERUM_FORGE_SHOW.md deleted file mode 100644 index 7b2e9949..00000000 --- a/wiki-information/events/OBLITERUM_FORGE_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: OBLITERUM_FORGE_SHOW - -**Title:** OBLITERUM FORGE SHOW - -**Content:** -Needs summary. -`OBLITERUM_FORGE_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/OPEN_MASTER_LOOT_LIST.md b/wiki-information/events/OPEN_MASTER_LOOT_LIST.md deleted file mode 100644 index f4b2aa81..00000000 --- a/wiki-information/events/OPEN_MASTER_LOOT_LIST.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: OPEN_MASTER_LOOT_LIST - -**Title:** OPEN MASTER LOOT LIST - -**Content:** -Needs summary. -`OPEN_MASTER_LOOT_LIST` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/OPEN_REPORT_PLAYER.md b/wiki-information/events/OPEN_REPORT_PLAYER.md deleted file mode 100644 index 0abbc166..00000000 --- a/wiki-information/events/OPEN_REPORT_PLAYER.md +++ /dev/null @@ -1,35 +0,0 @@ -## Event: OPEN_REPORT_PLAYER - -**Title:** OPEN REPORT PLAYER - -**Content:** -Fired after launching the player reporting window. -`OPEN_REPORT_PLAYER: token, reportType, playerName` - -**Payload:** -- `token` - - *number* - report Id -- `reportType` - - *string* - One of the values in PLAYER_REPORT_TYPE⊞ - - ⊟ - - PLAYER_REPORT_TYPE - - Constant - - Value - - PLAYER_REPORT_TYPE_SPAM - - spam - - PLAYER_REPORT_TYPE_LANGUAGE - - language - - PLAYER_REPORT_TYPE_ABUSE - - abuse - - PLAYER_REPORT_TYPE_BAD_PLAYER_NAME - - badplayername - - PLAYER_REPORT_TYPE_BAD_GUILD_NAME - - badguildname - - PLAYER_REPORT_TYPE_CHEATING - - cheater - - PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME - - badbattlepetname - - PLAYER_REPORT_TYPE_BAD_PET_NAME - - badpetname -- `playerName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/OPEN_TABARD_FRAME.md b/wiki-information/events/OPEN_TABARD_FRAME.md deleted file mode 100644 index 1779a1d9..00000000 --- a/wiki-information/events/OPEN_TABARD_FRAME.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: OPEN_TABARD_FRAME - -**Title:** OPEN TABARD FRAME - -**Content:** -Fired when interacting with an NPC allowing guild tabard customization. -`OPEN_TABARD_FRAME` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_INVITE_CANCEL.md b/wiki-information/events/PARTY_INVITE_CANCEL.md deleted file mode 100644 index 7ff434b9..00000000 --- a/wiki-information/events/PARTY_INVITE_CANCEL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PARTY_INVITE_CANCEL - -**Title:** PARTY INVITE CANCEL - -**Content:** -Fired when you decline a party invite. -`PARTY_INVITE_CANCEL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_INVITE_REQUEST.md b/wiki-information/events/PARTY_INVITE_REQUEST.md deleted file mode 100644 index fb06b8cb..00000000 --- a/wiki-information/events/PARTY_INVITE_REQUEST.md +++ /dev/null @@ -1,25 +0,0 @@ -## Event: PARTY_INVITE_REQUEST - -**Title:** PARTY INVITE REQUEST - -**Content:** -Fires when a player invite you to party. -`PARTY_INVITE_REQUEST: name, isTank, isHealer, isDamage, isNativeRealm, allowMultipleRoles, inviterGUID, questSessionActive` - -**Payload:** -- `name` - - *string* - The player that invited you. -- `isTank` - - *boolean* -- `isHealer` - - *boolean* -- `isDamage` - - *boolean* -- `isNativeRealm` - - *boolean* - Whether the invite is cross realm -- `allowMultipleRoles` - - *boolean* -- `inviterGUID` - - *string* -- `questSessionActive` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/PARTY_LEADER_CHANGED.md b/wiki-information/events/PARTY_LEADER_CHANGED.md deleted file mode 100644 index ffc7c786..00000000 --- a/wiki-information/events/PARTY_LEADER_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PARTY_LEADER_CHANGED - -**Title:** PARTY LEADER CHANGED - -**Content:** -Fired when the player's leadership changed. -`PARTY_LEADER_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md b/wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md deleted file mode 100644 index 00bb51c3..00000000 --- a/wiki-information/events/PARTY_LOOT_METHOD_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PARTY_LOOT_METHOD_CHANGED - -**Title:** PARTY LOOT METHOD CHANGED - -**Content:** -Fired when the party's loot method changes. -`PARTY_LOOT_METHOD_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PARTY_MEMBER_DISABLE.md b/wiki-information/events/PARTY_MEMBER_DISABLE.md deleted file mode 100644 index 24b1b83e..00000000 --- a/wiki-information/events/PARTY_MEMBER_DISABLE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PARTY_MEMBER_DISABLE - -**Title:** PARTY MEMBER DISABLE - -**Content:** -Fired when a specific party member is offline or dead. -`PARTY_MEMBER_DISABLE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PARTY_MEMBER_ENABLE.md b/wiki-information/events/PARTY_MEMBER_ENABLE.md deleted file mode 100644 index 7a88dd0d..00000000 --- a/wiki-information/events/PARTY_MEMBER_ENABLE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PARTY_MEMBER_ENABLE - -**Title:** PARTY MEMBER ENABLE - -**Content:** -Fired when a specific party member is still connected. -`PARTY_MEMBER_ENABLE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md b/wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md deleted file mode 100644 index 62b6cd39..00000000 --- a/wiki-information/events/PENDING_AZERITE_ESSENCE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PENDING_AZERITE_ESSENCE_CHANGED - -**Title:** PENDING AZERITE ESSENCE CHANGED - -**Content:** -Sent to the add on when the Heart of Azeroth modification window is open and the player left-clicks to "pick up" a Heart ability in the list of abilities to the right. Also sent when an ability is "dropped" by the cursor in any of the following ways - placing the ability in the center of the heart, closing the window, or left-clicking in the window outside the center target zone. -`PENDING_AZERITE_ESSENCE_CHANGED: essenceID` - -**Payload:** -- `essenceID` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/PETITION_CLOSED.md b/wiki-information/events/PETITION_CLOSED.md deleted file mode 100644 index 5cba3370..00000000 --- a/wiki-information/events/PETITION_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PETITION_CLOSED - -**Title:** PETITION CLOSED - -**Content:** -Fired when a petition is closed, e.g. by you signing it. -`PETITION_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PETITION_SHOW.md b/wiki-information/events/PETITION_SHOW.md deleted file mode 100644 index 2be8ce09..00000000 --- a/wiki-information/events/PETITION_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PETITION_SHOW - -**Title:** PETITION SHOW - -**Content:** -Fired when you are shown a petition to create a guild or arena team. This can be due to someone offering you to sign it, or because of you clicking your own charter in your inventory. See GetPetitionInfo. -`PETITION_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_ATTACK_START.md b/wiki-information/events/PET_ATTACK_START.md deleted file mode 100644 index 9a12b155..00000000 --- a/wiki-information/events/PET_ATTACK_START.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_ATTACK_START - -**Title:** PET ATTACK START - -**Content:** -Fired when the player's pet begins attacking. -`PET_ATTACK_START` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_ATTACK_STOP.md b/wiki-information/events/PET_ATTACK_STOP.md deleted file mode 100644 index d2092415..00000000 --- a/wiki-information/events/PET_ATTACK_STOP.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_ATTACK_STOP - -**Title:** PET ATTACK STOP - -**Content:** -Fired when the player's pet ceases attack. -`PET_ATTACK_STOP` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_HIDEGRID.md b/wiki-information/events/PET_BAR_HIDEGRID.md deleted file mode 100644 index 6a036cae..00000000 --- a/wiki-information/events/PET_BAR_HIDEGRID.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BAR_HIDEGRID - -**Title:** PET BAR HIDEGRID - -**Content:** -Fired when pet spells are dropped into the PetActionBar. -`PET_BAR_HIDEGRID` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_SHOWGRID.md b/wiki-information/events/PET_BAR_SHOWGRID.md deleted file mode 100644 index 18c3add1..00000000 --- a/wiki-information/events/PET_BAR_SHOWGRID.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BAR_SHOWGRID - -**Title:** PET BAR SHOWGRID - -**Content:** -Fired when pet spells are dragged from the pet spellbook or the PetActionBar. -`PET_BAR_SHOWGRID` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_UPDATE.md b/wiki-information/events/PET_BAR_UPDATE.md deleted file mode 100644 index 6fa64709..00000000 --- a/wiki-information/events/PET_BAR_UPDATE.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: PET_BAR_UPDATE - -**Title:** PET BAR UPDATE - -**Content:** -Fired whenever the pet bar is updated and its GUI needs to be re-rendered/refreshed. -`PET_BAR_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -Examples of actions which trigger this event: -- Losing your pet (causes the pet bar to vanish). -- Gaining a pet (causes the pet bar to appear). -- Triggering the pet "aggressive/defensive/passive" state (whether via the button or via commands like "/petdefensive"). Triggers even if the new state is the same as last time (ie. by re-triggering the same button multiple times in a row). -- Triggering the pet "follow" or "stay" commands (but not the "attack" command since unlike the others, its button never gets highlighted on the bar while the pet is attacking). Just like the aggressiveness state, this also reacts via commands like "/petstay", and will likewise react to repeated re-triggering (through any method). -- Toggling pet skill "autocast" state, regardless of whether you do it via the spellbook, or right-clicking on the bar icon itself, or using commands like "/petautocasttoggle Growl". -- Moving icons on the pet skill bar, such as by dragging icons from the pet spellbook onto the pet bar. (This is not your regular player action bar, which of course can't even contain pet spells even if you attempt to drag them there manually.) \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md b/wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md deleted file mode 100644 index cb500070..00000000 --- a/wiki-information/events/PET_BAR_UPDATE_COOLDOWN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BAR_UPDATE_COOLDOWN - -**Title:** PET BAR UPDATE COOLDOWN - -**Content:** -Fired when a pet spell cooldown starts. It is not called when the cooldown ends. -`PET_BAR_UPDATE_COOLDOWN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BAR_UPDATE_USABLE.md b/wiki-information/events/PET_BAR_UPDATE_USABLE.md deleted file mode 100644 index 1ff5c4b9..00000000 --- a/wiki-information/events/PET_BAR_UPDATE_USABLE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BAR_UPDATE_USABLE - -**Title:** PET BAR UPDATE USABLE - -**Content:** -Needs summary. -`PET_BAR_UPDATE_USABLE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md b/wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md deleted file mode 100644 index 86cf36b2..00000000 --- a/wiki-information/events/PET_BATTLE_ABILITY_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_ABILITY_CHANGED - -**Title:** PET BATTLE ABILITY CHANGED - -**Content:** -Needs summary. -`PET_BATTLE_ABILITY_CHANGED: owner, petIndex, abilityID` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* -- `abilityID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_ACTION_SELECTED.md b/wiki-information/events/PET_BATTLE_ACTION_SELECTED.md deleted file mode 100644 index 2f041365..00000000 --- a/wiki-information/events/PET_BATTLE_ACTION_SELECTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BATTLE_ACTION_SELECTED - -**Title:** PET BATTLE ACTION SELECTED - -**Content:** -Needs summary. -`PET_BATTLE_ACTION_SELECTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_AURA_APPLIED.md b/wiki-information/events/PET_BATTLE_AURA_APPLIED.md deleted file mode 100644 index 75013fcf..00000000 --- a/wiki-information/events/PET_BATTLE_AURA_APPLIED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_AURA_APPLIED - -**Title:** PET BATTLE AURA APPLIED - -**Content:** -Needs summary. -`PET_BATTLE_AURA_APPLIED: owner, petIndex, auraInstanceID` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* -- `auraInstanceID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_AURA_CANCELED.md b/wiki-information/events/PET_BATTLE_AURA_CANCELED.md deleted file mode 100644 index 26a9c0d4..00000000 --- a/wiki-information/events/PET_BATTLE_AURA_CANCELED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_AURA_CANCELED - -**Title:** PET BATTLE AURA CANCELED - -**Content:** -Needs summary. -`PET_BATTLE_AURA_CANCELED: owner, petIndex, auraInstanceID` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* -- `auraInstanceID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_AURA_CHANGED.md b/wiki-information/events/PET_BATTLE_AURA_CHANGED.md deleted file mode 100644 index cbd1ab1b..00000000 --- a/wiki-information/events/PET_BATTLE_AURA_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_AURA_CHANGED - -**Title:** PET BATTLE AURA CHANGED - -**Content:** -Needs summary. -`PET_BATTLE_AURA_CHANGED: owner, petIndex, auraInstanceID` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* -- `auraInstanceID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_CAPTURED.md b/wiki-information/events/PET_BATTLE_CAPTURED.md deleted file mode 100644 index 8859c4cc..00000000 --- a/wiki-information/events/PET_BATTLE_CAPTURED.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: PET_BATTLE_CAPTURED - -**Title:** PET BATTLE CAPTURED - -**Content:** -Fired when a pet battle ends, if the player successfully captured a battle pet. -`PET_BATTLE_CAPTURED: owner, petIndex` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* - -**Content Details:** -This event does not fire when a trap successfully snares a pet during a battle. This event is meant to signify when a player snares a pet, wins the battle, and is able to add the pet to their Pet Journal. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_CLOSE.md b/wiki-information/events/PET_BATTLE_CLOSE.md deleted file mode 100644 index 4e844807..00000000 --- a/wiki-information/events/PET_BATTLE_CLOSE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PET_BATTLE_CLOSE - -**Title:** PET BATTLE CLOSE - -**Content:** -Fired twice when the client exists a Pet Battle. -`PET_BATTLE_CLOSE` - -**Payload:** -- `None` - -**Content Details:** -This event fires twice at the very end of a pet battle, instructing the client to transition back to normal character controls. -The macro conditional evaluates to true during the first firing, and false during the second. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_FINAL_ROUND.md b/wiki-information/events/PET_BATTLE_FINAL_ROUND.md deleted file mode 100644 index e527715d..00000000 --- a/wiki-information/events/PET_BATTLE_FINAL_ROUND.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PET_BATTLE_FINAL_ROUND - -**Title:** PET BATTLE FINAL ROUND - -**Content:** -Fired at the end of the final round of a pet battle. -`PET_BATTLE_FINAL_ROUND: owner` - -**Payload:** -- `owner` - - *number* - Team index of the team that won the pet battle; 1 for the player's team, 2 for the opponent. - -**Content Details:** -This event is followed by HP recovery/XP gain notifications, and eventually PET_BATTLE_OVER and PET_BATTLE_CLOSE. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md b/wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md deleted file mode 100644 index 2ef6ab2c..00000000 --- a/wiki-information/events/PET_BATTLE_HEALTH_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_HEALTH_CHANGED - -**Title:** PET BATTLE HEALTH CHANGED - -**Content:** -Needs summary. -`PET_BATTLE_HEALTH_CHANGED: owner, petIndex, healthChange` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* -- `healthChange` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md b/wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md deleted file mode 100644 index cd88d3c8..00000000 --- a/wiki-information/events/PET_BATTLE_LEVEL_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_LEVEL_CHANGED - -**Title:** PET BATTLE LEVEL CHANGED - -**Content:** -Fired when a battle pet levels. -`PET_BATTLE_LEVEL_CHANGED: owner, petIndex, newLevel` - -**Payload:** -- `owner` - - *number* - Active player the battle pet belongs to -- `petIndex` - - *number* - Active slot the battle pet is in -- `newLevel` - - *number* - New level for the battle pet \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md b/wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md deleted file mode 100644 index b7ea70f9..00000000 --- a/wiki-information/events/PET_BATTLE_MAX_HEALTH_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_MAX_HEALTH_CHANGED - -**Title:** PET BATTLE MAX HEALTH CHANGED - -**Content:** -Needs summary. -`PET_BATTLE_MAX_HEALTH_CHANGED: owner, petIndex, healthChange` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* -- `healthChange` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OPENING_DONE.md b/wiki-information/events/PET_BATTLE_OPENING_DONE.md deleted file mode 100644 index ba267052..00000000 --- a/wiki-information/events/PET_BATTLE_OPENING_DONE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: PET_BATTLE_OPENING_DONE - -**Title:** PET BATTLE OPENING DONE - -**Content:** -Event fired at the end of camera transitioning for the pet battle -`PET_BATTLE_OPENING_DONE` - -**Payload:** -- `None` - -**Content Details:** -The transition is started with PET_BATTLE_OPENING_START. After this event the player is able to pet fight. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OPENING_START.md b/wiki-information/events/PET_BATTLE_OPENING_START.md deleted file mode 100644 index 46d03768..00000000 --- a/wiki-information/events/PET_BATTLE_OPENING_START.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: PET_BATTLE_OPENING_START - -**Title:** PET BATTLE OPENING START - -**Content:** -Begins the transition between the current UI to the Pet Battle one. -`PET_BATTLE_OPENING_START` - -**Payload:** -- `None` - -**Content Details:** -The payer is able to battle after PET_BATTLE_OPENING_DONE \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OVER.md b/wiki-information/events/PET_BATTLE_OVER.md deleted file mode 100644 index eb3c30c3..00000000 --- a/wiki-information/events/PET_BATTLE_OVER.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: PET_BATTLE_OVER - -**Title:** PET BATTLE OVER - -**Content:** -Fired when the pet battle is over, and all combat actions have been resolved. -`PET_BATTLE_OVER` - -**Payload:** -- `None` - -**Content Details:** -This event follows the post-battle healing and XP gain events after PET_BATTLE_FINAL_ROUND, and precedes PET_BATTLE_CLOSE. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md b/wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md deleted file mode 100644 index 1c23696f..00000000 --- a/wiki-information/events/PET_BATTLE_OVERRIDE_ABILITY.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PET_BATTLE_OVERRIDE_ABILITY - -**Title:** PET BATTLE OVERRIDE ABILITY - -**Content:** -Needs summary. -`PET_BATTLE_OVERRIDE_ABILITY: abilityIndex` - -**Payload:** -- `abilityIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_CHANGED.md b/wiki-information/events/PET_BATTLE_PET_CHANGED.md deleted file mode 100644 index ab6b6d37..00000000 --- a/wiki-information/events/PET_BATTLE_PET_CHANGED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PET_BATTLE_PET_CHANGED - -**Title:** PET BATTLE PET CHANGED - -**Content:** -Fired when a team's active battle pet changes. -`PET_BATTLE_PET_CHANGED: owner` - -**Payload:** -- `owner` - - *number* - index of the team the active pet of which has changed. - -**Content Details:** -C_PetBattles.GetActivePet returns the index of the new front-line pet when this event fires. \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md b/wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md deleted file mode 100644 index 004e9ce8..00000000 --- a/wiki-information/events/PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE - -**Title:** PET BATTLE PET ROUND PLAYBACK COMPLETE - -**Content:** -Needs summary. -`PET_BATTLE_PET_ROUND_PLAYBACK_COMPLETE: roundNumber` - -**Payload:** -- `roundNumber` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md b/wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md deleted file mode 100644 index 04a29e54..00000000 --- a/wiki-information/events/PET_BATTLE_PET_ROUND_RESULTS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PET_BATTLE_PET_ROUND_RESULTS - -**Title:** PET BATTLE PET ROUND RESULTS - -**Content:** -Needs summary. -`PET_BATTLE_PET_ROUND_RESULTS: roundNumber` - -**Payload:** -- `roundNumber` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md b/wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md deleted file mode 100644 index 73bb81a7..00000000 --- a/wiki-information/events/PET_BATTLE_PET_TYPE_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PET_BATTLE_PET_TYPE_CHANGED - -**Title:** PET BATTLE PET TYPE CHANGED - -**Content:** -Needs summary. -`PET_BATTLE_PET_TYPE_CHANGED: owner, petIndex, stateValue` - -**Payload:** -- `owner` - - *number* -- `petIndex` - - *number* -- `stateValue` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md b/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md deleted file mode 100644 index 2021b4e0..00000000 --- a/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUESTED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PET_BATTLE_PVP_DUEL_REQUESTED - -**Title:** PET BATTLE PVP DUEL REQUESTED - -**Content:** -Needs summary. -`PET_BATTLE_PVP_DUEL_REQUESTED: fullName` - -**Payload:** -- `fullName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md b/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md deleted file mode 100644 index c3f2c8a0..00000000 --- a/wiki-information/events/PET_BATTLE_PVP_DUEL_REQUEST_CANCEL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BATTLE_PVP_DUEL_REQUEST_CANCEL - -**Title:** PET BATTLE PVP DUEL REQUEST CANCEL - -**Content:** -Needs summary. -`PET_BATTLE_PVP_DUEL_REQUEST_CANCEL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md deleted file mode 100644 index 25ebaa20..00000000 --- a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED - -**Title:** PET BATTLE QUEUE PROPOSAL ACCEPTED - -**Content:** -Needs summary. -`PET_BATTLE_QUEUE_PROPOSAL_ACCEPTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md deleted file mode 100644 index 725f44c2..00000000 --- a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSAL_DECLINED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BATTLE_QUEUE_PROPOSAL_DECLINED - -**Title:** PET BATTLE QUEUE PROPOSAL DECLINED - -**Content:** -Needs summary. -`PET_BATTLE_QUEUE_PROPOSAL_DECLINED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md b/wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md deleted file mode 100644 index 79e75faf..00000000 --- a/wiki-information/events/PET_BATTLE_QUEUE_PROPOSE_MATCH.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BATTLE_QUEUE_PROPOSE_MATCH - -**Title:** PET BATTLE QUEUE PROPOSE MATCH - -**Content:** -Needs summary. -`PET_BATTLE_QUEUE_PROPOSE_MATCH` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_QUEUE_STATUS.md b/wiki-information/events/PET_BATTLE_QUEUE_STATUS.md deleted file mode 100644 index 8a0f2ba7..00000000 --- a/wiki-information/events/PET_BATTLE_QUEUE_STATUS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_BATTLE_QUEUE_STATUS - -**Title:** PET BATTLE QUEUE STATUS - -**Content:** -Needs summary. -`PET_BATTLE_QUEUE_STATUS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_BATTLE_XP_CHANGED.md b/wiki-information/events/PET_BATTLE_XP_CHANGED.md deleted file mode 100644 index fe9f2d3b..00000000 --- a/wiki-information/events/PET_BATTLE_XP_CHANGED.md +++ /dev/null @@ -1,18 +0,0 @@ -## Event: PET_BATTLE_XP_CHANGED - -**Title:** PET BATTLE XP CHANGED - -**Content:** -Fired when a battle pet gains experience during a pet battle. -`PET_BATTLE_XP_CHANGED: owner, petIndex, xpChange` - -**Payload:** -- `owner` - - *number* - team to which the pet belongs, 1 for the player's team, 2 for the opponent. -- `petIndex` - - *number* - pet index within the team. -- `xpChange` - - *number* - amount of XP gained. - -**Content Details:** -The PetJournal and PetBattles APIs still return the old level/experience information for the pet when this event fires. \ No newline at end of file diff --git a/wiki-information/events/PET_DISMISS_START.md b/wiki-information/events/PET_DISMISS_START.md deleted file mode 100644 index b9503859..00000000 --- a/wiki-information/events/PET_DISMISS_START.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PET_DISMISS_START - -**Title:** PET DISMISS START - -**Content:** -Needs summary. -`PET_DISMISS_START: delay` - -**Payload:** -- `delay` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PET_FORCE_NAME_DECLENSION.md b/wiki-information/events/PET_FORCE_NAME_DECLENSION.md deleted file mode 100644 index 098d9372..00000000 --- a/wiki-information/events/PET_FORCE_NAME_DECLENSION.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: PET_FORCE_NAME_DECLENSION - -**Title:** PET FORCE NAME DECLENSION - -**Content:** -Needs summary. -`PET_FORCE_NAME_DECLENSION: name, declinedName1, declinedName2, declinedName3, declinedName4, declinedName5` - -**Payload:** -- `name` - - *string* -- `declinedName1` - - *string?* -- `declinedName2` - - *string?* -- `declinedName3` - - *string?* -- `declinedName4` - - *string?* -- `declinedName5` - - *string?* \ No newline at end of file diff --git a/wiki-information/events/PET_SPELL_POWER_UPDATE.md b/wiki-information/events/PET_SPELL_POWER_UPDATE.md deleted file mode 100644 index b6ce245e..00000000 --- a/wiki-information/events/PET_SPELL_POWER_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_SPELL_POWER_UPDATE - -**Title:** PET SPELL POWER UPDATE - -**Content:** -Fires when the pet's spell power bonus changes. Use GetPetSpellBonusDamage() to retrieve the new value. -`PET_SPELL_POWER_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_CLOSED.md b/wiki-information/events/PET_STABLE_CLOSED.md deleted file mode 100644 index 6ec4ba56..00000000 --- a/wiki-information/events/PET_STABLE_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_STABLE_CLOSED - -**Title:** PET STABLE CLOSED - -**Content:** -Needs summary. -`PET_STABLE_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_SHOW.md b/wiki-information/events/PET_STABLE_SHOW.md deleted file mode 100644 index b9e72115..00000000 --- a/wiki-information/events/PET_STABLE_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_STABLE_SHOW - -**Title:** PET STABLE SHOW - -**Content:** -Needs summary. -`PET_STABLE_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_UPDATE.md b/wiki-information/events/PET_STABLE_UPDATE.md deleted file mode 100644 index 78da64dd..00000000 --- a/wiki-information/events/PET_STABLE_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_STABLE_UPDATE - -**Title:** PET STABLE UPDATE - -**Content:** -Needs summary. -`PET_STABLE_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md b/wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md deleted file mode 100644 index 57eeaf99..00000000 --- a/wiki-information/events/PET_STABLE_UPDATE_PAPERDOLL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_STABLE_UPDATE_PAPERDOLL - -**Title:** PET STABLE UPDATE PAPERDOLL - -**Content:** -Needs summary. -`PET_STABLE_UPDATE_PAPERDOLL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_UI_CLOSE.md b/wiki-information/events/PET_UI_CLOSE.md deleted file mode 100644 index a1ba24da..00000000 --- a/wiki-information/events/PET_UI_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_UI_CLOSE - -**Title:** PET UI CLOSE - -**Content:** -Needs summary. -`PET_UI_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PET_UI_UPDATE.md b/wiki-information/events/PET_UI_UPDATE.md deleted file mode 100644 index 405bafdc..00000000 --- a/wiki-information/events/PET_UI_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PET_UI_UPDATE - -**Title:** PET UI UPDATE - -**Content:** -Needs summary. -`PET_UI_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md b/wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md deleted file mode 100644 index ff44f736..00000000 --- a/wiki-information/events/PLAYERBANKBAGSLOTS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYERBANKBAGSLOTS_CHANGED - -**Title:** PLAYERBANKBAGSLOTS CHANGED - -**Content:** -This event only fires when bank bags slots are purchased. It no longer fires when bags in the slots are changed. Instead, when the bags are changed, PLAYERBANKSLOTS_CHANGED will fire, and arg1 will be NUM_BANKGENERIC_SLOTS + BagIndex. -`PLAYERBANKBAGSLOTS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYERBANKSLOTS_CHANGED.md b/wiki-information/events/PLAYERBANKSLOTS_CHANGED.md deleted file mode 100644 index bb9cd0b2..00000000 --- a/wiki-information/events/PLAYERBANKSLOTS_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYERBANKSLOTS_CHANGED - -**Title:** PLAYERBANKSLOTS CHANGED - -**Content:** -Fired when the One of the slots in the player's 24 bank slots has changed, or when any of the equipped bank bags have changed. Does not fire when an item is added to or removed from a bank bag. -`PLAYERBANKSLOTS_CHANGED: slot` - -**Payload:** -- `slot` - - *number* - When (slot <= NUM_BANKGENERIC_SLOTS), slot is the index of the generic bank slot that changed. When (slot > NUM_BANKGENERIC_SLOTS), (slot - NUM_BANKGENERIC_SLOTS) is the index of the equipped bank bag that changed. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ALIVE.md b/wiki-information/events/PLAYER_ALIVE.md deleted file mode 100644 index 3828b88c..00000000 --- a/wiki-information/events/PLAYER_ALIVE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: PLAYER_ALIVE - -**Title:** PLAYER ALIVE - -**Content:** -Fired when the player releases from death to a graveyard; or accepts a resurrect before releasing their spirit. -`PLAYER_ALIVE` - -**Payload:** -- `None` - -**Content Details:** -Does not fire when the player is alive after being a ghost. PLAYER_UNGHOST is triggered in that case. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md b/wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md deleted file mode 100644 index cfa39227..00000000 --- a/wiki-information/events/PLAYER_AVG_ITEM_LEVEL_UPDATE.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: PLAYER_AVG_ITEM_LEVEL_UPDATE - -**Title:** PLAYER AVG ITEM LEVEL UPDATE - -**Content:** -This event fires when the player's item level changes, and it fires on both maximum item level changes (when you acquire a new piece of soulbound armor of your armor type that has the highest item level in that slot) and equipped item level changes (equipping or removing armor). This event will therefore fire when you gain azerite if it levels up your . -It fires three times in all of these scenarios: -Equipping armor in an empty slot -Removing armor to leave that slot empty -Equipping armor in a slot where it would automatically remove another armor -Using the equipment manager to equip and remove multiple pieces of armor at once. -The following scenarios still need to be tested to see if they cause this event to fire: -The player puts their highest item level armor in the bank or void storage -The player's equipped armor loses all durability -The player's highest item level armor loses all durability while in the player's inventory -`PLAYER_AVG_ITEM_LEVEL_UPDATE` - -**Payload:** -- `None - You'll have to find some other way to get the player's equipped or maximum item level.` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_CAMPING.md b/wiki-information/events/PLAYER_CAMPING.md deleted file mode 100644 index 4caef11c..00000000 --- a/wiki-information/events/PLAYER_CAMPING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_CAMPING - -**Title:** PLAYER CAMPING - -**Content:** -Fired when the player is camping (logging out). -`PLAYER_CAMPING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_CONTROL_GAINED.md b/wiki-information/events/PLAYER_CONTROL_GAINED.md deleted file mode 100644 index d03e8140..00000000 --- a/wiki-information/events/PLAYER_CONTROL_GAINED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_CONTROL_GAINED - -**Title:** PLAYER CONTROL GAINED - -**Content:** -Fires after the PLAYER_CONTROL_LOST event, when control has been restored to the player. -`PLAYER_CONTROL_GAINED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_CONTROL_LOST.md b/wiki-information/events/PLAYER_CONTROL_LOST.md deleted file mode 100644 index a2a2588d..00000000 --- a/wiki-information/events/PLAYER_CONTROL_LOST.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_CONTROL_LOST - -**Title:** PLAYER CONTROL LOST - -**Content:** -Fires whenever the player is unable to control the character. Examples are when afflicted by fear, mind controlled, or when using a taxi. -`PLAYER_CONTROL_LOST` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md b/wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md deleted file mode 100644 index 07d96ed0..00000000 --- a/wiki-information/events/PLAYER_DAMAGE_DONE_MODS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_DAMAGE_DONE_MODS - -**Title:** PLAYER DAMAGE DONE MODS - -**Content:** -Needs summary. -`PLAYER_DAMAGE_DONE_MODS: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_DEAD.md b/wiki-information/events/PLAYER_DEAD.md deleted file mode 100644 index 76b6b7fa..00000000 --- a/wiki-information/events/PLAYER_DEAD.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_DEAD - -**Title:** PLAYER DEAD - -**Content:** -Fired when the player has died. -`PLAYER_DEAD` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md b/wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md deleted file mode 100644 index 57217e56..00000000 --- a/wiki-information/events/PLAYER_DIFFICULTY_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_DIFFICULTY_CHANGED - -**Title:** PLAYER DIFFICULTY CHANGED - -**Content:** -Needs summary. -`PLAYER_DIFFICULTY_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md b/wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md deleted file mode 100644 index 60f1a970..00000000 --- a/wiki-information/events/PLAYER_ENTERING_BATTLEGROUND.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_ENTERING_BATTLEGROUND - -**Title:** PLAYER ENTERING BATTLEGROUND - -**Content:** -Needs summary. -`PLAYER_ENTERING_BATTLEGROUND` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ENTERING_WORLD.md b/wiki-information/events/PLAYER_ENTERING_WORLD.md deleted file mode 100644 index 4e506c2a..00000000 --- a/wiki-information/events/PLAYER_ENTERING_WORLD.md +++ /dev/null @@ -1,30 +0,0 @@ -## Event: PLAYER_ENTERING_WORLD - -**Title:** PLAYER ENTERING WORLD - -**Content:** -Fires when the player logs in, /reloads the UI or zones between map instances. Basically whenever the loading screen appears. -`PLAYER_ENTERING_WORLD: isInitialLogin, isReloadingUi` - -**Payload:** -- `isInitialLogin` - - *boolean* - True whenever the character logs in. This includes logging out to character select and then logging in again. -- `isReloadingUi` - - *boolean* - -**Usage:** -```lua -local function OnEvent(self, event, isLogin, isReload) - if isLogin or isReload then - print("loaded the UI") - else - print("zoned between map instances") - end -end -local f = CreateFrame("Frame") -f:RegisterEvent("PLAYER_ENTERING_WORLD") -f:SetScript("OnEvent", OnEvent) -``` - -**Related Information:** -AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ENTER_COMBAT.md b/wiki-information/events/PLAYER_ENTER_COMBAT.md deleted file mode 100644 index 69a1c3b1..00000000 --- a/wiki-information/events/PLAYER_ENTER_COMBAT.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PLAYER_ENTER_COMBAT - -**Title:** PLAYER ENTER COMBAT - -**Content:** -Fired when a player engages auto-attack. Note that firing a gun or a spell, or getting aggro, does NOT trigger this event. -`PLAYER_ENTER_COMBAT` - -**Payload:** -- `None` - -**Content Details:** -PLAYER_ENTER_COMBAT and PLAYER_LEAVE_COMBAT are for *MELEE* combat only. They fire when you initiate autoattack and when you turn it off. However, any spell or ability that does not turn on autoattack does not trigger it. Nor does it trigger when you get aggro. -You probably want PLAYER_REGEN_DISABLED (fires when you get aggro) and PLAYER_REGEN_ENABLED (fires when you lose aggro). \ No newline at end of file diff --git a/wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md b/wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md deleted file mode 100644 index 2ac6a8a1..00000000 --- a/wiki-information/events/PLAYER_EQUIPMENT_CHANGED.md +++ /dev/null @@ -1,18 +0,0 @@ -## Event: PLAYER_EQUIPMENT_CHANGED - -**Title:** PLAYER EQUIPMENT CHANGED - -**Content:** -This event is fired when the players gear changes. -`PLAYER_EQUIPMENT_CHANGED: equipmentSlot, hasCurrent` - -**Payload:** -- `equipmentSlot` - - *number* - InventorySlotId -- `hasCurrent` - - *boolean* - True when a slot becomes empty, false when filled. - -**Content Details:** -The second payload value was historically documented doing the reverse; true (1) when filled or false (nil) otherwise. -Modern FrameXML code labels the payload hasCurrent but does not actually use this payload, so the developer intent is unclear. -It is unknown if the return values in fact 'flipped' at some point, or if the early documentation was simply wrong. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md b/wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md deleted file mode 100644 index 49ab8184..00000000 --- a/wiki-information/events/PLAYER_FARSIGHT_FOCUS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_FARSIGHT_FOCUS_CHANGED - -**Title:** PLAYER FARSIGHT FOCUS CHANGED - -**Content:** -Needs summary. -`PLAYER_FARSIGHT_FOCUS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_FLAGS_CHANGED.md b/wiki-information/events/PLAYER_FLAGS_CHANGED.md deleted file mode 100644 index 4a68282f..00000000 --- a/wiki-information/events/PLAYER_FLAGS_CHANGED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PLAYER_FLAGS_CHANGED - -**Title:** PLAYER FLAGS CHANGED - -**Content:** -This event fires when a Unit's flags change (e.g. /afk, /dnd). -`PLAYER_FLAGS_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -WoW condenses simultaneous flag changes into a single event. If you are currently AFK and not(DND) but you type /dnd you'll see two Chat Log messages ("You are no longer AFK" and "You are now DND: Do Not Disturb") but you'll only see a single PLAYER_FLAGS_CHANGED event. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_FOCUS_CHANGED.md b/wiki-information/events/PLAYER_FOCUS_CHANGED.md deleted file mode 100644 index 7569f018..00000000 --- a/wiki-information/events/PLAYER_FOCUS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_FOCUS_CHANGED - -**Title:** PLAYER FOCUS CHANGED - -**Content:** -This event is fired whenever the player's focus target (/focus) is changed, including when the focus target is lost or cleared. -`PLAYER_FOCUS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md b/wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md deleted file mode 100644 index 41d23daa..00000000 --- a/wiki-information/events/PLAYER_GAINS_VEHICLE_DATA.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: PLAYER_GAINS_VEHICLE_DATA - -**Title:** PLAYER GAINS VEHICLE DATA - -**Content:** -Needs summary. -`PLAYER_GAINS_VEHICLE_DATA: unitTarget, vehicleUIIndicatorID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `vehicleUIIndicatorID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_GUILD_UPDATE.md b/wiki-information/events/PLAYER_GUILD_UPDATE.md deleted file mode 100644 index 67e8274c..00000000 --- a/wiki-information/events/PLAYER_GUILD_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_GUILD_UPDATE - -**Title:** PLAYER GUILD UPDATE - -**Content:** -This appears to be fired when a player is gkicked, gquits, etc. -`PLAYER_GUILD_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEAVE_COMBAT.md b/wiki-information/events/PLAYER_LEAVE_COMBAT.md deleted file mode 100644 index 84d5a67a..00000000 --- a/wiki-information/events/PLAYER_LEAVE_COMBAT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_LEAVE_COMBAT - -**Title:** PLAYER LEAVE COMBAT - -**Content:** -Fired when the player leaves combat through death, defeat of opponents, or an ability. Does not fire if a player flees from combat on foot. -`PLAYER_LEAVE_COMBAT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEAVING_WORLD.md b/wiki-information/events/PLAYER_LEAVING_WORLD.md deleted file mode 100644 index 74510d48..00000000 --- a/wiki-information/events/PLAYER_LEAVING_WORLD.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_LEAVING_WORLD - -**Title:** PLAYER LEAVING WORLD - -**Content:** -Fired when a player logs out and possibly at other situations as well. -`PLAYER_LEAVING_WORLD` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEVEL_CHANGED.md b/wiki-information/events/PLAYER_LEVEL_CHANGED.md deleted file mode 100644 index 5e34644c..00000000 --- a/wiki-information/events/PLAYER_LEVEL_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: PLAYER_LEVEL_CHANGED - -**Title:** PLAYER LEVEL CHANGED - -**Content:** -Needs summary. -`PLAYER_LEVEL_CHANGED: oldLevel, newLevel, real` - -**Payload:** -- `oldLevel` - - *number* -- `newLevel` - - *number* -- `real` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LEVEL_UP.md b/wiki-information/events/PLAYER_LEVEL_UP.md deleted file mode 100644 index 84edb941..00000000 --- a/wiki-information/events/PLAYER_LEVEL_UP.md +++ /dev/null @@ -1,27 +0,0 @@ -## Event: PLAYER_LEVEL_UP - -**Title:** PLAYER LEVEL UP - -**Content:** -Fired when a player levels up. -`PLAYER_LEVEL_UP: level, healthDelta, powerDelta, numNewTalents, numNewPvpTalentSlots, strengthDelta, agilityDelta, staminaDelta, intellectDelta` - -**Payload:** -- `level` - - *number* - New player level. -- `healthDelta` - - *number* - Hit points gained from leveling. -- `powerDelta` - - *number* - Mana points gained from leveling. -- `numNewTalents` - - *number* - Talent points gained from leveling. -- `numNewPvpTalentSlots` - - *number* -- `strengthDelta` - - *number* -- `agilityDelta` - - *number* -- `staminaDelta` - - *number* -- `intellectDelta` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LOGIN.md b/wiki-information/events/PLAYER_LOGIN.md deleted file mode 100644 index 9a3687fa..00000000 --- a/wiki-information/events/PLAYER_LOGIN.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: PLAYER_LOGIN - -**Title:** PLAYER LOGIN - -**Content:** -Triggered immediately before PLAYER_ENTERING_WORLD on login and UI Reload, but NOT when entering/leaving instances. -`PLAYER_LOGIN` - -**Payload:** -- `None` - -**Content Details:** -Related Events -`PLAYER_LOGOUT` - -**Related Information:** -AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LOGOUT.md b/wiki-information/events/PLAYER_LOGOUT.md deleted file mode 100644 index 079db261..00000000 --- a/wiki-information/events/PLAYER_LOGOUT.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PLAYER_LOGOUT - -**Title:** PLAYER LOGOUT - -**Content:** -Sent when the player logs out or the UI is reloaded, just before SavedVariables are saved. The event fires after PLAYER_LEAVING_WORLD. -`PLAYER_LOGOUT` - -**Payload:** -- `None` - -**Content Details:** -Related Events -- `PLAYER_LOGIN` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md b/wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md deleted file mode 100644 index 7b5a7e6f..00000000 --- a/wiki-information/events/PLAYER_LOSES_VEHICLE_DATA.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_LOSES_VEHICLE_DATA - -**Title:** PLAYER LOSES VEHICLE DATA - -**Content:** -Needs summary. -`PLAYER_LOSES_VEHICLE_DATA: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_MONEY.md b/wiki-information/events/PLAYER_MONEY.md deleted file mode 100644 index f43463ab..00000000 --- a/wiki-information/events/PLAYER_MONEY.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: PLAYER_MONEY - -**Title:** PLAYER MONEY - -**Content:** -Fired whenever the player gains or loses money. -`PLAYER_MONEY` - -**Payload:** -- `None` - -**Content Details:** -To get the amount of money earned/lost, you'll need to save the return value from GetMoney from the last time PLAYER_MONEY fired and compare it to the new return value from GetMoney. - -**Usage:** -Egingell:PLAYER_MONEY \ No newline at end of file diff --git a/wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md b/wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md deleted file mode 100644 index dd435a7c..00000000 --- a/wiki-information/events/PLAYER_MOUNT_DISPLAY_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_MOUNT_DISPLAY_CHANGED - -**Title:** PLAYER MOUNT DISPLAY CHANGED - -**Content:** -Needs summary. -`PLAYER_MOUNT_DISPLAY_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md b/wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md deleted file mode 100644 index a12c1da9..00000000 --- a/wiki-information/events/PLAYER_PVP_KILLS_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_PVP_KILLS_CHANGED - -**Title:** PLAYER PVP KILLS CHANGED - -**Content:** -Fired when you get credit for killing an enemy player. Only honorable kills will trigger this event. -`PLAYER_PVP_KILLS_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_PVP_RANK_CHANGED.md b/wiki-information/events/PLAYER_PVP_RANK_CHANGED.md deleted file mode 100644 index 90353336..00000000 --- a/wiki-information/events/PLAYER_PVP_RANK_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_PVP_RANK_CHANGED - -**Title:** PLAYER PVP RANK CHANGED - -**Content:** -Needs summary. -`PLAYER_PVP_RANK_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_QUITING.md b/wiki-information/events/PLAYER_QUITING.md deleted file mode 100644 index 4e9b6c1e..00000000 --- a/wiki-information/events/PLAYER_QUITING.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PLAYER_QUITING - -**Title:** PLAYER QUITING - -**Content:** -Fired when the player tries to quit, as opposed to logout, while outside an inn. -`PLAYER_QUITING` - -**Payload:** -- `None` - -**Content Details:** -The dialog which appears after this event, has choices of "Exit Now" or "Cancel". -The dialog from PLAYER_CAMPING which appears when you try to logout outside an inn, only has a "Cancel" choice. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_REGEN_DISABLED.md b/wiki-information/events/PLAYER_REGEN_DISABLED.md deleted file mode 100644 index cf23084b..00000000 --- a/wiki-information/events/PLAYER_REGEN_DISABLED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PLAYER_REGEN_DISABLED - -**Title:** PLAYER REGEN DISABLED - -**Content:** -Fired whenever you enter combat, as normal regen rates are disabled during combat. This means that either you are in the hate list of a NPC or that you've been taking part in a pvp action (either as attacker or victim). -`PLAYER_REGEN_DISABLED` - -**Payload:** -- `None` - -**Content Details:** -Related Events -PLAYER_REGEN_ENABLED \ No newline at end of file diff --git a/wiki-information/events/PLAYER_REGEN_ENABLED.md b/wiki-information/events/PLAYER_REGEN_ENABLED.md deleted file mode 100644 index 76d275f8..00000000 --- a/wiki-information/events/PLAYER_REGEN_ENABLED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PLAYER_REGEN_ENABLED - -**Title:** PLAYER REGEN ENABLED - -**Content:** -Fired after ending combat, as regen rates return to normal. Useful for determining when a player has left combat. This occurs when you are not on the hate list of any NPC, or a few seconds after the latest pvp attack that you were involved with. -`PLAYER_REGEN_ENABLED` - -**Payload:** -- `None` - -**Content Details:** -Related Events -- `PLAYER_REGEN_DISABLED` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_REPORT_SUBMITTED.md b/wiki-information/events/PLAYER_REPORT_SUBMITTED.md deleted file mode 100644 index 73581ac9..00000000 --- a/wiki-information/events/PLAYER_REPORT_SUBMITTED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_REPORT_SUBMITTED - -**Title:** PLAYER REPORT SUBMITTED - -**Content:** -Needs summary. -`PLAYER_REPORT_SUBMITTED: invitedByGUID` - -**Payload:** -- `invitedByGUID` - - *string* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_ROLES_ASSIGNED.md b/wiki-information/events/PLAYER_ROLES_ASSIGNED.md deleted file mode 100644 index 50ea750a..00000000 --- a/wiki-information/events/PLAYER_ROLES_ASSIGNED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_ROLES_ASSIGNED - -**Title:** PLAYER ROLES ASSIGNED - -**Content:** -Needs summary. -`PLAYER_ROLES_ASSIGNED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_SKINNED.md b/wiki-information/events/PLAYER_SKINNED.md deleted file mode 100644 index a16b2fb3..00000000 --- a/wiki-information/events/PLAYER_SKINNED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_SKINNED - -**Title:** PLAYER SKINNED - -**Content:** -Fired when the player's insignia is removed in a Battleground. -`PLAYER_SKINNED: hasFreeRepop` - -**Payload:** -- `hasFreeRepop` - - *number* \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STARTED_LOOKING.md b/wiki-information/events/PLAYER_STARTED_LOOKING.md deleted file mode 100644 index 52ebab4e..00000000 --- a/wiki-information/events/PLAYER_STARTED_LOOKING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_STARTED_LOOKING - -**Title:** PLAYER STARTED LOOKING - -**Content:** -Fires when the camera starts free looking by clicking the left mouse button in the game world. -`PLAYER_STARTED_LOOKING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STARTED_MOVING.md b/wiki-information/events/PLAYER_STARTED_MOVING.md deleted file mode 100644 index 2898c41d..00000000 --- a/wiki-information/events/PLAYER_STARTED_MOVING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_STARTED_MOVING - -**Title:** PLAYER STARTED MOVING - -**Content:** -Needs summary. -`PLAYER_STARTED_MOVING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STARTED_TURNING.md b/wiki-information/events/PLAYER_STARTED_TURNING.md deleted file mode 100644 index 9c9cde56..00000000 --- a/wiki-information/events/PLAYER_STARTED_TURNING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_STARTED_TURNING - -**Title:** PLAYER STARTED TURNING - -**Content:** -Fires when the player starts turning by clicking the right mouse button in the game world. -`PLAYER_STARTED_TURNING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STOPPED_LOOKING.md b/wiki-information/events/PLAYER_STOPPED_LOOKING.md deleted file mode 100644 index 4f2168fb..00000000 --- a/wiki-information/events/PLAYER_STOPPED_LOOKING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_STOPPED_LOOKING - -**Title:** PLAYER STOPPED LOOKING - -**Content:** -Fires when the camera stops free looking by releasing the left mouse button. -`PLAYER_STOPPED_LOOKING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STOPPED_MOVING.md b/wiki-information/events/PLAYER_STOPPED_MOVING.md deleted file mode 100644 index ea9d04d3..00000000 --- a/wiki-information/events/PLAYER_STOPPED_MOVING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_STOPPED_MOVING - -**Title:** PLAYER STOPPED MOVING - -**Content:** -Needs summary. -`PLAYER_STOPPED_MOVING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_STOPPED_TURNING.md b/wiki-information/events/PLAYER_STOPPED_TURNING.md deleted file mode 100644 index 381e5f25..00000000 --- a/wiki-information/events/PLAYER_STOPPED_TURNING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_STOPPED_TURNING - -**Title:** PLAYER STOPPED TURNING - -**Content:** -Fires when the player stops turning by releasing the right mouse button. -`PLAYER_STOPPED_TURNING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TALENT_UPDATE.md b/wiki-information/events/PLAYER_TALENT_UPDATE.md deleted file mode 100644 index 22a5711e..00000000 --- a/wiki-information/events/PLAYER_TALENT_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: PLAYER_TALENT_UPDATE - -**Title:** PLAYER TALENT UPDATE - -**Content:** -Fired when the player changes between dual talent specs, and possibly when learning or unlearning talents and when a player levels up, before PLAYER_LEVEL_UP is fired. -`PLAYER_TALENT_UPDATE` - -**Payload:** -- `None` - -**Related Information:** -CHARACTER_POINTS_CHANGED - For Classic \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TARGET_CHANGED.md b/wiki-information/events/PLAYER_TARGET_CHANGED.md deleted file mode 100644 index 3429651c..00000000 --- a/wiki-information/events/PLAYER_TARGET_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_TARGET_CHANGED - -**Title:** PLAYER TARGET CHANGED - -**Content:** -This event is fired whenever the player's target is changed, including when the target is lost. -`PLAYER_TARGET_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md b/wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md deleted file mode 100644 index aeec028f..00000000 --- a/wiki-information/events/PLAYER_TARGET_SET_ATTACKING.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: PLAYER_TARGET_SET_ATTACKING - -**Title:** PLAYER TARGET SET ATTACKING - -**Content:** -Fired when the player enables autoattack. -`PLAYER_TARGET_SET_ATTACKING: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -This can occur when: -- IsCurrentSpell(6603) (where 6603 is the autoattack spell) changes from false to true -- The player changes target while autoattack is active. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TOTEM_UPDATE.md b/wiki-information/events/PLAYER_TOTEM_UPDATE.md deleted file mode 100644 index 5a25fe82..00000000 --- a/wiki-information/events/PLAYER_TOTEM_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_TOTEM_UPDATE - -**Title:** PLAYER TOTEM UPDATE - -**Content:** -This event fires whenever a totem is dropped (cast) or destroyed (either recalled or killed). -`PLAYER_TOTEM_UPDATE: totemSlot` - -**Payload:** -- `totemSlot` - - *number* - The number of the totem slot (1-4) affected by the update. See `GetTotemInfo`. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TRADE_MONEY.md b/wiki-information/events/PLAYER_TRADE_MONEY.md deleted file mode 100644 index e3e2433c..00000000 --- a/wiki-information/events/PLAYER_TRADE_MONEY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_TRADE_MONEY - -**Title:** PLAYER TRADE MONEY - -**Content:** -Fired when the player trades money. -`PLAYER_TRADE_MONEY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md b/wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md deleted file mode 100644 index 97803c33..00000000 --- a/wiki-information/events/PLAYER_TRIAL_XP_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_TRIAL_XP_UPDATE - -**Title:** PLAYER TRIAL XP UPDATE - -**Content:** -Needs summary. -`PLAYER_TRIAL_XP_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAYER_UNGHOST.md b/wiki-information/events/PLAYER_UNGHOST.md deleted file mode 100644 index 125190db..00000000 --- a/wiki-information/events/PLAYER_UNGHOST.md +++ /dev/null @@ -1,18 +0,0 @@ -## Event: PLAYER_UNGHOST - -**Title:** PLAYER UNGHOST - -**Content:** -Fired when the player is alive after being a ghost. -`PLAYER_UNGHOST` - -**Payload:** -- `None` - -**Content Details:** -The player is alive when this event happens. Does not fire when the player is resurrected before releasing. PLAYER_ALIVE is triggered in that case. -Fires after one of: -- Performing a successful corpse run and the player accepts the 'Resurrect Now' box. -- Accepting a resurrect from another player after releasing from a death. -- Zoning into an instance where the player is dead. -- When the player accept a resurrect from a Spirit Healer. \ No newline at end of file diff --git a/wiki-information/events/PLAYER_UPDATE_RESTING.md b/wiki-information/events/PLAYER_UPDATE_RESTING.md deleted file mode 100644 index f166fd7d..00000000 --- a/wiki-information/events/PLAYER_UPDATE_RESTING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PLAYER_UPDATE_RESTING - -**Title:** PLAYER UPDATE RESTING - -**Content:** -Fired when the player starts or stops resting, i.e. when entering/leaving inns/major towns. -`PLAYER_UPDATE_RESTING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PLAYER_XP_UPDATE.md b/wiki-information/events/PLAYER_XP_UPDATE.md deleted file mode 100644 index 7ad8d6ac..00000000 --- a/wiki-information/events/PLAYER_XP_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PLAYER_XP_UPDATE - -**Title:** PLAYER XP UPDATE - -**Content:** -Fired when the player's XP is updated (due quest completion or killing). -`PLAYER_XP_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PLAY_MOVIE.md b/wiki-information/events/PLAY_MOVIE.md deleted file mode 100644 index 8daf6f59..00000000 --- a/wiki-information/events/PLAY_MOVIE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: PLAY_MOVIE - -**Title:** PLAY MOVIE - -**Content:** -Fires when a pre-rendered movie should be played. -`PLAY_MOVIE: movieID` - -**Payload:** -- `movieID` - - *number* : MovieID - -**Related Information:** -MovieFrame_PlayMovie() \ No newline at end of file diff --git a/wiki-information/events/PORTRAITS_UPDATED.md b/wiki-information/events/PORTRAITS_UPDATED.md deleted file mode 100644 index 2ae856fc..00000000 --- a/wiki-information/events/PORTRAITS_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PORTRAITS_UPDATED - -**Title:** PORTRAITS UPDATED - -**Content:** -Needs summary. -`PORTRAITS_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PVP_RATED_STATS_UPDATE.md b/wiki-information/events/PVP_RATED_STATS_UPDATE.md deleted file mode 100644 index fc4b9cb6..00000000 --- a/wiki-information/events/PVP_RATED_STATS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PVP_RATED_STATS_UPDATE - -**Title:** PVP RATED STATS UPDATE - -**Content:** -Needs summary. -`PVP_RATED_STATS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/PVP_TIMER_UPDATE.md b/wiki-information/events/PVP_TIMER_UPDATE.md deleted file mode 100644 index 95a0a85c..00000000 --- a/wiki-information/events/PVP_TIMER_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: PVP_TIMER_UPDATE - -**Title:** PVP TIMER UPDATE - -**Content:** -Needs summary. -`PVP_TIMER_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/PVP_WORLDSTATE_UPDATE.md b/wiki-information/events/PVP_WORLDSTATE_UPDATE.md deleted file mode 100644 index 6e4dc460..00000000 --- a/wiki-information/events/PVP_WORLDSTATE_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: PVP_WORLDSTATE_UPDATE - -**Title:** PVP WORLDSTATE UPDATE - -**Content:** -Needs summary. -`PVP_WORLDSTATE_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_ACCEPTED.md b/wiki-information/events/QUEST_ACCEPTED.md deleted file mode 100644 index edaede93..00000000 --- a/wiki-information/events/QUEST_ACCEPTED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: QUEST_ACCEPTED - -**Title:** QUEST ACCEPTED - -**Content:** -Fires whenever the player accepts a quest. -`QUEST_ACCEPTED: questId` - -**Payload:** -- `questLogIndex` - - *number* - Classic only. Index of the quest in the quest log. You may pass this to `GetQuestLogTitle()` for information about the accepted quest. -- `questID` - - *number* - QuestID of the accepted quest. \ No newline at end of file diff --git a/wiki-information/events/QUEST_ACCEPT_CONFIRM.md b/wiki-information/events/QUEST_ACCEPT_CONFIRM.md deleted file mode 100644 index 52b12f0c..00000000 --- a/wiki-information/events/QUEST_ACCEPT_CONFIRM.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: QUEST_ACCEPT_CONFIRM - -**Title:** QUEST ACCEPT CONFIRM - -**Content:** -This event fires when an escort quest is started by another player. A dialog appears asking if the player also wants to start the quest. -`QUEST_ACCEPT_CONFIRM: name, questTitle` - -**Payload:** -- `name` - - *string* - Name of player who is starting escort quest. -- `questTitle` - - *string* - Title of escort quest. Eg. "Protecting the Shipment" \ No newline at end of file diff --git a/wiki-information/events/QUEST_AUTOCOMPLETE.md b/wiki-information/events/QUEST_AUTOCOMPLETE.md deleted file mode 100644 index fdecfc1b..00000000 --- a/wiki-information/events/QUEST_AUTOCOMPLETE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: QUEST_AUTOCOMPLETE - -**Title:** QUEST AUTOCOMPLETE - -**Content:** -Fires when a quest that can be auto-completed is completed. -`QUEST_AUTOCOMPLETE: questId` - -**Payload:** -- `questId` - - *number* - -**Content Details:** -Quests eligible for auto-completion do not need to be handed in to a specific NPC; instead, the player can complete the quest, receive the rewards, and remove it from their quest log anywhere in the world. -Use `ShowQuestComplete` in conjunction with `GetQuestLogIndexByID` to display the quest completion dialog, allowing use of `GetQuestReward` after `QUEST_COMPLETE` has fired. \ No newline at end of file diff --git a/wiki-information/events/QUEST_BOSS_EMOTE.md b/wiki-information/events/QUEST_BOSS_EMOTE.md deleted file mode 100644 index d2a5621a..00000000 --- a/wiki-information/events/QUEST_BOSS_EMOTE.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: QUEST_BOSS_EMOTE - -**Title:** QUEST BOSS EMOTE - -**Content:** -Needs summary. -`QUEST_BOSS_EMOTE: text, playerName, displayTime, enableBossEmoteWarningSound` - -**Payload:** -- `text` - - *string* -- `playerName` - - *string* -- `displayTime` - - *number* -- `enableBossEmoteWarningSound` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_COMPLETE.md b/wiki-information/events/QUEST_COMPLETE.md deleted file mode 100644 index 58767447..00000000 --- a/wiki-information/events/QUEST_COMPLETE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_COMPLETE - -**Title:** QUEST COMPLETE - -**Content:** -Fired after the player hits the "Continue" button in the quest-information page, before the "Complete Quest" button. In other words, it fires when you are given the option to complete a quest, but just before you actually complete the quest. -`QUEST_COMPLETE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_DETAIL.md b/wiki-information/events/QUEST_DETAIL.md deleted file mode 100644 index fb8750e8..00000000 --- a/wiki-information/events/QUEST_DETAIL.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: QUEST_DETAIL - -**Title:** QUEST DETAIL - -**Content:** -Fired when the player is given a more detailed view of his quest. -`QUEST_DETAIL: questStartItemID` - -**Payload:** -- `questStartItemID` - - *number?* - The ItemID of the item which begins the quest displayed in the quest detail view. - -**Content Details:** -To get the quest that is currently displayed use (tested with 10.0.5): -`questID = GetQuestID()` \ No newline at end of file diff --git a/wiki-information/events/QUEST_FINISHED.md b/wiki-information/events/QUEST_FINISHED.md deleted file mode 100644 index 568e4c25..00000000 --- a/wiki-information/events/QUEST_FINISHED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_FINISHED - -**Title:** QUEST FINISHED - -**Content:** -Fired whenever the quest frame changes (from Detail to Progress to Reward, etc.) or is closed. -`QUEST_FINISHED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_GREETING.md b/wiki-information/events/QUEST_GREETING.md deleted file mode 100644 index 7db90f40..00000000 --- a/wiki-information/events/QUEST_GREETING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_GREETING - -**Title:** QUEST GREETING - -**Content:** -Fired when talking to an NPC that offers or accepts more than one quest, i.e. has more than one active or available quest. -`QUEST_GREETING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_ITEM_UPDATE.md b/wiki-information/events/QUEST_ITEM_UPDATE.md deleted file mode 100644 index aa1c1fa0..00000000 --- a/wiki-information/events/QUEST_ITEM_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_ITEM_UPDATE - -**Title:** QUEST ITEM UPDATE - -**Content:** -Fired when the quest items are updated. -`QUEST_ITEM_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_LOG_UPDATE.md b/wiki-information/events/QUEST_LOG_UPDATE.md deleted file mode 100644 index d3e97ecd..00000000 --- a/wiki-information/events/QUEST_LOG_UPDATE.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: QUEST_LOG_UPDATE - -**Title:** QUEST LOG UPDATE - -**Content:** -Fires when the quest log updates. -`QUEST_LOG_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -Toggle `QuestMapFrame.ignoreQuestLogUpdate` to suppress the normal event handler. -This event fires very often: -- Viewing a quest for the first time in a session -- Changing zones across an instance boundary -- Picking up a non-grey item -- Completing a quest objective -- Expanding or collapsing headers in the quest log. \ No newline at end of file diff --git a/wiki-information/events/QUEST_PROGRESS.md b/wiki-information/events/QUEST_PROGRESS.md deleted file mode 100644 index 030b912f..00000000 --- a/wiki-information/events/QUEST_PROGRESS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_PROGRESS - -**Title:** QUEST PROGRESS - -**Content:** -Fired when a player is talking to an NPC about the status of a quest and has not yet clicked the complete button. -`QUEST_PROGRESS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_REMOVED.md b/wiki-information/events/QUEST_REMOVED.md deleted file mode 100644 index 460ecb23..00000000 --- a/wiki-information/events/QUEST_REMOVED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: QUEST_REMOVED - -**Title:** QUEST REMOVED - -**Content:** -Needs summary. -`QUEST_REMOVED: questID, wasReplayQuest` - -**Payload:** -- `questID` - - *number* -- `wasReplayQuest` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_CREATED.md b/wiki-information/events/QUEST_SESSION_CREATED.md deleted file mode 100644 index 2f279f00..00000000 --- a/wiki-information/events/QUEST_SESSION_CREATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_SESSION_CREATED - -**Title:** QUEST SESSION CREATED - -**Content:** -Fires upon starting a Party Sync session. -`QUEST_SESSION_CREATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_DESTROYED.md b/wiki-information/events/QUEST_SESSION_DESTROYED.md deleted file mode 100644 index c35e1ad8..00000000 --- a/wiki-information/events/QUEST_SESSION_DESTROYED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_SESSION_DESTROYED - -**Title:** QUEST SESSION DESTROYED - -**Content:** -Fires upon terminating a Party Sync session. -`QUEST_SESSION_CREATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md b/wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md deleted file mode 100644 index fa5f1274..00000000 --- a/wiki-information/events/QUEST_SESSION_ENABLED_STATE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: QUEST_SESSION_ENABLED_STATE_CHANGED - -**Title:** QUEST SESSION ENABLED STATE CHANGED - -**Content:** -Needs summary. -`QUEST_SESSION_ENABLED_STATE_CHANGED: enabled` - -**Payload:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_JOINED.md b/wiki-information/events/QUEST_SESSION_JOINED.md deleted file mode 100644 index 281c0f7d..00000000 --- a/wiki-information/events/QUEST_SESSION_JOINED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: QUEST_SESSION_JOINED - -**Title:** QUEST SESSION JOINED - -**Content:** -Fires upon joining a Party Sync session. -`QUEST_SESSION_CREATED` - -**Payload:** -- `None` - -**Related Information:** -QUEST_SESSION_LEFT -QUEST_SESSION_CREATED \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_LEFT.md b/wiki-information/events/QUEST_SESSION_LEFT.md deleted file mode 100644 index ed167bcb..00000000 --- a/wiki-information/events/QUEST_SESSION_LEFT.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: QUEST_SESSION_LEFT - -**Title:** QUEST SESSION LEFT - -**Content:** -Fires upon leaving a Party Sync session. -`QUEST_SESSION_CREATED` - -**Payload:** -- `None` - -**Related Information:** -QUEST_SESSION_JOINED -QUEST_SESSION_DESTROYED \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md b/wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md deleted file mode 100644 index 4cde1cbd..00000000 --- a/wiki-information/events/QUEST_SESSION_MEMBER_CONFIRM.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUEST_SESSION_MEMBER_CONFIRM - -**Title:** QUEST SESSION MEMBER CONFIRM - -**Content:** -Needs summary. -`QUEST_SESSION_MEMBER_CONFIRM` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md b/wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md deleted file mode 100644 index 4c3b8ad5..00000000 --- a/wiki-information/events/QUEST_SESSION_MEMBER_START_RESPONSE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: QUEST_SESSION_MEMBER_START_RESPONSE - -**Title:** QUEST SESSION MEMBER START RESPONSE - -**Content:** -Needs summary. -`QUEST_SESSION_MEMBER_START_RESPONSE: guid, response` - -**Payload:** -- `guid` - - *string* -- `response` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/QUEST_SESSION_NOTIFICATION.md b/wiki-information/events/QUEST_SESSION_NOTIFICATION.md deleted file mode 100644 index 6f463cce..00000000 --- a/wiki-information/events/QUEST_SESSION_NOTIFICATION.md +++ /dev/null @@ -1,124 +0,0 @@ -## Event: QUEST_SESSION_NOTIFICATION - -**Title:** QUEST SESSION NOTIFICATION - -**Content:** -Fires with a Party Sync notification. -`QUEST_SESSION_NOTIFICATION: result, guid` - -**Payload:** -- `result` - - *Enum.QuestSessionResult* -- `guid` - - *string* - The player triggering the notification. - - *Enum.QuestSessionResult* - - **Value** - - **Type** - - **Description** - - 0 - - Ok - - No notification message. - - 1 - - NotInParty - - "You are not in a party." - - 2 - - InvalidOwner - - "%s cannot participate in Party Sync." - - 3 - - AlreadyActive - - "Party sync is already active." - - 4 - - NotActive - - "Party Sync is not active." - - 5 - - InRaid - - "You are in a raid." - - 6 - - OwnerRefused - - "%s declined the Party Sync request." - - 7 - - Timeout - - "The Party Sync request timed out." - - 8 - - Disabled - - "Party Sync is currently disabled." - - 9 - - Started - - "Party Sync activated." - - 10 - - Stopped - - "Party Sync ended." - - 11 - - Joined - - No notification message. - - 12 - - Left - - "You left the Party Sync." - - 13 - - OwnerLeft - - "Party Sync ended." - - 14 - - ReadyCheckFailed - - "A party member declined the Party Sync request." - - 15 - - PartyDestroyed - - "Party Sync ended." - - 16 - - MemberTimeout - - No notification message. - - 17 - - AlreadyMember - - "You are already in Party Sync." - - 18 - - NotOwner - - "You are not the owner of the Party Sync." - - 19 - - AlreadyOwner - - "You are already in Party Sync. - - 20 - - AlreadyJoined - - "You are already in Party Sync." - - 21 - - NotMember - - "You are already in Party Sync." - - 22 - - Busy - - "Party Sync is busy." - - 23 - - JoinRejected - - "Your request to join the Party Sync was denied." - - 24 - - Logout - - No notification message. - - 25 - - Empty - - No notification message. - - 26 - - QuestNotCompleted - - "Party Sync failed to start because a party member has not completed their starting quests." - - 27 - - Resync - - "Quests have been re-synced." - - 28 - - Restricted - - "Party Sync failed to start because a party member is on a Class Trial." - - 29 - - InPetBattle - - "Party Sync failed to start because a party member is in a pet battle." - - 30 - - InvalidPublicParty - - "An unknown error has occurred while attempting to activate Party Sync." - - 31 - - Unknown - - "An unknown error has occurred while attempting to activate Party Sync." - - 32 - - InCombat - - "You cannot start Party Sync because you are in combat." - - 33 - - MemberInCombat - - "You cannot join a Party Sync if a member of the party is in combat." - -**Patch Updates:** -Patch 9.0.5 (2021-03-09): Added MemberInCombat field. -Patch 9.0.1 (2020-10-13): Added InCombat field. -Patch 8.2.5 (2019-09-24): Added. \ No newline at end of file diff --git a/wiki-information/events/QUEST_TURNED_IN.md b/wiki-information/events/QUEST_TURNED_IN.md deleted file mode 100644 index 3d36a38d..00000000 --- a/wiki-information/events/QUEST_TURNED_IN.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: QUEST_TURNED_IN - -**Title:** QUEST TURNED IN - -**Content:** -This event fires whenever the player turns in a quest, whether automatically with a Task-type quest (Bonus Objectives/World Quests), or by pressing the Complete button in a quest dialog window. -`QUEST_TURNED_IN: questID, xpReward, moneyReward` - -**Payload:** -- `questID` - - *number* - QuestID of the quest accepted. -- `xpReward` - - *number* - Number of Experience point awarded, if any. Zero if character is max level. -- `moneyReward` - - *number* - Amount of Money awarded, if any. Amount in coppers. \ No newline at end of file diff --git a/wiki-information/events/QUEST_WATCH_LIST_CHANGED.md b/wiki-information/events/QUEST_WATCH_LIST_CHANGED.md deleted file mode 100644 index d19bd43d..00000000 --- a/wiki-information/events/QUEST_WATCH_LIST_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: QUEST_WATCH_LIST_CHANGED - -**Title:** QUEST WATCH LIST CHANGED - -**Content:** -Needs summary. -`QUEST_WATCH_LIST_CHANGED: questID, added` - -**Payload:** -- `questID` - - *number?* -- `added` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/QUEST_WATCH_UPDATE.md b/wiki-information/events/QUEST_WATCH_UPDATE.md deleted file mode 100644 index 4a89ebe4..00000000 --- a/wiki-information/events/QUEST_WATCH_UPDATE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: QUEST_WATCH_UPDATE - -**Title:** QUEST WATCH UPDATE - -**Content:** -Seems to fire each time the objectives of the quest with the supplied questID update, i.e. whenever a partial objective has been accomplished: killing a mob, looting a quest item etc. -`QUEST_WATCH_UPDATE: questID` - -**Payload:** -- `questID` - - *number* - -**Content Details:** -UNIT_QUEST_LOG_CHANGED and QUEST_LOG_UPDATE both also seem to fire consistently – in that order – after each QUEST_WATCH_UPDATE. \ No newline at end of file diff --git a/wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md b/wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md deleted file mode 100644 index e1f3fc16..00000000 --- a/wiki-information/events/QUICK_TICKET_SYSTEM_STATUS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUICK_TICKET_SYSTEM_STATUS - -**Title:** QUICK TICKET SYSTEM STATUS - -**Content:** -Needs summary. -`QUICK_TICKET_SYSTEM_STATUS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md b/wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md deleted file mode 100644 index 22bff7d1..00000000 --- a/wiki-information/events/QUICK_TICKET_THROTTLE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: QUICK_TICKET_THROTTLE_CHANGED - -**Title:** QUICK TICKET THROTTLE CHANGED - -**Content:** -Needs summary. -`QUICK_TICKET_THROTTLE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md b/wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md deleted file mode 100644 index c0516b9b..00000000 --- a/wiki-information/events/RAF_ENTITLEMENT_DELIVERED.md +++ /dev/null @@ -1,41 +0,0 @@ -## Event: RAF_ENTITLEMENT_DELIVERED - -**Title:** RAF ENTITLEMENT DELIVERED - -**Content:** -Needs summary. -`RAF_ENTITLEMENT_DELIVERED: entitlementType, textureID, name, payloadID, showFancyToast, rafVersion` - -**Payload:** -- `entitlementType` - - *Enum.WoWEntitlementType* - - - Value - - Field - - Description - - 0 - Item - - 1 - Mount - - 2 - Battlepet - - 3 - Toy - - 4 - Appearance - - 5 - AppearanceSet - - 6 - GameTime - - 7 - Title - - 8 - Illusion - - 9 - Invalid -- `textureID` - - *number* -- `name` - - *string* -- `payloadID` - - *number?* -- `showFancyToast` - - *boolean* -- `rafVersion` - - *Enum.RecruitAFriendRewardsVersion* - - - Value - - Field - - Description - - 0 - InvalidVersion - - 1 - UnusedVersionOne - - 2 - VersionTwo - - 3 - VersionThree \ No newline at end of file diff --git a/wiki-information/events/RAID_BOSS_EMOTE.md b/wiki-information/events/RAID_BOSS_EMOTE.md deleted file mode 100644 index 272e7fdb..00000000 --- a/wiki-information/events/RAID_BOSS_EMOTE.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: RAID_BOSS_EMOTE - -**Title:** RAID BOSS EMOTE - -**Content:** -Needs summary. -`RAID_BOSS_EMOTE: text, playerName, displayTime, enableBossEmoteWarningSound` - -**Payload:** -- `text` - - *string* -- `playerName` - - *string* -- `displayTime` - - *number* -- `enableBossEmoteWarningSound` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RAID_BOSS_WHISPER.md b/wiki-information/events/RAID_BOSS_WHISPER.md deleted file mode 100644 index 56082bfc..00000000 --- a/wiki-information/events/RAID_BOSS_WHISPER.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: RAID_BOSS_WHISPER - -**Title:** RAID BOSS WHISPER - -**Content:** -Needs summary. -`RAID_BOSS_WHISPER: text, playerName, displayTime, enableBossEmoteWarningSound` - -**Payload:** -- `text` - - *string* -- `playerName` - - *string* -- `displayTime` - - *number* -- `enableBossEmoteWarningSound` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RAID_INSTANCE_WELCOME.md b/wiki-information/events/RAID_INSTANCE_WELCOME.md deleted file mode 100644 index 285b1565..00000000 --- a/wiki-information/events/RAID_INSTANCE_WELCOME.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: RAID_INSTANCE_WELCOME - -**Title:** RAID INSTANCE WELCOME - -**Content:** -Fired when the player enters an instance that saves raid members after a boss is killed. -`RAID_INSTANCE_WELCOME: mapname, timeLeft, locked, extended` - -**Payload:** -- `mapname` - - *string* - instance name -- `timeLeft` - - *number* - seconds until reset -- `locked` - - *number* -- `extended` - - *number* \ No newline at end of file diff --git a/wiki-information/events/RAID_ROSTER_UPDATE.md b/wiki-information/events/RAID_ROSTER_UPDATE.md deleted file mode 100644 index 89486769..00000000 --- a/wiki-information/events/RAID_ROSTER_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: RAID_ROSTER_UPDATE - -**Title:** RAID ROSTER UPDATE - -**Content:** -Fired whenever a raid is formed or disbanded, players are leaving or joining a raid, or when looting rules are changed (regardless of being in raid or party). -`RAID_ROSTER_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/RAID_TARGET_UPDATE.md b/wiki-information/events/RAID_TARGET_UPDATE.md deleted file mode 100644 index bc30bd81..00000000 --- a/wiki-information/events/RAID_TARGET_UPDATE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: RAID_TARGET_UPDATE - -**Title:** RAID TARGET UPDATE - -**Content:** -Fired when a raid target icon is changed or removed. Also fired when player join or leave a party or raid. -`RAID_TARGET_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -Does not get triggered if a mob wearing a raid target icon dies (the icon is removed from that mob, however.) -Related API -GetRaidTargetIndex • SetRaidTarget \ No newline at end of file diff --git a/wiki-information/events/RAISED_AS_GHOUL.md b/wiki-information/events/RAISED_AS_GHOUL.md deleted file mode 100644 index 73525141..00000000 --- a/wiki-information/events/RAISED_AS_GHOUL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: RAISED_AS_GHOUL - -**Title:** RAISED AS GHOUL - -**Content:** -Needs summary. -`RAISED_AS_GHOUL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/READY_CHECK.md b/wiki-information/events/READY_CHECK.md deleted file mode 100644 index 12235b28..00000000 --- a/wiki-information/events/READY_CHECK.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: READY_CHECK - -**Title:** READY CHECK - -**Content:** -Fired when a Ready Check is performed by the raid (or party) leader. -`READY_CHECK: initiatorName, readyCheckTimeLeft` - -**Payload:** -- `initiatorName` - - *string* -- `readyCheckTimeLeft` - - *number* - Time before automatic check completion in seconds (usually 30). \ No newline at end of file diff --git a/wiki-information/events/READY_CHECK_CONFIRM.md b/wiki-information/events/READY_CHECK_CONFIRM.md deleted file mode 100644 index 428bfd2f..00000000 --- a/wiki-information/events/READY_CHECK_CONFIRM.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: READY_CHECK_CONFIRM - -**Title:** READY CHECK CONFIRM - -**Content:** -Fired when a player confirms ready status. -`READY_CHECK_CONFIRM: unitTarget, isReady` - -**Payload:** -- `unitTarget` - - *string* : UnitId - The unit in raidN, partyN format. Fires twice if the confirming player is in your raid sub-group. -- `isReady` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/READY_CHECK_FINISHED.md b/wiki-information/events/READY_CHECK_FINISHED.md deleted file mode 100644 index 7bbcbda7..00000000 --- a/wiki-information/events/READY_CHECK_FINISHED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: READY_CHECK_FINISHED - -**Title:** READY CHECK FINISHED - -**Content:** -Fired when the ready check completes. -`READY_CHECK_FINISHED: preempted` - -**Payload:** -- `preempted` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md b/wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md deleted file mode 100644 index e1ca493b..00000000 --- a/wiki-information/events/RECEIVED_ACHIEVEMENT_LIST.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: RECEIVED_ACHIEVEMENT_LIST - -**Title:** RECEIVED ACHIEVEMENT LIST - -**Content:** -Needs summary. -`RECEIVED_ACHIEVEMENT_LIST` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md b/wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md deleted file mode 100644 index 4ea5ef09..00000000 --- a/wiki-information/events/RECEIVED_ACHIEVEMENT_MEMBER_LIST.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: RECEIVED_ACHIEVEMENT_MEMBER_LIST - -**Title:** RECEIVED ACHIEVEMENT MEMBER LIST - -**Content:** -Needs summary. -`RECEIVED_ACHIEVEMENT_MEMBER_LIST: achievementID` - -**Payload:** -- `achievementID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/REPLACE_ENCHANT.md b/wiki-information/events/REPLACE_ENCHANT.md deleted file mode 100644 index 22872a52..00000000 --- a/wiki-information/events/REPLACE_ENCHANT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: REPLACE_ENCHANT - -**Title:** REPLACE ENCHANT - -**Content:** -Fired when the player must confirm an enchantment replacement. -`REPLACE_ENCHANT: existingStr, replacementStr` - -**Payload:** -- `existingStr` - - *string* - enchantment -- `replacementStr` - - *string* - current enchantment \ No newline at end of file diff --git a/wiki-information/events/REPORT_PLAYER_RESULT.md b/wiki-information/events/REPORT_PLAYER_RESULT.md deleted file mode 100644 index f815dc7b..00000000 --- a/wiki-information/events/REPORT_PLAYER_RESULT.md +++ /dev/null @@ -1,50 +0,0 @@ -## Event: REPORT_PLAYER_RESULT - -**Title:** REPORT PLAYER RESULT - -**Content:** -Fires when attempting to report a player -`REPORT_PLAYER_RESULT: success, reportType` - -**Payload:** -- `success` - - *boolean* -- `reportType` - - *Enum.ReportType* - - *Value* - - *Field* - - *Description* - - 0 - - Chat - - 1 - - InWorld - - 2 - - ClubFinderPosting - - 3 - - ClubFinderApplicant - - 4 - - GroupFinderPosting - - 5 - - GroupFinderApplicant - - 6 - - ClubMember - - 7 - - GroupMember - - 8 - - Friend - - 9 - - Pet - - 10 - - BattlePet - - 11 - - Calendar - - 12 - - Mail - - 13 - - PvP - - 14 - - PvPScoreboard - - Added in 9.2.7 - - 15 - - PvPGroupMember - - Added in 10.0.5 \ No newline at end of file diff --git a/wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md b/wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md deleted file mode 100644 index f0f01739..00000000 --- a/wiki-information/events/REQUEST_CEMETERY_LIST_RESPONSE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: REQUEST_CEMETERY_LIST_RESPONSE - -**Title:** REQUEST CEMETERY LIST RESPONSE - -**Content:** -Needs summary. -`REQUEST_CEMETERY_LIST_RESPONSE: isGossipTriggered` - -**Payload:** -- `isGossipTriggered` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md b/wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md deleted file mode 100644 index 2d8b77d4..00000000 --- a/wiki-information/events/REQUIRED_GUILD_RENAME_RESULT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: REQUIRED_GUILD_RENAME_RESULT - -**Title:** REQUIRED GUILD RENAME RESULT - -**Content:** -Needs summary. -`REQUIRED_GUILD_RENAME_RESULT: success` - -**Payload:** -- `success` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md b/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md deleted file mode 100644 index 777eaeb2..00000000 --- a/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED - -**Title:** RESPEC AZERITE EMPOWERED ITEM CLOSED - -**Content:** -Needs summary. -`RESPEC_AZERITE_EMPOWERED_ITEM_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md b/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md deleted file mode 100644 index e1cddfe5..00000000 --- a/wiki-information/events/RESPEC_AZERITE_EMPOWERED_ITEM_OPENED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: RESPEC_AZERITE_EMPOWERED_ITEM_OPENED - -**Title:** RESPEC AZERITE EMPOWERED ITEM OPENED - -**Content:** -Needs summary. -`RESPEC_AZERITE_EMPOWERED_ITEM_OPENED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/RESURRECT_REQUEST.md b/wiki-information/events/RESURRECT_REQUEST.md deleted file mode 100644 index ea7429d7..00000000 --- a/wiki-information/events/RESURRECT_REQUEST.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: RESURRECT_REQUEST - -**Title:** RESURRECT REQUEST - -**Content:** -Fired when another player resurrects you. -`RESURRECT_REQUEST: inviter` - -**Payload:** -- `inviter` - - *string* - player name \ No newline at end of file diff --git a/wiki-information/events/ROLE_CHANGED_INFORM.md b/wiki-information/events/ROLE_CHANGED_INFORM.md deleted file mode 100644 index d9d60d4c..00000000 --- a/wiki-information/events/ROLE_CHANGED_INFORM.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: ROLE_CHANGED_INFORM - -**Title:** ROLE CHANGED INFORM - -**Content:** -Needs summary. -`ROLE_CHANGED_INFORM: changedName, fromName, oldRole, newRole` - -**Payload:** -- `changedName` - - *string* - player name -- `fromName` - - *string* - source of change -- `oldRole` - - *string* - previous role -- `newRole` - - *string* - new role \ No newline at end of file diff --git a/wiki-information/events/ROLE_POLL_BEGIN.md b/wiki-information/events/ROLE_POLL_BEGIN.md deleted file mode 100644 index 4900ef8e..00000000 --- a/wiki-information/events/ROLE_POLL_BEGIN.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: ROLE_POLL_BEGIN - -**Title:** ROLE POLL BEGIN - -**Content:** -Needs summary. -`ROLE_POLL_BEGIN: fromName` - -**Payload:** -- `fromName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/RUNE_POWER_UPDATE.md b/wiki-information/events/RUNE_POWER_UPDATE.md deleted file mode 100644 index 06988db0..00000000 --- a/wiki-information/events/RUNE_POWER_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: RUNE_POWER_UPDATE - -**Title:** RUNE POWER UPDATE - -**Content:** -Fired when a rune's state switches from usable to un-usable or visa-versa. -`RUNE_POWER_UPDATE: runeIndex, added` - -**Payload:** -- `runeIndex` - - *number* -- `added` - - *boolean?* - is the rune usable (if usable, it's not cooling, if not usable it's cooling) \ No newline at end of file diff --git a/wiki-information/events/RUNE_TYPE_UPDATE.md b/wiki-information/events/RUNE_TYPE_UPDATE.md deleted file mode 100644 index 4b32f51d..00000000 --- a/wiki-information/events/RUNE_TYPE_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: RUNE_TYPE_UPDATE - -**Title:** RUNE TYPE UPDATE - -**Content:** -New in 3.x. Fired when a rune's type is changed / updated. -`"RUNE_TYPE_UPDATE", arg1` - -**Parameters & Values:** -- `arg1` - - the rune that it's referencing to \ No newline at end of file diff --git a/wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md b/wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md deleted file mode 100644 index b5b4762e..00000000 --- a/wiki-information/events/SAVED_VARIABLES_TOO_LARGE.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: SAVED_VARIABLES_TOO_LARGE - -**Title:** SAVED VARIABLES TOO LARGE - -**Content:** -Fired when unable to load saved variables due to an out-of-memory error. -`SAVED_VARIABLES_TOO_LARGE: addOnName` - -**Payload:** -- `addOnName` - - *string* - Name of the AddOn. - -**Content Details:** -Fires after ADDON_LOADED. -The error could affect SavedVariables and/or SavedVariablesPerCharacter. -SavedVariables will not save on the next logout. - -**Related Information:** -AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/SCREENSHOT_FAILED.md b/wiki-information/events/SCREENSHOT_FAILED.md deleted file mode 100644 index f001ac73..00000000 --- a/wiki-information/events/SCREENSHOT_FAILED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SCREENSHOT_FAILED - -**Title:** SCREENSHOT FAILED - -**Content:** -Fired when a screenshot fails. -`SCREENSHOT_FAILED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SCREENSHOT_STARTED.md b/wiki-information/events/SCREENSHOT_STARTED.md deleted file mode 100644 index 4764f29c..00000000 --- a/wiki-information/events/SCREENSHOT_STARTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SCREENSHOT_STARTED - -**Title:** SCREENSHOT STARTED - -**Content:** -Needs summary. -`SCREENSHOT_STARTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SCREENSHOT_SUCCEEDED.md b/wiki-information/events/SCREENSHOT_SUCCEEDED.md deleted file mode 100644 index 799ef0a0..00000000 --- a/wiki-information/events/SCREENSHOT_SUCCEEDED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SCREENSHOT_SUCCEEDED - -**Title:** SCREENSHOT SUCCEEDED - -**Content:** -Fired when a screenshot is successfully taken. -`SCREENSHOT_SUCCEEDED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SEARCH_DB_LOADED.md b/wiki-information/events/SEARCH_DB_LOADED.md deleted file mode 100644 index c7e6cc9e..00000000 --- a/wiki-information/events/SEARCH_DB_LOADED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SEARCH_DB_LOADED - -**Title:** SEARCH DB LOADED - -**Content:** -Needs summary. -`SEARCH_DB_LOADED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SECURE_TRANSFER_CANCEL.md b/wiki-information/events/SECURE_TRANSFER_CANCEL.md deleted file mode 100644 index a509cd0c..00000000 --- a/wiki-information/events/SECURE_TRANSFER_CANCEL.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: SECURE_TRANSFER_CANCEL - -**Title:** SECURE TRANSFER CANCEL - -**Content:** -Fires when the user halts offering money or items to a stranger, after receiving a warning dialog. -`SECURE_TRANSFER_CANCEL` - -**Payload:** -- `None` - -**Related Information:** -SECURE_TRANSFER_CONFIRM_SEND_MAIL -SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT \ No newline at end of file diff --git a/wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md b/wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md deleted file mode 100644 index 77fad643..00000000 --- a/wiki-information/events/SECURE_TRANSFER_CONFIRM_SEND_MAIL.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: SECURE_TRANSFER_CONFIRM_SEND_MAIL - -**Title:** SECURE TRANSFER CONFIRM SEND MAIL - -**Content:** -Fires when mailing money or items to a stranger. -`SECURE_TRANSFER_CONFIRM_SEND_MAIL` - -**Payload:** -- `None` - -**Content Details:** -Does not fire if the recipient is: -- In the same guild -- On the friends list as a character (ie, not counting BattleTag or Real ID friends) -- An alt of the sender -While an addon could respond to this event, the most important utility is for SecureTransferDialog to securely confirm the user's intention without addon interference. - -**Related Information:** -SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT -SECURE_TRANSFER_CANCEL \ No newline at end of file diff --git a/wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md b/wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md deleted file mode 100644 index b6843e97..00000000 --- a/wiki-information/events/SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT - -**Title:** SECURE TRANSFER CONFIRM TRADE ACCEPT - -**Content:** -Fires when trading money or items to a stranger. -`SECURE_TRANSFER_CONFIRM_TRADE_ACCEPT` - -**Payload:** -- `None` - -**Content Details:** -Does not fire if the recipient is: -In the same guild -On the friends list -In the same group or raid -While an addon could respond to this event, the most important utility is for SecureTransferDialog to securely confirm the user's intention without addon interference. - -**Related Information:** -SECURE_TRANSFER_CONFIRM_SEND_MAIL -SECURE_TRANSFER_CANCEL \ No newline at end of file diff --git a/wiki-information/events/SELF_RES_SPELL_CHANGED.md b/wiki-information/events/SELF_RES_SPELL_CHANGED.md deleted file mode 100644 index 88a3cb46..00000000 --- a/wiki-information/events/SELF_RES_SPELL_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SELF_RES_SPELL_CHANGED - -**Title:** SELF RES SPELL CHANGED - -**Content:** -Needs summary. -`SELF_RES_SPELL_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SEND_MAIL_COD_CHANGED.md b/wiki-information/events/SEND_MAIL_COD_CHANGED.md deleted file mode 100644 index 40a53e1a..00000000 --- a/wiki-information/events/SEND_MAIL_COD_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SEND_MAIL_COD_CHANGED - -**Title:** SEND MAIL COD CHANGED - -**Content:** -Needs summary. -`SEND_MAIL_COD_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SEND_MAIL_MONEY_CHANGED.md b/wiki-information/events/SEND_MAIL_MONEY_CHANGED.md deleted file mode 100644 index fb4705d0..00000000 --- a/wiki-information/events/SEND_MAIL_MONEY_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SEND_MAIL_MONEY_CHANGED - -**Title:** SEND MAIL MONEY CHANGED - -**Content:** -Needs summary. -`SEND_MAIL_MONEY_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md b/wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md deleted file mode 100644 index d249cb70..00000000 --- a/wiki-information/events/SHOW_LFG_EXPAND_SEARCH_PROMPT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SHOW_LFG_EXPAND_SEARCH_PROMPT - -**Title:** SHOW LFG EXPAND SEARCH PROMPT - -**Content:** -Fires when the player is in Chromie Time, queued for a dungeon, and has been waiting in the queue for enough time to trigger the "expand your search" popup. -`SHOW_LFG_EXPAND_SEARCH_PROMPT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md b/wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md deleted file mode 100644 index 425f42e9..00000000 --- a/wiki-information/events/SHOW_LOOT_TOAST_LEGENDARY_LOOTED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SHOW_LOOT_TOAST_LEGENDARY_LOOTED - -**Title:** SHOW LOOT TOAST LEGENDARY LOOTED - -**Content:** -Needs summary. -`SHOW_LOOT_TOAST_LEGENDARY_LOOTED: itemLink` - -**Payload:** -- `itemLink` - - *string* \ No newline at end of file diff --git a/wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md b/wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md deleted file mode 100644 index 30421590..00000000 --- a/wiki-information/events/SHOW_LOOT_TOAST_UPGRADE.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: SHOW_LOOT_TOAST_UPGRADE - -**Title:** SHOW LOOT TOAST UPGRADE - -**Content:** -Needs summary. -`SHOW_LOOT_TOAST_UPGRADE: itemLink, quantity, specID, sex, baseQuality, personalLootToast, lessAwesome` - -**Payload:** -- `itemLink` - - *string* -- `quantity` - - *number* -- `specID` - - *number* -- `sex` - - *number* -- `baseQuality` - - *number* -- `personalLootToast` - - *boolean* -- `lessAwesome` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md b/wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md deleted file mode 100644 index 89a230b8..00000000 --- a/wiki-information/events/SHOW_PVP_FACTION_LOOT_TOAST.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: SHOW_PVP_FACTION_LOOT_TOAST - -**Title:** SHOW PVP FACTION LOOT TOAST - -**Content:** -Needs summary. -`SHOW_PVP_FACTION_LOOT_TOAST: typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, lessAwesome` - -**Payload:** -- `typeIdentifier` - - *string* -- `itemLink` - - *string* -- `quantity` - - *number* -- `specID` - - *number* -- `sex` - - *number* -- `personalLootToast` - - *boolean* -- `lessAwesome` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md b/wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md deleted file mode 100644 index f6217d21..00000000 --- a/wiki-information/events/SHOW_RATED_PVP_REWARD_TOAST.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: SHOW_RATED_PVP_REWARD_TOAST - -**Title:** SHOW RATED PVP REWARD TOAST - -**Content:** -Needs summary. -`SHOW_RATED_PVP_REWARD_TOAST: typeIdentifier, itemLink, quantity, specID, sex, personalLootToast, lessAwesome` - -**Payload:** -- `typeIdentifier` - - *string* -- `itemLink` - - *string* -- `quantity` - - *number* -- `specID` - - *number* -- `sex` - - *number* -- `personalLootToast` - - *boolean* -- `lessAwesome` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md b/wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md deleted file mode 100644 index 77ab81f0..00000000 --- a/wiki-information/events/SIMPLE_BROWSER_WEB_ERROR.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SIMPLE_BROWSER_WEB_ERROR - -**Title:** SIMPLE BROWSER WEB ERROR - -**Content:** -Needs summary. -`SIMPLE_BROWSER_WEB_ERROR: errorCode` - -**Payload:** -- `errorCode` - - *number* \ No newline at end of file diff --git a/wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md b/wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md deleted file mode 100644 index aa68221b..00000000 --- a/wiki-information/events/SIMPLE_BROWSER_WEB_PROXY_FAILED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SIMPLE_BROWSER_WEB_PROXY_FAILED - -**Title:** SIMPLE BROWSER WEB PROXY FAILED - -**Content:** -Needs summary. -`SIMPLE_BROWSER_WEB_PROXY_FAILED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md b/wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md deleted file mode 100644 index c0d9c2fc..00000000 --- a/wiki-information/events/SIMPLE_CHECKOUT_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SIMPLE_CHECKOUT_CLOSED - -**Title:** SIMPLE CHECKOUT CLOSED - -**Content:** -Needs summary. -`SIMPLE_CHECKOUT_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SKILL_LINES_CHANGED.md b/wiki-information/events/SKILL_LINES_CHANGED.md deleted file mode 100644 index 36fbbe91..00000000 --- a/wiki-information/events/SKILL_LINES_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: SKILL_LINES_CHANGED - -**Title:** SKILL LINES CHANGED - -**Content:** -Fired when the content of the player's skill list changes. It only fires for major changes to the list, such as learning or unlearning a skill or raising one's level from Journeyman to Master. It doesn't fire for skill rank increases. -`SKILL_LINES_CHANGED` - -**Payload:** -- `None` - -**Content Details:** -Using Frame:RegisterUnitEvent to register for this event does not appear to work. \ No newline at end of file diff --git a/wiki-information/events/SOCIAL_ITEM_RECEIVED.md b/wiki-information/events/SOCIAL_ITEM_RECEIVED.md deleted file mode 100644 index 35e936ca..00000000 --- a/wiki-information/events/SOCIAL_ITEM_RECEIVED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SOCIAL_ITEM_RECEIVED - -**Title:** SOCIAL ITEM RECEIVED - -**Content:** -Needs summary. -`SOCIAL_ITEM_RECEIVED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_ACCEPT.md b/wiki-information/events/SOCKET_INFO_ACCEPT.md deleted file mode 100644 index 378644cd..00000000 --- a/wiki-information/events/SOCKET_INFO_ACCEPT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SOCKET_INFO_ACCEPT - -**Title:** SOCKET INFO ACCEPT - -**Content:** -Needs summary. -`SOCKET_INFO_ACCEPT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_CLOSE.md b/wiki-information/events/SOCKET_INFO_CLOSE.md deleted file mode 100644 index 3cdf5707..00000000 --- a/wiki-information/events/SOCKET_INFO_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SOCKET_INFO_CLOSE - -**Title:** SOCKET INFO CLOSE - -**Content:** -Needs summary. -`SOCKET_INFO_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_FAILURE.md b/wiki-information/events/SOCKET_INFO_FAILURE.md deleted file mode 100644 index a5f4a785..00000000 --- a/wiki-information/events/SOCKET_INFO_FAILURE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SOCKET_INFO_FAILURE - -**Title:** SOCKET INFO FAILURE - -**Content:** -Needs summary. -`SOCKET_INFO_FAILURE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md b/wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md deleted file mode 100644 index 66afb5cd..00000000 --- a/wiki-information/events/SOCKET_INFO_REFUNDABLE_CONFIRM.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SOCKET_INFO_REFUNDABLE_CONFIRM - -**Title:** SOCKET INFO REFUNDABLE CONFIRM - -**Content:** -Needs summary. -`SOCKET_INFO_REFUNDABLE_CONFIRM` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_SUCCESS.md b/wiki-information/events/SOCKET_INFO_SUCCESS.md deleted file mode 100644 index a733ce21..00000000 --- a/wiki-information/events/SOCKET_INFO_SUCCESS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SOCKET_INFO_SUCCESS - -**Title:** SOCKET INFO SUCCESS - -**Content:** -Needs summary. -`SOCKET_INFO_SUCCESS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SOCKET_INFO_UPDATE.md b/wiki-information/events/SOCKET_INFO_UPDATE.md deleted file mode 100644 index 81942f1c..00000000 --- a/wiki-information/events/SOCKET_INFO_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SOCKET_INFO_UPDATE - -**Title:** SOCKET INFO UPDATE - -**Content:** -Needs summary. -`SOCKET_INFO_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SOUNDKIT_FINISHED.md b/wiki-information/events/SOUNDKIT_FINISHED.md deleted file mode 100644 index ea7c59e4..00000000 --- a/wiki-information/events/SOUNDKIT_FINISHED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SOUNDKIT_FINISHED - -**Title:** SOUNDKIT FINISHED - -**Content:** -Indicates a sound has finished playing, but only if the fourth argument in PlaySound(__, __, __, runFinishCallback) was set to true. -`SOUNDKIT_FINISHED: soundHandle` - -**Payload:** -- `soundHandle` - - *number* - The second return value from PlaySound() identifying which sound has finished playing. \ No newline at end of file diff --git a/wiki-information/events/SOUND_DEVICE_UPDATE.md b/wiki-information/events/SOUND_DEVICE_UPDATE.md deleted file mode 100644 index b76366dc..00000000 --- a/wiki-information/events/SOUND_DEVICE_UPDATE.md +++ /dev/null @@ -1,7 +0,0 @@ -## Event: SOUND_DEVICE_UPDATE - -**Title:** SOUND DEVICE UPDATE - -**Content:** -Information about the player's sound input or output devices has changed or become available. -`SOUND_DEVICE_UPDATE` \ No newline at end of file diff --git a/wiki-information/events/SPELLS_CHANGED.md b/wiki-information/events/SPELLS_CHANGED.md deleted file mode 100644 index 49ab0c39..00000000 --- a/wiki-information/events/SPELLS_CHANGED.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: SPELLS_CHANGED - -**Title:** SPELLS CHANGED - -**Content:** -Fires when spells in the spellbook change in any way. Can be trivial (e.g.: icon changes only), or substantial (e.g.: learning or unlearning spells/skills). -`SPELLS_CHANGED` - -**Payload:** -- `None` - -**Content Details:** -In prior game versions, this event also fired every time the player navigated the spellbook (swapped pages/tabs), since that caused UpdateSpells to be called which in turn always triggered a SPELLS_CHANGED event. However, that API has been removed since Patch 4.0.1. - -**Related Information:** -AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md deleted file mode 100644 index c826059d..00000000 --- a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_HIDE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SPELL_ACTIVATION_OVERLAY_GLOW_HIDE - -**Title:** SPELL ACTIVATION OVERLAY GLOW HIDE - -**Content:** -Needs summary. -`SPELL_ACTIVATION_OVERLAY_GLOW_HIDE: spellID` - -**Payload:** -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md deleted file mode 100644 index 3a32b09d..00000000 --- a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_GLOW_SHOW.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SPELL_ACTIVATION_OVERLAY_GLOW_SHOW - -**Title:** SPELL ACTIVATION OVERLAY GLOW SHOW - -**Content:** -Needs summary. -`SPELL_ACTIVATION_OVERLAY_GLOW_SHOW: spellID` - -**Payload:** -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md deleted file mode 100644 index c933fa3f..00000000 --- a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_HIDE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SPELL_ACTIVATION_OVERLAY_HIDE - -**Title:** SPELL ACTIVATION OVERLAY HIDE - -**Content:** -Needs summary. -`SPELL_ACTIVATION_OVERLAY_HIDE: spellID` - -**Payload:** -- `spellID` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md b/wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md deleted file mode 100644 index 69db5043..00000000 --- a/wiki-information/events/SPELL_ACTIVATION_OVERLAY_SHOW.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: SPELL_ACTIVATION_OVERLAY_SHOW - -**Title:** SPELL ACTIVATION OVERLAY SHOW - -**Content:** -Fired when the spell overlay is shown. -`SPELL_ACTIVATION_OVERLAY_SHOW: spellID, overlayFileDataID, locationName, scale, r, g, b` - -**Payload:** -- `spellID` - - *number* -- `overlayFileDataID` - - *number* - texture -- `locationName` - - *string* - possible values include simple points such as "CENTER" or "LEFT", or complex positions such as "RIGHT (FLIPPED)" or "TOP + BOTTOM (FLIPPED)", which are defined in a local table in SpellActivationOverlay.lua -- `scale` - - *number* -- `r` - - *number* -- `g` - - *number* -- `b` - - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_CONFIRMATION_PROMPT.md b/wiki-information/events/SPELL_CONFIRMATION_PROMPT.md deleted file mode 100644 index b74ef94b..00000000 --- a/wiki-information/events/SPELL_CONFIRMATION_PROMPT.md +++ /dev/null @@ -1,26 +0,0 @@ -## Event: SPELL_CONFIRMATION_PROMPT - -**Title:** SPELL CONFIRMATION PROMPT - -**Content:** -Fires when a spell confirmation prompt might be presented to the player. -`SPELL_CONFIRMATION_PROMPT: spellID, effectValue, message, duration, currencyTypesID, currencyCost, currentDifficulty` - -**Payload:** -- `spellID` - - *number* - Spell ID for the Confirmation Prompt Spell. These are very specific spells that only appear during this event. -- `effectValue` - - *number* - The possible values for this are not entirely known, however, 1 does seem to be the confirmType when the prompt triggers a bonus roll. -- `message` - - *string* -- `duration` - - *number* - This number is in seconds. Typically, it is 180 seconds. -- `currencyTypesID` - - *number* - The ID of the currency required if the prompt requires a currency (it does for bonus rolls). -- `currencyCost` - - *number* -- `currentDifficulty` - - *number* - -**Content Details:** -After this event has fired, the client can respond with the functions AcceptSpellConfirmationPrompt and DeclineSpellConfirmationPrompt. Notably, the event does not guarantee that the player can actually cast the spell. \ No newline at end of file diff --git a/wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md b/wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md deleted file mode 100644 index a921be83..00000000 --- a/wiki-information/events/SPELL_CONFIRMATION_TIMEOUT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: SPELL_CONFIRMATION_TIMEOUT - -**Title:** SPELL CONFIRMATION TIMEOUT - -**Content:** -Fires when a spell confirmation prompt was not accepted via AcceptSpellConfirmationPrompt or declined via DeclineSpellConfirmationPrompt within the allotted time (usually 3 minutes). -`SPELL_CONFIRMATION_TIMEOUT: spellID, effectValue` - -**Payload:** -- `spellID` - - *number* -- `effectValue` - - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_DATA_LOAD_RESULT.md b/wiki-information/events/SPELL_DATA_LOAD_RESULT.md deleted file mode 100644 index 270d1e7f..00000000 --- a/wiki-information/events/SPELL_DATA_LOAD_RESULT.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: SPELL_DATA_LOAD_RESULT - -**Title:** SPELL DATA LOAD RESULT - -**Content:** -Fires when data is available in response to C_Spell.RequestLoadSpellData. -`SPELL_DATA_LOAD_RESULT: spellID, success` - -**Payload:** -- `spellID` - - *number* -- `success` - - *boolean* - True if the spell was successfully queried from the server. Might return false when only partial spell data is available, e.g. everything except the spell description. - -**Related Information:** -SpellMixin \ No newline at end of file diff --git a/wiki-information/events/SPELL_POWER_CHANGED.md b/wiki-information/events/SPELL_POWER_CHANGED.md deleted file mode 100644 index 9702bb45..00000000 --- a/wiki-information/events/SPELL_POWER_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: SPELL_POWER_CHANGED - -**Title:** SPELL POWER CHANGED - -**Content:** -Fired when the player's Spell Power changes. -`SPELL_POWER_CHANGED` - -**Payload:** -- `None` - -**Content Details:** -Does not fire when Spell Healing changes. For that use PLAYER_DAMAGE_DONE_MODS. \ No newline at end of file diff --git a/wiki-information/events/SPELL_TEXT_UPDATE.md b/wiki-information/events/SPELL_TEXT_UPDATE.md deleted file mode 100644 index f256b55b..00000000 --- a/wiki-information/events/SPELL_TEXT_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SPELL_TEXT_UPDATE - -**Title:** SPELL TEXT UPDATE - -**Content:** -Needs summary. -`SPELL_TEXT_UPDATE: spellID` - -**Payload:** -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_CHARGES.md b/wiki-information/events/SPELL_UPDATE_CHARGES.md deleted file mode 100644 index 64103904..00000000 --- a/wiki-information/events/SPELL_UPDATE_CHARGES.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: SPELL_UPDATE_CHARGES - -**Title:** SPELL UPDATE CHARGES - -**Content:** -Needs summary. -`SPELL_UPDATE_CHARGES` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_COOLDOWN.md b/wiki-information/events/SPELL_UPDATE_COOLDOWN.md deleted file mode 100644 index 8f0fe059..00000000 --- a/wiki-information/events/SPELL_UPDATE_COOLDOWN.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: SPELL_UPDATE_COOLDOWN - -**Title:** SPELL UPDATE COOLDOWN - -**Content:** -This event is fired immediately whenever you cast a spell, as well as every second while you channel spells. -`SPELL_UPDATE_COOLDOWN` - -**Payload:** -- `None` - -**Content Details:** -The spell you cast doesn't need to have any explicit "cooldown" of its own, since this event also triggers off of anything that incurs a GCD (global cooldown). In other words, it basically fires whenever you cast any spell or channel any spell. -(It may possibly even trigger from spells that are "off the GCD" and which don't have any cooldown of their own; but there's no way to verify that, since all spells in game that are "off the GCD" are special class "burst" abilities with long cooldowns.) -It's worth noting that this event does NOT fire when spells finish their cooldown! - -**Usage:** -Whenever you cast a spell, this event triggers twice in a row. Most likely to signal that a spell cast has begun, and then to signal that the GCD has been triggered. -When a hunter auto-shoots, they're actually casting the "Auto Shot" spell (which repeatedly auto-casts itself until cancelled, and has a cooldown of its own, but is otherwise completely "off the GCD" and doesn't trigger the GCD at all when it's cast/shooting/aborted). So every time the hunter shoots a projectile, this event will fire to signal that the "Auto Shot" spell has begun its internal cooldown. Note that this behavior is unique to "Auto Shot"; and that the regular melee spell "Attack" (or melee swings) do NOT trigger this event. -Furthermore, any channeled spells will fire this event once per second while the channeling is ongoing. As an example, if you cast Volley, this event first fires once to signal that a spell with a cooldown (Volley) has been cast. Then it immediately fires again to signal that channeling of Volley has begun. And after that, it fires every second while the channeling is ongoing. - -**Related Information:** -GetSpellCooldown \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_ICON.md b/wiki-information/events/SPELL_UPDATE_ICON.md deleted file mode 100644 index 82866f58..00000000 --- a/wiki-information/events/SPELL_UPDATE_ICON.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: SPELL_UPDATE_ICON - -**Title:** SPELL UPDATE ICON - -**Content:** -Indicates a spell or ability has a new icon. -`SPELL_UPDATE_ICON` - -**Payload:** -- `None` - -**Content Details:** -Tracks changing spells such as Covenant abilities in Shadowlands. \ No newline at end of file diff --git a/wiki-information/events/SPELL_UPDATE_USABLE.md b/wiki-information/events/SPELL_UPDATE_USABLE.md deleted file mode 100644 index 3694c32e..00000000 --- a/wiki-information/events/SPELL_UPDATE_USABLE.md +++ /dev/null @@ -1,20 +0,0 @@ -## Event: SPELL_UPDATE_USABLE - -**Title:** SPELL UPDATE USABLE - -**Content:** -This event is fired when a spell becomes "useable" or "unusable". -`SPELL_UPDATE_USABLE` - -**Payload:** -- `None` - -**Content Details:** -The definition of useable and unusable is somewhat confusing. Firstly, range is not taken into account. Secondly if a spell requires a valid target and doesn't have one it gets marked as useable. If it requires mana or rage and there isn't enough then it gets marked as unusable. This results in the following behaviour: -Start) Feral druid in bear form out of combat, no target selected. -) Target enemy. Event is fired as some spells that require rage become marked as unusable. On the action bar the spell is marked in red as unusable. -) Use Enrage to gain rage. Event is fired as we now have enough rage. On the action bar the spell is marked unusable as out of range. -) Move into range. Event is not fired. On the action bar the spell is marked usable. -) Rage runs out. Event is fired as we no longer have enough rage. -) Remove target. Event is fired and spell is marked as useable on action bar. -It appears that the definition of useable is a little inaccurate and relates more to how it is displayed on the action bar than whether you can use the spell. Also after being attacked the event started firing every two seconds and this continued until well after the attacker was dead. Targetting a fresh enemy seemed to stop it. \ No newline at end of file diff --git a/wiki-information/events/START_AUTOREPEAT_SPELL.md b/wiki-information/events/START_AUTOREPEAT_SPELL.md deleted file mode 100644 index 360e3c26..00000000 --- a/wiki-information/events/START_AUTOREPEAT_SPELL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: START_AUTOREPEAT_SPELL - -**Title:** START AUTOREPEAT SPELL - -**Content:** -Needs summary. -`START_AUTOREPEAT_SPELL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/START_LOOT_ROLL.md b/wiki-information/events/START_LOOT_ROLL.md deleted file mode 100644 index a7ed9510..00000000 --- a/wiki-information/events/START_LOOT_ROLL.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: START_LOOT_ROLL - -**Title:** START LOOT ROLL - -**Content:** -Fired when a group loot item is being rolled on. -`START_LOOT_ROLL: rollID, rollTime, lootHandle` - -**Payload:** -- `rollID` - - *number* -- `rollTime` - - *number* -- `lootHandle` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/START_TIMER.md b/wiki-information/events/START_TIMER.md deleted file mode 100644 index 2e3f8ca6..00000000 --- a/wiki-information/events/START_TIMER.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: START_TIMER - -**Title:** START TIMER - -**Content:** -Needs summary. -`START_TIMER: timerType, timeRemaining, totalTime` - -**Payload:** -- `timerType` - - *number* -- `timeRemaining` - - *number* -- `totalTime` - - *number* \ No newline at end of file diff --git a/wiki-information/events/STOP_AUTOREPEAT_SPELL.md b/wiki-information/events/STOP_AUTOREPEAT_SPELL.md deleted file mode 100644 index 1e772a31..00000000 --- a/wiki-information/events/STOP_AUTOREPEAT_SPELL.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: STOP_AUTOREPEAT_SPELL - -**Title:** STOP AUTOREPEAT SPELL - -**Content:** -Needs summary. -`STOP_AUTOREPEAT_SPELL` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/STOP_MOVIE.md b/wiki-information/events/STOP_MOVIE.md deleted file mode 100644 index d75a41cd..00000000 --- a/wiki-information/events/STOP_MOVIE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: STOP_MOVIE - -**Title:** STOP MOVIE - -**Content:** -Needs summary. -`STOP_MOVIE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/STREAMING_ICON.md b/wiki-information/events/STREAMING_ICON.md deleted file mode 100644 index db1fc8f7..00000000 --- a/wiki-information/events/STREAMING_ICON.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: STREAMING_ICON - -**Title:** STREAMING ICON - -**Content:** -Fires when the streaming client state is updated. -`STREAMING_ICON: streamingStatus` - -**Payload:** -- `streamingStatus` - - *number* - - 0 - Nothing is currently being downloaded. - - 1 - Game data is currently being downloaded (green) - - 2 - Important game data is currently being downloaded (yellow) - - 3 - Core game data is currently being downloaded (red) \ No newline at end of file diff --git a/wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md b/wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md deleted file mode 100644 index d767f334..00000000 --- a/wiki-information/events/STREAM_VIEW_MARKER_UPDATED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: STREAM_VIEW_MARKER_UPDATED - -**Title:** STREAM VIEW MARKER UPDATED - -**Content:** -Needs summary. -`STREAM_VIEW_MARKER_UPDATED: clubId, streamId, lastReadTime` - -**Payload:** -- `clubId` - - *string* -- `streamId` - - *string* -- `lastReadTime` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md b/wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md deleted file mode 100644 index ed3c122e..00000000 --- a/wiki-information/events/SUPER_TRACKED_QUEST_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: SUPER_TRACKED_QUEST_CHANGED - -**Title:** SUPER TRACKED QUEST CHANGED - -**Content:** -Needs summary. -`SUPER_TRACKED_QUEST_CHANGED: superTrackedQuestID` - -**Payload:** -- `superTrackedQuestID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/SYSMSG.md b/wiki-information/events/SYSMSG.md deleted file mode 100644 index 317303c0..00000000 --- a/wiki-information/events/SYSMSG.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: SYSMSG - -**Title:** SYSMSG - -**Content:** -Fired when a system message occurs. Gets displayed in the UI error frame (the default red text in the top half of the screen) in the default UI. -`SYSMSG: string, r, g, b` - -**Payload:** -- `string` -- `string` -- `r` - - *number* -- `g` - - *number* -- `b` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TABARD_CANSAVE_CHANGED.md b/wiki-information/events/TABARD_CANSAVE_CHANGED.md deleted file mode 100644 index acc18969..00000000 --- a/wiki-information/events/TABARD_CANSAVE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TABARD_CANSAVE_CHANGED - -**Title:** TABARD CANSAVE CHANGED - -**Content:** -Fired when it is possible to save a tabard. -`TABARD_CANSAVE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TABARD_SAVE_PENDING.md b/wiki-information/events/TABARD_SAVE_PENDING.md deleted file mode 100644 index 4f9c55b6..00000000 --- a/wiki-information/events/TABARD_SAVE_PENDING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TABARD_SAVE_PENDING - -**Title:** TABARD SAVE PENDING - -**Content:** -Needs summary. -`TABARD_SAVE_PENDING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md b/wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md deleted file mode 100644 index 46d7bcb4..00000000 --- a/wiki-information/events/TALENTS_INVOLUNTARILY_RESET.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TALENTS_INVOLUNTARILY_RESET - -**Title:** TALENTS INVOLUNTARILY RESET - -**Content:** -Needs summary. -`TALENTS_INVOLUNTARILY_RESET: isPetTalents` - -**Payload:** -- `isPetTalents` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/TASK_PROGRESS_UPDATE.md b/wiki-information/events/TASK_PROGRESS_UPDATE.md deleted file mode 100644 index 9326ed06..00000000 --- a/wiki-information/events/TASK_PROGRESS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TASK_PROGRESS_UPDATE - -**Title:** TASK PROGRESS UPDATE - -**Content:** -Needs summary. -`TASK_PROGRESS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TAXIMAP_CLOSED.md b/wiki-information/events/TAXIMAP_CLOSED.md deleted file mode 100644 index 72a60322..00000000 --- a/wiki-information/events/TAXIMAP_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TAXIMAP_CLOSED - -**Title:** TAXIMAP CLOSED - -**Content:** -Fired when the taxi frame is closed. -`TAXIMAP_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TAXIMAP_OPENED.md b/wiki-information/events/TAXIMAP_OPENED.md deleted file mode 100644 index 45699e25..00000000 --- a/wiki-information/events/TAXIMAP_OPENED.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: TAXIMAP_OPENED - -**Title:** TAXIMAP OPENED - -**Content:** -Fired when the taxi viewer is opened. -`TAXIMAP_OPENED: system` - -**Payload:** -- `system` - - *Enum.UIMapSystem* - - *Value* - - *Field* - - *Description* - - 0 - World - - 1 - Taxi - - 2 - Adventure - - 3 - Minimap - -**Content Details:** -This will fire even if you know no flight paths connected to the one you're at, so the map doesn't actually open. \ No newline at end of file diff --git a/wiki-information/events/TIME_PLAYED_MSG.md b/wiki-information/events/TIME_PLAYED_MSG.md deleted file mode 100644 index 50799ebc..00000000 --- a/wiki-information/events/TIME_PLAYED_MSG.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: TIME_PLAYED_MSG - -**Title:** TIME PLAYED MSG - -**Content:** -Fired when the client received a time played message. -`TIME_PLAYED_MSG: totalTimePlayed, timePlayedThisLevel` - -**Payload:** -- `totalTimePlayed` - - *number* - Total time played in seconds. -- `timePlayedThisLevel` - - *number* - Time played for the current level in seconds. \ No newline at end of file diff --git a/wiki-information/events/TOGGLE_CONSOLE.md b/wiki-information/events/TOGGLE_CONSOLE.md deleted file mode 100644 index 60a46cd3..00000000 --- a/wiki-information/events/TOGGLE_CONSOLE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TOGGLE_CONSOLE - -**Title:** TOGGLE CONSOLE - -**Content:** -Needs summary. -`TOGGLE_CONSOLE: showConsole` - -**Payload:** -- `showConsole` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_AUCTION_SOLD.md b/wiki-information/events/TOKEN_AUCTION_SOLD.md deleted file mode 100644 index 9cef8c5b..00000000 --- a/wiki-information/events/TOKEN_AUCTION_SOLD.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TOKEN_AUCTION_SOLD - -**Title:** TOKEN AUCTION SOLD - -**Content:** -Needs summary. -`TOKEN_AUCTION_SOLD` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md b/wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md deleted file mode 100644 index 930fe039..00000000 --- a/wiki-information/events/TOKEN_BUY_CONFIRM_REQUIRED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TOKEN_BUY_CONFIRM_REQUIRED - -**Title:** TOKEN BUY CONFIRM REQUIRED - -**Content:** -Needs summary. -`TOKEN_BUY_CONFIRM_REQUIRED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_BUY_RESULT.md b/wiki-information/events/TOKEN_BUY_RESULT.md deleted file mode 100644 index 3a2a5f03..00000000 --- a/wiki-information/events/TOKEN_BUY_RESULT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TOKEN_BUY_RESULT - -**Title:** TOKEN BUY RESULT - -**Content:** -Needs summary. -`TOKEN_BUY_RESULT: result` - -**Payload:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md b/wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md deleted file mode 100644 index 36849389..00000000 --- a/wiki-information/events/TOKEN_CAN_VETERAN_BUY_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TOKEN_CAN_VETERAN_BUY_UPDATE - -**Title:** TOKEN CAN VETERAN BUY UPDATE - -**Content:** -Needs summary. -`TOKEN_CAN_VETERAN_BUY_UPDATE: result` - -**Payload:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md b/wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md deleted file mode 100644 index dab54d12..00000000 --- a/wiki-information/events/TOKEN_DISTRIBUTIONS_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TOKEN_DISTRIBUTIONS_UPDATED - -**Title:** TOKEN DISTRIBUTIONS UPDATED - -**Content:** -Needs summary. -`TOKEN_DISTRIBUTIONS_UPDATED: result` - -**Payload:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md b/wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md deleted file mode 100644 index 59649725..00000000 --- a/wiki-information/events/TOKEN_MARKET_PRICE_UPDATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TOKEN_MARKET_PRICE_UPDATED - -**Title:** TOKEN MARKET PRICE UPDATED - -**Content:** -Needs summary. -`TOKEN_MARKET_PRICE_UPDATED: result` - -**Payload:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md b/wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md deleted file mode 100644 index d48eab0d..00000000 --- a/wiki-information/events/TOKEN_REDEEM_BALANCE_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TOKEN_REDEEM_BALANCE_UPDATED - -**Title:** TOKEN REDEEM BALANCE UPDATED - -**Content:** -Needs summary. -`TOKEN_REDEEM_BALANCE_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md b/wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md deleted file mode 100644 index bc935cd9..00000000 --- a/wiki-information/events/TOKEN_REDEEM_CONFIRM_REQUIRED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TOKEN_REDEEM_CONFIRM_REQUIRED - -**Title:** TOKEN REDEEM CONFIRM REQUIRED - -**Content:** -Needs summary. -`TOKEN_REDEEM_CONFIRM_REQUIRED: choiceType` - -**Payload:** -- `choiceType` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md b/wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md deleted file mode 100644 index 743d727c..00000000 --- a/wiki-information/events/TOKEN_REDEEM_FRAME_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TOKEN_REDEEM_FRAME_SHOW - -**Title:** TOKEN REDEEM FRAME SHOW - -**Content:** -Needs summary. -`TOKEN_REDEEM_FRAME_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md b/wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md deleted file mode 100644 index 84ed2b32..00000000 --- a/wiki-information/events/TOKEN_REDEEM_GAME_TIME_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TOKEN_REDEEM_GAME_TIME_UPDATED - -**Title:** TOKEN REDEEM GAME TIME UPDATED - -**Content:** -Needs summary. -`TOKEN_REDEEM_GAME_TIME_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_REDEEM_RESULT.md b/wiki-information/events/TOKEN_REDEEM_RESULT.md deleted file mode 100644 index 71cc9ff5..00000000 --- a/wiki-information/events/TOKEN_REDEEM_RESULT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: TOKEN_REDEEM_RESULT - -**Title:** TOKEN REDEEM RESULT - -**Content:** -Needs summary. -`TOKEN_REDEEM_RESULT: result, choiceType` - -**Payload:** -- `result` - - *number* -- `choiceType` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md b/wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md deleted file mode 100644 index df5d4ab9..00000000 --- a/wiki-information/events/TOKEN_SELL_CONFIRM_REQUIRED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TOKEN_SELL_CONFIRM_REQUIRED - -**Title:** TOKEN SELL CONFIRM REQUIRED - -**Content:** -Needs summary. -`TOKEN_SELL_CONFIRM_REQUIRED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TOKEN_SELL_RESULT.md b/wiki-information/events/TOKEN_SELL_RESULT.md deleted file mode 100644 index f608277c..00000000 --- a/wiki-information/events/TOKEN_SELL_RESULT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TOKEN_SELL_RESULT - -**Title:** TOKEN SELL RESULT - -**Content:** -Needs summary. -`TOKEN_SELL_RESULT: result` - -**Payload:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TOKEN_STATUS_CHANGED.md b/wiki-information/events/TOKEN_STATUS_CHANGED.md deleted file mode 100644 index 69c294a4..00000000 --- a/wiki-information/events/TOKEN_STATUS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TOKEN_STATUS_CHANGED - -**Title:** TOKEN STATUS CHANGED - -**Content:** -Needs summary. -`TOKEN_STATUS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TOYS_UPDATED.md b/wiki-information/events/TOYS_UPDATED.md deleted file mode 100644 index 9f0388bf..00000000 --- a/wiki-information/events/TOYS_UPDATED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: TOYS_UPDATED - -**Title:** TOYS UPDATED - -**Content:** -Needs summary. -`TOYS_UPDATED: itemID, isNew, hasFanfare` - -**Payload:** -- `itemID` - - *number?* : ToyID -- `isNew` - - *boolean?* - Whether the toy has just been added to your collection. -- `hasFanfare` - - *boolean?* - Whether the toy should appear with a "fanfare" glow effect. \ No newline at end of file diff --git a/wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md b/wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md deleted file mode 100644 index 570ae712..00000000 --- a/wiki-information/events/TRACKED_ACHIEVEMENT_LIST_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: TRACKED_ACHIEVEMENT_LIST_CHANGED - -**Title:** TRACKED ACHIEVEMENT LIST CHANGED - -**Content:** -Needs summary. -`TRACKED_ACHIEVEMENT_LIST_CHANGED: achievementID, added` - -**Payload:** -- `achievementID` - - *number?* -- `added` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md b/wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md deleted file mode 100644 index 8d98dc4d..00000000 --- a/wiki-information/events/TRACKED_ACHIEVEMENT_UPDATE.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: TRACKED_ACHIEVEMENT_UPDATE - -**Title:** TRACKED ACHIEVEMENT UPDATE - -**Content:** -Fired when a timed event for an achievement begins or ends. The achievement does not have to be actively tracked for this to trigger. -`TRACKED_ACHIEVEMENT_UPDATE: achievementID, criteriaID, elapsed, duration` - -**Payload:** -- `achievementID` - - *number* -- `criteriaID` - - *number?* -- `elapsed` - - *number?* - Actual time -- `duration` - - *number?* - Time limit \ No newline at end of file diff --git a/wiki-information/events/TRADE_ACCEPT_UPDATE.md b/wiki-information/events/TRADE_ACCEPT_UPDATE.md deleted file mode 100644 index 21468ceb..00000000 --- a/wiki-information/events/TRADE_ACCEPT_UPDATE.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: TRADE_ACCEPT_UPDATE - -**Title:** TRADE ACCEPT UPDATE - -**Content:** -Fired when the status of the player and target accept buttons has changed. -`TRADE_ACCEPT_UPDATE: playerAccepted, targetAccepted` - -**Payload:** -- `playerAccepted` - - *number* - Player has agreed to the trade (1) or not (0) -- `targetAccepted` - - *number* - Target has agreed to the trade (1) or not (0) - -**Content Details:** -Target agree status only shown when he has done it first. By this, player and target agree status is only shown together (playerAccepted == 1 and targetAccepted == 1), when player agreed after target. \ No newline at end of file diff --git a/wiki-information/events/TRADE_CLOSED.md b/wiki-information/events/TRADE_CLOSED.md deleted file mode 100644 index 9e3a60b4..00000000 --- a/wiki-information/events/TRADE_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_CLOSED - -**Title:** TRADE CLOSED - -**Content:** -Fired when the trade window is closed by the trade being accepted, or the player or target closes the window. -`TRADE_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_MONEY_CHANGED.md b/wiki-information/events/TRADE_MONEY_CHANGED.md deleted file mode 100644 index cf70e98a..00000000 --- a/wiki-information/events/TRADE_MONEY_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_MONEY_CHANGED - -**Title:** TRADE MONEY CHANGED - -**Content:** -Fired when the trade window's money value is changed. -`TRADE_MONEY_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md b/wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md deleted file mode 100644 index 55fa4949..00000000 --- a/wiki-information/events/TRADE_PLAYER_ITEM_CHANGED.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: TRADE_PLAYER_ITEM_CHANGED - -**Title:** TRADE PLAYER ITEM CHANGED - -**Content:** -Fired when an item in the target's trade window is changed (items added or removed from trade). -`TRADE_PLAYER_ITEM_CHANGED: tradeSlotIndex` - -**Payload:** -- `tradeSlotIndex` - - *number* - -**Content Details:** -Not initially fired when trading is started by dropping an item on target. \ No newline at end of file diff --git a/wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md b/wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md deleted file mode 100644 index 837bb896..00000000 --- a/wiki-information/events/TRADE_POTENTIAL_BIND_ENCHANT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TRADE_POTENTIAL_BIND_ENCHANT - -**Title:** TRADE POTENTIAL BIND ENCHANT - -**Content:** -Needs summary. -`TRADE_POTENTIAL_BIND_ENCHANT: canBecomeBoundForTrade` - -**Payload:** -- `canBecomeBoundForTrade` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/TRADE_REPLACE_ENCHANT.md b/wiki-information/events/TRADE_REPLACE_ENCHANT.md deleted file mode 100644 index b3ef25d8..00000000 --- a/wiki-information/events/TRADE_REPLACE_ENCHANT.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: TRADE_REPLACE_ENCHANT - -**Title:** TRADE REPLACE ENCHANT - -**Content:** -Fired when the player must confirm an enchantment replacement in the trade window. -`TRADE_REPLACE_ENCHANT: existing, replacement` - -**Payload:** -- `existing` - - *string* - new enchantment -- `replacement` - - *string* - current enchantment \ No newline at end of file diff --git a/wiki-information/events/TRADE_REQUEST.md b/wiki-information/events/TRADE_REQUEST.md deleted file mode 100644 index 44dc2921..00000000 --- a/wiki-information/events/TRADE_REQUEST.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TRADE_REQUEST - -**Title:** TRADE REQUEST - -**Content:** -Fired when another player wishes to trade with you. -`TRADE_REQUEST: name` - -**Payload:** -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/events/TRADE_REQUEST_CANCEL.md b/wiki-information/events/TRADE_REQUEST_CANCEL.md deleted file mode 100644 index 61903b80..00000000 --- a/wiki-information/events/TRADE_REQUEST_CANCEL.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: TRADE_REQUEST_CANCEL - -**Title:** TRADE REQUEST CANCEL - -**Content:** -Fired when a trade attempt is cancelled. Fired after TRADE_CLOSED when aborted by player, and before TRADE_CLOSED when done by target. -`TRADE_REQUEST_CANCEL` - -**Payload:** -- `None` - -**Content Details:** -Upon a trade being cancelled (as in, either part clicking the cancel button), TRADE_CLOSED is fired twice, and then TRADE_REQUEST_CANCEL once. \ No newline at end of file diff --git a/wiki-information/events/TRADE_SHOW.md b/wiki-information/events/TRADE_SHOW.md deleted file mode 100644 index 2dc26d38..00000000 --- a/wiki-information/events/TRADE_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SHOW - -**Title:** TRADE SHOW - -**Content:** -Fired when the Trade window appears after a trade request has been accepted or auto-accepted -`TRADE_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_CLOSE.md b/wiki-information/events/TRADE_SKILL_CLOSE.md deleted file mode 100644 index 0a2bb8e6..00000000 --- a/wiki-information/events/TRADE_SKILL_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_CLOSE - -**Title:** TRADE SKILL CLOSE - -**Content:** -Fired when a trade skill window is closed. -`TRADE_SKILL_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md b/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md deleted file mode 100644 index 4484ba09..00000000 --- a/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_DATA_SOURCE_CHANGED - -**Title:** TRADE SKILL DATA SOURCE CHANGED - -**Content:** -Needs summary. -`TRADE_SKILL_DATA_SOURCE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md b/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md deleted file mode 100644 index df0806fa..00000000 --- a/wiki-information/events/TRADE_SKILL_DATA_SOURCE_CHANGING.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_DATA_SOURCE_CHANGING - -**Title:** TRADE SKILL DATA SOURCE CHANGING - -**Content:** -Needs summary. -`TRADE_SKILL_DATA_SOURCE_CHANGING` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md b/wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md deleted file mode 100644 index e5998c51..00000000 --- a/wiki-information/events/TRADE_SKILL_DETAILS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_DETAILS_UPDATE - -**Title:** TRADE SKILL DETAILS UPDATE - -**Content:** -Needs summary. -`TRADE_SKILL_DETAILS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_LIST_UPDATE.md b/wiki-information/events/TRADE_SKILL_LIST_UPDATE.md deleted file mode 100644 index 548bba1c..00000000 --- a/wiki-information/events/TRADE_SKILL_LIST_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_LIST_UPDATE - -**Title:** TRADE SKILL LIST UPDATE - -**Content:** -Needs summary. -`TRADE_SKILL_LIST_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_NAME_UPDATE.md b/wiki-information/events/TRADE_SKILL_NAME_UPDATE.md deleted file mode 100644 index 26fc213c..00000000 --- a/wiki-information/events/TRADE_SKILL_NAME_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_NAME_UPDATE - -**Title:** TRADE SKILL NAME UPDATE - -**Content:** -Needs summary. -`TRADE_SKILL_NAME_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_SHOW.md b/wiki-information/events/TRADE_SKILL_SHOW.md deleted file mode 100644 index 766021d1..00000000 --- a/wiki-information/events/TRADE_SKILL_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_SHOW - -**Title:** TRADE SKILL SHOW - -**Content:** -Fired when a trade skill window is opened. -`TRADE_SKILL_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_SKILL_UPDATE.md b/wiki-information/events/TRADE_SKILL_UPDATE.md deleted file mode 100644 index e73a738b..00000000 --- a/wiki-information/events/TRADE_SKILL_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_SKILL_UPDATE - -**Title:** TRADE SKILL UPDATE - -**Content:** -Fired immediately after TRADE_SKILL_SHOW, after something is created via tradeskill, or anytime the tradeskill window is updated (filtered, tree folded/unfolded, etc.) -`TRADE_SKILL_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md b/wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md deleted file mode 100644 index b2e6fc90..00000000 --- a/wiki-information/events/TRADE_TARGET_ITEM_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TRADE_TARGET_ITEM_CHANGED - -**Title:** TRADE TARGET ITEM CHANGED - -**Content:** -Fired when an item in the target's trade window is changed (items added or removed from trade). -`TRADE_TARGET_ITEM_CHANGED: tradeSlotIndex` - -**Payload:** -- `tradeSlotIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TRADE_UPDATE.md b/wiki-information/events/TRADE_UPDATE.md deleted file mode 100644 index b49c79d0..00000000 --- a/wiki-information/events/TRADE_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRADE_UPDATE - -**Title:** TRADE UPDATE - -**Content:** -Fired when the trade window is changed. -`TRADE_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_CLOSED.md b/wiki-information/events/TRAINER_CLOSED.md deleted file mode 100644 index 2c49f082..00000000 --- a/wiki-information/events/TRAINER_CLOSED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRAINER_CLOSED - -**Title:** TRAINER CLOSED - -**Content:** -Fired when the trainer is closed. -`TRAINER_CLOSED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md b/wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md deleted file mode 100644 index dadb40c2..00000000 --- a/wiki-information/events/TRAINER_DESCRIPTION_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRAINER_DESCRIPTION_UPDATE - -**Title:** TRAINER DESCRIPTION UPDATE - -**Content:** -Needs summary. -`TRAINER_DESCRIPTION_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md b/wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md deleted file mode 100644 index 271ccad0..00000000 --- a/wiki-information/events/TRAINER_SERVICE_INFO_NAME_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRAINER_SERVICE_INFO_NAME_UPDATE - -**Title:** TRAINER SERVICE INFO NAME UPDATE - -**Content:** -Needs summary. -`TRAINER_SERVICE_INFO_NAME_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_SHOW.md b/wiki-information/events/TRAINER_SHOW.md deleted file mode 100644 index 54400b96..00000000 --- a/wiki-information/events/TRAINER_SHOW.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRAINER_SHOW - -**Title:** TRAINER SHOW - -**Content:** -Fired when the trainer frame is shown. -`TRAINER_SHOW` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRAINER_UPDATE.md b/wiki-information/events/TRAINER_UPDATE.md deleted file mode 100644 index 2bf9d2ea..00000000 --- a/wiki-information/events/TRAINER_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRAINER_UPDATE - -**Title:** TRAINER UPDATE - -**Content:** -Fired when the trainer window needs to update. -`TRAINER_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md b/wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md deleted file mode 100644 index e72b5f54..00000000 --- a/wiki-information/events/TRANSMOG_OUTFITS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRANSMOG_OUTFITS_CHANGED - -**Title:** TRANSMOG OUTFITS CHANGED - -**Content:** -Needs summary. -`TRANSMOG_OUTFITS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TRIAL_CAP_REACHED_MONEY.md b/wiki-information/events/TRIAL_CAP_REACHED_MONEY.md deleted file mode 100644 index 779ba780..00000000 --- a/wiki-information/events/TRIAL_CAP_REACHED_MONEY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: TRIAL_CAP_REACHED_MONEY - -**Title:** TRIAL CAP REACHED MONEY - -**Content:** -This event is triggered whenever a player tries to gain gold at or above the gold limit, while playing on a Subscription-Lapsed or Starter Account. -`TRIAL_CAP_REACHED_MONEY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/TUTORIAL_TRIGGER.md b/wiki-information/events/TUTORIAL_TRIGGER.md deleted file mode 100644 index 5606a89d..00000000 --- a/wiki-information/events/TUTORIAL_TRIGGER.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: TUTORIAL_TRIGGER - -**Title:** TUTORIAL TRIGGER - -**Content:** -Fired when the tutorial/tips are shown. Will not fire if tutorials are turned off. -`TUTORIAL_TRIGGER: tutorialIndex, forceShow` - -**Payload:** -- `tutorialIndex` - - *number* -- `forceShow` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/TWITTER_LINK_RESULT.md b/wiki-information/events/TWITTER_LINK_RESULT.md deleted file mode 100644 index 88d5d6d2..00000000 --- a/wiki-information/events/TWITTER_LINK_RESULT.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: TWITTER_LINK_RESULT - -**Title:** TWITTER LINK RESULT - -**Content:** -Needs summary. -`TWITTER_LINK_RESULT: isLinked, screenName, error` - -**Payload:** -- `isLinked` - - *boolean* -- `screenName` - - *string* -- `error` - - *string* \ No newline at end of file diff --git a/wiki-information/events/TWITTER_POST_RESULT.md b/wiki-information/events/TWITTER_POST_RESULT.md deleted file mode 100644 index 69d49eed..00000000 --- a/wiki-information/events/TWITTER_POST_RESULT.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: TWITTER_POST_RESULT - -**Title:** TWITTER POST RESULT - -**Content:** -Needs summary. -`TWITTER_POST_RESULT: result` - -**Payload:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/events/TWITTER_STATUS_UPDATE.md b/wiki-information/events/TWITTER_STATUS_UPDATE.md deleted file mode 100644 index a3de3189..00000000 --- a/wiki-information/events/TWITTER_STATUS_UPDATE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: TWITTER_STATUS_UPDATE - -**Title:** TWITTER STATUS UPDATE - -**Content:** -Needs summary. -`TWITTER_STATUS_UPDATE: isTwitterEnabled, isLinked, screenName` - -**Payload:** -- `isTwitterEnabled` - - *boolean* -- `isLinked` - - *boolean* -- `screenName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md b/wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md deleted file mode 100644 index 41e91a1a..00000000 --- a/wiki-information/events/UI_MODEL_SCENE_INFO_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UI_MODEL_SCENE_INFO_UPDATED - -**Title:** UI MODEL SCENE INFO UPDATED - -**Content:** -Needs summary. -`UI_MODEL_SCENE_INFO_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UI_SCALE_CHANGED.md b/wiki-information/events/UI_SCALE_CHANGED.md deleted file mode 100644 index 7f4aa4d8..00000000 --- a/wiki-information/events/UI_SCALE_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UI_SCALE_CHANGED - -**Title:** UI SCALE CHANGED - -**Content:** -Needs summary. -`UI_SCALE_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UNIT_ATTACK.md b/wiki-information/events/UNIT_ATTACK.md deleted file mode 100644 index 2420d3c7..00000000 --- a/wiki-information/events/UNIT_ATTACK.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_ATTACK - -**Title:** UNIT ATTACK - -**Content:** -Fired when a units attack is affected (such as the weapon being swung). -`UNIT_ATTACK: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_ATTACK_POWER.md b/wiki-information/events/UNIT_ATTACK_POWER.md deleted file mode 100644 index f607b525..00000000 --- a/wiki-information/events/UNIT_ATTACK_POWER.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_ATTACK_POWER - -**Title:** UNIT ATTACK POWER - -**Content:** -Fired when a unit's attack power changes. -`UNIT_ATTACK_POWER: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_ATTACK_SPEED.md b/wiki-information/events/UNIT_ATTACK_SPEED.md deleted file mode 100644 index dc484352..00000000 --- a/wiki-information/events/UNIT_ATTACK_SPEED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_ATTACK_SPEED - -**Title:** UNIT ATTACK SPEED - -**Content:** -Fired when your attack speed is being listed or affected. -`UNIT_ATTACK_SPEED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_AURA.md b/wiki-information/events/UNIT_AURA.md deleted file mode 100644 index c4bebf11..00000000 --- a/wiki-information/events/UNIT_AURA.md +++ /dev/null @@ -1,135 +0,0 @@ -## Event: UNIT_AURA - -**Title:** UNIT AURA - -**Content:** -Fires when a buff, debuff, status, or item bonus was gained by or faded from an entity (player, pet, NPC, or mob.) -`UNIT_AURA: unitTarget, updateInfo` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `updateInfo` - - *UnitAuraUpdateInfo?* : Optional table of information about changed auras. - - Field - - Type - - Description - - addedAuras - - AuraData? - - List of auras added to the unit during this update. - - updatedAuraInstanceIDs - - *number?* - - List of existing auras on the unit modified during this update. - - removedAuraInstanceIDs - - *number?* - - List of existing auras removed from the unit during this update. - - isFullUpdate - - *boolean?* = false - - Whether or not a full update of the units' auras should be performed. If this is set, the other fields will likely be nil. - - AuraData - - Field - - Type - - Description - - applications - - *number* - - auraInstanceID - - *number* - - canApplyAura - - *boolean* - - Whether or not the player can apply this aura. - - charges - - *number* - - dispelName - - *string?* - - duration - - *number* - - expirationTime - - *number* - - icon - - *number* - - isBossAura - - *boolean* - - Whether or not this aura was applied by a boss. - - isFromPlayerOrPlayerPet - - *boolean* - - Whether or not this aura was applied by a player or their pet. - - isHarmful - - *boolean* - - Whether or not this aura is a debuff. - - isHelpful - - *boolean* - - Whether or not this aura is a buff. - - isNameplateOnly - - *boolean* - - Whether or not this aura should appear on nameplates. - - isRaid - - *boolean* - - Whether or not this aura meets the conditions of the RAID aura filter. - - isStealable - - *boolean* - - maxCharges - - *number* - - name - - *string* - - The name of the aura. - - nameplateShowAll - - *boolean* - - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - nameplateShowPersonal - - *boolean* - - points - - *array* - - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - sourceUnit - - *string?* - - Token of the unit that applied the aura. - - spellId - - *number* - - The spell ID of the aura. - - timeMod - - *number* - -**Content Details:** -The extended payload can be supplied to the AuraUtil.ShouldSkipAuraUpdate function alongside a predicate function to determine if a consumer of this event may skip further processing of the event as a performance optimization. -Related API -UnitAura - -**Usage:** -The aura InstanceIDs can be used to efficiently process aura updates and is queried with C_UnitAuras.GetAuraDataByAuraInstanceID. - Warning: GetAuraDataByAuraInstanceID doesn't work on removed aura InstanceIDs, so it might be a good idea to cache the information. -```lua -local count = 0 -local function OnEvent(self, event, unit, info) - count = count + 1 - if info.isFullUpdate then - print("full update") - return - end - if info.addedAuras then - local t = {} - for _, v in pairs(info.addedAuras) do - tinsert(t, format("%d(%s)", v.auraInstanceID, v.name)) - end - print(count, unit, "|cnGREEN_FONT_COLOR:added|r", table.concat(t, ", ")) - end - if info.updatedAuraInstanceIDs then - local t = {} - for _, v in pairs(info.updatedAuraInstanceIDs) do - local aura = C_UnitAuras.GetAuraDataByAuraInstanceID(unit, v) - tinsert(t, format("%d(%s)", aura.auraInstanceID, aura.name)) - end - print(count, unit, "|cnYELLOW_FONT_COLOR:updated|r", table.concat(t, ", ")) - end - if info.removedAuraInstanceIDs then - local t = {} - for _, v in pairs(info.removedAuraInstanceIDs) do - tinsert(t, v) - end - print(count, unit, "|cnRED_FONT_COLOR:removed|r", table.concat(t, ", ")) - end -end -local f = CreateFrame("Frame") -f:RegisterEvent("UNIT_AURA") -f:SetScript("OnEvent", OnEvent) -``` -The payload can contain any combination of addedAuras, updatedAuraInstanceIDs and removedAuraInstanceIDs. \ No newline at end of file diff --git a/wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md b/wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md deleted file mode 100644 index 50e191cf..00000000 --- a/wiki-information/events/UNIT_CHEAT_TOGGLE_EVENT.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UNIT_CHEAT_TOGGLE_EVENT - -**Title:** UNIT CHEAT TOGGLE EVENT - -**Content:** -Needs summary. -`UNIT_CHEAT_TOGGLE_EVENT` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md b/wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md deleted file mode 100644 index bba6938d..00000000 --- a/wiki-information/events/UNIT_CLASSIFICATION_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_CLASSIFICATION_CHANGED - -**Title:** UNIT CLASSIFICATION CHANGED - -**Content:** -Needs summary. -`UNIT_CLASSIFICATION_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_COMBAT.md b/wiki-information/events/UNIT_COMBAT.md deleted file mode 100644 index edd378f4..00000000 --- a/wiki-information/events/UNIT_COMBAT.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: UNIT_COMBAT - -**Title:** UNIT COMBAT - -**Content:** -Fired when an npc or player participates in combat and takes damage -`UNIT_COMBAT: unitTarget, event, flagText, amount, schoolMask` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `event` - - *string* - Action, Damage, etc (e.g. HEAL, DODGE, BLOCK, WOUND, MISS, PARRY, RESIST, ...) -- `flagText` - - *string* - Critical/Glancing indicator (e.g. CRITICAL, CRUSHING, GLANCING) -- `amount` - - *number* - The numeric damage -- `schoolMask` - - *number* - Damage type in numeric value (1 - physical; 2 - holy; 4 - fire; 8 - nature; 16 - frost; 32 - shadow; 64 - arcane) \ No newline at end of file diff --git a/wiki-information/events/UNIT_CONNECTION.md b/wiki-information/events/UNIT_CONNECTION.md deleted file mode 100644 index da314b0d..00000000 --- a/wiki-information/events/UNIT_CONNECTION.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: UNIT_CONNECTION - -**Title:** UNIT CONNECTION - -**Content:** -Needs summary. -`UNIT_CONNECTION: unitTarget, isConnected` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `isConnected` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/UNIT_DAMAGE.md b/wiki-information/events/UNIT_DAMAGE.md deleted file mode 100644 index 37eb2909..00000000 --- a/wiki-information/events/UNIT_DAMAGE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: UNIT_DAMAGE - -**Title:** UNIT DAMAGE - -**Content:** -Fired when the units melee damage changes. -`UNIT_DAMAGE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -Be warned that this often gets fired multiple times, for example when you change weapons. \ No newline at end of file diff --git a/wiki-information/events/UNIT_DEFENSE.md b/wiki-information/events/UNIT_DEFENSE.md deleted file mode 100644 index fbcb3214..00000000 --- a/wiki-information/events/UNIT_DEFENSE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_DEFENSE - -**Title:** UNIT DEFENSE - -**Content:** -Fired when a units defense is affected. -`UNIT_DEFENSE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_DISPLAYPOWER.md b/wiki-information/events/UNIT_DISPLAYPOWER.md deleted file mode 100644 index d2ef4646..00000000 --- a/wiki-information/events/UNIT_DISPLAYPOWER.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_DISPLAYPOWER - -**Title:** UNIT DISPLAYPOWER - -**Content:** -Fired when the unit's mana stype is changed. Occurs when a druid shapeshifts as well as in certain other cases. -`UNIT_DISPLAYPOWER: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_ENTERED_VEHICLE.md b/wiki-information/events/UNIT_ENTERED_VEHICLE.md deleted file mode 100644 index a08a9138..00000000 --- a/wiki-information/events/UNIT_ENTERED_VEHICLE.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: UNIT_ENTERED_VEHICLE - -**Title:** UNIT ENTERED VEHICLE - -**Content:** -Fired once the unit is considered to be inside a vehicle, as compared to UNIT_ENTERING_VEHICLE which happens beforehand. -`UNIT_ENTERED_VEHICLE: unitTarget, showVehicleFrame, isControlSeat, vehicleUIIndicatorID, vehicleGUID, mayChooseExit, hasPitch` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `showVehicleFrame` - - *boolean* - Vehicle has vehicle UI. -- `isControlSeat` - - *boolean* -- `vehicleUIIndicatorID` - - *number* - VehicleType (possible values are 'Natural' and 'Mechanical' and 'VehicleMount' and 'VehicleMount_Organic' or empty string). -- `vehicleGUID` - - *string* -- `mayChooseExit` - - *boolean* -- `hasPitch` - - *boolean* - Vehicle can aim. \ No newline at end of file diff --git a/wiki-information/events/UNIT_ENTERING_VEHICLE.md b/wiki-information/events/UNIT_ENTERING_VEHICLE.md deleted file mode 100644 index 2de36cca..00000000 --- a/wiki-information/events/UNIT_ENTERING_VEHICLE.md +++ /dev/null @@ -1,23 +0,0 @@ -## Event: UNIT_ENTERING_VEHICLE - -**Title:** UNIT ENTERING VEHICLE - -**Content:** -Fired as a unit is about to enter a vehicle, as compared to UNIT_ENTERED_VEHICLE which happens afterward. -`UNIT_ENTERING_VEHICLE: unitTarget, showVehicleFrame, isControlSeat, vehicleUIIndicatorID, vehicleGUID, mayChooseExit, hasPitch` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `showVehicleFrame` - - *boolean* -- `isControlSeat` - - *boolean* -- `vehicleUIIndicatorID` - - *number* -- `vehicleGUID` - - *string* -- `mayChooseExit` - - *boolean* -- `hasPitch` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/UNIT_EXITED_VEHICLE.md b/wiki-information/events/UNIT_EXITED_VEHICLE.md deleted file mode 100644 index 330b890d..00000000 --- a/wiki-information/events/UNIT_EXITED_VEHICLE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_EXITED_VEHICLE - -**Title:** UNIT EXITED VEHICLE - -**Content:** -Fired once the unit is considered to have left a vehicle, as compared to UNIT_EXITING_VEHICLE which happens beforehand. -`UNIT_EXITED_VEHICLE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_EXITING_VEHICLE.md b/wiki-information/events/UNIT_EXITING_VEHICLE.md deleted file mode 100644 index 51037354..00000000 --- a/wiki-information/events/UNIT_EXITING_VEHICLE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_EXITING_VEHICLE - -**Title:** UNIT EXITING VEHICLE - -**Content:** -Fired as a unit is about to exit a vehicle, as compared to UNIT_EXITED_VEHICLE which happens afterward. -`UNIT_EXITING_VEHICLE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_FACTION.md b/wiki-information/events/UNIT_FACTION.md deleted file mode 100644 index 9a73cde6..00000000 --- a/wiki-information/events/UNIT_FACTION.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_FACTION - -**Title:** UNIT FACTION - -**Content:** -Fired when a unit's faction is available. -`UNIT_FACTION: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_FLAGS.md b/wiki-information/events/UNIT_FLAGS.md deleted file mode 100644 index 3dc53afa..00000000 --- a/wiki-information/events/UNIT_FLAGS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_FLAGS - -**Title:** UNIT FLAGS - -**Content:** -Needs summary. -`UNIT_FLAGS: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_HAPPINESS.md b/wiki-information/events/UNIT_HAPPINESS.md deleted file mode 100644 index 430a30be..00000000 --- a/wiki-information/events/UNIT_HAPPINESS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_HAPPINESS - -**Title:** UNIT HAPPINESS - -**Content:** -Fired when the Pet Happiness changes. -`UNIT_HAPPINESS: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_HEALTH.md b/wiki-information/events/UNIT_HEALTH.md deleted file mode 100644 index fab7029a..00000000 --- a/wiki-information/events/UNIT_HEALTH.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_HEALTH - -**Title:** UNIT HEALTH - -**Content:** -Fires when the health of a unit changes. -`UNIT_HEALTH: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -Related API -UnitHealth \ No newline at end of file diff --git a/wiki-information/events/UNIT_HEALTH_FREQUENT.md b/wiki-information/events/UNIT_HEALTH_FREQUENT.md deleted file mode 100644 index 3e03b23d..00000000 --- a/wiki-information/events/UNIT_HEALTH_FREQUENT.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_HEALTH_FREQUENT - -**Title:** UNIT HEALTH FREQUENT - -**Content:** -Same event as UNIT_HEALTH but not throttled as aggressively by the client. -`UNIT_HEALTH_FREQUENT: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -Related API -UnitHealth \ No newline at end of file diff --git a/wiki-information/events/UNIT_HEAL_PREDICTION.md b/wiki-information/events/UNIT_HEAL_PREDICTION.md deleted file mode 100644 index 3acb2b3f..00000000 --- a/wiki-information/events/UNIT_HEAL_PREDICTION.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_HEAL_PREDICTION - -**Title:** UNIT HEAL PREDICTION - -**Content:** -Needs summary. -`UNIT_HEAL_PREDICTION: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_INVENTORY_CHANGED.md b/wiki-information/events/UNIT_INVENTORY_CHANGED.md deleted file mode 100644 index 61087d11..00000000 --- a/wiki-information/events/UNIT_INVENTORY_CHANGED.md +++ /dev/null @@ -1,20 +0,0 @@ -## Event: UNIT_INVENTORY_CHANGED - -**Title:** UNIT INVENTORY CHANGED - -**Content:** -Fired when the player equips or unequips an item. -`UNIT_INVENTORY_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -This event is not triggered when equipping/unequipping rings or trinkets. -This can also be called if your target or party members changes equipment (untested for hostile targets). -This event is also raised when a new item is placed in the player's containers, taking up a new slot. If the new item(s) are placed onto an existing stack or when two stacks already in the containers are merged, the event is not raised. When an item is moved inside the container or to the bank, the event is not raised. The event is raised when an existing stack is split inside the player's containers. -This event is also raised when a temporary enhancement (poison, lure, etc..) is applied to the player's weapon (untested for other units). It will again be raised when that enhancement is removed, including by manual cancellation or buff expiration. -If multiple slots are equipped/unequipped at once it only fires once now. -This event is triggered during initial character login but not during subsequent reloads. -This event is no longer triggered when changing zones. Inventory information is available when PLAYER_ENTERING_WORLD is triggered. \ No newline at end of file diff --git a/wiki-information/events/UNIT_LEVEL.md b/wiki-information/events/UNIT_LEVEL.md deleted file mode 100644 index 17ee9c5e..00000000 --- a/wiki-information/events/UNIT_LEVEL.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_LEVEL - -**Title:** UNIT LEVEL - -**Content:** -Fired whenever the level of a unit is available (e.g. when clicking a unit or someone joins the party). -`UNIT_LEVEL: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_MANA.md b/wiki-information/events/UNIT_MANA.md deleted file mode 100644 index b64a241e..00000000 --- a/wiki-information/events/UNIT_MANA.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_MANA - -**Title:** UNIT MANA - -**Content:** -Fired whenever a unit's mana changes. -`UNIT_MANA: unitTarget` - -**Payload:** -- `unitTarget` - - *string* - UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_MAXHEALTH.md b/wiki-information/events/UNIT_MAXHEALTH.md deleted file mode 100644 index c73d1e54..00000000 --- a/wiki-information/events/UNIT_MAXHEALTH.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_MAXHEALTH - -**Title:** UNIT MAXHEALTH - -**Content:** -Fires when the maximum health of a unit changes. -`UNIT_MAXHEALTH: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -Related API -UnitHealthMax \ No newline at end of file diff --git a/wiki-information/events/UNIT_MAXPOWER.md b/wiki-information/events/UNIT_MAXPOWER.md deleted file mode 100644 index 1355cdcb..00000000 --- a/wiki-information/events/UNIT_MAXPOWER.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: UNIT_MAXPOWER - -**Title:** UNIT MAXPOWER - -**Content:** -Fired when a unit's maximum power (mana, rage, focus, energy, runic power, ...) changes. -`UNIT_MAXPOWER: unitTarget, powerType` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `powerType` - - *string* - resource whose maximum value changed: "MANA", "RAGE", "ENERGY", "FOCUS", "HAPPINESS", "RUNIC_POWER". \ No newline at end of file diff --git a/wiki-information/events/UNIT_MODEL_CHANGED.md b/wiki-information/events/UNIT_MODEL_CHANGED.md deleted file mode 100644 index a6643bec..00000000 --- a/wiki-information/events/UNIT_MODEL_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_MODEL_CHANGED - -**Title:** UNIT MODEL CHANGED - -**Content:** -Fired when the unit's 3d model changes. -`UNIT_MODEL_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_NAME_UPDATE.md b/wiki-information/events/UNIT_NAME_UPDATE.md deleted file mode 100644 index 442b4003..00000000 --- a/wiki-information/events/UNIT_NAME_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_NAME_UPDATE - -**Title:** UNIT NAME UPDATE - -**Content:** -Fired when a unit's name changes. -`UNIT_NAME_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md b/wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md deleted file mode 100644 index f7567283..00000000 --- a/wiki-information/events/UNIT_OTHER_PARTY_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: UNIT_OTHER_PARTY_CHANGED - -**Title:** UNIT OTHER PARTY CHANGED - -**Content:** -Fired when a unit enter or leave an instance group while within a regular group. -Example¹: a unit doing dungeon finder, accepts an invite from a friend outside the instanced group. -Example²: the same unit leaves the instanced group and, is now in fact, inside the friend's group. -`UNIT_OTHER_PARTY_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PET.md b/wiki-information/events/UNIT_PET.md deleted file mode 100644 index 1fdb771f..00000000 --- a/wiki-information/events/UNIT_PET.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_PET - -**Title:** UNIT PET - -**Content:** -Fired when a unit's pet changes. -`UNIT_PET: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PET_EXPERIENCE.md b/wiki-information/events/UNIT_PET_EXPERIENCE.md deleted file mode 100644 index 8bf85124..00000000 --- a/wiki-information/events/UNIT_PET_EXPERIENCE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_PET_EXPERIENCE - -**Title:** UNIT PET EXPERIENCE - -**Content:** -Fired when the pet's experience changes. -`UNIT_PET_EXPERIENCE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PET_TRAINING_POINTS.md b/wiki-information/events/UNIT_PET_TRAINING_POINTS.md deleted file mode 100644 index 348c61f0..00000000 --- a/wiki-information/events/UNIT_PET_TRAINING_POINTS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_PET_TRAINING_POINTS - -**Title:** UNIT PET TRAINING POINTS - -**Content:** -Needs summary. -`UNIT_PET_TRAINING_POINTS: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_PHASE.md b/wiki-information/events/UNIT_PHASE.md deleted file mode 100644 index 531f00ab..00000000 --- a/wiki-information/events/UNIT_PHASE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: UNIT_PHASE - -**Title:** UNIT PHASE - -**Content:** -Fires when a unit becomes phased or unphased. -`UNIT_PHASE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Related Information:** -UnitPhaseReason(unit) \ No newline at end of file diff --git a/wiki-information/events/UNIT_PORTRAIT_UPDATE.md b/wiki-information/events/UNIT_PORTRAIT_UPDATE.md deleted file mode 100644 index 13c1ecff..00000000 --- a/wiki-information/events/UNIT_PORTRAIT_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_PORTRAIT_UPDATE - -**Title:** UNIT PORTRAIT UPDATE - -**Content:** -Fired when a units portrait changes. -`UNIT_PORTRAIT_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_BAR_HIDE.md b/wiki-information/events/UNIT_POWER_BAR_HIDE.md deleted file mode 100644 index d61109c9..00000000 --- a/wiki-information/events/UNIT_POWER_BAR_HIDE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_POWER_BAR_HIDE - -**Title:** UNIT POWER BAR HIDE - -**Content:** -Needs summary. -`UNIT_POWER_BAR_HIDE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_BAR_SHOW.md b/wiki-information/events/UNIT_POWER_BAR_SHOW.md deleted file mode 100644 index af4b881e..00000000 --- a/wiki-information/events/UNIT_POWER_BAR_SHOW.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_POWER_BAR_SHOW - -**Title:** UNIT POWER BAR SHOW - -**Content:** -Needs summary. -`UNIT_POWER_BAR_SHOW: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md b/wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md deleted file mode 100644 index 08ba3074..00000000 --- a/wiki-information/events/UNIT_POWER_BAR_TIMER_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_POWER_BAR_TIMER_UPDATE - -**Title:** UNIT POWER BAR TIMER UPDATE - -**Content:** -Needs summary. -`UNIT_POWER_BAR_TIMER_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_FREQUENT.md b/wiki-information/events/UNIT_POWER_FREQUENT.md deleted file mode 100644 index fdf60d6b..00000000 --- a/wiki-information/events/UNIT_POWER_FREQUENT.md +++ /dev/null @@ -1,20 +0,0 @@ -## Event: UNIT_POWER_FREQUENT - -**Title:** UNIT POWER FREQUENT - -**Content:** -Fired when a unit's current power (mana, rage, focus, energy, runic power, holy power, ...) changes. -`UNIT_POWER_FREQUENT: unitTarget, powerType` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `powerType` - - *string* - -**Content Details:** -Unlike UNIT_POWER_UPDATE, this event will fire multiple times per frame while the unit's power is regenerating or decaying quickly. -Related API -UnitPower -Related Events -UNIT_POWER_UPDATE \ No newline at end of file diff --git a/wiki-information/events/UNIT_POWER_UPDATE.md b/wiki-information/events/UNIT_POWER_UPDATE.md deleted file mode 100644 index b7c66fe0..00000000 --- a/wiki-information/events/UNIT_POWER_UPDATE.md +++ /dev/null @@ -1,25 +0,0 @@ -## Event: UNIT_POWER_UPDATE - -**Title:** UNIT POWER UPDATE - -**Content:** -Fired when a unit's current power (mana, rage, focus, energy, runic power, holy power, ...) changes. See below for details. -`UNIT_POWER_UPDATE: unitTarget, powerType` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `powerType` - - *string* - resource whose value changed: "MANA", "RAGE", "ENERGY", "FOCUS", "HAPPINESS", "RUNIC_POWER", "HOLY_POWER". - -**Content Details:** -This event is fired under the following conditions: -- A spell is cast which changes the unit's power. -- The unit reaches full power. -- While the unit's power is naturally regenerating or decaying, this event will only fire once every two seconds. See UNIT_POWER_FREQUENT for a more exact alternative. -Related API -- UnitPower -Related Events -- UNIT_POWER_FREQUENT -Related Enum -- Enum.PowerType \ No newline at end of file diff --git a/wiki-information/events/UNIT_QUEST_LOG_CHANGED.md b/wiki-information/events/UNIT_QUEST_LOG_CHANGED.md deleted file mode 100644 index e85a32be..00000000 --- a/wiki-information/events/UNIT_QUEST_LOG_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_QUEST_LOG_CHANGED - -**Title:** UNIT QUEST LOG CHANGED - -**Content:** -Fired whenever the quest log changes. (Frequently, but not as frequently as QUEST_LOG_UPDATE) -`UNIT_QUEST_LOG_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_RANGEDDAMAGE.md b/wiki-information/events/UNIT_RANGEDDAMAGE.md deleted file mode 100644 index dcdf2d14..00000000 --- a/wiki-information/events/UNIT_RANGEDDAMAGE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_RANGEDDAMAGE - -**Title:** UNIT RANGEDDAMAGE - -**Content:** -Fired when a unit's ranged damage changes. -`UNIT_RANGEDDAMAGE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_RANGED_ATTACK_POWER.md b/wiki-information/events/UNIT_RANGED_ATTACK_POWER.md deleted file mode 100644 index 1686b6f5..00000000 --- a/wiki-information/events/UNIT_RANGED_ATTACK_POWER.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_RANGED_ATTACK_POWER - -**Title:** UNIT RANGED ATTACK POWER - -**Content:** -Fired when a unit's ranged attack power changes. -`UNIT_RANGED_ATTACK_POWER: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_RESISTANCES.md b/wiki-information/events/UNIT_RESISTANCES.md deleted file mode 100644 index 24f63ef5..00000000 --- a/wiki-information/events/UNIT_RESISTANCES.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_RESISTANCES - -**Title:** UNIT RESISTANCES - -**Content:** -Fired when the units resistance changes -`UNIT_RESISTANCES: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md deleted file mode 100644 index 5c228b9e..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_START.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_CHANNEL_START - -**Title:** UNIT SPELLCAST CHANNEL START - -**Content:** -Fired when a unit begins channeling in the course of casting a spell. Received for party/raid members as well as the player. -`UNIT_SPELLCAST_CHANNEL_START: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md deleted file mode 100644 index 528a54e6..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_STOP.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_CHANNEL_STOP - -**Title:** UNIT SPELLCAST CHANNEL STOP - -**Content:** -Fired when a unit stops channeling. Received for party/raid members as well as the player. -`UNIT_SPELLCAST_CHANNEL_STOP: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md b/wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md deleted file mode 100644 index a0154716..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_CHANNEL_UPDATE.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_CHANNEL_UPDATE - -**Title:** UNIT SPELLCAST CHANNEL UPDATE - -**Content:** -Fires while a unit is channeling. Received for party/raid members, as well as the player. -`UNIT_SPELLCAST_CHANNEL_UPDATE: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_DELAYED.md b/wiki-information/events/UNIT_SPELLCAST_DELAYED.md deleted file mode 100644 index 9667a1d1..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_DELAYED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_DELAYED - -**Title:** UNIT SPELLCAST DELAYED - -**Content:** -Fired when a unit's spellcast is delayed, including party/raid members or the player. -`UNIT_SPELLCAST_DELAYED: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_FAILED.md b/wiki-information/events/UNIT_SPELLCAST_FAILED.md deleted file mode 100644 index f3d62c2a..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_FAILED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_FAILED - -**Title:** UNIT SPELLCAST FAILED - -**Content:** -Fired when a unit's spellcast fails, including party/raid members or the player. -`UNIT_SPELLCAST_FAILED: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md b/wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md deleted file mode 100644 index a92c432e..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_FAILED_QUIET.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_FAILED_QUIET - -**Title:** UNIT SPELLCAST FAILED QUIET - -**Content:** -Needs summary. -`UNIT_SPELLCAST_FAILED_QUIET: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md b/wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md deleted file mode 100644 index d2a464ce..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_INTERRUPTED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_INTERRUPTED - -**Title:** UNIT SPELLCAST INTERRUPTED - -**Content:** -Fired when a unit's spellcast is interrupted, including party/raid members or the player. -`UNIT_SPELLCAST_INTERRUPTED: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_SENT.md b/wiki-information/events/UNIT_SPELLCAST_SENT.md deleted file mode 100644 index b0cef023..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_SENT.md +++ /dev/null @@ -1,20 +0,0 @@ -## Event: UNIT_SPELLCAST_SENT - -**Title:** UNIT SPELLCAST SENT - -**Content:** -Fired when a unit attempts to cast a spell regardless of the success of the cast. -`UNIT_SPELLCAST_SENT: unit, target, castGUID, spellID` - -**Payload:** -- `unit` - - *string* : UnitId - Only fires for "player" -- `target` - - *string* : UnitId -- `castGUID` - - *string* : GUID - e.g. for (Spell ID 1543) "Cast-3-3783-1-7-1543-000197DD84" -- `spellID` - - *number* - -**Content Details:** -Fired when a unit tries to cast an instant, non-instant, or channeling spell even if out of range or out of line-of-sight (unless the unit is attempting to cast a non-instant spell while already casting or attempting to cast a spell that is on cooldown). \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_START.md b/wiki-information/events/UNIT_SPELLCAST_START.md deleted file mode 100644 index b0a01ed2..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_START.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_START - -**Title:** UNIT SPELLCAST START - -**Content:** -Fired when a unit begins casting a non-instant cast spell, including party/raid members or the player. -`UNIT_SPELLCAST_START: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_STOP.md b/wiki-information/events/UNIT_SPELLCAST_STOP.md deleted file mode 100644 index 8b6c1216..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_STOP.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_STOP - -**Title:** UNIT SPELLCAST STOP - -**Content:** -Fired when a unit stops casting, including party/raid members or the player. -`UNIT_SPELLCAST_STOP: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md b/wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md deleted file mode 100644 index da74efec..00000000 --- a/wiki-information/events/UNIT_SPELLCAST_SUCCEEDED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: UNIT_SPELLCAST_SUCCEEDED - -**Title:** UNIT SPELLCAST SUCCEEDED - -**Content:** -Fired when a spell is cast successfully. Event is received even if spell is resisted. -`UNIT_SPELLCAST_SUCCEEDED: unitTarget, castGUID, spellID` - -**Payload:** -- `unitTarget` - - *string* : UnitId -- `castGUID` - - *string* -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UNIT_SPELL_HASTE.md b/wiki-information/events/UNIT_SPELL_HASTE.md deleted file mode 100644 index ffacee3a..00000000 --- a/wiki-information/events/UNIT_SPELL_HASTE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_SPELL_HASTE - -**Title:** UNIT SPELL HASTE - -**Content:** -Needs summary. -`UNIT_SPELL_HASTE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_STATS.md b/wiki-information/events/UNIT_STATS.md deleted file mode 100644 index f52f3d2e..00000000 --- a/wiki-information/events/UNIT_STATS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_STATS - -**Title:** UNIT STATS - -**Content:** -Fired when a units stats are available. -`UNIT_STATS: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_TARGET.md b/wiki-information/events/UNIT_TARGET.md deleted file mode 100644 index f6216ab1..00000000 --- a/wiki-information/events/UNIT_TARGET.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: UNIT_TARGET - -**Title:** UNIT TARGET - -**Content:** -Fired when the target of yourself, raid, and party members change -`UNIT_TARGET: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -Should also work for 'pet' and 'focus'. This event only fires when the triggering unit is within the player's visual range. \ No newline at end of file diff --git a/wiki-information/events/UNIT_TARGETABLE_CHANGED.md b/wiki-information/events/UNIT_TARGETABLE_CHANGED.md deleted file mode 100644 index 0b920099..00000000 --- a/wiki-information/events/UNIT_TARGETABLE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_TARGETABLE_CHANGED - -**Title:** UNIT TARGETABLE CHANGED - -**Content:** -Needs summary. -`UNIT_TARGETABLE_CHANGED: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UNIT_THREAT_LIST_UPDATE.md b/wiki-information/events/UNIT_THREAT_LIST_UPDATE.md deleted file mode 100644 index 9bfb765a..00000000 --- a/wiki-information/events/UNIT_THREAT_LIST_UPDATE.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: UNIT_THREAT_LIST_UPDATE - -**Title:** UNIT THREAT LIST UPDATE - -**Content:** -Fired when the client receives updated threat information from the server, if an available mob's threat list has changed at all (i.e. anybody in combat with it has done anything). -`UNIT_THREAT_LIST_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId - -**Content Details:** -The unitTarget parameter may be "target" or "nameplateX" (and possibly some other units). However, this event does not fire for "targettarget" or "raidXtarget" (in WoW 1.13.6), even though updated threat values may be available using UnitDetailedThreatSituation. Therefore, threat addons for healers may need to periodically poll UnitDetailedThreatSituation, since enemies may be outside nameplate range (which is very short in Classic) and changing targets is undesired. \ No newline at end of file diff --git a/wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md b/wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md deleted file mode 100644 index 192b48de..00000000 --- a/wiki-information/events/UNIT_THREAT_SITUATION_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UNIT_THREAT_SITUATION_UPDATE - -**Title:** UNIT THREAT SITUATION UPDATE - -**Content:** -Fired when an available unit on an available mob's threat list moves past another unit on that list. -`UNIT_THREAT_SITUATION_UPDATE: unitTarget` - -**Payload:** -- `unitTarget` - - *string* : UnitId \ No newline at end of file diff --git a/wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md b/wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md deleted file mode 100644 index 23ee0b98..00000000 --- a/wiki-information/events/UPDATE_ACTIVE_BATTLEFIELD.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE ACTIVE BATTLEFIELD - -**Title:** UPDATE ACTIVE BATTLEFIELD - -**Content:** -Needs summary. -`UPDATE_ACTIVE_BATTLEFIELD` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_ALL_UI_WIDGETS.md b/wiki-information/events/UPDATE_ALL_UI_WIDGETS.md deleted file mode 100644 index c30f996e..00000000 --- a/wiki-information/events/UPDATE_ALL_UI_WIDGETS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_ALL_UI_WIDGETS - -**Title:** UPDATE ALL UI WIDGETS - -**Content:** -Needs summary. -`UPDATE_ALL_UI_WIDGETS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md b/wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md deleted file mode 100644 index 4630f3d7..00000000 --- a/wiki-information/events/UPDATE_BATTLEFIELD_SCORE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_BATTLEFIELD_SCORE - -**Title:** UPDATE BATTLEFIELD SCORE - -**Content:** -Fired whenever new battlefield score data has been received, this is usually fired after RequestBattlefieldScoreData is called. -`UPDATE_BATTLEFIELD_SCORE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md b/wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md deleted file mode 100644 index 0e10ce60..00000000 --- a/wiki-information/events/UPDATE_BATTLEFIELD_STATUS.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: UPDATE_BATTLEFIELD_STATUS - -**Title:** UPDATE BATTLEFIELD STATUS - -**Content:** -Fired whenever joining a queue, leaving a queue, battlefield to join is changed, when you can join a battlefield, or if somebody wins the battleground. -`UPDATE_BATTLEFIELD_STATUS: battleFieldIndex` - -**Payload:** -- `battleFieldIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BINDINGS.md b/wiki-information/events/UPDATE_BINDINGS.md deleted file mode 100644 index da474f1f..00000000 --- a/wiki-information/events/UPDATE_BINDINGS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_BINDINGS - -**Title:** UPDATE BINDINGS - -**Content:** -Fired when the keybindings are changed. Fired after completion of LoadBindings, SaveBindings, and SetBinding (and its derivatives). -`UPDATE_BINDINGS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_BONUS_ACTIONBAR.md b/wiki-information/events/UPDATE_BONUS_ACTIONBAR.md deleted file mode 100644 index d5b8907e..00000000 --- a/wiki-information/events/UPDATE_BONUS_ACTIONBAR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_BONUS_ACTIONBAR - -**Title:** UPDATE BONUS ACTIONBAR - -**Content:** -Needs summary. -`UPDATE_BONUS_ACTIONBAR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_CHAT_COLOR.md b/wiki-information/events/UPDATE_CHAT_COLOR.md deleted file mode 100644 index 5ee1327e..00000000 --- a/wiki-information/events/UPDATE_CHAT_COLOR.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: UPDATE_CHAT_COLOR - -**Title:** UPDATE CHAT COLOR - -**Content:** -Fired when the chat colour needs to be updated. Refer to ChangeChatColor for details on the parameters. -`UPDATE_CHAT_COLOR: name, r, g, b` - -**Payload:** -- `name` - - *string* - Chat type -- `r` - - *number* - red -- `g` - - *number* - green -- `b` - - *number* - blue \ No newline at end of file diff --git a/wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md b/wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md deleted file mode 100644 index a1cf62ec..00000000 --- a/wiki-information/events/UPDATE_CHAT_COLOR_NAME_BY_CLASS.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: UPDATE_CHAT_COLOR_NAME_BY_CLASS - -**Title:** UPDATE CHAT COLOR NAME BY CLASS - -**Content:** -Needs summary. -`UPDATE_CHAT_COLOR_NAME_BY_CLASS: name, colorNameByClass` - -**Payload:** -- `name` - - *string* -- `colorNameByClass` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/UPDATE_CHAT_WINDOWS.md b/wiki-information/events/UPDATE_CHAT_WINDOWS.md deleted file mode 100644 index 5bb85b03..00000000 --- a/wiki-information/events/UPDATE_CHAT_WINDOWS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_CHAT_WINDOWS - -**Title:** UPDATE CHAT WINDOWS - -**Content:** -Fired on load when chat settings are available for chat windows. -`UPDATE_CHAT_WINDOWS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_EXHAUSTION.md b/wiki-information/events/UPDATE_EXHAUSTION.md deleted file mode 100644 index 84824be1..00000000 --- a/wiki-information/events/UPDATE_EXHAUSTION.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_EXHAUSTION - -**Title:** UPDATE EXHAUSTION - -**Content:** -Fired when your character's XP exhaustion (i.e. the amount of your character's rested bonus) changes. Use `GetXPExhaustion` to query the current value. -`UPDATE_EXHAUSTION` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_FACTION.md b/wiki-information/events/UPDATE_FACTION.md deleted file mode 100644 index 201fed06..00000000 --- a/wiki-information/events/UPDATE_FACTION.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_FACTION - -**Title:** UPDATE FACTION - -**Content:** -Fired when your character's reputation of some faction has changed. -`UPDATE_FACTION` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md b/wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md deleted file mode 100644 index f82da969..00000000 --- a/wiki-information/events/UPDATE_FLOATING_CHAT_WINDOWS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_FLOATING_CHAT_WINDOWS - -**Title:** UPDATE FLOATING CHAT WINDOWS - -**Content:** -Fired on load when chat settings are available for a certain chat window. -`UPDATE_FLOATING_CHAT_WINDOWS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_INSTANCE_INFO.md b/wiki-information/events/UPDATE_INSTANCE_INFO.md deleted file mode 100644 index 839b7345..00000000 --- a/wiki-information/events/UPDATE_INSTANCE_INFO.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_INSTANCE_INFO - -**Title:** UPDATE INSTANCE INFO - -**Content:** -Fired when data from RequestRaidInfo is available. -`UPDATE_INSTANCE_INFO` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_INVENTORY_ALERTS.md b/wiki-information/events/UPDATE_INVENTORY_ALERTS.md deleted file mode 100644 index 81f84c58..00000000 --- a/wiki-information/events/UPDATE_INVENTORY_ALERTS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_INVENTORY_ALERTS - -**Title:** UPDATE INVENTORY ALERTS - -**Content:** -Fires whenever an item's durability status becomes yellow (low) or red (broken). Signals that the durability frame needs to be updated. May also fire on any durability status change, even if that change doesn't require an update to the durability frame. -`UPDATE_INVENTORY_ALERTS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_INVENTORY_DURABILITY.md b/wiki-information/events/UPDATE_INVENTORY_DURABILITY.md deleted file mode 100644 index 293480d1..00000000 --- a/wiki-information/events/UPDATE_INVENTORY_DURABILITY.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_INVENTORY_DURABILITY - -**Title:** UPDATE INVENTORY DURABILITY - -**Content:** -Should fire whenever the durability of an item in the character's possession changes. -`UPDATE_INVENTORY_DURABILITY` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_LFG_LIST.md b/wiki-information/events/UPDATE_LFG_LIST.md deleted file mode 100644 index 0a7422c4..00000000 --- a/wiki-information/events/UPDATE_LFG_LIST.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: UPDATE_LFG_LIST - -**Title:** UPDATE LFG LIST - -**Content:** -When fired prompts the LFG UI to update the list of LFG players. Signals LFG query results are available. -`UPDATE_LFG_LIST` - -**Payload:** -- `None` - -**Related Information:** -LFGQuery \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MACROS.md b/wiki-information/events/UPDATE_MACROS.md deleted file mode 100644 index 6b769be2..00000000 --- a/wiki-information/events/UPDATE_MACROS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_MACROS - -**Title:** UPDATE MACROS - -**Content:** -Called after applying or cancelling changes to a macro's content, name and/or icon. -`UPDATE_MACROS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MASTER_LOOT_LIST.md b/wiki-information/events/UPDATE_MASTER_LOOT_LIST.md deleted file mode 100644 index eac89d14..00000000 --- a/wiki-information/events/UPDATE_MASTER_LOOT_LIST.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_MASTER_LOOT_LIST - -**Title:** UPDATE MASTER LOOT LIST - -**Content:** -Needs summary. -`UPDATE_MASTER_LOOT_LIST` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MOUSEOVER_UNIT.md b/wiki-information/events/UPDATE_MOUSEOVER_UNIT.md deleted file mode 100644 index 387a75b7..00000000 --- a/wiki-information/events/UPDATE_MOUSEOVER_UNIT.md +++ /dev/null @@ -1,14 +0,0 @@ -## Event: UPDATE_MOUSEOVER_UNIT - -**Title:** UPDATE MOUSEOVER UNIT - -**Content:** -Fired when the mouseover object needs to be updated. -`UPDATE_MOUSEOVER_UNIT` - -**Payload:** -- `None` - -**Content Details:** -Fired when the target of the "mouseover" UnitId has changed and is a 3d model. (Does not fire when UnitExists("mouseover") becomes nil, or if you mouse over a unitframe.) -This appears to have been changed at some point, it now fires when mousing over unit frames as well. \ No newline at end of file diff --git a/wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md b/wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md deleted file mode 100644 index dd49e1ea..00000000 --- a/wiki-information/events/UPDATE_MULTI_CAST_ACTIONBAR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_MULTI_CAST_ACTIONBAR - -**Title:** UPDATE MULTI CAST ACTIONBAR - -**Content:** -Fired when the shaman totem multicast bar needs an update. -`UPDATE_MULTI_CAST_ACTIONBAR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md b/wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md deleted file mode 100644 index 4c6bbf3d..00000000 --- a/wiki-information/events/UPDATE_OVERRIDE_ACTIONBAR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_OVERRIDE_ACTIONBAR - -**Title:** UPDATE OVERRIDE ACTIONBAR - -**Content:** -Needs summary. -`UPDATE_OVERRIDE_ACTIONBAR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_PENDING_MAIL.md b/wiki-information/events/UPDATE_PENDING_MAIL.md deleted file mode 100644 index b5932631..00000000 --- a/wiki-information/events/UPDATE_PENDING_MAIL.md +++ /dev/null @@ -1,16 +0,0 @@ -## Event: UPDATE_PENDING_MAIL - -**Title:** UPDATE PENDING MAIL - -**Content:** -Fires when there is pending mail. -`UPDATE_PENDING_MAIL` - -**Payload:** -- `None` - -**Content Details:** -Fired when the player enters the world and enters/leaves an instance, if there is mail in the player's mailbox. -Fired when new mail is received. -Fired when mailbox window is closed if the number of mail items in the inbox changed (I.E. you deleted mail) -Does not appear to trigger when auction outbid mail is received... may not in other cases as well \ No newline at end of file diff --git a/wiki-information/events/UPDATE_POSSESS_BAR.md b/wiki-information/events/UPDATE_POSSESS_BAR.md deleted file mode 100644 index bb7d728f..00000000 --- a/wiki-information/events/UPDATE_POSSESS_BAR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_POSSESS_BAR - -**Title:** UPDATE POSSESS BAR - -**Content:** -Needs summary. -`UPDATE_POSSESS_BAR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md b/wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md deleted file mode 100644 index f6edb465..00000000 --- a/wiki-information/events/UPDATE_SHAPESHIFT_COOLDOWN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_SHAPESHIFT_COOLDOWN - -**Title:** UPDATE SHAPESHIFT COOLDOWN - -**Content:** -Needs summary. -`UPDATE_SHAPESHIFT_COOLDOWN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_FORM.md b/wiki-information/events/UPDATE_SHAPESHIFT_FORM.md deleted file mode 100644 index d97f03d2..00000000 --- a/wiki-information/events/UPDATE_SHAPESHIFT_FORM.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_SHAPESHIFT_FORM - -**Title:** UPDATE SHAPESHIFT FORM - -**Content:** -Fired when the current form changes. -`UPDATE_SHAPESHIFT_FORM` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md b/wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md deleted file mode 100644 index 5a9050d0..00000000 --- a/wiki-information/events/UPDATE_SHAPESHIFT_FORMS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_SHAPESHIFT_FORMS - -**Title:** UPDATE SHAPESHIFT FORMS - -**Content:** -Fired when the available set of forms changes (i.e. on skill gain) -`UPDATE_SHAPESHIFT_FORMS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md b/wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md deleted file mode 100644 index d2dbeb76..00000000 --- a/wiki-information/events/UPDATE_SHAPESHIFT_USABLE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_SHAPESHIFT_USABLE - -**Title:** UPDATE SHAPESHIFT USABLE - -**Content:** -Needs summary. -`UPDATE_SHAPESHIFT_USABLE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_STEALTH.md b/wiki-information/events/UPDATE_STEALTH.md deleted file mode 100644 index cbbf6d66..00000000 --- a/wiki-information/events/UPDATE_STEALTH.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: UPDATE_STEALTH - -**Title:** UPDATE STEALTH - -**Content:** -Fires when a player enters or leaves stealth. -`UPDATE_STEALTH` - -**Payload:** -- `None` - -**Related Information:** -IsStealthed() \ No newline at end of file diff --git a/wiki-information/events/UPDATE_TRADESKILL_RECAST.md b/wiki-information/events/UPDATE_TRADESKILL_RECAST.md deleted file mode 100644 index cdde4d3f..00000000 --- a/wiki-information/events/UPDATE_TRADESKILL_RECAST.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_TRADESKILL_RECAST - -**Title:** UPDATE TRADESKILL RECAST - -**Content:** -Needs summary. -`UPDATE_TRADESKILL_RECAST` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_UI_WIDGET.md b/wiki-information/events/UPDATE_UI_WIDGET.md deleted file mode 100644 index c4cb341c..00000000 --- a/wiki-information/events/UPDATE_UI_WIDGET.md +++ /dev/null @@ -1,149 +0,0 @@ -## Event: UPDATE_UI_WIDGET - -**Title:** UPDATE UI WIDGET - -**Content:** -Returns updated UI widget information. -`UPDATE_UI_WIDGET: widgetInfo` - -**Payload:** -- `widgetInfo` - - *UIWidgetInfo* - - **Field** - - **Type** - - **Description** - - `widgetID` - - *number* - - UiWidget.db2 - - `widgetSetID` - - *number* - - UiWidgetSetID - - `widgetType` - - *Enum.UIWidgetVisualizationType* - - `unitToken` - - *string?* - - UnitId; Added in 9.0.1 - - *Enum.UIWidgetVisualizationType* - - **Value** - - **Key** - - **Data Function** - - **Description** - - 0 - - IconAndText - - C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo - - 1 - - CaptureBar - - C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo - - 2 - - StatusBar - - C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo - - 3 - - DoubleStatusBar - - C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo - - 4 - - IconTextAndBackground - - C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo - - 5 - - DoubleIconAndText - - C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo - - 6 - - StackedResourceTracker - - C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo - - 7 - - IconTextAndCurrencies - - C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo - - 8 - - TextWithState - - C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo - - 9 - - HorizontalCurrencies - - C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo - - 10 - - BulletTextList - - C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo - - 11 - - ScenarioHeaderCurrenciesAndBackground - - C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo - - 12 - - TextureAndText - - C_UIWidgetManager.GetTextureAndTextVisualizationInfo - - Added in 8.2.0 - - 13 - - SpellDisplay - - C_UIWidgetManager.GetSpellDisplayVisualizationInfo - - Added in 8.1.0 - - 14 - - DoubleStateIconRow - - C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo - - Added in 8.1.5 - - 15 - - TextureAndTextRow - - C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo - - Added in 8.2.0 - - 16 - - ZoneControl - - C_UIWidgetManager.GetZoneControlVisualizationInfo - - Added in 8.2.0 - - 17 - - CaptureZone - - C_UIWidgetManager.GetCaptureZoneVisualizationInfo - - Added in 8.2.5 - - 18 - - TextureWithAnimation - - C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo - - Added in 9.0.1 - - 19 - - DiscreteProgressSteps - - C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo - - Added in 9.0.1 - - 20 - - ScenarioHeaderTimer - - C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo - - Added in 9.0.1 - - 21 - - TextColumnRow - - C_UIWidgetManager.GetTextColumnRowVisualizationInfo - - Added in 9.1.0 - - 22 - - Spacer - - C_UIWidgetManager.GetSpacerVisualizationInfo - - Added in 9.1.0 - - 23 - - UnitPowerBar - - C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo - - Added in 9.2.0 - - 24 - - FillUpFrames - - C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo - - Added in 10.0.0 - - 25 - - TextWithSubtext - - C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo - - Added in 10.0.2 - - 26 - - WorldLootObject - - Added in 10.1.0 - - 27 - - ItemDisplay - - C_UIWidgetManager.GetItemDisplayVisualizationInfo - - Added in 10.1.0 - -**Usage:** -Prints UI widget information when UPDATE_UI_WIDGET fires. -```lua -local function OnEvent(self, event, w) - local typeInfo = UIWidgetManager:GetWidgetTypeInfo(w.widgetType) - local visInfo = typeInfo.visInfoDataFunction(w.widgetID) - print(w.widgetSetID, w.widgetType, w.widgetID, visInfo) -end - -local f = CreateFrame("Frame") -f:RegisterEvent("UPDATE_UI_WIDGET") -f:SetScript("OnEvent", OnEvent) -``` -You can query the information from the specific data function yourself, or use visInfo which does it programmatically. -E.g. for the Arathi Basin PvP objective: -Widget Set ID: 1 - Top center part of the screen -Widget Type: 3 - Enum.UIWidgetVisualizationType.DoubleStatusBar -Widget ID: 1671 - UiWidget.VisID -> UiWidgetVisualization.ID 1200 "PvP - Domination - Double Status Bar" -/dump C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo(1671) \ No newline at end of file diff --git a/wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md b/wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md deleted file mode 100644 index 6fd694a5..00000000 --- a/wiki-information/events/UPDATE_VEHICLE_ACTIONBAR.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: UPDATE_VEHICLE_ACTIONBAR - -**Title:** UPDATE VEHICLE ACTIONBAR - -**Content:** -Needs summary. -`UPDATE_VEHICLE_ACTIONBAR` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/UPDATE_WEB_TICKET.md b/wiki-information/events/UPDATE_WEB_TICKET.md deleted file mode 100644 index ffc5cf71..00000000 --- a/wiki-information/events/UPDATE_WEB_TICKET.md +++ /dev/null @@ -1,21 +0,0 @@ -## Event: UPDATE_WEB_TICKET - -**Title:** UPDATE WEB TICKET - -**Content:** -Needs summary. -`UPDATE_WEB_TICKET: hasTicket, numTickets, ticketStatus, caseIndex, waitTimeMinutes, waitMessage` - -**Payload:** -- `hasTicket` - - *boolean* -- `numTickets` - - *number?* -- `ticketStatus` - - *number?* -- `caseIndex` - - *number?* -- `waitTimeMinutes` - - *number?* -- `waitMessage` - - *string?* \ No newline at end of file diff --git a/wiki-information/events/USE_BIND_CONFIRM.md b/wiki-information/events/USE_BIND_CONFIRM.md deleted file mode 100644 index e41b3a14..00000000 --- a/wiki-information/events/USE_BIND_CONFIRM.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: USE_BIND_CONFIRM - -**Title:** USE BIND CONFIRM - -**Content:** -Needs summary. -`USE_BIND_CONFIRM` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/USE_GLYPH.md b/wiki-information/events/USE_GLYPH.md deleted file mode 100644 index 1bb9343b..00000000 --- a/wiki-information/events/USE_GLYPH.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: USE_GLYPH - -**Title:** USE GLYPH - -**Content:** -Fires when the player attempts to apply a new glyph to an ability in the spell book. -`USE_GLYPH: spellID` - -**Payload:** -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/USE_NO_REFUND_CONFIRM.md b/wiki-information/events/USE_NO_REFUND_CONFIRM.md deleted file mode 100644 index e1d29fb2..00000000 --- a/wiki-information/events/USE_NO_REFUND_CONFIRM.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: USE_NO_REFUND_CONFIRM - -**Title:** USE NO REFUND CONFIRM - -**Content:** -Needs summary. -`USE_NO_REFUND_CONFIRM` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VARIABLES_LOADED.md b/wiki-information/events/VARIABLES_LOADED.md deleted file mode 100644 index 0bd94568..00000000 --- a/wiki-information/events/VARIABLES_LOADED.md +++ /dev/null @@ -1,18 +0,0 @@ -## Event: VARIABLES_LOADED - -**Title:** VARIABLES LOADED - -**Content:** -Fired in response to the CVars, Keybindings and other associated "Blizzard" variables being loaded. -`VARIABLES_LOADED` - -**Payload:** -- `None` - -**Content Details:** -Since key bindings and macros in particular may be stored on the server they event may be delayed a bit beyond the original loading sequence. -Previously (prior to 3.0.1) this event was part of the loading sequence. Although it still occurs within the same general timeframe as the other events, it no longer has a guaranteed order that can be relied on. This may be problematic to addons that relied on the order of VARIABLES_LOADED, specifically that it would fire before PLAYER_ENTERING_WORLD. -Addons should not use this event to check if their addon's saved variables have loaded. They can use ADDON_LOADED (testing for arg1 being the name of the addon) or another appropriate event to initialize, ensuring that the addon works when loaded on demand. - -**Related Information:** -AddOn loading process \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_ANGLE_SHOW.md b/wiki-information/events/VEHICLE_ANGLE_SHOW.md deleted file mode 100644 index dc878dac..00000000 --- a/wiki-information/events/VEHICLE_ANGLE_SHOW.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VEHICLE_ANGLE_SHOW - -**Title:** VEHICLE ANGLE SHOW - -**Content:** -Needs summary. -`VEHICLE_ANGLE_SHOW: shouldShow` - -**Payload:** -- `shouldShow` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_ANGLE_UPDATE.md b/wiki-information/events/VEHICLE_ANGLE_UPDATE.md deleted file mode 100644 index 03a4f79b..00000000 --- a/wiki-information/events/VEHICLE_ANGLE_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VEHICLE_ANGLE_UPDATE - -**Title:** VEHICLE ANGLE UPDATE - -**Content:** -Needs summary. -`VEHICLE_ANGLE_UPDATE: normalizedPitch, radians` - -**Payload:** -- `normalizedPitch` - - *number* -- `radians` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md b/wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md deleted file mode 100644 index 6f874099..00000000 --- a/wiki-information/events/VEHICLE_PASSENGERS_CHANGED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VEHICLE_PASSENGERS_CHANGED - -**Title:** VEHICLE PASSENGERS CHANGED - -**Content:** -Needs summary. -`VEHICLE_PASSENGERS_CHANGED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_POWER_SHOW.md b/wiki-information/events/VEHICLE_POWER_SHOW.md deleted file mode 100644 index f75e06c4..00000000 --- a/wiki-information/events/VEHICLE_POWER_SHOW.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VEHICLE_POWER_SHOW - -**Title:** VEHICLE POWER SHOW - -**Content:** -Needs summary. -`VEHICLE_POWER_SHOW: shouldShow` - -**Payload:** -- `shouldShow` - - *number?* \ No newline at end of file diff --git a/wiki-information/events/VEHICLE_UPDATE.md b/wiki-information/events/VEHICLE_UPDATE.md deleted file mode 100644 index 5d2a5981..00000000 --- a/wiki-information/events/VEHICLE_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VEHICLE_UPDATE - -**Title:** VEHICLE UPDATE - -**Content:** -Needs summary. -`VEHICLE_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md b/wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md deleted file mode 100644 index 590aca98..00000000 --- a/wiki-information/events/VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED - -**Title:** VOICE CHAT ACTIVE INPUT DEVICE UPDATED - -**Content:** -Needs summary. -`VOICE_CHAT_ACTIVE_INPUT_DEVICE_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md b/wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md deleted file mode 100644 index 20fd096b..00000000 --- a/wiki-information/events/VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED - -**Title:** VOICE CHAT ACTIVE OUTPUT DEVICE UPDATED - -**Content:** -Needs summary. -`VOICE_CHAT_ACTIVE_OUTPUT_DEVICE_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md deleted file mode 100644 index 834ac4a8..00000000 --- a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_ENERGY.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_AUDIO_CAPTURE_ENERGY - -**Title:** VOICE CHAT AUDIO CAPTURE ENERGY - -**Content:** -Needs summary. -`VOICE_CHAT_AUDIO_CAPTURE_ENERGY: isSpeaking, energy` - -**Payload:** -- `isSpeaking` - - *boolean* -- `energy` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md deleted file mode 100644 index 7b4aed36..00000000 --- a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STARTED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_AUDIO_CAPTURE_STARTED - -**Title:** VOICE CHAT AUDIO CAPTURE STARTED - -**Content:** -Needs summary. -`VOICE_CHAT_AUDIO_CAPTURE_STARTED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md b/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md deleted file mode 100644 index e9861cf2..00000000 --- a/wiki-information/events/VOICE_CHAT_AUDIO_CAPTURE_STOPPED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_AUDIO_CAPTURE_STOPPED - -**Title:** VOICE CHAT AUDIO CAPTURE STOPPED - -**Content:** -Needs summary. -`VOICE_CHAT_AUDIO_CAPTURE_STOPPED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md deleted file mode 100644 index eb455997..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_ACTIVATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_ACTIVATED - -**Title:** VOICE CHAT CHANNEL ACTIVATED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_ACTIVATED: channelID` - -**Payload:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md deleted file mode 100644 index 2ef1249a..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_DEACTIVATED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_DEACTIVATED - -**Title:** VOICE CHAT CHANNEL DEACTIVATED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_DEACTIVATED: channelID` - -**Payload:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md deleted file mode 100644 index 0690b7dc..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED - -**Title:** VOICE CHAT CHANNEL DISPLAY NAME CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_DISPLAY_NAME_CHANGED: channelID, channelDisplayName` - -**Payload:** -- `channelID` - - *number* -- `channelDisplayName` - - *string* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md deleted file mode 100644 index 925230d5..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_JOINED.md +++ /dev/null @@ -1,91 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_JOINED - -**Title:** VOICE CHAT CHANNEL JOINED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_JOINED: status, channelID, channelType, clubId, streamId` - -**Payload:** -- `status` - - *number* - Enum.VoiceChatStatusCode -- `channelID` - - *number* -- `channelType` - - *number* - Enum.ChatChannelType -- `clubId` - - *string?* -- `streamId` - - *string?* -- Enum.VoiceChatStatusCode - - Value - - Field - - Description - - 0 - - Success - - 1 - - OperationPending - - 2 - - TooManyRequests - - 3 - - LoginProhibited - - 4 - - ClientNotInitialized - - 5 - - ClientNotLoggedIn - - 6 - - ClientAlreadyLoggedIn - - 7 - - ChannelNameTooShort - - 8 - - ChannelNameTooLong - - 9 - - ChannelAlreadyExists - - 10 - - AlreadyInChannel - - 11 - - TargetNotFound - - 12 - - Failure - - 13 - - ServiceLost - - 14 - - UnableToLaunchProxy - - 15 - - ProxyConnectionTimeOut - - 16 - - ProxyConnectionUnableToConnect - - 17 - - ProxyConnectionUnexpectedDisconnect - - 18 - - Disabled - - 19 - - UnsupportedChatChannelType - - 20 - - InvalidCommunityStream - - 21 - - PlayerSilenced - - 22 - - PlayerVoiceChatParentalDisabled - - 23 - - InvalidInputDevice - - Added in 8.2.0 - - 24 - - InvalidOutputDevice - - Added in 8.2.0 -- Enum.ChatChannelType - - Value - - Field - - Description - - 0 - - None - - 1 - - Custom - - 2 - - Private_Party - - Documented as "PrivateParty" - - 3 - - Public_Party - - Documented as "PublicParty" - - 4 - - Communities \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md deleted file mode 100644 index 70bfb515..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED - -**Title:** VOICE CHAT CHANNEL MEMBER ACTIVE STATE CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_ACTIVE_STATE_CHANGED: memberID, channelID, isActive` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `isActive` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md deleted file mode 100644 index 6d7d8d85..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ADDED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_ADDED - -**Title:** VOICE CHAT CHANNEL MEMBER ADDED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_ADDED: memberID, channelID` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md deleted file mode 100644 index 38a71142..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED - -**Title:** VOICE CHAT CHANNEL MEMBER ENERGY CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_ENERGY_CHANGED: memberID, channelID, speakingEnergy` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `speakingEnergy` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md deleted file mode 100644 index 086cc83e..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED - -**Title:** VOICE CHAT CHANNEL MEMBER GUID UPDATED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_GUID_UPDATED: memberID, channelID` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md deleted file mode 100644 index 4c8b0f34..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED - -**Title:** VOICE CHAT CHANNEL MEMBER MUTE FOR ALL CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ALL_CHANGED: memberID, channelID, isMutedForAll` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `isMutedForAll` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md deleted file mode 100644 index 4d75fad5..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED - -**Title:** VOICE CHAT CHANNEL MEMBER MUTE FOR ME CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_MUTE_FOR_ME_CHANGED: memberID, channelID, isMutedForMe` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `isMutedForMe` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md deleted file mode 100644 index 23b4e5b3..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_REMOVED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_REMOVED - -**Title:** VOICE CHAT CHANNEL MEMBER REMOVED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_REMOVED: memberID, channelID` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md deleted file mode 100644 index 057b5d0f..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED - -**Title:** VOICE CHAT CHANNEL MEMBER SILENCED CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_SILENCED_CHANGED: memberID, channelID, isSilenced` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `isSilenced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md deleted file mode 100644 index cc85e58f..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED - -**Title:** VOICE CHAT CHANNEL MEMBER SPEAKING STATE CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_SPEAKING_STATE_CHANGED: memberID, channelID, isSpeaking` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `isSpeaking` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md deleted file mode 100644 index ff94eeaf..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE - -**Title:** VOICE CHAT CHANNEL MEMBER STT MESSAGE - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_STT_MESSAGE: memberID, channelID, message, language` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `message` - - *string* -- `language` - - *string* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md deleted file mode 100644 index d32afc96..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED.md +++ /dev/null @@ -1,15 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED - -**Title:** VOICE CHAT CHANNEL MEMBER VOLUME CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MEMBER_VOLUME_CHANGED: memberID, channelID, volume` - -**Payload:** -- `memberID` - - *number* -- `channelID` - - *number* -- `volume` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md deleted file mode 100644 index 86c83abc..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED - -**Title:** VOICE CHAT CHANNEL MUTE STATE CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_MUTE_STATE_CHANGED: channelID, isMuted` - -**Payload:** -- `channelID` - - *number* -- `isMuted` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md deleted file mode 100644 index 72d04158..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_PTT_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_PTT_CHANGED - -**Title:** VOICE CHAT CHANNEL PTT CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_PTT_CHANGED: channelID, pushToTalkSetting` - -**Payload:** -- `channelID` - - *number* -- `pushToTalkSetting` - - *string* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md deleted file mode 100644 index dc8bf475..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_REMOVED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_REMOVED - -**Title:** VOICE CHAT CHANNEL REMOVED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_REMOVED: channelID` - -**Payload:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md deleted file mode 100644 index 40230d40..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED - -**Title:** VOICE CHAT CHANNEL TRANSCRIBING CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_TRANSCRIBING_CHANGED: channelID, isTranscribing` - -**Payload:** -- `channelID` - - *number* -- `isTranscribing` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md deleted file mode 100644 index 05bfd24e..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED - -**Title:** VOICE CHAT CHANNEL TRANSMIT CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_TRANSMIT_CHANGED: channelID, isTransmitting` - -**Payload:** -- `channelID` - - *number* -- `isTransmitting` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md b/wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md deleted file mode 100644 index 4f8b1311..00000000 --- a/wiki-information/events/VOICE_CHAT_CHANNEL_VOLUME_CHANGED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOICE_CHAT_CHANNEL_VOLUME_CHANGED - -**Title:** VOICE CHAT CHANNEL VOLUME CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_CHANNEL_VOLUME_CHANGED: channelID, volume` - -**Payload:** -- `channelID` - - *number* -- `volume` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md b/wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md deleted file mode 100644 index 41d7c266..00000000 --- a/wiki-information/events/VOICE_CHAT_COMMUNICATION_MODE_CHANGED.md +++ /dev/null @@ -1,19 +0,0 @@ -## Event: VOICE_CHAT_COMMUNICATION_MODE_CHANGED - -**Title:** VOICE CHAT COMMUNICATION MODE CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_COMMUNICATION_MODE_CHANGED: communicationMode` - -**Payload:** -- `communicationMode` - - *number* - Enum.CommunicationMode - - Enum.CommunicationMode - - Value - - Field - - Description - - 0 - - PushToTalk - - 1 - - OpenMic \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md b/wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md deleted file mode 100644 index d8283cfe..00000000 --- a/wiki-information/events/VOICE_CHAT_CONNECTION_SUCCESS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_CONNECTION_SUCCESS - -**Title:** VOICE CHAT CONNECTION SUCCESS - -**Content:** -Needs summary. -`VOICE_CHAT_CONNECTION_SUCCESS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md b/wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md deleted file mode 100644 index fe687c02..00000000 --- a/wiki-information/events/VOICE_CHAT_DEAFENED_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOICE_CHAT_DEAFENED_CHANGED - -**Title:** VOICE CHAT DEAFENED CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_DEAFENED_CHANGED: isDeafened` - -**Payload:** -- `isDeafened` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_ERROR.md b/wiki-information/events/VOICE_CHAT_ERROR.md deleted file mode 100644 index b38bca3f..00000000 --- a/wiki-information/events/VOICE_CHAT_ERROR.md +++ /dev/null @@ -1,44 +0,0 @@ -## Event: VOICE_CHAT_ERROR - -**Title:** VOICE CHAT ERROR - -**Content:** -Needs summary. -`VOICE_CHAT_ERROR: platformCode, statusCode` - -**Payload:** -- `platformCode` - - *number* -- `statusCode` - - *number* - Enum.VoiceChatStatusCode - - Enum.VoiceChatStatusCode - - Value - - Field - - Description - - 0 - Success - - 1 - OperationPending - - 2 - TooManyRequests - - 3 - LoginProhibited - - 4 - ClientNotInitialized - - 5 - ClientNotLoggedIn - - 6 - ClientAlreadyLoggedIn - - 7 - ChannelNameTooShort - - 8 - ChannelNameTooLong - - 9 - ChannelAlreadyExists - - 10 - AlreadyInChannel - - 11 - TargetNotFound - - 12 - Failure - - 13 - ServiceLost - - 14 - UnableToLaunchProxy - - 15 - ProxyConnectionTimeOut - - 16 - ProxyConnectionUnableToConnect - - 17 - ProxyConnectionUnexpectedDisconnect - - 18 - Disabled - - 19 - UnsupportedChatChannelType - - 20 - InvalidCommunityStream - - 21 - PlayerSilenced - - 22 - PlayerVoiceChatParentalDisabled - - 23 - InvalidInputDevice - - Added in 8.2.0 - - 24 - InvalidOutputDevice - - Added in 8.2.0 \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md b/wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md deleted file mode 100644 index def39441..00000000 --- a/wiki-information/events/VOICE_CHAT_INPUT_DEVICES_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_INPUT_DEVICES_UPDATED - -**Title:** VOICE CHAT INPUT DEVICES UPDATED - -**Content:** -Needs summary. -`VOICE_CHAT_INPUT_DEVICES_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_LOGIN.md b/wiki-information/events/VOICE_CHAT_LOGIN.md deleted file mode 100644 index 6713e58a..00000000 --- a/wiki-information/events/VOICE_CHAT_LOGIN.md +++ /dev/null @@ -1,42 +0,0 @@ -## Event: VOICE_CHAT_LOGIN - -**Title:** VOICE CHAT LOGIN - -**Content:** -Needs summary. -`VOICE_CHAT_LOGIN: status` - -**Payload:** -- `status` - - *number* - Enum.VoiceChatStatusCode - - Enum.VoiceChatStatusCode - - Value - - Field - - Description - - 0 - Success - - 1 - OperationPending - - 2 - TooManyRequests - - 3 - LoginProhibited - - 4 - ClientNotInitialized - - 5 - ClientNotLoggedIn - - 6 - ClientAlreadyLoggedIn - - 7 - ChannelNameTooShort - - 8 - ChannelNameTooLong - - 9 - ChannelAlreadyExists - - 10 - AlreadyInChannel - - 11 - TargetNotFound - - 12 - Failure - - 13 - ServiceLost - - 14 - UnableToLaunchProxy - - 15 - ProxyConnectionTimeOut - - 16 - ProxyConnectionUnableToConnect - - 17 - ProxyConnectionUnexpectedDisconnect - - 18 - Disabled - - 19 - UnsupportedChatChannelType - - 20 - InvalidCommunityStream - - 21 - PlayerSilenced - - 22 - PlayerVoiceChatParentalDisabled - - 23 - InvalidInputDevice - - Added in 8.2.0 - - 24 - InvalidOutputDevice - - Added in 8.2.0 \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_LOGOUT.md b/wiki-information/events/VOICE_CHAT_LOGOUT.md deleted file mode 100644 index 9862c409..00000000 --- a/wiki-information/events/VOICE_CHAT_LOGOUT.md +++ /dev/null @@ -1,42 +0,0 @@ -## Event: VOICE_CHAT_LOGOUT - -**Title:** VOICE CHAT LOGOUT - -**Content:** -Needs summary. -`VOICE_CHAT_LOGOUT: status` - -**Payload:** -- `status` - - *number* - Enum.VoiceChatStatusCode - - Enum.VoiceChatStatusCode - - Value - - Field - - Description - - 0 - Success - - 1 - OperationPending - - 2 - TooManyRequests - - 3 - LoginProhibited - - 4 - ClientNotInitialized - - 5 - ClientNotLoggedIn - - 6 - ClientAlreadyLoggedIn - - 7 - ChannelNameTooShort - - 8 - ChannelNameTooLong - - 9 - ChannelAlreadyExists - - 10 - AlreadyInChannel - - 11 - TargetNotFound - - 12 - Failure - - 13 - ServiceLost - - 14 - UnableToLaunchProxy - - 15 - ProxyConnectionTimeOut - - 16 - ProxyConnectionUnableToConnect - - 17 - ProxyConnectionUnexpectedDisconnect - - 18 - Disabled - - 19 - UnsupportedChatChannelType - - 20 - InvalidCommunityStream - - 21 - PlayerSilenced - - 22 - PlayerVoiceChatParentalDisabled - - 23 - InvalidInputDevice - - Added in 8.2.0 - - 24 - InvalidOutputDevice - - Added in 8.2.0 \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md b/wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md deleted file mode 100644 index 824d9394..00000000 --- a/wiki-information/events/VOICE_CHAT_MUTED_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOICE_CHAT_MUTED_CHANGED - -**Title:** VOICE CHAT MUTED CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_MUTED_CHANGED: isMuted` - -**Payload:** -- `isMuted` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md b/wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md deleted file mode 100644 index 6f674794..00000000 --- a/wiki-information/events/VOICE_CHAT_OUTPUT_DEVICES_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_OUTPUT_DEVICES_UPDATED - -**Title:** VOICE CHAT OUTPUT DEVICES UPDATED - -**Content:** -Needs summary. -`VOICE_CHAT_OUTPUT_DEVICES_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md b/wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md deleted file mode 100644 index cc5c10de..00000000 --- a/wiki-information/events/VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE.md +++ /dev/null @@ -1,33 +0,0 @@ -## Event: VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE - -**Title:** VOICE CHAT PENDING CHANNEL JOIN STATE - -**Content:** -Needs summary. -`VOICE_CHAT_PENDING_CHANNEL_JOIN_STATE: channelType, clubId, streamId, pendingJoin` - -**Payload:** -- `channelType` - - *number* - Enum.ChatChannelType -- `clubId` - - *string?* -- `streamId` - - *string?* -- `pendingJoin` - - *boolean* -- Enum.ChatChannelType - - Value - - Field - - Description - - 0 - - None - - 1 - - Custom - - 2 - - Private_Party - - Documented as "PrivateParty" - - 3 - - Public_Party - - Documented as "PublicParty" - - 4 - - Communities \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md b/wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md deleted file mode 100644 index 55e8dfad..00000000 --- a/wiki-information/events/VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED - -**Title:** VOICE CHAT PTT BUTTON PRESSED STATE CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_PTT_BUTTON_PRESSED_STATE_CHANGED: isPressed` - -**Payload:** -- `isPressed` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md b/wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md deleted file mode 100644 index 2d6633fa..00000000 --- a/wiki-information/events/VOICE_CHAT_SILENCED_CHANGED.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOICE_CHAT_SILENCED_CHANGED - -**Title:** VOICE CHAT SILENCED CHANGED - -**Content:** -Needs summary. -`VOICE_CHAT_SILENCED_CHANGED: isSilenced` - -**Payload:** -- `isSilenced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md b/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md deleted file mode 100644 index 361798e0..00000000 --- a/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED - -**Title:** VOICE CHAT SPEAK FOR ME ACTIVE STATUS UPDATED - -**Content:** -Needs summary. -`VOICE_CHAT_SPEAK_FOR_ME_ACTIVE_STATUS_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md b/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md deleted file mode 100644 index 83d52dd8..00000000 --- a/wiki-information/events/VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED - -**Title:** VOICE CHAT SPEAK FOR ME FEATURE STATUS UPDATED - -**Content:** -Needs summary. -`VOICE_CHAT_SPEAK_FOR_ME_FEATURE_STATUS_UPDATED` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md deleted file mode 100644 index 329abc8f..00000000 --- a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FAILED.md +++ /dev/null @@ -1,63 +0,0 @@ -## Event: VOICE_CHAT_TTS_PLAYBACK_FAILED - -**Title:** VOICE CHAT TTS PLAYBACK FAILED - -**Content:** -Needs summary. -`VOICE_CHAT_TTS_PLAYBACK_FAILED: status, utteranceID, destination` - -**Payload:** -- `status` - - *Enum.VoiceTtsStatusCode* - - *Value* - - *Field* - - *Description* - - 0 - - Success - - 1 - - InvalidEngineType - - 2 - - EngineAllocationFailed - - 3 - - NotSupported - - 4 - - MaxCharactersExceeded - - 5 - - UtteranceBelowMinimumDuration - - 6 - - InputTextEnqueued - - 7 - - SdkNotInitialized - - 8 - - DestinationQueueFull - - 9 - - EnqueueNotNecessary - - 10 - - UtteranceNotFound - - 11 - - ManagerNotFound - - 12 - - InvalidArgument - - 13 - - InternalError -- `utteranceID` - - *number* -- `destination` - - *Enum.VoiceTtsDestination* - - *Value* - - *Field* - - *Description* - - 0 - - RemoteTransmission - - 1 - - LocalPlayback - - 2 - - RemoteTransmissionWithLocalPlayback - - 3 - - QueuedRemoteTransmission - - 4 - - QueuedLocalPlayback - - 5 - - QueuedRemoteTransmissionWithLocalPlayback - - 6 - - ScreenReader \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md deleted file mode 100644 index 864267ee..00000000 --- a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_FINISHED.md +++ /dev/null @@ -1,24 +0,0 @@ -## Event: VOICE_CHAT_TTS_PLAYBACK_FINISHED - -**Title:** VOICE CHAT TTS PLAYBACK FINISHED - -**Content:** -Needs summary. -`VOICE_CHAT_TTS_PLAYBACK_FINISHED: numConsumers, utteranceID, destination` - -**Payload:** -- `numConsumers` - - *number* -- `utteranceID` - - *number* -- `destination` - - *Enum.VoiceTtsDestination* - - *Value* - - *Field* - *Description* - - 0 - RemoteTransmission - - 1 - LocalPlayback - - 2 - RemoteTransmissionWithLocalPlayback - - 3 - QueuedRemoteTransmission - - 4 - QueuedLocalPlayback - - 5 - QueuedRemoteTransmissionWithLocalPlayback - - 6 - ScreenReader \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md b/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md deleted file mode 100644 index e6af59d8..00000000 --- a/wiki-information/events/VOICE_CHAT_TTS_PLAYBACK_STARTED.md +++ /dev/null @@ -1,26 +0,0 @@ -## Event: VOICE_CHAT_TTS_PLAYBACK_STARTED - -**Title:** VOICE CHAT TTS PLAYBACK STARTED - -**Content:** -Needs summary. -`VOICE_CHAT_TTS_PLAYBACK_STARTED: numConsumers, utteranceID, durationMS, destination` - -**Payload:** -- `numConsumers` - - *number* -- `utteranceID` - - *number* -- `durationMS` - - *number* -- `destination` - - *Enum.VoiceTtsDestination* - - *Value* - - *Field* - Description - - 0 - RemoteTransmission - - 1 - LocalPlayback - - 2 - RemoteTransmissionWithLocalPlayback - - 3 - QueuedRemoteTransmission - - 4 - QueuedLocalPlayback - - 5 - QueuedRemoteTransmissionWithLocalPlayback - - 6 - ScreenReader \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md b/wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md deleted file mode 100644 index dd89c73f..00000000 --- a/wiki-information/events/VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE.md +++ /dev/null @@ -1,30 +0,0 @@ -## Event: VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE - -**Title:** VOICE CHAT TTS SPEAK TEXT UPDATE - -**Content:** -Needs summary. -`VOICE_CHAT_TTS_SPEAK_TEXT_UPDATE: status, utteranceID` - -**Payload:** -- `status` - - *Enum.VoiceTtsStatusCode* - - *Value* - - *Field* - - *Description* - - 0 - Success - - 1 - InvalidEngineType - - 2 - EngineAllocationFailed - - 3 - NotSupported - - 4 - MaxCharactersExceeded - - 5 - UtteranceBelowMinimumDuration - - 6 - InputTextEnqueued - - 7 - SdkNotInitialized - - 8 - DestinationQueueFull - - 9 - EnqueueNotNecessary - - 10 - UtteranceNotFound - - 11 - ManagerNotFound - - 12 - InvalidArgument - - 13 - InternalError -- `utteranceID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md b/wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md deleted file mode 100644 index 4e312580..00000000 --- a/wiki-information/events/VOICE_CHAT_TTS_VOICES_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOICE_CHAT_TTS_VOICES_UPDATE - -**Title:** VOICE CHAT TTS VOICES UPDATE - -**Content:** -Needs summary. -`VOICE_CHAT_TTS_VOICES_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_DEPOSIT_WARNING.md b/wiki-information/events/VOID_DEPOSIT_WARNING.md deleted file mode 100644 index 6c2f3509..00000000 --- a/wiki-information/events/VOID_DEPOSIT_WARNING.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: VOID_DEPOSIT_WARNING - -**Title:** VOID DEPOSIT WARNING - -**Content:** -Fired when attempting to deposit an item with enchants/gems/reforges/etc into the Void Storage. -`VOID_DEPOSIT_WARNING: slot, link` - -**Payload:** -- `slot` - - *number* - Slot Index for `GetVoidTransferDepositInfo` -- `link` - - *string* - Item Link \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_CLOSE.md b/wiki-information/events/VOID_STORAGE_CLOSE.md deleted file mode 100644 index c1c93cc0..00000000 --- a/wiki-information/events/VOID_STORAGE_CLOSE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOID_STORAGE_CLOSE - -**Title:** VOID STORAGE CLOSE - -**Content:** -Needs summary. -`VOID_STORAGE_CLOSE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md b/wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md deleted file mode 100644 index ac0c67dc..00000000 --- a/wiki-information/events/VOID_STORAGE_CONTENTS_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOID_STORAGE_CONTENTS_UPDATE - -**Title:** VOID STORAGE CONTENTS UPDATE - -**Content:** -Fired when one the Void Storage slots is changed. -`VOID_STORAGE_CONTENTS_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md b/wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md deleted file mode 100644 index 7613484e..00000000 --- a/wiki-information/events/VOID_STORAGE_DEPOSIT_UPDATE.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: VOID_STORAGE_DEPOSIT_UPDATE - -**Title:** VOID STORAGE DEPOSIT UPDATE - -**Content:** -Fired when one the Void Transfer deposit slots is changed. -`VOID_STORAGE_DEPOSIT_UPDATE: slot` - -**Payload:** -- `slot` - - *number* - Slot Index for GetVoidTransferDepositInfo \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_OPEN.md b/wiki-information/events/VOID_STORAGE_OPEN.md deleted file mode 100644 index 4905cdc6..00000000 --- a/wiki-information/events/VOID_STORAGE_OPEN.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOID_STORAGE_OPEN - -**Title:** VOID STORAGE OPEN - -**Content:** -Needs summary. -`VOID_STORAGE_OPEN` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_STORAGE_UPDATE.md b/wiki-information/events/VOID_STORAGE_UPDATE.md deleted file mode 100644 index 89b67559..00000000 --- a/wiki-information/events/VOID_STORAGE_UPDATE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOID_STORAGE_UPDATE - -**Title:** VOID STORAGE UPDATE - -**Content:** -Fired when the Void Storage "tutorial" is progressed, or when the Void Storage hasn't been activated yet. -`VOID_STORAGE_UPDATE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_TRANSFER_DONE.md b/wiki-information/events/VOID_TRANSFER_DONE.md deleted file mode 100644 index d22a4563..00000000 --- a/wiki-information/events/VOID_TRANSFER_DONE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOID_TRANSFER_DONE - -**Title:** VOID TRANSFER DONE - -**Content:** -Fired when an item has been successfully deposited or withdrawn from the Void Storage. -`VOID_TRANSFER_DONE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/VOID_TRANSFER_SUCCESS.md b/wiki-information/events/VOID_TRANSFER_SUCCESS.md deleted file mode 100644 index d660aa7a..00000000 --- a/wiki-information/events/VOID_TRANSFER_SUCCESS.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: VOID_TRANSFER_SUCCESS - -**Title:** VOID TRANSFER SUCCESS - -**Content:** -Needs summary. -`VOID_TRANSFER_SUCCESS` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/WARFRONT_COMPLETED.md b/wiki-information/events/WARFRONT_COMPLETED.md deleted file mode 100644 index 2c54db9f..00000000 --- a/wiki-information/events/WARFRONT_COMPLETED.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: WARFRONT_COMPLETED - -**Title:** WARFRONT COMPLETED - -**Content:** -Needs summary. -`WARFRONT_COMPLETED: mapID, winner` - -**Payload:** -- `mapID` - - *number* -- `winner` - - *number* \ No newline at end of file diff --git a/wiki-information/events/WARGAME_REQUESTED.md b/wiki-information/events/WARGAME_REQUESTED.md deleted file mode 100644 index 99f969d5..00000000 --- a/wiki-information/events/WARGAME_REQUESTED.md +++ /dev/null @@ -1,17 +0,0 @@ -## Event: WARGAME_REQUESTED - -**Title:** WARGAME REQUESTED - -**Content:** -Needs summary. -`WARGAME_REQUESTED: opposingPartyMemberName, battlegroundName, timeoutSeconds, tournamentRules` - -**Payload:** -- `opposingPartyMemberName` - - *string* -- `battlegroundName` - - *string* -- `timeoutSeconds` - - *number* -- `tournamentRules` - - *boolean* \ No newline at end of file diff --git a/wiki-information/events/WEAR_EQUIPMENT_SET.md b/wiki-information/events/WEAR_EQUIPMENT_SET.md deleted file mode 100644 index 6e2da1b8..00000000 --- a/wiki-information/events/WEAR_EQUIPMENT_SET.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: WEAR_EQUIPMENT_SET - -**Title:** WEAR EQUIPMENT SET - -**Content:** -Needs summary. -`WEAR_EQUIPMENT_SET: setID` - -**Payload:** -- `setID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/WHO_LIST_UPDATE.md b/wiki-information/events/WHO_LIST_UPDATE.md deleted file mode 100644 index 5ef011df..00000000 --- a/wiki-information/events/WHO_LIST_UPDATE.md +++ /dev/null @@ -1,13 +0,0 @@ -## Event: WHO_LIST_UPDATE - -**Title:** WHO LIST UPDATE - -**Content:** -Fired when the client receives the result of a C_FriendList.SendWho request from the server. -`WHO_LIST_UPDATE` - -**Payload:** -- `None` - -**Content Details:** -Use C_FriendList.SetWhoToUi to manipulate this functionality. This event is only triggered if the Who panel was open at the time the Who data was received (this includes the case where the Blizzard UI opens it automatically because the return data was too big to display in the chat frame). \ No newline at end of file diff --git a/wiki-information/events/WORLD_PVP_QUEUE.md b/wiki-information/events/WORLD_PVP_QUEUE.md deleted file mode 100644 index bebaaca4..00000000 --- a/wiki-information/events/WORLD_PVP_QUEUE.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: WORLD_PVP_QUEUE - -**Title:** WORLD PVP QUEUE - -**Content:** -Needs summary. -`WORLD_PVP_QUEUE` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/WORLD_STATE_TIMER_START.md b/wiki-information/events/WORLD_STATE_TIMER_START.md deleted file mode 100644 index 1f5702e4..00000000 --- a/wiki-information/events/WORLD_STATE_TIMER_START.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: WORLD_STATE_TIMER_START - -**Title:** WORLD STATE TIMER START - -**Content:** -Needs summary. -`WORLD_STATE_TIMER_START: timerID` - -**Payload:** -- `timerID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/WORLD_STATE_TIMER_STOP.md b/wiki-information/events/WORLD_STATE_TIMER_STOP.md deleted file mode 100644 index 442c3910..00000000 --- a/wiki-information/events/WORLD_STATE_TIMER_STOP.md +++ /dev/null @@ -1,11 +0,0 @@ -## Event: WORLD_STATE_TIMER_STOP - -**Title:** WORLD STATE TIMER STOP - -**Content:** -Needs summary. -`WORLD_STATE_TIMER_STOP: timerID` - -**Payload:** -- `timerID` - - *number* \ No newline at end of file diff --git a/wiki-information/events/WOW_MOUSE_NOT_FOUND.md b/wiki-information/events/WOW_MOUSE_NOT_FOUND.md deleted file mode 100644 index c0f58652..00000000 --- a/wiki-information/events/WOW_MOUSE_NOT_FOUND.md +++ /dev/null @@ -1,10 +0,0 @@ -## Event: WOW_MOUSE_NOT_FOUND - -**Title:** WOW MOUSE NOT FOUND - -**Content:** -Fired after DetectWowMouse failing. -`WOW_MOUSE_NOT_FOUND` - -**Payload:** -- `None` \ No newline at end of file diff --git a/wiki-information/events/ZONE_CHANGED.md b/wiki-information/events/ZONE_CHANGED.md deleted file mode 100644 index e68f4d9f..00000000 --- a/wiki-information/events/ZONE_CHANGED.md +++ /dev/null @@ -1,31 +0,0 @@ -## Event: ZONE_CHANGED - -**Title:** ZONE CHANGED - -**Content:** -Fires when the player enters an outdoors subzone. -`ZONE_CHANGED` - -**Payload:** -- `None` - -**Content Details:** -Related API -GetSubZoneText -Related Events -ZONE_CHANGED_NEW -AREAZONE_CHANGED_INDOORS - -**Usage:** -In Stormwind, when moving from Valley of Heroes to Trade District. -```lua -local function OnEvent(self, event, ...) - print(event, GetSubZoneText()) -end - -local f = CreateFrame("Frame") -f:RegisterEvent("ZONE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` -> "ZONE_CHANGED", "Valley of Heroes" -> "ZONE_CHANGED", "Trade District" \ No newline at end of file diff --git a/wiki-information/events/ZONE_CHANGED_INDOORS.md b/wiki-information/events/ZONE_CHANGED_INDOORS.md deleted file mode 100644 index 8e4ec6b2..00000000 --- a/wiki-information/events/ZONE_CHANGED_INDOORS.md +++ /dev/null @@ -1,30 +0,0 @@ -## Event: ZONE_CHANGED_INDOORS - -**Title:** ZONE CHANGED INDOORS - -**Content:** -Fires when the player enters an indoors subzone. -`ZONE_CHANGED_INDOORS` - -**Payload:** -- `None` - -**Content Details:** -Related API -GetSubZoneText -Related Events -ZONE_CHANGED - -**Usage:** -In Shrine of Seven Stars, when moving from The Emperor's Step to The Golden Lantern. -```lua -local function OnEvent(self, event, ...) - print(event, GetSubZoneText()) -end - -local f = CreateFrame("Frame") -f:RegisterEvent("ZONE_CHANGED_INDOORS") -f:SetScript("OnEvent", OnEvent) -> "ZONE_CHANGED_INDOORS", "The Emperor's Step" -> "ZONE_CHANGED_INDOORS", "The Golden Lantern" -``` \ No newline at end of file diff --git a/wiki-information/events/ZONE_CHANGED_NEW_AREA.md b/wiki-information/events/ZONE_CHANGED_NEW_AREA.md deleted file mode 100644 index 821f074d..00000000 --- a/wiki-information/events/ZONE_CHANGED_NEW_AREA.md +++ /dev/null @@ -1,33 +0,0 @@ -## Event: ZONE_CHANGED_NEW_AREA - -**Title:** ZONE CHANGED NEW AREA - -**Content:** -Fires when the player enters a new zone. -`ZONE_CHANGED_NEW_AREA` - -**Payload:** -- `None` - -**Content Details:** -For example this fires when moving from Duskwood to Stranglethorn Vale or Durotar into Orgrimmar. -In interface terms, this is anytime you get a new set of channels. -Related API -GetChannelListC_Map.GetMapInfoGetZoneText • GetRealZoneText -Related Events -ZONE_CHANGED - -**Usage:** -When moving from Stormwind City to Elwynn Forest. -```lua -local function OnEvent(self, event, ...) - local mapID = C_Map.GetBestMapForUnit("player") - print(event, GetZoneText(), C_Map.GetMapInfo(mapID).name) -end - -local f = CreateFrame("Frame") -f:RegisterEvent("ZONE_CHANGED_NEW_AREA") -f:SetScript("OnEvent", OnEvent) -``` -> "ZONE_CHANGED_NEW_AREA", "Stormwind City", "Stormwind City" -> "ZONE_CHANGED_NEW_AREA", "Elwynn Forest", "Elwynn Forest" \ No newline at end of file diff --git a/wiki-information/functions/AbandonQuest.md b/wiki-information/functions/AbandonQuest.md deleted file mode 100644 index 9632cec0..00000000 --- a/wiki-information/functions/AbandonQuest.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: AbandonQuest - -**Content:** -Abandons the quest specified by `SetAbandonQuest()` -`AbandonQuest()` - -**Description:** -Calling `SetAbandonQuest()` triggers a dialog to confirm the user's intention, and the dialog calls `AbandonQuest()` when the user clicks "accept". \ No newline at end of file diff --git a/wiki-information/functions/AbandonSkill.md b/wiki-information/functions/AbandonSkill.md deleted file mode 100644 index b1b8156e..00000000 --- a/wiki-information/functions/AbandonSkill.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: AbandonSkill - -**Content:** -The player abandons a skill. -`AbandonSkill(skillLineID)` - -**Parameters:** -- `skillLineID` - - *number* - The Skill Line ID (can be found with API `GetProfessionInfo()`) - -**Usage:** -```lua -local prof1, prof2, archaeology, fishing, cooking, firstAid = GetProfessions(); -local skillLineID = select(7, GetProfessionInfo(prof1)); -AbandonSkill(skillLineID); -``` - -**Miscellaneous:** -The player abandons a skill. -**CAUTION:** There is no confirmation dialog for this action. Use with care. \ No newline at end of file diff --git a/wiki-information/functions/AcceptArenaTeam.md b/wiki-information/functions/AcceptArenaTeam.md deleted file mode 100644 index ccec77ee..00000000 --- a/wiki-information/functions/AcceptArenaTeam.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: AcceptArenaTeam - -**Content:** -Accepts a pending arena team invitation. -`AcceptArenaTeam()` - -**Description:** -Only one arena team invitation may be pending at any time. - -**Reference:** -- `ARENA_TEAM_INVITE_REQUEST` -- `ARENA_TEAM_INVITE_CANCEL` - -**See also:** -- `DeclineArenaTeam` \ No newline at end of file diff --git a/wiki-information/functions/AcceptBattlefieldPort.md b/wiki-information/functions/AcceptBattlefieldPort.md deleted file mode 100644 index 25086c90..00000000 --- a/wiki-information/functions/AcceptBattlefieldPort.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: AcceptBattlefieldPort - -**Content:** -Enters the Battleground if the queue is ready. -`AcceptBattlefieldPort(index, accept)` - -**Parameters:** -- `index` - - *number* - The battlefield in queue to enter. -- `accept` - - *boolean* - Whether or not to accept entry to the battlefield. \ No newline at end of file diff --git a/wiki-information/functions/AcceptDuel.md b/wiki-information/functions/AcceptDuel.md deleted file mode 100644 index 5bcac41d..00000000 --- a/wiki-information/functions/AcceptDuel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: AcceptDuel - -**Content:** -Accepts a duel challenge. -`AcceptDuel()` - -**Reference:** -- `StartDuel` to issue a duel challenge. -- `CancelDuel` to reject a duel challenge. \ No newline at end of file diff --git a/wiki-information/functions/AcceptGroup.md b/wiki-information/functions/AcceptGroup.md deleted file mode 100644 index f504314b..00000000 --- a/wiki-information/functions/AcceptGroup.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: AcceptGroup - -**Content:** -Accepts the invitation from a group. -`AcceptGroup()` - -**Usage:** -The following snippet auto-accepts invitations from characters whose names begin with the letter A. -```lua -local frame = CreateFrame("FRAME") -frame:RegisterEvent("PARTY_INVITE_REQUEST") -frame:SetScript("OnEvent", function(self, event, sender) - if sender:sub(1,1) == "A" then - AcceptGroup() - end -end) -``` - -**Description:** -You can use this after receiving the `PARTY_INVITE_REQUEST` event. If there is no invitation to a party, this function doesn't do anything. -Calling this function does NOT cause the "accept/decline dialog" to go away. Use `StaticPopup_Hide("PARTY_INVITE")` to hide the dialog. -Depending on the order events are dispatched in, your event handler may run before UIParent's, and therefore attempt to hide the dialog before it is shown. Delaying the attempt to hide the popup until `PARTY_MEMBERS_CHANGED` resolves this. \ No newline at end of file diff --git a/wiki-information/functions/AcceptGuild.md b/wiki-information/functions/AcceptGuild.md deleted file mode 100644 index bfd69f06..00000000 --- a/wiki-information/functions/AcceptGuild.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: AcceptGuild - -**Content:** -Accepts a guild invite. -`AcceptGuild()` - -**Reference:** -- `GUILD_INVITE_REQUEST` -- `GUILD_INVITE_CANCEL` -- See also: - - `DeclineGuild` \ No newline at end of file diff --git a/wiki-information/functions/AcceptProposal.md b/wiki-information/functions/AcceptProposal.md deleted file mode 100644 index f6e7c174..00000000 --- a/wiki-information/functions/AcceptProposal.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: AcceptProposal - -**Content:** -Enters the Dungeon if the LFG queue is ready. -`AcceptProposal()` - -**Reference:** -- `LFG_PROPOSAL_SHOW` -- `LFG_PROPOSAL_UPDATE` -- `LFG_PROPOSAL_SUCCEEDED` -- `LFG_PROPOSAL_FAILED` - -**See also:** -- `GetLFGProposal` -- `RejectProposal` \ No newline at end of file diff --git a/wiki-information/functions/AcceptQuest.md b/wiki-information/functions/AcceptQuest.md deleted file mode 100644 index 74ab68ba..00000000 --- a/wiki-information/functions/AcceptQuest.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: AcceptQuest - -**Content:** -Accepts the currently offered quest. -`AcceptQuest()` - -**Description:** -You can call this function once the `QUEST_DETAIL` event fires. - -**Reference:** -- `AcknowledgeAutoAcceptQuest` -- `DeclineQuest` \ No newline at end of file diff --git a/wiki-information/functions/AcceptResurrect.md b/wiki-information/functions/AcceptResurrect.md deleted file mode 100644 index e961cdb3..00000000 --- a/wiki-information/functions/AcceptResurrect.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: AcceptResurrect - -**Content:** -Accepts a resurrection offer. -`AcceptResurrect()` - -**Description:** -Most player-sponsored resurrection offers expire automatically after 60 seconds. - -**Reference:** -- `RESURRECT_REQUEST` -- `PLAYER_UNGHOST` -- `PLAYER_SKINNED` - -**See also:** -- `GetCorpseRecoveryDelay` -- `DeclineResurrect` -- `ResurrectHasSickness` -- `ResurrectHasTimer` \ No newline at end of file diff --git a/wiki-information/functions/AcceptSockets.md b/wiki-information/functions/AcceptSockets.md deleted file mode 100644 index 59c5539b..00000000 --- a/wiki-information/functions/AcceptSockets.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: AcceptSockets - -**Content:** -Confirms pending gems for socketing. -`AcceptSockets()` - -**Description:** -The socketing API designates a single item (SocketInventoryItem, SocketContainerItem) to be considered for socketing at a time. While an item is being considered for socketing, players may drop new gems into its sockets (ClickSocketButton). If the user wishes to actually perform the socketing, `AcceptSockets()` must be called to confirm. - -There is no dedicated API call to reject a tentative socketing, although you may use `CloseSocketInfo()` to exit socketing without making any changes to the item. You can then select the item for socketing again. - -Replaces existing gems if necessary. - -**Reference:** -- `SocketInventoryItem` -- `SocketContainerItem` -- `ClickSocketButton` -- `CloseSocketInfo` \ No newline at end of file diff --git a/wiki-information/functions/AcceptSpellConfirmationPrompt.md b/wiki-information/functions/AcceptSpellConfirmationPrompt.md deleted file mode 100644 index 6f533e01..00000000 --- a/wiki-information/functions/AcceptSpellConfirmationPrompt.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: AcceptSpellConfirmationPrompt - -**Content:** -Confirms a spell confirmation prompt (e.g. bonus loot roll). -`AcceptSpellConfirmationPrompt(spellID)` - -**Parameters:** -- `spellID` - - *number* - spell ID of the prompt to confirm. - -**Description:** -SPELL_CONFIRMATION_PROMPT fires when a spell confirmation prompt might be presented to the player; it provides the spellID and information about the type, text, and duration of the confirmation. Notably, the event does not guarantee that the player can actually cast the spell. -Calling this function accepts the spell prompt, performing the action in question. -SPELL_CONFIRMATION_TIMEOUT fires if the spell is not confirmed within the prompt duration. - -**Reference:** -- [DeclineSpellConfirmationPrompt](#) \ No newline at end of file diff --git a/wiki-information/functions/AcceptTrade.md b/wiki-information/functions/AcceptTrade.md deleted file mode 100644 index 37ca90fd..00000000 --- a/wiki-information/functions/AcceptTrade.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: AcceptTrade - -**Content:** -Accepts the current trade offer. -`AcceptTrade()` - -**Reference:** -- `TRADE_ACCEPT_UPDATE` -- `TRADE_CLOSED` -- `TRADE_MONEY_CHANGED` -- `TRADE_PLAYER_ITEM_CHANGED` -- `TRADE_REPLACE_ENCHANT` -- `TRADE_REQUEST` -- `TRADE_REQUEST_CANCEL` - -**Example Usage:** -This function can be used in a custom addon to automate the acceptance of trade offers. For instance, if you are developing an addon that facilitates quick trading between players, you can call `AcceptTrade()` to programmatically accept a trade once certain conditions are met. - -**Addons Using This Function:** -Many trading addons, such as TradeSkillMaster, use this function to streamline the trading process by automatically accepting trades that meet predefined criteria. \ No newline at end of file diff --git a/wiki-information/functions/AcceptXPLoss.md b/wiki-information/functions/AcceptXPLoss.md deleted file mode 100644 index 5a38fa09..00000000 --- a/wiki-information/functions/AcceptXPLoss.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: AcceptXPLoss - -**Content:** -Confirms the resurrection sickness and durability loss penalty on being resurrected by a spirit healer. -`AcceptXPLoss()` - -**Description:** -The name is misleading, originating from the WoW beta when resurrecting at a spirit healer cost experience. - -**Reference:** -- `CONFIRM_XP_LOSS` - fired upon accepting resurrection sickness and durability loss -- `PLAYER_UNGHOST` - fired upon returning to life by any source, including spirit healers \ No newline at end of file diff --git a/wiki-information/functions/ActionHasRange.md b/wiki-information/functions/ActionHasRange.md deleted file mode 100644 index d85ba640..00000000 --- a/wiki-information/functions/ActionHasRange.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: ActionHasRange - -**Content:** -Returns true if the action has a range requirement. -`hasRange = ActionHasRange(slotID)` - -**Parameters:** -- `slotID` - - *number* - The slot ID to test. - -**Returns:** -- `hasRange` - - *boolean* - True if the specified slot contains an action which has a numeric range requirement. - -**Description:** -This function returns true if the action in the specified slot ID has a numeric range requirement as shown in the action's tooltip, e.g., has a numeric range of 20 yards. For actions like Attack which have no numeric range requirement in their tooltip (even though they only work within a certain range), this function will return false. \ No newline at end of file diff --git a/wiki-information/functions/AddChatWindowChannel.md b/wiki-information/functions/AddChatWindowChannel.md deleted file mode 100644 index bbf50131..00000000 --- a/wiki-information/functions/AddChatWindowChannel.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: AddChatWindowChannel - -**Content:** -Enables messages from a chat channel index for a chat window. -`AddChatWindowChannel(windowId, channelName)` - -**Parameters:** -- `windowId` - - *number* - index of the chat window/frame (ascending from 1) to add the channel to. -- `channelName` - - *string* - name of the chat channel to add to the frame. - -**Description:** -A single channel may be configured to display in multiple chat windows/frames. -Chat output architecture has changed since release; calling this function alone is no longer sufficient to add a channel to a particular frame in the default UI. Use `ChatFrame_AddChannel(chatFrame, "channelName")` instead, like so: -```lua -ChatFrame_AddChannel(ChatWindow1, "Trade"); -- DEFAULT_CHAT_FRAME works well, too -``` - -**Reference:** -- `RemoveChatWindowChannel` \ No newline at end of file diff --git a/wiki-information/functions/AddChatWindowMessages.md b/wiki-information/functions/AddChatWindowMessages.md deleted file mode 100644 index 3890882f..00000000 --- a/wiki-information/functions/AddChatWindowMessages.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: AddChatWindowMessages - -**Content:** -Enables messages from the chat message type (e.g. "SAY") for a chat window. -`AddChatWindowMessages(index, messageGroup)` - -**Parameters:** -- `index` - - *number* - The chat window index, ascending from 1. -- `messageGroup` - - *string* - Message group to add to the chat window, e.g. "SAY", "EMOTE", "MONSTER_BOSS_EMOTE". - -**Reference:** -- `GetChatWindowMessages` -- `RemoveChatWindowMessages` -- `AddChatWindowChannel` \ No newline at end of file diff --git a/wiki-information/functions/AddQuestWatch.md b/wiki-information/functions/AddQuestWatch.md deleted file mode 100644 index 8129f2fd..00000000 --- a/wiki-information/functions/AddQuestWatch.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: AddQuestWatch - -**Content:** -Adds a quest to the list of quests being watched with an optional time to watch it. -`AddQuestWatch(questIndex)` - -**Parameters:** -- `questIndex` - - *number* - The index of the quest in the quest log. -- `watchTime` - - *number* - The amount of time to watch the quest in seconds. - -**Returns:** -- None \ No newline at end of file diff --git a/wiki-information/functions/AddTrackedAchievement.md b/wiki-information/functions/AddTrackedAchievement.md deleted file mode 100644 index 7e9e82a1..00000000 --- a/wiki-information/functions/AddTrackedAchievement.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: AddTrackedAchievement - -**Content:** -Tracks an achievement. -`AddTrackedAchievement(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - ID of the achievement to add to tracking. - -**Reference:** -- `TRACKED_ACHIEVEMENT_UPDATE` -- See also: - - `RemoveTrackedAchievement` - - `GetTrackedAchievements` - - `GetNumTrackedAchievements` - -**Description:** -A maximum of `WATCHFRAME_MAXACHIEVEMENTS` (10 as of 5.4.8) tracked achievements can be displayed by the WatchFrame at a time. -You may need to manually update the AchievementUI and WatchFrame after calling this function. \ No newline at end of file diff --git a/wiki-information/functions/AddTradeMoney.md b/wiki-information/functions/AddTradeMoney.md deleted file mode 100644 index 14740e99..00000000 --- a/wiki-information/functions/AddTradeMoney.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: AddTradeMoney - -**Content:** -Adds money currently held by the cursor to the trade offer. -`AddTradeMoney()` - -**Reference:** -- `PickupPlayerMoney` -- `PickupTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/Ambiguate.md b/wiki-information/functions/Ambiguate.md deleted file mode 100644 index ccea2a88..00000000 --- a/wiki-information/functions/Ambiguate.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: Ambiguate - -**Content:** -Returns a version of a character-realm string suitable for use in a given context. -`name = Ambiguate(fullName, context)` - -**Parameters:** -- `fullName` - - *string* - character-realm for a character, e.g. "Shion-DieAldor" -- `context` - - *string* - context the name will be used in, one of: "all", "guild", "mail", "none", or "short". - -**Returns:** -- `name` - - *string* - character or character-realm name combination that would be equivalent to fullName in the specified context. - - **Context** - - **Same Realm** - - **Different Realm** - - **Same Guild** - - **Other Guild** - - **Same Guild** - - **Other Guild** - - `all` - - character - - character - - character - - character-realm - - `guild` - - character - - character - - character - - character-realm - - `mail` - - character-realm - - character-realm - - character-realm - - character-realm - - `none` - - character - - character - - character-realm - - character-realm - - `short` - - character - - character - - character - - character - -**Description:** -If this is used on a character in the "guild" context, it will return in the character-realm format if there is another character in the same guild with the same name, but on a different realm. \ No newline at end of file diff --git a/wiki-information/functions/AreDangerousScriptsAllowed.md b/wiki-information/functions/AreDangerousScriptsAllowed.md deleted file mode 100644 index d83a8458..00000000 --- a/wiki-information/functions/AreDangerousScriptsAllowed.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: AreDangerousScriptsAllowed - -**Content:** -Needs summary. -`allowed = AreDangerousScriptsAllowed()` - -**Returns:** -- `allowed` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamDisband.md b/wiki-information/functions/ArenaTeamDisband.md deleted file mode 100644 index 1395a65f..00000000 --- a/wiki-information/functions/ArenaTeamDisband.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: ArenaTeamDisband - -**Content:** -Disbands an Arena Team if the player is the team captain. -`ArenaTeamDisband(index)` - -**Parameters:** -- `index` - - *number* - Index of the arena team to delete, index can be a value of 1 through 3. - -**Usage:** -The following macro disbands the first arena team. -```lua -/run ArenaTeamDisband(1) -``` -It can be used as the last solution to get rid of an arena team if all the other members of it don't come online anymore or if you just want to delete it. So far there is no UI implementation of this. \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamInviteByName.md b/wiki-information/functions/ArenaTeamInviteByName.md deleted file mode 100644 index 105e2a2e..00000000 --- a/wiki-information/functions/ArenaTeamInviteByName.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: ArenaTeamInviteByName - -**Content:** -Needs summary. -`ArenaTeamInviteByName(index, target)` - -**Parameters:** -- `index` - - *number* -- `target` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamLeave.md b/wiki-information/functions/ArenaTeamLeave.md deleted file mode 100644 index 5f4e76b5..00000000 --- a/wiki-information/functions/ArenaTeamLeave.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ArenaTeamLeave - -**Content:** -Needs summary. -`ArenaTeamLeave(index)` - -**Parameters:** -- `index` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamRoster.md b/wiki-information/functions/ArenaTeamRoster.md deleted file mode 100644 index 1aff5e0d..00000000 --- a/wiki-information/functions/ArenaTeamRoster.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: ArenaTeamRoster - -**Content:** -Requests the arena team information from the server -`ArenaTeamRoster(index)` - -**Parameters:** -- `index` - - *number* - Index of the arena team to request information from, 1 through 3. - -**Description:** -Because this sends a request to the server, you will not get the data instantly; you must register and watch for the `ARENA_TEAM_ROSTER_UPDATE` event. -It appears that `ARENA_TEAM_ROSTER_UPDATE` will not fire if you requested the same team index last call. \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamSetLeaderByName.md b/wiki-information/functions/ArenaTeamSetLeaderByName.md deleted file mode 100644 index f7accf4b..00000000 --- a/wiki-information/functions/ArenaTeamSetLeaderByName.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: ArenaTeamSetLeaderByName - -**Content:** -Needs summary. -`ArenaTeamSetLeaderByName(index, target)` - -**Parameters:** -- `index` - - *number* -- `target` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/ArenaTeamUninviteByName.md b/wiki-information/functions/ArenaTeamUninviteByName.md deleted file mode 100644 index 53710f99..00000000 --- a/wiki-information/functions/ArenaTeamUninviteByName.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: ArenaTeamUninviteByName - -**Content:** -Needs summary. -`ArenaTeamUninviteByName(index, target)` - -**Parameters:** -- `index` - - *number* -- `target` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/AscendStop.md b/wiki-information/functions/AscendStop.md deleted file mode 100644 index 2ce6ecc7..00000000 --- a/wiki-information/functions/AscendStop.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: AscendStop - -**Content:** -Called when the player releases the jump key. -`AscendStop()` - -**Description:** -This doesn't appear to affect the actual jump at all, but may be hooked to monitor when the jump key is released. -Called as the jump key is released, regardless if you are in the middle of the jump or held it down until the jump finished. - -**Usage:** -Prints "Jump Released" when releasing the jump key. -```lua -hooksecurefunc("AscendStop", function() - DEFAULT_CHAT_FRAME:AddMessage("Jump Released") -end) -``` - -**Reference:** -`JumpOrAscendStart` \ No newline at end of file diff --git a/wiki-information/functions/AssistUnit.md b/wiki-information/functions/AssistUnit.md deleted file mode 100644 index c8d69093..00000000 --- a/wiki-information/functions/AssistUnit.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: AssistUnit - -**Content:** -Assists the unit by targeting the same target. -`AssistUnit(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Description:** -If the player's target was changed by a Targeting Function, it is possible to restore the original target by assisting the player. - -**Example Usage:** -```lua --- Example of using AssistUnit to target the same target as the party leader -local partyLeader = "party1" -AssistUnit(partyLeader) -``` - -**Usage in Addons:** -- **HealBot**: This addon uses `AssistUnit` to allow healers to quickly assist the main tank or other party members, ensuring they can target the same enemy for healing or other actions. -- **Grid**: This raid unit frame addon can use `AssistUnit` to help players quickly switch targets to assist the main assist or tank in a raid environment. \ No newline at end of file diff --git a/wiki-information/functions/AttackTarget.md b/wiki-information/functions/AttackTarget.md deleted file mode 100644 index af3a3b4c..00000000 --- a/wiki-information/functions/AttackTarget.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: AttackTarget - -**Content:** -Toggles auto-attacking of the current target. -`AttackTarget()` - -**Description:** -This is actually a toggle. If not currently attacking, it will initiate attack. If currently attacking, it will stop attacking. -You can test your current attack "Action slot" using `IsCurrentAction(actionSlot)` for status (you'll have to find the auto-attack slot, though). -If you need a way to always engage auto-attack, rather than toggle it on or off, one workaround is `AssistUnit("player")` this will always attack if you have "Attack on assist" checked in the Advanced tab of the Interface Options panel. Note that you cannot combine this with `TargetNearestEnemy()` in the same function/macro: the "assist" target isn't updated fast enough. -The macro `/startattack` will always initiate auto-attack (or auto-shot for hunters, if the appropriate interface option is active). \ No newline at end of file diff --git a/wiki-information/functions/AutoEquipCursorItem.md b/wiki-information/functions/AutoEquipCursorItem.md deleted file mode 100644 index 9a9f8bdb..00000000 --- a/wiki-information/functions/AutoEquipCursorItem.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: AutoEquipCursorItem - -**Content:** -Equips the item currently held by the cursor. -`AutoEquipCursorItem()` - -**Usage:** -```lua -PickupContainerItem(0,1) -AutoEquipCursorItem() -PickupContainerItem(0,1) -AutoEquipCursorItem() -``` - -**Miscellaneous:** -**Result:** -Equips the first item in your backpack to the relevant slot (if it can be equipped). \ No newline at end of file diff --git a/wiki-information/functions/AutoStoreGuildBankItem.md b/wiki-information/functions/AutoStoreGuildBankItem.md deleted file mode 100644 index dd55a898..00000000 --- a/wiki-information/functions/AutoStoreGuildBankItem.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: AutoStoreGuildBankItem - -**Content:** -Withdraws an item from the Guild Bank to the character's inventory. -`AutoStoreGuildBankItem(tab, slot)` - -**Parameters:** -- `tab` - - *number* - The index of the tab in the guild bank -- `slot` - - *number* - The index of the slot in the chosen tab \ No newline at end of file diff --git a/wiki-information/functions/BNConnected.md b/wiki-information/functions/BNConnected.md deleted file mode 100644 index a3904701..00000000 --- a/wiki-information/functions/BNConnected.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: BNConnected - -**Content:** -Returns true if the WoW Client is connected to Battle.net. -`connected = BNConnected()` - -**Returns:** -- `connected` - - *boolean* - true if connected, false if not \ No newline at end of file diff --git a/wiki-information/functions/BNGetFOFInfo.md b/wiki-information/functions/BNGetFOFInfo.md deleted file mode 100644 index 5b2828ce..00000000 --- a/wiki-information/functions/BNGetFOFInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: BNGetFOFInfo - -**Content:** -Returns info for the specified friend of a Battle.net friend. -`friendID, accountName, isMutual = BNGetFOFInfo(mutual, nonMutual, index)` - -**Parameters:** -- `mutual` - - *boolean* - Should the list include mutual friends (i.e., people who you and the person referenced by presenceID are both friends with). -- `nonMutual` - - *boolean* - Should the list include non-mutual friends. -- `index` - - *number* - The index of the entry in the list to retrieve (1 to BNGetNumFOF(...)). - -**Returns:** -- `friendID` - - *number* - a unique numeric identifier for this friend for this session. -- `accountName` - - *string* - a Kstring representing the friend's name (As of 4.0). -- `isMutual` - - *boolean* - true if this person is a direct friend of yours, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendGameAccountInfo.md b/wiki-information/functions/BNGetFriendGameAccountInfo.md deleted file mode 100644 index 3b1bd689..00000000 --- a/wiki-information/functions/BNGetFriendGameAccountInfo.md +++ /dev/null @@ -1,77 +0,0 @@ -## Title: BNGetFriendGameAccountInfo - -**Content:** -Returns information about the specified toon of a RealID friend. -``` -hasFocus, characterName, client, realmName, realmID, faction, race, class, guild, zoneName, level, gameText, broadcastText, broadcastTime, canSoR, toonID, bnetIDAccount, isGameAFK, isGameBusy -= BNGetFriendGameAccountInfo(friendIndex) -= BNGetGameAccountInfo(bnetIDGameAccount) -= BNGetGameAccountInfoByGUID(guid) -``` - -**Parameters:** -- **BNGetFriendGameAccountInfo:** - - `friendIndex` - - *number* - Ranging from 1 to BNGetNumFriendGameAccounts() - -- **BNGetGameAccountInfo:** - - `bnetIDGameAccount` - - *number* - A unique numeric identifier for the friend during this session. - -- **BNGetGameAccountInfoByGUID:** - - `guid` - - *string* - -**Returns:** -- `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame. -- `characterName` - - *string* - The name of the logged in toon/character. -- `client` - - *string* - Either "WoW" (BNET_CLIENT_WOW), "S2" (BNET_CLIENT_S2), "WTCG" (BNET_CLIENT_WTCG), "App" (BNET_CLIENT_APP), "Hero" (BNET_CLIENT_HEROES), "Pro" (BNET_CLIENT_OVERWATCH), "CLNT" (BNET_CLIENT_CLNT), or "D3" (BNET_CLIENT_D3) for World of Warcraft, StarCraft 2, Hearthstone, BNet Application, Heroes of the Storm, Overwatch, another client, or Diablo 3. -- `realmName` - - *string* - The name of the logged in realm. -- `realmID` - - *number* - The ID for the logged in realm. -- `faction` - - *string* - The faction name (i.e., "Alliance" or "Horde"). -- `race` - - *string* - The localized race name (e.g., "Blood Elf"). -- `class` - - *string* - The localized class name (e.g., "Death Knight"). -- `guild` - - *string* - Seems to return "" even if the player is in a guild. -- `zoneName` - - *string* - The localized zone name (e.g., "The Undercity"). -- `level` - - *string* - The current level (e.g., "90"). -- `gameText` - - *string* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. -- `broadcastText` - - *string* - The Battle.Net broadcast message. -- `broadcastTime` - - *number* - The number of seconds elapsed since the current broadcast message was sent. -- `canSoR` - - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. -- `toonID` - - *number* - A unique numeric identifier for the friend's character during this session. -- `bnetIDAccount` - - *number* -- `isGameAFK` - - *boolean* -- `isGameBusy` - - *boolean* - -**Usage:** -```lua -local bnetIDGameAccount = select(6, BNGetFriendInfo(1)) -- assuming friend index 1 is me (Grdn) -local _, characterName, _, realmName = BNGetGameAccountInfo(bnetIDGameAccount) -print(toonName .. " plays on " .. realmName) -- Grdn plays on Onyxia -``` - -**Example Use Case:** -This function can be used to display detailed information about a RealID friend's current game status, such as their character name, realm, and current activity. This is particularly useful for addons that enhance the social experience in World of Warcraft by providing more detailed friend information. - -**Addons Using This Function:** -- **ElvUI**: A comprehensive UI replacement addon that uses this function to display detailed information about RealID friends in its enhanced friend list. -- **Prat**: A chat enhancement addon that uses this function to show detailed RealID friend information in the chat window. \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendIndex.md b/wiki-information/functions/BNGetFriendIndex.md deleted file mode 100644 index 29bb593c..00000000 --- a/wiki-information/functions/BNGetFriendIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: BNGetFriendIndex - -**Content:** -Returns the index in the friend frame of the given Battle.net friend. -`index = BNGetFriendIndex(presenceID)` - -**Parameters:** -- `presenceID` - - *number* - A unique numeric identifier for the friend's Battle.net account during this session. - -**Returns:** -- `index` - - *number* - The Battle.net friend's index on the friends list \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendInfo.md b/wiki-information/functions/BNGetFriendInfo.md deleted file mode 100644 index 9baf61ef..00000000 --- a/wiki-information/functions/BNGetFriendInfo.md +++ /dev/null @@ -1,76 +0,0 @@ -## Title: BNGetFriendInfo - -**Content:** -Returns information about the specified RealID friend. -```lua -bnetAccountID, accountName, battleTag, isBattleTagPresence, characterName, bnetIDGameAccount, client, isOnline, lastOnline, isAFK, isDND, messageText, noteText, isRIDFriend, messageTime, canSoR, isReferAFriend, canSummonFriend = BNGetFriendInfo(friendIndex) -``` -or -```lua -bnetAccountID, accountName, battleTag, isBattleTagPresence, characterName, bnetIDGameAccount, client, isOnline, lastOnline, isAFK, isDND, messageText, noteText, isRIDFriend, messageTime, canSoR, isReferAFriend, canSummonFriend = BNGetFriendInfoByID(bnetAccountID) -``` - -**Parameters:** -- `BNGetFriendInfo:` - - `friendIndex` - - *number* - The index on the friends list for this RealID friend, ranging from 1 to BNGetNumFriends() - -- `BNGetFriendInfoByID:` - - `bnetAccountID` - - *number* - A unique numeric identifier for this friend's battle.net account for the current session - -**Returns:** -- `bnetAccountID` - - *number* - A temporary ID for the friend's battle.net account during this session. -- `accountName` - - *string* - An escape sequence (starting with |K) representing the friend's full name or BattleTag name. -- `battleTag` - - *string* - A nickname and number that when combined, form a unique string that identifies the friend (e.g., "Nickname#0001"). -- `isBattleTagPresence` - - *boolean* - Whether or not the friend is known by their BattleTag. -- `characterName` - - *string* - The name of the logged in character. -- `bnetIDGameAccount` - - *number* - A unique numeric identifier for the friend's game account during this session. -- `client` - - *string* - See BNET_CLIENT -- `isOnline` - - *boolean* - Whether or not the friend is online. -- `lastOnline` - - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. -- `isAFK` - - *boolean* - Whether or not the friend is flagged as Away. -- `isDND` - - *boolean* - Whether or not the friend is flagged as Busy. -- `messageText` - - *string* - The friend's Battle.Net broadcast message. -- `noteText` - - *string* - The contents of the player's note about this friend. -- `isRIDFriend` - - *boolean* - Returns true for RealID friends and false for BattleTag friends. -- `messageTime` - - *number* - The number of seconds elapsed since the current broadcast message was sent. -- `canSoR` - - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. -- `isReferAFriend` - - *boolean* -- `canSummonFriend` - - *boolean* - -**Description:** -- `BNET_CLIENT` - - **Global** - - `Value` - - `Description` - - `BNET_CLIENT_WOW` - - *WoW* - World of Warcraft - - `BNET_CLIENT_APP` - - *App* - Battle.net desktop app - - `BNET_CLIENT_HEROES` - - *Hero* - Heroes of the Storm - - `BNET_CLIENT_CLNT` - - *CLNT* - -**Reference:** -- `BNGetFriendGameAccountInfo` -- `BNGetGameAccountInfo` \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendInfoByID.md b/wiki-information/functions/BNGetFriendInfoByID.md deleted file mode 100644 index 6d7c89c0..00000000 --- a/wiki-information/functions/BNGetFriendInfoByID.md +++ /dev/null @@ -1,77 +0,0 @@ -## Title: BNGetFriendInfo - -**Content:** -Returns information about the specified RealID friend. -```lua -bnetAccountID, accountName, battleTag, isBattleTagPresence, characterName, bnetIDGameAccount, client, isOnline, lastOnline, isAFK, isDND, messageText, noteText, isRIDFriend, messageTime, canSoR, isReferAFriend, canSummonFriend - = BNGetFriendInfo(friendIndex) - = BNGetFriendInfoByID(bnetAccountID) -``` - -**Parameters:** -- **BNGetFriendInfo:** - - `friendIndex` - - *number* - The index on the friends list for this RealID friend, ranging from 1 to BNGetNumFriends() - -- **BNGetFriendInfoByID:** - - `bnetAccountID` - - *number* - A unique numeric identifier for this friend's battle.net account for the current session - -**Returns:** -- `bnetAccountID` - - *number* - A temporary ID for the friend's battle.net account during this session. -- `accountName` - - *string* - An escape sequence (starting with |K) representing the friend's full name or BattleTag name. -- `battleTag` - - *string* - A nickname and number that when combined, form a unique string that identifies the friend (e.g., "Nickname#0001"). -- `isBattleTagPresence` - - *boolean* - Whether or not the friend is known by their BattleTag. -- `characterName` - - *string* - The name of the logged in character. -- `bnetIDGameAccount` - - *number* - A unique numeric identifier for the friend's game account during this session. -- `client` - - *string* - See BNET_CLIENT -- `isOnline` - - *boolean* - Whether or not the friend is online. -- `lastOnline` - - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. -- `isAFK` - - *boolean* - Whether or not the friend is flagged as Away. -- `isDND` - - *boolean* - Whether or not the friend is flagged as Busy. -- `messageText` - - *string* - The friend's Battle.Net broadcast message. -- `noteText` - - *string* - The contents of the player's note about this friend. -- `isRIDFriend` - - *boolean* - Returns true for RealID friends and false for BattleTag friends. -- `messageTime` - - *number* - The number of seconds elapsed since the current broadcast message was sent. -- `canSoR` - - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. -- `isReferAFriend` - - *boolean* -- `canSummonFriend` - - *boolean* - -**Description:** -BNET_CLIENT -- **Global** - - **Value** - - **Description** - - `BNET_CLIENT_WOW` - - WoW - - World of Warcraft - - `BNET_CLIENT_APP` - - App - - Battle.net desktop app - - `BNET_CLIENT_HEROES` - - Hero - - Heroes of the Storm - - `BNET_CLIENT_CLNT` - - CLNT - -**Reference:** -- `BNGetFriendGameAccountInfo` -- `BNGetGameAccountInfo` \ No newline at end of file diff --git a/wiki-information/functions/BNGetFriendInviteInfo.md b/wiki-information/functions/BNGetFriendInviteInfo.md deleted file mode 100644 index c081f79b..00000000 --- a/wiki-information/functions/BNGetFriendInviteInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: BNGetFriendInviteInfo - -**Content:** -Returns info for a Battle.net friend invite. -`inviteID, accountName, isBattleTag, message, sentTime = BNGetFriendInviteInfo(inviteIndex)` - -**Parameters:** -- `inviteIndex` - - *number* - Ranging from 1 to BNGetNumFriendInvites() - -**Returns:** -- `inviteID` - - *number* - Also known as the presence id. -- `accountName` - - *number* - Protected string for the friend account name, e.g. "|Kq4|k". -- `isBattleTag` - - *boolean* -- `message` - - *string?* - Appears to be always nil now. -- `sentTime` - - *number* - The unix time when the invite was sent/received. \ No newline at end of file diff --git a/wiki-information/functions/BNGetGameAccountInfo.md b/wiki-information/functions/BNGetGameAccountInfo.md deleted file mode 100644 index 8d6c7af8..00000000 --- a/wiki-information/functions/BNGetGameAccountInfo.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: BNGetFriendGameAccountInfo - -**Content:** -Returns information about the specified toon of a RealID friend. -``` -hasFocus, characterName, client, realmName, realmID, faction, race, class, guild, zoneName, level, gameText, broadcastText, broadcastTime, canSoR, toonID, bnetIDAccount, isGameAFK, isGameBusy -= BNGetFriendGameAccountInfo(friendIndex) -= BNGetGameAccountInfo(bnetIDGameAccount) -= BNGetGameAccountInfoByGUID(guid) -``` - -**Parameters:** -- **BNGetFriendGameAccountInfo:** - - `friendIndex` - - *number* - Ranging from 1 to BNGetNumFriendGameAccounts() - -- **BNGetGameAccountInfo:** - - `bnetIDGameAccount` - - *number* - A unique numeric identifier for the friend during this session. - -- **BNGetGameAccountInfoByGUID:** - - `guid` - - *string* - -**Returns:** -- `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame. -- `characterName` - - *string* - The name of the logged in toon/character. -- `client` - - *string* - Either "WoW" (BNET_CLIENT_WOW), "S2" (BNET_CLIENT_S2), "WTCG" (BNET_CLIENT_WTCG), "App" (BNET_CLIENT_APP), "Hero" (BNET_CLIENT_HEROES), "Pro" (BNET_CLIENT_OVERWATCH), "CLNT" (BNET_CLIENT_CLNT), or "D3" (BNET_CLIENT_D3) for World of Warcraft, StarCraft 2, Hearthstone, BNet Application, Heroes of the Storm, Overwatch, another client, or Diablo 3. -- `realmName` - - *string* - The name of the logged in realm. -- `realmID` - - *number* - The ID for the logged in realm. -- `faction` - - *string* - The faction name (i.e., "Alliance" or "Horde"). -- `race` - - *string* - The localized race name (e.g., "Blood Elf"). -- `class` - - *string* - The localized class name (e.g., "Death Knight"). -- `guild` - - *string* - Seems to return "" even if the player is in a guild. -- `zoneName` - - *string* - The localized zone name (e.g., "The Undercity"). -- `level` - - *string* - The current level (e.g., "90"). -- `gameText` - - *string* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. -- `broadcastText` - - *string* - The Battle.Net broadcast message. -- `broadcastTime` - - *number* - The number of seconds elapsed since the current broadcast message was sent. -- `canSoR` - - *boolean* - Whether or not this friend can receive a Scroll of Resurrection. -- `toonID` - - *number* - A unique numeric identifier for the friend's character during this session. -- `bnetIDAccount` - - *number* -- `isGameAFK` - - *boolean* -- `isGameBusy` - - *boolean* - -**Usage:** -```lua -local bnetIDGameAccount = select(6, BNGetFriendInfo(1)) -- assuming friend index 1 is me (Grdn) -local _, characterName, _, realmName = BNGetGameAccountInfo(bnetIDGameAccount) -print(toonName .. " plays on " .. realmName) -- Grdn plays on Onyxia -``` \ No newline at end of file diff --git a/wiki-information/functions/BNGetGameAccountInfoByGUID.md b/wiki-information/functions/BNGetGameAccountInfoByGUID.md deleted file mode 100644 index a6ccffd1..00000000 --- a/wiki-information/functions/BNGetGameAccountInfoByGUID.md +++ /dev/null @@ -1,106 +0,0 @@ -## Title: C_BattleNet.GetFriendGameAccountInfo - -**Content:** -Returns information on the game the Battle.net friend is playing. -```lua -gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) -``` - -**Parameters:** - -*GetFriendGameAccountInfo:* -- `friendIndex` - - *number* - Index ranging from 1 to BNGetNumFriends() -- `accountIndex` - - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() - -*GetGameAccountInfoByID:* -- `id` - - *number* - gameAccountInfo.gameAccountID - -*GetGameAccountInfoByGUID:* -- `guid` - - *string* - UnitGUID - -**Returns:** -- `gameAccountInfo` - - *BNetGameAccountInfo?* - - `Field` - - `Type` - - `Description` - - `gameAccountID` - - *number?* - A temporary ID for the friend's battle.net game account during this session. - - `clientProgram` - - *string* - BNET_CLIENT - - `isOnline` - - *boolean* - - `isGameBusy` - - *boolean* - - `isGameAFK` - - *boolean* - - `wowProjectID` - - *number?* - - `characterName` - - *string?* - The name of the logged in toon/character - - `realmName` - - *string?* - The name of the logged in realm - - `realmDisplayName` - - *string?* - - `realmID` - - *number?* - The ID for the logged in realm - - `factionName` - - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") - - `raceName` - - *string?* - The localized race name (e.g., "Blood Elf") - - `className` - - *string?* - The localized class name (e.g., "Death Knight") - - `areaName` - - *string?* - The localized zone name (e.g., "The Undercity") - - `characterLevel` - - *number?* - The current level (e.g., "90") - - `richPresence` - - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - - `playerGuid` - - *string?* - A unique numeric identifier for the friend's character during this session. - - `isWowMobile` - - *boolean* - - `canSummon` - - *boolean* - - `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame - - `regionID` - - *number* - Added in 9.1.0 - - `isInCurrentRegion` - - *boolean* - Added in 9.1.0 - -**Description:** -Related API: `C_BattleNet.GetFriendAccountInfo` - -**Usage:** -Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. -```lua -for i = 1, BNGetNumFriends() do - for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do - local game = C_BattleNet.GetFriendGameAccountInfo(i, j) - print(game.gameAccountID, game.isOnline, game.clientProgram) - end -end --- 5, true, "BSAp" - -C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo -for i = 1, BNGetNumFriends() do - local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo - print(game.gameAccountID, game.isOnline, game.clientProgram) -end --- 5, true, "BSAp" --- nil, false, "" -``` - -**Example Usage:** -This function can be used to display detailed information about the games your Battle.net friends are currently playing. For instance, you can create an addon that lists all your friends' current activities across different Blizzard games. - -**Addons Using This API:** -- **ElvUI**: This popular UI overhaul addon uses this API to display detailed information about Battle.net friends in its social module. -- **WeakAuras**: This addon can use this API to trigger custom alerts based on the online status or game activity of Battle.net friends. \ No newline at end of file diff --git a/wiki-information/functions/BNGetInfo.md b/wiki-information/functions/BNGetInfo.md deleted file mode 100644 index f50687ee..00000000 --- a/wiki-information/functions/BNGetInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: BNGetInfo - -**Content:** -Returns the player's own Battle.net info. -`presenceID, battleTag, toonID, currentBroadcast, bnetAFK, bnetDND, isRIDEnabled = BNGetInfo()` - -**Returns:** -- `presenceID` - - *number?* - Your presenceID - appears to be always nil in 8.1.5 -- `battleTag` - - *string* - A nickname and number that when combined, form a unique string that identifies the friend (e.g., "Nickname#0001") -- `toonID` - - *number* - Your toonID -- `currentBroadcast` - - *string* - the current text in your broadcast box -- `bnetAFK` - - *boolean* - true if you're flagged "Away" -- `bnetDND` - - *boolean* - true if you're flagged "Busy" -- `isRIDEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/BNGetNumFriendGameAccounts.md b/wiki-information/functions/BNGetNumFriendGameAccounts.md deleted file mode 100644 index 4c51d161..00000000 --- a/wiki-information/functions/BNGetNumFriendGameAccounts.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: BNGetNumFriendGameAccounts - -**Content:** -Returns the specified Battle.net friend's number of toons. -`numGameAccounts = BNGetNumFriendGameAccounts(friendIndex)` - -**Parameters:** -- `friendIndex` - - *number* - The Battle.net friend's index on the friends list. - -**Returns:** -- `numGameAccounts` - - *number* - The number of accounts or 0 if the friend is not online. - -**Description:** -This function returns the number of ACCOUNTS a player has that are identified with a given BattleTag ID rather than the number of characters on a given account. \ No newline at end of file diff --git a/wiki-information/functions/BNGetNumFriends.md b/wiki-information/functions/BNGetNumFriends.md deleted file mode 100644 index 913fd740..00000000 --- a/wiki-information/functions/BNGetNumFriends.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: BNGetNumFriends - -**Content:** -Returns the amount of (online) Battle.net friends. -`numBNetTotal, numBNetOnline, numBNetFavorite, numBNetFavoriteOnline = BNGetNumFriends()` - -**Returns:** -- `numBNetTotal` - - *number* - amount of Battle.net friends on the friends list -- `numBNetOnline` - - *number* - online Battle.net friends -- `numBNetFavorite` - - *number* - favorite battle.net friends -- `numBNetFavoriteOnline` - - *number* - favorite online battle.net friends - -**Usage:** -```lua -local total, online = BNGetNumFriends() -print("You have "..total.." Battle.net friends and "..online.." of them are online!") -``` \ No newline at end of file diff --git a/wiki-information/functions/BNSendGameData.md b/wiki-information/functions/BNSendGameData.md deleted file mode 100644 index 873e4dac..00000000 --- a/wiki-information/functions/BNSendGameData.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: BNSendGameData - -**Content:** -Sends an addon comm message to a Battle.net friend. -`BNSendGameData(presenceID, addonPrefix, message)` - -**Parameters:** -- `presenceID` - - *number* - A unique numeric identifier for the friend during this session. -- get it with `BNGetFriendInfo()` -- `addonPrefix` - - *string* - <=16 bytes, cannot include a colon -- `message` - - *string* - <=4078 bytes - -On receive, will trigger event `BN_CHAT_MSG_ADDON` with arguments `addonPrefix`, `message`, `"WHISPER"`, `senderPresenceID`. - -**Reference:** -- `BNSendWhisper(presenceID, message)` -- `BN_CHAT_MSG_ADDON` - -**References:** -- [Battle.net Forum](http://us.battle.net/wow/en/forum/topic/11437004031) \ No newline at end of file diff --git a/wiki-information/functions/BNSendWhisper.md b/wiki-information/functions/BNSendWhisper.md deleted file mode 100644 index b83739ad..00000000 --- a/wiki-information/functions/BNSendWhisper.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: BNSendWhisper - -**Content:** -Sends a whisper to Battle.net friends. -`BNSendWhisper(bnetAccountID, message)` - -**Parameters:** -- `bnetAccountID` - - *number* - A unique numeric identifier for the friend during this session. You can get `bnetAccountID` from `C_BattleNet.GetFriendAccountInfo()` -- `message` - - *string* - Message text. Must be less than 4096 bytes. - -The recipient will receive a `CHAT_MSG_BN_WHISPER` event, and the sender will also get a mirrored response from the server as `CHAT_MSG_BN_WHISPER_INFORM`. \ No newline at end of file diff --git a/wiki-information/functions/BNSetAFK.md b/wiki-information/functions/BNSetAFK.md deleted file mode 100644 index f181bdd1..00000000 --- a/wiki-information/functions/BNSetAFK.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: BNSetAFK - -**Content:** -Sets the player's online AFK status. -`BNSetAFK(bool)` - -**Parameters:** -- `bool` - - *boolean* - true to set your battle.net status to AFK and false to unset it. - -**Description:** -`BNSetDND(true)` can override AFK status. -`BNSetDND(false)` can't unset AFK status. \ No newline at end of file diff --git a/wiki-information/functions/BNSetCustomMessage.md b/wiki-information/functions/BNSetCustomMessage.md deleted file mode 100644 index 9a32cb08..00000000 --- a/wiki-information/functions/BNSetCustomMessage.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: BNSetCustomMessage - -**Content:** -Sends a broadcast message to your Real ID friends. -`BNSetCustomMessage(text)` - -**Parameters:** -- `text` - - *string* - message to be broadcasted (max 127 chars) - -**Description:** -Triggers `CHAT_MSG_BN_INLINE_TOAST_BROADCAST` (receiver) -Triggers `CHAT_MSG_BN_INLINE_TOAST_BROADCAST_INFORM` (sender) "Your broadcast has been sent." -See `BNGetInfo()` for the current broadcast message. - -**Usage:** -Sets your broadcast message. -```lua -BNSetCustomMessage("Hello friends!") -``` -Clears your broadcast message. -```lua -BNSetCustomMessage("") -``` \ No newline at end of file diff --git a/wiki-information/functions/BNSetDND.md b/wiki-information/functions/BNSetDND.md deleted file mode 100644 index 2d4f2e41..00000000 --- a/wiki-information/functions/BNSetDND.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: BNSetDND - -**Content:** -Sets the player's online DND status. -`BNSetDND(bool)` - -**Parameters:** -- `bool` - - *boolean* - true to set your battle.net status to DND and false to unset it. - -**Description:** -`BNSetAFK(true)` can override DND status. -`BNSetAFK(false)` can't unset DND status. \ No newline at end of file diff --git a/wiki-information/functions/BNSetFriendNote.md b/wiki-information/functions/BNSetFriendNote.md deleted file mode 100644 index 28692c37..00000000 --- a/wiki-information/functions/BNSetFriendNote.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: BNSetFriendNote - -**Content:** -Sets the Friend Note for a specific Battle.Net friend. -`BNSetFriendNote(bnetIDAccount, noteText)` - -**Parameters:** -- `bnetIDAccount` - - *number* - A unique numeric identifier for the friend's battle.net account during this session. -- `noteText` - - *string* - The text you wish to set as the battle.net friend's new note. \ No newline at end of file diff --git a/wiki-information/functions/BankButtonIDToInvSlotID.md b/wiki-information/functions/BankButtonIDToInvSlotID.md deleted file mode 100644 index c93925a0..00000000 --- a/wiki-information/functions/BankButtonIDToInvSlotID.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: BankButtonIDToInvSlotID - -**Content:** -Maps a BankButtonID to InventorySlotID. -`invSlot = BankButtonIDToInvSlotID(buttonID, isBag)` - -**Parameters:** -- `buttonID` - - *number* - bank item/bag ID. -- `isBag` - - *number* - 1 if buttonID is a bag, nil otherwise. Same result as ContainerIDToInventoryID, except this one only works for bank bags and is more awkward to use. - -**Returns:** -- `invSlot` - - An inventory slot ID that can be used in other inventory functions. \ No newline at end of file diff --git a/wiki-information/functions/BeginTrade.md b/wiki-information/functions/BeginTrade.md deleted file mode 100644 index e28d111d..00000000 --- a/wiki-information/functions/BeginTrade.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: BeginTrade - -**Content:** -Accepts an offer to start trading with another player. -`BeginTrade()` - -**Description:** -`TRADE_REQUEST` notifies you of a pending request to trade; the name of the initiating player is provided as the first argument in the event. -You may accept a trade request using this function, or reject it using `CancelTrade`. -`TRADE_REQUEST_CANCEL` fires if the offering player rescinds the invitation to trade (or moves out of range). \ No newline at end of file diff --git a/wiki-information/functions/BreakUpLargeNumbers.md b/wiki-information/functions/BreakUpLargeNumbers.md deleted file mode 100644 index ecbe820d..00000000 --- a/wiki-information/functions/BreakUpLargeNumbers.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: BreakUpLargeNumbers - -**Content:** -Divides digits into groups using a localized delimiter character. -`valueString = BreakUpLargeNumbers(value)` - -**Parameters:** -- `value` - - *number* - The number to convert into a localized string - -**Returns:** -- `valueString` - - *string* - The whole-number portion converted into a string if greater than 1000, or truncated to two decimals if less than 1000. - -**Description:** -Large numbers are grouped into thousands and millions with a `LARGE_NUMBER_SEPARATOR`, but no further grouping happens for even larger numbers (billions). -Small numbers with a decimal portion are separated with a `DECIMAL_SEPARATOR` and truncated to two decimal places. -Not intended for use with negative numbers. - -**Usage:** -```lua -BreakUpLargeNumbers(123.456789) -- 123.45 -BreakUpLargeNumbers(1234567.89) -- 1,234,567 -BreakUpLargeNumbers(1234567890) -- 1,234,567,890 -``` - -**Reference:** -- `GetLocale` -- `FillLocalizedClassList` -- `FormatLargeNumber` \ No newline at end of file diff --git a/wiki-information/functions/BuyGuildCharter.md b/wiki-information/functions/BuyGuildCharter.md deleted file mode 100644 index 8c3ab60d..00000000 --- a/wiki-information/functions/BuyGuildCharter.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: BuyGuildCharter - -**Content:** -Purchases a guild charter. -`BuyGuildCharter(guildName)` - -**Parameters:** -- `guildName` - - *string* - Name of the guild you wish to purchase a guild charter for. - -**Usage:** -The following purchases a guild charter for "MC Raiders": -```lua -BuyGuildCharter("MC Raiders"); -``` - -**Description:** -There are two preconditions to using BuyGuildCharter: -- Must be talking to a Guild Master NPC. -- Must be on the Purchase a Guild Charter screen. - -**Reference:** -- `OfferPetition` -- `TurnInGuildCharter` \ No newline at end of file diff --git a/wiki-information/functions/BuyMerchantItem.md b/wiki-information/functions/BuyMerchantItem.md deleted file mode 100644 index 2cd71622..00000000 --- a/wiki-information/functions/BuyMerchantItem.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: BuyMerchantItem - -**Content:** -Buys an item from a merchant. -`BuyMerchantItem(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the merchant's inventory -- `quantity` - - *number?* - Quantity to buy. - -**Description:** -If the item is sold in stacks, the quantity specifies how many stacks will be bought. -As of 4.1, the quantity argument behavior is different: -- If you do not specify quantity and the item is sold in stacks it will buy a stack. -- If you specify quantity it will buy the specified amount, sold in stacks or not. -- The only limitation is the maximum stack allowed to buy from the merchant at one time, you can check this with the `GetMerchantItemMaxStack` function. - -**Example Usage:** -```lua --- Buy the first item in the merchant's inventory -BuyMerchantItem(1) - --- Buy 5 stacks of the second item in the merchant's inventory -BuyMerchantItem(2, 5) -``` - -**Addons Using This Function:** -- **Auctioneer**: Uses `BuyMerchantItem` to automate the purchase of items from merchants for resale or crafting. -- **TradeSkillMaster**: Utilizes this function to streamline the process of buying materials from vendors for crafting operations. \ No newline at end of file diff --git a/wiki-information/functions/BuyStableSlot.md b/wiki-information/functions/BuyStableSlot.md deleted file mode 100644 index 0e76d519..00000000 --- a/wiki-information/functions/BuyStableSlot.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: BuyStableSlot - -**Content:** -Buys the next stable slot if the stable window is open and you can afford it. -`BuyStableSlot()` - -**Example Usage:** -This function can be used in macros or addons to automate the process of purchasing stable slots for hunters. For instance, a hunter might use this function in a custom addon to ensure they always have enough stable slots available for new pets. - -**Addons:** -Large addons like "PetTracker" might use this function to manage stable slots automatically, ensuring that players have a seamless experience when capturing and managing pets. \ No newline at end of file diff --git a/wiki-information/functions/BuyTrainerService.md b/wiki-information/functions/BuyTrainerService.md deleted file mode 100644 index e7e3bf84..00000000 --- a/wiki-information/functions/BuyTrainerService.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: BuyTrainerService - -**Content:** -Buys a trainer service (e.g. class skills and profession recipes). -`BuyTrainerService(index)` - -**Parameters:** -- `index` - - *number* - The index of the service to train. - -**Returns:** -- `nil` - -**Example Usage:** -```lua --- Assuming you are at a trainer and want to buy the first service available -BuyTrainerService(1) -``` - -**Description:** -This function is used to purchase a service from a trainer, such as learning a new class skill or profession recipe. The `index` parameter corresponds to the position of the service in the trainer's list. - -**Usage in Addons:** -Many addons that automate or enhance the training process, such as profession leveling addons, use this function to programmatically purchase skills or recipes from trainers. For example, an addon like "TradeSkillMaster" might use this function to help users quickly buy all available profession recipes. \ No newline at end of file diff --git a/wiki-information/functions/BuybackItem.md b/wiki-information/functions/BuybackItem.md deleted file mode 100644 index 86624b4c..00000000 --- a/wiki-information/functions/BuybackItem.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: BuybackItem - -**Content:** -Buys back an item from the merchant. -`BuybackItem(slot)` - -**Parameters:** -- `slot` - - *number* - the slot from top-left to bottom-right of the Merchant Buyback window. - -**Description:** -Merchant Buyback -``` - (1) (2) - (3) (4) - (5) (6) - (7) (8) - (9) (10) -(11) (12) -``` - -**Example Usage:** -```lua --- Buys back the first item in the buyback window -BuybackItem(1) -``` - -**Additional Information:** -This function is commonly used in addons that manage inventory and merchant interactions, such as "Bagnon" or "ElvUI". These addons may use `BuybackItem` to automate the process of buying back accidentally sold items. \ No newline at end of file diff --git a/wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md b/wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md deleted file mode 100644 index 8204ef84..00000000 --- a/wiki-information/functions/C_AccountInfo.GetIDFromBattleNetAccountGUID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AccountInfo.GetIDFromBattleNetAccountGUID - -**Content:** -Converts a battle.net account GUID to battle.net ID. -`battleNetAccountID = C_AccountInfo.GetIDFromBattleNetAccountGUID(battleNetAccountGUID)` - -**Parameters:** -- `battleNetAccountGUID` - - *string* : WOWGUID - -**Returns:** -- `battleNetAccountID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md b/wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md deleted file mode 100644 index e5544ded..00000000 --- a/wiki-information/functions/C_AccountInfo.IsGUIDBattleNetAccountType.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AccountInfo.IsGUIDBattleNetAccountType - -**Content:** -Returns whether a GUID is a battle.net account type. -`isBNet = C_AccountInfo.IsGUIDBattleNetAccountType(guid)` - -**Parameters:** -- `guid` - - *string* - WOWGUID - -**Returns:** -- `isBNet` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md b/wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md deleted file mode 100644 index 8727c2e4..00000000 --- a/wiki-information/functions/C_AccountInfo.IsGUIDRelatedToLocalAccount.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_AccountInfo.IsGUIDRelatedToLocalAccount - -**Content:** -Returns whether a GUID is related to the local (self) account. -`isLocalUser = C_AccountInfo.IsGUIDRelatedToLocalAccount(guid)` - -**Parameters:** -- `guid` - - *string* : WOWGUID - -**Returns:** -- `isLocalUser` - - *boolean* - -**Example Usage:** -This function can be used to determine if a specific GUID (Globally Unique Identifier) belongs to the player’s own account. This can be useful in scenarios where you need to check if a certain action or event is related to the player. - -**Example:** -```lua -local guid = UnitGUID("player") -local isLocalUser = C_AccountInfo.IsGUIDRelatedToLocalAccount(guid) -if isLocalUser then - print("This GUID belongs to the local player.") -else - print("This GUID does not belong to the local player.") -end -``` - -**Addons Usage:** -Large addons like **WeakAuras** and **ElvUI** might use this function to personalize user experiences or to ensure certain functionalities are only applied to the local player. For instance, WeakAuras could use it to display specific auras or effects only for the player’s character. \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.GetRewardItemID.md b/wiki-information/functions/C_AchievementInfo.GetRewardItemID.md deleted file mode 100644 index 9e5e810c..00000000 --- a/wiki-information/functions/C_AchievementInfo.GetRewardItemID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AchievementInfo.GetRewardItemID - -**Content:** -Returns any reward item for an achievement. -`rewardItemID = C_AchievementInfo.GetRewardItemID(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - AchievementID - -**Returns:** -- `rewardItemID` - - *number?* - The ID of the reward item, if any. \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md b/wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md deleted file mode 100644 index 1b587bbc..00000000 --- a/wiki-information/functions/C_AchievementInfo.GetSupercedingAchievements.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_AchievementInfo.GetSupercedingAchievements - -**Content:** -Returns the next achievement in a series. -`supercedingAchievements = C_AchievementInfo.GetSupercedingAchievements(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - AchievementID - -**Returns:** -- `supercedingAchievements` - - *number* - Only returns the next ID in a series even though it's in a table. - -**Usage:** -After Level 90 (6193) comes Level 100 (9060) -```lua -/dump C_AchievementInfo.GetSupercedingAchievements(6193) -> {9060} -``` \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.IsValidAchievement.md b/wiki-information/functions/C_AchievementInfo.IsValidAchievement.md deleted file mode 100644 index b1095f47..00000000 --- a/wiki-information/functions/C_AchievementInfo.IsValidAchievement.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_AchievementInfo.IsValidAchievement - -**Content:** -Needs summary. -`isValidAchievement = C_AchievementInfo.IsValidAchievement(achievementId)` - -**Parameters:** -- `achievementId` - - *number* - -**Returns:** -- `isValidAchievement` - - *boolean* - -**Example Usage:** -This function can be used to check if a given achievement ID corresponds to a valid achievement in the game. This can be particularly useful for addon developers who want to validate achievement IDs before performing operations on them. - -**Addon Usage:** -Large addons like "Overachiever" use this function to ensure that the achievement IDs they are working with are valid before attempting to display or manipulate achievement data. This helps in preventing errors and improving the reliability of the addon. \ No newline at end of file diff --git a/wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md b/wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md deleted file mode 100644 index cb85b870..00000000 --- a/wiki-information/functions/C_AchievementInfo.SetPortraitTexture.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AchievementInfo.SetPortraitTexture - -**Content:** -Sets a portrait texture for the unit being achievement compared. -`C_AchievementInfo.SetPortraitTexture(textureObject)` - -**Parameters:** -- `textureObject` - - *Texture* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.FindPetActionButtons.md b/wiki-information/functions/C_ActionBar.FindPetActionButtons.md deleted file mode 100644 index 378b0691..00000000 --- a/wiki-information/functions/C_ActionBar.FindPetActionButtons.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_ActionBar.FindPetActionButtons - -**Content:** -Needs summary. -`slots = C_ActionBar.FindPetActionButtons(petActionID)` - -**Parameters:** -- `petActionID` - - *number* - -**Returns:** -- `slots` - - *number* - -**Description:** -This function is used to find the action bar slots associated with a specific pet action. It returns the slot number where the pet action is located. - -**Example Usage:** -```lua -local petActionID = 1 -- Example pet action ID -local slot = C_ActionBar.FindPetActionButtons(petActionID) -print("Pet action is located in slot:", slot) -``` - -**Addons:** -Large addons like Bartender4 and Dominos use this function to manage and customize pet action bars, allowing players to rearrange and configure their pet abilities more effectively. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.FindSpellActionButtons.md b/wiki-information/functions/C_ActionBar.FindSpellActionButtons.md deleted file mode 100644 index 3b2f1d7b..00000000 --- a/wiki-information/functions/C_ActionBar.FindSpellActionButtons.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ActionBar.FindSpellActionButtons - -**Content:** -Needs summary. -`slots = C_ActionBar.FindSpellActionButtons(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `slots` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md b/wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md deleted file mode 100644 index 2ec8e228..00000000 --- a/wiki-information/functions/C_ActionBar.GetPetActionPetBarIndices.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_ActionBar.GetPetActionPetBarIndices - -**Content:** -Needs summary. -`slots = C_ActionBar.GetPetActionPetBarIndices(petActionID)` - -**Parameters:** -- `petActionID` - - *number* - -**Returns:** -- `slots` - - *number* - -**Example Usage:** -This function can be used to determine the slot indices on the pet action bar for a given pet action ID. This can be useful for addons that manage or customize pet action bars. - -**Addon Usage:** -Large addons like Bartender4, which is used for customizing action bars, might use this function to manage the pet action bar slots dynamically. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.HasPetActionButtons.md b/wiki-information/functions/C_ActionBar.HasPetActionButtons.md deleted file mode 100644 index cfb5560f..00000000 --- a/wiki-information/functions/C_ActionBar.HasPetActionButtons.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ActionBar.HasPetActionButtons - -**Content:** -True if the pet action is currently on your action bars. -`hasPetActionButtons = C_ActionBar.HasPetActionButtons(petActionID)` - -**Parameters:** -- `petActionID` - - *number* - -**Returns:** -- `hasPetActionButtons` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md b/wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md deleted file mode 100644 index b9af8d1a..00000000 --- a/wiki-information/functions/C_ActionBar.HasPetActionPetBarIndices.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ActionBar.HasPetActionPetBarIndices - -**Content:** -Needs summary. -`hasPetActionPetBarIndices = C_ActionBar.HasPetActionPetBarIndices(petActionID)` - -**Parameters:** -- `petActionID` - - *number* - -**Returns:** -- `hasPetActionPetBarIndices` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.HasSpellActionButtons.md b/wiki-information/functions/C_ActionBar.HasSpellActionButtons.md deleted file mode 100644 index 1d0bc849..00000000 --- a/wiki-information/functions/C_ActionBar.HasSpellActionButtons.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ActionBar.HasSpellActionButtons - -**Content:** -Needs summary. -`hasSpellActionButtons = C_ActionBar.HasSpellActionButtons(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `hasSpellActionButtons` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md b/wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md deleted file mode 100644 index fe2710a8..00000000 --- a/wiki-information/functions/C_ActionBar.IsAutoCastPetAction.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ActionBar.IsAutoCastPetAction - -**Content:** -Needs summary. -`isAutoCastPetAction = C_ActionBar.IsAutoCastPetAction(slotID)` - -**Parameters:** -- `slotID` - - *number* - -**Returns:** -- `isAutoCastPetAction` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md b/wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md deleted file mode 100644 index ef0f08cc..00000000 --- a/wiki-information/functions/C_ActionBar.IsEnabledAutoCastPetAction.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ActionBar.IsEnabledAutoCastPetAction - -**Content:** -Needs summary. -`isEnabledAutoCastPetAction = C_ActionBar.IsEnabledAutoCastPetAction(slotID)` - -**Parameters:** -- `slotID` - - *number* - -**Returns:** -- `isEnabledAutoCastPetAction` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsHarmfulAction.md b/wiki-information/functions/C_ActionBar.IsHarmfulAction.md deleted file mode 100644 index d8e32f0e..00000000 --- a/wiki-information/functions/C_ActionBar.IsHarmfulAction.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_ActionBar.IsHarmfulAction - -**Content:** -Returns true if the specified action is a harmful one. -`isHarmful = C_ActionBar.IsHarmfulAction(actionID, useNeutral)` - -**Parameters:** -- `actionID` - - *number* -- `useNeutral` - - *boolean* - -**Returns:** -- `isHarmful` - - *boolean* - -**Example Usage:** -This function can be used to determine if an action on the action bar is harmful, which can be useful for addons that need to differentiate between harmful and beneficial actions. For example, an addon that automatically casts spells might use this function to ensure it only casts harmful spells on enemies. - -**Addon Usage:** -Large addons like Bartender4, which is a popular action bar replacement addon, might use this function to provide additional customization options for users, such as highlighting harmful actions differently from beneficial ones. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsHelpfulAction.md b/wiki-information/functions/C_ActionBar.IsHelpfulAction.md deleted file mode 100644 index 700f4202..00000000 --- a/wiki-information/functions/C_ActionBar.IsHelpfulAction.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_ActionBar.IsHelpfulAction - -**Content:** -Returns true if the specified action is a helpful one. -`isHelpful = C_ActionBar.IsHelpfulAction(actionID, useNeutral)` - -**Parameters:** -- `actionID` - - *number* -- `useNeutral` - - *boolean* - -**Returns:** -- `isHelpful` - - *boolean* - -**Example Usage:** -This function can be used to determine if an action (such as a spell or ability) is beneficial, which can be useful for addons that manage action bars or automate certain actions based on the type of ability. - -**Addon Usage:** -Large addons like Bartender4, which is a popular action bar replacement addon, might use this function to categorize and display helpful actions differently from harmful ones. This helps in organizing the action bars more effectively based on the type of action. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md b/wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md deleted file mode 100644 index 3951d321..00000000 --- a/wiki-information/functions/C_ActionBar.IsOnBarOrSpecialBar.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_ActionBar.IsOnBarOrSpecialBar - -**Content:** -Needs summary. -`isOnBarOrSpecialBar = C_ActionBar.IsOnBarOrSpecialBar(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `isOnBarOrSpecialBar` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific spell is present on the action bar or a special bar. This can be particularly useful for addons that manage or customize action bars, ensuring that certain spells are always accessible to the player. - -**Addons:** -Large addons like Bartender4 or Dominos, which are popular action bar replacement addons, might use this function to verify the presence of spells on the action bars they manage. This helps in maintaining consistency and ensuring that the player's key bindings and action bar setups are correctly configured. \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md b/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md deleted file mode 100644 index e2288367..00000000 --- a/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowHealthBar.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ActionBar.ShouldOverrideBarShowHealthBar - -**Content:** -Needs summary. -`showHealthBar = C_ActionBar.ShouldOverrideBarShowHealthBar()` - -**Returns:** -- `showHealthBar` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md b/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md deleted file mode 100644 index cba24c5e..00000000 --- a/wiki-information/functions/C_ActionBar.ShouldOverrideBarShowManaBar.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ActionBar.ShouldOverrideBarShowManaBar - -**Content:** -Needs summary. -`showManaBar = C_ActionBar.ShouldOverrideBarShowManaBar()` - -**Returns:** -- `showManaBar` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md b/wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md deleted file mode 100644 index 4ab0af04..00000000 --- a/wiki-information/functions/C_ActionBar.ToggleAutoCastPetAction.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ActionBar.ToggleAutoCastPetAction - -**Content:** -Needs summary. -`C_ActionBar.ToggleAutoCastPetAction(slotID)` - -**Parameters:** -- `slotID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.DisableAddOn.md b/wiki-information/functions/C_AddOns.DisableAddOn.md deleted file mode 100644 index 420dd609..00000000 --- a/wiki-information/functions/C_AddOns.DisableAddOn.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_AddOns.DisableAddOn - -**Content:** -Disables an addon on the next session. -`C_AddOns.DisableAddOn(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be disabled, or an index from 1 to `C_AddOns.GetNumAddOns`. Blizzard addons cannot be disabled. -- `character` - - *string?* - The name of the character, excluding the realm name. If omitted, disables the addon for all characters. - -**Usage:** -Disables an addon for all characters on the current realm. -```lua -C_AddOns.DisableAddOn("HelloWorld") -``` -Disables an addon only for the current character. -```lua -C_AddOns.DisableAddOn("HelloWorld", UnitName("player")) -``` - -**Description:** -Related API: -- `C_AddOns.EnableAddOn` \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.DisableAllAddOns.md b/wiki-information/functions/C_AddOns.DisableAllAddOns.md deleted file mode 100644 index 0ff30634..00000000 --- a/wiki-information/functions/C_AddOns.DisableAllAddOns.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_AddOns.DisableAllAddOns - -**Content:** -Disables all addons on the addon list. -`C_AddOns.DisableAllAddOns()` - -**Parameters:** -- `character` - - *string?* - The name of the character, excluding the realm name. If omitted, disables all addons for all characters. - -**Example Usage:** -```lua --- Disable all addons for the current character -C_AddOns.DisableAllAddOns() - --- Disable all addons for a specific character -C_AddOns.DisableAllAddOns("CharacterName") -``` - -**Description:** -This function is useful for quickly disabling all addons, either globally or for a specific character. This can be particularly helpful when troubleshooting issues caused by addon conflicts or when preparing for a clean testing environment. - -**Addons Using This Function:** -While specific large addons using this function are not commonly documented, it is often used in custom scripts and addon management tools to provide users with the ability to quickly disable all addons for troubleshooting purposes. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.DoesAddOnExist.md b/wiki-information/functions/C_AddOns.DoesAddOnExist.md deleted file mode 100644 index 4093b068..00000000 --- a/wiki-information/functions/C_AddOns.DoesAddOnExist.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_AddOns.DoesAddOnExist - -**Content:** -Needs summary. -`exists = C_AddOns.DoesAddOnExist(name)` - -**Parameters:** -- `name` - - *string|number* - -**Returns:** -- `exists` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific addon is installed and available in the game. For instance, if you want to verify if the "Deadly Boss Mods" addon is installed, you can use this function as follows: -```lua -local addonName = "Deadly Boss Mods" -local exists = C_AddOns.DoesAddOnExist(addonName) -if exists then - print(addonName .. " is installed.") -else - print(addonName .. " is not installed.") -end -``` - -**Usage in Addons:** -Many large addons, such as ElvUI, use this function to check for the presence of other addons to ensure compatibility or to provide additional functionality if certain addons are detected. For example, ElvUI might check if "WeakAuras" is installed to offer enhanced integration features. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.EnableAddOn.md b/wiki-information/functions/C_AddOns.EnableAddOn.md deleted file mode 100644 index a52ee876..00000000 --- a/wiki-information/functions/C_AddOns.EnableAddOn.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_AddOns.EnableAddOn - -**Content:** -Enables an addon on the next session. -`C_AddOns.EnableAddOn(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be enabled, or an index from 1 to `C_AddOns.GetNumAddOns`. Blizzard addons can only be enabled by name. -- `character` - - *string?* - The name of the character, excluding the realm name. If omitted, enables the addon for all characters. - -**Usage:** -- Enables an addon for all characters on the current realm. - ```lua - C_AddOns.EnableAddOn("HelloWorld") - ``` -- Enables an addon only for the current character. - ```lua - C_AddOns.EnableAddOn("HelloWorld", UnitName("player")) - ``` - -**Description:** -Related API: -- `C_AddOns.DisableAddOn` \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.EnableAllAddOns.md b/wiki-information/functions/C_AddOns.EnableAllAddOns.md deleted file mode 100644 index 1aac37b8..00000000 --- a/wiki-information/functions/C_AddOns.EnableAllAddOns.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AddOns.EnableAllAddOns - -**Content:** -Enables all addons on the addon list. -`C_AddOns.EnableAllAddOns()` - -**Parameters:** -- `character` - - *string?* - The name of the character, excluding the realm name. If omitted, enables all addons for all characters. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnDependencies.md b/wiki-information/functions/C_AddOns.GetAddOnDependencies.md deleted file mode 100644 index e723408c..00000000 --- a/wiki-information/functions/C_AddOns.GetAddOnDependencies.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AddOns.GetAddOnDependencies - -**Content:** -Returns a list of TOC dependencies. -`dep1, ... = C_AddOns.GetAddOnDependencies(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. Blizzard addons can only be queried by name. - -**Returns:** -- `dep1, ...` - - *string?* - A list of addon names that are a dependency. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnEnableState.md b/wiki-information/functions/C_AddOns.GetAddOnEnableState.md deleted file mode 100644 index dbeb1a60..00000000 --- a/wiki-information/functions/C_AddOns.GetAddOnEnableState.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: C_AddOns.GetAddOnEnableState - -**Content:** -Queries the enabled state of an addon, optionally for a specific character. -`state = C_AddOns.GetAddOnEnableState(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. -- `character` - - *string?* - The name of the character to check against, or omitted/nil for all characters. - -**Returns:** -- `state` - - *Enum.AddOnEnableState* - The enabled state of the addon. - - `Value` - - `Field` - - `Description` - - `0` - - `None` - Disabled - - `1` - - `Some` - Enabled for some characters; this is only possible if character is nil. - - `2` - - `All` - Enabled - -**Example Usage:** -```lua -local state = C_AddOns.GetAddOnEnableState("MyAddon") -if state == Enum.AddOnEnableState.All then - print("MyAddon is enabled for all characters.") -elseif state == Enum.AddOnEnableState.Some then - print("MyAddon is enabled for some characters.") -else - print("MyAddon is disabled.") -end -``` - -**Additional Information:** -This function is useful for addon developers who need to check if their addon is enabled for specific characters or globally. It can be particularly helpful in scenarios where different settings or behaviors are required based on the addon's enabled state. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnInfo.md b/wiki-information/functions/C_AddOns.GetAddOnInfo.md deleted file mode 100644 index 29660786..00000000 --- a/wiki-information/functions/C_AddOns.GetAddOnInfo.md +++ /dev/null @@ -1,57 +0,0 @@ -## Title: C_AddOns.GetAddOnInfo - -**Content:** -Needs summary. -`name, title, notes, loadable, reason, security, updateAvailable = C_AddOns.GetAddOnInfo(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to C_AddOns.GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `name` - - *string* - The name of the AddOn (the folder name). -- `title` - - *string* - The localized title of the AddOn as listed in the .toc file. -- `notes` - - *string* - The localized notes about the AddOn from its .toc file. -- `loadable` - - *boolean* - Indicates if the AddOn is loaded or eligible to be loaded, true if it is, false if it is not. -- `reason` - - *string* - The reason why the AddOn cannot be loaded. This is nil if the addon is loadable, otherwise it contains a string token indicating the reason that can be localized by prepending "ADDON_". -- `security` - - *string* - Indicates the security status of the AddOn. This is currently "INSECURE" for all user-provided addons, "SECURE_PROTECTED" for guarded Blizzard addons, and "SECURE" for all other Blizzard AddOns. -- `updateAvailable` - - *boolean* - Not currently used. - -**Description:** -A full list of all reason codes can be found below. - -**Reason Codes:** -- `CORRUPT` - Corrupt -- `DEMAND_LOADED` - Only loadable on demand -- `DEP_BANNED` - Dependency banned -- `DEP_CORRUPT` - Dependency corrupt -- `DEP_DEMAND_LOADED` - Dependency only loadable on demand -- `DEP_DISABLED` - Dependency disabled -- `DEP_EXCLUDED_FROM_BUILD` - Dependency excluded from build -- `DEP_INSECURE` - Dependency incompatible -- `DEP_INTERFACE_VERSION` - Dependency insecure -- `DEP_LOADABLE` - Dependency out of date -- `DEP_MISSING` - Dependency missing -- `DEP_NO_ACTIVE_INTERFACE` - Dependency has no active UI -- `DEP_NOT_AVAILABLE` - Dependency not available -- `DEP_USER_ADDONS_DISABLED` - Dependency user addons disabled -- `DEP_WRONG_ACTIVE_INTERFACE` - Dependency has wrong active UI -- `DEP_WRONG_GAME_TYPE` - Dependency has wrong game type -- `DEP_WRONG_LOAD_PHASE` - Dependency has wrong load phase -- `EXCLUDED_FROM_BUILD` - Excluded from build -- `INSECURE` - Insecure -- `INTERFACE_VERSION` - Out of date -- `MISSING` - Missing -- `NO_ACTIVE_INTERFACE` - No active UI -- `NOT_AVAILABLE` - Not available -- `USER_ADDONS_DISABLED` - User addons disabled -- `WRONG_ACTIVE_INTERFACE` - Wrong active UI -- `WRONG_GAME_TYPE` - Wrong game type -- `WRONG_LOAD_PHASE` - Wrong load phase \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnMetadata.md b/wiki-information/functions/C_AddOns.GetAddOnMetadata.md deleted file mode 100644 index 2eee4967..00000000 --- a/wiki-information/functions/C_AddOns.GetAddOnMetadata.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_AddOns.GetAddOnMetadata - -**Content:** -Returns the TOC metadata of an addon. -`value = C_AddOns.GetAddOnMetadata(name, variable)` - -**Parameters:** -- `name` - - *string|number* - The name or index of the addon, case insensitive. -- `variable` - - *string* - Variable name, case insensitive. May be Title, Notes, Author, Version, or anything starting with X-. - -**Returns:** -- `value` - - *string?* - The value of the variable. - -**Description:** -Unlike `GetAddOnMetadata`, this function will raise an "Invalid AddOn name" error if supplied the name of an addon that does not exist. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md b/wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md deleted file mode 100644 index 8f25e32a..00000000 --- a/wiki-information/functions/C_AddOns.GetAddOnOptionalDependencies.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AddOns.GetAddOnOptionalDependencies - -**Content:** -Returns a list of optional TOC dependencies. -`dep1, ... = C_AddOns.GetAddOnOptionalDependencies(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `dep1, ...` - - *string?* - A list of addon names that are an optional dependency. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.GetNumAddOns.md b/wiki-information/functions/C_AddOns.GetNumAddOns.md deleted file mode 100644 index 2c062e04..00000000 --- a/wiki-information/functions/C_AddOns.GetNumAddOns.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AddOns.GetNumAddOns - -**Content:** -Returns the number of AddOns. -`numAddOns = C_AddOns.GetNumAddOns()` - -**Returns:** -- `numAddOns` - - *number* - The number of user-installed addons. Blizzard addons are not counted. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md b/wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md deleted file mode 100644 index ec5b0fff..00000000 --- a/wiki-information/functions/C_AddOns.IsAddOnLoadOnDemand.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_AddOns.IsAddOnLoadOnDemand - -**Content:** -Needs summary. -`loadOnDemand = C_AddOns.IsAddOnLoadOnDemand(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to C_AddOns.GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `loadOnDemand` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific addon is set to load on demand. This is useful for addon developers who want to manage dependencies and ensure that certain addons are only loaded when necessary. - -**Example:** -```lua -local addonName = "MyAddon" -local isLoadOnDemand = C_AddOns.IsAddOnLoadOnDemand(addonName) -print(addonName .. " is load on demand: " .. tostring(isLoadOnDemand)) -``` - -**Usage in Addons:** -Many large addons, such as WeakAuras, use this function to check the load state of their modules or dependencies to optimize performance and memory usage. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddOnLoadable.md b/wiki-information/functions/C_AddOns.IsAddOnLoadable.md deleted file mode 100644 index c3f14a51..00000000 --- a/wiki-information/functions/C_AddOns.IsAddOnLoadable.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_AddOns.IsAddOnLoadable - -**Content:** -Needs summary. -`loadable, reason = C_AddOns.IsAddOnLoadable(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. -- `character` - - *string?* - The name of the character to check against, or omitted/nil for all characters. -- `demandLoaded` - - *boolean?* = false - -**Returns:** -- `loadable` - - *boolean* -- `reason` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddOnLoaded.md b/wiki-information/functions/C_AddOns.IsAddOnLoaded.md deleted file mode 100644 index 73c4e002..00000000 --- a/wiki-information/functions/C_AddOns.IsAddOnLoaded.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_AddOns.IsAddOnLoaded - -**Content:** -Needs summary. -`loadedOrLoading, loaded = C_AddOns.IsAddOnLoaded(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to C_AddOns.GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `loadedOrLoading` - - *boolean* -- `loaded` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md b/wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md deleted file mode 100644 index 6ac69a4f..00000000 --- a/wiki-information/functions/C_AddOns.IsAddonVersionCheckEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AddOns.IsAddonVersionCheckEnabled - -**Content:** -Needs summary. -`isEnabled = C_AddOns.IsAddonVersionCheckEnabled()` - -**Returns:** -- `isEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.LoadAddOn.md b/wiki-information/functions/C_AddOns.LoadAddOn.md deleted file mode 100644 index 34aa738c..00000000 --- a/wiki-information/functions/C_AddOns.LoadAddOn.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_AddOns.LoadAddOn - -**Content:** -Needs summary. -`loaded, value = C_AddOns.LoadAddOn(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to `C_AddOns.GetNumAddOns`. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `loaded` - - *boolean?* - true if the addon was loaded successfully, or if it has already been loaded. -- `value` - - *string?* - Locale-independent reason why the addon could not be loaded e.g. "DISABLED", otherwise returns nil if the addon was loaded. - -**Description:** -Calling this function inside an `ADDON_LOADED` event handler may result in the named addon never receiving its own `ADDON_LOADED` event, as any new registrations for the event do not take effect until the dispatch of the first event has completed. \ No newline at end of file diff --git a/wiki-information/functions/C_AddOns.SetAddonVersionCheck.md b/wiki-information/functions/C_AddOns.SetAddonVersionCheck.md deleted file mode 100644 index 7da470ff..00000000 --- a/wiki-information/functions/C_AddOns.SetAddonVersionCheck.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AddOns.SetAddonVersionCheck - -**Content:** -Needs summary. -`C_AddOns.SetAddonVersionCheck(enabled)` - -**Parameters:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md deleted file mode 100644 index 847a880d..00000000 --- a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIForMap.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AreaPoiInfo.GetAreaPOIForMap - -**Content:** -Returns area points of interest for a map. -`areaPoiIDs = C_AreaPoiInfo.GetAreaPOIForMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `areaPoiIDs` - - *number* - AreaPOI \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md deleted file mode 100644 index fdc220e8..00000000 --- a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOIInfo.md +++ /dev/null @@ -1,53 +0,0 @@ -## Title: C_AreaPoiInfo.GetAreaPOIInfo - -**Content:** -Returns info for an area point of interest (e.g. World PvP objectives). -`poiInfo = C_AreaPoiInfo.GetAreaPOIInfo(uiMapID, areaPoiID)` - -**Parameters:** -- `uiMapID` - - *number* : UiMapID -- `areaPoiID` - - *number* : AreaPOI - -**Returns:** -- `poiInfo` - - *AreaPOIInfo* - a table containing: - - `Field` - - `Type` - - `Description` - - `areaPoiID` - - *number* - - `position` - - *vector2* 🔗 - - `name` - - *string* - e.g. "Domination Point Tower" - - `description` - - *string?* - e.g. "Horde Controlled" or "Grand Master Pet Tamer" - - `textureIndex` - - *number?* - - `tooltipWidgetSet` - - *number?* - Previously widgetSetID (10.2.6) - - `iconWidgetSet` - - *number?* - - `atlasName` - - *string?* - AtlasID - - `uiTextureKit` - - *string?* : textureKit - - `shouldGlow` - - *boolean* - - `factionID` - - *number?* - Added in 10.0.2 - - `isPrimaryMapForPOI` - - *boolean* - Added in 10.0.2 - - `isAlwaysOnFlightmap` - - *boolean* - Added in 10.0.2 - - `addPaddingAboveTooltipWidgets` - - *boolean?* - Previously addPaddingAboveWidgets (10.2.6) - - `highlightWorldQuestsOnHover` - - *boolean* - - `highlightVignettesOnHover` - - *boolean* - -**Description:** -The textureIndex specifies an icon from Interface/Minimap/POIIcons. You can use `GetPOITextureCoords()` to resolve these indices to texture coordinates. \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md b/wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md deleted file mode 100644 index 94803e78..00000000 --- a/wiki-information/functions/C_AreaPoiInfo.GetAreaPOITimeLeft.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AreaPoiInfo.GetAreaPOITimeLeft - -**Content:** -Returns the number of minutes until the POI expires. -`minutesLeft = C_AreaPoiInfo.GetAreaPOITimeLeft(areaPoiID)` - -**Parameters:** -- `areaPoiID` - - *number* - area point of interest ID. - -**Returns:** -- `minutesLeft` - - *number* - time left in minutes. \ No newline at end of file diff --git a/wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md b/wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md deleted file mode 100644 index 1caf56a2..00000000 --- a/wiki-information/functions/C_AreaPoiInfo.IsAreaPOITimed.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_AreaPoiInfo.IsAreaPOITimed - -**Content:** -Returns whether an area poi is timed. -`isTimed, hideTimerInTooltip = C_AreaPoiInfo.IsAreaPOITimed(areaPoiID)` - -**Parameters:** -- `areaPoiID` - - *number* - -**Returns:** -- `isTimed` - - *boolean* -- `hideTimerInTooltip` - - *boolean?* - -**Description:** -This statically determines if the POI is timed, `GetAreaPOITimeLeft` retrieves the value from the server and may return nothing for long intervals. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md b/wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md deleted file mode 100644 index e8c70eaf..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.CanSelectPower.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.CanSelectPower - -**Content:** -Needs summary. -`canSelect = C_AzeriteEmpoweredItem.CanSelectPower(azeriteEmpoweredItemLocation, powerID)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* -- `powerID` - - *number* - -**Returns:** -- `canSelect` - - *boolean* - -**Example Usage:** -This function can be used to determine if a specific Azerite power can be selected for an Azerite item. This is useful in addons that manage Azerite gear and powers, such as AzeritePowerWeights, which helps players choose the best Azerite traits for their gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md b/wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md deleted file mode 100644 index 7c32ea8d..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec - -**Content:** -Needs summary. -`C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec()` - -**Description:** -This function is used to close the Azerite Empowered Item Respec interface. This is typically used after a player has finished respeccing their Azerite traits and wants to close the UI. - -**Example Usage:** -```lua --- Example of closing the Azerite Empowered Item Respec interface -C_AzeriteEmpoweredItem.CloseAzeriteEmpoweredItemRespec() -``` - -**Usage in Addons:** -Large addons like AzeritePowerWeights use this function to manage the Azerite Empowered Item Respec interface, ensuring that the UI is properly closed after the player has made their selections. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md b/wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md deleted file mode 100644 index 3aba579f..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec - -**Content:** -Needs summary. -`C_AzeriteEmpoweredItem.ConfirmAzeriteEmpoweredItemRespec(azeriteEmpoweredItemLocation)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md deleted file mode 100644 index 37b09828..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfo.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.GetAllTierInfo - -**Content:** -Needs summary. -```lua -tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfo(azeriteEmpoweredItemLocation) -tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfoByItemID(itemInfo) -``` - -**Parameters:** - -*GetAllTierInfo:* -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* - -*GetAllTierInfoByItemID:* -- `itemInfo` - - *number|string* - Item ID, Link or Name -- `classID` - - *number?* - Specify a class ID to get tier information about that class, otherwise uses the player's class if left nil - -**Returns:** -- `tierInfo` - - *structure* - AzeriteEmpoweredItemTierInfo - - `Field` - - `Type` - - `Description` - - `azeritePowerIDs` - - *number* - - `unlockLevel` - - *number* - -**Example Usage:** -This function can be used to retrieve information about all the tiers of Azerite powers available for a given Azerite item. This is particularly useful for addons that need to display or process Azerite power information. - -**Addon Usage:** -Large addons like AzeritePowerWeights use this function to calculate and display the optimal Azerite traits for players based on their class and spec. This helps players make informed decisions about which Azerite traits to select for their gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md deleted file mode 100644 index 04c5ae6a..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAllTierInfoByItemID.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.GetAllTierInfo - -**Content:** -Needs summary. -```lua -tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfo(azeriteEmpoweredItemLocation) -tierInfo = C_AzeriteEmpoweredItem.GetAllTierInfoByItemID(itemInfo) -``` - -**Parameters:** - -*GetAllTierInfo:* -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* - -*GetAllTierInfoByItemID:* -- `itemInfo` - - *number|string* - Item ID, Link, or Name -- `classID` - - *number?* - Specify a class ID to get tier information about that class, otherwise uses the player's class if left nil - -**Returns:** -- `tierInfo` - - *structure* - AzeriteEmpoweredItemTierInfo - - `Field` - - `Type` - - `Description` - - `azeritePowerIDs` - - *number* - - `unlockLevel` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md deleted file mode 100644 index 0e5672b8..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost - -**Content:** -Needs summary. -`cost = C_AzeriteEmpoweredItem.GetAzeriteEmpoweredItemRespecCost()` - -**Returns:** -- `cost` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md deleted file mode 100644 index f5300b2a..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerInfo.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.GetPowerInfo - -**Content:** -Needs summary. -`powerInfo = C_AzeriteEmpoweredItem.GetPowerInfo(powerID)` - -**Parameters:** -- `powerID` - - *number* - -**Returns:** -- `powerInfo` - - *structure* - AzeriteEmpoweredItemPowerInfo - - `Field` - - `Type` - - `Description` - - `azeritePowerID` - - *number* - - `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md deleted file mode 100644 index 6761bc88..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.GetPowerText.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.GetPowerText - -**Content:** -Needs summary. -`powerText = C_AzeriteEmpoweredItem.GetPowerText(azeriteEmpoweredItemLocation, powerID, level)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* -- `powerID` - - *number* -- `level` - - *Enum.AzeritePowerLevel* - - `Value` - - `Field` - - `Description` - - `0` - - Base - - `1` - - Upgraded - - `2` - - Downgraded - -**Returns:** -- `powerText` - - *structure* - AzeriteEmpoweredItemPowerText - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `description` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md b/wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md deleted file mode 100644 index 25edba3d..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.GetSpecsForPower.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.GetSpecsForPower - -**Content:** -Needs summary. -`specInfo = C_AzeriteEmpoweredItem.GetSpecsForPower(powerID)` - -**Parameters:** -- `powerID` - - *number* - -**Returns:** -- `specInfo` - - *structure* - AzeriteSpecInfo - - `Field` - - `Type` - - `Description` - - `classID` - - *number* - - `specID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md b/wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md deleted file mode 100644 index aee2e63c..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.HasAnyUnselectedPowers.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.HasAnyUnselectedPowers - -**Content:** -Needs summary. -`hasAnyUnselectedPowers = C_AzeriteEmpoweredItem.HasAnyUnselectedPowers(azeriteEmpoweredItemLocation)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* - -**Returns:** -- `hasAnyUnselectedPowers` - - *boolean* - -**Example Usage:** -This function can be used to check if an Azerite item has any unselected powers. This is useful for addons that manage gear and want to alert the player if they have unselected Azerite powers. - -**Addon Usage:** -- **WeakAuras**: This popular addon could use this function to create alerts for players, reminding them to select Azerite powers on newly acquired gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md b/wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md deleted file mode 100644 index cf5f0bb7..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.HasBeenViewed.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.HasBeenViewed - -**Content:** -Needs summary. -`hasBeenViewed = C_AzeriteEmpoweredItem.HasBeenViewed(azeriteEmpoweredItemLocation)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* - -**Returns:** -- `hasBeenViewed` - - *boolean* - -**Example Usage:** -This function can be used to check if an Azerite Empowered Item has been viewed by the player. This can be useful in addons that track player interactions with Azerite gear, such as ensuring that players are aware of new traits available for selection. - -**Addon Usage:** -Large addons like WeakAuras might use this function to create alerts or notifications for players to view their Azerite Empowered Items and select new traits. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md deleted file mode 100644 index 55096a8c..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem - -**Content:** -Needs summary. -`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem(itemLocation)` -`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID(itemInfo)` - -**Parameters:** -- **IsAzeriteEmpoweredItem:** - - `itemLocation` - - *ItemLocationMixin* - -- **IsAzeriteEmpoweredItemByID:** - - `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `isAzeriteEmpoweredItem` - - *boolean* - -**Example Usage:** -This function can be used to check if a given item is an Azerite Empowered Item, which is useful for addons that manage gear sets or provide additional information about items in the player's inventory. - -**Addon Usage:** -Large addons like **Pawn** and **AzeritePowerWeights** use this function to determine if an item is an Azerite Empowered Item and to provide recommendations or weights for the best Azerite traits to choose. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md deleted file mode 100644 index 2fc7191f..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem - -**Content:** -Needs summary. -`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItem(itemLocation)` -`isAzeriteEmpoweredItem = C_AzeriteEmpoweredItem.IsAzeriteEmpoweredItemByID(itemInfo)` - -**Parameters:** -- **IsAzeriteEmpoweredItem:** - - `itemLocation` - - *ItemLocationMixin* - -- **IsAzeriteEmpoweredItemByID:** - - `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `isAzeriteEmpoweredItem` - - *boolean* - -**Example Usage:** -This function can be used to determine if a given item is an Azerite Empowered Item, which is useful for addons that manage gear sets or provide additional information about items in the player's inventory. - -**Addon Usage:** -Large addons like **Pawn** and **AzeritePowerWeights** use this function to evaluate and suggest the best Azerite traits for players based on their current gear. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md deleted file mode 100644 index 293b47f6..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable - -**Content:** -Needs summary. -`isAzeritePreviewSourceDisplayable = C_AzeriteEmpoweredItem.IsAzeritePreviewSourceDisplayable(itemInfo)` - -**Parameters:** -- `itemInfo` - - *string* -- `classID` - - *number?* - Specify a class ID to determine if it's displayable for that class, otherwise uses the player's class if left nil. - -**Returns:** -- `isAzeritePreviewSourceDisplayable` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md deleted file mode 100644 index d347c525..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped - -**Content:** -Needs summary. -`isHeartOfAzerothEquipped = C_AzeriteEmpoweredItem.IsHeartOfAzerothEquipped()` - -**Returns:** -- `isHeartOfAzerothEquipped` - - *boolean* - -**Example Usage:** -This function can be used to check if the player has the Heart of Azeroth equipped, which is essential for accessing Azerite traits in Battle for Azeroth content. - -**Addon Usage:** -Large addons like WeakAuras might use this function to create custom alerts or notifications for players, ensuring they have the Heart of Azeroth equipped when entering specific content or engaging in certain activities. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md deleted file mode 100644 index ac541f6e..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerAvailableForSpec.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.IsPowerAvailableForSpec - -**Content:** -Needs summary. -`isPowerAvailableForSpec = C_AzeriteEmpoweredItem.IsPowerAvailableForSpec(powerID, specID)` - -**Parameters:** -- `powerID` - - *number* -- `specID` - - *number* - -**Returns:** -- `isPowerAvailableForSpec` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md b/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md deleted file mode 100644 index 476670cd..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.IsPowerSelected.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.IsPowerSelected - -**Content:** -Needs summary. -`isSelected = C_AzeriteEmpoweredItem.IsPowerSelected(azeriteEmpoweredItemLocation, powerID)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* -- `powerID` - - *number* - -**Returns:** -- `isSelected` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md b/wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md deleted file mode 100644 index cef4445f..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.SelectPower.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.SelectPower - -**Content:** -Needs summary. -`success = C_AzeriteEmpoweredItem.SelectPower(azeriteEmpoweredItemLocation, powerID)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* -- `powerID` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Example Usage:** -This function can be used to select a specific Azerite power for an Azerite item. For instance, if you have an Azerite item and you want to programmatically select a power based on certain conditions, you can use this function to do so. - -**Addon Usage:** -Large addons like AzeritePowerWeights use this function to allow players to automatically select the best Azerite powers based on predefined weights and criteria. This helps in optimizing the character's performance without manually selecting each power. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md b/wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md deleted file mode 100644 index 184f0d6e..00000000 --- a/wiki-information/functions/C_AzeriteEmpoweredItem.SetHasBeenViewed.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEmpoweredItem.SetHasBeenViewed - -**Content:** -Needs summary. -`C_AzeriteEmpoweredItem.SetHasBeenViewed(azeriteEmpoweredItemLocation)` - -**Parameters:** -- `azeriteEmpoweredItemLocation` - - *ItemLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.ActivateEssence.md b/wiki-information/functions/C_AzeriteEssence.ActivateEssence.md deleted file mode 100644 index b8888359..00000000 --- a/wiki-information/functions/C_AzeriteEssence.ActivateEssence.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_AzeriteEssence.ActivateEssence - -**Content:** -Needs summary. -`C_AzeriteEssence.ActivateEssence(essenceID, milestoneID)` - -**Parameters:** -- `essenceID` - - *number* -- `milestoneID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md b/wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md deleted file mode 100644 index eab07a1d..00000000 --- a/wiki-information/functions/C_AzeriteEssence.CanActivateEssence.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_AzeriteEssence.CanActivateEssence - -**Content:** -Needs summary. -`canActivate = C_AzeriteEssence.CanActivateEssence(essenceID, milestoneID)` - -**Parameters:** -- `essenceID` - - *number* -- `milestoneID` - - *number* - -**Returns:** -- `canActivate` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific Azerite Essence can be activated at a given milestone. This is particularly useful in addons that manage Azerite Essences, such as those that provide recommendations or automate certain aspects of essence management. - -**Addon Usage:** -Large addons like WeakAuras might use this function to create custom alerts or notifications when an essence can be activated, enhancing the player's gameplay experience by providing timely and relevant information. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md b/wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md deleted file mode 100644 index a4dc6371..00000000 --- a/wiki-information/functions/C_AzeriteEssence.CanDeactivateEssence.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_AzeriteEssence.CanDeactivateEssence - -**Content:** -Needs summary. -`canDeactivate = C_AzeriteEssence.CanDeactivateEssence(milestoneID)` - -**Parameters:** -- `milestoneID` - - *number* - -**Returns:** -- `canDeactivate` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific Azerite Essence can be deactivated at a given milestone. This is useful in addons that manage Azerite Essences, allowing players to dynamically change their essences based on the content they are engaging with. - -**Addon Usage:** -Large addons like AzeritePowerWeights use this function to provide players with recommendations on which essences to activate or deactivate based on their current gear and the content they are participating in. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CanOpenUI.md b/wiki-information/functions/C_AzeriteEssence.CanOpenUI.md deleted file mode 100644 index c5556999..00000000 --- a/wiki-information/functions/C_AzeriteEssence.CanOpenUI.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.CanOpenUI - -**Content:** -Needs summary. -`canOpen = C_AzeriteEssence.CanOpenUI()` - -**Returns:** -- `canOpen` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md deleted file mode 100644 index 7df85328..00000000 --- a/wiki-information/functions/C_AzeriteEssence.ClearPendingActivationEssence.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_AzeriteEssence.ClearPendingActivationEssence - -**Content:** -Needs summary. -`C_AzeriteEssence.ClearPendingActivationEssence()` - -**Description:** -This function is used to clear any pending Azerite Essence activation. This can be useful in scenarios where a player has selected an Azerite Essence to activate but decides to cancel the activation before it is finalized. - -**Example Usage:** -```lua --- Clear any pending Azerite Essence activation -C_AzeriteEssence.ClearPendingActivationEssence() -``` - -**Additional Information:** -This function is part of the Azerite Essence system introduced in Battle for Azeroth. It is used to manage the activation of Azerite Essences, which are powerful abilities that can be slotted into the Heart of Azeroth. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.CloseForge.md b/wiki-information/functions/C_AzeriteEssence.CloseForge.md deleted file mode 100644 index c276366b..00000000 --- a/wiki-information/functions/C_AzeriteEssence.CloseForge.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_AzeriteEssence.CloseForge - -**Content:** -Needs summary. -`C_AzeriteEssence.CloseForge()` - -**Example Usage:** -This function can be used to close the Azerite Essence Forge UI in World of Warcraft. This is particularly useful in addons that manage Azerite Essences and need to programmatically close the forge interface. - -**Addons Using This Function:** -- **AzeritePowerWeights**: This addon uses `C_AzeriteEssence.CloseForge` to ensure the Azerite Essence Forge UI is closed after the user has finished configuring their essences, providing a smoother user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md b/wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md deleted file mode 100644 index 9fca31fb..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetEssenceHyperlink.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_AzeriteEssence.GetEssenceHyperlink - -**Content:** -Needs summary. -`link = C_AzeriteEssence.GetEssenceHyperlink(essenceID, rank)` - -**Parameters:** -- `essenceID` - - *number* -- `rank` - - *number* - -**Returns:** -- `link` - - *string* - azessenceLink \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md b/wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md deleted file mode 100644 index 43e84d56..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetEssenceInfo.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_AzeriteEssence.GetEssenceInfo - -**Content:** -Needs summary. -`info = C_AzeriteEssence.GetEssenceInfo(essenceID)` - -**Parameters:** -- `essenceID` - - *number* : AzeriteEssence.db2 - -**Returns:** -- `info` - - *structure* - AzeriteEssenceInfo - - `AzeriteEssenceInfo` - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `name` - - *string* - - `rank` - - *number* - - `unlocked` - - *boolean* - - `valid` - - *boolean* - - `icon` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetEssences.md b/wiki-information/functions/C_AzeriteEssence.GetEssences.md deleted file mode 100644 index 40b6f87d..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetEssences.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_AzeriteEssence.GetEssences - -**Content:** -Needs summary. -`essences = C_AzeriteEssence.GetEssences()` - -**Returns:** -- `essences` - - *structure* - AzeriteEssenceInfo - - `AzeriteEssenceInfo` - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `name` - - *string* - - `rank` - - *number* - - `unlocked` - - *boolean* - - `valid` - - *boolean* - - `icon` - - *number* - -**Example Usage:** -This function can be used to retrieve information about all the Azerite Essences a player has. For instance, an addon could use this to display a list of all available essences along with their ranks and icons. - -**Addons:** -Many popular addons like WeakAuras and AzeritePowerWeights use this function to provide players with detailed information about their Azerite Essences, helping them make informed decisions about which essences to equip. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md b/wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md deleted file mode 100644 index fbff8acc..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetMilestoneEssence.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_AzeriteEssence.GetMilestoneEssence - -**Content:** -Needs summary. -`essenceID = C_AzeriteEssence.GetMilestoneEssence(milestoneID)` - -**Parameters:** -- `milestoneID` - - *number* - -**Returns:** -- `essenceID` - - *number* - -**Example Usage:** -This function can be used to retrieve the essence ID associated with a specific Azerite milestone. For instance, if you want to check which essence is slotted into a particular milestone, you can use this function to get the essence ID and then use other functions to get more details about the essence. - -**Addon Usage:** -Large addons like WeakAuras might use this function to display or track the essences slotted into Azerite milestones, allowing players to create custom alerts or displays based on their current essences. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md b/wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md deleted file mode 100644 index 4b496270..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetMilestoneInfo.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: C_AzeriteEssence.GetMilestoneInfo - -**Content:** -Needs summary. -`info = C_AzeriteEssence.GetMilestoneInfo(milestoneID)` - -**Parameters:** -- `milestoneID` - - *number* - -**Returns:** -- `info` - - *structure* - AzeriteMilestoneInfo - - `AzeriteMilestoneInfo` - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `requiredLevel` - - *number* - - `canUnlock` - - *boolean* - - `unlocked` - - *boolean* - - `rank` - - *number?* (Added in 8.3.0) - - `slot` - - *Enum.AzeriteEssenceSlot?* - - `Enum.AzeriteEssenceSlot` - - `Value` - - `Field` - - `Description` - - `0` - - MainSlot - - `1` - - PassiveOneSlot - - `2` - - PassiveTwoSlot - - `3` - - PassiveThreeSlot (Added in 8.3.0) \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md b/wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md deleted file mode 100644 index 45361f7c..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetMilestoneSpell.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AzeriteEssence.GetMilestoneSpell - -**Content:** -Needs summary. -`spellID = C_AzeriteEssence.GetMilestoneSpell(milestoneID)` - -**Parameters:** -- `milestoneID` - - *number* - -**Returns:** -- `spellID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetMilestones.md b/wiki-information/functions/C_AzeriteEssence.GetMilestones.md deleted file mode 100644 index 518e559d..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetMilestones.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_AzeriteEssence.GetMilestones - -**Content:** -Needs summary. -`milestones = C_AzeriteEssence.GetMilestones()` - -**Returns:** -- `milestones` - - *structure* - AzeriteMilestoneInfo - - `AzeriteMilestoneInfo` - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `requiredLevel` - - *number* - - `canUnlock` - - *boolean* - - `unlocked` - - *boolean* - - `rank` - - *number?* - Added in 8.3.0 - - `slot` - - *Enum.AzeriteEssenceSlot?* - - `Enum.AzeriteEssenceSlot` - - `Value` - - `Field` - - `Description` - - `0` - - MainSlot - - `1` - - PassiveOneSlot - - `2` - - PassiveTwoSlot - - `3` - - PassiveThreeSlot - Added in 8.3.0 \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md b/wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md deleted file mode 100644 index 422ccf58..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetNumUnlockedEssences.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.GetNumUnlockedEssences - -**Content:** -Needs summary. -`numUnlockedEssences = C_AzeriteEssence.GetNumUnlockedEssences()` - -**Returns:** -- `numUnlockedEssences` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md b/wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md deleted file mode 100644 index 76185886..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetNumUsableEssences.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.GetNumUsableEssences - -**Content:** -Needs summary. -`numUsableEssences = C_AzeriteEssence.GetNumUsableEssences()` - -**Returns:** -- `numUsableEssences` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md deleted file mode 100644 index e85d4afd..00000000 --- a/wiki-information/functions/C_AzeriteEssence.GetPendingActivationEssence.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.GetPendingActivationEssence - -**Content:** -Needs summary. -`essenceID = C_AzeriteEssence.GetPendingActivationEssence()` - -**Returns:** -- `essenceID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md b/wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md deleted file mode 100644 index 97a5364c..00000000 --- a/wiki-information/functions/C_AzeriteEssence.HasNeverActivatedAnyEssences.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.HasNeverActivatedAnyEssences - -**Content:** -Needs summary. -`hasNeverActivatedAnyEssences = C_AzeriteEssence.HasNeverActivatedAnyEssences()` - -**Returns:** -- `hasNeverActivatedAnyEssences` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md deleted file mode 100644 index 22cfa0b1..00000000 --- a/wiki-information/functions/C_AzeriteEssence.HasPendingActivationEssence.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.HasPendingActivationEssence - -**Content:** -Needs summary. -`hasEssence = C_AzeriteEssence.HasPendingActivationEssence()` - -**Returns:** -- `hasEssence` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.IsAtForge.md b/wiki-information/functions/C_AzeriteEssence.IsAtForge.md deleted file mode 100644 index b638f40b..00000000 --- a/wiki-information/functions/C_AzeriteEssence.IsAtForge.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.IsAtForge - -**Content:** -Needs summary. -`isAtForge = C_AzeriteEssence.IsAtForge()` - -**Returns:** -- `isAtForge` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md b/wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md deleted file mode 100644 index 72960acf..00000000 --- a/wiki-information/functions/C_AzeriteEssence.SetPendingActivationEssence.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.SetPendingActivationEssence - -**Content:** -Needs summary. -`C_AzeriteEssence.SetPendingActivationEssence(essenceID)` - -**Parameters:** -- `essenceID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md b/wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md deleted file mode 100644 index e0f186d9..00000000 --- a/wiki-information/functions/C_AzeriteEssence.UnlockMilestone.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteEssence.UnlockMilestone - -**Content:** -Needs summary. -`C_AzeriteEssence.UnlockMilestone(milestoneID)` - -**Parameters:** -- `milestoneID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md b/wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md deleted file mode 100644 index 805fda6c..00000000 --- a/wiki-information/functions/C_AzeriteItem.FindActiveAzeriteItem.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteItem.FindActiveAzeriteItem - -**Content:** -Returns an `ItemLocationMixin` describing the location of the active Azerite item. -`activeAzeriteItemLocation = C_AzeriteItem.FindActiveAzeriteItem()` - -**Returns:** -- `activeAzeriteItemLocation` - - `ItemLocationMixin` - Describes the location of the active Azerite item. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md b/wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md deleted file mode 100644 index 784de9fb..00000000 --- a/wiki-information/functions/C_AzeriteItem.GetAzeriteItemXPInfo.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_AzeriteItem.GetAzeriteItemXPInfo - -**Content:** -Needs summary. -`xp, totalLevelXP = C_AzeriteItem.GetAzeriteItemXPInfo(azeriteItemLocation)` - -**Parameters:** -- `azeriteItemLocation` - - *ItemLocationMixin* - -**Returns:** -- `xp` - - *number* -- `totalLevelXP` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.GetPowerLevel.md b/wiki-information/functions/C_AzeriteItem.GetPowerLevel.md deleted file mode 100644 index 31ebcb65..00000000 --- a/wiki-information/functions/C_AzeriteItem.GetPowerLevel.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_AzeriteItem.GetPowerLevel - -**Content:** -Needs summary. -`powerLevel = C_AzeriteItem.GetPowerLevel(azeriteItemLocation)` - -**Parameters:** -- `azeriteItemLocation` - - *ItemLocationMixin* 🔗 - -**Returns:** -- `powerLevel` - - *number* - -**Description:** -This function retrieves the power level of an Azerite item at a specified location. The power level indicates the current level of Azerite power that has been unlocked for the item. - -**Example Usage:** -```lua -local azeriteItemLocation = ItemLocation:CreateFromBagAndSlot(bagID, slotID) -local powerLevel = C_AzeriteItem.GetPowerLevel(azeriteItemLocation) -print("Azerite Power Level: ", powerLevel) -``` - -**Addons Using This Function:** -- **WeakAuras**: Utilizes this function to display the power level of Azerite items in custom auras and notifications. -- **Pawn**: Uses this function to calculate and suggest upgrades for Azerite gear based on the power level. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md b/wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md deleted file mode 100644 index 7ab33cb0..00000000 --- a/wiki-information/functions/C_AzeriteItem.GetUnlimitedPowerLevel.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_AzeriteItem.GetUnlimitedPowerLevel - -**Content:** -Needs summary. -`powerLevel = C_AzeriteItem.GetUnlimitedPowerLevel(azeriteItemLocation)` - -**Parameters:** -- `azeriteItemLocation` - - *ItemLocationMixin* - -**Returns:** -- `powerLevel` - - *number* - -**Example Usage:** -This function can be used to retrieve the unlimited power level of an Azerite item, which can be useful for addons that track or display Azerite item information. - -**Addon Usage:** -Large addons like AzeritePowerWeights use this function to determine the power level of Azerite items to help players optimize their gear choices. \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md b/wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md deleted file mode 100644 index 0c689cd8..00000000 --- a/wiki-information/functions/C_AzeriteItem.HasActiveAzeriteItem.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteItem.HasActiveAzeriteItem - -**Content:** -Returns true if the is either equipped or in the player's (non-bank) bags. -`hasActiveAzeriteItem = C_AzeriteItem.HasActiveAzeriteItem()` - -**Returns:** -- `hasActiveAzeriteItem` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md deleted file mode 100644 index e5f2e35d..00000000 --- a/wiki-information/functions/C_AzeriteItem.IsAzeriteItem.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_AzeriteItem.IsAzeriteItem - -**Content:** -Needs summary. -`isAzeriteItem = C_AzeriteItem.IsAzeriteItem(itemLocation)` -`isAzeriteItem = C_AzeriteItem.IsAzeriteItemByID(itemInfo)` - -**Parameters:** - -*IsAzeriteItem:* -- `itemLocation` - - *ItemLocationMixin* - -*IsAzeriteItemByID:* -- `itemInfo` - - *number|string* - Item ID, Link or Name - -**Returns:** -- `isAzeriteItem` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md deleted file mode 100644 index 8cd92a32..00000000 --- a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemAtMaxLevel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteItem.IsAzeriteItemAtMaxLevel - -**Content:** -Needs summary. -`isAtMax = C_AzeriteItem.IsAzeriteItemAtMaxLevel()` - -**Returns:** -- `isAtMax` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md deleted file mode 100644 index 82b98d08..00000000 --- a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemByID.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_AzeriteItem.IsAzeriteItem - -**Content:** -Needs summary. -`isAzeriteItem = C_AzeriteItem.IsAzeriteItem(itemLocation)` -`isAzeriteItem = C_AzeriteItem.IsAzeriteItemByID(itemInfo)` - -**Parameters:** - -*IsAzeriteItem:* -- `itemLocation` - - *ItemLocationMixin* - -*IsAzeriteItemByID:* -- `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `isAzeriteItem` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md b/wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md deleted file mode 100644 index d9172e23..00000000 --- a/wiki-information/functions/C_AzeriteItem.IsAzeriteItemEnabled.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_AzeriteItem.IsAzeriteItemEnabled - -**Content:** -Needs summary. -`isEnabled = C_AzeriteItem.IsAzeriteItemEnabled(azeriteItemLocation)` - -**Parameters:** -- `azeriteItemLocation` - - *ItemLocationMixin* - -**Returns:** -- `isEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md b/wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md deleted file mode 100644 index 3ec21b90..00000000 --- a/wiki-information/functions/C_AzeriteItem.IsUnlimitedLevelingUnlocked.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_AzeriteItem.IsUnlimitedLevelingUnlocked - -**Content:** -Needs summary. -`isUnlimitedLevelingUnlocked = C_AzeriteItem.IsUnlimitedLevelingUnlocked()` - -**Returns:** -- `isUnlimitedLevelingUnlocked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md b/wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md deleted file mode 100644 index 56486658..00000000 --- a/wiki-information/functions/C_BarberShop.ApplyCustomizationChoices.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.ApplyCustomizationChoices - -**Content:** -Submits chosen barber shop customizations to the server for application. -`success = C_BarberShop.ApplyCustomizationChoices()` - -**Returns:** -- `success` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.Cancel.md b/wiki-information/functions/C_BarberShop.Cancel.md deleted file mode 100644 index cfe7a619..00000000 --- a/wiki-information/functions/C_BarberShop.Cancel.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_BarberShop.Cancel - -**Content:** -Dismisses the barber shop UI, cancelling all customizations. -`C_BarberShop.Cancel()` - -**Example Usage:** -This function can be used in an addon that provides a custom interface for character customization, allowing users to cancel their changes and exit the barber shop UI programmatically. - -**Addons Using This Function:** -Large addons like "ElvUI" or "WeakAuras" might use this function to provide enhanced user experiences by integrating barber shop functionalities into their custom UI elements. For instance, an addon could provide a button to quickly exit the barber shop without saving changes. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ClearPreviewChoices.md b/wiki-information/functions/C_BarberShop.ClearPreviewChoices.md deleted file mode 100644 index 017d3895..00000000 --- a/wiki-information/functions/C_BarberShop.ClearPreviewChoices.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.ClearPreviewChoices - -**Content:** -Clears all actively previewed customization choices on the character. -`C_BarberShop.ClearPreviewChoices()` - -**Parameters:** -- `clearSavedChoices` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md b/wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md deleted file mode 100644 index c9ffb3b8..00000000 --- a/wiki-information/functions/C_BarberShop.GetAvailableCustomizations.md +++ /dev/null @@ -1,95 +0,0 @@ -## Title: C_BarberShop.GetAvailableCustomizations - -**Content:** -Needs summary. -`categories = C_BarberShop.GetAvailableCustomizations()` - -**Returns:** -- `categories` - - *CharCustomizationCategory* - - `Field` - - `Type` - - `Description` - - `id` - - *number* - - `orderIndex` - - *number* - - `name` - - *string* - - `icon` - - *string : textureAtlas* - - `selectedIcon` - - *string : textureAtlas* - - `undressModel` - - *boolean* - - `subcategory` - - *boolean* - - `cameraZoomLevel` - - *number* - - `cameraDistanceOffset` - - *number* - - `spellShapeshiftFormID` - - *number?* - - `chrModelID` - - *number?* - - `options` - - *CharCustomizationOption* - - `hasNewChoices` - - *boolean* - - `needsNativeFormCategory` - - *boolean* - -- `CharCustomizationOption` - - `Field` - - `Type` - - `Description` - - `id` - - *number* - - `name` - - *string* - - `orderIndex` - - *number* - - `optionType` - - *Enum.ChrCustomizationOptionType* - - `choices` - - *CharCustomizationChoice* - - `currentChoiceIndex` - - *number?* - - `hasNewChoices` - - *boolean* - - `isSound` - - *boolean* - -- `Enum.ChrCustomizationOptionType` - - `Value` - - `Field` - - `Description` - - `0` - - *SelectionPopout* - - `1` - - *Checkbox* - - `2` - - *Slider* - -- `CharCustomizationChoice` - - `Field` - - `Type` - - `Description` - - `id` - - *number* - - `name` - - *string* - - `ineligibleChoice` - - *boolean* - - `isNew` - - *boolean* - - `swatchColor1` - - *colorRGB?* - - `swatchColor2` - - *colorRGB?* - - `soundKit` - - *number?* - - `isLocked` - - *boolean* - - `lockedText` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md b/wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md deleted file mode 100644 index d092d215..00000000 --- a/wiki-information/functions/C_BarberShop.GetCurrentCameraZoom.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.GetCurrentCameraZoom - -**Content:** -Returns the current camera zoom level. -`zoomLevel = C_BarberShop.GetCurrentCameraZoom()` - -**Returns:** -- `zoomLevel` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md b/wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md deleted file mode 100644 index 34be0468..00000000 --- a/wiki-information/functions/C_BarberShop.GetCurrentCharacterData.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: C_BarberShop.GetCurrentCharacterData - -**Content:** -Needs summary. -`characterData = C_BarberShop.GetCurrentCharacterData()` - -**Returns:** -- `characterData` - - *PlayerInfoCharacterData* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `fileName` - - *string* - - `alternateFormRaceData` - - *CharacterAlternateFormData?* - - `createScreenIconAtlas` - - *string* - - `sex` - - *Enum.UnitSex* - -**CharacterAlternateFormData:** -- `Field` -- `Type` -- `Description` -- `raceID` - - *number* -- `name` - - *string* -- `fileName` - - *string* -- `createScreenIconAtlas` - - *string* - -**Enum.UnitSex:** -- `Value` -- `Field` -- `Description` -- `0` - - Male -- `1` - - Female -- `2` - - None -- `3` - - Both -- `4` - - Neutral \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetCurrentCost.md b/wiki-information/functions/C_BarberShop.GetCurrentCost.md deleted file mode 100644 index b4bb0ca1..00000000 --- a/wiki-information/functions/C_BarberShop.GetCurrentCost.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.GetCurrentCost - -**Content:** -Returns the cost of the currently selected customizations. -`cost = C_BarberShop.GetCurrentCost()` - -**Returns:** -- `cost` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.GetViewingChrModel.md b/wiki-information/functions/C_BarberShop.GetViewingChrModel.md deleted file mode 100644 index fd6a45da..00000000 --- a/wiki-information/functions/C_BarberShop.GetViewingChrModel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.GetViewingChrModel - -**Content:** -Needs summary. -`chrModelID = C_BarberShop.GetViewingChrModel()` - -**Returns:** -- `chrModelID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.HasAnyChanges.md b/wiki-information/functions/C_BarberShop.HasAnyChanges.md deleted file mode 100644 index 23aac205..00000000 --- a/wiki-information/functions/C_BarberShop.HasAnyChanges.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.HasAnyChanges - -**Content:** -Needs summary. -`hasChanges = C_BarberShop.HasAnyChanges()` - -**Returns:** -- `hasChanges` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md b/wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md deleted file mode 100644 index dc66ca52..00000000 --- a/wiki-information/functions/C_BarberShop.IsViewingAlteredForm.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.IsViewingAlteredForm - -**Content:** -Returns true if the player is currently customizing an alternate form. -`isViewingAlteredForm = C_BarberShop.IsViewingAlteredForm()` - -**Returns:** -- `isViewingAlteredForm` - - *boolean* - true if the player is currently customizing an alternate form. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.IsViewingNativeSex.md b/wiki-information/functions/C_BarberShop.IsViewingNativeSex.md deleted file mode 100644 index e3990edd..00000000 --- a/wiki-information/functions/C_BarberShop.IsViewingNativeSex.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.IsViewingNativeSex - -**Content:** -Returns whether the currently visible body type at the barber shop is different than what the character had before visiting. -`isNativeSex = IsViewingNativeSex()` - -**Returns:** -- `isNativeSex` - - *boolean* - true if the character hasn't changed body type in the barber shop UI, otherwise false \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md b/wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md deleted file mode 100644 index 69c45315..00000000 --- a/wiki-information/functions/C_BarberShop.IsViewingVisibleSex.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_BarberShop.IsViewingVisibleSex - -**Content:** -Returns whether the currently visible body type at the barber shop is the same as `sexId`. -`isVisibleSex = IsViewingVisibleSex(sex)` - -**Parameters:** -- `sex` - - *number* - Ranging from 0 for body type 1 (masculine/male) to 1 for body type 2 (feminine/female). - -**Returns:** -- `isVisibleSex` - - *boolean* - true if the visible body type at barber shop UI matches `sex`, otherwise false. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md b/wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md deleted file mode 100644 index 83ae9d51..00000000 --- a/wiki-information/functions/C_BarberShop.PreviewCustomizationChoice.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_BarberShop.PreviewCustomizationChoice - -**Content:** -Previews a customization choice on the character without selecting it. -`C_BarberShop.PreviewCustomizationChoice(optionID, choiceID)` - -**Parameters:** -- `optionID` - - *number* -- `choiceID` - - *number* - -**Example Usage:** -This function can be used in an addon that allows players to preview different hairstyles, facial features, or other customization options in the Barber Shop without committing to the changes. For instance, an addon could provide a UI that lets players cycle through all available options and see how they look before making a final decision. - -**Addons Using This Function:** -Large addons like "BetterBarberShop" use this function to enhance the default Barber Shop interface by providing more intuitive controls for previewing and selecting character customizations. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md b/wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md deleted file mode 100644 index 01405e31..00000000 --- a/wiki-information/functions/C_BarberShop.RandomizeCustomizationChoices.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_BarberShop.RandomizeCustomizationChoices - -**Content:** -Needs summary. -`C_BarberShop.RandomizeCustomizationChoices()` - -**Example Usage:** -This function can be used to randomize the appearance of a character in the Barber Shop, providing a quick way to see different customization options without manually selecting each one. - -**Addons:** -Large addons like "ElvUI" or "Total RP 3" might use this function to provide users with a quick way to randomize their character's appearance for role-playing purposes or to quickly preview different looks. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ResetCameraRotation.md b/wiki-information/functions/C_BarberShop.ResetCameraRotation.md deleted file mode 100644 index 157a85e2..00000000 --- a/wiki-information/functions/C_BarberShop.ResetCameraRotation.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_BarberShop.ResetCameraRotation - -**Content:** -Resets the camera rotation. -`C_BarberShop.ResetCameraRotation()` - -**Example Usage:** -This function can be used in an addon that customizes the user interface for the Barber Shop in World of Warcraft. For instance, if an addon allows players to preview different hairstyles and appearances, it might use this function to reset the camera to its default rotation after the player has finished previewing. - -**Addons Using This Function:** -Large addons like "ElvUI" or "Bartender4" might use this function to ensure that the camera view is reset to a default state when exiting the Barber Shop interface, providing a consistent user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md b/wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md deleted file mode 100644 index ca585007..00000000 --- a/wiki-information/functions/C_BarberShop.ResetCustomizationChoices.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_BarberShop.ResetCustomizationChoices - -**Content:** -Resets all selected customization choices. -`C_BarberShop.ResetCustomizationChoices()` - -**Example Usage:** -This function can be used in an addon that provides a custom interface for the Barber Shop, allowing users to reset their changes and start over without having to exit and re-enter the Barber Shop. - -**Addons:** -Large addons like "ElvUI" or "WeakAuras" might use this function to provide enhanced user interfaces or customizations related to character appearance. For example, an addon could provide a button to reset all changes made in the Barber Shop, improving the user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.RotateCamera.md b/wiki-information/functions/C_BarberShop.RotateCamera.md deleted file mode 100644 index 82193a3e..00000000 --- a/wiki-information/functions/C_BarberShop.RotateCamera.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.RotateCamera - -**Content:** -Rotates the camera by the specified number of degrees. -`C_BarberShop.RotateCamera(diffDegrees)` - -**Parameters:** -- `diffDegrees` - - *number* - The number of degrees to rotate the camera. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md b/wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md deleted file mode 100644 index db65d447..00000000 --- a/wiki-information/functions/C_BarberShop.SetCameraDistanceOffset.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.SetCameraDistanceOffset - -**Content:** -Sets the distance offset of the camera. -`C_BarberShop.SetCameraDistanceOffset(offset)` - -**Parameters:** -- `offset` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md b/wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md deleted file mode 100644 index a0c4be1d..00000000 --- a/wiki-information/functions/C_BarberShop.SetCameraZoomLevel.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_BarberShop.SetCameraZoomLevel - -**Content:** -Sets the zoom level of the camera. -`C_BarberShop.SetCameraZoomLevel(zoomLevel)` - -**Parameters:** -- `zoomLevel` - - *number* -- `keepCustomZoom` - - *boolean?* - -**Example Usage:** -This function can be used in an addon to adjust the camera zoom level when a player is in the Barber Shop, providing a better view of their character's customization options. - -**Addon Usage:** -Large addons like "ElvUI" or "Bartender4" might use this function to enhance the user interface experience by adjusting the camera zoom level dynamically based on user settings or specific events. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetCustomizationChoice.md b/wiki-information/functions/C_BarberShop.SetCustomizationChoice.md deleted file mode 100644 index 4afba84b..00000000 --- a/wiki-information/functions/C_BarberShop.SetCustomizationChoice.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_BarberShop.SetCustomizationChoice - -**Content:** -Selects a customization choice. -`C_BarberShop.SetCustomizationChoice(optionID, choiceID)` - -**Parameters:** -- `optionID` - - *number* -- `choiceID` - - *number* - -**Example Usage:** -This function can be used to programmatically select a customization option in the Barber Shop interface. For instance, if you are developing an addon that allows players to randomize their character's appearance, you could use this function to apply a specific customization choice. - -**Addon Usage:** -Large addons like "BetterWardrobe" might use this function to allow users to save and apply different appearance presets, including hair styles and other customization options available in the Barber Shop. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetModelDressState.md b/wiki-information/functions/C_BarberShop.SetModelDressState.md deleted file mode 100644 index 84750502..00000000 --- a/wiki-information/functions/C_BarberShop.SetModelDressState.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.SetModelDressState - -**Content:** -Controls whether or not the character should be dressed. -`C_BarberShop.SetModelDressState(dressedState)` - -**Parameters:** -- `dressedState` - - *boolean* - Indicates whether the character should be dressed or not. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetSelectedSex.md b/wiki-information/functions/C_BarberShop.SetSelectedSex.md deleted file mode 100644 index 1bce0df5..00000000 --- a/wiki-information/functions/C_BarberShop.SetSelectedSex.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.SetSelectedSex - -**Content:** -Changes the selected gender of the character. -`C_BarberShop.SetSelectedSex(sex)` - -**Parameters:** -- `sex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md b/wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md deleted file mode 100644 index e69f5ee4..00000000 --- a/wiki-information/functions/C_BarberShop.SetViewingAlteredForm.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.SetViewingAlteredForm - -**Content:** -Controls whether the alternate form for a character is being customized. -`C_BarberShop.SetViewingAlteredForm(isViewingAlteredForm)` - -**Parameters:** -- `isViewingAlteredForm` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetViewingChrModel.md b/wiki-information/functions/C_BarberShop.SetViewingChrModel.md deleted file mode 100644 index 9a4c26b7..00000000 --- a/wiki-information/functions/C_BarberShop.SetViewingChrModel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.SetViewingChrModel - -**Content:** -Needs summary. -`C_BarberShop.SetViewingChrModel()` - -**Parameters:** -- `chrModelID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md b/wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md deleted file mode 100644 index 5fb905f7..00000000 --- a/wiki-information/functions/C_BarberShop.SetViewingShapeshiftForm.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.SetViewingShapeshiftForm - -**Content:** -Changes the shapeshift form being customized. Set to nil to revert to customizing the character's normal form. -`C_BarberShop.SetViewingShapeshiftForm()` - -**Parameters:** -- `shapeshiftFormID` - - *number?* - The ID of the shapeshift form to be customized. Can be set to `nil` to revert to the character's normal form. \ No newline at end of file diff --git a/wiki-information/functions/C_BarberShop.ZoomCamera.md b/wiki-information/functions/C_BarberShop.ZoomCamera.md deleted file mode 100644 index d6b83b4f..00000000 --- a/wiki-information/functions/C_BarberShop.ZoomCamera.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_BarberShop.ZoomCamera - -**Content:** -Zooms the camera by a specified amount. -`C_BarberShop.ZoomCamera(zoomAmount)` - -**Parameters:** -- `zoomAmount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md b/wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md deleted file mode 100644 index a0407b24..00000000 --- a/wiki-information/functions/C_BattleNet.GetAccountInfoByGUID.md +++ /dev/null @@ -1,142 +0,0 @@ -## Title: C_BattleNet.GetFriendAccountInfo - -**Content:** -Returns information about a Battle.net friend account. -```lua -accountInfo = C_BattleNet.GetFriendAccountInfo(friendIndex) -accountInfo = C_BattleNet.GetAccountInfoByID(id) -accountInfo = C_BattleNet.GetAccountInfoByGUID(guid) -``` - -**Parameters:** -- **GetFriendAccountInfo:** - - `friendIndex` - - *number* - Index ranging from 1 to BNGetNumFriends() - - `wowAccountGUID` - - *string?* - BNetAccountGUID - -- **GetAccountInfoByID:** - - `id` - - *number* - bnetAccountID - - `wowAccountGUID` - - *string?* - BNetAccountGUID - -- **GetAccountInfoByGUID:** - - `guid` - - *string* - UnitGUID - -**Returns:** -- `accountInfo` - - *BNetAccountInfo?* - - `Field` - - `Type` - - `Description` - - `bnetAccountID` - - *number* - A temporary ID for the friend's battle.net account during this session - - `accountName` - - *string* - A protected string representing the friend's full name or BattleTag name - - `battleTag` - - *string* - The friend's BattleTag (e.g., "Nickname#0001") - - `isFriend` - - *boolean* - - `isBattleTagFriend` - - *boolean* - Whether or not the friend is known by their BattleTag - - `lastOnlineTime` - - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. - - `isAFK` - - *boolean* - Whether or not the friend is flagged as Away - - `isDND` - - *boolean* - Whether or not the friend is flagged as Busy - - `isFavorite` - - *boolean* - Whether or not the friend is marked as a favorite by you - - `appearOffline` - - *boolean* - - `customMessage` - - *string* - The Battle.net broadcast message - - `customMessageTime` - - *number* - The number of seconds elapsed since the current broadcast message was sent - - `note` - - *string* - The contents of the player's note about this friend - - `rafLinkType` - - *Enum.RafLinkType* - - `gameAccountInfo` - - *BNetGameAccountInfo* - - `Field` - - `Type` - - `Description` - - `gameAccountID` - - *number?* - A temporary ID for the friend's battle.net game account during this session. - - `clientProgram` - - *string* - BNET_CLIENT - - `isOnline` - - *boolean* - - `isGameBusy` - - *boolean* - - `isGameAFK` - - *boolean* - - `wowProjectID` - - *number?* - - `characterName` - - *string?* - The name of the logged in toon/character - - `realmName` - - *string?* - The name of the logged in realm - - `realmDisplayName` - - *string?* - - `realmID` - - *number?* - The ID for the logged in realm - - `factionName` - - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") - - `raceName` - - *string?* - The localized race name (e.g., "Blood Elf") - - `className` - - *string?* - The localized class name (e.g., "Death Knight") - - `areaName` - - *string?* - The localized zone name (e.g., "The Undercity") - - `characterLevel` - - *number?* - The current level (e.g., "90") - - `richPresence` - - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - - `playerGuid` - - *string?* - A unique numeric identifier for the friend's character during this session. - - `isWowMobile` - - *boolean* - - `canSummon` - - *boolean* - - `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame - - `regionID` - - *number* - Added in 9.1.0 - - `isInCurrentRegion` - - *boolean* - Added in 9.1.0 - -**BNET_CLIENT:** -- **Global** - - `Value` - - `Description` - - `BNET_CLIENT_WOW` - - WoW - World of Warcraft - - `BNET_CLIENT_APP` - - App - Battle.net desktop app - - `BNET_CLIENT_HEROES` - - Hero - Heroes of the Storm - - `BNET_CLIENT_CLNT` - - CLNT - -**Description:** -Related API: `C_BattleNet.GetFriendGameAccountInfo` - -**Usage:** -Shows your own account info. -```lua -/dump C_BattleNet.GetAccountInfoByID(select(3, BNGetInfo())) -``` -Shows your Battle.net friends' account information. -```lua -for i = 1, BNGetNumFriends() do - local acc = C_BattleNet.GetFriendAccountInfo(i) - local game = acc.gameAccountInfo - print(acc.bnetAccountID, acc.accountName, game.gameAccountID, game.isOnline, game.clientProgram) -end --- 1, "|Kq2|k", 5, true, "BSAp" --- 2, "|Kq1|k", nil, false, "" -``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetAccountInfoByID.md b/wiki-information/functions/C_BattleNet.GetAccountInfoByID.md deleted file mode 100644 index 5b61dfb9..00000000 --- a/wiki-information/functions/C_BattleNet.GetAccountInfoByID.md +++ /dev/null @@ -1,129 +0,0 @@ -## Title: C_BattleNet.GetFriendAccountInfo - -**Content:** -Returns information about a Battle.net friend account. -```lua -accountInfo = C_BattleNet.GetFriendAccountInfo(friendIndex) -accountInfo = C_BattleNet.GetAccountInfoByID(id) -accountInfo = C_BattleNet.GetAccountInfoByGUID(guid) -``` - -**Parameters:** -- **GetFriendAccountInfo:** - - `friendIndex` - - *number* - Index ranging from 1 to BNGetNumFriends() - - `wowAccountGUID` - - *string?* - BNetAccountGUID - -- **GetAccountInfoByID:** - - `id` - - *number* - bnetAccountID - - `wowAccountGUID` - - *string?* - BNetAccountGUID - -- **GetAccountInfoByGUID:** - - `guid` - - *string* - UnitGUID - -**Returns:** -- `accountInfo` - - *BNetAccountInfo?* - - `Field` - - `Type` - - `Description` - - `bnetAccountID` - - *number* - A temporary ID for the friend's battle.net account during this session - - `accountName` - - *string* - A protected string representing the friend's full name or BattleTag name - - `battleTag` - - *string* - The friend's BattleTag (e.g., "Nickname#0001") - - `isFriend` - - *boolean* - - `isBattleTagFriend` - - *boolean* - Whether or not the friend is known by their BattleTag - - `lastOnlineTime` - - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. - - `isAFK` - - *boolean* - Whether or not the friend is flagged as Away - - `isDND` - - *boolean* - Whether or not the friend is flagged as Busy - - `isFavorite` - - *boolean* - Whether or not the friend is marked as a favorite by you - - `appearOffline` - - *boolean* - - `customMessage` - - *string* - The Battle.net broadcast message - - `customMessageTime` - - *number* - The number of seconds elapsed since the current broadcast message was sent - - `note` - - *string* - The contents of the player's note about this friend - - `rafLinkType` - - *Enum.RafLinkType* - - `gameAccountInfo` - - *BNetGameAccountInfo* - - `Field` - - `Type` - - `Description` - - `gameAccountID` - - *number?* - A temporary ID for the friend's battle.net game account during this session. - - `clientProgram` - - *string* - BNET_CLIENT - - `isOnline` - - *boolean* - - `isGameBusy` - - *boolean* - - `isGameAFK` - - *boolean* - - `wowProjectID` - - *number?* - - `characterName` - - *string?* - The name of the logged in toon/character - - `realmName` - - *string?* - The name of the logged in realm - - `realmDisplayName` - - *string?* - - `realmID` - - *number?* - The ID for the logged in realm - - `factionName` - - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") - - `raceName` - - *string?* - The localized race name (e.g., "Blood Elf") - - `className` - - *string?* - The localized class name (e.g., "Death Knight") - - `areaName` - - *string?* - The localized zone name (e.g., "The Undercity") - - `characterLevel` - - *number?* - The current level (e.g., "90") - - `richPresence` - - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - - `playerGuid` - - *string?* - A unique numeric identifier for the friend's character during this session. - - `isWowMobile` - - *boolean* - - `canSummon` - - *boolean* - - `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame - - `regionID` - - *number* - Added in 9.1.0 - - `isInCurrentRegion` - - *boolean* - Added in 9.1.0 - -**Description:** -Related API: `C_BattleNet.GetFriendGameAccountInfo` - -**Usage:** -Shows your own account info. -```lua -/dump C_BattleNet.GetAccountInfoByID(select(3, BNGetInfo())) -``` -Shows your Battle.net friends' account information. -```lua -for i = 1, BNGetNumFriends() do - local acc = C_BattleNet.GetFriendAccountInfo(i) - local game = acc.gameAccountInfo - print(acc.bnetAccountID, acc.accountName, game.gameAccountID, game.isOnline, game.clientProgram) -end --- 1, "|Kq2|k", 5, true, "BSAp" --- 2, "|Kq1|k", nil, false, "" -``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md b/wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md deleted file mode 100644 index 129e35f2..00000000 --- a/wiki-information/functions/C_BattleNet.GetFriendAccountInfo.md +++ /dev/null @@ -1,130 +0,0 @@ -## Title: C_BattleNet.GetFriendAccountInfo - -**Content:** -Returns information about a Battle.net friend account. -```lua -accountInfo = C_BattleNet.GetFriendAccountInfo(friendIndex) -accountInfo = C_BattleNet.GetAccountInfoByID(id) -accountInfo = C_BattleNet.GetAccountInfoByGUID(guid) -``` - -**Parameters:** - -*GetFriendAccountInfo:* -- `friendIndex` - - *number* - Index ranging from 1 to BNGetNumFriends() -- `wowAccountGUID` - - *string?* - BNetAccountGUID - -*GetAccountInfoByID:* -- `id` - - *number* - bnetAccountID -- `wowAccountGUID` - - *string?* - BNetAccountGUID - -*GetAccountInfoByGUID:* -- `guid` - - *string* - UnitGUID - -**Returns:** -- `accountInfo` - - *BNetAccountInfo?* - - `Field` - - `Type` - - `Description` - - `bnetAccountID` - - *number* - A temporary ID for the friend's battle.net account during this session - - `accountName` - - *string* - A protected string representing the friend's full name or BattleTag name - - `battleTag` - - *string* - The friend's BattleTag (e.g., "Nickname#0001") - - `isFriend` - - *boolean* - - `isBattleTagFriend` - - *boolean* - Whether or not the friend is known by their BattleTag - - `lastOnlineTime` - - *number* - The number of seconds elapsed since this friend was last online (from the epoch date of January 1, 1970). Returns nil if currently online. - - `isAFK` - - *boolean* - Whether or not the friend is flagged as Away - - `isDND` - - *boolean* - Whether or not the friend is flagged as Busy - - `isFavorite` - - *boolean* - Whether or not the friend is marked as a favorite by you - - `appearOffline` - - *boolean* - - `customMessage` - - *string* - The Battle.net broadcast message - - `customMessageTime` - - *number* - The number of seconds elapsed since the current broadcast message was sent - - `note` - - *string* - The contents of the player's note about this friend - - `rafLinkType` - - *Enum.RafLinkType* - - `gameAccountInfo` - - *BNetGameAccountInfo* - - `Field` - - `Type` - - `Description` - - `gameAccountID` - - *number?* - A temporary ID for the friend's battle.net game account during this session. - - `clientProgram` - - *string* - BNET_CLIENT - - `isOnline` - - *boolean* - - `isGameBusy` - - *boolean* - - `isGameAFK` - - *boolean* - - `wowProjectID` - - *number?* - - `characterName` - - *string?* - The name of the logged in toon/character - - `realmName` - - *string?* - The name of the logged in realm - - `realmDisplayName` - - *string?* - - `realmID` - - *number?* - - `factionName` - - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") - - `raceName` - - *string?* - The localized race name (e.g., "Blood Elf") - - `className` - - *string?* - The localized class name (e.g., "Death Knight") - - `areaName` - - *string?* - The localized zone name (e.g., "The Undercity") - - `characterLevel` - - *number?* - The current level (e.g., "90") - - `richPresence` - - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - - `playerGuid` - - *string?* - A unique numeric identifier for the friend's character during this session. - - `isWowMobile` - - *boolean* - - `canSummon` - - *boolean* - - `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame - - `regionID` - - *number* - Added in 9.1.0 - - `isInCurrentRegion` - - *boolean* - Added in 9.1.0 - -**Description:** -Related API: `C_BattleNet.GetFriendGameAccountInfo` - -**Usage:** -Shows your own account info. -```lua -/dump C_BattleNet.GetAccountInfoByID(select(3, BNGetInfo())) -``` -Shows your Battle.net friends' account information. -```lua -for i = 1, BNGetNumFriends() do - local acc = C_BattleNet.GetFriendAccountInfo(i) - local game = acc.gameAccountInfo - print(acc.bnetAccountID, acc.accountName, game.gameAccountID, game.isOnline, game.clientProgram) -end --- 1, "|Kq2|k", 5, true, "BSAp" --- 2, "|Kq1|k", nil, false, "" -``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md b/wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md deleted file mode 100644 index 03a7aa8d..00000000 --- a/wiki-information/functions/C_BattleNet.GetFriendGameAccountInfo.md +++ /dev/null @@ -1,111 +0,0 @@ -## Title: C_BattleNet.GetFriendGameAccountInfo - -**Content:** -Returns information on the game the Battle.net friend is playing. -```lua -gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) -``` - -**Parameters:** -- **GetFriendGameAccountInfo:** - - `friendIndex` - - *number* - Index ranging from 1 to BNGetNumFriends() - - `accountIndex` - - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() - -- **GetGameAccountInfoByID:** - - `id` - - *number* - `gameAccountInfo.gameAccountID` - -- **GetGameAccountInfoByGUID:** - - `guid` - - *string* - `UnitGUID` - -**Returns:** -- `gameAccountInfo` - - *BNetGameAccountInfo?* - - `Field` - - `Type` - - `Description` - - `gameAccountID` - - *number?* - A temporary ID for the friend's battle.net game account during this session. - - `clientProgram` - - *string* - BNET_CLIENT - - `isOnline` - - *boolean* - - `isGameBusy` - - *boolean* - - `isGameAFK` - - *boolean* - - `wowProjectID` - - *number?* - - `characterName` - - *string?* - The name of the logged in toon/character - - `realmName` - - *string?* - The name of the logged in realm - - `realmDisplayName` - - *string?* - - `realmID` - - *number?* - The ID for the logged in realm - - `factionName` - - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") - - `raceName` - - *string?* - The localized race name (e.g., "Blood Elf") - - `className` - - *string?* - The localized class name (e.g., "Death Knight") - - `areaName` - - *string?* - The localized zone name (e.g., "The Undercity") - - `characterLevel` - - *number?* - The current level (e.g., "90") - - `richPresence` - - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - - `playerGuid` - - *string?* - A unique numeric identifier for the friend's character during this session. - - `isWowMobile` - - *boolean* - - `canSummon` - - *boolean* - - `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame - - `regionID` - - *number* - Added in 9.1.0 - - `isInCurrentRegion` - - *boolean* - Added in 9.1.0 - -**BNET_CLIENT:** -- **Global** - - `Value` - - `Description` - - `BNET_CLIENT_WOW` - - WoW - World of Warcraft - - `BNET_CLIENT_APP` - - App - Battle.net desktop app - - `BNET_CLIENT_HEROES` - - Hero - Heroes of the Storm - - `BNET_CLIENT_CLNT` - - CLNT - -**Description:** -Related API: `C_BattleNet.GetFriendAccountInfo` - -**Usage:** -Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. -```lua -for i = 1, BNGetNumFriends() do - for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do - local game = C_BattleNet.GetFriendGameAccountInfo(i, j) - print(game.gameAccountID, game.isOnline, game.clientProgram) - end -end --- 5, true, "BSAp" - -C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo -for i = 1, BNGetNumFriends() do - local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo - print(game.gameAccountID, game.isOnline, game.clientProgram) -end --- 5, true, "BSAp" --- nil, false, "" -``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md b/wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md deleted file mode 100644 index b7704e45..00000000 --- a/wiki-information/functions/C_BattleNet.GetFriendNumGameAccounts.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_BattleNet.GetFriendNumGameAccounts - -**Content:** -Returns the number of game accounts for the Battle.net friend. -`numGameAccounts = C_BattleNet.GetFriendNumGameAccounts(friendIndex)` - -**Parameters:** -- `friendIndex` - - *number* - The Battle.net friend's index on the friends list ranging from 1 to `BNGetNumFriends()` - -**Returns:** -- `numGameAccounts` - - *number* - The number of accounts or 0 if the friend is not online. - -**Description:** -This function returns the number of ACCOUNTS a player has that are identified with a given BattleTag ID rather than the number of characters on a given account. \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md b/wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md deleted file mode 100644 index 449269d5..00000000 --- a/wiki-information/functions/C_BattleNet.GetGameAccountInfoByGUID.md +++ /dev/null @@ -1,98 +0,0 @@ -## Title: C_BattleNet.GetFriendGameAccountInfo - -**Content:** -Returns information on the game the Battle.net friend is playing. -```lua -gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) -``` - -**Parameters:** -- **GetFriendGameAccountInfo:** - - `friendIndex` - - *number* - Index ranging from 1 to BNGetNumFriends() - - `accountIndex` - - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() - -- **GetGameAccountInfoByID:** - - `id` - - *number* - gameAccountInfo.gameAccountID - -- **GetGameAccountInfoByGUID:** - - `guid` - - *string* - UnitGUID - -**Returns:** -- `gameAccountInfo` - - *BNetGameAccountInfo?* - - `Field` - - `Type` - - `Description` - - `gameAccountID` - - *number?* - A temporary ID for the friend's battle.net game account during this session. - - `clientProgram` - - *string* - BNET_CLIENT - - `isOnline` - - *boolean* - - `isGameBusy` - - *boolean* - - `isGameAFK` - - *boolean* - - `wowProjectID` - - *number?* - - `characterName` - - *string?* - The name of the logged in toon/character - - `realmName` - - *string?* - The name of the logged in realm - - `realmDisplayName` - - *string?* - - `realmID` - - *number?* - The ID for the logged in realm - - `factionName` - - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") - - `raceName` - - *string?* - The localized race name (e.g., "Blood Elf") - - `className` - - *string?* - The localized class name (e.g., "Death Knight") - - `areaName` - - *string?* - The localized zone name (e.g., "The Undercity") - - `characterLevel` - - *number?* - The current level (e.g., "90") - - `richPresence` - - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - - `playerGuid` - - *string?* - A unique numeric identifier for the friend's character during this session. - - `isWowMobile` - - *boolean* - - `canSummon` - - *boolean* - - `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame - - `regionID` - - *number* - Added in 9.1.0 - - `isInCurrentRegion` - - *boolean* - Added in 9.1.0 - -**Description:** -Related API: `C_BattleNet.GetFriendAccountInfo` - -**Usage:** -Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. -```lua -for i = 1, BNGetNumFriends() do - for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do - local game = C_BattleNet.GetFriendGameAccountInfo(i, j) - print(game.gameAccountID, game.isOnline, game.clientProgram) - end -end --- 5, true, "BSAp" - -C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo -for i = 1, BNGetNumFriends() do - local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo - print(game.gameAccountID, game.isOnline, game.clientProgram) -end --- 5, true, "BSAp" --- nil, false, "" -``` \ No newline at end of file diff --git a/wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md b/wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md deleted file mode 100644 index 98852aad..00000000 --- a/wiki-information/functions/C_BattleNet.GetGameAccountInfoByID.md +++ /dev/null @@ -1,109 +0,0 @@ -## Title: C_BattleNet.GetFriendGameAccountInfo - -**Content:** -Returns information on the game the Battle.net friend is playing. -```lua -gameAccountInfo = C_BattleNet.GetFriendGameAccountInfo(friendIndex, accountIndex) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByID(id) -gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(guid) -``` - -**Parameters:** - -*GetFriendGameAccountInfo:* -- `friendIndex` - - *number* - Index ranging from 1 to BNGetNumFriends() -- `accountIndex` - - *number* - Index ranging from 1 to C_BattleNet.GetFriendNumGameAccounts() - -*GetGameAccountInfoByID:* -- `id` - - *number* : gameAccountInfo.gameAccountID - -*GetGameAccountInfoByGUID:* -- `guid` - - *string* : UnitGUID - -**Returns:** -- `gameAccountInfo` - - *BNetGameAccountInfo?* - - `gameAccountID` - - *number?* - A temporary ID for the friend's battle.net game account during this session. - - `clientProgram` - - *string* - BNET_CLIENT - - `isOnline` - - *boolean* - - `isGameBusy` - - *boolean* - - `isGameAFK` - - *boolean* - - `wowProjectID` - - *number?* - - `characterName` - - *string?* - The name of the logged in toon/character - - `realmName` - - *string?* - The name of the logged in realm - - `realmDisplayName` - - *string?* - - `realmID` - - *number?* - The ID for the logged in realm - - `factionName` - - *string?* - The englishFaction name (i.e., "Alliance" or "Horde") - - `raceName` - - *string?* - The localized race name (e.g., "Blood Elf") - - `className` - - *string?* - The localized class name (e.g., "Death Knight") - - `areaName` - - *string?* - The localized zone name (e.g., "The Undercity") - - `characterLevel` - - *number?* - The current level (e.g., "90") - - `richPresence` - - *string?* - For WoW, returns "zoneName - realmName". For StarCraft 2 and Diablo 3, returns the location or activity the player is currently engaged in. - - `playerGuid` - - *string?* - A unique numeric identifier for the friend's character during this session. - - `isWowMobile` - - *boolean* - - `canSummon` - - *boolean* - - `hasFocus` - - *boolean* - Whether or not this toon is the one currently being displayed in Blizzard's FriendFrame - - `regionID` - - *number* - Added in 9.1.0 - - `isInCurrentRegion` - - *boolean* - Added in 9.1.0 - -**BNET_CLIENT:** -- `Global` - - `Value` - - `Description` - - `BNET_CLIENT_WOW` - - WoW - World of Warcraft - - `BNET_CLIENT_APP` - - App - Battle.net desktop app - - `BNET_CLIENT_HEROES` - - Hero - Heroes of the Storm - - `BNET_CLIENT_CLNT` - - CLNT - -**Description:** -Related API: `C_BattleNet.GetFriendAccountInfo` - -**Usage:** -Shows your Battle.net friends' game information. Tested with one friend online in the mobile app, and one friend offline. -```lua -for i = 1, BNGetNumFriends() do - for j = 1, C_BattleNet.GetFriendNumGameAccounts(i) do - local game = C_BattleNet.GetFriendGameAccountInfo(i, j) - print(game.gameAccountID, game.isOnline, game.clientProgram) - end -end --- 5, true, "BSAp" - -C_BattleNet.GetFriendAccountInfo() returns the same information in gameAccountInfo -for i = 1, BNGetNumFriends() do - local game = C_BattleNet.GetFriendAccountInfo(i).gameAccountInfo - print(game.gameAccountID, game.isOnline, game.clientProgram) -end --- 5, true, "BSAp" --- nil, false, "" -``` \ No newline at end of file diff --git a/wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md b/wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md deleted file mode 100644 index 4387f40a..00000000 --- a/wiki-information/functions/C_BehavioralMessaging.SendNotificationReceipt.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_BehavioralMessaging.SendNotificationReceipt - -**Content:** -Needs summary. -`C_BehavioralMessaging.SendNotificationReceipt(dbId, openTimeSeconds, readTimeSeconds)` - -**Parameters:** -- `dbId` - - *string* -- `openTimeSeconds` - - *number* -- `readTimeSeconds` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVar.md b/wiki-information/functions/C_CVar.GetCVar.md deleted file mode 100644 index 711b0bdd..00000000 --- a/wiki-information/functions/C_CVar.GetCVar.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_CVar.GetCVar - -**Content:** -Returns the current value of a console variable. -`value = C_CVar.GetCVar(name)` -`= GetCVar` - -**Parameters:** -- `name` - - *string* : CVar - name of the CVar to query the value of. - -**Returns:** -- `value` - - *string?* - current value of the CVar. - -**Description:** -Calling this function with an invalid variable name, or a variable that cannot be queried by AddOns (like "accountName"), will return nil. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarBitfield.md b/wiki-information/functions/C_CVar.GetCVarBitfield.md deleted file mode 100644 index 7532a258..00000000 --- a/wiki-information/functions/C_CVar.GetCVarBitfield.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_CVar.GetCVarBitfield - -**Content:** -Returns the bitfield of a console variable. -`value = C_CVar.GetCVarBitfield(name, index)` -`= GetCVarBitfield` - -**Parameters:** -- `name` - - *string* : CVar - name of the CVar. -- `index` - - *number* - Bitfield index. - -**Returns:** -- `value` - - *boolean?* - Value of the bitfield. - -**Reference:** -closedInfoFrames \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarBool.md b/wiki-information/functions/C_CVar.GetCVarBool.md deleted file mode 100644 index 2083a9db..00000000 --- a/wiki-information/functions/C_CVar.GetCVarBool.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_CVar.GetCVarBool - -**Content:** -Returns the boolean value of a console variable. -`value = C_CVar.GetCVarBool(name)` -`GetCVarBool` - -**Parameters:** -- `name` - - *string* - Name of the CVar to query the value of. - -**Returns:** -- `value` - - *boolean?* - Compared to GetCVar, "1" would return as true, "0" would return as false. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarDefault.md b/wiki-information/functions/C_CVar.GetCVarDefault.md deleted file mode 100644 index 5ad40b33..00000000 --- a/wiki-information/functions/C_CVar.GetCVarDefault.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_CVar.GetCVarDefault - -**Content:** -Returns the default value of a console variable. -`defaultValue = C_CVar.GetCVarDefault(name)` -`= GetCVarDefault` - -**Parameters:** -- `name` - - *string* - Name of the console variable to query. - -**Returns:** -- `defaultValue` - - *string?* - Default value of the console variable. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.GetCVarInfo.md b/wiki-information/functions/C_CVar.GetCVarInfo.md deleted file mode 100644 index 7f542488..00000000 --- a/wiki-information/functions/C_CVar.GetCVarInfo.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_CVar.GetCVarInfo - -**Content:** -Returns information on a console variable. -`value, defaultValue, isStoredServerAccount, isStoredServerCharacter, isLockedFromUser, isSecure, isReadOnly = C_CVar.GetCVarInfo(name)` - -**Parameters:** -- `name` - - *string* - Name of the CVar to query the value of. Only accepts console variables (i.e. not console commands). - -**Returns:** -- `value` - - *string* - Current value of the CVar. -- `defaultValue` - - *string* - Default value of the CVar. -- `isStoredServerAccount` - - *boolean* - If the CVar scope is set WoW account-wide. Stored on the server per CVar synchronizeConfig. -- `isStoredServerCharacter` - - *boolean* - If the CVar scope is character-specific. Stored on the server per CVar synchronizeConfig. -- `isLockedFromUser` - - *boolean* -- `isSecure` - - *boolean* - If the CVar cannot be set with SetCVar while in combat, which would fire ADDON_ACTION_BLOCKED. It's also not possible to set these via /console. Most nameplate CVars are secure. -- `isReadOnly` - - *boolean* - Returns true for portal, serverAlert, timingTestError. These CVars cannot be changed. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.RegisterCVar.md b/wiki-information/functions/C_CVar.RegisterCVar.md deleted file mode 100644 index ae8973c6..00000000 --- a/wiki-information/functions/C_CVar.RegisterCVar.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_CVar.RegisterCVar - -**Content:** -Temporarily registers a custom console variable. -`C_CVar.RegisterCVar(name)` - -**Parameters:** -- `name` - - *string* - Name of the custom CVar to set. -- `value` - - *string|number?* = "0" - Initial value of the CVar. - -**Description:** -You can register your own CVars. They are set game-wide and will persist after relogging/reloading but not after closing the game. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.ResetTestCVars.md b/wiki-information/functions/C_CVar.ResetTestCVars.md deleted file mode 100644 index b39f2e7a..00000000 --- a/wiki-information/functions/C_CVar.ResetTestCVars.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_CVar.ResetTestCVars - -**Content:** -Resets the ActionCam cvars. -`C_CVar.ResetTestCVars()` - -**Function:** -`ResetTestCVars` - -**Description:** -This function is used to reset the ActionCam-related console variables (CVars) to their default values. The ActionCam is a feature that allows for more dynamic camera movements and angles in the game. - -**Example Usage:** -```lua --- Reset the ActionCam CVars to their default values -C_CVar.ResetTestCVars() -``` - -**Additional Information:** -This function can be particularly useful for developers and players who are experimenting with the ActionCam settings and want to quickly revert to the default configuration. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.SetCVar.md b/wiki-information/functions/C_CVar.SetCVar.md deleted file mode 100644 index 6f6945ff..00000000 --- a/wiki-information/functions/C_CVar.SetCVar.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_CVar.SetCVar - -**Content:** -Sets a console variable. -`success = C_CVar.SetCVar(name)` - -**Parameters:** -- `name` - - *string* : CVar - Name of the CVar. -- `value` - - *string|number?* = "0" - The new value of the CVar. - -**Returns:** -- `success` - - *boolean* - Whether the CVar was successfully set. Returns nil if attempting to set a secure cvar in combat. - -**Description:** -Some settings require a reload/relog before they take effect. -CVars are not saved to Config.wtf until properly logging out or reloading the game. -Secure CVars cannot be set in combat and only with SetCVar instead of /console. -Character and Account specific variables are stored server-side depending on CVar synchronizeConfig. \ No newline at end of file diff --git a/wiki-information/functions/C_CVar.SetCVarBitfield.md b/wiki-information/functions/C_CVar.SetCVarBitfield.md deleted file mode 100644 index 4ce75f04..00000000 --- a/wiki-information/functions/C_CVar.SetCVarBitfield.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_CVar.SetCVarBitfield - -**Content:** -Sets the bitfield of a console variable. -`success = C_CVar.SetCVarBitfield(name, index, value)` -`= SetCVarBitfield` - -**Parameters:** -- `name` - - *string* - Name of the CVar to set the bitfield of. -- `index` - - *number* - Bitfield index. -- `value` - - *boolean* - The new value of the bitfield. - -**Returns:** -- `success` - - *boolean* - Whether the CVar was successfully set. - -**Reference:** -closedInfoFrames \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.AddEvent.md b/wiki-information/functions/C_Calendar.AddEvent.md deleted file mode 100644 index 7a161d68..00000000 --- a/wiki-information/functions/C_Calendar.AddEvent.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Calendar.AddEvent - -**Content:** -Saves the new event currently being created to the server. -`C_Calendar.AddEvent()` - -**Description:** -Finalizes the event candidate created by `C_Calendar.CreatePlayerEvent`, `C_Calendar.CreateGuildSignUpEvent`, and similar. -Requires at least `C_Calendar.EventSetTitle`, `C_Calendar.EventSetDate`, and `C_Calendar.EventSetTime` to be set. -This function is only used to create new events. To save changes to existing events, use `C_Calendar.UpdateEvent`. - -**Usage:** -Creates an event for tomorrow. -```lua -C_Calendar.CreatePlayerEvent() -local d = C_DateAndTime.GetCurrentCalendarTime() -C_Calendar.EventSetDate(d.month, d.monthDay+1, d.year) -C_Calendar.EventSetTime(d.hour, d.minute) -C_Calendar.EventSetTitle("hello") -C_Calendar.AddEvent() -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.AreNamesReady.md b/wiki-information/functions/C_Calendar.AreNamesReady.md deleted file mode 100644 index 54c27afe..00000000 --- a/wiki-information/functions/C_Calendar.AreNamesReady.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.AreNamesReady - -**Content:** -Needs summary. -`ready = C_Calendar.AreNamesReady()` - -**Returns:** -- `ready` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CanAddEvent.md b/wiki-information/functions/C_Calendar.CanAddEvent.md deleted file mode 100644 index b76d49ed..00000000 --- a/wiki-information/functions/C_Calendar.CanAddEvent.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.CanAddEvent - -**Content:** -Returns whether the player can add an event. -`canAddEvent = C_Calendar.CanAddEvent()` - -**Returns:** -- `canAddEvent` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CanSendInvite.md b/wiki-information/functions/C_Calendar.CanSendInvite.md deleted file mode 100644 index cdf629a7..00000000 --- a/wiki-information/functions/C_Calendar.CanSendInvite.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.CanSendInvite - -**Content:** -Returns whether the player can send invites. -`canSendInvite = C_Calendar.CanSendInvite()` - -**Returns:** -- `canSendInvite` - - *boolean* - Indicates if the player can send invites. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CloseEvent.md b/wiki-information/functions/C_Calendar.CloseEvent.md deleted file mode 100644 index 60feace3..00000000 --- a/wiki-information/functions/C_Calendar.CloseEvent.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.CloseEvent - -**Content:** -Closes the selected event without saving it. -`C_Calendar.CloseEvent()` - -**Example Usage:** -This function can be used in an addon that manages calendar events, allowing the user to close an event they were editing without saving any changes. - -**Addons:** -Large addons like "Calendar" or "Group Calendar" might use this function to provide users with the ability to discard changes to events they are editing. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md b/wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md deleted file mode 100644 index bc5b3eed..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventCanComplain.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Calendar.ContextMenuEventCanComplain - -**Content:** -Returns whether the player can report the event as spam. -`canComplain = C_Calendar.ContextMenuEventCanComplain(offsetMonths, monthDay, eventIndex)` - -**Parameters:** -- `offsetMonths` - - *number* -- `monthDay` - - *number* -- `eventIndex` - - *number* - -**Returns:** -- `canComplain` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md b/wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md deleted file mode 100644 index eeac76cb..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventCanEdit.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Calendar.ContextMenuEventCanEdit - -**Content:** -Returns whether the player can edit the event. -`canEdit = C_Calendar.ContextMenuEventCanEdit(offsetMonths, monthDay, eventIndex)` - -**Parameters:** -- `offsetMonths` - - *number* -- `monthDay` - - *number* -- `eventIndex` - - *number* - -**Returns:** -- `canEdit` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md b/wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md deleted file mode 100644 index 723f64e4..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventCanRemove.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Calendar.ContextMenuEventCanRemove - -**Content:** -Returns whether the player can remove the event. -`canRemove = C_Calendar.ContextMenuEventCanRemove(offsetMonths, monthDay, eventIndex)` - -**Parameters:** -- `offsetMonths` - - *number* -- `monthDay` - - *number* -- `eventIndex` - - *number* - -**Returns:** -- `canRemove` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md b/wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md deleted file mode 100644 index d3f00aa9..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventClipboard.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.ContextMenuEventClipboard - -**Content:** -Needs summary. -`exists = C_Calendar.ContextMenuEventClipboard()` - -**Returns:** -- `exists` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventComplain.md b/wiki-information/functions/C_Calendar.ContextMenuEventComplain.md deleted file mode 100644 index b51a751d..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventComplain.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.ContextMenuEventComplain - -**Content:** -Reports the event as spam. -`C_Calendar.ContextMenuEventComplain()` - -**Example Usage:** -This function can be used in addons that manage or interact with the in-game calendar to report events that are considered spam. For instance, an addon that helps players manage their calendar events might include a feature to quickly report spam events using this function. - -**Addons:** -While there are no specific large addons known to use this function, any addon that deals with calendar events, such as group event planners or guild event managers, could potentially use this function to help maintain a clean and relevant event list. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventCopy.md b/wiki-information/functions/C_Calendar.ContextMenuEventCopy.md deleted file mode 100644 index dea4b6a0..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventCopy.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.ContextMenuEventCopy - -**Content:** -Copies the event to the clipboard. -`C_Calendar.ContextMenuEventCopy()` - -**Example Usage:** -This function can be used in an addon to allow users to easily copy calendar events for sharing or duplication purposes. - -**Addons:** -Large addons like "Calendar" or "EventManager" might use this function to enhance user interaction with in-game events, allowing for easier management and sharing of events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md b/wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md deleted file mode 100644 index 7fd2969d..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventGetCalendarType.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.ContextMenuEventGetCalendarType - -**Content:** -Needs summary. -`calendarType = C_Calendar.ContextMenuEventGetCalendarType()` - -**Returns:** -- `calendarType` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventPaste.md b/wiki-information/functions/C_Calendar.ContextMenuEventPaste.md deleted file mode 100644 index 1e18b12a..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventPaste.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.ContextMenuEventPaste - -**Content:** -Pastes the clipboard event to the date. -`C_Calendar.ContextMenuEventPaste(offsetMonths, monthDay)` - -**Parameters:** -- `offsetMonths` - - *number* -- `monthDay` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventRemove.md b/wiki-information/functions/C_Calendar.ContextMenuEventRemove.md deleted file mode 100644 index 5305b98f..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventRemove.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.ContextMenuEventRemove - -**Content:** -Deletes the event. -`C_Calendar.ContextMenuEventRemove()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md b/wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md deleted file mode 100644 index 6aebe728..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuEventSignUp.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Calendar.ContextMenuEventSignUp - -**Content:** -Needs summary. -`C_Calendar.ContextMenuEventSignUp()` - -**Description:** -This function is used to sign up for an event in the in-game calendar context menu. It is typically used in the context of calendar events where players can sign up to participate in scheduled activities such as raids, dungeons, or other group events. - -**Example Usage:** -An example of how this function might be used is in an addon that manages raid sign-ups. When a player right-clicks on a calendar event and selects the option to sign up, this function would be called to register their participation. - -**Addons:** -Large addons like "Group Calendar" or "Calendar Addon" might use this function to handle event sign-ups directly from the calendar interface, streamlining the process for players to join scheduled events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md b/wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md deleted file mode 100644 index 8a4c67f9..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuGetEventIndex.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Calendar.ContextMenuGetEventIndex - -**Content:** -Needs summary. -`info = C_Calendar.ContextMenuGetEventIndex()` - -**Returns:** -- `info` - - *structure* - `CalendarEventIndexInfo` - - `CalendarEventIndexInfo` - - `Field` - - `Type` - - `Description` - - `offsetMonths` - - *number* - - `monthDay` - - *number* - - `eventIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md b/wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md deleted file mode 100644 index 563e5b17..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuInviteAvailable.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: C_Calendar.ContextMenuInviteAvailable - -**Content:** -Accepts the invitation to the event. -`C_Calendar.ContextMenuInviteAvailable()` - -**Example Usage:** -This function can be used in an addon to automatically accept calendar event invitations. For instance, a guild management addon might use this to ensure that all guild members accept important event invitations without manual intervention. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md b/wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md deleted file mode 100644 index af8f11f7..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuInviteDecline.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.ContextMenuInviteDecline - -**Content:** -Declines the invitation to the event. -`C_Calendar.ContextMenuInviteDecline()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md b/wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md deleted file mode 100644 index 1f2f7825..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuInviteRemove.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.ContextMenuInviteRemove - -**Content:** -Removes the event from the calendar. -`C_Calendar.ContextMenuInviteRemove()` - -**Example Usage:** -This function can be used in an addon to programmatically remove an event from the in-game calendar. For instance, if you are developing a calendar management addon, you might use this function to allow users to remove events directly from a context menu. - -**Addons Using This Function:** -Large addons like "Group Calendar" might use this function to manage calendar events, allowing users to remove events they no longer wish to attend or that have been canceled. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md b/wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md deleted file mode 100644 index b93c04a1..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuInviteTentative.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.ContextMenuInviteTentative - -**Content:** -Needs summary. -`C_Calendar.ContextMenuInviteTentative()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md b/wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md deleted file mode 100644 index 37b48d15..00000000 --- a/wiki-information/functions/C_Calendar.ContextMenuSelectEvent.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Calendar.ContextMenuSelectEvent - -**Content:** -Needs summary. -`C_Calendar.ContextMenuSelectEvent(offsetMonths, monthDay, eventIndex)` - -**Parameters:** -- `offsetMonths` - - *number* -- `monthDay` - - *number* -- `eventIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md b/wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md deleted file mode 100644 index ce9719d2..00000000 --- a/wiki-information/functions/C_Calendar.CreateCommunitySignUpEvent.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.CreateCommunitySignUpEvent - -**Content:** -Needs summary. -`C_Calendar.CreateCommunitySignUpEvent()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md b/wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md deleted file mode 100644 index c9669811..00000000 --- a/wiki-information/functions/C_Calendar.CreateGuildAnnouncementEvent.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Calendar.CreateGuildAnnouncementEvent - -**Content:** -Needs summary. -`C_Calendar.CreateGuildAnnouncementEvent()` - -**Description:** -This function is used to create a guild announcement event in the in-game calendar. Guild announcement events are typically used to inform guild members about important dates, such as raid schedules, meetings, or other significant events. - -**Example Usage:** -```lua --- Create a guild announcement event -C_Calendar.CreateGuildAnnouncementEvent() -``` - -**Additional Information:** -This function is part of the Calendar API, which allows for the creation and management of in-game events. It is commonly used by guild management addons to automate the scheduling of events and ensure that all guild members are informed about upcoming activities. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md b/wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md deleted file mode 100644 index d678a8d8..00000000 --- a/wiki-information/functions/C_Calendar.CreateGuildSignUpEvent.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.CreateGuildSignUpEvent - -**Content:** -Needs summary. -`C_Calendar.CreateGuildSignUpEvent()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.CreatePlayerEvent.md b/wiki-information/functions/C_Calendar.CreatePlayerEvent.md deleted file mode 100644 index 598ba033..00000000 --- a/wiki-information/functions/C_Calendar.CreatePlayerEvent.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: C_Calendar.CreatePlayerEvent - -**Content:** -Creates a new calendar event candidate for the player. -`C_Calendar.CreatePlayerEvent()` - -**Description:** -The calendar event is finalized with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventAvailable.md b/wiki-information/functions/C_Calendar.EventAvailable.md deleted file mode 100644 index 48317421..00000000 --- a/wiki-information/functions/C_Calendar.EventAvailable.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.EventAvailable - -**Content:** -Accepts the invitation to the currently open event. -`C_Calendar.EventAvailable()` - -**Example Usage:** -This function can be used in an addon to automatically accept calendar event invitations, such as guild events or raid schedules. - -**Addons:** -Large addons like "Deadly Boss Mods" (DBM) or "ElvUI" might use this function to manage event invitations and ensure that users are automatically signed up for important events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventCanEdit.md b/wiki-information/functions/C_Calendar.EventCanEdit.md deleted file mode 100644 index afbc1843..00000000 --- a/wiki-information/functions/C_Calendar.EventCanEdit.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventCanEdit - -**Content:** -Returns whether the event can be edited. -`canEdit = C_Calendar.EventCanEdit()` - -**Returns:** -- `canEdit` - - *boolean* - Indicates if the event can be edited. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventClearAutoApprove.md b/wiki-information/functions/C_Calendar.EventClearAutoApprove.md deleted file mode 100644 index 84ac408a..00000000 --- a/wiki-information/functions/C_Calendar.EventClearAutoApprove.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.EventClearAutoApprove - -**Content:** -Turns off automatic confirmations. -`C_Calendar.EventClearAutoApprove()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventClearLocked.md b/wiki-information/functions/C_Calendar.EventClearLocked.md deleted file mode 100644 index ad1900b0..00000000 --- a/wiki-information/functions/C_Calendar.EventClearLocked.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.EventClearLocked - -**Content:** -Unlocks the event. -`C_Calendar.EventClearLocked()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventClearModerator.md b/wiki-information/functions/C_Calendar.EventClearModerator.md deleted file mode 100644 index 6366c247..00000000 --- a/wiki-information/functions/C_Calendar.EventClearModerator.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventClearModerator - -**Content:** -Needs summary. -`C_Calendar.EventClearModerator(inviteIndex)` - -**Parameters:** -- `inviteIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventDecline.md b/wiki-information/functions/C_Calendar.EventDecline.md deleted file mode 100644 index e7cc202e..00000000 --- a/wiki-information/functions/C_Calendar.EventDecline.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.EventDecline - -**Content:** -Declines the invitation to the currently open event. -`C_Calendar.EventDecline()` - -**Example Usage:** -This function can be used in an addon to automatically decline calendar event invitations. For instance, if you are developing an addon that manages event participation, you could use this function to decline events that do not meet certain criteria. - -**Addons Using This Function:** -Large addons like "Calendar" or "Group Calendar" might use this function to manage event invitations, allowing users to automatically decline events based on their preferences or schedules. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetCalendarType.md b/wiki-information/functions/C_Calendar.EventGetCalendarType.md deleted file mode 100644 index 2f05b3bd..00000000 --- a/wiki-information/functions/C_Calendar.EventGetCalendarType.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventGetCalendarType - -**Content:** -Needs summary. -`calendarType = C_Calendar.EventGetCalendarType()` - -**Returns:** -- `calendarType` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetClubId.md b/wiki-information/functions/C_Calendar.EventGetClubId.md deleted file mode 100644 index 020c646a..00000000 --- a/wiki-information/functions/C_Calendar.EventGetClubId.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventGetClubId - -**Content:** -Needs summary. -`info = C_Calendar.EventGetClubId()` - -**Returns:** -- `info` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetInvite.md b/wiki-information/functions/C_Calendar.EventGetInvite.md deleted file mode 100644 index 90ac2b4f..00000000 --- a/wiki-information/functions/C_Calendar.EventGetInvite.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: C_Calendar.EventGetInvite - -**Content:** -Returns status information for an invitee for the currently opened event. -`info = C_Calendar.EventGetInvite(eventIndex)` - -**Parameters:** -- `eventIndex` - - *number* - Ranging from 1 to `C_Calendar.GetNumInvites()` - -**Returns:** -- `info` - - *CalendarEventInviteInfo* - - `Field` - - `Type` - - `Description` - - `name` - - *string?* - - `level` - - *number* - - `className` - - *string?* - - `classFilename` - - *string?* - - `inviteStatus` - - *Enum.CalendarStatus?* - - `modStatus` - - *string?* - "MODERATOR", "CREATOR" - - `inviteIsMine` - - *boolean* - True if the selected entry is the player - - `type` - - *Enum.CalendarInviteType* - - `notes` - - *string* - - `classID` - - *number?* - - `guid` - - *string* - -**Enum.CalendarStatus:** -- `Value` -- `Field` -- `Description` - - `0` - - Invited - - `1` - - Available - - `2` - - Declined - - `3` - - Confirmed - - `4` - - Out - - `5` - - Standby - - `6` - - Signedup - - `7` - - NotSignedup - - `8` - - Tentative - -**Enum.CalendarInviteType:** -- `Value` -- `Field` -- `Description` - - `0` - - Normal - - `1` - - Signup \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md b/wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md deleted file mode 100644 index 92cecbd4..00000000 --- a/wiki-information/functions/C_Calendar.EventGetInviteResponseTime.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_Calendar.EventGetInviteResponseTime - -**Content:** -Needs summary. -`time = C_Calendar.EventGetInviteResponseTime(eventIndex)` - -**Parameters:** -- `eventIndex` - - *number* - -**Returns:** -- `time` - - *Structure* - CalendarTime - - `CalendarTime` - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md b/wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md deleted file mode 100644 index 591a61d0..00000000 --- a/wiki-information/functions/C_Calendar.EventGetInviteSortCriterion.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.EventGetInviteSortCriterion - -**Content:** -Needs summary. -`criterion, reverse = C_Calendar.EventGetInviteSortCriterion()` - -**Returns:** -- `criterion` - - *string* -- `reverse` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetSelectedInvite.md b/wiki-information/functions/C_Calendar.EventGetSelectedInvite.md deleted file mode 100644 index 7be95ad3..00000000 --- a/wiki-information/functions/C_Calendar.EventGetSelectedInvite.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Calendar.EventGetSelectedInvite - -**Content:** -Needs summary. -`inviteIndex = C_Calendar.EventGetSelectedInvite()` - -**Returns:** -- `inviteIndex` - - *number?* - -**Description:** -This function is used to get the index of the selected invite in the calendar event. The exact use case and return type are not well-documented, but it is typically used in the context of managing calendar events and invites. - -**Example Usage:** -```lua -local inviteIndex = C_Calendar.EventGetSelectedInvite() -if inviteIndex then - print("Selected invite index: " .. inviteIndex) -else - print("No invite selected.") -end -``` - -**Addons:** -Large addons that manage calendar events, such as "Group Calendar" or "Guild Event Manager," might use this function to handle invites to events. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetStatusOptions.md b/wiki-information/functions/C_Calendar.EventGetStatusOptions.md deleted file mode 100644 index d8a04804..00000000 --- a/wiki-information/functions/C_Calendar.EventGetStatusOptions.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: C_Calendar.EventGetStatusOptions - -**Content:** -Needs summary. -`options = C_Calendar.EventGetStatusOptions(eventIndex)` - -**Parameters:** -- `eventIndex` - - *number* - -**Returns:** -- `options` - - *CalendarEventStatusOption* - - `Field` - - `Type` - - `Description` - - `status` - - *Enum.CalendarStatus* - - `statusString` - - *string* - - `Enum.CalendarStatus` - - *Value* - - `Field` - - `Description` - - `0` - - Invited - - `1` - - Available - - `2` - - Declined - - `3` - - Confirmed - - `4` - - Out - - `5` - - Standby - - `6` - - Signedup - - `7` - - NotSignedup - - `8` - - Tentative \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetTextures.md b/wiki-information/functions/C_Calendar.EventGetTextures.md deleted file mode 100644 index 0a5802ea..00000000 --- a/wiki-information/functions/C_Calendar.EventGetTextures.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: C_Calendar.EventGetTextures - -**Content:** -Needs summary. -`textures = C_Calendar.EventGetTextures(eventType)` - -**Parameters:** -- `eventType` - - *enum* - CalendarEventType - - `Enum.CalendarEventType` - - **Value** - - **Field** - - **Description** - - `0` - - Raid - - `1` - - Dungeon - - `2` - - PvP - - `3` - - Meeting - - `4` - - Other - - `5` - - HeroicDeprecated - -**Returns:** -- `textures` - - *structure* - CalendarEventTextureInfo - - `Field` - - `Type` - - `Description` - - `title` - - *string* - - `iconTexture` - - *number* - - `expansionLevel` - - *number* - - `difficultyId` - - *number?* - - `mapId` - - *number?* - - `isLfr` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetTypes.md b/wiki-information/functions/C_Calendar.EventGetTypes.md deleted file mode 100644 index 882f2e53..00000000 --- a/wiki-information/functions/C_Calendar.EventGetTypes.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventGetTypes - -**Content:** -Needs summary. -`types = C_Calendar.EventGetTypes()` - -**Returns:** -- `types` - - *string* - See also `Enum.CalendarEventType` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md b/wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md deleted file mode 100644 index e06d291e..00000000 --- a/wiki-information/functions/C_Calendar.EventGetTypesDisplayOrdered.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Calendar.EventGetTypesDisplayOrdered - -**Content:** -Needs summary. -`infos = C_Calendar.EventGetTypesDisplayOrdered()` - -**Returns:** -- `infos` - - *structure* - CalendarEventTypeDisplayInfo - - `Field` - - `Type` - - `Description` - - `displayString` - - *string* - - `eventType` - - *enum CalendarEventType* - - `Enum.CalendarEventType` - - `Value` - - `Field` - - `Description` - - `0` - - Raid - - `1` - - Dungeon - - `2` - - PvP - - `3` - - Meeting - - `4` - - Other - - `5` - - HeroicDeprecated \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventHasPendingInvite.md b/wiki-information/functions/C_Calendar.EventHasPendingInvite.md deleted file mode 100644 index de38acae..00000000 --- a/wiki-information/functions/C_Calendar.EventHasPendingInvite.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventHasPendingInvite - -**Content:** -Returns whether the player has an unanswered invitation to the currently selected event. -`hasPendingInvite = C_Calendar.EventHasPendingInvite()` - -**Returns:** -- `hasPendingInvite` - - *boolean* - Indicates if there is a pending invite for the current event. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md b/wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md deleted file mode 100644 index aab88781..00000000 --- a/wiki-information/functions/C_Calendar.EventHaveSettingsChanged.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventHaveSettingsChanged - -**Content:** -Returns whether the currently opened event has been modified. -`haveSettingsChanged = C_Calendar.EventHaveSettingsChanged()` - -**Returns:** -- `haveSettingsChanged` - - *boolean* - Indicates if the event settings have been changed. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventInvite.md b/wiki-information/functions/C_Calendar.EventInvite.md deleted file mode 100644 index b5147691..00000000 --- a/wiki-information/functions/C_Calendar.EventInvite.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Calendar.EventInvite - -**Content:** -Invites a player to the currently selected event. -`C_Calendar.EventInvite(name)` - -**Parameters:** -- `name` - - *string* - -**Description:** -You can't do invites while another calendar action is pending. -Register to the event "CALENDAR_ACTION_PENDING" and using that, check with `C_Calendar.CanSendInvite` if you can invite. -Inviting a player who is already on the invitation list will result in a " has already been invited." dialog box appearing. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventRemoveInvite.md b/wiki-information/functions/C_Calendar.EventRemoveInvite.md deleted file mode 100644 index 78ee4cac..00000000 --- a/wiki-information/functions/C_Calendar.EventRemoveInvite.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Calendar.EventRemoveInvite - -**Content:** -Needs summary. -`C_Calendar.EventRemoveInvite(inviteIndex)` -`C_Calendar.EventRemoveInviteByGuid(guid)` - -**Parameters:** - -**EventRemoveInvite:** -- `inviteIndex` - - *number* - -**EventRemoveInviteByGuid:** -- `guid` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md b/wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md deleted file mode 100644 index ae26755a..00000000 --- a/wiki-information/functions/C_Calendar.EventRemoveInviteByGuid.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Calendar.EventRemoveInvite - -**Content:** -Needs summary. -`C_Calendar.EventRemoveInvite(inviteIndex)` -`C_Calendar.EventRemoveInviteByGuid(guid)` - -**Parameters:** -- **EventRemoveInvite:** - - `inviteIndex` - - *number* - -- **EventRemoveInviteByGuid:** - - `guid` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSelectInvite.md b/wiki-information/functions/C_Calendar.EventSelectInvite.md deleted file mode 100644 index 2bdc2ed9..00000000 --- a/wiki-information/functions/C_Calendar.EventSelectInvite.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventSelectInvite - -**Content:** -Needs summary. -`C_Calendar.EventSelectInvite(inviteIndex)` - -**Parameters:** -- `inviteIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetAutoApprove.md b/wiki-information/functions/C_Calendar.EventSetAutoApprove.md deleted file mode 100644 index c8468d16..00000000 --- a/wiki-information/functions/C_Calendar.EventSetAutoApprove.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.EventSetAutoApprove - -**Content:** -Needs summary. -`C_Calendar.EventSetAutoApprove()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetClubId.md b/wiki-information/functions/C_Calendar.EventSetClubId.md deleted file mode 100644 index 5f6740de..00000000 --- a/wiki-information/functions/C_Calendar.EventSetClubId.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventSetClubId - -**Content:** -Needs summary. -`C_Calendar.EventSetClubId()` - -**Parameters:** -- `clubId` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetDate.md b/wiki-information/functions/C_Calendar.EventSetDate.md deleted file mode 100644 index 098e6ba8..00000000 --- a/wiki-information/functions/C_Calendar.EventSetDate.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Calendar.EventSetDate - -**Content:** -Sets the date for the currently opened event. -`C_Calendar.EventSetDate(month, monthDay, year)` - -**Parameters:** -- `month` - - *number* - 2 digits. -- `monthDay` - - *number* - 2 digits. -- `year` - - *number* - 4 digits (e.g., 2019). - -**Description:** -The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent` and similar. -The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetDescription.md b/wiki-information/functions/C_Calendar.EventSetDescription.md deleted file mode 100644 index f0da4409..00000000 --- a/wiki-information/functions/C_Calendar.EventSetDescription.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventSetDescription - -**Content:** -Needs summary. -`C_Calendar.EventSetDescription(description)` - -**Parameters:** -- `description` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetInviteStatus.md b/wiki-information/functions/C_Calendar.EventSetInviteStatus.md deleted file mode 100644 index 42658bf7..00000000 --- a/wiki-information/functions/C_Calendar.EventSetInviteStatus.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Calendar.EventSetInviteStatus - -**Content:** -Sets the invitation status of a player to the current event. -`C_Calendar.EventSetInviteStatus(eventIndex, status)` - -**Parameters:** -- `eventIndex` - - *number* -- `status` - - *Enum.CalendarStatus* - - `Value` - - `Field` - - `Description` - - `0` - - Invited - - `1` - - Available - - `2` - - Declined - - `3` - - Confirmed - - `4` - - Out - - `5` - - Standby - - `6` - - Signedup - - `7` - - NotSignedup - - `8` - - Tentative \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetLocked.md b/wiki-information/functions/C_Calendar.EventSetLocked.md deleted file mode 100644 index da8d5891..00000000 --- a/wiki-information/functions/C_Calendar.EventSetLocked.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Calendar.EventSetLocked - -**Content:** -Needs summary. -`C_Calendar.EventSetLocked()` - -**Description:** -This function is used to lock a calendar event, preventing further modifications. This can be useful in scenarios where an event organizer wants to finalize the details of an event and ensure no further changes are made. - -**Example Usage:** -An example use case for this function could be in a guild event management addon where the event organizer locks the event details once all participants have confirmed their attendance. - -**Addons:** -Large addons like "Guild Event Manager" might use this function to lock events after they have been created and confirmed by the participants. This ensures that the event details remain consistent and are not accidentally altered. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetModerator.md b/wiki-information/functions/C_Calendar.EventSetModerator.md deleted file mode 100644 index 7049672a..00000000 --- a/wiki-information/functions/C_Calendar.EventSetModerator.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventSetModerator - -**Content:** -Needs summary. -`C_Calendar.EventSetModerator(inviteIndex)` - -**Parameters:** -- `inviteIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetTextureID.md b/wiki-information/functions/C_Calendar.EventSetTextureID.md deleted file mode 100644 index 4042e3a9..00000000 --- a/wiki-information/functions/C_Calendar.EventSetTextureID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.EventSetTextureID - -**Content:** -Needs summary. -`C_Calendar.EventSetTextureID(textureIndex)` - -**Parameters:** -- `textureIndex` - - *number* - NOT a FileDataID, but an index relating to the returned table of `API_C_Calendar.EventGetTextures`. You cannot set a custom texture, or even one outside the chosen event type. Therefore, this function currently only has an effect when using the types Raid and Dungeon. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetTime.md b/wiki-information/functions/C_Calendar.EventSetTime.md deleted file mode 100644 index 90c7f8ed..00000000 --- a/wiki-information/functions/C_Calendar.EventSetTime.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Calendar.EventSetTime - -**Content:** -Sets the time for the currently opened event. -`C_Calendar.EventSetTime(hour, minute)` - -**Parameters:** -- `hour` - - *number* -- `minute` - - *number* - -**Description:** -The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent` and similar. -The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetTitle.md b/wiki-information/functions/C_Calendar.EventSetTitle.md deleted file mode 100644 index 3595f846..00000000 --- a/wiki-information/functions/C_Calendar.EventSetTitle.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Calendar.EventSetTitle - -**Content:** -Sets the title for the currently opened event. -`C_Calendar.EventSetTitle(title)` - -**Parameters:** -- `title` - - *string* - -**Description:** -The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent` and similar. -The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSetType.md b/wiki-information/functions/C_Calendar.EventSetType.md deleted file mode 100644 index 65d393e8..00000000 --- a/wiki-information/functions/C_Calendar.EventSetType.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Calendar.EventSetType - -**Content:** -Sets the event type for the current calendar event. -`C_Calendar.EventSetType(typeIndex)` - -**Parameters:** -- `typeIndex` - - *enum* - CalendarEventType - - `Enum.CalendarEventType` - - `Value` - - `Field` - - `Description` - - `0` - - Raid - - `1` - - Dungeon - - `2` - - PvP - - `3` - - Meeting - - `4` - - Other - - `5` - - HeroicDeprecated - -**Description:** -The calendar event must be previously opened with `C_Calendar.OpenEvent` or an event candidate from `C_Calendar.CreatePlayerEvent`. -The calendar event is updated with `C_Calendar.UpdateEvent` or created with `C_Calendar.AddEvent`. -If the event type is not set before creating with `C_Calendar.AddEvent`, it defaults to 1. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSignUp.md b/wiki-information/functions/C_Calendar.EventSignUp.md deleted file mode 100644 index 07a00062..00000000 --- a/wiki-information/functions/C_Calendar.EventSignUp.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Calendar.EventSignUp - -**Content:** -Needs summary. -`C_Calendar.EventSignUp()` - -**Description:** -This function is used to sign up for an event in the in-game calendar. It is typically used in scenarios where players need to register their participation for scheduled events such as raids, dungeons, or community gatherings. - -**Example Usage:** -```lua --- Example of signing up for an event -C_Calendar.EventSignUp() -``` - -**Addons:** -Large addons like "Deadly Boss Mods" (DBM) and "ElvUI" may use this function to automate event sign-ups or to provide enhanced calendar functionalities for guilds and communities. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventSortInvites.md b/wiki-information/functions/C_Calendar.EventSortInvites.md deleted file mode 100644 index 3b6411c1..00000000 --- a/wiki-information/functions/C_Calendar.EventSortInvites.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.EventSortInvites - -**Content:** -Needs summary. -`C_Calendar.EventSortInvites(criterion, reverse)` - -**Parameters:** -- `criterion` - - *string* -- `reverse` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.EventTentative.md b/wiki-information/functions/C_Calendar.EventTentative.md deleted file mode 100644 index 2c4f204b..00000000 --- a/wiki-information/functions/C_Calendar.EventTentative.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Calendar.EventTentative - -**Content:** -Needs summary. -`C_Calendar.EventTentative()` \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetClubCalendarEvents.md b/wiki-information/functions/C_Calendar.GetClubCalendarEvents.md deleted file mode 100644 index 20dd8135..00000000 --- a/wiki-information/functions/C_Calendar.GetClubCalendarEvents.md +++ /dev/null @@ -1,107 +0,0 @@ -## Title: C_Calendar.GetClubCalendarEvents - -**Content:** -Needs summary. -`events = C_Calendar.GetClubCalendarEvents(clubId, startTime, endTime)` - -**Parameters:** -- `clubId` - - *string* -- `startTime` - - *CalendarTime* -- `endTime` - - *CalendarTime* - -**CalendarTime Fields:** -- `year` - - *number* - The current year (e.g. 2019) -- `month` - - *number* - The current month -- `monthDay` - - *number* - The current day of the month -- `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) -- `hour` - - *number* - The current time in hours -- `minute` - - *number* - The current time in minutes - -**Returns:** -- `events` - - *CalendarDayEvent* - -**CalendarDayEvent Fields:** -- `eventID` - - *string* - Added in 8.1.0 -- `title` - - *string* -- `isCustomTitle` - - *boolean* - Added in 8.0.1 -- `startTime` - - *CalendarTime* -- `endTime` - - *CalendarTime* -- `calendarType` - - *string* - const CALENDARTYPE -- `sequenceType` - - *string* - "START", "END", "", "ONGOING" -- `eventType` - - *Enum.CalendarEventType* -- `iconTexture` - - *number?* - Added in 7.2.5 -- `modStatus` - - *string* - "MODERATOR", "CREATOR" -- `inviteStatus` - - *Enum.CalendarStatus* -- `invitedBy` - - *string* -- `difficulty` - - *number* -- `inviteType` - - *Enum.CalendarInviteType* -- `sequenceIndex` - - *number* -- `numSequenceDays` - - *number* -- `difficultyName` - - *string* -- `dontDisplayBanner` - - *boolean* -- `dontDisplayEnd` - - *boolean* -- `clubID` - - *string* - Added in 8.1.5 -- `isLocked` - - *boolean* - Added in 8.2.0 - -**CALENDARTYPE Values:** -- `"PLAYER"` - Player-created event or invitation -- `"GUILD_ANNOUNCEMENT"` - Guild announcement -- `"GUILD_EVENT"` - Guild event -- `"COMMUNITY_EVENT"` -- `"SYSTEM"` - Other server-provided event -- `"HOLIDAY"` - Seasonal/holiday events -- `"RAID_LOCKOUT"` - Instance lockouts - -**Enum.CalendarEventType Values:** -- `0` - Raid -- `1` - Dungeon -- `2` - PvP -- `3` - Meeting -- `4` - Other -- `5` - HeroicDeprecated - -**Enum.CalendarStatus Values:** -- `0` - Invited -- `1` - Available -- `2` - Declined -- `3` - Confirmed -- `4` - Out -- `5` - Standby -- `6` - Signedup -- `7` - NotSignedup -- `8` - Tentative - -**Enum.CalendarInviteType Values:** -- `0` - Normal -- `1` - Signup \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetDayEvent.md b/wiki-information/functions/C_Calendar.GetDayEvent.md deleted file mode 100644 index 21a19933..00000000 --- a/wiki-information/functions/C_Calendar.GetDayEvent.md +++ /dev/null @@ -1,145 +0,0 @@ -## Title: C_Calendar.GetDayEvent - -**Content:** -Retrieve information about the specified event. -`event = C_Calendar.GetDayEvent(monthOffset, monthDay, index)` - -**Parameters:** -- `monthOffset` - - *number* - the number of months to offset from today. -- `monthDay` - - *number* - the desired day of the month the event exists on. -- `index` - - *number* - the index of the desired event, from 1 through C_Calendar.GetNumDayEvents. - -**Returns:** -- `event` - - *CalendarDayEvent* - - `Field` - - `Type` - - `Description` - - `eventID` - - *string* - Added in 8.1.0 - - `title` - - *string* - - `isCustomTitle` - - *boolean* - Added in 8.0.1 - - `startTime` - - *CalendarTime* - - `endTime` - - *CalendarTime* - - `calendarType` - - *string* - const CALENDARTYPE - - `sequenceType` - - *string* - "START", "END", "", "ONGOING" - - `eventType` - - *Enum.CalendarEventType* - - `iconTexture` - - *number?* - Added in 7.2.5 - - `modStatus` - - *string* - "MODERATOR", "CREATOR" - - `inviteStatus` - - *Enum.CalendarStatus* - - `invitedBy` - - *string* - - `difficulty` - - *number* - - `inviteType` - - *Enum.CalendarInviteType* - - `sequenceIndex` - - *number* - - `numSequenceDays` - - *number* - - `difficultyName` - - *string* - - `dontDisplayBanner` - - *boolean* - - `dontDisplayEnd` - - *boolean* - - `clubID` - - *string* - Added in 8.1.5 - - `isLocked` - - *boolean* - Added in 8.2.0 - -**CalendarTime:** -- `Field` -- `Type` -- `Description` -- `year` - - *number* - The current year (e.g. 2019) -- `month` - - *number* - The current month -- `monthDay` - - *number* - The current day of the month -- `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) -- `hour` - - *number* - The current time in hours -- `minute` - - *number* - The current time in minutes - -**CALENDARTYPE:** -- `Value` -- `Description` -- `"PLAYER"` - - Player-created event or invitation -- `"GUILD_ANNOUNCEMENT"` - - Guild announcement -- `"GUILD_EVENT"` - - Guild event -- `"COMMUNITY_EVENT"` -- `"SYSTEM"` - - Other server-provided event -- `"HOLIDAY"` - - Seasonal/holiday events -- `"RAID_LOCKOUT"` - - Instance lockouts - -**Enum.CalendarEventType:** -- `Value` -- `Field` -- `Description` -- `0` - - Raid -- `1` - - Dungeon -- `2` - - PvP -- `3` - - Meeting -- `4` - - Other -- `5` - - HeroicDeprecated - -**Enum.CalendarStatus:** -- `Value` -- `Field` -- `Description` -- `0` - - Invited -- `1` - - Available -- `2` - - Declined -- `3` - - Confirmed -- `4` - - Out -- `5` - - Standby -- `6` - - Signedup -- `7` - - NotSignedup -- `8` - - Tentative - -**Enum.CalendarInviteType:** -- `Value` -- `Field` -- `Description` -- `0` - - Normal -- `1` - - Signup \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md b/wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md deleted file mode 100644 index 64b8b6d5..00000000 --- a/wiki-information/functions/C_Calendar.GetDefaultGuildFilter.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_Calendar.GetDefaultGuildFilter - -**Content:** -Needs summary. -`info = C_Calendar.GetDefaultGuildFilter()` - -**Returns:** -- `info` - - *structure* - CalendarGuildFilterInfo - - `Field` - - `Type` - - `Description` - - `minLevel` - - *number* - - `maxLevel` - - *number* - - `rank` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetEventIndex.md b/wiki-information/functions/C_Calendar.GetEventIndex.md deleted file mode 100644 index 62c96a19..00000000 --- a/wiki-information/functions/C_Calendar.GetEventIndex.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Calendar.GetEventIndex - -**Content:** -Needs summary. -`info = C_Calendar.GetEventIndex()` - -**Returns:** -- `info` - - *structure* - `CalendarEventIndexInfo` - - `CalendarEventIndexInfo` - - `Field` - - `Type` - - `Description` - - `offsetMonths` - - *number* - - `monthDay` - - *number* - - `eventIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetEventIndexInfo.md b/wiki-information/functions/C_Calendar.GetEventIndexInfo.md deleted file mode 100644 index 85f183cf..00000000 --- a/wiki-information/functions/C_Calendar.GetEventIndexInfo.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_Calendar.GetEventIndexInfo - -**Content:** -Needs summary. -`eventIndexInfo = C_Calendar.GetEventIndexInfo(eventID)` - -**Parameters:** -- `eventID` - - *string* -- `monthOffset` - - *number?* -- `monthDay` - - *number?* - -**Returns:** -- `eventIndexInfo` - - *structure* - CalendarEventIndexInfo (nilable) - - `CalendarEventIndexInfo` - - `Field` - - `Type` - - `Description` - - `offsetMonths` - - *number* - - `monthDay` - - *number* - - `eventIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetEventInfo.md b/wiki-information/functions/C_Calendar.GetEventInfo.md deleted file mode 100644 index 1b663d5b..00000000 --- a/wiki-information/functions/C_Calendar.GetEventInfo.md +++ /dev/null @@ -1,140 +0,0 @@ -## Title: C_Calendar.GetEventInfo - -**Content:** -Returns info for a calendar event. -`info = C_Calendar.GetEventInfo()` - -**Returns:** -- `info` - - *CalendarEventInfo* - - `Field` - - `Type` - - `Description` - - `title` - - *string* - - `description` - - *string* - - `creator` - - *string?* - The name of the character who created the event. - - `eventType` - - *Enum.CalendarEventType* - The type of event as specified by `C_Calendar.EventSetType`. - - `repeatOption` - - *Enum.CalendarEventRepeatOptions* - The repeat setting. - - `maxSize` - - *number* - Usually 100. - - `textureIndex` - - *number?* - The index of the event's texture in the list returned by `C_Calendar.EventGetTextures`. - - `time` - - *CalendarTime* - When the event occurs. - - `lockoutTime` - - *CalendarTime* - - `isLocked` - - *boolean* - Whether the event is locked. - - `isAutoApprove` - - *boolean* - Whether signups to the event should be automatically approved. - - `hasPendingInvite` - - *boolean* - Whether the player has been invited to this event and has not yet responded. - - `inviteStatus` - - *Enum.CalendarStatus?* - The character's current invite status for the event. - - `inviteType` - - *Enum.CalendarInviteType?* - - `calendarType` - - *string* - const `CALENDARTYPE` - - `communityName` - - *string?* - -**Enum.CalendarEventType** -- `Value` -- `Field` -- `Description` - - `0` - - Raid - - `1` - - Dungeon - - `2` - - PvP - - `3` - - Meeting - - `4` - - Other - - `5` - - HeroicDeprecated - -**Enum.CalendarEventRepeatOptions** -- `Value` -- `Field` -- `Description` - - `0` - - Never - - `1` - - Weekly - - `2` - - Biweekly - - `3` - - Monthly - -**CalendarTime** -- `Field` -- `Type` -- `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes - -**Enum.CalendarStatus** -- `Value` -- `Field` -- `Description` - - `0` - - Invited - - `1` - - Available - - `2` - - Declined - - `3` - - Confirmed - - `4` - - Out - - `5` - - Standby - - `6` - - Signedup - - `7` - - NotSignedup - - `8` - - Tentative - -**Enum.CalendarInviteType** -- `Value` -- `Field` -- `Description` - - `0` - - Normal - - `1` - - Signup - -**CALENDARTYPE** -- `Value` -- `Description` - - `"PLAYER"` - - Player-created event or invitation - - `"GUILD_ANNOUNCEMENT"` - - Guild announcement - - `"GUILD_EVENT"` - - Guild event - - `"COMMUNITY_EVENT"` - - `"SYSTEM"` - - Other server-provided event - - `"HOLIDAY"` - - Seasonal/holiday events - - `"RAID_LOCKOUT"` - - Instance lockouts \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetFirstPendingInvite.md b/wiki-information/functions/C_Calendar.GetFirstPendingInvite.md deleted file mode 100644 index 5e4434da..00000000 --- a/wiki-information/functions/C_Calendar.GetFirstPendingInvite.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Calendar.GetFirstPendingInvite - -**Content:** -Needs summary. -`firstPendingInvite = C_Calendar.GetFirstPendingInvite(offsetMonths, monthDay)` - -**Parameters:** -- `offsetMonths` - - *number* -- `monthDay` - - *number* - -**Returns:** -- `firstPendingInvite` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetGuildEventInfo.md b/wiki-information/functions/C_Calendar.GetGuildEventInfo.md deleted file mode 100644 index f7c4c7ce..00000000 --- a/wiki-information/functions/C_Calendar.GetGuildEventInfo.md +++ /dev/null @@ -1,59 +0,0 @@ -## Title: C_Calendar.GetGuildEventInfo - -**Content:** -Needs summary. -`info = C_Calendar.GetGuildEventInfo(index)` - -**Parameters:** -- `index` - - *number* - -**Returns:** -- `info` - - *CalendarGuildEventInfo* - - `Field` - - `Type` - - `Description` - - `eventID` - - *string* - - `year` - - *number* - - `month` - - *number* - - `monthDay` - - *number* - - `weekday` - - *number* - - `hour` - - *number* - - `minute` - - *number* - - `eventType` - - *Enum.CalendarEventType* - - `title` - - *string* - - `calendarType` - - *string* - - `texture` - - *number* - - `inviteStatus` - - *number* - - `clubID` - - *string* - -**Enum.CalendarEventType:** -- `Value` -- `Field` -- `Description` - - `0` - - Raid - - `1` - - Dungeon - - `2` - - PvP - - `3` - - Meeting - - `4` - - Other - - `5` - - HeroicDeprecated \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md b/wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md deleted file mode 100644 index f24e66e6..00000000 --- a/wiki-information/functions/C_Calendar.GetGuildEventSelectionInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Calendar.GetGuildEventSelectionInfo - -**Content:** -Needs summary. -`info = C_Calendar.GetGuildEventSelectionInfo(index)` - -**Parameters:** -- `index` - - *number* - -**Returns:** -- `info` - - *structure* - CalendarEventIndexInfo - - `CalendarEventIndexInfo` - - `Field` - - `Type` - - `Description` - - `offsetMonths` - - *number* - - `monthDay` - - *number* - - `eventIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetHolidayInfo.md b/wiki-information/functions/C_Calendar.GetHolidayInfo.md deleted file mode 100644 index 3f3cc5bd..00000000 --- a/wiki-information/functions/C_Calendar.GetHolidayInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: C_Calendar.GetHolidayInfo - -**Content:** -Returns seasonal holiday info. -`event = C_Calendar.GetHolidayInfo(monthOffset, monthDay, index)` - -**Parameters:** -- `monthOffset` - - *number* - The offset from the current month (only accepts 0 or 1). -- `monthDay` - - *number* - The day of the month. -- `index` - - *number* - -**Returns:** -- `event` - - *CalendarHolidayInfo* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `description` - - *string* - - `texture` - - *number* - - `startTime` - - *CalendarTime?* - - `endTime` - - *CalendarTime?* - - `CalendarTime` - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetMaxCreateDate.md b/wiki-information/functions/C_Calendar.GetMaxCreateDate.md deleted file mode 100644 index 76782ac5..00000000 --- a/wiki-information/functions/C_Calendar.GetMaxCreateDate.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Calendar.GetMaxCreateDate - -**Content:** -Returns the last day supported by the Calendar API. -`maxCreateDate = C_Calendar.GetMaxCreateDate()` - -**Returns:** -- `maxCreateDate` - - *structure* - CalendarTime - - `CalendarTime` - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes - -**Description:** -As of the 21st of March 2019, the date returned by this function on EU realms is Tuesday the 31st of March, 2020. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetMinDate.md b/wiki-information/functions/C_Calendar.GetMinDate.md deleted file mode 100644 index 86f67a8e..00000000 --- a/wiki-information/functions/C_Calendar.GetMinDate.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Calendar.GetMinDate - -**Content:** -Returns the first day supported by the Calendar API. -`minDate = C_Calendar.GetMinDate()` - -**Returns:** -- `minDate` - - *structure* - CalendarTime - - `CalendarTime` - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes - -**Description:** -As of Patch 8.1.5, the date returned by this function on EU realms is Wednesday the 24th of November, 2004. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetMonthInfo.md b/wiki-information/functions/C_Calendar.GetMonthInfo.md deleted file mode 100644 index b8907292..00000000 --- a/wiki-information/functions/C_Calendar.GetMonthInfo.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_Calendar.GetMonthInfo - -**Content:** -Returns information about the calendar month by offset. -`monthInfo = C_Calendar.GetMonthInfo()` - -**Parameters:** -- `offsetMonths` - - *number? = 0* - Offset in months from the currently selected Calendar month, positive numbers indicating future months. - -**Returns:** -- `monthInfo` - - *structure* - CalendarMonthInfo - - `Field` - - `Type` - - `Description` - - `month` - - *number* - Month index (1-12) - - `year` - - *number* - Year at the offset date (2004+) - - `numDays` - - *number* - Number of days in the month (28-31) - - `firstWeekday` - - *number* - Weekday on which the month begins (1 = Sunday, 2 = Monday, ..., 7 = Saturday) - -**Description:** -This function returns information based on the currently selected calendar month (per `C_Calendar.SetMonth`). Prior to opening the calendar for the first time in a given session, this is set to `C_Calendar.GetMinDate` (i.e. November 2004). \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNextClubId.md b/wiki-information/functions/C_Calendar.GetNextClubId.md deleted file mode 100644 index ff7128e6..00000000 --- a/wiki-information/functions/C_Calendar.GetNextClubId.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.GetNextClubId - -**Content:** -Needs summary. -`clubId = C_Calendar.GetNextClubId()` - -**Returns:** -- `clubId` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumDayEvents.md b/wiki-information/functions/C_Calendar.GetNumDayEvents.md deleted file mode 100644 index 109ce019..00000000 --- a/wiki-information/functions/C_Calendar.GetNumDayEvents.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Calendar.GetNumDayEvents - -**Content:** -Returns the number of events for a given day/month offset. -`numDayEvents = C_Calendar.GetNumDayEvents(offsetMonths, monthDay)` - -**Parameters:** -- `offsetMonths` - - *number* - The number of months to advance from today. -- `monthDay` - - *number* - The day of the given month. - -**Returns:** -- `numDayEvents` - - *number* - The number of events on the day in question. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumGuildEvents.md b/wiki-information/functions/C_Calendar.GetNumGuildEvents.md deleted file mode 100644 index 2b7f9936..00000000 --- a/wiki-information/functions/C_Calendar.GetNumGuildEvents.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.GetNumGuildEvents - -**Content:** -Needs summary. -`numGuildEvents = C_Calendar.GetNumGuildEvents()` - -**Returns:** -- `numGuildEvents` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumInvites.md b/wiki-information/functions/C_Calendar.GetNumInvites.md deleted file mode 100644 index 4d334aa3..00000000 --- a/wiki-information/functions/C_Calendar.GetNumInvites.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.GetNumInvites - -**Content:** -Returns the number of invitees for the currently opened event. -`num = C_Calendar.GetNumInvites()` - -**Returns:** -- `num` - - *number* - The number of invitees for the currently opened event. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetNumPendingInvites.md b/wiki-information/functions/C_Calendar.GetNumPendingInvites.md deleted file mode 100644 index 2661a85f..00000000 --- a/wiki-information/functions/C_Calendar.GetNumPendingInvites.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.GetNumPendingInvites - -**Content:** -Needs summary. -`num = C_Calendar.GetNumPendingInvites()` - -**Returns:** -- `num` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.GetRaidInfo.md b/wiki-information/functions/C_Calendar.GetRaidInfo.md deleted file mode 100644 index 7735b59a..00000000 --- a/wiki-information/functions/C_Calendar.GetRaidInfo.md +++ /dev/null @@ -1,49 +0,0 @@ -## Title: C_Calendar.GetRaidInfo - -**Content:** -Needs summary. -`info = C_Calendar.GetRaidInfo(offsetMonths, monthDay, eventIndex)` - -**Parameters:** -- `offsetMonths` - - *number* -- `monthDay` - - *number* -- `eventIndex` - - *number* - -**Returns:** -- `info` - - *structure* - CalendarRaidInfo - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `calendarType` - - *string* - - `raidID` - - *number* - - `time` - - *structure* - CalendarTime - - `difficulty` - - *number* - - `difficultyName` - - *string?* - -**CalendarTime:** -- `Field` -- `Type` -- `Description` -- `year` - - *number* - The current year (e.g. 2019) -- `month` - - *number* - The current month -- `monthDay` - - *number* - The current day of the month -- `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) -- `hour` - - *number* - The current time in hours -- `minute` - - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.IsActionPending.md b/wiki-information/functions/C_Calendar.IsActionPending.md deleted file mode 100644 index 98244832..00000000 --- a/wiki-information/functions/C_Calendar.IsActionPending.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.IsActionPending - -**Content:** -Needs summary. -`actionPending = C_Calendar.IsActionPending()` - -**Returns:** -- `actionPending` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.IsEventOpen.md b/wiki-information/functions/C_Calendar.IsEventOpen.md deleted file mode 100644 index 8d3aff9d..00000000 --- a/wiki-information/functions/C_Calendar.IsEventOpen.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.IsEventOpen - -**Content:** -Needs summary. -`isOpen = C_Calendar.IsEventOpen()` - -**Returns:** -- `isOpen` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.MassInviteCommunity.md b/wiki-information/functions/C_Calendar.MassInviteCommunity.md deleted file mode 100644 index c0ac3fda..00000000 --- a/wiki-information/functions/C_Calendar.MassInviteCommunity.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Calendar.MassInviteCommunity - -**Content:** -Needs summary. -`C_Calendar.MassInviteCommunity(clubId, minLevel, maxLevel)` - -**Parameters:** -- `clubId` - - *string* -- `minLevel` - - *number* -- `maxLevel` - - *number* -- `maxRankOrder` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.MassInviteGuild.md b/wiki-information/functions/C_Calendar.MassInviteGuild.md deleted file mode 100644 index 37efefb3..00000000 --- a/wiki-information/functions/C_Calendar.MassInviteGuild.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_Calendar.MassInviteGuild - -**Content:** -Needs summary. -`C_Calendar.MassInviteGuild(minLevel, maxLevel, maxRankOrder)` - -**Parameters:** -- `minLevel` - - *number* -- `maxLevel` - - *number* -- `maxRankOrder` - - *number* - -**Example Usage:** -This function can be used to mass invite guild members to a calendar event based on their level and rank. For instance, if you want to invite all guild members between levels 10 and 50 who are of rank 3 or lower, you would call: -```lua -C_Calendar.MassInviteGuild(10, 50, 3) -``` - -**Addons:** -Large addons like **Guild Event Manager** might use this function to automate the process of inviting guild members to events, ensuring that only members who meet certain criteria are invited. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.OpenCalendar.md b/wiki-information/functions/C_Calendar.OpenCalendar.md deleted file mode 100644 index 319422cc..00000000 --- a/wiki-information/functions/C_Calendar.OpenCalendar.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.OpenCalendar - -**Content:** -Requests calendar information from the server. Does not open the calendar frame. -`C_Calendar.OpenCalendar()` - -**Description:** -Fires `CALENDAR_UPDATE_EVENT_LIST` when your query has finished processing on the server and new calendar information is available. -If called during the loading process, (even at `PLAYER_ENTERING_WORLD`) the query will not return. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.OpenEvent.md b/wiki-information/functions/C_Calendar.OpenEvent.md deleted file mode 100644 index 5443e412..00000000 --- a/wiki-information/functions/C_Calendar.OpenEvent.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Calendar.OpenEvent - -**Content:** -Establishes an event for future calendar API calls -`success = C_Calendar.OpenEvent(offsetMonths, monthDay, index)` - -**Parameters:** -- `offsetMonths` - - *number* - The number of months to offset from today. -- `monthDay` - - *number* - The day of the month on which the desired event is scheduled (1 - 31). -- `index` - - *number* - Ranging from 1 through `C_Calendar.GetNumDayEvents(offsetMonths, monthDay)`. - -**Returns:** -- `success` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.RemoveEvent.md b/wiki-information/functions/C_Calendar.RemoveEvent.md deleted file mode 100644 index f41ac9e5..00000000 --- a/wiki-information/functions/C_Calendar.RemoveEvent.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.RemoveEvent - -**Content:** -Removes the selected event from the calendar (invitees only). -`C_Calendar.RemoveEvent()` - -**Example Usage:** -This function can be used in an addon to allow users to remove events they have been invited to from their in-game calendar. For instance, a guild management addon might use this function to help members manage their event schedules by removing events they no longer wish to attend. - -**Addons Using This Function:** -Large addons like "Guild Calendar" or "Group Calendar" might use this function to manage calendar events, allowing users to remove events they are no longer interested in attending. \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.SetAbsMonth.md b/wiki-information/functions/C_Calendar.SetAbsMonth.md deleted file mode 100644 index 773013ea..00000000 --- a/wiki-information/functions/C_Calendar.SetAbsMonth.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Calendar.SetAbsMonth - -**Content:** -Sets the reference month and year for functions which use a month offset. -`C_Calendar.SetAbsMonth(month, year)` - -**Parameters:** -- `month` - - *number* -- `year` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.SetMonth.md b/wiki-information/functions/C_Calendar.SetMonth.md deleted file mode 100644 index d407a158..00000000 --- a/wiki-information/functions/C_Calendar.SetMonth.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.SetMonth - -**Content:** -Needs summary. -`C_Calendar.SetMonth(offsetMonths)` - -**Parameters:** -- `offsetMonths` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.SetNextClubId.md b/wiki-information/functions/C_Calendar.SetNextClubId.md deleted file mode 100644 index 4d540ce6..00000000 --- a/wiki-information/functions/C_Calendar.SetNextClubId.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Calendar.SetNextClubId - -**Content:** -Needs summary. -`C_Calendar.SetNextClubId()` - -**Parameters:** -- `clubId` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Calendar.UpdateEvent.md b/wiki-information/functions/C_Calendar.UpdateEvent.md deleted file mode 100644 index 97fe05e3..00000000 --- a/wiki-information/functions/C_Calendar.UpdateEvent.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: C_Calendar.UpdateEvent - -**Content:** -Saves the selected event. -`C_Calendar.UpdateEvent()` - -**Description:** -The calendar event must be previously opened with `C_Calendar.OpenEvent`. \ No newline at end of file diff --git a/wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md b/wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md deleted file mode 100644 index 95b243ad..00000000 --- a/wiki-information/functions/C_CameraDefaults.GetCameraFOVDefaults.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_CameraDefaults.GetCameraFOVDefaults - -**Content:** -Needs summary. -`fieldOfViewDegreesDefault, fieldOfViewDegreesPlayerMin, fieldOfViewDegreesPlayerMax = C_CameraDefaults.GetCameraFOVDefaults()` - -**Returns:** -- `fieldOfViewDegreesDefault` - - *number* -- `fieldOfViewDegreesPlayerMin` - - *number* -- `fieldOfViewDegreesPlayerMax` - - *number* - -**Example Usage:** -This function can be used to retrieve the default field of view (FOV) settings for the camera in World of Warcraft. This can be particularly useful for addons that aim to modify or reset camera settings to their default values. - -**Addon Usage:** -Large addons that deal with camera settings or provide custom camera controls, such as DynamicCam, might use this function to ensure they are working within the default FOV parameters set by the game. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md b/wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md deleted file mode 100644 index f53fa926..00000000 --- a/wiki-information/functions/C_ChatBubbles.GetAllChatBubbles.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_ChatBubbles.GetAllChatBubbles - -**Content:** -Returns all active chat bubbles. -`chatBubbles = C_ChatBubbles.GetAllChatBubbles()` - -**Parameters:** -- `includeForbidden` - - *boolean?* = false - -**Returns:** -- `chatBubbles` - - *Widget_API* - -**Description:** -Previously it was required to iterate over the WorldFrame children to access the chat bubbles. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.CanReportPlayer.md b/wiki-information/functions/C_ChatInfo.CanReportPlayer.md deleted file mode 100644 index 1e10c630..00000000 --- a/wiki-information/functions/C_ChatInfo.CanReportPlayer.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ChatInfo.CanReportPlayer - -**Content:** -Returns if a player can be reported. -`canReport = C_ReportSystem.CanReportPlayer(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin*🔗 - -**Returns:** -- `canReport` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md b/wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md deleted file mode 100644 index d01a0b5e..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChannelInfoFromIdentifier.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: C_ChatInfo.GetChannelInfoFromIdentifier - -**Content:** -Needs summary. -`info = C_ChatInfo.GetChannelInfoFromIdentifier(channelIdentifier)` - -**Parameters:** -- `channelIdentifier` - - *string* - -**Returns:** -- `info` - - *ChatChannelInfo?* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `shortcut` - - *string* - - `localID` - - *number* - - `instanceID` - - *number* - - `zoneChannelID` - - *number* - - `channelType` - - *Enum.PermanentChatChannelType* - - `Enum.PermanentChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Zone - - `2` - - Communities - - `3` - - Custom \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md b/wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md deleted file mode 100644 index 18dc71fa..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChannelRosterInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_ChatInfo.GetChannelRosterInfo - -**Content:** -Needs summary. -`name, owner, moderator, guid = C_ChatInfo.GetChannelRosterInfo(channelIndex, rosterIndex)` - -**Parameters:** -- `channelIndex` - - *number* -- `rosterIndex` - - *number* - -**Returns:** -- `name` - - *string* -- `owner` - - *boolean* -- `moderator` - - *boolean* -- `guid` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelShortcut.md b/wiki-information/functions/C_ChatInfo.GetChannelShortcut.md deleted file mode 100644 index 6df6a411..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChannelShortcut.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_ChatInfo.GetChannelShortcut - -**Content:** -Needs summary. -`shortcut = C_ChatInfo.GetChannelShortcut(channelIndex)` -`shortcut = C_ChatInfo.GetChannelShortcutForChannelID(channelID)` - -**Parameters:** -- `GetChannelShortcut:` - - `channelIndex` - - *number* -- `GetChannelShortcutForChannelID:` - - `channelID` - - *number* - -**Returns:** -- `shortcut` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md b/wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md deleted file mode 100644 index 6df6a411..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChannelShortcutForChannelID.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_ChatInfo.GetChannelShortcut - -**Content:** -Needs summary. -`shortcut = C_ChatInfo.GetChannelShortcut(channelIndex)` -`shortcut = C_ChatInfo.GetChannelShortcutForChannelID(channelID)` - -**Parameters:** -- `GetChannelShortcut:` - - `channelIndex` - - *number* -- `GetChannelShortcutForChannelID:` - - `channelID` - - *number* - -**Returns:** -- `shortcut` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md b/wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md deleted file mode 100644 index 7a049ebe..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChatLineSenderGUID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ChatInfo.GetChatLineSenderGUID - -**Content:** -Needs summary. -`guid = C_ChatInfo.GetChatLineSenderGUID(chatLine)` - -**Parameters:** -- `chatLine` - - *number* - -**Returns:** -- `guid` - - *string* : WOWGUID \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md b/wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md deleted file mode 100644 index 16a86bc1..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChatLineSenderName.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ChatInfo.GetChatLineSenderName - -**Content:** -Needs summary. -`name = C_ChatInfo.GetChatLineSenderName(chatLine)` - -**Parameters:** -- `chatLine` - - *number* - -**Returns:** -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatLineText.md b/wiki-information/functions/C_ChatInfo.GetChatLineText.md deleted file mode 100644 index d79109b7..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChatLineText.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ChatInfo.GetChatLineText - -**Content:** -Needs summary. -`text = C_ChatInfo.GetChatLineText(chatLine)` - -**Parameters:** -- `chatLine` - - *number* - -**Returns:** -- `text` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetChatTypeName.md b/wiki-information/functions/C_ChatInfo.GetChatTypeName.md deleted file mode 100644 index 8eb27214..00000000 --- a/wiki-information/functions/C_ChatInfo.GetChatTypeName.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_ChatInfo.GetChatTypeName - -**Content:** -Needs summary. -`name = C_ChatInfo.GetChatTypeName(typeID)` - -**Parameters:** -- `typeID` - - *number* - -**Returns:** -- `name` - - *string?* - -**Example Usage:** -This function can be used to retrieve the name of a chat type based on its type ID. For instance, if you have a type ID and you want to know the corresponding chat type name, you can use this function to get that information. - -**Addons Usage:** -Large addons that manage or enhance chat functionalities, such as Prat or Chatter, might use this function to dynamically handle different chat types based on their IDs. This allows for more flexible and robust chat management features. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md b/wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md deleted file mode 100644 index b1b68ca0..00000000 --- a/wiki-information/functions/C_ChatInfo.GetNumActiveChannels.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ChatInfo.GetNumActiveChannels - -**Content:** -Needs summary. -`numChannels = C_ChatInfo.GetNumActiveChannels()` - -**Returns:** -- `numChannels` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md b/wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md deleted file mode 100644 index 6f858f4a..00000000 --- a/wiki-information/functions/C_ChatInfo.GetRegisteredAddonMessagePrefixes.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_ChatInfo.GetRegisteredAddonMessagePrefixes - -**Content:** -Returns addon message prefixes the client is currently registered to receive. -`registeredPrefixes = C_ChatInfo.GetRegisteredAddonMessagePrefixes()` - -**Returns:** -- `registeredPrefixes` - - *string* - -**Reference:** -- `C_ChatInfo.IsAddonMessagePrefixRegistered()` -- `C_ChatInfo.RegisterAddonMessagePrefix()` - -**Example Usage:** -This function can be used to retrieve a list of all addon message prefixes that the client is currently set up to handle. This is useful for debugging or for ensuring that your addon is properly registered to communicate with other addons. - -**Addon Usage:** -Many large addons, such as WeakAuras, use this function to manage communication between different users' clients. By checking which prefixes are registered, the addon can ensure it is able to send and receive the necessary messages for its functionality. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md b/wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md deleted file mode 100644 index 3d54ff5d..00000000 --- a/wiki-information/functions/C_ChatInfo.IsAddonMessagePrefixRegistered.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_ChatInfo.IsAddonMessagePrefixRegistered - -**Content:** -Returns whether the prefix is registered. -`isRegistered = C_ChatInfo.IsAddonMessagePrefixRegistered(prefix)` - -**Parameters:** -- `prefix` - - *string* - -**Returns:** -- `isRegistered` - - *boolean* - -**Reference:** -- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` -- `C_ChatInfo.RegisterAddonMessagePrefix()` - -### Example Usage: -This function can be used to check if a specific prefix for addon communication is already registered before attempting to register it again. This is useful in preventing duplicate registrations which can lead to errors or unexpected behavior. - -### Addon Usage: -Many large addons, such as WeakAuras, use this function to manage their communication channels. For instance, WeakAuras uses custom prefixes to send data between players, ensuring that the prefix is registered before sending messages to avoid conflicts. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsChatLineCensored.md b/wiki-information/functions/C_ChatInfo.IsChatLineCensored.md deleted file mode 100644 index c3e2d1fb..00000000 --- a/wiki-information/functions/C_ChatInfo.IsChatLineCensored.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ChatInfo.IsChatLineCensored - -**Content:** -Needs summary. -`isCensored = C_ChatInfo.IsChatLineCensored(chatLine)` - -**Parameters:** -- `chatLine` - - *number* - -**Returns:** -- `isCensored` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsPartyChannelType.md b/wiki-information/functions/C_ChatInfo.IsPartyChannelType.md deleted file mode 100644 index 9529b594..00000000 --- a/wiki-information/functions/C_ChatInfo.IsPartyChannelType.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_ChatInfo.IsPartyChannelType - -**Content:** -Needs summary. -`isPartyChannelType = C_ChatInfo.IsPartyChannelType(channelType)` - -**Parameters:** -- `channelType` - - *Enum.ChatChannelType* - - `Enum.ChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - - `None` - - `1` - - `Custom` - - `2` - - `Private_Party` - - Documented as "PrivateParty" - - `3` - - `Public_Party` - - Documented as "PublicParty" - - `4` - - `Communities` - -**Returns:** -- `isPartyChannelType` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.IsValidChatLine.md b/wiki-information/functions/C_ChatInfo.IsValidChatLine.md deleted file mode 100644 index 7568151b..00000000 --- a/wiki-information/functions/C_ChatInfo.IsValidChatLine.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ChatInfo.IsValidChatLine - -**Content:** -Needs summary. -`isValid = C_ChatInfo.IsValidChatLine()` - -**Parameters:** -- `chatLine` - - *number?* - -**Returns:** -- `isValid` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md b/wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md deleted file mode 100644 index 7571ff49..00000000 --- a/wiki-information/functions/C_ChatInfo.RegisterAddonMessagePrefix.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_ChatInfo.RegisterAddonMessagePrefix - -**Content:** -Registers an addon message prefix to receive messages for that prefix. -`result = C_ChatInfo.RegisterAddonMessagePrefix(prefix)` - -**Parameters:** -- `prefix` - - *string* - The message prefix to register for delivery, at most 16 characters. - -**Returns:** -- `result` - - *Enum.RegisterAddonMessagePrefixResult* - Result code indicating if the prefix was registered successfully. - -**Description:** -Registering prefixes does not persist after doing a /reload. -It's recommended to use the addon name as a prefix (provided it fits within the 16 byte limit) since it's more likely to be unique and other addon authors will have an easier time instead of figuring out what addon a certain abbreviation belongs to. See the Globe wut page for a list of addons that use this API to avoid collisions. - -**Reference:** -- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` -- `C_ChatInfo.IsAddonMessagePrefixRegistered()` -- `C_ChatInfo.SendAddonMessage()` - -**Example Usage:** -This function can be used to register a custom prefix for an addon to communicate with other players using the same addon. For example, an addon named "MyAddon" could register the prefix "MyAddonMsg" to send and receive messages specific to that addon. - -**Addons Using This API:** -Many large addons, such as "WeakAuras" and "DBM (Deadly Boss Mods)", use this API to handle inter-addon communication. They register specific prefixes to send data between users running the same addon, ensuring coordinated behavior and data sharing. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.ReportPlayer.md b/wiki-information/functions/C_ChatInfo.ReportPlayer.md deleted file mode 100644 index 39617f06..00000000 --- a/wiki-information/functions/C_ChatInfo.ReportPlayer.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: C_ReportSystem.OpenReportPlayerDialog - -**Content:** -Opens the dialog for reporting a player. -`C_ReportSystem.OpenReportPlayerDialog(reportType, playerName)` - -**Parameters:** -- `reportType` - - *string* - One of the strings found in PLAYER_REPORT_TYPE -- `playerName` - - *string* - Name of the player being reported -- `playerLocation` - - *PlayerLocationMixin* - -**PLAYER_REPORT_TYPE Constants:** -- `PLAYER_REPORT_TYPE` - - *Constant* - *Value* - - `PLAYER_REPORT_TYPE_SPAM` - - *spam* - - `PLAYER_REPORT_TYPE_LANGUAGE` - - *language* - - `PLAYER_REPORT_TYPE_ABUSE` - - *abuse* - - `PLAYER_REPORT_TYPE_BAD_PLAYER_NAME` - - *badplayername* - - `PLAYER_REPORT_TYPE_BAD_GUILD_NAME` - - *badguildname* - - `PLAYER_REPORT_TYPE_CHEATING` - - *cheater* - - `PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME` - - *badbattlepetname* - - `PLAYER_REPORT_TYPE_BAD_PET_NAME` - - *badpetname* - -**Description:** -This function is not protected and therefore available to Addons, unlike `C_ReportSystem.InitiateReportPlayer` and `C_ReportSystem.SendReportPlayer`. -This reporting restriction was added because AddOn BadBoy allegedly sent out a number of false positives. -Triggers `OPEN_REPORT_PLAYER` once the window is open. - -**Usage:** -Opens the spam report dialog for the current target. -```lua -/run C_ReportSystem.OpenReportPlayerDialog(PLAYER_REPORT_TYPE_SPAM, UnitName("target"), PlayerLocation:CreateFromUnit("target")) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.SendAddonMessage.md b/wiki-information/functions/C_ChatInfo.SendAddonMessage.md deleted file mode 100644 index 88fad19f..00000000 --- a/wiki-information/functions/C_ChatInfo.SendAddonMessage.md +++ /dev/null @@ -1,153 +0,0 @@ -## Title: C_ChatInfo.SendAddonMessage - -**Content:** -Sends a message over an addon comm channel. -`result = C_ChatInfo.SendAddonMessage(prefix, message )` -`= C_ChatInfo.SendAddonMessageLogged` - -**Parameters:** -- `prefix` - - *string* - Message prefix, can be used as your addon identifier; at most 16 characters. -- `message` - - *string* - Text to send, at most 255 characters. All characters (decimal ID 1-255) are permissible except NULL (ASCII 0). -- `chatType` - - *string? = PARTY* - The addon channel to send to. -- `target` - - *string|number?* - The player name or custom channel number receiving the message for "WHISPER" or "CHANNEL" chatTypes. - -**Returns:** -- `result` - - *Enum.SendAddonMessageResult* - Result code indicating if the message has been enqueued by the API for submission. This does not mean that the message has yet been sent, and may still be subject to any server-side throttling. - -**Miscellaneous:** -- `chatType` - - **Retail** - - **Classic** - - **Description** - - `"PARTY"` - - ✔️ - - ✔️ - - Addon message to party members. - - `"RAID"` - - ✔️ - - ✔️ - - Addon message to raid members. If not in a raid group, the message will instead be sent on the PARTY chat type. - - `"INSTANCE_CHAT"` - - ✔️ - - ✔️ - - Addon message to grouped players in instanced content such as dungeons, raids and battlegrounds. - - `"GUILD"` - - ✔️ - - ✔️ - - Addon message to guild members. Prints a "You are not in a guild." system message if you're not in a guild. - - `"OFFICER"` - - ✔️ - - ✔️ - - Addon message to guild officers. - - `"WHISPER"` - - ✔️ - - ✔️ - - Addon message to a player. Only works for players on the same or any connected realms. Use player name as target argument. Prints a "Player is offline." system message if the target is offline. - - `"CHANNEL"` - - ✔️ - - ❌ - - Addon message to a custom chat channel. Use channel number as target argument. Disabled on Classic to prevent players communicating over custom chat channels. - - `"SAY"` - - ❌ - - ✔️ - - Addon message to players within /say range. Subject to heavy throttling and certain specific characters are disallowed. - - `"YELL"` - - ❌ - - ✔️ - - Addon message to players within /yell range. Subject to heavy throttling and certain specific characters are disallowed. - -**Message throttling:** -Communications on all chat types are subject to a per-prefix throttle. Additionally, if too much data is being sent simultaneously on separate prefixes then the client may be disconnected. For this reason, it is strongly recommended to use ChatThrottleLib or AceComm to manage the queueing of messages. -- Each registered prefix is given an allowance of 10 addon messages that can be sent. -- Each message sent on a prefix reduces this allowance by 1. -- If the allowance reaches zero, further attempts to send messages on the same prefix will fail, returning Enum.SendAddonMessageResult.AddonMessageThrottle to the caller. -- Each prefix regains its allowance at a rate of 1 message per second, up to the original maximum of 10 messages. -- This restriction does not apply to whispers outside of instanced content. -- All numbers provided above are the default values, however, these can be dynamically reconfigured by the server at any time. - -**Libraries:** -There is a server-side throttle on in-game addon communication so it's recommended to serialize, compress and encode data before you send them over the addon comms channel. -- **Serialize:** - - LibSerialize - - AceSerializer -- **Compress/Encode:** - - LibDeflate - - LibCompress -- **Comms:** - - ChatThrottleLib - - AceComm - -The LibSerialize project page has detailed examples and documentation for using LibSerialize + LibDeflate and AceComm: -```lua --- Dependencies: AceAddon-3.0, AceComm-3.0, LibSerialize, LibDeflate -MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceComm-3.0") -local LibSerialize = LibStub("LibSerialize") -local LibDeflate = LibStub("LibDeflate") - -function MyAddon:OnEnable() - self:RegisterComm("MyPrefix") -end - --- With compression (recommended): -function MyAddon:Transmit(data) - local serialized = LibSerialize:Serialize(data) - local compressed = LibDeflate:CompressDeflate(serialized) - local encoded = LibDeflate:EncodeForWoWAddonChannel(compressed) - self:SendCommMessage("MyPrefix", encoded, "WHISPER", UnitName("player")) -end - -function MyAddon:OnCommReceived(prefix, payload, distribution, sender) - local decoded = LibDeflate:DecodeForWoWAddonChannel(payload) - if not decoded then return end - local decompressed = LibDeflate:DecompressDeflate(decoded) - if not decompressed then return end - local success, data = LibSerialize:Deserialize(decompressed) - if not success then return end - -- Handle `data` -end -``` - -**Description:** -Recipients must register a prefix using `C_ChatInfo.RegisterAddonMessagePrefix()` to receive its messages via `CHAT_MSG_ADDON`. This prefix can be max 16 characters long and it's recommended to use the addon name if possible so other authors can easily see which addon a registered prefix belongs to. -Prior to Patch 11.0.0, Blizzard has provided a deprecation wrapper for this API that shifts the result code to the second return position. A forward-compatible way to reliably access the enum return value is to use a negative select index to grab the last return value. - -**C_ChatInfo.SendAddonMessageLogged:** -Addons transmitting user-generated content should use this API so recipients can report violations of the Code of Conduct. -Fires `CHAT_MSG_ADDON_LOGGED` when receiving messages sent via this function. -The message has to be plain text for the game masters to read it. Moreover, the messages will silently fail to be sent if it contains an unsupported non-printable character. Some amount of metadata is tolerated, but should be kept as minimal as possible to keep the messages readable for Blizzard's game masters. - -This function has been introduced as a solution to growing issues of harassment and doxxing via addon communications, where players would use addons to send content against the terms of service to other players (roleplaying addons are particularly affected as they offer a free form canvas to share RP profiles). As regular addon messages are not logged they cannot be seen by game masters, they had no way to act upon this content. If you use this function, game masters will be able to check the addon communication logs in case of a report and act upon the content. Users should report addon content that is against the terms of service using Blizzard's support website via the Harassment in addon text option. - -**Usage:** -Whispers yourself an addon message when you login or /reload -```lua -local prefix = "SomePrefix123" -local playerName = UnitName("player") -local function OnEvent(self, event, ...) - if event == "CHAT_MSG_ADDON" then - print(event, ...) - elseif event == "PLAYER_ENTERING_WORLD" then - local isLogin, isReload = ... - if isLogin or isReload then - C_ChatInfo.SendAddonMessage(prefix, "You can't see this message", "WHISPER", playerName) - C_ChatInfo.RegisterAddonMessagePrefix(prefix) - C_ChatInfo.SendAddonMessage(prefix, "Hello world!", "WHISPER", playerName) - end - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("CHAT_MSG_ADDON") -f:RegisterEvent("PLAYER_ENTERING_WORLD") -f:SetScript("OnEvent", OnEvent) -``` - -**Reference:** -- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` -- `C_ChatInfo.IsAddonMessagePrefixRegistered()` -- `BNSendGameData()` - Battle.net equivalent. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md b/wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md deleted file mode 100644 index a606bf74..00000000 --- a/wiki-information/functions/C_ChatInfo.SendAddonMessageLogged.md +++ /dev/null @@ -1,153 +0,0 @@ -## Title: C_ChatInfo.SendAddonMessage - -**Content:** -Sends a message over an addon comm channel. -`result = C_ChatInfo.SendAddonMessage(prefix, message )` -`result = C_ChatInfo.SendAddonMessageLogged` - -**Parameters:** -- `prefix` - - *string* - Message prefix, can be used as your addon identifier; at most 16 characters. -- `message` - - *string* - Text to send, at most 255 characters. All characters (decimal ID 1-255) are permissible except NULL (ASCII 0). -- `chatType` - - *string? = PARTY* - The addon channel to send to. -- `target` - - *string|number?* - The player name or custom channel number receiving the message for "WHISPER" or "CHANNEL" chatTypes. - -**Returns:** -- `result` - - *Enum.SendAddonMessageResult* - Result code indicating if the message has been enqueued by the API for submission. This does not mean that the message has yet been sent, and may still be subject to any server-side throttling. - -**Miscellaneous:** -- **chatType** - - **Retail** - - **Classic** - - **Description** - - `"PARTY"` - - ✔️ - - ✔️ - - Addon message to party members. - - `"RAID"` - - ✔️ - - ✔️ - - Addon message to raid members. If not in a raid group, the message will instead be sent on the PARTY chat type. - - `"INSTANCE_CHAT"` - - ✔️ - - ✔️ - - Addon message to grouped players in instanced content such as dungeons, raids, and battlegrounds. - - `"GUILD"` - - ✔️ - - ✔️ - - Addon message to guild members. Prints a "You are not in a guild." system message if you're not in a guild. - - `"OFFICER"` - - ✔️ - - ✔️ - - Addon message to guild officers. - - `"WHISPER"` - - ✔️ - - ✔️ - - Addon message to a player. Only works for players on the same or any connected realms. Use player name as target argument. Prints a "Player is offline." system message if the target is offline. - - `"CHANNEL"` - - ✔️ - - ❌ - - Addon message to a custom chat channel. Use channel number as target argument. Disabled on Classic to prevent players communicating over custom chat channels. - - `"SAY"` - - ❌ - - ✔️ - - Addon message to players within /say range. Subject to heavy throttling and certain specific characters are disallowed. - - `"YELL"` - - ❌ - - ✔️ - - Addon message to players within /yell range. Subject to heavy throttling and certain specific characters are disallowed. - -**Message throttling:** -Communications on all chat types are subject to a per-prefix throttle. Additionally, if too much data is being sent simultaneously on separate prefixes then the client may be disconnected. For this reason, it is strongly recommended to use ChatThrottleLib or AceComm to manage the queueing of messages. -- Each registered prefix is given an allowance of 10 addon messages that can be sent. -- Each message sent on a prefix reduces this allowance by 1. -- If the allowance reaches zero, further attempts to send messages on the same prefix will fail, returning Enum.SendAddonMessageResult.AddonMessageThrottle to the caller. -- Each prefix regains its allowance at a rate of 1 message per second, up to the original maximum of 10 messages. -- This restriction does not apply to whispers outside of instanced content. -- All numbers provided above are the default values, however, these can be dynamically reconfigured by the server at any time. - -**Libraries:** -There is a server-side throttle on in-game addon communication so it's recommended to serialize, compress and encode data before you send them over the addon comms channel. -- **Serialize:** - - LibSerialize - - AceSerializer -- **Compress/Encode:** - - LibDeflate - - LibCompress -- **Comms:** - - ChatThrottleLib - - AceComm - -The LibSerialize project page has detailed examples and documentation for using LibSerialize + LibDeflate and AceComm: -```lua --- Dependencies: AceAddon-3.0, AceComm-3.0, LibSerialize, LibDeflate -MyAddon = LibStub("AceAddon-3.0"):NewAddon("MyAddon", "AceComm-3.0") -local LibSerialize = LibStub("LibSerialize") -local LibDeflate = LibStub("LibDeflate") - -function MyAddon:OnEnable() - self:RegisterComm("MyPrefix") -end - --- With compression (recommended): -function MyAddon:Transmit(data) - local serialized = LibSerialize:Serialize(data) - local compressed = LibDeflate:CompressDeflate(serialized) - local encoded = LibDeflate:EncodeForWoWAddonChannel(compressed) - self:SendCommMessage("MyPrefix", encoded, "WHISPER", UnitName("player")) -end - -function MyAddon:OnCommReceived(prefix, payload, distribution, sender) - local decoded = LibDeflate:DecodeForWoWAddonChannel(payload) - if not decoded then return end - local decompressed = LibDeflate:DecompressDeflate(decoded) - if not decompressed then return end - local success, data = LibSerialize:Deserialize(decompressed) - if not success then return end - -- Handle `data` -end -``` - -**Description:** -Recipients must register a prefix using `C_ChatInfo.RegisterAddonMessagePrefix()` to receive its messages via `CHAT_MSG_ADDON`. This prefix can be max 16 characters long and it's recommended to use the addon name if possible so other authors can easily see which addon a registered prefix belongs to. - -Prior to Patch 11.0.0, Blizzard has provided a deprecation wrapper for this API that shifts the result code to the second return position. A forward-compatible way to reliably access the enum return value is to use a negative select index to grab the last return value. - -**C_ChatInfo.SendAddonMessageLogged:** -Addons transmitting user-generated content should use this API so recipients can report violations of the Code of Conduct. -Fires `CHAT_MSG_ADDON_LOGGED` when receiving messages sent via this function. -The message has to be plain text for the game masters to read it. Moreover, the messages will silently fail to be sent if it contains an unsupported non-printable character. Some amount of metadata is tolerated, but should be kept as minimal as possible to keep the messages readable for Blizzard's game masters. - -This function has been introduced as a solution to growing issues of harassment and doxxing via addon communications, where players would use addons to send content against the terms of service to other players (roleplaying addons are particularly affected as they offer a free form canvas to share RP profiles). As regular addon messages are not logged they cannot be seen by game masters, they had no way to act upon this content. If you use this function, game masters will be able to check the addon communication logs in case of a report and act upon the content. Users should report addon content that is against the terms of service using Blizzard's support website via the Harassment in addon text option. - -**Usage:** -Whispers yourself an addon message when you login or /reload -```lua -local prefix = "SomePrefix123" -local playerName = UnitName("player") -local function OnEvent(self, event, ...) - if event == "CHAT_MSG_ADDON" then - print(event, ...) - elseif event == "PLAYER_ENTERING_WORLD" then - local isLogin, isReload = ... - if isLogin or isReload then - C_ChatInfo.SendAddonMessage(prefix, "You can't see this message", "WHISPER", playerName) - C_ChatInfo.RegisterAddonMessagePrefix(prefix) - C_ChatInfo.SendAddonMessage(prefix, "Hello world!", "WHISPER", playerName) - end - end -end -local f = CreateFrame("Frame") -f:RegisterEvent("CHAT_MSG_ADDON") -f:RegisterEvent("PLAYER_ENTERING_WORLD") -f:SetScript("OnEvent", OnEvent) -``` - -**Reference:** -- `C_ChatInfo.GetRegisteredAddonMessagePrefixes()` -- `C_ChatInfo.IsAddonMessagePrefixRegistered()` -- `BNSendGameData()` - Battle.net equivalent. \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md b/wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md deleted file mode 100644 index 9edaef40..00000000 --- a/wiki-information/functions/C_ChatInfo.SwapChatChannelsByChannelIndex.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_ChatInfo.SwapChatChannelsByChannelIndex - -**Content:** -Needs summary. -`C_ChatInfo.SwapChatChannelsByChannelIndex(firstChannelIndex, secondChannelIndex)` - -**Parameters:** -- `firstChannelIndex` - - *number* -- `secondChannelIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ChatInfo.UncensorChatLine.md b/wiki-information/functions/C_ChatInfo.UncensorChatLine.md deleted file mode 100644 index b8b2770e..00000000 --- a/wiki-information/functions/C_ChatInfo.UncensorChatLine.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ChatInfo.UncensorChatLine - -**Content:** -Needs summary. -`C_ChatInfo.UncensorChatLine(chatLine)` - -**Parameters:** -- `chatLine` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AcceptInvitation.md b/wiki-information/functions/C_Club.AcceptInvitation.md deleted file mode 100644 index b108d205..00000000 --- a/wiki-information/functions/C_Club.AcceptInvitation.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.AcceptInvitation - -**Content:** -Needs summary. -`C_Club.AcceptInvitation(clubId)` - -**Parameters:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AddClubStreamChatChannel.md b/wiki-information/functions/C_Club.AddClubStreamChatChannel.md deleted file mode 100644 index 1e546eae..00000000 --- a/wiki-information/functions/C_Club.AddClubStreamChatChannel.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Club.AddClubStreamChatChannel - -**Content:** -Adds a communities channel. -`C_Club.AddClubStreamChatChannel(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Example Usage:** -This function can be used to add a specific stream (chat channel) to a community (club) in World of Warcraft. For instance, if you have a community for your guild and you want to add a new chat channel for raid discussions, you would use this function to do so. - -**Addons:** -Large addons like "ElvUI" or "WeakAuras" might use this function to manage community channels dynamically, especially in scenarios where they provide enhanced communication features or custom chat functionalities. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AdvanceStreamViewMarker.md b/wiki-information/functions/C_Club.AdvanceStreamViewMarker.md deleted file mode 100644 index 08fa3461..00000000 --- a/wiki-information/functions/C_Club.AdvanceStreamViewMarker.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Club.AdvanceStreamViewMarker - -**Content:** -Needs summary. -`C_Club.AdvanceStreamViewMarker(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.AssignMemberRole.md b/wiki-information/functions/C_Club.AssignMemberRole.md deleted file mode 100644 index 9bcf2697..00000000 --- a/wiki-information/functions/C_Club.AssignMemberRole.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Club.AssignMemberRole - -**Content:** -Needs summary. -`C_Club.AssignMemberRole(clubId, memberId, roleId)` - -**Parameters:** -- `clubId` - - *string* -- `memberId` - - *number* -- `roleId` - - *Enum.ClubRoleIdentifier* - - **Enum.ClubRoleIdentifier** - - **Value** - - **Field** - - **Description** - - `1` - - *Owner* - - `2` - - *Leader* - - `3` - - *Moderator* - - `4` - - *Member* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md b/wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md deleted file mode 100644 index acc611db..00000000 --- a/wiki-information/functions/C_Club.CanResolvePlayerLocationFromClubMessageData.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Club.CanResolvePlayerLocationFromClubMessageData - -**Content:** -Needs summary. -`canResolve = C_Club.CanResolvePlayerLocationFromClubMessageData(clubId, streamId, epoch, position)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `epoch` - - *number* -- `position` - - *number* - -**Returns:** -- `canResolve` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md b/wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md deleted file mode 100644 index 77ec6bac..00000000 --- a/wiki-information/functions/C_Club.ClearAutoAdvanceStreamViewMarker.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Club.ClearAutoAdvanceStreamViewMarker - -**Content:** -Needs summary. -`C_Club.ClearAutoAdvanceStreamViewMarker()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ClearClubPresenceSubscription.md b/wiki-information/functions/C_Club.ClearClubPresenceSubscription.md deleted file mode 100644 index 46d3fe4a..00000000 --- a/wiki-information/functions/C_Club.ClearClubPresenceSubscription.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Club.ClearClubPresenceSubscription - -**Content:** -Needs summary. -`C_Club.ClearClubPresenceSubscription()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CompareBattleNetDisplayName.md b/wiki-information/functions/C_Club.CompareBattleNetDisplayName.md deleted file mode 100644 index 1babbdd8..00000000 --- a/wiki-information/functions/C_Club.CompareBattleNetDisplayName.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Club.CompareBattleNetDisplayName - -**Content:** -Needs summary. -`comparison = C_Club.CompareBattleNetDisplayName(clubId, lhsMemberId, rhsMemberId)` - -**Parameters:** -- `clubId` - - *string* -- `lhsMemberId` - - *number* -- `rhsMemberId` - - *number* - -**Returns:** -- `comparison` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CreateClub.md b/wiki-information/functions/C_Club.CreateClub.md deleted file mode 100644 index 87875864..00000000 --- a/wiki-information/functions/C_Club.CreateClub.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Club.CreateClub - -**Content:** -Needs summary. -`C_Club.CreateClub(name, shortName, description, clubType, avatarId, isCrossFaction)` - -**Parameters:** -- `name` - - *string* - The name of the club. -- `shortName` - - *string?* - An optional short name for the club. -- `description` - - *string* - A description of the club. -- `clubType` - - *Enum.ClubType* - Valid types are BattleNet or Character. - - **Value** - - **Field** - - **Description** - - `0` - - *BattleNet* - - `1` - - *Character* - - `2` - - *Guild* - - `3` - - *Other* -- `avatarId` - - *number* - The ID of the avatar for the club. -- `isCrossFaction` - - *boolean?* - An optional boolean indicating if the club is cross-faction. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CreateStream.md b/wiki-information/functions/C_Club.CreateStream.md deleted file mode 100644 index 96e1b0e4..00000000 --- a/wiki-information/functions/C_Club.CreateStream.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_Club.CreateStream - -**Content:** -Needs summary. -`C_Club.CreateStream(clubId, name, subject, leadersAndModeratorsOnly)` - -**Parameters:** -- `clubId` - - *string* -- `name` - - *string* -- `subject` - - *string* -- `leadersAndModeratorsOnly` - - *boolean* - -**Description:** -Check the canCreateStream privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.CreateTicket.md b/wiki-information/functions/C_Club.CreateTicket.md deleted file mode 100644 index 98c86008..00000000 --- a/wiki-information/functions/C_Club.CreateTicket.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Club.CreateTicket - -**Content:** -This is protected and only available to the Blizzard UI. Used for creating a ticket for a community club. -`C_Club.CreateTicket(clubId)` - -**Parameters:** -- `clubId` - - *string* -- `allowedRedeemCount` - - *number?* - Number of uses. `nil` means unlimited -- `duration` - - *number?* - Duration in seconds. `nil` never expires -- `defaultStreamId` - - *string?* -- `isCrossFaction` - - *boolean?* - -**Description:** -Check `canCreateTicket` privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DeclineInvitation.md b/wiki-information/functions/C_Club.DeclineInvitation.md deleted file mode 100644 index 09135fcc..00000000 --- a/wiki-information/functions/C_Club.DeclineInvitation.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.DeclineInvitation - -**Content:** -Needs summary. -`C_Club.DeclineInvitation(clubId)` - -**Parameters:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyClub.md b/wiki-information/functions/C_Club.DestroyClub.md deleted file mode 100644 index f3cece5b..00000000 --- a/wiki-information/functions/C_Club.DestroyClub.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Club.DestroyClub - -**Content:** -Needs summary. -`C_Club.DestroyClub(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Description:** -Check the canDestroy privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyMessage.md b/wiki-information/functions/C_Club.DestroyMessage.md deleted file mode 100644 index ffd7e727..00000000 --- a/wiki-information/functions/C_Club.DestroyMessage.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Club.DestroyMessage - -**Content:** -Needs summary. -`C_Club.DestroyMessage(clubId, streamId, messageId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `messageId` - - *structure* - ClubMessageIdentifier - - `ClubMessageIdentifier` - - `Field` - - `Type` - - `Description` - - `epoch` - - *number* - number of microseconds since the UNIX epoch - - `position` - - *number* - sort order for messages at the same time \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyStream.md b/wiki-information/functions/C_Club.DestroyStream.md deleted file mode 100644 index c1a1a1f4..00000000 --- a/wiki-information/functions/C_Club.DestroyStream.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Club.DestroyStream - -**Content:** -Needs summary. -`C_Club.DestroyStream(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Description:** -Check canDestroyStream privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DestroyTicket.md b/wiki-information/functions/C_Club.DestroyTicket.md deleted file mode 100644 index aed41423..00000000 --- a/wiki-information/functions/C_Club.DestroyTicket.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Club.DestroyTicket - -**Content:** -Needs summary. -`C_Club.DestroyTicket(clubId, ticketId)` - -**Parameters:** -- `clubId` - - *string* -- `ticketId` - - *string* - -**Description:** -Check canDestroyTicket privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md b/wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md deleted file mode 100644 index acedd87f..00000000 --- a/wiki-information/functions/C_Club.DoesAnyCommunityHaveUnreadMessages.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.DoesAnyCommunityHaveUnreadMessages - -**Content:** -Needs summary. -`hasUnreadMessages = C_Club.DoesAnyCommunityHaveUnreadMessages()` - -**Returns:** -- `hasUnreadMessages` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.EditClub.md b/wiki-information/functions/C_Club.EditClub.md deleted file mode 100644 index 5b95f0ac..00000000 --- a/wiki-information/functions/C_Club.EditClub.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_Club.EditClub - -**Content:** -Needs summary. -`C_Club.EditClub(clubId)` - -**Parameters:** -- `clubId` - - *string* -- `name` - - *string?* -- `shortName` - - *string?* -- `description` - - *string?* -- `avatarId` - - *number?* -- `broadcast` - - *string?* -- `crossFaction` - - *boolean?* - -**Description:** -nil arguments will not change existing club data \ No newline at end of file diff --git a/wiki-information/functions/C_Club.EditMessage.md b/wiki-information/functions/C_Club.EditMessage.md deleted file mode 100644 index b2d61ecf..00000000 --- a/wiki-information/functions/C_Club.EditMessage.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_Club.EditMessage - -**Content:** -Needs summary. -`C_Club.EditMessage(clubId, streamId, messageId, message)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `messageId` - - *ClubMessageIdentifier* - - `Field` - - `Type` - - `Description` - - `epoch` - - *number* - number of microseconds since the UNIX epoch - - `position` - - *number* - sort order for messages at the same time -- `message` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.EditStream.md b/wiki-information/functions/C_Club.EditStream.md deleted file mode 100644 index 456a4fc6..00000000 --- a/wiki-information/functions/C_Club.EditStream.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Club.EditStream - -**Content:** -Needs summary. -`C_Club.EditStream(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `name` - - *string?* -- `subject` - - *string?* -- `leadersAndModeratorsOnly` - - *boolean?* - -**Description:** -Check the `canSetStreamName`, `canSetStreamSubject`, `canSetStreamAccess` privileges. `nil` arguments will not change existing stream data. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.Flush.md b/wiki-information/functions/C_Club.Flush.md deleted file mode 100644 index 15ae4510..00000000 --- a/wiki-information/functions/C_Club.Flush.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Club.Flush - -**Content:** -Needs summary. -`C_Club.Flush()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.FocusCommunityStreams.md b/wiki-information/functions/C_Club.FocusCommunityStreams.md deleted file mode 100644 index 238feb74..00000000 --- a/wiki-information/functions/C_Club.FocusCommunityStreams.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Club.FocusCommunityStreams - -**Content:** -Needs summary. -`C_Club.FocusCommunityStreams()` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.FocusStream.md b/wiki-information/functions/C_Club.FocusStream.md deleted file mode 100644 index 0ec08320..00000000 --- a/wiki-information/functions/C_Club.FocusStream.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Club.FocusStream - -**Content:** -Needs summary. -`focused = C_Club.FocusStream(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Returns:** -- `focused` - - *boolean* - -**Example Usage:** -This function can be used to set a specific stream within a club as the focused stream. This might be useful in an addon that manages multiple chat streams within a club, allowing the user to highlight or prioritize a particular stream. - -**Addon Usage:** -Large addons like "ElvUI" or "Prat" that manage chat functionalities might use this function to allow users to focus on specific streams within their club chats, enhancing the user experience by providing more control over their chat environment. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetAssignableRoles.md b/wiki-information/functions/C_Club.GetAssignableRoles.md deleted file mode 100644 index af99f669..00000000 --- a/wiki-information/functions/C_Club.GetAssignableRoles.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_Club.GetAssignableRoles - -**Content:** -Needs summary. -`assignableRoles = C_Club.GetAssignableRoles(clubId, memberId)` - -**Parameters:** -- `clubId` - - *string* -- `memberId` - - *number* - -**Returns:** -- `assignableRoles` - - *Enum.ClubRoleIdentifier* - - *Enum.ClubRoleIdentifier* - - `Value` - - `Field` - - `Description` - - `1` - - `Owner` - - `2` - - `Leader` - - `3` - - `Moderator` - - `4` - - `Member` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetAvatarIdList.md b/wiki-information/functions/C_Club.GetAvatarIdList.md deleted file mode 100644 index d4605814..00000000 --- a/wiki-information/functions/C_Club.GetAvatarIdList.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_Club.GetAvatarIdList - -**Content:** -Needs summary. -`avatarIds = C_Club.GetAvatarIdList(clubType)` - -**Parameters:** -- `clubType` - - *Enum.ClubType* - - `Enum.ClubType` - - `Value` - - `Field` - - `Description` - - `0` - BattleNet - - `1` - Character - - `2` - Guild - - `3` - Other - -**Returns:** -- `avatarIds` - - *number?* - -**Description:** -Listen for `AVATAR_LIST_UPDATED` event. This can happen if we haven't downloaded the Battle.net avatar list yet. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubInfo.md b/wiki-information/functions/C_Club.GetClubInfo.md deleted file mode 100644 index e27dc8cd..00000000 --- a/wiki-information/functions/C_Club.GetClubInfo.md +++ /dev/null @@ -1,55 +0,0 @@ -## Title: C_Club.GetClubInfo - -**Content:** -Needs summary. -`info = C_Club.GetClubInfo(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `info` - - *ClubInfo?* - - `Field` - - `Type` - - `Description` - - `clubId` - - *string* - - `name` - - *string* - - `shortName` - - *string?* - - `description` - - *string* - - `broadcast` - - *string* - - `clubType` - - *Enum.ClubType* - - `avatarId` - - *number* - - `memberCount` - - *number?* - - `favoriteTimeStamp` - - *number?* - - `joinTime` - - *number?* - - UNIX timestamp measured in microsecond precision. - - `socialQueueingEnabled` - - *boolean?* - - `crossFaction` - - *boolean?* - - Added in 9.2.5 - -**Enum.ClubType:** -- `Value` -- `Field` -- `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubMembers.md b/wiki-information/functions/C_Club.GetClubMembers.md deleted file mode 100644 index 650ca39f..00000000 --- a/wiki-information/functions/C_Club.GetClubMembers.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_Club.GetClubMembers - -**Content:** -Needs summary. -`members = C_Club.GetClubMembers(clubId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string?* - -**Returns:** -- `members` - - *number* - -**Description:** -This function retrieves the members of a specified club. The `clubId` is a unique identifier for the club, and the optional `streamId` can be used to filter members based on a specific stream within the club. - -**Example Usage:** -```lua -local clubId = "1234567890" -local members = C_Club.GetClubMembers(clubId) -print("Number of members in the club:", members) -``` - -**Addons Using This Function:** -- **Communities**: The in-game Communities feature uses this function to display the list of members in a community or guild. -- **Guild Management Addons**: Addons like "Guild Roster Manager" use this function to fetch and display detailed information about guild members. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubPrivileges.md b/wiki-information/functions/C_Club.GetClubPrivileges.md deleted file mode 100644 index 23b889fc..00000000 --- a/wiki-information/functions/C_Club.GetClubPrivileges.md +++ /dev/null @@ -1,103 +0,0 @@ -## Title: C_Club.GetClubPrivileges - -**Content:** -Needs summary. -`privilegeInfo = C_Club.GetClubPrivileges(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `privilegeInfo` - - *structure* - ClubPrivilegeInfo - - `Field` - - `Type` - - `Description` - - `canDestroy` - - *boolean* - - `canSetAttribute` - - *boolean* - - `canSetName` - - *boolean* - - `canSetDescription` - - *boolean* - - `canSetAvatar` - - *boolean* - - `canSetBroadcast` - - *boolean* - - `canSetPrivacyLevel` - - *boolean* - - `canSetOwnMemberAttribute` - - *boolean* - - `canSetOtherMemberAttribute` - - *boolean* - - `canSetOwnMemberNote` - - *boolean* - - `canSetOtherMemberNote` - - *boolean* - - `canSetOwnVoiceState` - - *boolean* - - `canSetOwnPresenceLevel` - - *boolean* - - `canUseVoice` - - *boolean* - - `canVoiceMuteMemberForAll` - - *boolean* - - `canGetInvitation` - - *boolean* - - `canSendInvitation` - - *boolean* - - `canSendGuestInvitation` - - *boolean* - - `canRevokeOwnInvitation` - - *boolean* - - `canRevokeOtherInvitation` - - *boolean* - - `canGetBan` - - *boolean* - - `canGetSuggestion` - - *boolean* - - `canSuggestMember` - - *boolean* - - `canGetTicket` - - *boolean* - - `canCreateTicket` - - *boolean* - - `canDestroyTicket` - - *boolean* - - `canAddBan` - - *boolean* - - `canRemoveBan` - - *boolean* - - `canCreateStream` - - *boolean* - - `canDestroyStream` - - *boolean* - - `canSetStreamPosition` - - *boolean* - - `canSetStreamAttribute` - - *boolean* - - `canSetStreamName` - - *boolean* - - `canSetStreamSubject` - - *boolean* - - `canSetStreamAccess` - - *boolean* - - `canSetStreamVoiceLevel` - - *boolean* - - `canCreateMessage` - - *boolean* - - `canDestroyOwnMessage` - - *boolean* - - `canDestroyOtherMessage` - - *boolean* - - `canEditOwnMessage` - - *boolean* - - `canPinMessage` - - *boolean* - - `kickableRoleIds` - - *number* - Roles that can be kicked and banned - -**Description:** -The privileges for the logged-in user for this club. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md b/wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md deleted file mode 100644 index 440d22eb..00000000 --- a/wiki-information/functions/C_Club.GetClubStreamNotificationSettings.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_Club.GetClubStreamNotificationSettings - -**Content:** -Needs summary. -`settings = C_Club.GetClubStreamNotificationSettings(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `settings` - - *structure* - ClubStreamNotificationSetting - - `ClubStreamNotificationSetting` - - `Field` - - `Type` - - `Description` - - `streamId` - - *string* - - `filter` - - *Enum.ClubStreamNotificationFilter* - - `Enum.ClubStreamNotificationFilter` - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Mention - - `2` - - All \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetCommunityNameResultText.md b/wiki-information/functions/C_Club.GetCommunityNameResultText.md deleted file mode 100644 index 0b40b1ba..00000000 --- a/wiki-information/functions/C_Club.GetCommunityNameResultText.md +++ /dev/null @@ -1,55 +0,0 @@ -## Title: C_Club.GetCommunityNameResultText - -**Content:** -Needs summary. -`errorCode = C_Club.GetCommunityNameResultText(result)` - -**Parameters:** -- `result` - - *Enum.ValidateNameResult* - - **Value** - - **Field** - - **Description** - - `0` - - Success - - `1` - - Failure - - `2` - - NoName - - `3` - - TooShort - - `4` - - TooLong - - `5` - - InvalidCharacter - - `6` - - MixedLanguages - - `7` - - Profane - - `8` - - Reserved - - `9` - - InvalidApostrophe - - `10` - - MultipleApostrophes - - `11` - - ThreeConsecutive - - `12` - - InvalidSpace - - `13` - - ConsecutiveSpaces - - `14` - - RussianConsecutiveSilentCharacters - - `15` - - RussianSilentCharacterAtBeginningOrEnd - - `16` - - DeclensionDoesntMatchBaseName - - `17` - - SpacesDisallowed - -**Returns:** -- `errorCode` - - *string?* - -**Change Log:** -- Added in 8.2.5 \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md b/wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md deleted file mode 100644 index f75a665e..00000000 --- a/wiki-information/functions/C_Club.GetInfoFromLastCommunityChatLine.md +++ /dev/null @@ -1,149 +0,0 @@ -## Title: C_Club.GetInfoFromLastCommunityChatLine - -**Content:** -Needs summary. -`messageInfo, clubId, streamId, clubType = C_Club.GetInfoFromLastCommunityChatLine()` - -**Returns:** -- `messageInfo` - - *structure* - ClubMessageInfo -- `clubId` - - *string* -- `streamId` - - *string* -- `clubType` - - *Enum.ClubType* - -**ClubMessageInfo:** -- `Field` -- `Type` -- `Description` -- `messageId` - - *ClubMessageIdentifier* -- `content` - - *string* - Protected string -- `author` - - *ClubMemberInfo* -- `destroyer` - - *ClubMemberInfo?* - May be nil even if the message has been destroyed -- `destroyed` - - *boolean* -- `edited` - - *boolean* - -**ClubMessageIdentifier:** -- `Field` -- `Type` -- `Description` -- `epoch` - - *number* - number of microseconds since the UNIX epoch -- `position` - - *number* - sort order for messages at the same time - -**ClubMemberInfo:** -- `Field` -- `Type` -- `Description` -- `isSelf` - - *boolean* -- `memberId` - - *number* -- `name` - - *string?* - name may be encoded as a Kstring -- `role` - - *Enum.ClubRoleIdentifier?* -- `presence` - - *Enum.ClubMemberPresence* -- `clubType` - - *Enum.ClubType?* -- `guid` - - *string?* -- `bnetAccountId` - - *number?* -- `memberNote` - - *string?* -- `officerNote` - - *string?* -- `classID` - - *number?* -- `race` - - *number?* -- `level` - - *number?* -- `zone` - - *string?* -- `achievementPoints` - - *number?* -- `profession1ID` - - *number?* -- `profession1Rank` - - *number?* -- `profession1Name` - - *string?* -- `profession2ID` - - *number?* -- `profession2Rank` - - *number?* -- `profession2Name` - - *string?* -- `lastOnlineYear` - - *number?* -- `lastOnlineMonth` - - *number?* -- `lastOnlineDay` - - *number?* -- `lastOnlineHour` - - *number?* -- `guildRank` - - *string?* -- `guildRankOrder` - - *number?* -- `isRemoteChat` - - *boolean?* -- `overallDungeonScore` - - *number?* - Added in 9.1.0 -- `faction` - - *Enum.PvPFaction?* - Added in 9.2.5 - -**Enum.ClubRoleIdentifier:** -- `Value` -- `Field` -- `Description` -- `1` - - Owner -- `2` - - Leader -- `3` - - Moderator -- `4` - - Member - -**Enum.ClubMemberPresence:** -- `Value` -- `Field` -- `Description` -- `0` - - Unknown -- `1` - - Online -- `2` - - OnlineMobile -- `3` - - Offline -- `4` - - Away -- `5` - - Busy - -**Enum.ClubType:** -- `Value` -- `Field` -- `Description` -- `0` - - BattleNet -- `1` - - Character -- `2` - - Guild -- `3` - - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationCandidates.md b/wiki-information/functions/C_Club.GetInvitationCandidates.md deleted file mode 100644 index 346be06c..00000000 --- a/wiki-information/functions/C_Club.GetInvitationCandidates.md +++ /dev/null @@ -1,43 +0,0 @@ -## Title: C_Club.GetInvitationCandidates - -**Content:** -Returns a list of players that you can send a request to a Battle.net club. Returns an empty list for Character based clubs. -`candidates = C_Club.GetInvitationCandidates(filter, maxResults, cursorPosition, allowFullMatch, clubId)` - -**Parameters:** -- `filter` - - *string?* - Optional filter string to narrow down the search. -- `maxResults` - - *number?* - Optional maximum number of results to return. -- `cursorPosition` - - *number?* - Optional cursor position for pagination. -- `allowFullMatch` - - *boolean?* - Optional boolean to allow full match. -- `clubId` - - *string* - The ID of the club to which you want to send invitations. - -**Returns:** -- `candidates` - - *ClubInvitationCandidateInfo* - A table containing information about each candidate. - - `Field` - - `Type` - - `Description` - - `memberId` - - *number* - The unique ID of the candidate. - - `name` - - *string* - The name of the candidate. - - `priority` - - *number* - The priority of the candidate. - - `status` - - *Enum.ClubInvitationCandidateStatus* - The status of the candidate. - -**Enum.ClubInvitationCandidateStatus:** -- `Value` -- `Field` -- `Description` - - `0` - - `Available` - The candidate is available for an invitation. - - `1` - - `InvitePending` - An invitation is already pending for the candidate. - - `2` - - `AlreadyMember` - The candidate is already a member of the club. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationInfo.md b/wiki-information/functions/C_Club.GetInvitationInfo.md deleted file mode 100644 index 3c3f8b4f..00000000 --- a/wiki-information/functions/C_Club.GetInvitationInfo.md +++ /dev/null @@ -1,183 +0,0 @@ -## Title: C_Club.GetInvitationInfo - -**Content:** -Needs summary. -`invitation = C_Club.GetInvitationInfo(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `invitation` - - *structure* - ClubSelfInvitationInfo (nilable) - - **ClubSelfInvitationInfo** - - `Field` - - `Type` - - `Description` - - `invitationId` - - *string* - - `club` - - *ClubInfo* - - `inviter` - - *ClubMemberInfo* - - `leaders` - - *ClubMemberInfo* - - - **ClubInfo** - - `Field` - - `Type` - - `Description` - - `clubId` - - *string* - - `name` - - *string* - - `shortName` - - *string?* - - `description` - - *string* - - `broadcast` - - *string* - - `clubType` - - *Enum.ClubType* - - `avatarId` - - *number* - - `memberCount` - - *number?* - - `favoriteTimeStamp` - - *number?* - - `joinTime` - - *number?* - - UNIX timestamp measured in microsecond precision. - - `socialQueueingEnabled` - - *boolean?* - - `crossFaction` - - *boolean?* - - Added in 9.2.5 - - - **Enum.ClubType** - - `Value` - - `Field` - - `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other - - - **ClubMemberInfo** - - `Field` - - `Type` - - `Description` - - `isSelf` - - *boolean* - - `memberId` - - *number* - - `name` - - *string?* - - name may be encoded as a Kstring - - `role` - - *Enum.ClubRoleIdentifier?* - - `presence` - - *Enum.ClubMemberPresence* - - `clubType` - - *Enum.ClubType?* - - `guid` - - *string?* - - `bnetAccountId` - - *number?* - - `memberNote` - - *string?* - - `officerNote` - - *string?* - - `classID` - - *number?* - - `race` - - *number?* - - `level` - - *number?* - - `zone` - - *string?* - - `achievementPoints` - - *number?* - - `profession1ID` - - *number?* - - `profession1Rank` - - *number?* - - `profession1Name` - - *string?* - - `profession2ID` - - *number?* - - `profession2Rank` - - *number?* - - `profession2Name` - - *string?* - - `lastOnlineYear` - - *number?* - - `lastOnlineMonth` - - *number?* - - `lastOnlineDay` - - *number?* - - `lastOnlineHour` - - *number?* - - `guildRank` - - *string?* - - `guildRankOrder` - - *number?* - - `isRemoteChat` - - *boolean?* - - `overallDungeonScore` - - *number?* - - Added in 9.1.0 - - `faction` - - *Enum.PvPFaction?* - - Added in 9.2.5 - - - **Enum.ClubRoleIdentifier** - - `Value` - - `Field` - - `Description` - - `1` - - Owner - - `2` - - Leader - - `3` - - Moderator - - `4` - - Member - - - **Enum.ClubMemberPresence** - - `Value` - - `Field` - - `Description` - - `0` - - Unknown - - `1` - - Online - - `2` - - OnlineMobile - - `3` - - Offline - - `4` - - Away - - `5` - - Busy - - - **Enum.ClubType** - - `Value` - - `Field` - - `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other - -**Description:** -Get info about a specific club the active player has been invited to. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationsForClub.md b/wiki-information/functions/C_Club.GetInvitationsForClub.md deleted file mode 100644 index 020db154..00000000 --- a/wiki-information/functions/C_Club.GetInvitationsForClub.md +++ /dev/null @@ -1,132 +0,0 @@ -## Title: C_Club.GetInvitationsForClub - -**Content:** -Needs summary. -`invitations = C_Club.GetInvitationsForClub(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `invitations` - - *structure* - ClubInvitationInfo - - `Field` - - `Type` - - `Description` - - `invitationId` - - *string* - - `isMyInvitation` - - *boolean* - - `invitee` - - *structure* ClubMemberInfo - - `ClubMemberInfo` - - `Field` - - `Type` - - `Description` - - `isSelf` - - *boolean* - - `memberId` - - *number* - - `name` - - *string?* - name may be encoded as a Kstring - - `role` - - *Enum.ClubRoleIdentifier?* - - `presence` - - *Enum.ClubMemberPresence* - - `clubType` - - *Enum.ClubType?* - - `guid` - - *string?* - - `bnetAccountId` - - *number?* - - `memberNote` - - *string?* - - `officerNote` - - *string?* - - `classID` - - *number?* - - `race` - - *number?* - - `level` - - *number?* - - `zone` - - *string?* - - `achievementPoints` - - *number?* - - `profession1ID` - - *number?* - - `profession1Rank` - - *number?* - - `profession1Name` - - *string?* - - `profession2ID` - - *number?* - - `profession2Rank` - - *number?* - - `profession2Name` - - *string?* - - `lastOnlineYear` - - *number?* - - `lastOnlineMonth` - - *number?* - - `lastOnlineDay` - - *number?* - - `lastOnlineHour` - - *number?* - - `guildRank` - - *string?* - - `guildRankOrder` - - *number?* - - `isRemoteChat` - - *boolean?* - - `overallDungeonScore` - - *number?* - Added in 9.1.0 - - `faction` - - *Enum.PvPFaction?* - Added in 9.2.5 - -**Enum.ClubRoleIdentifier:** -- `Value` -- `Field` -- `Description` - - `1` - - Owner - - `2` - - Leader - - `3` - - Moderator - - `4` - - Member - -**Enum.ClubMemberPresence:** -- `Value` -- `Field` -- `Description` - - `0` - - Unknown - - `1` - - Online - - `2` - - OnlineMobile - - `3` - - Offline - - `4` - - Away - - `5` - - Busy - -**Enum.ClubType:** -- `Value` -- `Field` -- `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other - -**Description:** -Get the pending invitations for this club. Call `RequestInvitationsForClub()` to retrieve invitations from the server. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetInvitationsForSelf.md b/wiki-information/functions/C_Club.GetInvitationsForSelf.md deleted file mode 100644 index f2cec9d4..00000000 --- a/wiki-information/functions/C_Club.GetInvitationsForSelf.md +++ /dev/null @@ -1,179 +0,0 @@ -## Title: C_Club.GetInvitationsForSelf - -**Content:** -Needs summary. -`invitations = C_Club.GetInvitationsForSelf()` - -**Returns:** -- `invitations` - - *structure* - ClubSelfInvitationInfo - - **ClubSelfInvitationInfo** - - `Field` - - `Type` - - `Description` - - `invitationId` - - *string* - - `club` - - *ClubInfo* - - `inviter` - - *ClubMemberInfo* - - `leaders` - - *ClubMemberInfo* - - - **ClubInfo** - - `Field` - - `Type` - - `Description` - - `clubId` - - *string* - - `name` - - *string* - - `shortName` - - *string?* - - `description` - - *string* - - `broadcast` - - *string* - - `clubType` - - *Enum.ClubType* - - `avatarId` - - *number* - - `memberCount` - - *number?* - - `favoriteTimeStamp` - - *number?* - - `joinTime` - - *number?* - - UNIX timestamp measured in microsecond precision. - - `socialQueueingEnabled` - - *boolean?* - - `crossFaction` - - *boolean?* - - Added in 9.2.5 - - - **Enum.ClubType** - - `Value` - - `Field` - - `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other - - - **ClubMemberInfo** - - `Field` - - `Type` - - `Description` - - `isSelf` - - *boolean* - - `memberId` - - *number* - - `name` - - *string?* - - name may be encoded as a Kstring - - `role` - - *Enum.ClubRoleIdentifier?* - - `presence` - - *Enum.ClubMemberPresence* - - `clubType` - - *Enum.ClubType?* - - `guid` - - *string?* - - `bnetAccountId` - - *number?* - - `memberNote` - - *string?* - - `officerNote` - - *string?* - - `classID` - - *number?* - - `race` - - *number?* - - `level` - - *number?* - - `zone` - - *string?* - - `achievementPoints` - - *number?* - - `profession1ID` - - *number?* - - `profession1Rank` - - *number?* - - `profession1Name` - - *string?* - - `profession2ID` - - *number?* - - `profession2Rank` - - *number?* - - `profession2Name` - - *string?* - - `lastOnlineYear` - - *number?* - - `lastOnlineMonth` - - *number?* - - `lastOnlineDay` - - *number?* - - `lastOnlineHour` - - *number?* - - `guildRank` - - *string?* - - `guildRankOrder` - - *number?* - - `isRemoteChat` - - *boolean?* - - `overallDungeonScore` - - *number?* - - Added in 9.1.0 - - `faction` - - *Enum.PvPFaction?* - - Added in 9.2.5 - - - **Enum.ClubRoleIdentifier** - - `Value` - - `Field` - - `Description` - - `1` - - Owner - - `2` - - Leader - - `3` - - Moderator - - `4` - - Member - - - **Enum.ClubMemberPresence** - - `Value` - - `Field` - - `Description` - - `0` - - Unknown - - `1` - - Online - - `2` - - OnlineMobile - - `3` - - Offline - - `4` - - Away - - `5` - - Busy - - - **Enum.ClubType** - - `Value` - - `Field` - - `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other - -**Description:** -These are the clubs the active player has been invited to. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMemberInfo.md b/wiki-information/functions/C_Club.GetMemberInfo.md deleted file mode 100644 index 8b5b26a3..00000000 --- a/wiki-information/functions/C_Club.GetMemberInfo.md +++ /dev/null @@ -1,122 +0,0 @@ -## Title: C_Club.GetMemberInfo - -**Content:** -Needs summary. -`info = C_Club.GetMemberInfo(clubId, memberId)` - -**Parameters:** -- `clubId` - - *string* -- `memberId` - - *number* - -**Returns:** -- `info` - - *structure* - ClubMemberInfo (nilable) - - `ClubMemberInfo` - - `Field` - - `Type` - - `Description` - - `isSelf` - - *boolean* - - `memberId` - - *number* - - `name` - - *string?* - name may be encoded as a Kstring - - `role` - - *Enum.ClubRoleIdentifier?* - - `presence` - - *Enum.ClubMemberPresence* - - `clubType` - - *Enum.ClubType?* - - `guid` - - *string?* - - `bnetAccountId` - - *number?* - - `memberNote` - - *string?* - - `officerNote` - - *string?* - - `classID` - - *number?* - - `race` - - *number?* - - `level` - - *number?* - - `zone` - - *string?* - - `achievementPoints` - - *number?* - - `profession1ID` - - *number?* - - `profession1Rank` - - *number?* - - `profession1Name` - - *string?* - - `profession2ID` - - *number?* - - `profession2Rank` - - *number?* - - `profession2Name` - - *string?* - - `lastOnlineYear` - - *number?* - - `lastOnlineMonth` - - *number?* - - `lastOnlineDay` - - *number?* - - `lastOnlineHour` - - *number?* - - `guildRank` - - *string?* - - `guildRankOrder` - - *number?* - - `isRemoteChat` - - *boolean?* - - `overallDungeonScore` - - *number?* - Added in 9.1.0 - - `faction` - - *Enum.PvPFaction?* - Added in 9.2.5 - -**Enum.ClubRoleIdentifier:** -- `Value` - - `Field` - - `Description` - - `1` - - Owner - - `2` - - Leader - - `3` - - Moderator - - `4` - - Member - -**Enum.ClubMemberPresence:** -- `Value` - - `Field` - - `Description` - - `0` - - Unknown - - `1` - - Online - - `2` - - OnlineMobile - - `3` - - Offline - - `4` - - Away - - `5` - - Busy - -**Enum.ClubType:** -- `Value` - - `Field` - - `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMemberInfoForSelf.md b/wiki-information/functions/C_Club.GetMemberInfoForSelf.md deleted file mode 100644 index bf8fab9d..00000000 --- a/wiki-information/functions/C_Club.GetMemberInfoForSelf.md +++ /dev/null @@ -1,123 +0,0 @@ -## Title: C_Club.GetMemberInfoForSelf - -**Content:** -Needs summary. -`info = C_Club.GetMemberInfoForSelf(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `info` - - *structure* - ClubMemberInfo (nilable) - - `ClubMemberInfo` - - `Field` - - `Type` - - `Description` - - `isSelf` - - *boolean* - - `memberId` - - *number* - - `name` - - *string?* - name may be encoded as a Kstring - - `role` - - *Enum.ClubRoleIdentifier?* - - `presence` - - *Enum.ClubMemberPresence* - - `clubType` - - *Enum.ClubType?* - - `guid` - - *string?* - - `bnetAccountId` - - *number?* - - `memberNote` - - *string?* - - `officerNote` - - *string?* - - `classID` - - *number?* - - `race` - - *number?* - - `level` - - *number?* - - `zone` - - *string?* - - `achievementPoints` - - *number?* - - `profession1ID` - - *number?* - - `profession1Rank` - - *number?* - - `profession1Name` - - *string?* - - `profession2ID` - - *number?* - - `profession2Rank` - - *number?* - - `profession2Name` - - *string?* - - `lastOnlineYear` - - *number?* - - `lastOnlineMonth` - - *number?* - - `lastOnlineDay` - - *number?* - - `lastOnlineHour` - - *number?* - - `guildRank` - - *string?* - - `guildRankOrder` - - *number?* - - `isRemoteChat` - - *boolean?* - - `overallDungeonScore` - - *number?* - - `faction` - - *Enum.PvPFaction?* (Added in 9.2.5) - -**Enum.ClubRoleIdentifier:** -- `Value` -- `Field` -- `Description` - - `1` - - Owner - - `2` - - Leader - - `3` - - Moderator - - `4` - - Member - -**Enum.ClubMemberPresence:** -- `Value` -- `Field` -- `Description` - - `0` - - Unknown - - `1` - - Online - - `2` - - OnlineMobile - - `3` - - Offline - - `4` - - Away - - `5` - - Busy - -**Enum.ClubType:** -- `Value` -- `Field` -- `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other - -**Description:** -Info for the logged-in user for this club. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessageInfo.md b/wiki-information/functions/C_Club.GetMessageInfo.md deleted file mode 100644 index 5a339cce..00000000 --- a/wiki-information/functions/C_Club.GetMessageInfo.md +++ /dev/null @@ -1,163 +0,0 @@ -## Title: C_Club.GetMessageInfo - -**Content:** -Needs summary. -`message = C_Club.GetMessageInfo(clubId, streamId, messageId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `messageId` - - *structure* - ClubMessageIdentifier - -**ClubMessageIdentifier:** -- `Field` -- `Type` -- `Description` -- `epoch` - - *number* - number of microseconds since the UNIX epoch -- `position` - - *number* - sort order for messages at the same time - -**Returns:** -- `message` - - *structure* - ClubMessageInfo (nilable) - -**ClubMessageInfo:** -- `Field` -- `Type` -- `Description` -- `messageId` - - *ClubMessageIdentifier* -- `content` - - *string* - Protected string -- `author` - - *ClubMemberInfo* -- `destroyer` - - *ClubMemberInfo?* - May be nil even if the message has been destroyed -- `destroyed` - - *boolean* -- `edited` - - *boolean* - -**ClubMessageIdentifier:** -- `Field` -- `Type` -- `Description` -- `epoch` - - *number* - number of microseconds since the UNIX epoch -- `position` - - *number* - sort order for messages at the same time - -**ClubMemberInfo:** -- `Field` -- `Type` -- `Description` -- `isSelf` - - *boolean* -- `memberId` - - *number* -- `name` - - *string?* - name may be encoded as a Kstring -- `role` - - *Enum.ClubRoleIdentifier?* -- `presence` - - *Enum.ClubMemberPresence* -- `clubType` - - *Enum.ClubType?* -- `guid` - - *string?* -- `bnetAccountId` - - *number?* -- `memberNote` - - *string?* -- `officerNote` - - *string?* -- `classID` - - *number?* -- `race` - - *number?* -- `level` - - *number?* -- `zone` - - *string?* -- `achievementPoints` - - *number?* -- `profession1ID` - - *number?* -- `profession1Rank` - - *number?* -- `profession1Name` - - *string?* -- `profession2ID` - - *number?* -- `profession2Rank` - - *number?* -- `profession2Name` - - *string?* -- `lastOnlineYear` - - *number?* -- `lastOnlineMonth` - - *number?* -- `lastOnlineDay` - - *number?* -- `lastOnlineHour` - - *number?* -- `guildRank` - - *string?* -- `guildRankOrder` - - *number?* -- `isRemoteChat` - - *boolean?* -- `overallDungeonScore` - - *number?* - Added in 9.1.0 -- `faction` - - *Enum.PvPFaction?* - Added in 9.2.5 - -**Enum.ClubRoleIdentifier:** -- `Value` -- `Field` -- `Description` -- `1` - - Owner -- `2` - - Leader -- `3` - - Moderator -- `4` - - Member - -**Enum.ClubMemberPresence:** -- `Value` -- `Field` -- `Description` -- `0` - - Unknown -- `1` - - Online -- `2` - - OnlineMobile -- `3` - - Offline -- `4` - - Away -- `5` - - Busy - -**Enum.ClubType:** -- `Value` -- `Field` -- `Description` -- `0` - - BattleNet -- `1` - - Character -- `2` - - Guild -- `3` - - Other - -**Description:** -Get info about a particular message. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessageRanges.md b/wiki-information/functions/C_Club.GetMessageRanges.md deleted file mode 100644 index 565d91b4..00000000 --- a/wiki-information/functions/C_Club.GetMessageRanges.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: C_Club.GetMessageRanges - -**Content:** -Needs summary. -`ranges = C_Club.GetMessageRanges(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Returns:** -- `ranges` - - *structure* - ClubMessageRange - - `ClubMessageRange` - - `Field` - - `Type` - - `Description` - - `oldestMessageId` - - *ClubMessageIdentifier* - - `newestMessageId` - - *ClubMessageIdentifier* - - `ClubMessageIdentifier` - - `Field` - - `Type` - - `Description` - - `epoch` - - *number* - number of microseconds since the UNIX epoch - - `position` - - *number* - sort order for messages at the same time - -**Description:** -Get the ranges of the messages currently downloaded. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessagesBefore.md b/wiki-information/functions/C_Club.GetMessagesBefore.md deleted file mode 100644 index 25ee95f9..00000000 --- a/wiki-information/functions/C_Club.GetMessagesBefore.md +++ /dev/null @@ -1,165 +0,0 @@ -## Title: C_Club.GetMessagesBefore - -**Content:** -Needs summary. -`messages = C_Club.GetMessagesBefore(clubId, streamId, newest, count)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `newest` - - *structure* - ClubMessageIdentifier -- `count` - - *number* - -**ClubMessageIdentifier:** -- `Field` -- `Type` -- `Description` -- `epoch` - - *number* - number of microseconds since the UNIX epoch -- `position` - - *number* - sort order for messages at the same time - -**Returns:** -- `messages` - - *structure* - ClubMessageInfo - -**ClubMessageInfo:** -- `Field` -- `Type` -- `Description` -- `messageId` - - *ClubMessageIdentifier* -- `content` - - *string* - Protected string -- `author` - - *ClubMemberInfo* -- `destroyer` - - *ClubMemberInfo?* - May be nil even if the message has been destroyed -- `destroyed` - - *boolean* -- `edited` - - *boolean* - -**ClubMessageIdentifier:** -- `Field` -- `Type` -- `Description` -- `epoch` - - *number* - number of microseconds since the UNIX epoch -- `position` - - *number* - sort order for messages at the same time - -**ClubMemberInfo:** -- `Field` -- `Type` -- `Description` -- `isSelf` - - *boolean* -- `memberId` - - *number* -- `name` - - *string?* - name may be encoded as a Kstring -- `role` - - *Enum.ClubRoleIdentifier?* -- `presence` - - *Enum.ClubMemberPresence* -- `clubType` - - *Enum.ClubType?* -- `guid` - - *string?* -- `bnetAccountId` - - *number?* -- `memberNote` - - *string?* -- `officerNote` - - *string?* -- `classID` - - *number?* -- `race` - - *number?* -- `level` - - *number?* -- `zone` - - *string?* -- `achievementPoints` - - *number?* -- `profession1ID` - - *number?* -- `profession1Rank` - - *number?* -- `profession1Name` - - *string?* -- `profession2ID` - - *number?* -- `profession2Rank` - - *number?* -- `profession2Name` - - *string?* -- `lastOnlineYear` - - *number?* -- `lastOnlineMonth` - - *number?* -- `lastOnlineDay` - - *number?* -- `lastOnlineHour` - - *number?* -- `guildRank` - - *string?* -- `guildRankOrder` - - *number?* -- `isRemoteChat` - - *boolean?* -- `overallDungeonScore` - - *number?* - Added in 9.1.0 -- `faction` - - *Enum.PvPFaction?* - Added in 9.2.5 - -**Enum.ClubRoleIdentifier:** -- `Value` -- `Field` -- `Description` -- `1` - - Owner -- `2` - - Leader -- `3` - - Moderator -- `4` - - Member - -**Enum.ClubMemberPresence:** -- `Value` -- `Field` -- `Description` -- `0` - - Unknown -- `1` - - Online -- `2` - - OnlineMobile -- `3` - - Offline -- `4` - - Away -- `5` - - Busy - -**Enum.ClubType:** -- `Value` -- `Field` -- `Description` -- `0` - - BattleNet -- `1` - - Character -- `2` - - Guild -- `3` - - Other - -**Description:** -Get downloaded messages before (and including) the specified messageId limited by count. These are filtered by ignored players. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetMessagesInRange.md b/wiki-information/functions/C_Club.GetMessagesInRange.md deleted file mode 100644 index 20b1529f..00000000 --- a/wiki-information/functions/C_Club.GetMessagesInRange.md +++ /dev/null @@ -1,159 +0,0 @@ -## Title: C_Club.GetMessagesInRange - -**Content:** -Get downloaded messages in the given range. -`messages = C_Club.GetMessagesInRange(clubId, streamId, oldest, newest)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `oldest` - - *ClubMessageIdentifier* -- `newest` - - *ClubMessageIdentifier* - -**ClubMessageIdentifier Fields:** -- `epoch` - - *number* - number of microseconds since the UNIX epoch -- `position` - - *number* - sort order for messages at the same time - -**Returns:** -- `messages` - - *ClubMessageInfo* - -**ClubMessageInfo Fields:** -- `messageId` - - *ClubMessageIdentifier* -- `content` - - *string* - Protected string -- `author` - - *ClubMemberInfo* -- `destroyer` - - *ClubMemberInfo?* - May be nil even if the message has been destroyed -- `destroyed` - - *boolean* -- `edited` - - *boolean* - -**ClubMessageIdentifier Fields:** -- `epoch` - - *number* - number of microseconds since the UNIX epoch -- `position` - - *number* - sort order for messages at the same time - -**ClubMemberInfo Fields:** -- `isSelf` - - *boolean* -- `memberId` - - *number* -- `name` - - *string?* - name may be encoded as a Kstring -- `role` - - *Enum.ClubRoleIdentifier?* -- `presence` - - *Enum.ClubMemberPresence* -- `clubType` - - *Enum.ClubType?* -- `guid` - - *string?* -- `bnetAccountId` - - *number?* -- `memberNote` - - *string?* -- `officerNote` - - *string?* -- `classID` - - *number?* -- `race` - - *number?* -- `level` - - *number?* -- `zone` - - *string?* -- `achievementPoints` - - *number?* -- `profession1ID` - - *number?* -- `profession1Rank` - - *number?* -- `profession1Name` - - *string?* -- `profession2ID` - - *number?* -- `profession2Rank` - - *number?* -- `profession2Name` - - *string?* -- `lastOnlineYear` - - *number?* -- `lastOnlineMonth` - - *number?* -- `lastOnlineDay` - - *number?* -- `lastOnlineHour` - - *number?* -- `guildRank` - - *string?* -- `guildRankOrder` - - *number?* -- `isRemoteChat` - - *boolean?* -- `overallDungeonScore` - - *number?* - Added in 9.1.0 -- `faction` - - *Enum.PvPFaction?* - Added in 9.2.5 - -**Enum.ClubRoleIdentifier Values:** -- `1` - - *Owner* -- `2` - - *Leader* -- `3` - - *Moderator* -- `4` - - *Member* - -**Enum.ClubMemberPresence Values:** -- `0` - - *Unknown* -- `1` - - *Online* -- `2` - - *OnlineMobile* -- `3` - - *Offline* -- `4` - - *Away* -- `5` - - *Busy* - -**Enum.ClubType Values:** -- `0` - - *BattleNet* -- `1` - - *Character* -- `2` - - *Guild* -- `3` - - *Other* - -**Description:** -The messages are filtered by ignored players. - -**Usage:** -Prints all guild messages from start to end. Only tested with a small guild. -```lua -local club = C_Club.GetGuildClubId() -local streams = C_Club.GetStreams(club) -local guildStream = streams.streamId -local ranges = C_Club.GetMessageRanges(club, guildStream) -local oldest, newest = ranges.oldestMessageId, ranges.newestMessageId -local messages = C_Club.GetMessagesInRange(club, guildStream, oldest, newest) -for _, v in pairs(messages) do - local timestamp = date("%Y-%m-%d %H:%M:%S", v.messageId.epoch/1e6) - print(format("%s %s: |cffdda0dd%s|r", timestamp, v.author.name, v.content)) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetStreamInfo.md b/wiki-information/functions/C_Club.GetStreamInfo.md deleted file mode 100644 index abe3d4d1..00000000 --- a/wiki-information/functions/C_Club.GetStreamInfo.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: C_Club.GetStreamInfo - -**Content:** -Needs summary. -`streamInfo = C_Club.GetStreamInfo(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Returns:** -- `streamInfo` - - *structure* - ClubStreamInfo (nilable) - - `ClubStreamInfo` - - `Field` - - `Type` - - `Description` - - `streamId` - - *string* - - `name` - - *string* - - `subject` - - *string* - - `leadersAndModeratorsOnly` - - *boolean* - - `streamType` - - *Enum.ClubStreamType* - - `creationTime` - - *number* - -**Enum.ClubStreamType:** -- `Value` -- `Field` -- `Description` -- `0` - - General -- `1` - - Guild -- `2` - - Officer -- `3` - - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetStreamViewMarker.md b/wiki-information/functions/C_Club.GetStreamViewMarker.md deleted file mode 100644 index 4e2eb7ce..00000000 --- a/wiki-information/functions/C_Club.GetStreamViewMarker.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Club.GetStreamViewMarker - -**Content:** -Needs summary. -`lastReadTime = C_Club.GetStreamViewMarker(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Returns:** -- `lastReadTime` - - *number?* - nil if stream view is at current \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetStreams.md b/wiki-information/functions/C_Club.GetStreams.md deleted file mode 100644 index 39c96235..00000000 --- a/wiki-information/functions/C_Club.GetStreams.md +++ /dev/null @@ -1,68 +0,0 @@ -## Title: C_Club.GetStreams - -**Content:** -Needs summary. -`streams = C_Club.GetStreams(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `streams` - - *structure* - ClubStreamInfo - - `ClubStreamInfo` - - `Field` - - `Type` - - `Description` - - `streamId` - - *string* - - `name` - - *string* - - `subject` - - *string* - - `leadersAndModeratorsOnly` - - *boolean* - - `streamType` - - *Enum.ClubStreamType* - - `creationTime` - - *number* - - - `Enum.ClubStreamType` - - `Value` - - `Field` - - `Description` - - `0` - - General - - `1` - - Guild - - `2` - - Officer - - `3` - - Other - -**Usage:** -Prints the streams/channels for your guild. -```lua -local club = C_Club.GetGuildClubId() -local streams = C_Club.GetStreams(club) -for _, v in pairs(streams) do - print(v.streamId, v.name) -end --- 1, "Guild" --- 2, "Officer" -``` - -Prints all guild messages from start to end. Only tested with a small guild. -```lua -local club = C_Club.GetGuildClubId() -local streams = C_Club.GetStreams(club) -local guildStream = streams.streamId -local ranges = C_Club.GetMessageRanges(club, guildStream) -local oldest, newest = ranges.oldestMessageId, ranges.newestMessageId -local messages = C_Club.GetMessagesInRange(club, guildStream, oldest, newest) -for _, v in pairs(messages) do - local timestamp = date("%Y-%m-%d %H:%M:%S", v.messageId.epoch/1e6) - print(format("%s %s: |cffdda0dd%s|r", timestamp, v.author.name, v.content)) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetSubscribedClubs.md b/wiki-information/functions/C_Club.GetSubscribedClubs.md deleted file mode 100644 index c77d6a8a..00000000 --- a/wiki-information/functions/C_Club.GetSubscribedClubs.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_Club.GetSubscribedClubs - -**Content:** -Needs summary. -`clubs = C_Club.GetSubscribedClubs()` - -**Returns:** -- `clubs` - - *structure* - ClubInfo - - `ClubInfo` - - `Field` - - `Type` - - `Description` - - `clubId` - - *string* - - `name` - - *string* - - `shortName` - - *string?* - - `description` - - *string* - - `broadcast` - - *string* - - `clubType` - - *Enum.ClubType* - - `avatarId` - - *number* - - `memberCount` - - *number?* - - `favoriteTimeStamp` - - *number?* - - `joinTime` - - *number?* - - UNIX timestamp measured in microsecond precision. - - `socialQueueingEnabled` - - *boolean?* - - `crossFaction` - - *boolean?* - - Added in 9.2.5 - -- `Enum.ClubType` - - `Value` - - `Field` - - `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other \ No newline at end of file diff --git a/wiki-information/functions/C_Club.GetTickets.md b/wiki-information/functions/C_Club.GetTickets.md deleted file mode 100644 index a73b58f2..00000000 --- a/wiki-information/functions/C_Club.GetTickets.md +++ /dev/null @@ -1,141 +0,0 @@ -## Title: C_Club.GetTickets - -**Content:** -Needs summary. -`tickets = C_Club.GetTickets(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `tickets` - - *structure* - ClubTicketInfo - - `ClubTicketInfo` - - `Field` - - `Type` - - `Description` - - `ticketId` - - *string* - - `allowedRedeemCount` - - *number* - - `currentRedeemCount` - - *number* - - `creationTime` - - *number* - Creation time in microseconds since the UNIX epoch - - `expirationTime` - - *number* - Expiration time in microseconds since the UNIX epoch - - `defaultStreamId` - - *string?* - - `creator` - - *ClubMemberInfo* - - `ClubMemberInfo` - - `Field` - - `Type` - - `Description` - - `isSelf` - - *boolean* - - `memberId` - - *number* - - `name` - - *string?* - name may be encoded as a Kstring - - `role` - - *Enum.ClubRoleIdentifier?* - - `presence` - - *Enum.ClubMemberPresence* - - `clubType` - - *Enum.ClubType?* - - `guid` - - *string?* - - `bnetAccountId` - - *number?* - - `memberNote` - - *string?* - - `officerNote` - - *string?* - - `classID` - - *number?* - - `race` - - *number?* - - `level` - - *number?* - - `zone` - - *string?* - - `achievementPoints` - - *number?* - - `profession1ID` - - *number?* - - `profession1Rank` - - *number?* - - `profession1Name` - - *string?* - - `profession2ID` - - *number?* - - `profession2Rank` - - *number?* - - `profession2Name` - - *string?* - - `lastOnlineYear` - - *number?* - - `lastOnlineMonth` - - *number?* - - `lastOnlineDay` - - *number?* - - `lastOnlineHour` - - *number?* - - `guildRank` - - *string?* - - `guildRankOrder` - - *number?* - - `isRemoteChat` - - *boolean?* - - `overallDungeonScore` - - *number?* - Added in 9.1.0 - - `faction` - - *Enum.PvPFaction?* - Added in 9.2.5 - -**Enum.ClubRoleIdentifier** -- `Value` -- `Field` -- `Description` - - `1` - - Owner - - `2` - - Leader - - `3` - - Moderator - - `4` - - Member - -**Enum.ClubMemberPresence** -- `Value` -- `Field` -- `Description` - - `0` - - Unknown - - `1` - - Online - - `2` - - OnlineMobile - - `3` - - Offline - - `4` - - Away - - `5` - - Busy - -**Enum.ClubType** -- `Value` -- `Field` -- `Description` - - `0` - - BattleNet - - `1` - - Character - - `2` - - Guild - - `3` - - Other - -**Description:** -Get the existing tickets for this club. Call `RequestTickets()` to retrieve tickets from the server. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsAccountMuted.md b/wiki-information/functions/C_Club.IsAccountMuted.md deleted file mode 100644 index 82ea260b..00000000 --- a/wiki-information/functions/C_Club.IsAccountMuted.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Club.IsAccountMuted - -**Content:** -Needs summary. -`accountMuted = C_Club.IsAccountMuted(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Returns:** -- `accountMuted` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsBeginningOfStream.md b/wiki-information/functions/C_Club.IsBeginningOfStream.md deleted file mode 100644 index 124c65d7..00000000 --- a/wiki-information/functions/C_Club.IsBeginningOfStream.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Club.IsBeginningOfStream - -**Content:** -Needs summary. -`isBeginningOfStream = C_Club.IsBeginningOfStream(clubId, streamId, messageId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `messageId` - - *structure* - ClubMessageIdentifier - - `ClubMessageIdentifier` - - `Field` - - `Type` - - `Description` - - `epoch` - - *number* - number of microseconds since the UNIX epoch - - `position` - - *number* - sort order for messages at the same time - -**Returns:** -- `isBeginningOfStream` - - *boolean* - -**Description:** -Returns whether the given message is the first message in the stream, taking into account ignored messages. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsEnabled.md b/wiki-information/functions/C_Club.IsEnabled.md deleted file mode 100644 index 388d68be..00000000 --- a/wiki-information/functions/C_Club.IsEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.IsEnabled - -**Content:** -Needs summary. -`clubsEnabled = C_Club.IsEnabled()` - -**Returns:** -- `clubsEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsRestricted.md b/wiki-information/functions/C_Club.IsRestricted.md deleted file mode 100644 index 949992fa..00000000 --- a/wiki-information/functions/C_Club.IsRestricted.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Club.IsRestricted - -**Content:** -Needs summary. -`restrictionReason = C_Club.IsRestricted()` - -**Returns:** -- `restrictionReason` - - *Enum.ClubRestrictionReason* - - `Value` - - `Field` - - `Description` - - `0` - - `None` - - `1` - - `Unavailable` \ No newline at end of file diff --git a/wiki-information/functions/C_Club.IsSubscribedToStream.md b/wiki-information/functions/C_Club.IsSubscribedToStream.md deleted file mode 100644 index 1dfa6fb5..00000000 --- a/wiki-information/functions/C_Club.IsSubscribedToStream.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Club.IsSubscribedToStream - -**Content:** -Needs summary. -`subscribed = C_Club.IsSubscribedToStream(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Returns:** -- `subscribed` - - *boolean* - -**Example Usage:** -This function can be used to check if a player is subscribed to a specific stream within a club. This is useful for addons that manage or display club activities and communications. - -**Addons:** -Large addons like "Community Manager" might use this function to manage and display the subscription status of various streams within a club, ensuring that users are kept up-to-date with the streams they are interested in. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.KickMember.md b/wiki-information/functions/C_Club.KickMember.md deleted file mode 100644 index 69cec949..00000000 --- a/wiki-information/functions/C_Club.KickMember.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Club.KickMember - -**Content:** -Needs summary. -`C_Club.KickMember(clubId, memberId)` - -**Parameters:** -- `clubId` - - *string* -- `memberId` - - *number* - -**Description:** -Check `kickableRoleIds` privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.LeaveClub.md b/wiki-information/functions/C_Club.LeaveClub.md deleted file mode 100644 index 26db1bb0..00000000 --- a/wiki-information/functions/C_Club.LeaveClub.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.LeaveClub - -**Content:** -Needs summary. -`C_Club.LeaveClub(clubId)` - -**Parameters:** -- `clubId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RedeemTicket.md b/wiki-information/functions/C_Club.RedeemTicket.md deleted file mode 100644 index 225fe3df..00000000 --- a/wiki-information/functions/C_Club.RedeemTicket.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.RedeemTicket - -**Content:** -Needs summary. -`C_Club.RedeemTicket(ticketId)` - -**Parameters:** -- `ticketId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestInvitationsForClub.md b/wiki-information/functions/C_Club.RequestInvitationsForClub.md deleted file mode 100644 index 9502d425..00000000 --- a/wiki-information/functions/C_Club.RequestInvitationsForClub.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Club.RequestInvitationsForClub - -**Content:** -Needs summary. -`C_Club.RequestInvitationsForClub(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Description:** -Request invitations for this club from the server. Check canGetInvitation privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestMoreMessagesBefore.md b/wiki-information/functions/C_Club.RequestMoreMessagesBefore.md deleted file mode 100644 index 1c25c606..00000000 --- a/wiki-information/functions/C_Club.RequestMoreMessagesBefore.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Club.RequestMoreMessagesBefore - -**Content:** -Needs summary. -`alreadyHasMessages = C_Club.RequestMoreMessagesBefore(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `messageId` - - *structure* - ClubMessageIdentifier (optional) - - `ClubMessageIdentifier` - - `Field` - - `Type` - - `Description` - - `epoch` - - *number* - number of microseconds since the UNIX epoch - - `position` - - *number* - sort order for messages at the same time - - `count` - - *number?* - -**Returns:** -- `alreadyHasMessages` - - *boolean* - -**Description:** -Call this when the user scrolls near the top of the message view, and more need to be displayed. The history will be downloaded backwards (newest to oldest). \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestTicket.md b/wiki-information/functions/C_Club.RequestTicket.md deleted file mode 100644 index c7e0ecfa..00000000 --- a/wiki-information/functions/C_Club.RequestTicket.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.RequestTicket - -**Content:** -Needs summary. -`C_Club.RequestTicket(ticketId)` - -**Parameters:** -- `ticketId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RequestTickets.md b/wiki-information/functions/C_Club.RequestTickets.md deleted file mode 100644 index 38a16783..00000000 --- a/wiki-information/functions/C_Club.RequestTickets.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Club.RequestTickets - -**Content:** -Needs summary. -`C_Club.RequestTickets(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Description:** -Request tickets from server. Check canGetTicket privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.RevokeInvitation.md b/wiki-information/functions/C_Club.RevokeInvitation.md deleted file mode 100644 index f5cd30ac..00000000 --- a/wiki-information/functions/C_Club.RevokeInvitation.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Club.RevokeInvitation - -**Content:** -Needs summary. -`C_Club.RevokeInvitation(clubId, memberId)` - -**Parameters:** -- `clubId` - - *string* -- `memberId` - - *number* - -**Description:** -Check `canRevokeOwnInvitation` or `canRevokeOtherInvitation`. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SendBattleTagFriendRequest.md b/wiki-information/functions/C_Club.SendBattleTagFriendRequest.md deleted file mode 100644 index 31278873..00000000 --- a/wiki-information/functions/C_Club.SendBattleTagFriendRequest.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Club.SendBattleTagFriendRequest - -**Content:** -Needs summary. -`C_Club.SendBattleTagFriendRequest(guildClubId, memberId)` - -**Parameters:** -- `guildClubId` - - *string* -- `memberId` - - *number* - -**Example Usage:** -This function can be used to send a BattleTag friend request to a member of a specific guild club. For instance, if you have the `guildClubId` and `memberId` of a player you wish to add as a friend, you can use this function to send the request programmatically. - -**Additional Information:** -This function is particularly useful for addons that manage social interactions within the game, such as guild management tools or social networking addons. It allows for automated friend requests based on certain criteria or events within the addon. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SendInvitation.md b/wiki-information/functions/C_Club.SendInvitation.md deleted file mode 100644 index 880dda75..00000000 --- a/wiki-information/functions/C_Club.SendInvitation.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Club.SendInvitation - -**Content:** -Needs summary. -`C_Club.SendInvitation(clubId, memberId)` - -**Parameters:** -- `clubId` - - *string* -- `memberId` - - *number* - -**Description:** -Check the canSendInvitation privilege. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SendMessage.md b/wiki-information/functions/C_Club.SendMessage.md deleted file mode 100644 index 84f0d9b0..00000000 --- a/wiki-information/functions/C_Club.SendMessage.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Club.SendMessage - -**Content:** -This is a protected function and will not work via addons. Used to send a message to a Club Stream. -`C_Club.SendMessage(clubId, streamId, message)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* -- `message` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md b/wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md deleted file mode 100644 index a02a1441..00000000 --- a/wiki-information/functions/C_Club.SetAutoAdvanceStreamViewMarker.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Club.SetAutoAdvanceStreamViewMarker - -**Content:** -Needs summary. -`C_Club.SetAutoAdvanceStreamViewMarker(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Description:** -Only one stream can be set for auto-advance at a time. Focused streams will have their view times advanced automatically. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetAvatarTexture.md b/wiki-information/functions/C_Club.SetAvatarTexture.md deleted file mode 100644 index d8cce8da..00000000 --- a/wiki-information/functions/C_Club.SetAvatarTexture.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Club.SetAvatarTexture - -**Content:** -Needs summary. -`C_Club.SetAvatarTexture(texture, avatarId, clubType)` - -**Parameters:** -- `texture` - - *table* -- `avatarId` - - *number* -- `clubType` - - *Enum.ClubType* - - `Enum.ClubType` - - **Value** - - **Field** - - **Description** - - `0` - - *BattleNet* - - `1` - - *Character* - - `2` - - *Guild* - - `3` - - *Other* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetClubMemberNote.md b/wiki-information/functions/C_Club.SetClubMemberNote.md deleted file mode 100644 index ebfabf0c..00000000 --- a/wiki-information/functions/C_Club.SetClubMemberNote.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Club.SetClubMemberNote - -**Content:** -Needs summary. -`C_Club.SetClubMemberNote(clubId, memberId, note)` - -**Parameters:** -- `clubId` - - *string* -- `memberId` - - *number* -- `note` - - *string* - -**Description:** -Check the `canSetOwnMemberNote` and `canSetOtherMemberNote` privileges. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetClubPresenceSubscription.md b/wiki-information/functions/C_Club.SetClubPresenceSubscription.md deleted file mode 100644 index 363fefb4..00000000 --- a/wiki-information/functions/C_Club.SetClubPresenceSubscription.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Club.SetClubPresenceSubscription - -**Content:** -Needs summary. -`C_Club.SetClubPresenceSubscription(clubId)` - -**Parameters:** -- `clubId` - - *string* - -**Description:** -You can only be subscribed to 0 or 1 clubs for presence. Subscribing to a new club automatically unsubscribes you from the existing subscription. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md b/wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md deleted file mode 100644 index 560366c9..00000000 --- a/wiki-information/functions/C_Club.SetClubStreamNotificationSettings.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Club.SetClubStreamNotificationSettings - -**Content:** -Needs summary. -`C_Club.SetClubStreamNotificationSettings(clubId, settings)` - -**Parameters:** -- `clubId` - - *string* -- `settings` - - *table* - -**Example Usage:** -This function can be used to set the notification settings for a specific club stream. For instance, if you want to mute notifications for a particular club stream, you can call this function with the appropriate settings. - -**Addons:** -Large addons like "ElvUI" or "WeakAuras" might use this function to manage club notifications based on user preferences. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetCommunityID.md b/wiki-information/functions/C_Club.SetCommunityID.md deleted file mode 100644 index 13adc5b6..00000000 --- a/wiki-information/functions/C_Club.SetCommunityID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.SetCommunityID - -**Content:** -Needs summary. -`C_Club.SetCommunityID(communityID)` - -**Parameters:** -- `communityID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetFavorite.md b/wiki-information/functions/C_Club.SetFavorite.md deleted file mode 100644 index 00092aca..00000000 --- a/wiki-information/functions/C_Club.SetFavorite.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Club.SetFavorite - -**Content:** -Needs summary. -`C_Club.SetFavorite(clubId, isFavorite)` - -**Parameters:** -- `clubId` - - *string* -- `isFavorite` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.SetSocialQueueingEnabled.md b/wiki-information/functions/C_Club.SetSocialQueueingEnabled.md deleted file mode 100644 index 69aa4def..00000000 --- a/wiki-information/functions/C_Club.SetSocialQueueingEnabled.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Club.SetSocialQueueingEnabled - -**Content:** -Needs summary. -`C_Club.SetSocialQueueingEnabled(clubId, enabled)` - -**Parameters:** -- `clubId` - - *string* -- `enabled` - - *boolean* - -**Description:** -This function is used to enable or disable social queueing for a specific club. Social queueing allows club members to see each other's activities and join them more easily. - -**Example Usage:** -```lua --- Enable social queueing for a club with a specific ID -local clubId = "1234567890" -local enabled = true -C_Club.SetSocialQueueingEnabled(clubId, enabled) -``` - -**Addons:** -Large addons like "ElvUI" and "WeakAuras" might use this function to manage social interactions and queueing within their custom interfaces, enhancing the social experience for users. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ShouldAllowClubType.md b/wiki-information/functions/C_Club.ShouldAllowClubType.md deleted file mode 100644 index ebd6703f..00000000 --- a/wiki-information/functions/C_Club.ShouldAllowClubType.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Club.ShouldAllowClubType - -**Content:** -Needs summary. -`clubTypeIsAllowed = C_Club.ShouldAllowClubType(clubType)` - -**Parameters:** -- `clubType` - - *Enum.ClubType* - - `0` - BattleNet - - `1` - Character - - `2` - Guild - - `3` - Other - -**Returns:** -- `clubTypeIsAllowed` - - *boolean* - -**Description:** -This function checks if a specific type of club is allowed. The `clubType` parameter is an enumeration that specifies the type of club, such as BattleNet, Character, Guild, or Other. The function returns a boolean indicating whether the specified club type is allowed. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.UnfocusAllStreams.md b/wiki-information/functions/C_Club.UnfocusAllStreams.md deleted file mode 100644 index 0ffe0e60..00000000 --- a/wiki-information/functions/C_Club.UnfocusAllStreams.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Club.UnfocusAllStreams - -**Content:** -Needs summary. -`C_Club.UnfocusAllStreams(unsubscribe)` - -**Parameters:** -- `unsubscribe` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Club.UnfocusStream.md b/wiki-information/functions/C_Club.UnfocusStream.md deleted file mode 100644 index 18cc88de..00000000 --- a/wiki-information/functions/C_Club.UnfocusStream.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_Club.UnfocusStream - -**Content:** -Needs summary. -`C_Club.UnfocusStream(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Description:** -This function is used to unfocus a specific stream within a club. This can be useful in scenarios where an addon or script needs to stop receiving updates or notifications from a particular stream in a club. - -**Example Usage:** -```lua --- Example of how to use C_Club.UnfocusStream -local clubId = "1234567890" -- Example club ID -local streamId = "0987654321" -- Example stream ID - --- Unfocus the specified stream -C_Club.UnfocusStream(clubId, streamId) -``` - -**Usage in Addons:** -Large addons that manage in-game communities or chat functionalities, such as "Community Manager" or "Guild Chat Enhancer," might use this function to manage the focus on different streams within a club, ensuring that the user interface remains responsive and relevant to the user's current context. \ No newline at end of file diff --git a/wiki-information/functions/C_Club.ValidateText.md b/wiki-information/functions/C_Club.ValidateText.md deleted file mode 100644 index 4ff7f378..00000000 --- a/wiki-information/functions/C_Club.ValidateText.md +++ /dev/null @@ -1,58 +0,0 @@ -## Title: C_Club.ValidateText - -**Content:** -Needs summary. -`result = C_Club.ValidateText(clubType, text, clubFieldType)` - -**Parameters:** -- `clubType` - - *Enum.ClubType* - - **Value** - - **Field** - - **Description** - - `0` - BattleNet - - `1` - Character - - `2` - Guild - - `3` - Other -- `text` - - *string* -- `clubFieldType` - - *Enum.ClubFieldType* - - **Value** - - **Field** - - **Description** - - `0` - ClubName - - `1` - ClubShortName - - `2` - ClubDescription - - `3` - ClubBroadcast - - `4` - ClubStreamName - - `5` - ClubStreamSubject - - `6` - NumTypes - -**Returns:** -- `result` - - *Enum.ValidateNameResult* - - **Value** - - **Field** - - **Description** - - `0` - Success - - `1` - Failure - - `2` - NoName - - `3` - TooShort - - `4` - TooLong - - `5` - InvalidCharacter - - `6` - MixedLanguages - - `7` - Profane - - `8` - Reserved - - `9` - InvalidApostrophe - - `10` - MultipleApostrophes - - `11` - ThreeConsecutive - - `12` - InvalidSpace - - `13` - ConsecutiveSpaces - - `14` - RussianConsecutiveSilentCharacters - - `15` - RussianSilentCharacterAtBeginningOrEnd - - `16` - DeclensionDoesn't Match BaseName - - `17` - SpacesDisallowed - -**Change Log:** -Added in 8.2.5 \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AddPlayerOverrideName.md b/wiki-information/functions/C_Commentator.AddPlayerOverrideName.md deleted file mode 100644 index d93c396e..00000000 --- a/wiki-information/functions/C_Commentator.AddPlayerOverrideName.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.AddPlayerOverrideName - -**Content:** -Needs summary. -`C_Commentator.AddPlayerOverrideName(playerName, overrideName)` - -**Parameters:** -- `playerName` - - *string* -- `overrideName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md b/wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md deleted file mode 100644 index cfc1ddc7..00000000 --- a/wiki-information/functions/C_Commentator.AddTrackedDefensiveAuras.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.AddTrackedDefensiveAuras - -**Content:** -Needs summary. -`C_Commentator.AddTrackedDefensiveAuras(spellIDs)` - -**Parameters:** -- `spellIDs` - - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md b/wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md deleted file mode 100644 index 3e951c4b..00000000 --- a/wiki-information/functions/C_Commentator.AddTrackedOffensiveAuras.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.AddTrackedOffensiveAuras - -**Content:** -Needs summary. -`C_Commentator.AddTrackedOffensiveAuras(spellIDs)` - -**Parameters:** -- `spellIDs` - - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AreTeamsSwapped.md b/wiki-information/functions/C_Commentator.AreTeamsSwapped.md deleted file mode 100644 index 63205200..00000000 --- a/wiki-information/functions/C_Commentator.AreTeamsSwapped.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.AreTeamsSwapped - -**Content:** -Needs summary. -`teamsAreSwapped = C_Commentator.AreTeamsSwapped()` - -**Returns:** -- `teamsAreSwapped` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AssignPlayerToTeam.md b/wiki-information/functions/C_Commentator.AssignPlayerToTeam.md deleted file mode 100644 index b69d8e6b..00000000 --- a/wiki-information/functions/C_Commentator.AssignPlayerToTeam.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.AssignPlayerToTeam - -**Content:** -Needs summary. -`C_Commentator.AssignPlayerToTeam(playerName, teamName)` - -**Parameters:** -- `playerName` - - *string* -- `teamName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AssignPlayersToTeam.md b/wiki-information/functions/C_Commentator.AssignPlayersToTeam.md deleted file mode 100644 index 9309a81c..00000000 --- a/wiki-information/functions/C_Commentator.AssignPlayersToTeam.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.AssignPlayersToTeam - -**Content:** -Needs summary. -`C_Commentator.AssignPlayersToTeam(playerName, teamName)` - -**Parameters:** -- `playerName` - - *string* -- `teamName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md b/wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md deleted file mode 100644 index baf723c3..00000000 --- a/wiki-information/functions/C_Commentator.AssignPlayersToTeamInCurrentInstance.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.AssignPlayersToTeamInCurrentInstance - -**Content:** -Needs summary. -`C_Commentator.AssignPlayersToTeamInCurrentInstance(teamIndex, teamName)` - -**Parameters:** -- `teamIndex` - - *number* -- `teamName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md b/wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md deleted file mode 100644 index 6427aa76..00000000 --- a/wiki-information/functions/C_Commentator.CanUseCommentatorCheats.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.CanUseCommentatorCheats - -**Content:** -Needs summary. -`canUseCommentatorCheats = C_Commentator.CanUseCommentatorCheats()` - -**Returns:** -- `canUseCommentatorCheats` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ClearCameraTarget.md b/wiki-information/functions/C_Commentator.ClearCameraTarget.md deleted file mode 100644 index 6ea4d921..00000000 --- a/wiki-information/functions/C_Commentator.ClearCameraTarget.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: C_Commentator.ClearCameraTarget - -**Content:** -Needs summary. -`C_Commentator.ClearCameraTarget()` - -**Description:** -This function is used to clear the current camera target in the World of Warcraft Commentator mode, which is often used in esports and live event broadcasts to control the camera view. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ClearFollowTarget.md b/wiki-information/functions/C_Commentator.ClearFollowTarget.md deleted file mode 100644 index e920294c..00000000 --- a/wiki-information/functions/C_Commentator.ClearFollowTarget.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.ClearFollowTarget - -**Content:** -Needs summary. -`C_Commentator.ClearFollowTarget()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ClearLookAtTarget.md b/wiki-information/functions/C_Commentator.ClearLookAtTarget.md deleted file mode 100644 index f208fb66..00000000 --- a/wiki-information/functions/C_Commentator.ClearLookAtTarget.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.ClearLookAtTarget - -**Content:** -Needs summary. -`C_Commentator.ClearLookAtTarget()` - -**Parameters:** -- `lookAtIndex` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.EnterInstance.md b/wiki-information/functions/C_Commentator.EnterInstance.md deleted file mode 100644 index 7f1505c6..00000000 --- a/wiki-information/functions/C_Commentator.EnterInstance.md +++ /dev/null @@ -1,6 +0,0 @@ -## Title: C_Commentator.EnterInstance - -**Content:** -Needs summary. -`C_Commentator.EnterInstance()` - diff --git a/wiki-information/functions/C_Commentator.ExitInstance.md b/wiki-information/functions/C_Commentator.ExitInstance.md deleted file mode 100644 index 6cb78df6..00000000 --- a/wiki-information/functions/C_Commentator.ExitInstance.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.ExitInstance - -**Content:** -Needs summary. -`C_Commentator.ExitInstance()` - -**Example Usage:** -This function can be used in scenarios where a commentator needs to exit an instance, such as during esports events or live streams where the commentator needs to leave the game instance they are currently in. - -**Addons:** -While specific large addons using this function are not well-documented, it is likely used in custom addons designed for esports events or live streaming tools that manage commentator actions within World of Warcraft. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FindSpectatedUnit.md b/wiki-information/functions/C_Commentator.FindSpectatedUnit.md deleted file mode 100644 index 03f38793..00000000 --- a/wiki-information/functions/C_Commentator.FindSpectatedUnit.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Commentator.FindSpectatedUnit - -**Content:** -Needs summary. -`playerIndex, teamIndex, isPet = C_Commentator.FindSpectatedUnit(unitToken)` - -**Parameters:** -- `unitToken` - - *string* - UnitId - -**Returns:** -- `playerIndex` - - *number* -- `teamIndex` - - *number* -- `isPet` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md b/wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md deleted file mode 100644 index e8a39ea7..00000000 --- a/wiki-information/functions/C_Commentator.FindTeamNameInCurrentInstance.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.FindTeamNameInCurrentInstance - -**Content:** -Needs summary. -`teamName = C_Commentator.FindTeamNameInCurrentInstance(teamIndex)` - -**Parameters:** -- `teamIndex` - - *number* - -**Returns:** -- `teamName` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md b/wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md deleted file mode 100644 index b024f79e..00000000 --- a/wiki-information/functions/C_Commentator.FindTeamNameInDirectory.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.FindTeamNameInDirectory - -**Content:** -Needs summary. -`teamName = C_Commentator.FindTeamNameInDirectory(playerNames)` - -**Parameters:** -- `playerNames` - - *string* - -**Returns:** -- `teamName` - - *string?* - -**Example Usage:** -This function can be used to find the team name associated with a list of player names in the commentator's directory. This can be particularly useful in esports or tournament settings where commentators need to quickly reference team information based on player names. - -**Addons:** -Large addons or tools used for esports commentary, such as those used in official Blizzard tournaments, might use this function to streamline the process of identifying teams and providing accurate commentary. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FlushCommentatorHistory.md b/wiki-information/functions/C_Commentator.FlushCommentatorHistory.md deleted file mode 100644 index 14473b14..00000000 --- a/wiki-information/functions/C_Commentator.FlushCommentatorHistory.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.FlushCommentatorHistory - -**Content:** -Needs summary. -`C_Commentator.FlushCommentatorHistory()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FollowPlayer.md b/wiki-information/functions/C_Commentator.FollowPlayer.md deleted file mode 100644 index 06fe9deb..00000000 --- a/wiki-information/functions/C_Commentator.FollowPlayer.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.FollowPlayer - -**Content:** -Needs summary. -`C_Commentator.FollowPlayer(factionIndex, playerIndex)` - -**Parameters:** -- `factionIndex` - - *number* -- `playerIndex` - - *number* -- `forceInstantTransition` - - *boolean?* - -**Example Usage:** -This function can be used in a World of Warcraft addon designed for commentators or broadcasters to follow a specific player in a PvP match or battleground. By specifying the faction and player index, the camera can be directed to follow the desired player, enhancing the viewing experience for spectators. - -**Addons Using This Function:** -Large addons like "ArenaLive" or "Gladius" might use this function to provide better camera control and player tracking during PvP events, making it easier for commentators to highlight key moments and player actions. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.FollowUnit.md b/wiki-information/functions/C_Commentator.FollowUnit.md deleted file mode 100644 index f311c0c3..00000000 --- a/wiki-information/functions/C_Commentator.FollowUnit.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.FollowUnit - -**Content:** -Needs summary. -`C_Commentator.FollowUnit(token)` - -**Parameters:** -- `token` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ForceFollowTransition.md b/wiki-information/functions/C_Commentator.ForceFollowTransition.md deleted file mode 100644 index 0d54e2ed..00000000 --- a/wiki-information/functions/C_Commentator.ForceFollowTransition.md +++ /dev/null @@ -1,6 +0,0 @@ -## Title: C_Commentator.ForceFollowTransition - -**Content:** -Needs summary. -`C_Commentator.ForceFollowTransition()` - diff --git a/wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md b/wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md deleted file mode 100644 index c4bc812a..00000000 --- a/wiki-information/functions/C_Commentator.GetAdditionalCameraWeight.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.GetAdditionalCameraWeight - -**Content:** -Needs summary. -`teamIndex, playerIndex = C_Commentator.GetAdditionalCameraWeight()` - -**Returns:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md b/wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md deleted file mode 100644 index aec70a51..00000000 --- a/wiki-information/functions/C_Commentator.GetAdditionalCameraWeightByToken.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.GetAdditionalCameraWeightByToken - -**Content:** -Needs summary. -`weight = C_Commentator.GetAdditionalCameraWeightByToken(unitToken)` - -**Parameters:** -- `unitToken` - - *string* : UnitId - -**Returns:** -- `weight` - - *number* - -**Example Usage:** -This function can be used in addons or scripts that need to adjust camera behavior based on specific units in a commentator mode, such as in esports broadcasting addons. - -**Addons:** -Large addons like "ArenaLive" or "Gladius" might use this function to enhance the spectator experience by dynamically adjusting camera weights based on the units being tracked. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md b/wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md deleted file mode 100644 index c2824550..00000000 --- a/wiki-information/functions/C_Commentator.GetAllPlayerOverrideNames.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Commentator.GetAllPlayerOverrideNames - -**Content:** -Needs summary. -`nameEntries = C_Commentator.GetAllPlayerOverrideNames()` - -**Returns:** -- `nameEntries` - - *structure* - NameOverrideEntry - - `Field` - - `Type` - - `Description` - - `originalName` - - *string* - - `overrideName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCamera.md b/wiki-information/functions/C_Commentator.GetCamera.md deleted file mode 100644 index 41bf50ad..00000000 --- a/wiki-information/functions/C_Commentator.GetCamera.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Commentator.GetCamera - -**Content:** -Needs summary. -`xPos, yPos, zPos, yaw, pitch, roll, fov = C_Commentator.GetCamera()` - -**Returns:** -- `xPos` - - *number* -- `yPos` - - *number* -- `zPos` - - *number* -- `yaw` - - *number* -- `pitch` - - *number* -- `roll` - - *number* -- `fov` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCameraCollision.md b/wiki-information/functions/C_Commentator.GetCameraCollision.md deleted file mode 100644 index f9a77bf3..00000000 --- a/wiki-information/functions/C_Commentator.GetCameraCollision.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetCameraCollision - -**Content:** -Needs summary. -`isColliding = C_Commentator.GetCameraCollision()` - -**Returns:** -- `isColliding` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCameraPosition.md b/wiki-information/functions/C_Commentator.GetCameraPosition.md deleted file mode 100644 index 582feb18..00000000 --- a/wiki-information/functions/C_Commentator.GetCameraPosition.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.GetCameraPosition - -**Content:** -Needs summary. -`xPos, yPos, zPos = C_Commentator.GetCameraPosition()` - -**Returns:** -- `xPos` - - *number* -- `yPos` - - *number* -- `zPos` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCommentatorHistory.md b/wiki-information/functions/C_Commentator.GetCommentatorHistory.md deleted file mode 100644 index bc09ac43..00000000 --- a/wiki-information/functions/C_Commentator.GetCommentatorHistory.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_Commentator.GetCommentatorHistory - -**Content:** -Needs summary. -`history = C_Commentator.GetCommentatorHistory()` - -**Returns:** -- `history` - - *CommentatorHistory* - - `Field` - - `Type` - - `Description` - - `series` - - *CommentatorSeries* - - `teamDirectory` - - *CommentatorTeamDirectoryEntry* - - `overrideNameDirectory` - - *CommentatorOverrideNameEntry* - -**CommentatorSeries** -- `Field` -- `Type` -- `Description` -- `teams` - - *CommentatorSeriesTeam* - -**CommentatorSeriesTeam** -- `Field` -- `Type` -- `Description` -- `name` - - *string* -- `score` - - *number* - -**CommentatorTeamDirectoryEntry** -- `Field` -- `Type` -- `Description` -- `playerName` - - *string* -- `teamName` - - *string* - -**CommentatorOverrideNameEntry** -- `Field` -- `Type` -- `Description` -- `originalName` - - *string* -- `newName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetCurrentMapID.md b/wiki-information/functions/C_Commentator.GetCurrentMapID.md deleted file mode 100644 index 15a3c43f..00000000 --- a/wiki-information/functions/C_Commentator.GetCurrentMapID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetCurrentMapID - -**Content:** -Needs summary. -`mapID = C_Commentator.GetCurrentMapID()` - -**Returns:** -- `mapID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetDampeningPercent.md b/wiki-information/functions/C_Commentator.GetDampeningPercent.md deleted file mode 100644 index f5f89b06..00000000 --- a/wiki-information/functions/C_Commentator.GetDampeningPercent.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetDampeningPercent - -**Content:** -Needs summary. -`percentage = C_Commentator.GetDampeningPercent()` - -**Returns:** -- `percentage` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md b/wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md deleted file mode 100644 index bb9acdea..00000000 --- a/wiki-information/functions/C_Commentator.GetDistanceBeforeForcedHorizontalConvergence.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetDistanceBeforeForcedHorizontalConvergence - -**Content:** -Needs summary. -`distance = C_Commentator.GetDistanceBeforeForcedHorizontalConvergence()` - -**Returns:** -- `distance` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md b/wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md deleted file mode 100644 index abf7b2d8..00000000 --- a/wiki-information/functions/C_Commentator.GetDurationToForceHorizontalConvergence.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetDurationToForceHorizontalConvergence - -**Content:** -Needs summary. -`ms = C_Commentator.GetDurationToForceHorizontalConvergence()` - -**Returns:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetExcludeDistance.md b/wiki-information/functions/C_Commentator.GetExcludeDistance.md deleted file mode 100644 index 344c28f2..00000000 --- a/wiki-information/functions/C_Commentator.GetExcludeDistance.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetExcludeDistance - -**Content:** -Needs summary. -`excludeDistance = C_Commentator.GetExcludeDistance()` - -**Returns:** -- `excludeDistance` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetHardlockWeight.md b/wiki-information/functions/C_Commentator.GetHardlockWeight.md deleted file mode 100644 index 3b260d3b..00000000 --- a/wiki-information/functions/C_Commentator.GetHardlockWeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetHardlockWeight - -**Content:** -Needs summary. -`weight = C_Commentator.GetHardlockWeight()` - -**Returns:** -- `weight` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md b/wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md deleted file mode 100644 index bea25f8e..00000000 --- a/wiki-information/functions/C_Commentator.GetHorizontalAngleThresholdToSmooth.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetHorizontalAngleThresholdToSmooth - -**Content:** -Needs summary. -`angle = C_Commentator.GetHorizontalAngleThresholdToSmooth()` - -**Returns:** -- `angle` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetIndirectSpellID.md b/wiki-information/functions/C_Commentator.GetIndirectSpellID.md deleted file mode 100644 index 42be1c1a..00000000 --- a/wiki-information/functions/C_Commentator.GetIndirectSpellID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.GetIndirectSpellID - -**Content:** -Needs summary. -`indirectSpellID = C_Commentator.GetIndirectSpellID(trackedSpellID)` - -**Parameters:** -- `trackedSpellID` - - *number* - -**Returns:** -- `indirectSpellID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetInstanceInfo.md b/wiki-information/functions/C_Commentator.GetInstanceInfo.md deleted file mode 100644 index 634f70ab..00000000 --- a/wiki-information/functions/C_Commentator.GetInstanceInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Commentator.GetInstanceInfo - -**Content:** -Needs summary. -`mapID, mapName, status, instanceIDLow, instanceIDHigh = C_Commentator.GetInstanceInfo(mapIndex, instanceIndex)` - -**Parameters:** -- `mapIndex` - - *number* -- `instanceIndex` - - *number* - -**Returns:** -- `mapID` - - *number* -- `mapName` - - *string?* -- `status` - - *number* -- `instanceIDLow` - - *number* -- `instanceIDHigh` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md b/wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md deleted file mode 100644 index 1992db91..00000000 --- a/wiki-information/functions/C_Commentator.GetLookAtLerpAmount.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetLookAtLerpAmount - -**Content:** -Needs summary. -`amount = C_Commentator.GetLookAtLerpAmount()` - -**Returns:** -- `amount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMapInfo.md b/wiki-information/functions/C_Commentator.GetMapInfo.md deleted file mode 100644 index 128b3db9..00000000 --- a/wiki-information/functions/C_Commentator.GetMapInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.GetMapInfo - -**Content:** -Needs summary. -`teamSize, minLevel, maxLevel, numInstances = C_Commentator.GetMapInfo(mapIndex)` - -**Parameters:** -- `mapIndex` - - *number* - -**Returns:** -- `teamSize` - - *number* -- `minLevel` - - *number* -- `maxLevel` - - *number* -- `numInstances` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMatchDuration.md b/wiki-information/functions/C_Commentator.GetMatchDuration.md deleted file mode 100644 index 1be6349a..00000000 --- a/wiki-information/functions/C_Commentator.GetMatchDuration.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMatchDuration - -**Content:** -Needs summary. -`seconds = C_Commentator.GetMatchDuration()` - -**Returns:** -- `seconds` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md b/wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md deleted file mode 100644 index f651274c..00000000 --- a/wiki-information/functions/C_Commentator.GetMaxNumPlayersPerTeam.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMaxNumPlayersPerTeam - -**Content:** -Needs summary. -`maxNumPlayersPerTeam = C_Commentator.GetMaxNumPlayersPerTeam()` - -**Returns:** -- `maxNumPlayersPerTeam` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMaxNumTeams.md b/wiki-information/functions/C_Commentator.GetMaxNumTeams.md deleted file mode 100644 index 583a2535..00000000 --- a/wiki-information/functions/C_Commentator.GetMaxNumTeams.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMaxNumTeams - -**Content:** -Needs summary. -`maxNumTeams = C_Commentator.GetMaxNumTeams()` - -**Returns:** -- `maxNumTeams` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMode.md b/wiki-information/functions/C_Commentator.GetMode.md deleted file mode 100644 index 9c76829b..00000000 --- a/wiki-information/functions/C_Commentator.GetMode.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMode - -**Content:** -Needs summary. -`commentatorMode = C_Commentator.GetMode()` - -**Returns:** -- `commentatorMode` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md b/wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md deleted file mode 100644 index 50932803..00000000 --- a/wiki-information/functions/C_Commentator.GetMsToHoldForHorizontalMovement.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMsToHoldForHorizontalMovement - -**Content:** -Needs summary. -`ms = C_Commentator.GetMsToHoldForHorizontalMovement()` - -**Returns:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md b/wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md deleted file mode 100644 index cae5c23f..00000000 --- a/wiki-information/functions/C_Commentator.GetMsToHoldForVerticalMovement.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMsToHoldForVerticalMovement - -**Content:** -Needs summary. -`ms = C_Commentator.GetMsToHoldForVerticalMovement()` - -**Returns:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md b/wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md deleted file mode 100644 index e9f3aed8..00000000 --- a/wiki-information/functions/C_Commentator.GetMsToSmoothHorizontalChange.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMsToSmoothHorizontalChange - -**Content:** -Needs summary. -`ms = C_Commentator.GetMsToSmoothHorizontalChange()` - -**Returns:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md b/wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md deleted file mode 100644 index 60ba08d0..00000000 --- a/wiki-information/functions/C_Commentator.GetMsToSmoothVerticalChange.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetMsToSmoothVerticalChange - -**Content:** -Needs summary. -`ms = C_Commentator.GetMsToSmoothVerticalChange()` - -**Returns:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetNumMaps.md b/wiki-information/functions/C_Commentator.GetNumMaps.md deleted file mode 100644 index 6b252f79..00000000 --- a/wiki-information/functions/C_Commentator.GetNumMaps.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetNumMaps - -**Content:** -Needs summary. -`numMaps = C_Commentator.GetNumMaps()` - -**Returns:** -- `numMaps` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetNumPlayers.md b/wiki-information/functions/C_Commentator.GetNumPlayers.md deleted file mode 100644 index 999b3b2a..00000000 --- a/wiki-information/functions/C_Commentator.GetNumPlayers.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.GetNumPlayers - -**Content:** -Needs summary. -`numPlayers = C_Commentator.GetNumPlayers(factionIndex)` - -**Parameters:** -- `factionIndex` - - *number* - -**Returns:** -- `numPlayers` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetOrCreateSeries.md b/wiki-information/functions/C_Commentator.GetOrCreateSeries.md deleted file mode 100644 index dd0eded7..00000000 --- a/wiki-information/functions/C_Commentator.GetOrCreateSeries.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Commentator.GetOrCreateSeries - -**Content:** -Needs summary. -`data = C_Commentator.GetOrCreateSeries(teamName1, teamName2)` - -**Parameters:** -- `teamName1` - - *string* -- `teamName2` - - *string* - -**Returns:** -- `data` - - *CommentatorSeries* - - `Field` - - `Type` - - `Description` - - `teams` - - *CommentatorSeriesTeam* - - `CommentatorSeriesTeam` - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `score` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md b/wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md deleted file mode 100644 index fbdd9537..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerAuraInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Commentator.GetPlayerAuraInfo - -**Content:** -Needs summary. -`startTime, duration, enable = C_Commentator.GetPlayerAuraInfo(teamIndex, playerIndex, spellID)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* -- `spellID` - - *number* - -**Returns:** -- `startTime` - - *number* -- `duration` - - *number* -- `enable` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md deleted file mode 100644 index a6e73e06..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerAuraInfoByUnit.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.GetPlayerAuraInfoByUnit - -**Content:** -Needs summary. -`startTime, duration, enable = C_Commentator.GetPlayerAuraInfoByUnit(token, spellID)` - -**Parameters:** -- `token` - - *string* -- `spellID` - - *number* - -**Returns:** -- `startTime` - - *number* -- `duration` - - *number* -- `enable` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md b/wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md deleted file mode 100644 index c8addaf4..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerCooldownInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Commentator.GetPlayerCooldownInfo - -**Content:** -Needs summary. -`startTime, duration, enable = C_Commentator.GetPlayerCooldownInfo(teamIndex, playerIndex, spellID)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* -- `spellID` - - *number* - -**Returns:** -- `startTime` - - *number* -- `duration` - - *number* -- `enable` - - *boolean* - -**Description:** -This function retrieves cooldown information for a specific player's spell in a commentator mode match. It can be used to track the cooldown status of abilities during esports events or other competitive matches. - -**Example Usage:** -An addon designed for commentators might use this function to display cooldown timers for players' abilities on the screen, providing viewers with real-time information about the availability of key spells. - -**Addons:** -Large addons like "ArenaLive" or "Gladius" might use this function to enhance the spectator experience by showing detailed cooldown information for players in PvP matches. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md deleted file mode 100644 index 0152d70c..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerCooldownInfoByUnit.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.GetPlayerCooldownInfoByUnit - -**Content:** -Needs summary. -`startTime, duration, enable = C_Commentator.GetPlayerCooldownInfoByUnit(unitToken, spellID)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `spellID` - - *number* - -**Returns:** -- `startTime` - - *number* -- `duration` - - *number* -- `enable` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md b/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md deleted file mode 100644 index 57a0168d..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.GetPlayerCrowdControlInfo - -**Content:** -Needs summary. -`spellID, expiration, duration = C_Commentator.GetPlayerCrowdControlInfo(teamIndex, playerIndex)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* - -**Returns:** -- `spellID` - - *number* -- `expiration` - - *number* -- `duration` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md deleted file mode 100644 index 2a48e088..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerCrowdControlInfoByUnit.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Commentator.GetPlayerCrowdControlInfoByUnit - -**Content:** -Needs summary. -`spellID, expiration, duration = C_Commentator.GetPlayerCrowdControlInfoByUnit(token)` - -**Parameters:** -- `token` - - *string* - -**Returns:** -- `spellID` - - *number* -- `expiration` - - *number* -- `duration` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerData.md b/wiki-information/functions/C_Commentator.GetPlayerData.md deleted file mode 100644 index 29e243dd..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerData.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: C_Commentator.GetPlayerData - -**Content:** -Needs summary. -`info = C_Commentator.GetPlayerData(teamIndex, playerIndex)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* - -**Returns:** -- `info` - - *CommentatorPlayerData?* - - `Field` - - `Type` - - `Description` - - `unitToken` - - *string* - - `name` - - *string* - - `faction` - - *number* - - `specialization` - - *number* - - `damageDone` - - *number* - - `damageTaken` - - *number* - - `healingDone` - - *number* - - `healingTaken` - - *number* - - `kills` - - *number* - - `deaths` - - *number* - - `soloShuffleRoundWins` - - *number* - - `soloShuffleRoundLosses` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md b/wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md deleted file mode 100644 index f62083f9..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerFlagInfo.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_Commentator.GetPlayerFlagInfo - -**Content:** -Needs summary. -`hasFlag = C_Commentator.GetPlayerFlagInfo(teamIndex, playerIndex)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* - -**Returns:** -- `hasFlag` - - *boolean* - -**Description:** -This function is used to determine if a player in a commentator's view has a flag. It is particularly useful in PvP scenarios, such as battlegrounds or arena matches, where tracking flag possession is crucial for commentary and analysis. - -**Example Usage:** -In a custom addon designed for eSports commentary, this function can be used to highlight players who are currently carrying a flag, allowing commentators to provide more detailed and engaging play-by-play analysis. - -**Addons Using This Function:** -- **Blizzard's Arena Spectator UI**: Utilizes this function to display flag status for players during arena matches, enhancing the viewing experience for spectators. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md deleted file mode 100644 index d973f07b..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerFlagInfoByUnit.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_Commentator.GetPlayerFlagInfoByUnit - -**Content:** -Needs summary. -`hasFlag = C_Commentator.GetPlayerFlagInfoByUnit(unitToken)` - -**Parameters:** -- `unitToken` - - *string* : UnitId - -**Returns:** -- `hasFlag` - - *boolean* - -**Description:** -This function checks if a player, identified by the `unitToken`, has a flag in a battleground or similar context. It returns `true` if the player has the flag, and `false` otherwise. - -**Example Usage:** -This function can be used in addons that track player status in battlegrounds, such as determining if a player is carrying the flag in Warsong Gulch. - -**Addons:** -Large PvP-oriented addons like "BattlegroundTargets" might use this function to provide real-time information about flag carriers to players. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerOverrideName.md b/wiki-information/functions/C_Commentator.GetPlayerOverrideName.md deleted file mode 100644 index ee4f8a4a..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerOverrideName.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.GetPlayerOverrideName - -**Content:** -Needs summary. -`overrideName = C_Commentator.GetPlayerOverrideName(originalName)` - -**Parameters:** -- `originalName` - - *string* - -**Returns:** -- `overrideName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md b/wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md deleted file mode 100644 index 980430d3..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerSpellCharges.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Commentator.GetPlayerSpellCharges - -**Content:** -Needs summary. -`charges, maxCharges, startTime, duration = C_Commentator.GetPlayerSpellCharges(teamIndex, playerIndex, spellID)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* -- `spellID` - - *number* - -**Returns:** -- `charges` - - *number* -- `maxCharges` - - *number* -- `startTime` - - *number* -- `duration` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md b/wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md deleted file mode 100644 index 6550b68f..00000000 --- a/wiki-information/functions/C_Commentator.GetPlayerSpellChargesByUnit.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Commentator.GetPlayerSpellChargesByUnit - -**Content:** -Needs summary. -`charges, maxCharges, startTime, duration = C_Commentator.GetPlayerSpellChargesByUnit(unitToken, spellID)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `spellID` - - *number* - -**Returns:** -- `charges` - - *number* -- `maxCharges` - - *number* -- `startTime` - - *number* -- `duration` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetPositionLerpAmount.md b/wiki-information/functions/C_Commentator.GetPositionLerpAmount.md deleted file mode 100644 index f0aceaa9..00000000 --- a/wiki-information/functions/C_Commentator.GetPositionLerpAmount.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetPositionLerpAmount - -**Content:** -Needs summary. -`amount = C_Commentator.GetPositionLerpAmount()` - -**Returns:** -- `amount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md b/wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md deleted file mode 100644 index 6301e0df..00000000 --- a/wiki-information/functions/C_Commentator.GetSmoothFollowTransitioning.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetSmoothFollowTransitioning - -**Content:** -Needs summary. -`enabled = C_Commentator.GetSmoothFollowTransitioning()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetSoftlockWeight.md b/wiki-information/functions/C_Commentator.GetSoftlockWeight.md deleted file mode 100644 index 6a562a6a..00000000 --- a/wiki-information/functions/C_Commentator.GetSoftlockWeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetSoftlockWeight - -**Content:** -Needs summary. -`weight = C_Commentator.GetSoftlockWeight()` - -**Returns:** -- `weight` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetSpeedFactor.md b/wiki-information/functions/C_Commentator.GetSpeedFactor.md deleted file mode 100644 index 452954cd..00000000 --- a/wiki-information/functions/C_Commentator.GetSpeedFactor.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Commentator.GetSpeedFactor - -**Content:** -Needs summary. -`factor = C_Commentator.GetSpeedFactor()` - -**Returns:** -- `factor` - - *number* - -**Example Usage:** -This function can be used in addons or scripts that need to retrieve the current speed factor in a commentator mode, which might be useful for adjusting the playback speed of events or animations in a World of Warcraft match commentary addon. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetStartLocation.md b/wiki-information/functions/C_Commentator.GetStartLocation.md deleted file mode 100644 index eb8d94d8..00000000 --- a/wiki-information/functions/C_Commentator.GetStartLocation.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.GetStartLocation - -**Content:** -Needs summary. -`pos = C_Commentator.GetStartLocation(instanceID)` - -**Parameters:** -- `instanceID` - - *number* - -**Returns:** -- `pos` - - *Vector3DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTeamColor.md b/wiki-information/functions/C_Commentator.GetTeamColor.md deleted file mode 100644 index 56246a58..00000000 --- a/wiki-information/functions/C_Commentator.GetTeamColor.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.GetTeamColor - -**Content:** -Needs summary. -`color = C_Commentator.GetTeamColor(teamIndex)` -`color = C_Commentator.GetTeamColorByUnit(unitToken)` - -**Parameters:** -- **GetTeamColor:** - - `teamIndex` - - *number* - -- **GetTeamColorByUnit:** - - `unitToken` - - *string* : UnitId - -**Returns:** -- `color` - - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTeamColorByUnit.md b/wiki-information/functions/C_Commentator.GetTeamColorByUnit.md deleted file mode 100644 index ac1164e5..00000000 --- a/wiki-information/functions/C_Commentator.GetTeamColorByUnit.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Commentator.GetTeamColor - -**Content:** -Needs summary. -`color = C_Commentator.GetTeamColor(teamIndex)` -`color = C_Commentator.GetTeamColorByUnit(unitToken)` - -**Parameters:** - -*GetTeamColor:* -- `teamIndex` - - *number* - -*GetTeamColorByUnit:* -- `unitToken` - - *string* : UnitId - -**Returns:** -- `color` - - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md b/wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md deleted file mode 100644 index 8647cf53..00000000 --- a/wiki-information/functions/C_Commentator.GetTimeLeftInMatch.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.GetTimeLeftInMatch - -**Content:** -Needs summary. -`timeLeft = C_Commentator.GetTimeLeftInMatch()` - -**Returns:** -- `timeLeft` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTrackedSpellID.md b/wiki-information/functions/C_Commentator.GetTrackedSpellID.md deleted file mode 100644 index 7858b178..00000000 --- a/wiki-information/functions/C_Commentator.GetTrackedSpellID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.GetTrackedSpellID - -**Content:** -Needs summary. -`trackedSpellID = C_Commentator.GetTrackedSpellID(indirectSpellID)` - -**Parameters:** -- `indirectSpellID` - - *number* - -**Returns:** -- `trackedSpellID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTrackedSpells.md b/wiki-information/functions/C_Commentator.GetTrackedSpells.md deleted file mode 100644 index 8b7eee01..00000000 --- a/wiki-information/functions/C_Commentator.GetTrackedSpells.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_Commentator.GetTrackedSpells - -**Content:** -Needs summary. -`spells = C_Commentator.GetTrackedSpells(teamIndex, playerIndex, category)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* -- `category` - - *number* - Enum.TrackedSpellCategory - - `Enum.TrackedSpellCategory` - - `Value` - - `Field` - - `Description` - - `0` - Offensive - - `1` - Defensive - - `2` - Debuff - - `3` - RacialAbility (Added in 10.0.5) - - `4` - Count - -**Returns:** -- `spells` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md b/wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md deleted file mode 100644 index ec026953..00000000 --- a/wiki-information/functions/C_Commentator.GetTrackedSpellsByUnit.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_Commentator.GetTrackedSpellsByUnit - -**Content:** -Needs summary. -`spells = C_Commentator.GetTrackedSpellsByUnit(unitToken, category)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `category` - - *Enum.TrackedSpellCategory* - - `Value` - - `Field` - - `Description` - - `0` - - Offensive - - `1` - - Defensive - - `2` - - Debuff - - `3` - - RacialAbility - - Added in 10.0.5 - - `4` - - Count - -**Returns:** -- `spells` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetUnitData.md b/wiki-information/functions/C_Commentator.GetUnitData.md deleted file mode 100644 index b4bb27bc..00000000 --- a/wiki-information/functions/C_Commentator.GetUnitData.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_Commentator.GetUnitData - -**Content:** -Needs summary. -`data = C_Commentator.GetUnitData(unitToken)` - -**Parameters:** -- `unitToken` - - *string* : UnitId - -**Returns:** -- `data` - - *CommentatorUnitData* - - `Field` - - `Type` - - `Description` - - `healthMax` - - *number* - - `health` - - *number* - - `absorbTotal` - - *number* - - `isDeadOrGhost` - - *boolean* - - `isFeignDeath` - - *boolean* - - `powerTypeToken` - - *string* - - `power` - - *number* - - `powerMax` - - *number* - -**Example Usage:** -This function can be used in addons or scripts that need to retrieve detailed information about a unit in a commentator mode, such as in esports broadcasting tools or advanced unit frame addons. - -**Addons Using This Function:** -- **Blizzard's Esports Tools**: Utilized for providing real-time data about units during esports events, allowing commentators to give detailed insights into the game state. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.GetWargameInfo.md b/wiki-information/functions/C_Commentator.GetWargameInfo.md deleted file mode 100644 index 7aa0307e..00000000 --- a/wiki-information/functions/C_Commentator.GetWargameInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.GetWargameInfo - -**Content:** -Needs summary. -`name, minPlayers, maxPlayers, isArena = C_Commentator.GetWargameInfo(listID)` - -**Parameters:** -- `listID` - - *number* - -**Returns:** -- `name` - - *string* -- `minPlayers` - - *number* -- `maxPlayers` - - *number* -- `isArena` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.HasTrackedAuras.md b/wiki-information/functions/C_Commentator.HasTrackedAuras.md deleted file mode 100644 index af7425b9..00000000 --- a/wiki-information/functions/C_Commentator.HasTrackedAuras.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Commentator.HasTrackedAuras - -**Content:** -Needs summary. -`hasOffensiveAura, hasDefensiveAura = C_Commentator.HasTrackedAuras(token)` - -**Parameters:** -- `token` - - *string* - -**Returns:** -- `hasOffensiveAura` - - *boolean* -- `hasDefensiveAura` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsSmartCameraLocked.md b/wiki-information/functions/C_Commentator.IsSmartCameraLocked.md deleted file mode 100644 index 7206f759..00000000 --- a/wiki-information/functions/C_Commentator.IsSmartCameraLocked.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.IsSmartCameraLocked - -**Content:** -Needs summary. -`isSmartCameraLocked = C_Commentator.IsSmartCameraLocked()` - -**Returns:** -- `isSmartCameraLocked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsSpectating.md b/wiki-information/functions/C_Commentator.IsSpectating.md deleted file mode 100644 index 85cd4e61..00000000 --- a/wiki-information/functions/C_Commentator.IsSpectating.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.IsSpectating - -**Content:** -Needs summary. -`isSpectating = C_Commentator.IsSpectating()` - -**Returns:** -- `isSpectating` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md b/wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md deleted file mode 100644 index 2a40f866..00000000 --- a/wiki-information/functions/C_Commentator.IsTrackedDefensiveAura.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.IsTrackedDefensiveAura - -**Content:** -Needs summary. -`isDefensiveTrigger = C_Commentator.IsTrackedDefensiveAura(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `isDefensiveTrigger` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md b/wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md deleted file mode 100644 index 1cdb00a6..00000000 --- a/wiki-information/functions/C_Commentator.IsTrackedOffensiveAura.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.IsTrackedOffensiveAura - -**Content:** -Needs summary. -`isOffensiveTrigger = C_Commentator.IsTrackedOffensiveAura(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `isOffensiveTrigger` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedSpell.md b/wiki-information/functions/C_Commentator.IsTrackedSpell.md deleted file mode 100644 index e7322618..00000000 --- a/wiki-information/functions/C_Commentator.IsTrackedSpell.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: C_Commentator.IsTrackedSpell - -**Content:** -Needs summary. -`isTracked = C_Commentator.IsTrackedSpell(teamIndex, playerIndex, spellID, category)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* -- `spellID` - - *number* -- `category` - - *number* - Enum.TrackedSpellCategory - - `Enum.TrackedSpellCategory` - - `Value` - - `Field` - - `Description` - - `0` - - Offensive - - `1` - - Defensive - - `2` - - Debuff - - `3` - - RacialAbility - - Added in 10.0.5 - - `4` - - Count - -**Returns:** -- `isTracked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md b/wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md deleted file mode 100644 index e57c2908..00000000 --- a/wiki-information/functions/C_Commentator.IsTrackedSpellByUnit.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_Commentator.IsTrackedSpellByUnit - -**Content:** -Needs summary. -`isTracked = C_Commentator.IsTrackedSpellByUnit(unitToken, spellID, category)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `spellID` - - *number* -- `category` - - *Enum.TrackedSpellCategory* - - `Value` - - `Field` - - `Description` - - `0` - - Offensive - - `1` - - Defensive - - `2` - - Debuff - - `3` - - RacialAbility - - Added in 10.0.5 - - `4` - - Count - -**Returns:** -- `isTracked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.IsUsingSmartCamera.md b/wiki-information/functions/C_Commentator.IsUsingSmartCamera.md deleted file mode 100644 index 638c41a4..00000000 --- a/wiki-information/functions/C_Commentator.IsUsingSmartCamera.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.IsUsingSmartCamera - -**Content:** -Needs summary. -`isUsingSmartCamera = C_Commentator.IsUsingSmartCamera()` - -**Returns:** -- `isUsingSmartCamera` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.LookAtPlayer.md b/wiki-information/functions/C_Commentator.LookAtPlayer.md deleted file mode 100644 index 4f36f110..00000000 --- a/wiki-information/functions/C_Commentator.LookAtPlayer.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.LookAtPlayer - -**Content:** -Needs summary. -`C_Commentator.LookAtPlayer(factionIndex, playerIndex)` - -**Parameters:** -- `factionIndex` - - *number* -- `playerIndex` - - *number* -- `lookAtIndex` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md b/wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md deleted file mode 100644 index caffbc83..00000000 --- a/wiki-information/functions/C_Commentator.RemoveAllOverrideNames.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Commentator.RemoveAllOverrideNames - -**Content:** -Needs summary. -`C_Commentator.RemoveAllOverrideNames()` - -**Description:** -This function is used to remove all override names that have been set for players in the commentator mode. This can be useful in eSports or other competitive settings where player names might need to be anonymized or replaced with aliases for the duration of a match or event. - -**Example Usage:** -In a custom addon designed for managing eSports events, you might use this function to clear all player name overrides at the end of a match to reset the display for the next game. - -```lua --- Clear all override names at the end of a match -C_Commentator.RemoveAllOverrideNames() -``` - -**Addons:** -While specific large addons using this function are not well-documented, it is likely to be used in custom addons designed for eSports event management or live streaming tools where commentator mode is utilized. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md b/wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md deleted file mode 100644 index 78274d93..00000000 --- a/wiki-information/functions/C_Commentator.RemovePlayerOverrideName.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.RemovePlayerOverrideName - -**Content:** -Needs summary. -`C_Commentator.RemovePlayerOverrideName(originalPlayerName)` - -**Parameters:** -- `originalPlayerName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md b/wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md deleted file mode 100644 index d7499165..00000000 --- a/wiki-information/functions/C_Commentator.RequestPlayerCooldownInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.RequestPlayerCooldownInfo - -**Content:** -Needs summary. -`C_Commentator.RequestPlayerCooldownInfo(teamIndex, playerIndex)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetFoVTarget.md b/wiki-information/functions/C_Commentator.ResetFoVTarget.md deleted file mode 100644 index 8f0edab2..00000000 --- a/wiki-information/functions/C_Commentator.ResetFoVTarget.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.ResetFoVTarget - -**Content:** -Needs summary. -`C_Commentator.ResetFoVTarget()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetSeriesScores.md b/wiki-information/functions/C_Commentator.ResetSeriesScores.md deleted file mode 100644 index dd4d4172..00000000 --- a/wiki-information/functions/C_Commentator.ResetSeriesScores.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.ResetSeriesScores - -**Content:** -Needs summary. -`C_Commentator.ResetSeriesScores(teamName1, teamName2)` - -**Parameters:** -- `teamName1` - - *string* -- `teamName2` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetSettings.md b/wiki-information/functions/C_Commentator.ResetSettings.md deleted file mode 100644 index 15413721..00000000 --- a/wiki-information/functions/C_Commentator.ResetSettings.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.ResetSettings - -**Content:** -Needs summary. -`C_Commentator.ResetSettings()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ResetTrackedAuras.md b/wiki-information/functions/C_Commentator.ResetTrackedAuras.md deleted file mode 100644 index 0f4ecd86..00000000 --- a/wiki-information/functions/C_Commentator.ResetTrackedAuras.md +++ /dev/null @@ -1,6 +0,0 @@ -## Title: C_Commentator.ResetTrackedAuras - -**Content:** -Needs summary. -`C_Commentator.ResetTrackedAuras()` - diff --git a/wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md b/wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md deleted file mode 100644 index 3b0cf8ec..00000000 --- a/wiki-information/functions/C_Commentator.SetAdditionalCameraWeight.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Commentator.SetAdditionalCameraWeight - -**Content:** -Needs summary. -`C_Commentator.SetAdditionalCameraWeight(teamIndex, playerIndex, weight)` - -**Parameters:** -- `teamIndex` - - *number* -- `playerIndex` - - *number* -- `weight` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md b/wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md deleted file mode 100644 index b0cf76de..00000000 --- a/wiki-information/functions/C_Commentator.SetAdditionalCameraWeightByToken.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Commentator.SetAdditionalCameraWeightByToken - -**Content:** -Needs summary. -`C_Commentator.SetAdditionalCameraWeightByToken(unitToken, weight)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `weight` - - *number* - -**Description:** -This function is used in the World of Warcraft API to set an additional camera weight for a specific unit identified by `unitToken`. The `weight` parameter determines the influence this unit has on the camera's behavior. - -**Example Usage:** -This function can be used in custom addons or scripts that manage camera behavior during events such as PvP tournaments or raids, where certain units (like bosses or key players) need to be focused on more frequently by the camera. - -**Addons:** -Large addons like "Blizzard Esports" might use this function to enhance the viewing experience during live broadcasts by dynamically adjusting the camera focus based on the importance of different units in the game. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetBlocklistedAuras.md b/wiki-information/functions/C_Commentator.SetBlocklistedAuras.md deleted file mode 100644 index e639cf45..00000000 --- a/wiki-information/functions/C_Commentator.SetBlocklistedAuras.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetBlocklistedAuras - -**Content:** -Needs summary. -`C_Commentator.SetBlocklistedAuras(spellIDs)` - -**Parameters:** -- `spellIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md b/wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md deleted file mode 100644 index 9c1d4db7..00000000 --- a/wiki-information/functions/C_Commentator.SetBlocklistedCooldowns.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Commentator.SetBlocklistedCooldowns - -**Content:** -Needs summary. -`C_Commentator.SetBlocklistedCooldowns(specID, spellIDs)` - -**Parameters:** -- `specID` - - *number* -- `spellIDs` - - *number* - -**Description:** -This function is used to set a list of cooldowns that should be blocklisted for a specific specialization in the commentator mode. This can be useful for customizing the display of cooldowns during esports events or other broadcasts where certain cooldowns should not be shown. - -**Example Usage:** -```lua --- Example: Blocklist specific cooldowns for a specialization -local specID = 71 -- Arms Warrior -local spellIDs = { 12345, 67890 } -- Example spell IDs to blocklist -C_Commentator.SetBlocklistedCooldowns(specID, spellIDs) -``` - -**Usage in Addons:** -This function is particularly useful in addons designed for esports broadcasting, such as the official Blizzard esports tools or third-party commentator addons. It allows broadcasters to control which cooldowns are visible to the audience, enhancing the viewing experience by hiding less relevant information. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCamera.md b/wiki-information/functions/C_Commentator.SetCamera.md deleted file mode 100644 index 95d75204..00000000 --- a/wiki-information/functions/C_Commentator.SetCamera.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Commentator.SetCamera - -**Content:** -Needs summary. -`C_Commentator.SetCamera(xPos, yPos, zPos, yaw, pitch, roll, fov)` - -**Parameters:** -- `xPos` - - *number* -- `yPos` - - *number* -- `zPos` - - *number* -- `yaw` - - *number* -- `pitch` - - *number* -- `roll` - - *number* -- `fov` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCameraCollision.md b/wiki-information/functions/C_Commentator.SetCameraCollision.md deleted file mode 100644 index 77e452ae..00000000 --- a/wiki-information/functions/C_Commentator.SetCameraCollision.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetCameraCollision - -**Content:** -Needs summary. -`C_Commentator.SetCameraCollision(collide)` - -**Parameters:** -- `collide` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCameraPosition.md b/wiki-information/functions/C_Commentator.SetCameraPosition.md deleted file mode 100644 index d4ede736..00000000 --- a/wiki-information/functions/C_Commentator.SetCameraPosition.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Commentator.SetCameraPosition - -**Content:** -Needs summary. -`C_Commentator.SetCameraPosition(xPos, yPos, zPos, snapToLocation)` - -**Parameters:** -- `xPos` - - *number* -- `yPos` - - *number* -- `zPos` - - *number* -- `snapToLocation` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCheatsEnabled.md b/wiki-information/functions/C_Commentator.SetCheatsEnabled.md deleted file mode 100644 index 462e9451..00000000 --- a/wiki-information/functions/C_Commentator.SetCheatsEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetCheatsEnabled - -**Content:** -Needs summary. -`C_Commentator.SetCheatsEnabled(enableCheats)` - -**Parameters:** -- `enableCheats` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetCommentatorHistory.md b/wiki-information/functions/C_Commentator.SetCommentatorHistory.md deleted file mode 100644 index 35f0c740..00000000 --- a/wiki-information/functions/C_Commentator.SetCommentatorHistory.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_Commentator.SetCommentatorHistory - -**Content:** -Needs summary. -`C_Commentator.SetCommentatorHistory(history)` - -**Parameters:** -- `history` - - *CommentatorHistory* - - `Field` - - `Type` - - `Description` - - `series` - - *CommentatorSeries* - - `teamDirectory` - - *CommentatorTeamDirectoryEntry* - - `overrideNameDirectory` - - *CommentatorOverrideNameEntry* - -**CommentatorSeries:** -- `Field` -- `Type` -- `Description` -- `teams` - - *CommentatorSeriesTeam* - -**CommentatorSeriesTeam:** -- `Field` -- `Type` -- `Description` -- `name` - - *string* -- `score` - - *number* - -**CommentatorTeamDirectoryEntry:** -- `Field` -- `Type` -- `Description` -- `playerName` - - *string* -- `teamName` - - *string* - -**CommentatorOverrideNameEntry:** -- `Field` -- `Type` -- `Description` -- `originalName` - - *string* -- `newName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md b/wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md deleted file mode 100644 index 0fea0385..00000000 --- a/wiki-information/functions/C_Commentator.SetDistanceBeforeForcedHorizontalConvergence.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetDistanceBeforeForcedHorizontalConvergence - -**Content:** -Needs summary. -`C_Commentator.SetDistanceBeforeForcedHorizontalConvergence(distance)` - -**Parameters:** -- `distance` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md b/wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md deleted file mode 100644 index ce9f1570..00000000 --- a/wiki-information/functions/C_Commentator.SetDurationToForceHorizontalConvergence.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetDurationToForceHorizontalConvergence - -**Content:** -Needs summary. -`C_Commentator.SetDurationToForceHorizontalConvergence(ms)` - -**Parameters:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetExcludeDistance.md b/wiki-information/functions/C_Commentator.SetExcludeDistance.md deleted file mode 100644 index 0acf8f03..00000000 --- a/wiki-information/functions/C_Commentator.SetExcludeDistance.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetExcludeDistance - -**Content:** -Needs summary. -`C_Commentator.SetExcludeDistance(excludeDistance)` - -**Parameters:** -- `excludeDistance` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md b/wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md deleted file mode 100644 index cd949ad9..00000000 --- a/wiki-information/functions/C_Commentator.SetFollowCameraSpeeds.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.SetFollowCameraSpeeds - -**Content:** -Needs summary. -`C_Commentator.SetFollowCameraSpeeds(elasticSpeed, minSpeed)` - -**Parameters:** -- `elasticSpeed` - - *number* -- `minSpeed` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetHardlockWeight.md b/wiki-information/functions/C_Commentator.SetHardlockWeight.md deleted file mode 100644 index e18dda1b..00000000 --- a/wiki-information/functions/C_Commentator.SetHardlockWeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetHardlockWeight - -**Content:** -Needs summary. -`C_Commentator.SetHardlockWeight(weight)` - -**Parameters:** -- `weight` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md b/wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md deleted file mode 100644 index 8c472be2..00000000 --- a/wiki-information/functions/C_Commentator.SetHorizontalAngleThresholdToSmooth.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetHorizontalAngleThresholdToSmooth - -**Content:** -Needs summary. -`C_Commentator.SetHorizontalAngleThresholdToSmooth(angle)` - -**Parameters:** -- `angle` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md b/wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md deleted file mode 100644 index 258bf593..00000000 --- a/wiki-information/functions/C_Commentator.SetLookAtLerpAmount.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetLookAtLerpAmount - -**Content:** -Needs summary. -`C_Commentator.SetLookAtLerpAmount(amount)` - -**Parameters:** -- `amount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md b/wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md deleted file mode 100644 index 9242baf0..00000000 --- a/wiki-information/functions/C_Commentator.SetMapAndInstanceIndex.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.SetMapAndInstanceIndex - -**Content:** -Needs summary. -`C_Commentator.SetMapAndInstanceIndex(mapIndex, instanceIndex)` - -**Parameters:** -- `mapIndex` - - *number* -- `instanceIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMouseDisabled.md b/wiki-information/functions/C_Commentator.SetMouseDisabled.md deleted file mode 100644 index 64c4262e..00000000 --- a/wiki-information/functions/C_Commentator.SetMouseDisabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetMouseDisabled - -**Content:** -Needs summary. -`C_Commentator.SetMouseDisabled(disabled)` - -**Parameters:** -- `disabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMoveSpeed.md b/wiki-information/functions/C_Commentator.SetMoveSpeed.md deleted file mode 100644 index 8a95c207..00000000 --- a/wiki-information/functions/C_Commentator.SetMoveSpeed.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetMoveSpeed - -**Content:** -Needs summary. -`C_Commentator.SetMoveSpeed(newSpeed)` - -**Parameters:** -- `newSpeed` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md b/wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md deleted file mode 100644 index 88d8c2ec..00000000 --- a/wiki-information/functions/C_Commentator.SetMsToHoldForHorizontalMovement.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetMsToHoldForHorizontalMovement - -**Content:** -Needs summary. -`C_Commentator.SetMsToHoldForHorizontalMovement(ms)` - -**Parameters:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md b/wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md deleted file mode 100644 index 12264b23..00000000 --- a/wiki-information/functions/C_Commentator.SetMsToHoldForVerticalMovement.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetMsToHoldForVerticalMovement - -**Content:** -Needs summary. -`C_Commentator.SetMsToHoldForVerticalMovement(ms)` - -**Parameters:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md b/wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md deleted file mode 100644 index c2fe1632..00000000 --- a/wiki-information/functions/C_Commentator.SetMsToSmoothHorizontalChange.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetMsToSmoothHorizontalChange - -**Content:** -Needs summary. -`C_Commentator.SetMsToSmoothHorizontalChange(ms)` - -**Parameters:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md b/wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md deleted file mode 100644 index 048651e6..00000000 --- a/wiki-information/functions/C_Commentator.SetMsToSmoothVerticalChange.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetMsToSmoothVerticalChange - -**Content:** -Needs summary. -`C_Commentator.SetMsToSmoothVerticalChange(ms)` - -**Parameters:** -- `ms` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetPositionLerpAmount.md b/wiki-information/functions/C_Commentator.SetPositionLerpAmount.md deleted file mode 100644 index 51e53c83..00000000 --- a/wiki-information/functions/C_Commentator.SetPositionLerpAmount.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetPositionLerpAmount - -**Content:** -Needs summary. -`C_Commentator.SetPositionLerpAmount(amount)` - -**Parameters:** -- `amount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md b/wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md deleted file mode 100644 index 8e634289..00000000 --- a/wiki-information/functions/C_Commentator.SetRequestedDebuffCooldowns.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Commentator.SetRequestedDebuffCooldowns - -**Content:** -Needs summary. -`C_Commentator.SetRequestedDebuffCooldowns(specID, spellIDs)` - -**Parameters:** -- `specID` - - *number* -- `spellIDs` - - *table* - diff --git a/wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md b/wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md deleted file mode 100644 index 4bd4a7de..00000000 --- a/wiki-information/functions/C_Commentator.SetRequestedDefensiveCooldowns.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.SetRequestedDefensiveCooldowns - -**Content:** -Needs summary. -`C_Commentator.SetRequestedDefensiveCooldowns(specID, spellIDs)` - -**Parameters:** -- `specID` - - *number* -- `spellIDs` - - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md b/wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md deleted file mode 100644 index 19c6a057..00000000 --- a/wiki-information/functions/C_Commentator.SetRequestedOffensiveCooldowns.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Commentator.SetRequestedOffensiveCooldowns - -**Content:** -Needs summary. -`C_Commentator.SetRequestedOffensiveCooldowns(specID, spellIDs)` - -**Parameters:** -- `specID` - - *number* -- `spellIDs` - - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSeriesScore.md b/wiki-information/functions/C_Commentator.SetSeriesScore.md deleted file mode 100644 index 00b8b9eb..00000000 --- a/wiki-information/functions/C_Commentator.SetSeriesScore.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Commentator.SetSeriesScore - -**Content:** -Needs summary. -`C_Commentator.SetSeriesScore(teamName1, teamName2, scoringTeamName, score)` - -**Parameters:** -- `teamName1` - - *string* -- `teamName2` - - *string* -- `scoringTeamName` - - *string* -- `score` - - *number* - -**Example Usage:** -This function can be used in custom addons or scripts designed for managing or displaying scores in a series of matches, such as in esports tournaments or PvP events. - -**Addons:** -While specific large addons using this function are not well-documented, it is likely to be used in addons related to esports or competitive gaming where match series scores need to be tracked and displayed. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSeriesScores.md b/wiki-information/functions/C_Commentator.SetSeriesScores.md deleted file mode 100644 index 9ce7d6f6..00000000 --- a/wiki-information/functions/C_Commentator.SetSeriesScores.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Commentator.SetSeriesScores - -**Content:** -Needs summary. -`C_Commentator.SetSeriesScores(teamName1, teamName2, score1, score2)` - -**Parameters:** -- `teamName1` - - *string* -- `teamName2` - - *string* -- `score1` - - *number* -- `score2` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSmartCameraLocked.md b/wiki-information/functions/C_Commentator.SetSmartCameraLocked.md deleted file mode 100644 index 9f69ee2b..00000000 --- a/wiki-information/functions/C_Commentator.SetSmartCameraLocked.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetSmartCameraLocked - -**Content:** -Needs summary. -`C_Commentator.SetSmartCameraLocked(locked)` - -**Parameters:** -- `locked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md b/wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md deleted file mode 100644 index f3ee3056..00000000 --- a/wiki-information/functions/C_Commentator.SetSmoothFollowTransitioning.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetSmoothFollowTransitioning - -**Content:** -Needs summary. -`C_Commentator.SetSmoothFollowTransitioning(enabled)` - -**Parameters:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSoftlockWeight.md b/wiki-information/functions/C_Commentator.SetSoftlockWeight.md deleted file mode 100644 index 16352eb7..00000000 --- a/wiki-information/functions/C_Commentator.SetSoftlockWeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetSoftlockWeight - -**Content:** -Needs summary. -`C_Commentator.SetSoftlockWeight(weight)` - -**Parameters:** -- `weight` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetSpeedFactor.md b/wiki-information/functions/C_Commentator.SetSpeedFactor.md deleted file mode 100644 index 1f4d7d66..00000000 --- a/wiki-information/functions/C_Commentator.SetSpeedFactor.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetSpeedFactor - -**Content:** -Needs summary. -`C_Commentator.SetSpeedFactor(factor)` - -**Parameters:** -- `factor` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetTargetHeightOffset.md b/wiki-information/functions/C_Commentator.SetTargetHeightOffset.md deleted file mode 100644 index 153aa353..00000000 --- a/wiki-information/functions/C_Commentator.SetTargetHeightOffset.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetTargetHeightOffset - -**Content:** -Needs summary. -`C_Commentator.SetTargetHeightOffset(offset)` - -**Parameters:** -- `offset` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SetUseSmartCamera.md b/wiki-information/functions/C_Commentator.SetUseSmartCamera.md deleted file mode 100644 index 20820bde..00000000 --- a/wiki-information/functions/C_Commentator.SetUseSmartCamera.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.SetUseSmartCamera - -**Content:** -Needs summary. -`C_Commentator.SetUseSmartCamera(useSmartCamera)` - -**Parameters:** -- `useSmartCamera` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md b/wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md deleted file mode 100644 index ce935349..00000000 --- a/wiki-information/functions/C_Commentator.SnapCameraLookAtPoint.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_Commentator.SnapCameraLookAtPoint - -**Content:** -Needs summary. -`C_Commentator.SnapCameraLookAtPoint()` - -**Description:** -This function is part of the Commentator API, which is used primarily for managing camera views and other aspects of the spectator mode in World of Warcraft. The `SnapCameraLookAtPoint` function likely snaps the camera to look at a specific point, although the exact details are not provided in the summary. - -**Example Usage:** -This function can be used in custom spectator modes or addons that manage camera views during PvP tournaments or other events where a commentator's perspective is needed. - -**Addons:** -Large addons like the WoW Esports API might use this function to control camera angles and provide better viewing experiences during live streams of competitive events. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.StartWargame.md b/wiki-information/functions/C_Commentator.StartWargame.md deleted file mode 100644 index 8d396025..00000000 --- a/wiki-information/functions/C_Commentator.StartWargame.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Commentator.StartWargame - -**Content:** -Needs summary. -`C_Commentator.StartWargame(listID, teamSize, tournamentRules, teamOneCaptain, teamTwoCaptain)` - -**Parameters:** -- `listID` - - *number* -- `teamSize` - - *number* -- `tournamentRules` - - *boolean* -- `teamOneCaptain` - - *string* -- `teamTwoCaptain` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.SwapTeamSides.md b/wiki-information/functions/C_Commentator.SwapTeamSides.md deleted file mode 100644 index 16a99bd5..00000000 --- a/wiki-information/functions/C_Commentator.SwapTeamSides.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Commentator.SwapTeamSides - -**Content:** -Needs summary. -`C_Commentator.SwapTeamSides()` - -**Description:** -This function is used in the World of Warcraft API to swap the sides of the teams in a commentator's view. This can be particularly useful in esports broadcasting or in-game events where the commentator needs to switch perspectives for better clarity or to follow the action more effectively. - -**Example Usage:** -In a custom addon designed for esports commentary, you might use this function to dynamically change the view of the teams during a live broadcast. - -```lua --- Example usage in a custom addon -if event == "SWAP_SIDES" then - C_Commentator.SwapTeamSides() -end -``` - -**Addons Using This Function:** -- **WoW Esports Addon**: This addon might use `C_Commentator.SwapTeamSides` to enhance the viewing experience by allowing commentators to switch team perspectives seamlessly during live matches. \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ToggleCheats.md b/wiki-information/functions/C_Commentator.ToggleCheats.md deleted file mode 100644 index 96a1c6ce..00000000 --- a/wiki-information/functions/C_Commentator.ToggleCheats.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.ToggleCheats - -**Content:** -Needs summary. -`C_Commentator.ToggleCheats()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.UpdateMapInfo.md b/wiki-information/functions/C_Commentator.UpdateMapInfo.md deleted file mode 100644 index 1ba84d41..00000000 --- a/wiki-information/functions/C_Commentator.UpdateMapInfo.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Commentator.UpdateMapInfo - -**Content:** -Needs summary. -`C_Commentator.UpdateMapInfo()` - -**Parameters:** -- `targetPlayer` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.UpdatePlayerInfo.md b/wiki-information/functions/C_Commentator.UpdatePlayerInfo.md deleted file mode 100644 index af9f6899..00000000 --- a/wiki-information/functions/C_Commentator.UpdatePlayerInfo.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.UpdatePlayerInfo - -**Content:** -Needs summary. -`C_Commentator.UpdatePlayerInfo()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ZoomIn.md b/wiki-information/functions/C_Commentator.ZoomIn.md deleted file mode 100644 index d15fd8a3..00000000 --- a/wiki-information/functions/C_Commentator.ZoomIn.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.ZoomIn - -**Content:** -Needs summary. -`C_Commentator.ZoomIn()` \ No newline at end of file diff --git a/wiki-information/functions/C_Commentator.ZoomOut.md b/wiki-information/functions/C_Commentator.ZoomOut.md deleted file mode 100644 index ef6c049c..00000000 --- a/wiki-information/functions/C_Commentator.ZoomOut.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Commentator.ZoomOut - -**Content:** -Needs summary. -`C_Commentator.ZoomOut()` \ No newline at end of file diff --git a/wiki-information/functions/C_Console.GetAllCommands.md b/wiki-information/functions/C_Console.GetAllCommands.md deleted file mode 100644 index da5aedfc..00000000 --- a/wiki-information/functions/C_Console.GetAllCommands.md +++ /dev/null @@ -1,76 +0,0 @@ -## Title: C_Console.GetAllCommands - -**Content:** -Returns all console variables and commands. -`commands = C_Console.GetAllCommands()` - -**Returns:** -- `commands` - - *ConsoleCommandInfo* - - `Field` - - `Type` - - `Description` - - `command` - - *string* - - `help` - - *string* - - `category` - - *Enum.ConsoleCategory* - - `commandType` - - *Enum.ConsoleCommandType* - - `scriptContents` - - *string* - - `scriptParameters` - - *string* - -- `Enum.ConsoleCategory` - - `Value` - - `Field` - - `Description` - - `0` - - Debug - - `1` - - Graphics - - `2` - - Console - - `3` - - Combat - - `4` - - Game - - `5` - - Default - - `6` - - Net - - `7` - - Sound - - `8` - - Gm - - `9` - - Reveal - - `10` - - None - -- `Enum.ConsoleCommandType` - - `Value` - - `Field` - - `Description` - - `0` - - Cvar - - `1` - - Command - - `2` - - Macro - - `3` - - Script - -**Description:** -Not all cvars are returned yet on initial login until VARIABLES_LOADED, e.g. AutoPushSpellToActionBar. - -**Usage:** -Prints all cvars and commands. -```lua -/run for k, v in pairs(C_Console.GetAllCommands()) do print(k, v.command) end -``` - -**Reference:** -[AdvancedInterfaceOptions Issue #38](https://github.com/Stanzilla/AdvancedInterfaceOptions/issues/38) \ No newline at end of file diff --git a/wiki-information/functions/C_Console.GetColorFromType.md b/wiki-information/functions/C_Console.GetColorFromType.md deleted file mode 100644 index cb3ddd7d..00000000 --- a/wiki-information/functions/C_Console.GetColorFromType.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Console.GetColorFromType - -**Content:** -Returns color info for a color type. -`color = C_Console.GetColorFromType(colorType)` - -**Parameters:** -- `colorType` - - *Enum.ConsoleColorType* - - `Value` - - `Field` - - `Description` - - `0` - DefaultColor - - `1` - InputColor - - `2` - EchoColor - - `3` - ErrorColor - - `4` - WarningColor - - `5` - GlobalColor - - `6` - AdminColor - - `7` - HighlightColor - - `8` - BackgroundColor - - `9` - ClickbufferColor - - `10` - PrivateColor - - `11` - DefaultGreen - -**Returns:** -- `color` - - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Console.GetFontHeight.md b/wiki-information/functions/C_Console.GetFontHeight.md deleted file mode 100644 index 99493b2e..00000000 --- a/wiki-information/functions/C_Console.GetFontHeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Console.GetFontHeight - -**Content:** -Returns the console's currently used font height. -`fontHeightInPixels = C_Console.GetFontHeight()` - -**Returns:** -- `fontHeightInPixels` - - *number* - The height of the font in pixels used by the console. \ No newline at end of file diff --git a/wiki-information/functions/C_Console.PrintAllMatchingCommands.md b/wiki-information/functions/C_Console.PrintAllMatchingCommands.md deleted file mode 100644 index bc939baf..00000000 --- a/wiki-information/functions/C_Console.PrintAllMatchingCommands.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Console.PrintAllMatchingCommands - -**Content:** -Prints all matching console commands. -`C_Console.PrintAllMatchingCommands(partialCommandText)` - -**Parameters:** -- `partialCommandText` - - *string* - -**Example Usage:** -This function can be used to find all console commands that match a given partial text. For instance, if you are unsure of the full command but know it starts with "reload", you can use this function to list all commands that start with "reload". - -**Addons:** -This function is often used in debugging tools and development addons to help developers quickly find and test console commands. \ No newline at end of file diff --git a/wiki-information/functions/C_Console.SetFontHeight.md b/wiki-information/functions/C_Console.SetFontHeight.md deleted file mode 100644 index 9e991a0e..00000000 --- a/wiki-information/functions/C_Console.SetFontHeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Console.SetFontHeight - -**Content:** -Sets the console's font height. -`C_Console.SetFontHeight(fontHeightInPixels)` - -**Parameters:** -- `fontHeightInPixels` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md b/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md deleted file mode 100644 index f3f7ae83..00000000 --- a/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByID.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ConsoleScriptCollection.GetCollectionDataByID - -**Content:** -Needs summary. -`data = C_ConsoleScriptCollection.GetCollectionDataByID(collectionID)` - -**Parameters:** -- `collectionID` - - *number* - -**Returns:** -- `data` - - *ConsoleScriptCollectionData?* - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md b/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md deleted file mode 100644 index 839710b6..00000000 --- a/wiki-information/functions/C_ConsoleScriptCollection.GetCollectionDataByTag.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ConsoleScriptCollection.GetCollectionDataByTag - -**Content:** -Needs summary. -`data = C_ConsoleScriptCollection.GetCollectionDataByTag(collectionTag)` - -**Parameters:** -- `collectionTag` - - *string* - -**Returns:** -- `data` - - *ConsoleScriptCollectionData?* - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetElements.md b/wiki-information/functions/C_ConsoleScriptCollection.GetElements.md deleted file mode 100644 index 4d9b51ee..00000000 --- a/wiki-information/functions/C_ConsoleScriptCollection.GetElements.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ConsoleScriptCollection.GetElements - -**Content:** -Needs summary. -`elementIDs = C_ConsoleScriptCollection.GetElements(collectionID)` - -**Parameters:** -- `collectionID` - - *number* - -**Returns:** -- `elementIDs` - - *ConsoleScriptCollectionElementData* - - `Field` - - `Type` - - `Description` - - `collectionID` - - *number?* - - `consoleScriptID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md b/wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md deleted file mode 100644 index 319d8827..00000000 --- a/wiki-information/functions/C_ConsoleScriptCollection.GetScriptData.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_ConsoleScriptCollection.GetScriptData - -**Content:** -Needs summary. -`data = C_ConsoleScriptCollection.GetScriptData(consoleScriptID)` - -**Parameters:** -- `consoleScriptID` - - *number* - -**Returns:** -- `data` - - *ConsoleScriptData* - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `name` - - *string* - - `help` - - *string* - - `script` - - *string* - - `params` - - *string* - - `isLuaScript` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.ContainerIDToInventoryID.md b/wiki-information/functions/C_Container.ContainerIDToInventoryID.md deleted file mode 100644 index a196eebe..00000000 --- a/wiki-information/functions/C_Container.ContainerIDToInventoryID.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: C_Container.ContainerIDToInventoryID - -**Content:** -Needs summary. -`inventoryID = C_Container.ContainerIDToInventoryID(containerID)` - -**Parameters:** -- `containerID` - - *number* : Enum.BagIndex - -**Values:** -| Description | containerID | inventoryID | -|---------------|-------------|-------------| -| Backpack | 0 | nil | -| Bag 1 | 1 | 31 | -| Bag 2 | 2 | 32 | -| Bag 3 | 3 | 33 | -| Bag 4 | 4 | 34 | -| Reagent bag | N/A | 35 | -| Bank bag 1 | 5 | 76 | -| Bank bag 2 | 6 | 77 | -| Bank bag 3 | 7 | 78 | -| Bank bag 4 | 8 | 79 | -| Bank bag 5 | 9 | 80 | -| Bank bag 6 | 10 | 81 | -| Bank bag 7 | N/A | 82 | -| Bank | -1 | nil | -| Keyring | -2 | nil | -| Reagent bank | -3 | nil | -| Bank bags | -4 | nil | - -**Returns:** -- `inventoryID` - - *number* : inventorySlotID \ No newline at end of file diff --git a/wiki-information/functions/C_Container.ContainerRefundItemPurchase.md b/wiki-information/functions/C_Container.ContainerRefundItemPurchase.md deleted file mode 100644 index 8937da5b..00000000 --- a/wiki-information/functions/C_Container.ContainerRefundItemPurchase.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Container.ContainerRefundItemPurchase - -**Content:** -Needs summary. -`C_Container.ContainerRefundItemPurchase(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* -- `isEquipped` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetBagName.md b/wiki-information/functions/C_Container.GetBagName.md deleted file mode 100644 index 48ddbd2b..00000000 --- a/wiki-information/functions/C_Container.GetBagName.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Container.GetBagName - -**Content:** -Needs summary. -`name = C_Container.GetBagName(bagIndex)` - -**Parameters:** -- `bagIndex` - - *number* - -**Returns:** -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetBagSlotFlag.md b/wiki-information/functions/C_Container.GetBagSlotFlag.md deleted file mode 100644 index e3e7a76f..00000000 --- a/wiki-information/functions/C_Container.GetBagSlotFlag.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_Container.GetBagSlotFlag - -**Content:** -Needs summary. -`isSet = C_Container.GetBagSlotFlag(bagIndex, flag)` - -**Parameters:** -- `bagIndex` - - *number* -- `flag` - - *Enum.BagSlotFlags* - - `Value` - - `Field` - - `Description` - - `1` - DisableAutoSort - - `2` - PriorityEquipment - - `4` - PriorityConsumables - - `8` - PriorityTradeGoods - - `16` - PriorityJunk - - `32` - PriorityQuestItems - - `63` - BagSlotValidFlagsAll - - `62` - BagSlotPriorityFlagsAll - -**Returns:** -- `isSet` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerFreeSlots.md b/wiki-information/functions/C_Container.GetContainerFreeSlots.md deleted file mode 100644 index 76087c9e..00000000 --- a/wiki-information/functions/C_Container.GetContainerFreeSlots.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Container.GetContainerFreeSlots - -**Content:** -Needs summary. -`freeSlots = C_Container.GetContainerFreeSlots(containerIndex)` - -**Parameters:** -- `containerIndex` - - *number* - -**Returns:** -- `freeSlots` - - *number* - -**Example Usage:** -This function can be used to determine how many free slots are available in a specific container (bag). For instance, an addon that manages inventory space could use this function to alert the player when their bags are nearly full. - -**Addon Usage:** -Large addons like Bagnon, which is an inventory management addon, might use this function to display the number of free slots in each bag. This helps players manage their inventory more efficiently by providing a clear overview of available space. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemCooldown.md b/wiki-information/functions/C_Container.GetContainerItemCooldown.md deleted file mode 100644 index df88edce..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemCooldown.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Container.GetContainerItemCooldown - -**Content:** -Needs summary. -`startTime, duration, enable = C_Container.GetContainerItemCooldown(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `startTime` - - *number* -- `duration` - - *number* -- `enable` - - *number* - -**Example Usage:** -This function can be used to check the cooldown status of an item in a specific container slot. For instance, if you want to know when a health potion will be available for use again, you can call this function with the appropriate container and slot indices. - -**Addon Usage:** -Large addons like **Bagnon** and **ArkInventory** use this function to display cooldown information directly on the item icons within the inventory UI, providing players with a visual indication of when items will be ready for use again. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemDurability.md b/wiki-information/functions/C_Container.GetContainerItemDurability.md deleted file mode 100644 index 0e7d897d..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemDurability.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Container.GetContainerItemDurability - -**Content:** -Needs summary. -`durability, maxDurability = C_Container.GetContainerItemDurability(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `durability` - - *number* -- `maxDurability` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemID.md b/wiki-information/functions/C_Container.GetContainerItemID.md deleted file mode 100644 index fc69ed61..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemID.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Container.GetContainerItemID - -**Content:** -Needs summary. -`itemID = C_Container.GetContainerItemID(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `itemID` - - *number?* - -**Example Usage:** -This function can be used to retrieve the item ID of an item in a specific slot of a container (bag). For example, if you want to check what item is in the first slot of your backpack, you could use: -```lua -local itemID = C_Container.GetContainerItemID(0, 1) -print("Item ID in first slot of backpack:", itemID) -``` - -**Addons Usage:** -Many inventory management addons, such as Bagnon or ArkInventory, use this function to identify items in the player's bags to provide enhanced bag management features. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemInfo.md b/wiki-information/functions/C_Container.GetContainerItemInfo.md deleted file mode 100644 index face95be..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: C_Container.GetContainerItemInfo - -**Content:** -Needs summary. -`containerInfo = C_Container.GetContainerItemInfo(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `containerInfo` - - *ContainerItemInfo?* - Returns nil if the container slot is empty. - - `Field` - - `Type` - - `Description` - - `iconFileID` - - *number* - - `stackCount` - - *number* - - `isLocked` - - *boolean* - - `quality` - - *Enum.ItemQuality?* - - `isReadable` - - *boolean* - - `hasLoot` - - *boolean* - - `hyperlink` - - *string* - - `isFiltered` - - *boolean* - - `hasNoValue` - - *boolean* - - `itemID` - - *number* - - `isBound` - - *boolean* - -**Example Usage:** -This function can be used to retrieve detailed information about a specific item in a player's bag. For instance, an addon could use this to display additional information about items when the player hovers over them in their inventory. - -**Addon Usage:** -Large addons like Bagnon use this function to manage and display inventory items. Bagnon, for example, uses it to fetch item details to show item icons, stack counts, and other relevant information in a unified inventory interface. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemLink.md b/wiki-information/functions/C_Container.GetContainerItemLink.md deleted file mode 100644 index fdc4d45f..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemLink.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Container.GetContainerItemLink - -**Content:** -Needs summary. -`itemLink = C_Container.GetContainerItemLink(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `itemLink` - - *string* - -**Example Usage:** -This function can be used to retrieve the item link of an item in a specific bag and slot. For example, if you want to get the item link of the item in the first slot of your backpack, you would call: -```lua -local itemLink = C_Container.GetContainerItemLink(0, 1) -print(itemLink) -``` - -**Addons Usage:** -Many inventory management addons, such as Bagnon or ArkInventory, use this function to display item information in custom bag interfaces. They call this function to get the item link and then use the link to fetch more detailed information about the item, such as its name, quality, and tooltip. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md b/wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md deleted file mode 100644 index 56f2718b..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemPurchaseCurrency.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Container.GetContainerItemPurchaseCurrency - -**Content:** -Needs summary. -`currencyInfo = C_Container.GetContainerItemPurchaseCurrency(containerIndex, slotIndex, itemIndex, isEquipped)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* -- `itemIndex` - - *number* -- `isEquipped` - - *boolean* - -**Returns:** -- `currencyInfo` - - *ItemPurchaseCurrency* - - `Field` - - `Type` - - `Description` - - `iconFileID` - - *number?* - - `currencyCount` - - *number* - - `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md b/wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md deleted file mode 100644 index 61931770..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemPurchaseInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Container.GetContainerItemPurchaseInfo - -**Content:** -Needs summary. -`info = C_Container.GetContainerItemPurchaseInfo(containerIndex, slotIndex, isEquipped)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* -- `isEquipped` - - *boolean* - -**Returns:** -- `info` - - *ItemPurchaseInfo* - - `Field` - - `Type` - - `Description` - - `money` - - *number* - - `itemCount` - - *number* - - `refundSeconds` - - *number* - - `currencyCount` - - *number* - - `hasEnchants` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md b/wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md deleted file mode 100644 index 47e65f64..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemPurchaseItem.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Container.GetContainerItemPurchaseItem - -**Content:** -Needs summary. -`itemInfo = C_Container.GetContainerItemPurchaseItem(containerIndex, slotIndex, itemIndex, isEquipped)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* -- `itemIndex` - - *number* -- `isEquipped` - - *boolean* - -**Returns:** -- `itemInfo` - - *ItemPurchaseItem* - - `Field` - - `Type` - - `Description` - - `iconFileID` - - *number?* - - `itemCount` - - *number* - - `hyperlink` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerItemQuestInfo.md b/wiki-information/functions/C_Container.GetContainerItemQuestInfo.md deleted file mode 100644 index a66e8774..00000000 --- a/wiki-information/functions/C_Container.GetContainerItemQuestInfo.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_Container.GetContainerItemQuestInfo - -**Content:** -Needs summary. -`questInfo = C_Container.GetContainerItemQuestInfo(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number (BagID)* - Index of the bag to query. -- `slotIndex` - - *number* - Index of the slot within the bag (ascending from 1) to query. - -**Returns:** -- `questInfo` - - *ItemQuestInfo* - - `Field` - - `Type` - - `Description` - - `isQuestItem` - - *boolean* - true if the item is a quest item, nil otherwise. Items starting quests are apparently not considered to be quest items. - - `questID` - - *number?* - Quest ID of the quest this item starts, no value if it does not start a quest or if the call refers to a bank bag/slot when the bank is not being visited. - - `isActive` - - *boolean* - true if the quest this item starts has been accepted by the player, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerNumFreeSlots.md b/wiki-information/functions/C_Container.GetContainerNumFreeSlots.md deleted file mode 100644 index cbd2bb16..00000000 --- a/wiki-information/functions/C_Container.GetContainerNumFreeSlots.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_Container.GetContainerNumFreeSlots - -**Content:** -Returns the number of free slots & the bagType that an equipped bag or backpack belongs to. -`numFreeSlots, bagType = C_Container.GetContainerNumFreeSlots(bagIndex)` - -**Parameters:** -- `bagIndex` - - *number* - -**Returns:** -- `numFreeSlots` - - *number* -- `bagType` - - *number* : ItemFamily - -**Reference:** -- `GetItemFamily` - Returns bagType of item. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetContainerNumSlots.md b/wiki-information/functions/C_Container.GetContainerNumSlots.md deleted file mode 100644 index 01537d19..00000000 --- a/wiki-information/functions/C_Container.GetContainerNumSlots.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_Container.GetContainerNumSlots - -**Content:** -Needs summary. -`numSlots = C_Container.GetContainerNumSlots(containerIndex)` - -**Parameters:** -- `containerIndex` - - *number* - -**Returns:** -- `numSlots` - - *number* - -**Example Usage:** -This function can be used to determine the number of slots in a specific container (bag) by providing the container index. For instance, you can use it to check how many slots are available in your backpack or any other bag. - -**Example Code:** -```lua -local containerIndex = 0 -- Index for the backpack -local numSlots = C_Container.GetContainerNumSlots(containerIndex) -print("Number of slots in the backpack:", numSlots) -``` - -**Addons Using This Function:** -Many inventory management addons, such as Bagnon and AdiBags, use this function to dynamically display the number of slots available in each container. This helps in providing a more organized and user-friendly interface for managing items. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md b/wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md deleted file mode 100644 index c635e5d7..00000000 --- a/wiki-information/functions/C_Container.GetInsertItemsLeftToRight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Container.GetInsertItemsLeftToRight - -**Content:** -Needs summary. -`isEnabled = C_Container.GetInsertItemsLeftToRight()` - -**Returns:** -- `isEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.GetItemCooldown.md b/wiki-information/functions/C_Container.GetItemCooldown.md deleted file mode 100644 index 674929fe..00000000 --- a/wiki-information/functions/C_Container.GetItemCooldown.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Container.GetItemCooldown - -**Content:** -Needs summary. -`startTime, duration, enable = C_Container.GetItemCooldown(itemID)` - -**Parameters:** -- `itemID` - - *number* - Will not accept an itemlink or name. - -**Returns:** -- `startTime` - - *number* -- `duration` - - *number* -- `enable` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.IsContainerFiltered.md b/wiki-information/functions/C_Container.IsContainerFiltered.md deleted file mode 100644 index 64224513..00000000 --- a/wiki-information/functions/C_Container.IsContainerFiltered.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Container.IsContainerFiltered - -**Content:** -Needs summary. -`isFiltered = C_Container.IsContainerFiltered(containerIndex)` - -**Parameters:** -- `containerIndex` - - *number* - -**Returns:** -- `isFiltered` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific container (bag) is currently filtered. For instance, if you want to determine whether a bag is set to only show certain types of items (e.g., equipment, consumables), you can use this function. - -**Addon Usage:** -Large addons like Bagnon or AdiBags might use this function to manage and display the contents of bags more effectively, ensuring that only the relevant items are shown based on user-defined filters. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.PickupContainerItem.md b/wiki-information/functions/C_Container.PickupContainerItem.md deleted file mode 100644 index 5cfce0b4..00000000 --- a/wiki-information/functions/C_Container.PickupContainerItem.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Container.PickupContainerItem - -**Content:** -Needs summary. -`C_Container.PickupContainerItem(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetBagPortraitTexture.md b/wiki-information/functions/C_Container.SetBagPortraitTexture.md deleted file mode 100644 index cf6d3d35..00000000 --- a/wiki-information/functions/C_Container.SetBagPortraitTexture.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Container.SetBagPortraitTexture - -**Content:** -Needs summary. -`C_Container.SetBagPortraitTexture(texture, bagIndex)` - -**Parameters:** -- `texture` - - *Texture* - The texture to be set for the bag portrait. -- `bagIndex` - - *number* - The index of the bag. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetBagSlotFlag.md b/wiki-information/functions/C_Container.SetBagSlotFlag.md deleted file mode 100644 index a5d0b204..00000000 --- a/wiki-information/functions/C_Container.SetBagSlotFlag.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Container.SetBagSlotFlag - -**Content:** -Needs summary. -`C_Container.SetBagSlotFlag(bagIndex, flag, isSet)` - -**Parameters:** -- `bagIndex` - - *number* -- `flag` - - *Enum.BagSlotFlags* - - `Value` - - `Field` - - `Description` - - `1` - - `DisableAutoSort` - - `2` - - `PriorityEquipment` - - `4` - - `PriorityConsumables` - - `8` - - `PriorityTradeGoods` - - `16` - - `PriorityJunk` - - `32` - - `PriorityQuestItems` - - `63` - - `BagSlotValidFlagsAll` - - `62` - - `BagSlotPriorityFlagsAll` -- `isSet` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md b/wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md deleted file mode 100644 index cafca196..00000000 --- a/wiki-information/functions/C_Container.SetInsertItemsLeftToRight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Container.SetInsertItemsLeftToRight - -**Content:** -Needs summary. -`C_Container.SetInsertItemsLeftToRight(enable)` - -**Parameters:** -- `enable` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SetItemSearch.md b/wiki-information/functions/C_Container.SetItemSearch.md deleted file mode 100644 index 9f320967..00000000 --- a/wiki-information/functions/C_Container.SetItemSearch.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Container.SetItemSearch - -**Content:** -Needs summary. -`C_Container.SetItemSearch(searchString)` - -**Parameters:** -- `searchString` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.ShowContainerSellCursor.md b/wiki-information/functions/C_Container.ShowContainerSellCursor.md deleted file mode 100644 index 1efb4688..00000000 --- a/wiki-information/functions/C_Container.ShowContainerSellCursor.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Container.ShowContainerSellCursor - -**Content:** -Needs summary. -`C_Container.ShowContainerSellCursor(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SocketContainerItem.md b/wiki-information/functions/C_Container.SocketContainerItem.md deleted file mode 100644 index 886b1003..00000000 --- a/wiki-information/functions/C_Container.SocketContainerItem.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Container.SocketContainerItem - -**Content:** -Needs summary. -`success = C_Container.SocketContainerItem(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Example Usage:** -This function can be used to socket a gem into an item located in a specific container and slot. For instance, if you have a gem and an item in your bag and you want to socket the gem into the item, you would use this function to perform that action programmatically. - -**Addons:** -Large addons like TradeSkillMaster (TSM) might use this function to automate the process of socketing gems into items to optimize gear for selling or personal use. \ No newline at end of file diff --git a/wiki-information/functions/C_Container.SplitContainerItem.md b/wiki-information/functions/C_Container.SplitContainerItem.md deleted file mode 100644 index 40cbd511..00000000 --- a/wiki-information/functions/C_Container.SplitContainerItem.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Container.SplitContainerItem - -**Content:** -Needs summary. -`C_Container.SplitContainerItem(containerIndex, slotIndex, amount)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* -- `amount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Container.UseContainerItem.md b/wiki-information/functions/C_Container.UseContainerItem.md deleted file mode 100644 index c84003dd..00000000 --- a/wiki-information/functions/C_Container.UseContainerItem.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Container.UseContainerItem - -**Content:** -Needs summary. -`C_Container.UseContainerItem(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* -- `unitToken` - - *string?* -- `reagentBankOpen` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_CreatureInfo.GetClassInfo.md b/wiki-information/functions/C_CreatureInfo.GetClassInfo.md deleted file mode 100644 index 1eddbcee..00000000 --- a/wiki-information/functions/C_CreatureInfo.GetClassInfo.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: C_CreatureInfo.GetClassInfo - -**Content:** -Returns info for a class by ID. -`classInfo = C_CreatureInfo.GetClassInfo(classID)` - -**Parameters:** -- `classID` - - *number* : ClassId - Ranging from 1 to GetNumClasses() - - Values: - - `ID` - - `className` (enUS) - - `classFile` - - Description - - `1` - - `Warrior` - - `WARRIOR` - - `2` - - `Paladin` - - `PALADIN` - - `3` - - `Hunter` - - `HUNTER` - - `4` - - `Rogue` - - `ROGUE` - - `5` - - `Priest` - - `PRIEST` - - `6` - - `Death Knight` - - `DEATHKNIGHT` - - Added in 3.0.2 - - `7` - - `Shaman` - - `SHAMAN` - - `8` - - `Mage` - - `MAGE` - - `9` - - `Warlock` - - `WARLOCK` - - `10` - - `Monk` - - `MONK` - - Added in 5.0.4 - - `11` - - `Druid` - - `DRUID` - - `12` - - `Demon Hunter` - - `DEMONHUNTER` - - Added in 7.0.3 - - `13` - - `Evoker` - - `EVOKER` - - Added in 10.0.0 - -**Returns:** -- `classInfo` - - *ClassInfo?* - - `Field` - - `Type` - - `Description` - - `className` - - *string* - Localized name, e.g. "Warrior" or "Guerrier". - - `classFile` - - *string* - Locale-independent name, e.g. "WARRIOR". - - `classID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CreatureInfo.GetFactionInfo.md b/wiki-information/functions/C_CreatureInfo.GetFactionInfo.md deleted file mode 100644 index 2110ea7c..00000000 --- a/wiki-information/functions/C_CreatureInfo.GetFactionInfo.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_CreatureInfo.GetFactionInfo - -**Content:** -Returns the faction name for a race. -`factionInfo = C_CreatureInfo.GetFactionInfo(raceID)` - -**Parameters:** -- `raceID` - - *number* - -**Returns:** -- `factionInfo` - - *structure* - FactionInfo (nilable) - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `groupTag` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_CreatureInfo.GetRaceInfo.md b/wiki-information/functions/C_CreatureInfo.GetRaceInfo.md deleted file mode 100644 index 76f7713f..00000000 --- a/wiki-information/functions/C_CreatureInfo.GetRaceInfo.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_CreatureInfo.GetRaceInfo - -**Content:** -Returns both localized and locale-independent race names. -`raceInfo = C_CreatureInfo.GetRaceInfo(raceID)` - -**Parameters:** -- `raceID` - - *number* - -**Returns:** -- `raceInfo` - - *structure* - RaceInfo (nilable) - - `Field` - - `Type` - - `Description` - - `raceName` - - *string* - localized name, e.g. "Night Elf" - - `clientFileString` - - *string* - non-localized name, e.g. "NightElf" - - `raceID` - - *number* - -**Example Usage:** -This function can be used to retrieve race information for displaying in a user interface or for logging purposes. For instance, an addon that customizes character creation screens might use this function to fetch and display race names. - -**Addon Usage:** -Large addons like "Altoholic" might use this function to display race information for characters across different realms and accounts. \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md b/wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md deleted file mode 100644 index b9e711b3..00000000 --- a/wiki-information/functions/C_CurrencyInfo.GetBasicCurrencyInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_CurrencyInfo.GetBasicCurrencyInfo - -**Content:** -Needs summary. -`info = C_CurrencyInfo.GetBasicCurrencyInfo(currencyType)` - -**Parameters:** -- `currencyType` - - *number* -- `quantity` - - *number?* - -**Returns:** -- `info` - - *structure* - CurrencyDisplayInfo - - `CurrencyDisplayInfo` - - `Field` - - `Type` - - `Description` - - `name` - - *string* - CurrencyContainer.ContainerName_lang - - `description` - - *string* - - `icon` - - *number* - - `quality` - - *number* - - `displayAmount` - - *number* - - `actualAmount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md deleted file mode 100644 index 29e1b705..00000000 --- a/wiki-information/functions/C_CurrencyInfo.GetCurrencyContainerInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_CurrencyInfo.GetCurrencyContainerInfo - -**Content:** -Needs summary. -`info = C_CurrencyInfo.GetCurrencyContainerInfo(currencyType, quantity)` - -**Parameters:** -- `currencyType` - - *number* - CurrencyID -- `quantity` - - *number* - -**Returns:** -- `info` - - *CurrencyDisplayInfo* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - CurrencyContainer.ContainerName_lang - - `description` - - *string* - - `icon` - - *number* - - `quality` - - *number* - - `displayAmount` - - *number* - - `actualAmount` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md deleted file mode 100644 index 1ea4ae77..00000000 --- a/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfo.md +++ /dev/null @@ -1,67 +0,0 @@ -## Title: C_CurrencyInfo.GetCurrencyInfo - -**Content:** -Returns info for a currency by ID. -```lua -info = C_CurrencyInfo.GetCurrencyInfo(type) -info = C_CurrencyInfo.GetCurrencyInfoFromLink(link) -``` - -**Parameters:** - -*GetCurrencyInfo:* -- `type` - - *number* : CurrencyID - -*GetCurrencyInfoFromLink:* -- `link` - - *string* : currencyLink - -**Returns:** -- `info` - - *CurrencyInfo* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - Localized name of the currency - - `description` - - *string* - Added in 10.0.0 - - `isHeader` - - *boolean* - Used by currency window (some currency IDs are the headers) - - `isHeaderExpanded` - - *boolean* - Whether header is expanded or collapsed in currency window - - `isTypeUnused` - - *boolean* - Sorts currency at the bottom of currency window in "Unused" header - - `isShowInBackpack` - - *boolean* - Shows currency on Blizzard backpack frame - - `quantity` - - *number* - Current amount of the currency - - `trackedQuantity` - - *number* - Added in 9.1.5 - - `iconFileID` - - *number* - FileID - - `maxQuantity` - - *number* - Total maximum currency possible - - `canEarnPerWeek` - - *boolean* - Whether the currency is limited per week - - `quantityEarnedThisWeek` - - *number* - 0 if canEarnPerWeek is false - - `isTradeable` - - *boolean* - - `quality` - - *Enum.ItemQuality* - - `maxWeeklyQuantity` - - *number* - 0 if canEarnPerWeek is false - - `totalEarned` - - *number* - Added in 9.0.2; Returns 0 if useTotalEarnedForMaxQty is false, prevents earning if equal to maxQuantity - - `discovered` - - *boolean* - Whether the character has ever earned the currency - - `useTotalEarnedForMaxQty` - - *boolean* - Added in 9.0.2; Whether the currency has a moving maximum (e.g. seasonal) - -**Example Usage:** -This function can be used to retrieve detailed information about a specific currency in the game, such as the player's current amount, whether it is displayed in the backpack, and other metadata. For instance, it can be used in an addon to display a custom currency tracker. - -**Addon Usage:** -Large addons like "Titan Panel" use this API to display currency information on the player's UI, allowing players to keep track of their currencies without opening the currency window. \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md deleted file mode 100644 index 52c45f98..00000000 --- a/wiki-information/functions/C_CurrencyInfo.GetCurrencyInfoFromLink.md +++ /dev/null @@ -1,61 +0,0 @@ -## Title: C_CurrencyInfo.GetCurrencyInfo - -**Content:** -Returns info for a currency by ID. -```lua -info = C_CurrencyInfo.GetCurrencyInfo(type) -info = C_CurrencyInfo.GetCurrencyInfoFromLink(link) -``` - -**Parameters:** - -*GetCurrencyInfo:* -- `type` - - *number* : CurrencyID - -*GetCurrencyInfoFromLink:* -- `link` - - *string* : currencyLink - -**Returns:** -- `info` - - *CurrencyInfo* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - Localized name of the currency - - `description` - - *string* - Added in 10.0.0 - - `isHeader` - - *boolean* - Used by currency window (some currency IDs are the headers) - - `isHeaderExpanded` - - *boolean* - Whether header is expanded or collapsed in currency window - - `isTypeUnused` - - *boolean* - Sorts currency at the bottom of currency window in "Unused" header - - `isShowInBackpack` - - *boolean* - Shows currency on Blizzard backpack frame - - `quantity` - - *number* - Current amount of the currency - - `trackedQuantity` - - *number* - Added in 9.1.5 - - `iconFileID` - - *number* - FileID - - `maxQuantity` - - *number* - Total maximum currency possible - - `canEarnPerWeek` - - *boolean* - Whether the currency is limited per week - - `quantityEarnedThisWeek` - - *number* - 0 if canEarnPerWeek is false - - `isTradeable` - - *boolean* - - `quality` - - *Enum.ItemQuality* - - `maxWeeklyQuantity` - - *number* - 0 if canEarnPerWeek is false - - `totalEarned` - - *number* - Added in 9.0.2; Returns 0 if useTotalEarnedForMaxQty is false, prevents earning if equal to maxQuantity - - `discovered` - - *boolean* - Whether the character has ever earned the currency - - `useTotalEarnedForMaxQty` - - *boolean* - Added in 9.0.2; Whether the currency has a moving maximum (e.g. seasonal) \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md b/wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md deleted file mode 100644 index fb0411e9..00000000 --- a/wiki-information/functions/C_CurrencyInfo.GetCurrencyListLink.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_CurrencyInfo.GetCurrencyListLink - -**Content:** -Get the currencyLink for the specified currency list index. -`link = C_CurrencyInfo.GetCurrencyListLink(index)` - -**Parameters:** -- `index` - - *number* - -**Returns:** -- `link` - - *string* : currencyLink \ No newline at end of file diff --git a/wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md b/wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md deleted file mode 100644 index dd6dc3ca..00000000 --- a/wiki-information/functions/C_CurrencyInfo.IsCurrencyContainer.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_CurrencyInfo.IsCurrencyContainer - -**Content:** -Needs summary. -`isCurrencyContainer = C_CurrencyInfo.IsCurrencyContainer(currencyID, quantity)` - -**Parameters:** -- `currencyID` - - *number* -- `quantity` - - *number* - -**Returns:** -- `isCurrencyContainer` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md b/wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md deleted file mode 100644 index be063943..00000000 --- a/wiki-information/functions/C_Cursor.DropCursorCommunitiesStream.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Cursor.DropCursorCommunitiesStream - -**Content:** -Needs summary. -`C_Cursor.DropCursorCommunitiesStream()` \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md b/wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md deleted file mode 100644 index 3064ac92..00000000 --- a/wiki-information/functions/C_Cursor.GetCursorCommunitiesStream.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Cursor.GetCursorCommunitiesStream - -**Content:** -Needs summary. -`clubId, streamId = C_Cursor.GetCursorCommunitiesStream()` - -**Returns:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.GetCursorItem.md b/wiki-information/functions/C_Cursor.GetCursorItem.md deleted file mode 100644 index 7b7ffccf..00000000 --- a/wiki-information/functions/C_Cursor.GetCursorItem.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Cursor.GetCursorItem - -**Content:** -Returns the item currently dragged by the player. -`item = C_Cursor.GetCursorItem()` - -**Returns:** -- `item` - - *ItemLocationMixin* - The item currently dragged by the player, or nil if not dragging an item. - -**Reference:** -Patch 8.0.1 (2018-07-16): Added. \ No newline at end of file diff --git a/wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md b/wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md deleted file mode 100644 index e3c8c4c6..00000000 --- a/wiki-information/functions/C_Cursor.SetCursorCommunitiesStream.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Cursor.SetCursorCommunitiesStream - -**Content:** -Needs summary. -`C_Cursor.SetCursorCommunitiesStream(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md b/wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md deleted file mode 100644 index 33790634..00000000 --- a/wiki-information/functions/C_DateAndTime.AdjustTimeByDays.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_DateAndTime.AdjustTimeByDays - -**Content:** -Returns the date after a specified amount of days. -`newDate = C_DateAndTime.AdjustTimeByDays(date, days)` -`newDate = C_DateAndTime.AdjustTimeByMinutes(date, minutes)` - -**Parameters:** -- `AdjustTimeByDays:` - - `date` - - *CalendarTime* - - `days` - - *number* -- `AdjustTimeByMinutes:` - - `date` - - *CalendarTime* - - `minutes` - - *number* - -**Returns:** -- `newDate` - - *CalendarTime* - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md b/wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md deleted file mode 100644 index 3185a002..00000000 --- a/wiki-information/functions/C_DateAndTime.AdjustTimeByMinutes.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_DateAndTime.AdjustTimeByDays - -**Content:** -Returns the date after a specified amount of days. -`newDate = C_DateAndTime.AdjustTimeByDays(date, days)` -`newDate = C_DateAndTime.AdjustTimeByMinutes(date, minutes)` - -**Parameters:** -- **AdjustTimeByDays:** - - `date` - - *CalendarTime* - - `days` - - *number* -- **AdjustTimeByMinutes:** - - `date` - - *CalendarTime* - - `minutes` - - *number* - -**Returns:** -- `newDate` - - *CalendarTime* - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.CompareCalendarTime.md b/wiki-information/functions/C_DateAndTime.CompareCalendarTime.md deleted file mode 100644 index 99bbb704..00000000 --- a/wiki-information/functions/C_DateAndTime.CompareCalendarTime.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_DateAndTime.CompareCalendarTime - -**Content:** -Compares two dates with each other. -`comparison = C_DateAndTime.CompareCalendarTime(lhsCalendarTime, rhsCalendarTime)` - -**Parameters:** -- `lhsCalendarTime` - - *CalendarTime* - left-hand side time -- `rhsCalendarTime` - - *CalendarTime* - right-hand side time - -**CalendarTime Fields:** -- `year` - - *number* - The current year (e.g. 2019) -- `month` - - *number* - The current month -- `monthDay` - - *number* - The current day of the month -- `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) -- `hour` - - *number* - The current time in hours -- `minute` - - *number* - The current time in minutes - -**Returns:** -- `comparison` - - *number* - - `1` : `rhsCalendarTime` is at a later time - - `0` : `rhsCalendarTime` is at the same time - - `-1` : `rhsCalendarTime` is at an earlier time \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md b/wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md deleted file mode 100644 index ea35ac1c..00000000 --- a/wiki-information/functions/C_DateAndTime.GetCalendarTimeFromEpoch.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: C_DateAndTime.GetCalendarTimeFromEpoch - -**Content:** -Returns the date for a specified amount of time since the UNIX epoch for the OS time zone. -`date = C_DateAndTime.GetCalendarTimeFromEpoch(epoch)` - -**Parameters:** -- `epoch` - - *number* - time in microseconds - -**Returns:** -- `date` - - *CalendarTime* - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes - -**Usage:** -```lua -local d = C_DateAndTime.GetCalendarTimeFromEpoch(1e6 * 60 * 60 * 24) -print(format("One day since epoch is %d-%02d-%02d %02d:%02d", d.year, d.month, d.monthDay, d.hour, d.minute)) --- Output: One day since epoch is 1970-01-02 01:00 -``` \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md b/wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md deleted file mode 100644 index fdb76043..00000000 --- a/wiki-information/functions/C_DateAndTime.GetCurrentCalendarTime.md +++ /dev/null @@ -1,47 +0,0 @@ -## Title: C_DateAndTime.GetCurrentCalendarTime - -**Content:** -Returns the realm's current date and time. -`currentCalendarTime = C_DateAndTime.GetCurrentCalendarTime()` - -**Returns:** -- `currentCalendarTime` - - *CalendarTime* - - `Field` - - `Type` - - `Description` - - `year` - - *number* - The current year (e.g. 2019) - - `month` - - *number* - The current month - - `monthDay` - - *number* - The current day of the month - - `weekday` - - *number* - The current day of the week (1=Sunday, 2=Monday, ..., 7=Saturday) - - `hour` - - *number* - The current time in hours - - `minute` - - *number* - The current time in minutes - -**Usage:** -```lua -local d = C_DateAndTime.GetCurrentCalendarTime() -local weekDay = CALENDAR_WEEKDAY_NAMES -local month = CALENDAR_FULLDATE_MONTH_NAMES -print(format("The time is %02d:%02d, %s, %d %s %d", d.hour, d.minute, weekDay, d.monthDay, month, d.year)) --- The time is 07:55, Friday, 15 March 2019 -``` - -**Miscellaneous:** -When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. -```lua --- unix time -time() -- 1596157547 -GetServerTime() -- 1596157549 --- local time, same as `date(nil, time())` -date() -- "Fri Jul 31 03:05:47 2020" --- realm time -GetGameTime() -- 20, 4 -C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 -C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md b/wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md deleted file mode 100644 index c2f6edb1..00000000 --- a/wiki-information/functions/C_DateAndTime.GetSecondsUntilDailyReset.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_DateAndTime.GetSecondsUntilDailyReset - -**Content:** -Needs summary. -`seconds = C_DateAndTime.GetSecondsUntilDailyReset()` - -**Returns:** -- `seconds` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md b/wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md deleted file mode 100644 index b35c2c37..00000000 --- a/wiki-information/functions/C_DateAndTime.GetSecondsUntilWeeklyReset.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_DateAndTime.GetSecondsUntilWeeklyReset - -**Content:** -Returns the number of seconds until the weekly reset. -`seconds = C_DateAndTime.GetSecondsUntilWeeklyReset()` - -**Returns:** -- `seconds` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md b/wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md deleted file mode 100644 index d922fa2f..00000000 --- a/wiki-information/functions/C_DateAndTime.GetServerTimeLocal.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_DateAndTime.GetServerTimeLocal - -**Content:** -Returns the server's Unix time offset by the server's timezone. -`serverTimeLocal = C_DateAndTime.GetServerTimeLocal()` - -**Returns:** -- `serverTimeLocal` - - *number* - Time in seconds since the epoch, only updates every 60 seconds. - -**Miscellaneous:** -When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. -```lua --- unix time -time() -- 1596157547 -GetServerTime()) -- 1596157549 --- local time, same as `date(nil, time())` -date() -- "Fri Jul 31 03:05:47 2020" --- realm time -GetGameTime() -- 20, 4 -C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 -C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md b/wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md deleted file mode 100644 index d375998d..00000000 --- a/wiki-information/functions/C_DeathInfo.GetCorpseMapPosition.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_DeathInfo.GetCorpseMapPosition - -**Content:** -Returns the location of the player's corpse on the map. -`position = C_DeathInfo.GetCorpseMapPosition(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `position` - - *Vector2DMixin?* - Returns nil when there is no corpse. - -**Example Usage:** -This function can be used in addons that need to display the player's corpse location on the map. For instance, an addon that helps players find their way back to their corpse after dying could use this function to mark the corpse's position on the map. - -**Addon Usage:** -Large addons like "TomTom" or "Mapster" might use this function to provide additional map functionalities, such as marking the location of the player's corpse to assist in navigation after death. \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md b/wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md deleted file mode 100644 index 982d92f8..00000000 --- a/wiki-information/functions/C_DeathInfo.GetDeathReleasePosition.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_DeathInfo.GetDeathReleasePosition - -**Content:** -When the player is dead and hasn't released spirit, returns the location of the graveyard they will release to. -`position = C_DeathInfo.GetDeathReleasePosition(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - -**Returns:** -- `position` - - *Vector2DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md b/wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md deleted file mode 100644 index 00bcd33d..00000000 --- a/wiki-information/functions/C_DeathInfo.GetGraveyardsForMap.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_DeathInfo.GetGraveyardsForMap - -**Content:** -Returns graveyard info and location for a map. -`graveyards = C_DeathInfo.GetGraveyardsForMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `graveyards` - - *GraveyardMapInfo* - - `Field` - - `Type` - - `Description` - - `areaPoiID` - - *number* - AreaPOI.ID - - `position` - - *Vector2DMixin* - - - `name` - - *string* - - - `textureIndex` - - *number* - - - `graveyardID` - - *number* - - - `isGraveyardSelectable` - - *boolean* - \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md b/wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md deleted file mode 100644 index 2af589d9..00000000 --- a/wiki-information/functions/C_DeathInfo.GetSelfResurrectOptions.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_DeathInfo.GetSelfResurrectOptions - -**Content:** -Returns self resurrect options for your character, including from soulstones. -`options = C_DeathInfo.GetSelfResurrectOptions()` - -**Returns:** -- `options` - - *structure* - SelfResurrectOption - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `optionType` - - *Enum.SelfResurrectOptionType* - - `id` - - *number* - - `canUse` - - *boolean* - - `isLimited` - - *boolean* - - `priority` - - *number* - -**Enum.SelfResurrectOptionType:** -- `Value` - - `Field` - - `Description` - - `0` - - Spell - - `1` - - Item \ No newline at end of file diff --git a/wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md b/wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md deleted file mode 100644 index 519a8bd7..00000000 --- a/wiki-information/functions/C_DeathInfo.UseSelfResurrectOption.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_DeathInfo.UseSelfResurrectOption - -**Content:** -Uses a soulstone or similar means of self resurrection. -`C_DeathInfo.UseSelfResurrectOption(optionType, id)` - -**Parameters:** -- `optionType` - - *Enum.SelfResurrectOptionType* -- `id` - - *number* - -**Enum.SelfResurrectOptionType:** -- `Value` - - `Field` - - `Description` - - `0` - - Spell - - `1` - - Item \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.AddCategoryFilter.md b/wiki-information/functions/C_Engraving.AddCategoryFilter.md deleted file mode 100644 index bbb7800d..00000000 --- a/wiki-information/functions/C_Engraving.AddCategoryFilter.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.AddCategoryFilter - -**Content:** -Needs summary. -`C_Engraving.AddCategoryFilter(category)` - -**Parameters:** -- `category` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md b/wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md deleted file mode 100644 index aadd75f1..00000000 --- a/wiki-information/functions/C_Engraving.AddExclusiveCategoryFilter.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.AddExclusiveCategoryFilter - -**Content:** -Needs summary. -`C_Engraving.AddExclusiveCategoryFilter(category)` - -**Parameters:** -- `category` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.CastRune.md b/wiki-information/functions/C_Engraving.CastRune.md deleted file mode 100644 index cf7b86db..00000000 --- a/wiki-information/functions/C_Engraving.CastRune.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.CastRune - -**Content:** -Needs summary. -`C_Engraving.CastRune(skillLineAbilityID)` - -**Parameters:** -- `skillLineAbilityID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.ClearCategoryFilter.md b/wiki-information/functions/C_Engraving.ClearCategoryFilter.md deleted file mode 100644 index 0593a640..00000000 --- a/wiki-information/functions/C_Engraving.ClearCategoryFilter.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.ClearCategoryFilter - -**Content:** -Needs summary. -`C_Engraving.ClearCategoryFilter(category)` - -**Parameters:** -- `category` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.EnableEquippedFilter.md b/wiki-information/functions/C_Engraving.EnableEquippedFilter.md deleted file mode 100644 index d6724fe7..00000000 --- a/wiki-information/functions/C_Engraving.EnableEquippedFilter.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.EnableEquippedFilter - -**Content:** -Needs summary. -`C_Engraving.EnableEquippedFilter(enabled)` - -**Parameters:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetCurrentRuneCast.md b/wiki-information/functions/C_Engraving.GetCurrentRuneCast.md deleted file mode 100644 index 1fcda1fa..00000000 --- a/wiki-information/functions/C_Engraving.GetCurrentRuneCast.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_Engraving.GetCurrentRuneCast - -**Content:** -Needs summary. -`engravingInfo = C_Engraving.GetCurrentRuneCast()` - -**Returns:** -- `engravingInfo` - - *EngravingData?* - - `Field` - - `Type` - - `Description` - - `skillLineAbilityID` - - *number* - - `itemEnchantmentID` - - *number* - - `name` - - *string* - - `iconTexture` - - *number* - - `equipmentSlot` - - *number* - - `level` - - *number* - - `learnedAbilitySpellIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md b/wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md deleted file mode 100644 index c1775126..00000000 --- a/wiki-information/functions/C_Engraving.GetEngravingModeEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.GetEngravingModeEnabled - -**Content:** -Needs summary. -`enabled = C_Engraving.GetEngravingModeEnabled()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md b/wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md deleted file mode 100644 index 372f1a6f..00000000 --- a/wiki-information/functions/C_Engraving.GetExclusiveCategoryFilter.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.GetExclusiveCategoryFilter - -**Content:** -Needs summary. -`category = C_Engraving.GetExclusiveCategoryFilter()` - -**Returns:** -- `category` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetNumRunesKnown.md b/wiki-information/functions/C_Engraving.GetNumRunesKnown.md deleted file mode 100644 index f1900157..00000000 --- a/wiki-information/functions/C_Engraving.GetNumRunesKnown.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Engraving.GetNumRunesKnown - -**Content:** -Needs summary. -`known, max = C_Engraving.GetNumRunesKnown()` - -**Parameters:** -- `equipmentSlot` - - *number?* - -**Returns:** -- `known` - - *number* -- `max` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetRuneCategories.md b/wiki-information/functions/C_Engraving.GetRuneCategories.md deleted file mode 100644 index 014bc87e..00000000 --- a/wiki-information/functions/C_Engraving.GetRuneCategories.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Engraving.GetRuneCategories - -**Content:** -Needs summary. -`categories = C_Engraving.GetRuneCategories(shouldFilter, ownedOnly)` - -**Parameters:** -- `shouldFilter` - - *boolean* -- `ownedOnly` - - *boolean* - -**Returns:** -- `categories` - - *number* - diff --git a/wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md b/wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md deleted file mode 100644 index 7372ca60..00000000 --- a/wiki-information/functions/C_Engraving.GetRuneForEquipmentSlot.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Engraving.GetRuneForEquipmentSlot - -**Content:** -Needs summary. -`engravingInfo = C_Engraving.GetRuneForEquipmentSlot(equipmentSlot)` - -**Parameters:** -- `equipmentSlot` - - *number* - -**Returns:** -- `engravingInfo` - - *EngravingData?* - - `Field` - - `Type` - - `Description` - - `skillLineAbilityID` - - *number* - - `itemEnchantmentID` - - *number* - - `name` - - *string* - - `iconTexture` - - *number* - - `equipmentSlot` - - *number* - - `level` - - *number* - - `learnedAbilitySpellIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md b/wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md deleted file mode 100644 index cf527854..00000000 --- a/wiki-information/functions/C_Engraving.GetRuneForInventorySlot.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Engraving.GetRuneForInventorySlot - -**Content:** -Needs summary. -`engravingInfo = C_Engraving.GetRuneForInventorySlot(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `engravingInfo` - - *EngravingData?* - - `Field` - - `Type` - - `Description` - - `skillLineAbilityID` - - *number* - - `itemEnchantmentID` - - *number* - - `name` - - *string* - - `iconTexture` - - *number* - - `equipmentSlot` - - *number* - - `level` - - *number* - - `learnedAbilitySpellIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.GetRunesForCategory.md b/wiki-information/functions/C_Engraving.GetRunesForCategory.md deleted file mode 100644 index 8d85319f..00000000 --- a/wiki-information/functions/C_Engraving.GetRunesForCategory.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Engraving.GetRunesForCategory - -**Content:** -Needs summary. -`engravingInfo = C_Engraving.GetRunesForCategory(category, ownedOnly)` - -**Parameters:** -- `category` - - *number* -- `ownedOnly` - - *boolean* - -**Returns:** -- `engravingInfo` - - *EngravingData* - - `Field` - - `Type` - - `Description` - - `skillLineAbilityID` - - *number* - - `itemEnchantmentID` - - *number* - - `name` - - *string* - - `iconTexture` - - *number* - - `equipmentSlot` - - *number* - - `level` - - *number* - - `learnedAbilitySpellIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.HasCategoryFilter.md b/wiki-information/functions/C_Engraving.HasCategoryFilter.md deleted file mode 100644 index 0e0bf24e..00000000 --- a/wiki-information/functions/C_Engraving.HasCategoryFilter.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Engraving.HasCategoryFilter - -**Content:** -Needs summary. -`result = C_Engraving.HasCategoryFilter(category)` - -**Parameters:** -- `category` - - *number* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsEngravingEnabled.md b/wiki-information/functions/C_Engraving.IsEngravingEnabled.md deleted file mode 100644 index 2c41ab0e..00000000 --- a/wiki-information/functions/C_Engraving.IsEngravingEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.IsEngravingEnabled - -**Content:** -Needs summary. -`value = C_Engraving.IsEngravingEnabled()` - -**Returns:** -- `value` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md b/wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md deleted file mode 100644 index 90a7492e..00000000 --- a/wiki-information/functions/C_Engraving.IsEquipmentSlotEngravable.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Engraving.IsEquipmentSlotEngravable - -**Content:** -Needs summary. -`result = C_Engraving.IsEquipmentSlotEngravable(equipmentSlot)` - -**Parameters:** -- `equipmentSlot` - - *number* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md b/wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md deleted file mode 100644 index 03f13ec7..00000000 --- a/wiki-information/functions/C_Engraving.IsEquippedFilterEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.IsEquippedFilterEnabled - -**Content:** -Needs summary. -`enabled = C_Engraving.IsEquippedFilterEnabled()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md b/wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md deleted file mode 100644 index fe45d9f3..00000000 --- a/wiki-information/functions/C_Engraving.IsInventorySlotEngravable.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Engraving.IsInventorySlotEngravable - -**Content:** -Needs summary. -`result = C_Engraving.IsInventorySlotEngravable(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md b/wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md deleted file mode 100644 index 2764838d..00000000 --- a/wiki-information/functions/C_Engraving.IsInventorySlotEngravableByCurrentRuneCast.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Engraving.IsInventorySlotEngravableByCurrentRuneCast - -**Content:** -Needs summary. -`result = C_Engraving.IsInventorySlotEngravableByCurrentRuneCast(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* -- `slotIndex` - - *number* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsKnownRuneSpell.md b/wiki-information/functions/C_Engraving.IsKnownRuneSpell.md deleted file mode 100644 index 96731b61..00000000 --- a/wiki-information/functions/C_Engraving.IsKnownRuneSpell.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Engraving.IsKnownRuneSpell - -**Content:** -Needs summary. -`result = C_Engraving.IsKnownRuneSpell(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.IsRuneEquipped.md b/wiki-information/functions/C_Engraving.IsRuneEquipped.md deleted file mode 100644 index 8b184507..00000000 --- a/wiki-information/functions/C_Engraving.IsRuneEquipped.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Engraving.IsRuneEquipped - -**Content:** -Needs summary. -`result = C_Engraving.IsRuneEquipped(skillLineAbilityID)` - -**Parameters:** -- `skillLineAbilityID` - - *number* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md b/wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md deleted file mode 100644 index e1522424..00000000 --- a/wiki-information/functions/C_Engraving.SetEngravingModeEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.SetEngravingModeEnabled - -**Content:** -Needs summary. -`C_Engraving.SetEngravingModeEnabled(enabled)` - -**Parameters:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Engraving.SetSearchFilter.md b/wiki-information/functions/C_Engraving.SetSearchFilter.md deleted file mode 100644 index 8962aa30..00000000 --- a/wiki-information/functions/C_Engraving.SetSearchFilter.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Engraving.SetSearchFilter - -**Content:** -Needs summary. -`C_Engraving.SetSearchFilter(filter)` - -**Parameters:** -- `filter` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md deleted file mode 100644 index 9032f2b7..00000000 --- a/wiki-information/functions/C_EquipmentSet.AssignSpecToEquipmentSet.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_EquipmentSet.AssignSpecToEquipmentSet - -**Content:** -Assigns an equipment set to a specialization. -`C_EquipmentSet.AssignSpecToEquipmentSet(equipmentSetID, specIndex)` - -**Parameters:** -- `equipmentSetID` - - *number* -- `specIndex` - - *number* - -**Example Usage:** -This function can be used to automatically switch equipment sets when changing specializations. For instance, if a player has different gear sets for their tank and DPS specializations, this function can be used to ensure the correct gear is equipped when switching between these roles. - -**Addons:** -Large addons like "ElvUI" and "WeakAuras" might use this function to enhance their functionality related to equipment management and specialization switching. For example, ElvUI could use it to streamline the process of changing gear sets when the player changes their specialization, providing a smoother user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md b/wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md deleted file mode 100644 index 8140eb89..00000000 --- a/wiki-information/functions/C_EquipmentSet.CanUseEquipmentSets.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.CanUseEquipmentSets - -**Content:** -Returns whether any equipment sets can be used. -`canUseEquipmentSets = C_EquipmentSet.CanUseEquipmentSets()` - -**Returns:** -- `canUseEquipmentSets` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md deleted file mode 100644 index 2e04efee..00000000 --- a/wiki-information/functions/C_EquipmentSet.CreateEquipmentSet.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_EquipmentSet.CreateEquipmentSet - -**Content:** -Creates an equipment set. -`C_EquipmentSet.CreateEquipmentSet(equipmentSetName)` - -**Parameters:** -- `equipmentSetName` - - *string* - The name of the equipment set to be created. -- `icon` - - *string?* - (Optional) The icon to be used for the equipment set. - -**Example Usage:** -```lua --- Create a new equipment set named "PvP Gear" -C_EquipmentSet.CreateEquipmentSet("PvP Gear", "Interface\\Icons\\INV_Sword_27") -``` - -**Description:** -This function is used to create a new equipment set with the specified name and optional icon. Equipment sets allow players to quickly switch between different sets of gear, which is particularly useful for changing roles or activities, such as switching from PvE to PvP gear. - -**Usage in Addons:** -Many popular addons, such as "Outfitter" and "ItemRack," use this function to manage and create equipment sets for players. These addons provide a user-friendly interface for creating, updating, and switching between different sets of gear, enhancing the player's ability to manage their equipment efficiently. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md deleted file mode 100644 index fd42d07a..00000000 --- a/wiki-information/functions/C_EquipmentSet.DeleteEquipmentSet.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.DeleteEquipmentSet - -**Content:** -Deletes an equipment set. -`C_EquipmentSet.DeleteEquipmentSet(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md b/wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md deleted file mode 100644 index 7373dbbe..00000000 --- a/wiki-information/functions/C_EquipmentSet.EquipmentSetContainsLockedItems.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_EquipmentSet.EquipmentSetContainsLockedItems - -**Content:** -Returns whether an equipment set has locked items. -`hasLockedItems = C_EquipmentSet.EquipmentSetContainsLockedItems(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - -**Returns:** -- `hasLockedItems` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md deleted file mode 100644 index a192c7d3..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetAssignedSpec.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_EquipmentSet.GetEquipmentSetAssignedSpec - -**Content:** -Returns the specialization assigned to an equipment set. -`specIndex = C_EquipmentSet.GetEquipmentSetAssignedSpec(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - -**Returns:** -- `specIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md deleted file mode 100644 index 4bc6cf6e..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetForSpec.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_EquipmentSet.GetEquipmentSetForSpec - -**Content:** -Returns the equipment set currently assigned to a specific specialization. -`equipmentSetID = C_EquipmentSet.GetEquipmentSetForSpec(specIndex)` - -**Parameters:** -- `specIndex` - - *number* - -**Returns:** -- `equipmentSetID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md deleted file mode 100644 index e5af1cf0..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_EquipmentSet.GetEquipmentSetID - -**Content:** -Returns the set ID of an equipment set with the specified name. -`equipmentSetID = C_EquipmentSet.GetEquipmentSetID(equipmentSetName)` - -**Parameters:** -- `equipmentSetName` - - *string* - equipment set name to query - -**Returns:** -- `equipmentSetID` - - *number* - set ID of an equipment set with the specified name, or nil if no sets with the specified name are currently saved. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md deleted file mode 100644 index 90d9f0f8..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetIDs.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.GetEquipmentSetIDs - -**Content:** -Returns an array containing all currently saved equipment set IDs. -`equipmentSetIDs = C_EquipmentSet.GetEquipmentSetIDs()` - -**Returns:** -- `equipmentSetIDs` - - *number* - An array of equipment set IDs of the currently available equipment sets. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md b/wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md deleted file mode 100644 index 535f2019..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetEquipmentSetInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_EquipmentSet.GetEquipmentSetInfo - -**Content:** -Returns information about a saved equipment set. -`name, iconFileID, setID, isEquipped, numItems, numEquipped, numInInventory, numLost, numIgnored = C_EquipmentSet.GetEquipmentSetInfo(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - equipment set ID to query information about. - -**Returns:** -- `name` - - *string* - name of the equipment set. -- `iconFileID` - - *number* - icon texture selected for the equipment set. -- `setID` - - *number* - equipment set ID. -- `isEquipped` - - *boolean* - true if all non-ignored slots in the set are currently equipped. -- `numItems` - - *number* - number of items included in the set. -- `numEquipped` - - *number* - number of items in the set currently equipped. -- `numInInventory` - - *number* - number of items in the set currently in the player's bags/bank, if bank is available. -- `numLost` - - *number* - number of items in the set that are not currently available to the player. -- `numIgnored` - - *number* - number of inventory slots ignored by the set. - -**Description:** -Equipment set IDs are assigned when the set is created and do not change as other sets are added or deleted. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md b/wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md deleted file mode 100644 index 5bcccc6b..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetIgnoredSlots.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_EquipmentSet.GetIgnoredSlots - -**Content:** -Returns ignored slots of an equipment set. -`slotIgnored = C_EquipmentSet.GetIgnoredSlots(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - -**Returns:** -- `slotIgnored` - - *boolean* - indexed by InventorySlotId \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetItemIDs.md b/wiki-information/functions/C_EquipmentSet.GetItemIDs.md deleted file mode 100644 index 9c1dabb8..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetItemIDs.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_EquipmentSet.GetItemIDs - -**Content:** -Returns the item IDs of an equipment set. -`itemIDs = C_EquipmentSet.GetItemIDs(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - Appears to return valid info for indices - -**Returns:** -- `itemIDs` - - *table* - a table of numbers indexed by InventorySlotId - -**Usage:** -To print all items that are part of the first set: -```lua -local items = C_EquipmentSet.GetItemIDs(0) -for i = 1, 19 do - if items then - print(i, (GetItemInfo(items[i]))) - end -end -``` - -**Example Use Case:** -This function can be used to retrieve and display the item IDs of all items in a specific equipment set. This is particularly useful for addons that manage or display equipment sets, such as those that help players quickly switch between different gear configurations for different activities (e.g., PvP, PvE, or specific roles like tanking or healing). - -**Addons Using This Function:** -- **Outfitter**: A popular addon that allows players to create, manage, and switch between different equipment sets. It uses this function to retrieve the item IDs for the sets it manages. -- **ItemRack**: Another addon for managing equipment sets, which uses this function to display and switch between different sets of gear. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetItemLocations.md b/wiki-information/functions/C_EquipmentSet.GetItemLocations.md deleted file mode 100644 index 80819777..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetItemLocations.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_EquipmentSet.GetItemLocations - -**Content:** -Returns the location of all items in an equipment set. -`locations = C_EquipmentSet.GetItemLocations(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - -**Returns:** -- `locations` - - *number* - indexed by InventorySlotId - -**Description:** -The values for each slot can be examined as follows: -- `-1` : The item for this slot is unavailable. -- `0` : The slot should be emptied. -- `1` : This slot is ignored by the equipment set, no change will be made. -- Any other value can be examined by calling `EquipmentManager_UnpackLocation` - -**Details:** -This function does not differentiate between slots that cannot be equipped and slots that you have chosen to ignore in the equipment manager. For example, if you are testing to see if a particular item in your inventory has become unavailable (perhaps you sold it or scrapped it by mistake), you cannot simply scan looking for `-1` values as the ammo slot will return a `-1` as well as slots that you cannot equip at all (such as shields for hunters). Additional coding, likely by class and spec, are needed to make that differentiation. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md b/wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md deleted file mode 100644 index 8d591644..00000000 --- a/wiki-information/functions/C_EquipmentSet.GetNumEquipmentSets.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.GetNumEquipmentSets - -**Content:** -Returns the number of saved equipment sets. -`numEquipmentSets = C_EquipmentSet.GetNumEquipmentSets()` - -**Returns:** -- `numEquipmentSets` - - *number* - number of saved sets for the current character. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md b/wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md deleted file mode 100644 index 4d402265..00000000 --- a/wiki-information/functions/C_EquipmentSet.IgnoreSlotForSave.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.IgnoreSlotForSave - -**Content:** -Ignores an equipment slot for saving. -`C_EquipmentSet.IgnoreSlotForSave(slot)` - -**Parameters:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md b/wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md deleted file mode 100644 index 0067ae90..00000000 --- a/wiki-information/functions/C_EquipmentSet.IsSlotIgnoredForSave.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_EquipmentSet.IsSlotIgnoredForSave - -**Content:** -Returns whether a slot is ignored for saving. -`isSlotIgnored = C_EquipmentSet.IsSlotIgnoredForSave(slot)` - -**Parameters:** -- `slot` - - *number* - -**Returns:** -- `isSlotIgnored` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific equipment slot is set to be ignored when saving an equipment set. This is useful for addons that manage equipment sets and need to ensure certain slots are not altered. - -**Addons:** -Large addons like "ItemRack" and "Outfitter" use this function to manage and save equipment sets, ensuring that specific slots (like trinkets or weapons) can be ignored based on user preferences. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md deleted file mode 100644 index d381ce58..00000000 --- a/wiki-information/functions/C_EquipmentSet.ModifyEquipmentSet.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_EquipmentSet.ModifyEquipmentSet - -**Content:** -Modifies an equipment set. -`C_EquipmentSet.ModifyEquipmentSet(equipmentSetID, newName)` - -**Parameters:** -- `equipmentSetID` - - *number* -- `newName` - - *string* -- `newIcon` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md deleted file mode 100644 index b11f9de6..00000000 --- a/wiki-information/functions/C_EquipmentSet.PickupEquipmentSet.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.PickupEquipmentSet - -**Content:** -Picks up an equipment set, placing it on the cursor. -`C_EquipmentSet.PickupEquipmentSet(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md deleted file mode 100644 index ab66b995..00000000 --- a/wiki-information/functions/C_EquipmentSet.SaveEquipmentSet.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_EquipmentSet.SaveEquipmentSet - -**Content:** -Saves your currently equipped items into an equipment set. -`C_EquipmentSet.SaveEquipmentSet(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - can be retrieved from an existing equipment set by name with `C_EquipmentSet.GetEquipmentSetID`. -- `icon` - - *string?* - icon to use for the equipment set. If omitted, the existing icon will be used. Accepts both texture names and file IDs, e.g. `"INV_Ammo_Snowball"`, `655708` or `"655708"`. - -**Description:** -Can only modify an existing equipment set. \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md b/wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md deleted file mode 100644 index 83e2f2fb..00000000 --- a/wiki-information/functions/C_EquipmentSet.UnassignEquipmentSetSpec.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.UnassignEquipmentSetSpec - -**Content:** -Unassigns an equipment set from a specialization. -`C_EquipmentSet.UnassignEquipmentSetSpec(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md b/wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md deleted file mode 100644 index 65f1c448..00000000 --- a/wiki-information/functions/C_EquipmentSet.UnignoreSlotForSave.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EquipmentSet.UnignoreSlotForSave - -**Content:** -Unignores a slot for saving. -`C_EquipmentSet.UnignoreSlotForSave(slot)` - -**Parameters:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md b/wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md deleted file mode 100644 index ff0759c8..00000000 --- a/wiki-information/functions/C_EquipmentSet.UseEquipmentSet.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_EquipmentSet.UseEquipmentSet - -**Content:** -Equips items from a specified equipment set. -`setWasEquipped = C_EquipmentSet.UseEquipmentSet(equipmentSetID)` - -**Parameters:** -- `equipmentSetID` - - *number* - -**Returns:** -- `setWasEquipped` - - *boolean* - true if the set was equipped, nil otherwise. Failure conditions include invalid arguments, and engaging in combat. - -**Description:** -This function does not produce error messages when it fails. -FrameXML's `EquipmentManager_EquipSet("name")` will produce a visible error, but will not provide a return value indicating success/failure. \ No newline at end of file diff --git a/wiki-information/functions/C_EventUtils.IsEventValid.md b/wiki-information/functions/C_EventUtils.IsEventValid.md deleted file mode 100644 index 10b14817..00000000 --- a/wiki-information/functions/C_EventUtils.IsEventValid.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_EventUtils.IsEventValid - -**Content:** -Checks if a named event exists and can be registered for. -`valid = C_EventUtils.IsEventValid(eventName)` - -**Parameters:** -- `eventName` - - *string* - The name of the event to query. - -**Returns:** -- `valid` - - *boolean* - true if the named event exists and can be registered for, false if not. \ No newline at end of file diff --git a/wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md b/wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md deleted file mode 100644 index ef28e838..00000000 --- a/wiki-information/functions/C_EventUtils.NotifySettingsLoaded.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_EventUtils.NotifySettingsLoaded - -**Content:** -Notifies the user interface that settings are loaded and are ready to be queried. -`C_EventUtils.NotifySettingsLoaded()` - -**Description:** -Immediately triggers the `SETTINGS_LOADED` event. -This function will be called after both the `PLAYER_ENTERING_WORLD` and `VARIABLES_LOADED` events have fired. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddFriend.md b/wiki-information/functions/C_FriendList.AddFriend.md deleted file mode 100644 index d2cc7893..00000000 --- a/wiki-information/functions/C_FriendList.AddFriend.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_FriendList.AddFriend - -**Content:** -Adds a friend to your friend list. -`C_FriendList.AddFriend(name)` - -**Parameters:** -- `name` - - *string* - The name of the player you would like to add. -- `notes` - - *string?* - The note that will show in your friend list. - -**Description:** -You can have a maximum of 100 people on your friends list at the same time. -The player being added does not need to be online for this to work. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddIgnore.md b/wiki-information/functions/C_FriendList.AddIgnore.md deleted file mode 100644 index 147d43fe..00000000 --- a/wiki-information/functions/C_FriendList.AddIgnore.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_FriendList.AddIgnore - -**Content:** -Adds a player to your ignore list. -`added = C_FriendList.AddIgnore(name)` - -**Parameters:** -- `name` - - *string* - the name of the player you would like to ignore. - -**Returns:** -- `added` - - *boolean* - whether the player was successfully added to your ignore list. This seems to only return false when trying to ignore someone who is already being ignored, otherwise true. - -**Description:** -You can have a maximum of 50 people on your ignore list at the same time. -The player being ignored does not need to be online for this to work. -Calling this function when a player is already ignored, removes the ignore. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddOrDelIgnore.md b/wiki-information/functions/C_FriendList.AddOrDelIgnore.md deleted file mode 100644 index d0002c43..00000000 --- a/wiki-information/functions/C_FriendList.AddOrDelIgnore.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.AddOrDelIgnore - -**Content:** -Adds or removes a player to/from the ignore list. -`C_FriendList.AddOrDelIgnore(name)` - -**Parameters:** -- `name` - - *string* - the name of the player to add or remove. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.AddOrRemoveFriend.md b/wiki-information/functions/C_FriendList.AddOrRemoveFriend.md deleted file mode 100644 index afdd6483..00000000 --- a/wiki-information/functions/C_FriendList.AddOrRemoveFriend.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_FriendList.AddOrRemoveFriend - -**Content:** -Adds or removes a player to or from the friends list. -`C_FriendList.AddOrRemoveFriend(name, notes)` - -**Parameters:** -- `name` - - *string* - The name of the player to add or remove. -- `notes` - - *string* - (Required) The note in the friends frame. - -**Description:** -If the player is already on your friends list, the player will be removed regardless of whether you pass notes as the second argument. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.DelIgnore.md b/wiki-information/functions/C_FriendList.DelIgnore.md deleted file mode 100644 index f51a4166..00000000 --- a/wiki-information/functions/C_FriendList.DelIgnore.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_FriendList.DelIgnore - -**Content:** -Removes a player from your ignore list. -`removed = C_FriendList.DelIgnore(name)` - -**Parameters:** -- `name` - - *string* - the name of the player you would like to remove from your ignore list. - -**Returns:** -- `removed` - - *boolean* - whether the player was successfully removed from your ignore list. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.DelIgnoreByIndex.md b/wiki-information/functions/C_FriendList.DelIgnoreByIndex.md deleted file mode 100644 index 08725562..00000000 --- a/wiki-information/functions/C_FriendList.DelIgnoreByIndex.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.DelIgnoreByIndex - -**Content:** -Removes a player from your ignore list. -`C_FriendList.DelIgnoreByIndex(index)` - -**Parameters:** -- `index` - - *number* - index of the player you would like to remove. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetFriendInfo.md b/wiki-information/functions/C_FriendList.GetFriendInfo.md deleted file mode 100644 index c9617304..00000000 --- a/wiki-information/functions/C_FriendList.GetFriendInfo.md +++ /dev/null @@ -1,69 +0,0 @@ -## Title: C_FriendList.GetFriendInfo - -**Content:** -Retrieves information about a person on your friends list. -```lua -info = C_FriendList.GetFriendInfo(name) -info = C_FriendList.GetFriendInfoByIndex(index) -``` - -**Parameters:** -- **GetFriendInfo:** - - `name` - - *string* - name of friend in the friend list. - -- **GetFriendInfoByIndex:** - - `index` - - *number* - index of the friend, up to `C_FriendList.GetNumFriends()` limited to max 100. - -**Returns:** -- `info` - - *FriendInfo* - a table containing: - - `Field` - - `Type` - - `Description` - - `connected` - - *boolean* - If the friend is online - - `name` - - *string* - Friend's name - - `className` - - *string?* - Friend's class, or "Unknown" (if offline) - - `area` - - *string?* - Current location, or "Unknown" (if offline) - - `notes` - - *string?* - Notes about the friend - - `guid` - - *string* - GUID, example: "Player-1096-085DE703" - - `level` - - *number* - Friend's level, or 0 (if offline) - - `dnd` - - *boolean* - If the friend's current status flag is DND - - `afk` - - *boolean* - If the friend's current status flag is AFK - - `rafLinkType` - - *Enum.RafLinkType* - Type of Recruit-A-Friend link - - `mobile` - - *boolean* - If the friend is on mobile - -**Enum.RafLinkType:** -- `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Recruit - - `2` - - Friend - - `3` - - Both - -**Description:** -Friend information isn't necessarily automatically kept up to date. You can use `C_FriendList.ShowFriends()` to request an update from the server. - -**Usage:** -```lua -local f = C_FriendList.GetFriendInfoByIndex(1) -print(format("Your friend %s (level %d %s) is in %s", f.name, f.level, f.className, f.area)) --- Your friend Aërto (level 74 Warrior) is in Sholazar Basin -``` \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md b/wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md deleted file mode 100644 index 5bf0f020..00000000 --- a/wiki-information/functions/C_FriendList.GetFriendInfoByIndex.md +++ /dev/null @@ -1,69 +0,0 @@ -## Title: C_FriendList.GetFriendInfo - -**Content:** -Retrieves information about a person on your friends list. -```lua -info = C_FriendList.GetFriendInfo(name) -info = C_FriendList.GetFriendInfoByIndex(index) -``` - -**Parameters:** -- **GetFriendInfo:** - - `name` - - *string* - name of friend in the friend list. - -- **GetFriendInfoByIndex:** - - `index` - - *number* - index of the friend, up to `C_FriendList.GetNumFriends()` limited to max 100. - -**Returns:** -- `info` - - *FriendInfo* - - `Field` - - `Type` - - `Description` - - `connected` - - *boolean* - If the friend is online - - `name` - - *string* - - `className` - - *string?* - Friend's class, or "Unknown" (if offline) - - `area` - - *string?* - Current location, or "Unknown" (if offline) - - `notes` - - *string?* - - `guid` - - *string* - GUID, example: "Player-1096-085DE703" - - `level` - - *number* - Friend's level, or 0 (if offline) - - `dnd` - - *boolean* - If the friend's current status flag is DND - - `afk` - - *boolean* - If the friend's current status flag is AFK - - `rafLinkType` - - *Enum.RafLinkType* - - `mobile` - - *boolean* - -- **Enum.RafLinkType** - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Recruit - - `2` - - Friend - - `3` - - Both - -**Description:** -Friend information isn't necessarily automatically kept up to date. You can use `C_FriendList.ShowFriends()` to request an update from the server. - -**Usage:** -```lua -local f = C_FriendList.GetFriendInfoByIndex(1) -print(format("Your friend %s (level %d %s) is in %s", f.name, f.level, f.className, f.area)) --- Your friend Aërto (level 74 Warrior) is in Sholazar Basin -``` \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetIgnoreName.md b/wiki-information/functions/C_FriendList.GetIgnoreName.md deleted file mode 100644 index 35c7c925..00000000 --- a/wiki-information/functions/C_FriendList.GetIgnoreName.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_FriendList.GetIgnoreName - -**Content:** -Returns the name of a currently ignored player. -`name = C_FriendList.GetIgnoreName(index)` - -**Parameters:** -- `index` - - *number* - index of the ignored player, up to `C_FriendList.GetNumIgnores` (max 50). - -**Returns:** -- `name` - - *string?* - name of the ignored player. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumFriends.md b/wiki-information/functions/C_FriendList.GetNumFriends.md deleted file mode 100644 index fae152d5..00000000 --- a/wiki-information/functions/C_FriendList.GetNumFriends.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.GetNumFriends - -**Content:** -Returns how many friends you have. -`numFriends = C_FriendList.GetNumFriends()` - -**Returns:** -- `numFriends` - - *number* - the number of friends you have (max 100). \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumIgnores.md b/wiki-information/functions/C_FriendList.GetNumIgnores.md deleted file mode 100644 index d75e9b96..00000000 --- a/wiki-information/functions/C_FriendList.GetNumIgnores.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.GetNumIgnores - -**Content:** -Returns the number of entries on your ignore list. -`numIgnores = C_FriendList.GetNumIgnores()` - -**Returns:** -- `numIgnores` - - *number* - the number of players on your ignore list (max 50). \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumOnlineFriends.md b/wiki-information/functions/C_FriendList.GetNumOnlineFriends.md deleted file mode 100644 index b322a7f1..00000000 --- a/wiki-information/functions/C_FriendList.GetNumOnlineFriends.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.GetNumOnlineFriends - -**Content:** -Returns the number of online friends. -`numOnline = C_FriendList.GetNumOnlineFriends()` - -**Returns:** -- `numOnline` - - *number* - the number of online friends. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetNumWhoResults.md b/wiki-information/functions/C_FriendList.GetNumWhoResults.md deleted file mode 100644 index 659c2867..00000000 --- a/wiki-information/functions/C_FriendList.GetNumWhoResults.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_FriendList.GetNumWhoResults - -**Content:** -Get the number of entries resulting from your most recent /who query. -`numWhos, totalNumWhos = C_FriendList.GetNumWhoResults()` - -**Returns:** -- `numWhos` - - *number* - Number of results returned -- `totalNumWhos` - - *number* - Number of results to display - -**Description:** -Both return values never seem to go over 50. -If `totalNumWhos` would be bigger than 50, the amount shown will be capped to `MAX_WHOS_FROM_SERVER` (50) in FrameXML. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetSelectedFriend.md b/wiki-information/functions/C_FriendList.GetSelectedFriend.md deleted file mode 100644 index 13900112..00000000 --- a/wiki-information/functions/C_FriendList.GetSelectedFriend.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_FriendList.GetSelectedFriend - -**Content:** -Returns the index of the currently selected friend. -`index = C_FriendList.GetSelectedFriend()` - -**Returns:** -- `index` - - *number?* - The index of the friend which is currently selected on the friend list. Returns nil if you have no friends. - -**Description:** -This function is necessary because indices can change in response to friend status updates. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetSelectedIgnore.md b/wiki-information/functions/C_FriendList.GetSelectedIgnore.md deleted file mode 100644 index f30a7fcc..00000000 --- a/wiki-information/functions/C_FriendList.GetSelectedIgnore.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.GetSelectedIgnore - -**Content:** -Returns the currently selected index in the ignore listing. -`index = C_FriendList.GetSelectedIgnore()` - -**Returns:** -- `index` - - *number?* - the index of the ignored player which is currently selected on the friend list. Returns nil if you have nobody ignored. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.GetWhoInfo.md b/wiki-information/functions/C_FriendList.GetWhoInfo.md deleted file mode 100644 index dccb5ee9..00000000 --- a/wiki-information/functions/C_FriendList.GetWhoInfo.md +++ /dev/null @@ -1,43 +0,0 @@ -## Title: C_FriendList.GetWhoInfo - -**Content:** -Retrieves info about a character on your current /who list. -`info = C_FriendList.GetWhoInfo(index)` - -**Parameters:** -- `index` - - *number* - Index 1 up to `C_FriendList.GetNumWhoResults()` - -**Returns:** -- `info` - - *WhoInfo* - - `Field` - - `Type` - - `Description` - - `fullName` - - *string* - Character-Realm name - - `fullGuildName` - - *string* - Guild name - - `level` - - *number* - - `raceStr` - - *string* - - `classStr` - - *string* - Localized class name - - `area` - - *string* - The character's current zone - - `filename` - - *string?* - Localization-independent classFilename - - `gender` - - *number* - Sex of the character. 2 for male, 3 for female - -**Usage:** -```lua -local p = C_FriendList.GetWhoInfo(1) -print(format("%s (level %d %s %s) is in %s", p.fullName, p.level, p.raceStr, p.classStr, p.area)) --- Output: Nartan-Ravenholdt (level 43 Kul Tiran Druid) is in Eastern Plaguelands -``` - -**Reference:** -- `C_FriendList.SendWho()` -- `/who` \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsFriend.md b/wiki-information/functions/C_FriendList.IsFriend.md deleted file mode 100644 index da792740..00000000 --- a/wiki-information/functions/C_FriendList.IsFriend.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_FriendList.IsFriend - -**Content:** -Returns whether a character is your friend. -`isFriend = C_FriendList.IsFriend(guid)` - -**Parameters:** -- `guid` - - *string* - GUID - -**Returns:** -- `isFriend` - - *boolean* - whether the character is your friend. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsIgnored.md b/wiki-information/functions/C_FriendList.IsIgnored.md deleted file mode 100644 index 03e6439b..00000000 --- a/wiki-information/functions/C_FriendList.IsIgnored.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_FriendList.IsIgnored - -**Content:** -Returns whether a character is being ignored by you. -`isIgnored = C_FriendList.IsIgnored(token)` - -**Parameters:** -- `token` - - *string* - The UnitId or name of the character. - -**Returns:** -- `isIgnored` - - *boolean* - whether the character is ignored. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsIgnoredByGuid.md b/wiki-information/functions/C_FriendList.IsIgnoredByGuid.md deleted file mode 100644 index 64b71f30..00000000 --- a/wiki-information/functions/C_FriendList.IsIgnoredByGuid.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_FriendList.IsIgnoredByGuid - -**Content:** -Returns whether a character is being ignored by you. -`isIgnored = C_FriendList.IsIgnoredByGuid(guid)` - -**Parameters:** -- `guid` - - *string* - GUID of the character. - -**Returns:** -- `isIgnored` - - *boolean* - whether the character is ignored. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.IsOnIgnoredList.md b/wiki-information/functions/C_FriendList.IsOnIgnoredList.md deleted file mode 100644 index 4acfb9d8..00000000 --- a/wiki-information/functions/C_FriendList.IsOnIgnoredList.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_FriendList.IsOnIgnoredList - -**Content:** -Needs summary. -`isIgnored = C_FriendList.IsOnIgnoredList(token)` - -**Parameters:** -- `token` - - *string* - -**Returns:** -- `isIgnored` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.RemoveFriend.md b/wiki-information/functions/C_FriendList.RemoveFriend.md deleted file mode 100644 index 4f81eed3..00000000 --- a/wiki-information/functions/C_FriendList.RemoveFriend.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_FriendList.RemoveFriend - -**Content:** -Removes a friend from the friends list. -`removed = C_FriendList.RemoveFriend(name)` - -**Parameters:** -- `name` - - *string* - the name of the friend to remove. - -**Returns:** -- `removed` - - *boolean* - whether the friend was successfully removed. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.RemoveFriendByIndex.md b/wiki-information/functions/C_FriendList.RemoveFriendByIndex.md deleted file mode 100644 index b2e47fff..00000000 --- a/wiki-information/functions/C_FriendList.RemoveFriendByIndex.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.RemoveFriendByIndex - -**Content:** -Removes a friend from the friends list. -`C_FriendList.RemoveFriendByIndex(index)` - -**Parameters:** -- `index` - - *number* - the index of the friend in the friends list to remove. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SendWho.md b/wiki-information/functions/C_FriendList.SendWho.md deleted file mode 100644 index cdc0b916..00000000 --- a/wiki-information/functions/C_FriendList.SendWho.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: C_FriendList.SendWho - -**Content:** -Requests a list of other online players. -`C_FriendList.SendWho(filter, origin)` - -**Parameters:** -- `filter` - - *string* - The criteria for which you want to perform a Who query. This can be anything for which you could normally search in a Who query: - - Any string, which will be matched against players' names, guild names, zones, and levels. - - Name (`n-""`) - - Zone (`z-""`) - - Race (`r-""`) - - Class (`c-""`) - - Guild (`g-""`) - - Level ranges: (`-`) - - These can be combined, but no more than one of each type can be searched for at once. Note that the quotation marks around the zone, race, and class must be present. Double quotation marks are required, as single quotation marks won't work. -- `origin` - - *Enum.SocialWhoOrigin* - - `Value` - - `Field` - - `Description` - - `0` - Unknown - - `1` - Social - - `2` - Chat - - `3` - Item - -**Description:** -Fires `WHO_LIST_UPDATE` when the requested query has been processed. Note that there is a server-side cooldown; queries are not guaranteed to generate a response. - -**Usage:** -- Searches for players in the level 20 to 40 range. - ```lua - C_FriendList.SendWho("20-40") - ``` -- Searches for Night Elf Rogues in Teldrassil, of levels 10-15, with the string "bob" in their (guild) names. - ```lua - C_FriendList.SendWho('bob z-"Teldrassil" r-"Night Elf" c-"Rogue" 10-15') - ``` - -**Reference:** -- `C_FriendList.GetWhoInfo()` -- `C_FriendList.SetWhoToUi()` - -**Example Use Case:** -This function can be used in addons that need to search for players based on specific criteria, such as finding potential group members or guild recruits. For example, an addon like "LookingForGroup" might use this function to find players who meet certain level and class requirements for a dungeon run. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetFriendNotes.md b/wiki-information/functions/C_FriendList.SetFriendNotes.md deleted file mode 100644 index fd1991b8..00000000 --- a/wiki-information/functions/C_FriendList.SetFriendNotes.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_FriendList.SetFriendNotes - -**Content:** -Sets the note text for a friend. -`found = C_FriendList.SetFriendNotes(name, notes)` - -**Parameters:** -- `name` - - *string* - name of friend in the friend list. -- `notes` - - *string* - the text that the friend's note will be set to, up to 48 characters, anything longer will be truncated. - -**Returns:** -- `found` - - *boolean* - Whether the friend's note was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md b/wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md deleted file mode 100644 index b945f814..00000000 --- a/wiki-information/functions/C_FriendList.SetFriendNotesByIndex.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_FriendList.SetFriendNotesByIndex - -**Content:** -Sets the note text for a friend. -`C_FriendList.SetFriendNotesByIndex(index, notes)` - -**Parameters:** -- `index` - - *number* - index of the friend, up to `C_FriendList.GetNumFriends` (max 100). Note that status changes can re-order the friend list, indices are not guaranteed to remain stable across events. -- `notes` - - *string* - the text that the friend's note will be set to, up to 48 characters, anything longer will be truncated. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetSelectedFriend.md b/wiki-information/functions/C_FriendList.SetSelectedFriend.md deleted file mode 100644 index 63bfdf75..00000000 --- a/wiki-information/functions/C_FriendList.SetSelectedFriend.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_FriendList.SetSelectedFriend - -**Content:** -Updates the current selected friend. -`C_FriendList.SetSelectedFriend(index)` - -**Parameters:** -- `index` - - *number* - the index of the friend to be selected. - -**Description:** -This function is necessary because indices can change in response to friend status updates. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetSelectedIgnore.md b/wiki-information/functions/C_FriendList.SetSelectedIgnore.md deleted file mode 100644 index 26015cec..00000000 --- a/wiki-information/functions/C_FriendList.SetSelectedIgnore.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_FriendList.SetSelectedIgnore - -**Content:** -Sets the currently selected ignore entry. -`C_FriendList.SetSelectedIgnore(index)` - -**Parameters:** -- `index` - - *number* - the index of the ignored player to be selected. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SetWhoToUi.md b/wiki-information/functions/C_FriendList.SetWhoToUi.md deleted file mode 100644 index f8c4d9e2..00000000 --- a/wiki-information/functions/C_FriendList.SetWhoToUi.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_FriendList.SetWhoToUi - -**Content:** -Sets how the result of a /who request will be delivered. -`C_FriendList.SetWhoToUi(whoToUi)` - -**Parameters:** -- `whoToUi` - - *boolean* - If true the results will always be delivered as a WHO_LIST_UPDATE event and displayed in the FriendsFrame. If false the results may be returned as a sequence of CHAT_MSG_SYSTEM events (up to 3 results) or a WHO_LIST_UPDATE event (4+ results). - -**Description:** -The /who query is subject to a server-side throttle; throttled requests are silently dropped. -This setting does not persist between relog/reload. -The FriendsFrame will automatically display open to display the results when the WHO_LIST_UPDATE event is triggered. You may hide the frame using `HideUIPanel(FriendsFrame)` (protected during combat lockdown), or temporarily unregister it from WHO_LIST_UPDATE to prevent this behavior if your addon relies on performing /who queries in the background. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.ShowFriends.md b/wiki-information/functions/C_FriendList.ShowFriends.md deleted file mode 100644 index 89baba7b..00000000 --- a/wiki-information/functions/C_FriendList.ShowFriends.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_FriendList.ShowFriends - -**Content:** -Requests updated friends information from server. -`C_FriendList.ShowFriends()` - -**Example Usage:** -This function can be used in an addon to refresh the friends list data. For instance, if you are developing an addon that displays your friends' online status, you can call `C_FriendList.ShowFriends()` to ensure you have the most up-to-date information. - -**Addons Using This Function:** -Many social and communication addons, such as "Prat" or "Chatter," use this function to keep the friends list current and to provide accurate information to the user. \ No newline at end of file diff --git a/wiki-information/functions/C_FriendList.SortWho.md b/wiki-information/functions/C_FriendList.SortWho.md deleted file mode 100644 index 51972339..00000000 --- a/wiki-information/functions/C_FriendList.SortWho.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_FriendList.SortWho - -**Content:** -Sorts the last /who reply received by the client. -`C_FriendList.SortWho(sorting)` - -**Parameters:** -- `sorting` - - *string* - The column by which you wish to sort the who list: - - `"name"` (default) - - `"level"` - - `"class"` - - `"zone"` - - `"guild"` - - `"race"` - -**Reference:** -`WHO_LIST_UPDATE` is fired when the list is sorted. - -**Description:** -This function changes the mapping between `C_FriendList.GetWhoInfo` indices and result rows. -FrameXML will show the who frame on this event, even if it was not visible before. -Calling the same sort twice will reverse the sort. -You may sort by guild, race, or zone even if it is not the currently selected second column on the who frame. \ No newline at end of file diff --git a/wiki-information/functions/C_FunctionContainers.CreateCallback.md b/wiki-information/functions/C_FunctionContainers.CreateCallback.md deleted file mode 100644 index a1c51881..00000000 --- a/wiki-information/functions/C_FunctionContainers.CreateCallback.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_FunctionContainers.CreateCallback - -**Content:** -Creates a function container that invokes a cancellable callback function. -`container = C_FunctionContainers.CreateCallback(func)` - -**Parameters:** -- `func` - - *function* - A Lua function to be called. - -**Returns:** -- `container` - - *FunctionContainer* - A container object bound to the supplied function. - -**Description:** -The supplied callback must be a Lua function. The API will reject C functions and any non-function values. - -**Usage:** -The following snippet creates a function container and schedules it to be executed every second, cancelling itself after five calls. -```lua -local container -container = C_FunctionContainers.CreateCallback(function() - container.timesCalled = container.timesCalled + 1 - if container.timesCalled == 5 then - container:Cancel() - end - print("Called!") -end) -container.timesCalled = 0 -C_Timer.NewTicker(1, container) -``` - -**Example Use Case:** -This function can be used in scenarios where you need to repeatedly execute a function with the ability to cancel it after a certain condition is met. For instance, it can be used in an addon to periodically check for updates or changes in the game state and stop checking after a certain number of iterations. - -**Addon Usage:** -Large addons like WeakAuras might use this function to create dynamic and cancellable callbacks for custom animations or periodic checks. This allows for efficient resource management by ensuring that callbacks are only active when needed and can be cancelled when their purpose is fulfilled. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.AddSDLMapping.md b/wiki-information/functions/C_GamePad.AddSDLMapping.md deleted file mode 100644 index 8e6a597b..00000000 --- a/wiki-information/functions/C_GamePad.AddSDLMapping.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_GamePad.AddSDLMapping - -**Content:** -Needs summary. -`success = C_GamePad.AddSDLMapping(platform, mapping)` - -**Parameters:** -- `platform` - - *Enum.ClientPlatformType* - - `Value` - - `Field` - - `Description` - - `0` - Windows - - `1` - Macintosh -- `mapping` - - *string* - -**Returns:** -- `success` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ApplyConfigs.md b/wiki-information/functions/C_GamePad.ApplyConfigs.md deleted file mode 100644 index b49b4329..00000000 --- a/wiki-information/functions/C_GamePad.ApplyConfigs.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_GamePad.ApplyConfigs - -**Content:** -Needs summary. -`C_GamePad.ApplyConfigs()` \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.AxisIndexToConfigName.md b/wiki-information/functions/C_GamePad.AxisIndexToConfigName.md deleted file mode 100644 index 10912c1e..00000000 --- a/wiki-information/functions/C_GamePad.AxisIndexToConfigName.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_GamePad.AxisIndexToConfigName - -**Content:** -Needs summary. -`configName = C_GamePad.AxisIndexToConfigName(axisIndex)` - -**Parameters:** -- `axisIndex` - - *number* - -**Returns:** -- `configName` - - *string?* - -**Example Usage:** -This function can be used to retrieve the configuration name for a specific gamepad axis index. This is useful for addons that need to map gamepad inputs to specific actions or settings. - -**Addons:** -While there is no specific large addon mentioned, any addon that deals with gamepad support, such as ConsolePort, might use this function to handle gamepad axis configurations. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ButtonBindingToIndex.md b/wiki-information/functions/C_GamePad.ButtonBindingToIndex.md deleted file mode 100644 index 0e2380d6..00000000 --- a/wiki-information/functions/C_GamePad.ButtonBindingToIndex.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_GamePad.ButtonBindingToIndex - -**Content:** -Converts the name of a keybinding to its assigned gamepad button index. Returns nil if no gamepad button is assigned to the requested keybinding. -`buttonIndex = C_GamePad.ButtonBindingToIndex(bindingName)` - -**Parameters:** -- `bindingName` - - *string* - -**Returns:** -- `buttonIndex` - - *number?* - -**Example Usage:** -This function can be used to map a specific keybinding to a gamepad button index, which is useful for addons that provide gamepad support or custom keybinding configurations. - -**Addon Usage:** -Large addons like ConsolePort use this function to provide seamless gamepad integration by mapping World of Warcraft keybindings to gamepad buttons, enhancing the gameplay experience for players who prefer using a gamepad. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ButtonIndexToBinding.md b/wiki-information/functions/C_GamePad.ButtonIndexToBinding.md deleted file mode 100644 index be16192c..00000000 --- a/wiki-information/functions/C_GamePad.ButtonIndexToBinding.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_GamePad.ButtonIndexToBinding - -**Content:** -Returns the name of the keybinding assigned to a specified gamepad button index. Returns nil if no keybinding is assigned to the requested button. -`bindingName = C_GamePad.ButtonIndexToBinding(buttonIndex)` - -**Parameters:** -- `buttonIndex` - - *number* - -**Returns:** -- `bindingName` - - *string?* - -**Example Usage:** -This function can be used to retrieve the keybinding name for a specific button on a gamepad. For instance, if you want to check what action is bound to the "A" button on an Xbox controller, you would use this function with the appropriate button index. - -**Addons:** -Large addons that support gamepad functionality, such as ConsolePort, may use this function to dynamically display or modify keybindings based on the gamepad button indices. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md b/wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md deleted file mode 100644 index 3b106d23..00000000 --- a/wiki-information/functions/C_GamePad.ButtonIndexToConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_GamePad.ButtonIndexToConfigName - -**Content:** -Needs summary. -`configName = C_GamePad.ButtonIndexToConfigName(buttonIndex)` - -**Parameters:** -- `buttonIndex` - - *number* - -**Returns:** -- `configName` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.ClearLedColor.md b/wiki-information/functions/C_GamePad.ClearLedColor.md deleted file mode 100644 index b81cbbf9..00000000 --- a/wiki-information/functions/C_GamePad.ClearLedColor.md +++ /dev/null @@ -1,6 +0,0 @@ -## Title: C_GamePad.ClearLedColor - -**Content:** -Needs summary. -`C_GamePad.ClearLedColor()` - diff --git a/wiki-information/functions/C_GamePad.DeleteConfig.md b/wiki-information/functions/C_GamePad.DeleteConfig.md deleted file mode 100644 index 9fbbfe26..00000000 --- a/wiki-information/functions/C_GamePad.DeleteConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_GamePad.DeleteConfig - -**Content:** -Needs summary. -`C_GamePad.DeleteConfig(configID)` - -**Parameters:** -- `configID` - - *GamePadConfigID* - - `Field` - - `Type` - - `Description` - - `vendorID` - - *number?* - - `productID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetActiveDeviceID.md b/wiki-information/functions/C_GamePad.GetActiveDeviceID.md deleted file mode 100644 index 5cc35f7f..00000000 --- a/wiki-information/functions/C_GamePad.GetActiveDeviceID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GamePad.GetActiveDeviceID - -**Content:** -Needs summary. -`deviceID = C_GamePad.GetActiveDeviceID()` - -**Returns:** -- `deviceID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetAllConfigIDs.md b/wiki-information/functions/C_GamePad.GetAllConfigIDs.md deleted file mode 100644 index cf1d5bd3..00000000 --- a/wiki-information/functions/C_GamePad.GetAllConfigIDs.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_GamePad.GetAllConfigIDs - -**Content:** -Needs summary. -`configIDs = C_GamePad.GetAllConfigIDs()` - -**Returns:** -- `configIDs` - - *GamePadConfigID* - - `Field` - - `Type` - - `Description` - - `vendorID` - - *number?* - - `productID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetAllDeviceIDs.md b/wiki-information/functions/C_GamePad.GetAllDeviceIDs.md deleted file mode 100644 index 0421fa0b..00000000 --- a/wiki-information/functions/C_GamePad.GetAllDeviceIDs.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GamePad.GetAllDeviceIDs - -**Content:** -Needs summary. -`deviceIDs = C_GamePad.GetAllDeviceIDs()` - -**Returns:** -- `deviceIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetCombinedDeviceID.md b/wiki-information/functions/C_GamePad.GetCombinedDeviceID.md deleted file mode 100644 index 33cd4e90..00000000 --- a/wiki-information/functions/C_GamePad.GetCombinedDeviceID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GamePad.GetCombinedDeviceID - -**Content:** -Needs summary. -`deviceID = C_GamePad.GetCombinedDeviceID()` - -**Returns:** -- `deviceID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetConfig.md b/wiki-information/functions/C_GamePad.GetConfig.md deleted file mode 100644 index 8ea37750..00000000 --- a/wiki-information/functions/C_GamePad.GetConfig.md +++ /dev/null @@ -1,109 +0,0 @@ -## Title: C_GamePad.GetConfig - -**Content:** -Needs summary. -`config = C_GamePad.GetConfig(configID)` - -**Parameters:** -- `configID` - - *GamePadConfigID* - -**Returns:** -- `config` - - *GamePadConfig?* - - `Field` - - `Type` - - `Description` - - `comment` - - *string?* - - `name` - - *string?* - - `configID` - - *GamePadConfigID* - - `labelStyle` - - *string?* - - `rawButtonMappings` - - *GamePadRawButtonMapping* - - `rawAxisMappings` - - *GamePadRawAxisMapping* - - `axisConfigs` - - *GamePadAxisConfig* - - `stickConfigs` - - *GamePadStickConfig* - -**GamePadConfigID:** -- `Field` -- `Type` -- `Description` -- `vendorID` - - *number?* -- `productID` - - *number?* - -**GamePadRawButtonMapping:** -- `Field` -- `Type` -- `Description` -- `rawIndex` - - *number* -- `button` - - *string?* -- `axis` - - *string?* -- `axisValue` - - *number?* -- `comment` - - *string?* - -**GamePadRawAxisMapping:** -- `Field` -- `Type` -- `Description` -- `rawIndex` - - *number* -- `axis` - - *string?* -- `comment` - - *string?* - -**GamePadAxisConfig:** -- `Field` -- `Type` -- `Description` -- `axis` - - *string* -- `shift` - - *number?* -- `scale` - - *number?* -- `deadzone` - - *number?* -- `buttonThreshold` - - *number?* -- `buttonPos` - - *string?* -- `buttonNeg` - - *string?* -- `comment` - - *string?* - -**GamePadStickConfig:** -- `Field` -- `Type` -- `Description` -- `stick` - - *string* -- `axisX` - - *string?* -- `axisY` - - *string?* -- `deadzone` - - *number?* -- `deadzoneX` - - *number?* -- `deadzoneY` - - *number?* -- `comment` - - *string?* - -**Added in 9.1.5** \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetDeviceMappedState.md b/wiki-information/functions/C_GamePad.GetDeviceMappedState.md deleted file mode 100644 index 464e39d4..00000000 --- a/wiki-information/functions/C_GamePad.GetDeviceMappedState.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: C_GamePad.GetDeviceMappedState - -**Content:** -Needs summary. -`state = C_GamePad.GetDeviceMappedState()` - -**Parameters:** -- `deviceID` - - *number?* - -**Returns:** -- `state` - - *GamePadMappedState?* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `labelStyle` - - *string* - - `buttonCount` - - *number* - - `axisCount` - - *number* - - `stickCount` - - *number* - - `buttons` - - *boolean* - - `axes` - - *number* - - `sticks` - - *GamePadStick* - - `Field` - - `Type` - - `Description` - - `x` - - *number* - - `y` - - *number* - - `len` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetDeviceRawState.md b/wiki-information/functions/C_GamePad.GetDeviceRawState.md deleted file mode 100644 index 7b3c75e5..00000000 --- a/wiki-information/functions/C_GamePad.GetDeviceRawState.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_GamePad.GetDeviceRawState - -**Content:** -Needs summary. -`rawState = C_GamePad.GetDeviceRawState(deviceID)` - -**Parameters:** -- `deviceID` - - *number* - -**Returns:** -- `rawState` - - *GamePadRawState?* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `vendorID` - - *number* - - `productID` - - *number* - - `rawButtonCount` - - *number* - - `rawAxisCount` - - *number* - - `rawButtons` - - *boolean* - - `rawAxes` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetLedColor.md b/wiki-information/functions/C_GamePad.GetLedColor.md deleted file mode 100644 index 5eb1eaec..00000000 --- a/wiki-information/functions/C_GamePad.GetLedColor.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GamePad.GetLedColor - -**Content:** -Needs summary. -`color = C_GamePad.GetLedColor()` - -**Returns:** -- `color` - - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.GetPowerLevel.md b/wiki-information/functions/C_GamePad.GetPowerLevel.md deleted file mode 100644 index c0a728db..00000000 --- a/wiki-information/functions/C_GamePad.GetPowerLevel.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_GamePad.GetPowerLevel - -**Content:** -Needs summary. -`powerLevel = C_GamePad.GetPowerLevel()` - -**Parameters:** -- `deviceID` - - *number?* - -**Returns:** -- `powerLevel` - - *GamePadPowerLevel* - - `Value` - - `Field` - - `Description` - - `0` - - Critical - - `1` - - Low - - `2` - - Medium - - `3` - - High - - `4` - - Wired - - `5` - - Unknown \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.IsEnabled.md b/wiki-information/functions/C_GamePad.IsEnabled.md deleted file mode 100644 index a1cb17d6..00000000 --- a/wiki-information/functions/C_GamePad.IsEnabled.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_GamePad.IsEnabled - -**Content:** -Returns true if gamepad support is enabled on this system. -`enabled = C_GamePad.IsEnabled()` - -**Returns:** -- `enabled` - - *boolean* - True if gamepad support is enabled. - -**Example Usage:** -This function can be used to check if the gamepad support is enabled before attempting to bind gamepad controls or display gamepad-specific UI elements. - -**Addons:** -Large addons like ConsolePort use this function to determine if they should initialize gamepad-specific features and configurations. \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.SetConfig.md b/wiki-information/functions/C_GamePad.SetConfig.md deleted file mode 100644 index b1368656..00000000 --- a/wiki-information/functions/C_GamePad.SetConfig.md +++ /dev/null @@ -1,103 +0,0 @@ -## Title: C_GamePad.SetConfig - -**Content:** -Needs summary. -`C_GamePad.SetConfig(config)` - -**Parameters:** -- `config` - - *GamePadConfig* - - `Field` - - `Type` - - `Description` - - `comment` - - *string?* - - `name` - - *string?* - - `configID` - - *GamePadConfigID* - - `labelStyle` - - *string?* - - `rawButtonMappings` - - *GamePadRawButtonMapping* - - `rawAxisMappings` - - *GamePadRawAxisMapping* - - `axisConfigs` - - *GamePadAxisConfig* - - `stickConfigs` - - *GamePadStickConfig* - -**GamePadConfigID:** -- `Field` -- `Type` -- `Description` -- `vendorID` - - *number?* -- `productID` - - *number?* - -**GamePadRawButtonMapping:** -- `Field` -- `Type` -- `Description` -- `rawIndex` - - *number* -- `button` - - *string?* -- `axis` - - *string?* -- `axisValue` - - *number?* -- `comment` - - *string?* - -**GamePadRawAxisMapping:** -- `Field` -- `Type` -- `Description` -- `rawIndex` - - *number* -- `axis` - - *string?* -- `comment` - - *string?* - -**GamePadAxisConfig:** -- `Field` -- `Type` -- `Description` -- `axis` - - *string* -- `shift` - - *number?* -- `scale` - - *number?* -- `deadzone` - - *number?* -- `buttonThreshold` - - *number?* -- `buttonPos` - - *string?* -- `buttonNeg` - - *string?* -- `comment` - - *string?* - -**GamePadStickConfig:** -- `Field` -- `Type` -- `Description` -- `stick` - - *string* -- `axisX` - - *string?* -- `axisY` - - *string?* -- `deadzone` - - *number?* -- `deadzoneX` - - *number?* (Added in 9.1.5) -- `deadzoneY` - - *number?* (Added in 9.1.5) -- `comment` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.SetLedColor.md b/wiki-information/functions/C_GamePad.SetLedColor.md deleted file mode 100644 index 511dcc79..00000000 --- a/wiki-information/functions/C_GamePad.SetLedColor.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GamePad.SetLedColor - -**Content:** -Needs summary. -`C_GamePad.SetLedColor(color)` - -**Parameters:** -- `color` - - *ColorMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.SetVibration.md b/wiki-information/functions/C_GamePad.SetVibration.md deleted file mode 100644 index 24d73e6b..00000000 --- a/wiki-information/functions/C_GamePad.SetVibration.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_GamePad.SetVibration - -**Content:** -Makes the gamepad vibrate. -`C_GamePad.SetVibration(vibrationType, intensity)` - -**Parameters:** -- `vibrationType` - - *string* -- `intensity` - - *number* - -**Description:** -Vibration duration lasts for around 1 second. -"Trigger" type vibrations appear to be only supported by the PS5 controller, as trigger haptic vibration. - -**Usage:** -Vibrates the gamepad at 100% intensity. -`C_GamePad.SetVibration("High", 1)` \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.StickIndexToConfigName.md b/wiki-information/functions/C_GamePad.StickIndexToConfigName.md deleted file mode 100644 index 2d6dd491..00000000 --- a/wiki-information/functions/C_GamePad.StickIndexToConfigName.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_GamePad.StickIndexToConfigName - -**Content:** -Needs summary. -`configName = C_GamePad.StickIndexToConfigName(stickIndex)` - -**Parameters:** -- `stickIndex` - - *number* - -**Returns:** -- `configName` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GamePad.StopVibration.md b/wiki-information/functions/C_GamePad.StopVibration.md deleted file mode 100644 index e32f0d9a..00000000 --- a/wiki-information/functions/C_GamePad.StopVibration.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_GamePad.StopVibration - -**Content:** -Needs summary. -`C_GamePad.StopVibration()` - -**Example Usage:** -This function can be used to stop any ongoing vibration on a gamepad. For instance, if a game event triggers a vibration and you want to stop it after a certain condition is met, you can call this function. - -**Example:** -```lua --- Example of stopping gamepad vibration after a certain event -if event == "PLAYER_DEAD" then - C_GamePad.StopVibration() -end -``` - -**Addons:** -While there are no specific large addons known to use this function extensively, it can be useful in custom addons that provide enhanced gamepad support or custom gamepad feedback mechanisms. \ No newline at end of file diff --git a/wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md b/wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md deleted file mode 100644 index a25fc656..00000000 --- a/wiki-information/functions/C_GameRules.IsSelfFoundAllowed.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GameRules.IsSelfFoundAllowed - -**Content:** -Needs summary. -`active = C_GameRules.IsSelfFoundAllowed()` - -**Returns:** -- `active` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.CloseGossip.md b/wiki-information/functions/C_GossipInfo.CloseGossip.md deleted file mode 100644 index 107a1cac..00000000 --- a/wiki-information/functions/C_GossipInfo.CloseGossip.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_GossipInfo.CloseGossip - -**Content:** -Closes the gossip window. -`C_GossipInfo.CloseGossip()` - -**Example Usage:** -This function can be used in a script or addon to automatically close the gossip window after interacting with an NPC. For instance, if you have an addon that automates quest acceptance and completion, you might use `C_GossipInfo.CloseGossip()` to close the gossip window once the interaction is complete. - -**Addons Using This Function:** -Many quest automation addons, such as "AutoTurnIn" and "QuickQuest," use this function to streamline the questing process by automatically closing the gossip window after accepting or completing quests. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.ForceGossip.md b/wiki-information/functions/C_GossipInfo.ForceGossip.md deleted file mode 100644 index 10287b88..00000000 --- a/wiki-information/functions/C_GossipInfo.ForceGossip.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_GossipInfo.ForceGossip - -**Content:** -Returns true if gossip text must be displayed. For example, making this return true shows the Banker gossip. -`forceGossip = C_GossipInfo.ForceGossip()` - -**Returns:** -- `forceGossip` - - *boolean* - -**Description:** -When this is made to return true, gossip text will no longer be skipped if there is only one non-gossip option. For example, when speaking to the Banker. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetActiveQuests.md b/wiki-information/functions/C_GossipInfo.GetActiveQuests.md deleted file mode 100644 index 5a27d770..00000000 --- a/wiki-information/functions/C_GossipInfo.GetActiveQuests.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_GossipInfo.GetActiveQuests - -**Content:** -Returns the quests which can be turned in at a quest giver. -`info = C_GossipInfo.GetActiveQuests()` - -**Returns:** -- `info` - - *GossipQuestUIInfo* - - `Field` - - `Type` - - `Description` - - `title` - - *string* - - `questLevel` - - *number* - - `isTrivial` - - *boolean* - - `frequency` - - *number?* - - `repeatable` - - *boolean?* - - `isComplete` - - *boolean?* - - `isLegendary` - - *boolean* - - `isIgnored` - - *boolean* - - `questID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetAvailableQuests.md b/wiki-information/functions/C_GossipInfo.GetAvailableQuests.md deleted file mode 100644 index 454f7e1b..00000000 --- a/wiki-information/functions/C_GossipInfo.GetAvailableQuests.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: C_GossipInfo.GetAvailableQuests - -**Content:** -Returns the available quests at a quest giver. -`info = C_GossipInfo.GetAvailableQuests()` - -**Returns:** -- `info` - - *GossipQuestUIInfo* - - `Field` - - `Type` - - `Description` - - `title` - - *string* - - `questLevel` - - *number* - - `isTrivial` - - *boolean* - - `frequency` - - *number?* - - `repeatable` - - *boolean?* - - `isComplete` - - *boolean?* - - `isLegendary` - - *boolean* - - `isIgnored` - - *boolean* - - `questID` - - *number* - -**Description:** -Available quests are quests that the player does not yet have in their quest log. -This list is available after `GOSSIP_SHOW` has fired. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md b/wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md deleted file mode 100644 index cd5e09c2..00000000 --- a/wiki-information/functions/C_GossipInfo.GetCompletedOptionDescriptionString.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GossipInfo.GetCompletedOptionDescriptionString - -**Content:** -Needs summary. -`description = C_GossipInfo.GetCompletedOptionDescriptionString()` - -**Returns:** -- `description` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md b/wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md deleted file mode 100644 index b4be0e5d..00000000 --- a/wiki-information/functions/C_GossipInfo.GetCustomGossipDescriptionString.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GossipInfo.GetCustomGossipDescriptionString - -**Content:** -Needs summary. -`description = C_GossipInfo.GetCustomGossipDescriptionString()` - -**Returns:** -- `description` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md b/wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md deleted file mode 100644 index 1ac9b12c..00000000 --- a/wiki-information/functions/C_GossipInfo.GetFriendshipReputation.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_GossipInfo.GetFriendshipReputation - -**Content:** -Needs summary. -`reputationInfo = C_GossipInfo.GetFriendshipReputation(friendshipFactionID)` - -**Parameters:** -- `friendshipFactionID` - - *number* - -**Returns:** -- `reputationInfo` - - *FriendshipReputationInfo* - - `Field` - - `Type` - - `Description` - - `friendshipFactionID` - - *number* - - `standing` - - *number* - - `maxRep` - - *number* - - `name` - - *string?* - - `text` - - *string* - - `texture` - - *number* - - `reaction` - - *string* - - `reactionThreshold` - - *number* - - `nextThreshold` - - *number?* - - `reversedColor` - - *boolean* - - `overrideColor` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md b/wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md deleted file mode 100644 index 944faaa7..00000000 --- a/wiki-information/functions/C_GossipInfo.GetFriendshipReputationRanks.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_GossipInfo.GetFriendshipReputationRanks - -**Content:** -Needs summary. -`rankInfo = C_GossipInfo.GetFriendshipReputationRanks(friendshipFactionID)` - -**Parameters:** -- `friendshipFactionID` - - *number* - -**Returns:** -- `rankInfo` - - *FriendshipReputationRankInfo* - - `Field` - - `Type` - - `Description` - - `currentLevel` - - *number* - - `maxLevel` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md b/wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md deleted file mode 100644 index 6c3f23c9..00000000 --- a/wiki-information/functions/C_GossipInfo.GetNumActiveQuests.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_GossipInfo.GetNumActiveQuests - -**Content:** -Returns the number of active quests that you should eventually turn in to this NPC. -`numQuests = C_GossipInfo.GetNumActiveQuests()` - -**Returns:** -- `numQuests` - - *number* - -**Description:** -This information is available when the `GOSSIP_SHOW` event fires. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md b/wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md deleted file mode 100644 index a6ed7a8b..00000000 --- a/wiki-information/functions/C_GossipInfo.GetNumAvailableQuests.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_GossipInfo.GetNumAvailableQuests - -**Content:** -Returns the number of quests (that you are not already on) offered by this NPC. -`numQuests = C_GossipInfo.GetNumAvailableQuests()` - -**Returns:** -- `numQuests` - - *number* - -**Example Usage:** -This function can be used in an addon to determine how many new quests an NPC is offering to the player. For instance, an addon could use this to display a notification or update a UI element indicating the number of available quests when interacting with an NPC. - -**Addon Usage:** -Large addons like Questie or Storyline might use this function to enhance the questing experience by providing additional information about available quests directly in the game's interface. Questie, for example, could use this to mark NPCs on the map that have new quests available for the player. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetOptions.md b/wiki-information/functions/C_GossipInfo.GetOptions.md deleted file mode 100644 index 4dbe1dcd..00000000 --- a/wiki-information/functions/C_GossipInfo.GetOptions.md +++ /dev/null @@ -1,94 +0,0 @@ -## Title: C_GossipInfo.GetOptions - -**Content:** -Returns the available gossip options at a quest giver. -`info = C_GossipInfo.GetOptions()` - -**Returns:** -- `info` - - *GossipOptionUIInfo* - - `Field` - - `Type` - - `Description` - - `gossipOptionID` - - *number?* - This can be nil to avoid automation - - `name` - - *string* - Text of the gossip item - - `icon` - - *number : fileID* - Icon of the gossip type - - `rewards` - - *GossipOptionRewardInfo* - - `status` - - *Enum.GossipOptionStatus* - - `spellID` - - *number?* - - `flags` - - *number* - - `overrideIconID` - - *number? : fileID* - - `selectOptionWhenOnlyOption` - - *boolean* - - `orderIndex` - - *number* - -- `GossipOptionRewardInfo` - - `Field` - - `Type` - - `Description` - - `id` - - *number* - - `quantity` - - *number* - - `rewardType` - - *Enum.GossipOptionRewardType* - -- `Enum.GossipOptionRewardType` - - `Value` - - `Field` - - `Description` - - `0` - - *Item* - - `1` - - *Currency* - -- `Enum.GossipOptionStatus` - - `Value` - - `Field` - - `Description` - - `0` - - *Available* - - `1` - - *Unavailable* - - `2` - - *Locked* - - `3` - - *AlreadyComplete* - -**Description:** -Related Events: -- `GOSSIP_SHOW` - -Related API: -- `C_GossipInfo.SelectOption` -- `C_GossipInfo.SelectOptionByIndex` -- `C_GossipInfo.SelectActiveQuest` -- `C_GossipInfo.SelectAvailableQuest` - -**Usage:** -Prints gossip options and automatically selects the vendor gossip when e.g. at an innkeeper. -```lua -local function OnEvent(self, event) - local info = C_GossipInfo.GetOptions() - for i, v in pairs(info) do - print(i, v.icon, v.name, v.gossipOptionID) - if v.icon == 132060 then -- interface/gossipframe/vendorgossipicon.blp - print("Selecting vendor gossip option.") - C_GossipInfo.SelectOption(v.gossipOptionID) - end - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("GOSSIP_SHOW") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md b/wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md deleted file mode 100644 index 27531865..00000000 --- a/wiki-information/functions/C_GossipInfo.GetPoiForUiMapID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_GossipInfo.GetPoiForUiMapID - -**Content:** -Returns any gossip point of interest on the map. -`gossipPoiID = C_GossipInfo.GetPoiForUiMapID(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `gossipPoiID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetPoiInfo.md b/wiki-information/functions/C_GossipInfo.GetPoiInfo.md deleted file mode 100644 index 9b453515..00000000 --- a/wiki-information/functions/C_GossipInfo.GetPoiInfo.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_GossipInfo.GetPoiInfo - -**Content:** -Returns info for a gossip point of interest (e.g. the red flags when asking city guards for directions). -`gossipPoiInfo = C_GossipInfo.GetPoiInfo(uiMapID, gossipPoiID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID -- `gossipPoiID` - - *number* - -**Returns:** -- `gossipPoiInfo` - - *GossipPoiInfo?* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `textureIndex` - - *number* - Used for `GetPOITextureCoords()` - - `position` - - *Vector2DMixin* - - `inBattleMap` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.GetText.md b/wiki-information/functions/C_GossipInfo.GetText.md deleted file mode 100644 index 25161237..00000000 --- a/wiki-information/functions/C_GossipInfo.GetText.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_GossipInfo.GetText - -**Content:** -Returns the gossip text. -`gossipText = C_GossipInfo.GetText()` - -**Returns:** -- `gossipText` - - *string* - -**Description:** -Available when GOSSIP_SHOW fires. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectActiveQuest.md b/wiki-information/functions/C_GossipInfo.SelectActiveQuest.md deleted file mode 100644 index f08ff1a1..00000000 --- a/wiki-information/functions/C_GossipInfo.SelectActiveQuest.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_GossipInfo.SelectActiveQuest - -**Content:** -Selects an active quest from the gossip window. -`C_GossipInfo.SelectActiveQuest(optionID)` - -**Parameters:** -- `optionID` - - *number* - questID from `C_GossipInfo.GetActiveQuests` - -**Example Usage:** -This function can be used in an addon to automate the selection of active quests from NPCs that offer multiple quests. For instance, if an NPC offers several quests and you want to programmatically select a specific one, you can use this function. - -**Addon Usage:** -Large addons like **Questie** or **Zygor Guides** might use this function to streamline quest interactions, ensuring that the correct quest is selected without user intervention. This can be particularly useful in questing guides or automation scripts where minimizing user input is desired. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md b/wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md deleted file mode 100644 index 53ab0e80..00000000 --- a/wiki-information/functions/C_GossipInfo.SelectAvailableQuest.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_GossipInfo.SelectAvailableQuest - -**Content:** -Selects an available quest from the gossip window. -`C_GossipInfo.SelectAvailableQuest(optionID)` - -**Parameters:** -- `optionID` - - *number* - questID from `C_GossipInfo.GetAvailableQuests` - -**Example Usage:** -This function can be used in an addon to automate the selection of available quests from NPCs. For instance, an addon designed to streamline questing might use this function to automatically pick up all available quests from an NPC when the player interacts with them. - -**Addons Using This Function:** -- **Questie**: A popular quest helper addon that provides quest information and tracking. It uses this function to automate the process of accepting quests from NPCs, making the questing experience more efficient for players. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectOption.md b/wiki-information/functions/C_GossipInfo.SelectOption.md deleted file mode 100644 index 27aee227..00000000 --- a/wiki-information/functions/C_GossipInfo.SelectOption.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: C_GossipInfo.SelectOption - -**Content:** -Selects a gossip (conversation) option. -`C_GossipInfo.SelectOption(optionID)` - -**Parameters:** -- `optionID` - - *number* - gossipOptionID from `C_GossipInfo.GetOptions()` -- `text` - - *string?* -- `confirmed` - - *boolean?* - -**Usage:** -Prints gossip options and automatically selects the vendor gossip when e.g. at an innkeeper. -```lua -local function OnEvent(self, event) - local info = C_GossipInfo.GetOptions() - for i, v in pairs(info) do - print(i, v.icon, v.name, v.gossipOptionID) - if v.icon == 132060 then -- interface/gossipframe/vendorgossipicon.blp - print("Selecting vendor gossip option.") - C_GossipInfo.SelectOption(v.gossipOptionID) - end - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("GOSSIP_SHOW") -f:SetScript("OnEvent", OnEvent) -``` - -**Reference:** -UI SelectGossipOption - This is an API for players and addon authors to continue to be able to select by index rather than ID. \ No newline at end of file diff --git a/wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md b/wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md deleted file mode 100644 index e3cfcaf9..00000000 --- a/wiki-information/functions/C_GossipInfo.SelectOptionByIndex.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_GossipInfo.SelectOptionByIndex - -**Content:** -Needs summary. -`C_GossipInfo.SelectOptionByIndex(optionID)` - -**Parameters:** -- `optionID` - - *number* - orderIndex from `C_GossipInfo.GetOptions()` -- `text` - - *string?* -- `confirmed` - - *boolean?* - -**Example Usage:** -This function can be used to programmatically select a gossip option in a conversation with an NPC. For instance, if an NPC offers multiple dialogue options, you can use this function to select a specific option based on its index. - -**Addons:** -Large addons like "Questie" or "Zygor Guides" might use this function to automate quest interactions, allowing the addon to select the appropriate dialogue options without user intervention. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md b/wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md deleted file mode 100644 index dc41361c..00000000 --- a/wiki-information/functions/C_GuildInfo.CanEditOfficerNote.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_GuildInfo.CanEditOfficerNote - -**Content:** -Returns true if the player can edit guild officer notes. -`canEditOfficerNote = C_GuildInfo.CanEditOfficerNote()` - -**Returns:** -- `canEditOfficerNote` - - *boolean* - true if the player can edit guild officer notes - -**Example Usage:** -This function can be used in an addon to check if the player has the necessary permissions to edit officer notes in the guild. For instance, an addon that manages guild information might use this function to enable or disable the UI elements for editing officer notes based on the player's permissions. - -**Addons:** -Large addons like "Guild Roster Manager" might use this function to determine if the player can edit officer notes and provide appropriate functionalities based on that permission. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md b/wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md deleted file mode 100644 index 64c26589..00000000 --- a/wiki-information/functions/C_GuildInfo.CanSpeakInGuildChat.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_GuildInfo.CanSpeakInGuildChat - -**Content:** -Returns true if the player can use guild chat. -`canSpeakInGuildChat = C_GuildInfo.CanSpeakInGuildChat()` - -**Returns:** -- `canSpeakInGuildChat` - - *boolean* - true if the player can use guild chat - -**Example Usage:** -This function can be used to check if a player has the necessary permissions to send messages in the guild chat. For instance, an addon could use this to enable or disable guild chat-related features based on the player's permissions. - -**Addons:** -Large addons like "ElvUI" or "Prat" might use this function to manage chat functionalities, ensuring that guild chat options are only available to players who have the permission to use them. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md b/wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md deleted file mode 100644 index f9f322a4..00000000 --- a/wiki-information/functions/C_GuildInfo.CanViewOfficerNote.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GuildInfo.CanViewOfficerNote - -**Content:** -Returns true if the player can view guild officer notes. -`canViewOfficerNote = C_GuildInfo.CanViewOfficerNote()` - -**Returns:** -- `canViewOfficerNote` - - *boolean* - true if the player can view guild officer notes, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md b/wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md deleted file mode 100644 index 22682bfb..00000000 --- a/wiki-information/functions/C_GuildInfo.GetGuildRankOrder.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_GuildInfo.GetGuildRankOrder - -**Content:** -Returns the current rank of a guild member. -`rankOrder = C_GuildInfo.GetGuildRankOrder(guid)` - -**Parameters:** -- `guid` - - *string* - -**Returns:** -- `rankOrder` - - *number* - Starting at 1 (Guild Master) \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md b/wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md deleted file mode 100644 index 1af54000..00000000 --- a/wiki-information/functions/C_GuildInfo.GetGuildTabardInfo.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_GuildInfo.GetGuildTabardInfo - -**Content:** -Needs summary. -`tabardInfo = C_GuildInfo.GetGuildTabardInfo(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `tabardInfo` - - *structure* - GuildTabardInfo (nilable) - - `GuildTabardInfo` - - `Field` - - `Type` - - `Description` - - `backgroundColor` - - *ColorMixin* - - `borderColor` - - *ColorMixin* - - `emblemColor` - - *ColorMixin* - - `emblemFileID` - - *number* - GuildEmblem.db2 - - `emblemStyle` - - *number* - -**Example Usage:** -This function can be used to retrieve the tabard information of a guild, which can be useful for displaying guild tabards in custom UI elements or addons. - -**Addons:** -Large addons like "ElvUI" and "Guild Roster Manager" might use this function to display guild tabard information in their custom guild interfaces. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md b/wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md deleted file mode 100644 index 6fccdd7c..00000000 --- a/wiki-information/functions/C_GuildInfo.GuildControlGetRankFlags.md +++ /dev/null @@ -1,83 +0,0 @@ -## Title: C_GuildInfo.GuildControlGetRankFlags - -**Content:** -Returns the permission flags for a rank index. -`permissions = C_GuildInfo.GuildControlGetRankFlags(rankOrder)` - -**Parameters:** -- `rankOrder` - - *number* - Starting at 1 (Guild Master) - -**Returns:** -- `permissions` - - *boolean* - table indices ranging from 1 to 21. - - `GUILDCONTROL_OPTION` - - `Index` - - `GlobalString` - - `Name` - - `Description` - - `1` - - `GUILDCONTROL_OPTION1` - - Guildchat Listen - - `2` - - `GUILDCONTROL_OPTION2` - - Guildchat Speak - - `3` - - `GUILDCONTROL_OPTION3` - - Officerchat Listen - - `4` - - `GUILDCONTROL_OPTION4` - - Officerchat Speak - - `5` - - `GUILDCONTROL_OPTION5` - - Promote - - `6` - - `GUILDCONTROL_OPTION6` - - Demote - - `7` - - `GUILDCONTROL_OPTION7` - - Invite Member - - `8` - - `GUILDCONTROL_OPTION8` - - Remove Member - - `9` - - `GUILDCONTROL_OPTION9` - - Set MOTD - - `10` - - `GUILDCONTROL_OPTION10` - - Edit Public Note - - `11` - - `GUILDCONTROL_OPTION11` - - View Officer Note - - `12` - - `GUILDCONTROL_OPTION12` - - Edit Officer Note - - `13` - - `GUILDCONTROL_OPTION13` - - Modify Guild Info - - `14` - - `GUILDCONTROL_OPTION14` - - Create Guild Event - - `15` - - `GUILDCONTROL_OPTION15` - - Guild Bank Repair - - Use guild funds for repairs - - `16` - - `GUILDCONTROL_OPTION16` - - Withdraw Gold - - Withdraw gold from the guild bank - - `17` - - `GUILDCONTROL_OPTION17` - - Create Guild Event - - `18` - - `GUILDCONTROL_OPTION18` - - Requires Authenticator - - `19` - - `GUILDCONTROL_OPTION19` - - Modify Bank Tabs - - `20` - - `GUILDCONTROL_OPTION20` - - Remove Guild Event - - `21` - - `GUILDCONTROL_OPTION21` - - Recruitment \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.GuildRoster.md b/wiki-information/functions/C_GuildInfo.GuildRoster.md deleted file mode 100644 index 6ddba2df..00000000 --- a/wiki-information/functions/C_GuildInfo.GuildRoster.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_GuildInfo.GuildRoster - -**Content:** -Requests updated guild roster information from the server. -`C_GuildInfo.GuildRoster()` - -**Description:** -`GUILD_ROSTER_UPDATE` fires when updated (but not necessarily altered) information is received from the server. -The call will be ignored completely if the last `GuildRoster()` call was less than 10 seconds ago (most likely to limit the traffic caused by frequent opening/closing of the guild tab). - -**Reference:** -`GetGuildRosterInfo` \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.IsGuildOfficer.md b/wiki-information/functions/C_GuildInfo.IsGuildOfficer.md deleted file mode 100644 index b9a2c1e1..00000000 --- a/wiki-information/functions/C_GuildInfo.IsGuildOfficer.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_GuildInfo.IsGuildOfficer - -**Content:** -Needs summary. -`isOfficer = C_GuildInfo.IsGuildOfficer()` - -**Returns:** -- `isOfficer` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md b/wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md deleted file mode 100644 index 9d5c8d44..00000000 --- a/wiki-information/functions/C_GuildInfo.IsGuildRankAssignmentAllowed.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_GuildInfo.IsGuildRankAssignmentAllowed - -**Content:** -Needs summary. -`isGuildRankAssignmentAllowed = C_GuildInfo.IsGuildRankAssignmentAllowed(guid, rankOrder)` - -**Parameters:** -- `guid` - - *string* -- `rankOrder` - - *number* - Starting at 1 (Guild Master) - -**Returns:** -- `isGuildRankAssignmentAllowed` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.MemberExistsByName.md b/wiki-information/functions/C_GuildInfo.MemberExistsByName.md deleted file mode 100644 index 0c96cf05..00000000 --- a/wiki-information/functions/C_GuildInfo.MemberExistsByName.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_GuildInfo.MemberExistsByName - -**Content:** -Needs summary. -`exists = C_GuildInfo.MemberExistsByName(name)` - -**Parameters:** -- `name` - - *string* - -**Returns:** -- `exists` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md b/wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md deleted file mode 100644 index 9f87e4ab..00000000 --- a/wiki-information/functions/C_GuildInfo.QueryGuildMembersForRecipe.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_GuildInfo.QueryGuildMembersForRecipe - -**Content:** -Needs summary. -`updatedRecipeSpellID = C_GuildInfo.QueryGuildMembersForRecipe(skillLineID, recipeSpellID)` - -**Parameters:** -- `skillLineID` - - *number* -- `recipeSpellID` - - *number* -- `recipeLevel` - - *number?* - -**Returns:** -- `updatedRecipeSpellID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.RemoveFromGuild.md b/wiki-information/functions/C_GuildInfo.RemoveFromGuild.md deleted file mode 100644 index 8874473b..00000000 --- a/wiki-information/functions/C_GuildInfo.RemoveFromGuild.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_GuildInfo.RemoveFromGuild - -**Content:** -Removes a member from the guild. -`C_GuildInfo.RemoveFromGuild(guid)` - -**Parameters:** -- `guid` - - *string* - -**Reference:** -- `GuildUninvite()` - -**Example Usage:** -This function can be used in a guild management addon to automate the removal of inactive or problematic members from the guild. - -**Addon Usage:** -Large guild management addons like "Guild Roster Manager" might use this function to provide guild leaders with tools to manage their guild members efficiently. \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md b/wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md deleted file mode 100644 index 6635b627..00000000 --- a/wiki-information/functions/C_GuildInfo.SetGuildRankOrder.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_GuildInfo.SetGuildRankOrder - -**Content:** -Sets the guild rank for a member. -`C_GuildInfo.SetGuildRankOrder(guid, rankOrder)` - -**Parameters:** -- `guid` - - *string* -- `rankOrder` - - *number* - Starting at 1 (Guild Master) \ No newline at end of file diff --git a/wiki-information/functions/C_GuildInfo.SetNote.md b/wiki-information/functions/C_GuildInfo.SetNote.md deleted file mode 100644 index e369acfa..00000000 --- a/wiki-information/functions/C_GuildInfo.SetNote.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_GuildInfo.SetNote - -**Content:** -Sets the guild note for a member. -`C_GuildInfo.SetNote(guid, note, isPublic)` - -**Parameters:** -- `guid` - - *string* -- `note` - - *string* -- `isPublic` - - *boolean* - -**Reference:** -GuildRosterSetPublicNote() \ No newline at end of file diff --git a/wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md b/wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md deleted file mode 100644 index 4bfde96c..00000000 --- a/wiki-information/functions/C_Heirloom.CanHeirloomUpgradeFromPending.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_Heirloom.CanHeirloomUpgradeFromPending - -**Content:** -Returns true if an heirloom can be upgraded by using an upgrade item. -`boolean = C_Heirloom.CanHeirloomUpgradeFromPending(itemID)` - -**Parameters:** -- `itemID` - - *number* - a heirloom itemID - -**Returns:** -- *boolean* - -**Example Usage:** -This function can be used to check if a specific heirloom item can be upgraded before attempting to use an upgrade item on it. This is useful in addons that manage heirloom collections or automate the upgrading process. - -**Addons:** -Large addons like "Altoholic" and "AllTheThings" might use this function to provide users with information about their heirloom items and whether they can be upgraded. \ No newline at end of file diff --git a/wiki-information/functions/C_Heirloom.GetHeirloomInfo.md b/wiki-information/functions/C_Heirloom.GetHeirloomInfo.md deleted file mode 100644 index 0bbbf193..00000000 --- a/wiki-information/functions/C_Heirloom.GetHeirloomInfo.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_Heirloom.GetHeirloomInfo - -**Content:** -Returns information about a heirloom by itemID. -`name, itemEquipLoc, isPvP, itemTexture, upgradeLevel, source, searchFiltered, effectiveLevel, minLevel, maxLevel = C_Heirloom.GetHeirloomInfo(itemID)` - -**Parameters:** -- `itemID` - - *number* - a heirloom itemID - -**Returns:** -- `name` - - *string* - false if not a heirloom item -- `itemEquipLoc` - - *string* -- `isPvP` - - *boolean* -- `itemTexture` - - *string* -- `upgradeLevel` - - *number* -- `source` - - *number* - heirloom source index -- `searchFiltered` - - *boolean* -- `effectiveLevel` - - *number* -- `minLevel` - - *number* -- `maxLevel` - - *number* - -**Example Usage:** -This function can be used to retrieve detailed information about a specific heirloom item, which can be useful for addons that manage heirloom collections or display heirloom information to the player. - -**Addons:** -Large addons like "Altoholic" use this function to display heirloom information across multiple characters, helping players keep track of their heirloom collections. \ No newline at end of file diff --git a/wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md b/wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md deleted file mode 100644 index 52a01526..00000000 --- a/wiki-information/functions/C_Heirloom.GetHeirloomItemIDs.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Heirloom.GetHeirloomItemIDs - -**Content:** -Returns the heirloom item IDs for all classes. -`itemIDs = C_Heirloom.GetHeirloomItemIDs()` - -**Returns:** -- `itemIDs` - - *number* - Heirloom item IDs for all classes. \ No newline at end of file diff --git a/wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md b/wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md deleted file mode 100644 index b34507ca..00000000 --- a/wiki-information/functions/C_InterfaceFileManifest.GetInterfaceArtFiles.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_InterfaceFileManifest.GetInterfaceArtFiles - -**Content:** -Obtains a list of all interface art file names. -`images = C_InterfaceFileManifest.GetInterfaceArtFiles()` - -**Returns:** -- `images` - - *string?* - A list of file names. - -**Description:** -This function always returns nil inside the FrameXML environment. It only returns a table while on Glue screens such as character selection, where addon code cannot run. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.DoesItemExist.md b/wiki-information/functions/C_Item.DoesItemExist.md deleted file mode 100644 index 0997b188..00000000 --- a/wiki-information/functions/C_Item.DoesItemExist.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_Item.DoesItemExist - -**Content:** -Needs summary. -```lua -itemExists = C_Item.DoesItemExist(emptiableItemLocation) -itemExists = C_Item.DoesItemExistByID(itemInfo) -``` - -**Parameters:** -- **DoesItemExist:** - - `emptiableItemLocation` - - *ItemLocationMixin* - -- **DoesItemExistByID:** - - `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `itemExists` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific item exists in the game. For instance, it can be useful in inventory management addons to verify if an item is valid before performing operations on it. - -**Addons Using This Function:** -Large addons like **Bagnon** and **ArkInventory** might use this function to ensure that items being displayed or manipulated in the inventory actually exist, preventing errors and improving user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.DoesItemExistByID.md b/wiki-information/functions/C_Item.DoesItemExistByID.md deleted file mode 100644 index 71d9e04f..00000000 --- a/wiki-information/functions/C_Item.DoesItemExistByID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.DoesItemExist - -**Content:** -Needs summary. -`itemExists = C_Item.DoesItemExist(emptiableItemLocation)` -`itemExists = C_Item.DoesItemExistByID(itemInfo)` - -**Parameters:** -- **DoesItemExist:** - - `emptiableItemLocation` - - *ItemLocationMixin* - -- **DoesItemExistByID:** - - `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `itemExists` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetCurrentItemLevel.md b/wiki-information/functions/C_Item.GetCurrentItemLevel.md deleted file mode 100644 index 59fcad5c..00000000 --- a/wiki-information/functions/C_Item.GetCurrentItemLevel.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Item.GetCurrentItemLevel - -**Content:** -Needs summary. -`currentItemLevel = C_Item.GetCurrentItemLevel(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin* 🔗 - -**Returns:** -- `currentItemLevel` - - *number?* - -**Example Usage:** -This function can be used to determine the current item level of an item in a specific location, such as a player's inventory or equipped gear. This is particularly useful for addons that need to display or compare item levels. - -**Addon Usage:** -- **Pawn**: This popular addon uses `C_Item.GetCurrentItemLevel` to help players determine which items are upgrades by comparing item levels and other stats. -- **SimulationCraft**: This addon uses the function to export a player's current gear setup, including item levels, for simulation purposes. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemGUID.md b/wiki-information/functions/C_Item.GetItemGUID.md deleted file mode 100644 index b936bb32..00000000 --- a/wiki-information/functions/C_Item.GetItemGUID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Item.GetItemGUID - -**Content:** -Needs summary. -`itemGuid = C_Item.GetItemGUID(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin* 🔗 - -**Returns:** -- `itemGUID` - - *string* - ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemID.md b/wiki-information/functions/C_Item.GetItemID.md deleted file mode 100644 index 455bca46..00000000 --- a/wiki-information/functions/C_Item.GetItemID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.GetItemID - -**Content:** -Needs summary. -`itemID = C_Item.GetItemID(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin*🔗 - -**Returns:** -- `itemID` - - *number* - -**Example Usage:** -This function can be used to retrieve the unique item ID of an item located in a specific inventory slot. For instance, if you want to get the item ID of the item equipped in the main hand slot, you can use this function with the appropriate `ItemLocationMixin`. - -**Addons:** -Many large addons, such as TradeSkillMaster (TSM), use this function to identify items in the player's inventory or bank to manage auctions, inventory, and crafting operations. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemIDForItemInfo.md b/wiki-information/functions/C_Item.GetItemIDForItemInfo.md deleted file mode 100644 index 81e5fc74..00000000 --- a/wiki-information/functions/C_Item.GetItemIDForItemInfo.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_Item.GetItemIDForItemInfo - -**Content:** -Needs summary. -`itemID = C_Item.GetItemIDForItemInfo(itemInfo)` - -**Parameters:** -- `itemInfo` - - *number|string* - -**Returns:** -- `itemID` - - *number* - -**Description:** -This function retrieves the item ID for a given item information input, which can be either an item ID or an item link. - -**Example Usage:** -```lua -local itemID = C_Item.GetItemIDForItemInfo("item:168185::::::::120:253::13::::") -- Returns the item ID for the given item link -print(itemID) -- Output: 168185 -``` - -**Use in Addons:** -Many addons that deal with item management, such as inventory or auction house addons, use this function to convert item links or other item information into a standardized item ID for further processing. For example, the popular addon "Auctioneer" might use this function to identify items for auction data analysis. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemIcon.md b/wiki-information/functions/C_Item.GetItemIcon.md deleted file mode 100644 index c5b5f0b4..00000000 --- a/wiki-information/functions/C_Item.GetItemIcon.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_Item.GetItemIcon - -**Content:** -Needs summary. -```lua -icon = C_Item.GetItemIcon(itemLocation) -icon = C_Item.GetItemIconByID(itemInfo) -``` - -**Parameters:** - -*GetItemIcon:* -- `itemLocation` - - *ItemLocationMixin* - -*GetItemIconByID:* -- `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `icon` - - *number?* : FileID - -**Reference:** -- `GetItemIcon()` - -**Example Usage:** -This function can be used to retrieve the icon of an item, which can be useful for displaying item icons in custom UI elements or addons. - -**Addon Usage:** -Large addons like **WeakAuras** and **ElvUI** might use this function to display item icons dynamically based on the player's inventory or equipment. For instance, WeakAuras could use it to show an icon of a specific item when certain conditions are met, enhancing the visual feedback for players. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemIconByID.md b/wiki-information/functions/C_Item.GetItemIconByID.md deleted file mode 100644 index a0af8bc6..00000000 --- a/wiki-information/functions/C_Item.GetItemIconByID.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_Item.GetItemIcon - -**Content:** -Needs summary. -```lua -icon = C_Item.GetItemIcon(itemLocation) -icon = C_Item.GetItemIconByID(itemInfo) -``` - -**Parameters:** - -*GetItemIcon:* -- `itemLocation` - - *ItemLocationMixin* - -*GetItemIconByID:* -- `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `icon` - - *number?* : FileID - -**Reference:** -- `GetItemIcon()` - -**Example Usage:** -This function can be used to retrieve the icon of an item, which can be useful for displaying item icons in custom UI elements or addons. - -**Addon Usage:** -Large addons like **WeakAuras** and **ElvUI** use this function to display item icons dynamically based on the player's inventory or equipment. For example, WeakAuras might use it to show an icon of a specific item when certain conditions are met, enhancing the visual feedback for players. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemInventoryType.md b/wiki-information/functions/C_Item.GetItemInventoryType.md deleted file mode 100644 index 3c3405ad..00000000 --- a/wiki-information/functions/C_Item.GetItemInventoryType.md +++ /dev/null @@ -1,163 +0,0 @@ -## Title: C_Item.GetItemInventoryType - -**Content:** -Needs summary. -`inventoryType = C_Item.GetItemInventoryType(itemLocation)` -`inventoryType = C_Item.GetItemInventoryTypeByID(itemInfo)` - -**Parameters:** -- **GetItemInventoryType:** - - `itemLocation` - - *ItemLocationMixin* - -- **GetItemInventoryTypeByID:** - - `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `inventoryType` - - *Enum.InventoryType* - - **Value** - - **Field** - - **ItemEquipLocGlobalString (enUS)** - - **InvSlotId** - - `0` - - **IndexNonEquipType** - - `INVTYPE_NON_EQUIP` - - Non-equippable - - `1` - - **IndexHeadType** - - `INVTYPE_HEAD` - - Head - - `2` - - **IndexNeckType** - - `INVTYPE_NECK` - - Neck - - `3` - - **IndexShoulderType** - - `INVTYPE_SHOULDER` - - Shoulder - - `4` - - **IndexBodyType** - - `INVTYPE_BODY` - - Shirt - - `5` - - **IndexChestType** - - `INVTYPE_CHEST` - - Chest - - `6` - - **IndexWaistType** - - `INVTYPE_WAIST` - - Waist - - `7` - - **IndexLegsType** - - `INVTYPE_LEGS` - - Legs - - `8` - - **IndexFeetType** - - `INVTYPE_FEET` - - Feet - - `9` - - **IndexWristType** - - `INVTYPE_WRIST` - - Wrist - - `10` - - **IndexHandType** - - `INVTYPE_HAND` - - Hands - - `11` - - **IndexFingerType** - - `INVTYPE_FINGER` - - Finger - - `12` - - **IndexTrinketType** - - `INVTYPE_TRINKET` - - Trinket - - `13` - - **IndexWeaponType** - - `INVTYPE_WEAPON` - - One-Hand - - `14` - - **IndexShieldType** - - `INVTYPE_SHIELD` - - Off Hand - - `15` - - **IndexRangedType** - - `INVTYPE_RANGED` - - Ranged - - `16` - - **IndexCloakType** - - `INVTYPE_CLOAK` - - Back - - `17` - - **Index2HweaponType** - - `INVTYPE_2HWEAPON` - - Two-Hand - - `18` - - **IndexBagType** - - `INVTYPE_BAG` - - Bag - - `19` - - **IndexTabardType** - - `INVTYPE_TABARD` - - Tabard - - `20` - - **IndexRobeType** - - `INVTYPE_ROBE` - - Chest - - `21` - - **IndexWeaponmainhandType** - - `INVTYPE_WEAPONMAINHAND` - - Main Hand - - `22` - - **IndexWeaponoffhandType** - - `INVTYPE_WEAPONOFFHAND` - - Off Hand - - `23` - - **IndexHoldableType** - - `INVTYPE_HOLDABLE` - - Held In Off-hand - - `24` - - **IndexAmmoType** - - `INVTYPE_AMMO` - - Ammo - - `25` - - **IndexThrownType** - - `INVTYPE_THROWN` - - Thrown - - `26` - - **IndexRangedrightType** - - `INVTYPE_RANGEDRIGHT` - - Ranged - - `27` - - **IndexQuiverType** - - `INVTYPE_QUIVER` - - Quiver - - `28` - - **IndexRelicType** - - `INVTYPE_RELIC` - - Relic - - `29` - - **IndexProfessionToolType** - - `INVTYPE_PROFESSION_TOOL` - - Profession Tool - - `30` - - **IndexProfessionGearType** - - `INVTYPE_PROFESSION_GEAR` - - Profession Equipment - - `31` - - **IndexEquipablespellOffensiveType** - - `INVTYPE_EQUIPABLESPELL_OFFENSIVE` - - Equipable Spell - Offensive - - `32` - - **IndexEquipablespellUtilityType** - - `INVTYPE_EQUIPABLESPELL_UTILITY` - - Equipable Spell - Utility - - `33` - - **IndexEquipablespellDefensiveType** - - `INVTYPE_EQUIPABLESPELL_DEFENSIVE` - - Equipable Spell - Defensive - - `34` - - **IndexEquipablespellWeaponType** - - `INVTYPE_EQUIPABLESPELL_WEAPON` - - Equipable Spell - Weapon \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemInventoryTypeByID.md b/wiki-information/functions/C_Item.GetItemInventoryTypeByID.md deleted file mode 100644 index 3c3405ad..00000000 --- a/wiki-information/functions/C_Item.GetItemInventoryTypeByID.md +++ /dev/null @@ -1,163 +0,0 @@ -## Title: C_Item.GetItemInventoryType - -**Content:** -Needs summary. -`inventoryType = C_Item.GetItemInventoryType(itemLocation)` -`inventoryType = C_Item.GetItemInventoryTypeByID(itemInfo)` - -**Parameters:** -- **GetItemInventoryType:** - - `itemLocation` - - *ItemLocationMixin* - -- **GetItemInventoryTypeByID:** - - `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `inventoryType` - - *Enum.InventoryType* - - **Value** - - **Field** - - **ItemEquipLocGlobalString (enUS)** - - **InvSlotId** - - `0` - - **IndexNonEquipType** - - `INVTYPE_NON_EQUIP` - - Non-equippable - - `1` - - **IndexHeadType** - - `INVTYPE_HEAD` - - Head - - `2` - - **IndexNeckType** - - `INVTYPE_NECK` - - Neck - - `3` - - **IndexShoulderType** - - `INVTYPE_SHOULDER` - - Shoulder - - `4` - - **IndexBodyType** - - `INVTYPE_BODY` - - Shirt - - `5` - - **IndexChestType** - - `INVTYPE_CHEST` - - Chest - - `6` - - **IndexWaistType** - - `INVTYPE_WAIST` - - Waist - - `7` - - **IndexLegsType** - - `INVTYPE_LEGS` - - Legs - - `8` - - **IndexFeetType** - - `INVTYPE_FEET` - - Feet - - `9` - - **IndexWristType** - - `INVTYPE_WRIST` - - Wrist - - `10` - - **IndexHandType** - - `INVTYPE_HAND` - - Hands - - `11` - - **IndexFingerType** - - `INVTYPE_FINGER` - - Finger - - `12` - - **IndexTrinketType** - - `INVTYPE_TRINKET` - - Trinket - - `13` - - **IndexWeaponType** - - `INVTYPE_WEAPON` - - One-Hand - - `14` - - **IndexShieldType** - - `INVTYPE_SHIELD` - - Off Hand - - `15` - - **IndexRangedType** - - `INVTYPE_RANGED` - - Ranged - - `16` - - **IndexCloakType** - - `INVTYPE_CLOAK` - - Back - - `17` - - **Index2HweaponType** - - `INVTYPE_2HWEAPON` - - Two-Hand - - `18` - - **IndexBagType** - - `INVTYPE_BAG` - - Bag - - `19` - - **IndexTabardType** - - `INVTYPE_TABARD` - - Tabard - - `20` - - **IndexRobeType** - - `INVTYPE_ROBE` - - Chest - - `21` - - **IndexWeaponmainhandType** - - `INVTYPE_WEAPONMAINHAND` - - Main Hand - - `22` - - **IndexWeaponoffhandType** - - `INVTYPE_WEAPONOFFHAND` - - Off Hand - - `23` - - **IndexHoldableType** - - `INVTYPE_HOLDABLE` - - Held In Off-hand - - `24` - - **IndexAmmoType** - - `INVTYPE_AMMO` - - Ammo - - `25` - - **IndexThrownType** - - `INVTYPE_THROWN` - - Thrown - - `26` - - **IndexRangedrightType** - - `INVTYPE_RANGEDRIGHT` - - Ranged - - `27` - - **IndexQuiverType** - - `INVTYPE_QUIVER` - - Quiver - - `28` - - **IndexRelicType** - - `INVTYPE_RELIC` - - Relic - - `29` - - **IndexProfessionToolType** - - `INVTYPE_PROFESSION_TOOL` - - Profession Tool - - `30` - - **IndexProfessionGearType** - - `INVTYPE_PROFESSION_GEAR` - - Profession Equipment - - `31` - - **IndexEquipablespellOffensiveType** - - `INVTYPE_EQUIPABLESPELL_OFFENSIVE` - - Equipable Spell - Offensive - - `32` - - **IndexEquipablespellUtilityType** - - `INVTYPE_EQUIPABLESPELL_UTILITY` - - Equipable Spell - Utility - - `33` - - **IndexEquipablespellDefensiveType** - - `INVTYPE_EQUIPABLESPELL_DEFENSIVE` - - Equipable Spell - Defensive - - `34` - - **IndexEquipablespellWeaponType** - - `INVTYPE_EQUIPABLESPELL_WEAPON` - - Equipable Spell - Weapon \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemLink.md b/wiki-information/functions/C_Item.GetItemLink.md deleted file mode 100644 index e858438d..00000000 --- a/wiki-information/functions/C_Item.GetItemLink.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Item.GetItemLink - -**Content:** -Needs summary. -`itemLink = C_Item.GetItemLink(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin* 🔗 - -**Returns:** -- `itemLink` - - *string?* : ItemLink \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemMaxStackSize.md b/wiki-information/functions/C_Item.GetItemMaxStackSize.md deleted file mode 100644 index 927b72a8..00000000 --- a/wiki-information/functions/C_Item.GetItemMaxStackSize.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.GetItemMaxStackSize - -**Content:** -Needs summary. -`stackSize = C_Item.GetItemMaxStackSize(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin* - -**Returns:** -- `stackSize` - - *number?* - -**Example Usage:** -This function can be used to determine the maximum stack size of an item at a given location, which is useful for inventory management addons. - -**Addons:** -Large addons like Bagnon or ArkInventory might use this function to display or manage item stacks within the player's inventory. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md b/wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md deleted file mode 100644 index 401fc999..00000000 --- a/wiki-information/functions/C_Item.GetItemMaxStackSizeByID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.GetItemMaxStackSizeByID - -**Content:** -Needs summary. -`stackSize = C_Item.GetItemMaxStackSizeByID(itemInfo)` - -**Parameters:** -- `itemInfo` - - *string* - -**Returns:** -- `stackSize` - - *number?* - -**Example Usage:** -This function can be used to determine the maximum stack size of an item in World of Warcraft. For instance, if you want to know how many potions you can stack in one inventory slot, you can use this function to get that information. - -**Addon Usage:** -Large addons like Auctioneer may use this function to determine how many items can be listed in a single auction stack, optimizing the auction creation process for users. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemName.md b/wiki-information/functions/C_Item.GetItemName.md deleted file mode 100644 index 46100b2e..00000000 --- a/wiki-information/functions/C_Item.GetItemName.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Item.GetItemName - -**Content:** -Needs summary. -```lua -itemName = C_Item.GetItemName(itemLocation) -itemName = C_Item.GetItemNameByID(itemInfo) -``` - -**Parameters:** - -**GetItemName:** -- `itemLocation` - - *ItemLocationMixin* - -**GetItemNameByID:** -- `itemInfo` - - *number|string* - Item ID, Link or Name - -**Returns:** -- `itemName` - - *string?* - -**Example Usage:** -This function can be used to retrieve the name of an item based on its location or ID. For instance, if you have an item in your inventory and you want to display its name in a custom UI element, you can use `C_Item.GetItemName` to get the name and then display it. - -**Addons:** -Many large addons like **WeakAuras** and **TradeSkillMaster** use similar functions to display item names dynamically based on user interactions or inventory changes. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemNameByID.md b/wiki-information/functions/C_Item.GetItemNameByID.md deleted file mode 100644 index 0d925cba..00000000 --- a/wiki-information/functions/C_Item.GetItemNameByID.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_Item.GetItemName - -**Content:** -Needs summary. -`itemName = C_Item.GetItemName(itemLocation)` -`itemName = C_Item.GetItemNameByID(itemInfo)` - -**Parameters:** -- **GetItemName:** - - `itemLocation` - - *ItemLocationMixin* - -- **GetItemNameByID:** - - `itemInfo` - - *number|string* - Item ID, Link, or Name - -**Returns:** -- `itemName` - - *string?* - -**Description:** -The `C_Item.GetItemName` function retrieves the name of an item based on its location or ID. This can be particularly useful for addons that need to display item names dynamically, such as inventory management addons or tooltip enhancements. - -**Example Usage:** -```lua -local itemLocation = ItemLocation:CreateFromBagAndSlot(bag, slot) -local itemName = C_Item.GetItemName(itemLocation) -print("Item Name: ", itemName) - -local itemID = 12345 -local itemNameByID = C_Item.GetItemNameByID(itemID) -print("Item Name by ID: ", itemNameByID) -``` - -**Addons Using This Function:** -- **Bagnon:** An inventory management addon that uses this function to display item names in the player's bags. -- **TipTac:** A tooltip enhancement addon that uses this function to show item names in tooltips. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemQuality.md b/wiki-information/functions/C_Item.GetItemQuality.md deleted file mode 100644 index a2a204e4..00000000 --- a/wiki-information/functions/C_Item.GetItemQuality.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_Item.GetItemQuality - -**Content:** -Needs summary. -`itemQuality = C_Item.GetItemQuality(itemLocation)` -`itemQuality = C_Item.GetItemQualityByID(itemInfo)` - -**Parameters:** -- **GetItemQuality:** - - `itemLocation` - - *ItemLocationMixin* - -- **GetItemQualityByID:** - - `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `itemQuality` - - *Enum.ItemQuality* - - **Value** - - **Field** - - **GlobalString (enUS)** - - `0` - - Poor - - ITEM_QUALITY0_DESC - - `1` - - Common - - ITEM_QUALITY1_DESC - - `2` - - Uncommon - - ITEM_QUALITY2_DESC - - `3` - - Rare - - ITEM_QUALITY3_DESC - - `4` - - Epic - - ITEM_QUALITY4_DESC - - `5` - - Legendary - - ITEM_QUALITY5_DESC - - `6` - - Artifact - - ITEM_QUALITY6_DESC - - `7` - - Heirloom - - ITEM_QUALITY7_DESC - - `8` - - WoW Token - - ITEM_QUALITY8_DESC - -**Reference:** -`GetItemQualityColor()` \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetItemQualityByID.md b/wiki-information/functions/C_Item.GetItemQualityByID.md deleted file mode 100644 index d20ff1d4..00000000 --- a/wiki-information/functions/C_Item.GetItemQualityByID.md +++ /dev/null @@ -1,62 +0,0 @@ -## Title: C_Item.GetItemQuality - -**Content:** -Needs summary. -```lua -itemQuality = C_Item.GetItemQuality(itemLocation) -itemQuality = C_Item.GetItemQualityByID(itemInfo) -``` - -**Parameters:** - -**GetItemQuality:** -- `itemLocation` - - *ItemLocationMixin* - -**GetItemQualityByID:** -- `itemInfo` - - *number|string* - Item ID, Link, or Name - -**Returns:** -- `itemQuality` - - *Enum.ItemQuality* - - `Value` - - `Field` - - `GlobalString (enUS)` - - `0` - - Poor - - ITEM_QUALITY0_DESC - - `1` - - Common - - ITEM_QUALITY1_DESC - - `2` - - Uncommon - - ITEM_QUALITY2_DESC - - `3` - - Rare - - ITEM_QUALITY3_DESC - - `4` - - Epic - - ITEM_QUALITY4_DESC - - `5` - - Legendary - - ITEM_QUALITY5_DESC - - `6` - - Artifact - - ITEM_QUALITY6_DESC - - `7` - - Heirloom - - ITEM_QUALITY7_DESC - - `8` - - WoW Token - - ITEM_QUALITY8_DESC - -**Reference:** -- `GetItemQualityColor()` - -**Example Usage:** -This function can be used to determine the quality of an item, which is useful for addons that need to display item quality or filter items based on their quality. For instance, an addon that manages inventory might use this function to sort items by quality or to highlight high-quality items. - -**Addons Using This Function:** -- **Bagnon**: A popular inventory management addon that uses item quality to color-code items in the player's bags. -- **Auctioneer**: An addon that helps players with auction house activities, which might use item quality to determine pricing strategies for different items. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.GetStackCount.md b/wiki-information/functions/C_Item.GetStackCount.md deleted file mode 100644 index 09ba2632..00000000 --- a/wiki-information/functions/C_Item.GetStackCount.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.GetStackCount - -**Content:** -Needs summary. -`stackCount = C_Item.GetStackCount(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin* - -**Returns:** -- `stackCount` - - *number* - -**Example Usage:** -This function can be used to determine the number of items in a specific item location, such as a bag slot or bank slot. For instance, if you want to check how many potions you have in a specific bag slot, you can use this function to get that count. - -**Addon Usage:** -Large addons like Bagnon, which manage and display inventory, might use this function to display the stack count of items in the player's bags and bank. This helps in providing a clear and concise view of the player's inventory. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsBound.md b/wiki-information/functions/C_Item.IsBound.md deleted file mode 100644 index b189d5db..00000000 --- a/wiki-information/functions/C_Item.IsBound.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Item.IsBound - -**Content:** -Needs summary. -`isBound = C_Item.IsBound(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin* - The location of the item to be checked. - -**Returns:** -- `isBound` - - *boolean* - Whether or not the item is soul- or accountbound. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsItemDataCached.md b/wiki-information/functions/C_Item.IsItemDataCached.md deleted file mode 100644 index 244c0823..00000000 --- a/wiki-information/functions/C_Item.IsItemDataCached.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.IsItemDataCached - -**Content:** -Needs summary. -`isCached = C_Item.IsItemDataCached(itemLocation)` -`isCached = C_Item.IsItemDataCachedByID(itemInfo)` - -**Parameters:** -- **IsItemDataCached:** - - `itemLocation` - - *ItemLocationMixin* - -- **IsItemDataCachedByID:** - - `itemInfo` - - *string* : ItemLink or ID - -**Returns:** -- `isCached` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsItemDataCachedByID.md b/wiki-information/functions/C_Item.IsItemDataCachedByID.md deleted file mode 100644 index 244c0823..00000000 --- a/wiki-information/functions/C_Item.IsItemDataCachedByID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.IsItemDataCached - -**Content:** -Needs summary. -`isCached = C_Item.IsItemDataCached(itemLocation)` -`isCached = C_Item.IsItemDataCachedByID(itemInfo)` - -**Parameters:** -- **IsItemDataCached:** - - `itemLocation` - - *ItemLocationMixin* - -- **IsItemDataCachedByID:** - - `itemInfo` - - *string* : ItemLink or ID - -**Returns:** -- `isCached` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Item.IsLocked.md b/wiki-information/functions/C_Item.IsLocked.md deleted file mode 100644 index 839baa4c..00000000 --- a/wiki-information/functions/C_Item.IsLocked.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Item.IsLocked - -**Content:** -Needs summary. -`isLocked = C_Item.IsLocked(itemLocation)` - -**Parameters:** -- `itemLocation` - - *ItemLocationMixin*🔗 - -**Returns:** -- `isLocked` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific item in a player's inventory is currently locked (e.g., due to being in use or being a quest item). - -**Addon Usage:** -Large addons like **Bagnon** or **ArkInventory** might use this function to determine the lock status of items when displaying inventory grids, ensuring that locked items are visually distinct or handled differently in the UI. \ No newline at end of file diff --git a/wiki-information/functions/C_Item.LockItem.md b/wiki-information/functions/C_Item.LockItem.md deleted file mode 100644 index 1a5fa349..00000000 --- a/wiki-information/functions/C_Item.LockItem.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Item.LockItem - -**Content:** -Needs summary. -`C_Item.LockItem(itemLocation)` -`C_Item.LockItemByGUID(itemGUID)` - -**Parameters:** - -**LockItem:** -- `itemLocation` - - *ItemLocationMixin* - -**LockItemByGUID:** -- `itemGUID` - - *string* : ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.LockItemByGUID.md b/wiki-information/functions/C_Item.LockItemByGUID.md deleted file mode 100644 index d7bd6086..00000000 --- a/wiki-information/functions/C_Item.LockItemByGUID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Item.LockItem - -**Content:** -Needs summary. -`C_Item.LockItem(itemLocation)` -`C_Item.LockItemByGUID(itemGUID)` - -**Parameters:** - -**LockItem:** -- `itemLocation` - - *ItemLocationMixin* - -**LockItemByGUID:** -- `itemGUID` - - *string* - ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.RequestLoadItemData.md b/wiki-information/functions/C_Item.RequestLoadItemData.md deleted file mode 100644 index 0006464a..00000000 --- a/wiki-information/functions/C_Item.RequestLoadItemData.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Item.RequestLoadItemData - -**Content:** -Requests item data and fires `ITEM_DATA_LOAD_RESULT`. -```lua -C_Item.RequestLoadItemData(itemLocation) -C_Item.RequestLoadItemDataByID(itemInfo) -``` - -**Parameters:** -- **RequestLoadItemData:** - - `itemLocation` - - *ItemLocationMixin* - -- **RequestLoadItemDataByID:** - - `itemInfo` - - *string* : ItemLink or ID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.RequestLoadItemDataByID.md b/wiki-information/functions/C_Item.RequestLoadItemDataByID.md deleted file mode 100644 index 0006464a..00000000 --- a/wiki-information/functions/C_Item.RequestLoadItemDataByID.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_Item.RequestLoadItemData - -**Content:** -Requests item data and fires `ITEM_DATA_LOAD_RESULT`. -```lua -C_Item.RequestLoadItemData(itemLocation) -C_Item.RequestLoadItemDataByID(itemInfo) -``` - -**Parameters:** -- **RequestLoadItemData:** - - `itemLocation` - - *ItemLocationMixin* - -- **RequestLoadItemDataByID:** - - `itemInfo` - - *string* : ItemLink or ID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.UnlockItem.md b/wiki-information/functions/C_Item.UnlockItem.md deleted file mode 100644 index b13399f8..00000000 --- a/wiki-information/functions/C_Item.UnlockItem.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Item.UnlockItem - -**Content:** -Needs summary. -`C_Item.UnlockItem(itemLocation)` -`C_Item.UnlockItemByGUID(itemGUID)` - -**Parameters:** - -**UnlockItem:** -- `itemLocation` - - *ItemLocationMixin* - -**UnlockItemByGUID:** -- `itemGUID` - - *string* : ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_Item.UnlockItemByGUID.md b/wiki-information/functions/C_Item.UnlockItemByGUID.md deleted file mode 100644 index b13399f8..00000000 --- a/wiki-information/functions/C_Item.UnlockItemByGUID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Item.UnlockItem - -**Content:** -Needs summary. -`C_Item.UnlockItem(itemLocation)` -`C_Item.UnlockItemByGUID(itemGUID)` - -**Parameters:** - -**UnlockItem:** -- `itemLocation` - - *ItemLocationMixin* - -**UnlockItemByGUID:** -- `itemGUID` - - *string* : ItemGUID \ No newline at end of file diff --git a/wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md b/wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md deleted file mode 100644 index a30f284b..00000000 --- a/wiki-information/functions/C_ItemSocketInfo.CompleteSocketing.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_ItemSocketInfo.CompleteSocketing - -**Content:** -Completes socketing an item, binding it to the player. -`C_ItemSocketInfo.CompleteSocketing()` - -**Example Usage:** -This function can be used in an addon to automate the process of socketing gems into an item. For instance, an addon could provide a user interface for selecting gems and then call this function to complete the socketing process. - -**Addons Using This Function:** -Large addons like Pawn use this function to help players optimize their gear by suggesting the best gems to socket and then automating the socketing process. \ No newline at end of file diff --git a/wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md b/wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md deleted file mode 100644 index d7c72354..00000000 --- a/wiki-information/functions/C_ItemUpgrade.GetItemHyperlink.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ItemUpgrade.GetItemHyperlink - -**Content:** -Returns an itemLink of the anticipated result from applying item upgrading using the ItemUpgradeFrame. -`link = C_ItemUpgrade.GetItemHyperlink()` - -**Returns:** -- `link` - - *string* - itemLink \ No newline at end of file diff --git a/wiki-information/functions/C_KeyBindings.GetBindingIndex.md b/wiki-information/functions/C_KeyBindings.GetBindingIndex.md deleted file mode 100644 index 1632e6a7..00000000 --- a/wiki-information/functions/C_KeyBindings.GetBindingIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_KeyBindings.GetBindingIndex - -**Content:** -Needs summary. -`bindingIndex = C_KeyBindings.GetBindingIndex(action)` - -**Parameters:** -- `action` - - *string* - -**Returns:** -- `bindingIndex` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_KeyBindings.GetCustomBindingType.md b/wiki-information/functions/C_KeyBindings.GetCustomBindingType.md deleted file mode 100644 index fa03e213..00000000 --- a/wiki-information/functions/C_KeyBindings.GetCustomBindingType.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_KeyBindings.GetCustomBindingType - -**Content:** -Returns the type of a custom binding. -`customBindingType = C_KeyBindings.GetCustomBindingType(bindingIndex)` - -**Parameters:** -- `bindingIndex` - - *number* - -**Returns:** -- `customBindingType` - - *Enum.CustomBindingType (nilable)* - - `Value` - - `Field` - - `Description` - - `0` - - VoicePushToTalk \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md b/wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md deleted file mode 100644 index 2e3ecf44..00000000 --- a/wiki-information/functions/C_LFGInfo.CanPlayerUseGroupFinder.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGInfo.CanPlayerUseGroupFinder - -**Content:** -Returns true if the player is allowed to use group finder tools, or false and a reason string if not. -`canUse, failureReason = C_LFGInfo.CanPlayerUseGroupFinder()` - -**Returns:** -- `canUse` - - *boolean* -- `failureReason` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md b/wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md deleted file mode 100644 index 9d4ba125..00000000 --- a/wiki-information/functions/C_LFGInfo.CanPlayerUseLFD.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGInfo.CanPlayerUseLFD - -**Content:** -Returns true if the player is allowed to queue for instanced dungeon content, or false and a reason string if not. -`canUse, failureReason = C_LFGInfo.CanPlayerUseLFD()` - -**Returns:** -- `canUse` - - *boolean* -- `failureReason` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md b/wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md deleted file mode 100644 index 21f71272..00000000 --- a/wiki-information/functions/C_LFGInfo.CanPlayerUseLFR.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGInfo.CanPlayerUseLFR - -**Content:** -Returns true if the player is allowed to queue for instanced raid content, or false and a reason string if not. -`canUse, failureReason = C_LFGInfo.CanPlayerUseLFR()` - -**Returns:** -- `canUse` - - *boolean* -- `failureReason` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md b/wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md deleted file mode 100644 index ab149481..00000000 --- a/wiki-information/functions/C_LFGInfo.CanPlayerUsePVP.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGInfo.CanPlayerUsePVP - -**Content:** -Returns true if the player is allowed to queue for instanced PvP content, or false and a reason string if not. -`canUse, failureReason = C_LFGInfo.CanPlayerUsePVP()` - -**Returns:** -- `canUse` - - *boolean* -- `failureReason` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md b/wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md deleted file mode 100644 index beffd7dc..00000000 --- a/wiki-information/functions/C_LFGInfo.CanPlayerUsePremadeGroup.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGInfo.CanPlayerUsePremadeGroup - -**Content:** -Returns true if the player is allowed to use the premade group finder, or false and a reason string if not. -`canUse, failureReason = C_LFGInfo.CanPlayerUsePremadeGroup()` - -**Returns:** -- `canUse` - - *boolean* -- `failureReason` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md b/wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md deleted file mode 100644 index 652d01ba..00000000 --- a/wiki-information/functions/C_LFGInfo.ConfirmLfgExpandSearch.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_LFGInfo.ConfirmLfgExpandSearch - -**Content:** -Needs summary. -`C_LFGInfo.ConfirmLfgExpandSearch()` - -**Description:** -This function is used to confirm the expansion of the search radius for the Looking For Group (LFG) system. When the LFG system cannot find a match within the initial search parameters, it may prompt the user to expand the search to include a wider range of potential matches. This function confirms that action. - -**Example Usage:** -An addon might use this function to automatically confirm the expansion of the search radius, ensuring that the player finds a group more quickly without manual intervention. - -**Addons:** -Large addons like "DBM (Deadly Boss Mods)" or "ElvUI" might use this function to enhance the LFG experience by automating certain aspects of the group-finding process. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md b/wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md deleted file mode 100644 index 10f38cbf..00000000 --- a/wiki-information/functions/C_LFGInfo.GetAllEntriesForCategory.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_LFGInfo.GetAllEntriesForCategory - -**Content:** -Returns any dungeons for a LFG category you're queued up for. -`lfgDungeonIDs = C_LFGInfo.GetAllEntriesForCategory(category)` - -**Parameters:** -- `category` - - *number* - - *Enum* - - `Value` - - `Description` - - `LE_LFG_CATEGORY_LFD` - - *1* - Dungeon Finder - - `LE_LFG_CATEGORY_LFR` - - *2* - Other Raids - - `LE_LFG_CATEGORY_RF` - - *3* - Raid Finder - - `LE_LFG_CATEGORY_SCENARIO` - - *4* - Scenarios - - `LE_LFG_CATEGORY_FLEXRAID` - - *5* - Flexible Raid - - `LE_LFG_CATEGORY_WORLDPVP` - - *6* - Ashran - - `LE_LFG_CATEGORY_BATTLEFIELD` - - *7* - Brawl - -**Returns:** -- `lfgDungeonIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.GetLFDLockStates.md b/wiki-information/functions/C_LFGInfo.GetLFDLockStates.md deleted file mode 100644 index eaccbe33..00000000 --- a/wiki-information/functions/C_LFGInfo.GetLFDLockStates.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_LFGInfo.GetLFDLockStates - -**Content:** -Needs summary. -`lockInfo = C_LFGInfo.GetLFDLockStates()` - -**Returns:** -- `lockInfo` - - *LFGLockInfo* - - `Field` - - `Type` - - `Description` - - `lfgID` - - *number* - - `reason` - - *number* - index. See LFG_INSTANCE_INVALID_CODES - - `hideEntry` - - *boolean* - -**Example Usage:** -This function can be used to retrieve the lockout states for various LFG (Looking For Group) instances. This is useful for determining which instances a player is locked out of and the reasons for the lockout. - -**Addon Usage:** -Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to display lockout information to players, helping them manage their dungeon and raid lockouts more effectively. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md b/wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md deleted file mode 100644 index 34a5e217..00000000 --- a/wiki-information/functions/C_LFGInfo.GetRoleCheckDifficultyDetails.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGInfo.GetRoleCheckDifficultyDetails - -**Content:** -Needs summary. -`maxLevel, isLevelReduced = C_LFGInfo.GetRoleCheckDifficultyDetails()` - -**Returns:** -- `maxLevel` - - *number?* -- `isLevelReduced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.HideNameFromUI.md b/wiki-information/functions/C_LFGInfo.HideNameFromUI.md deleted file mode 100644 index 9f722186..00000000 --- a/wiki-information/functions/C_LFGInfo.HideNameFromUI.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: C_LFGInfo.HideNameFromUI - -**Content:** -Returns true if a dungeon name has to be hidden in the UI. -`shouldHide = C_LFGInfo.HideNameFromUI(dungeonID)` - -**Parameters:** -- `dungeonID` - - *number* - -**Returns:** -- `shouldHide` - - *boolean* - -**Description:** -List of IDs where `shouldHide` is true. -- **ID**: 1030 - - **Name**: 7.0 Artifacts - Sub Rog - Acquisition - Demonic Portal World - - **DifficultyID**: 12: Normal Scenario -- **ID**: 1090 - - **Name**: Boost 2.0 R&D - - **DifficultyID**: 12: Normal Scenario -- **ID**: 1307 - - **Name**: Tideskorn Harbor Acquisition Scenarios - JMC - - **DifficultyID**: 12: Normal Scenario -- **ID**: 1309 - - **Name**: Shield's Rest Acquisition Scenarios - JMC - - **DifficultyID**: 12: Normal Scenario -- **ID**: 1371 - - **Name**: Priest Order Formation - JMC - - **DifficultyID**: 12: Normal Scenario -- **ID**: 1381 - - **Name**: Blade in Twilight - - **DifficultyID**: 12: Normal Scenario -- **ID**: 1382 - - **Name**: Sword of Kings - - **DifficultyID**: 12: Normal Scenario -- **ID**: 1436 - - **Name**: 7.2 Broken Shore Intro - Legion Command Ship (KMS) - - **DifficultyID**: 12: Normal Scenario \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md b/wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md deleted file mode 100644 index 5da3c211..00000000 --- a/wiki-information/functions/C_LFGInfo.IsGroupFinderEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGInfo.IsGroupFinderEnabled - -**Content:** -Needs summary. -`enabled = C_LFGInfo.IsGroupFinderEnabled()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md b/wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md deleted file mode 100644 index e8a9ab2b..00000000 --- a/wiki-information/functions/C_LFGInfo.IsInLFGFollowerDungeon.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGInfo.IsInLFGFollowerDungeon - -**Content:** -Needs summary. -`result = C_LFGInfo.IsInLFGFollowerDungeon()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsLFDEnabled.md b/wiki-information/functions/C_LFGInfo.IsLFDEnabled.md deleted file mode 100644 index e7b60ed5..00000000 --- a/wiki-information/functions/C_LFGInfo.IsLFDEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGInfo.IsLFDEnabled - -**Content:** -Needs summary. -`enabled = C_LFGInfo.IsLFDEnabled()` - -**Returns:** -- `enabled` - - *boolean* - Indicates whether the Looking For Dungeon (LFD) system is enabled. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md b/wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md deleted file mode 100644 index 41ed5684..00000000 --- a/wiki-information/functions/C_LFGInfo.IsLFGFollowerDungeon.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_LFGInfo.IsLFGFollowerDungeon - -**Content:** -Needs summary. -`result = C_LFGInfo.IsLFGFollowerDungeon(dungeonID)` - -**Parameters:** -- `dungeonID` - - *number* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsLFREnabled.md b/wiki-information/functions/C_LFGInfo.IsLFREnabled.md deleted file mode 100644 index 287fe9ca..00000000 --- a/wiki-information/functions/C_LFGInfo.IsLFREnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGInfo.IsLFREnabled - -**Content:** -Needs summary. -`enabled = C_LFGInfo.IsLFREnabled()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md b/wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md deleted file mode 100644 index b17f26ff..00000000 --- a/wiki-information/functions/C_LFGInfo.IsPremadeGroupEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGInfo.IsPremadeGroupEnabled - -**Content:** -Needs summary. -`enabled = C_LFGInfo.IsPremadeGroupEnabled()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ApplyToGroup.md b/wiki-information/functions/C_LFGList.ApplyToGroup.md deleted file mode 100644 index e331f7d1..00000000 --- a/wiki-information/functions/C_LFGList.ApplyToGroup.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_LFGList.ApplyToGroup - -**Content:** -Needs summary. -`C_LFGList.ApplyToGroup(resultID)` - -**Parameters:** -- `resultID` - - *number* -- `tankOK` - - *boolean?* -- `healerOK` - - *boolean?* -- `damageOK` - - *boolean?* - -**Example Usage:** -This function can be used to apply to a group in the Looking For Group (LFG) system. For instance, if you find a group you want to join, you can use this function to send an application to that group. - -**Addons:** -Large addons like **Deadly Boss Mods (DBM)** and **ElvUI** might use this function to automate group applications or to enhance the LFG experience by providing additional UI elements or notifications. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md b/wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md deleted file mode 100644 index fc348170..00000000 --- a/wiki-information/functions/C_LFGList.CanActiveEntryUseAutoAccept.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGList.CanActiveEntryUseAutoAccept - -**Content:** -Needs summary. -`canUseAutoAccept = C_LFGList.CanActiveEntryUseAutoAccept()` - -**Returns:** -- `canUseAutoAccept` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.CanCreateQuestGroup.md b/wiki-information/functions/C_LFGList.CanCreateQuestGroup.md deleted file mode 100644 index 2ed17118..00000000 --- a/wiki-information/functions/C_LFGList.CanCreateQuestGroup.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_LFGList.CanCreateQuestGroup - -**Content:** -Needs summary. -`canCreate = C_LFGList.CanCreateQuestGroup(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `canCreate` - - *boolean* - -**Example Usage:** -This function can be used to determine if a player can create a group for a specific quest using the Looking For Group (LFG) system. For instance, if you have a quest ID and want to check if you can create a group for it, you can use this function to get a boolean result. - -**Addons Usage:** -Large addons like "World Quest Tracker" might use this function to allow players to create groups for world quests directly from the quest tracker interface. This enhances the player's ability to find groups for completing world quests more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearApplicationTextFields.md b/wiki-information/functions/C_LFGList.ClearApplicationTextFields.md deleted file mode 100644 index 59d0cbf6..00000000 --- a/wiki-information/functions/C_LFGList.ClearApplicationTextFields.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_LFGList.ClearApplicationTextFields - -**Content:** -Needs summary. -`C_LFGList.ClearApplicationTextFields()` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearCreationTextFields.md b/wiki-information/functions/C_LFGList.ClearCreationTextFields.md deleted file mode 100644 index 3338b7d5..00000000 --- a/wiki-information/functions/C_LFGList.ClearCreationTextFields.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_LFGList.ClearCreationTextFields - -**Content:** -Needs summary. -`C_LFGList.ClearCreationTextFields()` - -**Description:** -This function is used to clear the text fields in the Looking For Group (LFG) creation interface. This can be useful when resetting the form or preparing it for a new entry. - -**Example Usage:** -```lua --- Clear the text fields in the LFG creation interface -C_LFGList.ClearCreationTextFields() -``` - -**Usage in Addons:** -Large addons like "Premade Groups Filter" might use this function to reset the LFG creation form when users are setting up new group listings. This ensures that no residual text from previous entries remains, providing a clean slate for new group descriptions and titles. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearSearchResults.md b/wiki-information/functions/C_LFGList.ClearSearchResults.md deleted file mode 100644 index 30df5844..00000000 --- a/wiki-information/functions/C_LFGList.ClearSearchResults.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_LFGList.ClearSearchResults - -**Content:** -Needs summary. -`C_LFGList.ClearSearchResults()` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ClearSearchTextFields.md b/wiki-information/functions/C_LFGList.ClearSearchTextFields.md deleted file mode 100644 index d32fad07..00000000 --- a/wiki-information/functions/C_LFGList.ClearSearchTextFields.md +++ /dev/null @@ -1,6 +0,0 @@ -## Title: C_LFGList.ClearSearchTextFields - -**Content:** -Needs summary. -`C_LFGList.ClearSearchTextFields()` - diff --git a/wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md b/wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md deleted file mode 100644 index ca3c9924..00000000 --- a/wiki-information/functions/C_LFGList.CopyActiveEntryInfoToCreationFields.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_LFGList.CopyActiveEntryInfoToCreationFields - -**Content:** -Needs summary. -`C_LFGList.CopyActiveEntryInfoToCreationFields()` - -**Description:** -This function is used to copy the information from an active LFG (Looking For Group) entry to the creation fields, which can be useful when you want to quickly recreate or edit an existing LFG entry without manually re-entering all the details. - -**Example Usage:** -An example use case for this function would be in an addon that helps players manage their LFG entries. If a player wants to quickly recreate a group with the same settings as a previous one, this function can be called to populate the creation fields with the previous entry's information. - -**Addons:** -Large addons like "Premade Groups Filter" or "LFG Bulletin Board" might use this function to streamline the process of creating and managing LFG entries, making it easier for players to find and join groups. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.CreateListing.md b/wiki-information/functions/C_LFGList.CreateListing.md deleted file mode 100644 index 0cb755a6..00000000 --- a/wiki-information/functions/C_LFGList.CreateListing.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_LFGList.CreateListing - -**Content:** -Creates a group finder listing. -`success = C_LFGList.CreateListing(activityID, itemLevel, honorLevel)` - -**Parameters:** -- `activityID` - - *number* : GroupFinderActivity.ID -- `itemLevel` - - *number* -- `honorLevel` - - *number* -- `autoAccept` - - *boolean?* -- `privateGroup` - - *boolean?* -- `questID` - - *number?* - -**Returns:** -- `success` - - *boolean* - Generally returns true if there was a valid group title. - -**Usage:** -Creates a group listing for "Custom PvE". Requires the title of the listing to have been typed manually, otherwise it silently fails. Setting the title is explicitly protected. -```lua -/run C_LFGList.CreateListing(16, 0, 0) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md b/wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md deleted file mode 100644 index c085abda..00000000 --- a/wiki-information/functions/C_LFGList.DoesEntryTitleMatchPrebuiltTitle.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_LFGList.DoesEntryTitleMatchPrebuiltTitle - -**Content:** -Needs summary. -`matches = C_LFGList.DoesEntryTitleMatchPrebuiltTitle(activityID, groupID)` - -**Parameters:** -- `activityID` - - *number* -- `groupID` - - *number* -- `playstyle` - - *Enum.LFGEntryPlaystyle?* - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Standard - - `2` - - Casual - - `3` - - Hardcore - -**Returns:** -- `matches` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActiveEntryInfo.md b/wiki-information/functions/C_LFGList.GetActiveEntryInfo.md deleted file mode 100644 index 1115cfdc..00000000 --- a/wiki-information/functions/C_LFGList.GetActiveEntryInfo.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_LFGList.GetActiveEntryInfo - -**Content:** -Returns information about your currently listed group. -`entryData = C_LFGList.GetActiveEntryInfo()` - -**Returns:** -- `entryData` - - *LfgEntryData* - - `activityID` - - *number* - The activityID of the group. Use `C_LFGList.GetActivityInfo(activityID)` to get more information about the activity. This field is not present in Classic. - - `activityIDs` - - *number* - List of activity IDs for the listed group. This field is exclusive to Classic. - - `requiredItemLevel` - - *number* - Item level requirement for applications. Returns 0 if no requirement is set. - - `requiredHonorLevel` - - *number* - Honor level requirement for applications. - - `name` - - *string* - Protected string. - - `comment` - - *string* - Protected string. - - `voiceChat` - - *string* - Voice chat specified by group creator. Returns an empty string if no voice chat is specified. - - `duration` - - *number* - Expiration time of the group in seconds. Currently starts at 1800 seconds (30 minutes). If no player joins the group within this time, the group is delisted for inactivity. - - `autoAccept` - - *boolean* - If new applicants are automatically invited. - - `privateGroup` - - *boolean* - Indicates if the group is private. - - `questID` - - *number?* - Quest ID associated with the group, if any. - - `requiredDungeonScore` - - *number?* - Required dungeon score for applications. - - `requiredPvpRating` - - *number?* - Required PvP rating for applications. - - `playstyle` - - *Enum.LFGEntryPlaystyle?* - Playstyle of the group. - - `isCrossFactionListing` - - *boolean* - Indicates if the group is cross-faction. Added in 9.2.5. - -**Enum.LFGEntryPlaystyle:** -- `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Standard - - `2` - - Casual - - `3` - - Hardcore \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityFullName.md b/wiki-information/functions/C_LFGList.GetActivityFullName.md deleted file mode 100644 index d32e494f..00000000 --- a/wiki-information/functions/C_LFGList.GetActivityFullName.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_LFGList.GetActivityFullName - -**Content:** -Needs summary. -`fullName = C_LFGList.GetActivityFullName(activityID)` - -**Parameters:** -- `activityID` - - *number* -- `questID` - - *number?* -- `showWarmode` - - *boolean?* - -**Returns:** -- `fullName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityGroupInfo.md b/wiki-information/functions/C_LFGList.GetActivityGroupInfo.md deleted file mode 100644 index fdfa38f8..00000000 --- a/wiki-information/functions/C_LFGList.GetActivityGroupInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_LFGList.GetActivityGroupInfo - -**Content:** -Returns info for an activity group. -`name, groupOrder = C_LFGList.GetActivityGroupInfo(groupID)` - -**Parameters:** -- `groupID` - - *number* - The groupID for which information are requested, as returned by `C_LFGList.GetAvailableActivityGroups()`. - -**Returns:** -- `name` - - *string* - Name of the group. -- `groupOrder` - - *number* - ? - -**Example Usage:** -This function can be used to retrieve the name and order of a specific activity group in the Looking For Group (LFG) system. For instance, if you have a group ID and want to display the name of the group in your addon, you can use this function to get that information. - -**Addons Using This Function:** -Large addons like **Deadly Boss Mods (DBM)** and **ElvUI** may use this function to display or organize LFG activities based on their group information. For example, DBM might use it to categorize different raid activities, while ElvUI could use it to enhance the user interface for LFG activities. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityInfo.md b/wiki-information/functions/C_LFGList.GetActivityInfo.md deleted file mode 100644 index ffddb3da..00000000 --- a/wiki-information/functions/C_LFGList.GetActivityInfo.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: C_LFGList.GetActivityInfo - -**Content:** -Returns information about an activity for premade groups. -`fullName, shortName, categoryID, groupID, itemLevel, filters, minLevel, maxPlayers, displayType, orderIndex, useHonorLevel, showQuickJoinToast, isMythicPlusActivity, isRatedPvpActivity, isCurrentRaidActivity = C_LFGList.GetActivityInfo(activityID)` - -**Parameters:** -- `activityID` - - *number* : GroupFinderActivity.ID - The activityID for which information is requested, as returned by `C_LFGList.GetAvailableActivities()`. - -**Returns:** -- `fullName` - - *string* - Full name of the activity. -- `shortName` - - *string* - Short name of the activity, for example just "World Bosses" instead of the fullName "World Bosses (Pandaria)". -- `categoryID` - - *number* - The categoryID of this activity, as returned by `C_LFGList.GetAvailableCategories()`. -- `groupID` - - *number* - The groupID of this activity, as returned by `C_LFGList.GetAvailableActivityGroups()`. -- `itemLevel` - - *number* - Minimum item level required for this activity. Returns 0 if no requirement. -- `filters` - - *number* - Bit mask of filters for this activity. See details. -- `minLevel` - - *number* - Minimum level required for this activity. -- `maxPlayers` - - *number* - Maximum number of players allowed for this activity. -- `displayType` - - *number* - The display type ID for this activity. See details. -- `orderIndex` - - *number* - How the activity is ordered. See details. -- `useHonorLevel` - - *boolean* -- `showQuickJoinToast` - - *boolean* -- `isMythicPlusActivity` - - *boolean* -- `isRatedPvpActivity` - - *boolean* -- `isCurrentRaidActivity` - - *boolean* - -**Description:** -**DisplayType:** -The display type determines how the current size of a group is displayed in the list. This number ranges from 1 to NUM_LE_LFG_LIST_DISPLAY_TYPES: -- `LE_LFG_LIST_DISPLAY_TYPE_ROLE_COUNT` - - *1* - Display how many of each class role are present in the group. This is used for custom groups, for example. -- `LE_LFG_LIST_DISPLAY_TYPE_ROLE_ENUMERATE` - - *2* - Each present and each missing player in the group is depicted with a role icon. This is used for 5-man dungeons, for example. -- `LE_LFG_LIST_DISPLAY_TYPE_CLASS_ENUMERATE` - - *3* - ? -- `LE_LFG_LIST_DISPLAY_TYPE_HIDE_ALL` - - *4* - Hide all group size indicators. -- `LE_LFG_LIST_DISPLAY_TYPE_PLAYER_COUNT` - - *5* - Only display the total number of players in the group. This is used for questing groups, for example. - -**ActivityOrder:** -Please add any available information to this section. - -**Miscellaneous:** -**Filters:** -Please add any available information to this section. -- `LE_LFG_LIST_FILTER_RECOMMENDED` - - *1* - ? -- `LE_LFG_LIST_FILTER_NOT_RECOMMENDED` - - *2* - ? -- `LE_LFG_LIST_FILTER_PVE` - - *4* - ? -- `LE_LFG_LIST_FILTER_PVP` - - *8* - ? \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md b/wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md deleted file mode 100644 index c3e142c2..00000000 --- a/wiki-information/functions/C_LFGList.GetActivityInfoExpensive.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_LFGList.GetActivityInfoExpensive - -**Content:** -Returns the zone associated with an activity. -`currentArea = C_LFGList.GetActivityInfoExpensive(activityID)` - -**Parameters:** -- `activityID` - - *number* - The activityID for which information is requested, as returned by `C_LFGList.GetAvailableActivities()`. - -**Returns:** -- `currentArea` - - *boolean* - True if you are in the zone of the activity, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetActivityInfoTable.md b/wiki-information/functions/C_LFGList.GetActivityInfoTable.md deleted file mode 100644 index b9e75e9f..00000000 --- a/wiki-information/functions/C_LFGList.GetActivityInfoTable.md +++ /dev/null @@ -1,78 +0,0 @@ -## Title: C_LFGList.GetActivityInfoTable - -**Content:** -Needs summary. -`activityInfo = C_LFGList.GetActivityInfoTable(activityID)` - -**Parameters:** -- `activityID` - - *number* -- `questID` - - *number?* -- `showWarmode` - - *boolean?* - -**Returns:** -- `activityInfo` - - *GroupFinderActivityInfo* - - `Field` - - `Type` - - `Description` - - `fullName` - - *string* - - `shortName` - - *string* - - `categoryID` - - *number* - - `groupFinderActivityGroupID` - - *number* - - `ilvlSuggestion` - - *number* - - `filters` - - *number* - - `minLevel` - - *number* - - `maxNumPlayers` - - *number* - - `displayType` - - *Enum.LFGListDisplayType* - - `orderIndex` - - *number* - - `useHonorLevel` - - *boolean* - - `showQuickJoinToast` - - *boolean* - - `isMythicPlusActivity` - - *boolean* - - `isRatedPvpActivity` - - *boolean* - - `isCurrentRaidActivity` - - *boolean* - - `isPvpActivity` - - *boolean* - - `isMythicActivity` - - *boolean* - - `allowCrossFaction` - - *boolean* - - *Added in 9.2.5* - - `useDungeonRoleExpectations` - - *boolean* - - *Added in 10.0.0* - -**Enum.LFGListDisplayType:** -- `Value` -- `Field` -- `Description` -- `0` - - *RoleCount* -- `1` - - *RoleEnumerate* -- `2` - - *ClassEnumerate* -- `3` - - *HideAll* -- `4` - - *PlayerCount* -- `5` - - *Comment* - - *Added in 10.0.0* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md b/wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md deleted file mode 100644 index c06892d1..00000000 --- a/wiki-information/functions/C_LFGList.GetApplicantDungeonScoreForListing.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_LFGList.GetApplicantDungeonScoreForListing - -**Content:** -Needs summary. -`bestDungeonScoreForListing = C_LFGList.GetApplicantDungeonScoreForListing(localID, applicantIndex, activityID)` - -**Parameters:** -- `localID` - - *number* -- `applicantIndex` - - *number* -- `activityID` - - *number* - -**Returns:** -- `bestDungeonScoreForListing` - - *BestDungeonScoreMapInfo* - - `Field` - - `Type` - - `Description` - - `mapScore` - - *number* - - `mapName` - - *string* - - `bestRunLevel` - - *number* - - `finishedSuccess` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantInfo.md b/wiki-information/functions/C_LFGList.GetApplicantInfo.md deleted file mode 100644 index cdb39da6..00000000 --- a/wiki-information/functions/C_LFGList.GetApplicantInfo.md +++ /dev/null @@ -1,48 +0,0 @@ -## Title: C_LFGList.GetApplicantInfo - -**Content:** -Returns status information and a custom message of an applicant. -`applicantData = C_LFGList.GetApplicantInfo(applicantID)` - -**Parameters:** -- `applicantID` - - *number* - Ascending number of applicants since the creation of the activity. - -**Returns:** -- `applicantData` - - *structure* - LfgApplicantData - - `Field` - - `Type` - - `Description` - - `applicantID` - - *number* - Same as applicantID or nil - - `applicationStatus` - - *string* - - `pendingApplicationStatus` - - *string?* - "applied", "cancelled" - - `numMembers` - - *number* - 1 or higher if a group - - `isNew` - - *boolean* - - `comment` - - *string* - Applicant custom message - - `displayOrderID` - - *number* - - `applicationStatus` - - *Value* - Description - - `applied` - - `invited` - - `failed` - - `cancelled` - - `declined` - - `declined_full` - - `declined_delisted` - - `timedout` - - `inviteaccepted` - - `invitedeclined` - -**Example Usage:** -This function can be used to retrieve detailed information about an applicant to a group activity, such as a dungeon or raid. For instance, it can be used to display the applicant's status and custom message in a custom LFG (Looking For Group) addon. - -**Addons Using This Function:** -Large addons like "ElvUI" and "DBM" (Deadly Boss Mods) may use this function to manage group applications and display relevant information to the user. For example, ElvUI could use it to enhance the LFG interface, while DBM might use it to track the status of group members. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md b/wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md deleted file mode 100644 index 703602cb..00000000 --- a/wiki-information/functions/C_LFGList.GetApplicantMemberInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: C_LFGList.GetApplicantMemberInfo - -**Content:** -Returns info for an applicant. -`name, class, localizedClass, level, itemLevel, honorLevel, tank, healer, damage, assignedRole, relationship, dungeonScore, pvpItemLevel = C_LFGList.GetApplicantMemberInfo(applicantID, memberIndex)` - -**Parameters:** -- `applicantID` - - *number* - ascending number of applicants since creation of the activity returned by `C_LFGList.GetApplicants()` -- `memberIndex` - - *number* - iteration of `C_LFGList.GetApplicants()` argument #4 (numMembers) - -**Returns:** -1. `name` - - *string* - Character name and realm -2. `class` - - *string* - English class name (uppercase) -3. `localizedClass` - - *string* - Localized class name -4. `level` - - *number* -5. `itemLevel` - - *number* -6. `honorLevel` - - *number* -7. `tank` - - *boolean* - true if applicant offers tank role -8. `healer` - - *boolean* - true if applicant offers healer role -9. `damage` - - *boolean* - true if applicant offers damage role -10. `assignedRole` - - *string* - English role name (uppercase) -11. `relationship` - - *boolean?* - true if a friend, otherwise nil -12. `dungeonScore` - - *number* -13. `pvpItemLevel` - - *number* - -**Example Usage:** -This function can be used to retrieve detailed information about applicants for a group activity in the Looking For Group (LFG) system. For instance, an addon could use this to display a list of applicants along with their roles, item levels, and other relevant information to help the group leader make informed decisions about who to invite. - -**Addons Using This Function:** -- **ElvUI**: This popular UI overhaul addon uses `C_LFGList.GetApplicantMemberInfo` to enhance the LFG interface, providing more detailed information about applicants directly in the UI. -- **Raider.IO**: This addon uses the function to fetch and display dungeon scores and other relevant information about applicants, helping group leaders to assess the suitability of applicants for high-level Mythic+ dungeons. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantMemberStats.md b/wiki-information/functions/C_LFGList.GetApplicantMemberStats.md deleted file mode 100644 index 354e7af1..00000000 --- a/wiki-information/functions/C_LFGList.GetApplicantMemberStats.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_LFGList.GetApplicantMemberStats - -**Content:** -Returns the Proving Grounds stats of an applicant. -`stats = C_LFGList.GetApplicantMemberStats(applicantID, memberIndex)` - -**Parameters:** -- `applicantID` - - *number* - ascending number of applicants since creation of the activity returned by `C_LFGList.GetApplicants()` -- `memberIndex` - - *number* - iteration of `C_LFGList.GetApplicants()` argument #4 (numMembers) - -**Returns:** -- `stats` - - *table* - -**Description:** -Currently used to check proving ground stats of an applicant group member -- **Entry** - - **PG Tank** - - `stats>0` - Gold - - `stats>0` - Silver - - `stats>0` - Bronze -- **Entry** - - **PG Healer** - - `stats>0` - Gold - - `stats>0` - Silver - - `stats>0` - Bronze -- **Entry** - - **PG Damage** - - `stats>0` - Gold - - `stats>0` - Silver - - `stats>0` - Bronze - -**Reference:** -- `C_LFGList.GetApplicants()` -- `C_LFGList.GetApplicantMemberInfo(applicantID)` \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md b/wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md deleted file mode 100644 index 7bec2de4..00000000 --- a/wiki-information/functions/C_LFGList.GetApplicantPvpRatingInfoForListing.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_LFGList.GetApplicantPvpRatingInfoForListing - -**Content:** -Needs summary. -`pvpRatingInfo = C_LFGList.GetApplicantPvpRatingInfoForListing(localID, applicantIndex, activityID)` - -**Parameters:** -- `localID` - - *number* -- `applicantIndex` - - *number* -- `activityID` - - *number* - -**Returns:** -- `pvpRatingInfo` - - *PvpRatingInfo* - - `Field` - - `Type` - - `Description` - - `bracket` - - *number* - - `rating` - - *number* - - `activityName` - - *string* - - `tier` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetApplicants.md b/wiki-information/functions/C_LFGList.GetApplicants.md deleted file mode 100644 index a34e80a7..00000000 --- a/wiki-information/functions/C_LFGList.GetApplicants.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_LFGList.GetApplicants - -**Content:** -Returns the list of applicants to your group. -`applicants = C_LFGList.GetApplicants()` - -**Returns:** -- `applicants` - - *table* - a simple table with applicantIDs (numbers) - -**Example Usage:** -This function can be used to retrieve the list of players who have applied to join your group in the Looking For Group (LFG) system. For instance, you can loop through the returned table to get details about each applicant. - -```lua -local applicants = C_LFGList.GetApplicants() -for _, applicantID in ipairs(applicants) do - -- Process each applicantID - print("Applicant ID:", applicantID) -end -``` - -**Addon Usage:** -Large addons like "ElvUI" and "DBM" (Deadly Boss Mods) may use this function to manage group applications more effectively, providing custom notifications or automating group management tasks based on the list of applicants. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetAvailableActivities.md b/wiki-information/functions/C_LFGList.GetAvailableActivities.md deleted file mode 100644 index eadfe0c7..00000000 --- a/wiki-information/functions/C_LFGList.GetAvailableActivities.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_LFGList.GetAvailableActivities - -**Content:** -Returns a list of available LFG activities. -`activities = C_LFGList.GetAvailableActivities()` - -**Parameters:** -- `categoryID` - - *number?* - Use to only get activityIDs associated with a specific category. Use `C_LFGList.GetAvailableCategories()` to get a list of all available categoryIDs. If omitted, the function returns activities of all categories. -- `groupID` - - *number?* - Use to only get activityIDs associated with a specific group. See `C_LFGList.GetActivityGroupInfo` for more information. If omitted, the function returns activities of all groups. -- `filter` - - *number?* - Bit mask to filter the results. See `C_LFGList.GetActivityInfo` for more information. - -**Returns:** -- `activities` - - *table* - A table containing the requested activityIDs (not in order). \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md b/wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md deleted file mode 100644 index 35dbcf93..00000000 --- a/wiki-information/functions/C_LFGList.GetAvailableActivityGroups.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_LFGList.GetAvailableActivityGroups - -**Content:** -Returns a list of available LFG groups. -`groups = C_LFGList.GetAvailableActivityGroups(categoryID)` - -**Parameters:** -- `categoryID` - - *number* - The categoryID of the category you want to get available groups of. Use `C_LFGList.GetAvailableCategories()` to get a list of all available categoryIDs. -- `filter` - - *number?* - Bit mask to filter the results. See `C_LFGList.GetActivityInfo` for more information. - -**Returns:** -- `groups` - - *table* - A table containing the requested groupIDs (not in order). \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetAvailableCategories.md b/wiki-information/functions/C_LFGList.GetAvailableCategories.md deleted file mode 100644 index f060fd8f..00000000 --- a/wiki-information/functions/C_LFGList.GetAvailableCategories.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_LFGList.GetAvailableCategories - -**Content:** -Returns a list of available LFG categories. -`categories = C_LFGList.GetAvailableCategories()` - -**Parameters:** -- `filter` - - *number?* - Bit mask to filter the results. If omitted the function returns all categories. See `C_LFGList.GetActivityInfo` for more information. - -**Returns:** -- `categories` - - *table* - A table containing the requested categoryIDs (not in order). \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetCategoryInfo.md b/wiki-information/functions/C_LFGList.GetCategoryInfo.md deleted file mode 100644 index 45c8ec43..00000000 --- a/wiki-information/functions/C_LFGList.GetCategoryInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_LFGList.GetCategoryInfo - -**Content:** -Returns information about a specific category. Each category can contain many activity groups, which can contain many activities. -`name, separateRecommended, autoChoose, preferCurrentArea = C_LFGList.GetCategoryInfo(categoryID)` - -**Parameters:** -- `categoryID` - - *number* - The categoryID of the category you want to query. Use `C_LFGList.GetAvailableCategories()` to get a list of all available categoryIDs. - -**Returns:** -- `name` - - *string* - The name of the category. -- `separateRecommended` - - *boolean* -- `autoChoose` - - *boolean* -- `preferCurrentArea` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetFilteredSearchResults.md b/wiki-information/functions/C_LFGList.GetFilteredSearchResults.md deleted file mode 100644 index ba1bc197..00000000 --- a/wiki-information/functions/C_LFGList.GetFilteredSearchResults.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGList.GetFilteredSearchResults - -**Content:** -Needs summary. -`totalResultsFound, filteredResults = C_LFGList.GetFilteredSearchResults()` - -**Returns:** -- `totalResultsFound` - - *number?* = 0 -- `filteredResults` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetKeystoneForActivity.md b/wiki-information/functions/C_LFGList.GetKeystoneForActivity.md deleted file mode 100644 index 830f8a3e..00000000 --- a/wiki-information/functions/C_LFGList.GetKeystoneForActivity.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_LFGList.GetKeystoneForActivity - -**Content:** -Needs summary. -`level = C_LFGList.GetKeystoneForActivity(activityID)` - -**Parameters:** -- `activityID` - - *number* - -**Returns:** -- `level` - - *number* - -**Example Usage:** -This function can be used to retrieve the keystone level for a specific activity in the Looking For Group (LFG) system. For instance, if you have an activity ID for a Mythic+ dungeon, you can use this function to get the keystone level required for that activity. - -**Addons Usage:** -Large addons like **Raider.IO** and **Mythic Dungeon Tools** might use this function to display or calculate the keystone levels for various activities, helping players to find suitable groups for their Mythic+ runs. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md b/wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md deleted file mode 100644 index 30cae712..00000000 --- a/wiki-information/functions/C_LFGList.GetLfgCategoryInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_LFGList.GetLfgCategoryInfo - -**Content:** -Needs summary. -`categoryData = C_LFGList.GetLfgCategoryInfo(categoryID)` - -**Parameters:** -- `categoryID` - - *number* - -**Returns:** -- `categoryData` - - *LfgCategoryData* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `searchPromptOverride` - - *string?* - - `separateRecommended` - - *boolean* - - `autoChooseActivity` - - *boolean* - - `preferCurrentArea` - - *boolean* - - `showPlaystyleDropdown` - - *boolean* - - `allowCrossFaction` - - *boolean* - -**Added in 9.2.5** \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetRoles.md b/wiki-information/functions/C_LFGList.GetRoles.md deleted file mode 100644 index 3cecde2f..00000000 --- a/wiki-information/functions/C_LFGList.GetRoles.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_LFGList.GetRoles - -**Content:** -Returns the currently selected Group Finder roles as a table. -`roles = C_LFGList.GetRoles()` - -**Returns:** -- `roles` - - *table* - - `Key` (*string*) - - `Value` (*boolean*) - - `dps` - - true/false - - `healer` - - true/false - - `tank` - - true/false \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetSearchResultInfo.md b/wiki-information/functions/C_LFGList.GetSearchResultInfo.md deleted file mode 100644 index a0495507..00000000 --- a/wiki-information/functions/C_LFGList.GetSearchResultInfo.md +++ /dev/null @@ -1,109 +0,0 @@ -## Title: C_LFGList.GetSearchResultInfo - -**Content:** -Needs summary. -`searchResultData = C_LFGList.GetSearchResultInfo(searchResultID)` - -**Parameters:** -- `searchResultID` - - *number* - -**Returns:** -- `searchResultData` - - *LfgSearchResultData* - - `Field` - - `Type` - - `Description` - - `searchResultID` - - *number* - - `activityID` - - *number* - Activity ID for the found group. This field is not present in Classic. - - `activityIDs` - - *number* - List of activity IDs for the found group. This field is exclusive to Classic. - - `leaderName` - - *string?* - - `name` - - *string* - Protected string - - `comment` - - *string* - Protected string - - `voiceChat` - - *string* - - `requiredItemLevel` - - *number* - - `requiredHonorLevel` - - *number* - - `hasSelf` - - *boolean* - Added in 10.0.0 - - `numMembers` - - *number* - - `numBNetFriends` - - *number* - - `numCharFriends` - - *number* - - `numGuildMates` - - *number* - - `isDelisted` - - *boolean* - - `autoAccept` - - *boolean* - - `isWarMode` - - *boolean* - - `age` - - *number* - - `questID` - - *number?* - - `leaderOverallDungeonScore` - - *number?* - - `leaderDungeonScoreInfo` - - *BestDungeonScoreMapInfo?* - - `leaderPvpRatingInfo` - - *PvpRatingInfo?* - - `requiredDungeonScore` - - *number?* - - `requiredPvpRating` - - *number?* - - `playstyle` - - *Enum.LFGEntryPlaystyle?* - - `crossFactionListing` - - *boolean?* - Added in 9.2.5 - - `leaderFactionGroup` - - *number* - Added in 9.2.5 - -**BestDungeonScoreMapInfo** -- `Field` -- `Type` -- `Description` -- `mapScore` - - *number* -- `mapName` - - *string* -- `bestRunLevel` - - *number* -- `finishedSuccess` - - *boolean* - -**PvpRatingInfo** -- `Field` -- `Type` -- `Description` -- `bracket` - - *number* -- `rating` - - *number* -- `activityName` - - *string* -- `tier` - - *number* - -**Enum.LFGEntryPlaystyle** -- `Value` -- `Field` -- `Description` -- `0` - - None -- `1` - - Standard -- `2` - - Casual -- `3` - - Hardcore \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.GetSearchResults.md b/wiki-information/functions/C_LFGList.GetSearchResults.md deleted file mode 100644 index 4f68f4b8..00000000 --- a/wiki-information/functions/C_LFGList.GetSearchResults.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGList.GetSearchResults - -**Content:** -Returns a table of search result IDs. -`totalResultsFound, results = C_LFGList.GetSearchResults()` - -**Returns:** -- `totalResultsFound` - - *number?* = 0 - Total number of IDs inside results -- `results` - - *number* - Table of resultIDs \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.HasActiveEntryInfo.md b/wiki-information/functions/C_LFGList.HasActiveEntryInfo.md deleted file mode 100644 index 1a41f76a..00000000 --- a/wiki-information/functions/C_LFGList.HasActiveEntryInfo.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGList.HasActiveEntryInfo - -**Content:** -Needs summary. -`hasActiveEntryInfo = C_LFGList.HasActiveEntryInfo()` - -**Returns:** -- `hasActiveEntryInfo` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.HasSearchResultInfo.md b/wiki-information/functions/C_LFGList.HasSearchResultInfo.md deleted file mode 100644 index 39ae7548..00000000 --- a/wiki-information/functions/C_LFGList.HasSearchResultInfo.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_LFGList.HasSearchResultInfo - -**Content:** -Needs summary. -`hasSearchResultInfo = C_LFGList.HasSearchResultInfo(searchResultID)` - -**Parameters:** -- `searchResultID` - - *number* - -**Returns:** -- `hasSearchResultInfo` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.InviteApplicant.md b/wiki-information/functions/C_LFGList.InviteApplicant.md deleted file mode 100644 index 883f7209..00000000 --- a/wiki-information/functions/C_LFGList.InviteApplicant.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_LFGList.InviteApplicant - -**Content:** -Invites a queued applicant to your group. -`C_LFGList.InviteApplicant(applicantID)` - -**Parameters:** -- `applicantID` - - *number* - -**Reference:** -- 2014-10-14, LFGList.xml, version 6.0.2.19033, near line 281, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md b/wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md deleted file mode 100644 index 7ad100c3..00000000 --- a/wiki-information/functions/C_LFGList.IsPlayerAuthenticatedForLFG.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_LFGList.IsPlayerAuthenticatedForLFG - -**Content:** -Needs summary. -`isAuthenticated = C_LFGList.IsPlayerAuthenticatedForLFG()` - -**Parameters:** -- `activityID` - - *number?* : GroupFinderActivity.ID - -**Returns:** -- `isAuthenticated` - - *boolean* - -**Example Usage:** -This function can be used to check if a player is authenticated for a specific activity in the Looking For Group (LFG) system. For instance, before attempting to join a group for a dungeon or raid, you can verify if the player meets the necessary authentication requirements. - -**Addons:** -Large addons like "Deadly Boss Mods (DBM)" and "ElvUI" might use this function to ensure that players meet the necessary criteria before allowing them to join specific group activities. This helps in maintaining the integrity and smooth functioning of group activities by ensuring all participants are properly authenticated. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.RemoveListing.md b/wiki-information/functions/C_LFGList.RemoveListing.md deleted file mode 100644 index 031e72b2..00000000 --- a/wiki-information/functions/C_LFGList.RemoveListing.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_LFGList.RemoveListing - -**Content:** -Needs summary. -`C_LFGList.RemoveListing()` - -**Description:** -This function is used to remove a listing from the Looking For Group (LFG) system. It is typically called when a player no longer wants their group to be listed for others to join. - -**Example Usage:** -A player might use this function to remove their group from the LFG listing after they have found enough members or decided to disband the group. - -**Addons:** -Large addons like "Premade Groups Filter" and "LFG Bulletin Board" might use this function to manage group listings dynamically based on user preferences and group status. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.RequestAvailableActivities.md b/wiki-information/functions/C_LFGList.RequestAvailableActivities.md deleted file mode 100644 index a652bb5b..00000000 --- a/wiki-information/functions/C_LFGList.RequestAvailableActivities.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_LFGList.RequestAvailableActivities - -**Content:** -Signals the server to request that it send the client information about available activities. -`C_LFGList.RequestAvailableActivities()` - -**Reference:** -- `LFG_LIST_AVAILABILITY_UPDATE`, when this information is available to the client - -**Description:** -This is a prerequisite for at least some of the `C_LFGList.GetAvailable*` functions to return meaningful data. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.SetRoles.md b/wiki-information/functions/C_LFGList.SetRoles.md deleted file mode 100644 index 810508f1..00000000 --- a/wiki-information/functions/C_LFGList.SetRoles.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_LFGList.SetRoles - -**Content:** -Sets the player's Group Finder roles -`success = C_LFGList.SetRoles(roles)` - -**Parameters:** -- `roles` - - *table* - A table with each role as a string key, and a boolean value for whether that role should be selected. All roles must be present in the table. - - `Key (string)` - - `Value (boolean)` - - `dps` - - true/false - - `healer` - - true/false - - `tank` - - true/false - -**Returns:** -- `success` - - *boolean* - Whether setting the roles was successful or not \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.SetSearchToQuestID.md b/wiki-information/functions/C_LFGList.SetSearchToQuestID.md deleted file mode 100644 index 8673295b..00000000 --- a/wiki-information/functions/C_LFGList.SetSearchToQuestID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_LFGList.SetSearchToQuestID - -**Content:** -Needs summary. -`C_LFGList.SetSearchToQuestID(questID)` - -**Parameters:** -- `questID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.UpdateListing.md b/wiki-information/functions/C_LFGList.UpdateListing.md deleted file mode 100644 index 78623b19..00000000 --- a/wiki-information/functions/C_LFGList.UpdateListing.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: C_LFGList.UpdateListing - -**Content:** -Updates information for the players' currently listed group. -```lua --- Retail -C_LFGList.UpdateListing(activityID, itemLevel, honorLevel, autoAccept, privateGroup) --- Classic -C_LFGList.UpdateListing(activityIDs) -``` - -**Parameters:** - -**Retail:** -- `activityID` - - *number* - Activity ID to register the group for. -- `itemLevel` - - *number* - Minimum required item level for group applicants. -- `honorLevel` - - *number* - Minimum required honor level for group applicants. -- `autoAccept` - - *boolean* - If true, new applicants will be automatically invited to join the group. -- `privateGroup` - - *boolean* - If true, the listing will only be visible to friends and guild members of players inside the group. -- `questID` - - *number?* - Optional quest ID to associate with the group listing. -- `mythicPlusRating` - - *number?* - Optional mythic plus rating needed to signup to the group listing. -- `pvpRating` - - *number?* - Optional pvp rating needed to signup to the group listing. -- `selectedPlaystyle` - - *number?* - Refers to Enum.LFGEntryPlaystyle values. -- `isCrossFaction` - - *boolean = true* - Optional. If false, the group listing will not be visible to players of the opposite faction. If nil, true will be assumed. - -**Classic:** -- `activityIDs` - - *number* - Table of up to three activity IDs to register the group listing for. - -**Description:** -For Classic, a player can register interest in a maximum of three activities at once. Other options for listings such as preferred item level, auto-accept, and private groups do not exist. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md b/wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md deleted file mode 100644 index 2a3ba9b5..00000000 --- a/wiki-information/functions/C_LFGList.ValidateRequiredDungeonScore.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_LFGList.ValidateRequiredDungeonScore - -**Content:** -Needs summary. -`passes = C_LFGList.ValidateRequiredDungeonScore(dungeonScore)` - -**Parameters:** -- `dungeonScore` - - *number* - -**Returns:** -- `passes` - - *boolean* - -**Example Usage:** -This function can be used to validate if a player's dungeon score meets the required threshold for a specific dungeon or activity in the Looking For Group (LFG) system. - -**Addons Usage:** -Large addons like **Raider.IO** might use this function to check if a player's dungeon score qualifies them for certain group activities or dungeons. This helps in automating the process of group formation based on player performance metrics. \ No newline at end of file diff --git a/wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md b/wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md deleted file mode 100644 index 285c0bd4..00000000 --- a/wiki-information/functions/C_LFGList.ValidateRequiredPvpRatingForActivity.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_LFGList.ValidateRequiredPvpRatingForActivity - -**Content:** -Needs summary. -`passes = C_LFGList.ValidateRequiredPvpRatingForActivity(activityID, rating)` - -**Parameters:** -- `activityID` - - *number* -- `rating` - - *number* - -**Returns:** -- `passes` - - *boolean* - -**Example Usage:** -This function can be used to check if a player's PvP rating meets the required rating for a specific activity in the Looking For Group (LFG) system. - -**Addons Usage:** -Large addons like "Premade Groups Filter" might use this function to filter out activities based on the player's PvP rating, ensuring that only eligible activities are shown to the player. \ No newline at end of file diff --git a/wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md b/wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md deleted file mode 100644 index ccb27eae..00000000 --- a/wiki-information/functions/C_Loot.IsLegacyLootModeEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Loot.IsLegacyLootModeEnabled - -**Content:** -Needs summary. -`isLegacyLootModeEnabled = C_Loot.IsLegacyLootModeEnabled()` - -**Returns:** -- `isLegacyLootModeEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LootHistory.GetItem.md b/wiki-information/functions/C_LootHistory.GetItem.md deleted file mode 100644 index 0ef773bd..00000000 --- a/wiki-information/functions/C_LootHistory.GetItem.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_LootHistory.GetItem - -**Content:** -Returns item details for a loot event. -`rollID, itemLink, numPlayers, isDone, winnerIdx, isMasterLoot = C_LootHistory.GetItem(itemIdx)` - -**Parameters:** -- `itemIdx` - - *number* - Loot history ID - -**Returns:** -- `rollID` - - *number* -- `itemLink` - - *string* -- `numPlayers` - - *number* - Total players eligible for item -- `isDone` - - *boolean* -- `winnerIdx` - - *number* - See C_LootHistory.GetPlayerInfo -- `isMasterLoot` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LootHistory.GetPlayerInfo.md b/wiki-information/functions/C_LootHistory.GetPlayerInfo.md deleted file mode 100644 index e46233af..00000000 --- a/wiki-information/functions/C_LootHistory.GetPlayerInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_LootHistory.GetPlayerInfo - -**Content:** -Returns player details for a loot event. -`name, class, rollType, roll, isWinner, isMe = C_LootHistory.GetPlayerInfo(itemIdx, playerIdx)` - -**Parameters:** -- `itemIdx` - - *number* - See `C_LootHistory.GetItem` - -**Returns:** -- `name` - - *string* -- `class` - - *string* -- `rollType` - - *number* - (0: pass, 1: need, 2: greed, 3: disenchant) -- `roll` - - *number* -- `isWinner` - - *boolean* -- `isMe` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md deleted file mode 100644 index f8f72d2a..00000000 --- a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlData.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title: C_LossOfControl.GetActiveLossOfControlData - -**Content:** -Returns info about an active loss-of-control effect. -`event = C_LossOfControl.GetActiveLossOfControlData(index)` -`event = C_LossOfControl.GetActiveLossOfControlDataByUnit(unitToken, index)` - -**Parameters:** - -*GetActiveLossOfControlData:* -- `index` - - *number* - Ranging from 1 to `C_LossOfControl.GetActiveLossOfControlDataCount()` - -*GetActiveLossOfControlDataByUnit:* -- `unitToken` - - *string* : UnitId - Only works while in commentator mode. -- `index` - - *number* - -**Returns:** -- `event` - - *LossOfControlData?* - - `Field` - - `Type` - - `Description` - - `locType` - - *string* - Effect type, e.g. "SCHOOL_INTERRUPT" - - `spellID` - - *number* - Spell ID causing the effect - - `displayText` - - *string* - Name of the effect, e.g. "Interrupted" - - `iconTexture` - - *number* - FileID - - `startTime` - - *number?* - Time at which this effect began, as per `GetTime()` - - `timeRemaining` - - *number?* - Number of seconds remaining. - - `duration` - - *number?* - Duration of the effect, in seconds. - - `lockoutSchool` - - *number* - Locked out spell school identifier; can be fed into `GetSchoolString()` to retrieve school name. - - `priority` - - *number* - - `displayType` - - *number* - An integer specifying how this event should be displayed to the player, per the Interface-configured options: - - 0: the effect should not be displayed. - - 1: the effect should be displayed as a brief alert when it occurs. - - 2: the effect should be displayed for its full duration. - -**Description:** -Loss of Control debuffs that are applied only while standing in an Area of Effect may not include a `startTime`, `timeRemaining` nor `duration` in the table returned. An example of this is Vol'zith the Whisperer's Yawning Gate ability. \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md deleted file mode 100644 index 52b5002f..00000000 --- a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataByUnit.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_LossOfControl.GetActiveLossOfControlData - -**Content:** -Returns info about an active loss-of-control effect. -```lua -event = C_LossOfControl.GetActiveLossOfControlData(index) -event = C_LossOfControl.GetActiveLossOfControlDataByUnit(unitToken, index) -``` - -**Parameters:** -- **GetActiveLossOfControlData:** - - `index` - - *number* - Ranging from 1 to `C_LossOfControl.GetActiveLossOfControlDataCount()` - -- **GetActiveLossOfControlDataByUnit:** - - `unitToken` - - *string* : UnitId - Only works while in commentator mode. - - `index` - - *number* - -**Returns:** -- `event` - - *LossOfControlData?* - - `Field` - - `Type` - - `Description` - - `locType` - - *string* - Effect type, e.g. "SCHOOL_INTERRUPT" - - `spellID` - - *number* - Spell ID causing the effect - - `displayText` - - *string* - Name of the effect, e.g. "Interrupted" - - `iconTexture` - - *number* - FileID - - `startTime` - - *number?* - Time at which this effect began, as per `GetTime()` - - `timeRemaining` - - *number?* - Number of seconds remaining. - - `duration` - - *number?* - Duration of the effect, in seconds. - - `lockoutSchool` - - *number* - Locked out spell school identifier; can be fed into `GetSchoolString()` to retrieve school name. - - `priority` - - *number* - - `displayType` - - *number* - An integer specifying how this event should be displayed to the player, per the Interface-configured options: - - 0: the effect should not be displayed. - - 1: the effect should be displayed as a brief alert when it occurs. - - 2: the effect should be displayed for its full duration. - -**Description:** -Loss of Control debuffs that are applied only while standing in an Area of Effect may not include a `startTime`, `timeRemaining` nor `duration` in the table returned. An example of this is Vol'zith the Whisperer's Yawning Gate ability. \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md deleted file mode 100644 index f8d207ff..00000000 --- a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCount.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_LossOfControl.GetActiveLossOfControlDataCount - -**Content:** -Returns the number of active loss-of-control effects. -`count = C_LossOfControl.GetActiveLossOfControlDataCount()` -`count = C_LossOfControl.GetActiveLossOfControlDataCountByUnit(unitToken)` - -**Parameters:** -- **GetActiveLossOfControlDataCount:** - - None - -- **GetActiveLossOfControlDataCountByUnit:** - - `unitToken` - - *string* : UnitId - Only works while in commentator mode. - -**Returns:** -- `count` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md b/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md deleted file mode 100644 index 25af75e5..00000000 --- a/wiki-information/functions/C_LossOfControl.GetActiveLossOfControlDataCountByUnit.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_LossOfControl.GetActiveLossOfControlDataCount - -**Content:** -Returns the number of active loss-of-control effects. -```lua -count = C_LossOfControl.GetActiveLossOfControlDataCount() -count = C_LossOfControl.GetActiveLossOfControlDataCountByUnit(unitToken) -``` - -**Parameters:** -- **GetActiveLossOfControlDataCount:** - - None - -- **GetActiveLossOfControlDataCountByUnit:** - - `unitToken` - - *string* : UnitId - Only works while in commentator mode. - -**Returns:** -- `count` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Mail.HasInboxMoney.md b/wiki-information/functions/C_Mail.HasInboxMoney.md deleted file mode 100644 index 8a982c2b..00000000 --- a/wiki-information/functions/C_Mail.HasInboxMoney.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Mail.HasInboxMoney - -**Content:** -Returns true if a mail has money attached. -`inboxItemHasMoneyAttached = C_Mail.HasInboxMoney(inboxIndex)` - -**Parameters:** -- `inboxIndex` - - *number* - -**Returns:** -- `inboxItemHasMoneyAttached` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific mail in the player's inbox contains money. This is useful for addons that manage mail, such as those that automate the collection of auction house sales or other financial transactions. - -**Addon Usage:** -Large addons like Postal use this function to help manage and display mail contents efficiently. Postal, for example, can use this function to highlight mails that contain money, making it easier for players to quickly identify and collect their earnings. \ No newline at end of file diff --git a/wiki-information/functions/C_Mail.IsCommandPending.md b/wiki-information/functions/C_Mail.IsCommandPending.md deleted file mode 100644 index 4a4b46a0..00000000 --- a/wiki-information/functions/C_Mail.IsCommandPending.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Mail.IsCommandPending - -**Content:** -Returns true if the current mail command is still processing. -`isCommandPending = C_Mail.IsCommandPending()` - -**Returns:** -- `isCommandPending` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetAreaInfo.md b/wiki-information/functions/C_Map.GetAreaInfo.md deleted file mode 100644 index beb42aa8..00000000 --- a/wiki-information/functions/C_Map.GetAreaInfo.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Map.GetAreaInfo - -**Content:** -Returns a map subzone name. -`name = C_Map.GetAreaInfo(areaID)` - -**Parameters:** -- `areaID` - - *number* - AreaTable.db2 - -**Returns:** -- `name` - - *string* - -**Reference:** -- `C_MapExplorationInfo.GetExploredAreaIDsAtPosition()` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetBestMapForUnit.md b/wiki-information/functions/C_Map.GetBestMapForUnit.md deleted file mode 100644 index d6ed231d..00000000 --- a/wiki-information/functions/C_Map.GetBestMapForUnit.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_Map.GetBestMapForUnit - -**Content:** -Returns the current UI map for the given unit. Only works for the player and group members. -`uiMapID = C_Map.GetBestMapForUnit(unitToken)` - -**Parameters:** -- `unitToken` - - *string* : UnitId - -**Returns:** -- `uiMapID` - - *number?* : UiMapID - Returns the "lowest" map the unit is on. For example, if a unit is in a microdungeon it will return that instead of the zone or continent map. - -**Description:** -Related API: -- `C_Map.GetMapInfo` -- `GetInstanceInfo` - -Related Events: -- `ZONE_CHANGED` -- `ZONE_CHANGED_NEW_AREA` - -**Usage:** -Prints the current map for the player. -```lua -/run local mapID = C_Map.GetBestMapForUnit("player"); print(format("You are in %s (%d)", C_Map.GetMapInfo(mapID).name, mapID)) --- You are in Stormwind City (84) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetBountySetIDForMap.md b/wiki-information/functions/C_Map.GetBountySetIDForMap.md deleted file mode 100644 index 483fc07a..00000000 --- a/wiki-information/functions/C_Map.GetBountySetIDForMap.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Map.GetBountySetIDForMap - -**Content:** -Needs summary. -`bountySetID = C_Map.GetBountySetIDForMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - -**Returns:** -- `bountySetID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetFallbackWorldMapID.md b/wiki-information/functions/C_Map.GetFallbackWorldMapID.md deleted file mode 100644 index bd0da331..00000000 --- a/wiki-information/functions/C_Map.GetFallbackWorldMapID.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: C_Map.GetFallbackWorldMapID - -**Content:** -Returns the world map id. -`uiMapID = C_Map.GetFallbackWorldMapID()` - -**Returns:** -- `uiMapID` - - *number* - UiMapID - - Returns 947 (Azeroth) \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md b/wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md deleted file mode 100644 index c9b3072c..00000000 --- a/wiki-information/functions/C_Map.GetMapArtBackgroundAtlas.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Map.GetMapArtBackgroundAtlas - -**Content:** -Returns the background atlas for a map. -`atlasName = C_Map.GetMapArtBackgroundAtlas(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* : UiMapID - - **Values:** - - `ID` | `Atlas` - - `993` | `AdventureMap_TileBg` - - `994` | `AdventureMap_TileBg` - - `1011` | `AdventureMap_TileBg` - - `1014` | `AdventureMap_TileBg` - - `1208` | `AdventureMap_TileBg` - - `1209` | `AdventureMap_TileBg` - - `1384` | `AdventureMap_TileBg` - - `1467` | `AdventureMap_TileBg` - -**Returns:** -- `atlasName` - - *string* - AtlasID \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md b/wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md deleted file mode 100644 index e4293176..00000000 --- a/wiki-information/functions/C_Map.GetMapArtHelpTextPosition.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_Map.GetMapArtHelpTextPosition - -**Content:** -Returns the position for the "Click to Zoom In" hint text on flight maps. -`position = C_Map.GetMapArtHelpTextPosition(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* : UiMapID - -**Returns:** -- `position` - - *Enum.MapCanvasPosition* - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - BottomLeft - - `2` - - BottomRight - - `3` - - TopLeft - - `4` - - TopRight \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtID.md b/wiki-information/functions/C_Map.GetMapArtID.md deleted file mode 100644 index 00402546..00000000 --- a/wiki-information/functions/C_Map.GetMapArtID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Map.GetMapArtID - -**Content:** -Returns the art for a (phased) map. -`uiMapArtID = C_Map.GetMapArtID(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `uiMapArtID` - - *number* - -**Example Usage:** -This function can be used to retrieve the art ID for a specific map, which can then be used to display the correct map art in a custom UI or addon. - -**Addon Usage:** -Large addons like "TomTom" or "HandyNotes" might use this function to ensure they are displaying the correct map art for phased areas, ensuring that waypoints and notes are accurately placed on the map. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtLayerTextures.md b/wiki-information/functions/C_Map.GetMapArtLayerTextures.md deleted file mode 100644 index b1cf60a5..00000000 --- a/wiki-information/functions/C_Map.GetMapArtLayerTextures.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Map.GetMapArtLayerTextures - -**Content:** -Returns the art layer textures for a map. -`textures = C_Map.GetMapArtLayerTextures(uiMapID, layerIndex)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID -- `layerIndex` - - *number* - -**Returns:** -- `textures` - - *number* - -**Description:** -This function is used to retrieve the textures for a specific art layer of a map. It can be useful for addons that need to display or manipulate map textures. - -**Example Usage:** -```lua -local uiMapID = 1415 -- Example map ID -local layerIndex = 1 -- Example layer index -local textures = C_Map.GetMapArtLayerTextures(uiMapID, layerIndex) -for i, texture in ipairs(textures) do - print("Texture " .. i .. ": " .. texture) -end -``` - -**Addons Using This Function:** -- **Mapster**: An addon that enhances the World Map. It uses this function to retrieve and display custom map textures. -- **HandyNotes**: An addon that adds custom notes to the world map. It may use this function to overlay additional textures on the map. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapArtLayers.md b/wiki-information/functions/C_Map.GetMapArtLayers.md deleted file mode 100644 index a7da9dae..00000000 --- a/wiki-information/functions/C_Map.GetMapArtLayers.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Map.GetMapArtLayers - -**Content:** -Returns the art layers for a map. -`layerInfo = C_Map.GetMapArtLayers(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `layerInfo` - - *UiMapLayerInfo* - - `Field` - - `Type` - - `Description` - - `layerWidth` - - *number* - - `layerHeight` - - *number* - - `tileWidth` - - *number* - - `tileHeight` - - *number* - - `minScale` - - *number* - - `maxScale` - - *number* - - `additionalZoomSteps` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapBannersForMap.md b/wiki-information/functions/C_Map.GetMapBannersForMap.md deleted file mode 100644 index f16868af..00000000 --- a/wiki-information/functions/C_Map.GetMapBannersForMap.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_Map.GetMapBannersForMap - -**Content:** -Returns the poi banners for a map. -`mapBanners = C_Map.GetMapBannersForMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `mapBanners` - - *MapBannerInfo* - - `Field` - - `Type` - - `Description` - - `areaPoiID` - - *number* - - `name` - - *string* - - `atlasName` - - *string* - - `uiTextureKit` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapChildrenInfo.md b/wiki-information/functions/C_Map.GetMapChildrenInfo.md deleted file mode 100644 index ee7d24c5..00000000 --- a/wiki-information/functions/C_Map.GetMapChildrenInfo.md +++ /dev/null @@ -1,109 +0,0 @@ -## Title: C_Map.GetMapChildrenInfo - -**Content:** -Returns info for the children of a map. -`info = C_Map.GetMapChildrenInfo(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID -- `mapType` - - *Enum.UIMapType?* - Filters results by a specific map type. -- `allDescendants` - - *boolean?* - Whether to recurse on each child or not. - -**Returns:** -- `info` - - *UiMapDetails* - - `Field` - - `Type` - - `Description` - - `mapID` - - *number* - UiMapID - - `name` - - *string* - - `mapType` - - *Enum.UIMapType* - - `parentMapID` - - *number* - Returns 0 if there is no parent map - - `flags` - - *Enum.UIMapFlag* - Added in 9.0.1 - -**Enum.UIMapType:** -- `Value` -- `Field` -- `Description` -- `0` - - Cosmic -- `1` - - World -- `2` - - Continent -- `3` - - Zone -- `4` - - Dungeon -- `5` - - Micro -- `6` - - Orphan - -**Enum.UIMapFlag:** -- `Value` -- `Field` -- `Description` -- `0x1` - - NoHighlight -- `0x2` - - ShowOverlays -- `0x4` - - ShowTaxiNodes -- `0x8` - - GarrisonMap -- `0x10` - - FallbackToParentMap -- `0x20` - - NoHighlightTexture -- `0x40` - - ShowTaskObjectives -- `0x80` - - NoWorldPositions -- `0x100` - - HideArchaeologyDigs -- `0x200` - - DoNotTranslateBranches (Renamed from Deprecated in 10.2.5) -- `0x400` - - HideIcons -- `0x800` - - HideVignettes -- `0x1000` - - ForceAllOverlayExplored -- `0x2000` - - FlightMapShowZoomOut -- `0x4000` - - FlightMapAutoZoom -- `0x8000` - - ForceOnNavbar -- `0x10000` - - AlwaysAllowUserWaypoints -- `0x20000` - - AlwaysAllowTaxiPathing - -**Usage:** -Children of the "Cosmic" uiMapID (not to be confused with the UIMapType). -```lua -/dump C_Map.GetMapChildrenInfo(946) -{ - {mapType=2, mapID=101, name="Outland", parentMapID=946}, - {mapType=2, mapID=572, name="Draenor", parentMapID=946}, - {mapType=1, mapID=947, name="Azeroth", parentMapID=946} -} -``` -Children of the "Cosmic" uiMapID with mapType==2 -```lua -/dump C_Map.GetMapChildrenInfo(946, 2) -{ - {mapType=2, mapID=101, name="Outland", parentMapID=946}, - {mapType=2, mapID=572, name="Draenor", parentMapID=946} -} -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapDisplayInfo.md b/wiki-information/functions/C_Map.GetMapDisplayInfo.md deleted file mode 100644 index 960fca04..00000000 --- a/wiki-information/functions/C_Map.GetMapDisplayInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Map.GetMapDisplayInfo - -**Content:** -Returns whether group member pins should be hidden. -`hideIcons = C_Map.GetMapDisplayInfo(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `hideIcons` - - *boolean* - -**Example Usage:** -This function can be used to determine if the map should hide group member icons, which can be useful for custom map displays or addons that modify the map interface. - -**Addon Usage:** -Large addons like "TomTom" or "HandyNotes" might use this function to decide whether to display group member icons on custom map overlays. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapGroupID.md b/wiki-information/functions/C_Map.GetMapGroupID.md deleted file mode 100644 index 925a82b9..00000000 --- a/wiki-information/functions/C_Map.GetMapGroupID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Map.GetMapGroupID - -**Content:** -Returns the map group for a map. -`uiMapGroupID = C_Map.GetMapGroupID(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `uiMapGroupID` - - *number* - -**Example Usage:** -This function can be used to determine the group ID of a specific map, which can be useful for addons that need to handle map-related data, such as displaying map overlays or managing map transitions. - -**Addons:** -Large addons like "TomTom" and "World Quest Tracker" might use this function to manage and display map-related information efficiently. For example, "TomTom" could use it to group waypoints by map group, while "World Quest Tracker" might use it to organize world quests by their map groups. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapGroupMembersInfo.md b/wiki-information/functions/C_Map.GetMapGroupMembersInfo.md deleted file mode 100644 index 6f249e4b..00000000 --- a/wiki-information/functions/C_Map.GetMapGroupMembersInfo.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_Map.GetMapGroupMembersInfo - -**Content:** -Returns the floors for a map group. -`info = C_Map.GetMapGroupMembersInfo(uiMapGroupID)` - -**Parameters:** -- `uiMapGroupID` - - *number* - -**Returns:** -- `info` - - *table* `UiMapGroupMemberInfo` - - `Field` - - `Type` - - `Description` - - `mapID` - - *number* - `UiMapID` - - `relativeHeightIndex` - - *number* - - `name` - - *string* - Floor name \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md b/wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md deleted file mode 100644 index ab2e07ff..00000000 --- a/wiki-information/functions/C_Map.GetMapHighlightInfoAtPosition.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_Map.GetMapHighlightInfoAtPosition - -**Content:** -Returns a map highlight pin for a location. -`fileDataID, atlasID, texturePercentageX, texturePercentageY, textureX, textureY, scrollChildX, scrollChildY = C_Map.GetMapHighlightInfoAtPosition(uiMapID, x, y)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID -- `x` - - *number* -- `y` - - *number* - -**Returns:** -- `fileDataID` - - *number* - FileDataID -- `atlasID` - - *string* - AtlasID -- `texturePercentageX` - - *number* -- `texturePercentageY` - - *number* -- `textureX` - - *number* -- `textureY` - - *number* -- `scrollChildX` - - *number* -- `scrollChildY` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapInfo.md b/wiki-information/functions/C_Map.GetMapInfo.md deleted file mode 100644 index 932dc585..00000000 --- a/wiki-information/functions/C_Map.GetMapInfo.md +++ /dev/null @@ -1,100 +0,0 @@ -## Title: C_Map.GetMapInfo - -**Content:** -Returns map information. -`info = C_Map.GetMapInfo(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* : UiMapID - -**Returns:** -- `info` - - *UiMapDetails* - - `Field` - - `Type` - - `Description` - - `mapID` - - *number* - UiMapID - - `name` - - *string* - - `mapType` - - *Enum.UIMapType* - - `parentMapID` - - *number* - Returns 0 if there is no parent map - - `flags` - - *Enum.UIMapFlag* - Added in 9.0.1 - -**Enum.UIMapType:** -- `Value` -- `Field` -- `Description` - - `0` - - Cosmic - - `1` - - World - - `2` - - Continent - - `3` - - Zone - - `4` - - Dungeon - - `5` - - Micro - - `6` - - Orphan - -**Enum.UIMapFlag:** -- `Value` -- `Field` -- `Description` - - `0x1` - - NoHighlight - - `0x2` - - ShowOverlays - - `0x4` - - ShowTaxiNodes - - `0x8` - - GarrisonMap - - `0x10` - - FallbackToParentMap - - `0x20` - - NoHighlightTexture - - `0x40` - - ShowTaskObjectives - - `0x80` - - NoWorldPositions - - `0x100` - - HideArchaeologyDigs - - `0x200` - - DoNotTranslateBranches (Renamed from Deprecated in 10.2.5) - - `0x400` - - HideIcons - - `0x800` - - HideVignettes - - `0x1000` - - ForceAllOverlayExplored - - `0x2000` - - FlightMapShowZoomOut - - `0x4000` - - FlightMapAutoZoom - - `0x8000` - - ForceOnNavbar - - `0x10000` - - AlwaysAllowUserWaypoints - - `0x20000` - - AlwaysAllowTaxiPathing - -**Description:** -- **Related API:** - - `C_Map.GetBestMapForUnit` -- **Related Events:** - - `ZONE_CHANGED` - - `ZONE_CHANGED_NEW_AREA` - -**Usage:** -Prints the current map for the player. -```lua -/run local mapID = C_Map.GetBestMapForUnit("player"); print(format("You are in %s (%d)", C_Map.GetMapInfo(mapID).name, mapID)) --- You are in Stormwind City (84) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapInfoAtPosition.md b/wiki-information/functions/C_Map.GetMapInfoAtPosition.md deleted file mode 100644 index 896c3b05..00000000 --- a/wiki-information/functions/C_Map.GetMapInfoAtPosition.md +++ /dev/null @@ -1,99 +0,0 @@ -## Title: C_Map.GetMapInfoAtPosition - -**Content:** -Returns info for any child or adjacent maps at a position on the map. -`info = C_Map.GetMapInfoAtPosition(uiMapID, x, y)` - -**Parameters:** -- `uiMapID` - - *number* : UiMapID -- `x` - - *number* -- `y` - - *number* -- `ignoreZoneMapPositionData` - - *boolean?* - -**Returns:** -- `info` - - *UiMapDetails* - - `Field` - - `Type` - - `Description` - - `mapID` - - *number* - UiMapID - - `name` - - *string* - - `mapType` - - *Enum.UIMapType* - - `parentMapID` - - *number* - Returns 0 if there is no parent map - - `flags` - - *Enum.UIMapFlag* - Added in 9.0.1 - -**Enum.UIMapType:** -- `Value` -- `Field` -- `Description` - - `0` - - Cosmic - - `1` - - World - - `2` - - Continent - - `3` - - Zone - - `4` - - Dungeon - - `5` - - Micro - - `6` - - Orphan - -**Enum.UIMapFlag:** -- `Value` -- `Field` -- `Description` - - `0x1` - - NoHighlight - - `0x2` - - ShowOverlays - - `0x4` - - ShowTaxiNodes - - `0x8` - - GarrisonMap - - `0x10` - - FallbackToParentMap - - `0x20` - - NoHighlightTexture - - `0x40` - - ShowTaskObjectives - - `0x80` - - NoWorldPositions - - `0x100` - - HideArchaeologyDigs - - `0x200` - - DoNotTranslateBranches (Renamed from Deprecated in 10.2.5) - - `0x400` - - HideIcons - - `0x800` - - HideVignettes - - `0x1000` - - ForceAllOverlayExplored - - `0x2000` - - FlightMapShowZoomOut - - `0x4000` - - FlightMapAutoZoom - - `0x8000` - - ForceOnNavbar - - `0x10000` - - AlwaysAllowUserWaypoints - - `0x20000` - - AlwaysAllowTaxiPathing - -**Description:** -No return value in instances, the WoD Garrison, the beginning of the new player experience, or empty regions of the cosmic map. -Otherwise, returns map info for: -- Child maps, such as zones in a continent. -- Adjacent maps, such as zones next to the current one. -- The current map, similar to `C_Map.GetMapInfo()`. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapLevels.md b/wiki-information/functions/C_Map.GetMapLevels.md deleted file mode 100644 index c17298dc..00000000 --- a/wiki-information/functions/C_Map.GetMapLevels.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Map.GetMapLevels - -**Content:** -Returns the suggested player and battle pet levels for a map. -`playerMinLevel, playerMaxLevel, petMinLevel, petMaxLevel = C_Map.GetMapLevels(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `playerMinLevel` - - *number* -- `playerMaxLevel` - - *number* -- `petMinLevel` - - *number?* = 0 -- `petMaxLevel` - - *number?* = 0 \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapLinksForMap.md b/wiki-information/functions/C_Map.GetMapLinksForMap.md deleted file mode 100644 index 73bd91bb..00000000 --- a/wiki-information/functions/C_Map.GetMapLinksForMap.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_Map.GetMapLinksForMap - -**Content:** -Returns the map pins that link to another map. -`mapLinks = C_Map.GetMapLinksForMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `mapLinks` - - *MapLinkInfo* - - `Field` - - `Type` - - `Description` - - `areaPoiID` - - *number* - - `position` - - *Vector2DMixin* 🔗 - - `name` - - *string* - - `atlasName` - - *string* - - `linkedUiMapID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapPosFromWorldPos.md b/wiki-information/functions/C_Map.GetMapPosFromWorldPos.md deleted file mode 100644 index b59ca013..00000000 --- a/wiki-information/functions/C_Map.GetMapPosFromWorldPos.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Map.GetMapPosFromWorldPos - -**Content:** -Translates a world map position to a map position. -`uiMapID, mapPosition = C_Map.GetMapPosFromWorldPos(continentID, worldPosition)` - -**Parameters:** -- `continentID` - - *number* - InstanceID of the continent -- `worldPosition` - - *Vector2DMixin* - The world position to be translated -- `overrideUiMapID` - - *number?* - If you don't set this to the map that you want a relative position in, it defaults to the mapID for the player's continent, essentially normalizing world coordinates (i.e. 478.1,598.2) into continent map coordinates (i.e. 0.44,0.61) - -**Returns:** -- `uiMapID` - - *number* - UiMapID -- `mapPosition` - - *Vector2DMixin* - The translated map position \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetMapRectOnMap.md b/wiki-information/functions/C_Map.GetMapRectOnMap.md deleted file mode 100644 index 57854723..00000000 --- a/wiki-information/functions/C_Map.GetMapRectOnMap.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Map.GetMapRectOnMap - -**Content:** -Needs summary. -`minX, maxX, minY, maxY = C_Map.GetMapRectOnMap(uiMapID, topUiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID -- `topUiMapID` - - *number* - -**Returns:** -- `minX` - - *number* -- `maxX` - - *number* -- `minY` - - *number* -- `maxY` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetPlayerMapPosition.md b/wiki-information/functions/C_Map.GetPlayerMapPosition.md deleted file mode 100644 index 0de6fd9a..00000000 --- a/wiki-information/functions/C_Map.GetPlayerMapPosition.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Map.GetPlayerMapPosition - -**Content:** -Returns the location of the unit on a map. -`position = C_Map.GetPlayerMapPosition(uiMapID, unitToken)` - -**Parameters:** -- `uiMapID` - - *number* : UiMapID -- `unitToken` - - *string* : UnitId - -**Returns:** -- `position` - - *Vector2DMixin?* - -**Usage:** -Prints the current map coords for the player. -```lua -local map = C_Map.GetBestMapForUnit("player") -local position = C_Map.GetPlayerMapPosition(map, "player") -print(position:GetXY()) -- 0.54766619205475, 0.54863452911377 -``` - -Sending a map pin for a target: -Sends a map pin to General chat for the target (but still uses your own location). -```lua -/run local c,p,t,m=C_Map,"player","target"m=c.GetBestMapForUnit(p)c.SetUserWaypoint{uiMapID=m,position=c.GetPlayerMapPosition(m,p)}SendChatMessage(format("%%t (%d%%)%s",UnitHealth(t)/UnitHealthMax(t)*100,c.GetUserWaypointHyperlink()),"CHANNEL",nil,1) -``` - -**Reference:** -WoWInterface: C_Map.GetPlayerMapPosition Memory Usage \ No newline at end of file diff --git a/wiki-information/functions/C_Map.GetWorldPosFromMapPos.md b/wiki-information/functions/C_Map.GetWorldPosFromMapPos.md deleted file mode 100644 index 33b8647b..00000000 --- a/wiki-information/functions/C_Map.GetWorldPosFromMapPos.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_Map.GetWorldPosFromMapPos - -**Content:** -Translates a map position to a world map position. -`continentID, worldPosition = C_Map.GetWorldPosFromMapPos(uiMapID, mapPosition)` - -**Parameters:** -- `uiMapID` - - *number* : UiMapID -- `mapPosition` - - *Vector2DMixin* - as returned from `C_Map.GetPlayerMapPosition()` - -**Returns:** -- `continentID` - - *number* : InstanceID -- `worldPosition` - - *Vector2DMixin* - -**Usage:** -Prints the world coords and size for the boundary box of Elwynn Forest. -```lua -/dump C_Map.GetWorldPosFromMapPos(37, {x=0, y=0}) -- x = -7939.580078125, y = 1535.4200439453 -/dump C_Map.GetWorldPosFromMapPos(37, {x=1, y=1}) -- x = -10254.200195312, y = -1935.4200439453 -/dump C_Map.GetMapWorldSize(37) -- 3470.8400878906, 2314.6201171875 -``` - -**Reference:** -- `UnitPosition()` -- HereBeDragons library \ No newline at end of file diff --git a/wiki-information/functions/C_Map.MapHasArt.md b/wiki-information/functions/C_Map.MapHasArt.md deleted file mode 100644 index 3299d329..00000000 --- a/wiki-information/functions/C_Map.MapHasArt.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Map.MapHasArt - -**Content:** -Returns true if the map has art and can be displayed by the FrameXML. -`hasArt = C_Map.MapHasArt(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `hasArt` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific map has art assets before attempting to display it in a custom UI element. For instance, an addon that provides enhanced map features might use this function to ensure that the map data is available before rendering additional overlays or markers. - -**Addon Usage:** -Large addons like "TomTom" or "HandyNotes" might use this function to verify the presence of map art before adding waypoints or notes to the map, ensuring that their features are only applied to maps that can be properly displayed. \ No newline at end of file diff --git a/wiki-information/functions/C_Map.RequestPreloadMap.md b/wiki-information/functions/C_Map.RequestPreloadMap.md deleted file mode 100644 index b7a9c50d..00000000 --- a/wiki-information/functions/C_Map.RequestPreloadMap.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Map.RequestPreloadMap - -**Content:** -Preloads textures for a map. -`C_Map.RequestPreloadMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md b/wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md deleted file mode 100644 index 6886450f..00000000 --- a/wiki-information/functions/C_MapExplorationInfo.GetExploredAreaIDsAtPosition.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_MapExplorationInfo.GetExploredAreaIDsAtPosition - -**Content:** -Returns the explored areas for the location on a map. -`areaID = C_MapExplorationInfo.GetExploredAreaIDsAtPosition(uiMapID, normalizedPosition)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID -- `normalizedPosition` - - *Vector2DMixin* - -**Returns:** -- `areaID` - - *number?* - AreaTable.db2 \ No newline at end of file diff --git a/wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md b/wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md deleted file mode 100644 index d26af5c4..00000000 --- a/wiki-information/functions/C_MapExplorationInfo.GetExploredMapTextures.md +++ /dev/null @@ -1,47 +0,0 @@ -## Title: C_MapExplorationInfo.GetExploredMapTextures - -**Content:** -Returns explored map textures for a map. -`overlayInfo = C_MapExplorationInfo.GetExploredMapTextures(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `overlayInfo` - - *UiMapExplorationInfo* - - `Field` - - `Type` - - `Description` - - `textureWidth` - - *number* - - `textureHeight` - - *number* - - `offsetX` - - *number* - - `offsetY` - - *number* - - `isShownByMouseOver` - - *boolean* - - `isDrawOnTopLayer` - - *boolean* - - `fileDataIDs` - - *number* - - `hitRect` - - *UiMapExplorationHitRect* - - `UiMapExplorationHitRect` - - `Field` - - `Type` - - `Description` - - `top` - - *number* - - `bottom` - - *number* - - `left` - - *number* - - `right` - - *number* - -**Added in:** -Patch 10.0.0 \ No newline at end of file diff --git a/wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md b/wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md deleted file mode 100644 index c7644f05..00000000 --- a/wiki-information/functions/C_MerchantFrame.GetBuybackItemID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_MerchantFrame.GetBuybackItemID - -**Content:** -Needs summary. -`buybackItemID = C_MerchantFrame.GetBuybackItemID(buybackSlotIndex)` - -**Parameters:** -- `buybackSlotIndex` - - *number* - -**Returns:** -- `buybackItemID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetNumTrackingTypes.md b/wiki-information/functions/C_Minimap.GetNumTrackingTypes.md deleted file mode 100644 index e4b8d51c..00000000 --- a/wiki-information/functions/C_Minimap.GetNumTrackingTypes.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Minimap.GetNumTrackingTypes - -**Content:** -Needs summary. -`numTrackingTypes = C_Minimap.GetNumTrackingTypes()` - -**Returns:** -- `numTrackingTypes` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md b/wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md deleted file mode 100644 index ab18a27a..00000000 --- a/wiki-information/functions/C_Minimap.GetObjectIconTextureCoords.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Minimap.GetObjectIconTextureCoords - -**Content:** -Needs summary. -`textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW = C_Minimap.GetObjectIconTextureCoords()` - -**Parameters:** -- `index` - - *number?* - -**Returns:** -- `textureCoordsX` - - *number* -- `textureCoordsY` - - *number* -- `textureCoordsZ` - - *number* -- `textureCoordsW` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetPOITextureCoords.md b/wiki-information/functions/C_Minimap.GetPOITextureCoords.md deleted file mode 100644 index 1a1edae7..00000000 --- a/wiki-information/functions/C_Minimap.GetPOITextureCoords.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Minimap.GetPOITextureCoords - -**Content:** -Needs summary. -`textureCoordsX, textureCoordsY, textureCoordsZ, textureCoordsW = C_Minimap.GetPOITextureCoords()` - -**Parameters:** -- `index` - - *number?* - -**Returns:** -- `textureCoordsX` - - *number* -- `textureCoordsY` - - *number* -- `textureCoordsZ` - - *number* -- `textureCoordsW` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.GetTrackingInfo.md b/wiki-information/functions/C_Minimap.GetTrackingInfo.md deleted file mode 100644 index 103a3390..00000000 --- a/wiki-information/functions/C_Minimap.GetTrackingInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Minimap.GetTrackingInfo - -**Content:** -Needs summary. -`name, textureFileID, active, type, subType, spellID = C_Minimap.GetTrackingInfo(spellIndex)` - -**Parameters:** -- `spellIndex` - - *number* - -**Returns:** -- `name` - - *string* -- `textureFileID` - - *number* -- `active` - - *boolean* -- `type` - - *string* -- `subType` - - *number* -- `spellID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_Minimap.SetTracking.md b/wiki-information/functions/C_Minimap.SetTracking.md deleted file mode 100644 index a09b7879..00000000 --- a/wiki-information/functions/C_Minimap.SetTracking.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_Minimap.SetTracking - -**Content:** -Needs summary. -`C_Minimap.SetTracking(index, on)` - -**Parameters:** -- `index` - - *number* -- `on` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.AddActiveModelScene.md b/wiki-information/functions/C_ModelInfo.AddActiveModelScene.md deleted file mode 100644 index 1f45c2b0..00000000 --- a/wiki-information/functions/C_ModelInfo.AddActiveModelScene.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_ModelInfo.AddActiveModelScene - -**Content:** -Needs summary. -`C_ModelInfo.AddActiveModelScene(modelSceneFrame, modelSceneID)` - -**Parameters:** -- `modelSceneFrame` - - *table* -- `modelSceneID` - - *number* - -**Description:** -This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md b/wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md deleted file mode 100644 index 9ffa66fd..00000000 --- a/wiki-information/functions/C_ModelInfo.AddActiveModelSceneActor.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_ModelInfo.AddActiveModelSceneActor - -**Content:** -Needs summary. -`C_ModelInfo.AddActiveModelSceneActor(modelSceneFrameActor, modelSceneActorID)` - -**Parameters:** -- `modelSceneFrameActor` - - *table* -- `modelSceneActorID` - - *number* - -**Description:** -This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md b/wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md deleted file mode 100644 index 0ffc8d65..00000000 --- a/wiki-information/functions/C_ModelInfo.ClearActiveModelScene.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_ModelInfo.ClearActiveModelScene - -**Content:** -Needs summary. -`C_ModelInfo.ClearActiveModelScene(modelSceneFrame)` - -**Parameters:** -- `modelSceneFrame` - - *table* - -**Description:** -This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md b/wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md deleted file mode 100644 index ef5b7119..00000000 --- a/wiki-information/functions/C_ModelInfo.ClearActiveModelSceneActor.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_ModelInfo.ClearActiveModelSceneActor - -**Content:** -Needs summary. -`C_ModelInfo.ClearActiveModelSceneActor(modelSceneFrameActor)` - -**Parameters:** -- `modelSceneFrameActor` - - *table* - -**Description:** -This function does nothing in public clients. \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md deleted file mode 100644 index 4d14757f..00000000 --- a/wiki-information/functions/C_ModelInfo.GetModelSceneActorDisplayInfoByID.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_ModelInfo.GetModelSceneActorDisplayInfoByID - -**Content:** -Needs summary. -`actorDisplayInfo = C_ModelInfo.GetModelSceneActorDisplayInfoByID(modelActorDisplayID)` - -**Parameters:** -- `modelActorDisplayID` - - *number* - -**Returns:** -- `actorDisplayInfo` - - *UIModelSceneActorDisplayInfo* - - `Field` - - `Type` - - `Description` - - `animation` - - *number* - - `animationVariation` - - *number* - - `animSpeed` - - *number* - - `animationKitID` - - *number?* - - `spellVisualKitID` - - *number?* - - `alpha` - - *number* - - `scale` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md deleted file mode 100644 index 02b2e0dc..00000000 --- a/wiki-information/functions/C_ModelInfo.GetModelSceneActorInfoByID.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_ModelInfo.GetModelSceneActorInfoByID - -**Content:** -Needs summary. -`actorInfo = C_ModelInfo.GetModelSceneActorInfoByID(modelActorID)` - -**Parameters:** -- `modelActorID` - - *number* - -**Returns:** -- `actorInfo` - - *UIModelSceneActorInfo* - - `Field` - - `Type` - - `Description` - - `modelActorID` - - *number* - - `scriptTag` - - *string* - - `position` - - *Vector3DMixin* 🔗 - - `yaw` - - *number* - - `pitch` - - *number* - - `roll` - - *number* - - `normalizeScaleAggressiveness` - - *number?* - - `useCenterForOriginX` - - *boolean* - - `useCenterForOriginY` - - *boolean* - - `useCenterForOriginZ` - - *boolean* - - `modelActorDisplayID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md deleted file mode 100644 index 07066d28..00000000 --- a/wiki-information/functions/C_ModelInfo.GetModelSceneCameraInfoByID.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_ModelInfo.GetModelSceneCameraInfoByID - -**Content:** -Needs summary. -`modelSceneCameraInfo = C_ModelInfo.GetModelSceneCameraInfoByID(modelSceneCameraID)` - -**Parameters:** -- `modelSceneCameraID` - - *number* - -**Returns:** -- `modelSceneCameraInfo` - - *UIModelSceneCameraInfo* - - `Field` - - `Type` - - `Description` - - `modelSceneCameraID` - - *number* - - `scriptTag` - - *string* - - `cameraType` - - *string* - - `target` - - *Vector3DMixin* - - `yaw` - - *number* - - `pitch` - - *number* - - `roll` - - *number* - - `zoomDistance` - - *number* - - `minZoomDistance` - - *number* - - `maxZoomDistance` - - *number* - - `zoomedTargetOffset` - - *Vector3DMixin* - - `zoomedYawOffset` - - *number* - - `zoomedPitchOffset` - - *number* - - `zoomedRollOffset` - - *number* - - `flags` - - *Enum.ModelSceneSetting* - - `Enum.ModelSceneSetting` - - `Value` - - `Field` - - `Description` - - `1` - - AlignLightToOrbitDelta \ No newline at end of file diff --git a/wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md b/wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md deleted file mode 100644 index 8a518a22..00000000 --- a/wiki-information/functions/C_ModelInfo.GetModelSceneInfoByID.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: C_ModelInfo.GetModelSceneInfoByID - -**Content:** -Needs summary. -`modelSceneType, modelCameraIDs, modelActorsIDs, flags = C_ModelInfo.GetModelSceneInfoByID(modelSceneID)` - -**Parameters:** -- `modelSceneID` - - *number* - -**Returns:** -- `modelSceneType` - - *Enum.ModelSceneType* - - `Value` - - `Field` - - `Description` - - `0` - MountJournal - - `1` - PetJournalCard - - `2` - ShopCard - - `3` - EncounterJournal - - `4` - PetJournalLoadout - - `5` - ArtifactTier2 - - `6` - ArtifactTier2ForgingScene - - `7` - ArtifactTier2SlamEffect - - `8` - CommentatorVictoryFanfare - - `9` - ArtifactRelicTalentEffect - - `10` - PvPWarModeOrb - - `11` - PvPWarModeFire - - `12` - PartyPose - - `13` - AzeriteItemLevelUpToast - - `14` - AzeritePowers - - `15` - AzeriteRewardGlow - - `16` - HeartOfAzeroth - - `17` - WorldMapThreat - - `18` - Soulbinds - - `19` - JailersTowerAnimaGlow -- `modelCameraIDs` - - *number* -- `modelActorsIDs` - - *number* -- `flags` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.ClearFanfare.md b/wiki-information/functions/C_MountJournal.ClearFanfare.md deleted file mode 100644 index 78be36ad..00000000 --- a/wiki-information/functions/C_MountJournal.ClearFanfare.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_MountJournal.ClearFanfare - -**Content:** -Needs summary. -`C_MountJournal.ClearFanfare(mountID)` - -**Parameters:** -- `mountID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.ClearRecentFanfares.md b/wiki-information/functions/C_MountJournal.ClearRecentFanfares.md deleted file mode 100644 index c54c6cde..00000000 --- a/wiki-information/functions/C_MountJournal.ClearRecentFanfares.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_MountJournal.ClearRecentFanfares - -**Content:** -Needs summary. -`C_MountJournal.ClearRecentFanfares()` \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.Dismiss.md b/wiki-information/functions/C_MountJournal.Dismiss.md deleted file mode 100644 index dec579ec..00000000 --- a/wiki-information/functions/C_MountJournal.Dismiss.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_MountJournal.Dismiss - -**Content:** -Dismisses the currently summoned mount. -`C_MountJournal.Dismiss()` - -**Reference:** -- `COMPANION_UPDATE`, at which time `IsMounted()` will correctly return false -- See also: `C_MountJournal.SummonByID` - -**Description:** -Has no result if the player is not mounted. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md b/wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md deleted file mode 100644 index 9b9fb1ea..00000000 --- a/wiki-information/functions/C_MountJournal.GetAllCreatureDisplayIDsForMountID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_MountJournal.GetAllCreatureDisplayIDsForMountID - -**Content:** -Needs summary. -`creatureDisplayIDs = C_MountJournal.GetAllCreatureDisplayIDsForMountID(mountID)` - -**Parameters:** -- `mountID` - - *number* - -**Returns:** -- `creatureDisplayIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md b/wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md deleted file mode 100644 index faf921cb..00000000 --- a/wiki-information/functions/C_MountJournal.GetCollectedDragonridingMounts.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_MountJournal.GetCollectedDragonridingMounts - -**Content:** -Needs summary. -`mountIDs = C_MountJournal.GetCollectedDragonridingMounts()` - -**Returns:** -- `mountIDs` - - *number* - -**Description:** -This function retrieves the IDs of the dragonriding mounts that the player has collected. The returned `mountIDs` can be used to display or manage the player's collection of dragonriding mounts. - -**Example Usage:** -```lua -local mountIDs = C_MountJournal.GetCollectedDragonridingMounts() -for _, mountID in ipairs(mountIDs) do - print("Collected Dragonriding Mount ID:", mountID) -end -``` - -**Change Log:** -Patch 10.0.0 (2022-11-15): Added. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md b/wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md deleted file mode 100644 index ec2f5fb5..00000000 --- a/wiki-information/functions/C_MountJournal.GetCollectedFilterSetting.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_MountJournal.GetCollectedFilterSetting - -**Content:** -Indicates whether the specified mount journal filter is enabled. -`isChecked = C_MountJournal.GetCollectedFilterSetting(filterIndex)` - -**Parameters:** -- `filterIndex` - - *number* - - **Value** | **Enum** | **Description** - - `1` | `LE_MOUNT_JOURNAL_FILTER_COLLECTED` - - `2` | `LE_MOUNT_JOURNAL_FILTER_NOT_COLLECTED` - - `3` | `LE_MOUNT_JOURNAL_FILTER_UNUSABLE` - -**Returns:** -- `isChecked` - - *boolean* - true if the filter is enabled (mounts matching the filter are displayed), or false if the filter is disabled (mounts matching the filter are hidden) - -**Description:** -Returns true if the specified ID is not associated with an existing filter. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md deleted file mode 100644 index afae3384..00000000 --- a/wiki-information/functions/C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo.md +++ /dev/null @@ -1,126 +0,0 @@ -## Title: C_MountJournal.GetMountAllCreatureDisplayInfoByID - -**Content:** -Returns the display IDs for a mount. -`allDisplayInfo = C_MountJournal.GetMountAllCreatureDisplayInfoByID(mountID)` -`allDisplayInfo = C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo(mountIndex)` - -**Parameters:** -- `GetMountAllCreatureDisplayInfoByID:` - - `mountID` - - *number* - MountID - -- `GetDisplayedMountAllCreatureDisplayInfo:` - - `mountIndex` - - *number* - the index of the displayed mount, i.e. mount in list that matches current search query and filters, in the range of 1 to `C_MountJournal.GetNumDisplayedMounts` - -**Values:** -Note: This list is up to date as of patch 8.1.5 (29737) Mar 14 2019 -- `ID` -- `Name` -- `DisplayIDs` - - `17` - - `Felsteed` - - `2346, 51651` - - `83` - - `Dreadsteed` - - `14554, 51652` - - `422` - - `Vicious War Steed` - - `38668, 91643` - - `435` - - `Mountain Horse` - - `39096, 91641` - - `436` - - `Swift Mountain Horse` - - `39095, 91642` - - `860` - - `Archmage's Prismatic Disc` - - `73770, 73768, 73769` - - `861` - - `High Priest's Lightsworn Seeker` - - `73774, 73775, 73773` - - `866` - - `Deathlord's Vilebrood Vanquisher` - - `73785, 75313, 75314` - - `867` - - `Battlelord's Bloodthirsty War Wyrm` - - `73778, 75994, 75995` - - `888` - - `Farseer's Raging Tempest` - - `76024, 74144, 76025` - - `925` - - `Onyx War Hyena` - - `75322, 91593` - - `926` - - `Alabaster Hyena` - - `75323, 91592` - - `928` - - `Dune Scavenger` - - `75324, 91591` - - `996` - - `Seabraid Stallion` - - `80357, 91599` - - `997` - - `Gilded Ravasaur` - - `80358, 91594` - - `1010` - - `Admiralty Stallion` - - `82148, 91600` - - `1011` - - `Shu-Zen, the Divine Sentinel` - - `81772, 84570, 84571, 84570, 81772` - - `1015` - - `Dapple Gray` - - `81693, 91601` - - `1016` - - `Smoky Charger` - - `82161, 91602` - - `1018` - - `Terrified Pack Mule` - - `81694, 91603` - - `1019` - - `Goldenmane` - - `81690, 91604` - - `1038` - - `Zandalari Direhorn` - - `83525, 91595` - - `1173` - - `Broken Highland Mustang` - - `87773, 91606` - - `1174` - - `Highland Mustang` - - `87774, 91607` - - `1182` - - `Lil' Donkey` - - `85581, 91608` - - `1198` - - `Kul Tiran Charger` - - `88974, 91640` - - `1220` - - `Bruce` - - `90419, 90420` - - `1221` - - `Hogrus, Swine of Good Fortune` - - `90398, 91597` - - `1222` - - `Vulpine Familiar` - - `90397, 91598` - - `1225` - - `Crusader's Direhorn` - - `90501, 91596` - - `1245` - - `Bloodflank Charger` - - `91388, 91609` - -**Returns:** -- `allDisplayInfo` - - *structure* - MountCreatureDisplayInfo - - `MountCreatureDisplayInfo` - - `Field` - - `Type` - - `Description` - - `creatureDisplayID` - - *number* - CreatureDisplayID - - `isVisible` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountID.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountID.md deleted file mode 100644 index 0a9a0894..00000000 --- a/wiki-information/functions/C_MountJournal.GetDisplayedMountID.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_MountJournal.GetDisplayedMountID - -**Content:** -Needs summary. -`mountID = C_MountJournal.GetDisplayedMountID(displayIndex)` - -**Parameters:** -- `displayIndex` - - *number* - -**Returns:** -- `mountID` - - *number* - -**Example Usage:** -This function can be used to retrieve the mount ID of a mount displayed at a specific index in the Mount Journal. This is useful for addons that need to interact with or display information about mounts in the player's collection. - -**Example:** -```lua -local displayIndex = 1 -local mountID = C_MountJournal.GetDisplayedMountID(displayIndex) -print("The mount ID at display index 1 is:", mountID) -``` - -**Addons:** -Large addons like "MountJournalEnhanced" use this function to provide additional sorting and filtering options for mounts in the Mount Journal. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md deleted file mode 100644 index e0818398..00000000 --- a/wiki-information/functions/C_MountJournal.GetDisplayedMountInfo.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: C_MountJournal.GetMountInfoByID - -**Content:** -Returns information about the specified mount. -```lua -name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetMountInfoByID(mountID) -name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetDisplayedMountInfo(displayIndex) -``` - -**Parameters:** -- **GetMountInfoByID:** - - `mountID` - - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` - -- **GetDisplayedMountInfo:** - - `displayIndex` - - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` - -**Returns:** -1. `name` - - *string* - The name of the mount. -2. `spellID` - - *number* - The ID of the spell that summons the mount. -3. `icon` - - *number* : FileID - Icon texture used by the mount. -4. `isActive` - - *boolean* - Indicates if the player is currently mounted on the mount. -5. `isUsable` - - *boolean* - Indicates if the mount is usable based on the player's current location, riding skill, profession skill, class, etc. -6. `sourceType` - - *number* - Indicates generally how the mount may be obtained; a localized string describing the acquisition method is returned by `C_MountJournal.GetMountInfoExtraByID`. -7. `isFavorite` - - *boolean* - Indicates if the mount is currently marked as a favorite. -8. `isFactionSpecific` - - *boolean* - true if the mount is only available to one faction, false otherwise. -9. `faction` - - *number?* - 0 if the mount is available only to Horde players, 1 if the mount is available only to Alliance players, or nil if the mount is not faction-specific. -10. `shouldHideOnChar` - - *boolean* - Indicates if the mount should be hidden in the player's mount journal (includes Swift Spectral Gryphon and mounts specific to the opposite faction). -11. `isCollected` - - *boolean* - Indicates if the player has learned the mount. -12. `mountID` - - *number* - ID of the mount. -13. `isForDragonriding` - - *boolean* - Indicates if the mount is for Dragonriding. - -**Description:** -Current values of the `sourceType` return include: -- 0 - not categorized; includes many mounts that should (and may eventually) be included in one of the other categories - -| BATTLE_PET_SOURCE | ID | Constant | Value | Description | -|-------------------|----|----------|-------|-------------| -| 1 | BATTLE_PET_SOURCE_1 | Drop | 1 | Drop | -| 2 | BATTLE_PET_SOURCE_2 | Quest | 2 | Quest | -| 3 | BATTLE_PET_SOURCE_3 | Vendor | 3 | Vendor | -| 4 | BATTLE_PET_SOURCE_4 | Profession | 4 | Profession | -| 5 | BATTLE_PET_SOURCE_5 | Pet Battle | 5 | Pet Battle | -| 6 | BATTLE_PET_SOURCE_6 | Achievement| 6 | Achievement | -| 7 | BATTLE_PET_SOURCE_7 | World Event| 7 | World Event | -| 8 | BATTLE_PET_SOURCE_8 | Promotion | 8 | Promotion | -| 9 | BATTLE_PET_SOURCE_9 | Trading Card Game | 9 | Trading Card Game | -| 10 | BATTLE_PET_SOURCE_10| In-Game Shop | 10 | In-Game Shop | -| 11 | BATTLE_PET_SOURCE_11| Discovery | 11 | Discovery | \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md b/wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md deleted file mode 100644 index 3a62573c..00000000 --- a/wiki-information/functions/C_MountJournal.GetDisplayedMountInfoExtra.md +++ /dev/null @@ -1,62 +0,0 @@ -## Title: C_MountJournal.GetMountInfoExtraByID - -**Content:** -Returns extra information about the specified mount. -```lua -creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, -uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview -= C_MountJournal.GetMountInfoExtraByID(mountID) -= C_MountJournal.GetDisplayedMountInfoExtra(index) -``` - -**Parameters:** -- **GetMountInfoExtraByID:** - - `mountID` - - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` - -- **GetDisplayedMountInfoExtra:** - - `index` - - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` - -**Returns:** -- `creatureDisplayInfoID` - - *number* : DisplayID - If nil, then the mount has multiple displayIDs, from `C_MountJournal.GetMountAllCreatureDisplayInfoByID()`. This is not consistent however, since this can be not nil and still have multiple displayIds. -- `description` - - *string* - flavor text describing the mount -- `source` - - *string* - information about how the mount is obtained, including vendor name and location, monetary cost, etc. -- `isSelfMount` - - *boolean* - true if the player transforms into the mount (e.g., Obsidian Nightwing or Sandstone Drake), or false for normal mounts -- `mountTypeID` - - *number* - a number indicating the capabilities of the mount; known values include: - - 230 for most ground mounts - - 231 for - - 232 for (was named Abyssal Seahorse prior to Warlords of Draenor) - - 241 for Blue, Green, Red, and Yellow Qiraji Battle Tank (restricted to use inside Temple of Ahn'Qiraj) - - 242 for Swift Spectral Gryphon (hidden in the mount journal, used while dead in certain zones) - - 247 for - - 248 for most flying mounts, including those that change capability based on riding skill - - 254 for - - 269 for - - 284 for and Chauffeured Mechano-Hog - - 398 for - - 402 for Dragonriding - - 407 for - - 408 for - - 412 for Otto and Ottuk - - 424 for Dragonriding mounts, including mounts that have dragonriding animations but are not yet enabled for dragonriding. -- `uiModelSceneID` - - *number* : ModelSceneID -- `animID` - - *number* -- `spellVisualKitID` - - *number* -- `disablePlayerMountPreview` - - *boolean* - -**Example Usage:** -This function can be used to retrieve detailed information about a specific mount, which can be useful for addons that manage or display mount collections. For example, an addon could use this function to show additional details about a mount when a player hovers over it in their mount journal. - -**Addons Using This Function:** -- **Altoholic:** This addon uses `C_MountJournal.GetMountInfoExtraByID` to display detailed mount information across multiple characters, helping players manage their collections more effectively. -- **Mount Journal Enhanced:** This addon enhances the default mount journal by adding more detailed information about each mount, including the extra information retrieved by this function. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetIsFavorite.md b/wiki-information/functions/C_MountJournal.GetIsFavorite.md deleted file mode 100644 index 0d5ed0fd..00000000 --- a/wiki-information/functions/C_MountJournal.GetIsFavorite.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_MountJournal.GetIsFavorite - -**Content:** -Indicates whether the specified mount is marked as a favorite. -`isFavorite, canSetFavorite = C_MountJournal.GetIsFavorite(mountIndex)` - -**Parameters:** -- `mountIndex` - - *number* - Index of the mount, in the range of 1 to `C_MountJournal.GetNumMounts()` (inclusive) - -**Returns:** -- `isFavorite` - - *boolean* -- `canSetFavorite` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md b/wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md deleted file mode 100644 index 83c4333a..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountAllCreatureDisplayInfoByID.md +++ /dev/null @@ -1,64 +0,0 @@ -## Title: C_MountJournal.GetMountAllCreatureDisplayInfoByID - -**Content:** -Returns the display IDs for a mount. -`allDisplayInfo = C_MountJournal.GetMountAllCreatureDisplayInfoByID(mountID)` -`allDisplayInfo = C_MountJournal.GetDisplayedMountAllCreatureDisplayInfo(mountIndex)` - -**Parameters:** -- `GetMountAllCreatureDisplayInfoByID:` - - `mountID` - - *number* - MountID - -- `GetDisplayedMountAllCreatureDisplayInfo:` - - `mountIndex` - - *number* - the index of the displayed mount, i.e. mount in list that matches current search query and filters, in the range of 1 to `C_MountJournal.GetNumDisplayedMounts` - -**Values:** -Note: This list is up to date as of patch 8.1.5 (29737) Mar 14 2019 -- `ID` -- `Name` -- `DisplayIDs` - - 17 - Felsteed - 2346, 51651 - - 83 - Dreadsteed - 14554, 51652 - - 422 - Vicious War Steed - 38668, 91643 - - 435 - Mountain Horse - 39096, 91641 - - 436 - Swift Mountain Horse - 39095, 91642 - - 860 - Archmage's Prismatic Disc - 73770, 73768, 73769 - - 861 - High Priest's Lightsworn Seeker - 73774, 73775, 73773 - - 866 - Deathlord's Vilebrood Vanquisher - 73785, 75313, 75314 - - 867 - Battlelord's Bloodthirsty War Wyrm - 73778, 75994, 75995 - - 888 - Farseer's Raging Tempest - 76024, 74144, 76025 - - 925 - Onyx War Hyena - 75322, 91593 - - 926 - Alabaster Hyena - 75323, 91592 - - 928 - Dune Scavenger - 75324, 91591 - - 996 - Seabraid Stallion - 80357, 91599 - - 997 - Gilded Ravasaur - 80358, 91594 - - 1010 - Admiralty Stallion - 82148, 91600 - - 1011 - Shu-Zen, the Divine Sentinel - 81772, 84570, 84571, 84570, 81772 - - 1015 - Dapple Gray - 81693, 91601 - - 1016 - Smoky Charger - 82161, 91602 - - 1018 - Terrified Pack Mule - 81694, 91603 - - 1019 - Goldenmane - 81690, 91604 - - 1038 - Zandalari Direhorn - 83525, 91595 - - 1173 - Broken Highland Mustang - 87773, 91606 - - 1174 - Highland Mustang - 87774, 91607 - - 1182 - Lil' Donkey - 85581, 91608 - - 1198 - Kul Tiran Charger - 88974, 91640 - - 1220 - Bruce - 90419, 90420 - - 1221 - Hogrus, Swine of Good Fortune - 90398, 91597 - - 1222 - Vulpine Familiar - 90397, 91598 - - 1225 - Crusader's Direhorn - 90501, 91596 - - 1245 - Bloodflank Charger - 91388, 91609 - -**Returns:** -- `allDisplayInfo` - - *structure* - MountCreatureDisplayInfo - - `MountCreatureDisplayInfo` - - `Field` - - `Type` - - `Description` - - `creatureDisplayID` - - *number* - CreatureDisplayID - - `isVisible` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountFromItem.md b/wiki-information/functions/C_MountJournal.GetMountFromItem.md deleted file mode 100644 index 52be07dc..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountFromItem.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_MountJournal.GetMountFromItem - -**Content:** -Returns the mount for an item ID. -`mountID = C_MountJournal.GetMountFromItem(itemID)` - -**Parameters:** -- `itemID` - - *number* - -**Returns:** -- `mountID` - - *number?* - -**Example Usage:** -This function can be used to determine which mount is associated with a specific item ID. For instance, if you have an item that you suspect grants a mount, you can use this function to confirm the mount ID. - -**Addons Usage:** -Large addons like "AllTheThings" use this function to track and catalog mounts associated with items, helping players to complete their mount collections. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountFromSpell.md b/wiki-information/functions/C_MountJournal.GetMountFromSpell.md deleted file mode 100644 index c83078a1..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountFromSpell.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_MountJournal.GetMountFromSpell - -**Content:** -Returns the mount for a spell ID. -`mountID = C_MountJournal.GetMountFromSpell(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `mountID` - - *number?* - -**Example Usage:** -This function can be used to retrieve the mount ID associated with a specific spell ID. This is particularly useful for addons that manage or display mount collections, allowing them to link spells to their corresponding mounts. - -**Addon Usage:** -Large addons like "MountJournalEnhanced" or "CollectMe" might use this function to enhance the user interface for mount collections, providing additional information or functionality based on the mount ID retrieved from a spell ID. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountIDs.md b/wiki-information/functions/C_MountJournal.GetMountIDs.md deleted file mode 100644 index 7c740ff0..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountIDs.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_MountJournal.GetMountIDs - -**Content:** -Returns the IDs of mounts listed in the mount journal. -`mountIDs = C_MountJournal.GetMountIDs()` - -**Returns:** -- `mountIDs` - - *number* - MountID \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountInfoByID.md b/wiki-information/functions/C_MountJournal.GetMountInfoByID.md deleted file mode 100644 index 05a81f5a..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountInfoByID.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: C_MountJournal.GetMountInfoByID - -**Content:** -Returns information about the specified mount. -```lua -name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetMountInfoByID(mountID) -name, spellID, icon, isActive, isUsable, sourceType, isFavorite, isFactionSpecific, faction, shouldHideOnChar, isCollected, mountID, isForDragonriding = C_MountJournal.GetDisplayedMountInfo(displayIndex) -``` - -**Parameters:** -- **GetMountInfoByID:** - - `mountID` - - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` - -- **GetDisplayedMountInfo:** - - `displayIndex` - - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` - -**Returns:** -1. `name` - - *string* - The name of the mount. -2. `spellID` - - *number* - The ID of the spell that summons the mount. -3. `icon` - - *number* : FileID - Icon texture used by the mount. -4. `isActive` - - *boolean* - Indicates if the player is currently mounted on the mount. -5. `isUsable` - - *boolean* - Indicates if the mount is usable based on the player's current location, riding skill, profession skill, class, etc. -6. `sourceType` - - *number* - Indicates generally how the mount may be obtained; a localized string describing the acquisition method is returned by `C_MountJournal.GetMountInfoExtraByID`. -7. `isFavorite` - - *boolean* - Indicates if the mount is currently marked as a favorite. -8. `isFactionSpecific` - - *boolean* - true if the mount is only available to one faction, false otherwise. -9. `faction` - - *number?* - 0 if the mount is available only to Horde players, 1 if the mount is available only to Alliance players, or nil if the mount is not faction-specific. -10. `shouldHideOnChar` - - *boolean* - Indicates if the mount should be hidden in the player's mount journal (includes Swift Spectral Gryphon and mounts specific to the opposite faction). -11. `isCollected` - - *boolean* - Indicates if the player has learned the mount. -12. `mountID` - - *number* - ID of the mount. -13. `isForDragonriding` - - *boolean* - Indicates if the mount is used for Dragonriding. - -**Description:** -Current values of the `sourceType` return include: -- 0 - not categorized; includes many mounts that should (and may eventually) be included in one of the other categories - -| BATTLE_PET_SOURCE | ID | Constant | Value | Description | -|-------------------|----|----------|-------|-------------| -| 1 | 1 | BATTLE_PET_SOURCE_1 | Drop | Drop | -| 2 | 2 | BATTLE_PET_SOURCE_2 | Quest | Quest | -| 3 | 3 | BATTLE_PET_SOURCE_3 | Vendor | Vendor | -| 4 | 4 | BATTLE_PET_SOURCE_4 | Profession | Profession | -| 5 | 5 | BATTLE_PET_SOURCE_5 | Pet Battle | Pet Battle | -| 6 | 6 | BATTLE_PET_SOURCE_6 | Achievement| Achievement | -| 7 | 7 | BATTLE_PET_SOURCE_7 | World Event| World Event | -| 8 | 8 | BATTLE_PET_SOURCE_8 | Promotion | Promotion | -| 9 | 9 | BATTLE_PET_SOURCE_9 | Trading Card Game | Trading Card Game | -| 10 | 10 | BATTLE_PET_SOURCE_10| In-Game Shop | In-Game Shop | -| 11 | 11 | BATTLE_PET_SOURCE_11| Discovery | Discovery | \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md b/wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md deleted file mode 100644 index d961fa24..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountInfoExtraByID.md +++ /dev/null @@ -1,62 +0,0 @@ -## Title: C_MountJournal.GetMountInfoExtraByID - -**Content:** -Returns extra information about the specified mount. -```lua -creatureDisplayInfoID, description, source, isSelfMount, mountTypeID, -uiModelSceneID, animID, spellVisualKitID, disablePlayerMountPreview -= C_MountJournal.GetMountInfoExtraByID(mountID) -= C_MountJournal.GetDisplayedMountInfoExtra(index) -``` - -**Parameters:** -- **GetMountInfoExtraByID:** - - `mountID` - - *number* : MountID - Returned from `C_MountJournal.GetMountIDs()` - -- **GetDisplayedMountInfoExtra:** - - `index` - - *number* - Index of the displayed mount in the mount journal list with the current search query and filters. Ranging from 1 to `C_MountJournal.GetNumDisplayedMounts()` - -**Returns:** -- `creatureDisplayInfoID` - - *number* : DisplayID - If nil, then the mount has multiple displayIDs, from `C_MountJournal.GetMountAllCreatureDisplayInfoByID()`. This is not consistent however, since this can be not nil and still have multiple displayIds. -- `description` - - *string* - flavor text describing the mount -- `source` - - *string* - information about how the mount is obtained, including vendor name and location, monetary cost, etc. -- `isSelfMount` - - *boolean* - true if the player transforms into the mount (e.g., Obsidian Nightwing or Sandstone Drake), or false for normal mounts -- `mountTypeID` - - *number* - a number indicating the capabilities of the mount; known values include: - - 230 for most ground mounts - - 231 for - - 232 for (was named Abyssal Seahorse prior to Warlords of Draenor) - - 241 for Blue, Green, Red, and Yellow Qiraji Battle Tank (restricted to use inside Temple of Ahn'Qiraj) - - 242 for Swift Spectral Gryphon (hidden in the mount journal, used while dead in certain zones) - - 247 for - - 248 for most flying mounts, including those that change capability based on riding skill - - 254 for - - 269 for - - 284 for and Chauffeured Mechano-Hog - - 398 for - - 402 for Dragonriding - - 407 for - - 408 for - - 412 for Otto and Ottuk - - 424 for Dragonriding mounts, including mounts that have dragonriding animations but are not yet enabled for dragonriding. -- `uiModelSceneID` - - *number* : ModelSceneID -- `animID` - - *number* -- `spellVisualKitID` - - *number* -- `disablePlayerMountPreview` - - *boolean* - -**Example Usage:** -This function can be used to retrieve detailed information about a specific mount, which can be useful for addons that manage or display mount collections. For example, an addon could use this function to show additional details about a mount when a player hovers over it in their mount journal. - -**Addons Using This Function:** -- **MountJournalEnhanced**: This addon enhances the default mount journal by adding more filters and sorting options. It uses `C_MountJournal.GetMountInfoExtraByID` to display additional information about each mount, such as its source and description. -- **AllTheThings**: This comprehensive collection tracking addon uses this function to provide detailed information about mounts, helping players track which mounts they have collected and which ones they still need to obtain. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountLink.md b/wiki-information/functions/C_MountJournal.GetMountLink.md deleted file mode 100644 index 03bf4ea6..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountLink.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_MountJournal.GetMountLink - -**Content:** -Needs summary. -`mountCreatureDisplayInfoLink = C_MountJournal.GetMountLink(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `mountCreatureDisplayInfoLink` - - *string?* - -**Example Usage:** -This function can be used to retrieve a link to a mount's creature display information based on its spell ID. This can be useful for addons that need to display or manipulate mount information. - -**Addon Usage:** -Large addons like "MountJournalEnhanced" might use this function to provide additional details or functionalities related to mounts, such as displaying mount links in tooltips or chat. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md b/wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md deleted file mode 100644 index 5a311d67..00000000 --- a/wiki-information/functions/C_MountJournal.GetMountUsabilityByID.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_MountJournal.GetMountUsabilityByID - -**Content:** -Returns if a mount is currently usable by the player. -`isUsable, useError = C_MountJournal.GetMountUsabilityByID(mountID, checkIndoors)` - -**Parameters:** -- `mountID` - - *number* -- `checkIndoors` - - *boolean* - -**Returns:** -- `isUsable` - - *boolean* -- `useError` - - *string?* - -**Example Usage:** -This function can be used to check if a specific mount can be used in the current environment. For instance, you might want to check if a flying mount can be used indoors or if a specific mount is restricted in certain areas. - -**Addon Usage:** -Large addons like "MountJournalEnhanced" use this function to provide users with detailed information about mount usability, including restrictions and error messages when attempting to use a mount in an inappropriate location. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md b/wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md deleted file mode 100644 index a4320654..00000000 --- a/wiki-information/functions/C_MountJournal.GetNumDisplayedMounts.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_MountJournal.GetNumDisplayedMounts - -**Content:** -Returns the number of (filtered) mounts shown in the mount journal. -`numMounts = C_MountJournal.GetNumDisplayedMounts()` - -**Returns:** -- `numMounts` - - *number* - -**Reference:** -- `C_MountJournal.GetNumMounts` \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetNumMounts.md b/wiki-information/functions/C_MountJournal.GetNumMounts.md deleted file mode 100644 index b8e87d82..00000000 --- a/wiki-information/functions/C_MountJournal.GetNumMounts.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_MountJournal.GetNumMounts - -**Content:** -Returns the number of mounts listed in the mount journal. -`numMounts = C_MountJournal.GetNumMounts()` - -**Returns:** -- `numMounts` - - *number* - -**Description:** -Unlike the corresponding function for the pet journal, the number returned by this function includes not only the mounts that are currently visible in the mount journal, but also the mounts that are hidden by the player's current filter preferences, mounts that are hidden because they are not available to the player's faction, and mounts that are never displayed, such as the Swift Spectral Gryphon which players are mounted on while dead in certain zones. - -**Reference:** -- `C_MountJournal.GetNumDisplayedMounts` \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md b/wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md deleted file mode 100644 index 497e0436..00000000 --- a/wiki-information/functions/C_MountJournal.GetNumMountsNeedingFanfare.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_MountJournal.GetNumMountsNeedingFanfare - -**Content:** -Needs summary. -`numMountsNeedingFanfare = C_MountJournal.GetNumMountsNeedingFanfare()` - -**Returns:** -- `numMountsNeedingFanfare` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsSourceChecked.md b/wiki-information/functions/C_MountJournal.IsSourceChecked.md deleted file mode 100644 index 6564c51b..00000000 --- a/wiki-information/functions/C_MountJournal.IsSourceChecked.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_MountJournal.IsSourceChecked - -**Content:** -Needs summary. -`isChecked = C_MountJournal.IsSourceChecked(filterIndex)` - -**Parameters:** -- `filterIndex` - - *number* - -**Returns:** -- `isChecked` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific source filter is currently checked in the Mount Journal. For instance, if you want to verify whether mounts obtained from a specific source (like achievements or vendors) are being displayed, you can use this function. - -**Addons:** -Large addons like "AllTheThings" use this function to filter and display mounts based on their sources, helping players track their mount collection progress more effectively. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsTypeChecked.md b/wiki-information/functions/C_MountJournal.IsTypeChecked.md deleted file mode 100644 index 10c40345..00000000 --- a/wiki-information/functions/C_MountJournal.IsTypeChecked.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_MountJournal.IsTypeChecked - -**Content:** -Needs summary. -`isChecked = C_MountJournal.IsTypeChecked(filterIndex)` - -**Parameters:** -- `filterIndex` - - *number* - -**Returns:** -- `isChecked` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific mount type filter is currently active in the Mount Journal. For instance, if you want to check if the "Flying" mount filter is enabled, you would use the corresponding filter index for flying mounts. - -**Addons Usage:** -Large addons like "MountsJournal" or "CollectMe" might use this function to determine which mount types are currently being filtered by the user, allowing them to display or hide mounts accordingly. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md b/wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md deleted file mode 100644 index 9fa8e0bb..00000000 --- a/wiki-information/functions/C_MountJournal.IsUsingDefaultFilters.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_MountJournal.IsUsingDefaultFilters - -**Content:** -Needs summary. -`isUsingDefaultFilters = C_MountJournal.IsUsingDefaultFilters()` - -**Returns:** -- `isUsingDefaultFilters` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsValidSourceFilter.md b/wiki-information/functions/C_MountJournal.IsValidSourceFilter.md deleted file mode 100644 index 72a2d64c..00000000 --- a/wiki-information/functions/C_MountJournal.IsValidSourceFilter.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_MountJournal.IsValidSourceFilter - -**Content:** -Needs summary. -`isValid = C_MountJournal.IsValidSourceFilter(filterIndex)` - -**Parameters:** -- `filterIndex` - - *number* - -**Returns:** -- `isValid` - - *boolean* - -**Example Usage:** -This function can be used to check if a given source filter index is valid within the Mount Journal. This is useful for addons that manage or display mount collections, ensuring that the filters applied are valid and won't cause errors. - -**Addons:** -Large addons like "AllTheThings" and "CollectMe" might use this function to validate source filters when displaying or managing mount collections. This ensures that the filters applied by the user or the addon itself are valid and won't result in unexpected behavior. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.IsValidTypeFilter.md b/wiki-information/functions/C_MountJournal.IsValidTypeFilter.md deleted file mode 100644 index 7f1937fc..00000000 --- a/wiki-information/functions/C_MountJournal.IsValidTypeFilter.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_MountJournal.IsValidTypeFilter - -**Content:** -Needs summary. -`isValid = C_MountJournal.IsValidTypeFilter(filterIndex)` - -**Parameters:** -- `filterIndex` - - *number* - -**Returns:** -- `isValid` - - *boolean* - -**Example Usage:** -This function can be used to check if a given filter index is valid within the Mount Journal. This is useful when creating custom UIs or addons that interact with the Mount Journal and need to validate filter indices before applying them. - -**Addons:** -Large addons like "MountsJournal" or "CollectMe" might use this function to ensure that the filter indices they are working with are valid before applying filters to the Mount Journal. This helps in preventing errors and ensuring smooth functionality. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.NeedsFanfare.md b/wiki-information/functions/C_MountJournal.NeedsFanfare.md deleted file mode 100644 index b273d229..00000000 --- a/wiki-information/functions/C_MountJournal.NeedsFanfare.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_MountJournal.NeedsFanfare - -**Content:** -Needs summary. -`needsFanfare = C_MountJournal.NeedsFanfare(mountID)` - -**Parameters:** -- `mountID` - - *number* - -**Returns:** -- `needsFanfare` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.Pickup.md b/wiki-information/functions/C_MountJournal.Pickup.md deleted file mode 100644 index d66c7281..00000000 --- a/wiki-information/functions/C_MountJournal.Pickup.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_MountJournal.Pickup - -**Content:** -Picks up the specified mount onto the cursor, usually in preparation for placing it on an action button. -`C_MountJournal.Pickup(displayIndex)` - -**Parameters:** -- `displayIndex` - - *number* - Index of the mount, in the range of 1 to `C_MountJournal.GetNumMounts()` (inclusive), or 0 to pick up the "Summon Random Favorite Mount" button. - -**Description:** -- Triggers `CURSOR_UPDATE` to indicate that the contents of the cursor have changed. -- Triggers `ACTIONBAR_SHOWGRID` to indicate that the outlines of empty action bar buttons are now being displayed. -- Does nothing if the specified index is out of bounds or belongs to a mount that the player has not collected. -- When a mount is on the cursor, `GetCursorInfo()` returns `"mount", ` where `` is the same as the second value returned by `GetActionInfo()` for an action button containing the same mount. -- When the "Summon Random Favorite Mount" button is on the cursor or action button, the `mountActionID` is 268435455. - -**Reference:** -- `ClearCursor()` -- `GetCursorInfo()` -- `PlaceAction()` - -**Example Usage:** -This function can be used in macros or addons to allow players to easily place mounts on their action bars. For instance, an addon could provide a user interface for managing mounts and use `C_MountJournal.Pickup` to let players drag and drop mounts onto their action bars. - -**Addon Usage:** -Large addons like Bartender4 or Dominos, which provide extensive customization of action bars, might use this function to facilitate the placement of mounts on action buttons. This allows users to manage their mounts directly from the addon’s interface. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetAllSourceFilters.md b/wiki-information/functions/C_MountJournal.SetAllSourceFilters.md deleted file mode 100644 index 6d707558..00000000 --- a/wiki-information/functions/C_MountJournal.SetAllSourceFilters.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_MountJournal.SetAllSourceFilters - -**Content:** -Needs summary. -`C_MountJournal.SetAllSourceFilters(isChecked)` - -**Parameters:** -- `isChecked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetAllTypeFilters.md b/wiki-information/functions/C_MountJournal.SetAllTypeFilters.md deleted file mode 100644 index a76d48df..00000000 --- a/wiki-information/functions/C_MountJournal.SetAllTypeFilters.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_MountJournal.SetAllTypeFilters - -**Content:** -Needs summary. -`C_MountJournal.SetAllTypeFilters(isChecked)` - -**Parameters:** -- `isChecked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md b/wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md deleted file mode 100644 index e873c24e..00000000 --- a/wiki-information/functions/C_MountJournal.SetCollectedFilterSetting.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_MountJournal.SetCollectedFilterSetting - -**Content:** -Enables or disables the specified mount journal filter. -`C_MountJournal.SetCollectedFilterSetting(filterIndex, isChecked)` - -**Parameters:** -- `filterIndex` - - *number* - - `Value` - - `Enum` - - `Description` - - `1` - - `LE_MOUNT_JOURNAL_FILTER_COLLECTED` - - `2` - - `LE_MOUNT_JOURNAL_FILTER_NOT_COLLECTED` - - `3` - - `LE_MOUNT_JOURNAL_FILTER_UNUSABLE` -- `isChecked` - - *boolean* - -**Description:** -Does nothing if the specified ID is not associated with an existing filter. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetDefaultFilters.md b/wiki-information/functions/C_MountJournal.SetDefaultFilters.md deleted file mode 100644 index 50a73411..00000000 --- a/wiki-information/functions/C_MountJournal.SetDefaultFilters.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_MountJournal.SetDefaultFilters - -**Content:** -Needs summary. -`C_MountJournal.SetDefaultFilters()` - -**Description:** -This function resets the mount journal filters to their default state. This can be useful if you have applied multiple filters and want to quickly revert to the default view without manually unchecking each filter. - -**Example Usage:** -```lua --- Reset the mount journal filters to default -C_MountJournal.SetDefaultFilters() -``` - -**Use in Addons:** -Large addons like "MountsJournal" or "CollectMe" might use this function to ensure that the mount list is in a known state before applying their own custom filters or sorting logic. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetIsFavorite.md b/wiki-information/functions/C_MountJournal.SetIsFavorite.md deleted file mode 100644 index 78882fc7..00000000 --- a/wiki-information/functions/C_MountJournal.SetIsFavorite.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_MountJournal.SetIsFavorite - -**Content:** -Marks or unmarks the specified mount as a favorite. -`C_MountJournal.SetIsFavorite(mountIndex, isFavorite)` - -**Parameters:** -- `mountIndex` - - *number* - Index of the mount, in the range of 1 to `C_MountJournal.GetNumMounts()` (inclusive) -- `isFavorite` - - *boolean* - -**Description:** -Does nothing if the specified index is out of range. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetSearch.md b/wiki-information/functions/C_MountJournal.SetSearch.md deleted file mode 100644 index d8a2bb5a..00000000 --- a/wiki-information/functions/C_MountJournal.SetSearch.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_MountJournal.SetSearch - -**Content:** -Needs summary. -`C_MountJournal.SetSearch(searchValue)` - -**Parameters:** -- `searchValue` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetSourceFilter.md b/wiki-information/functions/C_MountJournal.SetSourceFilter.md deleted file mode 100644 index 60be1328..00000000 --- a/wiki-information/functions/C_MountJournal.SetSourceFilter.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_MountJournal.SetSourceFilter - -**Content:** -Needs summary. -`C_MountJournal.SetSourceFilter(filterIndex, isChecked)` - -**Parameters:** -- `filterIndex` - - *number* -- `isChecked` - - *boolean* - -**Description:** -This function is used to set the source filter for the Mount Journal. The `filterIndex` parameter specifies which filter to set, and the `isChecked` parameter specifies whether the filter should be enabled or disabled. - -**Example Usage:** -```lua --- Enable the filter for mounts obtained from achievements -C_MountJournal.SetSourceFilter(1, true) - --- Disable the filter for mounts obtained from vendors -C_MountJournal.SetSourceFilter(2, false) -``` - -**Additional Information:** -This function is commonly used in addons that manage or enhance the Mount Journal, such as MountFarmHelper or MountJournalEnhanced. These addons use this function to allow users to quickly filter and find specific mounts based on their source. \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SetTypeFilter.md b/wiki-information/functions/C_MountJournal.SetTypeFilter.md deleted file mode 100644 index 80edf6d1..00000000 --- a/wiki-information/functions/C_MountJournal.SetTypeFilter.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_MountJournal.SetTypeFilter - -**Content:** -Needs summary. -`C_MountJournal.SetTypeFilter(filterIndex, isChecked)` - -**Parameters:** -- `filterIndex` - - *number* -- `isChecked` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_MountJournal.SummonByID.md b/wiki-information/functions/C_MountJournal.SummonByID.md deleted file mode 100644 index bfec52db..00000000 --- a/wiki-information/functions/C_MountJournal.SummonByID.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_MountJournal.SummonByID - -**Content:** -Summons the specified mount. -`C_MountJournal.SummonByID(mountID)` - -**Parameters:** -- `mountID` - - *number* : MountID - Valid mount IDs are returned from `C_MountJournal.GetMountIDs()`, or 0 to summon a random favorite mount appropriate to the current area. - -**Reference:** -- `UNIT_SPELLCAST_SENT`, when the player begins casting the spell to summon the mount. -- `COMPANION_UPDATE`, after the spellcast completes, but at this time `IsMounted()` does not yet return true. -- See also: `C_MountJournal.Dismiss`. - -**Description:** -If the specified index is out of range, nothing happens. -If the player has not yet collected the specified mount, no mount is summoned, and an error message is displayed in the center of the player's screen. The text of the error message is contained in the global variable `MOUNT_JOURNAL_NOT_COLLECTED`; in English clients, it is "You have not collected this mount." -If the specified index is 0, but the player has not marked any mounts as favorites, or does not have any favorite mounts that are appropriate for the current area, the error message "You have no valid favorite mounts." (global variable `ERR_MOUNT_NO_FAVORITES`) is displayed. -If the player cannot fly in the current area, then "appropriate for the current area" only includes ground-only mounts; it does not include flying mounts which can also run on land. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md b/wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md deleted file mode 100644 index 283a82d5..00000000 --- a/wiki-information/functions/C_NamePlate.GetNamePlateForUnit.md +++ /dev/null @@ -1,47 +0,0 @@ -## Title: C_NamePlate.GetNamePlateForUnit - -**Content:** -Returns the nameplate for a unit. -`nameplate = C_NamePlate.GetNamePlateForUnit(unitId)` - -**Parameters:** -- `unitId` - - *string* - UnitId -- `isSecure` - - *boolean?* - If protected nameplates for friendly units while in instanced areas should be returned. - -**Returns:** -- `nameplate` - - *NameplateBase?* - Frame|NamePlateBaseMixin - - `Field` - - `Type` - - `Description` - - `UnitFrame` - - *Button* - - `driverFrame` - - *NamePlateDriverFrame* - points to NamePlateDriverFrame (NamePlateDriverMixin) - - `namePlateUnitToken` - - *string* - e.g. "nameplate1" - - `template` - - *string* - e.g. "NamePlateUnitFrameTemplate" - - `NamePlateBaseMixin` - - `OnAdded` - - *function* - - `OnRemoved` - - *function* - - `OnOptionsUpdated` - - *function* - - `ApplyOffsets` - - *function* - - `GetAdditionalInsetPadding` - - *function* - - `GetPreferredInsets` - - *function* - - `OnSizeChanged` - - *function* - -**Example Usage:** -This function can be used to retrieve the nameplate frame associated with a specific unit, which can be useful for customizing the appearance or behavior of nameplates in addons. - -**Addon Usage:** -Large addons like ElvUI and Plater Nameplates use this function to manage and customize nameplates for units, allowing for enhanced visual customization and additional functionality such as displaying debuffs, health bars, and other unit-specific information directly on the nameplate. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.GetNamePlates.md b/wiki-information/functions/C_NamePlate.GetNamePlates.md deleted file mode 100644 index 06f4175f..00000000 --- a/wiki-information/functions/C_NamePlate.GetNamePlates.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: C_NamePlate.GetNamePlates - -**Content:** -Returns the currently visible nameplates. -`nameplates = C_NamePlate.GetNamePlates()` - -**Parameters:** -- `isSecure` - - *boolean?* - Whether protected nameplates for friendly units while in instanced areas should be returned. - -**Returns:** -- `nameplates` - - *NameplateBase : Frame|NamePlateBaseMixin* - - `Field` - - `Type` - - `Description` - - `UnitFrame` - - *Button* - - `driverFrame` - - *NamePlateDriverFrame* - points to NamePlateDriverFrame (NamePlateDriverMixin) - - `namePlateUnitToken` - - *string* - e.g. "nameplate1" - - `template` - - *string* - e.g. "NamePlateUnitFrameTemplate" - - `NamePlateBaseMixin` - - `OnAdded` - - *function* - - `OnRemoved` - - *function* - - `OnOptionsUpdated` - - *function* - - `ApplyOffsets` - - *function* - - `GetAdditionalInsetPadding` - - *function* - - `GetPreferredInsets` - - *function* - - `OnSizeChanged` - - *function* - -**Example Usage:** -This function can be used to retrieve all currently visible nameplates, which is useful for addons that need to interact with or display information about nameplates. For example, an addon that customizes nameplate appearance or adds additional information like health percentages or debuffs would use this function to get the list of nameplates to modify. - -**Addons Using This Function:** -- **TidyPlates**: A popular addon that enhances the default nameplates with additional customization options and information. It uses `C_NamePlate.GetNamePlates` to retrieve the current nameplates and apply its custom styles and data overlays. -- **Plater Nameplates**: Another widely used nameplate addon that offers extensive customization and scripting capabilities. It leverages this function to manage and update the nameplates dynamically based on user settings and scripts. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md b/wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md deleted file mode 100644 index 5e1b44b3..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateEnemyClickThrough.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_NamePlate.SetNamePlateEnemyClickThrough - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateEnemyClickThrough(clickthrough)` - -**Parameters:** -- `clickthrough` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md b/wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md deleted file mode 100644 index 935adad6..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateEnemyPreferredClickInsets.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_NamePlate.SetNamePlateEnemyPreferredClickInsets - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateEnemyPreferredClickInsets(left, right, top, bottom)` - -**Parameters:** -- `left` - - *number* -- `right` - - *number* -- `top` - - *number* -- `bottom` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md b/wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md deleted file mode 100644 index 485af6d5..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateEnemySize.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_NamePlate.SetNamePlateEnemySize - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateEnemySize(width, height)` - -**Parameters:** -- `width` - - *number* -- `height` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md deleted file mode 100644 index fc7aa434..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyClickThrough.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_NamePlate.SetNamePlateFriendlyClickThrough - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateFriendlyClickThrough(clickthrough)` - -**Parameters:** -- `clickthrough` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md deleted file mode 100644 index cf91a177..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlyPreferredClickInsets.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_NamePlate.SetNamePlateFriendlyPreferredClickInsets - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateFriendlyPreferredClickInsets(left, right, top, bottom)` - -**Parameters:** -- `left` - - *number* -- `right` - - *number* -- `top` - - *number* -- `bottom` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md b/wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md deleted file mode 100644 index d515c678..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateFriendlySize.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_NamePlate.SetNamePlateFriendlySize - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateFriendlySize(width, height)` - -**Parameters:** -- `width` - - *number* -- `height` - - *number* - -**Example Usage:** -This function can be used to set the size of friendly nameplates in the game. For instance, if you want to make friendly nameplates larger for better visibility in a crowded area, you could use this function to adjust their width and height. - -**Addons:** -Large addons like ElvUI and Plater Nameplates might use this function to allow users to customize the appearance of friendly nameplates according to their preferences. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md b/wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md deleted file mode 100644 index c8a0ded5..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateSelfClickThrough.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_NamePlate.SetNamePlateSelfClickThrough - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateSelfClickThrough(clickthrough)` - -**Parameters:** -- `clickthrough` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md b/wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md deleted file mode 100644 index a2367ec2..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateSelfPreferredClickInsets.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_NamePlate.SetNamePlateSelfPreferredClickInsets - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateSelfPreferredClickInsets(left, right, top, bottom)` - -**Parameters:** -- `left` - - *number* -- `right` - - *number* -- `top` - - *number* -- `bottom` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md b/wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md deleted file mode 100644 index dc70a1e5..00000000 --- a/wiki-information/functions/C_NamePlate.SetNamePlateSelfSize.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_NamePlate.SetNamePlateSelfSize - -**Content:** -Needs summary. -`C_NamePlate.SetNamePlateSelfSize(width, height)` - -**Parameters:** -- `width` - - *number* -- `height` - - *number* - -**Example Usage:** -This function can be used to set the size of the player's own nameplate. For instance, if you want to make your nameplate larger for better visibility, you can call this function with the desired width and height. - -```lua --- Example: Set the player's nameplate size to 150 width and 40 height -C_NamePlate.SetNamePlateSelfSize(150, 40) -``` - -**Usage in Addons:** -Large addons like ElvUI and Plater Nameplates use this function to customize the appearance of nameplates, including the player's own nameplate, to provide a more personalized and informative UI experience. \ No newline at end of file diff --git a/wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md b/wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md deleted file mode 100644 index 976aaa1e..00000000 --- a/wiki-information/functions/C_NamePlate.SetTargetClampingInsets.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_NamePlate.SetTargetClampingInsets - -**Content:** -Needs summary. -`C_NamePlate.SetTargetClampingInsets(verticalInset, unk)` - -**Parameters:** -- `verticalInset` - - *number* - The clamping inset from the top and bottom of the screen. -- `unk` - - *number* - Unknown \ No newline at end of file diff --git a/wiki-information/functions/C_NewItems.ClearAll.md b/wiki-information/functions/C_NewItems.ClearAll.md deleted file mode 100644 index 678f9a56..00000000 --- a/wiki-information/functions/C_NewItems.ClearAll.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_NewItems.ClearAll - -**Content:** -Clears the new item flag on all items in the player's inventory. -`C_NewItems.ClearAll()` - -**Reference:** -- `C_NewItems.IsNewItem` -- `C_NewItems.RemoveNewItem` \ No newline at end of file diff --git a/wiki-information/functions/C_NewItems.IsNewItem.md b/wiki-information/functions/C_NewItems.IsNewItem.md deleted file mode 100644 index 07cd1610..00000000 --- a/wiki-information/functions/C_NewItems.IsNewItem.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_NewItems.IsNewItem - -**Content:** -Returns true if the item in the inventory slot is flagged as new. -`isNew = C_NewItems.IsNewItem(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* - BagID of the container. -- `slotIndex` - - *number* - ID of the inventory slot within the container. - -**Returns:** -- `isNew` - - *boolean* - Returns true if the inventory slot holds a newly-acquired item; otherwise false (empty slot or a non-new item). - -**Reference:** -- `C_NewItems.RemoveNewItem(bag, slot)` - Used by FrameXML/ContainerFrame.lua to clear the new-item flag after interacting with the new item or closing the bags. -- `IsBattlePayItem(bag, slot)` - Used by FrameXML/ContainerFrame.lua to emphasize recent purchases from the In-Game Store. \ No newline at end of file diff --git a/wiki-information/functions/C_NewItems.RemoveNewItem.md b/wiki-information/functions/C_NewItems.RemoveNewItem.md deleted file mode 100644 index 99b5954a..00000000 --- a/wiki-information/functions/C_NewItems.RemoveNewItem.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_NewItems.RemoveNewItem - -**Content:** -Clears the "new item" flag. -`C_NewItems.RemoveNewItem(containerIndex, slotIndex)` - -**Parameters:** -- `containerIndex` - - *number* : bagID - container slot id. -- `slotIndex` - - *number* - slot within the bag to clear the "new item" flag for. - -**Reference:** -- `C_NewItems.ClearAll` \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md b/wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md deleted file mode 100644 index 1d33ab4e..00000000 --- a/wiki-information/functions/C_PaperDollInfo.GetArmorEffectiveness.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_PaperDollInfo.GetArmorEffectiveness - -**Content:** -Needs summary. -`effectiveness = C_PaperDollInfo.GetArmorEffectiveness(armor, attackerLevel)` - -**Parameters:** -- `armor` - - *number* -- `attackerLevel` - - *number* - -**Returns:** -- `effectiveness` - - *number* - -**Example Usage:** -This function can be used to determine the effectiveness of a player's armor against an attacker of a specific level. This can be particularly useful for addons that calculate damage mitigation or for theorycrafters analyzing the impact of armor on damage taken. - -**Addon Usage:** -Large addons like Pawn or SimulationCraft might use this function to provide players with detailed information about how their armor will perform against enemies of different levels. This helps players make informed decisions about gear upgrades and optimizations. \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md b/wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md deleted file mode 100644 index f679efc5..00000000 --- a/wiki-information/functions/C_PaperDollInfo.GetArmorEffectivenessAgainstTarget.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_PaperDollInfo.GetArmorEffectivenessAgainstTarget - -**Content:** -Needs summary. -`effectiveness = C_PaperDollInfo.GetArmorEffectivenessAgainstTarget(armor)` - -**Parameters:** -- `armor` - - *number* - -**Returns:** -- `effectiveness` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md b/wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md deleted file mode 100644 index 6d8a4068..00000000 --- a/wiki-information/functions/C_PaperDollInfo.GetMinItemLevel.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_PaperDollInfo.GetMinItemLevel - -**Content:** -Needs summary. -`minItemLevel = C_PaperDollInfo.GetMinItemLevel()` - -**Returns:** -- `minItemLevel` - - *number?* - -**Example Usage:** -This function can be used to retrieve the minimum item level of the player's equipment. This can be useful for addons that need to check if the player meets certain item level requirements for dungeons, raids, or other content. - -**Addon Usage:** -Large addons like "Pawn" or "GearScore" might use this function to evaluate and compare the player's gear to suggest upgrades or improvements. \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md b/wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md deleted file mode 100644 index bb56dd08..00000000 --- a/wiki-information/functions/C_PaperDollInfo.OffhandHasShield.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PaperDollInfo.OffhandHasShield - -**Content:** -Needs summary. -`offhandHasShield = C_PaperDollInfo.OffhandHasShield()` - -**Returns:** -- `offhandHasShield` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md b/wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md deleted file mode 100644 index bbbf775b..00000000 --- a/wiki-information/functions/C_PaperDollInfo.OffhandHasWeapon.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PaperDollInfo.OffhandHasWeapon - -**Content:** -Needs summary. -`offhandHasWeapon = C_PaperDollInfo.OffhandHasWeapon()` - -**Returns:** -- `offhandHasWeapon` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md b/wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md deleted file mode 100644 index a9348b13..00000000 --- a/wiki-information/functions/C_PartyInfo.ConfirmLeaveParty.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PartyInfo.ConfirmLeaveParty - -**Content:** -Immediately leave the party with no regard for potentially destructive actions. -`C_PartyInfo.ConfirmLeaveParty()` - -**Parameters:** -- `category` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.GetActiveCategories.md b/wiki-information/functions/C_PartyInfo.GetActiveCategories.md deleted file mode 100644 index 3132c3a6..00000000 --- a/wiki-information/functions/C_PartyInfo.GetActiveCategories.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PartyInfo.GetActiveCategories - -**Content:** -Needs summary. -`categories = C_PartyInfo.GetActiveCategories()` - -**Returns:** -- `categories` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md b/wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md deleted file mode 100644 index a08182fc..00000000 --- a/wiki-information/functions/C_PartyInfo.GetInviteConfirmationInvalidQueues.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_PartyInfo.GetInviteConfirmationInvalidQueues - -**Content:** -Needs summary. -`invalidQueues = C_PartyInfo.GetInviteConfirmationInvalidQueues(inviteGUID)` - -**Parameters:** -- `inviteGUID` - - *string* - -**Returns:** -- `invalidQueues` - - *unknown* QueueSpecificInfo \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md b/wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md deleted file mode 100644 index 2a4ccf54..00000000 --- a/wiki-information/functions/C_PartyInfo.IsCrossFactionParty.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_PartyInfo.IsCrossFactionParty - -**Content:** -Needs summary. -`isCrossFactionParty = C_PartyInfo.IsCrossFactionParty()` - -**Parameters:** -- `category` - - *number?* - If not provided, the active party is used. - -**Returns:** -- `isCrossFactionParty` - - *boolean* - -**Example Usage:** -This function can be used to determine if the current party is a cross-faction party, which can be useful for addons that need to handle faction-specific logic differently. - -**Addons:** -Large addons like "ElvUI" or "DBM" might use this function to adjust their behavior based on whether the party is cross-faction, ensuring compatibility and proper functionality across different faction members. \ No newline at end of file diff --git a/wiki-information/functions/C_PartyInfo.IsPartyFull.md b/wiki-information/functions/C_PartyInfo.IsPartyFull.md deleted file mode 100644 index b82098db..00000000 --- a/wiki-information/functions/C_PartyInfo.IsPartyFull.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_PartyInfo.IsPartyFull - -**Content:** -Needs summary. -`isFull = C_PartyInfo.IsPartyFull()` - -**Parameters:** -- `category` - - *number?* - If not provided, the active party is used. - -**Returns:** -- `isFull` - - *boolean* - -**Example Usage:** -This function can be used to check if the current party is full. This is useful in scenarios where you want to ensure that there is space available before inviting another player to the party. - -**Example:** -```lua -if not C_PartyInfo.IsPartyFull() then - -- Invite a player to the party - InviteUnit("PlayerName") -else - print("The party is full.") -end -``` - -**Addons Usage:** -Large addons like "ElvUI" and "DBM" (Deadly Boss Mods) might use this function to manage party compositions and ensure that party-related features are only activated when the party is not full. For example, DBM might use it to check if there is room to invite more players for a raid. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.ClearSearchFilter.md b/wiki-information/functions/C_PetJournal.ClearSearchFilter.md deleted file mode 100644 index 97445524..00000000 --- a/wiki-information/functions/C_PetJournal.ClearSearchFilter.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_PetJournal.ClearSearchFilter - -**Content:** -Clears the search box in the pet journal. -`C_PetJournal.ClearSearchFilter()` - -**Reference:** -- `C_PetJournal.SetSearchFilter` - -**Example Usage:** -This function can be used in addons that manage or enhance the pet journal interface. For instance, an addon that provides advanced search and filtering options for pets might use `C_PetJournal.ClearSearchFilter` to reset the search box before applying new filters. - -**Addons:** -Large addons like "Rematch" use this function to manage pet collections and provide a better user interface for pet battles and pet management. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.FindPetIDByName.md b/wiki-information/functions/C_PetJournal.FindPetIDByName.md deleted file mode 100644 index 6ca0c9e6..00000000 --- a/wiki-information/functions/C_PetJournal.FindPetIDByName.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_PetJournal.FindPetIDByName - -**Content:** -Returns pet species and GUID by pet name. -`speciesId, petGUID = C_PetJournal.FindPetIDByName(petName)` - -**Parameters:** -- `petName` - - *string* - Name of the pet to find species/GUID of. - -**Returns:** -- `speciesId` - - *number* - Species ID of the first battle pet (or species) with the specified name, nil if no such pet exists. -- `petGUID` - - *string* - GUID of the first battle pet collected by the player with the specified name, nil if the player has not collected any pets with the specified name. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md b/wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md deleted file mode 100644 index c3bc8c9c..00000000 --- a/wiki-information/functions/C_PetJournal.GetNumCollectedInfo.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_PetJournal.GetNumCollectedInfo - -**Content:** -Returns the number of collected battle pets of a particular species. -`numCollected, limit = C_PetJournal.GetNumCollectedInfo(speciesId)` - -**Parameters:** -- `speciesId` - - *number* - Battle pet species ID to query, e.g. 635 for Adder battle pets. - -**Returns:** -- `numCollected` - - *number* - Number of battle pets of the queried species the player has collected. -- `limit` - - *number* - Maximum number of battle pets of the queried species the player may collect. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPetSources.md b/wiki-information/functions/C_PetJournal.GetNumPetSources.md deleted file mode 100644 index c6d40af7..00000000 --- a/wiki-information/functions/C_PetJournal.GetNumPetSources.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_PetJournal.GetNumPetSources - -**Content:** -Returns information about the number of pet sources. -`numSources = C_PetJournal.GetNumPetSources()` - -**Returns:** -- `numSources` - - *number* - Number of pet sources available - -**Reference:** -- `C_PetJournal.SetAllPetSourcesChecked` -- `C_PetJournal.IsPetSourceChecked` -- `C_PetJournal.SetPetSourceChecked` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPetTypes.md b/wiki-information/functions/C_PetJournal.GetNumPetTypes.md deleted file mode 100644 index 0741c916..00000000 --- a/wiki-information/functions/C_PetJournal.GetNumPetTypes.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_PetJournal.GetNumPetTypes - -**Content:** -Returns information about the number of pet types. -`numTypes = C_PetJournal.GetNumPetTypes()` - -**Returns:** -- `numTypes` - - *number* - Number of pet types available - -**Reference:** -- `C_PetJournal.SetAllPetTypesChecked` -- `C_PetJournal.IsPetTypeChecked` -- `C_PetJournal.SetPetTypeFilter` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPets.md b/wiki-information/functions/C_PetJournal.GetNumPets.md deleted file mode 100644 index 9602035f..00000000 --- a/wiki-information/functions/C_PetJournal.GetNumPets.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_PetJournal.GetNumPets - -**Content:** -Returns information about the number of battle pets. -`numPets, numOwned = C_PetJournal.GetNumPets()` - -**Returns:** -- `numPets` - - *number* - Total number of pets available -- `numOwned` - - *number* - Number of pets currently owned \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md b/wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md deleted file mode 100644 index 51b697b2..00000000 --- a/wiki-information/functions/C_PetJournal.GetNumPetsInJournal.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_PetJournal.GetNumPetsInJournal - -**Content:** -Needs summary. -`maxAllowed, numPets = C_PetJournal.GetNumPetsInJournal(creatureID)` - -**Parameters:** -- `creatureID` - - *number* - -**Returns:** -- `maxAllowed` - - *number* -- `numPets` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md b/wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md deleted file mode 100644 index 1ad712d7..00000000 --- a/wiki-information/functions/C_PetJournal.GetOwnedBattlePetString.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_PetJournal.GetOwnedBattlePetString - -**Content:** -Returns a formatted string indicating how many of a battle pet species the player has collected. -`ownedString = C_PetJournal.GetOwnedBattlePetString(speciesId)` - -**Parameters:** -- `speciesId` - - *number* - Battle pet species ID. - -**Returns:** -- `ownedString` - - *string* - a description of how many pets of this species you've collected, e.g. `"|cFFFFD200Collected (1/3)"`, or `nil` if you haven't collected any. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md b/wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md deleted file mode 100644 index a5abcfba..00000000 --- a/wiki-information/functions/C_PetJournal.GetPetCooldownByGUID.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_PetJournal.GetPetCooldownByGUID - -**Content:** -Returns the cooldown associated with summoning a battle pet companion. -`start, duration, isEnabled = C_PetJournal.GetPetCooldownByGUID(GUID)` - -**Parameters:** -- `GUID` - - *string* - GUID of a battle pet in your collection to query the cooldown of. - -**Returns:** -- `start` - - *number* - the time the cooldown period began, based on GetTime(). -- `duration` - - *number* - the duration of the cooldown period. -- `isEnabled` - - *number* - 1 if the cooldown is not paused. - -**Description:** -If the queried pet is not currently on a cooldown, this function will return 0, 0, 1. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md b/wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md deleted file mode 100644 index 1fd8e5a6..00000000 --- a/wiki-information/functions/C_PetJournal.GetPetInfoByIndex.md +++ /dev/null @@ -1,72 +0,0 @@ -## Title: C_PetJournal.GetPetInfoByIndex - -**Content:** -Returns information about a battle pet. -`petID, speciesID, owned, customName, level, favorite, isRevoked, speciesName, icon, petType, companionID, tooltip, description, isWild, canBattle, isTradeable, isUnique, obtainable = C_PetJournal.GetPetInfoByIndex(index)` - -**Parameters:** -- `index` - - *number* - Numeric index of the pet in the Pet Journal, ascending from 1. - -**Returns:** -- `Index` -- `Value` -- `Type` -- `Details` - - `1` - - `petID` - - *String* - GUID for this specific pet - - `2` - - `speciesID` - - *Number* - Identifier for the pet species - - `3` - - `owned` - - *Boolean* - Whether the pet is owned by the player - - `4` - - `customName` - - *String* - Name assigned by the player or nil if unnamed - - `5` - - `level` - - *Number* - The pet's current battle level - - `6` - - `favorite` - - *Boolean* - Whether the pet is marked as a favorite - - `7` - - `isRevoked` - - *Boolean* - True if the pet is revoked; false otherwise. - - `8` - - `speciesName` - - *String* - Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.) - - `9` - - `icon` - - *String* - Full path for the species' icon - - `10` - - `petType` - - *Number* - Index of the species' petType. - - `11` - - `companionID` - - *Number* - NPC ID for the summoned companion pet. - - `12` - - `tooltip` - - *String* - Section of the tooltip that provides location information - - `13` - - `description` - - *String* - Section of the tooltip that provides pet description ("flavor text") - - `14` - - `isWild` - - *Boolean* - True if the pet was/can be caught in the wild, false otherwise. - - `15` - - `canBattle` - - *Boolean* - True if this pet can be used in battles, false otherwise. - - `16` - - `isTradeable` - - *Boolean* - True if this pet can be traded, false otherwise. - - `17` - - `isUnique` - - *Boolean* - True if this pet is unique, false otherwise. - - `18` - - `obtainable` - - *Boolean* - True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets). - -**Description:** -`index` is subject to filter and search result, e.g., a search for "Snake" where `index` is 1 will return information about the first snake in the journal, whereas an empty search and filter will return information about the first pet in the journal. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md b/wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md deleted file mode 100644 index 85cfd718..00000000 --- a/wiki-information/functions/C_PetJournal.GetPetInfoByPetID.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_PetJournal.GetPetInfoByPetID - -**Content:** -Returns information about a battle pet. -`speciesID, customName, level, xp, maxXp, displayID, isFavorite, name, icon, petType, creatureID, sourceText, description, isWild, canBattle, tradable, unique, obtainable = C_PetJournal.GetPetInfoByPetID(petID)` - -**Parameters:** -- `petID` - - *string* : GUID - -**Returns:** -| Index | Value | Type | Details | -|-------|-------------|---------|-----------------------------------------------------------------------------------------------| -| 1 | speciesID | Number | Identifier for the pet species | -| 2 | customName | String | Name assigned by the player or nil if unnamed | -| 3 | level | Number | The pet's current battle level | -| 4 | xp | Number | The pet's current xp | -| 5 | maxXp | Number | The pet's maximum xp | -| 6 | displayID | Number | The display ID of the pet | -| 7 | isFavorite | Boolean | Whether the pet is marked as a favorite | -| 8 | name | String | Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.) | -| 9 | icon | String | Full path for the species' icon | -| 10 | petType | Number | Index of the species' pet type | -| 11 | creatureID | Number | NPC ID for the summoned companion pet | -| 12 | sourceText | String | Section of the tooltip that provides location information | -| 13 | description | String | Section of the tooltip that provides pet description ("flavor text") | -| 14 | isWild | Boolean | For pets in the player's possession, true if the pet was caught in the wild. For pets not in the player's possession, true if the pet can be caught in the wild. | -| 15 | canBattle | Boolean | True if this pet can be used in battles, false otherwise. | -| 16 | tradable | Boolean | True if this pet can be traded, false otherwise. | -| 17 | unique | Boolean | True if this pet is unique, false otherwise. | -| 18 | obtainable | Boolean | True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets). | - -**Description:** -Information about the player's battle pets is available after `UPDATE_SUMMONPETS_ACTION` has fired. - -**Reference:** -- `C_PetJournal.GetPetStats` -- `C_PetJournal.GetPetInfoBySpeciesID` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md b/wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md deleted file mode 100644 index 1d94f2cf..00000000 --- a/wiki-information/functions/C_PetJournal.GetPetInfoBySpeciesID.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_PetJournal.GetPetInfoBySpeciesID - -**Content:** -Returns information about a pet species. -`speciesName, speciesIcon, petType, companionID, tooltipSource, tooltipDescription, isWild, canBattle, isTradeable, isUnique, obtainable, creatureDisplayID = C_PetJournal.GetPetInfoBySpeciesID(speciesID)` - -**Parameters:** -- `speciesID` - - *number* - identifier for the pet species - -**Returns:** -| Index | Value | Type | Details | -|-------|---------------------|---------|--------------------------------------------------------------------------------------------------------------| -| 1 | speciesName | String | Name of the pet species ("Albino Snake", "Blue Mini Jouster", etc.) | -| 2 | speciesIcon | String | Full path for the species' icon | -| 3 | petType | Number | Index of the species' pet type. | -| 4 | companionID | Number | NPC ID for the summoned companion pet. | -| 5 | tooltipSource | String | Section of the species tooltip that provides location information | -| 6 | tooltipDescription | String | Section of the species tooltip that provides pet description ("flavor text") | -| 7 | isWild | Boolean | For pets in the player's possession, true if the pet was caught in the wild. For pets not in the player's possession, true if the pet can be caught in the wild. | -| 8 | canBattle | Boolean | True if this pet can be used in battles, false otherwise. | -| 9 | isTradeable | Boolean | True if this pet can be traded, false otherwise. | -| 10 | isUnique | Boolean | True if this pet is unique, false otherwise. | -| 11 | obtainable | Boolean | True if this pet can be obtained, false otherwise (only false for tamer pets and developer/test pets). | -| 12 | creatureDisplayID | Number | Creature display ID of the species. | - -**Reference:** -`C_PetJournal.GetPetInfoByPetID` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md b/wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md deleted file mode 100644 index a1455a10..00000000 --- a/wiki-information/functions/C_PetJournal.GetPetLoadOutInfo.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_PetJournal.GetPetLoadOutInfo - -**Content:** -Returns information about a slot in your battle pet team. -`petGUID, ability1, ability2, ability3, locked = C_PetJournal.GetPetLoadOutInfo(slotIndex)` - -**Parameters:** -- `slotIndex` - - *number* - battle pet slot index, an integer between 1 and 3. Values outside this range throw an error. - -**Returns:** -- `petGUID` - - *string* - GUID of the battle pet currently in this slot. -- `ability1` - - *number* - Ability ID of the first (level 1/10) ability selected for the battle pet in this slot. -- `ability2` - - *number* - Ability ID of the second (level 2/15) ability selected for the battle pet in this slot. -- `ability3` - - *number* - Ability ID of the third (level 4/20) ability selected for the battle pet in this slot. -- `locked` - - *boolean* - false if the player can place a battle pet in this slot, true otherwise. - -**Description:** -Ability IDs are returned even for slots that are not yet unlocked by a low-level battle pet. -Slots are locked until the player has earned the necessary achievement/skill. The first slot is unlocked by learning. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetSortParameter.md b/wiki-information/functions/C_PetJournal.GetPetSortParameter.md deleted file mode 100644 index acf2eec3..00000000 --- a/wiki-information/functions/C_PetJournal.GetPetSortParameter.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_PetJournal.GetPetSortParameter - -**Content:** -Returns the index of the currently active sort parameter. -`sortParameter = C_PetJournal.GetPetSortParameter()` - -**Returns:** -- `sortParameter` - - *number* - currently active ordering for `C_PetJournal.GetPetInfoByIndex`, e.g. 1 for sorting by name. - -**Reference:** -- `C_PetJournal.SetPetSortParameter` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetPetSummonInfo.md b/wiki-information/functions/C_PetJournal.GetPetSummonInfo.md deleted file mode 100644 index 3ae51b05..00000000 --- a/wiki-information/functions/C_PetJournal.GetPetSummonInfo.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_PetJournal.GetPetSummonInfo - -**Content:** -Needs summary. -`isSummonable, error, errorText = C_PetJournal.GetPetSummonInfo(battlePetGUID)` - -**Parameters:** -- `battlePetGUID` - - *string* - -**Returns:** -- `isSummonable` - - *boolean* -- `error` - - *Enum.PetJournalError* - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - PetIsDead - - `2` - JournalIsLocked - - `3` - InvalidFaction - - `4` - NoFavoritesToSummon - - `5` - NoValidRandomSummon - - `6` - InvalidCovenant -- `errorText` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md b/wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md deleted file mode 100644 index d712cc84..00000000 --- a/wiki-information/functions/C_PetJournal.GetSummonedPetGUID.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_PetJournal.GetSummonedPetGUID - -**Content:** -Returns information about a battle pet. -`summonedPetGUID = C_PetJournal.GetSummonedPetGUID()` - -**Returns:** -- `summonedPetGUID` - - *string* - GUID identifying the currently-summoned battle pet, or nil if no battle pet is summoned. - -**Description:** -Blizzard has moved all petIDs over to the "petGUID" system, but left all of their functions using the petID terminology (not the petGUID terminology) except for this one. For consistency, the term "petID" should continue to be used. - -**Reference:** -- `C_PetJournal.SummonPetByGUID` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.IsFilterChecked.md b/wiki-information/functions/C_PetJournal.IsFilterChecked.md deleted file mode 100644 index f1f91d29..00000000 --- a/wiki-information/functions/C_PetJournal.IsFilterChecked.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_PetJournal.IsFilterChecked - -**Content:** -Returns true if the selected filter is checked. -`isFiltered = C_PetJournal.IsFilterChecked(filter)` - -**Parameters:** -- `filter` - - *number* - Bitfield for each filter - - `LE_PET_JOURNAL_FILTER_COLLECTED`: Pets you have collected - - `LE_PET_JOURNAL_FILTER_NOT_COLLECTED`: Pets you have not collected - -**Returns:** -- `isFiltered` - - *boolean* - True if the filter is checked, false if the filter is unchecked - -**Reference:** -- `C_PetJournal.SetFilterChecked` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.IsPetSourceChecked.md b/wiki-information/functions/C_PetJournal.IsPetSourceChecked.md deleted file mode 100644 index 9a2da1a1..00000000 --- a/wiki-information/functions/C_PetJournal.IsPetSourceChecked.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_PetJournal.IsPetSourceChecked - -**Content:** -Returns true if the pet source is checked. -`isChecked = C_PetJournal.IsPetSourceChecked(index)` - -**Parameters:** -- `index` - - *number* - Index (from 1 to GetNumPetSources()) of all available pet sources - -**Returns:** -- `isChecked` - - *boolean* - True if the source is checked, false if the source is unchecked - -**Reference:** -- `C_PetJournal.SetAllPetSourcesChecked` -- `C_PetJournal.SetPetSourceChecked` -- `C_PetJournal.GetNumPetSources` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.IsPetTypeChecked.md b/wiki-information/functions/C_PetJournal.IsPetTypeChecked.md deleted file mode 100644 index 018bb0c6..00000000 --- a/wiki-information/functions/C_PetJournal.IsPetTypeChecked.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_PetJournal.IsPetTypeChecked - -**Content:** -Returns true if the pet type is checked. -`isChecked = C_PetJournal.IsPetTypeChecked(index)` - -**Parameters:** -- `index` - - *number* - Index (from 1 to GetNumPetTypes()) of all available pet types - -**Returns:** -- `isChecked` - - *boolean* - True if the filter is checked, false if the filter is unchecked - -**Reference:** -- `C_PetJournal.SetAllPetTypesChecked` -- `C_PetJournal.SetPetTypeFilter` -- `C_PetJournal.GetNumPetTypes` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PetIsFavorite.md b/wiki-information/functions/C_PetJournal.PetIsFavorite.md deleted file mode 100644 index f9cf7663..00000000 --- a/wiki-information/functions/C_PetJournal.PetIsFavorite.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_PetJournal.PetIsFavorite - -**Content:** -Returns true if the collected battle pet is favorited. -`isFavorite = C_PetJournal.PetIsFavorite(petGUID)` - -**Parameters:** -- `petGUID` - - *string* - GUID of a battle pet in your collection. - -**Returns:** -- `isFavorite` - - *boolean* - true if this pet is marked as a favorite, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PetIsRevoked.md b/wiki-information/functions/C_PetJournal.PetIsRevoked.md deleted file mode 100644 index df7b34ac..00000000 --- a/wiki-information/functions/C_PetJournal.PetIsRevoked.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_PetJournal.PetIsRevoked - -**Content:** -Returns whether or not the pet is revoked. -`isRevoked = C_PetJournal.PetIsRevoked(petID)` - -**Parameters:** -- `petID` - - *string* - Unique identifier for this specific pet. - -**Returns:** -- `isRevoked` - - *boolean* - true if the pet is revoked. - -**Description:** -Revoked pets are pets that have been stripped from the player in every fashion except for their name. They remain in the Pet Journal, but they cannot be summoned or used in battle. In addition, the rarity border and level icon will not appear around and over the pet's name in the Pet Journal's scrolling list. -This function returns true for Blizzard Pet Store pets on the PTR, which suggests that `isRevoked` is only ever true for pets that cost money and have not been authorized for a specific World of Warcraft account. This mechanic is likely in place to prevent characters from transferring with an unused Blizzard Pet Store pet to a different account that does not have access to that pet. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PetIsSummonable.md b/wiki-information/functions/C_PetJournal.PetIsSummonable.md deleted file mode 100644 index 3ff941fd..00000000 --- a/wiki-information/functions/C_PetJournal.PetIsSummonable.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_PetJournal.PetIsSummonable - -**Content:** -Returns true if you can summon this pet. -`isSummonable = C_PetJournal.PetIsSummonable(battlePetGUID)` - -**Parameters:** -- `battlePetGUID` - - *string* - Unique identifier for this specific pet. - -**Returns:** -- `isSummonable` - - *boolean* - True if the pet can be summoned, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.PickupPet.md b/wiki-information/functions/C_PetJournal.PickupPet.md deleted file mode 100644 index ef5f746c..00000000 --- a/wiki-information/functions/C_PetJournal.PickupPet.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_PetJournal.PickupPet - -**Content:** -Places a battle pet onto the mouse cursor. -`C_PetJournal.PickupPet(petID)` - -**Parameters:** -- `petID` - - *string* - GUID of a battle pet in your collection. - -**Description:** -The function places a specific battle pet in your collection on your cursor. -Battle pets on your cursor can be placed on your action bars. -Attempting to pick up a battle pet that's already on the cursor clears the cursor instead. - -**Reference:** -`GetCursorInfo` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md b/wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md deleted file mode 100644 index 9727f0b4..00000000 --- a/wiki-information/functions/C_PetJournal.SetAllPetSourcesChecked.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_PetJournal.SetAllPetSourcesChecked - -**Content:** -Sets or clears all the pet sources in the filter menu. -`C_PetJournal.SetAllPetSourcesChecked(value)` - -**Parameters:** -- `value` - - *boolean* - True to set all the pet sources, false to clear all the pet sources - -**Reference:** -- `C_PetJournal.SetPetSourceChecked` -- `C_PetJournal.IsPetSourceChecked` -- `C_PetJournal.GetNumPetSources` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md b/wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md deleted file mode 100644 index 1f28718d..00000000 --- a/wiki-information/functions/C_PetJournal.SetAllPetTypesChecked.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_PetJournal.SetAllPetTypesChecked - -**Content:** -Sets or clears all the pet types in the filter menu. -`C_PetJournal.SetAllPetTypesChecked(value)` - -**Parameters:** -- `value` - - *boolean* - True to set all the pet types, false to clear all the pet types - -**Reference:** -- `C_PetJournal.SetPetTypeFilter` -- `C_PetJournal.IsPetTypeChecked` -- `C_PetJournal.GetNumPetTypes` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetFavorite.md b/wiki-information/functions/C_PetJournal.SetFavorite.md deleted file mode 100644 index 9663179b..00000000 --- a/wiki-information/functions/C_PetJournal.SetFavorite.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_PetJournal.SetFavorite - -**Content:** -Sets (or clears) the pet as a favorite. -`C_PetJournal.SetFavorite(petID, value)` - -**Parameters:** -- `petID` - - *string* - Unique identifier for this specific pet -- `value` - - *number* - - - `0`: Pet is not a favorite - - `1`: Pet is a favorite \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetFilterChecked.md b/wiki-information/functions/C_PetJournal.SetFilterChecked.md deleted file mode 100644 index 01e08ae6..00000000 --- a/wiki-information/functions/C_PetJournal.SetFilterChecked.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_PetJournal.SetFilterChecked - -**Content:** -Sets the filters in the filter menu. -`C_PetJournal.SetFilterChecked(filter, value)` - -**Parameters:** -- `filter` - - *number* - Bitfield for each filter - - `LE_PET_JOURNAL_FILTER_COLLECTED`: Pets you have collected - - `LE_PET_JOURNAL_FILTER_NOT_COLLECTED`: Pets you have not collected -- `value` - - *boolean* - True to set the filter, false to clear the filter - -**Reference:** -- `C_PetJournal.IsFilterChecked` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md b/wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md deleted file mode 100644 index fc3467fe..00000000 --- a/wiki-information/functions/C_PetJournal.SetPetLoadOutInfo.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_PetJournal.SetPetLoadOutInfo - -**Content:** -Places the specified pet into a battle pet slot. -`C_PetJournal.SetPetLoadOutInfo(slotIndex, petID)` - -**Parameters:** -- `slotIndex` - - *number* - Battle pet slot index, integer between 1 and 3. -- `petID` - - *string* - Battle pet GUID of a pet in your collection to move into the battle pet slot. - -**Description:** -If the pet specified by `petID` is already in a battle pet slot, the pets are exchanged. - -**Reference:** -- `C_PetJournal.SetAbility` -- `C_PetJournal.GetPetLoadOutInfo` - -### Example Usage: -This function can be used in an addon to automate the process of setting up battle pets for pet battles. For instance, an addon could allow users to save and load different pet battle teams quickly. - -### Addon Usage: -- **Rematch**: A popular addon that helps players manage their pet battle teams. It uses `C_PetJournal.SetPetLoadOutInfo` to set pets into specific slots when loading saved teams. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetSortParameter.md b/wiki-information/functions/C_PetJournal.SetPetSortParameter.md deleted file mode 100644 index d88d2ed5..00000000 --- a/wiki-information/functions/C_PetJournal.SetPetSortParameter.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_PetJournal.SetPetSortParameter - -**Content:** -Changes the battle pet ordering in the pet journal. -`C_PetJournal.SetPetSortParameter(sortParameter)` - -**Parameters:** -- `sortParameter` - - *number* - Index of the ordering type that should be applied to `C_PetJournal.GetPetInfoByIndex` returns; one of the following global numeric values: - - `LE_SORT_BY_NAME` - - `LE_SORT_BY_LEVEL` - - `LE_SORT_BY_RARITY` - - `LE_SORT_BY_PETTYPE` - -**Reference:** -- `C_PetJournal.GetPetSortParameter` - -### Example Usage: -This function can be used to change the sorting order of pets in the Pet Journal. For instance, if you want to sort your pets by their level, you would call: -```lua -C_PetJournal.SetPetSortParameter(LE_SORT_BY_LEVEL) -``` - -### Addon Usage: -Large addons like "Rematch" use this function to allow users to customize the sorting of their pet lists based on different criteria such as name, level, rarity, or pet type. This enhances the user experience by providing flexible ways to organize and manage their pet collections. \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetSourceChecked.md b/wiki-information/functions/C_PetJournal.SetPetSourceChecked.md deleted file mode 100644 index 993f4431..00000000 --- a/wiki-information/functions/C_PetJournal.SetPetSourceChecked.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_PetJournal.SetPetSourceChecked - -**Content:** -Sets the pet source in the filter menu. -`C_PetJournal.SetPetSourceChecked(index, value)` - -**Parameters:** -- `index` - - *number* - Index (from 1 to GetNumPetSources()) of all available pet sources -- `value` - - *boolean* - True to set the pet source, false to clear the pet source - -**Reference:** -- `C_PetJournal.SetAllPetSourcesChecked` -- `C_PetJournal.IsPetSourceChecked` -- `C_PetJournal.GetNumPetSources` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetPetTypeFilter.md b/wiki-information/functions/C_PetJournal.SetPetTypeFilter.md deleted file mode 100644 index aa3f4431..00000000 --- a/wiki-information/functions/C_PetJournal.SetPetTypeFilter.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_PetJournal.SetPetTypeFilter - -**Content:** -Sets the pet type in the filter menu. -`C_PetJournal.SetPetTypeFilter(index, value)` - -**Parameters:** -- `index` - - *number* - Index (from 1 to GetNumPetTypes()) of all available pet types -- `value` - - *boolean* - True to set the pet type, false to clear the pet type - -**Reference:** -- `C_PetJournal.SetAllPetTypesChecked` -- `C_PetJournal.IsPetTypeChecked` -- `C_PetJournal.GetNumPetTypes` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SetSearchFilter.md b/wiki-information/functions/C_PetJournal.SetSearchFilter.md deleted file mode 100644 index 75678876..00000000 --- a/wiki-information/functions/C_PetJournal.SetSearchFilter.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_PetJournal.SetSearchFilter - -**Content:** -Sets the search filter in the pet journal. -`C_PetJournal.SetSearchFilter(text)` - -**Parameters:** -- `text` - - *string* - Search text for the pet journal - -**Reference:** -- `C_PetJournal.ClearSearchFilter` \ No newline at end of file diff --git a/wiki-information/functions/C_PetJournal.SummonPetByGUID.md b/wiki-information/functions/C_PetJournal.SummonPetByGUID.md deleted file mode 100644 index 2a1d6d06..00000000 --- a/wiki-information/functions/C_PetJournal.SummonPetByGUID.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_PetJournal.SummonPetByGUID - -**Content:** -Summons (or dismisses) a pet. -`C_PetJournal.SummonPetByGUID(petID)` - -**Parameters:** -- `petID` - - *string* - GUID of the battle pet to summon. If the pet is already summoned, it will be dismissed. - -**Description:** -You can dismiss the currently-summoned battle pet by running: -```lua -C_PetJournal.SummonPetByGUID(C_PetJournal.GetSummonedPetGUID()) -``` -Note that this will throw an error if you do not have a pet summoned. -Blizzard has moved all petIDs over to the "petGUID" system, but left all of their functions using the petID terminology (not the petGUID terminology) except for this one. For consistency, the term "petID" should continue to be used. - -**Reference:** -- `C_PetJournal.GetSummonedPetGUID` - -### Example Usage: -This function can be used in macros or addons to manage battle pets. For example, you could create a macro to summon a specific pet by its GUID: -```lua -/run C_PetJournal.SummonPetByGUID("BattlePet-0-000012345678") -``` - -### Addon Usage: -Large addons like Rematch use this function to manage pet teams and automate the summoning and dismissing of pets based on the player's preferences and the current situation in the game. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.CanUseItem.md b/wiki-information/functions/C_PlayerInfo.CanUseItem.md deleted file mode 100644 index b35c3c64..00000000 --- a/wiki-information/functions/C_PlayerInfo.CanUseItem.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_PlayerInfo.CanUseItem - -**Content:** -Needs summary. -`isUseable = C_PlayerInfo.CanUseItem(itemID)` - -**Parameters:** -- `itemID` - - *number* - -**Returns:** -- `isUseable` - - *boolean* - -**Example Usage:** -This function can be used to check if a player can use a specific item based on their current state, such as level, class, or other restrictions. - -**Addon Usage:** -Large addons like WeakAuras might use this function to determine if a player can use a specific item before displaying an alert or creating a custom UI element. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md b/wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md deleted file mode 100644 index 1ab22ce4..00000000 --- a/wiki-information/functions/C_PlayerInfo.GUIDIsPlayer.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_PlayerInfo.GUIDIsPlayer - -**Content:** -Returns true if the GUID belongs to a player. -`isPlayer = C_PlayerInfo.GUIDIsPlayer(guid)` - -**Parameters:** -- `guid` - - *string* - The GUID to be checked. - -**Returns:** -- `isPlayer` - - *boolean* - True if the GUID represents a player unit, or false if not. - -**Description:** -This function currently as of patch 9.0.2 only validates that the supplied GUID begins with the string "Player-". \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md b/wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md deleted file mode 100644 index 45d7acf9..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetAlternateFormInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_PlayerInfo.GetAlternateFormInfo - -**Content:** -Returns if the player has an alternate form and if they are currently in that form. -`hasAlternateForm, inAlternateForm = C_PlayerInfo.GetAlternateFormInfo()` - -**Returns:** -- `hasAlternateForm` - - *boolean* -- `inAlternateForm` - - *boolean* - Whether the player is in their alternate form (such as in human form for worgen). \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetClass.md b/wiki-information/functions/C_PlayerInfo.GetClass.md deleted file mode 100644 index b1b1d996..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetClass.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_PlayerInfo.GetClass - -**Content:** -Returns the class of a player. -`className, classFilename, classID = C_PlayerInfo.GetClass(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin*🔗 - -**Returns:** -- `className` - - *string?* -- `classFilename` - - *string?* -- `classID` - - *number?* : ClassId \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetDisplayID.md b/wiki-information/functions/C_PlayerInfo.GetDisplayID.md deleted file mode 100644 index ef0b3085..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetDisplayID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PlayerInfo.GetDisplayID - -**Content:** -Needs summary. -`displayID = C_PlayerInfo.GetDisplayID()` - -**Returns:** -- `displayID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetName.md b/wiki-information/functions/C_PlayerInfo.GetName.md deleted file mode 100644 index ba2decee..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetName.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_PlayerInfo.GetName - -**Content:** -Returns the name of a player. -`name = C_PlayerInfo.GetName(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin*🔗 - -**Returns:** -- `name` - - *string?* - -**Example Usage:** -```lua -local playerLocation = PlayerLocation:CreateFromUnit("player") -local playerName = C_PlayerInfo.GetName(playerLocation) -print("Player's name is: " .. (playerName or "Unknown")) -``` - -**Description:** -This function is useful for retrieving the name of a player based on their location. It can be particularly handy in addons that need to display or log player names dynamically. - -**Addons Using This Function:** -- **Details! Damage Meter**: Uses this function to fetch and display player names in the damage and healing meters. -- **WeakAuras**: Utilizes this function to get player names for custom triggers and displays. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md b/wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md deleted file mode 100644 index 6a8b5883..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetNativeDisplayID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PlayerInfo.GetNativeDisplayID - -**Content:** -Needs summary. -`nativeDisplayID = C_PlayerInfo.GetNativeDisplayID()` - -**Returns:** -- `nativeDisplayID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md b/wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md deleted file mode 100644 index 712b2302..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetPetStableCreatureDisplayInfoID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_PlayerInfo.GetPetStableCreatureDisplayInfoID - -**Content:** -Needs summary. -`creatureDisplayInfoID = C_PlayerInfo.GetPetStableCreatureDisplayInfoID(index)` - -**Parameters:** -- `index` - - *number* - -**Returns:** -- `creatureDisplayInfoID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md b/wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md deleted file mode 100644 index a63b852d..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetPlayerCharacterData.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: C_PlayerInfo.GetPlayerCharacterData - -**Content:** -Needs summary. -`characterData = C_PlayerInfo.GetPlayerCharacterData()` - -**Returns:** -- `characterData` - - *PlayerInfoCharacterData* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `fileName` - - *string* - - `alternateFormRaceData` - - *CharacterAlternateFormData?* - - `createScreenIconAtlas` - - *string* - - `sex` - - *Enum.UnitSex* - -**CharacterAlternateFormData** -- `Field` -- `Type` -- `Description` -- `raceID` - - *number* -- `name` - - *string* -- `fileName` - - *string* -- `createScreenIconAtlas` - - *string* - -**Enum.UnitSex** -- `Value` -- `Field` -- `Description` -- `0` - - Male -- `1` - - Female -- `2` - - None -- `3` - - Both -- `4` - - Neutral \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetRace.md b/wiki-information/functions/C_PlayerInfo.GetRace.md deleted file mode 100644 index 993bd527..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetRace.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_PlayerInfo.GetRace - -**Content:** -Returns the race of a player. -`raceID = C_PlayerInfo.GetRace(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin*🔗 - -**Returns:** -- `raceID` - - *number?* - -**Example Usage:** -```lua -local playerLocation = PlayerLocation:CreateFromUnit("player") -local raceID = C_PlayerInfo.GetRace(playerLocation) -print("Player's race ID is:", raceID) -``` - -**Description:** -This function is useful for determining the race of a player character, which can be used in various addons to customize behavior or display information based on the player's race. For example, an addon might use this function to provide race-specific tips or to adjust the appearance of the UI based on the player's race. - -**Addons Using This Function:** -- **WeakAuras**: This popular addon uses `C_PlayerInfo.GetRace` to customize auras and triggers based on the player's race, allowing for more personalized and relevant notifications. -- **ElvUI**: This comprehensive UI overhaul addon may use this function to adjust the interface elements and themes according to the player's race, providing a more immersive experience. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.GetSex.md b/wiki-information/functions/C_PlayerInfo.GetSex.md deleted file mode 100644 index 6af4071b..00000000 --- a/wiki-information/functions/C_PlayerInfo.GetSex.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: C_PlayerInfo.GetSex - -**Content:** -Returns the sex of a player. -`sex = C_PlayerInfo.GetSex(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* - -**Returns:** -- `sex` - - *Enum.UnitSex?* - - `Value` - - `Field` - - `Description` - - `0` - - Male - - `1` - - Female - - `2` - - None - - `3` - - Both - - `4` - - Neutral - -**Usage:** -Returns the gender of your character. -```lua -/dump C_PlayerInfo.GetSex(PlayerLocation:CreateFromUnit("player")) -- 1 (Female) -``` - -**Reference:** -- `UnitSex()` \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md b/wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md deleted file mode 100644 index f855ef26..00000000 --- a/wiki-information/functions/C_PlayerInfo.HasVisibleInvSlot.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_PlayerInfo.HasVisibleInvSlot - -**Content:** -Needs summary. -`isVisible = C_PlayerInfo.HasVisibleInvSlot(slot)` - -**Parameters:** -- `slot` - - *number* - -**Returns:** -- `isVisible` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific inventory slot is visible on the player's character. For instance, it can be useful in addons that manage or display equipment, ensuring that certain slots are not hidden or obscured. - -**Addon Usage:** -Large addons like "ElvUI" or "WeakAuras" might use this function to dynamically adjust the user interface based on the visibility of inventory slots, providing a more customized and responsive experience for the player. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsConnected.md b/wiki-information/functions/C_PlayerInfo.IsConnected.md deleted file mode 100644 index b163b668..00000000 --- a/wiki-information/functions/C_PlayerInfo.IsConnected.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_PlayerInfo.IsConnected - -**Content:** -Returns true if the player is connected. -`isConnected = C_PlayerInfo.IsConnected()` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin?* - -**Returns:** -- `isConnected` - - *boolean?* - -**Reference:** -- `UnitIsConnected()` - -**Example Usage:** -This function can be used to check if a specific player is currently connected to the game. This is particularly useful in scenarios where you need to verify the connection status of a player before performing certain actions, such as sending a message or inviting them to a group. - -**Addon Usage:** -Large addons like "ElvUI" and "WeakAuras" might use this function to ensure that the player or other players are connected before updating UI elements or triggering certain events. For instance, "ElvUI" could use it to check the connection status of group members to display accurate information in the unit frames. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md b/wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md deleted file mode 100644 index ddc33ad2..00000000 --- a/wiki-information/functions/C_PlayerInfo.IsDisplayRaceNative.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PlayerInfo.IsDisplayRaceNative - -**Content:** -Needs summary. -`isDisplayRaceNative = C_PlayerInfo.IsDisplayRaceNative()` - -**Returns:** -- `isDisplayRaceNative` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsMirrorImage.md b/wiki-information/functions/C_PlayerInfo.IsMirrorImage.md deleted file mode 100644 index 6049499b..00000000 --- a/wiki-information/functions/C_PlayerInfo.IsMirrorImage.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PlayerInfo.IsMirrorImage - -**Content:** -Needs summary. -`isMirrorImage = C_PlayerInfo.IsMirrorImage()` - -**Returns:** -- `isMirrorImage` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md b/wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md deleted file mode 100644 index a7ad6f6c..00000000 --- a/wiki-information/functions/C_PlayerInfo.IsPlayerNPERestricted.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PlayerInfo.IsPlayerNPERestricted - -**Content:** -Returns true if the player has new player experience restrictions in place. -`isRestricted = C_PlayerInfo.IsPlayerNPERestricted()` - -**Returns:** -- `isRestricted` - - *boolean* - True if the player has new player experience restrictions in place. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md b/wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md deleted file mode 100644 index a2529162..00000000 --- a/wiki-information/functions/C_PlayerInfo.IsSelfFoundActive.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PlayerInfo.IsSelfFoundActive - -**Content:** -Needs summary. -`active = C_PlayerInfo.IsSelfFoundActive()` - -**Returns:** -- `active` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md b/wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md deleted file mode 100644 index 088b5eb2..00000000 --- a/wiki-information/functions/C_PlayerInfo.UnitIsSameServer.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_PlayerInfo.UnitIsSameServer - -**Content:** -Returns true if a player is from the same or connected realm. -`unitIsSameServer = C_PlayerInfo.UnitIsSameServer(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* - -**Returns:** -- `unitIsSameServer` - - *boolean* - -**Usage:** -Shows if your target is on the same (connected) realm. -```lua -/dump C_PlayerInfo.UnitIsSameServer(PlayerLocation:CreateFromUnit("target")) -``` - -**Reference:** -- `UnitIsSameServer` \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md b/wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md deleted file mode 100644 index a629ce94..00000000 --- a/wiki-information/functions/C_PlayerInteractionManager.ClearInteraction.md +++ /dev/null @@ -1,77 +0,0 @@ -## Title: C_PlayerInteractionManager.ClearInteraction - -**Content:** -Needs summary. -`C_PlayerInteractionManager.ClearInteraction()` - -**Parameters:** -- `type` - - *Enum.PlayerInteractionType?* - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - TradePartner - - `2` - Item - - `3` - Gossip - - `4` - QuestGiver - - `5` - Merchant - - `6` - TaxiNode - - `7` - Trainer - - `8` - Banker - - `9` - AlliedRaceDetailsGiver - - `10` - GuildBanker - - `11` - Registrar - - `12` - Vendor - - `13` - PetitionVendor - - `14` - TabardVendor - - `15` - TalentMaster - - `16` - SpecializationMaster - - `17` - MailInfo - - `18` - SpiritHealer - - `19` - AreaSpiritHealer - - `20` - Binder - - `21` - Auctioneer - - `22` - StableMaster - - `23` - BattleMaster - - `24` - Transmogrifier - - `25` - LFGDungeon - - `26` - VoidStorageBanker - - `27` - BlackMarketAuctioneer - - `28` - AdventureMap - - `29` - WorldMap - - `30` - GarrArchitect - - `31` - GarrTradeskill - - `32` - GarrMission - - `33` - ShipmentCrafter - - `34` - GarrRecruitment - - `35` - GarrTalent - - `36` - Trophy - - `37` - PlayerChoice - - `38` - ArtifactForge - - `39` - ObliterumForge - - `40` - ScrappingMachine - - `41` - ContributionCollector - - `42` - AzeriteRespec - - `43` - IslandQueue - - `44` - ItemInteraction - - `45` - ChromieTime - - `46` - CovenantPreview - - `47` - AnimaDiversion - - `48` - LegendaryCrafting - - `49` - WeeklyRewards - - `50` - Soulbind - - `51` - CovenantSanctum - - `52` - NewPlayerGuide - - `53` - ItemUpgrade - - `54` - AdventureJournal - - `55` - Renown - - `56` - AzeriteForge - - `57` - PerksProgramVendor - - `58` - ProfessionsCraftingOrder - - `59` - Professions - - `60` - ProfessionsCustomerOrder - - `61` - TraitSystem - - `62` - BarbersChoice - - `63` - JailersTowerBuffs - - `64` - MajorFactionRenown \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md b/wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md deleted file mode 100644 index b8b86d01..00000000 --- a/wiki-information/functions/C_PlayerInteractionManager.ConfirmationInteraction.md +++ /dev/null @@ -1,77 +0,0 @@ -## Title: C_PlayerInteractionManager.ConfirmationInteraction - -**Content:** -Needs summary. -`C_PlayerInteractionManager.ConfirmationInteraction()` - -**Parameters:** -- `type` - - *Enum.PlayerInteractionType?* - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - TradePartner - - `2` - Item - - `3` - Gossip - - `4` - QuestGiver - - `5` - Merchant - - `6` - TaxiNode - - `7` - Trainer - - `8` - Banker - - `9` - AlliedRaceDetailsGiver - - `10` - GuildBanker - - `11` - Registrar - - `12` - Vendor - - `13` - PetitionVendor - - `14` - TabardVendor - - `15` - TalentMaster - - `16` - SpecializationMaster - - `17` - MailInfo - - `18` - SpiritHealer - - `19` - AreaSpiritHealer - - `20` - Binder - - `21` - Auctioneer - - `22` - StableMaster - - `23` - BattleMaster - - `24` - Transmogrifier - - `25` - LFGDungeon - - `26` - VoidStorageBanker - - `27` - BlackMarketAuctioneer - - `28` - AdventureMap - - `29` - WorldMap - - `30` - GarrArchitect - - `31` - GarrTradeskill - - `32` - GarrMission - - `33` - ShipmentCrafter - - `34` - GarrRecruitment - - `35` - GarrTalent - - `36` - Trophy - - `37` - PlayerChoice - - `38` - ArtifactForge - - `39` - ObliterumForge - - `40` - ScrappingMachine - - `41` - ContributionCollector - - `42` - AzeriteRespec - - `43` - IslandQueue - - `44` - ItemInteraction - - `45` - ChromieTime - - `46` - CovenantPreview - - `47` - AnimaDiversion - - `48` - LegendaryCrafting - - `49` - WeeklyRewards - - `50` - Soulbind - - `51` - CovenantSanctum - - `52` - NewPlayerGuide - - `53` - ItemUpgrade - - `54` - AdventureJournal - - `55` - Renown - - `56` - AzeriteForge - - `57` - PerksProgramVendor - - `58` - ProfessionsCraftingOrder - - `59` - Professions - - `60` - ProfessionsCustomerOrder - - `61` - TraitSystem - - `62` - BarbersChoice - - `63` - JailersTowerBuffs - - `64` - MajorFactionRenown \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md b/wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md deleted file mode 100644 index 5363a9bb..00000000 --- a/wiki-information/functions/C_PlayerInteractionManager.InteractUnit.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_PlayerInteractionManager.InteractUnit - -**Content:** -Needs summary. -`success = C_PlayerInteractionManager.InteractUnit(unit)` - -**Parameters:** -- `unit` - - *string* -- `exactMatch` - - *boolean?* = false -- `looseTargeting` - - *boolean?* = true - -**Returns:** -- `success` - - *boolean* - -**Example Usage:** -This function can be used to interact with a specific unit in the game. For instance, if you want to interact with an NPC or another player, you can use this function to initiate the interaction. - -**Addons Usage:** -Large addons like "ElvUI" or "Questie" might use this function to automate interactions with NPCs for questing or other purposes. For example, "Questie" could use it to automatically interact with quest givers or turn in quests. \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md b/wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md deleted file mode 100644 index e48fd015..00000000 --- a/wiki-information/functions/C_PlayerInteractionManager.IsInteractingWithNpcOfType.md +++ /dev/null @@ -1,81 +0,0 @@ -## Title: C_PlayerInteractionManager.IsInteractingWithNpcOfType - -**Content:** -Needs summary. -`interacting = C_PlayerInteractionManager.IsInteractingWithNpcOfType(type)` - -**Parameters:** -- `type` - - *Enum.PlayerInteractionType* - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - TradePartner - - `2` - Item - - `3` - Gossip - - `4` - QuestGiver - - `5` - Merchant - - `6` - TaxiNode - - `7` - Trainer - - `8` - Banker - - `9` - AlliedRaceDetailsGiver - - `10` - GuildBanker - - `11` - Registrar - - `12` - Vendor - - `13` - PetitionVendor - - `14` - TabardVendor - - `15` - TalentMaster - - `16` - SpecializationMaster - - `17` - MailInfo - - `18` - SpiritHealer - - `19` - AreaSpiritHealer - - `20` - Binder - - `21` - Auctioneer - - `22` - StableMaster - - `23` - BattleMaster - - `24` - Transmogrifier - - `25` - LFGDungeon - - `26` - VoidStorageBanker - - `27` - BlackMarketAuctioneer - - `28` - AdventureMap - - `29` - WorldMap - - `30` - GarrArchitect - - `31` - GarrTradeskill - - `32` - GarrMission - - `33` - ShipmentCrafter - - `34` - GarrRecruitment - - `35` - GarrTalent - - `36` - Trophy - - `37` - PlayerChoice - - `38` - ArtifactForge - - `39` - ObliterumForge - - `40` - ScrappingMachine - - `41` - ContributionCollector - - `42` - AzeriteRespec - - `43` - IslandQueue - - `44` - ItemInteraction - - `45` - ChromieTime - - `46` - CovenantPreview - - `47` - AnimaDiversion - - `48` - LegendaryCrafting - - `49` - WeeklyRewards - - `50` - Soulbind - - `51` - CovenantSanctum - - `52` - NewPlayerGuide - - `53` - ItemUpgrade - - `54` - AdventureJournal - - `55` - Renown - - `56` - AzeriteForge - - `57` - PerksProgramVendor - - `58` - ProfessionsCraftingOrder - - `59` - Professions - - `60` - ProfessionsCustomerOrder - - `61` - TraitSystem - - `62` - BarbersChoice - - `63` - JailersTowerBuffs - - `64` - MajorFactionRenown - -**Returns:** -- `interacting` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md b/wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md deleted file mode 100644 index 7dac9999..00000000 --- a/wiki-information/functions/C_PlayerInteractionManager.IsReplacingUnit.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PlayerInteractionManager.IsReplacingUnit - -**Content:** -Needs summary. -`replacing = C_PlayerInteractionManager.IsReplacingUnit()` - -**Returns:** -- `replacing` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md b/wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md deleted file mode 100644 index fcbb61a1..00000000 --- a/wiki-information/functions/C_PlayerInteractionManager.IsValidNPCInteraction.md +++ /dev/null @@ -1,81 +0,0 @@ -## Title: C_PlayerInteractionManager.IsValidNPCInteraction - -**Content:** -Needs summary. -`isValidInteraction = C_PlayerInteractionManager.IsValidNPCInteraction(type)` - -**Parameters:** -- `type` - - *Enum.PlayerInteractionType* - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - TradePartner - - `2` - Item - - `3` - Gossip - - `4` - QuestGiver - - `5` - Merchant - - `6` - TaxiNode - - `7` - Trainer - - `8` - Banker - - `9` - AlliedRaceDetailsGiver - - `10` - GuildBanker - - `11` - Registrar - - `12` - Vendor - - `13` - PetitionVendor - - `14` - TabardVendor - - `15` - TalentMaster - - `16` - SpecializationMaster - - `17` - MailInfo - - `18` - SpiritHealer - - `19` - AreaSpiritHealer - - `20` - Binder - - `21` - Auctioneer - - `22` - StableMaster - - `23` - BattleMaster - - `24` - Transmogrifier - - `25` - LFGDungeon - - `26` - VoidStorageBanker - - `27` - BlackMarketAuctioneer - - `28` - AdventureMap - - `29` - WorldMap - - `30` - GarrArchitect - - `31` - GarrTradeskill - - `32` - GarrMission - - `33` - ShipmentCrafter - - `34` - GarrRecruitment - - `35` - GarrTalent - - `36` - Trophy - - `37` - PlayerChoice - - `38` - ArtifactForge - - `39` - ObliterumForge - - `40` - ScrappingMachine - - `41` - ContributionCollector - - `42` - AzeriteRespec - - `43` - IslandQueue - - `44` - ItemInteraction - - `45` - ChromieTime - - `46` - CovenantPreview - - `47` - AnimaDiversion - - `48` - LegendaryCrafting - - `49` - WeeklyRewards - - `50` - Soulbind - - `51` - CovenantSanctum - - `52` - NewPlayerGuide - - `53` - ItemUpgrade - - `54` - AdventureJournal - - `55` - Renown - - `56` - AzeriteForge - - `57` - PerksProgramVendor - - `58` - ProfessionsCraftingOrder - - `59` - Professions - - `60` - ProfessionsCustomerOrder - - `61` - TraitSystem - - `62` - BarbersChoice - - `63` - JailersTowerBuffs - - `64` - MajorFactionRenown - -**Returns:** -- `isValidInteraction` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md b/wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md deleted file mode 100644 index 39b6e540..00000000 --- a/wiki-information/functions/C_PvP.GetArenaCrowdControlInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_PvP.GetArenaCrowdControlInfo - -**Content:** -Needs summary. -`spellID, startTime, duration = C_PvP.GetArenaCrowdControlInfo(playerToken)` - -**Parameters:** -- `playerToken` - - *string* - -**Returns:** -- `spellID` - - *number* -- `startTime` - - *number* -- `duration` - - *number* - -**Example Usage:** -This function can be used to get information about crowd control effects on a player in an arena match. For instance, an addon could use this to display a timer for how long a player will be affected by a crowd control spell. - -**Addon Usage:** -- **Gladius**: This popular PvP addon uses `C_PvP.GetArenaCrowdControlInfo` to track and display crowd control durations on enemy players in arena matches, helping players to better manage their cooldowns and crowd control strategies. \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md b/wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md deleted file mode 100644 index fea622b5..00000000 --- a/wiki-information/functions/C_PvP.GetBattlefieldVehicleInfo.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: C_PvP.GetBattlefieldVehicleInfo - -**Content:** -Returns battleground vehicle info. -`info = C_PvP.GetBattlefieldVehicleInfo(vehicleIndex, uiMapID)` - -**Parameters:** -- `vehicleIndex` - - *number* -- `uiMapID` - - *number* : UiMapID - -**Returns:** -- `info` - - *BattlefieldVehicleInfo* - - `Field` - - `Type` - - `Description` - - `x` - - *number* - - `y` - - *number* - - `name` - - *string* - - `isOccupied` - - *boolean* - - `atlas` - - *string* - - `textureWidth` - - *number* - - `textureHeight` - - *number* - - `facing` - - *number* - - `isPlayer` - - *boolean* - - `isAlive` - - *boolean* - - `shouldDrawBelowPlayerBlips` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetBattlefieldVehicles.md b/wiki-information/functions/C_PvP.GetBattlefieldVehicles.md deleted file mode 100644 index 7a5438e9..00000000 --- a/wiki-information/functions/C_PvP.GetBattlefieldVehicles.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_PvP.GetBattlefieldVehicles - -**Content:** -Needs summary. -`vehicles = C_PvP.GetBattlefieldVehicles(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - -**Returns:** -- `vehicles` - - *BattlefieldVehicleInfo* - - `Field` - - `Type` - - `Description` - - `x` - - *number* - - `y` - - *number* - - `name` - - *string* - - `isOccupied` - - *boolean* - - `atlas` - - *string* - - `textureWidth` - - *number* - - `textureHeight` - - *number* - - `facing` - - *number* - - `isPlayer` - - *boolean* - - `isAlive` - - *boolean* - - `shouldDrawBelowPlayerBlips` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.GetRandomBGRewards.md b/wiki-information/functions/C_PvP.GetRandomBGRewards.md deleted file mode 100644 index a15bbc12..00000000 --- a/wiki-information/functions/C_PvP.GetRandomBGRewards.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_PvP.GetRandomBGRewards - -**Content:** -Needs summary. -`honor, experience, itemRewards, currencyRewards = C_PvP.GetRandomBGRewards()` - -**Returns:** -- `honor` - - *number* -- `experience` - - *number* -- `itemRewards` - - *BattlefieldItemReward?* - - `Field` - - `Type` - - `Description` - - `id` - - *number* - - `name` - - *string* - - `texture` - - *number* - - `quantity` - - *number* -- `currencyRewards` - - *BattlefieldCurrencyReward?* - - `Field` - - `Type` - - `Description` - - `id` - - *number* - - `quantity` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.IsInBrawl.md b/wiki-information/functions/C_PvP.IsInBrawl.md deleted file mode 100644 index 0abebc4f..00000000 --- a/wiki-information/functions/C_PvP.IsInBrawl.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PvP.IsInBrawl - -**Content:** -Needs summary. -`isInBrawl = C_PvP.IsInBrawl()` - -**Returns:** -- `isInBrawl` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.IsPVPMap.md b/wiki-information/functions/C_PvP.IsPVPMap.md deleted file mode 100644 index ad4b333b..00000000 --- a/wiki-information/functions/C_PvP.IsPVPMap.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PvP.IsPVPMap - -**Content:** -Needs summary. -`isPVPMap = C_PvP.IsPVPMap()` - -**Returns:** -- `isPVPMap` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.IsRatedMap.md b/wiki-information/functions/C_PvP.IsRatedMap.md deleted file mode 100644 index c35f4a7b..00000000 --- a/wiki-information/functions/C_PvP.IsRatedMap.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_PvP.IsRatedMap - -**Content:** -Returns if the map is a rated battleground or arena. -`isRatedMap = C_PvP.IsRatedMap()` - -**Returns:** -- `isRatedMap` - - *boolean* - -**Example Usage:** -This function can be used to determine if the current map is a rated battleground or arena, which can be useful for addons that track player performance or provide specific features for rated PvP environments. - -**Addons:** -Many PvP-oriented addons, such as Gladius, use this function to adjust their behavior based on whether the player is in a rated match. For example, they might display additional statistics or enable certain features only in rated environments. \ No newline at end of file diff --git a/wiki-information/functions/C_PvP.RequestCrowdControlSpell.md b/wiki-information/functions/C_PvP.RequestCrowdControlSpell.md deleted file mode 100644 index 24eb9dda..00000000 --- a/wiki-information/functions/C_PvP.RequestCrowdControlSpell.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_PvP.RequestCrowdControlSpell - -**Content:** -Needs summary. -`C_PvP.RequestCrowdControlSpell(playerToken)` - -**Parameters:** -- `playerToken` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md b/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md deleted file mode 100644 index 1cc3560f..00000000 --- a/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpellInfo.md +++ /dev/null @@ -1,56 +0,0 @@ -## Title: C_QuestInfoSystem.GetQuestRewardSpellInfo - -**Content:** -Needs summary. -`info = C_QuestInfoSystem.GetQuestRewardSpellInfo(questID, spellID)` - -**Parameters:** -- `questID` - - *number?* -- `spellID` - - *number* - Spell Ids from C_QuestInfoSystem.GetQuestRewardSpells - -**Returns:** -- `info` - - *QuestRewardSpellInfo?* - - `Field` - - `Type` - - `Description` - - `texture` - - *number* : fileID - - `name` - - *string* - - `garrFollowerID` - - *number?* - - `isTradeskill` - - *boolean* - - `isSpellLearned` - - *boolean* - - `hideSpellLearnText` - - *boolean* - - `isBoostSpell` - - *boolean* - - `genericUnlock` - - *boolean* - - `type` - - *Enum.QuestCompleteSpellType* - - `Enum.QuestCompleteSpellType` - - `Value` - - `Field` - - `Description` - - `0` - - LegacyBehavior - - `1` - - Follower - - `2` - - Tradeskill - - `3` - - Ability - - `4` - - Aura - - `5` - - Spell - - `6` - - Unlock - - `7` - - Companion \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md b/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md deleted file mode 100644 index cd8c4fdc..00000000 --- a/wiki-information/functions/C_QuestInfoSystem.GetQuestRewardSpells.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_QuestInfoSystem.GetQuestRewardSpells - -**Content:** -Needs summary. -`spellIDs = C_QuestInfoSystem.GetQuestRewardSpells()` - -**Parameters:** -- `questID` - - *number?* - -**Returns:** -- `spellIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md b/wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md deleted file mode 100644 index beba3786..00000000 --- a/wiki-information/functions/C_QuestInfoSystem.GetQuestShouldToastCompletion.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_QuestInfoSystem.GetQuestShouldToastCompletion - -**Content:** -Needs summary. -`shouldToast = C_QuestInfoSystem.GetQuestShouldToastCompletion()` - -**Parameters:** -- `questID` - - *number?* - -**Returns:** -- `shouldToast` - - *boolean* - -**Example Usage:** -This function can be used to determine if a quest completion should trigger a toast notification. This can be particularly useful for addons that manage quest tracking and notifications, ensuring that important quest completions are highlighted to the player. - -**Addon Usage:** -Large addons like "Questie" or "TomTom" might use this function to enhance the user experience by providing visual feedback when a quest is completed, ensuring players are aware of their progress and achievements. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md b/wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md deleted file mode 100644 index 3ad80c58..00000000 --- a/wiki-information/functions/C_QuestInfoSystem.HasQuestRewardSpells.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_QuestInfoSystem.HasQuestRewardSpells - -**Content:** -Needs summary. -`hasRewardSpells = C_QuestInfoSystem.HasQuestRewardSpells()` - -**Parameters:** -- `questID` - - *number?* - -**Returns:** -- `hasRewardSpells` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md b/wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md deleted file mode 100644 index 5632be3f..00000000 --- a/wiki-information/functions/C_QuestLog.GetMapForQuestPOIs.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestLog.GetMapForQuestPOIs - -**Content:** -Needs summary. -`uiMapID = C_QuestLog.GetMapForQuestPOIs()` - -**Returns:** -- `uiMapID` - - *number* - UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetMaxNumQuests.md b/wiki-information/functions/C_QuestLog.GetMaxNumQuests.md deleted file mode 100644 index 45d20f4d..00000000 --- a/wiki-information/functions/C_QuestLog.GetMaxNumQuests.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestLog.GetMaxNumQuests - -**Content:** -This is the maximum number of quests a player can be on, including hidden quests, world quests, emissaries, etc. -`maxNumQuests = C_QuestLog.GetMaxNumQuests()` - -**Returns:** -- `maxNumQuests` - - *number* - The maximum number of quests a player can be on. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md b/wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md deleted file mode 100644 index 7c6f66f7..00000000 --- a/wiki-information/functions/C_QuestLog.GetMaxNumQuestsCanAccept.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestLog.GetMaxNumQuestsCanAccept - -**Content:** -This is the maximum number of standard quests a player can accept. These are quests that are normally visible in the quest log. -`maxNumQuestsCanAccept = C_QuestLog.GetMaxNumQuestsCanAccept()` - -**Returns:** -- `maxNumQuestsCanAccept` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetQuestInfo.md b/wiki-information/functions/C_QuestLog.GetQuestInfo.md deleted file mode 100644 index 7be17631..00000000 --- a/wiki-information/functions/C_QuestLog.GetQuestInfo.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_QuestLog.GetQuestInfo - -**Content:** -Returns the name for a Quest ID. -`title = C_QuestLog.GetQuestInfo(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `title` - - *string* - name of the quest - -**Description:** -This API does not require the quest to be in your quest log. -If the name is still an empty string (after having queried it from the server once) then the quest is assumed to have been removed. - -**Reference:** -QuestEventListener \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetQuestObjectives.md b/wiki-information/functions/C_QuestLog.GetQuestObjectives.md deleted file mode 100644 index 790c0c13..00000000 --- a/wiki-information/functions/C_QuestLog.GetQuestObjectives.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_QuestLog.GetQuestObjectives - -**Content:** -Returns info for the objectives of a quest. -`objectives = C_QuestLog.GetQuestObjectives(questID)` - -**Parameters:** -- `questID` - - *number* - Unique QuestID for the quest to be queried. - -**Returns:** -- `objectives` - - *table* - a table (can be an empty table for quests without objectives) containing: a subtable for each objective which in turn contains the below values - - `Field` - - `Type` - - `Description` - - `text` - - *string* - the text displayed in the quest log and the quest tracker - - `type` - - *string* - "monster", "item", etc. - - `finished` - - *boolean* - true if the objective has been completed - - `numFulfilled` - - *number* - number of partial objectives fulfilled - - `numRequired` - - *number* - number of partial objectives required - -**Description:** -For example, calling this function for the quest Colonel Kurzen returns a table with three subtables (with keys 1, 2, and 3), two with the type "monster" and one with the type "item". -Quests that have been encountered before (i.e. cached) are able to be queried instantly, however, if the function is supplied a quest ID of a quest that isn't cached yet, it will not return anything until called again. Sometimes three calls are needed to fully cache everything (such as text). -It returns an empty table for some quests without any objectives, for example, A Threat Within. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.GetQuestsOnMap.md b/wiki-information/functions/C_QuestLog.GetQuestsOnMap.md deleted file mode 100644 index 12bf4be1..00000000 --- a/wiki-information/functions/C_QuestLog.GetQuestsOnMap.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_QuestLog.GetQuestsOnMap - -**Content:** -Needs summary. -`quests = C_QuestLog.GetQuestsOnMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `quests` - - *QuestOnMapInfo* - a table containing the following fields: - - `Field` - - `Type` - - `Description` - - `questID` - - *number* - - `x` - - *number* - - `y` - - *number* - - `type` - - *number* - - `isMapIndicatorQuest` - - *boolean* - -**Example Usage:** -This function can be used to retrieve a list of quests available on a specific map. For instance, an addon could use this to display all quests on the player's current map, allowing for a more interactive and informative map interface. - -**Addon Usage:** -Large addons like **Questie** use this function to populate the world map with available quests, providing players with visual indicators of where they can pick up new quests. This enhances the questing experience by making it easier to find and track quests. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.IsOnQuest.md b/wiki-information/functions/C_QuestLog.IsOnQuest.md deleted file mode 100644 index 0d5fc9e5..00000000 --- a/wiki-information/functions/C_QuestLog.IsOnQuest.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_QuestLog.IsOnQuest - -**Content:** -Needs summary. -`isOnQuest = C_QuestLog.IsOnQuest(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `isOnQuest` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md b/wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md deleted file mode 100644 index 97c9afa3..00000000 --- a/wiki-information/functions/C_QuestLog.IsQuestFlaggedCompleted.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_QuestLog.IsQuestFlaggedCompleted - -**Content:** -Returns if a quest has been completed. -`isCompleted = C_QuestLog.IsQuestFlaggedCompleted(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `isCompleted` - - *boolean* - Returns true if completed; returns false if not completed or if the questID is invalid. - -**Usage:** -Returns if WANTED: "Hogger" has been completed. -`/dump C_QuestLog.IsQuestFlaggedCompleted(176)` - -**Reference:** -- `C_QuestLog.GetAllCompletedQuestIDs()` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md b/wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md deleted file mode 100644 index 16ee0456..00000000 --- a/wiki-information/functions/C_QuestLog.SetMapForQuestPOIs.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestLog.SetMapForQuestPOIs - -**Content:** -Needs summary. -`C_QuestLog.SetMapForQuestPOIs(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md b/wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md deleted file mode 100644 index b4f08fa0..00000000 --- a/wiki-information/functions/C_QuestLog.ShouldShowQuestRewards.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_QuestLog.ShouldShowQuestRewards - -**Content:** -Needs summary. -`shouldShow = C_QuestLog.ShouldShowQuestRewards(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `shouldShow` - - *boolean* - -**Example Usage:** -This function can be used to determine if the rewards for a specific quest should be shown to the player. This can be particularly useful in custom quest tracking addons or UI modifications where you want to conditionally display quest rewards. - -**Addon Usage:** -Large addons like Questie or TomTom might use this function to enhance their quest tracking features by showing or hiding quest rewards based on certain conditions. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.CanStart.md b/wiki-information/functions/C_QuestSession.CanStart.md deleted file mode 100644 index bb91dfec..00000000 --- a/wiki-information/functions/C_QuestSession.CanStart.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_QuestSession.CanStart - -**Content:** -Indicates the player may request starting Party Sync. -`allowed = C_QuestSession.CanStart()` - -**Returns:** -- `allowed` - - *boolean* - True if the player is in a party that has not yet begun to activate Party Sync. - -**Reference:** -- `C_QuestSession.CanStop()` - Applicable after Party Sync has begun. -- `C_QuestSession.RequestSessionStart()` - Used to request Party Sync, if CanStart() is true. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.CanStop.md b/wiki-information/functions/C_QuestSession.CanStop.md deleted file mode 100644 index 29dc927f..00000000 --- a/wiki-information/functions/C_QuestSession.CanStop.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_QuestSession.CanStop - -**Content:** -Indicates the player may request stopping Party Sync. -`allowed = C_QuestSession.CanStop()` - -**Returns:** -- `allowed` - - *boolean* - True if the player is in a party with Party Sync but may end it. - -**Reference:** -- `C_QuestSession.CanStart()` - Applicable before Party Sync has begun. -- `C_QuestSession.RequestSessionStop()` - Used to terminate Party Sync, if `CanStop()` is true. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.Exists.md b/wiki-information/functions/C_QuestSession.Exists.md deleted file mode 100644 index 35c28529..00000000 --- a/wiki-information/functions/C_QuestSession.Exists.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_QuestSession.Exists - -**Content:** -Indicates Party Sync is active or requested by a party member. -`exists = C_QuestSession.Exists()` - -**Returns:** -- `exists` - - *boolean* - True if Party Sync is active or there is a pending request to activate it; false otherwise. - -**Reference:** -- `C_QuestSession.HasJoined()` - Only true when active (excludes pending requests). \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md b/wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md deleted file mode 100644 index 190d310f..00000000 --- a/wiki-information/functions/C_QuestSession.GetAvailableSessionCommand.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_QuestSession.GetAvailableSessionCommand - -**Content:** -Needs summary. -`command = C_QuestSession.GetAvailableSessionCommand()` - -**Returns:** -- `command` - - *Enum.QuestSessionCommand* - - `Enum.QuestSessionCommand` - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - Start - - `2` - Stop - - `3` - SessionActiveNoCommand - -**Example Usage:** -This function can be used to determine the current available command for a quest session. For instance, if you are developing an addon that manages quest sessions, you can use this function to check if a session can be started, stopped, or if there is no command available. - -**Addon Usage:** -Large addons like "World Quest Tracker" might use this function to manage quest sessions more effectively, ensuring that players are aware of the current state of their quest sessions and can act accordingly. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetPendingCommand.md b/wiki-information/functions/C_QuestSession.GetPendingCommand.md deleted file mode 100644 index 25e9a96f..00000000 --- a/wiki-information/functions/C_QuestSession.GetPendingCommand.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_QuestSession.GetPendingCommand - -**Content:** -Needs summary. -`hasPendingCommand = C_QuestSession.HasPendingCommand()` - -**Returns:** -- `command` - - *Enum* - Enum.QuestSessionCommand - - `Value` - - `Field` - - `Description` - - `0` - - `None` - - `1` - - `Start` - - `2` - - `Stop` - - `3` - - `SessionActiveNoCommand` - -**Reference:** -`C_QuestSession.HasPendingCommand()` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md b/wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md deleted file mode 100644 index 5adda01c..00000000 --- a/wiki-information/functions/C_QuestSession.GetProposedMaxLevelForSession.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestSession.GetProposedMaxLevelForSession - -**Content:** -Needs summary. -`proposedMaxLevel = C_QuestSession.GetProposedMaxLevelForSession()` - -**Returns:** -- `proposedMaxLevel` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md b/wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md deleted file mode 100644 index fcff7039..00000000 --- a/wiki-information/functions/C_QuestSession.GetSessionBeginDetails.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_QuestSession.GetSessionBeginDetails - -**Content:** -Identifies the party member requesting Party Sync. -`details = C_QuestSession.GetSessionBeginDetails()` - -**Returns:** -- `details` - - *QuestSessionPlayerDetails?* - Returns nil if there is no pending request from another party member. - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `guid` - - *string* - GUID - -**Description:** -This only applies when a pending request was initiated by another party member. - -**Reference:** -C_QuestSession.SendSessionBeginResponse(beginSession) - Used to indicate agreement with starting Party Sync. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md b/wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md deleted file mode 100644 index c276c7fd..00000000 --- a/wiki-information/functions/C_QuestSession.GetSuperTrackedQuest.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_QuestSession.GetSuperTrackedQuest - -**Content:** -Needs summary. -`questID = C_QuestSession.GetSuperTrackedQuest()` - -**Returns:** -- `questID` - - *number?* - QuestID - -**Reference:** -- `C_QuestSession.SetQuestIsSuperTracked(questID, superTrack)` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.HasJoined.md b/wiki-information/functions/C_QuestSession.HasJoined.md deleted file mode 100644 index 1ba9a2ee..00000000 --- a/wiki-information/functions/C_QuestSession.HasJoined.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_QuestSession.HasJoined - -**Content:** -Indicates Party Sync is active. -`hasJoined = C_QuestSession.HasJoined()` - -**Returns:** -- `hasJoined` - - *boolean* - True if Party Sync is active; false otherwise. - -**Reference:** -- `C_QuestSession.Exists()` - Also true when there is a pending request to activate Party Sync. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.HasPendingCommand.md b/wiki-information/functions/C_QuestSession.HasPendingCommand.md deleted file mode 100644 index 65759fe7..00000000 --- a/wiki-information/functions/C_QuestSession.HasPendingCommand.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_QuestSession.HasPendingCommand - -**Content:** -Needs summary. -`hasPendingCommand = C_QuestSession.HasPendingCommand()` - -**Returns:** -- `hasPendingCommand` - - *boolean* - -**Reference:** -- `C_QuestSession.GetPendingCommand()` \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.RequestSessionStart.md b/wiki-information/functions/C_QuestSession.RequestSessionStart.md deleted file mode 100644 index 016bf191..00000000 --- a/wiki-information/functions/C_QuestSession.RequestSessionStart.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestSession.RequestSessionStart - -**Content:** -Requests party members to begin Party Sync if permissible. -`C_QuestSession.RequestSessionStart()` - -**Reference:** -- `C_QuestSession.CanStart()` - Indicates if a request to begin Party Sync at this time is permissible. -- `C_QuestSession.RequestSessionStop()` - Applicable after Party Sync has begun. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.RequestSessionStop.md b/wiki-information/functions/C_QuestSession.RequestSessionStop.md deleted file mode 100644 index 4dc4c34a..00000000 --- a/wiki-information/functions/C_QuestSession.RequestSessionStop.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestSession.RequestSessionStop - -**Content:** -Stops Party Sync if permissible. -`C_QuestSession.RequestSessionStop()` - -**Reference:** -- `C_QuestSession.CanStop()` - Indicates if stopping Party Sync at this time is permissible. -- `C_QuestSession.RequestSessionStart()` - Applicable before Party Sync has begun. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md b/wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md deleted file mode 100644 index c7dfc3b7..00000000 --- a/wiki-information/functions/C_QuestSession.SendSessionBeginResponse.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_QuestSession.SendSessionBeginResponse - -**Content:** -Consents to activating Party Sync following a request by another party member. -`C_QuestSession.SendSessionBeginResponse(beginSession)` - -**Parameters:** -- `beginSession` - - *boolean* - True to agree with starting Party Sync, or false to reject it. - -**Description:** -This only applies when a pending request was initiated by another party member. - -**Reference:** -- `C_QuestSession.GetSessionBeginDetails()` - Indicates which party member asked for the Party Sync to begin. \ No newline at end of file diff --git a/wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md b/wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md deleted file mode 100644 index 90c1947d..00000000 --- a/wiki-information/functions/C_QuestSession.SetQuestIsSuperTracked.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_QuestSession.SetQuestIsSuperTracked - -**Content:** -Needs summary. -`C_QuestSession.SetQuestIsSuperTracked(questID, superTrack)` - -**Parameters:** -- `questID` - - *number* - QuestID -- `superTrack` - - *boolean* - -**Reference:** -- `C_QuestSession.GetSuperTrackedQuest()` - -**References:** -- 2019-09-24, QuestSession.lua, version 8.2.5.31960, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/C_RaidLocks.IsEncounterComplete.md b/wiki-information/functions/C_RaidLocks.IsEncounterComplete.md deleted file mode 100644 index ad2e7dce..00000000 --- a/wiki-information/functions/C_RaidLocks.IsEncounterComplete.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_RaidLocks.IsEncounterComplete - -**Content:** -Needs summary. -`encounterIsComplete = C_RaidLocks.IsEncounterComplete(mapID, encounterID)` - -**Parameters:** -- `mapID` - - *number* : UiMapID -- `encounterID` - - *number* : JournalEncounterID -- `difficultyID` - - *number?* : DifficultyID - -**Returns:** -- `encounterIsComplete` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific encounter within a raid instance has been completed. This is particularly useful for raid tracking addons or for players who want to ensure they have completed all encounters in a raid for the week. - -**Addons:** -Large addons like "DBM (Deadly Boss Mods)" or "BigWigs" might use this function to track encounter completions and provide alerts or updates to the player. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.CanReportPlayer.md b/wiki-information/functions/C_ReportSystem.CanReportPlayer.md deleted file mode 100644 index 6da48865..00000000 --- a/wiki-information/functions/C_ReportSystem.CanReportPlayer.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ReportSystem.CanReportPlayer - -**Content:** -Returns if a player can be reported. -`canReport = C_ReportSystem.CanReportPlayer(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* - The location of the player to be reported. - -**Returns:** -- `canReport` - - *boolean* - Returns `true` if the player can be reported, otherwise `false`. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md b/wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md deleted file mode 100644 index a1677b75..00000000 --- a/wiki-information/functions/C_ReportSystem.CanReportPlayerForLanguage.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_ReportSystem.CanReportPlayerForLanguage - -**Content:** -Needs summary. -`canReport = C_ReportSystem.CanReportPlayerForLanguage(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* - -**Returns:** -- `canReport` - - *boolean* - -**Example Usage:** -This function can be used to determine if a player can be reported for inappropriate language based on their location. For instance, in a custom addon that monitors chat for offensive language, this function can be used to check if the offending player can be reported. - -**Addons Using This Function:** -Large addons like "BadBoy" (a chat spam filter) might use this function to automate the reporting of players who use inappropriate language in chat. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md b/wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md deleted file mode 100644 index 2fdd7337..00000000 --- a/wiki-information/functions/C_ReportSystem.GetMajorCategoriesForReportType.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: C_ReportSystem.GetMajorCategoriesForReportType - -**Content:** -Needs summary. -`majorCategories = C_ReportSystem.GetMajorCategoriesForReportType(reportType)` - -**Parameters:** -- `reportType` - - *Enum.ReportType* - - **Value** - - **Field** - - **Description** - - `0` - Chat - - `1` - InWorld - - `2` - ClubFinderPosting - - `3` - ClubFinderApplicant - - `4` - GroupFinderPosting - - `5` - GroupFinderApplicant - - `6` - ClubMember - - `7` - GroupMember - - `8` - Friend - - `9` - Pet - - `10` - BattlePet - - `11` - Calendar - - `12` - Mail - - `13` - PvP - - `14` - PvPScoreboard (Added in 9.2.7) - - `15` - PvPGroupMember (Added in 10.0.5) - -**Returns:** -- `majorCategories` - - *Enum.ReportMajorCategory* - - **Value** - - **Field** - - **Description** - - `0` - InappropriateCommunication - - `1` - GameplaySabotage - - `2` - Cheating - - `3` - InappropriateName \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md b/wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md deleted file mode 100644 index c8375c54..00000000 --- a/wiki-information/functions/C_ReportSystem.GetMajorCategoryString.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ReportSystem.GetMajorCategoryString - -**Content:** -Needs summary. -`majorCategoryString = C_ReportSystem.GetMajorCategoryString(majorCategory)` - -**Parameters:** -- `majorCategory` - - *Enum.ReportMajorCategory* - - `Value` - - `Field` - - `Description` - - `0` - InappropriateCommunication - - `1` - GameplaySabotage - - `2` - Cheating - - `3` - InappropriateName - -**Returns:** -- `majorCategoryString` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md b/wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md deleted file mode 100644 index fa6ff5f5..00000000 --- a/wiki-information/functions/C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory.md +++ /dev/null @@ -1,59 +0,0 @@ -## Title: C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory - -**Content:** -Needs summary. -`minorCategories = C_ReportSystem.GetMinorCategoriesForReportTypeAndMajorCategory(reportType, majorCategory)` - -**Parameters:** -- `reportType` - - *Enum.ReportType* - - `Value` - - `Field` - - `Description` - - `0` - Chat - - `1` - InWorld - - `2` - ClubFinderPosting - - `3` - ClubFinderApplicant - - `4` - GroupFinderPosting - - `5` - GroupFinderApplicant - - `6` - ClubMember - - `7` - GroupMember - - `8` - Friend - - `9` - Pet - - `10` - BattlePet - - `11` - Calendar - - `12` - Mail - - `13` - PvP - - `14` - PvPScoreboard (Added in 9.2.7) - - `15` - PvPGroupMember (Added in 10.0.5) -- `majorCategory` - - *Enum.ReportMajorCategory* - - `Value` - - `Field` - - `Description` - - `0` - InappropriateCommunication - - `1` - GameplaySabotage - - `2` - Cheating - - `3` - InappropriateName - -**Returns:** -- `minorCategories` - - *Enum.ReportMinorCategory* - - `Value` - - `Field` - - `Description` - - `0x1` - TextChat - - `0x2` - Boosting - - `0x4` - Spam - - `0x8` - Afk - - `0x10` - IntentionallyFeeding - - `0x20` - BlockingProgress - - `0x40` - Hacking - - `0x80` - Botting - - `0x100` - Advertisement - - `0x200` - BTag - - `0x400` - GroupName - - `0x800` - CharacterName - - `0x1000` - GuildName - - `0x2000` - Description - - `0x4000` - Name \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md b/wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md deleted file mode 100644 index 62df455f..00000000 --- a/wiki-information/functions/C_ReportSystem.GetMinorCategoryString.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: C_ReportSystem.GetMinorCategoryString - -**Content:** -Needs summary. -`minorCategoryString = C_ReportSystem.GetMinorCategoryString(minorCategory)` - -**Parameters:** -- `minorCategory` - - *Enum.ReportMinorCategory* - - `Value` - - `Field` - - `Description` - - `0x1` - - TextChat - - `0x2` - - Boosting - - `0x4` - - Spam - - `0x8` - - Afk - - `0x10` - - IntentionallyFeeding - - `0x20` - - BlockingProgress - - `0x40` - - Hacking - - `0x80` - - Botting - - `0x100` - - Advertisement - - `0x200` - - BTag - - `0x400` - - GroupName - - `0x800` - - CharacterName - - `0x1000` - - GuildName - - `0x2000` - - Description - - `0x4000` - - Name - -**Returns:** -- `minorCategoryString` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md b/wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md deleted file mode 100644 index 416a120d..00000000 --- a/wiki-information/functions/C_ReportSystem.InitiateReportPlayer.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_ReportSystem.InitiateReportPlayer - -**Content:** -Initiates a report against a player. -`token = C_ReportSystem.InitiateReportPlayer(complaintType)` - -**Parameters:** -- `complaintType` - - *string* : PLAYER_REPORT_TYPE - the reason for reporting. -- `playerLocation` - - *PlayerLocationMixin* - -**PLAYER_REPORT_TYPE Constants:** -- `PLAYER_REPORT_TYPE_SPAM` - - *spam* -- `PLAYER_REPORT_TYPE_LANGUAGE` - - *language* -- `PLAYER_REPORT_TYPE_ABUSE` - - *abuse* -- `PLAYER_REPORT_TYPE_BAD_PLAYER_NAME` - - *badplayername* -- `PLAYER_REPORT_TYPE_BAD_GUILD_NAME` - - *badguildname* -- `PLAYER_REPORT_TYPE_CHEATING` - - *cheater* -- `PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME` - - *badbattlepetname* -- `PLAYER_REPORT_TYPE_BAD_PET_NAME` - - *badpetname* - -**Returns:** -- `token` - - *number* - the token used for `C_ReportSystem.SendReportPlayer`. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md b/wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md deleted file mode 100644 index fe5edb8b..00000000 --- a/wiki-information/functions/C_ReportSystem.OpenReportPlayerDialog.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: C_ReportSystem.OpenReportPlayerDialog - -**Content:** -Opens the dialog for reporting a player. -`C_ReportSystem.OpenReportPlayerDialog(reportType, playerName)` - -**Parameters:** -- `reportType` - - *string* - One of the strings found in PLAYER_REPORT_TYPE -- `playerName` - - *string* - Name of the player being reported -- `playerLocation` - - *PlayerLocationMixin* - -### PLAYER_REPORT_TYPE -- **Constant** - **Value** - - `PLAYER_REPORT_TYPE_SPAM` - spam - - `PLAYER_REPORT_TYPE_LANGUAGE` - language - - `PLAYER_REPORT_TYPE_ABUSE` - abuse - - `PLAYER_REPORT_TYPE_BAD_PLAYER_NAME` - badplayername - - `PLAYER_REPORT_TYPE_BAD_GUILD_NAME` - badguildname - - `PLAYER_REPORT_TYPE_CHEATING` - cheater - - `PLAYER_REPORT_TYPE_BAD_BATTLEPET_NAME` - badbattlepetname - - `PLAYER_REPORT_TYPE_BAD_PET_NAME` - badpetname - -**Description:** -This function is not protected and therefore available to Addons, unlike `C_ReportSystem.InitiateReportPlayer` and `C_ReportSystem.SendReportPlayer`. -This reporting restriction was added because AddOn BadBoy allegedly sent out a number of false positives. -Triggers `OPEN_REPORT_PLAYER` once the window is open. - -**Usage:** -Opens the spam report dialog for the current target. -```lua -/run C_ReportSystem.OpenReportPlayerDialog(PLAYER_REPORT_TYPE_SPAM, UnitName("target"), PlayerLocation:CreateFromUnit("target")) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.ReportServerLag.md b/wiki-information/functions/C_ReportSystem.ReportServerLag.md deleted file mode 100644 index ea9827d4..00000000 --- a/wiki-information/functions/C_ReportSystem.ReportServerLag.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_ReportSystem.ReportServerLag - -**Content:** -Needs summary. -`C_ReportSystem.ReportServerLag()` - -**Description:** -This function is used to report server lag to Blizzard. It can be useful for players experiencing latency issues to notify the developers about server performance problems. - -**Example Usage:** -A player experiencing significant lag during gameplay can use this function to report the issue: -```lua -C_ReportSystem.ReportServerLag() -``` - -**Addons:** -While specific large addons using this function are not well-documented, it can be integrated into custom addons designed to monitor and report server performance issues automatically. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md b/wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md deleted file mode 100644 index 1ca7f46c..00000000 --- a/wiki-information/functions/C_ReportSystem.ReportStuckInCombat.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_ReportSystem.ReportStuckInCombat - -**Content:** -Needs summary. -`C_ReportSystem.ReportStuckInCombat()` - -**Description:** -This function is used to report that a player is stuck in combat. This can be useful in situations where the game does not properly recognize that combat has ended, preventing the player from performing certain actions such as mounting or using certain abilities. - -**Example Usage:** -```lua --- Example of using C_ReportSystem.ReportStuckInCombat -C_ReportSystem.ReportStuckInCombat() -print("Reported being stuck in combat.") -``` - -**Usage in Addons:** -While not commonly used in large addons, this function can be useful in custom scripts or smaller addons designed to handle specific combat-related issues. For example, an addon that helps players manage combat states might use this function to automatically report when the player is stuck in combat, potentially triggering other actions to resolve the issue. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SendReport.md b/wiki-information/functions/C_ReportSystem.SendReport.md deleted file mode 100644 index cccfaa3b..00000000 --- a/wiki-information/functions/C_ReportSystem.SendReport.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_ReportSystem.SendReport - -**Content:** -Not allowed to be called by addons -`C_ReportSystem.SendReport(reportInfo)` - -**Parameters:** -- `reportInfo` - - *ReportInfoMixin* -- `playerLocation` - - *PlayerLocationMixin* (optional) \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SendReportPlayer.md b/wiki-information/functions/C_ReportSystem.SendReportPlayer.md deleted file mode 100644 index cae964be..00000000 --- a/wiki-information/functions/C_ReportSystem.SendReportPlayer.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_ReportSystem.SendReportPlayer - -**Content:** -Sends an initiated report against a player. -`C_ReportSystem.SendReportPlayer(token)` - -**Parameters:** -- `token` - - *number* - the token from C_ReportSystem.InitiateReportPlayer. -- `comment` - - *string?* - any comments and details. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md b/wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md deleted file mode 100644 index bd79334b..00000000 --- a/wiki-information/functions/C_ReportSystem.SetPendingReportPetTarget.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ReportSystem.SetPendingReportPetTarget - -**Content:** -Report a pet for an inappropriate name. -`set = C_ReportSystem.SetPendingReportPetTarget()` - -**Parameters:** -- `target` - - *string?* : UnitId - defaults to "target". - -**Returns:** -- `set` - - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md b/wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md deleted file mode 100644 index 0ce8043c..00000000 --- a/wiki-information/functions/C_ReportSystem.SetPendingReportTarget.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ReportSystem.SetPendingReportTarget - -**Content:** -Populates the reporting window with details about a target player. -`set = C_ReportSystem.SetPendingReportTarget()` -`set = C_ReportSystem.SetPendingReportTargetByGuid()` - -**Parameters:** - -*SetPendingReportTarget:* -- `target` - - *string?* : UnitId - defaults to "target" - -*SetPendingReportTargetByGuid:* -- `guid` - - *string?* : GUID - -**Returns:** -- `set` - - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md b/wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md deleted file mode 100644 index 0ce8043c..00000000 --- a/wiki-information/functions/C_ReportSystem.SetPendingReportTargetByGuid.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ReportSystem.SetPendingReportTarget - -**Content:** -Populates the reporting window with details about a target player. -`set = C_ReportSystem.SetPendingReportTarget()` -`set = C_ReportSystem.SetPendingReportTargetByGuid()` - -**Parameters:** - -*SetPendingReportTarget:* -- `target` - - *string?* : UnitId - defaults to "target" - -*SetPendingReportTargetByGuid:* -- `guid` - - *string?* : GUID - -**Returns:** -- `set` - - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.GetFactionParagonInfo.md b/wiki-information/functions/C_Reputation.GetFactionParagonInfo.md deleted file mode 100644 index fdb1b19b..00000000 --- a/wiki-information/functions/C_Reputation.GetFactionParagonInfo.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: C_Reputation.GetFactionParagonInfo - -**Content:** -Returns Paragon info on a faction. -`currentValue, threshold, rewardQuestID, hasRewardPending, tooLowLevelForParagon = C_Reputation.GetFactionParagonInfo(factionID)` - -**Parameters:** -- `factionID` - - *number* - FactionID - -**Returns:** -- `currentValue` - - *number* - The amount of reputation you have earned in the current level of Paragon. -- `threshold` - - *number* - The amount of reputation until you gain the next Paragon level. -- `rewardQuestID` - - *number* - The ID of the quest once you attain a new Paragon level (or your first). -- `hasRewardPending` - - *boolean* - True if the player has attained a Paragon level but has not completed the reward quest. -- `tooLowLevelForParagon` - - *boolean* - True if the player level is too low to complete the Paragon reward quest. - -**Description:** -The `currentValue` return value contains a prefix that indicates the amount of paragon rewards you have gotten so far. -For example, having received a paragon reward for The Undying Army 12 times, if one calls the above function and the current rep level is 717, the result for `currentValue` will be 120717. - -**Usage:** -Reading the current reputation points of the Venthyr covenant: -```lua -local factionID = 2413 -local currentValue, threshold, rewardQuestID, hasRewardPending, tooLowLevelForParagon = C_Reputation.GetFactionParagonInfo(factionID) --- total iterations (= Rewards Earned) -local level = math.floor(currentValue/threshold)-(hasRewardPending and 1 or 0) -local realValue = tonumber(string.sub(currentValue, string.len(level) + 1)) -print("current rep: ", realValue, " (", threshold, "), level: ", level) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.IsFactionParagon.md b/wiki-information/functions/C_Reputation.IsFactionParagon.md deleted file mode 100644 index 3a9e2474..00000000 --- a/wiki-information/functions/C_Reputation.IsFactionParagon.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_Reputation.IsFactionParagon - -**Content:** -Returns true if a faction is a paragon reputation. -`isParagon = C_Reputation.IsFactionParagon(factionID)` - -**Parameters:** -- `factionID` - - *number* - The factionID from the 14th return of `GetFactionInfo` or the 6th return from `GetWatchedFactionInfo`. - -**Returns:** -- `isParagon` - - *boolean* - true if the faction is Paragon level, false otherwise. - -**Reference:** -- `GetFactionInfo` -- `GetWatchedFactionInfo` -- `C_Reputation.GetFactionParagonInfo` \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md b/wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md deleted file mode 100644 index d438ddb1..00000000 --- a/wiki-information/functions/C_Reputation.RequestFactionParagonPreloadRewardData.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Reputation.RequestFactionParagonPreloadRewardData - -**Content:** -Needs summary. -`C_Reputation.RequestFactionParagonPreloadRewardData(factionID)` - -**Parameters:** -- `factionID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Reputation.SetWatchedFaction.md b/wiki-information/functions/C_Reputation.SetWatchedFaction.md deleted file mode 100644 index fd78e331..00000000 --- a/wiki-information/functions/C_Reputation.SetWatchedFaction.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Reputation.SetWatchedFaction - -**Content:** -Needs summary. -`C_Reputation.SetWatchedFaction(factionID)` - -**Parameters:** -- `factionID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md b/wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md deleted file mode 100644 index 859fb0f5..00000000 --- a/wiki-information/functions/C_ScriptedAnimations.GetAllScriptedAnimationEffects.md +++ /dev/null @@ -1,102 +0,0 @@ -## Title: C_ScriptedAnimations.GetAllScriptedAnimationEffects - -**Content:** -Needs summary. -`scriptedAnimationEffects = C_ScriptedAnimations.GetAllScriptedAnimationEffects()` - -**Returns:** -- `scriptedAnimationEffects` - - *ScriptedAnimationEffect* - - `Field` - - `Type` - - `Description` - - `id` - - *number* - - `visual` - - *number* - - `visualScale` - - *number* - - `duration` - - *number* - - `trajectory` - - *Enum.ScriptedAnimationTrajectory* - - `yawRadians` - - *number* - - `pitchRadians` - - *number* - - `rollRadians` - - *number* - - `offsetX` - - *number* - - `offsetY` - - *number* - - `offsetZ` - - *number* - - `animation` - - *number* - - `animationSpeed` - - *number* - - `alpha` - - *number* - - `useTargetAsSource` - - *boolean* - - `startBehavior` - - *Enum.ScriptedAnimationBehavior?* - - `startSoundKitID` - - *number?* - - `finishEffectID` - - *number?* - - `finishBehavior` - - *Enum.ScriptedAnimationBehavior?* - - `finishSoundKitID` - - *number?* - - `startAlphaFade` - - *number?* - - `startAlphaFadeDuration` - - *number?* - - `endAlphaFade` - - *number?* - - `endAlphaFadeDuration` - - *number?* - - `animationStartOffset` - - *number?* - - `loopingSoundKitID` - - *number?* - - `particleOverrideScale` - - *number?* - -**Enum.ScriptedAnimationTrajectory** -- `Value` -- `Field` -- `Description` - - `0` - - AtSource - - `1` - - AtTarget - - `2` - - Straight - - `3` - - CurveLeft - - `4` - - CurveRight - - `5` - - CurveRandom - - `6` - - HalfwayBetween - -**Enum.ScriptedAnimationBehavior** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - TargetShake - - `2` - - TargetKnockBack - - `3` - - SourceRecoil - - `4` - - SourceCollideWithTarget - - `5` - - UIParentShake \ No newline at end of file diff --git a/wiki-information/functions/C_Seasons.GetActiveSeason.md b/wiki-information/functions/C_Seasons.GetActiveSeason.md deleted file mode 100644 index c8234617..00000000 --- a/wiki-information/functions/C_Seasons.GetActiveSeason.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Seasons.GetActiveSeason - -**Content:** -Returns the ID of the season that is active on the current realm. -`seasonID = C_Seasons.GetActiveSeason()` - -**Returns:** -- `seasonID` - - *Enum.SeasonID* - The currently active season ID. - - `Value` - - `Field` - - `Description` - - `0` - - `NoSeason` - Used for normal (non-seasonal) realms. - - `1` - - `SeasonOfMastery` - Season of Mastery realms. - - `2` - - `SeasonOfDiscovery` - Season of Discovery realms. - - `3` - - `Hardcore` - -**Description:** -This function will not return nil when no season is active; instead, the NoSeason ID will be returned. \ No newline at end of file diff --git a/wiki-information/functions/C_Seasons.HasActiveSeason.md b/wiki-information/functions/C_Seasons.HasActiveSeason.md deleted file mode 100644 index 891d5391..00000000 --- a/wiki-information/functions/C_Seasons.HasActiveSeason.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Seasons.HasActiveSeason - -**Content:** -Returns true if the player is on a seasonal realm. -`active = C_Seasons.HasActiveSeason()` - -**Returns:** -- `active` - - *boolean* - true if the player is on a seasonal realm, otherwise false. - -**Description:** -Information about the current season active on a realm can be queried via `C_Seasons.GetActiveSeason`. \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetLastItem.md b/wiki-information/functions/C_Social.GetLastItem.md deleted file mode 100644 index 869d2525..00000000 --- a/wiki-information/functions/C_Social.GetLastItem.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Social.GetLastItem - -**Content:** -Needs summary. -`itemID, itemName, iconFileID, itemQuality, itemLevel, itemLinkString = C_Social.GetLastItem()` - -**Returns:** -- `itemID` - - *number* -- `itemName` - - *string* -- `iconFileID` - - *number* -- `itemQuality` - - *number* -- `itemLevel` - - *number* -- `itemLinkString` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetLastScreenshot.md b/wiki-information/functions/C_Social.GetLastScreenshot.md deleted file mode 100644 index 08cfb168..00000000 --- a/wiki-information/functions/C_Social.GetLastScreenshot.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Social.GetLastScreenshotIndex - -**Content:** -Returns the index of the last screenshot. -`screenshotIndex = C_Social.GetLastScreenshotIndex()` - -**Returns:** -- `screenshotIndex` - - *number* - index of the screenshot. Zero if no screenshots have been taken yet. \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetNumCharactersPerMedia.md b/wiki-information/functions/C_Social.GetNumCharactersPerMedia.md deleted file mode 100644 index 400df2fc..00000000 --- a/wiki-information/functions/C_Social.GetNumCharactersPerMedia.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Social.GetMaxTweetLength - -**Content:** -Returns the max character length of a tweet. -`maxTweetLength = C_Social.GetMaxTweetLength()` - -**Returns:** -- `maxTweetLength` - - *number* - the current max character length for the user (280). \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetScreenshotByIndex.md b/wiki-information/functions/C_Social.GetScreenshotByIndex.md deleted file mode 100644 index f7d5e092..00000000 --- a/wiki-information/functions/C_Social.GetScreenshotByIndex.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_Social.GetScreenshotInfoByIndex - -**Content:** -Returns the display resolution of a screenshot. -`screenWidth, screenHeight = C_Social.GetScreenshotInfoByIndex(index)` - -**Parameters:** -- `index` - - *number* - index of the screenshot. Does not persist between sessions. - -**Returns:** -- `screenWidth` - - *number* - width of the screen in pixels. -- `screenHeight` - - *number* - height of the screen in pixels. - -**Usage:** -Prints the screenshot information of this session. -```lua -for i = 1, C_Social.GetLastScreenshotIndex() do - local width, height = C_Social.GetScreenshotInfoByIndex(i) - print(i, width, height) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.GetTweetLength.md b/wiki-information/functions/C_Social.GetTweetLength.md deleted file mode 100644 index 0740fc97..00000000 --- a/wiki-information/functions/C_Social.GetTweetLength.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Social.GetTweetLength - -**Content:** -Needs summary. -`tweetLength = C_Social.GetTweetLength(tweetText)` - -**Parameters:** -- `tweetText` - - *string* - -**Returns:** -- `tweetLength` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.IsSocialEnabled.md b/wiki-information/functions/C_Social.IsSocialEnabled.md deleted file mode 100644 index 24a82cd4..00000000 --- a/wiki-information/functions/C_Social.IsSocialEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Social.IsSocialEnabled - -**Content:** -Needs summary. -`isEnabled = C_Social.IsSocialEnabled()` - -**Returns:** -- `isEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterCheckStatus.md b/wiki-information/functions/C_Social.TwitterCheckStatus.md deleted file mode 100644 index ac492565..00000000 --- a/wiki-information/functions/C_Social.TwitterCheckStatus.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Social.TwitterCheckStatus - -**Content:** -Not allowed to be called by addons. -`C_Social.TwitterCheckStatus()` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterConnect.md b/wiki-information/functions/C_Social.TwitterConnect.md deleted file mode 100644 index 485bf7b1..00000000 --- a/wiki-information/functions/C_Social.TwitterConnect.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Social.TwitterConnect - -**Content:** -Not allowed to be called by addons. -`C_Social.TwitterConnect()` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterDisconnect.md b/wiki-information/functions/C_Social.TwitterDisconnect.md deleted file mode 100644 index 82060144..00000000 --- a/wiki-information/functions/C_Social.TwitterDisconnect.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_Social.TwitterDisconnect - -**Content:** -Not allowed to be called by addons. -`C_Social.TwitterDisconnect()` \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md b/wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md deleted file mode 100644 index b240e4e9..00000000 --- a/wiki-information/functions/C_Social.TwitterGetMSTillCanPost.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Social.TwitterGetMSTillCanPost - -**Content:** -Needs summary. -`msTimeLeft = C_Social.TwitterGetMSTillCanPost()` - -**Returns:** -- `msTimeLeft` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Social.TwitterPostMessage.md b/wiki-information/functions/C_Social.TwitterPostMessage.md deleted file mode 100644 index bfd62140..00000000 --- a/wiki-information/functions/C_Social.TwitterPostMessage.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Social.TwitterPostMessage - -**Content:** -Needs summary. -`C_Social.TwitterPostMessage(message)` - -**Parameters:** -- `message` - - *string* - -**Description:** -Not allowed to be called by addons. \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md b/wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md deleted file mode 100644 index 199b2b12..00000000 --- a/wiki-information/functions/C_SocialRestrictions.AcknowledgeRegionalChatDisabled.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_SocialRestrictions.AcknowledgeRegionalChatDisabled - -**Content:** -Needs summary. -`C_SocialRestrictions.AcknowledgeRegionalChatDisabled()` \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md b/wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md deleted file mode 100644 index 694f115d..00000000 --- a/wiki-information/functions/C_SocialRestrictions.IsChatDisabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SocialRestrictions.IsChatDisabled - -**Content:** -Needs summary. -`disabled = C_SocialRestrictions.IsChatDisabled()` - -**Returns:** -- `disabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsMuted.md b/wiki-information/functions/C_SocialRestrictions.IsMuted.md deleted file mode 100644 index 7b4777b2..00000000 --- a/wiki-information/functions/C_SocialRestrictions.IsMuted.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SocialRestrictions.IsMuted - -**Content:** -Needs summary. -`isMuted = C_SocialRestrictions.IsMuted()` - -**Returns:** -- `isMuted` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsSilenced.md b/wiki-information/functions/C_SocialRestrictions.IsSilenced.md deleted file mode 100644 index 889bed36..00000000 --- a/wiki-information/functions/C_SocialRestrictions.IsSilenced.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SocialRestrictions.IsSilenced - -**Content:** -Needs summary. -`isSilenced = C_SocialRestrictions.IsSilenced()` - -**Returns:** -- `isSilenced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.IsSquelched.md b/wiki-information/functions/C_SocialRestrictions.IsSquelched.md deleted file mode 100644 index 54d3ed33..00000000 --- a/wiki-information/functions/C_SocialRestrictions.IsSquelched.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SocialRestrictions.IsSquelched - -**Content:** -Needs summary. -`isSquelched = C_SocialRestrictions.IsSquelched()` - -**Returns:** -- `isSquelched` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md b/wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md deleted file mode 100644 index b6c09d8f..00000000 --- a/wiki-information/functions/C_SocialRestrictions.SetChatDisabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SocialRestrictions.SetChatDisabled - -**Content:** -Needs summary. -`C_SocialRestrictions.SetChatDisabled(disabled)` - -**Parameters:** -- `disabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Sound.GetSoundScaledVolume.md b/wiki-information/functions/C_Sound.GetSoundScaledVolume.md deleted file mode 100644 index 837beb41..00000000 --- a/wiki-information/functions/C_Sound.GetSoundScaledVolume.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Sound.GetSoundScaledVolume - -**Content:** -Needs summary. -`scaledVolume = C_Sound.GetSoundScaledVolume(soundHandle)` - -**Parameters:** -- `soundHandle` - - *number* - -**Returns:** -- `scaledVolume` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Sound.IsPlaying.md b/wiki-information/functions/C_Sound.IsPlaying.md deleted file mode 100644 index 3c156167..00000000 --- a/wiki-information/functions/C_Sound.IsPlaying.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Sound.IsPlaying - -**Content:** -Needs summary. -`isPlaying = C_Sound.IsPlaying(soundHandle)` - -**Parameters:** -- `soundHandle` - - *number* - -**Returns:** -- `isPlaying` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific sound is currently playing in the game. For instance, if you have a custom addon that plays a sound when a certain event occurs, you can use `C_Sound.IsPlaying` to verify if the sound is still playing before attempting to play it again. - -**Addons:** -Many large addons that manage sound effects, such as DBM (Deadly Boss Mods) or WeakAuras, might use this function to ensure that sounds are not played multiple times simultaneously, which can help in managing sound clutter and improving the user experience. \ No newline at end of file diff --git a/wiki-information/functions/C_Sound.PlayItemSound.md b/wiki-information/functions/C_Sound.PlayItemSound.md deleted file mode 100644 index 59384550..00000000 --- a/wiki-information/functions/C_Sound.PlayItemSound.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_Sound.PlayItemSound - -**Content:** -Needs summary. -`C_Sound.PlayItemSound(soundType, itemLocation)` - -**Parameters:** -- `soundType` - - *Enum.ItemSoundType* - - `Value` - - `Field` - - `Description` - - `0` - - Pickup - - `1` - - Drop - - `2` - - Use - - `3` - - Close -- `itemLocation` - - *ItemLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_Spell.DoesSpellExist.md b/wiki-information/functions/C_Spell.DoesSpellExist.md deleted file mode 100644 index 1a386372..00000000 --- a/wiki-information/functions/C_Spell.DoesSpellExist.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Spell.DoesSpellExist - -**Content:** -Needs summary. -`spellExists = C_Spell.DoesSpellExist(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `spellExists` - - *boolean* - -**Reference:** -DoesSpellExist() - This is apparently not the same since it points to a different function reference. \ No newline at end of file diff --git a/wiki-information/functions/C_Spell.IsSpellDataCached.md b/wiki-information/functions/C_Spell.IsSpellDataCached.md deleted file mode 100644 index 58a61a6b..00000000 --- a/wiki-information/functions/C_Spell.IsSpellDataCached.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: C_Spell.IsSpellDataCached - -**Content:** -Needs summary. -`isCached = C_Spell.IsSpellDataCached(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `isCached` - - *boolean* - -**Description:** -This function checks if the data for a specific spell, identified by its `spellID`, is already cached on the client. This can be useful for addons that need to ensure spell data is available before attempting to use or display it. - -**Example Usage:** -```lua -local spellID = 12345 -if C_Spell.IsSpellDataCached(spellID) then - print("Spell data is cached.") -else - print("Spell data is not cached.") -end -``` - -**Addons Using This Function:** -- **WeakAuras**: This popular addon uses `C_Spell.IsSpellDataCached` to check if spell data is available before creating custom auras and effects based on specific spells. This ensures that the addon can provide accurate and up-to-date information to the player. \ No newline at end of file diff --git a/wiki-information/functions/C_Spell.RequestLoadSpellData.md b/wiki-information/functions/C_Spell.RequestLoadSpellData.md deleted file mode 100644 index d4cb82c3..00000000 --- a/wiki-information/functions/C_Spell.RequestLoadSpellData.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_Spell.RequestLoadSpellData - -**Content:** -Requests spell data and fires `SPELL_DATA_LOAD_RESULT`. -`C_Spell.RequestLoadSpellData(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Reference:** -- `SpellMixin` \ No newline at end of file diff --git a/wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md b/wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md deleted file mode 100644 index fba82b71..00000000 --- a/wiki-information/functions/C_SpellBook.GetSpellLinkFromSpellID.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_SpellBook.GetSpellLinkFromSpellID - -**Content:** -Needs summary. -`spellLink = C_SpellBook.GetSpellLinkFromSpellID(spellID)` - -**Parameters:** -- `spellID` - - *number* -- `glyphID` - - *number?* - -**Returns:** -- `spellLink` - - *string* - -**Example Usage:** -This function can be used to retrieve the link of a spell given its spell ID. This is particularly useful for addons that need to display or manipulate spell links. - -**Addon Usage:** -Large addons like WeakAuras might use this function to fetch and display spell links in custom auras or notifications. \ No newline at end of file diff --git a/wiki-information/functions/C_StableInfo.GetNumActivePets.md b/wiki-information/functions/C_StableInfo.GetNumActivePets.md deleted file mode 100644 index 19a03c5c..00000000 --- a/wiki-information/functions/C_StableInfo.GetNumActivePets.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_StableInfo.GetNumActivePets - -**Content:** -Needs summary. -`numActivePets = C_StableInfo.GetNumActivePets()` - -**Returns:** -- `numActivePets` - - *number* - -**Description:** -Appears to be added for a "Hunter Tame Tutorial". \ No newline at end of file diff --git a/wiki-information/functions/C_StableInfo.GetNumStablePets.md b/wiki-information/functions/C_StableInfo.GetNumStablePets.md deleted file mode 100644 index 2f8232ce..00000000 --- a/wiki-information/functions/C_StableInfo.GetNumStablePets.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_StableInfo.GetNumStablePets - -**Content:** -Needs summary. -`numStablePets = C_StableInfo.GetNumStablePets()` - -**Returns:** -- `numStablePets` - - *number* - -**Description:** -Appears to be added for a "Hunter Tame Tutorial". \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md b/wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md deleted file mode 100644 index 2799ca7b..00000000 --- a/wiki-information/functions/C_StorePublic.DoesGroupHavePurchaseableProducts.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_StorePublic.DoesGroupHavePurchaseableProducts - -**Content:** -Needs summary. -`hasPurchaseableProducts = C_StorePublic.DoesGroupHavePurchaseableProducts(groupID)` - -**Parameters:** -- `groupID` - - *number* - -**Returns:** -- `hasPurchaseableProducts` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md b/wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md deleted file mode 100644 index 268b6617..00000000 --- a/wiki-information/functions/C_StorePublic.HasPurchaseableProducts.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_StorePublic.HasPurchaseableProducts - -**Content:** -Needs summary. -`hasPurchaseableProducts = C_StorePublic.HasPurchaseableProducts()` - -**Returns:** -- `hasPurchaseableProducts` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md b/wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md deleted file mode 100644 index 08b7a237..00000000 --- a/wiki-information/functions/C_StorePublic.IsDisabledByParentalControls.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_StorePublic.IsDisabledByParentalControls - -**Content:** -Returns whether access to the in-game shop is disabled by parental controls. -`isDisabled = C_StorePublic.IsDisabledByParentalControls()` - -**Returns:** -- `isDisabled` - - *boolean* - true if the player cannot access the in-game shop due to parental controls, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_StorePublic.IsEnabled.md b/wiki-information/functions/C_StorePublic.IsEnabled.md deleted file mode 100644 index 6ac5cc9b..00000000 --- a/wiki-information/functions/C_StorePublic.IsEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_StorePublic.IsEnabled - -**Content:** -Returns whether the In-Game Store is available for the player. -`isEnabled = C_StorePublic.IsEnabled()` - -**Returns:** -- `isEnabled` - - *boolean* - true if the store is available, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.CancelSummon.md b/wiki-information/functions/C_SummonInfo.CancelSummon.md deleted file mode 100644 index df1bb4a0..00000000 --- a/wiki-information/functions/C_SummonInfo.CancelSummon.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_SummonInfo.CancelSummon - -**Content:** -Declines a summon request. -`C_SummonInfo.CancelSummon()` - -**Example Usage:** -This function can be used in a scenario where a player receives a summon request but decides not to accept it. For instance, an addon could automatically decline summon requests under certain conditions, such as being in combat or in a specific zone. - -**Addons:** -While there are no specific large addons known to use this function directly, it could be utilized in custom scripts or smaller addons that manage player interactions and automate responses to summon requests. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.ConfirmSummon.md b/wiki-information/functions/C_SummonInfo.ConfirmSummon.md deleted file mode 100644 index 26cac83a..00000000 --- a/wiki-information/functions/C_SummonInfo.ConfirmSummon.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_SummonInfo.ConfirmSummon - -**Content:** -Accepts a summon request. -`C_SummonInfo.ConfirmSummon()` - -**Example Usage:** -This function can be used in a scenario where a player receives a summon request from another player or a warlock's summoning portal. By calling `C_SummonInfo.ConfirmSummon()`, the player can automatically accept the summon without manually clicking the accept button. - -**Addon Usage:** -Large addons like **DBM (Deadly Boss Mods)** or **ElvUI** might use this function to streamline the summoning process during raids or group activities, ensuring that players can quickly and efficiently respond to summon requests without interrupting their gameplay. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md b/wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md deleted file mode 100644 index c30fa0d7..00000000 --- a/wiki-information/functions/C_SummonInfo.GetSummonConfirmAreaName.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SummonInfo.GetSummonConfirmAreaName - -**Content:** -Returns the zone where you will be summoned to. -`areaName = C_SummonInfo.GetSummonConfirmAreaName()` - -**Returns:** -- `areaName` - - *string* - the zone of the summoning origin. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md b/wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md deleted file mode 100644 index 8fb03187..00000000 --- a/wiki-information/functions/C_SummonInfo.GetSummonConfirmSummoner.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_SummonInfo.GetSummonConfirmSummoner - -**Content:** -Returns the name of the player summoning you. -`summoner = C_SummonInfo.GetSummonConfirmSummoner()` - -**Returns:** -- `summoner` - - *string?* - name of the player summoning you, or nil if no summon is currently pending. - -**Description:** -The function returns correct results after the `CONFIRM_SUMMON` event. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md b/wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md deleted file mode 100644 index f28a13fe..00000000 --- a/wiki-information/functions/C_SummonInfo.GetSummonConfirmTimeLeft.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SummonInfo.GetSummonConfirmTimeLeft - -**Content:** -Returns the time left in seconds for accepting a summon. -`timeLeft = C_SummonInfo.GetSummonConfirmTimeLeft()` - -**Returns:** -- `timeLeft` - - *number* - Time in seconds. Zero if not being summoned. \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.GetSummonReason.md b/wiki-information/functions/C_SummonInfo.GetSummonReason.md deleted file mode 100644 index 3e7856a6..00000000 --- a/wiki-information/functions/C_SummonInfo.GetSummonReason.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SummonInfo.GetSummonReason - -**Content:** -Returns the reason for a summon. -`summonReason = C_SummonInfo.GetSummonReason()` - -**Returns:** -- `summonReason` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md b/wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md deleted file mode 100644 index a428b91e..00000000 --- a/wiki-information/functions/C_SummonInfo.IsSummonSkippingStartExperience.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SummonInfo.IsSummonSkippingStartExperience - -**Content:** -Returns true if the summon will take the player out of a confined starting zone. -`isSummonSkippingStartExperience = C_SummonInfo.IsSummonSkippingStartExperience()` - -**Returns:** -- `isSummonSkippingStartExperience` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_System.GetFrameStack.md b/wiki-information/functions/C_System.GetFrameStack.md deleted file mode 100644 index 134e866f..00000000 --- a/wiki-information/functions/C_System.GetFrameStack.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_System.GetFrameStack - -**Content:** -Returns an array of all UI objects under the mouse cursor, as would be exposed through the frame stack tooltip. The returned table is ordered from highest object level to lowest. -`objects = C_System.GetFrameStack()` - -**Returns:** -- `objects` - - *ScriptRegion* - A table of all UI objects under the mouse cursor, ordered from highest object level to lowest. \ No newline at end of file diff --git a/wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md b/wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md deleted file mode 100644 index 5ff31e77..00000000 --- a/wiki-information/functions/C_SystemVisibilityManager.IsSystemVisible.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_SystemVisibilityManager.IsSystemVisible - -**Content:** -Needs summary. -`visible = C_SystemVisibilityManager.IsSystemVisible(system)` - -**Parameters:** -- `system` - - *Enum.UISystemType* - - `Value` - - `Field` - - `Description` - - `0` - - InGameNavigation - -**Returns:** -- `visible` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetChannelEnabled.md b/wiki-information/functions/C_TTSSettings.GetChannelEnabled.md deleted file mode 100644 index c7bbb133..00000000 --- a/wiki-information/functions/C_TTSSettings.GetChannelEnabled.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: C_TTSSettings.GetChannelEnabled - -**Content:** -Needs summary. -`enabled = C_TTSSettings.GetChannelEnabled(channelInfo)` - -**Parameters:** -- `channelInfo` - - *ChatChannelInfo* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `shortcut` - - *string* - - `localID` - - *number* - - `instanceID` - - *number* - - `zoneChannelID` - - *number* - - `channelType` - - *Enum.PermanentChatChannelType* - - `Enum.PermanentChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Zone - - `2` - - Communities - - `3` - - Custom - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md b/wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md deleted file mode 100644 index e1eaeafd..00000000 --- a/wiki-information/functions/C_TTSSettings.GetCharacterSettingsSaved.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_TTSSettings.GetCharacterSettingsSaved - -**Content:** -Needs summary. -`settingsBeenSaved = C_TTSSettings.GetCharacterSettingsSaved()` - -**Returns:** -- `settingsBeenSaved` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md b/wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md deleted file mode 100644 index 38139001..00000000 --- a/wiki-information/functions/C_TTSSettings.GetChatTypeEnabled.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_TTSSettings.GetChatTypeEnabled - -**Content:** -Needs summary. -`enabled = C_TTSSettings.GetChatTypeEnabled(chatName)` - -**Parameters:** -- `chatName` - - *string* - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetSetting.md b/wiki-information/functions/C_TTSSettings.GetSetting.md deleted file mode 100644 index 90c6e108..00000000 --- a/wiki-information/functions/C_TTSSettings.GetSetting.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_TTSSettings.GetSetting - -**Content:** -Needs summary. -`enabled = C_TTSSettings.GetSetting(setting)` - -**Parameters:** -- `setting` - - *Enum.TtsBoolSetting* - - `Value` - - `Field` - - `Description` - - `0` - PlaySoundSeparatingChatLineBreaks - - `1` - AddCharacterNameToSpeech - - `2` - PlayActivitySoundWhenNotFocused - - `3` - AlternateSystemVoice - - `4` - NarrateMyMessages - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetSpeechRate.md b/wiki-information/functions/C_TTSSettings.GetSpeechRate.md deleted file mode 100644 index 9fe10161..00000000 --- a/wiki-information/functions/C_TTSSettings.GetSpeechRate.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_TTSSettings.GetSpeechRate - -**Content:** -Needs summary. -`rate = C_TTSSettings.GetSpeechRate()` - -**Returns:** -- `rate` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetSpeechVolume.md b/wiki-information/functions/C_TTSSettings.GetSpeechVolume.md deleted file mode 100644 index 09a6f291..00000000 --- a/wiki-information/functions/C_TTSSettings.GetSpeechVolume.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_TTSSettings.GetSpeechVolume - -**Content:** -Needs summary. -`volume = C_TTSSettings.GetSpeechVolume()` - -**Returns:** -- `volume` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md b/wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md deleted file mode 100644 index 786d5d85..00000000 --- a/wiki-information/functions/C_TTSSettings.GetVoiceOptionID.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_TTSSettings.GetVoiceOptionID - -**Content:** -Get the user's preferred text to speech voices. -`voiceID = C_TTSSettings.GetVoiceOptionID(voiceType)` - -**Parameters:** -- `voiceType` - - *Enum.TtsVoiceType* - - `Value` - - `Field` - - `Description` - - `0` - - Standard - - `1` - - Alternate - -**Returns:** -- `voiceID` - - *number* - Used with `C_VoiceChat.SpeakText()`. \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md b/wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md deleted file mode 100644 index 5806fc7d..00000000 --- a/wiki-information/functions/C_TTSSettings.GetVoiceOptionName.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_TTSSettings.GetVoiceOptionName - -**Content:** -Needs summary. -`voiceName = C_TTSSettings.GetVoiceOptionName(voiceType)` - -**Parameters:** -- `voiceType` - - *Enum.TtsVoiceType* - - `Value` - - `Field` - - `Description` - - `0` - - Standard - - `1` - - Alternate - -**Returns:** -- `voiceName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md b/wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md deleted file mode 100644 index 24ec9d42..00000000 --- a/wiki-information/functions/C_TTSSettings.MarkCharacterSettingsSaved.md +++ /dev/null @@ -1,6 +0,0 @@ -## Title: C_TTSSettings.MarkCharacterSettingsSaved - -**Content:** -Needs summary. -`C_TTSSettings.MarkCharacterSettingsSaved()` - diff --git a/wiki-information/functions/C_TTSSettings.SetChannelEnabled.md b/wiki-information/functions/C_TTSSettings.SetChannelEnabled.md deleted file mode 100644 index c5f635c1..00000000 --- a/wiki-information/functions/C_TTSSettings.SetChannelEnabled.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_TTSSettings.SetChannelEnabled - -**Content:** -Needs summary. -`C_TTSSettings.SetChannelEnabled(channelInfo)` - -**Parameters:** -- `channelInfo` - - *ChatChannelInfo* - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `shortcut` - - *string* - - `localID` - - *number* - - `instanceID` - - *number* - - `zoneChannelID` - - *number* - - `channelType` - - *Enum.PermanentChatChannelType* - - `Enum.PermanentChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Zone - - `2` - - Communities - - `3` - - Custom -- `newVal` - - *boolean? = false* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md b/wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md deleted file mode 100644 index 08037dd5..00000000 --- a/wiki-information/functions/C_TTSSettings.SetChannelKeyEnabled.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_TTSSettings.SetChannelKeyEnabled - -**Content:** -Needs summary. -`C_TTSSettings.SetChannelKeyEnabled(channelKey)` - -**Parameters:** -- `channelKey` - - *string* -- `newVal` - - *boolean? = false* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md b/wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md deleted file mode 100644 index eba4eb9a..00000000 --- a/wiki-information/functions/C_TTSSettings.SetChatTypeEnabled.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_TTSSettings.SetChatTypeEnabled - -**Content:** -Needs summary. -`C_TTSSettings.SetChatTypeEnabled(chatName)` - -**Parameters:** -- `chatName` - - *string* -- `newVal` - - *boolean? = false* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetDefaultSettings.md b/wiki-information/functions/C_TTSSettings.SetDefaultSettings.md deleted file mode 100644 index a94618bc..00000000 --- a/wiki-information/functions/C_TTSSettings.SetDefaultSettings.md +++ /dev/null @@ -1,6 +0,0 @@ -## Title: C_TTSSettings.SetDefaultSettings - -**Content:** -Needs summary. -`C_TTSSettings.SetDefaultSettings()` - diff --git a/wiki-information/functions/C_TTSSettings.SetSetting.md b/wiki-information/functions/C_TTSSettings.SetSetting.md deleted file mode 100644 index 334bbfb4..00000000 --- a/wiki-information/functions/C_TTSSettings.SetSetting.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_TTSSettings.SetSetting - -**Content:** -Needs summary. -`C_TTSSettings.SetSetting(setting)` - -**Parameters:** -- `setting` - - *Enum.TtsBoolSetting* - - `Value` - - `Field` - - `Description` - - `0` - PlaySoundSeparatingChatLineBreaks - - `1` - AddCharacterNameToSpeech - - `2` - PlayActivitySoundWhenNotFocused - - `3` - AlternateSystemVoice - - `4` - NarrateMyMessages -- `newVal` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetSpeechRate.md b/wiki-information/functions/C_TTSSettings.SetSpeechRate.md deleted file mode 100644 index 2f004e3b..00000000 --- a/wiki-information/functions/C_TTSSettings.SetSpeechRate.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_TTSSettings.SetSpeechRate - -**Content:** -Needs summary. -`C_TTSSettings.SetSpeechRate(newVal)` - -**Parameters:** -- `newVal` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetSpeechVolume.md b/wiki-information/functions/C_TTSSettings.SetSpeechVolume.md deleted file mode 100644 index 59dd0ed5..00000000 --- a/wiki-information/functions/C_TTSSettings.SetSpeechVolume.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_TTSSettings.SetSpeechVolume - -**Content:** -Needs summary. -`C_TTSSettings.SetSpeechVolume(newVal)` - -**Parameters:** -- `newVal` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.SetVoiceOption.md b/wiki-information/functions/C_TTSSettings.SetVoiceOption.md deleted file mode 100644 index 650e0d4a..00000000 --- a/wiki-information/functions/C_TTSSettings.SetVoiceOption.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_TTSSettings.SetVoiceOption - -**Content:** -Needs summary. -`C_TTSSettings.SetVoiceOption(voiceType, voiceID)` - -**Parameters:** -- `voiceType` - - *Enum.TtsVoiceType* - - `Value` - - `Field` - - `Description` - - `0` - Standard - - `1` - Alternate -- `voiceID` - - *number* - diff --git a/wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md b/wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md deleted file mode 100644 index b3ed523d..00000000 --- a/wiki-information/functions/C_TTSSettings.SetVoiceOptionName.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_TTSSettings.SetVoiceOptionName - -**Content:** -Needs summary. -`C_TTSSettings.SetVoiceOptionName(voiceType, voiceName)` - -**Parameters:** -- `voiceType` - - *Enum.TtsVoiceType* - - `Value` - - `Field` - - `Description` - - `0` - - Standard - - `1` - - Alternate -- `voiceName` - - *string* - -**Description:** -This function is used to set the voice option for text-to-speech settings in World of Warcraft. The `voiceType` parameter allows you to choose between standard and alternate voice types, while the `voiceName` parameter specifies the name of the voice to be used. - -**Example Usage:** -```lua --- Set the voice option to the standard voice type with a specific voice name -C_TTSSettings.SetVoiceOptionName(Enum.TtsVoiceType.Standard, "VoiceName1") - --- Set the voice option to the alternate voice type with a different voice name -C_TTSSettings.SetVoiceOptionName(Enum.TtsVoiceType.Alternate, "VoiceName2") -``` - -**Addons:** -Large addons that provide accessibility features, such as text-to-speech, may use this function to customize the voice settings for users. For example, an addon designed to assist visually impaired players might allow users to select different voices for better clarity and understanding. \ No newline at end of file diff --git a/wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md b/wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md deleted file mode 100644 index b25faacf..00000000 --- a/wiki-information/functions/C_TTSSettings.ShouldOverrideMessage.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_TTSSettings.ShouldOverrideMessage - -**Content:** -Needs summary. -`overrideMessage = C_TTSSettings.ShouldOverrideMessage(language, messageText)` - -**Parameters:** -- `language` - - *number* -- `messageText` - - *string* - -**Returns:** -- `overrideMessage` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md b/wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md deleted file mode 100644 index db5b32d9..00000000 --- a/wiki-information/functions/C_TaskQuest.DoesMapShowTaskQuestObjectives.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_TaskQuest.DoesMapShowTaskQuestObjectives - -**Content:** -Needs summary. -`showsTaskQuestObjectives = C_TaskQuest.DoesMapShowTaskQuestObjectives(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `showsTaskQuestObjectives` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md b/wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md deleted file mode 100644 index a3fd8007..00000000 --- a/wiki-information/functions/C_TaskQuest.GetQuestInfoByQuestID.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_TaskQuest.GetQuestInfoByQuestID - -**Content:** -Needs summary. -`questTitle, factionID, capped, displayAsObjective = C_TaskQuest.GetQuestInfoByQuestID(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `questTitle` - - *string* -- `factionID` - - *number?* : FactionID -- `capped` - - *boolean?* -- `displayAsObjective` - - *boolean?* - -**Example Usage:** -This function can be used to retrieve detailed information about a specific task quest by its quest ID. For instance, it can be used in an addon to display quest information in a custom quest tracker. - -**Addons Using This Function:** -Large addons like World Quest Tracker use this function to fetch and display information about world quests, including their titles, associated factions, and whether they are capped or displayed as objectives. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestLocation.md b/wiki-information/functions/C_TaskQuest.GetQuestLocation.md deleted file mode 100644 index 9da8ed8e..00000000 --- a/wiki-information/functions/C_TaskQuest.GetQuestLocation.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_TaskQuest.GetQuestLocation - -**Content:** -Needs summary. -`locationX, locationY = C_TaskQuest.GetQuestLocation(questID, uiMapID)` - -**Parameters:** -- `questID` - - *number* -- `uiMapID` - - *number* : UiMapID - -**Returns:** -- `locationX` - - *number* -- `locationY` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md b/wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md deleted file mode 100644 index f2f76513..00000000 --- a/wiki-information/functions/C_TaskQuest.GetQuestProgressBarInfo.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_TaskQuest.GetQuestProgressBarInfo - -**Content:** -Needs summary. -`progress = C_TaskQuest.GetQuestProgressBarInfo(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `progress` - - *number* - -**Description:** -This function retrieves the progress of a quest that has a progress bar. The progress is returned as a number, which typically represents the percentage of completion. - -**Example Usage:** -```lua -local questID = 12345 -local progress = C_TaskQuest.GetQuestProgressBarInfo(questID) -print("Quest Progress: " .. progress .. "%") -``` - -**Addons Using This Function:** -- **World Quest Tracker**: This addon uses `C_TaskQuest.GetQuestProgressBarInfo` to display the progress of world quests on the map and in the quest tracker. -- **TomTom**: This popular navigation addon may use this function to provide users with progress updates for quests that involve traveling to specific locations. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md b/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md deleted file mode 100644 index 9370515e..00000000 --- a/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftMinutes.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_TaskQuest.GetQuestTimeLeftSeconds - -**Content:** -Returns the time left for a quest. -```lua -secondsLeft = C_TaskQuest.GetQuestTimeLeftSeconds(questID) -minutesLeft = C_TaskQuest.GetQuestTimeLeftMinutes(questID) -``` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- **GetQuestTimeLeftSeconds:** - - `secondsLeft` - - *number* - time left in seconds. - -- **GetQuestTimeLeftMinutes:** - - `minutesLeft` - - *number* - time left in minutes. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md b/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md deleted file mode 100644 index 9370515e..00000000 --- a/wiki-information/functions/C_TaskQuest.GetQuestTimeLeftSeconds.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_TaskQuest.GetQuestTimeLeftSeconds - -**Content:** -Returns the time left for a quest. -```lua -secondsLeft = C_TaskQuest.GetQuestTimeLeftSeconds(questID) -minutesLeft = C_TaskQuest.GetQuestTimeLeftMinutes(questID) -``` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- **GetQuestTimeLeftSeconds:** - - `secondsLeft` - - *number* - time left in seconds. - -- **GetQuestTimeLeftMinutes:** - - `minutesLeft` - - *number* - time left in minutes. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestZoneID.md b/wiki-information/functions/C_TaskQuest.GetQuestZoneID.md deleted file mode 100644 index 7e2010ff..00000000 --- a/wiki-information/functions/C_TaskQuest.GetQuestZoneID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_TaskQuest.GetQuestZoneID - -**Content:** -Needs summary. -`uiMapID = C_TaskQuest.GetQuestZoneID(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `uiMapID` - - *number* : UiMapID \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md b/wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md deleted file mode 100644 index 3e677dc4..00000000 --- a/wiki-information/functions/C_TaskQuest.GetQuestsForPlayerByMapID.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: C_TaskQuest.GetQuestsForPlayerByMapID - -**Content:** -Locates world quests, follower quests, and bonus objectives on a map. -`taskPOIs = C_TaskQuest.GetQuestsForPlayerByMapID(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `taskPOIs` - - *TaskPOIData* - - `Field` - - `Type` - - `Description` - - `questId` - - *number* - - `x` - - *number* - - `y` - - *number* - - `inProgress` - - *boolean* - - `numObjectives` - - *number* - - `mapID` - - *number* - - `isQuestStart` - - *boolean* - - `isDaily` - - *boolean* - - `isCombatAllyQuest` - - *boolean* - - `childDepth` - - *number?* - -**Reference:** -- `C_QuestLine.GetAvailableQuestLines()` \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetThreatQuests.md b/wiki-information/functions/C_TaskQuest.GetThreatQuests.md deleted file mode 100644 index cb21b552..00000000 --- a/wiki-information/functions/C_TaskQuest.GetThreatQuests.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_TaskQuest.GetThreatQuests - -**Content:** -Needs summary. -`quests = C_TaskQuest.GetThreatQuests()` - -**Returns:** -- `quests` - - *number* - -**Description:** -This function retrieves the list of threat quests available. Threat quests are typically world quests that have a higher level of difficulty or importance. - -**Example Usage:** -```lua -local threatQuests = C_TaskQuest.GetThreatQuests() -for _, questID in ipairs(threatQuests) do - print("Threat Quest ID:", questID) -end -``` - -**Addons:** -Large addons like World Quest Tracker may use this function to display or track threat quests separately from regular world quests, providing players with information on more challenging or significant quests available in the game world. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md b/wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md deleted file mode 100644 index 5920741c..00000000 --- a/wiki-information/functions/C_TaskQuest.GetUIWidgetSetIDFromQuestID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_TaskQuest.GetUIWidgetSetIDFromQuestID - -**Content:** -Needs summary. -`UiWidgetSetID = C_TaskQuest.GetUIWidgetSetIDFromQuestID(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `UiWidgetSetID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.IsActive.md b/wiki-information/functions/C_TaskQuest.IsActive.md deleted file mode 100644 index 824fb7f7..00000000 --- a/wiki-information/functions/C_TaskQuest.IsActive.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_TaskQuest.IsActive - -**Content:** -Needs summary. -`active = C_TaskQuest.IsActive(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `active` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific task quest is currently active. For instance, an addon that tracks world quests might use this function to determine if a particular world quest is available for the player. - -**Addon Usage:** -Large addons like World Quest Tracker use this function to filter and display only the active world quests on the map, providing players with up-to-date information on available quests. \ No newline at end of file diff --git a/wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md b/wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md deleted file mode 100644 index 860a7061..00000000 --- a/wiki-information/functions/C_TaskQuest.RequestPreloadRewardData.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_TaskQuest.RequestPreloadRewardData - -**Content:** -Needs summary. -`C_TaskQuest.RequestPreloadRewardData(questID)` - -**Parameters:** -- `questID` - - *number* - Unique QuestID for the quest to be queried. \ No newline at end of file diff --git a/wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md b/wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md deleted file mode 100644 index 47d31306..00000000 --- a/wiki-information/functions/C_TaxiMap.GetAllTaxiNodes.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: C_TaxiMap.GetAllTaxiNodes - -**Content:** -Returns information on taxi nodes at the current flight master. -`taxiNodes = C_TaxiMap.GetAllTaxiNodes(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `taxiNodes` - - *TaxiNodeInfo* - - `Field` - - `Type` - - `Description` - - `nodeID` - - *number* - - `position` - - *vector2* - - `name` - - *string* - - `state` - - *Enum.FlightPathState* - - `slotIndex` - - *number* - - `textureKit` - - *string* - textureKit - - `useSpecialIcon` - - *boolean* - - `specialIconCostString` - - *string?* - - `isMapLayerTransition` - - *boolean* - -**Enum.FlightPathState:** -- `Value` -- `Field` -- `Description` - - `0` - - Current - - `1` - - Reachable - - `2` - - Unreachable \ No newline at end of file diff --git a/wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md b/wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md deleted file mode 100644 index cfa062b0..00000000 --- a/wiki-information/functions/C_TaxiMap.GetTaxiNodesForMap.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_TaxiMap.GetTaxiNodesForMap - -**Content:** -Returns information on taxi nodes for a given map, without considering the current flight master. -`mapTaxiNodes = C_TaxiMap.GetTaxiNodesForMap(uiMapID)` - -**Parameters:** -- `uiMapID` - - *number* - UiMapID - -**Returns:** -- `mapTaxiNodes` - - *MapTaxiNodeInfo* - - `Field` - - `Type` - - `Description` - - `nodeID` - - *number* - - `position` - - *Vector2DMixin* - - `name` - - *string* - - `atlasName` - - *string* - AtlasID - - `faction` - - *Enum.FlightPathFaction* - - `textureKit` - - *string* - -**Enum.FlightPathFaction Values:** -- `Field` -- `Description` -- `0` - - Neutral -- `1` - - Horde -- `2` - - Alliance \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.ClearTitleIconTexture.md b/wiki-information/functions/C_Texture.ClearTitleIconTexture.md deleted file mode 100644 index f8d37fa9..00000000 --- a/wiki-information/functions/C_Texture.ClearTitleIconTexture.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Texture.ClearTitleIconTexture - -**Content:** -Needs summary. -`C_Texture.ClearTitleIconTexture(texture)` - -**Parameters:** -- `texture` - - *Texture* \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetAtlasElementID.md b/wiki-information/functions/C_Texture.GetAtlasElementID.md deleted file mode 100644 index 630813de..00000000 --- a/wiki-information/functions/C_Texture.GetAtlasElementID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Texture.GetAtlasElementID - -**Content:** -Needs summary. -`elementID = C_Texture.GetAtlasElementID(atlas)` - -**Parameters:** -- `atlas` - - *string* - textureAtlas - -**Returns:** -- `elementID` - - *number* - -**Example Usage:** -This function can be used to retrieve the element ID of a specific texture atlas. This is useful in scenarios where you need to manipulate or reference specific elements within a texture atlas. - -**Addon Usage:** -Large addons like WeakAuras might use this function to dynamically reference and manipulate texture elements for custom visual effects and UI elements. \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetAtlasID.md b/wiki-information/functions/C_Texture.GetAtlasID.md deleted file mode 100644 index 667b43d3..00000000 --- a/wiki-information/functions/C_Texture.GetAtlasID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Texture.GetAtlasID - -**Content:** -Needs summary. -`atlasID = C_Texture.GetAtlasID(atlas)` - -**Parameters:** -- `atlas` - - *string* - textureAtlas - -**Returns:** -- `atlasID` - - *number* - -**Example Usage:** -This function can be used to retrieve the unique ID of a texture atlas, which can be useful for managing and referencing textures in your addon. - -**Addons Using This Function:** -Large addons like WeakAuras might use this function to dynamically reference and manage texture atlases for custom visual effects. \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetAtlasInfo.md b/wiki-information/functions/C_Texture.GetAtlasInfo.md deleted file mode 100644 index 78d7fd60..00000000 --- a/wiki-information/functions/C_Texture.GetAtlasInfo.md +++ /dev/null @@ -1,71 +0,0 @@ -## Title: C_Texture.GetAtlasInfo - -**Content:** -Returns atlas info. -`info = C_Texture.GetAtlasInfo(atlas)` - -**Parameters:** -- `atlas` - - *string* - Name of the atlas - -**Returns:** -- `info` - - *AtlasInfo* - - `Field` - - `Type` - - `Description` - - `width` - - *number* - - `height` - - *number* - - `rawSize` - - *vector2* - - `leftTexCoord` - - *number* - - `rightTexCoord` - - *number* - - `topTexCoord` - - *number* - - `bottomTexCoord` - - *number* - - `tilesHorizontally` - - *boolean* - - `tilesVertically` - - *boolean* - - `file` - - *number?* - FileID of parent texture - - `filename` - - *string?* - - `sliceData` - - *UITextureSliceData?* - - `UITextureSliceData` - - `Field` - - `Type` - - `Description` - - `marginLeft` - - *number* - - `marginTop` - - *number* - - `marginRight` - - *number* - - `marginBottom` - - *number* - - `sliceMode` - - *Enum.UITextureSliceMode* - - `Enum.UITextureSliceMode` - - `Value` - - `Field` - - `Description` - - `0` - - Stretched - - Default - - `1` - - Tiled - -**Reference:** -- `Texture:GetAtlas()` -- `Texture:SetAtlas()` -- `UI CreateAtlasMarkup` - Returns an inline fontstring texture from an atlas -- `Helix/AtlasInfo.lua` - Lua table containing atlas info -- `UiTextureAtlasMember.db2` - DBC for atlases -- `Texture Atlas Viewer` - Addon for browsing atlases in-game \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md b/wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md deleted file mode 100644 index d7397891..00000000 --- a/wiki-information/functions/C_Texture.GetFilenameFromFileDataID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Texture.GetFilenameFromFileDataID - -**Content:** -Returns a string representing a file ID. -`filename = C_Texture.GetFilenameFromFileDataID(fileDataID)` - -**Parameters:** -- `fileDataID` - - *number* - The file ID to query. - -**Returns:** -- `filename` - - *string* - A string of the form "FileData ID {fileDataID}". - -**Description:** -This appears to mirror the return value of `TextureBase:GetTextureFilePath`. \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.GetTitleIconTexture.md b/wiki-information/functions/C_Texture.GetTitleIconTexture.md deleted file mode 100644 index f26d5d79..00000000 --- a/wiki-information/functions/C_Texture.GetTitleIconTexture.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_Texture.GetTitleIconTexture - -**Content:** -Needs summary. -`C_Texture.GetTitleIconTexture(titleID, version, callback)` - -**Parameters:** -- `titleID` - - *string* -- `version` - - *Enum.TitleIconVersion* - - `Value` - - `Field` - - `Description` - - `0` - - Small - - `1` - - Medium - - `2` - - Large -- `callback` - - *function : GetTitleIconTextureCallback* - - `Param` - - `Type` - - `Description` - - `1` - - success - - *boolean* - - `2` - - texture - - *number : fileID* \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.IsTitleIconTextureReady.md b/wiki-information/functions/C_Texture.IsTitleIconTextureReady.md deleted file mode 100644 index 4dff0bfa..00000000 --- a/wiki-information/functions/C_Texture.IsTitleIconTextureReady.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_Texture.IsTitleIconTextureReady - -**Content:** -Needs summary. -`ready = C_Texture.IsTitleIconTextureReady(titleID, version)` - -**Parameters:** -- `titleID` - - *string* -- `version` - - *Enum.TitleIconVersion* - - `Value` - - `Field` - - `Description` - - `0` - - Small - - `1` - - Medium - - `2` - - Large - -**Returns:** -- `ready` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Texture.SetTitleIconTexture.md b/wiki-information/functions/C_Texture.SetTitleIconTexture.md deleted file mode 100644 index 0c69aacd..00000000 --- a/wiki-information/functions/C_Texture.SetTitleIconTexture.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_Texture.SetTitleIconTexture - -**Content:** -Needs summary. -`C_Texture.SetTitleIconTexture(texture, titleID, version)` - -**Parameters:** -- `texture` - - *Texture* -- `titleID` - - *string* -- `version` - - *Enum.TitleIconVersion* - - `Value` - - `Field` - - `Description` - - `0` - - Small - - `1` - - Medium - - `2` - - Large \ No newline at end of file diff --git a/wiki-information/functions/C_Timer.After.md b/wiki-information/functions/C_Timer.After.md deleted file mode 100644 index 8614725a..00000000 --- a/wiki-information/functions/C_Timer.After.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_Timer.After - -**Content:** -Schedules a timer. -`C_Timer.After(seconds, callback)` - -**Parameters:** -- `seconds` - - *number* - Time in seconds before the timer finishes. -- `callback` - - *function|FunctionContainer* - Callback function to run. - -**Usage:** -Prints "Hello" after 2.5 seconds. -```lua -/run C_Timer.After(2.5, function() print("Hello") end) -``` -RunNextFrame is a utility function with zero seconds delay. -```lua --- prints "hello" and then "world" -RunNextFrame(function() print("world") end) -print("hello") -``` - -**Description:** -With a duration of 0 ms, the earliest the callback will be called is on the next frame. -Timing accuracy is limited to the frame rate. -C_Timer.After() is generally more efficient than using an Animation or OnUpdate script. - -In most cases, initiating a second C_Timer is still going to be cheaper than using an Animation or OnUpdate. The issue here is that both Animation and OnUpdate calls have overhead that applies every frame while they are active. For OnUpdate, the overhead lies in the extra function call to Lua. For Animations, we’re doing work C-side that allows us to support smoothing, parallel animations, and animation propagation. In contrast, the new C_Timer system uses a standard heap implementation. It’s only doing work when the timer is created or destroyed (and even then, that work is fairly minimal). - -The one case where you’re better off not using the new C_Timer system is when you have a ticker with a very short period – something that’s going to fire every couple frames. For example, you have a ticker you want to fire every 0.05 seconds; you’re going to be best served by using an OnUpdate function (where about half the function calls will do something useful and half will just decrement the timer). \ No newline at end of file diff --git a/wiki-information/functions/C_Timer.NewTicker.md b/wiki-information/functions/C_Timer.NewTicker.md deleted file mode 100644 index 9d871bb8..00000000 --- a/wiki-information/functions/C_Timer.NewTicker.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: C_Timer.NewTimer - -**Content:** -Schedules a (repeating) timer that can be canceled. -`cbObject = C_Timer.NewTimer(seconds, callback)` -`cbObject = C_Timer.NewTicker(seconds, callback)` - -**Parameters:** -- `seconds` - - *number* - Time in seconds between each iteration. -- `callback` - - *function|FunctionContainer* - Callback function to run. -- `iterations` - - *number?* - Number of times to repeat, or indefinite if omitted. - -**Returns:** -- `cbObject` - - *userdata : FunctionContainer* - Timer handle with `:Cancel()` and `:IsCancelled()` methods. - -**Description:** -The callback function will be supplied a view of the timer handle (`cbObject`) when invoked. -The handle returned from the function and the one supplied to the callback are distinct objects that both reference a shared state. See the examples for more details. -`C_Timer.NewTimer()` has just a single iteration and is essentially the same as `C_Timer.NewTicker(duration, callback, 1)`. -Errors thrown inside a callback function will not halt the ticker. - -**Usage:** -- Schedules a repeating timer which runs 4 times. - ```lua - /run C_Timer.NewTicker(2.5, function() print(GetTime()) end, 4) - ``` -- Schedules a timer but cancels it right away. - ```lua - local myTimer = C_Timer.NewTimer(3, function() print("Hello") end) - print(myTimer:IsCancelled()) -- false - myTimer:Cancel() - print(myTimer:IsCancelled()) -- true - ``` -- Schedules a timer that prints a value written to a field stored on the timer handle itself. Timer handles all reference the same shared state internally, so user-defined fields written to handles can be used to supply additional data for use by the callback. - ```lua - local myTimer = C_Timer.NewTimer(2.5, function(self) print("self.data is:", self.data) end) - myTimer.data = GetTime() - ``` -- Schedules a repeating timer which runs 4 times and prints the timer handle returned from the function and supplied to the callback. Note that each print will result in a different object address being displayed, indicating the timer handles have a distinct identity. - ```lua - /run print(C_Timer.NewTicker(0.25, function(self) print(self) end, 4)) - ``` - -**Reference:** -- AceTimer-3.0 -- OnUpdate \ No newline at end of file diff --git a/wiki-information/functions/C_Timer.NewTimer.md b/wiki-information/functions/C_Timer.NewTimer.md deleted file mode 100644 index acffd4fb..00000000 --- a/wiki-information/functions/C_Timer.NewTimer.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: C_Timer.NewTimer - -**Content:** -Schedules a (repeating) timer that can be canceled. -`cbObject = C_Timer.NewTimer(seconds, callback)` -`cbObject = C_Timer.NewTicker(seconds, callback)` - -**Parameters:** -- `seconds` - - *number* - Time in seconds between each iteration. -- `callback` - - *function|FunctionContainer* - Callback function to run. -- `iterations` - - *number?* - Number of times to repeat, or indefinite if omitted. - -**Returns:** -- `cbObject` - - *userdata : FunctionContainer* - Timer handle with `:Cancel()` and `:IsCancelled()` methods. - -**Description:** -The callback function will be supplied a view of the timer handle (`cbObject`) when invoked. -The handle returned from the function and the one supplied to the callback are distinct objects that both reference a shared state. See the examples for more details. -`C_Timer.NewTimer()` has just a single iteration and is essentially the same as `C_Timer.NewTicker(duration, callback, 1)` -Errors thrown inside a callback function will not halt the ticker. - -**Usage:** -- Schedules a repeating timer which runs 4 times. - ```lua - /run C_Timer.NewTicker(2.5, function() print(GetTime()) end, 4) - ``` -- Schedules a timer but cancels it right away. - ```lua - local myTimer = C_Timer.NewTimer(3, function() print("Hello") end) - print(myTimer:IsCancelled()) -- false - myTimer:Cancel() - print(myTimer:IsCancelled()) -- true - ``` -- Schedules a timer that prints a value written to a field stored on the timer handle itself. Timer handles all reference the same shared state internally, so user-defined fields written to handles can be used to supply additional data for use by the callback. - ```lua - local myTimer = C_Timer.NewTimer(2.5, function(self) print("self.data is:", self.data) end) - myTimer.data = GetTime() - ``` -- Schedules a repeating timer which runs 4 times and prints the timer handle returned from the function and supplied to the callback. Note that each print will result in a different object address being displayed, indicating the timer handles have a distinct identity. - ```lua - /run print(C_Timer.NewTicker(0.25, function(self) print(self) end, 4)) - ``` - -**Reference:** -- AceTimer-3.0 -- OnUpdate \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetNumToys.md b/wiki-information/functions/C_ToyBox.GetNumToys.md deleted file mode 100644 index a0a3da28..00000000 --- a/wiki-information/functions/C_ToyBox.GetNumToys.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ToyBox.GetNumToys - -**Content:** -Returns the total amount of toys. -`numToys = C_ToyBox.GetNumToys()` - -**Returns:** -- `numToys` - - *number* - The amount of toys in the game; this is not affected by the toy box filter. \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetToyFromIndex.md b/wiki-information/functions/C_ToyBox.GetToyFromIndex.md deleted file mode 100644 index 4959878b..00000000 --- a/wiki-information/functions/C_ToyBox.GetToyFromIndex.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ToyBox.GetToyFromIndex - -**Content:** -Returns a toy by index. -`itemID = C_ToyBox.GetToyFromIndex(index)` - -**Parameters:** -- `index` - - *number* - Ranging from 1 to `C_ToyBox.GetNumFilteredToys`. - -**Returns:** -- `itemID` - - *number* - The Item ID of the toy. Returns -1 if the index is invalid. \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetToyInfo.md b/wiki-information/functions/C_ToyBox.GetToyInfo.md deleted file mode 100644 index 07398638..00000000 --- a/wiki-information/functions/C_ToyBox.GetToyInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_ToyBox.GetToyInfo - -**Content:** -Returns toy info. -`itemID, toyName, icon, isFavorite, hasFanfare, itemQuality = C_ToyBox.GetToyInfo(itemID)` - -**Parameters:** -- `itemID` - - *number* - The itemID returned from `C_ToyBox.GetToyFromIndex()`; possible values listed at ToyID. - -**Returns:** -- `itemID` - - *number* - The Item ID of the toy. -- `toyName` - - *string* - The name of the toy. -- `icon` - - *number* - The icon texture (FileID). -- `isFavorite` - - *boolean* - Whether the toy is set to favorite. -- `hasFanfare` - - *boolean* - Shows a highlight for the toy. -- `itemQuality` - - *Enum.ItemQuality* \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBox.GetToyLink.md b/wiki-information/functions/C_ToyBox.GetToyLink.md deleted file mode 100644 index cfbbda2b..00000000 --- a/wiki-information/functions/C_ToyBox.GetToyLink.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ToyBox.GetToyLink - -**Content:** -Returns the item link for a toy. -`C_ToyBox.GetToyLink(itemID)` - -**Parameters:** -- `itemID` - - *number* - Numeric ID of the item. - -**Returns:** -- `itemLink` - - *string?* - The toy's localized itemLink, or nil if that itemID is not a toy. - -**External Resources:** -- GitHub FrameXML -- GetheGlobe "wut?" Tool -- Townlong-YakBlizzard API Docs -- Townlong-YakOffline /api addon -- MrBuds \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md b/wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md deleted file mode 100644 index a8d035f2..00000000 --- a/wiki-information/functions/C_ToyBoxInfo.ClearFanfare.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_ToyBoxInfo.ClearFanfare - -**Content:** -Clears a fanfare for a toy. -`C_ToyBoxInfo.ClearFanfare(itemID)` - -**Parameters:** -- `itemID` - - *number* - The ID of the toy item to clear the fanfare for. \ No newline at end of file diff --git a/wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md b/wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md deleted file mode 100644 index b794e487..00000000 --- a/wiki-information/functions/C_ToyBoxInfo.NeedsFanfare.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ToyBoxInfo.NeedsFanfare - -**Content:** -Returns whether a toy needs a fanfare. -`needsFanfare = C_ToyBoxInfo.NeedsFanfare(itemID)` - -**Parameters:** -- `itemID` - - *number* - -**Returns:** -- `needsFanfare` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CanPurchaseRank.md b/wiki-information/functions/C_Traits.CanPurchaseRank.md deleted file mode 100644 index d55a4250..00000000 --- a/wiki-information/functions/C_Traits.CanPurchaseRank.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_Traits.CanPurchaseRank - -**Content:** -Checks whether a node entry is purchasable. -`canPurchase = C_Traits.CanPurchaseRank(configID, nodeID, nodeEntryID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* -- `nodeEntryID` - - *number* - -**Returns:** -- `canPurchase` - - *boolean* - -**Description:** -There is generally little value in calling this API, instead, you can call `C_Traits.PurchaseRank` or `C_Traits.SetSelection` directly, and check their return values. -Currently, the default UI only uses this API for profession nodes, to check whether unlocking a node, or spending points on the node is possible, and not for generic talents or class talents. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CanRefundRank.md b/wiki-information/functions/C_Traits.CanRefundRank.md deleted file mode 100644 index f1c85b13..00000000 --- a/wiki-information/functions/C_Traits.CanRefundRank.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Traits.CanRefundRank - -**Content:** -Needs summary. -`canRefund = C_Traits.CanRefundRank(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* - -**Returns:** -- `canRefund` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md b/wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md deleted file mode 100644 index 894cf80e..00000000 --- a/wiki-information/functions/C_Traits.CascadeRepurchaseRanks.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Traits.CascadeRepurchaseRanks - -**Content:** -Needs summary. -`success = C_Traits.CascadeRepurchaseRanks(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* - -**Returns:** -- `success` - - *boolean* - diff --git a/wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md b/wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md deleted file mode 100644 index 7c165970..00000000 --- a/wiki-information/functions/C_Traits.ClearCascadeRepurchaseHistory.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Traits.ClearCascadeRepurchaseHistory - -**Content:** -Needs summary. -`C_Traits.ClearCascadeRepurchaseHistory(configID)` - -**Parameters:** -- `configID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.CommitConfig.md b/wiki-information/functions/C_Traits.CommitConfig.md deleted file mode 100644 index 5bdb7363..00000000 --- a/wiki-information/functions/C_Traits.CommitConfig.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_Traits.CommitConfig - -**Content:** -Applies any pending changes to talents. -`success = C_Traits.CommitConfig(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Reference:** -C_ClassTalents.CommitConfig should be used instead, when committing talent tree talents. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.ConfigHasStagedChanges.md b/wiki-information/functions/C_Traits.ConfigHasStagedChanges.md deleted file mode 100644 index d16d1433..00000000 --- a/wiki-information/functions/C_Traits.ConfigHasStagedChanges.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Traits.ConfigHasStagedChanges - -**Content:** -Needs summary. -`hasChanges = C_Traits.ConfigHasStagedChanges(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `hasChanges` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GenerateImportString.md b/wiki-information/functions/C_Traits.GenerateImportString.md deleted file mode 100644 index 15132c4d..00000000 --- a/wiki-information/functions/C_Traits.GenerateImportString.md +++ /dev/null @@ -1,62 +0,0 @@ -## Title: C_Traits.GenerateImportString - -**Content:** -Generate a talent loadout string for a given loadout -`importString = C_Traits.GenerateImportString(configID)` - -**Parameters:** -- `configID` - - *number* - a talent loadout, e.g. from `C_ClassTalents.GetConfigIDsBySpecID` or simply `C_ClassTalents.GetActiveConfigID`. - -**Returns:** -- `importString` - - *string* - a talent loadout string, which can be used to import the loadout, can be sent to a friend, or used on external websites. An empty string is returned if the client can't find data for the loadout. - -**Description:** -No data is available until the first `TRAIT_CONFIG_LIST_UPDATED`. When reloading UI, data is available immediately. -This API works only for talent loadouts for the current character, but it does work for other specs. The returned string can be used in the Talent Tree UI to import the loadout, and its format has been documented by Blizzard in `Blizzard_ClassTalentImportExport.lua`. - -It's important to note that if you use this API with a loadout outside your current spec, the Specialization ID in the header will be incorrect, since that will always reflect your current spec instead. So you may want to change the header with code like this: - -```lua --- note: this example is made for Serialization Version 1 specifically, and if Blizzard updates the format, this may no longer work -local bitWidthHeaderVersion = 8; -local bitWidthHeaderSpecID = 16; - -local function fixLoadoutString(loadoutString, specID) - local exportStream = ExportUtil.MakeExportDataStream(); - local importStream = ExportUtil.MakeImportDataStream(loadoutString); - - if importStream:ExtractValue(bitWidthHeaderVersion) ~= 1 then - return nil; -- only version 1 is supported - end - - local headerSpecID = importStream:ExtractValue(bitWidthHeaderSpecID); - if headerSpecID == specID then - return loadoutString; -- no update needed - end - - exportStream:AddValue(bitWidthHeaderVersion, 1); - exportStream:AddValue(bitWidthHeaderSpecID, specID); - local remainingBits = importStream:GetNumberOfBits() - bitWidthHeaderVersion - bitWidthHeaderSpecID; - - -- copy the remaining bits in batches of 16 - while remainingBits > 0 do - local bitsToCopy = math.min(remainingBits, 16); - exportStream:AddValue(bitsToCopy, importStream:ExtractValue(bitsToCopy)); - remainingBits = remainingBits - bitsToCopy; - end - - return exportStream:GetExportString(); -end - -local spec = 62; -- assuming you're playing mage -local configID = C_ClassTalents.GetConfigIDsBySpecID(specID); -- assuming you have an arcane loadout -print(fixLoadoutString(C_Traits.GenerateImportString(configID), specID)) -``` - -**Example Usage:** -This function can be used to share talent loadouts with friends or to save and import loadouts from external websites. For instance, you can generate a loadout string for your current talent configuration and send it to a friend who can then import it into their game. - -**Addons:** -Many popular addons like WeakAuras and ElvUI use similar APIs to manage and share configurations. This specific API can be used by talent management addons to facilitate the sharing and importing of talent builds. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GenerateInspectImportString.md b/wiki-information/functions/C_Traits.GenerateInspectImportString.md deleted file mode 100644 index 3ad16bb5..00000000 --- a/wiki-information/functions/C_Traits.GenerateInspectImportString.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Traits.GenerateInspectImportString - -**Content:** -Returns a Talent Build String for an inspected target. -`importString = C_Traits.GenerateInspectImportString(target)` - -**Parameters:** -- `target` - - *string* : UnitId - For example "target" - -**Returns:** -- `importString` - - *string* - the Talent Build String, or an empty string if inspect information is not available - -**Description:** -You must first inspect a player before this API returns any data. After inspecting, you should use `C_Traits.HasValidInspectData` to confirm valid inspect data is available to the client. - -**Reference:** -`C_Traits.GenerateImportString` to retrieve Talent Build Strings for the current player character. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConditionInfo.md b/wiki-information/functions/C_Traits.GetConditionInfo.md deleted file mode 100644 index 8ac1931e..00000000 --- a/wiki-information/functions/C_Traits.GetConditionInfo.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: C_Traits.GetConditionInfo - -**Content:** -Returns conditionInfo applicable to the configID you enter -`condInfo = C_Traits.GetConditionInfo(configID, condID)` - -**Parameters:** -- `configID` - - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. -- `condID` - - *number* - trait conditionId as found in e.g. `C_Traits.GetNodeInfo` or `C_Traits.GetEntryInfo` - -**Returns:** -- `condInfo` - - *TraitCondInfo* - returns nil if no info is found - - `Field` - - `Type` - - `Description` - - `condID` - - *number* - as supplied in the arguments - - `ranksGranted` - - *number?* - if the condition is met, this number of ranks is granted to applicable nodes - - `isAlwaysMet` - - *boolean* - generally false, no TraitConditions are currently used where this is true - - `isMet` - - *boolean* - whether the condition is met - - `isGate` - - *boolean* - whether the condition is a Gate - this generally only impacts tooltips and class talent trees - - `questID` - - *number?* - no conditions seem to currently exist with this value - presumably these would require a quest to be completed; or, less likely, require the quest to be in your questlog - - `achievementID` - - *number?* - condition is met if the achievement has been earned - - `specSetID` - - *number?* - condition is met if your spec matches any spec from the specified specSet (see `C_SpecializationInfo.GetSpecIDs`) - - `playerLevel` - - *number?* - condition is met if you are at or above the specified level - - `traitCurrencyID` - - *number?* - combined with spentAmountRequired - matches the ID in TraitCurrencyCost (see `C_Traits.GetNodeCost`, and `C_Traits.GetTreeCurrencyInfo`) - - `spentAmountRequired` - - *number?* - condition is met if you spent the specified amount in the specified traitCurrency - - `tooltipFormat` - - *string?* - a tooltip string, potentially with placeholders suitable for `string.format`, which can be displayed if the condition isn't met - - `tooltipText` - - *string?* - Blizzard_SharedTalentUI adds this data to the response manually, see `Blizzard_SharedTalentUtil.lua`; the data is based on tooltipFormat, and adds quest/achievement/spec/level/spending info - -**Description:** -Trait conditions have specific types. These types are not exposed in the API, but an enum is documented (`Enum.TraitConditionType`). -Conditions broadly fall into 2 categories, 'Friendly' and 'NotFriendly'. Friendly conditions give benefits, while NotFriendly conditions impose restrictions. - -**Enum.TraitConditionType:** -- `Value` -- `Field` -- `Category` -- `Description` - - `0` - - `Available` - - `NotFriendly` - - Nodes are available by default, but if any condition of this type is not met, then the node is not available - e.g. Gates are implemented this way - - `1` - - `Visible` - - `NotFriendly` - - Nodes are visible by default, but if any condition of this type is not met, then the node is not visible - e.g. if a condition requires a specific spec, the node will be hidden - - `2` - - `Granted` - - `Friendly` - - Grants rank(s) for the relevant node - - `3` - - `Increased` - - `Friendly` - - No condition of this type currently exists, presumably they work similar to Granted \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigIDBySystemID.md b/wiki-information/functions/C_Traits.GetConfigIDBySystemID.md deleted file mode 100644 index 95bd2fc9..00000000 --- a/wiki-information/functions/C_Traits.GetConfigIDBySystemID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Traits.GetConfigIDBySystemID - -**Content:** -Needs summary. -`configID = C_Traits.GetConfigIDBySystemID(systemID)` - -**Parameters:** -- `systemID` - - *number* - The systems are defined in TraitSystem.db2. E.g. Dragonriding is 1 - -**Returns:** -- `configID` - - *number* - -**Example Usage:** -This function can be used to retrieve the configuration ID for a specific trait system. For instance, if you want to get the configuration ID for the Dragonriding system, you would call this function with the systemID corresponding to Dragonriding. - -**Addons:** -Large addons that manage or display trait systems, such as talent tree managers or custom UI enhancements, might use this function to dynamically load and display the correct configuration for different systems. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigIDByTreeID.md b/wiki-information/functions/C_Traits.GetConfigIDByTreeID.md deleted file mode 100644 index 05db24fa..00000000 --- a/wiki-information/functions/C_Traits.GetConfigIDByTreeID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Traits.GetConfigIDByTreeID - -**Content:** -Used for "Generic Trait" trees, such as dragonflying talents. Not used for player talent trees. -`configID = C_Traits.GetConfigIDByTreeID(treeID)` - -**Parameters:** -- `treeID` - - *number* - -**Returns:** -- `configID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigInfo.md b/wiki-information/functions/C_Traits.GetConfigInfo.md deleted file mode 100644 index 763a4f65..00000000 --- a/wiki-information/functions/C_Traits.GetConfigInfo.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: C_Traits.GetConfigInfo - -**Content:** -Needs summary. -`configInfo = C_Traits.GetConfigInfo(configID)` - -**Parameters:** -- `configID` - - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. - -**Returns:** -- `configInfo` - - *TraitConfigInfo* - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - ConfigID - - `type` - - *Enum.TraitConfigType* - - `name` - - *string* - E.g. talent loadout name - - `treeIDs` - - *number* - Can be used in e.g. `C_Traits.GetTreeNodes` or `C_Traits.GetTreeInfo` - - `usesSharedActionBars` - - *boolean* - Whether the talent loadout uses shared/global action bar setup, or loadout specific setup - -**Enum.TraitConfigType:** -- `Value` -- `Field` -- `Description` - - `0` - - Invalid - - `1` - - Combat - - Talent Tree - - `2` - - Profession - - Profession Specialization - - `3` - - Generic - - E.g. Dragon Riding talents \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetConfigsByType.md b/wiki-information/functions/C_Traits.GetConfigsByType.md deleted file mode 100644 index 459a4d32..00000000 --- a/wiki-information/functions/C_Traits.GetConfigsByType.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Traits.GetConfigsByType - -**Content:** -Needs summary. -`configIDs = C_Traits.GetConfigsByType(configType)` - -**Parameters:** -- `configType` - - *Enum.TraitConfigType* - - `Value` - - `Field` - - `Description` - - `0` - Invalid - - `1` - Combat (Talent Tree) - - `2` - Profession (Profession Specialization) - - `3` - Generic (E.g. Dragon Riding talents) - -**Returns:** -- `configIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetDefinitionInfo.md b/wiki-information/functions/C_Traits.GetDefinitionInfo.md deleted file mode 100644 index cfb87350..00000000 --- a/wiki-information/functions/C_Traits.GetDefinitionInfo.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: C_Traits.GetDefinitionInfo - -**Content:** -Needs summary. -`definitionInfo = C_Traits.GetDefinitionInfo(definitionID)` - -**Parameters:** -- `definitionID` - - *number* - -**Returns:** -- `definitionInfo` - - *TraitDefinitionInfo* - - `Field` - - `Type` - - `Description` - - `spellID` - - *number?* - - `overrideName` - - *string?* - - `overrideSubtext` - - *string?* - - `overrideDescription` - - *string?* - - `overrideIcon` - - *number?* - - `overriddenSpellID` - - *number?* - - `subType` - - *Enum.TraitDefinitionSubType?* - - **Enum.TraitDefinitionSubType** - - `Value` - - `Field` - - `Description` - - `0` - - DragonflightRed - - `1` - - DragonflightBlue - - `2` - - DragonflightGreen - - `3` - - DragonflightBronze - - `4` - - DragonflightBlack \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetEntryInfo.md b/wiki-information/functions/C_Traits.GetEntryInfo.md deleted file mode 100644 index 8730bd4a..00000000 --- a/wiki-information/functions/C_Traits.GetEntryInfo.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_Traits.GetEntryInfo - -**Content:** -Needs summary. -`entryInfo = C_Traits.GetEntryInfo(configID, entryID)` - -**Parameters:** -- `configID` - - *number* -- `entryID` - - *number* - -**Returns:** -- `entryInfo` - - *TraitEntryInfo* - - `Field` - - `Type` - - `Description` - - `definitionID` - - *number* - - `type` - - *Enum.TraitNodeEntryType* - - `maxRanks` - - *number* - - `isAvailable` - - *boolean* - - `conditionIDs` - - *number* - -**Enum.TraitNodeEntryType Values:** -- `Field` -- `Description` -- `0` - - SpendHex -- `1` - - SpendSquare -- `2` - - SpendCircle -- `3` - - SpendSmallCircle -- `4` - - DeprecatedSelect -- `5` - - DragAndDrop -- `6` - - SpendDiamond -- `7` - - ProfPath -- `8` - - ProfPerk -- `9` - - ProfPathUnlock \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md b/wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md deleted file mode 100644 index ae0d3e61..00000000 --- a/wiki-information/functions/C_Traits.GetLoadoutSerializationVersion.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Traits.GetLoadoutSerializationVersion - -**Content:** -Returns the version of the Talent Build String format. -`serializationVersion = C_Traits.GetLoadoutSerializationVersion()` - -**Returns:** -- `serializationVersion` - - *number* - -**Description:** -The Talent Build String is encoded with a header, this header contains the version of the format. If the build string's version doesn't match the return from this API, the game will not attempt to parse the string any further. -Currently, this is simply 1, it is assumed that Blizzard will increase the version number to 2 if they make any changes to the format of their Talent Build Strings. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetNodeCost.md b/wiki-information/functions/C_Traits.GetNodeCost.md deleted file mode 100644 index 97f9e2ed..00000000 --- a/wiki-information/functions/C_Traits.GetNodeCost.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: C_Traits.GetNodeCost - -**Content:** -Needs summary. -`costs = C_Traits.GetNodeCost(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* - -**Returns:** -- `costs` - - *TraitCurrencyCost* - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - TraitCurrencyID, see `C_Traits.GetTraitCurrencyInfo` and `C_Traits.GetTreeCurrencyInfo` - - `amount` - - *number* - the amount of TraitCurrency a given node/entry costs \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetNodeInfo.md b/wiki-information/functions/C_Traits.GetNodeInfo.md deleted file mode 100644 index bf72ab39..00000000 --- a/wiki-information/functions/C_Traits.GetNodeInfo.md +++ /dev/null @@ -1,121 +0,0 @@ -## Title: C_Traits.GetNodeInfo - -**Content:** -Returns NodeInfo applicable to the configID you enter. -`nodeInfo = C_Traits.GetNodeInfo(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. -- `nodeID` - - *number* - e.g. from `C_Traits.GetTreeNodes` - -**Returns:** -- `nodeInfo` - - *TraitNodeInfo?* - if the configID is not valid, returns nil. If information for a node cannot be retrieved for another reason, all fields are zeroed out. Most information relates to your current preview state, unless otherwise specified - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - nodeID, 0 if node information isn't available to you - - `posX` - - *number* - X offset relative to the top-left corner of the UI, some class talent trees have an additional global offset - - `posY` - - *number* - Y offset relative to the top-left corner of the UI, some class talent trees have an additional global offset - - `flags` - - *number* - &1: ShowMultipleIcons - generally 0 for regular nodes, 1 for choice nodes - - `entryIDs` - - *number* - List of entryIDs - generally there is 1 for regular nodes, 2 for choice nodes; used in `C_Traits.GetEntryInfo` - - `entryIDsWithCommittedRanks` - - *number* - Committed entryIDs, which can be different from the preview state. E.g. moving talents/traits around, without pressing the confirm button, will not change this value - - `canPurchaseRank` - - *boolean* - False if you already have the max ranks purchased / granted; true otherwise - - `canRefundRank` - - *boolean* - False if you purchased 0 ranks; true otherwise - - `isAvailable` - - *boolean* - False if not available due to Gates (i.e. you may need to spend x more points to unlock a new row of traits/talents) - - `isVisible` - - *boolean* - False if a node should not be shown in the UI, this generally only happens when all other info is zeroed out as well - - `ranksPurchased` - - *number* - Number of ranks purchased, automatically granted ranks do not count - - `activeRank` - - *number* - The current (preview) rank for the node - used to track if the node is maxed, or has progress; this can never be greater than maxRanks - - `currentRank` - - *number* - Similar to activeRank - used for tooltips and other texts; through bugs, it can be possible for this to be greater than maxRanks, seems to be the sum of GrantedRanks + PurchasedRanks - - `activeEntry` - - *TraitEntryRankInfo?* - The currently selected (preview) entry; if no entry is learned, regular nodes have an entry with rank 0, choice nodes have nil; the rank matches activeRank - - `nextEntry` - - *TraitEntryRankInfo?* - The next entry when spending a point; nil for choice nodes, or if maxed - - `maxRanks` - - *number* - Maximum ranks for a node, also applies to choice nodes - - `type` - - *Enum.TraitNodeType* - The type of node, has implications for how the API interacts with the node, and how the UI displays and interacts with the node - - `visibleEdges` - - *TraitOutEdgeInfo* - Outgoing connections for a node, filtered to only return edges with a visible target node - the UI displays these as arrows pointing towards other nodes - - `meetsEdgeRequirements` - - *boolean* - True if incoming edge requirements are met (see `Enum.TraitEdgeType`), or if there are no incoming edges (i.e. the initial nodes in a tree), false otherwise - the UI uses this to disable the node button - - `groupIDs` - - *number* - TraitNodeGroups are not generally exposed through the API, but they relate to how Gates work, TraitCurrency costs, TraitConditions, and possibly more - - `conditionIDs` - - *number* - Can be used for `C_Traits.GetConditionInfo` conditions can grant ranks, limit visibility to specs, set Gate requirements, and more - - `isCascadeRepurchasable` - - *boolean* - If true, you can shift-click to purchase back nodes that you previously had selected, but were deselected because you unlearned something higher up in the tree - - `cascadeRepurchaseEntryID` - - *number?* - TraitEntryRankInfo - - `Field` - - `Type` - - `Description` - - `entryID` - - *number* - As used in `C_Traits.GetEntryInfo` - - `rank` - - *number* - May be 0 for single choice nodes - -**Enum.TraitNodeType** -- `Value` -- `Field` -- `Description` -- `0` - - Single - The most common type, includes multi-rank traits and single-rank traits -- `1` - - Tiered - Unsure where this is used, but seems to result in the node and nodeEntry costs being combined in some way -- `2` - - Selection - Applies to all choice nodes, where you can select between multiple (generally 2) options - -**TraitOutEdgeInfo** -- `Field` -- `Type` -- `Description` -- `targetNode` - - *number* - The target nodeID -- `type` - - *Enum.TraitEdgeType* - Has implications on how meetsEdgeRequirements is calculated -- `visualStyle` - - *Enum.TraitEdgeVisualStyle* - Defines how the UI displays the edge -- `isActive` - - *boolean* - Active edges generally have a different visual, and meetsEdgeRequirements is calculated based on active incoming edges - -**Enum.TraitEdgeType** -- `Value` -- `Field` -- `Description` -- `0` - - VisualOnly - Simply results in a visual connection, has no impact on edge requirements -- `1` - - DeprecatedRankConnection - Presumably deprecated, and can be ignored -- `2` - - SufficientForAvailability - If any incoming edge of this type is active, all edges of this type pass the edge requirements -- `3` - - RequiredForAvailability - All incoming edges of this type must be active to pass the edge requirements -- `4` - - MutuallyExclusive - No edges of this type currently exist, but the UI does show a different visual effect - presumably, only 1 incoming edge if this type is allowed to be active, to pass the edge requirements -- `5` - - DeprecatedSelectionOption - Presumably deprecated, and can be ignored - -**Enum.TraitEdgeVisualStyle** -- `Value` -- `Field` -- `Description` -- `0` - - None - No edges of this type exist, presumably, they would not display in the UI -- `1` - - Straight - A simple straight arrow between nodes \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetStagedChangesCost.md b/wiki-information/functions/C_Traits.GetStagedChangesCost.md deleted file mode 100644 index 8bff095a..00000000 --- a/wiki-information/functions/C_Traits.GetStagedChangesCost.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Traits.GetStagedChangesCost - -**Content:** -Needs summary. -`costs = C_Traits.GetStagedChangesCost(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `costs` - - *TraitCurrencyCost* - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - TraitCurrencyID, see `C_Traits.GetTraitCurrencyInfo` and `C_Traits.GetTreeCurrencyInfo` - - `amount` - - *number* - the amount of TraitCurrency a given node/entry costs \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetStagedPurchases.md b/wiki-information/functions/C_Traits.GetStagedPurchases.md deleted file mode 100644 index 22460e5f..00000000 --- a/wiki-information/functions/C_Traits.GetStagedPurchases.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Traits.GetStagedPurchases - -**Content:** -Needs summary. -`nodeIDsWithPurchases = C_Traits.GetStagedPurchases(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `nodeIDsWithPurchases` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md b/wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md deleted file mode 100644 index 23e01b80..00000000 --- a/wiki-information/functions/C_Traits.GetTraitCurrencyInfo.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: C_Traits.GetTraitCurrencyInfo - -**Content:** -Returns meta information about a TraitCurrency. Use `C_Traits.GetTreeCurrencyInfo` if you're looking for TraitCurrency spent/available instead. -```lua -flags, type, currencyTypesID, icon = C_Traits.GetTraitCurrencyInfo(traitCurrencyID) -``` - -**Parameters:** -- `traitCurrencyID` - - *number* - -**Returns:** -- `flags` - - *number* - any combination of bit flags of `Enum.TraitCurrencyFlag` -- `type` - - *Enum.TraitCurrencyFlag* - indicates how the TraitCurrency is sourced -- `currencyTypesID` - - *number?* - CurrencyID, if non-empty, the TraitCurrency is directly linked to the specified Currency -- `icon` - - *number?* - IconID - -**Enum.TraitCurrencyFlag:** -- `Value` -- `Field` -- `Description` - - `0x1` - - `ShowQuantityAsSpent` - - Currently not used by any TraitCurrency - - `0x2` - - `TraitSourcedShowMax` - - Currently not used by any TraitCurrency - - `0x4` - - `UseClassIcon` - - Currently, all currencies with this flag are TalentTree class talent points - - `0x8` - - `UseSpecIcon` - - Currently, all currencies with this flag are TalentTree spec talent points - -**Enum.TraitCurrencyType:** -- `Value` -- `Field` -- `Description` - - `0` - - `Gold` - - Currency used is gold - - `1` - - `CurrencyTypesBased` - - TraitCurrencies of this type will spend regular CurrencyID, see `currencyTypesID` return value - - `2` - - `TraitSourced` - - This TraitCurrency can be earned through being above a certain level (e.g. for talent points), earning achievements (e.g. for some profession unlocks, or dragon riding), or by spending points in another TraitNode (e.g. profession unlocks). See `TraitCurrencySource.db2` \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitDescription.md b/wiki-information/functions/C_Traits.GetTraitDescription.md deleted file mode 100644 index f77e66a6..00000000 --- a/wiki-information/functions/C_Traits.GetTraitDescription.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_Traits.GetTraitDescription - -**Content:** -Needs summary. -`description = C_Traits.GetTraitDescription(entryID, rank)` - -**Parameters:** -- `entryID` - - *number* -- `rank` - - *number* - -**Returns:** -- `description` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitSystemFlags.md b/wiki-information/functions/C_Traits.GetTraitSystemFlags.md deleted file mode 100644 index f5745c9d..00000000 --- a/wiki-information/functions/C_Traits.GetTraitSystemFlags.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_Traits.GetTraitSystemFlags - -**Content:** -Returns flags for "Generic Trait" trees, such as dragonriding talents. Not related to player talent trees. -`flags = C_Traits.GetTraitSystemFlags(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `flags` - - *number* - See `Enum.TraitSystemFlag` - -**Description:** -This function is used to retrieve flags associated with generic trait systems, which are different from the player talent trees. An example of such a system is the dragonriding talents. The flags returned can be used to determine specific properties or states of the trait system. - -**Example Usage:** -```lua -local configID = 12345 -- Example config ID for a dragonriding talent tree -local flags = C_Traits.GetTraitSystemFlags(configID) -print(flags) -- Outputs the flags associated with the given config ID -``` - -**Addons:** -Large addons that manage or enhance talent systems, such as WeakAuras or ElvUI, might use this function to display or modify information related to generic trait systems like dragonriding talents. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md b/wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md deleted file mode 100644 index 6e0b4d31..00000000 --- a/wiki-information/functions/C_Traits.GetTraitSystemWidgetSetID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Traits.GetTraitSystemWidgetSetID - -**Content:** -Needs summary. -`uiWidgetSetID = C_Traits.GetTraitSystemWidgetSetID(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `uiWidgetSetID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md b/wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md deleted file mode 100644 index d9f1720a..00000000 --- a/wiki-information/functions/C_Traits.GetTreeCurrencyInfo.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_Traits.GetTreeCurrencyInfo - -**Content:** -Returns the list of TraitCurrencies related to a TraitTree. -`treeCurrencyInfo = C_Traits.GetTreeCurrencyInfo(configID, treeID, excludeStagedChanges)` - -**Parameters:** -- `configID` - - *number* - For TalentTrees this will often be `C_ClassTalents.GetActiveConfigID`, this is -1 when inspecting a player. For professions, this will be `C_ProfSpecs.GetConfigIDForSkillLine`. -- `treeID` - - *number* - For TalentTrees a class-specific TreeID, for professions `C_ProfSpecs.GetSpecTabIDsForSkillLine`. -- `excludeStagedChanges` - - *boolean* - If true, the committed value is returned; if false, the staged value is returned instead. - -**Returns:** -- `treeCurrencyInfo` - - *TreeCurrencyInfo* - For TalentTrees, the first currency returned is for the class points, the second currency is spec points. - - `Field` - - `Type` - - `Description` - - `traitCurrencyID` - - *number* - Can be used in e.g. `C_Traits.GetNodeCost` and `C_Traits.GetTraitCurrencyInfo` - - `quantity` - - *number* - How much currency is available to be used, e.g. available talent points, or profession knowledge. - - `maxQuantity` - - *number?* - For TalentTrees, the amount of points available at your current level. - - `spent` - - *number* - The amount of currency already spent on traits. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeHash.md b/wiki-information/functions/C_Traits.GetTreeHash.md deleted file mode 100644 index ad15e782..00000000 --- a/wiki-information/functions/C_Traits.GetTreeHash.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_Traits.GetTreeHash - -**Content:** -Get a checksum of the specified tree's structure. -`result = C_Traits.GetTreeHash(treeID)` - -**Parameters:** -- `treeID` - - *number* - -**Returns:** -- `result` - - *number* - 16 numbers between 1 and 256 - -**Description:** -The default UI uses this checksum to check whether a talent string was created based on a different talent layout. The hash can be expected to change if any talents are changed. -It's important to realize that the hash does not cover any player choices; its only purpose is to determine if a talent string corresponds to a valid tree. -Third-party websites will use a table with 16 zeroes instead, to disable this specific validation step. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeInfo.md b/wiki-information/functions/C_Traits.GetTreeInfo.md deleted file mode 100644 index 0fde3771..00000000 --- a/wiki-information/functions/C_Traits.GetTreeInfo.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_Traits.GetTreeInfo - -**Content:** -Needs summary. -`treeInfo = C_Traits.GetTreeInfo(configID, treeID)` - -**Parameters:** -- `configID` - - *number* -- `treeID` - - *number* - -**Returns:** -- `treeInfo` - - *TraitTreeInfo* - - `Field` - - `Type` - - `Description` - - `ID` - - *number* - - `gates` - - *TraitGateInfo* - - `hideSingleRankNumbers` - - *boolean* - -**TraitGateInfo** -- `Field` -- `Type` -- `Description` -- `topLeftNodeID` - - *number* -- `conditionID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.GetTreeNodes.md b/wiki-information/functions/C_Traits.GetTreeNodes.md deleted file mode 100644 index e0a7fb8d..00000000 --- a/wiki-information/functions/C_Traits.GetTreeNodes.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_Traits.GetTreeNodes - -**Content:** -Returns a list of nodeIDs for a given treeID. For talent trees, this contains nodes for all specializations of the tree's class. -`nodeIDs = C_Traits.GetTreeNodes(treeID)` - -**Parameters:** -- `treeID` - - *number* - e.g. from `C_Traits.GetConfigInfo` - -**Returns:** -- `nodeIDs` - - *number* - list of nodeIDs in ascending order, can be used in `C_Traits.GetNodeInfo` - -**Example Usage:** -This function can be used to retrieve all node IDs for a specific talent tree, which can then be further queried for detailed node information using `C_Traits.GetNodeInfo`. - -**Addons:** -Large addons like WeakAuras might use this function to dynamically display talent tree information and track changes in a player's talent configuration. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.HasValidInspectData.md b/wiki-information/functions/C_Traits.HasValidInspectData.md deleted file mode 100644 index 43840e5a..00000000 --- a/wiki-information/functions/C_Traits.HasValidInspectData.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Traits.HasValidInspectData - -**Content:** -Needs summary. -`hasValidInspectData = C_Traits.HasValidInspectData()` - -**Returns:** -- `hasValidInspectData` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.IsReadyForCommit.md b/wiki-information/functions/C_Traits.IsReadyForCommit.md deleted file mode 100644 index 891643df..00000000 --- a/wiki-information/functions/C_Traits.IsReadyForCommit.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_Traits.IsReadyForCommit - -**Content:** -Needs summary. -`isReadyForCommit = C_Traits.IsReadyForCommit()` - -**Returns:** -- `isReadyForCommit` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.PurchaseRank.md b/wiki-information/functions/C_Traits.PurchaseRank.md deleted file mode 100644 index ae68232f..00000000 --- a/wiki-information/functions/C_Traits.PurchaseRank.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_Traits.PurchaseRank - -**Content:** -Attempt to purchase a rank. Changes are not applied until they are committed (through `C_Traits.CommitConfig` or `C_ClassTalents.CommitConfig`). -`success = C_Traits.PurchaseRank(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Reference:** -`C_Traits.SetSelection` to purchase/select a Selection node. `C_Traits.PurchaseRank` should not be used with selection nodes (aka choice nodes). \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.RefundAllRanks.md b/wiki-information/functions/C_Traits.RefundAllRanks.md deleted file mode 100644 index c32d0eb6..00000000 --- a/wiki-information/functions/C_Traits.RefundAllRanks.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: C_Traits.RefundAllRanks - -**Content:** -Needs summary. -`success = C_Traits.RefundAllRanks(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Description:** -This function is used to refund all ranks for a specific node in a given configuration. It can be useful in scenarios where a player wants to reset their trait points and reallocate them differently. - -**Example Usage:** -```lua -local configID = 12345 -local nodeID = 67890 -local success = C_Traits.RefundAllRanks(configID, nodeID) -if success then - print("All ranks have been successfully refunded.") -else - print("Failed to refund ranks.") -end -``` - -**Addons Using This Function:** -- **WeakAuras**: This popular addon might use this function to allow players to reset their trait points and reconfigure their abilities based on different scenarios or encounters. -- **ElvUI**: Another widely used addon that could leverage this function to provide users with an easy way to reset and reallocate their trait points within the UI. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.RefundRank.md b/wiki-information/functions/C_Traits.RefundRank.md deleted file mode 100644 index 09ec240e..00000000 --- a/wiki-information/functions/C_Traits.RefundRank.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Traits.RefundRank - -**Content:** -Attempt to refund a rank. Changes are not applied until they are committed (through `C_Traits.CommitConfig` or `C_ClassTalents.CommitConfig`). -`success = C_Traits.RefundRank(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* -- `clearEdges` - - *boolean?* - if true, refunding the talent will refund all talents that no longer meet their requirements - -**Returns:** -- `success` - - *boolean* - -**Description:** -If you pass `clearEdges = true`, it's possible that refunding a node results in other nodes being refunded too. E.g. if you no longer meet a gate criterium, or if the node is the only path to a set of selected talents. - -**Reference:** -- `C_Traits.SetSelection` to unselect a Selection node. `C_Traits.RefundRank` must not be used with selection nodes (aka choice nodes). \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.ResetTree.md b/wiki-information/functions/C_Traits.ResetTree.md deleted file mode 100644 index 8692ac5a..00000000 --- a/wiki-information/functions/C_Traits.ResetTree.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: C_Traits.ResetTree - -**Content:** -Resets the tree, refunding any purchased traits where possible. The reset is not automatically saved, use `C_Traits.CommitConfig` for that. -`success = C_Traits.ResetTree(configID, treeID)` - -**Parameters:** -- `configID` - - *number* -- `treeID` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Description:** -This function is used to reset a talent tree, refunding any purchased traits. It is important to note that the reset is not automatically saved, so you must use `C_Traits.CommitConfig` to save the changes. - -**Example Usage:** -```lua -local configID = 12345 -local treeID = 67890 -local success = C_Traits.ResetTree(configID, treeID) -if success then - print("Tree reset successfully!") - C_Traits.CommitConfig(configID) -else - print("Failed to reset the tree.") -end -``` - -**Addons Using This Function:** -- **WeakAuras**: This popular addon uses `C_Traits.ResetTree` to manage and reset custom talent configurations for different encounters or scenarios. -- **ElvUI**: This comprehensive UI replacement addon may use this function to reset talent trees as part of its configuration management features. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.ResetTreeByCurrency.md b/wiki-information/functions/C_Traits.ResetTreeByCurrency.md deleted file mode 100644 index ac27cf7f..00000000 --- a/wiki-information/functions/C_Traits.ResetTreeByCurrency.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_Traits.ResetTreeByCurrency - -**Content:** -Resets the tree, refunding any purchased traits where possible, but only if the trait costs the specified traitCurrencyID. -`success = C_Traits.ResetTreeByCurrency(configID, treeID, traitCurrencyID)` - -**Parameters:** -- `configID` - - *number* -- `treeID` - - *number* -- `traitCurrencyID` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Description:** -This API is used to reset only class talents, or only spec talents, rather than resetting the entire tree with `C_Traits.ResetTree`. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.RollbackConfig.md b/wiki-information/functions/C_Traits.RollbackConfig.md deleted file mode 100644 index f8633151..00000000 --- a/wiki-information/functions/C_Traits.RollbackConfig.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_Traits.RollbackConfig - -**Content:** -Rolls back any pending changes to the trait config - reverting any unsaved changes. -`success = C_Traits.RollbackConfig(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `success` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.SetSelection.md b/wiki-information/functions/C_Traits.SetSelection.md deleted file mode 100644 index 05422770..00000000 --- a/wiki-information/functions/C_Traits.SetSelection.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: C_Traits.SetSelection - -**Content:** -Attempt to change the current selection for a selection node (aka choice node). Changes are not applied until they are committed (through `C_Traits.CommitConfig` or `C_ClassTalents.CommitConfig`). -`success = C_Traits.SetSelection(configID, nodeID)` - -**Parameters:** -- `configID` - - *number* -- `nodeID` - - *number* -- `nodeEntryID` - - *number?* - pass nil to unselect the node, effectively the equivalent of `C_Traits.RefundRank`. -- `clearEdges` - - *boolean?* - if true, unselecting the node will refund all talents that no longer meet their requirements - -**Returns:** -- `success` - - *boolean* - -**Description:** -This API can be used to set the initial selection, change a selection, or unselect a selection node (aka choice node). Passing `clearEdges = true`, and unselecting a selection node, may result in other talents being refunded, e.g., if you no longer meet a gate criterion, or if the selection node is the only path to a set of selected talents. -You should not use the `C_Traits.PurchaseRank` or `C_Traits.RefundRank` APIs on selection nodes. `C_Traits.SetSelection` is the only API used to modify selection node choices. \ No newline at end of file diff --git a/wiki-information/functions/C_Traits.StageConfig.md b/wiki-information/functions/C_Traits.StageConfig.md deleted file mode 100644 index 3fe60e43..00000000 --- a/wiki-information/functions/C_Traits.StageConfig.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_Traits.StageConfig - -**Content:** -Needs summary. -`success = C_Traits.StageConfig(configID)` - -**Parameters:** -- `configID` - - *number* - -**Returns:** -- `success` - - *boolean* - -**Description:** -This function stages a configuration for traits. The `configID` parameter is the unique identifier for the configuration you want to stage. The function returns a boolean indicating whether the staging was successful. - -**Example Usage:** -```lua -local configID = 12345 -local success = C_Traits.StageConfig(configID) -if success then - print("Configuration staged successfully.") -else - print("Failed to stage configuration.") -end -``` - -**Addons Using This Function:** -Large addons that manage character traits or configurations, such as WeakAuras or ElvUI, might use this function to stage trait configurations before applying them. This ensures that the configuration is valid and can be applied without errors. \ No newline at end of file diff --git a/wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md b/wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md deleted file mode 100644 index c4f034b5..00000000 --- a/wiki-information/functions/C_UI.DoesAnyDisplayHaveNotch.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_UI.DoesAnyDisplayHaveNotch - -**Content:** -True if any display attached has a notch. This does not mean the current view intersects the notch. -`notchPresent = C_UI.DoesAnyDisplayHaveNotch()` - -**Returns:** -- `notchPresent` - - *boolean* - True if any display attached has a notch. \ No newline at end of file diff --git a/wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md b/wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md deleted file mode 100644 index 725324fe..00000000 --- a/wiki-information/functions/C_UI.GetTopLeftNotchSafeRegion.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_UI.GetTopLeftNotchSafeRegion - -**Content:** -Region of screen left of screen notch. Zeros if no notch. -`left, right, top, bottom = C_UI.GetTopLeftNotchSafeRegion()` - -**Returns:** -- `left` - - *number* -- `right` - - *number* -- `top` - - *number* -- `bottom` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md b/wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md deleted file mode 100644 index 516cbe89..00000000 --- a/wiki-information/functions/C_UI.GetTopRightNotchSafeRegion.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_UI.GetTopRightNotchSafeRegion - -**Content:** -Region of screen right of screen notch. Zeros if no notch. -`left, right, top, bottom = C_UI.GetTopRightNotchSafeRegion()` - -**Returns:** -- `left` - - *number* -- `right` - - *number* -- `top` - - *number* -- `bottom` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UI.Reload.md b/wiki-information/functions/C_UI.Reload.md deleted file mode 100644 index 18d15010..00000000 --- a/wiki-information/functions/C_UI.Reload.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_UI.Reload - -**Content:** -Reloads the User Interface. -`C_UI.Reload()` - -**Description:** -Reloading the interface saves the current settings to disk, and updates any addon files previously loaded by the game. In order to load new files (or addons), the game must be restarted. -You can also use the `/reload` slash command; or the console equivalent: `/console ReloadUI`. - -**Example Usage:** -This function is commonly used by addon developers to quickly test changes to their addons without needing to restart the game. For instance, after modifying an addon's Lua or XML files, calling `C_UI.Reload()` will apply those changes immediately. - -**Popular Addons Using This Function:** -Many popular addons, such as ElvUI and WeakAuras, provide a button or command to reload the UI, leveraging this function to help users apply configuration changes or updates without restarting the game. \ No newline at end of file diff --git a/wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md b/wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md deleted file mode 100644 index 68a49459..00000000 --- a/wiki-information/functions/C_UI.ShouldUIParentAvoidNotch.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_UI.ShouldUIParentAvoidNotch - -**Content:** -UIParent will shift down to avoid notch if true. This does not mean there is a notch. -`willAvoidNotch = C_UI.ShouldUIParentAvoidNotch()` - -**Returns:** -- `willAvoidNotch` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_UIColor.GetColors.md b/wiki-information/functions/C_UIColor.GetColors.md deleted file mode 100644 index 943682d5..00000000 --- a/wiki-information/functions/C_UIColor.GetColors.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_UIColor.GetColors - -**Content:** -Returns a list of UI colors to be imported into the global environment on login. -`colors = C_UIColor.GetColors()` - -**Returns:** -- `colors` - - *DBColorExport* - A list of UI color structures. - - `Field` - - `Type` - - `Description` - - `baseTag` - - *string* - The global name to associate with this color. - - `color` - - *ColorMixin* - The color data. - -**Description:** -UI colors are stored within the global color client database. \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md b/wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md deleted file mode 100644 index 74b29b74..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetAllWidgetsBySetID.md +++ /dev/null @@ -1,78 +0,0 @@ -## Title: C_UIWidgetManager.GetAllWidgetsBySetID - -**Content:** -Returns all widgets for a widget set ID. -`widgets = C_UIWidgetManager.GetAllWidgetsBySetID(setID)` - -**Parameters:** -- `setID` - - *number* : UiWidgetSetID - -**ID Location Function:** -- `1` - `C_UIWidgetManager.GetTopCenterWidgetSetID()` -- `2` - `C_UIWidgetManager.GetBelowMinimapWidgetSetID()` -- `240` - `C_UIWidgetManager.GetObjectiveTrackerWidgetSetID()` -- `283` - `C_UIWidgetManager.GetPowerBarWidgetSetID()` - -**Returns:** -- `widgets` - - *UIWidgetInfo* - - `Field` - - `Type` - - `Description` - - `widgetID` - - *number* - UiWidget.db2 - - `widgetSetID` - - *number* - UiWidgetSetID - - `widgetType` - - *Enum.UIWidgetVisualizationType* - - `unitToken` - - *string?* - UnitId; Added in 9.0.1 - -**Enum.UIWidgetVisualizationType:** -- `Value` - `Key` - `Data Function` - `Description` -- `0` - `IconAndText` - `C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo` -- `1` - `CaptureBar` - `C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo` -- `2` - `StatusBar` - `C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo` -- `3` - `DoubleStatusBar` - `C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo` -- `4` - `IconTextAndBackground` - `C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo` -- `5` - `DoubleIconAndText` - `C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo` -- `6` - `StackedResourceTracker` - `C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo` -- `7` - `IconTextAndCurrencies` - `C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo` -- `8` - `TextWithState` - `C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo` -- `9` - `HorizontalCurrencies` - `C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo` -- `10` - `BulletTextList` - `C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo` -- `11` - `ScenarioHeaderCurrenciesAndBackground` - `C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo` -- `12` - `TextureAndText` - `C_UIWidgetManager.GetTextureAndTextVisualizationInfo` (Added in 8.2.0) -- `13` - `SpellDisplay` - `C_UIWidgetManager.GetSpellDisplayVisualizationInfo` (Added in 8.1.0) -- `14` - `DoubleStateIconRow` - `C_UIWidgetManager.GetDoubleStateIconRowVisualizationInfo` (Added in 8.1.5) -- `15` - `TextureAndTextRow` - `C_UIWidgetManager.GetTextureAndTextRowVisualizationInfo` (Added in 8.2.0) -- `16` - `ZoneControl` - `C_UIWidgetManager.GetZoneControlVisualizationInfo` (Added in 8.2.0) -- `17` - `CaptureZone` - `C_UIWidgetManager.GetCaptureZoneVisualizationInfo` (Added in 8.2.5) -- `18` - `TextureWithAnimation` - `C_UIWidgetManager.GetTextureWithAnimationVisualizationInfo` (Added in 9.0.1) -- `19` - `DiscreteProgressSteps` - `C_UIWidgetManager.GetDiscreteProgressStepsVisualizationInfo` (Added in 9.0.1) -- `20` - `ScenarioHeaderTimer` - `C_UIWidgetManager.GetScenarioHeaderTimerWidgetVisualizationInfo` (Added in 9.0.1) -- `21` - `TextColumnRow` - `C_UIWidgetManager.GetTextColumnRowVisualizationInfo` (Added in 9.1.0) -- `22` - `Spacer` - `C_UIWidgetManager.GetSpacerVisualizationInfo` (Added in 9.1.0) -- `23` - `UnitPowerBar` - `C_UIWidgetManager.GetUnitPowerBarWidgetVisualizationInfo` (Added in 9.2.0) -- `24` - `FillUpFrames` - `C_UIWidgetManager.GetFillUpFramesWidgetVisualizationInfo` (Added in 10.0.0) -- `25` - `TextWithSubtext` - `C_UIWidgetManager.GetTextWithSubtextWidgetVisualizationInfo` (Added in 10.0.2) -- `26` - `WorldLootObject` (Added in 10.1.0) -- `27` - `ItemDisplay` - `C_UIWidgetManager.GetItemDisplayVisualizationInfo` (Added in 10.1.0) - -**Usage:** -Prints all UI widget IDs for the top center part of the screen, e.g. on Warsong Gulch: -```lua -local topCenter = C_UIWidgetManager.GetTopCenterWidgetSetID() -local widgets = C_UIWidgetManager.GetAllWidgetsBySetID(topCenter) -for _, w in pairs(widgets) do - print(w.widgetType, w.widgetID) -end --- Output: --- 0, 6 -- IconAndText, VisID 3: Icon And Text: No Texture Kit --- 3, 2 -- DoubleStatusBar, VisID 1197: PvP - CTF - Double Status Bar --- 14, 1640 -- DoubleStateIconRow, VisID 1201: PvP - CTF - Flag Status -``` - -**Reference:** -`UPDATE_UI_WIDGET` \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md b/wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md deleted file mode 100644 index 4de05ac6..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetBelowMinimapWidgetSetID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_UIWidgetManager.GetBelowMinimapWidgetSetID - -**Content:** -Needs summary. -`setID = C_UIWidgetManager.GetBelowMinimapWidgetSetID()` - -**Returns:** -- `setID` - - *number* : UiWidgetSetID - Returns 2 - - `ID` - - `Location Function` - - `1` - - `C_UIWidgetManager.GetTopCenterWidgetSetID()` - - `2` - - `C_UIWidgetManager.GetBelowMinimapWidgetSetID()` - - `240` - - `C_UIWidgetManager.GetObjectiveTrackerWidgetSetID()` - - `283` - - `C_UIWidgetManager.GetPowerBarWidgetSetID()` \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md deleted file mode 100644 index 5fb32548..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo.md +++ /dev/null @@ -1,86 +0,0 @@ -## Title: C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetBulletTextListWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *BulletTextListWidgetVisualizationInfo?* - - `shownState` - - *Enum.WidgetShownState* - - `enabledState` - - *Enum.WidgetEnabledState* - - `lines` - - *string* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- **Value** - **Field** - **Description** - - `0` - Hidden - - `1` - Shown - -**Enum.WidgetEnabledState** -- **Value** - **Field** - **Description** - - `0` - Disabled - - `1` - Yellow (Renamed from Enabled in 10.1.0) - - `2` - Red - - `3` - White (Added in 9.1.0) - - `4` - Green (Added in 9.1.0) - - `5` - Artifact (Renamed from Gold in 10.1.0) - - `6` - Black (Added in 9.2.0) - -**Enum.WidgetAnimationType** -- **Value** - **Field** - **Description** - - `0` - None - - `1` - Fade - -**Enum.UIWidgetScale** -- **Value** - **Field** - **Description** - - `0` - OneHundred - - `1` - Ninty - - `2` - Eighty - - `3` - Seventy - - `4` - Sixty - - `5` - Fifty - -**Enum.UIWidgetLayoutDirection** -- **Value** - **Field** - **Description** - - `0` - Default - - `1` - Vertical - - `2` - Horizontal - - `3` - Overlap - - `4` - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- **Value** - **Field** - **Description** - - `0` - None - - `1` - Front - - `2` - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md deleted file mode 100644 index 00c1df6d..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo.md +++ /dev/null @@ -1,162 +0,0 @@ -## Title: C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetCaptureBarWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *CaptureBarWidgetVisualizationInfo?* - - `Field` - - `Type` - - `Description` - - `shownState` - - *Enum.WidgetShownState* - - `barValue` - - *number* - - `barMinValue` - - *number* - - `barMaxValue` - - *number* - - `neutralZoneSize` - - *number* - - `neutralZoneCenter` - - *number* - - `tooltip` - - *string* - - `glowAnimType` - - *Enum.CaptureBarWidgetGlowAnimType* - - `fillDirectionType` - - *Enum.CaptureBarWidgetFillDirectionType* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Shown - -**Enum.CaptureBarWidgetGlowAnimType** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Pulse - -**Enum.CaptureBarWidgetFillDirectionType** -- `Value` -- `Field` -- `Description` - - `0` - - RightToLeft - - `1` - - LeftToRight - -**Enum.UIWidgetTooltipLocation** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- `Value` -- `Field` -- `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md deleted file mode 100644 index 62cfc55e..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo.md +++ /dev/null @@ -1,135 +0,0 @@ -## Title: C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetDoubleIconAndTextWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from UPDATE_UI_WIDGET and C_UIWidgetManager.GetAllWidgetsBySetID() - -**Returns:** -- `widgetInfo` - - *DoubleIconAndTextWidgetVisualizationInfo?* - - `shownState` - - *Enum.WidgetShownState* - - `label` - - *string* - - `leftText` - - *string* - - `leftTooltip` - - *string* - - `rightText` - - *string* - - `rightTooltip` - - *string* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- **Value** - - **Field** - - **Description** - - `0` - - Hidden - - `1` - - Shown - -**Enum.UIWidgetTooltipLocation** -- **Value** - - **Field** - - **Description** - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType** -- **Value** - - **Field** - - **Description** - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- **Value** - - **Field** - - **Description** - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- **Value** - - **Field** - - **Description** - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- **Value** - - **Field** - - **Description** - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md deleted file mode 100644 index ac8beb4c..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo.md +++ /dev/null @@ -1,171 +0,0 @@ -## Title: C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetDoubleStatusBarWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *DoubleStatusBarWidgetVisualizationInfo?* - - `Field` - - `Type` - - `Description` - - `shownState` - - *Enum.WidgetShownState* - - `leftBarMin` - - *number* - - `leftBarMax` - - *number* - - `leftBarValue` - - *number* - - `leftBarTooltip` - - *string* - - `rightBarMin` - - *number* - - `rightBarMax` - - *number* - - `rightBarValue` - - *number* - - `rightBarTooltip` - - *string* - - `barValueTextType` - - *Enum.StatusBarValueTextType* - - `text` - - *string* - - `leftBarTooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `rightBarTooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `fillMotionType` - - *Enum.UIWidgetMotionType* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Shown - -**Enum.StatusBarValueTextType** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Percentage - - `2` - - Value - - `3` - - Time - - `4` - - TimeShowOneLevelOnly - - `5` - - ValueOverMax - - `6` - - ValueOverMaxNormalized - -**Enum.UIWidgetTooltipLocation** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- `Value` -- `Field` -- `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md deleted file mode 100644 index 4159aa97..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo.md +++ /dev/null @@ -1,145 +0,0 @@ -## Title: C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetHorizontalCurrenciesWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *HorizontalCurrenciesWidgetVisualizationInfo?* - - `Field` - - `Type` - - `Description` - - `shownState` - - *Enum.WidgetShownState* - - `currencies` - - *UIWidgetCurrencyInfo* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Shown - -**UIWidgetCurrencyInfo** -- `Field` -- `Type` -- `Description` - - `iconFileID` - - *number* - - `leadingText` - - *string* - - `text` - - *string* - - `tooltip` - - *string* - - `isCurrencyMaxed` - - *boolean* - -**Enum.UIWidgetTooltipLocation** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- `Value` -- `Field` -- `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md deleted file mode 100644 index 823acd1b..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo.md +++ /dev/null @@ -1,138 +0,0 @@ -## Title: C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetIconAndTextWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *IconAndTextWidgetVisualizationInfo?* - - `Field` - - `Type` - - `Description` - - `state` - - *Enum.IconAndTextWidgetState* - - `text` - - *string* - - `tooltip` - - *string* - - `dynamicTooltip` - - *string* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.IconAndTextWidgetState:** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Shown - - `2` - - ShownWithDynamicIconFlashing - - `3` - - ShownWithDynamicIconNotFlashing - -**Enum.UIWidgetTooltipLocation:** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType:** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale:** -- `Value` -- `Field` -- `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection:** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer:** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md deleted file mode 100644 index 8e949935..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo.md +++ /dev/null @@ -1,105 +0,0 @@ -## Title: C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetIconTextAndBackgroundWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *IconTextAndBackgroundWidgetVisualizationInfo?* - - `Field` - - `Type` - - `Description` - - `shownState` - - *Enum.WidgetShownState* - - `text` - - *string* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Shown - -**Enum.WidgetAnimationType** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- `Value` -- `Field` -- `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md deleted file mode 100644 index e7e42f83..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo.md +++ /dev/null @@ -1,171 +0,0 @@ -## Title: C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetIconTextAndCurrenciesWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *IconTextAndCurrenciesWidgetVisualizationInfo?* - - `shownState` - - *Enum.WidgetShownState* - - `enabledState` - - *Enum.WidgetEnabledState* - - `descriptionShownState` - - *Enum.WidgetShownState* - - `descriptionEnabledState` - - *Enum.WidgetEnabledState* - - `text` - - *string* - - `description` - - *string* - - `currencies` - - *UIWidgetCurrencyInfo* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState:** -- `Value` - - `Field` - - `Description` - - `0` - - Hidden - - `1` - - Shown - -**Enum.WidgetEnabledState:** -- `Value` - - `Field` - - `Description` - - `0` - - Disabled - - `1` - - Yellow (Renamed from Enabled in 10.1.0) - - `2` - - Red - - `3` - - White (Added in 9.1.0) - - `4` - - Green (Added in 9.1.0) - - `5` - - Artifact (Renamed from Gold in 10.1.0) - - `6` - - Black (Added in 9.2.0) - -**UIWidgetCurrencyInfo:** -- `Field` - - `Type` - - `Description` - - `iconFileID` - - *number* - - `leadingText` - - *string* - - `text` - - *string* - - `tooltip` - - *string* - - `isCurrencyMaxed` - - *boolean* - -**Enum.UIWidgetTooltipLocation:** -- `Value` - - `Field` - - `Description` - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType:** -- `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale:** -- `Value` - - `Field` - - `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection:** -- `Value` - - `Field` - - `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer:** -- `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md deleted file mode 100644 index f1c6ed24..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo.md +++ /dev/null @@ -1,119 +0,0 @@ -## Title: C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *ScenarioHeaderCurrenciesAndBackgroundWidgetVisualizationInfo?* - - `shownState` - - *Enum.WidgetShownState* - - `currencies` - - *UIWidgetCurrencyInfo* - - `headerText` - - *string* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- **Value** - - **Field** - - **Description** - - `0` - - Hidden - - `1` - - Shown - -**UIWidgetCurrencyInfo** -- **Field** - - **Type** - - **Description** - - `iconFileID` - - *number* - - `leadingText` - - *string* - - `text` - - *string* - - `tooltip` - - *string* - - `isCurrencyMaxed` - - *boolean* - -**Enum.WidgetAnimationType** -- **Value** - - **Field** - - **Description** - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- **Value** - - **Field** - - **Description** - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- **Value** - - **Field** - - **Description** - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- **Value** - - **Field** - - **Description** - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md deleted file mode 100644 index be601333..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo.md +++ /dev/null @@ -1,145 +0,0 @@ -## Title: C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetStackedResourceTrackerWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *StackedResourceTrackerWidgetVisualizationInfo?* - - `Field` - - `Type` - - `Description` - - `shownState` - - *Enum.WidgetShownState* - - `resources` - - *UIWidgetCurrencyInfo* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Shown - -**UIWidgetCurrencyInfo** -- `Field` -- `Type` -- `Description` - - `iconFileID` - - *number* - - `leadingText` - - *string* - - `text` - - *string* - - `tooltip` - - *string* - - `isCurrencyMaxed` - - *boolean* - -**Enum.UIWidgetTooltipLocation** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- `Value` -- `Field` -- `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md deleted file mode 100644 index 0e7a28d3..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo.md +++ /dev/null @@ -1,214 +0,0 @@ -## Title: C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetStatusBarWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *StatusBarWidgetVisualizationInfo?* - - `shownState` - - *Enum.WidgetShownState* - - `barMin` - - *number* - - `barMax` - - *number* - - `barValue` - - *number* - - `text` - - *string* - - `tooltip` - - *string* - - `barValueTextType` - - *Enum.StatusBarValueTextType* - - `overrideBarText` - - *string* - - `overrideBarTextShownType` - - *Enum.StatusBarOverrideBarTextShownType* - - `colorTint` - - *Enum.StatusBarColorTintValue* - - `partitionValues` - - *number* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `fillMotionType` - - *Enum.UIWidgetMotionType* - - `barTextEnabledState` - - *Enum.WidgetEnabledState* - - `barTextFontType` - - *Enum.UIWidgetFontType* - - `barTextSizeType` - - *Enum.UIWidgetTextSizeType* - - `textEnabledState` - - *Enum.WidgetEnabledState* - - `textFontType` - - *Enum.UIWidgetFontType* - - `textSizeType` - - *Enum.UIWidgetTextSizeType* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* : textureKit - - `frameTextureKit` - - *string* : textureKit - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState:** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Shown - -**Enum.StatusBarValueTextType:** -- `Value` -- `Field` -- `Description` - - `0` - - Hidden - - `1` - - Percentage - - `2` - - Value - - `3` - - Time - - `4` - - TimeShowOneLevelOnly - - `5` - - ValueOverMax - - `6` - - ValueOverMaxNormalized - -**Enum.StatusBarOverrideBarTextShownType:** -- `Value` -- `Field` -- `Description` - - `0` - - Never - - `1` - - Always - - `2` - - OnlyOnMouseover - - `3` - - OnlyNotOnMouseover - -**Enum.StatusBarColorTintValue:** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Black - - `2` - - White - - `3` - - Red - - `4` - - Yellow - - `5` - - Orange - - `6` - - Purple - - `7` - - Green - - `8` - - Blue - -**Enum.UIWidgetTooltipLocation:** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetAnimationType:** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale:** -- `Value` -- `Field` -- `Description` - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection:** -- `Value` -- `Field` -- `Description` - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer:** -- `Value` -- `Field` -- `Description` - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md deleted file mode 100644 index 48297373..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo.md +++ /dev/null @@ -1,203 +0,0 @@ -## Title: C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetTextWithStateWidgetVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - Returned from `UPDATE_UI_WIDGET` and `C_UIWidgetManager.GetAllWidgetsBySetID()` - -**Returns:** -- `widgetInfo` - - *TextWithStateWidgetVisualizationInfo?* - - `shownState` - - *Enum.WidgetShownState* - - `enabledState` - - *Enum.WidgetEnabledState* - - `text` - - *string* - - `tooltip` - - *string* - - `textSizeType` - - *Enum.UIWidgetTextSizeType* - - `fontType` - - *Enum.UIWidgetFontType* - - `bottomPadding` - - *number* - - `tooltipLoc` - - *Enum.UIWidgetTooltipLocation* - - `hAlign` - - *Enum.WidgetTextHorizontalAlignmentType* - - `widgetSizeSetting` - - *number* - - `textureKit` - - *string* - - `frameTextureKit` - - *string* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `inAnimType` - - *Enum.WidgetAnimationType* - - `outAnimType` - - *Enum.WidgetAnimationType* - - `widgetScale` - - *Enum.UIWidgetScale* - - `layoutDirection` - - *Enum.UIWidgetLayoutDirection* - - `modelSceneLayer` - - *Enum.UIWidgetModelSceneLayer* - - `scriptedAnimationEffectID` - - *number* - -**Enum.WidgetShownState** -- **Value** - - **Field** - - **Description** - - `0` - - Hidden - - `1` - - Shown - -**Enum.WidgetEnabledState** -- **Value** - - **Field** - - **Description** - - `0` - - Disabled - - `1` - - Yellow (Renamed from Enabled in 10.1.0) - - `2` - - Red - - `3` - - White (Added in 9.1.0) - - `4` - - Green (Added in 9.1.0) - - `5` - - Artifact (Renamed from Gold in 10.1.0) - - `6` - - Black (Added in 9.2.0) - -**Enum.UIWidgetTextSizeType** -- **Value** - - **Field** - - **Description** - - `0` - - Small12Pt - - `1` - - Medium16Pt - - `2` - - Large24Pt - - `3` - - Huge27Pt - - `4` - - Standard14Pt - - `5` - - Small10Pt - - `6` - - Small11Pt - - `7` - - Medium18Pt - - `8` - - Large20Pt - -**Enum.UIWidgetFontType** -- **Value** - - **Field** - - **Description** - - `0` - - Normal - - `1` - - Shadow - - `2` - - Outline - -**Enum.UIWidgetTooltipLocation** -- **Value** - - **Field** - - **Description** - - `0` - - Default - - `1` - - BottomLeft - - `2` - - Left - - `3` - - TopLeft - - `4` - - Top - - `5` - - TopRight - - `6` - - Right - - `7` - - BottomRight - - `8` - - Bottom - -**Enum.WidgetTextHorizontalAlignmentType** -- **Value** - - **Field** - - **Description** - - `0` - - Left - - `1` - - Center - - `2` - - Right - -**Enum.WidgetAnimationType** -- **Value** - - **Field** - - **Description** - - `0` - - None - - `1` - - Fade - -**Enum.UIWidgetScale** -- **Value** - - **Field** - - **Description** - - `0` - - OneHundred - - `1` - - Ninty - - `2` - - Eighty - - `3` - - Seventy - - `4` - - Sixty - - `5` - - Fifty - -**Enum.UIWidgetLayoutDirection** -- **Value** - - **Field** - - **Description** - - `0` - - Default - - `1` - - Vertical - - `2` - - Horizontal - - `3` - - Overlap - - `4` - - HorizontalForceNewRow - -**Enum.UIWidgetModelSceneLayer** -- **Value** - - **Field** - - **Description** - - `0` - - None - - `1` - - Front - - `2` - - Back \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md b/wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md deleted file mode 100644 index 740290e5..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetTextureWithStateVisualizationInfo.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: C_UIWidgetManager.GetTextureWithStateVisualizationInfo - -**Content:** -Needs summary. -`widgetInfo = C_UIWidgetManager.GetTextureWithStateVisualizationInfo(widgetID)` - -**Parameters:** -- `widgetID` - - *number* - -**Returns:** -- `widgetInfo` - - *structure* - TextureWithStateVisualizationInfo (nilable) - - `Key` - - `Type` - - `Description` - - `shownState` - - *Enum.WidgetShownState* - - `name` - - *string* - - `backgroundTextureKitID` - - *number* - - `portraitTextureKitID` - - *number* - - `hasTimer` - - *boolean* - - `orderIndex` - - *number* - - `widgetTag` - - *string* - - `Enum.WidgetShownState` - - `Value` - - `Field` - - `Description` - - `0` - - Hidden - - `1` - - Shown - -**Reference:** -Blizzard API Documentation \ No newline at end of file diff --git a/wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md b/wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md deleted file mode 100644 index f622bd90..00000000 --- a/wiki-information/functions/C_UIWidgetManager.GetTopCenterWidgetSetID.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: C_UIWidgetManager.GetTopCenterWidgetSetID - -**Content:** -Returns the widget set ID for the top center part of the screen. -`setID = C_UIWidgetManager.GetTopCenterWidgetSetID()` - -**Returns:** -- `setID` - - *number* : UiWidgetSetID - Returns 1 - - `ID` - - `Location Function` - - `1` - - `C_UIWidgetManager.GetTopCenterWidgetSetID()` - - `2` - - `C_UIWidgetManager.GetBelowMinimapWidgetSetID()` - - `240` - - `C_UIWidgetManager.GetObjectiveTrackerWidgetSetID()` - - `283` - - `C_UIWidgetManager.GetPowerBarWidgetSetID()` - -**Usage:** -Prints all UI widget IDs for the top center part of the screen, e.g. on Warsong Gulch: -```lua -local topCenter = C_UIWidgetManager.GetTopCenterWidgetSetID() -local widgets = C_UIWidgetManager.GetAllWidgetsBySetID(topCenter) -for _, w in pairs(widgets) do - print(w.widgetType, w.widgetID) -end --- Output example: --- 0, 6 -- IconAndText, VisID 3: Icon And Text: No Texture Kit --- 3, 2 -- DoubleStatusBar, VisID 1197: PvP - CTF - Double Status Bar --- 14, 1640 -- DoubleStateIconRow, VisID 1201: PvP - CTF - Flag Status -``` \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md b/wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md deleted file mode 100644 index 5d819472..00000000 --- a/wiki-information/functions/C_UnitAuras.AddPrivateAuraAnchor.md +++ /dev/null @@ -1,58 +0,0 @@ -## Title: C_UnitAuras.AddPrivateAuraAnchor - -**Content:** -Needs summary. -`anchorID = C_UnitAuras.AddPrivateAuraAnchor(args)` - -**Parameters:** -- `args` - - *AddPrivateAuraAnchorArgs* - - `Field` - - `Type` - - `Description` - - `unitToken` - - *string* - - `auraIndex` - - *number* - - `parent` - - *Frame* - - `showCountdownFrame` - - *boolean* - - `showCountdownNumbers` - - *boolean* - - `iconInfo` - - *PrivateAuraIconInfo?* - - `durationAnchor` - - *AnchorBinding?* - -**PrivateAuraIconInfo** -- `Field` -- `Type` -- `Description` -- `iconAnchor` - - *AnchorBinding* -- `iconWidth` - - *number : uiUnit* -- `iconHeight` - - *number : uiUnit* - -**AnchorBinding** -- `Field` -- `Type` -- `Description` -- `point` - - *string : FramePoint* - - TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER -- `relativeTo` - - *ScriptRegion* -- `relativePoint` - - *string : FramePoint* - - TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER -- `offsetX` - - *number : uiUnit* -- `offsetY` - - *number : uiUnit* - -**Returns:** -- `anchorID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md b/wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md deleted file mode 100644 index 4022ea59..00000000 --- a/wiki-information/functions/C_UnitAuras.AddPrivateAuraAppliedSound.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_UnitAuras.AddPrivateAuraAppliedSound - -**Content:** -Needs summary. -`privateAuraSoundID = C_UnitAuras.AddPrivateAuraAppliedSound(sound)` - -**Parameters:** -- `sound` - - *UnitPrivateAuraAppliedSoundInfo* - - `Field` - - `Type` - - `Description` - - `unitToken` - - *string* - - `spellID` - - *number* - - `soundFileName` - - *string?* - - `soundFileID` - - *number?* - - `outputChannel` - - *string?* - -**Returns:** -- `privateAuraSoundID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.AuraIsPrivate.md b/wiki-information/functions/C_UnitAuras.AuraIsPrivate.md deleted file mode 100644 index b86bb438..00000000 --- a/wiki-information/functions/C_UnitAuras.AuraIsPrivate.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_UnitAuras.AuraIsPrivate - -**Content:** -Needs summary. -`isPrivate = C_UnitAuras.AuraIsPrivate(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `isPrivate` - - *boolean* - -**Example Usage:** -This function can be used to determine if a specific aura (identified by its spell ID) is private. This can be useful in addons that manage or display aura information, ensuring that private auras are handled appropriately. - -**Addon Usage:** -Large addons like WeakAuras might use this function to filter out private auras when displaying aura information to the player, ensuring that only relevant and non-private auras are shown in custom UI elements. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md b/wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md deleted file mode 100644 index 64af695a..00000000 --- a/wiki-information/functions/C_UnitAuras.GetAuraDataByAuraInstanceID.md +++ /dev/null @@ -1,65 +0,0 @@ -## Title: C_UnitAuras.GetAuraDataByAuraInstanceID - -**Content:** -Returns information about an aura on a unit by a given aura instance ID. -`aura = C_UnitAuras.GetAuraDataByAuraInstanceID(unit, auraInstanceID)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to query. -- `auraInstanceID` - - *number* - An aura instance ID. - -**Returns:** -- `aura` - - *UnitAuraInfo?* - Structured information about the found aura, if any. - - `applications` - - *number* - - `auraInstanceID` - - *number* - - `canApplyAura` - - *boolean* - Whether or not the player can apply this aura. - - `charges` - - *number* - - `dispelName` - - *string?* - - `duration` - - *number* - - `expirationTime` - - *number* - - `icon` - - *number* - - `isBossAura` - - *boolean* - Whether or not this aura was applied by a boss. - - `isFromPlayerOrPlayerPet` - - *boolean* - Whether or not this aura was applied by a player or their pet. - - `isHarmful` - - *boolean* - Whether or not this aura is a debuff. - - `isHelpful` - - *boolean* - Whether or not this aura is a buff. - - `isNameplateOnly` - - *boolean* - Whether or not this aura should appear on nameplates. - - `isRaid` - - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. - - `isStealable` - - *boolean* - - `maxCharges` - - *number* - - `name` - - *string* - The name of the aura. - - `nameplateShowAll` - - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - `nameplateShowPersonal` - - *boolean* - - `points` - - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - `sourceUnit` - - *string?* - Token of the unit that applied the aura. - - `spellId` - - *number* - The spell ID of the aura. - - `timeMod` - - *number* - -**Description:** -Related Events -- `UNIT_AURA` \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md b/wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md deleted file mode 100644 index b9d3443b..00000000 --- a/wiki-information/functions/C_UnitAuras.GetAuraDataByIndex.md +++ /dev/null @@ -1,81 +0,0 @@ -## Title: C_UnitAuras.GetAuraDataByIndex - -**Content:** -Needs summary. -`aura = C_UnitAuras.GetAuraDataByIndex(unitToken, index)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `index` - - *number* -- `filter` - - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". - -**Miscellaneous:** -- **Filter** | **Description** - - `"HELPFUL"` | Buffs - - `"HARMFUL"` | Debuffs - - `"PLAYER"` | Auras Debuffs applied by the player - - `"RAID"` | Buffs the player can apply and debuffs the player can dispel - - `"CANCELABLE"` | Buffs that can be cancelled with /cancelaura or CancelUnitBuff() - - `"NOT_CANCELABLE"` | Buffs that cannot be cancelled - - `"INCLUDE_NAME_PLATE_ONLY"` | Auras that should be shown on nameplates - - `"MAW"` | Torghast Anima Powers - -**Returns:** -- `aura` - - *AuraData?* - - `Field` - - `Type` - - `Description` - - `applications` - - *number* - - `auraInstanceID` - - *number* - - `canApplyAura` - - *boolean* - Whether or not the player can apply this aura. - - `charges` - - *number* - - `dispelName` - - *string?* - - `duration` - - *number* - - `expirationTime` - - *number* - - `icon` - - *number* - - `isBossAura` - - *boolean* - Whether or not this aura was applied by a boss. - - `isFromPlayerOrPlayerPet` - - *boolean* - Whether or not this aura was applied by a player or their pet. - - `isHarmful` - - *boolean* - Whether or not this aura is a debuff. - - `isHelpful` - - *boolean* - Whether or not this aura is a buff. - - `isNameplateOnly` - - *boolean* - Whether or not this aura should appear on nameplates. - - `isRaid` - - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. - - `isStealable` - - *boolean* - - `maxCharges` - - *number* - - `name` - - *string* - The name of the aura. - - `nameplateShowAll` - - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - `nameplateShowPersonal` - - *boolean* - - `points` - - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - `sourceUnit` - - *string?* - Token of the unit that applied the aura. - - `spellId` - - *number* - The spell ID of the aura. - - `timeMod` - - *number* - -**Description:** -C_UnitAuras.GetBuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HELPFUL"), returning only buffs and ignores any HARMFUL filter. -C_UnitAuras.GetDebuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HARMFUL"), returning only debuffs and ignores any HELPFUL filter. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md b/wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md deleted file mode 100644 index 5600f549..00000000 --- a/wiki-information/functions/C_UnitAuras.GetAuraDataBySlot.md +++ /dev/null @@ -1,64 +0,0 @@ -## Title: C_UnitAuras.GetAuraDataBySlot - -**Content:** -Returns information about an aura on a unit by a given slot index. -`aura = C_UnitAuras.GetAuraDataBySlot(unit, slot)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to query. -- `slot` - - *number* - A slot index obtained from the variable returns of UnitAuraSlots. - -**Returns:** -- `aura` - - *UnitAuraInfo?* - Structured information about the found aura, if any. - - `applications` - - *number* - - `auraInstanceID` - - *number* - - `canApplyAura` - - *boolean* - Whether or not the player can apply this aura. - - `charges` - - *number* - - `dispelName` - - *string?* - - `duration` - - *number* - - `expirationTime` - - *number* - - `icon` - - *number* - - `isBossAura` - - *boolean* - Whether or not this aura was applied by a boss. - - `isFromPlayerOrPlayerPet` - - *boolean* - Whether or not this aura was applied by a player or their pet. - - `isHarmful` - - *boolean* - Whether or not this aura is a debuff. - - `isHelpful` - - *boolean* - Whether or not this aura is a buff. - - `isNameplateOnly` - - *boolean* - Whether or not this aura should appear on nameplates. - - `isRaid` - - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. - - `isStealable` - - *boolean* - - `maxCharges` - - *number* - - `name` - - *string* - The name of the aura. - - `nameplateShowAll` - - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - `nameplateShowPersonal` - - *boolean* - - `points` - - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - `sourceUnit` - - *string?* - Token of the unit that applied the aura. - - `spellId` - - *number* - The spell ID of the aura. - - `timeMod` - - *number* - -**Description:** -This API can be used as an alternative to UnitAuraBySlot to obtain information about the aura in a structured table. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md b/wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md deleted file mode 100644 index f017f713..00000000 --- a/wiki-information/functions/C_UnitAuras.GetAuraDataBySpellName.md +++ /dev/null @@ -1,89 +0,0 @@ -## Title: C_UnitAuras.GetAuraDataBySpellName - -**Content:** -Needs summary. -`aura = C_UnitAuras.GetAuraDataBySpellName(unitToken, spellName)` - -**Parameters:** -- `unitToken` - - *string* - UnitId -- `spellName` - - *string* -- `filter` - - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". - -**Miscellaneous:** -- **Filter** - - **Description** - - `"HELPFUL"` - - Buffs - - `"HARMFUL"` - - Debuffs - - `"PLAYER"` - - Auras Debuffs applied by the player - - `"RAID"` - - Buffs the player can apply and debuffs the player can dispel - - `"CANCELABLE"` - - Buffs that can be cancelled with /cancelaura or CancelUnitBuff() - - `"NOT_CANCELABLE"` - - Buffs that cannot be cancelled - - `"INCLUDE_NAME_PLATE_ONLY"` - - Auras that should be shown on nameplates - - `"MAW"` - - Torghast Anima Powers - -**Returns:** -- `aura` - - *AuraData?* - - `applications` - - *number* - - `auraInstanceID` - - *number* - - `canApplyAura` - - *boolean* - Whether or not the player can apply this aura. - - `charges` - - *number* - - `dispelName` - - *string?* - - `duration` - - *number* - - `expirationTime` - - *number* - - `icon` - - *number* - - `isBossAura` - - *boolean* - Whether or not this aura was applied by a boss. - - `isFromPlayerOrPlayerPet` - - *boolean* - Whether or not this aura was applied by a player or their pet. - - `isHarmful` - - *boolean* - Whether or not this aura is a debuff. - - `isHelpful` - - *boolean* - Whether or not this aura is a buff. - - `isNameplateOnly` - - *boolean* - Whether or not this aura should appear on nameplates. - - `isRaid` - - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. - - `isStealable` - - *boolean* - - `maxCharges` - - *number* - - `name` - - *string* - The name of the aura. - - `nameplateShowAll` - - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - `nameplateShowPersonal` - - *boolean* - - `points` - - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - `sourceUnit` - - *string?* - Token of the unit that applied the aura. - - `spellId` - - *number* - The spell ID of the aura. - - `timeMod` - - *number* - -**Example Usage:** -This function can be used to retrieve detailed information about a specific aura (buff or debuff) on a unit by its spell name. For instance, if you want to check if a player has a specific buff and get its details, you can use this function. - -**Addon Usage:** -Large addons like WeakAuras use this function to track and display aura information on units. WeakAuras can create custom visual and audio alerts based on the presence and details of specific auras, helping players to react to buffs and debuffs in real-time. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetAuraSlots.md b/wiki-information/functions/C_UnitAuras.GetAuraSlots.md deleted file mode 100644 index a88a933e..00000000 --- a/wiki-information/functions/C_UnitAuras.GetAuraSlots.md +++ /dev/null @@ -1,43 +0,0 @@ -## Title: C_UnitAuras.GetAuraSlots - -**Content:** -Needs summary. -`outContinuationToken, slots = C_UnitAuras.GetAuraSlots(unitToken, filter)` - -**Parameters:** -- `unitToken` - - *string* - UnitToken -- `filter` - - *string* -- `maxSlots` - - *number?* -- `continuationToken` - - *number?* - -**Returns:** -- `outContinuationToken` - - *number?* - (Variable returns) -- `slots` - - *number* - -**Description:** -This function is used to retrieve the aura slots for a given unit. The `unitToken` parameter specifies the unit whose auras are being queried, and the `filter` parameter allows for filtering specific types of auras (e.g., "HELPFUL", "HARMFUL"). The `maxSlots` and `continuationToken` parameters are optional and can be used to handle large numbers of auras by paginating the results. - -**Example Usage:** -```lua -local unitToken = "player" -local filter = "HELPFUL" -local maxSlots = 40 -local continuationToken = nil - -continuationToken, slots = C_UnitAuras.GetAuraSlots(unitToken, filter, maxSlots, continuationToken) - -for i, slot in ipairs(slots) do - local aura = C_UnitAuras.GetAuraDataBySlot(unitToken, slot) - print(aura.name, aura.duration) -end -``` - -**Addons Using This Function:** -- **WeakAuras**: This popular addon uses `C_UnitAuras.GetAuraSlots` to track and display buffs and debuffs on units, allowing players to create custom visual and audio alerts based on aura conditions. -- **ElvUI**: This comprehensive UI replacement addon uses the function to manage and display unit auras in its unit frames, providing players with detailed information about buffs and debuffs on themselves and their targets. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md b/wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md deleted file mode 100644 index fea30561..00000000 --- a/wiki-information/functions/C_UnitAuras.GetBuffDataByIndex.md +++ /dev/null @@ -1,87 +0,0 @@ -## Title: C_UnitAuras.GetBuffDataByIndex - -**Content:** -Needs summary. -`aura = C_UnitAuras.GetBuffDataByIndex(unitToken, index)` - -**Parameters:** -- `unitToken` - - *string* -- `index` - - *number* -- `filter` - - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". - -**Miscellaneous:** -- **Filter** - - **Description** - - `"HELPFUL"` - - Buffs - - `"HARMFUL"` - - Debuffs - - `"PLAYER"` - - Auras Debuffs applied by the player - - `"RAID"` - - Buffs the player can apply and debuffs the player can dispel - - `"CANCELABLE"` - - Buffs that can be cancelled with /cancelaura or CancelUnitBuff() - - `"NOT_CANCELABLE"` - - Buffs that cannot be cancelled - - `"INCLUDE_NAME_PLATE_ONLY"` - - Auras that should be shown on nameplates - - `"MAW"` - - Torghast Anima Powers - -**Returns:** -- `aura` - - *AuraData?* - - `applications` - - *number* - - `auraInstanceID` - - *number* - - `canApplyAura` - - *boolean* - Whether or not the player can apply this aura. - - `charges` - - *number* - - `dispelName` - - *string?* - - `duration` - - *number* - - `expirationTime` - - *number* - - `icon` - - *number* - - `isBossAura` - - *boolean* - Whether or not this aura was applied by a boss. - - `isFromPlayerOrPlayerPet` - - *boolean* - Whether or not this aura was applied by a player or their pet. - - `isHarmful` - - *boolean* - Whether or not this aura is a debuff. - - `isHelpful` - - *boolean* - Whether or not this aura is a buff. - - `isNameplateOnly` - - *boolean* - Whether or not this aura should appear on nameplates. - - `isRaid` - - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. - - `isStealable` - - *boolean* - - `maxCharges` - - *number* - - `name` - - *string* - The name of the aura. - - `nameplateShowAll` - - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - `nameplateShowPersonal` - - *boolean* - - `points` - - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - `sourceUnit` - - *string?* - Token of the unit that applied the aura. - - `spellId` - - *number* - The spell ID of the aura. - - `timeMod` - - *number* - -**Description:** -C_UnitAuras.GetBuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HELPFUL"), returning only buffs and ignores any HARMFUL filter. -C_UnitAuras.GetDebuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HARMFUL"), returning only debuffs and ignores any HELPFUL filter. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md b/wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md deleted file mode 100644 index 1c41a186..00000000 --- a/wiki-information/functions/C_UnitAuras.GetCooldownAuraBySpellID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_UnitAuras.GetCooldownAuraBySpellID - -**Content:** -Obtains the spell ID of a passive cooldown effect associated with a spell. -`passiveCooldownSpellID = C_UnitAuras.GetCooldownAuraBySpellID(spellID)` - -**Parameters:** -- `spellID` - - *number* - The spell ID to query. - -**Returns:** -- `passiveCooldownSpellID` - - *number?* - The spell ID of an associated passive aura effect, if any. - -**Description:** -This API is used in conjunction with `C_UnitAuras.GetPlayerAuraBySpellID` to display passive effect cooldowns on action buttons. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md b/wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md deleted file mode 100644 index 38bc6636..00000000 --- a/wiki-information/functions/C_UnitAuras.GetDebuffDataByIndex.md +++ /dev/null @@ -1,90 +0,0 @@ -## Title: C_UnitAuras.GetDebuffDataByIndex - -**Content:** -Needs summary. -`aura = C_UnitAuras.GetDebuffDataByIndex(unitToken, index)` - -**Parameters:** -- `unitToken` - - *string* -- `index` - - *number* -- `filter` - - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HARMFUL". - -**Miscellaneous:** -- **Filter** - - **Description** - - `"HELPFUL"` - - Buffs - - `"HARMFUL"` - - Debuffs - - `"PLAYER"` - - Auras Debuffs applied by the player - - `"RAID"` - - Buffs the player can apply and debuffs the player can dispel - - `"CANCELABLE"` - - Buffs that can be cancelled with /cancelaura or CancelUnitBuff() - - `"NOT_CANCELABLE"` - - Buffs that cannot be cancelled - - `"INCLUDE_NAME_PLATE_ONLY"` - - Auras that should be shown on nameplates - - `"MAW"` - - Torghast Anima Powers - -**Returns:** -- `aura` - - *AuraData?* - - `Field` - - `Type` - - `Description` - - `applications` - - *number* - - `auraInstanceID` - - *number* - - `canApplyAura` - - *boolean* - Whether or not the player can apply this aura. - - `charges` - - *number* - - `dispelName` - - *string?* - - `duration` - - *number* - - `expirationTime` - - *number* - - `icon` - - *number* - - `isBossAura` - - *boolean* - Whether or not this aura was applied by a boss. - - `isFromPlayerOrPlayerPet` - - *boolean* - Whether or not this aura was applied by a player or their pet. - - `isHarmful` - - *boolean* - Whether or not this aura is a debuff. - - `isHelpful` - - *boolean* - Whether or not this aura is a buff. - - `isNameplateOnly` - - *boolean* - Whether or not this aura should appear on nameplates. - - `isRaid` - - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. - - `isStealable` - - *boolean* - - `maxCharges` - - *number* - - `name` - - *string* - The name of the aura. - - `nameplateShowAll` - - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - `nameplateShowPersonal` - - *boolean* - - `points` - - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - `sourceUnit` - - *string?* - Token of the unit that applied the aura. - - `spellId` - - *number* - The spell ID of the aura. - - `timeMod` - - *number* - -**Description:** -C_UnitAuras.GetBuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HELPFUL"), returning only buffs and ignores any HARMFUL filter. -C_UnitAuras.GetDebuffDataByIndex() is an alias for C_UnitAuras.GetAuraDataByIndex(unit, index, "HARMFUL"), returning only debuffs and ignores any HELPFUL filter. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md b/wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md deleted file mode 100644 index 23450453..00000000 --- a/wiki-information/functions/C_UnitAuras.GetPlayerAuraBySpellID.md +++ /dev/null @@ -1,66 +0,0 @@ -## Title: C_UnitAuras.GetPlayerAuraBySpellID - -**Content:** -Returns information about an aura on the player by a given spell ID. -`aura = C_UnitAuras.GetPlayerAuraBySpellID(spellID)` - -**Parameters:** -- `spellID` - - *number* - The spell ID to query. - -**Returns:** -- `aura` - - *AuraData?* - Structured information about the found aura, if any. - - `applications` - - *number* - - `auraInstanceID` - - *number* - - `canApplyAura` - - *boolean* - Whether or not the player can apply this aura. - - `charges` - - *number* - - `dispelName` - - *string?* - - `duration` - - *number* - - `expirationTime` - - *number* - - `icon` - - *number* - - `isBossAura` - - *boolean* - Whether or not this aura was applied by a boss. - - `isFromPlayerOrPlayerPet` - - *boolean* - Whether or not this aura was applied by a player or their pet. - - `isHarmful` - - *boolean* - Whether or not this aura is a debuff. - - `isHelpful` - - *boolean* - Whether or not this aura is a buff. - - `isNameplateOnly` - - *boolean* - Whether or not this aura should appear on nameplates. - - `isRaid` - - *boolean* - Whether or not this aura meets the conditions of the RAID aura filter. - - `isStealable` - - *boolean* - - `maxCharges` - - *number* - - `name` - - *string* - The name of the aura. - - `nameplateShowAll` - - *boolean* - Whether or not this aura should always be shown irrespective of any usual filtering logic. - - `nameplateShowPersonal` - - *boolean* - - `points` - - *array* - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - - `sourceUnit` - - *string?* - Token of the unit that applied the aura. - - `spellId` - - *number* - The spell ID of the aura. - - `timeMod` - - *number* - -**Example Usage:** -This function can be used to check if a player has a specific buff or debuff by its spell ID. For instance, if you want to check if the player has the "Power Word: Fortitude" buff, you can use its spell ID to query this function. - -**Addons Using This Function:** -- **WeakAuras**: This popular addon uses this function to track and display auras on the player, allowing for highly customizable alerts and displays based on the player's current buffs and debuffs. -- **ElvUI**: This comprehensive UI replacement addon uses this function to manage and display aura information on unit frames, providing players with clear and concise information about their current auras. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md b/wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md deleted file mode 100644 index 86bc51cc..00000000 --- a/wiki-information/functions/C_UnitAuras.IsAuraFilteredOutByInstanceID.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: C_UnitAuras.IsAuraFilteredOutByInstanceID - -**Content:** -Tests if an aura passes a specific filter. -`isFiltered = C_UnitAuras.IsAuraFilteredOutByInstanceID(unit, auraInstanceID, filterString)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to query. -- `auraInstanceID` - - *number* - The aura instance ID to test. -- `filterString` - - *string* - The aura filter string to test, e.g., "HELPFUL" or "HARMFUL". - -**Miscellaneous:** -- **Filter** | **Description** - - `"HELPFUL"` | Buffs - - `"HARMFUL"` | Debuffs - - `"PLAYER"` | Auras Debuffs applied by the player - - `"RAID"` | Buffs the player can apply and debuffs the player can dispel - - `"CANCELABLE"` | Buffs that can be cancelled with /cancelaura or CancelUnitBuff() - - `"NOT_CANCELABLE"` | Buffs that cannot be cancelled - - `"INCLUDE_NAME_PLATE_ONLY"` | Auras that should be shown on nameplates - - `"MAW"` | Torghast Anima Powers - -**Returns:** -- `isFiltered` - - *boolean* - true if the aura passes the specified filter, or false if not. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md b/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md deleted file mode 100644 index 98bb6c90..00000000 --- a/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAnchor.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_UnitAuras.RemovePrivateAuraAnchor - -**Content:** -Needs summary. -`C_UnitAuras.RemovePrivateAuraAnchor(anchorID)` - -**Parameters:** -- `anchorID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md b/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md deleted file mode 100644 index 7daf59b0..00000000 --- a/wiki-information/functions/C_UnitAuras.RemovePrivateAuraAppliedSound.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_UnitAuras.RemovePrivateAuraAppliedSound - -**Content:** -Needs summary. -`C_UnitAuras.RemovePrivateAuraAppliedSound(privateAuraSoundID)` - -**Parameters:** -- `privateAuraSoundID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md b/wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md deleted file mode 100644 index 4fbafa25..00000000 --- a/wiki-information/functions/C_UnitAuras.SetPrivateWarningTextAnchor.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_UnitAuras.SetPrivateWarningTextAnchor - -**Content:** -Needs summary. -`C_UnitAuras.SetPrivateWarningTextAnchor(parent)` - -**Parameters:** -- `parent` - - *Frame* - The parent frame to which the warning text will be anchored. -- `anchor` - - *AnchorBinding?* - The anchor binding details. - - `Field` - - `Type` - - `Description` - - `point` - - *string* - FramePoint (e.g., TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER) - - `relativeTo` - - *ScriptRegion* - The region relative to which the anchor point is set. - - `relativePoint` - - *string* - FramePoint (e.g., TOPLEFT, TOPRIGHT, BOTTOMLEFT, BOTTOMRIGHT, TOP, BOTTOM, LEFT, RIGHT, CENTER) - - `offsetX` - - *number* - Horizontal offset in UI units. - - `offsetY` - - *number* - Vertical offset in UI units. \ No newline at end of file diff --git a/wiki-information/functions/C_UnitAuras.WantsAlteredForm.md b/wiki-information/functions/C_UnitAuras.WantsAlteredForm.md deleted file mode 100644 index 8d3b424d..00000000 --- a/wiki-information/functions/C_UnitAuras.WantsAlteredForm.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_UnitAuras.WantsAlteredForm - -**Content:** -Needs summary. -`wantsAlteredForm = C_UnitAuras.WantsAlteredForm(unitToken)` - -**Parameters:** -- `unitToken` - - *string* - -**Returns:** -- `wantsAlteredForm` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_UserFeedback.SubmitBug.md b/wiki-information/functions/C_UserFeedback.SubmitBug.md deleted file mode 100644 index 8f511f44..00000000 --- a/wiki-information/functions/C_UserFeedback.SubmitBug.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: C_UserFeedback.SubmitBug - -**Content:** -Replaces `GMSubmitBug`. -`success = C_UserFeedback.SubmitBug(bugInfo)` - -**Parameters:** -- `bugInfo` - - *string* -- `suppressNotification` - - *boolean?* = false - -**Returns:** -- `success` - - *boolean* - -**Example Usage:** -```lua -local bugInfo = "There is a bug with the quest 'A Threat Within'. The NPC does not spawn." -local success = C_UserFeedback.SubmitBug(bugInfo, true) -if success then - print("Bug report submitted successfully.") -else - print("Failed to submit bug report.") -end -``` - -**Description:** -This function is used to submit a bug report directly to Blizzard's bug tracking system. It replaces the older `GMSubmitBug` function. The `suppressNotification` parameter is optional and defaults to `false`. When set to `true`, it suppresses the notification that usually appears after submitting a bug report. - -**Change Log:** -Patch 8.0.1 (2018-07-17): Added. \ No newline at end of file diff --git a/wiki-information/functions/C_UserFeedback.SubmitSuggestion.md b/wiki-information/functions/C_UserFeedback.SubmitSuggestion.md deleted file mode 100644 index f6bb5693..00000000 --- a/wiki-information/functions/C_UserFeedback.SubmitSuggestion.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: C_UserFeedback.SubmitSuggestion - -**Content:** -Replaces `GMSubmitSuggestion`. -`success = C_UserFeedback.SubmitSuggestion(suggestion)` - -**Parameters:** -- `suggestion` - - *string* - -**Returns:** -- `success` - - *boolean* - -**Example Usage:** -```lua -local suggestion = "Add more flight paths in the new zone." -local success = C_UserFeedback.SubmitSuggestion(suggestion) -if success then - print("Suggestion submitted successfully!") -else - print("Failed to submit suggestion.") -end -``` - -**Description:** -This function allows players to submit suggestions directly to the game developers. It replaces the older `GMSubmitSuggestion` function and provides a streamlined way to send feedback. - -**Usage in Addons:** -Large addons like **ElvUI** and **WeakAuras** might use this function to allow users to submit suggestions for improvements or new features directly from the addon interface. This can enhance user engagement and provide valuable feedback to addon developers. \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md b/wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md deleted file mode 100644 index 22cfe865..00000000 --- a/wiki-information/functions/C_VideoOptions.GetCurrentGameWindowSize.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VideoOptions.GetCurrentGameWindowSize - -**Content:** -Needs summary. -`size = C_VideoOptions.GetCurrentGameWindowSize()` - -**Returns:** -- `size` - - *Vector2DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md b/wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md deleted file mode 100644 index 30bd9fd5..00000000 --- a/wiki-information/functions/C_VideoOptions.GetDefaultGameWindowSize.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_VideoOptions.GetDefaultGameWindowSize - -**Content:** -Needs summary. -`size = C_VideoOptions.GetDefaultGameWindowSize(monitor)` - -**Parameters:** -- `monitor` - - *number* - -**Returns:** -- `size` - - *Vector2DMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md b/wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md deleted file mode 100644 index 460bb97f..00000000 --- a/wiki-information/functions/C_VideoOptions.GetGameWindowSizes.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_VideoOptions.GetGameWindowSizes - -**Content:** -Needs summary. -`sizes = C_VideoOptions.GetGameWindowSizes(monitor, fullscreen)` - -**Parameters:** -- `monitor` - - *number* -- `fullscreen` - - *boolean* - -**Returns:** -- `sizes` - - *vector2* \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md b/wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md deleted file mode 100644 index a8adfd8d..00000000 --- a/wiki-information/functions/C_VideoOptions.GetGxAdapterInfo.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_VideoOptions.GetGxAdapterInfo - -**Content:** -Returns info about the system's graphics adapter. -`adapters = C_VideoOptions.GetGxAdapterInfo()` - -**Returns:** -- `adapters` - - *structure* - GxAdapterInfoDetails - - `Field` - - `Type` - - `Description` - - `name` - - *string* - e.g. "NVIDIA GeForce GTX 1060GB" - - `isLowPower` - - *boolean* - - `isExternal` - - *boolean* - whether the adapter is external \ No newline at end of file diff --git a/wiki-information/functions/C_VideoOptions.SetGameWindowSize.md b/wiki-information/functions/C_VideoOptions.SetGameWindowSize.md deleted file mode 100644 index 9c4a997c..00000000 --- a/wiki-information/functions/C_VideoOptions.SetGameWindowSize.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_VideoOptions.SetGameWindowSize - -**Content:** -Needs summary. -`C_VideoOptions.SetGameWindowSize(x, y)` - -**Parameters:** -- `x` - - *number* -- `y` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ActivateChannel.md b/wiki-information/functions/C_VoiceChat.ActivateChannel.md deleted file mode 100644 index 8ae03bae..00000000 --- a/wiki-information/functions/C_VoiceChat.ActivateChannel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.ActivateChannel - -**Content:** -Needs summary. -`C_VoiceChat.ActivateChannel(channelID)` - -**Parameters:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md b/wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md deleted file mode 100644 index eb6c4c61..00000000 --- a/wiki-information/functions/C_VoiceChat.ActivateChannelTranscription.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.ActivateChannelTranscription - -**Content:** -Needs summary. -`C_VoiceChat.ActivateChannelTranscription(channelID)` - -**Parameters:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.BeginLocalCapture.md b/wiki-information/functions/C_VoiceChat.BeginLocalCapture.md deleted file mode 100644 index 15869eaa..00000000 --- a/wiki-information/functions/C_VoiceChat.BeginLocalCapture.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_VoiceChat.BeginLocalCapture - -**Content:** -Needs summary. -`C_VoiceChat.BeginLocalCapture(listenToLocalUser)` - -**Parameters:** -- `listenToLocalUser` - - *boolean* - -**Description:** -This function is used to start capturing local voice input. The `listenToLocalUser` parameter determines whether the local user can hear their own voice during the capture. - -**Example Usage:** -```lua --- Start capturing local voice input and allow the user to hear their own voice -C_VoiceChat.BeginLocalCapture(true) -``` - -**Use in Addons:** -Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to provide voice communication features within their interfaces, allowing users to communicate more effectively during gameplay. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md b/wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md deleted file mode 100644 index 5bd33c69..00000000 --- a/wiki-information/functions/C_VoiceChat.CanPlayerUseVoiceChat.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.CanPlayerUseVoiceChat - -**Content:** -Needs summary. -`canUseVoiceChat = C_VoiceChat.CanPlayerUseVoiceChat()` - -**Returns:** -- `canUseVoiceChat` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.CreateChannel.md b/wiki-information/functions/C_VoiceChat.CreateChannel.md deleted file mode 100644 index 222de635..00000000 --- a/wiki-information/functions/C_VoiceChat.CreateChannel.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: C_VoiceChat.CreateChannel - -**Content:** -Needs summary. -`status = C_VoiceChat.CreateChannel(channelDisplayName)` - -**Parameters:** -- `channelDisplayName` - - *string* - -**Returns:** -- `status` - - *Enum.VoiceChatStatusCode* - - `Enum.VoiceChatStatusCode` - - `Value` - - `Field` - - `Description` - - `0` - Success - - `1` - OperationPending - - `2` - TooManyRequests - - `3` - LoginProhibited - - `4` - ClientNotInitialized - - `5` - ClientNotLoggedIn - - `6` - ClientAlreadyLoggedIn - - `7` - ChannelNameTooShort - - `8` - ChannelNameTooLong - - `9` - ChannelAlreadyExists - - `10` - AlreadyInChannel - - `11` - TargetNotFound - - `12` - Failure - - `13` - ServiceLost - - `14` - UnableToLaunchProxy - - `15` - ProxyConnectionTimeOut - - `16` - ProxyConnectionUnableToConnect - - `17` - ProxyConnectionUnexpectedDisconnect - - `18` - Disabled - - `19` - UnsupportedChatChannelType - - `20` - InvalidCommunityStream - - `21` - PlayerSilenced - - `22` - PlayerVoiceChatParentalDisabled - - `23` - InvalidInputDevice (Added in 8.2.0) - - `24` - InvalidOutputDevice (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.DeactivateChannel.md b/wiki-information/functions/C_VoiceChat.DeactivateChannel.md deleted file mode 100644 index 328da1e9..00000000 --- a/wiki-information/functions/C_VoiceChat.DeactivateChannel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.DeactivateChannel - -**Content:** -Needs summary. -`C_VoiceChat.DeactivateChannel(channelID)` - -**Parameters:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md b/wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md deleted file mode 100644 index 19665f62..00000000 --- a/wiki-information/functions/C_VoiceChat.DeactivateChannelTranscription.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.DeactivateChannelTranscription - -**Content:** -Needs summary. -`C_VoiceChat.DeactivateChannelTranscription(channelID)` - -**Parameters:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.EndLocalCapture.md b/wiki-information/functions/C_VoiceChat.EndLocalCapture.md deleted file mode 100644 index 245268bb..00000000 --- a/wiki-information/functions/C_VoiceChat.EndLocalCapture.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: C_VoiceChat.EndLocalCapture - -**Content:** -Needs summary. -`C_VoiceChat.EndLocalCapture()` - -**Description:** -This function is used to end the local voice chat capture. It is typically used in scenarios where you want to stop capturing the user's voice input, such as when the user leaves a voice chat channel or disables voice chat functionality. - -**Example Usage:** -```lua --- Example of ending local voice chat capture -C_VoiceChat.EndLocalCapture() -print("Voice chat capture has been ended.") -``` - -**Usage in Addons:** -Large addons that manage voice communication, such as "ElvUI" or "DBM (Deadly Boss Mods)", might use this function to control voice chat features, ensuring that voice capture is properly managed when users join or leave voice channels. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetActiveChannelID.md b/wiki-information/functions/C_VoiceChat.GetActiveChannelID.md deleted file mode 100644 index 092fd814..00000000 --- a/wiki-information/functions/C_VoiceChat.GetActiveChannelID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetActiveChannelID - -**Content:** -Needs summary. -`channelID = C_VoiceChat.GetActiveChannelID()` - -**Returns:** -- `channelID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetActiveChannelType.md b/wiki-information/functions/C_VoiceChat.GetActiveChannelType.md deleted file mode 100644 index 2a4e0b6c..00000000 --- a/wiki-information/functions/C_VoiceChat.GetActiveChannelType.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetActiveChannelType - -**Content:** -Needs summary. -`channelType = C_VoiceChat.GetActiveChannelType()` - -**Returns:** -- `channelType` - - *unknown* ChatChannelType (nilable) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md b/wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md deleted file mode 100644 index e7777d64..00000000 --- a/wiki-information/functions/C_VoiceChat.GetAvailableInputDevices.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_VoiceChat.GetAvailableInputDevices - -**Content:** -Needs summary. -`inputDevices = C_VoiceChat.GetAvailableInputDevices()` - -**Returns:** -- `inputDevices` - - *structure* - VoiceAudioDevice (nilable) - - `VoiceAudioDevice` - - `Field` - - `Type` - - `Description` - - `deviceID` - - *string* - - `displayName` - - *string* - - `isActive` - - *boolean* - - `isSystemDefault` - - *boolean* - - `isCommsDefault` - - *boolean* - -**Added in:** 9.1.0 \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md b/wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md deleted file mode 100644 index 3ddc5494..00000000 --- a/wiki-information/functions/C_VoiceChat.GetAvailableOutputDevices.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: C_VoiceChat.GetAvailableOutputDevices - -**Content:** -Needs summary. -`outputDevices = C_VoiceChat.GetAvailableOutputDevices()` - -**Returns:** -- `outputDevices` - - *structure* - VoiceAudioDevice (nilable) - - `VoiceAudioDevice` - - `Field` - - `Type` - - `Description` - - `deviceID` - - *string* - - `displayName` - - *string* - - `isActive` - - *boolean* - - `isSystemDefault` - - *boolean* - - `isCommsDefault` - - *boolean* - -**Change Log:** -- Added in 9.1.0 \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetChannel.md b/wiki-information/functions/C_VoiceChat.GetChannel.md deleted file mode 100644 index 79627b07..00000000 --- a/wiki-information/functions/C_VoiceChat.GetChannel.md +++ /dev/null @@ -1,71 +0,0 @@ -## Title: C_VoiceChat.GetChannel - -**Content:** -Needs summary. -`channel = C_VoiceChat.GetChannel(channelID)` - -**Parameters:** -- `channelID` - - *number* - -**Returns:** -- `channel` - - *structure* - VoiceChatChannel (nilable) - - `VoiceChatChannel` - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `channelID` - - *number* - - `channelType` - - *Enum.ChatChannelType* - - `clubId` - - *string* - - `streamId` - - *string* - - `volume` - - *number* - - `isActive` - - *boolean* - - `isMuted` - - *boolean* - - `isTransmitting` - - *boolean* - - `isTranscribing` - - *boolean* - - `members` - - *VoiceChatMember* - - `Enum.ChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Custom - - `2` - - Private_Party - - Documented as "PrivateParty" - - `3` - - Public_Party - - Documented as "PublicParty" - - `4` - - Communities - - `VoiceChatMember` - - `Field` - - `Type` - - `Description` - - `energy` - - *number* - - `memberID` - - *number* - - `isActive` - - *boolean* - - `isSpeaking` - - *boolean* - - `isMutedForAll` - - *boolean* - - `isSilenced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md b/wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md deleted file mode 100644 index 7e632a05..00000000 --- a/wiki-information/functions/C_VoiceChat.GetChannelForChannelType.md +++ /dev/null @@ -1,56 +0,0 @@ -## Title: C_VoiceChat.GetChannelForChannelType - -**Content:** -Needs summary. -`channel = C_VoiceChat.GetChannelForChannelType(channelType)` - -**Parameters:** -- `channelType` - - *Enum.ChatChannelType* - - `Enum.ChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - Custom - - `2` - Private_Party (Documented as "PrivateParty") - - `3` - Public_Party (Documented as "PublicParty") - - `4` - Communities - -**Returns:** -- `channel` - - *structure* - VoiceChatChannel (nilable) - - `VoiceChatChannel` - - `Field` - - `Type` - - `Description` - - `name` - *string* - - `channelID` - *number* - - `channelType` - *Enum.ChatChannelType* - - `clubId` - *string* - - `streamId` - *string* - - `volume` - *number* - - `isActive` - *boolean* - - `isMuted` - *boolean* - - `isTransmitting` - *boolean* - - `isTranscribing` - *boolean* (Added in 9.1.0) - - `members` - *VoiceChatMember* - - `Enum.ChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - None - - `1` - Custom - - `2` - Private_Party (Documented as "PrivateParty") - - `3` - Public_Party (Documented as "PublicParty") - - `4` - Communities - - `VoiceChatMember` - - `Field` - - `Type` - - `Description` - - `energy` - *number* - - `memberID` - *number* - - `isActive` - *boolean* - - `isSpeaking` - *boolean* - - `isMutedForAll` - *boolean* - - `isSilenced` - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md b/wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md deleted file mode 100644 index e18c79ae..00000000 --- a/wiki-information/functions/C_VoiceChat.GetChannelForCommunityStream.md +++ /dev/null @@ -1,75 +0,0 @@ -## Title: C_VoiceChat.GetChannelForCommunityStream - -**Content:** -Needs summary. -`channel = C_VoiceChat.GetChannelForCommunityStream(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* - -**Returns:** -- `channel` - - *structure* - VoiceChatChannel (nilable) - - `VoiceChatChannel` - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `channelID` - - *number* - - `channelType` - - *Enum.ChatChannelType* - - `clubId` - - *string* - - `streamId` - - *string* - - `volume` - - *number* - - `isActive` - - *boolean* - - `isMuted` - - *boolean* - - `isTransmitting` - - *boolean* - - `isTranscribing` - - *boolean* - - `members` - - *VoiceChatMember* - - `Enum.ChatChannelType` - - `Value` - - `Field` - - `Description` - - `0` - - None - - `1` - - Custom - - `2` - - Private_Party - - Documented as "PrivateParty" - - `3` - - Public_Party - - Documented as "PublicParty" - - `4` - - Communities - - `VoiceChatMember` - - `Field` - - `Type` - - `Description` - - `energy` - - *number* - - `memberID` - - *number* - - `isActive` - - *boolean* - - `isSpeaking` - - *boolean* - - `isMutedForAll` - - *boolean* - - `isSilenced` - - *boolean* - -**Added in 9.1.0** \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetCommunicationMode.md b/wiki-information/functions/C_VoiceChat.GetCommunicationMode.md deleted file mode 100644 index 83335740..00000000 --- a/wiki-information/functions/C_VoiceChat.GetCommunicationMode.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_VoiceChat.GetCommunicationMode - -**Content:** -Needs summary. -`communicationMode = C_VoiceChat.GetCommunicationMode()` - -**Returns:** -- `communicationMode` - - *Enum.CommunicationMode (nilable)* - - *Enum.CommunicationMode* - - `Value` - - `Field` - - `Description` - - `0` - - `PushToTalk` - - `1` - - `OpenMic` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md b/wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md deleted file mode 100644 index ba63490f..00000000 --- a/wiki-information/functions/C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode.md +++ /dev/null @@ -1,62 +0,0 @@ -## Title: C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode - -**Content:** -Needs summary. -`statusCode = C_VoiceChat.GetCurrentVoiceChatConnectionStatusCode()` - -**Returns:** -- `statusCode` - - *Enum.VoiceChatStatusCode?* - - `Value` - - `Field` - - `Description` - - `0` - - Success - - `1` - - OperationPending - - `2` - - TooManyRequests - - `3` - - LoginProhibited - - `4` - - ClientNotInitialized - - `5` - - ClientNotLoggedIn - - `6` - - ClientAlreadyLoggedIn - - `7` - - ChannelNameTooShort - - `8` - - ChannelNameTooLong - - `9` - - ChannelAlreadyExists - - `10` - - AlreadyInChannel - - `11` - - TargetNotFound - - `12` - - Failure - - `13` - - ServiceLost - - `14` - - UnableToLaunchProxy - - `15` - - ProxyConnectionTimeOut - - `16` - - ProxyConnectionUnableToConnect - - `17` - - ProxyConnectionUnexpectedDisconnect - - `18` - - Disabled - - `19` - - UnsupportedChatChannelType - - `20` - - InvalidCommunityStream - - `21` - - PlayerSilenced - - `22` - - PlayerVoiceChatParentalDisabled - - `23` - - InvalidInputDevice (Added in 8.2.0) - - `24` - - InvalidOutputDevice (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetInputVolume.md b/wiki-information/functions/C_VoiceChat.GetInputVolume.md deleted file mode 100644 index 6f986d81..00000000 --- a/wiki-information/functions/C_VoiceChat.GetInputVolume.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetInputVolume - -**Content:** -Needs summary. -`volume = C_VoiceChat.GetInputVolume()` - -**Returns:** -- `volume` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md b/wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md deleted file mode 100644 index 02201e25..00000000 --- a/wiki-information/functions/C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo - -**Content:** -Needs summary. -`memberInfo = C_VoiceChat.GetLocalPlayerActiveChannelMemberInfo()` - -**Returns:** -- `memberInfo` - - *structure* - VoiceChatMember (nilable) - - `VoiceChatMember` - - `Field` - - `Type` - - `Description` - - `energy` - - *number* - - `memberID` - - *number* - - `isActive` - - *boolean* - - `isSpeaking` - - *boolean* - - `isMutedForAll` - - *boolean* - - `isSilenced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md b/wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md deleted file mode 100644 index 028ba1df..00000000 --- a/wiki-information/functions/C_VoiceChat.GetLocalPlayerMemberID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_VoiceChat.GetLocalPlayerMemberID - -**Content:** -Needs summary. -`memberID = C_VoiceChat.GetLocalPlayerMemberID(channelID)` - -**Parameters:** -- `channelID` - - *number* - -**Returns:** -- `memberID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md b/wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md deleted file mode 100644 index ebc4b154..00000000 --- a/wiki-information/functions/C_VoiceChat.GetMasterVolumeScale.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetMasterVolumeScale - -**Content:** -Needs summary. -`scale = C_VoiceChat.GetMasterVolumeScale()` - -**Returns:** -- `scale` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberGUID.md b/wiki-information/functions/C_VoiceChat.GetMemberGUID.md deleted file mode 100644 index fd23c7bd..00000000 --- a/wiki-information/functions/C_VoiceChat.GetMemberGUID.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_VoiceChat.GetMemberGUID - -**Content:** -Needs summary. -`memberGUID = C_VoiceChat.GetMemberGUID(memberID, channelID)` - -**Parameters:** -- `memberID` - - *number* -- `channelID` - - *number* - -**Returns:** -- `memberGUID` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberID.md b/wiki-information/functions/C_VoiceChat.GetMemberID.md deleted file mode 100644 index c6450ad6..00000000 --- a/wiki-information/functions/C_VoiceChat.GetMemberID.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_VoiceChat.GetMemberID - -**Content:** -Needs summary. -`memberID = C_VoiceChat.GetMemberID(channelID, memberGUID)` - -**Parameters:** -- `channelID` - - *number* -- `memberGUID` - - *string* - -**Returns:** -- `memberID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberInfo.md b/wiki-information/functions/C_VoiceChat.GetMemberInfo.md deleted file mode 100644 index daf11bde..00000000 --- a/wiki-information/functions/C_VoiceChat.GetMemberInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_VoiceChat.GetMemberInfo - -**Content:** -Needs summary. -`memberInfo = C_VoiceChat.GetMemberInfo(memberID, channelID)` - -**Parameters:** -- `memberID` - - *number* -- `channelID` - - *number* - -**Returns:** -- `memberInfo` - - *structure* - VoiceChatMember (nilable) - - `VoiceChatMember` - - `Field` - - `Type` - - `Description` - - `energy` - - *number* - - `memberID` - - *number* - - `isActive` - - *boolean* - - `isSpeaking` - - *boolean* - - `isMutedForAll` - - *boolean* - - `isSilenced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberName.md b/wiki-information/functions/C_VoiceChat.GetMemberName.md deleted file mode 100644 index 92346baa..00000000 --- a/wiki-information/functions/C_VoiceChat.GetMemberName.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_VoiceChat.GetMemberName - -**Content:** -Needs summary. -`memberName = C_VoiceChat.GetMemberName(memberID, channelID)` - -**Parameters:** -- `memberID` - - *number* -- `channelID` - - *number* - -**Returns:** -- `memberName` - - *string?* - -**Description:** -This function retrieves the name of a member in a specified voice chat channel. It can be useful for addons that manage or display voice chat information, such as showing who is speaking in a voice channel. - -**Example Usage:** -An addon could use this function to display the names of all members in a voice chat channel, helping users to identify who is currently connected and speaking. - -**Addons:** -Large addons like **DBM (Deadly Boss Mods)** or **ElvUI** might use this function to enhance their voice chat features, providing better integration and user experience by displaying member names in their custom UI elements. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetMemberVolume.md b/wiki-information/functions/C_VoiceChat.GetMemberVolume.md deleted file mode 100644 index 64cc4864..00000000 --- a/wiki-information/functions/C_VoiceChat.GetMemberVolume.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_VoiceChat.GetMemberVolume - -**Content:** -Needs summary. -`volume = C_VoiceChat.GetMemberVolume(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin*🔗 - -**Returns:** -- `volume` - - *number?* - -**Description:** -This function retrieves the volume level for a specific member in the voice chat, identified by their `playerLocation`. - -**Example Usage:** -```lua -local playerLocation = PlayerLocation:CreateFromUnit("player") -local volume = C_VoiceChat.GetMemberVolume(playerLocation) -print("Current volume level for the player:", volume) -``` - -**Addons Using This Function:** -- **DBM (Deadly Boss Mods):** Utilizes this function to adjust voice alerts based on individual player volume settings. -- **ElvUI:** May use this function to integrate voice chat volume controls within its comprehensive UI customization options. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetOutputVolume.md b/wiki-information/functions/C_VoiceChat.GetOutputVolume.md deleted file mode 100644 index b825a98a..00000000 --- a/wiki-information/functions/C_VoiceChat.GetOutputVolume.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetOutputVolume - -**Content:** -Needs summary. -`volume = C_VoiceChat.GetOutputVolume()` - -**Returns:** -- `volume` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md b/wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md deleted file mode 100644 index 6bb2aabe..00000000 --- a/wiki-information/functions/C_VoiceChat.GetPTTButtonPressedState.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetPTTButtonPressedState - -**Content:** -Needs summary. -`isPressed = C_VoiceChat.GetPTTButtonPressedState()` - -**Returns:** -- `isPressed` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetProcesses.md b/wiki-information/functions/C_VoiceChat.GetProcesses.md deleted file mode 100644 index 840e51f0..00000000 --- a/wiki-information/functions/C_VoiceChat.GetProcesses.md +++ /dev/null @@ -1,78 +0,0 @@ -## Title: C_VoiceChat.GetProcesses - -**Content:** -Needs summary. -`processes = C_VoiceChat.GetProcesses()` - -**Returns:** -- `processes` - - *structure* - VoiceChatProcess - - `Field` - - `Type` - - `Description` - - `name` - - *string* - - `channels` - - *structure* VoiceChatChannel - -**VoiceChatChannel:** -- `Field` -- `Type` -- `Description` -- `name` - - *string* -- `channelID` - - *number* -- `channelType` - - *Enum.ChatChannelType* -- `clubId` - - *string* -- `streamId` - - *string* -- `volume` - - *number* -- `isActive` - - *boolean* -- `isMuted` - - *boolean* -- `isTransmitting` - - *boolean* -- `isTranscribing` - - *boolean* -- `Added in 9.1.0` -- `members` - - *VoiceChatMember* - -**Enum.ChatChannelType:** -- `Value` -- `Field` -- `Description` -- `0` - - None -- `1` - - Custom -- `2` - - Private_Party - - Documented as "PrivateParty" -- `3` - - Public_Party - - Documented as "PublicParty" -- `4` - - Communities - -**VoiceChatMember:** -- `Field` -- `Type` -- `Description` -- `energy` - - *number* -- `memberID` - - *number* -- `isActive` - - *boolean* -- `isSpeaking` - - *boolean* -- `isMutedForAll` - - *boolean* -- `isSilenced` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md b/wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md deleted file mode 100644 index 8a7b8258..00000000 --- a/wiki-information/functions/C_VoiceChat.GetPushToTalkBinding.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetPushToTalkBinding - -**Content:** -Needs summary. -`keys = C_VoiceChat.GetPushToTalkBinding()` - -**Returns:** -- `keys` - - *string?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md b/wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md deleted file mode 100644 index 00256f89..00000000 --- a/wiki-information/functions/C_VoiceChat.GetRemoteTtsVoices.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_VoiceChat.GetRemoteTtsVoices - -**Content:** -Needs summary. -`ttsVoices = C_VoiceChat.GetRemoteTtsVoices()` - -**Returns:** -- `ttsVoices` - - *VoiceTtsVoiceType* - - `Field` - - `Type` - - `Description` - - `voiceID` - - *number* - - `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetTtsVoices.md b/wiki-information/functions/C_VoiceChat.GetTtsVoices.md deleted file mode 100644 index de93ebb1..00000000 --- a/wiki-information/functions/C_VoiceChat.GetTtsVoices.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_VoiceChat.GetTtsVoices - -**Content:** -Needs summary. -`ttsVoices = C_VoiceChat.GetTtsVoices()` - -**Returns:** -- `ttsVoices` - - *VoiceTtsVoiceType* - - `Field` - - `Type` - - `Description` - - `voiceID` - - *number* - - `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.GetVADSensitivity.md b/wiki-information/functions/C_VoiceChat.GetVADSensitivity.md deleted file mode 100644 index ed00a853..00000000 --- a/wiki-information/functions/C_VoiceChat.GetVADSensitivity.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.GetVADSensitivity - -**Content:** -Needs summary. -`sensitivity = C_VoiceChat.GetVADSensitivity()` - -**Returns:** -- `sensitivity` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md b/wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md deleted file mode 100644 index e49aafde..00000000 --- a/wiki-information/functions/C_VoiceChat.IsChannelJoinPending.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: C_VoiceChat.IsChannelJoinPending - -**Content:** -Needs summary. -`isPending = C_VoiceChat.IsChannelJoinPending(channelType)` - -**Parameters:** -- `channelType` - - *Enum.ChatChannelType* -- `clubId` - - *string?* -- `streamId` - - *string?* - -**Enum.ChatChannelType Values:** -- `0` - - `None` -- `1` - - `Custom` -- `2` - - `Private_Party` - - Documented as "PrivateParty" -- `3` - - `Public_Party` - - Documented as "PublicParty" -- `4` - - `Communities` - -**Returns:** -- `isPending` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsDeafened.md b/wiki-information/functions/C_VoiceChat.IsDeafened.md deleted file mode 100644 index cddd1cc0..00000000 --- a/wiki-information/functions/C_VoiceChat.IsDeafened.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsDeafened - -**Content:** -Needs summary. -`isDeafened = C_VoiceChat.IsDeafened()` - -**Returns:** -- `isDeafened` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsEnabled.md b/wiki-information/functions/C_VoiceChat.IsEnabled.md deleted file mode 100644 index 250a3f02..00000000 --- a/wiki-information/functions/C_VoiceChat.IsEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsEnabled - -**Content:** -Needs summary. -`isEnabled = C_VoiceChat.IsEnabled()` - -**Returns:** -- `isEnabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsLoggedIn.md b/wiki-information/functions/C_VoiceChat.IsLoggedIn.md deleted file mode 100644 index 35663767..00000000 --- a/wiki-information/functions/C_VoiceChat.IsLoggedIn.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsLoggedIn - -**Content:** -Needs summary. -`isLoggedIn = C_VoiceChat.IsLoggedIn()` - -**Returns:** -- `isLoggedIn` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md b/wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md deleted file mode 100644 index e9a3b3a5..00000000 --- a/wiki-information/functions/C_VoiceChat.IsMemberLocalPlayer.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_VoiceChat.IsMemberLocalPlayer - -**Content:** -Needs summary. -`isLocalPlayer = C_VoiceChat.IsMemberLocalPlayer(memberID, channelID)` - -**Parameters:** -- `memberID` - - *number* -- `channelID` - - *number* - -**Returns:** -- `isLocalPlayer` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMemberMuted.md b/wiki-information/functions/C_VoiceChat.IsMemberMuted.md deleted file mode 100644 index f1bca09e..00000000 --- a/wiki-information/functions/C_VoiceChat.IsMemberMuted.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: C_VoiceChat.IsMemberMuted - -**Content:** -Needs summary. -`mutedForMe = C_VoiceChat.IsMemberMuted(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* - -**Returns:** -- `mutedForMe` - - *boolean?* - -**Description:** -This function checks if a specific member in the voice chat is muted for the player. The `playerLocation` parameter is a `PlayerLocationMixin` object that specifies the location of the player whose mute status is being queried. - -**Example Usage:** -```lua -local playerLocation = PlayerLocation:CreateFromUnit("target") -local isMuted = C_VoiceChat.IsMemberMuted(playerLocation) -print("Is the target muted for me?", isMuted) -``` - -**Addons Using This Function:** -- **DBM (Deadly Boss Mods):** Uses this function to ensure that important voice alerts are not missed by checking if key members are muted. -- **ElvUI:** Utilizes this function to manage voice chat settings and ensure smooth communication during raids and battlegrounds. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md b/wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md deleted file mode 100644 index f83db14a..00000000 --- a/wiki-information/functions/C_VoiceChat.IsMemberMutedForAll.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: C_VoiceChat.IsMemberMutedForAll - -**Content:** -Needs summary. -`mutedForAll = C_VoiceChat.IsMemberMutedForAll(memberID, channelID)` - -**Parameters:** -- `memberID` - - *number* -- `channelID` - - *number* - -**Returns:** -- `mutedForAll` - - *boolean?* - diff --git a/wiki-information/functions/C_VoiceChat.IsMemberSilenced.md b/wiki-information/functions/C_VoiceChat.IsMemberSilenced.md deleted file mode 100644 index 43923c3c..00000000 --- a/wiki-information/functions/C_VoiceChat.IsMemberSilenced.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_VoiceChat.IsMemberSilenced - -**Content:** -Needs summary. -`silenced = C_VoiceChat.IsMemberSilenced(memberID, channelID)` - -**Parameters:** -- `memberID` - - *number* -- `channelID` - - *number* - -**Returns:** -- `silenced` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsMuted.md b/wiki-information/functions/C_VoiceChat.IsMuted.md deleted file mode 100644 index 599eb452..00000000 --- a/wiki-information/functions/C_VoiceChat.IsMuted.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsMuted - -**Content:** -Needs summary. -`isMuted = C_VoiceChat.IsMuted()` - -**Returns:** -- `isMuted` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsParentalDisabled.md b/wiki-information/functions/C_VoiceChat.IsParentalDisabled.md deleted file mode 100644 index fed787e2..00000000 --- a/wiki-information/functions/C_VoiceChat.IsParentalDisabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsParentalDisabled - -**Content:** -Needs summary. -`isParentalDisabled = C_VoiceChat.IsParentalDisabled()` - -**Returns:** -- `isParentalDisabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsParentalMuted.md b/wiki-information/functions/C_VoiceChat.IsParentalMuted.md deleted file mode 100644 index 7185ae90..00000000 --- a/wiki-information/functions/C_VoiceChat.IsParentalMuted.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsParentalMuted - -**Content:** -Needs summary. -`isParentalMuted = C_VoiceChat.IsParentalMuted()` - -**Returns:** -- `isParentalMuted` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md b/wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md deleted file mode 100644 index 6eb7226f..00000000 --- a/wiki-information/functions/C_VoiceChat.IsPlayerUsingVoice.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_VoiceChat.IsPlayerUsingVoice - -**Content:** -Needs summary. -`isUsingVoice = C_VoiceChat.IsPlayerUsingVoice(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* - -**Returns:** -- `isUsingVoice` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsSilenced.md b/wiki-information/functions/C_VoiceChat.IsSilenced.md deleted file mode 100644 index fcc1e732..00000000 --- a/wiki-information/functions/C_VoiceChat.IsSilenced.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsSilenced - -**Content:** -Needs summary. -`isSilenced = C_VoiceChat.IsSilenced()` - -**Returns:** -- `isSilenced` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md b/wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md deleted file mode 100644 index 58d0d75d..00000000 --- a/wiki-information/functions/C_VoiceChat.IsSpeakForMeActive.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsSpeakForMeActive - -**Content:** -Needs summary. -`isActive = C_VoiceChat.IsSpeakForMeActive()` - -**Returns:** -- `isActive` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md b/wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md deleted file mode 100644 index dcda2e51..00000000 --- a/wiki-information/functions/C_VoiceChat.IsSpeakForMeAllowed.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsSpeakForMeAllowed - -**Content:** -Needs summary. -`isAllowed = C_VoiceChat.IsSpeakForMeAllowed()` - -**Returns:** -- `isAllowed` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsTranscribing.md b/wiki-information/functions/C_VoiceChat.IsTranscribing.md deleted file mode 100644 index 2e5339d5..00000000 --- a/wiki-information/functions/C_VoiceChat.IsTranscribing.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsTranscribing - -**Content:** -Needs summary. -`isTranscribing = C_VoiceChat.IsTranscribing()` - -**Returns:** -- `isTranscribing` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md b/wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md deleted file mode 100644 index e86ea0ca..00000000 --- a/wiki-information/functions/C_VoiceChat.IsTranscriptionAllowed.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsTranscriptionAllowed - -**Content:** -Needs summary. -`isAllowed = C_VoiceChat.IsTranscriptionAllowed()` - -**Returns:** -- `isAllowed` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md b/wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md deleted file mode 100644 index 0688dadc..00000000 --- a/wiki-information/functions/C_VoiceChat.IsVoiceChatConnected.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.IsVoiceChatConnected - -**Content:** -Needs summary. -`connected = C_VoiceChat.IsVoiceChatConnected()` - -**Returns:** -- `connected` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.LeaveChannel.md b/wiki-information/functions/C_VoiceChat.LeaveChannel.md deleted file mode 100644 index c839fed4..00000000 --- a/wiki-information/functions/C_VoiceChat.LeaveChannel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.LeaveChannel - -**Content:** -Needs summary. -`C_VoiceChat.LeaveChannel(channelID)` - -**Parameters:** -- `channelID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.Login.md b/wiki-information/functions/C_VoiceChat.Login.md deleted file mode 100644 index 78eebc88..00000000 --- a/wiki-information/functions/C_VoiceChat.Login.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_VoiceChat.Login - -**Content:** -Needs summary. -`status = C_VoiceChat.Login()` - -**Returns:** -- `status` - - *Enum.VoiceChatStatusCode* - - `Enum.VoiceChatStatusCode` - - `Value` - - `Field` - - `Description` - - `0` - Success - - `1` - OperationPending - - `2` - TooManyRequests - - `3` - LoginProhibited - - `4` - ClientNotInitialized - - `5` - ClientNotLoggedIn - - `6` - ClientAlreadyLoggedIn - - `7` - ChannelNameTooShort - - `8` - ChannelNameTooLong - - `9` - ChannelAlreadyExists - - `10` - AlreadyInChannel - - `11` - TargetNotFound - - `12` - Failure - - `13` - ServiceLost - - `14` - UnableToLaunchProxy - - `15` - ProxyConnectionTimeOut - - `16` - ProxyConnectionUnableToConnect - - `17` - ProxyConnectionUnexpectedDisconnect - - `18` - Disabled - - `19` - UnsupportedChatChannelType - - `20` - InvalidCommunityStream - - `21` - PlayerSilenced - - `22` - PlayerVoiceChatParentalDisabled - - `23` - InvalidInputDevice (Added in 8.2.0) - - `24` - InvalidOutputDevice (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.Logout.md b/wiki-information/functions/C_VoiceChat.Logout.md deleted file mode 100644 index e6ed2c57..00000000 --- a/wiki-information/functions/C_VoiceChat.Logout.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: C_VoiceChat.Logout - -**Content:** -Needs summary. -`status = C_VoiceChat.Logout()` - -**Returns:** -- `status` - - *Enum.VoiceChatStatusCode* - - `Enum.VoiceChatStatusCode` - - `Value` - - `Field` - - `Description` - - `0` - - `Success` - - `1` - - `OperationPending` - - `2` - - `TooManyRequests` - - `3` - - `LoginProhibited` - - `4` - - `ClientNotInitialized` - - `5` - - `ClientNotLoggedIn` - - `6` - - `ClientAlreadyLoggedIn` - - `7` - - `ChannelNameTooShort` - - `8` - - `ChannelNameTooLong` - - `9` - - `ChannelAlreadyExists` - - `10` - - `AlreadyInChannel` - - `11` - - `TargetNotFound` - - `12` - - `Failure` - - `13` - - `ServiceLost` - - `14` - - `UnableToLaunchProxy` - - `15` - - `ProxyConnectionTimeOut` - - `16` - - `ProxyConnectionUnableToConnect` - - `17` - - `ProxyConnectionUnexpectedDisconnect` - - `18` - - `Disabled` - - `19` - - `UnsupportedChatChannelType` - - `20` - - `InvalidCommunityStream` - - `21` - - `PlayerSilenced` - - `22` - - `PlayerVoiceChatParentalDisabled` - - `23` - - `InvalidInputDevice` (Added in 8.2.0) - - `24` - - `InvalidOutputDevice` (Added in 8.2.0) \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md b/wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md deleted file mode 100644 index a8b8e9ea..00000000 --- a/wiki-information/functions/C_VoiceChat.MarkChannelsDiscovered.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: C_VoiceChat.MarkChannelsDiscovered - -**Content:** -Needs summary. -`C_VoiceChat.MarkChannelsDiscovered()` - -**Description:** -Once the UI has enumerated all channels, use this to reset the channel discovery state, it will be updated again if appropriate. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md b/wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md deleted file mode 100644 index 56fac07f..00000000 --- a/wiki-information/functions/C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel - -**Content:** -Needs summary. -`C_VoiceChat.RequestJoinAndActivateCommunityStreamChannel(clubId, streamId)` - -**Parameters:** -- `clubId` - - *string* -- `streamId` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md b/wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md deleted file mode 100644 index a3776c26..00000000 --- a/wiki-information/functions/C_VoiceChat.RequestJoinChannelByChannelType.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: C_VoiceChat.RequestJoinChannelByChannelType - -**Content:** -Needs summary. -`C_VoiceChat.RequestJoinChannelByChannelType(channelType)` - -**Parameters:** -- `channelType` - - *Enum.ChatChannelType* - - `Value` - - `Field` - - `Description` - - `0` - - `None` - - `1` - - `Custom` - - `2` - - `Private_Party` - - Documented as "PrivateParty" - - `3` - - `Public_Party` - - Documented as "PublicParty" - - `4` - - `Communities` - -**Additional Information:** -- `autoActivate` - - *boolean?* - -**Example Usage:** -```lua --- Example of joining a custom voice chat channel -C_VoiceChat.RequestJoinChannelByChannelType(Enum.ChatChannelType.Custom) -``` - -**Addons Usage:** -Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to facilitate voice communication within custom or party channels, enhancing coordination during raids or group activities. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetCommunicationMode.md b/wiki-information/functions/C_VoiceChat.SetCommunicationMode.md deleted file mode 100644 index 0b4e5dcd..00000000 --- a/wiki-information/functions/C_VoiceChat.SetCommunicationMode.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: C_VoiceChat.SetCommunicationMode - -**Content:** -Needs summary. -`C_VoiceChat.SetCommunicationMode(communicationMode)` - -**Parameters:** -- `communicationMode` - - *Enum.CommunicationMode* - - `Enum.CommunicationMode` - - **Value** - - **Field** - - **Description** - - `0` - - PushToTalk - - `1` - - OpenMic \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetDeafened.md b/wiki-information/functions/C_VoiceChat.SetDeafened.md deleted file mode 100644 index d345feb4..00000000 --- a/wiki-information/functions/C_VoiceChat.SetDeafened.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetDeafened - -**Content:** -Needs summary. -`C_VoiceChat.SetDeafened(isDeafened)` - -**Parameters:** -- `isDeafened` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetInputDevice.md b/wiki-information/functions/C_VoiceChat.SetInputDevice.md deleted file mode 100644 index c4a7dfda..00000000 --- a/wiki-information/functions/C_VoiceChat.SetInputDevice.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetInputDevice - -**Content:** -Needs summary. -`C_VoiceChat.SetInputDevice(deviceID)` - -**Parameters:** -- `deviceID` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetInputVolume.md b/wiki-information/functions/C_VoiceChat.SetInputVolume.md deleted file mode 100644 index b7d478da..00000000 --- a/wiki-information/functions/C_VoiceChat.SetInputVolume.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetInputVolume - -**Content:** -Needs summary. -`C_VoiceChat.SetInputVolume(volume)` - -**Parameters:** -- `volume` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md b/wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md deleted file mode 100644 index aaacceed..00000000 --- a/wiki-information/functions/C_VoiceChat.SetMasterVolumeScale.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetMasterVolumeScale - -**Content:** -Needs summary. -`C_VoiceChat.SetMasterVolumeScale(scale)` - -**Parameters:** -- `scale` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMemberMuted.md b/wiki-information/functions/C_VoiceChat.SetMemberMuted.md deleted file mode 100644 index 6ec61f2b..00000000 --- a/wiki-information/functions/C_VoiceChat.SetMemberMuted.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_VoiceChat.SetMemberMuted - -**Content:** -Needs summary. -`C_VoiceChat.SetMemberMuted(playerLocation, muted)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* - The location of the player to be muted. -- `muted` - - *boolean* - Whether the player should be muted (true) or unmuted (false). - -**Example Usage:** -```lua -local playerLocation = PlayerLocation:CreateFromUnit("target") -C_VoiceChat.SetMemberMuted(playerLocation, true) -``` - -This function can be used to programmatically mute or unmute a player in voice chat, which can be useful in addons that manage voice communication, such as raid coordination tools or social addons. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMemberVolume.md b/wiki-information/functions/C_VoiceChat.SetMemberVolume.md deleted file mode 100644 index 87f776cb..00000000 --- a/wiki-information/functions/C_VoiceChat.SetMemberVolume.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: C_VoiceChat.SetMemberVolume - -**Content:** -Needs summary. -`C_VoiceChat.SetMemberVolume(playerLocation, volume)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* -- `volume` - - *number* - -**Description:** -Adjusts member volume across all channels. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetMuted.md b/wiki-information/functions/C_VoiceChat.SetMuted.md deleted file mode 100644 index 0929b73b..00000000 --- a/wiki-information/functions/C_VoiceChat.SetMuted.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetMuted - -**Content:** -Needs summary. -`C_VoiceChat.SetMuted(isMuted)` - -**Parameters:** -- `isMuted` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetOutputDevice.md b/wiki-information/functions/C_VoiceChat.SetOutputDevice.md deleted file mode 100644 index ac00271b..00000000 --- a/wiki-information/functions/C_VoiceChat.SetOutputDevice.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetOutputDevice - -**Content:** -Needs summary. -`C_VoiceChat.SetOutputDevice(deviceID)` - -**Parameters:** -- `deviceID` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetOutputVolume.md b/wiki-information/functions/C_VoiceChat.SetOutputVolume.md deleted file mode 100644 index a8aea529..00000000 --- a/wiki-information/functions/C_VoiceChat.SetOutputVolume.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetOutputVolume - -**Content:** -Needs summary. -`C_VoiceChat.SetOutputVolume(volume)` - -**Parameters:** -- `volume` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetPortraitTexture.md b/wiki-information/functions/C_VoiceChat.SetPortraitTexture.md deleted file mode 100644 index af6aa557..00000000 --- a/wiki-information/functions/C_VoiceChat.SetPortraitTexture.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_VoiceChat.SetPortraitTexture - -**Content:** -Needs summary. -`C_VoiceChat.SetPortraitTexture(textureObject, memberID, channelID)` - -**Parameters:** -- `textureObject` - - *table* -- `memberID` - - *number* -- `channelID` - - *number* - -**Example Usage:** -This function can be used to set the portrait texture for a voice chat member in a specific channel. For instance, if you are developing an addon that manages voice chat and you want to display the portrait of each member in the chat, you can use this function to set the appropriate texture. - -**Addon Usage:** -Large addons like **ElvUI** or **DBM (Deadly Boss Mods)** might use this function to enhance their voice chat features, such as displaying member portraits in custom UI elements or during boss encounters to show who is speaking. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md b/wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md deleted file mode 100644 index ba419f15..00000000 --- a/wiki-information/functions/C_VoiceChat.SetPushToTalkBinding.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetPushToTalkBinding - -**Content:** -Needs summary. -`C_VoiceChat.SetPushToTalkBinding(keys)` - -**Parameters:** -- `keys` - - *table* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SetVADSensitivity.md b/wiki-information/functions/C_VoiceChat.SetVADSensitivity.md deleted file mode 100644 index e695e88b..00000000 --- a/wiki-information/functions/C_VoiceChat.SetVADSensitivity.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SetVADSensitivity - -**Content:** -Needs summary. -`C_VoiceChat.SetVADSensitivity(sensitivity)` - -**Parameters:** -- `sensitivity` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md b/wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md deleted file mode 100644 index 3cd28206..00000000 --- a/wiki-information/functions/C_VoiceChat.ShouldDiscoverChannels.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: C_VoiceChat.ShouldDiscoverChannels - -**Content:** -Needs summary. -`shouldDiscoverChannels = C_VoiceChat.ShouldDiscoverChannels()` - -**Returns:** -- `shouldDiscoverChannels` - - *boolean* - -**Description:** -Use this while loading to determine if the UI should attempt to rediscover the previously joined/active voice channels. \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md b/wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md deleted file mode 100644 index b7ad7462..00000000 --- a/wiki-information/functions/C_VoiceChat.SpeakRemoteTextSample.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.SpeakRemoteTextSample - -**Content:** -Needs summary. -`C_VoiceChat.SpeakRemoteTextSample(text)` - -**Parameters:** -- `text` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.SpeakText.md b/wiki-information/functions/C_VoiceChat.SpeakText.md deleted file mode 100644 index 9d8c4b58..00000000 --- a/wiki-information/functions/C_VoiceChat.SpeakText.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: C_VoiceChat.SpeakText - -**Content:** -Reads text to speech. -`C_VoiceChat.SpeakText(voiceID, text, destination, rate, volume)` - -**Parameters:** -- `voiceID` - - *number* - Voice IDs from `.GetTtsVoices` or `.GetRemoteTtsVoices`. -- `text` - - *string* - The message to speak. -- `destination` - - *Enum.VoiceTtsDestination* - - `Value` - - `Field` - - `Description` - - `0` - RemoteTransmission - - `1` - LocalPlayback - - `2` - RemoteTransmissionWithLocalPlayback - - `3` - QueuedRemoteTransmission - - `4` - QueuedLocalPlayback - - `5` - QueuedRemoteTransmissionWithLocalPlayback - - `6` - ScreenReader -- `rate` - - *number* - Speech rate; the speed at which the text is read. -- `volume` - - *number* - Volume level of the speech. - -**Description:** -Despite the name, nearly-simultaneous queued messages will play out of order; the 'queue' is neither FIFO or LIFO. -The languages packs installed will vary, and it is possible for none to be installed. The user's local preferences may be found with `C_TTSSettings.GetVoiceOptionID`. - -**Usage:** -Speaks a message with Microsoft David (enUS system locale). -```lua -/run C_VoiceChat.SpeakText(0, "Hello world", Enum.VoiceTtsDestination.LocalPlayback, 0, 100) -``` -Speaks a message with Microsoft Zira (enUS system locale), with a slower speech rate. -```lua -/run C_VoiceChat.SpeakText(1, "Hello world", Enum.VoiceTtsDestination.LocalPlayback, -10, 100) -``` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.StopSpeakingText.md b/wiki-information/functions/C_VoiceChat.StopSpeakingText.md deleted file mode 100644 index 561b7f22..00000000 --- a/wiki-information/functions/C_VoiceChat.StopSpeakingText.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_VoiceChat.StopSpeakingText - -**Content:** -Needs summary. -`C_VoiceChat.StopSpeakingText()` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ToggleDeafened.md b/wiki-information/functions/C_VoiceChat.ToggleDeafened.md deleted file mode 100644 index f89a6429..00000000 --- a/wiki-information/functions/C_VoiceChat.ToggleDeafened.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_VoiceChat.ToggleDeafened - -**Content:** -Needs summary. -`C_VoiceChat.ToggleDeafened()` \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md b/wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md deleted file mode 100644 index abfaff16..00000000 --- a/wiki-information/functions/C_VoiceChat.ToggleMemberMuted.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_VoiceChat.ToggleMemberMuted - -**Content:** -Needs summary. -`C_VoiceChat.ToggleMemberMuted(playerLocation)` - -**Parameters:** -- `playerLocation` - - *PlayerLocationMixin* \ No newline at end of file diff --git a/wiki-information/functions/C_VoiceChat.ToggleMuted.md b/wiki-information/functions/C_VoiceChat.ToggleMuted.md deleted file mode 100644 index 0fcb3b5a..00000000 --- a/wiki-information/functions/C_VoiceChat.ToggleMuted.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: C_VoiceChat.ToggleMuted - -**Content:** -Needs summary. -`C_VoiceChat.ToggleMuted()` \ No newline at end of file diff --git a/wiki-information/functions/C_XMLUtil.GetTemplateInfo.md b/wiki-information/functions/C_XMLUtil.GetTemplateInfo.md deleted file mode 100644 index 8093c264..00000000 --- a/wiki-information/functions/C_XMLUtil.GetTemplateInfo.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: C_XMLUtil.GetTemplateInfo - -**Content:** -Returns information about a defined XML template. -`info = C_XMLUtil.GetTemplateInfo(name)` - -**Parameters:** -- `name` - - *string* - The name of the template to query. - -**Returns:** -- `info` - - *XMLTemplateInfo?* - Information about the queried template if found, or nil if the template does not exist. - - `Field` - - `Type` - - `Description` - - `type` - - *string* - The frame type ("Frame", "Button", etc.) of the XML template. - - `width` - - *number* - The statically defined width present in a `` element on the template. If no width is defined, this will be zero. - - `height` - - *number* - The statically defined height present in a `` element on the template. If no height is defined, this will be zero. - - `inherits` - - *string?* - A comma-delimited string of inherited templates, matching the inherits XML attribute. If no templates are inherited, this will be nil. - - `keyValues` - - *XMLTemplateKeyValue* - A list of defined key/value pairs defined within a `` element on the template. If no key/values pairs are defined, this will be an empty table. - - `XMLTemplateKeyValue` - - `Field` - - `Type` - - `Description` - - `key` - - *string* - The value used as the key when this template is instantiated. This will be the string as-supplied in the key attribute on the `` element itself and not the actual Lua value. - - `keyType` - - *string* - The type of the defined key. - - `type` - - *string* - The type of the defined value. - - `value` - - *string* - The value assigned to the key when this template is instantiated. This will be the string as-supplied in the value attribute on the `` element itself and not the actual Lua value. \ No newline at end of file diff --git a/wiki-information/functions/C_XMLUtil.GetTemplates.md b/wiki-information/functions/C_XMLUtil.GetTemplates.md deleted file mode 100644 index 2482103e..00000000 --- a/wiki-information/functions/C_XMLUtil.GetTemplates.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: C_XMLUtil.GetTemplates - -**Content:** -Returns a list of all registered XML templates. -`templates = C_XMLUtil.GetTemplates()` - -**Returns:** -- `templates` - - *XMLTemplateListInfo* - An array of tables for each registered XML template. - - `Field` - - `Type` - - `Description` - - `name` - - *string* - The name of the XML template. - - `type` - - *string* - The frame type ("Frame", "Button", etc.) of the XML template. - -**Usage:** -The following snippet will print all the names and frame types of registered XML templates. -```lua -for _, template in ipairs(C_XMLUtil.GetTemplates()) do - print(template.name, template.type) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/CalculateStringEditDistance.md b/wiki-information/functions/CalculateStringEditDistance.md deleted file mode 100644 index beeca6c4..00000000 --- a/wiki-information/functions/CalculateStringEditDistance.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: CalculateStringEditDistance - -**Content:** -Needs summary. -`distance = CalculateStringEditDistance(firstString, secondString)` - -**Parameters:** -- `firstString` - - *stringView* -- `secondString` - - *stringView* - -**Returns:** -- `distance` - - *number* - -**Description:** -This function calculates the edit distance between two strings, which is a measure of how dissimilar two strings are to one another by counting the minimum number of operations required to transform one string into the other. This can be useful for various text processing tasks, such as spell checking, DNA sequence analysis, and natural language processing. - -**Example Usage:** -```lua -local str1 = "kitten" -local str2 = "sitting" -local distance = CalculateStringEditDistance(str1, str2) -print("The edit distance between 'kitten' and 'sitting' is:", distance) -``` - -**Addons Using This Function:** -- **WeakAuras**: This popular addon for creating custom visual and audio alerts uses `CalculateStringEditDistance` to compare strings for various triggers and conditions. -- **ElvUI**: A comprehensive UI overhaul addon that might use this function for comparing user input strings for configuration and customization purposes. \ No newline at end of file diff --git a/wiki-information/functions/CallCompanion.md b/wiki-information/functions/CallCompanion.md deleted file mode 100644 index 8b3deed5..00000000 --- a/wiki-information/functions/CallCompanion.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: CallCompanion - -**Content:** -Summons a companion. -`CallCompanion(type, id)` - -**Parameters:** -- `type` - - *string* - The type of companion to summon or dismiss: "CRITTER" or "MOUNT". -- `id` - - *number* - The companion index to summon or dismiss, ascending from 1. - -**Usage:** -The following macro summons the first mount your character has acquired: -```lua -/run CallCompanion("MOUNT",1) -``` -The following macro summons a random mount your character has acquired: -```lua -/run CallCompanion("MOUNT", random(GetNumCompanions("MOUNT"))) -``` - -**Description:** -The list of companions is usually, but not always, alphabetically sorted. You may not rely on the indices to remain stable, even if the number of companions is not altered. - -**Reference:** -- `GetNumCompanions` -- `GetCompanionInfo` \ No newline at end of file diff --git a/wiki-information/functions/CameraOrSelectOrMoveStart.md b/wiki-information/functions/CameraOrSelectOrMoveStart.md deleted file mode 100644 index 258d4996..00000000 --- a/wiki-information/functions/CameraOrSelectOrMoveStart.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: CameraOrSelectOrMoveStart - -**Content:** -Begin "Left click" in the 3D world. -`CameraOrSelectOrMoveStart()` - -**Description:** -This function is called when left-clicking in the 3-D world. It is most useful for selecting a target for a pending spell cast. -Calling this function clears the "mouseover" unit. -When used alone, puts you into a "mouselook" mode until `CameraOrSelectOrMoveStop` is called. \ No newline at end of file diff --git a/wiki-information/functions/CameraOrSelectOrMoveStop.md b/wiki-information/functions/CameraOrSelectOrMoveStop.md deleted file mode 100644 index d49f3f75..00000000 --- a/wiki-information/functions/CameraOrSelectOrMoveStop.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: CameraOrSelectOrMoveStop - -**Content:** -Called when you release the "Left-Click" mouse button. -`CameraOrSelectOrMoveStop()` - -**Parameters:** -- `stickyFlag` - - *Flag (optional)* - If present and set then any camera offset is 'sticky' and remains until explicitly cancelled. - -**Description:** -This function is called when left-clicking in the 3-D world. -When used alone, it can cancel a "mouselook" started by a call to `CameraOrSelectOrMoveStart`. -**IMPORTANT:** The normal restrictions regarding hardware event initiations still apply to anything this function might do. \ No newline at end of file diff --git a/wiki-information/functions/CameraZoomIn.md b/wiki-information/functions/CameraZoomIn.md deleted file mode 100644 index 165827dc..00000000 --- a/wiki-information/functions/CameraZoomIn.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: CameraZoomIn - -**Content:** -Zooms the camera in. -`CameraZoomIn(increment)` - -**Parameters:** -- `(float increment)` - -**Description:** -Zooms the camera into the viewplane by increment. The increment must be between 0.0 and 50 with 0.0 indicating no zoom relative to current view and 50 being maximum zoom. From a completely zoomed out position, an increment of 50 will result in a first person camera angle. - -As of patch 1.9.0, if the 'Interface Options > Advanced Options > Max Camera Distance' setting is set to Low, then the largest value for increment is 15. If this setting is set to High, then the largest value for increment is 30. With `/console CVar_cameraDistanceMaxFactor` the maximum value is 50. \ No newline at end of file diff --git a/wiki-information/functions/CanAbandonQuest.md b/wiki-information/functions/CanAbandonQuest.md deleted file mode 100644 index b571e227..00000000 --- a/wiki-information/functions/CanAbandonQuest.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: CanAbandonQuest - -**Content:** -Returns whether the player can abandon a specific quest. -`canAbandon = CanAbandonQuest(questID)` - -**Parameters:** -- `questID` - - *number* - quest ID of the quest to query, e.g. 5944 for In Dreams. - -**Returns:** -- `canAbandon` - - *boolean* - 1 if the player is currently on the specified quest and can abandon it, nil otherwise. - -**Description:** -Some quests cannot be abandoned. These include some of the Battle Pet Tamers quests. \ No newline at end of file diff --git a/wiki-information/functions/CanBeRaidTarget.md b/wiki-information/functions/CanBeRaidTarget.md deleted file mode 100644 index 5e7244ae..00000000 --- a/wiki-information/functions/CanBeRaidTarget.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: CanBeRaidTarget - -**Content:** -Returns true if the unit can be marked with a raid target icon. -`canBeRaidTarget = CanBeRaidTarget(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `canBeRaidTarget` - - *boolean* - true if raid target markers can be assigned to the queried unit, false otherwise. - -**Reference:** -- `SetRaidTarget` - -**Example Usage:** -This function can be used in a raid addon to determine if a specific unit can be marked with a raid target icon. For instance, in a boss encounter, you might want to mark certain adds or players with specific icons for better coordination. - -**Addons Using This Function:** -Many raid management addons, such as Deadly Boss Mods (DBM) and BigWigs, use this function to automate the marking of units during encounters. This helps raid leaders quickly assign targets without manual intervention. \ No newline at end of file diff --git a/wiki-information/functions/CanChangePlayerDifficulty.md b/wiki-information/functions/CanChangePlayerDifficulty.md deleted file mode 100644 index 22308b17..00000000 --- a/wiki-information/functions/CanChangePlayerDifficulty.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: CanChangePlayerDifficulty - -**Content:** -Needs summary. -`canChange, notOnCooldown = CanChangePlayerDifficulty()` - -**Returns:** -- `canChange` - - *boolean* -- `notOnCooldown` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanDualWield.md b/wiki-information/functions/CanDualWield.md deleted file mode 100644 index 5f43b04f..00000000 --- a/wiki-information/functions/CanDualWield.md +++ /dev/null @@ -1,73 +0,0 @@ -## Title: CanDualWield - -**Content:** -Returns whether the player can dual wield weapons. -`canDualWield = CanDualWield()` - -**Returns:** -- `canDualWield` - - *boolean* - This returns true if One-Hand weapons can be equipped into both `INVSLOT_MAINHAND` and `INVSLOT_OFFHAND`. - -**Description:** -Fury Warriors can dual wield one-hand weapons, and two-hand weapons (or a combination) from the baseline passive. - -**Parameters:** -- **Retail:** - - **Class** - - **CanDualWield** - - **IsSpellKnown** - - **IsPlayerSpell** - - Rogue - - ✔️ - - ❌ 674 - - ✔️ 674 - - Hunter - - ✔️ - - ❌ 674 - - ✔️ 674 - - Demon Hunter - - ✔️ - - ❌ 674 - - ✔️ 674 - - Frost Death Knight - - ✔️ - - ❌ 674 - - ✔️ 674 - - Brewmaster Monk - - ✔️ - - ❌ 674 - - ❌ 674 - - Windwalker Monk - - ✔️ - - ❌ 674 - - ❌ 674 - - Enhancement Shaman - - ✔️ - - ❌ 674 - - ❌ 674 - - Fury Warrior - - ✔️ - - ❌ 674, ✔️ 46917 - - ❌ 674, ✔️ 46917 - -- **Classic:** - - **Class** - - **CanDualWield** - - **IsSpellKnown** - - **IsPlayerSpell** - - Rogue (level 10) - - ✔️ - - ✔️ 674 - - ✔️ 674 - - Hunter (level 20) - - ✔️ - - ✔️ 674 - - ✔️ 674 - - Warrior (level 20) - - ✔️ - - ✔️ 674 - - ✔️ 674 - -**Reference:** -- `Enum.InventoryType` -- `InventorySlotId` \ No newline at end of file diff --git a/wiki-information/functions/CanEditMOTD.md b/wiki-information/functions/CanEditMOTD.md deleted file mode 100644 index 6296b945..00000000 --- a/wiki-information/functions/CanEditMOTD.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CanEditMOTD - -**Content:** -Returns true if the player can edit the guild message of the day. -`canEdit = CanEditMOTD()` - -**Returns:** -- `canEdit` - - *boolean* - Returns true if the player can edit the guild MOTD \ No newline at end of file diff --git a/wiki-information/functions/CanEjectPassengerFromSeat.md b/wiki-information/functions/CanEjectPassengerFromSeat.md deleted file mode 100644 index b989ae19..00000000 --- a/wiki-information/functions/CanEjectPassengerFromSeat.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: CanEjectPassengerFromSeat - -**Content:** -Needs summary. -`canEject = CanEjectPassengerFromSeat(virtualSeatIndex)` - -**Parameters:** -- `virtualSeatIndex` - - *number* - -**Returns:** -- `canEject` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanGrantLevel.md b/wiki-information/functions/CanGrantLevel.md deleted file mode 100644 index 5c539f5c..00000000 --- a/wiki-information/functions/CanGrantLevel.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: CanGrantLevel - -**Content:** -Returns whether you can grant levels to a particular player. -`status = CanGrantLevel(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `status` - - *boolean* - true if you can grant levels to the unit; nil otherwise (unit is not RAF-linked to you, does not meet level requirements, or you are out of levels to grant). - -**Usage:** -The snippet below prints whether you can grant levels to your target right now. -```lua -local status = CanGrantLevel("target") -if status then - print("I can grant levels to my friend!") -else - print("I am out of free levels for now.") -end -``` \ No newline at end of file diff --git a/wiki-information/functions/CanGuildDemote.md b/wiki-information/functions/CanGuildDemote.md deleted file mode 100644 index d2a85674..00000000 --- a/wiki-information/functions/CanGuildDemote.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: CanGuildDemote - -**Content:** -Returns true if the player can demote guild members. -`canDemote = CanGuildDemote()` - -**Returns:** -- `canDemote` - - *boolean* - Returns true if the player can demote. - -**Example Usage:** -This function can be used in a guild management addon to check if the current player has the permissions to demote other guild members. For instance, before displaying the demote option in a guild member's context menu, the addon can call `CanGuildDemote()` to ensure the player has the necessary permissions. - -**Addons Using This Function:** -Large guild management addons like "Guild Roster Manager" may use this function to manage guild ranks and permissions effectively. It helps in ensuring that only players with the appropriate permissions can perform demotions within the guild. \ No newline at end of file diff --git a/wiki-information/functions/CanGuildInvite.md b/wiki-information/functions/CanGuildInvite.md deleted file mode 100644 index d18bc13c..00000000 --- a/wiki-information/functions/CanGuildInvite.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CanGuildInvite - -**Content:** -Returns true if the player can invite new members to the guild. -`canInvite = CanGuildInvite()` - -**Returns:** -- `canInvite` - - *boolean* - Whether you can invite people to your current guild \ No newline at end of file diff --git a/wiki-information/functions/CanGuildPromote.md b/wiki-information/functions/CanGuildPromote.md deleted file mode 100644 index 27f05793..00000000 --- a/wiki-information/functions/CanGuildPromote.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: CanGuildPromote - -**Content:** -Returns true if the player can promote guild members. -`canPromote = CanGuildPromote()` - -**Returns:** -- `canPromote` - - *boolean* - Returns 1 if the player can promote, nil if not. - -**Usage:** -```lua -if CanGuildPromote() then - -- do stuff -end -``` - -**Example Use Case:** -This function can be used in guild management addons to check if the current player has the permission to promote other guild members. For instance, an addon that automates guild promotions based on certain criteria can use this function to ensure the player has the necessary permissions before attempting to promote a member. - -**Addons Using This Function:** -Many guild management addons, such as "Guild Roster Manager" and "GuildMaster", use this function to manage guild ranks and permissions effectively. These addons often include features like automated promotions, demotions, and rank adjustments based on player activity and contributions. \ No newline at end of file diff --git a/wiki-information/functions/CanInspect.md b/wiki-information/functions/CanInspect.md deleted file mode 100644 index a3e59cd4..00000000 --- a/wiki-information/functions/CanInspect.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: CanInspect - -**Content:** -Returns true if the player can inspect the unit. -`canInspect = CanInspect(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId -- `showError` - - *boolean?* - If true, the function will display an error message ("You can't inspect that unit") if you cannot inspect the specified unit. - -**Returns:** -- `canInspect` - - *boolean* - True if you can inspect the specified unit - -**Description:** -You cannot inspect NPCs, nor PvP-enabled hostile players in PvP-enabled locations. - -**Reference:** -- `NotifyInspect` \ No newline at end of file diff --git a/wiki-information/functions/CanJoinBattlefieldAsGroup.md b/wiki-information/functions/CanJoinBattlefieldAsGroup.md deleted file mode 100644 index fbd03606..00000000 --- a/wiki-information/functions/CanJoinBattlefieldAsGroup.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: CanJoinBattlefieldAsGroup - -**Content:** -Returns true if the player can join a battlefield with a group. -`isTrue = CanJoinBattlefieldAsGroup()` - -**Returns:** -- `isTrue` - - *boolean* - returns true, if the player can join the battlefield as group - -**Usage:** -```lua -if (CanJoinBattlefieldAsGroup()) then - JoinBattlefield(0, 1) -- join battlefield as group -else - JoinBattlefield(0, 0) -- join battlefield as single player -end -``` - -**Result:** -Queries the player either as group or as single player. \ No newline at end of file diff --git a/wiki-information/functions/CanLootUnit.md b/wiki-information/functions/CanLootUnit.md deleted file mode 100644 index ea0a1fd5..00000000 --- a/wiki-information/functions/CanLootUnit.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: CanLootUnit - -**Content:** -Needs summary. -`hasLoot, canLoot = CanLootUnit(targetUnit)` - -**Parameters:** -- `targetUnit` - - *string* : WOWGUID - -**Returns:** -- `hasLoot` - - *boolean* -- `canLoot` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanMerchantRepair.md b/wiki-information/functions/CanMerchantRepair.md deleted file mode 100644 index 6b7fac35..00000000 --- a/wiki-information/functions/CanMerchantRepair.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CanMerchantRepair - -**Content:** -Returns true if the merchant can repair items. -`canRepair = CanMerchantRepair()` - -**Returns:** -- `canRepair` - - *number* - Is 1 if the merchant can repair, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/CanReplaceGuildMaster.md b/wiki-information/functions/CanReplaceGuildMaster.md deleted file mode 100644 index 37e92893..00000000 --- a/wiki-information/functions/CanReplaceGuildMaster.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: CanReplaceGuildMaster - -**Content:** -Returns whether you can impeach the Guild Master due to inactivity. -`canReplace = CanReplaceGuildMaster()` - -**Returns:** -- `canReplace` - - *boolean* - true if you can replace the Guild Master. - -**Reference:** -- `ReplaceGuildMaster` - - New in 4.3: Inactive Guild Leader Replacement \ No newline at end of file diff --git a/wiki-information/functions/CanSendAuctionQuery.md b/wiki-information/functions/CanSendAuctionQuery.md deleted file mode 100644 index 01fd64e4..00000000 --- a/wiki-information/functions/CanSendAuctionQuery.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: CanSendAuctionQuery - -**Content:** -Determine if a new auction house query can be sent (via `QueryAuctionItems()`) -`canQuery, canQueryAll = CanSendAuctionQuery()` - -**Returns:** -- `canQuery` - - *boolean* - True if a normal auction house query can be made -- `canQueryAll` - - *boolean* - True if a full ("getall") auction house query can be made (added in 2.3) - -**Description:** -There is always a short delay (usually less than a second) after each query before another query can take place. -Full ("getall") queries are only allowed once every ~15 minutes. \ No newline at end of file diff --git a/wiki-information/functions/CanShowAchievementUI.md b/wiki-information/functions/CanShowAchievementUI.md deleted file mode 100644 index 2c6ed7ea..00000000 --- a/wiki-information/functions/CanShowAchievementUI.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: CanShowAchievementUI - -**Content:** -Returns if the AchievementUI can be displayed. -`canShow = CanShowAchievementUI()` - -**Returns:** -- `canShow` - - *boolean* - true if the achievement data is available (and hence the AchievementUI can be displayed), false otherwise. - -**Description:** -This function returns false if called while the player is logging in (but not on subsequent UI reloads). -Achievement completion data is streamed to the client when the character logs in. -The streaming process is indicated by `RECEIVED_ACHIEVEMENT_LIST` events and generally completes before `PLAYER_LOGIN`. \ No newline at end of file diff --git a/wiki-information/functions/CanShowResetInstances.md b/wiki-information/functions/CanShowResetInstances.md deleted file mode 100644 index da5cb5fa..00000000 --- a/wiki-information/functions/CanShowResetInstances.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CanShowResetInstances - -**Content:** -Returns true if the character can currently reset their instances. -`canReset = CanShowResetInstances()` - -**Returns:** -- `canReset` - - *boolean* - true if player can reset instances \ No newline at end of file diff --git a/wiki-information/functions/CanSummonFriend.md b/wiki-information/functions/CanSummonFriend.md deleted file mode 100644 index d88d3197..00000000 --- a/wiki-information/functions/CanSummonFriend.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: CanSummonFriend - -**Content:** -Returns whether you can RaF summon a particular unit. -`summonable = CanSummonFriend(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The player to check whether you can summon. - -**Returns:** -- `summonable` - - *boolean* - 1 if you can summon the unit using RaF, nil otherwise. - -**Usage:** -The snippet below checks whether you can summon the target, and, if so, whispers and summons her to you. -```lua -local t = "target"; -if CanSummonFriend(t) then - SendChatMessage("I am summoning you!", "WHISPER", nil, t) - SummonFriend(t) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/CanSwitchVehicleSeat.md b/wiki-information/functions/CanSwitchVehicleSeat.md deleted file mode 100644 index 09f9cc2d..00000000 --- a/wiki-information/functions/CanSwitchVehicleSeat.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CanSwitchVehicleSeat - -**Content:** -Needs summary. -`canSwitch = CanSwitchVehicleSeat()` - -**Returns:** -- `canSwitch` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CanUpgradeExpansion.md b/wiki-information/functions/CanUpgradeExpansion.md deleted file mode 100644 index 16892061..00000000 --- a/wiki-information/functions/CanUpgradeExpansion.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CanUpgradeExpansion - -**Content:** -Needs summary. -`canUpgradeExpansion = CanUpgradeExpansion()` - -**Returns:** -- `canUpgradeExpansion` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CancelDuel.md b/wiki-information/functions/CancelDuel.md deleted file mode 100644 index 5d8d0de0..00000000 --- a/wiki-information/functions/CancelDuel.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: CancelDuel - -**Content:** -Forfeits the current duel or declines a duel invitation. -`CancelDuel()` - -**Reference:** -- `StartDuel` -- `AcceptDuel` - -**Example Usage:** -```lua --- If the player is currently in a duel and wants to forfeit -CancelDuel() -``` - -**Addons Usage:** -Many PvP-related addons might use `CancelDuel` to provide users with a quick way to forfeit duels through the addon interface. For example, an addon that manages PvP settings and preferences might include a button to cancel ongoing duels. \ No newline at end of file diff --git a/wiki-information/functions/CancelItemTempEnchantment.md b/wiki-information/functions/CancelItemTempEnchantment.md deleted file mode 100644 index df78dcb5..00000000 --- a/wiki-information/functions/CancelItemTempEnchantment.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: CancelItemTempEnchantment - -**Content:** -Removes temporary weapon enchants (e.g. Rogue poisons and sharpening stones). -`CancelItemTempEnchantment(weaponHand)` - -**Parameters:** -- `weaponHand` - - *number* - 1 for Main Hand, 2 for Off Hand. - -**Example Usage:** -This function can be used in macros or addons to remove temporary enchants from weapons. For instance, a Rogue might use this to remove poisons from their weapons before applying a different type of poison. - -**Addons:** -Many large addons, such as WeakAuras, might use this function to manage weapon enchants dynamically based on certain conditions or triggers. \ No newline at end of file diff --git a/wiki-information/functions/CancelLogout.md b/wiki-information/functions/CancelLogout.md deleted file mode 100644 index 3f2ac391..00000000 --- a/wiki-information/functions/CancelLogout.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: CancelLogout - -**Content:** -Cancels the logout timer (from camping or quitting). -`CancelLogout()` - -**Description:** -This is called whenever the logout dialogs are hidden. \ No newline at end of file diff --git a/wiki-information/functions/CancelPendingEquip.md b/wiki-information/functions/CancelPendingEquip.md deleted file mode 100644 index 9a7ea6ca..00000000 --- a/wiki-information/functions/CancelPendingEquip.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: CancelPendingEquip - -**Content:** -Cancels a pending equip confirmation. -`CancelPendingEquip(slot)` - -**Parameters:** -- `slot` - - *number* - equipment slot to cancel equipping an item to. - -**Description:** -When attempting to equip an item which will become soulbound, the equip operation is suspended, and a dialog is presented for the user to decide whether or not to proceed. This call is made by that dialog if the user decides not to equip the item. \ No newline at end of file diff --git a/wiki-information/functions/CancelPreloadingMovie.md b/wiki-information/functions/CancelPreloadingMovie.md deleted file mode 100644 index 8ada6af0..00000000 --- a/wiki-information/functions/CancelPreloadingMovie.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CancelPreloadingMovie - -**Content:** -Needs summary. -`CancelPreloadingMovie(movieId)` - -**Parameters:** -- `movieId` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/CancelShapeshiftForm.md b/wiki-information/functions/CancelShapeshiftForm.md deleted file mode 100644 index d519855f..00000000 --- a/wiki-information/functions/CancelShapeshiftForm.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CancelShapeshiftForm - -**Content:** -Cancels a shapeshift form. -`CancelShapeshiftForm()` - -**Description:** -Shapeshifting cannot be cancelled through normal buff functions as that would allow insecure code to manipulate the macro conditional. -You can use `/cancelform` in a macro instead. \ No newline at end of file diff --git a/wiki-information/functions/CancelTrackingBuff.md b/wiki-information/functions/CancelTrackingBuff.md deleted file mode 100644 index 492924a5..00000000 --- a/wiki-information/functions/CancelTrackingBuff.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: CancelTrackingBuff - -**Content:** -Cancels your current tracking buff (skills like Find Minerals and Track Humanoids). -`CancelTrackingBuff()` - -**Example Usage:** -This function can be used in macros or addons to automatically cancel a tracking buff. For instance, if a player wants to switch from tracking minerals to tracking herbs, they can use this function to cancel the current tracking buff before applying the new one. - -**Addons:** -Many large addons related to gathering professions, such as GatherMate2, may use this function to manage tracking buffs efficiently. For example, an addon could automatically switch tracking based on the player's current zone or the resources they are most interested in. \ No newline at end of file diff --git a/wiki-information/functions/CancelTrade.md b/wiki-information/functions/CancelTrade.md deleted file mode 100644 index 103bdcf7..00000000 --- a/wiki-information/functions/CancelTrade.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: CancelTrade - -**Content:** -Declines the current trade offer. -`CancelTrade()` - -**Parameters:** -- None - -**Returns:** -- None \ No newline at end of file diff --git a/wiki-information/functions/CancelUnitBuff.md b/wiki-information/functions/CancelUnitBuff.md deleted file mode 100644 index 071d7954..00000000 --- a/wiki-information/functions/CancelUnitBuff.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: CancelUnitBuff - -**Content:** -Removes a specific buff from the character. -`CancelUnitBuff(unit, buffIndex)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to cancel the buff from, must be under the player's control. -- `buffIndex` - - *number* - index of the buff to cancel, ascending from 1. -- `filter` - - *string* - any combination of "HELPFUL|HARMFUL|PLAYER|RAID|CANCELABLE|NOT_CANCELABLE". - -**Description:** -This function does not work for canceling druid forms, rogue Stealth, death knight presences, or priest Shadowform. \ No newline at end of file diff --git a/wiki-information/functions/CaseAccentInsensitiveParse.md b/wiki-information/functions/CaseAccentInsensitiveParse.md deleted file mode 100644 index 89a1ccdf..00000000 --- a/wiki-information/functions/CaseAccentInsensitiveParse.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: CaseAccentInsensitiveParse - -**Content:** -Converts a string with accented letters to lowercase. -`lower = CaseAccentInsensitiveParse(name)` - -**Parameters:** -- `name` - - *string* - The string to be converted to lowercase. - -**Returns:** -- `lower` - - *string* - A lowercased equivalent of the input string. - -**Description:** -This API only supports a limited set of codepoints for conversion and is not suitable as a general-purpose Unicode-aware case conversion function. -The table below documents support for uppercase characters within defined Unicode codepoint blocks. A block is considered "supported" only if all uppercase class characters within the block will be converted to their lowercase equivalents by this function. - -| Block Name | Supported | Notes | -|--------------------|-----------|-----------------------------------------------------------------------| -| Basic Latin | ✔️ | | -| Latin-1 Supplement | ✔️ | | -| Latin Extended-A | ❌ | Limited support for Œ (U+0152) and Ÿ (U+0178) only. | - -**Usage:** -This example demonstrates the support for the Basic and Supplemental Latin codepoint ranges, outputting a lowercased pair of strings. -```lua -local basic = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" -local supplemental = "ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝÞ" -print(CaseAccentInsensitiveParse(basic)) -print(CaseAccentInsensitiveParse(supplemental)) --- Prints: --- abcdefghijklmnopqrstuvwxyz --- àáâãäåæçèéêëìíîïðñòóôõöøùúûüýþ -``` \ No newline at end of file diff --git a/wiki-information/functions/CastPetAction.md b/wiki-information/functions/CastPetAction.md deleted file mode 100644 index 38d28c46..00000000 --- a/wiki-information/functions/CastPetAction.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: CastPetAction - -**Content:** -Cast the corresponding pet skill. -`CastPetAction(index)` - -**Parameters:** -- `index` - - *number* - pet action bar slot index, ascending from 1. -- `target` - - *string? : UnitId* - The unit to cast the action on; defaults to "target". \ No newline at end of file diff --git a/wiki-information/functions/CastShapeshiftForm.md b/wiki-information/functions/CastShapeshiftForm.md deleted file mode 100644 index 616a3d38..00000000 --- a/wiki-information/functions/CastShapeshiftForm.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: CastShapeshiftForm - -**Content:** -Casts a shapeshift ability. -`CastShapeshiftForm(index)` - -**Parameters:** -- `index` - - *number* - specifies which shapeshift form to activate or toggle; generally equivalent to the index of the form on the stance bar. - -**Example Usage:** -```lua --- Example: Cast the first shapeshift form (e.g., Bear Form for Druids) -CastShapeshiftForm(1) -``` - -**Description:** -This function is typically used by classes that have shapeshifting abilities, such as Druids. It allows the player to switch between different forms, such as Bear Form, Cat Form, etc., by specifying the index of the form. - -**Addons:** -Many addons that enhance class-specific functionalities, such as "WeakAuras" or "TellMeWhen," use this function to automate or provide visual cues for shapeshifting abilities. For example, an addon might automatically switch the player to Bear Form when their health drops below a certain threshold. \ No newline at end of file diff --git a/wiki-information/functions/CastSpell.md b/wiki-information/functions/CastSpell.md deleted file mode 100644 index 8fabc653..00000000 --- a/wiki-information/functions/CastSpell.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: CastSpell - -**Content:** -Casts a spell from the spellbook. -`CastSpell(spellIndex, spellbookType)` - -**Parameters:** -- `spellIndex` - - *number* - index of the spell to cast. -- `spellbookType` - - *string* - spellbook to cast the spell from; one of - - `BOOKTYPE_SPELL` ("spell") for player spells - - `BOOKTYPE_PET` ("pet") for pet abilities - -**Description:** -This function cannot be used from insecure execution paths except to "cast" trade skills (e.g. Cooking, Alchemy). - -**Reference:** -- `CastSpellByName` - -**Example Usage:** -```lua --- Cast the first spell in the player's spellbook -CastSpell(1, BOOKTYPE_SPELL) - --- Cast the first ability in the pet's spellbook -CastSpell(1, BOOKTYPE_PET) -``` - -**Addons Usage:** -Many addons that automate spell casting or provide custom spell casting interfaces use `CastSpell`. For example, the popular addon "Bartender" uses it to allow players to cast spells directly from custom action bars. \ No newline at end of file diff --git a/wiki-information/functions/CastSpellByName.md b/wiki-information/functions/CastSpellByName.md deleted file mode 100644 index d895e836..00000000 --- a/wiki-information/functions/CastSpellByName.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: CastSpellByName - -**Content:** -Casts a spell by name. -`CastSpellByName(spellName)` - -**Parameters:** -- `name` - - *string* - Name of the spell to cast, e.g. "Alchemy". -- `target` - - *string? : UnitId* - The unit to cast the spell on. If omitted, "target" is assumed for spells that require a target. - -**Description:** -You can still use this function to open trade skill windows and to summon mounts even from a tainted execution path. \ No newline at end of file diff --git a/wiki-information/functions/CastingInfo.md b/wiki-information/functions/CastingInfo.md deleted file mode 100644 index d0dff2c5..00000000 --- a/wiki-information/functions/CastingInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: CastingInfo - -**Content:** -Returns the player's currently casting spell. -`name, text, texture, startTime, endTime, isTradeSkill, castID, notInterruptible, spellID = CastingInfo()` - -**Returns:** -- `name` - - *string* - The name of the spell. -- `text` - - *string* - The name to be displayed. -- `texture` - - *number* : FileID -- `startTime` - - *number* - Specifies when casting began in milliseconds (corresponds to GetTime()*1000). -- `endTime` - - *number* - Specifies when casting will end in milliseconds (corresponds to GetTime()*1000). -- `isTradeSkill` - - *boolean* -- `castID` - - *string* - e.g. "Cast-3-4479-0-1318-2053-000014AD63" -- `notInterruptible` - - *boolean* - This is always nil. -- `spellID` - - *number* - -**Description:** -In Classic, only casting information for the player is available. This API is essentially the same as `UnitCastingInfo("player")`. - -**Example Usage:** -This function can be used in addons to track the player's current casting spell. For instance, an addon that displays a custom casting bar would use `CastingInfo()` to get the details of the spell being cast and update the bar accordingly. - -**Addons Using This API:** -Many popular addons like Quartz and Gnosis use this API to provide enhanced casting bar functionalities, showing detailed information about the spell being cast, including start and end times, and whether the spell is interruptible. \ No newline at end of file diff --git a/wiki-information/functions/ChangeActionBarPage.md b/wiki-information/functions/ChangeActionBarPage.md deleted file mode 100644 index 0c9a8daf..00000000 --- a/wiki-information/functions/ChangeActionBarPage.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: ChangeActionBarPage - -**Content:** -Changes the current action bar page. -`ChangeActionBarPage(actionBarPage)` - -**Parameters:** -- `actionBarPage` - - *number* - Which page of your action bar to switch to. Expects an integer 1-6. - -**Description:** -Notifies the UI that the current action button set has been updated to the current value of the `CURRENT_ACTIONBAR_PAGE` global variable. -Will cause an `ACTIONBAR_PAGE_CHANGED` event to fire only if there was actually a change (tested in 9.0.5). \ No newline at end of file diff --git a/wiki-information/functions/ChangeChatColor.md b/wiki-information/functions/ChangeChatColor.md deleted file mode 100644 index 68db37ab..00000000 --- a/wiki-information/functions/ChangeChatColor.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: ChangeChatColor - -**Content:** -Updates the color for a type of chat message. -`ChangeChatColor(channelname, red, green, blue)` - -**Parameters:** -- `channelname` - - *string* - Name of the channel as given in chat-cache.txt files. -- `red, green, blue` - - *number* - RGB values (0-1, floats). - -**Usage:** -```lua -ChangeChatColor("CHANNEL1", 255/255, 192/255, 192/255); -ChangeChatColor("CHANNEL1", 255/255, 192/255, 192/255); -``` - -**Miscellaneous:** -Result: -Reset the General channel to the default (255,192,192, slightly off-white) color. - -**Reference:** -`FontString:SetTextColor()`. \ No newline at end of file diff --git a/wiki-information/functions/ChannelBan.md b/wiki-information/functions/ChannelBan.md deleted file mode 100644 index 663821bc..00000000 --- a/wiki-information/functions/ChannelBan.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: ChannelBan - -**Content:** -Bans a player from the specified channel. -`ChannelBan(channelName, playerName)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel to ban on -- `playerName` - - *string* - The name of the player to ban - -**Usage:** -`ChannelBan("uimods", "Sembiance")` \ No newline at end of file diff --git a/wiki-information/functions/ChannelInfo.md b/wiki-information/functions/ChannelInfo.md deleted file mode 100644 index 1217de3c..00000000 --- a/wiki-information/functions/ChannelInfo.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: ChannelInfo - -**Content:** -Returns the player's currently channeling spell. -`name, text, texture, startTime, endTime, isTradeSkill, notInterruptible, spellID = ChannelInfo()` - -**Returns:** -- `name` - - *string* - The name of the spell, or nil if no spell is being channeled. -- `text` - - *string* - The name to be displayed. -- `texture` - - *number* : FileID -- `startTime` - - *number* - Specifies when channeling began in milliseconds (corresponds to GetTime()*1000). -- `endTime` - - *number* - Specifies when channeling will end in milliseconds (corresponds to GetTime()*1000). -- `isTradeSkill` - - *boolean* -- `notInterruptible` - - *boolean* - This is always nil. -- `spellID` - - *number* - -**Description:** -In Classic, only channeling information for the player is available. This API is essentially the same as `UnitChannelInfo("player")`. \ No newline at end of file diff --git a/wiki-information/functions/ChannelInvite.md b/wiki-information/functions/ChannelInvite.md deleted file mode 100644 index a31b058a..00000000 --- a/wiki-information/functions/ChannelInvite.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: ChannelInvite - -**Content:** -Invites the specified user to the channel. -`ChannelInvite(channelName, playerName)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel to invite to -- `playerName` - - *string* - The name of the player to invite - -**Usage:** -`ChannelInvite("uimods", "Sembiance")` \ No newline at end of file diff --git a/wiki-information/functions/ChannelKick.md b/wiki-information/functions/ChannelKick.md deleted file mode 100644 index 0481fd4f..00000000 --- a/wiki-information/functions/ChannelKick.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: ChannelKick - -**Content:** -Kicks a player from the specified channel. -`ChannelKick(channelName, playerName)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel to kick from -- `playerName` - - *string* - The name of the player to kick - -**Usage:** -`ChannelKick("uimods", "alexyoshi")` \ No newline at end of file diff --git a/wiki-information/functions/CheckInbox.md b/wiki-information/functions/CheckInbox.md deleted file mode 100644 index 0fc0985d..00000000 --- a/wiki-information/functions/CheckInbox.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CheckInbox - -**Content:** -Queries the server for mail. -`CheckInbox()` - -**Description:** -This function requires that the mailbox window is open. -After it is called and the inbox populated, the client's stored mailbox information can be accessed from anywhere in the world. That is, functions like `GetInboxHeaderInfo()` and `GetInboxNumItems()` may be called from anywhere. Note that only the *stored* information can be accessed -- to get current inbox info, you have to call `CheckInbox()` again. \ No newline at end of file diff --git a/wiki-information/functions/CheckInteractDistance.md b/wiki-information/functions/CheckInteractDistance.md deleted file mode 100644 index 533a3940..00000000 --- a/wiki-information/functions/CheckInteractDistance.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: CheckInteractDistance - -**Content:** -Returns true if the player is in range to perform a specific interaction with the unit. -`inRange = CheckInteractDistance(unit, distIndex)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to compare distance to. -- `distIndex` - - *number* - A value from 1 to 5: - - 1 = Compare Achievements, 28 yards - - 2 = Trade, 8 yards - - 3 = Duel, 7 yards - - 4 = Follow, 28 yards - - 5 = Pet-battle Duel, 7 yards - -**Returns:** -- `inRange` - - *boolean* - 1 if you are in range to perform the interaction, nil otherwise. - -**Description:** -If "unit" is a hostile unit, the return values are the same. But you obviously won't be able to do things like Trade. - -**Usage:** -```lua -if ( CheckInteractDistance("target", 4) ) then - FollowUnit("target"); -else - -- we're too far away to follow the target -end -``` - -**Example Use Case:** -This function can be used in addons that need to check if a player is within a certain range to perform actions like trading, dueling, or following another player. For instance, an addon that automates following a party member would use this function to ensure the player is close enough to follow the target. - -**Addons Using This Function:** -Many large addons, such as "Questie" and "Zygor Guides," use this function to determine if the player is within range to interact with NPCs or other players for quest objectives or guide steps. \ No newline at end of file diff --git a/wiki-information/functions/CheckTalentMasterDist.md b/wiki-information/functions/CheckTalentMasterDist.md deleted file mode 100644 index c76abe32..00000000 --- a/wiki-information/functions/CheckTalentMasterDist.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CheckTalentMasterDist - -**Content:** -Needs summary. -`result = CheckTalentMasterDist()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ClassicExpansionAtLeast.md b/wiki-information/functions/ClassicExpansionAtLeast.md deleted file mode 100644 index 7aaba77f..00000000 --- a/wiki-information/functions/ClassicExpansionAtLeast.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: ClassicExpansionAtLeast - -**Content:** -Needs summary. -`isAtLeast = ClassicExpansionAtLeast(expansionLevel)` - -**Parameters:** -- `expansionLevel` - - *number* - -**Returns:** -- `isAtLeast` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ClearCursor.md b/wiki-information/functions/ClearCursor.md deleted file mode 100644 index ad852000..00000000 --- a/wiki-information/functions/ClearCursor.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: ClearCursor - -**Content:** -Clears any objects from the cursor. -`ClearCursor()` - -**Parameters:** -- None - -**Returns:** -- None - -**Usage:** -```lua -ClearCursor(); -PickUpContainerItem(0,1); -ClearCursor(); -PickUpContainerItem(0,1); -``` - -**Description:** -This function was added in patch 1.12 (The Drums of War). \ No newline at end of file diff --git a/wiki-information/functions/ClearOverrideBindings.md b/wiki-information/functions/ClearOverrideBindings.md deleted file mode 100644 index b1434ad7..00000000 --- a/wiki-information/functions/ClearOverrideBindings.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ClearOverrideBindings - -**Content:** -Removes all override bindings owned by a specific frame. -`ClearOverrideBindings(owner)` - -**Parameters:** -- `owner` - - *Frame* - The frame to clear override bindings for. - -**Description:** -The client will automatically restore overridden bindings once override bindings are cleared. \ No newline at end of file diff --git a/wiki-information/functions/ClearSendMail.md b/wiki-information/functions/ClearSendMail.md deleted file mode 100644 index 2399bb7f..00000000 --- a/wiki-information/functions/ClearSendMail.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: ClearSendMail - -**Content:** -Clears the text and item attachments in the Send Mail tab. -`ClearSendMail()` - -**Parameters:** -- None - -**Returns:** -- `nil` - -**Description:** -This function is used to clear any text and item attachments that have been added to the Send Mail tab in the in-game mail system. This can be useful for addons that manage or automate mail sending, ensuring that the mail tab is reset to a clean state before performing any operations. - -**Example Usage:** -An addon that automates sending items to a bank alt might use `ClearSendMail()` to ensure no leftover items or text from a previous mail operation interfere with the current one. - -**Addons Using This Function:** -- **Postal**: A popular mail management addon that enhances the in-game mail interface. It uses `ClearSendMail()` to clear the mail tab when performing batch mail operations, ensuring that each mail is sent correctly without leftover data from previous mails. \ No newline at end of file diff --git a/wiki-information/functions/ClearTarget.md b/wiki-information/functions/ClearTarget.md deleted file mode 100644 index da46b566..00000000 --- a/wiki-information/functions/ClearTarget.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ClearTarget - -**Content:** -Clears the selected target. -`willMakeChange = ClearTarget()` - -**Returns:** -- `willMakeChange` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ClickSendMailItemButton.md b/wiki-information/functions/ClickSendMailItemButton.md deleted file mode 100644 index b64179d0..00000000 --- a/wiki-information/functions/ClickSendMailItemButton.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: ClickSendMailItemButton - -**Content:** -Drops or picks up an item from the cursor to the Send Mail tab. -`ClickSendMailItemButton(itemIndex)` - -**Parameters:** -- `itemIndex` - - *number* - The index of the item (1-ATTACHMENTS_MAX_SEND(12)) -- `clearItem` - - *boolean?* - Clear the item already in this slot. (Done by right-clicking an item) \ No newline at end of file diff --git a/wiki-information/functions/ClickStablePet.md b/wiki-information/functions/ClickStablePet.md deleted file mode 100644 index 69ba58b2..00000000 --- a/wiki-information/functions/ClickStablePet.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: ClickStablePet - -**Content:** -Selects a stable pet. -`ClickStablePet(index)` - -**Parameters:** -- `index` - - *number* - -**Reference:** -- `GetSelectedStablePet()` - -**Example Usage:** -This function can be used in macros or addons to automate the selection of a pet from the stable. For instance, if you have a specific pet you want to select based on its index in the stable, you can use this function to do so. - -**Addons:** -Large addons like "PetTracker" might use this function to manage and automate pet selections within the game. \ No newline at end of file diff --git a/wiki-information/functions/CloseItemText.md b/wiki-information/functions/CloseItemText.md deleted file mode 100644 index 86882afa..00000000 --- a/wiki-information/functions/CloseItemText.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: CloseItemText - -**Content:** -Close an open item text (book, plaque, etc). -`CloseItemText()` - -**Description:** -Causes the `ITEM_TEXT_CLOSED` event to be sent. \ No newline at end of file diff --git a/wiki-information/functions/CloseLoot.md b/wiki-information/functions/CloseLoot.md deleted file mode 100644 index adca37fe..00000000 --- a/wiki-information/functions/CloseLoot.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: CloseLoot - -**Content:** -Close the loot window. -`CloseLoot()` - -**Parameters:** -- `errNum` - - *number?* - A reason for the window closing. Unsure whether/how the game deals with error codes passed to it. - -**Reference:** -- `LOOT_CLOSED` - -**Description:** -Pretty self-explanatory. Unless there is some type of error, don't pass the error argument. \ No newline at end of file diff --git a/wiki-information/functions/ClosePetition.md b/wiki-information/functions/ClosePetition.md deleted file mode 100644 index 86effa6f..00000000 --- a/wiki-information/functions/ClosePetition.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: ClosePetition - -**Content:** -Closes the current petition. -`ClosePetition()` - -**Description:** -Triggers `PETITION_CLOSED`. \ No newline at end of file diff --git a/wiki-information/functions/CloseSocketInfo.md b/wiki-information/functions/CloseSocketInfo.md deleted file mode 100644 index 5e0d07e4..00000000 --- a/wiki-information/functions/CloseSocketInfo.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: CloseSocketInfo - -**Content:** -Cancels pending gems for socketing. -`CloseSocketInfo()` - -**Reference:** -AcceptSockets \ No newline at end of file diff --git a/wiki-information/functions/ClosestUnitPosition.md b/wiki-information/functions/ClosestUnitPosition.md deleted file mode 100644 index a3be0939..00000000 --- a/wiki-information/functions/ClosestUnitPosition.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: ClosestUnitPosition - -**Content:** -Returns the unit position of the closest creature by ID. Only works for mobs in the starting zones. -`xPos, yPos, distance = ClosestUnitPosition(creatureID)` - -**Parameters:** -- `creatureID` - - *number* - NPC ID of a GUID of a creature. - -**Returns:** -- `xPos` - - *number* -- `yPos` - - *number* -- `distance` - - *number* - Relative distance in yards. \ No newline at end of file diff --git a/wiki-information/functions/CollapseFactionHeader.md b/wiki-information/functions/CollapseFactionHeader.md deleted file mode 100644 index 8fd9a67b..00000000 --- a/wiki-information/functions/CollapseFactionHeader.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: CollapseFactionHeader - -**Content:** -Collapse a faction header row. -`CollapseFactionHeader(rowIndex)` - -**Parameters:** -- `rowIndex` - - *number* - The row index of the header to collapse (Specifying a non-header row can have unpredictable results). The `UPDATE_FACTION` event is fired after the change since faction indexes will have been shifted around. - -**Reference:** -- `ExpandFactionHeader` \ No newline at end of file diff --git a/wiki-information/functions/CollapseQuestHeader.md b/wiki-information/functions/CollapseQuestHeader.md deleted file mode 100644 index 6b53f418..00000000 --- a/wiki-information/functions/CollapseQuestHeader.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: ExpandQuestHeader - -**Content:** -Expands/collapses a quest log header. -`ExpandQuestHeader(index)` -`CollapseQuestHeader(index)` - -**Parameters:** -- `index` - - *number* - Position in the quest log from 1 at the top, including collapsed and invisible content. -- `isAuto` - - *boolean* - Used when resetting the quest log to a default state. - -**Description:** -Applies to all headers when the index does not point to a header, including out-of-range values like 0. -Fires `QUEST_LOG_UPDATE`. Toggle `QuestMapFrame.ignoreQuestLogUpdate` to suppress the normal event handler. - -**Usage:** -Expand all quest headers: -```lua -ExpandQuestHeader(0) -``` -Collapse the first quest header (always at position 1) while suppressing the normal event handler: -```lua -QuestMapFrame.ignoreQuestLogUpdate = true -CollapseQuestHeader(1) -QuestMapFrame.ignoreQuestLogUpdate = nil -``` - -**Reference:** -`QuestMapFrame_ResetFilters()` - FrameXML function to restore the default expanded/collapsed state. \ No newline at end of file diff --git a/wiki-information/functions/CollapseSkillHeader.md b/wiki-information/functions/CollapseSkillHeader.md deleted file mode 100644 index 1472ddfb..00000000 --- a/wiki-information/functions/CollapseSkillHeader.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: CollapseSkillHeader - -**Content:** -Collapses a header in the skills window. -`CollapseSkillHeader(index)` - -**Parameters:** -- `index` - - *number* - The index of a line in the skills window, can be a header or skill line belonging to a header. Index 0 ("All") will collapse all headers. - -**Reference:** -- `GetSkillLineInfo()` \ No newline at end of file diff --git a/wiki-information/functions/CollapseTrainerSkillLine.md b/wiki-information/functions/CollapseTrainerSkillLine.md deleted file mode 100644 index 3e6ee86e..00000000 --- a/wiki-information/functions/CollapseTrainerSkillLine.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: CollapseTrainerSkillLine - -**Content:** -Collapses a header in the trainer window, hiding all spells below it. -`CollapseTrainerSkillLine(index)` - -**Parameters:** -- `index` - - *number* - The index of a line in the trainer window (if the supplied index is not a header, an error is produced). - - Index 0 ("All") will collapse all headers. - - Note that indices are affected by the trainer filter, see `GetTrainerServiceTypeFilter()` and `SetTrainerServiceTypeFilter()` - -**Usage:** -Collapses all trainer headers. This can also be done by using index 0 instead. -```lua -for i = 1, GetNumTrainerServices() do - local category = select(3, GetTrainerServiceInfo(i)) - if category == "header" then - CollapseTrainerSkillLine(i) - end -end -``` - -**Reference:** -- `GetTrainerServiceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/CombatLogAdvanceEntry.md b/wiki-information/functions/CombatLogAdvanceEntry.md deleted file mode 100644 index 1e83e5f8..00000000 --- a/wiki-information/functions/CombatLogAdvanceEntry.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: CombatLogAdvanceEntry - -**Content:** -Advances the combat log selection by the given amount of entries. -`CombatLogAdvanceEntry(count)` - -**Parameters:** -- `count` - - *number* - number of entries to traverse within the combat log, see details below. Can be negative. -- `ignoreFilter` - - *boolean* - set to true to ignore combat log filters - -**Returns:** -- `isValidIndex` - - *boolean* - will return false if the new index does not exist in the combat log, but will still set the entry regardless. Otherwise, returns true for valid indices. - -**Description:** -This function will traverse through the combat log by the given number of entries. It will not fail, or throw an error if you attempt to advance to an index that does not exist, instead it will return false but will still set the selected entry to that invalid index, and does NOT wrap around to the beginning when it reaches the end. - -**Usage:** -Combat log indexing and traversal -```lua -CombatLogSetCurrentEntry(0, true); -- sets current entry to the most recent entry, ignoring filters. --- will return false --- the above function sets the selected entry to 0, or the last value in the list. attempting to advance +1 entries from the end will result in an invalid index. -local success = CombatLogAdvanceEntry(1, true); - --- will return true --- instead of adding one to the index, we subtract one to move backwards through the combat log history. -local success = CombatLogAdvanceEntry(-1, true); - -CombatLogSetCurrentEntry(1, true); -- sets current entry to the first, or oldest entry, ignoring filters. --- will return true --- adding one to the index, we now traverse up from the oldest entry, as set above. -local success = CombatLogAdvanceEntry(1, true); -``` - -**Reference:** -- `CombatLogSetCurrentEntry()` -- `COMBAT_LOG_EVENT` \ No newline at end of file diff --git a/wiki-information/functions/CombatLogGetCurrentEntry.md b/wiki-information/functions/CombatLogGetCurrentEntry.md deleted file mode 100644 index 628e9737..00000000 --- a/wiki-information/functions/CombatLogGetCurrentEntry.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: CombatLogGetCurrentEntry - -**Content:** -Returns the combat log entry that is currently selected by `CombatLogSetCurrentEntry()`. -```lua -local timestamp, subevent, hideCaster, sourceGUID, sourceName, sourceFlags, sourceRaidFlags, destGUID, destName, destFlags, destRaidFlags = CombatLogGetCurrentEntry(); -``` - -**Returns:** -This function's returns are identical to those of `CombatLogGetCurrentEventInfo()`. For more details see `COMBAT_LOG_EVENT`. \ No newline at end of file diff --git a/wiki-information/functions/CombatLogGetCurrentEventInfo.md b/wiki-information/functions/CombatLogGetCurrentEventInfo.md deleted file mode 100644 index 999ce386..00000000 --- a/wiki-information/functions/CombatLogGetCurrentEventInfo.md +++ /dev/null @@ -1,47 +0,0 @@ -## Title: CombatLogGetCurrentEventInfo - -**Content:** -Returns the current COMBAT_LOG_EVENT payload. -`arg1, arg2, ... = CombatLogGetCurrentEventInfo()` - -**Returns:** -Returns a variable number of values: 11 base values and up to 13 extra values based upon the subtype of the event. - -**Description:** -In the new event system for 8.0, supporting the original functionality of the CLEU event was problematic due to the "context" arguments, i.e. each argument can be interpreted differently depending on the previous arguments. The payload was subsequently moved to this function. - -**Usage:** -Prints all CLEU parameters. -```lua -local function OnEvent(self, event) - print(CombatLogGetCurrentEventInfo()) -end -local f = CreateFrame("Frame") -f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") -f:SetScript("OnEvent", OnEvent) -``` - -Displays your spell or melee critical hits. -```lua -local playerGUID = UnitGUID("player") -local MSG_CRITICAL_HIT = "Your %s critically hit %s for %d damage!" -local f = CreateFrame("Frame") -f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") -f:SetScript("OnEvent", function(self, event) - local _, subevent, _, sourceGUID, _, _, _, _, destName = CombatLogGetCurrentEventInfo() - local spellId, amount, critical - if subevent == "SWING_DAMAGE" then - amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) - elseif subevent == "SPELL_DAMAGE" then - spellId, _, _, amount, _, _, _, _, _, critical = select(12, CombatLogGetCurrentEventInfo()) - end - if critical and sourceGUID == playerGUID then - -- get the link of the spell or the MELEE globalstring - local action = spellId and GetSpellLink(spellId) or MELEE - print(MSG_CRITICAL_HIT:format(action, destName, amount)) - end -end) -``` - -**Example Use Case:** -This function is commonly used in combat log analysis addons such as Recount and Details! Damage Meter. These addons use `CombatLogGetCurrentEventInfo` to parse combat log events and provide detailed statistics on damage, healing, and other combat metrics. \ No newline at end of file diff --git a/wiki-information/functions/CombatLogSetCurrentEntry.md b/wiki-information/functions/CombatLogSetCurrentEntry.md deleted file mode 100644 index c8b1bb0c..00000000 --- a/wiki-information/functions/CombatLogSetCurrentEntry.md +++ /dev/null @@ -1,47 +0,0 @@ -## Title: CombatLogSetCurrentEntry - -**Content:** -Sets the currently selected combat log entry to the given value, to be retrieved using `CombatLogGetCurrentEntry()`. -`CombatLogSetCurrentEntry(index)` - -**Parameters:** -- `index` - - *number* - see details below -- `ignoreFilter` - - *boolean* - set to true to ignore combat log filters - -**Returns:** -- `isValidIndex` - - *boolean* - will return false if the index does not exist in the combat log, but will still set the entry. Otherwise, returns true for valid indices. - -**Description:** -Combat log indexing works a bit differently than standard Lua indexing. You can treat the combat log like a big table, with the oldest entries being placed at the beginning, and the newest entries at the end. -Unlike standard Lua tables, however, an index of 0 will set the entry to the most recent combat log entry. Additionally, you are also able to index the combat log backwards using negative values. For example, an index of -1 will return the second to last, or second most recent entry in the combat log. -See `CombatLogAdvanceEntry()` for details on traversing the combat log. - -**Usage:** -```lua --- Combat log indexing -CombatLogSetCurrentEntry(0, true); -- most recent entry, ignoring filters. -local newestEntry = {CombatLogGetCurrentEntry()}; - -CombatLogSetCurrentEntry(1, true); -- oldest entry, ignoring filters. -local oldestEntry = {CombatLogGetCurrentEntry()}; - -CombatLogSetCurrentEntry(-5, true); -- fifth newest entry, ignoring filters. -local fifthNewestEntry = {CombatLogGetCurrentEntry()}; - -CombatLogSetCurrentEntry(5, true); -- fifth oldest entry, ignoring filters. -local fifthOldestEntry = {CombatLogGetCurrentEntry()}; -``` - -**Reference:** -- `CombatLogGetCurrentEntry()` -- `CombatLogAdvanceEntry()` - -**Example Use Case:** -This function can be used in addons that analyze combat logs for specific events or patterns. For instance, an addon that tracks damage taken over time might use this function to set the current entry to various points in the combat log to gather data. - -**Addons Using This Function:** -- **Recount**: A popular damage meter addon that tracks and displays damage, healing, and other combat-related statistics. It uses combat log entries to compile and display detailed combat data. -- **Details! Damage Meter**: Another comprehensive damage meter addon that provides in-depth analysis of combat logs to present detailed statistics on player performance. \ No newline at end of file diff --git a/wiki-information/functions/CombatLog_Object_IsA.md b/wiki-information/functions/CombatLog_Object_IsA.md deleted file mode 100644 index 2c0a9939..00000000 --- a/wiki-information/functions/CombatLog_Object_IsA.md +++ /dev/null @@ -1,64 +0,0 @@ -## Title: CombatLog_Object_IsA - -**Content:** -Returns whether a unit from the combat log matches a given filter. -`isMatch = CombatLog_Object_IsA(unitFlags, mask)` - -**Parameters:** -- `unitFlags` - - *number* - UnitFlag bitfield, i.e. sourceFlags or destFlags from COMBAT_LOG_EVENT. -- `mask` - - *number* - COMBATLOG_FILTER constant. - -**Returns:** -- `isMatch` - - *boolean* - True if a bitfield in each of the four main categories matches. - -**Description:** -Both of the arguments to this function must be valid Combat Log Objects. That is, for the four main categories of the UnitFlag bitfield, there must be at least one nonzero bit. Passing in a single COMBATLOG_OBJECT constant will cause the check to return false. - -**Miscellaneous:** -- **Constant** - bit field - - `COMBATLOG_FILTER_ME` - - `0x0000000000000001` - - `COMBATLOG_FILTER_MINE` - - `0x0000000000000005` - - `COMBATLOG_FILTER_MY_PET` - - `0x0000000000000011` - - `COMBATLOG_FILTER_FRIENDLY_UNITS` - - `0x00000000000000E1` - - `COMBATLOG_FILTER_HOSTILE_PLAYERS` - - `0x00000000000004E1` - - `COMBATLOG_FILTER_HOSTILE_UNITS` - - `0x00000000000004E2` - - `COMBATLOG_FILTER_NEUTRAL_UNITS` - - `0x00000000000004E4` - - `COMBATLOG_FILTER_UNKNOWN_UNITS` - - `0x0000000000000800` - - `COMBATLOG_FILTER_EVERYTHING` - - `0xFFFFFFFFFFFFFFFF` - -You can also construct your own filter; make sure to use at least one constant from each category: -```lua -local COMBATLOG_FILTER_FRIENDLY_PLAYERS = bit.bor( - COMBATLOG_OBJECT_AFFILIATION_PARTY, - COMBATLOG_OBJECT_AFFILIATION_RAID, - COMBATLOG_OBJECT_AFFILIATION_OUTSIDER, - COMBATLOG_OBJECT_REACTION_FRIENDLY, - COMBATLOG_OBJECT_CONTROL_PLAYER, - COMBATLOG_OBJECT_TYPE_PLAYER -) -``` - -**Usage:** -Prints if the combat log source unit is a hostile NPC. -```lua -local f = CreateFrame("Frame") -f:RegisterEvent("COMBAT_LOG_EVENT_UNFILTERED") -f:SetScript("OnEvent", function(self, event) - local timestamp, subevent, _, sourceGUID, sourceName, sourceFlags = CombatLogGetCurrentEventInfo() - if CombatLog_Object_IsA(sourceFlags, COMBATLOG_FILTER_HOSTILE_UNITS) then - print(subevent, sourceName, format("0x%X", sourceFlags), "is a hostile NPC") - end -end) -``` \ No newline at end of file diff --git a/wiki-information/functions/CombatTextSetActiveUnit.md b/wiki-information/functions/CombatTextSetActiveUnit.md deleted file mode 100644 index 23a65d0e..00000000 --- a/wiki-information/functions/CombatTextSetActiveUnit.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: CombatTextSetActiveUnit - -**Content:** -Changes the entity for which COMBAT_TEXT_UPDATE events fire. -`CombatTextSetActiveUnit(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The entity you want to receive notifications for. - -**Description:** -The event is tied to the entity rather than the unit -- thus, if you call `CombatTextSetActiveUnit("target")` and then target something else, you'll get notifications for the unit you were targeting when calling the function, rather than your new target. -Only one unit can be "active" at a time. -The `COMBAT_TEXT_UPDATE` event is used to provide part of Blizzard's Floating Combat Text functionality; it fires to notify of aura gains/losses and incoming damage and heals. - -**Reference:** -- `COMBAT_TEXT_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/CompleteQuest.md b/wiki-information/functions/CompleteQuest.md deleted file mode 100644 index 50d9ed32..00000000 --- a/wiki-information/functions/CompleteQuest.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: CompleteQuest - -**Content:** -Continues the quest dialog to the reward selection step. -`CompleteQuest()` - -**Description:** -Unlike the name would suggest, this does not finalize the completion of a quest. Instead, it is called when you press the continue button, and is used to continue from the progress dialog to the completion dialog. See `GetQuestReward()` for actually completing a quest. - -If you're interested in hooking the function called when completing a quest, check out `QuestRewardCompleteButton_OnClick` (in `FrameXML\\QuestFrame.lua`) instead. \ No newline at end of file diff --git a/wiki-information/functions/ConfirmAcceptQuest.md b/wiki-information/functions/ConfirmAcceptQuest.md deleted file mode 100644 index 3ed8b934..00000000 --- a/wiki-information/functions/ConfirmAcceptQuest.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: ConfirmAcceptQuest - -**Content:** -Accepts a quest started by a group member (e.g. escort quests). -`ConfirmAcceptQuest()` - -**Description:** -Can be used after the `QUEST_ACCEPT_CONFIRM` event has fired. \ No newline at end of file diff --git a/wiki-information/functions/ConfirmLootRoll.md b/wiki-information/functions/ConfirmLootRoll.md deleted file mode 100644 index 871c14be..00000000 --- a/wiki-information/functions/ConfirmLootRoll.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: ConfirmLootRoll - -**Content:** -Confirms a loot roll. -`ConfirmLootRoll(rollID)` - -**Parameters:** -- `rollID` - - *number* - As passed by the event. (The number increases with every roll you have in a party) -- `roll` - - *number* - Type of roll: (also passed by the event) - - `1` : Need roll - - `2` : Greed roll - - `3` : Disenchant roll - -**Usage:** -```lua -local f = CreateFrame("Frame", "MyAddon") -f:RegisterEvent("CONFIRM_LOOT_ROLL") -f:SetScript("OnEvent", function(self, event, ...) - if event == "CONFIRM_LOOT_ROLL" then - local rollID, roll = ... - ConfirmLootRoll(rollID, roll) - end -end) -``` - -**Reference:** -- `CONFIRM_LOOT_ROLL` -- `CONFIRM_DISENCHANT_ROLL` \ No newline at end of file diff --git a/wiki-information/functions/ConfirmLootSlot.md b/wiki-information/functions/ConfirmLootSlot.md deleted file mode 100644 index 0079b707..00000000 --- a/wiki-information/functions/ConfirmLootSlot.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ConfirmLootSlot - -**Content:** -Confirms looting of a BoP item. -`ConfirmLootSlot(slot)` - -**Parameters:** -- `slot` - - *number* - the loot slot of a BoP loot item that is waiting for confirmation - -**Description:** -If the player has already clicked on a LootButton object with loot index 1, and the item is "Bind on Pickup" and awaiting confirmation, then the item will be looted and placed in the player's bags. \ No newline at end of file diff --git a/wiki-information/functions/ConfirmPetUnlearn.md b/wiki-information/functions/ConfirmPetUnlearn.md deleted file mode 100644 index dac9ee0d..00000000 --- a/wiki-information/functions/ConfirmPetUnlearn.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ConfirmPetUnlearn - -**Content:** -Confirms unlearning the current pet's skills. -`ConfirmPetUnlearn()` - -**Reference:** -- `GetSelectedStablePet()` -- `CONFIRM_PET_UNLEARN` \ No newline at end of file diff --git a/wiki-information/functions/ConfirmReadyCheck.md b/wiki-information/functions/ConfirmReadyCheck.md deleted file mode 100644 index adb8ac97..00000000 --- a/wiki-information/functions/ConfirmReadyCheck.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ConfirmReadyCheck - -**Content:** -Responds to a ready check. -`ConfirmReadyCheck(isReady)` - -**Parameters:** -- `isReady` - - *number?* - 1 if the player is ready, nil if the player is not ready - -**Description:** -This function is used in response to receiving a READY_CHECK event. Normally this event will display the ReadyCheckFrame dialog which will in turn call ConfirmReadyCheck in response to the user clicking the Yes or No button. \ No newline at end of file diff --git a/wiki-information/functions/ConsoleAddMessage.md b/wiki-information/functions/ConsoleAddMessage.md deleted file mode 100644 index 15f6eff2..00000000 --- a/wiki-information/functions/ConsoleAddMessage.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ConsoleAddMessage - -**Content:** -Needs summary. -`ConsoleAddMessage(message)` - -**Parameters:** -- `message` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/ConsoleExec.md b/wiki-information/functions/ConsoleExec.md deleted file mode 100644 index ebf62823..00000000 --- a/wiki-information/functions/ConsoleExec.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ConsoleExec - -**Content:** -Execute a console command. -`ConsoleExec(command)` - -**Parameters:** -- `command` - - *string* - The console command to execute. - -**Description:** -`/run ConsoleExec("command")` is equivalent to `/console command`. \ No newline at end of file diff --git a/wiki-information/functions/ConsoleGetAllCommands.md b/wiki-information/functions/ConsoleGetAllCommands.md deleted file mode 100644 index edd8549e..00000000 --- a/wiki-information/functions/ConsoleGetAllCommands.md +++ /dev/null @@ -1,64 +0,0 @@ -## Title: ConsoleGetAllCommands - -**Content:** -Needs summary. -`commands = ConsoleGetAllCommands()` - -**Returns:** -- `commands` - - *ConsoleCommandInfo* - - `Field` - - `Type` - - `Description` - - `command` - - *string* - - `help` - - *string* - - `category` - - *Enum.ConsoleCategory* - - `commandType` - - *Enum.ConsoleCommandType* - - `scriptContents` - - *string* - - `scriptParameters` - - *string* - -**Enum.ConsoleCategory:** -- `Value` - - `Field` - - `Description` - - `0` - - Debug - - `1` - - Graphics - - `2` - - Console - - `3` - - Combat - - `4` - - Game - - `5` - - Default - - `6` - - Net - - `7` - - Sound - - `8` - - Gm - - `9` - - Reveal - - `10` - - None - -**Enum.ConsoleCommandType:** -- `Value` - - `Field` - - `Description` - - `0` - - Cvar - - `1` - - Command - - `2` - - Macro - - `3` - - Script \ No newline at end of file diff --git a/wiki-information/functions/ConsoleGetColorFromType.md b/wiki-information/functions/ConsoleGetColorFromType.md deleted file mode 100644 index 14867353..00000000 --- a/wiki-information/functions/ConsoleGetColorFromType.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: ConsoleGetColorFromType - -**Content:** -Needs summary. -`color = ConsoleGetColorFromType(colorType)` - -**Parameters:** -- `colorType` - - *Enum.ConsoleColorType* - - `Value` - - `Field` - - `Description` - - `0` - DefaultColor - - `1` - InputColor - - `2` - EchoColor - - `3` - ErrorColor - - `4` - WarningColor - - `5` - GlobalColor - - `6` - AdminColor - - `7` - HighlightColor - - `8` - BackgroundColor - - `9` - ClickbufferColor - - `10` - PrivateColor - - `11` - DefaultGreen - -**Returns:** -- `color` - - *colorRGB* \ No newline at end of file diff --git a/wiki-information/functions/ConsoleGetFontHeight.md b/wiki-information/functions/ConsoleGetFontHeight.md deleted file mode 100644 index fc3d24f7..00000000 --- a/wiki-information/functions/ConsoleGetFontHeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ConsoleGetFontHeight - -**Content:** -Needs summary. -`fontHeightInPixels = ConsoleGetFontHeight()` - -**Returns:** -- `fontHeightInPixels` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/ConsolePrintAllMatchingCommands.md b/wiki-information/functions/ConsolePrintAllMatchingCommands.md deleted file mode 100644 index 36502f86..00000000 --- a/wiki-information/functions/ConsolePrintAllMatchingCommands.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ConsolePrintAllMatchingCommands - -**Content:** -Needs summary. -`ConsolePrintAllMatchingCommands(partialCommandText)` - -**Parameters:** -- `partialCommandText` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/ConsoleSetFontHeight.md b/wiki-information/functions/ConsoleSetFontHeight.md deleted file mode 100644 index 99babf9b..00000000 --- a/wiki-information/functions/ConsoleSetFontHeight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ConsoleSetFontHeight - -**Content:** -Needs summary. -`ConsoleSetFontHeight(fontHeightInPixels)` - -**Parameters:** -- `fontHeightInPixels` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/ContainerIDToInventoryID.md b/wiki-information/functions/ContainerIDToInventoryID.md deleted file mode 100644 index f9cf29b2..00000000 --- a/wiki-information/functions/ContainerIDToInventoryID.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: ContainerIDToInventoryID - -**Content:** -`bagID = ContainerIDToInventoryID(containerID)` - -**Parameters:** -- `bagID` - - *number* - BagID between 1 and NUM_BAG_SLOTS + NUM_BANKBAGSLOTS - -**Values:** -| ID | Vanilla1.13.7 | Vanilla1.14.0 | TBC2.5.2 | Retail | Description | -|----|---------------|---------------|----------|--------|-------------| -| 1 | 20 | | | | 1st character bag | -| 2 | 21 | | | | 2nd character bag | -| 3 | 22 | | | | 3rd character bag | -| 4 | 23 | | | | 4th character bag | -| 48-71 | 48-71 | 48-75 | 52-79 | | bank slots (vanilla: 24, bcc/retail: 28) | -| 5 | 72 | 76 | 76 | 80 | 1st bank bag | -| 6 | 73 | 77 | 77 | 81 | 2nd bank bag | -| 7 | 74 | 78 | 78 | 82 | 3rd bank bag | -| 8 | 75 | 79 | 79 | 83 | 4th bank bag | -| 9 | 76 | 80 | 80 | 84 | 5th bank bag | -| 10 | 77 | 81 | 81 | 85 | 6th bank bag | -| 11 | | 82 | 86 | | 7th bank bag | - -**Returns:** -- `inventoryID` - - *number* - InventorySlotId used in functions like `PutItemInBag()` and `GetInventoryItemLink()` - -**Usage:** -Prints all bag container IDs and their respective inventory IDs (You need to be at the bank for bank inventory IDs to return valid results): -```lua -for i = 1, NUM_BAG_SLOTS + NUM_BANKBAGSLOTS do - local invID = ContainerIDToInventoryID(i) - print(i, invID, GetInventoryItemLink("player", invID)) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/ConvertToParty.md b/wiki-information/functions/ConvertToParty.md deleted file mode 100644 index 83e1f9fd..00000000 --- a/wiki-information/functions/ConvertToParty.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: ConvertToParty - -**Content:** -Converts a raid group with 5 or fewer members to a party. -`ConvertToParty()` - -**Reference:** -`ConvertToRaid` \ No newline at end of file diff --git a/wiki-information/functions/ConvertToRaid.md b/wiki-information/functions/ConvertToRaid.md deleted file mode 100644 index de7313a5..00000000 --- a/wiki-information/functions/ConvertToRaid.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: C_PartyInfo.ConvertToRaid - -**Content:** -Needs summary. -`C_PartyInfo.ConvertToRaid()` - -**Description:** -Usually, this will convert to raid immediately. In some cases (e.g. PartySync), the user will be prompted to confirm converting to raid, because it's potentially destructive. \ No newline at end of file diff --git a/wiki-information/functions/CopyToClipboard.md b/wiki-information/functions/CopyToClipboard.md deleted file mode 100644 index 9bff731d..00000000 --- a/wiki-information/functions/CopyToClipboard.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: CopyToClipboard - -**Content:** -Copies text to the clipboard. -`length = CopyToClipboard(text)` - -**Parameters:** -- `text` - - *string* -- `removeMarkup` - - *boolean?* = false - -**Returns:** -- `length` - - *number* - -**Example Usage:** -```lua -local textToCopy = "Hello, World!" -local length = CopyToClipboard(textToCopy) -print("Copied text length: " .. length) -``` - -**Description:** -The `CopyToClipboard` function is useful for copying text programmatically within the game. This can be particularly handy for addons that need to allow users to easily copy information, such as coordinates, item links, or other data, to their clipboard for use outside the game. - -**Addons Using This Function:** -Many UI enhancement addons, such as ElvUI and WeakAuras, use this function to provide users with the ability to copy text directly from the game interface to their system clipboard. This enhances user experience by allowing easy sharing of information. \ No newline at end of file diff --git a/wiki-information/functions/CreateFont.md b/wiki-information/functions/CreateFont.md deleted file mode 100644 index 5bfb4f56..00000000 --- a/wiki-information/functions/CreateFont.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: CreateFont - -**Content:** -Creates a Font object. -`fontObject = CreateFont(name)` - -**Parameters:** -- `name` - - *string* - Globally-accessible name to be assigned for use as `_G`. - -**Returns:** -- `fontObject` - - *Font* - Reference to the new font object. - -**Description:** -Font objects, similar to XML `` elements, may be used to create a common font pattern assigned to several widgets via `FontInstance:SetFontObject(fontObject)`. -Subsequently changing the font object will affect the text displayed on every widget it was assigned to. -Since the new font object is created without any properties, it should be initialized via `FontInstance:SetFont(path, height)` or `Font:CopyFontObject(otherFont)`. - -**Example Usage:** -```lua -local myFont = CreateFont("MyFont") -myFont:SetFont("Fonts\\FRIZQT__.TTF", 12) -myText:SetFontObject(myFont) -``` - -**Addons Using This:** -Many large addons, such as ElvUI and WeakAuras, use `CreateFont` to create custom font objects for consistent text styling across various UI elements. For example, ElvUI uses it to ensure that all text elements adhere to the user's chosen font settings, providing a cohesive look and feel. \ No newline at end of file diff --git a/wiki-information/functions/CreateFrame.md b/wiki-information/functions/CreateFrame.md deleted file mode 100644 index ac6ceab2..00000000 --- a/wiki-information/functions/CreateFrame.md +++ /dev/null @@ -1,105 +0,0 @@ -## Title: CreateFrame - -**Content:** -Creates a Frame object. -`frame = CreateFrame(frameType)` - -**Parameters:** -- `frameType` - - *string* - Type of the frame; e.g. "Frame" or "Button". -- `name` - - *string?* - Globally accessible name to assign to the frame, or nil for an anonymous frame. -- `parent` - - *Frame?* - Parent object to assign to the frame, or nil to be parentless; cannot be a string. Can also be set with `Region:SetParent()`. -- `template` - - *string?* - Comma-delimited list of virtual XML templates to inherit; see also a complete list of FrameXML templates. -- `id` - - *number?* - ID to assign to the frame. Can also be set with `Frame:SetID()`. - -**Returns:** -- `frame` - - *Frame* - The created Frame object or one of the other frame type objects. - -**Miscellaneous:** -Possible frame types are available from the XML schema: -- Frame -- ArchaeologyDigSiteFrame -- Browser -- Button -- CheckButton -- Checkout -- CinematicModel -- ColorSelect -- Cooldown -- DressUpModel -- EditBox -- FogOfWarFrame -- GameTooltip -- MessageFrame -- Model -- ModelScene -- MovieFrame -- OffScreenFrame -- PlayerModel -- QuestPOIFrame -- ScenarioPOIFrame -- ScrollFrame -- SimpleHTML -- Slider -- StatusBar -- TabardModel -- UnitPositionFrame - -**Description:** -Fires the frame's OnLoad script, if it has one from an inherited template. -Frames cannot be deleted or garbage collected, so it may be preferable to reuse them. -Intrinsic frames may also be used. - -**Usage:** -Shows a texture which is also parented to UIParent so it will have the same UI scale and hidden when toggled with Alt-Z -```lua -local f = CreateFrame("Frame", nil, UIParent) -f:SetPoint("CENTER") -f:SetSize(64, 64) -f.tex = f:CreateTexture() -f.tex:SetAllPoints(f) -f.tex:SetTexture("interface/icons/inv_mushroom_11") -``` - -Creates a button which inherits textures and widget scripts from UIPanelButtonTemplate -```lua -local btn = CreateFrame("Button", nil, UIParent, "UIPanelButtonTemplate") -btn:SetPoint("CENTER") -btn:SetSize(100, 40) -btn:SetText("Click me") -btn:SetScript("OnClick", function(self, button, down) - print("Pressed", button, down and "down" or "up") -end) -btn:RegisterForClicks("AnyDown", "AnyUp") -``` - -Displays an animated model for a DisplayID. -```lua -local m = CreateFrame("PlayerModel") -m:SetPoint("CENTER") -m:SetSize(200, 200) -m:SetDisplayInfo(21723) -- murloccostume.m2 -``` - -Registers for events being fired, like chat messages and when you start/stop moving. -```lua -local function OnEvent(self, event, ...) - print(event, ...) -end -local f = CreateFrame("Frame") -f:RegisterEvent("CHAT_MSG_CHANNEL") -f:RegisterEvent("PLAYER_STARTED_MOVING") -f:RegisterEvent("PLAYER_STOPPED_MOVING") -f:SetScript("OnEvent", OnEvent) -``` - -**Reference:** -- `CreateFramePool()` - -**Example Use Case:** -CreateFrame is widely used in many addons to create various UI elements. For example, the popular addon "WeakAuras" uses `CreateFrame` to create custom frames for displaying auras and other visual indicators. \ No newline at end of file diff --git a/wiki-information/functions/CreateMacro.md b/wiki-information/functions/CreateMacro.md deleted file mode 100644 index dc37f929..00000000 --- a/wiki-information/functions/CreateMacro.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: CreateMacro - -**Content:** -Creates a macro. -`macroId = CreateMacro(name, iconFileID)` - -**Parameters:** -- `name` - - *string* - The name of the macro to be displayed in the UI. The current UI imposes a 16-character limit. -- `iconFileID` - - *number|string* - A FileID or string identifying the icon texture to use. The available icons can be retrieved by calling `GetMacroIcons()` and `GetMacroItemIcons()`; other textures inside `Interface\\ICONS` may also be used. -- `body` - - *string?* - The macro commands to be executed. If this string is longer than 255 characters, only the first 255 will be saved. -- `perCharacter` - - *boolean?* - true to create a per-character macro, nil to create a general macro available to all characters. - -**Returns:** -- `macroId` - - *number* - The 1-based index of the newly-created macro, as displayed in the "Create Macros" UI. - -**Usage:** -Creates an empty macro with the respective FileID for "trade_engineering": -```lua -/run CreateMacro("test", 136243) -``` -Creates a character-specific macro. The question mark icon will dynamically display the Hearthstone icon: -```lua -/run CreateMacro("to home", "INV_Misc_QuestionMark", "/cast Hearthstone", true) -``` - -**Description:** -This function will generate an error if the maximum macros of the specified kind already exist (120 for per account and 18 for per character). -It is possible to create macros with duplicate names. You should enumerate the current macros using `GetNumMacros()` and `GetMacroInfo(macroId)` to ensure that your new macro name doesn't already exist. Macros with duplicate names can be used in most situations, but the behavior of macro functions that retrieve a macro by name is undefined when multiple macros of that name exist. - -**Reference:** -- `EditMacro` \ No newline at end of file diff --git a/wiki-information/functions/CreateWindow.md b/wiki-information/functions/CreateWindow.md deleted file mode 100644 index 9d9485ae..00000000 --- a/wiki-information/functions/CreateWindow.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: CreateWindow - -**Content:** -Needs summary. -`window = CreateWindow()` - -**Parameters:** -- `popupStyle` - - *boolean?* = true - -**Returns:** -- `window` - - *SimpleWindow?* - -**Description:** -This function is disabled in public clients and will always return nil. \ No newline at end of file diff --git a/wiki-information/functions/CursorCanGoInSlot.md b/wiki-information/functions/CursorCanGoInSlot.md deleted file mode 100644 index 41204fba..00000000 --- a/wiki-information/functions/CursorCanGoInSlot.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: CursorCanGoInSlot - -**Content:** -True if the item held by the cursor can be equipped in the specified (equipment) inventory slot. -`fitsInSlot = CursorCanGoInSlot(invSlot)` - -**Parameters:** -- `invSlot` - - *number* : inventorySlotId - Inventory slot to query - -**Returns:** -- `fitsInSlot` - - *boolean* - 1 if the thing currently on the cursor can go into the specified slot, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/CursorHasItem.md b/wiki-information/functions/CursorHasItem.md deleted file mode 100644 index cd667a73..00000000 --- a/wiki-information/functions/CursorHasItem.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: CursorHasItem - -**Content:** -Returns true if the cursor currently holds an item. -`hasItem = CursorHasItem()` - -**Returns:** -- `hasItem` - - *boolean* - Whether the cursor is holding an item. - -**Description:** -This function returns nil if the item on the cursor was not picked up via `PickupContainerItem`, e.g. items from the guild bank (which are picked up via `PickupGuildBankItem`) or a merchant item. \ No newline at end of file diff --git a/wiki-information/functions/CursorHasMacro.md b/wiki-information/functions/CursorHasMacro.md deleted file mode 100644 index 8c070208..00000000 --- a/wiki-information/functions/CursorHasMacro.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CursorHasMacro - -**Content:** -Needs summary. -`result = CursorHasMacro()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/CursorHasMoney.md b/wiki-information/functions/CursorHasMoney.md deleted file mode 100644 index fad9f3e6..00000000 --- a/wiki-information/functions/CursorHasMoney.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: CursorHasMoney - -**Content:** -Needs summary. -`result = CursorHasMoney()` - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -This function can be used to check if the cursor is currently holding money. This is useful in scenarios where you need to verify if a player is attempting to drag and drop money, such as when making a trade or depositing money into a guild bank. - -**Addons:** -Many large addons that deal with trading, banking, or auction house functionalities might use this function to ensure proper handling of money transactions. For example, the popular addon "TradeSkillMaster" could use this function to verify if the user is trying to move money while managing their auctions or inventory. \ No newline at end of file diff --git a/wiki-information/functions/CursorHasSpell.md b/wiki-information/functions/CursorHasSpell.md deleted file mode 100644 index 2a49b4f1..00000000 --- a/wiki-information/functions/CursorHasSpell.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: CursorHasSpell - -**Content:** -Needs summary. -`result = CursorHasSpell()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/DeathRecap_GetEvents.md b/wiki-information/functions/DeathRecap_GetEvents.md deleted file mode 100644 index 4a36fa13..00000000 --- a/wiki-information/functions/DeathRecap_GetEvents.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title: DeathRecap_GetEvents - -**Content:** -Returns a table representing the last five damaging combat events against the player. -`events = DeathRecap_GetEvents()` - -**Parameters:** -- `recapID` - - *number* - The specific death to view, from 1 to the most recent death. If this is not given, the most recent ID is used. - -**Returns:** -- `events` - - *table* - A table of events for the chosen death, or nil if the player has not died this session. - -**Description:** -The return table contains five sub tables. The keys for these tables are the same as the param names used for COMBAT_LOG_EVENT. -Example: -```lua -{ - { - timestamp = 1421121447.489, - event = "SWING_DAMAGE", - hideCaster = false, - sourceGUID = "Creature-0-3296-870-59-72280-0000347644", - sourceName = "Manifestation of Pride", - sourceFlags = 2632, - sourceRaidFlags = 0, - destGUID = "Player-3296-0084A447", - destName = "Gethe", - destFlags = 1297, - destRaidFlags = 0, - amount = 1472, - overkill = -1, - school = 1, - critical = false, - glancing = false, - crushing = false, - isOffHand = false, - multistrike = false, - currentHP = 2185, - }, - {...}, - {...}, - {...}, - {...}, -} -``` - -**Reference:** -- `DeathRecap_HasEvents` -- `GetDeathRecapLink` \ No newline at end of file diff --git a/wiki-information/functions/DeathRecap_HasEvents.md b/wiki-information/functions/DeathRecap_HasEvents.md deleted file mode 100644 index 38d0a4d9..00000000 --- a/wiki-information/functions/DeathRecap_HasEvents.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: DeathRecap_HasEvents - -**Content:** -Returns a boolean for if the player has any available death events. -`hasEvents = DeathRecap_HasEvents()` - -**Returns:** -- `hasEvents` - - *boolean* - Whether or not `DeathRecap_GetEvents` can return a useful value. - -**Reference:** -- `DeathRecap_GetEvents` -- `GetDeathRecapLink` \ No newline at end of file diff --git a/wiki-information/functions/DeclineArenaTeam.md b/wiki-information/functions/DeclineArenaTeam.md deleted file mode 100644 index b3baa900..00000000 --- a/wiki-information/functions/DeclineArenaTeam.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: DeclineArenaTeam - -**Content:** -Declines a pending arena team invitation. -`DeclineArenaTeam()` - -**Description:** -Only one arena team invitation may be pending at any time. - -**Reference:** -- `ARENA_TEAM_INVITE_REQUEST` -- `ARENA_TEAM_INVITE_CANCEL` - -**See also:** -- `AcceptArenaTeam` \ No newline at end of file diff --git a/wiki-information/functions/DeclineChannelInvite.md b/wiki-information/functions/DeclineChannelInvite.md deleted file mode 100644 index d50f002c..00000000 --- a/wiki-information/functions/DeclineChannelInvite.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: DeclineChannelInvite - -**Content:** -Declines an invitation to join a specific chat channel. -`DeclineChannelInvite(channel)` - -**Parameters:** -- `channel` - - *string* - name of the channel the player was invited to but does not wish to join. - -**Description:** -`CHANNEL_INVITE_REQUEST` fires when the player has been invited to a chat channel. -There is no equivalent Accept function; FrameXML merely calls `JoinPermanentChannel` when the invitation is accepted. \ No newline at end of file diff --git a/wiki-information/functions/DeclineGroup.md b/wiki-information/functions/DeclineGroup.md deleted file mode 100644 index 3cca2a22..00000000 --- a/wiki-information/functions/DeclineGroup.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: DeclineGroup - -**Content:** -Declines an invitation to a group. -`DeclineGroup()` - -**Usage:** -The following snippet auto-declines invitations from characters whose names contain Ghost. -```lua -local frame = CreateFrame("FRAME") -frame:RegisterEvent("PARTY_INVITE_REQUEST") -frame:SetScript("OnEvent", function(self, event, sender) - if sender:match("Ghost") then - DeclineGroup() - end -end) -``` - -**Description:** -You can use this after receiving the `PARTY_INVITE_REQUEST` event. If there is no invitation to a party, this function doesn't do anything. -Calling this function does NOT cause the "accept/decline dialog" to go away. Use `StaticPopup_Hide("PARTY_INVITE")` to hide the dialog. -Depending on the order events are dispatched in, your event handler may run before UIParent's, and therefore attempt to hide the dialog before it is shown. Delaying the attempt to hide the popup until `PARTY_MEMBERS_CHANGED` resolves this. \ No newline at end of file diff --git a/wiki-information/functions/DeclineGuild.md b/wiki-information/functions/DeclineGuild.md deleted file mode 100644 index e82c7ae5..00000000 --- a/wiki-information/functions/DeclineGuild.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: DeclineGuild - -**Content:** -Declines a guild invite. -`DeclineGuild()` - -**Reference:** -- `GUILD_INVITE_REQUEST` -- `GUILD_INVITE_CANCEL` -- See also: - - `AcceptGuild` \ No newline at end of file diff --git a/wiki-information/functions/DeclineName.md b/wiki-information/functions/DeclineName.md deleted file mode 100644 index 8f08f265..00000000 --- a/wiki-information/functions/DeclineName.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: DeclineName - -**Content:** -Returns suggested declensions for a Russian name. -`genitive, dative, accusative, instrumental, prepositional = DeclineName(name, gender, declensionSet)` - -**Parameters:** -- `name` - - *string* - Nominative form of the player's or pet's name (string) -- `gender` - - *number* - Gender for the returned names (for declensions of the player's name, should match the player's gender; for the pet's name, should be neuter). - - `ID` - - `Gender` - - `1` - - Neutrum / Unknown - - `2` - - Male - - `3` - - Female -- `declensionSet` - - *number* - Ranging from 1 to `GetNumDeclensionSets()`. Lower indices correspond to "better" suggestions for the given name. - -**Returns:** -- `genitive` - - *string* -- `dative` - - *string* -- `accusative` - - *string* -- `instrumental` - - *string* -- `prepositional` - - *string* - -**Description:** -Requires the ruRU client. -Static names for e.g NPCs are in `DeclinedWord.db2`, `DeclinedWordCases.db2`. \ No newline at end of file diff --git a/wiki-information/functions/DeclineQuest.md b/wiki-information/functions/DeclineQuest.md deleted file mode 100644 index 6a38c4c8..00000000 --- a/wiki-information/functions/DeclineQuest.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: DeclineQuest - -**Content:** -Declines the currently offered quest. -`DeclineQuest()` - -**Description:** -You can call this function once the QUEST_DETAIL event fires. - -**Reference:** -[AcceptQuest](#acceptquest) \ No newline at end of file diff --git a/wiki-information/functions/DeclineResurrect.md b/wiki-information/functions/DeclineResurrect.md deleted file mode 100644 index f8a673c8..00000000 --- a/wiki-information/functions/DeclineResurrect.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: DeclineResurrect - -**Content:** -Declines a resurrection offer. -`DeclineResurrect()` - -**Reference:** -- `RESURRECT_REQUEST` - -**See also:** -- `AcceptResurrect` \ No newline at end of file diff --git a/wiki-information/functions/DeclineSpellConfirmationPrompt.md b/wiki-information/functions/DeclineSpellConfirmationPrompt.md deleted file mode 100644 index ad037032..00000000 --- a/wiki-information/functions/DeclineSpellConfirmationPrompt.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: DeclineSpellConfirmationPrompt - -**Content:** -Declines a spell confirmation prompt (e.g. bonus loot roll). -`DeclineSpellConfirmationPrompt(spellID)` - -**Parameters:** -- `spellID` - - *number* - spell ID of the prompt to decline. - -**Description:** -SPELL_CONFIRMATION_PROMPT fires when a spell confirmation prompt might be presented to the player; it provides the spellID and information about the type, text, and duration of the confirmation prompt. -Calling this function declines the spell prompt: the player does not perform the prompted action. - -**Reference:** -- `AcceptSpellConfirmationPrompt` - -### Example Usage: -This function can be used in scenarios where an addon or script needs to automatically decline certain spell confirmation prompts, such as declining bonus loot rolls in a raid environment. - -### Addon Usage: -Large addons like Deadly Boss Mods (DBM) might use this function to automatically decline certain prompts during encounters to ensure that the player's focus remains on the fight mechanics rather than on additional prompts. \ No newline at end of file diff --git a/wiki-information/functions/DeleteCursorItem.md b/wiki-information/functions/DeleteCursorItem.md deleted file mode 100644 index c2d42157..00000000 --- a/wiki-information/functions/DeleteCursorItem.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: DeleteCursorItem - -**Content:** -Destroys the item held by the cursor. -`DeleteCursorItem()` - -**Description:** -This does not deselect the item, this destroys it. Use `ClearCursor()` to drop an item from the cursor without destroying it. \ No newline at end of file diff --git a/wiki-information/functions/DeleteInboxItem.md b/wiki-information/functions/DeleteInboxItem.md deleted file mode 100644 index 99e0c03f..00000000 --- a/wiki-information/functions/DeleteInboxItem.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: DeleteInboxItem - -**Content:** -Requests the server to remove a mailbox message. -`DeleteInboxItem(index)` - -**Parameters:** -- `index` - - *number* - the index of the message (1 is the first message) - -**Description:** -`DeleteInboxItem()` returns immediately but one must listen for `MAIL_INBOX_UPDATE`. -The asynchronous request may fail for different reasons, such as an invalid index or when another deletion request is already in progress. -`DeleteInboxItem()` is an unconditional request; the server does not check whether the message still has an item or money attached. -The confirmation box that appears in-game for these conditions is instead triggered by `InboxItemCanDelete` before calling `DeleteInboxItem`. -Note that `InboxItemCanDelete` is not a permission-checking function, it is just an API for determining whether a message is returnable (and thus has a misleading name). All messages are in fact deletable. \ No newline at end of file diff --git a/wiki-information/functions/DeleteMacro.md b/wiki-information/functions/DeleteMacro.md deleted file mode 100644 index 1beb9b1d..00000000 --- a/wiki-information/functions/DeleteMacro.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: DeleteMacro - -**Content:** -Deletes a macro. -`DeleteMacro(indexOrName)` - -**Parameters:** -The sole argument has two forms to identify which macro to delete. -- `indexOrName` - - *number|string* - Index ranging from 1 to 120 for account-wide macros and 121 to 138 for character-specific ones or name of the macro to delete. - -**Usage:** -Deleting all global macros: -```lua --- Start at the end, and move backward to first position (1). -for i = 0 + select(1, GetNumMacros()), 1, -1 do - DeleteMacro(i) -end -``` - -Deleting all character-specific macros: -```lua --- Start at the end, and move backward to first position (121). -for i = 120 + select(2, GetNumMacros()), 121, -1 do - DeleteMacro(i) -end -``` - -**Reference:** -- `GetMacroInfo()` -- `EditMacro()` -- `PickupMacro()` - -**Example Use Case:** -This function can be used in a scenario where a player wants to clear out all their macros, either globally or character-specific, to start fresh or to manage their macro slots more efficiently. - -**Addons Using This Function:** -Many macro management addons, such as "GSE: Gnome Sequencer Enhanced", use this function to delete existing macros before creating new ones to ensure there are no conflicts or to reset the macro list. \ No newline at end of file diff --git a/wiki-information/functions/DescendStop.md b/wiki-information/functions/DescendStop.md deleted file mode 100644 index d14f69de..00000000 --- a/wiki-information/functions/DescendStop.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: DescendStop - -**Content:** -Stops descending while flying or swimming. -`DescendStop()` - -**Example Usage:** -This function can be used in macros or scripts to control character movement, particularly useful in scenarios where precise control over flying or swimming is required. - -**Addons:** -Many addons that enhance character movement or provide custom controls for flying mounts might use this function. For example, addons like "FlightMaster" or "EasyFly" could utilize `DescendStop()` to provide better control over descent during flight. \ No newline at end of file diff --git a/wiki-information/functions/DestroyTotem.md b/wiki-information/functions/DestroyTotem.md deleted file mode 100644 index 4bcf01fe..00000000 --- a/wiki-information/functions/DestroyTotem.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: DestroyTotem - -**Content:** -Destroys a totem/minion. -`DestroyTotem(slot)` - -**Parameters:** -- `slot` - - *number* - The totem type to be destroyed, where Fire is 1, Earth is 2, Water is 3, and Air is 4. - -**Reference:** -- `PLAYER_TOTEM_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/DisableAddOn.md b/wiki-information/functions/DisableAddOn.md deleted file mode 100644 index 6adfdf27..00000000 --- a/wiki-information/functions/DisableAddOn.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: DisableAddOn - -**Content:** -Disables an addon for subsequent sessions. -`DisableAddOn(addon)` - -**Parameters:** -- `addon` - - *number* - addonIndex from 1 to GetNumAddOns() - - *or string* - addonName (as in toc/folder filename) of the addon, case insensitive. -- `character` - - *string?* - playerName of the character (without realm) - - *or boolean?* - enableAll True if the addon should be enabled/disabled for all characters on the realm. - - Defaults to the current character. This param is currently bugged when attempting to use it (Issue #156). - -**Description:** -Takes effect only after reloading the UI. -Attempting to disable secure addons with the GuardedAddOn TOC metadata field will result in a "Cannot disable a guarded AddOn" error. - -**Usage:** -Enables the addon at index 1 for the current character. -```lua -function PrintAddonInfo(idx) - local name = GetAddOnInfo(idx) - local enabledState = GetAddOnEnableState(nil, idx) - print(name, enabledState) -end - -PrintAddonInfo(1) -- "HelloWorld", 0 -EnableAddOn(1) -PrintAddonInfo(1) -- "HelloWorld", 2 -``` - -This should enable an addon for all characters, provided it isn't bugged. -```lua -EnableAddOn("HelloWorld", true) -``` - -Blizzard addons can be only accessed by name instead of index. -```lua -DisableAddOn("Blizzard_CombatLog") -``` \ No newline at end of file diff --git a/wiki-information/functions/DismissCompanion.md b/wiki-information/functions/DismissCompanion.md deleted file mode 100644 index 8c566eaf..00000000 --- a/wiki-information/functions/DismissCompanion.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: DismissCompanion - -**Content:** -Dismisses the current companion. -`DismissCompanion(type)` - -**Parameters:** -- `type` - - *string* - type of companion to dismiss, either "MOUNT" or "CRITTER". \ No newline at end of file diff --git a/wiki-information/functions/Dismount.md b/wiki-information/functions/Dismount.md deleted file mode 100644 index 64884fb2..00000000 --- a/wiki-information/functions/Dismount.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: Dismount - -**Content:** -Dismounts the character. -`Dismount()` - -**Example Usage:** -```lua --- This will dismount the player if they are currently mounted -Dismount() -``` - -**Description:** -The `Dismount` function is used to dismount the player's character if they are currently mounted. This can be useful in various scenarios, such as when a player needs to interact with an object or NPC that requires them to be on foot. - -**Usage in Addons:** -Many addons that manage mounts or provide enhanced mount functionality may use the `Dismount` function. For example: -- **Mount addons** like "MountManager" or "GupPet" might use this function to automatically dismount the player when they need to perform certain actions that cannot be done while mounted. \ No newline at end of file diff --git a/wiki-information/functions/DisplayChannelOwner.md b/wiki-information/functions/DisplayChannelOwner.md deleted file mode 100644 index 13ae2a2b..00000000 --- a/wiki-information/functions/DisplayChannelOwner.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: DisplayChannelOwner - -**Content:** -Prints the name of the owner of the specified channel. -`DisplayChannelOwner(channelName)` - -**Parameters:** -- `channelName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/DoReadyCheck.md b/wiki-information/functions/DoReadyCheck.md deleted file mode 100644 index 553f022f..00000000 --- a/wiki-information/functions/DoReadyCheck.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: DoReadyCheck - -**Content:** -Initiates a ready check. -`DoReadyCheck()` - -**Description:** -This function initiates a raid ready check and will cause all raid members to receive a READY_CHECK event. Processing of the ready check results appears to be either server-side or internal to the client and does not seem to be directly available to the scripting system. - -Since there's no event that emits when everyone is ready, you'll have to use `CHAT_MSG_SYSTEM` events and check if the message contains the string "Everyone is Ready", which is server-sided emitted to the player when everyone is ready in a party. - -You can accomplish this by registering the event: -```lua -local frame = CreateFrame("Frame") -- Create the frame -frame:RegisterEvent("CHAT_MSG_SYSTEM") -- Register the event -frame:SetScript("OnEvent", function(self, event, msg) -- When the event fires do: - if strfind(msg, "Everyone is Ready") then -- Check if the System Message contains the string "Everyone is Ready". - -- Insert code for when all players are ready! - end -end) -``` - -**Example Usage:** -This function is commonly used in raid management addons to ensure all members are ready before starting an encounter. For instance, the popular addon "Deadly Boss Mods" (DBM) uses ready checks to confirm that all raid members are prepared for a boss fight. \ No newline at end of file diff --git a/wiki-information/functions/DoTradeSkill.md b/wiki-information/functions/DoTradeSkill.md deleted file mode 100644 index 8213aa10..00000000 --- a/wiki-information/functions/DoTradeSkill.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: DoTradeSkill - -**Content:** -Performs the tradeskill a specified number of times. -`DoTradeSkill(index, repeat)` - -**Parameters:** -- `index` - - *number* - The index of the tradeskill recipe. -- `repeat` - - *number* - The number of times to repeat the creation of the specified recipe. - -**Example Usage:** -```lua --- Example: Crafting 5 items of the first recipe in the tradeskill window -DoTradeSkill(1, 5) -``` - -**Description:** -The `DoTradeSkill` function is used to automate the crafting process in World of Warcraft. By specifying the index of the tradeskill recipe and the number of times to repeat the action, players can efficiently craft multiple items without manual intervention. - -**Usage in Addons:** -Many large addons, such as TradeSkillMaster (TSM), use `DoTradeSkill` to automate crafting processes. TSM, for example, allows players to queue up multiple items to be crafted and then uses this function to process the queue, making it easier to manage large-scale crafting operations. \ No newline at end of file diff --git a/wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md b/wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md deleted file mode 100644 index e2ef573b..00000000 --- a/wiki-information/functions/DoesCurrentLocaleSellExpansionLevels.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: DoesCurrentLocaleSellExpansionLevels - -**Content:** -Needs summary. -`regionSellsExpansions = DoesCurrentLocaleSellExpansionLevels()` - -**Returns:** -- `regionSellsExpansions` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/DoesSpellExist.md b/wiki-information/functions/DoesSpellExist.md deleted file mode 100644 index c0c1e01d..00000000 --- a/wiki-information/functions/DoesSpellExist.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: DoesSpellExist - -**Content:** -This function returns true if the player character knows the spell. -`spellExists = DoesSpellExist(spellName)` - -**Parameters:** -- `spellName` - - *string* - -**Returns:** -- `spellExists` - - *boolean* - -**Reference:** -C_Spell.DoesSpellExist \ No newline at end of file diff --git a/wiki-information/functions/DropItemOnUnit.md b/wiki-information/functions/DropItemOnUnit.md deleted file mode 100644 index 47020c68..00000000 --- a/wiki-information/functions/DropItemOnUnit.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: DropItemOnUnit - -**Content:** -Drops an item from the cursor onto a unit, i.e. to initiate a trade. -`DropItemOnUnit(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - Unit to which you want to give the item on the cursor. - -**Usage:** -```lua -if (CursorHasItem()) then - DropItemOnUnit("pet"); -end; -``` - -**Miscellaneous:** -**Result:** -Item is dropped from the cursor and given to the player's pet. \ No newline at end of file diff --git a/wiki-information/functions/EditMacro.md b/wiki-information/functions/EditMacro.md deleted file mode 100644 index 866eb957..00000000 --- a/wiki-information/functions/EditMacro.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: EditMacro - -**Content:** -Modifies an existing macro. -`macroID = EditMacro(macroInfo, name)` - -**Parameters:** -- `macroInfo` - - *number|string* - The index or name of the macro to be edited. Index ranges from 1 to 120 for account-wide macros and 121 to 138 for character-specific. -- `name` - - *string* - The name to assign to the macro. The current UI imposes a 16-character limit. The existing name remains unchanged if this argument is nil. -- `icon` - - *number|string : FileID* - The path to the icon texture to assign to the macro. The existing icon remains unchanged if this argument is nil. -- `body` - - *string?* - The macro commands to be executed. If this string is longer than 255 characters, only the first 255 will be saved. - -**Returns:** -- `macroID` - - *number* - The new index of the macro, as displayed in the "Create Macros" UI. Same as argument "index" unless the macro name is changed, as they are sorted alphabetically. - -**Description:** -If this function is called from within the macro that is edited, the rest of the macro (from the final character's position of the `/run` command onward) will run the new version. - -**Usage:** -```lua -local macroID = EditMacro(1, "GoHome", 134414, "/use Hearthstone") -``` - -**Example Use Case:** -This function can be used to dynamically update a macro based on certain conditions or events in the game. For instance, an addon could use `EditMacro` to change the behavior of a macro depending on the player's current location or status. - -**Addon Usage:** -Many large addons, such as GSE (Gnome Sequencer Enhanced), use `EditMacro` to manage and update macros for users. GSE allows players to create complex sequences of abilities and spells, and it uses `EditMacro` to update these sequences dynamically based on user input or game events. \ No newline at end of file diff --git a/wiki-information/functions/EjectPassengerFromSeat.md b/wiki-information/functions/EjectPassengerFromSeat.md deleted file mode 100644 index fd35d0f4..00000000 --- a/wiki-information/functions/EjectPassengerFromSeat.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: EjectPassengerFromSeat - -**Content:** -Needs summary. -`EjectPassengerFromSeat(virtualSeatIndex)` - -**Parameters:** -- `virtualSeatIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/EnableAddOn.md b/wiki-information/functions/EnableAddOn.md deleted file mode 100644 index 71679ef3..00000000 --- a/wiki-information/functions/EnableAddOn.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: EnableAddOn - -**Content:** -Enables an addon for subsequent sessions. -`EnableAddOn(addon)` - -**Parameters:** -- `addon` - - *number* - addonIndex from 1 to `GetNumAddOns()` - - *or string* - addonName (as in toc/folder filename) of the addon, case insensitive. -- `character` - - *string?* - playerName of the character (without realm) - - *or boolean?* - enableAll True if the addon should be enabled/disabled for all characters on the realm. - - Defaults to the current character. This param is currently bugged when attempting to use it (Issue #156). - -**Description:** -Takes effect only after reloading the UI. - -**Usage:** -Enables the addon at index 1 for the current character. -```lua -function PrintAddonInfo(idx) - local name = GetAddOnInfo(idx) - local enabledState = GetAddOnEnableState(nil, idx) - print(name, enabledState) -end - -PrintAddonInfo(1) -- "HelloWorld", 0 -EnableAddOn(1) -PrintAddonInfo(1) -- "HelloWorld", 2 -``` - -This should enable an addon for all characters, provided it isn't bugged. -```lua -EnableAddOn("HelloWorld", true) -``` - -Blizzard addons can be only accessed by name instead of index. -```lua -DisableAddOn("Blizzard_CombatLog") -``` \ No newline at end of file diff --git a/wiki-information/functions/EnumerateFrames.md b/wiki-information/functions/EnumerateFrames.md deleted file mode 100644 index 404b3d87..00000000 --- a/wiki-information/functions/EnumerateFrames.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: EnumerateFrames - -**Content:** -Returns the frame which follows the current frame. -`nextFrame = EnumerateFrames()` - -**Parameters:** -- `currentFrame` - - *Frame* - The current frame. If omitted, returns the first frame. - -**Returns:** -- `nextFrame` - - *Frame* - The frame following `currentFrame`. Returns `nil` if there are no more frames. - -**Usage:** -The following snippet prints the names of all visible frames under the mouse cursor. -```lua -local f = EnumerateFrames() -while f do - if f:IsVisible() and f:IsMouseOver() then - print(f:GetDebugName()) - end - f = EnumerateFrames(f) -end -``` - -**Description:** -This API enumerates every single non-forbidden frame whether named, unnamed, or anonymous script handlers. This includes all descendants of other frames. -- If you're using this to search for a frame, make sure you return or break out of the while loop early so you don't continue looping after you get what you need. Not only will you save CPU time, you will also have access to the frame sooner and are less likely to cause lockups. -- If you know the name of the frame you're looking for, don't use this function, just use the frame's name directly or get it from the `_G` table. -- If you're looking for frame(s) that have specific events registered, don't use this function, just use `GetFramesRegisteredForEvent`. -- Don't make new frames inside the while loop. -- The order of iteration follows the order that the frames were created in. \ No newline at end of file diff --git a/wiki-information/functions/EnumerateServerChannels.md b/wiki-information/functions/EnumerateServerChannels.md deleted file mode 100644 index c57d6a4e..00000000 --- a/wiki-information/functions/EnumerateServerChannels.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: EnumerateServerChannels - -**Content:** -Returns all available server channels (zone dependent). -`channel1, channel2, ... = EnumerateServerChannels()` - -**Returns:** -- `channel1, channel2, ...` - - *strings* containing all available server channels in this zone \ No newline at end of file diff --git a/wiki-information/functions/EquipCursorItem.md b/wiki-information/functions/EquipCursorItem.md deleted file mode 100644 index ff1d1497..00000000 --- a/wiki-information/functions/EquipCursorItem.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: EquipCursorItem - -**Content:** -Equips the currently picked up item to a specific inventory slot. -`EquipCursorItem(slot)` - -**Parameters:** -- `slot` - - *number* - The InventorySlotId to place the item into. - -**Usage:** -```lua -EquipCursorItem(GetInventorySlotInfo("HEADSLOT")); -EquipCursorItem(GetInventorySlotInfo("HEADSLOT")); -``` - -**Miscellaneous:** -**Result:** -Attempts to equip the currently picked up item to the head slot. \ No newline at end of file diff --git a/wiki-information/functions/EquipItemByName.md b/wiki-information/functions/EquipItemByName.md deleted file mode 100644 index c1067936..00000000 --- a/wiki-information/functions/EquipItemByName.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: EquipItemByName - -**Content:** -Equips an item, optionally into a specified slot. -`EquipItemByName(itemId or itemName or itemLink)` - -**Parameters:** -- `(itemId or "itemName" or "itemLink")` - - `itemId` - - *number* - The numeric ID of the item. i.e., 12345 - - `itemName` - - *string* - The name of the item, i.e., "Worn Dagger". Partial names are valid inputs as well, i.e., "Worn". If several items with the same piece of name exist, the first one found will be equipped. - - `itemLink` - - *string* - The itemLink, when Shift-Clicking items. - - `slot` - - *number?* - The inventory slot to put the item in, obtained via `GetInventorySlotInfo()`. - -**Reference:** -- Blue post confirming 3.3.0 change. \ No newline at end of file diff --git a/wiki-information/functions/EquipPendingItem.md b/wiki-information/functions/EquipPendingItem.md deleted file mode 100644 index f3f3f2aa..00000000 --- a/wiki-information/functions/EquipPendingItem.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: EquipPendingItem - -**Content:** -Equips the currently pending Bind-on-Equip or Bind-on-Pickup item from the specified inventory slot. -`EquipPendingItem(invSlot)` - -**Parameters:** -- `invSlot` - - *number* : InventorySlotId - The slot ID of the item being equipped - -**Description:** -When the player attempts to use a Bind-on-Equip or Bind-on-Pickup item for the first time, the game triggers a confirmation dialog. This method appears to be an internal method used by that dialog which equips the item which activated the dialog if accepted. \ No newline at end of file diff --git a/wiki-information/functions/ExpandCurrencyList.md b/wiki-information/functions/ExpandCurrencyList.md deleted file mode 100644 index dc520f0d..00000000 --- a/wiki-information/functions/ExpandCurrencyList.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: ExpandCurrencyList - -**Content:** -Alters the expanded state of a currency list header. -`ExpandCurrencyList(id, expanded)` - -**Parameters:** -- `id` - - *Number* - Index of the header in the currency list to expand/collapse. -- `expanded` - - *Number* - 0 to set to collapsed state; 1 to set to expanded state. - -**Notes and Caveats:** -This function affects the `isExpanded` return value of the `GetCurrencyListInfo` API function, but has no immediate impact on the currency UI (which caches the expanded state when it is shown). -Currencies under collapsed headers are still available to `GetCurrencyListInfo`, so this is a purely visual switch. \ No newline at end of file diff --git a/wiki-information/functions/ExpandFactionHeader.md b/wiki-information/functions/ExpandFactionHeader.md deleted file mode 100644 index 53eaa408..00000000 --- a/wiki-information/functions/ExpandFactionHeader.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: ExpandFactionHeader - -**Content:** -Expand a faction header row. -`ExpandFactionHeader(rowIndex)` - -**Parameters:** -- `rowIndex` - - *number* - The row index of the header to expand (Specifying a non-header row can have unpredictable results). The `UPDATE_FACTION` event is fired after the change since faction indexes will have been shifted around. - -**Reference:** -- `CollapseFactionHeader` - -**Example Usage:** -```lua --- Example of expanding a faction header -local factionIndex = 1 -- Assuming the first faction is a header -ExpandFactionHeader(factionIndex) -``` - -**Additional Information:** -This function is often used in addons that manage or display faction reputation information. For example, an addon like "ReputationBars" might use this function to ensure all faction headers are expanded before displaying detailed reputation bars for each faction. \ No newline at end of file diff --git a/wiki-information/functions/ExpandQuestHeader.md b/wiki-information/functions/ExpandQuestHeader.md deleted file mode 100644 index 6b53f418..00000000 --- a/wiki-information/functions/ExpandQuestHeader.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: ExpandQuestHeader - -**Content:** -Expands/collapses a quest log header. -`ExpandQuestHeader(index)` -`CollapseQuestHeader(index)` - -**Parameters:** -- `index` - - *number* - Position in the quest log from 1 at the top, including collapsed and invisible content. -- `isAuto` - - *boolean* - Used when resetting the quest log to a default state. - -**Description:** -Applies to all headers when the index does not point to a header, including out-of-range values like 0. -Fires `QUEST_LOG_UPDATE`. Toggle `QuestMapFrame.ignoreQuestLogUpdate` to suppress the normal event handler. - -**Usage:** -Expand all quest headers: -```lua -ExpandQuestHeader(0) -``` -Collapse the first quest header (always at position 1) while suppressing the normal event handler: -```lua -QuestMapFrame.ignoreQuestLogUpdate = true -CollapseQuestHeader(1) -QuestMapFrame.ignoreQuestLogUpdate = nil -``` - -**Reference:** -`QuestMapFrame_ResetFilters()` - FrameXML function to restore the default expanded/collapsed state. \ No newline at end of file diff --git a/wiki-information/functions/ExpandSkillHeader.md b/wiki-information/functions/ExpandSkillHeader.md deleted file mode 100644 index a96f4d3e..00000000 --- a/wiki-information/functions/ExpandSkillHeader.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: ExpandSkillHeader - -**Content:** -Expands a header in the skills window. -`ExpandSkillHeader(index)` - -**Parameters:** -- `index` - - *number* - The index of a line in the skills window. Index 0 ("All") will expand all headers. - -**Reference:** -- `GetSkillLineInfo()` - -**Example Usage:** -```lua --- Expanding all skill headers -ExpandSkillHeader(0) - --- Expanding a specific skill header by index -local skillIndex = 3 -ExpandSkillHeader(skillIndex) -``` - -**Common Addon Usage:** -Many addons that manage or display profession and skill information, such as TradeSkillMaster or Skillet, may use this function to ensure all skill headers are expanded before processing or displaying skill data. \ No newline at end of file diff --git a/wiki-information/functions/ExpandTradeSkillSubClass.md b/wiki-information/functions/ExpandTradeSkillSubClass.md deleted file mode 100644 index 26a7e52a..00000000 --- a/wiki-information/functions/ExpandTradeSkillSubClass.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: ExpandTradeSkillSubClass - -**Content:** -Expands a header within a tradeskill window. -`ExpandTradeSkillSubClass(index)` - -**Parameters:** -- `index` - - *number* - index within the tradeskill window - -**Reference:** -It is unknown whether an event triggers. - -**Usage:** -```lua -_, skillType, _, isExpanded, _, _ = GetTradeSkillInfo(skillIndex) -for index = GetNumTradeSkills(), 1, -1 do - if skillType == "header" then - ExpandTradeSkillSubClass(index) - end -end -``` - -**Result:** -All your currently-listed subclasses will be expanded. Subclasses that are folded within another will remain at their former state, collapsed or expanded. - -**Description:** -No error is generated when already isExpanded. -An error is generated when the skillType ~= "header": Bad skill line in ExpandTradeSkillSubClass. \ No newline at end of file diff --git a/wiki-information/functions/ExpandTrainerSkillLine.md b/wiki-information/functions/ExpandTrainerSkillLine.md deleted file mode 100644 index ee1fd0a0..00000000 --- a/wiki-information/functions/ExpandTrainerSkillLine.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: ExpandTrainerSkillLine - -**Content:** -Expands a header in the trainer window, showing all spells below it. -`ExpandTrainerSkillLine(index)` - -**Parameters:** -- `index` - - *number* - The index of a line in the trainer window (if the supplied index is not a header, an error is produced). - - Index 0 ("All") will expand all headers. - - Note that indices are affected by the trainer filter, see `GetTrainerServiceTypeFilter()` and `SetTrainerServiceTypeFilter()` - -**Reference:** -- `GetTrainerServiceInfo()` - -**Example Usage:** -```lua --- Expanding all headers in the trainer window -ExpandTrainerSkillLine(0) - --- Expanding a specific header by index -ExpandTrainerSkillLine(2) -``` - -**Additional Information:** -This function is useful in addons that manage or enhance the trainer window interface, such as those that provide additional filtering or sorting options for available skills. \ No newline at end of file diff --git a/wiki-information/functions/FactionToggleAtWar.md b/wiki-information/functions/FactionToggleAtWar.md deleted file mode 100644 index 939019b3..00000000 --- a/wiki-information/functions/FactionToggleAtWar.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: FactionToggleAtWar - -**Content:** -Toggles the At War status for a faction. -`FactionToggleAtWar(rowIndex)` - -**Parameters:** -- `rowIndex` - - *number* - The row index of the faction to toggle the At War status for. The row must have a true `canToggleAtWar` value (From `GetFactionInfo`). - -**Description:** -The `UPDATE_FACTION` event will be fired after the change. \ No newline at end of file diff --git a/wiki-information/functions/FillLocalizedClassList.md b/wiki-information/functions/FillLocalizedClassList.md deleted file mode 100644 index a6eefee7..00000000 --- a/wiki-information/functions/FillLocalizedClassList.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: FillLocalizedClassList - -**Content:** -Fills a table with localized male or female class names. -`t = FillLocalizedClassList(tbl, isFemale)` - -**Parameters:** -- `classTable` - - *table* - The table you want to be filled with the data. -- `isFemale` - - *boolean?* - If the table should be filled with female class names. - -**Returns:** -- `classTable` - - *table* - The same table argument you passed. - -**Usage:** -Prints all female class names. -```lua -local t = {} -FillLocalizedClassList(t, true) -for classFile, name in pairs(t) do - print(classFile, name) -end -``` - -FrameXML already populates the `LOCALIZED_CLASS_NAMES_MALE` and `LOCALIZED_CLASS_NAMES_FEMALE` globals. -```lua -/dump LOCALIZED_CLASS_NAMES_MALE, LOCALIZED_CLASS_NAMES_FEMALE --- on frFR locale --- Male class names -= { - DEATHKNIGHT = "Chevalier de la mort", - DEMONHUNTER = "Chasseur de démons", - DRUID = "Druide", - EVOKER = "Évocateur", - HUNTER = "Chasseur", - MAGE = "Mage", - MONK = "Moine", - PALADIN = "Paladin", - PRIEST = "Prêtre", - ROGUE = "Voleur", - SHAMAN = "Chaman", - WARLOCK = "Démoniste", - WARRIOR = "Guerrier", -}, --- Female class names -= { - DEATHKNIGHT = "Chevalier de la mort", - DEMONHUNTER = "Chasseuse de démons", - DRUID = "Druidesse", - EVOKER = "Évocatrice", - HUNTER = "Chasseresse", - MAGE = "Mage", - MONK = "Moniale", - PALADIN = "Paladin", - PRIEST = "Prêtresse", - ROGUE = "Voleuse", - SHAMAN = "Chamane", - WARLOCK = "Démoniste", - WARRIOR = "Guerrière", -} -``` \ No newline at end of file diff --git a/wiki-information/functions/FindBaseSpellByID.md b/wiki-information/functions/FindBaseSpellByID.md deleted file mode 100644 index fba95701..00000000 --- a/wiki-information/functions/FindBaseSpellByID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: FindBaseSpellByID - -**Content:** -Needs summary. -`baseSpellID = FindBaseSpellByID(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `baseSpellID` - - *number* - -**Reference:** -- `FindSpellOverrideByID` \ No newline at end of file diff --git a/wiki-information/functions/FindSpellOverrideByID.md b/wiki-information/functions/FindSpellOverrideByID.md deleted file mode 100644 index 44cf3a4f..00000000 --- a/wiki-information/functions/FindSpellOverrideByID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: FindSpellOverrideByID - -**Content:** -Needs summary. -`overrideSpellID = FindSpellOverrideByID(spellID)` - -**Parameters:** -- `spellID` - - *number* - -**Returns:** -- `overrideSpellID` - - *number* - -**Reference:** -- `FindBaseSpellByID` \ No newline at end of file diff --git a/wiki-information/functions/FlashClientIcon.md b/wiki-information/functions/FlashClientIcon.md deleted file mode 100644 index 45260466..00000000 --- a/wiki-information/functions/FlashClientIcon.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: FlashClientIcon - -**Content:** -Flashes the game client icon in the Operating System. -`FlashClientIcon()` - -**Usage:** -Flashes the client icon after 5 seconds. -```lua -/run C_Timer.After(5, FlashClientIcon) -``` -Prevents flashing the client icon by NOP'ing it. -```lua -FlashClientIcon = function() end -``` \ No newline at end of file diff --git a/wiki-information/functions/FlipCameraYaw.md b/wiki-information/functions/FlipCameraYaw.md deleted file mode 100644 index 90f127a8..00000000 --- a/wiki-information/functions/FlipCameraYaw.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: FlipCameraYaw - -**Content:** -Rotates the camera around the Z-axis. -`FlipCameraYaw(angle)` - -**Parameters:** -- `angle` - - *number* - The angle in degrees to rotate the camera. - -**Description:** -Rotates the camera about the Z-axis by the angle amount specified in degrees. \ No newline at end of file diff --git a/wiki-information/functions/FocusUnit.md b/wiki-information/functions/FocusUnit.md deleted file mode 100644 index 54166fb7..00000000 --- a/wiki-information/functions/FocusUnit.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: FocusUnit - -**Content:** -Sets the focus target. -`FocusUnit()` - -**Parameters:** -- `name` - - *string?* : UnitId - The unit to focus. \ No newline at end of file diff --git a/wiki-information/functions/FollowUnit.md b/wiki-information/functions/FollowUnit.md deleted file mode 100644 index a8259d01..00000000 --- a/wiki-information/functions/FollowUnit.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: FollowUnit - -**Content:** -Follows a friendly player unit. -`FollowUnit(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to follow. - -**Description:** -You can stop follow by following the player itself: `FollowUnit("player")`. This can have side effects if the character is in a vehicle. -It is not possible to stop following someone from a script. The player needs to take action (move, jump, sit, whatever). See the Discussion page. -For historical reference, see also `FollowByName()`, which has been removed from the API. \ No newline at end of file diff --git a/wiki-information/functions/ForceGossip.md b/wiki-information/functions/ForceGossip.md deleted file mode 100644 index 0850effd..00000000 --- a/wiki-information/functions/ForceGossip.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ForceGossip - -**Content:** -Returns whether the gossip text must be displayed. -`forced = ForceGossip()` - -**Returns:** -- `forced` - - *boolean* - 1 if the client should display the gossip text for this NPC, nil if it is okay to skip directly to the only interaction option available. \ No newline at end of file diff --git a/wiki-information/functions/ForceQuit.md b/wiki-information/functions/ForceQuit.md deleted file mode 100644 index 23d09746..00000000 --- a/wiki-information/functions/ForceQuit.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: ForceQuit - -**Content:** -Instantly quits the game, ignoring the 20 seconds timer. -`ForceQuit()` - -**Description:** -Your character will remain present in Azeroth (and attackable by NPCs and other players) until the realm server notices that your WoW client is not connected anymore. - -**Reference:** -`Quit` \ No newline at end of file diff --git a/wiki-information/functions/FrameXML_Debug.md b/wiki-information/functions/FrameXML_Debug.md deleted file mode 100644 index 812fa640..00000000 --- a/wiki-information/functions/FrameXML_Debug.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: FrameXML_Debug - -**Content:** -Queries or sets the FrameXML debug logging flag. -`enabled = FrameXML_Debug()` - -**Parameters:** -- `enabled` - - *number?* - 0 to disable debug logging, or 1 to enable it. If not specified, the logging flag will not be modified. - -**Returns:** -- `enabled` - - *number* - The applied logging flag value. - -**Description:** -When FrameXML debugging is enabled, extensive information about the load process is written to `World of Warcraft/.../Logs/FrameXML.log` and `GlueXML.log`. This information includes addon and file load order, as well as the names of all created frames and templates. \ No newline at end of file diff --git a/wiki-information/functions/GMRequestPlayerInfo.md b/wiki-information/functions/GMRequestPlayerInfo.md deleted file mode 100644 index 224c75b4..00000000 --- a/wiki-information/functions/GMRequestPlayerInfo.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GMRequestPlayerInfo - -**Content:** -`GMRequestPlayerInfo()` - -**Parameters:** -- Nothing - -**Returns:** -- Nothing - -**Description:** -Always yields an 'Access Denied' error. \ No newline at end of file diff --git a/wiki-information/functions/GMSubmitBug.md b/wiki-information/functions/GMSubmitBug.md deleted file mode 100644 index 9dd9c062..00000000 --- a/wiki-information/functions/GMSubmitBug.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: C_UserFeedback.SubmitBug - -**Content:** -Replaces `GMSubmitBug`. -`success = C_UserFeedback.SubmitBug(bugInfo)` - -**Parameters:** -- `bugInfo` - - *string* -- `suppressNotification` - - *boolean?* = false - -**Returns:** -- `success` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GMSubmitSuggestion.md b/wiki-information/functions/GMSubmitSuggestion.md deleted file mode 100644 index a4ddd4ba..00000000 --- a/wiki-information/functions/GMSubmitSuggestion.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_UserFeedback.SubmitSuggestion - -**Content:** -Replaces `GMSubmitSuggestion`. -`success = C_UserFeedback.SubmitSuggestion(suggestion)` - -**Parameters:** -- `suggestion` - - *string* - -**Returns:** -- `success` - - *boolean* - -**Example Usage:** -This function can be used to submit a suggestion to the game's feedback system. For instance, if a player wants to suggest a new feature or report a minor issue that doesn't require immediate attention, they can use this function to send their feedback directly to the developers. - -**Addons:** -While not commonly used in large addons, this function can be found in smaller utility addons that provide in-game feedback options for players. These addons might include a UI element where players can type their suggestions and submit them without leaving the game. \ No newline at end of file diff --git a/wiki-information/functions/GetAbandonQuestItems.md b/wiki-information/functions/GetAbandonQuestItems.md deleted file mode 100644 index 5a4bc7e5..00000000 --- a/wiki-information/functions/GetAbandonQuestItems.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_QuestLog.GetAbandonQuestItems - -**Content:** -Needs summary. -`itemIDs = C_QuestLog.GetAbandonQuestItems()` - -**Returns:** -- `itemIDs` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAbandonQuestName.md b/wiki-information/functions/GetAbandonQuestName.md deleted file mode 100644 index 7a8cc0ef..00000000 --- a/wiki-information/functions/GetAbandonQuestName.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetAbandonQuestName - -**Content:** -Returns the name of a quest that will be abandoned if `AbandonQuest` is called. -`questName = GetAbandonQuestName()` - -**Returns:** -- `questName` - - *string* - Name of the quest that will be abandoned. - -**Description:** -The FrameXML-provided quest log calls `SetAbandonQuest` whenever a quest entry is selected, so this function will usually return the name of the currently selected quest. - -**Reference:** -- `SetAbandonQuest` -- `AbandonQuest` \ No newline at end of file diff --git a/wiki-information/functions/GetAccountExpansionLevel.md b/wiki-information/functions/GetAccountExpansionLevel.md deleted file mode 100644 index 66625f3f..00000000 --- a/wiki-information/functions/GetAccountExpansionLevel.md +++ /dev/null @@ -1,55 +0,0 @@ -## Title: GetAccountExpansionLevel - -**Content:** -Returns the expansion level the account has been flagged for. -`expansionLevel = GetAccountExpansionLevel()` - -**Returns:** -- `expansionLevel` - - *number* - The expansion the player's game license has been flagged for. - - `NUM_LE_EXPANSION_LEVELS` - - `Value` - - `Enum` - - `Description` - - `LE_EXPANSION_LEVEL_CURRENT` - - 0 - - `LE_EXPANSION_CLASSIC` - - Vanilla / Classic Era - - 1 - - `LE_EXPANSION_BURNING_CRUSADE` - - The Burning Crusade - - 2 - - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` - - Wrath of the Lich King - - 3 - - `LE_EXPANSION_CATACLYSM` - - Cataclysm - - 4 - - `LE_EXPANSION_MISTS_OF_PANDARIA` - - Mists of Pandaria - - 5 - - `LE_EXPANSION_WARLORDS_OF_DRAENOR` - - Warlords of Draenor - - 6 - - `LE_EXPANSION_LEGION` - - Legion - - 7 - - `LE_EXPANSION_BATTLE_FOR_AZEROTH` - - Battle for Azeroth - - 8 - - `LE_EXPANSION_SHADOWLANDS` - - Shadowlands - - 9 - - `LE_EXPANSION_DRAGONFLIGHT` - - Dragonflight - - 10 - - `LE_EXPANSION_11_0` - -**Usage:** -Before and after pre-ordering the Shadowlands expansion. Requires a client restart to update, if still in-game. -```lua -/dump GetAccountExpansionLevel() -- 7 -> 8 -``` - -**Reference:** -`GetExpansionLevel()` - Returns the newest expansion actually available to the player. \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementCategory.md b/wiki-information/functions/GetAchievementCategory.md deleted file mode 100644 index fb48cee3..00000000 --- a/wiki-information/functions/GetAchievementCategory.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetAchievementCategory - -**Content:** -Returns the category number the requested achievement belongs to. -`categoryID = GetAchievementCategory(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - ID of the achievement to retrieve information for. - -**Returns:** -- `categoryID` - - *number* - ID of the achievement's category. - -**Reference:** -- `GetAchievementComparisonInfo` -- `SetAchievementComparisonUnit` -- `GetNumComparisonCompletedAchievements` - -**Example Usage:** -This function can be used to categorize achievements in an addon that tracks player progress. For instance, an addon like "Overachiever" might use this function to organize achievements into their respective categories for easier navigation and display. - -**Addons Using This Function:** -- **Overachiever**: This popular achievement tracking addon uses `GetAchievementCategory` to sort and display achievements by their categories, helping players to focus on specific types of achievements they want to complete. \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementComparisonInfo.md b/wiki-information/functions/GetAchievementComparisonInfo.md deleted file mode 100644 index 0c59941c..00000000 --- a/wiki-information/functions/GetAchievementComparisonInfo.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetAchievementComparisonInfo - -**Content:** -Returns information about the comparison unit's achievements. -`completed, month, day, year = GetAchievementComparisonInfo(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - ID of the achievement to retrieve information for. - -**Returns:** -- `completed` - - *boolean* - Returns true/false depending on whether the unit has completed the achievement or not. -- `month` - - *number* - Month in which the unit has completed the achievement. Returns nil if completed is false. -- `day` - - *number* - Day of the month in which the unit has completed the achievement. Returns nil if completed is false. -- `year` - - *number* - Year (two digits, 21st century is assumed) in which the unit has completed the achievement. Returns nil if completed is false. - -**Description:** -Only accurate after the `SetAchievementComparisonUnit` is called and the `INSPECT_ACHIEVEMENT_READY` event has fired. -Inaccurate after `ClearAchievementComparisonUnit` has been called. - -**Reference:** -- `ClearAchievementComparisonUnit` -- `SetAchievementComparisonUnit` -- `GetNumComparisonCompletedAchievements` \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementCriteriaInfo.md b/wiki-information/functions/GetAchievementCriteriaInfo.md deleted file mode 100644 index a7d8ea6c..00000000 --- a/wiki-information/functions/GetAchievementCriteriaInfo.md +++ /dev/null @@ -1,210 +0,0 @@ -## Title: GetAchievementCriteriaInfo - -**Content:** -Returns info for the specified achievement criteria. -```lua -criteriaString, criteriaType, completed, quantity, reqQuantity, charName, flags, assetID, quantityString, criteriaID, eligible - = GetAchievementCriteriaInfo(achievementID, criteriaIndex) - = GetAchievementCriteriaInfoByID(achievementID, criteriaID) -``` - -**Parameters:** -- **GetAchievementCriteriaInfo:** - - `achievementID` - - *number* - Achievement ID the queried criteria belongs to. - - `criteriaIndex` - - *number* - Index of the criteria to query, ascending from 1 up to `GetAchievementNumCriteria(achievementID)`. - -- **GetAchievementCriteriaInfoByID:** - - `achievementID` - - *number* - - `criteriaID` - - *number* - Unique ID of the criteria to query. - - `countHidden` - - *boolean* - -**Values:** -See `Criteria.db2` - -**Achievement Criteria Info:** -- **Value** -- **Description** -- **Corresponding AssetID** - - `0` - - Monster kill - - Monster ID - - `1` - - Winning PvP objectives in a thorough manner (holding all bases, controlling all flags) - - `5` - - Reaching a player level - - Player level - - `7` - - Weapon skill - - probably a skill ID of some sort - - `8` - - Another achievement - - Achievement ID - - `9` - - Completing quests globally - - `10` - - Completing a daily quest every day - - `11` - - Completing quests in specific areas - - `12` - - Collecting currency - - Currency ID - - `14` - - Completing daily quests - - `16` - - Dying in specific locations - - Location - - `20` - - Defeating a boss encounter - - NPC ID - - `27` - - Completing a quest - - Quest ID - - `28` - - Getting a spell cast on you - - Spell ID - - `29` - - Casting a spell (often crafting) - - Spell ID - - `30` - - PvP objectives (flags, assaulting, defending) - - `31` - - PvP kills in battleground PvP locations - - `32` - - Winning ranked arena matches in specific locations - - (probably a location ID) - - `34` - - Squashling (owning a specific pet?) - - Spell ID - - `35` - - PvP kills while under the influence of something - - `36` - - Acquiring items (soulbound) - - Item ID - - `37` - - Winning arenas - - `38` - - Highest-reached arena team rating - - Team size - - `39` - - Achieving arena team rating - - Team size - - `41` - - Eating or drinking a specific item - - Item ID - - `42` - - Fishing things up - - Item ID - - `43` - - Exploration - - (location ID?) - - `44` - - Reaching a PvP rank (old PvP system) - - Rank - - `45` - - Purchasing 7 bank slots - - `46` - - Exalted rep - - Faction ID - - `47` - - 5 reputations to exalted - - `49` - - Equipping items - - Slot ID (quality is presumably encoded into flags) - - `52` - - Killing specific classes of player - - `53` - - Kill-a-given-race - - (Race ID?) - - `54` - - Using emotes on targets - - (likely the emote ID) - - `55` - - Healing - - `56` - - Being a wrecking ball in Alterac Valley - - `57` - - Having items (tabards and legendaries) - - Item ID - - `59` - - Getting gold from vendors - - `62` - - Getting gold from quest rewards - - `67` - - Looting gold - - `68` - - Reading books - - Object ID - - `70` - - Killing players in world PvP locations - - `72` - - Fishing things from schools or wreckage - - Object ID - - `73` - - Killing Mal'Ganis on Heroic. Why? Who can say. - - `74` - - Earning a title (for guild achievements) - - `75` - - Obtaining mounts - - `96` - - Obtaining battle pets - - NPC ID of the pet - - `109` - - Fishing, either in general or in specific locations - - `110` - - Casting spells on specific target - - Spell ID - - `112` - - Learning cooking recipes - - `113` - - Honorable kills - - `124` - - Spending guild gold on repairs - - `125` - - Reaching a guild level - - `126` - - Crafting items as a guild - - `127` - - Fishing as a guild - - `128` - - Purchasing guild bank tabs - - `129` - - Guild achievement points - - `130` - - Winning rated battlegrounds - - `132` - - Reaching rated battleground rating - - `133` - - Purchasing a guild crest - -**Returns:** -1. `criteriaString` - - *string* - The name of the criteria. -2. `criteriaType` - - *number* - Criteria type; specifies the meaning of the `assetID`. -3. `completed` - - *boolean* - True if you've completed this criteria; false otherwise. -4. `quantity` - - *number* - Quantity requirement imposed by some `criteriaType`. -5. `reqQuantity` - - *number* - The required quantity for the criteria. Used mostly in achievements with progress bars. Usually 0. -6. `charName` - - *string* - The name of the character that completed this achievement. -7. `flags` - - *number* - Some flags. Currently unknown purpose. -8. `assetID` - - *number* - Criteria data whose meaning depends on the type. -9. `quantityString` - - *string* - The string used to display the current quantity. Usually the string form of the `quantity` return. -10. `criteriaID` - - *number* - Unique criteria ID. -11. `eligible` - - *boolean* - True if the criteria is eligible to be completed; false otherwise. Used to determine whether to show the criteria line in the objectives tracker in red or not. -12. `duration` - - *number* -13. `elapsed` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementCriteriaInfoByID.md b/wiki-information/functions/GetAchievementCriteriaInfoByID.md deleted file mode 100644 index a798ee7a..00000000 --- a/wiki-information/functions/GetAchievementCriteriaInfoByID.md +++ /dev/null @@ -1,117 +0,0 @@ -## Title: GetAchievementCriteriaInfo - -**Content:** -Returns info for the specified achievement criteria. -```lua -criteriaString, criteriaType, completed, quantity, reqQuantity, charName, flags, assetID, quantityString, criteriaID, eligible - = GetAchievementCriteriaInfo(achievementID, criteriaIndex) - = GetAchievementCriteriaInfoByID(achievementID, criteriaID) -``` - -**Parameters:** - -*GetAchievementCriteriaInfo:* -- `achievementID` - - *number* - Achievement ID the queried criteria belongs to. -- `criteriaIndex` - - *number* - Index of the criteria to query, ascending from 1 up to `GetAchievementNumCriteria(achievementID)`. - -*GetAchievementCriteriaInfoByID:* -- `achievementID` - - *number* -- `criteriaID` - - *number* - Unique ID of the criteria to query. -- `countHidden` - - *boolean* - -**Achievement Criteria Info:** -- **Value** - **Description** - **Corresponding AssetID** - - `0` - Monster kill - Monster ID - - `1` - Winning PvP objectives in a thorough manner (holding all bases, controlling all flags) - - `5` - Reaching a player level - Player level - - `7` - Weapon skill - probably a skill ID of some sort - - `8` - Another achievement - Achievement ID - - `9` - Completing quests globally - - `10` - Completing a daily quest every day - - `11` - Completing quests in specific areas - - `12` - Collecting currency - Currency ID - - `14` - Completing daily quests - - `16` - Dying in specific locations - Location - - `20` - Defeating a boss encounter - NPC ID - - `27` - Completing a quest - Quest ID - - `28` - Getting a spell cast on you - Spell ID - - `29` - Casting a spell (often crafting) - Spell ID - - `30` - PvP objectives (flags, assaulting, defending) - - `31` - PvP kills in battleground PvP locations - - `32` - Winning ranked arena matches in specific locations - (probably a location ID) - - `34` - Squashling (owning a specific pet?) - Spell ID - - `35` - PvP kills while under the influence of something - - `36` - Acquiring items (soulbound) - Item ID - - `37` - Winning arenas - - `38` - Highest-reached arena team rating - Team size - - `39` - Achieving arena team rating - Team size - - `41` - Eating or drinking a specific item - Item ID - - `42` - Fishing things up - Item ID - - `43` - Exploration - (location ID?) - - `44` - Reaching a PvP rank (old PvP system) - Rank - - `45` - Purchasing 7 bank slots - - `46` - Exalted rep - Faction ID - - `47` - 5 reputations to exalted - - `49` - Equipping items - Slot ID (quality is presumably encoded into flags) - - `52` - Killing specific classes of player - - `53` - Kill-a-given-race - (Race ID?) - - `54` - Using emotes on targets - (likely the emote ID) - - `55` - Healing - - `56` - Being a wrecking ball in Alterac Valley - - `57` - Having items (tabards and legendaries) - Item ID - - `59` - Getting gold from vendors - - `62` - Getting gold from quest rewards - - `67` - Looting gold - - `68` - Reading books - Object ID - - `70` - Killing players in world PvP locations - - `72` - Fishing things from schools or wreckage - Object ID - - `73` - Killing Mal'Ganis on Heroic. Why? Who can say. - - `74` - Earning a title (for guild achievements) - - `75` - Obtaining mounts - - `96` - Obtaining battle pets - NPC ID of the pet - - `109` - Fishing, either in general or in specific locations - - `110` - Casting spells on specific target - Spell ID - - `112` - Learning cooking recipes - - `113` - Honorable kills - - `124` - Spending guild gold on repairs - - `125` - Reaching a guild level - - `126` - Crafting items as a guild - - `127` - Fishing as a guild - - `128` - Purchasing guild bank tabs - - `129` - Guild achievement points - - `130` - Winning rated battlegrounds - - `132` - Reaching rated battleground rating - - `133` - Purchasing a guild crest - -**Returns:** -1. `criteriaString` - - *string* - The name of the criteria. -2. `criteriaType` - - *number* - Criteria type; specifies the meaning of the assetID. -3. `completed` - - *boolean* - True if you've completed this criteria; false otherwise. -4. `quantity` - - *number* - Quantity requirement imposed by some criteriaType. -5. `reqQuantity` - - *number* - The required quantity for the criteria. Used mostly in achievements with progress bars. Usually 0. -6. `charName` - - *string* - The name of the character that completed this achievement. -7. `flags` - - *number* - Some flags. Currently unknown purpose. -8. `assetID` - - *number* - Criteria data whose meaning depends on the type. -9. `quantityString` - - *string* - The string used to display the current quantity. Usually the string form of the quantity return. -10. `criteriaID` - - *number* - Unique criteria ID. -11. `eligible` - - *boolean* - True if the criteria is eligible to be completed; false otherwise. Used to determine whether to show the criteria line in the objectives tracker in red or not. -12. `duration` - - *number* -13. `elapsed` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementLink.md b/wiki-information/functions/GetAchievementLink.md deleted file mode 100644 index 5afab093..00000000 --- a/wiki-information/functions/GetAchievementLink.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetAchievementLink - -**Content:** -Returns an achievement link. -`achievementLink = GetAchievementLink(AchievementID)` - -**Parameters:** -- `achievementID` - - *number* - The ID of the Achievement. - -**Returns:** -- `achievementLink` - - *string* - The achievementLink to this achievement. \ No newline at end of file diff --git a/wiki-information/functions/GetAchievementNumCriteria.md b/wiki-information/functions/GetAchievementNumCriteria.md deleted file mode 100644 index b57bc2c3..00000000 --- a/wiki-information/functions/GetAchievementNumCriteria.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetAchievementNumCriteria - -**Content:** -Returns the number of criteria for an achievement. -`numCriteria = GetAchievementNumCriteria(achievementID)` - -**Parameters:** -- `achievementID` - - Uniquely identifies each achievement - -**Returns:** -- `numCriteria` - - *number* - The number of criteria required for the given Achievement - -**Description:** -Used in conjunction with `GetAchievementCriteriaInfo`. \ No newline at end of file diff --git a/wiki-information/functions/GetActionBarPage.md b/wiki-information/functions/GetActionBarPage.md deleted file mode 100644 index 05ebe4a1..00000000 --- a/wiki-information/functions/GetActionBarPage.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetActionBarPage - -**Content:** -Returns the current action bar page. -`index = GetActionBarPage()` - -**Returns:** -- `index` - - *number* - integer index of the current action bar page, ascending from 1. - -**Description:** -The returned value reflects the player-selected action bar, which might not actually be available if overridden by a vehicle, mind control, temporary shapeshift, or other similar mechanics. -This function is available in the RestrictedEnvironment. -Can be queried using the macro conditional. -CURRENT_ACTIONBAR_PAGE is obsolete. \ No newline at end of file diff --git a/wiki-information/functions/GetActionBarToggles.md b/wiki-information/functions/GetActionBarToggles.md deleted file mode 100644 index 48caa554..00000000 --- a/wiki-information/functions/GetActionBarToggles.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetActionBarToggles - -**Content:** -Returns the enabled states for the extra action bars. -`bottomLeftState, bottomRightState, sideRightState, sideRight2State = GetActionBarToggles()` - -**Returns:** -- `bottomLeftState` - - *Flag* - 1 if the left-hand bottom action bar is shown, nil otherwise. -- `bottomRightState` - - *Flag* - 1 if the right-hand bottom action bar is shown, nil otherwise. -- `sideRightState` - - *Flag* - 1 if the first (outer) right side action bar is shown, nil otherwise. -- `sideRight2State` - - *Flag* - 1 if the second (inner) right side action bar is shown, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetActionCharges.md b/wiki-information/functions/GetActionCharges.md deleted file mode 100644 index 10a8f7ff..00000000 --- a/wiki-information/functions/GetActionCharges.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetActionCharges - -**Content:** -Returns information about the charges of a charge-accumulating player ability. -`currentCharges, maxCharges, cooldownStart, cooldownDuration, chargeModRate = GetActionCharges(slot)` - -**Parameters:** -- `slot` - - *number* - The action slot to retrieve data from. - -**Returns:** -- `currentCharges` - - *number* - The number of charges of the ability currently available. -- `maxCharges` - - *number* - The maximum number of charges the ability may have available. -- `cooldownStart` - - *number* - Time (per GetTime) at which the next charge cooldown began, or 2^32 / 1000 if the spell is not currently recharging. -- `cooldownDuration` - - *number* - Time (in seconds) required to gain a charge. -- `chargeModRate` - - *number* - The rate at which the charge cooldown widget's animation should be updated. - -**Description:** -Abilities like can be used by the player rapidly, and then slowly accumulate charges over time. The `cooldownStart` and `cooldownDuration` return values indicate the cooldown timer for acquiring the next charge (when `currentCharges` is less than `maxCharges`). -If the queried spell does not accumulate charges over time (e.g. or ), this function does not return any values. - -**Reference:** -- `GetSpellCharges()` - Referring to any spell ID or localized spell name. \ No newline at end of file diff --git a/wiki-information/functions/GetActionCooldown.md b/wiki-information/functions/GetActionCooldown.md deleted file mode 100644 index 792d8f77..00000000 --- a/wiki-information/functions/GetActionCooldown.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetActionCooldown - -**Content:** -Returns cooldown info for the specified action slot. -`start, duration, enable, modRate = GetActionCooldown(slot)` - -**Parameters:** -- `slot` - - *number* - The action slot to retrieve data from. - -**Returns:** -- `start` - - *number* - The time at which the current cooldown period began (relative to the result of GetTime), or 0 if the cooldown is not active or not applicable. -- `duration` - - *number* - The duration of the current cooldown period in seconds, or 0 if the cooldown is not active or not applicable. -- `enable` - - *number* - Indicates if cooldown is enabled, is greater than 0 if a cooldown could be active, and 0 if a cooldown cannot be active. This lets you know when a shapeshifting form has ended and the actual countdown has started. -- `modRate` - - *number* - The rate at which the cooldown widget's animation should be updated. - -**Usage:** -```lua -local start, duration, enable, modRate = GetActionCooldown(slot); -if ( start == 0 ) then - -- do stuff when cooldown is not active -else - -- do stuff when cooldown is under effect -end -``` - -**Example Use Case:** -This function is commonly used in addons that manage action bars, such as Bartender4 or Dominos, to display cooldown timers on action buttons. It helps players to know when they can use their abilities again by showing a visual cooldown overlay on the action buttons. \ No newline at end of file diff --git a/wiki-information/functions/GetActionCount.md b/wiki-information/functions/GetActionCount.md deleted file mode 100644 index abee64da..00000000 --- a/wiki-information/functions/GetActionCount.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: GetActionCount - -**Content:** -Returns the available number of uses for an action. -`text = GetActionCount(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - An action slot ID. - -**Returns:** -- `text` - - *number* - How often an item-based action (see details) may be performed; or always zero for other action types. - -**Description:** -Use with `IsConsumableAction()` and `IsStackableAction()` to confirm that 'zero' is due to having zero uses of an item-based action, rather than always returning zero. -In Classic, use with `IsItemAction()` to ignore abilities that require a reagent; or alternatively use with `GetItemCount(itemID)` if the itemID of a reagent is known. -In Retail, use with `GetActionCharges()` for abilities with multiple charges. - -**Usage:** -The following example originates from an older version of FrameXML/ActionButton.lua to display a number on each action button if applicable. -```lua -function ActionButton_UpdateCount (self) - local text = _G; - local action = self.action; - if ( IsConsumableAction(action) or IsStackableAction(action) or (not IsItemAction(action) and GetActionCount(action) > 0) ) then - local count = GetActionCount(action); - if ( count > (self.maxDisplayCount or 9999 ) ) then - text:SetText("*"); - else - text:SetText(count); - end - else - local charges, maxCharges, chargeStart, chargeDuration = GetActionCharges(action); - if (maxCharges > 1) then - text:SetText(charges); - else - text:SetText(""); - end - end -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetActionInfo.md b/wiki-information/functions/GetActionInfo.md deleted file mode 100644 index d56c98ec..00000000 --- a/wiki-information/functions/GetActionInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetActionInfo - -**Content:** -Returns info for an action. -`actionType, id, subType = GetActionInfo(slot)` - -**Parameters:** -- `slot` - - *number* - Action slot to retrieve information about. - -**Returns:** -- `actionType` - - *string* - Type of action button. (e.g. spell, item, macro, companion, equipmentset, flyout) -- `id` - - *Mixed* - Appropriate identifier for the action specified by actionType -- e.g. spell IDs for spells, item IDs for items, equipment set names for equipment sets. -- `subType` - - *Mixed* - Additional identifier for the action specified by actionType -- e.g. whether the companion ID is for a MOUNT or a CRITTER companion. - -**Usage:** -```lua -local actionType, id, subType = GetActionInfo(1); -if (actionType == "companion" and subType == "MOUNT") then - print("Button 1 is a mount:", GetSpellLink(id)) -end -``` - -**Example Use Case:** -This function can be used to determine what type of action is assigned to a specific action bar slot. For instance, if you want to check if a particular slot is assigned to a mount, you can use this function to retrieve the action type and subtype, and then perform actions based on that information. - -**Addons Using This Function:** -Many popular addons like Bartender4 and Dominos use `GetActionInfo` to manage and customize action bars. These addons rely on this function to retrieve and display the correct icons and tooltips for the actions assigned to each slot. \ No newline at end of file diff --git a/wiki-information/functions/GetActionLossOfControlCooldown.md b/wiki-information/functions/GetActionLossOfControlCooldown.md deleted file mode 100644 index 0488dd63..00000000 --- a/wiki-information/functions/GetActionLossOfControlCooldown.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetActionLossOfControlCooldown - -**Content:** -Returns information about a loss-of-control cooldown affecting an action. -`start, duration = GetActionLossOfControlCooldown(slot)` - -**Parameters:** -- `slot` - - *number* - action slot to query information about. - -**Returns:** -- `start` - - *number* - time at which the cooldown began, per GetTime. -- `duration` - - *number* - duration of the cooldown in seconds; 0 if the action is not currently affected by a loss-of-control cooldown. - -**Reference:** -- `Cooldown:SetLossOfControlCooldown` -- `C_LossOfControl.GetEventInfo` -- `LOSS_OF_CONTROL_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetActionText.md b/wiki-information/functions/GetActionText.md deleted file mode 100644 index 0342d6ad..00000000 --- a/wiki-information/functions/GetActionText.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetActionText - -**Content:** -Returns the label text for an action. -`text = GetActionText(actionSlot)` - -**Parameters:** -- `actionSlot` - - *ActionSlot* - The queried slot. - -**Returns:** -- `text` - - *String* - The action's text, if present. Macro actions use their names for their action text. - - *nil* - If the slot has no action text, or is empty. Most standard WoW action icons don't have action text. \ No newline at end of file diff --git a/wiki-information/functions/GetActionTexture.md b/wiki-information/functions/GetActionTexture.md deleted file mode 100644 index 619461e9..00000000 --- a/wiki-information/functions/GetActionTexture.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetActionTexture - -**Content:** -Returns the icon texture for an action. -`texture = GetActionTexture(actionSlot)` - -**Parameters:** -- `actionSlot` - - *ActionSlot* - The queried slot. - -**Returns:** -- `texture` - - *String* - The texture filepath for the action's icon image - - *nil* - if the slot is empty \ No newline at end of file diff --git a/wiki-information/functions/GetActiveTalentGroup.md b/wiki-information/functions/GetActiveTalentGroup.md deleted file mode 100644 index 25418ae1..00000000 --- a/wiki-information/functions/GetActiveTalentGroup.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetActiveTalentGroup - -**Content:** -Returns the index of the current active talent group. -`index = GetActiveTalentGroup(isInspect, isPet);` - -**Parameters:** -- `isInspect` - - *Boolean* - If true returns the information for the inspected unit instead of the player. -- `isPet` - - *Boolean* - If true returns the information for the inspected pet. - -**Returns:** -- `index` - - *Number* - The index of the current active talent group (1 for primary / 2 for secondary). \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnCPUUsage.md b/wiki-information/functions/GetAddOnCPUUsage.md deleted file mode 100644 index b6013b83..00000000 --- a/wiki-information/functions/GetAddOnCPUUsage.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: GetAddOnCPUUsage - -**Content:** -Returns the total time used for an addon. -`time = GetAddOnCPUUsage(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `time` - - *number* - The total time used by the specified AddOn, in milliseconds. - -**Description:** -This function will raise an error if a secure Blizzard addon is queried. -This function returns a cached value calculated by `UpdateAddOnCPUUsage()`. The time is the sum of `GetFunctionCPUUsage(f, false)` for all functions `f` created on behalf of the AddOn. These functions include both functions created directly by the AddOn itself, as well as functions created by external functions that were called by the AddOn. That means even though an external function does not belong to an AddOn, functions created by that external function are attributed to the calling AddOn. - -Notably, the time used does NOT include calls into the WoW API. - -Running this code will show the addon using 300-350ms CPU time: -```lua -e = debugprofilestop() + 500 -while debugprofilestop() < e do end --- we're spending a lot of time simply calling the API! -``` - -But running THIS code will show the addon using much closer to 500ms CPU time: -```lua -e = debugprofilestop() + 500 -while debugprofilestop() < e do - for i = 1, 1000 do end -end -``` - -However, in both cases, `:GetFrameCPUUsage()` on the addon's frame will report 500ms used. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnDependencies.md b/wiki-information/functions/GetAddOnDependencies.md deleted file mode 100644 index f2f39d6e..00000000 --- a/wiki-information/functions/GetAddOnDependencies.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetAddOnDependencies - -**Content:** -Returns the TOC dependencies of an addon. -`dep1, dep2, ... = GetAddOnDependencies(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `dep1, dep2, ...` - - *string* - List of addon names that are a required dependency. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnEnableState.md b/wiki-information/functions/GetAddOnEnableState.md deleted file mode 100644 index 4e0720d4..00000000 --- a/wiki-information/functions/GetAddOnEnableState.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetAddOnEnableState - -**Content:** -Get the enabled state of an addon for a character. -`enabledState = GetAddOnEnableState(character, name)` - -**Parameters:** -- `character` - - *string?* - The name of the character to check against or nil. -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `enabledState` - - *number* - The enabled state of the addon. - - `0` - disabled - - `1` - enabled for some - - `2` - enabled - -**Description:** -This is primarily used by the default UI to set the checkbox state in the AddOnList. A return of 1 is only possible if `character` is nil. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnInfo.md b/wiki-information/functions/GetAddOnInfo.md deleted file mode 100644 index 28780a34..00000000 --- a/wiki-information/functions/GetAddOnInfo.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: GetAddOnInfo - -**Content:** -Get information about an AddOn. -`name, title, notes, loadable, reason, security, newVersion = GetAddOnInfo(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `name` - - *string* - The name of the AddOn (the folder name). -- `title` - - *string* - The title of the AddOn as listed in the .toc file (presumably this is the appropriate localized one). -- `notes` - - *string* - The notes about the AddOn from its .toc file (presumably this is the appropriate localized one). -- `loadable` - - *boolean* - Indicates if the AddOn is loaded or eligible to be loaded, true if it is, false if it is not. -- `reason` - - *string* - The reason why the AddOn cannot be loaded. This is nil if the addon is loadable, otherwise it contains a string token indicating the reason that can be localized by prepending "ADDON_". ("BANNED", "CORRUPT", "DEMAND_LOADED", "DISABLED", "INCOMPATIBLE", "INTERFACE_VERSION", "MISSING") -- `security` - - *string* - Indicates the security status of the AddOn. This is currently "INSECURE" for all user-provided addons, "SECURE_PROTECTED" for guarded Blizzard addons, and "SECURE" for all other Blizzard AddOns. -- `newVersion` - - *boolean* - Not currently used. - -**Description:** -If the function is passed a string, `name` will always be the value passed, so check if `reason` equals "MISSING" to find out if an addon exists. -If the function is passed a number that is out of range, you will get an error message, specifically: ` AddOn index must be in the range of 1 to `. - -**Example Usage:** -```lua -local name, title, notes, loadable, reason, security, newVersion = GetAddOnInfo("MyAddon") -if reason == "MISSING" then - print("Addon does not exist.") -else - print("Addon exists and is loadable: ", loadable) -end -``` - -**AddOns Using This Function:** -Many large addons use `GetAddOnInfo` to check the status of other addons or to manage dependencies. For example: -- **WeakAuras**: Uses it to check if certain addons are present and to manage compatibility. -- **ElvUI**: Uses it to ensure that required modules or plugins are available and loaded correctly. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnMemoryUsage.md b/wiki-information/functions/GetAddOnMemoryUsage.md deleted file mode 100644 index acb336ae..00000000 --- a/wiki-information/functions/GetAddOnMemoryUsage.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetAddOnMemoryUsage - -**Content:** -Returns the memory used for an addon. -`mem = GetAddOnMemoryUsage(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `mem` - - *number* - Memory usage of the addon in kilobytes. - -**Description:** -This function returns a cached value calculated by `UpdateAddOnMemoryUsage()`. This function will raise an error if a secure Blizzard addon is queried. - -**Usage:** -Prints the memory usage for all addons. -```lua -UpdateAddOnMemoryUsage() -for i = 1, GetNumAddOns() do - local name = GetAddOnInfo(i) - print(GetAddOnMemoryUsage(i), name) -end -``` - -**Example Use Case:** -This function can be used by addon developers to monitor and optimize the memory usage of their addons. For instance, developers can periodically check the memory usage to ensure their addon is not consuming excessive resources, which can help in maintaining the performance of the game. - -**Addons Using This Function:** -Many performance monitoring addons, such as "Addon Control Panel" and "Details! Damage Meter," use this function to display memory usage statistics to the user. This helps players identify which addons are using the most memory and manage their addon load accordingly. \ No newline at end of file diff --git a/wiki-information/functions/GetAddOnMetadata.md b/wiki-information/functions/GetAddOnMetadata.md deleted file mode 100644 index 9905ee47..00000000 --- a/wiki-information/functions/GetAddOnMetadata.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetAddOnMetadata - -**Content:** -Returns the TOC metadata of an addon. -`value = GetAddOnMetadata(index, field)` -`GetAddOnMetadata(name, field)` - -**Parameters:** -- `index` - - *index* - The index in the addon list. Note that you cannot query Blizzard addons by index. -- `name` - - *string* - The name of the addon, case insensitive. -- `field` - - *string* - Field name, case insensitive. May be Title, Notes, Author, Version, or anything starting with X- - -**Returns:** -- `value` - - *string?* - The value of the field. \ No newline at end of file diff --git a/wiki-information/functions/GetAllowLowLevelRaid.md b/wiki-information/functions/GetAllowLowLevelRaid.md deleted file mode 100644 index 4e98105c..00000000 --- a/wiki-information/functions/GetAllowLowLevelRaid.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetAllowLowLevelRaid - -**Content:** -Needs summary. -`allowLowLevel = GetAllowLowLevelRaid()` - -**Returns:** -- `allowLowLevel` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GetArenaTeamIndexBySize.md b/wiki-information/functions/GetArenaTeamIndexBySize.md deleted file mode 100644 index 8b85b1b3..00000000 --- a/wiki-information/functions/GetArenaTeamIndexBySize.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetArenaTeamIndexBySize - -**Content:** -Returns the index of an arena team for the specified team size. -`index = GetArenaTeamIndexBySize(size)` - -**Parameters:** -- `size` - - *number* - team size (number of people), i.e. 2, 3, or 5. - -**Returns:** -- `index` - - *number* - arena team index for the specified team size, or nil if the player is not in a team of the specified size. - -**Description:** -Arena team indices typically correspond to their creation/join order, and may be discontinuous. -You can get information about a given team from its index using `GetArenaTeam`. \ No newline at end of file diff --git a/wiki-information/functions/GetArenaTeamRosterInfo.md b/wiki-information/functions/GetArenaTeamRosterInfo.md deleted file mode 100644 index 1e35cdf1..00000000 --- a/wiki-information/functions/GetArenaTeamRosterInfo.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: GetArenaTeamRosterInfo - -**Content:** -Requests information regarding the arena team that the player is in, see Returns for a full list of what this returns. -`name, rank, level, class, online, played, win, seasonPlayed, seasonWin, personalRating = GetArenaTeamRosterInfo(teamindex, playerid)` - -**Parameters:** -- `teamindex` - - *number* - Index of the team you want information on, can be a value between 1 and 3. -- `playerindex` - - *number* - Index of the team member. Starts at 1. - -**Returns:** -- `name` - - *string* - Name of the player. -- `rank` - - *number* - 0 denotes team captain, while 1 denotes a regular member. -- `level` - - *number* - Player level. -- `class` - - *string* - The localized class of the player. -- `online` - - *number* - 1 denotes the player being online. nil denotes the player as offline. -- `played` - - *number* - Number of games this player has played this week. -- `win` - - *number* - Number of games this player has won this week. -- `seasonPlayed` - - *number* - Number of games played the entire season. -- `seasonWin` - - *number* - Number of games this player has won this week. -- `personalRating` - - *number* - Player's personal rating with this team. \ No newline at end of file diff --git a/wiki-information/functions/GetArmorPenetration.md b/wiki-information/functions/GetArmorPenetration.md deleted file mode 100644 index 59e2daaf..00000000 --- a/wiki-information/functions/GetArmorPenetration.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetArmorPenetration - -**Content:** -Returns the percentage of target's armor your physical attacks ignore due to armor penetration. -`armorPen = GetArmorPenetration()` - -**Returns:** -- `armorPen` - - *number* - Percent of armor ignored by your physical attacks. \ No newline at end of file diff --git a/wiki-information/functions/GetAtlasInfo.md b/wiki-information/functions/GetAtlasInfo.md deleted file mode 100644 index 78d7fd60..00000000 --- a/wiki-information/functions/GetAtlasInfo.md +++ /dev/null @@ -1,71 +0,0 @@ -## Title: C_Texture.GetAtlasInfo - -**Content:** -Returns atlas info. -`info = C_Texture.GetAtlasInfo(atlas)` - -**Parameters:** -- `atlas` - - *string* - Name of the atlas - -**Returns:** -- `info` - - *AtlasInfo* - - `Field` - - `Type` - - `Description` - - `width` - - *number* - - `height` - - *number* - - `rawSize` - - *vector2* - - `leftTexCoord` - - *number* - - `rightTexCoord` - - *number* - - `topTexCoord` - - *number* - - `bottomTexCoord` - - *number* - - `tilesHorizontally` - - *boolean* - - `tilesVertically` - - *boolean* - - `file` - - *number?* - FileID of parent texture - - `filename` - - *string?* - - `sliceData` - - *UITextureSliceData?* - - `UITextureSliceData` - - `Field` - - `Type` - - `Description` - - `marginLeft` - - *number* - - `marginTop` - - *number* - - `marginRight` - - *number* - - `marginBottom` - - *number* - - `sliceMode` - - *Enum.UITextureSliceMode* - - `Enum.UITextureSliceMode` - - `Value` - - `Field` - - `Description` - - `0` - - Stretched - - Default - - `1` - - Tiled - -**Reference:** -- `Texture:GetAtlas()` -- `Texture:SetAtlas()` -- `UI CreateAtlasMarkup` - Returns an inline fontstring texture from an atlas -- `Helix/AtlasInfo.lua` - Lua table containing atlas info -- `UiTextureAtlasMember.db2` - DBC for atlases -- `Texture Atlas Viewer` - Addon for browsing atlases in-game \ No newline at end of file diff --git a/wiki-information/functions/GetAttackPowerForStat.md b/wiki-information/functions/GetAttackPowerForStat.md deleted file mode 100644 index 93205b87..00000000 --- a/wiki-information/functions/GetAttackPowerForStat.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetAttackPowerForStat - -**Content:** -Returns the amount of attack power contributed by a specific amount of a stat. -`attackPower = GetAttackPowerForStat(stat, value)` - -**Parameters:** -- `stat` - - *number* - Index of the stat (Strength, Agility, ...) to check the bonus AP of. - - 1: `LE_UNIT_STAT_STRENGTH` - - 2: `LE_UNIT_STAT_AGILITY` - - 3: `LE_UNIT_STAT_STAMINA` - - 4: `LE_UNIT_STAT_INTELLECT` - - 5: `LE_UNIT_STAT_SPIRIT` (not available in 9.0.5) -- `value` - - *number* - Amount of the stat to check the AP value of. - -**Returns:** -- `attackPower` - - *number* - Amount of attack power granted by the specified amount of the specified stat. \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemBattlePetInfo.md b/wiki-information/functions/GetAuctionItemBattlePetInfo.md deleted file mode 100644 index bae15fb7..00000000 --- a/wiki-information/functions/GetAuctionItemBattlePetInfo.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetAuctionItemBattlePetInfo - -**Content:** -Retrieves info about one Battle Pet in the current retrieved list of Battle Pets from the Auction House. -`creatureID, displayID = GetAuctionItemBattlePetInfo(type, index)` - -**Parameters:** -- `type` - - *string* - One of the following: - - `"list"` - An item up for auction, the "Browse" tab in the dialog. - - `"bidder"` - An item the player has bid on, the "Bids" tab in the dialog. - - `"owner"` - An item the player has up for auction, the "Auctions" tab in the dialog. -- `index` - - *number* - The index of the item in the list to retrieve info from (normally 1-50, inclusive). - -**Returns:** -- `creatureID` - - *number* - An indexing value Blizzard uses to number NPCs. -- `displayID` - - *number* - An indexing value Blizzard uses to number model/skin combinations. - -**Description:** -The `displayID` return appears to always be 0, possibly because the function is only used by Blizzard in conjunction with `DressUpBattlePet`. - -**Reference:** -- `DressUpBattlePet` -- `GetAuctionItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemInfo.md b/wiki-information/functions/GetAuctionItemInfo.md deleted file mode 100644 index 645df98b..00000000 --- a/wiki-information/functions/GetAuctionItemInfo.md +++ /dev/null @@ -1,76 +0,0 @@ -## Title: GetAuctionItemInfo - -**Content:** -Retrieves info about one item in the current retrieved list of items from the Auction House. -```lua -name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, highBidder, bidderFullName, owner, ownerFullName, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo(type, index) -``` - -**Parameters:** -- `type` - - *string* - One of the following: - - `"list"` - An item up for auction, the "Browse" tab in the dialog. - - `"bidder"` - An item the player has bid on, the "Bids" tab in the dialog. - - `"owner"` - An item the player has up for auction, the "Auctions" tab in the dialog. -- `index` - - *number* - The index of the item in the list to retrieve info from (normally 1-50, inclusive) - -**Returns:** -1. `name` - - *string* - the name of the item -2. `texture` - - *number* - the fileID of the texture of the item -3. `count` - - *number* - the number of items in the auction item, zero if item is "sold" in the "owner" auctions -4. `quality` - - *Enum.ItemQuality* -5. `canUse` - - *boolean* - true if the user can use the item, false if not -6. `level` - - *number* - the level required to use the item -7. `levelColHeader` - - *string* - The preceding level return value changes depending on the value of levelColHeader: - - `"REQ_LEVEL_ABBR"` - level represents the required character level - - `"SKILL_ABBR"` - level represents the required skill level (for recipes) - - `"ITEM_LEVEL_ABBR"` - level represents the item level - - `"SLOT_ABBR"` - level represents the number of slots (for containers) -8. `minBid` - - *number* - the starting bid price -9. `minIncrement` - - *number* - the minimum amount of item at which to put the next bid -10. `buyoutPrice` - - *number* - zero if no buy out, otherwise it contains the buyout price of the auction item -11. `bidAmount` - - *number* - the current highest bid, zero if no one has bid yet -12. `highBidder` - - *string?* - returns name of highest bidder, nil otherwise -13. `bidderFullName` - - *string?* - returns bidder's full name if from virtual realm, nil otherwise -14. `owner` - - *string* - the player that is selling the item -15. `ownerFullName` - - *string?* - returns owner's full name if from virtual realm, nil otherwise -16. `saleStatus` - - *number* - 1 for sold, 0 for unsold -17. `itemId` - - *number* - item id -18. `hasAllInfo` - - *boolean* - was everything returned - -**Usage:** -```lua --- Retrieves info about the first item in the list of your currently auctioned items. -local name, texture, count, quality, canUse, level, levelColHeader, minBid, minIncrement, buyoutPrice, bidAmount, - highBidder, bidderFullName, owner, ownerFullName, saleStatus, itemId, hasAllInfo = GetAuctionItemInfo("owner", 1); -``` - -**Description:** -- **Auctions being returned as nil:** - As of 4.0.1, auctions will be returned as "nil" for items not yet in the client's itemcache. New items resolve at a rate of 30 unique itemids every 30 seconds. (Note that "of the Xxx" items share the same itemid) - Blizzard's standard auction house view overcomes this problem by reacting to `AUCTION_ITEM_LIST_UPDATE` and re-querying the items. - -- **The "owner" field and playername resolving:** - Note that the "owner" field can be nil. This happens because the auction listing internally contains player GUIDs rather than names, and the WoW client does not query the server for names until `GetAuctionItemInfo()` is actually called for the item, and the result takes one RTT to arrive. The GUID->name mapping is then stored in a name resolution cache, which gets cleared upon logout (not UI reload). - Blizzard's standard auction house view overcomes this problem by reacting to `AUCTION_ITEM_LIST_UPDATE` and re-querying the items. - However, this event-driven approach does not really work for e.g. scanner engines. There, the correct solution is to re-query items with nil owners for a short time (a low number of seconds). There IS a possibility that it NEVER returns something - this happens when someone puts something up for auction and then deletes his character. - Note that the playername resolver will only resolve a certain number of sellers every 30 seconds. When this limit is exceeded, it will appear as if responses arrive in batches every 30 seconds. \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemLink.md b/wiki-information/functions/GetAuctionItemLink.md deleted file mode 100644 index 489efc7d..00000000 --- a/wiki-information/functions/GetAuctionItemLink.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetAuctionItemLink - -**Content:** -Retrieves the itemLink of one item in the current retrieved list of items from the Auction House. -`itemLink = GetAuctionItemLink(type, index)` - -**Parameters:** -- `type` - - *string* - One of the following: - - `"list"` - An item up for auction, the "Browse" tab in the dialog. - - `"bidder"` - An item the player has bid on, the "Bids" tab in the dialog. - - `"owner"` - An item the player has up for auction, the "Auctions" tab in the dialog. -- `index` - - *number* - The index of the item in the list to retrieve info from (normally 1-50, inclusive). - -**Returns:** -- `itemLink` - - *itemLink* - The itemLink for the specified item or - - `nil`, if type and/or index is invalid. \ No newline at end of file diff --git a/wiki-information/functions/GetAuctionItemSubClasses.md b/wiki-information/functions/GetAuctionItemSubClasses.md deleted file mode 100644 index 8de251e3..00000000 --- a/wiki-information/functions/GetAuctionItemSubClasses.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: GetAuctionItemSubClasses - -**Content:** -Gets a list of the sub-classes for an Auction House item class. -`subClass1, subClass2, subClass3, ... = GetAuctionItemSubClasses(classID)` - -**Parameters:** -- `classID` - - *number* - ID of the item class. - -**Returns:** -- `subClass1, subClass2, subClass3, ...` - - *number* - The valid subclasses for an item class. - -**Usage:** -Prints all subclass IDs for the Consumables category. -```lua -local classID = LE_ITEM_CLASS_CONSUMABLE -for _, subClassID in pairs({GetAuctionItemSubClasses(classID)}) do - print(subClassID, (GetItemSubClassInfo(classID, subClassID))) -end -``` -Output: -``` -0, Explosives and Devices -1, Potion -2, Elixir -3, Flask -5, Food & Drink -7, Bandage -9, Vantus Runes -8, Other -``` - -**Reference:** -- ItemType - List of item (sub)classes -- GetItemClassInfo -- GetItemSubClassInfo -- GetAuctionItemClasses (removed) \ No newline at end of file diff --git a/wiki-information/functions/GetAutoCompleteRealms.md b/wiki-information/functions/GetAutoCompleteRealms.md deleted file mode 100644 index 0aa214be..00000000 --- a/wiki-information/functions/GetAutoCompleteRealms.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetAutoCompleteRealms - -**Content:** -Returns a table of realm names for auto-completion. -`realmNames = GetAutoCompleteRealms()` - -**Parameters:** -- `realmNames` - - *table?* - If a table is provided, it will be populated with realm names; otherwise, a new table will be created. - -**Returns:** -- `realmNames` - - *table* - An array of realm names the player can interact with through Connected Realms. Realm names will be in normalized format without spaces or hyphens (see GetNormalizedRealmName). - -**Description:** -Certain characters are removed from realm names, most notably Space and - while others remain, such as ' and variants of Latin letters (e.g. umlauts and accented letters). -The supplied table is not wiped; only the array keys needed to return the result are modified. -May not be available at load time until PLAYER_LOGIN (i.e. found to not work during VARIABLES_LOADED). \ No newline at end of file diff --git a/wiki-information/functions/GetAutoCompleteResults.md b/wiki-information/functions/GetAutoCompleteResults.md deleted file mode 100644 index c1c99fbf..00000000 --- a/wiki-information/functions/GetAutoCompleteResults.md +++ /dev/null @@ -1,48 +0,0 @@ -## Title: GetAutoCompleteResults - -**Content:** -Returns possible player names matching a given prefix string and specified requirements. -`results = GetAutoCompleteResults(text, numResults, cursorPosition, allowFullMatch, includeBitField, excludeBitField)` - -**Parameters:** -- `text` - - *string* - First characters of the possible names to be autocompleted -- `numResults` - - *number* - Number of results desired. -- `cursorPosition` - - *number* - Position of the cursor within the editbox (i.e. how much of the text string should be matching). -- `allowFullMatch` - - *boolean* -- `includeBitField` - - *number* - Bit mask of filters that the results must match at least one of. -- `excludeBitField` - - *number* - Bit mask of filters that the results must not match any of. - -**Filter values:** -The `includeBitField` and `excludeBitField` bit mask parameters can be composed from the following components: - -| AutocompleteFlag | Global | Value | Description | -|-------------------------------|-------------------|--------------|-----------------------------------------------------------------------------| -| AUTOCOMPLETE_FLAG_NONE | 0x00000000 | Mask usable for including or excluding no results. | -| AUTOCOMPLETE_FLAG_IN_GROUP | 0x00000001 | Matches characters in your current party or raid. | -| AUTOCOMPLETE_FLAG_IN_GUILD | 0x00000002 | Matches characters in your current guild. | -| AUTOCOMPLETE_FLAG_FRIEND | 0x00000004 | Matches characters on your character-specific friends list. | -| AUTOCOMPLETE_FLAG_BNET | 0x00000008 | Matches characters on your Battle.net friends list. | -| AUTOCOMPLETE_FLAG_INTERACTED_WITH | 0x00000010 | Matches characters that the player has interacted with directly, such as exchanging whispers. | -| AUTOCOMPLETE_FLAG_ONLINE | 0x00000020 | Matches characters that are currently online. | -| AUTO_COMPLETE_IN_AOI | 0x00000040 | Matches characters in the local area of interest. | -| AUTO_COMPLETE_ACCOUNT_CHARACTER | 0x00000080 | Matches characters on any of the current players' Battle.net game accounts. | -| AUTOCOMPLETE_FLAG_ALL | 0xFFFFFFFF | Mask usable for including or excluding all results. | - -**Returns:** -- `results` - - *table* - Auto-completed names of players that satisfy the requirements. - - `Field` - - `Type` - - `Description` - - `bnetID` - - *number* - - `name` - - *string* - The realm part can possibly be omitted for players on the same realm. This format might be inconsistent (on Classic), e.g. Foo-Nethergarde Keep and Foo-MirageRaceway - - `priority` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAutoDeclineGuildInvites.md b/wiki-information/functions/GetAutoDeclineGuildInvites.md deleted file mode 100644 index 6e24ee69..00000000 --- a/wiki-information/functions/GetAutoDeclineGuildInvites.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetAutoDeclineGuildInvites - -**Content:** -Returns true if guild invites are being automatically declined. -`autoDecline = GetAutoDeclineGuildInvites()` - -**Returns:** -- `autoDecline` - - *boolean* - -**Reference:** -- `SetAutoDeclineGuildInvites` \ No newline at end of file diff --git a/wiki-information/functions/GetAvailableBandwidth.md b/wiki-information/functions/GetAvailableBandwidth.md deleted file mode 100644 index 70fbc505..00000000 --- a/wiki-information/functions/GetAvailableBandwidth.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetAvailableBandwidth - -**Content:** -Needs summary. -`result = GetAvailableBandwidth()` - -**Returns:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetAvailableLocales.md b/wiki-information/functions/GetAvailableLocales.md deleted file mode 100644 index 8e00ce4a..00000000 --- a/wiki-information/functions/GetAvailableLocales.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetAvailableLocales - -**Content:** -Returns the available locale strings. -`locale1, locale2, ... = GetAvailableLocales()` - -**Parameters:** -- `ignoreLocalRestrictions` - - *boolean?* - If true, returns the complete list of locales. - -**Returns:** -- `locale1, locale2, ...` - - *string* - -**Usage:** -```lua -/dump GetAvailableLocales() -- "enUS", "esMX", "ptBR" (on a US server) -/dump GetAvailableLocales(true) -- "enUS", "koKR", "frFR", "deDE", "zhCN", "esES", "zhTW", "esMX", "ruRU", "ptBR", "itIT" -``` \ No newline at end of file diff --git a/wiki-information/functions/GetAverageItemLevel.md b/wiki-information/functions/GetAverageItemLevel.md deleted file mode 100644 index efa1dd8f..00000000 --- a/wiki-information/functions/GetAverageItemLevel.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetAverageItemLevel - -**Content:** -Returns the character's average item level. -`avgItemLevel, avgItemLevelEquipped, avgItemLevelPvp = GetAverageItemLevel()` - -**Returns:** -- `avgItemLevel` - - *number* - The average item level of the player. This value is not rounded off to any significant digits. -- `avgItemLevelEquipped` - - *number* - The average equipped item level of the player. This value is not rounded off to any significant digits. -- `avgItemLevelPvp` - - *number* - The average equipped item level your character is considered to have under PvP situations. Item slots are weighted and gems are taken into account to compute this value. It is likely used to derive PvP Scaling coefficient. - -**Usage:** -The following macro prints your average and equipped item levels (to two decimal places) to chat: -```lua -/run print(("Average Item level: %.2f; Equipped item level: %.2f"):format(GetAverageItemLevel())) -``` - -**Description:** -This function is only used to get the average iLevel of the player. It cannot be used to get the average iLevel of anybody else. -Currently, Blizzard's formula for equipped average item level is as follows: -``` - sum of item levels for equipped gear (I) ------------------------------------------ = Equipped Average Item Level - number of slots (S) -``` -- (I) = in taking the sum, the tabard and shirt always count as zero -- some heirloom items count as zero, other heirlooms count as one -- (S) = number of slots depends on the contents of the main and off hand as follows: - - 17 with both hands holding items - - 17 with a single one-hand item (or a single two-handed item with Titan's Grip) - - 16 with a two-handed item equipped (and no Titan's Grip) - - 16 with both hands empty \ No newline at end of file diff --git a/wiki-information/functions/GetBackgroundLoadingStatus.md b/wiki-information/functions/GetBackgroundLoadingStatus.md deleted file mode 100644 index a7137e30..00000000 --- a/wiki-information/functions/GetBackgroundLoadingStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetBackgroundLoadingStatus - -**Content:** -Needs summary. -`result = GetBackgroundLoadingStatus()` - -**Returns:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetBackpackCurrencyInfo.md b/wiki-information/functions/GetBackpackCurrencyInfo.md deleted file mode 100644 index 36037891..00000000 --- a/wiki-information/functions/GetBackpackCurrencyInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetBackpackCurrencyInfo - -**Content:** -Returns info for a tracked currency in the backpack. -`name, count, icon, currencyID = GetBackpackCurrencyInfo(index)` - -**Parameters:** -- `index` - - *number* - Index, ascending from 1 to `GetNumWatchedTokens()`. - -**Returns:** -- `name` - - *string* - Localized currency name. -- `count` - - *number* - Amount currently possessed by the player. -- `icon` - - *number* - FileID of the currency icon. -- `currencyID` - - *number* - CurrencyID of the currency. \ No newline at end of file diff --git a/wiki-information/functions/GetBankSlotCost.md b/wiki-information/functions/GetBankSlotCost.md deleted file mode 100644 index 6c63ad85..00000000 --- a/wiki-information/functions/GetBankSlotCost.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetBankSlotCost - -**Content:** -Returns the cost of the next bank bag slot. -`cost = GetBankSlotCost(numSlots)` - -**Parameters:** -- `numSlots` - - *number* - Number of slots already purchased. - -**Returns:** -- `cost` - - *number* - Price of the next bank slot in copper. - -**Usage:** -The following example outputs the amount of money you'll have to pay for the next bank slot: -```lua -local numSlots, full = GetNumBankSlots(); -if full then - print("You may not buy any more bank slots"); -else - local c = GetBankSlotCost(numSlots); - print(("Your next bank slot costs %d g %d s %d c"):format(c / 10000, c / 100 % 100, c % 100)); -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldEstimatedWaitTime.md b/wiki-information/functions/GetBattlefieldEstimatedWaitTime.md deleted file mode 100644 index 96d02bf8..00000000 --- a/wiki-information/functions/GetBattlefieldEstimatedWaitTime.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetBattlefieldEstimatedWaitTime - -**Content:** -Returns the estimated queue time to enter the battlefield. -`waitTime = GetBattlefieldEstimatedWaitTime()` - -**Returns:** -- `waitTime` - - *number* - Milliseconds until a battlefield will be available. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldFlagPosition.md b/wiki-information/functions/GetBattlefieldFlagPosition.md deleted file mode 100644 index dbed622d..00000000 --- a/wiki-information/functions/GetBattlefieldFlagPosition.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetBattlefieldFlagPosition - -**Content:** -Used to position the flag icon on the world map and the battlefield minimap. -`flagX, flagY, flagToken = GetBattlefieldFlagPosition(index)` - -**Parameters:** -- `index` - - *number* - Index to get the flag position from - -**Returns:** -- `flagX` - - *number* - Position of the flag on the map. -- `flagY` - - *number* - Position of the flag on the map. -- `flagToken` - - *string* - Name of flag texture in `Interface\\WorldStateFrame\\` - - In Warsong Gulch the names of the flag textures are the strings "AllianceFlag" and "HordeFlag". \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldInstanceExpiration.md b/wiki-information/functions/GetBattlefieldInstanceExpiration.md deleted file mode 100644 index ab17b503..00000000 --- a/wiki-information/functions/GetBattlefieldInstanceExpiration.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetBattlefieldInstanceExpiration - -**Content:** -Get shutdown timer for the battlefield instance. -`expiration = GetBattlefieldInstanceExpiration()` - -**Returns:** -- `expiration` - - *number* - the number of milliseconds before the Battlefield will close after a battle is finished. This is 0 before the battle is finished. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldInstanceInfo.md b/wiki-information/functions/GetBattlefieldInstanceInfo.md deleted file mode 100644 index fd9363d4..00000000 --- a/wiki-information/functions/GetBattlefieldInstanceInfo.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetBattlefieldInstanceInfo - -**Content:** -Returns the battlefield instance ID for an index in the battlemaster listing. -`instanceID = GetBattlefieldInstanceInfo(index)` - -**Parameters:** -- `index` - - *number* - The battlefield instance index, from 1 to `GetNumBattlefields()` when speaking to the battlemaster. - -**Returns:** -- `instanceID` - - *number* - The battlefield instance ID. For example, the ID in "Warsong Gulch 2". \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldInstanceRunTime.md b/wiki-information/functions/GetBattlefieldInstanceRunTime.md deleted file mode 100644 index 53d5fd96..00000000 --- a/wiki-information/functions/GetBattlefieldInstanceRunTime.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetBattlefieldInstanceRunTime - -**Content:** -Returns the time passed since the battlefield started. -`time = GetBattlefieldInstanceRunTime()` - -**Returns:** -- `time` - - *number* - milliseconds passed since the battle started \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldPortExpiration.md b/wiki-information/functions/GetBattlefieldPortExpiration.md deleted file mode 100644 index b0536ec5..00000000 --- a/wiki-information/functions/GetBattlefieldPortExpiration.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetBattlefieldPortExpiration - -**Content:** -Returns the remaining seconds before the battlefield port expires. -`expiration = GetBattlefieldPortExpiration(index)` - -**Parameters:** -- `index` - - *number* - Index of queue to get the expiration from - -**Returns:** -- `expiration` - - *number* - Remaining time of battlefield port in seconds \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldScore.md b/wiki-information/functions/GetBattlefieldScore.md deleted file mode 100644 index 31220f6a..00000000 --- a/wiki-information/functions/GetBattlefieldScore.md +++ /dev/null @@ -1,64 +0,0 @@ -## Title: GetBattlefieldScore - -**Content:** -Returns info for a player's score in battlefields. -`name, killingBlows, honorableKills, deaths, honorGained, faction, race, class, classToken, damageDone, healingDone, bgRating, ratingChange, preMatchMMR, mmrChange, talentSpec = GetBattlefieldScore(index)` - -**Parameters:** -- `index` - - *number* - The character's index in battlegrounds, going from 1 to `GetNumBattlefieldScores()`. - -**Returns:** -- `name` - - *string* - The player's name, with their server name attached if from a different server to the player. -- `killingBlows` - - *number* - Number of killing blows. -- `honorableKills` - - *number* - Number of honorable kills. -- `deaths` - - *number* - The number of deaths. -- `honorGained` - - *number* - The amount of honor gained so far (Bonus Honor). -- `faction` - - *number* - (Battlegrounds: Horde = 0, Alliance = 1 / Arenas: Green Team = 0, Yellow Team = 1). -- `race` - - *string* - The player's race (Orc, Undead, Human, etc). -- `class` - - *string* - The player's class (Mage, Hunter, Warrior, etc). -- `classToken` - - *string* - The player's class name in English given in all capitals (MAGE, HUNTER, WARRIOR, etc). -- `damageDone` - - *number* - The amount of damage done. -- `healingDone` - - *number* - The amount of healing done. -- `bgRating` - - *number* - The player's battleground rating. -- `ratingChange` - - *number* - The change in the player's rating. -- `preMatchMMR` - - *number* - The player's matchmaking rating before the match. -- `mmrChange` - - *number* - The change in the player's matchmaking rating. -- `talentSpec` - - *string* - Localized name of player build. - -**Usage:** -How to count the number of players in each faction. -```lua -local numScores = GetNumBattlefieldScores() -local numHorde = 0 -local numAlliance = 0 -for i = 1, numScores do - name, killingBlows, honorableKills, deaths, honorGained, faction = GetBattlefieldScore(i) - if (faction) then - if (faction == 0) then - numHorde = numHorde + 1 - else - numAlliance = numAlliance + 1 - end - end -end -``` - -**Example Use Case:** -This function can be used in addons that track player performance in battlegrounds or arenas. For example, an addon like "Recount" or "Details!" could use this function to display detailed statistics about each player's performance, such as damage done, healing done, and number of kills. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldStatInfo.md b/wiki-information/functions/GetBattlefieldStatInfo.md deleted file mode 100644 index 14d19be2..00000000 --- a/wiki-information/functions/GetBattlefieldStatInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: GetBattlefieldStatInfo - -**Content:** -Get list of battleground specific columns on the scoreboard. -`name, icon, tooltip = GetBattlefieldStatInfo(index)` - -**Parameters:** -- `index` - - *number* - Column to get data for - -**Returns:** -- `name` - - *string* - Name of the column (e.g., Flags Captured) -- `icon` - - *string* - Icon displayed when on the scoreboard rows (e.g., Horde flag icon next to the flag captures of an Alliance player) -- `tooltip` - - *string* - Tooltip displayed when hovering over a column's name - -**Description:** -Used to retrieve the custom scoreboard columns inside a battleground. - -**Example Usage:** -```lua -local index = 1 -local name, icon, tooltip = GetBattlefieldStatInfo(index) -print("Column Name: ", name) -print("Icon: ", icon) -print("Tooltip: ", tooltip) -``` - -**Battleground Specific Columns:** -- **Warsong Gulch:** - - Flags Captured - - Flags Returned -- **Arathi Basin:** - - Bases Assaulted - - Bases Defended -- **Alterac Valley:** - - Graveyards Assaulted - - Graveyards Defended - - Towers Assaulted - - Towers Defended - - Mines Captured - - Leaders Killed - - Secondary Objectives \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldStatus.md b/wiki-information/functions/GetBattlefieldStatus.md deleted file mode 100644 index 907a76e0..00000000 --- a/wiki-information/functions/GetBattlefieldStatus.md +++ /dev/null @@ -1,48 +0,0 @@ -## Title: GetBattlefieldStatus - -**Content:** -Returns the status of the battlefield the player is either queued for or inside. -`status, mapName, teamSize, registeredMatch, suspendedQueue, queueType, gameType, role, asGroup, shortDescription, longDescription = GetBattlefieldStatus(index)` - -**Parameters:** -- `index` - - *number* - Index of the battlefield you wish to view, in the range of 1 to GetMaxBattlefieldID() - -**Returns:** -- `status` - - *string* - Battlefield status, one of: - - `queued` - Waiting for a battlefield to become ready, you're in the queue - - `confirm` - Ready to join a battlefield - - `active` - Inside an active battlefield - - `none` - Not queued for anything in this index - - `error` - This should never happen -- `mapName` - - *string* - Localized name of the battlefield (e.g., Warsong Gulch or Blade's Edge Arena) -- `teamSize` - - *number* - Team size of the battlefield's queue (2, 3, or 5 in an arena queue, or 0 in other queue types) -- `registeredMatch` - - *number* - 1 in a registered arena queue, or 0 in a skirmish or non-arena queue; use teamSize to check for arenas. -- `suspendedQueue` - - *unknown* - (used to determine whether the eye icon on the LFG minimap button should animate, presumed boolean or 1/nil) -- `queueType` - - *string* - The type of battleground, one of: - - `ARENA` - - `BATTLEGROUND` - - `WARGAME` -- `gameType` - - *string* - ??? (displayed as-is to the user on the queue ready dialog, so presumed localized; can be an empty string) -- `role` - - *string* - The role assigned to the player (TANK, DAMAGER, HEALER) in a non-rated battleground, or nil for other queue types. -- `asGroup` - - *unknown* -- `shortDescription` - - *string* -- `longDescription` - - *string* - -**Example Usage:** -This function can be used to check the status of a player's queue for battlegrounds or arenas. For instance, an addon could use this to display the current queue status and estimated wait time for the player. - -**Addons Using This Function:** -- **DBM (Deadly Boss Mods):** Uses this function to provide alerts and status updates for players queued for battlegrounds or arenas. -- **BattlegroundTargets:** Utilizes this function to display detailed information about the player's current battleground queue status and team composition. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldTimeWaited.md b/wiki-information/functions/GetBattlefieldTimeWaited.md deleted file mode 100644 index 75b52349..00000000 --- a/wiki-information/functions/GetBattlefieldTimeWaited.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetBattlefieldTimeWaited - -**Content:** -Returns the time the player has waited in the queue. -`timeInQueue = GetBattlefieldTimeWaited(battlegroundQueuePosition)` - -**Parameters:** -- `battlegroundQueuePosition` - - *number* - The queue position. - -**Returns:** -- `timeInQueue` - - *number* - Milliseconds this player has been waiting in the queue. - -**Usage:** -You queue up for Arathi Basin and Alterac Valley. -```lua -x = GetBattlefieldTimeWaited(1); -- Arathi Basin -y = GetBattlefieldTimeWaited(2); -- Alterac Valley -``` -As soon as the join message appears, that slot is "empty" (returns 0) but they are not reordered, queuing up again will use the lowest slot available. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlefieldWinner.md b/wiki-information/functions/GetBattlefieldWinner.md deleted file mode 100644 index 8b345211..00000000 --- a/wiki-information/functions/GetBattlefieldWinner.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetBattlefieldWinner - -**Content:** -Returns the winner of the battlefield. -`winner = GetBattlefieldWinner()` - -**Returns:** -- `winner` - - *number* - Faction/team that has won the battlefield. Results are: - - `nil` if nobody has won - - `0` for Horde - - `1` for Alliance - - `255` for a draw in a battleground - - `0` for Green Team and `1` for Yellow in an arena - -**Description:** -Gets the winner of the battleground that the player is currently in. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlegroundInfo.md b/wiki-information/functions/GetBattlegroundInfo.md deleted file mode 100644 index 202561e0..00000000 --- a/wiki-information/functions/GetBattlegroundInfo.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetBattlegroundInfo - -**Content:** -Returns information about a battleground type. -`name, canEnter, isHoliday, isRandom, battleGroundID, info = GetBattlegroundInfo(index)` - -**Parameters:** -- `index` - - *number* - battleground type index, 1 to `GetNumBattlegroundTypes()`. - -**Returns:** -- `localizedName` - - *string* - Localized battleground name. -- `canEnter` - - *boolean* - `true` if the player can queue for this battleground, `false` otherwise. -- `isHoliday` - - *boolean* - `true` if this battleground is currently granting bonus honor due to a battleground holiday, `false` otherwise. -- `isRandom` - - *boolean* - `true` if this battleground is the random. -- `battleGroundID` - - *number* - the ID associated with the Battleground. See `BattlemasterList.db2` for full list. -- `mapDescription` - - *string* - Localized information about the battleground map. -- `bgInstanceID` - - *number* - InstanceID of the battleground map. -- `maxPlayers` - - *number* - Maximum number of players allowed in the battleground. -- `gameType` - - *string* - Type of the game (e.g., "CTF" for Capture the Flag). Empty string if none. -- `iconTexture` - - *number* - Path to the icon texture representing the battleground. -- `shortDescription` - - *string* - Short description of the battleground. -- `longDescription` - - *string* - Long description of the battleground. -- `hasControllingHoliday` - - *number* - `1` if there's a controlling holiday for the battleground, `0` otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetBattlegroundPoints.md b/wiki-information/functions/GetBattlegroundPoints.md deleted file mode 100644 index 1275f4ae..00000000 --- a/wiki-information/functions/GetBattlegroundPoints.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetBattlegroundPoints - -**Content:** -Returns battleground points earned by a team. -`currentPoints, maxPoints = GetBattlegroundPoints(team)` - -**Parameters:** -- `team` - - *number* - team to query the points of; 0 for Horde, 1 for Alliance. - -**Returns:** -- `currentPoints` - - *number* - current battleground points earned by the team. -- `maxPoints` - - *number* - maximum amount of battleground points the team can earn. - -**Description:** -As of 5.3, both return values are always 0; FrameXML comments in WorldStateFrame.lua state: -Long-term we'd like the battleground objectives to work more like this, but it's not working for 5.3. \ No newline at end of file diff --git a/wiki-information/functions/GetBestFlexRaidChoice.md b/wiki-information/functions/GetBestFlexRaidChoice.md deleted file mode 100644 index 6210bb88..00000000 --- a/wiki-information/functions/GetBestFlexRaidChoice.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetBestFlexRaidChoice - -**Content:** -Returns the dungeon ID of the most appropriate Flex Raid instance for the player. -`flexDungeonID = GetBestFlexRaidChoice()` - -**Returns:** -- `flexDungeonID` - - *number* - dungeon ID of the most appropriate Flex Raid instance for the player, or nil if no Flex Raids are currently appropriate. - -**Description:** -If there are no flex raids available for your character (i.e. you're below level 90), this function returns nil. -Otherwise, it returns the dungeon ID of the most advanced Flex Raid the player is eligible for. -You can retrieve information about the suggested flex raid using `GetLFGDungeonInfo`. \ No newline at end of file diff --git a/wiki-information/functions/GetBestRFChoice.md b/wiki-information/functions/GetBestRFChoice.md deleted file mode 100644 index dac0947b..00000000 --- a/wiki-information/functions/GetBestRFChoice.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetBestRFChoice - -**Content:** -Returns the suggested raid for the Raid Finder. -`dungeonId = GetBestRFChoice()` - -**Parameters:** -- None - -**Returns:** -- `dungeonId` - - *number* - Dungeon ID - -**Usage:** -```lua -/dump GetBestRFChoice() --- Example output: 416 -``` - -**Example Use Case:** -This function can be used to programmatically determine the best raid choice for a player using the Raid Finder. For instance, an addon could use this function to automatically suggest or queue the player for the most appropriate raid based on the game's internal logic. - -**Addons Using This Function:** -While specific large addons using this function are not documented, it is likely that raid management or automation addons could leverage this function to enhance the user experience by providing intelligent raid suggestions. \ No newline at end of file diff --git a/wiki-information/functions/GetBillingTimeRested.md b/wiki-information/functions/GetBillingTimeRested.md deleted file mode 100644 index add36906..00000000 --- a/wiki-information/functions/GetBillingTimeRested.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetBillingTimeRested - -**Content:** -Returns the amount of "healthy" time left for players on Chinese realms. -`secondsRemaining = GetBillingTimeRested()` - -**Returns:** -- `secondsRemaining` - - *number* - Amount of time left in seconds to play as rested. See details below for clarification. Returns nil for EU and US accounts. - -**Usage:** -The official function (modified to output in the chat frame) when you have partial play time left: -```lua -print(string.format(PLAYTIME_TIRED, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) -``` -The official function (modified to output in the chat frame) when you have no play time left at all: -```lua -print(string.format(PLAYTIME_UNHEALTHY, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) -``` - -**Description:** -Only relevant on Chinese realms. -- When you reach 3 hours remaining you will get "tired", reducing both the amount of money and experience that you receive by 1/2. -- If you play for 5 hours you will get "unhealthy", and won't be able to turn in quests, receive experience or loot. -- The time left is stored on your account, and will display the same amount on every character. -- The time will decay as you stay logged out. - -**Reference:** -- PartialPlayTime -- NoPlayTime \ No newline at end of file diff --git a/wiki-information/functions/GetBindLocation.md b/wiki-information/functions/GetBindLocation.md deleted file mode 100644 index a8ee8c91..00000000 --- a/wiki-information/functions/GetBindLocation.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetBindLocation - -**Content:** -Returns the subzone the character's Hearthstone is set to. -`location = GetBindLocation()` - -**Returns:** -Returns the String name of the subzone the player's Hearthstone is set to, e.g. "Tarren Mill", "Crossroads", or "Brill". - -**Usage:** -```lua -bindLocation = GetBindLocation(); --- If the player's Hearthstone is set to the inn at Allerian Stronghold then bindLocation is assigned "Allerian Stronghold". -``` - -**Example Use Case:** -This function can be used in addons that need to display or utilize the player's current Hearthstone location. For instance, an addon that manages travel routes or provides information about the nearest flight paths might use this function to offer more relevant suggestions based on the player's bind location. - -**Addons Using This Function:** -Many travel and utility addons, such as "TomTom" and "Hearthstone Tracker," use this function to provide players with information about their Hearthstone location and to enhance the player's travel experience in the game. \ No newline at end of file diff --git a/wiki-information/functions/GetBinding.md b/wiki-information/functions/GetBinding.md deleted file mode 100644 index c6c584b6..00000000 --- a/wiki-information/functions/GetBinding.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: GetBinding - -**Content:** -Returns the name and keys for a binding by index. -`command, category, key1, key2, ... = GetBinding(index)` - -**Parameters:** -- `index` - - *number* - index of the binding to query, from 1 to GetNumBindings(). -- `alwaysIncludeGamepad` - - *boolean?* - If gamepad support is disabled, then gamepad bindings are only returned if this is true. - -**Returns:** -- `command` - - *string* - Command this binding will perform (e.g. MOVEFORWARD). For well-behaved bindings, a human-readable description is stored in the `_G` global variable. -- `category` - - *string* - Category this binding was declared in (e.g. BINDING_HEADER_MOVEMENT). For well-behaved bindings, a human-readable title is stored in the `_G` global variable. -- `key1, key2, ...` - - *string?* - Key combination this binding is bound to (e.g. W, CTRL-F). `key1` and `key2` can be nil if there is nothing bound to the command. - -**Description:** -Even though the default Key Binding window only shows up to two bindings for each command, it is actually possible to bind more using `SetBinding`, and this function will return all of the keys bound to the given command, not just the first two. - -**Usage:** -```lua -local function dumpBinding(command, category, ...) - local cmdName = _G[command] - local catName = _G[category] - print(("%s > %s (%s) is bound to:"):format(catName or "?", cmdName or "?", command), strjoin(", ", ...)) -end - -dumpBinding(GetBinding(5)) -- "Movement Keys > Turn Right (TURNRIGHT) is bound to: D, RIGHT" -``` - -**Reference:** -- `GetBindingAction` -- `GetBindingKey` -- `GetBindingByKey` -- `Bindings.xml` \ No newline at end of file diff --git a/wiki-information/functions/GetBindingAction.md b/wiki-information/functions/GetBindingAction.md deleted file mode 100644 index d2167537..00000000 --- a/wiki-information/functions/GetBindingAction.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetBindingAction - -**Content:** -Returns the binding name for a key (combination). -`action = GetBindingAction(binding)` - -**Parameters:** -- `binding` - - *string* - The name of the key (e.g., "BUTTON1", "1", "CTRL-G") -- `checkOverride` - - *boolean?* - if true, override bindings will be checked, otherwise, only default (bindings.xml/SetBinding) bindings are consulted. - -**Returns:** -- `action` - - *string* - action command performed by the binding. If no action is bound to the key, an empty string is returned. - -**Reference:** -- `GetBindingByKey` - -**Example Usage:** -```lua -local action = GetBindingAction("CTRL-G") -print(action) -- This will print the action bound to "CTRL-G" if any, otherwise an empty string. -``` - -**Additional Information:** -This function is commonly used in addons that manage or display key bindings, such as Bartender4 or ElvUI. These addons use `GetBindingAction` to retrieve and display the current key bindings for various actions, allowing users to customize their gameplay experience. \ No newline at end of file diff --git a/wiki-information/functions/GetBindingByKey.md b/wiki-information/functions/GetBindingByKey.md deleted file mode 100644 index a39b2fe4..00000000 --- a/wiki-information/functions/GetBindingByKey.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetBindingByKey - -**Content:** -Returns the binding action performed when the specified key combination is triggered. -`bindingAction = GetBindingByKey(key)` - -**Parameters:** -- `key` - - *string* - binding key to query, e.g. "G", "ALT-G", "ALT-CTRL-SHIFT-F1". - -**Returns:** -- `bindingAction` - - *string* - binding action that will be performed, e.g. "TOGGLEAUTORUN", "CLICK Purrseus:k1", or nil if no action will be performed. - -**Description:** -This function takes into account override bindings by default. -This discards modifiers from the key argument until a binding matches; thus, querying for ALT-CTRL-SHIFT-G can return the action performed due to the simple "G" binding. - -**Reference:** -`GetBindingAction` \ No newline at end of file diff --git a/wiki-information/functions/GetBindingKey.md b/wiki-information/functions/GetBindingKey.md deleted file mode 100644 index f9d02b7e..00000000 --- a/wiki-information/functions/GetBindingKey.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: GetBindingKey - -**Content:** -Returns the keys bound to the given command. -`key1, key2, ... = GetBindingKey(command)` - -**Parameters:** -- `command` - - The name of the command to get key bindings for (e.g. MOVEFORWARD, TOGGLEFRIENDSTAB) - -**Returns:** -- (Variable returns) - - `key1` - - *string* - The string representation(s) of all the key(s) bound to this command (e.g. W, CTRL-F) - - `key2` - - *string* - -**Usage:** -```lua -local command, key1, key2 = GetBinding("MOVEFORWARD") -DEFAULT_CHAT_FRAME:AddMessage(BINDING_NAME_MOVEFORWARD .. " has the following keys bound:") -if key1 then - DEFAULT_CHAT_FRAME:AddMessage(key1) -end -if key2 then - DEFAULT_CHAT_FRAME:AddMessage(key2) -end -``` - -**Description:** -Even though the default Key Binding window only shows up to two bindings for each command, it is actually possible to bind more using SetBinding, and this function will return all of the keys bound to the given command, not just the first two. - -**Reference:** -- `GetBinding` -- `GetBindingAction` -- `GetBindingByKey` \ No newline at end of file diff --git a/wiki-information/functions/GetBindingText.md b/wiki-information/functions/GetBindingText.md deleted file mode 100644 index 07c0e85c..00000000 --- a/wiki-information/functions/GetBindingText.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetBindingText - -**Content:** -Returns the string for the given key and prefix. Essentially a specialized `getglobal()` for bindings. -`text = GetBindingText()` - -**Parameters:** -- `key` - - *string?* - The name of the key (e.g. "UP", "SHIFT-PAGEDOWN") -- `prefix` - - *string?* - The prefix of the variable name you're looking for. Usually "KEY_" or "BINDING_NAME_". -- `abbreviate` - - *boolean?* - Whether to return an abbreviated version of the modifier keys - -**Returns:** -- `text` - - *string* - The value of the global variable derived from the prefix and key name you specified. For example, "UP" and "KEY_" would return the value of the global variable `KEY_UP` which is "Up Arrow" in the English locale. If the global variable doesn't exist for the combination specified, it appears to just return the key name you specified. Modifier key prefixes are stripped from the input and added back into the output. The third parameter, if true, causes the function to simply substitute the abbreviations 'c', 'a', 's', and 'st' for the strings CTRL, ALT, SHIFT, and STRG (German client only) in the result. - -**Usage:** -```lua -/dump GetBindingText("UP", "KEY_") --- "Up Arrow" -``` \ No newline at end of file diff --git a/wiki-information/functions/GetBlockChance.md b/wiki-information/functions/GetBlockChance.md deleted file mode 100644 index 109f53a1..00000000 --- a/wiki-information/functions/GetBlockChance.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetBlockChance - -**Content:** -Returns the block chance percentage. -`blockChance = GetBlockChance()` - -**Returns:** -- `blockChance` - - *number* - The player's block chance in percentage. - -**Reference:** -- `GetDodgeChance` -- `GetCritChance` -- `GetParryChance` -- `GetCombatRating` -- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetBonusBarOffset.md b/wiki-information/functions/GetBonusBarOffset.md deleted file mode 100644 index 2b4f328d..00000000 --- a/wiki-information/functions/GetBonusBarOffset.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: GetBonusBarOffset - -**Content:** -Returns the current bonus action bar index (e.g. for the Rogue stealth bar). -`offset = GetBonusBarOffset()` - -**Parameters:** -- **Returns** - - `offset` - *Number* - The current bonus action bar index. - -**Description:** -Certain classes have "bonus action bars" for their class-specific actions, e.g. the various Stance Bars for the Warrior class. `GetBonusBarOffset()` returns the index of the current action bar that is being displayed. Note that simply scrolling through the action bar pages won't change the output; only switching to the different bonus bars. Each class has their own way of indexing their bonus bars. - -- **Warrior** - - Battle Stance: 1 - - Defensive Stance: 2 - - Berserker Stance: 3 -- **Druid** - - Caster: 0 - - Cat: 1 - - Tree of Life: 2 - - Bear: 3 - - Moonkin: 4 -- **Rogue** - - Normal: 0 - - Stealthed: 1 -- **Priest** - - Normal: 0 - - Shadowform: 1 -- **All Characters** - - When Possessing a Target: 5 - -**Usage:** -```lua -/script ChatFrame1:AddMessage(GetBonusBarOffset()) -``` -This will simply print the output of `GetBonusBarOffset()`. It should change as you change between your bonus bars. - -```lua -slotID = (1 + (NUM_ACTIONBAR_PAGES + GetBonusBarOffset() - 1) * NUM_ACTIONBAR_BUTTONS) -``` -Here, `slotID` will be the action slot number for the first slot of the current bonus bar. For example, for a Warrior in Defensive Stance, `slotID = 85`, which is correct. (ActionSlot) \ No newline at end of file diff --git a/wiki-information/functions/GetBuildInfo.md b/wiki-information/functions/GetBuildInfo.md deleted file mode 100644 index abd0416b..00000000 --- a/wiki-information/functions/GetBuildInfo.md +++ /dev/null @@ -1,54 +0,0 @@ -## Title: GetBuildInfo - -**Content:** -Returns info for the current client build. -`version, build, date, tocversion, localizedVersion, buildType = GetBuildInfo()` - -**Returns:** -- `version` - - *string* - Current patch version -- `build` - - *string* - Build number -- `date` - - *string* - Build date -- `tocversion` - - *number* - Interface (.toc) version number -- `localizedVersion` - - *string* - Localized translation for the string "Version" -- `buildType` - - *string* - Localized build type and machine architecture - -**Description:** -In the initial testing build of Patch 10.1.0 (48480) the `localizedVersion` and `buildType` return values do not function as intended and will return an empty string and a string with just a space character respectively. - -**Usage:** -```lua -/dump GetBuildInfo() -- "9.0.2", "36665", "Nov 17 2020", 90002 -``` - -**Miscellaneous:** -- **Flavor** - - **Patch** - - **TOC version** -- **The War Within** - - **11.0.0** - - **110000** -- **Mainline PTR** - - **10.2.7** - - **100207** -- **Mainline** - - **10.2.6** - - **100207** -- **Cataclysm Classic** - - **4.4.0** - - **40400** -- **Wrath Classic** - - **3.4.3** - - **30403** -- **Classic Era** - - **1.15.2** - - **11502** - -**Reference:** -- [Public client builds - List of documented builds](https://wow.tools/builds/) -- [List of datamined builds](https://www.townlong-yak.com/framexml/builds) \ No newline at end of file diff --git a/wiki-information/functions/GetButtonMetatable.md b/wiki-information/functions/GetButtonMetatable.md deleted file mode 100644 index 256a5ffa..00000000 --- a/wiki-information/functions/GetButtonMetatable.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetButtonMetatable - -**Content:** -Returns the metatable used by Button objects. -`metatable = GetButtonMetatable()` - -**Returns:** -- `metatable` - - *table* - The metatable used by Button objects. - -**Description:** -The metatable returned by this function is shared between all non-forbidden Button object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetBuybackItemInfo.md b/wiki-information/functions/GetBuybackItemInfo.md deleted file mode 100644 index 9fed3250..00000000 --- a/wiki-information/functions/GetBuybackItemInfo.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: GetBuybackItemInfo - -**Content:** -Returns info for an item that can be bought back from a merchant. -`name, icon, price, quantity = GetBuybackItemInfo(slotIndex)` - -**Parameters:** -- `slotIndex` - - *number* - The index of a slot in the merchant's buyback inventory, between 1 and `GetNumBuybackItems()`. - -**Returns:** -- `name` - - *string* - The name of the item. -- `icon` - - *number (fileID)* - Icon texture of the item. -- `price` - - *number* - The price, in copper, it will cost to buy the item(s) back. -- `quantity` - - *number* - The quantity of items in the stack. -- `numAvailable` - - *number* - The number available. -- `isUsable` - - *boolean* - True if the item is usable, false otherwise. - -**Reference:** -- `GetNumBuybackItems` \ No newline at end of file diff --git a/wiki-information/functions/GetCVarInfo.md b/wiki-information/functions/GetCVarInfo.md deleted file mode 100644 index 7f542488..00000000 --- a/wiki-information/functions/GetCVarInfo.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: C_CVar.GetCVarInfo - -**Content:** -Returns information on a console variable. -`value, defaultValue, isStoredServerAccount, isStoredServerCharacter, isLockedFromUser, isSecure, isReadOnly = C_CVar.GetCVarInfo(name)` - -**Parameters:** -- `name` - - *string* - Name of the CVar to query the value of. Only accepts console variables (i.e. not console commands). - -**Returns:** -- `value` - - *string* - Current value of the CVar. -- `defaultValue` - - *string* - Default value of the CVar. -- `isStoredServerAccount` - - *boolean* - If the CVar scope is set WoW account-wide. Stored on the server per CVar synchronizeConfig. -- `isStoredServerCharacter` - - *boolean* - If the CVar scope is character-specific. Stored on the server per CVar synchronizeConfig. -- `isLockedFromUser` - - *boolean* -- `isSecure` - - *boolean* - If the CVar cannot be set with SetCVar while in combat, which would fire ADDON_ACTION_BLOCKED. It's also not possible to set these via /console. Most nameplate CVars are secure. -- `isReadOnly` - - *boolean* - Returns true for portal, serverAlert, timingTestError. These CVars cannot be changed. \ No newline at end of file diff --git a/wiki-information/functions/GetCameraZoom.md b/wiki-information/functions/GetCameraZoom.md deleted file mode 100644 index 9be09e6f..00000000 --- a/wiki-information/functions/GetCameraZoom.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetCameraZoom - -**Content:** -Returns the current zoom level of the camera. -`zoom = GetCameraZoom()` - -**Returns:** -- `zoom` - - *number* - the currently set zoom level - -**Description:** -Doesn't take camera collisions with the environment into account and will return what the camera would be at. If the camera is in motion, the zoom level that is set that frame is used, not the zoom level that the camera is traveling to. \ No newline at end of file diff --git a/wiki-information/functions/GetCategoryList.md b/wiki-information/functions/GetCategoryList.md deleted file mode 100644 index 1cbb73a3..00000000 --- a/wiki-information/functions/GetCategoryList.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetCategoryList - -**Content:** -Returns the list of achievement categories. -`idTable = GetCategoryList()` - -**Returns:** -- `idTable` - - *table* - array containing achievement category IDs, in no particular order. - -**Reference:** -- `GetCategoryInfo(categoryId)` -- `GetCategoryNumAchievements(categoryId)` \ No newline at end of file diff --git a/wiki-information/functions/GetCategoryNumAchievements.md b/wiki-information/functions/GetCategoryNumAchievements.md deleted file mode 100644 index 186b7e30..00000000 --- a/wiki-information/functions/GetCategoryNumAchievements.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetCategoryNumAchievements - -**Content:** -Returns the number of achievements for a category. -`total, completed, incompleted = GetCategoryNumAchievements(categoryId)` - -**Parameters:** -- `categoryId` - - *number* - Achievement category ID, as returned by GetCategoryList. -- `includeAll` - - *boolean?* - If true-equivalent, include all achievements, otherwise, only includes those currently visible. - -**Returns:** -- `total` - - *number* - total number of achievements in the specified category. -- `completed` - - *number* - number of completed achievements in the specified category. -- `incompleted` - - *number* - number of incompleted achievements in the specified category. - -**Usage:** -The snippet below prints the achievement IDs and names of all achievements in the World Events > Midsummer category: -```lua -for i=1, (GetCategoryNumAchievements(161)) do - local id, name = GetAchievementInfo(161, i) - print(id, name) -end -``` - -**Reference:** -- `GetCategoryList` -- `GetAchievementInfo(categoryId, index)` \ No newline at end of file diff --git a/wiki-information/functions/GetCemeteryPreference.md b/wiki-information/functions/GetCemeteryPreference.md deleted file mode 100644 index 613520e5..00000000 --- a/wiki-information/functions/GetCemeteryPreference.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetCemeteryPreference - -**Content:** -Needs summary. -`result = GetCemeteryPreference()` - -**Returns:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetChannelList.md b/wiki-information/functions/GetChannelList.md deleted file mode 100644 index 65ac7d3b..00000000 --- a/wiki-information/functions/GetChannelList.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetChannelList - -**Content:** -Returns the list of joined chat channels. -`id, name, disabled, ... = GetChannelList()` - -**Returns:** -- (Variable returns: `id1, name1, disabled1, id2, name2, disabled2, ...`) - - `id` - - *number* - channel number - - `name` - - *string* - channel name - - `disabled` - - *boolean* - If the channel is disabled, e.g. the Trade channel when you're not in a city. - -**Usage:** -Prints the channels the player is currently in. -```lua -local channels = {GetChannelList()} -for i = 1, #channels, 3 do - local id, name, disabled = channels[i], channels[i+1], channels[i+2] - print(id, name, disabled) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetChannelName.md b/wiki-information/functions/GetChannelName.md deleted file mode 100644 index 8143aff4..00000000 --- a/wiki-information/functions/GetChannelName.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GetChannelName - -**Content:** -Returns info for a chat channel. -`id, name, instanceID, isCommunitiesChannel = GetChannelName(name)` - -**Parameters:** -- `name` - - *string|number* - name of the channel to query, e.g. "Trade - City", or a channel ID to query, e.g. 1 for the chat channel currently addressable using /1. - -**Returns:** -- `id` - - *number* - The ID of the channel, or 0 if the channel is not found. -- `name` - - *string* - The name of the channel, e.g. "Trade - Stormwind", or nil if the player is not in the queried channel. -- `instanceID` - - *number* - Index used to deduplicate channels. Usually zero, unless two channels with the same name exist. -- `isCommunitiesChannel` - - *boolean* - True if this is a Blizzard Communities channel, false if not. - -**Description:** -Note that querying `GetChannelName("Trade - City")` may return values which appear to be valid even while the player is not in a city. Consider using `GetChannelName((GetChannelName("Trade - City"))) > 0` to check whether you really have access to the Trade channel. \ No newline at end of file diff --git a/wiki-information/functions/GetChatWindowInfo.md b/wiki-information/functions/GetChatWindowInfo.md deleted file mode 100644 index 7db3cf7c..00000000 --- a/wiki-information/functions/GetChatWindowInfo.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: GetChatWindowInfo - -**Content:** -Returns info for a chat window. -`name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(frameIndex)` - -**Parameters:** -- `frameIndex` - - *number* - The index of the chat window to get information for (starts at 1). - -**Returns:** -- `name` - - *string* - The name of the chat window, or an empty string for its default name. -- `fontSize` - - *number* - The font size for the window. -- `r` - - *number* - The red component of the window's background color (0.0 - 1.0). -- `g` - - *number* - The green component of the window's background color (0.0 - 1.0). -- `b` - - *number* - The blue component of the window's background color (0.0 - 1.0). -- `alpha` - - *number* - The alpha level (opacity) of the window background (0.0 - 1.0). -- `shown` - - *number* - 1 if the window is shown, 0 if it is hidden. -- `locked` - - *number* - 1 if the window is locked in place, 0 if it is movable. -- `docked` - - *number* - 1 to NUM_CHAT_WINDOWS; Index Order of docked tab EG: General = 1, Combat Log = 2. nil if floating. -- `uninteractable` - - *number* - 1 if the window is uninteractable, 0 if it is interactable. - -**Usage:** -```lua -local name, fontSize, r, g, b, alpha, shown, locked, docked, uninteractable = GetChatWindowInfo(i); -``` - -**Description:** -Retrieves Chat Window configuration information. This is what FrameXML uses to know how to display the actual windows. This configuration information is set via the `SetChatWindow...()` family of functions which causes the "UPDATE_CHAT_WINDOWS" event to fire. FrameXML calls `GetChatWindowInfo()` when it receives this event. -`frameIndex` can be any chat window index between 1 and NUM_CHAT_WINDOWS. `1` is the main chat window. \ No newline at end of file diff --git a/wiki-information/functions/GetChatWindowMessages.md b/wiki-information/functions/GetChatWindowMessages.md deleted file mode 100644 index d0f00490..00000000 --- a/wiki-information/functions/GetChatWindowMessages.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetChatWindowMessages - -**Content:** -Returns subscribed message types for a chat window. -`type1, ... = GetChatWindowMessages(index)` - -**Parameters:** -- `index` - - *number* - Chat window index, ascending from 1. - -**Returns:** -- `type1, ...` - - *string* - Chat type received by the window. - -**Reference:** -- `AddChatWindowMessages` -- `RemoveChatWindowMessages` \ No newline at end of file diff --git a/wiki-information/functions/GetClassInfo.md b/wiki-information/functions/GetClassInfo.md deleted file mode 100644 index 1d43cb70..00000000 --- a/wiki-information/functions/GetClassInfo.md +++ /dev/null @@ -1,68 +0,0 @@ -## Title: GetClassInfo - -**Content:** -Returns information about a class. -`className, classFile, classID = GetClassInfo(classID)` - -**Parameters:** -- `classID` - - *number* : ClassId - Ranging from 1 to `GetNumClasses()` - - Values: - - `ID` - - `className` (enUS) - - `classFile` - - `Description` - - `1` - - `Warrior` - - `WARRIOR` - - `2` - - `Paladin` - - `PALADIN` - - `3` - - `Hunter` - - `HUNTER` - - `4` - - `Rogue` - - `ROGUE` - - `5` - - `Priest` - - `PRIEST` - - `6` - - `Death Knight` - - `DEATHKNIGHT` - - Added in 3.0.2 - - `7` - - `Shaman` - - `SHAMAN` - - `8` - - `Mage` - - `MAGE` - - `9` - - `Warlock` - - `WARLOCK` - - `10` - - `Monk` - - `MONK` - - Added in 5.0.4 - - `11` - - `Druid` - - `DRUID` - - `12` - - `Demon Hunter` - - `DEMONHUNTER` - - Added in 7.0.3 - - `13` - - `Evoker` - - `EVOKER` - - Added in 10.0.0 - -**Returns:** -- `className` - - *string* - Localized name, e.g. "Warrior" or "Guerrier". -- `classFile` - - *string* - Locale-independent name, e.g. "WARRIOR". -- `classID` - - *number* : ClassId - -**Description:** -Returns nil for classes that don't exist in Classic. \ No newline at end of file diff --git a/wiki-information/functions/GetClassicExpansionLevel.md b/wiki-information/functions/GetClassicExpansionLevel.md deleted file mode 100644 index 63841619..00000000 --- a/wiki-information/functions/GetClassicExpansionLevel.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetClassicExpansionLevel - -**Content:** -Needs summary. -`expansionLevel = GetClassicExpansionLevel()` - -**Returns:** -- `expansionLevel` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetClickFrame.md b/wiki-information/functions/GetClickFrame.md deleted file mode 100644 index 9e27ba99..00000000 --- a/wiki-information/functions/GetClickFrame.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetClickFrame - -**Content:** -Returns the frame registered with the given object name. -`frame = GetClickFrame(name)` - -**Parameters:** -- `name` - - *string* - The name of the frame to obtain. - -**Returns:** -- `frame` - - *table?* - The table handle to the named frame if it exists, else nil. - -**Description:** -This function acts as a secure cache for frame name to object lookups. The first call to this function will cache the frame object registered assigned to name in the global namespace, and all subsequent calls thereafter will return the same frame even if the global is later replaced. -This function will not cache frame objects if the queried name does not match their actual object name as returned by `UIObject:GetName()`. -If called securely, this function returns the frame to the caller untainted. \ No newline at end of file diff --git a/wiki-information/functions/GetClientDisplayExpansionLevel.md b/wiki-information/functions/GetClientDisplayExpansionLevel.md deleted file mode 100644 index c014a930..00000000 --- a/wiki-information/functions/GetClientDisplayExpansionLevel.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: GetClientDisplayExpansionLevel - -**Content:** -Returns the expansion level of the game client. -`expansionLevel = GetClientDisplayExpansionLevel()` - -**Returns:** -- `expansionLevel` - - *number* - - `NUM_LE_EXPANSION_LEVELS` - - **Value** - - **Enum** - - **Description** - - `LE_EXPANSION_LEVEL_CURRENT` - - 0 - - `LE_EXPANSION_CLASSIC` - - Vanilla / Classic Era - - 1 - - `LE_EXPANSION_BURNING_CRUSADE` - - The Burning Crusade - - 2 - - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` - - Wrath of the Lich King - - 3 - - `LE_EXPANSION_CATACLYSM` - - Cataclysm - - 4 - - `LE_EXPANSION_MISTS_OF_PANDARIA` - - Mists of Pandaria - - 5 - - `LE_EXPANSION_WARLORDS_OF_DRAENOR` - - Warlords of Draenor - - 6 - - `LE_EXPANSION_LEGION` - - Legion - - 7 - - `LE_EXPANSION_BATTLE_FOR_AZEROTH` - - Battle for Azeroth - - 8 - - `LE_EXPANSION_SHADOWLANDS` - - Shadowlands - - 9 - - `LE_EXPANSION_DRAGONFLIGHT` - - Dragonflight - - 10 - - `LE_EXPANSION_11_0` - -**Usage:** -Before and after updating to the 9.0.1 pre-patch. -`/dump GetClientDisplayExpansionLevel() -- 7 -> 8` \ No newline at end of file diff --git a/wiki-information/functions/GetCoinIcon.md b/wiki-information/functions/GetCoinIcon.md deleted file mode 100644 index 220160b3..00000000 --- a/wiki-information/functions/GetCoinIcon.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetCoinIcon - -**Content:** -Returns the path to the texture used for a given amount of money. -`texturePath = GetCoinIcon(amount)` - -**Parameters:** -- `amount` - - *number* - amount of money in copper - -**Returns:** -- `texturePath` - - *string* - Path to icon used for the amount of money. - -**Description:** -Currently returns `"Interface/Icons/INV_Misc_Coin_XX"`, where `XX` ranges from 01 to 06. Respectively, these correspond to: -- 01, 02 - Gold coins (loose and stack) -- 03, 04 - Silver coins (loose and stack) -- 05, 06 - Copper coins (loose and stack) - -These are not the same icons used in a standard money frame (e.g., under your main backpack), instead these are the ones used in loot frames. \ No newline at end of file diff --git a/wiki-information/functions/GetCoinText.md b/wiki-information/functions/GetCoinText.md deleted file mode 100644 index 278b79c3..00000000 --- a/wiki-information/functions/GetCoinText.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title: GetCoinText - -**Content:** -Breaks up an amount of money into gold/silver/copper. -`formattedAmount = GetCoinText(amount)` - -**Parameters:** -- `amount` - - *number* - the amount of money in copper (for example, the return value from GetMoney) -- `separator` - - *string?* - a string to insert between the formatted amounts of currency, if there is more than one type - -**Returns:** -- `formattedAmount` - - *string* - a (presumably localized) string suitable for printing or displaying - -**Usage:** -```lua --- Example usage of GetMoney and GetCoinText -GetMoney() -local money = GetMoney() -local gold = floor(money / 1e4) -local silver = floor(money / 100 % 100) -local copper = money % 100 -print(("You have %dg %ds %dc"):format(gold, silver, copper)) --- Output: You have 10851g 62s 40c - --- Using GetCoinText -print(GetCoinText(GetMoney())) -- "10851 Gold, 62 Silver, 40 Copper" -print(GetCoinText(12345678, " ")) -- "1234 Gold 23 Silver 45 Copper" -print(GetCoinText(12345678, "X")) -- "1234 GoldX23 SilverX45 Copper" - --- Using GetMoneyString -print(GetMoneyString(12345678)) -print(GetMoneyString(12345678, true)) --- Output: 1234 56 78 --- Output: 1,234 56 78 - --- Using GetCoinTextureString -print(GetCoinTextureString(1234578)) -print(GetCoinTextureString(1234578, 24)) --- Output: 1234 56 78 --- Output: 1234 56 78 -``` - -**Example Use Case:** -This function is particularly useful for addons that need to display the player's current amount of money in a user-friendly format. For instance, an auction house addon might use `GetCoinText` to show the total amount of money a player has after selling items. - -**Addons Using This Function:** -- **Auctioneer**: This addon uses `GetCoinText` to display the player's current gold, silver, and copper in various parts of its interface, such as when listing items for sale or showing the total earnings from auctions. -- **Bagnon**: This inventory management addon uses `GetCoinText` to show the total amount of money a player has across all their characters and banks. \ No newline at end of file diff --git a/wiki-information/functions/GetCoinTextureString.md b/wiki-information/functions/GetCoinTextureString.md deleted file mode 100644 index d9cac0da..00000000 --- a/wiki-information/functions/GetCoinTextureString.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title: GetCoinTextureString - -**Content:** -Breaks up an amount of money into gold/silver/copper with icons. -`formattedAmount = GetCoinTextureString(amount)` - -**Parameters:** -- `amount` - - *number* - the amount of money in copper (for example, the return value from GetMoney) -- `fontHeight` - - *number?* - the height of the coin icon; if not specified, defaults to 14. - -**Returns:** -- `formattedAmount` - - *string* - a string suitable for printing or displaying. - -**Usage:** -```lua --- Example usage of GetMoney and GetCoinTextureString -GetMoney() -local money = GetMoney() -local gold = floor(money / 1e4) -local silver = floor(money / 100 % 100) -local copper = money % 100 -print(("You have %dg %ds %dc"):format(gold, silver, copper)) --- You have 10851g 62s 40c - --- Using GetCoinText -print(GetCoinText(GetMoney())) -- "10851 Gold, 62 Silver, 40 Copper" -print(GetCoinText(12345678, " ")) -- "1234 Gold 23 Silver 45 Copper" -print(GetCoinText(12345678, "X")) -- "1234 GoldX23 SilverX45 Copper" - --- Using GetMoneyString -print(GetMoneyString(12345678)) -print(GetMoneyString(12345678, true)) --- 1234 56 78 --- 1,234 56 78 - --- Using GetCoinTextureString -print(GetCoinTextureString(1234578)) -print(GetCoinTextureString(1234578, 24)) --- 1234 56 78 --- 1234 56 78 -``` - -**Example Use Case:** -This function is particularly useful in addons that display the player's current money in a more visually appealing way, such as in tooltips, UI elements, or chat messages. For instance, an addon like "Titan Panel" might use this function to show the player's gold, silver, and copper with appropriate icons on the panel. - -**Addons Using This Function:** -- **Titan Panel:** This popular addon uses `GetCoinTextureString` to display the player's current money on the panel with icons, making it easier to read at a glance. -- **Bagnon:** Another widely used addon, Bagnon, might use this function to show the total money across all characters in a unified and visually appealing format. \ No newline at end of file diff --git a/wiki-information/functions/GetCombatRating.md b/wiki-information/functions/GetCombatRating.md deleted file mode 100644 index b1c01bc1..00000000 --- a/wiki-information/functions/GetCombatRating.md +++ /dev/null @@ -1,89 +0,0 @@ -## Title: GetCombatRating - -**Content:** -Returns a specific combat rating. -`rating = GetCombatRating(ratingIndex)` - -**Parameters:** -- `ratingIndex` - - *number* - One of the following constants from FrameXML/PaperDollFrame.lua: - - `Value` - - `Field` - - `Description` - - `1` - - `CR_WEAPON_SKILL` - Removed in patch 6.0.2 - - `2` - - `CR_DEFENSE_SKILL` - - `3` - - `CR_DODGE` - - `4` - - `CR_PARRY` - - `5` - - `CR_BLOCK` - - `6` - - `CR_HIT_MELEE` - - `7` - - `CR_HIT_RANGED` - - `8` - - `CR_HIT_SPELL` - - `9` - - `CR_CRIT_MELEE` - - `10` - - `CR_CRIT_RANGED` - - `11` - - `CR_CRIT_SPELL` - - `12` - - `CR_MULTISTRIKE` - Formerly CR_HIT_TAKEN_MELEE until patch 6.0.2 - - `13` - - `CR_READINESS` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 - - `14` - - `CR_SPEED` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 - - `15` - - `CR_RESILIENCE_CRIT_TAKEN` - - `16` - - `CR_RESILIENCE_PLAYER_DAMAGE_TAKEN` - - `17` - - `CR_LIFESTEAL` - Formerly CR_CRIT_TAKEN_SPELL until patch 6.0.2 - - `18` - - `CR_HASTE_MELEE` - - `19` - - `CR_HASTE_RANGED` - - `20` - - `CR_HASTE_SPELL` - - `21` - - `CR_AVOIDANCE` - Formerly CR_WEAPON_SKILL_MAINHAND until patch 6.0.2 - - `22` - - `CR_WEAPON_SKILL_OFFHAND` - Removed in patch 6.0.2 - - `23` - - `CR_WEAPON_SKILL_RANGED` - - `24` - - `CR_EXPERTISE` - - `25` - - `CR_ARMOR_PENETRATION` - - `26` - - `CR_MASTERY` - - `27` - - `CR_PVP_POWER` - Removed in patch 6.0.2 - - `29` - - `CR_VERSATILITY_DAMAGE_DONE` - - `31` - - `CR_VERSATILITY_DAMAGE_TAKEN` - -**Returns:** -- `rating` - - *number* - the actual rating for the combat rating. - -**Description:** -Related API: `GetCombatRatingBonus` - -**Usage:** -```lua -local hitRating = GetCombatRating(CR_HIT_MELEE) -print(hitRating) -- 63 -``` - -**Example Use Case:** -This function can be used to retrieve the player's current rating for a specific combat stat, which can be useful for addons that display detailed character statistics or for custom UI elements that need to show combat ratings. - -**Addons Using This API:** -Many popular addons like "Details! Damage Meter" and "Recount" use this API to display detailed combat statistics and performance metrics for players. \ No newline at end of file diff --git a/wiki-information/functions/GetCombatRatingBonus.md b/wiki-information/functions/GetCombatRatingBonus.md deleted file mode 100644 index b69013b6..00000000 --- a/wiki-information/functions/GetCombatRatingBonus.md +++ /dev/null @@ -1,87 +0,0 @@ -## Title: GetCombatRatingBonus - -**Content:** -Returns the bonus percentage for a specific combat rating. -`ratingBonus = GetCombatRatingBonus(ratingIndex)` - -**Parameters:** -- `ratingIndex` - - *number* - One of the following values from FrameXML/PaperDollFrame.lua: - - `Value` - - `Field` - - `Description` - - `1` - - `CR_WEAPON_SKILL` - Removed in patch 6.0.2 - - `2` - - `CR_DEFENSE_SKILL` - - `3` - - `CR_DODGE` - - `4` - - `CR_PARRY` - - `5` - - `CR_BLOCK` - - `6` - - `CR_HIT_MELEE` - - `7` - - `CR_HIT_RANGED` - - `8` - - `CR_HIT_SPELL` - - `9` - - `CR_CRIT_MELEE` - - `10` - - `CR_CRIT_RANGED` - - `11` - - `CR_CRIT_SPELL` - - `12` - - `CR_MULTISTRIKE` - Formerly CR_HIT_TAKEN_MELEE until patch 6.0.2 - - `13` - - `CR_READINESS` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 - - `14` - - `CR_SPEED` - Formerly CR_HIT_TAKEN_SPELL until patch 6.0.2 - - `15` - - `CR_RESILIENCE_CRIT_TAKEN` - - `16` - - `CR_RESILIENCE_PLAYER_DAMAGE_TAKEN` - - `17` - - `CR_LIFESTEAL` - Formerly CR_CRIT_TAKEN_SPELL until patch 6.0.2 - - `18` - - `CR_HASTE_MELEE` - - `19` - - `CR_HASTE_RANGED` - - `20` - - `CR_HASTE_SPELL` - - `21` - - `CR_AVOIDANCE` - Formerly CR_WEAPON_SKILL_MAINHAND until patch 6.0.2 - - `22` - - `CR_WEAPON_SKILL_OFFHAND` - Removed in patch 6.0.2 - - `23` - - `CR_WEAPON_SKILL_RANGED` - - `24` - - `CR_EXPERTISE` - - `25` - - `CR_ARMOR_PENETRATION` - - `26` - - `CR_MASTERY` - - `27` - - `CR_PVP_POWER` - Removed in patch 6.0.2 - - `29` - - `CR_VERSATILITY_DAMAGE_DONE` - - `31` - - `CR_VERSATILITY_DAMAGE_TAKEN` - -**Returns:** -- `ratingBonus` - - *number* - the actual bonus in percent the combat rating confers; e.g. 5.13452 - -**Usage:** -```lua -hitBonus = GetCombatRatingBonus(CR_HIT_MELEE) -- 5.13452 -``` - -**Reference:** -- `GetCombatRating`: Gets the underlying rating that contributes to the bonus -- `GetCritChance`: Gets the player's current Crit Chance % -- `GetMastery`: Gets the player's current Mastery % -- `GetDodgeChance`: Gets the player's current Dodge Chance % -- `GetParryChance`: Gets the player's current Parry Chance % -- `GetBlockChance`: Gets the player's current Block Chance % \ No newline at end of file diff --git a/wiki-information/functions/GetComboPoints.md b/wiki-information/functions/GetComboPoints.md deleted file mode 100644 index 8489ef72..00000000 --- a/wiki-information/functions/GetComboPoints.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetComboPoints - -**Content:** -Returns the amount of current combo points. -`comboPoints = GetComboPoints(unit, target)` - -**Parameters:** -- `unit` - - *string* : UnitId - Normally "player" or "vehicle". -- `target` - - *string* : UnitId - Normally "target". - -**Returns:** -- `comboPoints` - - *number* - Number of combo points unit has on target; between 0 and 5 inclusive. - -**Description:** -`UNIT_COMBO_POINTS` fires when combo points are updated. It fires every 10 seconds outside of combat if the rogue has shared combo points, and it continues to fire every 10 seconds until the combo point pool is empty. - -Patch 6.0.2 (2014-10-14): Combo Points for rogues are now shared across all targets and they are no longer lost when switching targets. - -`GetComboPoints` will return 0 if the target is friendly or not found. Use `UnitPower(unitId, 4)` to get combo points without an enemy targeted. - -**Reference:** -- `UnitPower` - -**Example Usage:** -```lua -local comboPoints = GetComboPoints("player", "target") -print("Current combo points on target: ", comboPoints) -``` - -**Addons Using This Function:** -- **ElvUI**: A comprehensive UI replacement addon that uses `GetComboPoints` to display combo points on the unit frames. -- **WeakAuras**: A powerful and flexible framework for displaying highly customizable graphics on your screen to indicate buffs, debuffs, and other relevant information, including combo points. \ No newline at end of file diff --git a/wiki-information/functions/GetCompanionCooldown.md b/wiki-information/functions/GetCompanionCooldown.md deleted file mode 100644 index f3c9e673..00000000 --- a/wiki-information/functions/GetCompanionCooldown.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetCompanionCooldown - -**Content:** -Returns cooldown information about the companions you have. -`startTime, duration, isEnabled = GetCompanionCooldown("type", id)` - -**Parameters:** -- `type` - - *String (companionType)* - Type of the companion being queried ("CRITTER" or "MOUNT") -- `id` - - *Number* - The slot id to query (starts at 1). - -**Returns:** -- `start` - - *Number* - the time the cooldown period began, based on GetTime(). -- `duration` - - *Number* - the duration of the cooldown period. -- `isEnabled` - - *Number* - 1 if the companion has a cooldown. \ No newline at end of file diff --git a/wiki-information/functions/GetCompanionInfo.md b/wiki-information/functions/GetCompanionInfo.md deleted file mode 100644 index 23778a28..00000000 --- a/wiki-information/functions/GetCompanionInfo.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: GetCompanionInfo - -**Content:** -Returns info for a companion. -`creatureID, creatureName, creatureSpellID, icon, issummoned, mountType = GetCompanionInfo(type, id)` - -**Parameters:** -- `type` - - *string* - Companion type to query: "CRITTER" or "MOUNT". -- `id` - - *number* - Index of the slot to query. Starting at 1 and going up to `GetNumCompanions("type")`. - -**Returns:** -- `creatureID` - - *number* - The NPC ID of the companion. -- `creatureName` - - *string* - The name of the companion. -- `creatureSpellID` - - *number* - The spell ID to cast the companion. This is not passed to `CallCompanion`, but can be used with, e.g., `GetSpellInfo`. -- `icon` - - *string* - The texture of the icon for the companion. -- `issummoned` - - *boolean* - 1 if the companion is summoned, nil if it's not. -- `mountType` - - *number* - Bitfield for air/ground/water mounts - - 0x1: Ground - - 0x2: Can fly - - 0x4: ? (set for most mounts) - - 0x8: Underwater - - 0x10: Can jump (turtles cannot) - -**Description:** -The indices are unstable: you may not rely on the ("type", id) mapping to the same companion after an arbitrary amount of time, even if the player does not learn/unlearn any companions during the period. -Generally, the indices are ordered alphabetically, though this order may be violated during the initial loading process and upon zoning. - -**Reference:** -- `GetNumCompanions` -- `CallCompanion` -- `C_PetJournal` function \ No newline at end of file diff --git a/wiki-information/functions/GetComparisonStatistic.md b/wiki-information/functions/GetComparisonStatistic.md deleted file mode 100644 index 0ae4c61a..00000000 --- a/wiki-information/functions/GetComparisonStatistic.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetComparisonStatistic - -**Content:** -Returns the specified statistic from the comparison player unit. -`value = GetComparisonStatistic(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - The ID of the Achievement. - -**Returns:** -- `value` - - *string* - The value of the requested Statistic from the comparison unit. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerFreeSlots.md b/wiki-information/functions/GetContainerFreeSlots.md deleted file mode 100644 index abdc5464..00000000 --- a/wiki-information/functions/GetContainerFreeSlots.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetContainerFreeSlots - -**Content:** -Populates a table with references to unused slots inside a container. -```lua -returnTable = GetContainerFreeSlots(index) -GetContainerFreeSlots(index, returnTable) -``` - -**Parameters:** -- `index` - - *number* - the slot containing the bag, e.g. 0 for backpack, etc. -- `returnTable` - - *table?* - Provide an empty table and the function will populate it with the free slots - -**Returns:** -- `returnTable` - - *table* - If you do not specify `returnTable` as an argument, the function constructs and returns a new table instead - -**Reference:** -- `GetContainerNumFreeSlots` \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemCooldown.md b/wiki-information/functions/GetContainerItemCooldown.md deleted file mode 100644 index 9d414335..00000000 --- a/wiki-information/functions/GetContainerItemCooldown.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetContainerItemCooldown - -**Content:** -Returns cooldown information for an item in your inventory. -`startTime, duration, isEnabled = GetContainerItemCooldown(bagID, slot)` - -**Parameters:** -- `(bagID, slot)` - - `bagID` - - *number* - number of the bag the item is in, 0 is your backpack, 1-4 are the four additional bags - - `slot` - - *number* - slot number of the bag item you want the info for. - -**Returns:** -- `startTime, duration, isEnabled` - - `startTime` - - the time the cooldown period began - - `duration` - - the duration of the cooldown period - - `isEnabled` - - 1 if the item has a cooldown, 0 otherwise \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemDurability.md b/wiki-information/functions/GetContainerItemDurability.md deleted file mode 100644 index ae86b17d..00000000 --- a/wiki-information/functions/GetContainerItemDurability.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: GetContainerItemDurability - -**Content:** -Returns the durability of an item in a container slot. -`current, maximum = GetContainerItemDurability(bag, slot)` - -**Parameters:** -- `bag` - - *number* - Index of the bag slot the bag storing the item is in. -- `slot` - - *number* - Index of the bag slot containing the item to query durability of. - -**Returns:** -- `current` - - *number* - current durability value. -- `maximum` - - *number* - maximum durability value. - -**Reference:** -- `GetInventoryItemDurability` - -**Example Usage:** -This function can be used to check the durability of items in a player's inventory, which is useful for addons that manage equipment or provide alerts when items are close to breaking. - -**Addon Usage:** -Large addons like "ElvUI" and "WeakAuras" may use this function to display durability information on the user interface, helping players keep track of their gear's condition. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemID.md b/wiki-information/functions/GetContainerItemID.md deleted file mode 100644 index 8cc72f6e..00000000 --- a/wiki-information/functions/GetContainerItemID.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetContainerItemID - -**Content:** -Returns the item ID in a container slot. -`itemId = GetContainerItemID(bag, slot)` - -**Parameters:** -- `bag` - - *number (BagID)* - Index of the bag to query. -- `slot` - - *number* - Index of the slot within the bag to query; ascending from 1. - -**Returns:** -- `itemId` - - *number* - item ID of the item held in the container slot, nil if there is no item in the container slot. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemInfo.md b/wiki-information/functions/GetContainerItemInfo.md deleted file mode 100644 index 3c73a718..00000000 --- a/wiki-information/functions/GetContainerItemInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: GetContainerItemInfo - -**Content:** -Returns info for an item in a container slot. -`icon, itemCount, locked, quality, readable, lootable, itemLink, isFiltered, noValue, itemID, isBound = GetContainerItemInfo(bagID, slot)` - -**Parameters:** -- `bagID` - - *number* - BagID of the bag the item is in, e.g. 0 for your backpack. -- `slot` - - *number* - index of the slot inside the bag to look up. - -**Returns:** -1. `texture` - - *number* - The icon texture (FileID) for the item in the specified bag slot. -2. `itemCount` - - *number* - The number of items in the specified bag slot. -3. `locked` - - *boolean* - True if the item is locked by the server, false otherwise. -4. `quality` - - *number* - The Quality of the item. -5. `readable` - - *boolean* - True if the item can be "read" (as in a book), false otherwise. -6. `lootable` - - *boolean* - True if the item is a temporary container containing items that can be looted, false otherwise. -7. `itemLink` - - *string* - The itemLink of the item in the specified bag slot. -8. `isFiltered` - - *boolean* - True if the item is grayed-out during the current inventory search, false otherwise. -9. `noValue` - - *boolean* - True if the item has no gold value, false otherwise. -10. `itemID` - - *number* - The unique ID for the item in the specified bag slot. -11. `isBound` - - *boolean* - True if the item is bound to the current character, false otherwise. - -**Reference:** -- `GetItemInfo` -- `GetItemInfoInstant` - -**Example Usage:** -This function can be used to retrieve detailed information about items in a player's inventory, which is useful for inventory management addons. For example, an addon could use this function to display item counts, quality, and other attributes in a custom inventory UI. - -**Addons Using This Function:** -- **Bagnon**: A popular inventory management addon that consolidates all bags into a single window. It uses `GetContainerItemInfo` to display item details and manage inventory efficiently. -- **ArkInventory**: Another comprehensive inventory addon that allows for highly customizable bag layouts and item sorting. It relies on `GetContainerItemInfo` to fetch item data for its various features. \ No newline at end of file diff --git a/wiki-information/functions/GetContainerItemLink.md b/wiki-information/functions/GetContainerItemLink.md deleted file mode 100644 index 6db14b26..00000000 --- a/wiki-information/functions/GetContainerItemLink.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetContainerItemLink - -**Content:** -Returns a link of the object located in the specified slot of a specified bag. -`itemLink = GetContainerItemLink(bagID, slotIndex)` - -**Parameters:** -- `bagID` - - *number* - Bag index (bagID). Valid indices are integers -2 through 11. 0 is the backpack. -- `slotIndex` - - *number* - Slot index within the specified bag, ascending from 1. Slot 1 is typically the leftmost topmost slot. - -**Returns:** -- `itemLink` - - *string* - a chat link for the object in the specified bag slot; nil if there is no such object. This is typically, but not always an ItemLink. - -**Usage:** -The following macro prints the ItemLink of the item located in bag 0, slot 1. -```lua -/run link=GetContainerItemLink(0,1); printable=gsub(link, "\\124", "\\124\\124"); print("Here's the item link for the first slot of your backpack: \\"" .. printable .. "\\"") -``` - -**Description:** -Since Patch 5.0.4, certain companion pets may be put in a cage and traded. The cage is not an item, but nevertheless occupies bag slots. For such caged companions, the returned link describes a battle pet ("|Hbattlet:...") rather than an item ("|Hitem:..."). \ No newline at end of file diff --git a/wiki-information/functions/GetContainerNumFreeSlots.md b/wiki-information/functions/GetContainerNumFreeSlots.md deleted file mode 100644 index 8c41d8a6..00000000 --- a/wiki-information/functions/GetContainerNumFreeSlots.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetContainerNumFreeSlots - -**Content:** -Returns the number of free slots in a bag. -`numberOfFreeSlots, bagType = GetContainerNumFreeSlots(bagID)` - -**Parameters:** -- `bagID` - - *number* - the slot containing the bag, e.g. 0 for backpack, etc. - -**Returns:** -- `numberOfFreeSlots` - - *number* - the number of free slots in the specified bag. -- `bagType` - - *number (itemFamily Bitfield)* - The type of the container, described using bits to indicate its permissible contents. - -**Reference:** -- `GetContainerFreeSlots` - Returns a table containing references to each free slot \ No newline at end of file diff --git a/wiki-information/functions/GetContainerNumSlots.md b/wiki-information/functions/GetContainerNumSlots.md deleted file mode 100644 index 33db61b9..00000000 --- a/wiki-information/functions/GetContainerNumSlots.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetContainerNumSlots - -**Content:** -Returns the total number of slots in the bag specified by the index. -`numberOfSlots = GetContainerNumSlots(bagID)` - -**Parameters:** -- `bagID` - - *number* - the slot containing the bag, e.g. 0 for backpack, etc. - -**Returns:** -- `numberOfSlots` - - *number* - the number of slots in the specified bag, or 0 if there is no bag in the given slot. - -**Description:** -In 2.0.3, the Key Ring(-2) always returns 32. The size of the bag displayed is determined by the amount of space used in the keyring. -As of 3.0.3, immediately after a PLAYER_ENTERING_WORLD event (initial login or zone change through an instance, i.e., any time you see a loading screen), several events of BAG_UPDATE are fired, one for each bag slot you have purchased. All bag data is available during the PLAYER_ENTERING_WORLD event, but this function returns 0 for bags that have not had the BAG_UPDATE function called. This is most likely due to the UI resetting its internal cache sometime between the PLAYER_ENTERING_WORLD event and the first BAG_UPDATE event. \ No newline at end of file diff --git a/wiki-information/functions/GetCorpseRecoveryDelay.md b/wiki-information/functions/GetCorpseRecoveryDelay.md deleted file mode 100644 index 565c4a36..00000000 --- a/wiki-information/functions/GetCorpseRecoveryDelay.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetCorpseRecoveryDelay - -**Content:** -Needs summary. -`result = GetCorpseRecoveryDelay()` - -**Returns:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetCraftDescription.md b/wiki-information/functions/GetCraftDescription.md deleted file mode 100644 index 8e2d989b..00000000 --- a/wiki-information/functions/GetCraftDescription.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetCraftDescription - -**Content:** -This command returns a string description of what the current craft does. -`craftDescription = GetCraftDescription(index)` - -**Parameters:** -- `index` - - *number* - Number from 1 to X number of total crafts, where 1 is the top-most craft listed. - -**Returns:** -- `craftDescription` - - *string* - Returns, for example, "Permanently enchant a two handed melee weapon to grant +25 Agility." - -**Example Usage:** -```lua -local index = 1 -local description = GetCraftDescription(index) -print(description) -- Output: "Permanently enchant a two handed melee weapon to grant +25 Agility." -``` - -**Additional Information:** -This function is often used in crafting-related addons to display detailed information about what each craft does. For example, an addon that helps players manage their professions might use this function to show descriptions of all available crafts in a user-friendly interface. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftDisplaySkillLine.md b/wiki-information/functions/GetCraftDisplaySkillLine.md deleted file mode 100644 index 4b6b27f4..00000000 --- a/wiki-information/functions/GetCraftDisplaySkillLine.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetCraftDisplaySkillLine - -**Content:** -This command retrieves displayable information for the current craft. -`name, rank, maxRank = GetCraftDisplaySkillLine()` - -**Returns:** -- `name` - - *string* - The name of the active craft, or nil if the current craft has no displayable name. Also nil if there are no active crafting windows. -- `rank` - - *number* - The player's current rank for the named craft, if applicable. -- `maxRank` - - *number* - The maximum rank for the named craft, if applicable. - -**Description:** -The two crafts, Beast Training and Enchanting, have a slightly different UI: the latter has a blue progress bar at the top of the window indicating the player's rank while the former does not. Accordingly, this function returns nil when the Beast Training window is open, while all return values should be valid when the Enchanting window is open. - -**Reference:** -`GetCraftSkillLine()` returns the name of the currently active crafting window regardless of whether the name should be displayed. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftInfo.md b/wiki-information/functions/GetCraftInfo.md deleted file mode 100644 index faaf4c41..00000000 --- a/wiki-information/functions/GetCraftInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetCraftInfo - -**Content:** -`craftName, craftSubSpellName, craftType, numAvailable, isExpanded, trainingPointCost, requiredLevel = GetCraftInfo(index)` - -**Parameters:** -- `index` - - *number* - 1 to GetNumCrafts() - -**Returns:** -- `craftName` - - Name of the item you can craft -- `craftSubSpellName` -- `craftType` - - *string* - "header" or how hard it is to create the item; trivial, easy, medium, or optimal. -- `numAvailable` - - This is the number of items you can create with the reagents you have in your inventory (the number is also shown in the UI). -- `isExpanded` - - Only applies to headers. Indicates whether they are expanded or contracted. Nil if not applicable. -- `trainingPointCost` - - This is the number of training points needed to train this skill if at a trainer. Nil if the craft window is not a trainer. -- `requiredLevel` - - The required level to train this skill if at a trainer. Nil if the craft window is not a trainer. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftItemLink.md b/wiki-information/functions/GetCraftItemLink.md deleted file mode 100644 index 424d3fe6..00000000 --- a/wiki-information/functions/GetCraftItemLink.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetCraftItemLink - -**Content:** -Returns an itemLink for the specified trade skill item in the current active trade skill. -`itemLink = GetCraftItemLink(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the current active trade skill. - -**Returns:** -- `itemLink` - - *itemLink* - the corresponding item link for that item or - - *nil* - if the index is invalid or there is no active trade skill. - -**Description:** -This function works with the trade skill which is currently active. Initially, there is no active trade skill. A trade skill becomes active when a trade skill window is opened, for instance. -Note that not all trade skills will change the active trade skill for this function. Only those which can generate chat links for a single trade skill will change the active setting (not to be mixed up with item links for crafted items). At the moment, this is only the enchanting trade skill window. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftName.md b/wiki-information/functions/GetCraftName.md deleted file mode 100644 index 8a0ef001..00000000 --- a/wiki-information/functions/GetCraftName.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetCraftName - -**Content:** -Gets the name displayed on the craft window. -`craftName = GetCraftName()` - -**Returns:** -- `craftName` - - *string* - It appears to return the localized name for Enchanting, Poisons for Rogues, and Cooking. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftNumReagents.md b/wiki-information/functions/GetCraftNumReagents.md deleted file mode 100644 index 0d197c46..00000000 --- a/wiki-information/functions/GetCraftNumReagents.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetCraftNumReagents - -**Content:** -This command tells the caller how many reagents are required for said craft. -`numRequiredReagents = GetCraftNumReagents(index)` - -**Parameters:** -- `index` - - *Numeric* - Number from 1 to X, where X is the total number of possible crafts. - -**Returns:** -- `numRequiredReagents` - - *Integer* - This is the number of required reagents for said craft. For example, 4 (for any craft that requires 4 reagents to perform). \ No newline at end of file diff --git a/wiki-information/functions/GetCraftReagentInfo.md b/wiki-information/functions/GetCraftReagentInfo.md deleted file mode 100644 index 41efac89..00000000 --- a/wiki-information/functions/GetCraftReagentInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetCraftReagentInfo - -**Content:** -This command tells the caller the name of the reagent, path to the used texture, number of required reagents, and number of said reagents that the caller currently has in their bags. -`name, texturePath, numRequired, numHave = GetCraftReagentInfo(index, n)` - -**Parameters:** -- `index` - - *number* - starting at 1 going down to X number of possible crafts, where 1 is the top-most listed craft. -- `n` - - *number* - starting at 1 to X, where X is the total number of reagents said craft requires. - -**Returns:** -- `name` - - Name of the reagent required. e.g., "Large Brilliant Shard" -- `texturePath` - - Path to the required item texture. e.g., "Interface\\Icons\\INV_Enchant_ShardBrilliantLarge" -- `numRequired` - - *number* - Number of total required reagents. -- `numHave` - - *number* - Number of total required reagents that the user has on them currently. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftReagentItemLink.md b/wiki-information/functions/GetCraftReagentItemLink.md deleted file mode 100644 index c150360e..00000000 --- a/wiki-information/functions/GetCraftReagentItemLink.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetCraftReagentItemLink - -**Content:** -This command returns a required reagent (as an itemLink) for a specific craftable item from the currently visible tradeskill window. -`reagentLink = GetCraftReagentItemLink(index, n)` - -**Parameters:** -- `index` - - *number* - index of the requested craft recipe, where 1 is the top-most listed recipe. -- `n` - - *number* - index of the Nth reagent for the recipe, where 1 is the first reagent. - -**Returns:** -- `reagentLink` - - *string* - itemLink for the requested reagent. - -**Description:** -If you specify an invalid index, `nil` is returned. -If there is no visible tradeskill window, `nil` is returned. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftRecipeLink.md b/wiki-information/functions/GetCraftRecipeLink.md deleted file mode 100644 index 68ab9b4c..00000000 --- a/wiki-information/functions/GetCraftRecipeLink.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetCraftRecipeLink - -**Content:** -Returns the EnchantLink for a craft. -`link = GetCraftRecipeLink(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the current active trade skill. - -**Returns:** -- `link` - - *string* - An EnchantLink (color coded with href) which can be included in chat messages to show the reagents and the items the craft creates. - -**Description:** -This function works with the trade skill which is currently active and only the trade skills that use the CraftFrame, not the TradeSkillFrame. Initially, there is no active trade skill. A trade skill becomes active when a trade skill window is opened, for instance. -Note that not all trade skills will change the active trade skill for this function. At the moment, only enchanting and hunter's train-pet window use CraftFrame. Use `GetTradeSkillRecipeLink` for the other professions. \ No newline at end of file diff --git a/wiki-information/functions/GetCraftSkillLine.md b/wiki-information/functions/GetCraftSkillLine.md deleted file mode 100644 index cf095f41..00000000 --- a/wiki-information/functions/GetCraftSkillLine.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetCraftSkillLine - -**Content:** -This command tells the caller which, if any, crafting window is currently open. -`currentCraftingWindow = GetCraftSkillLine(n)` - -**Parameters:** -- `n` - - *number* - Not sure how this is used, but any number greater than zero seems to behave identically. Passing zero always results in a nil return value. - -**Returns:** -- `currentCraftingWindow` - - *string* - The name of the currently opened crafting window, or nil if no crafting window is open. This will be one of "Enchanting" or "Beast Training". - -**Description:** -This function is not quite the same as `GetCraftDisplaySkillLine()`. The latter returns nil in case the Beast Training window is open, while the current function returns "Beast Training". \ No newline at end of file diff --git a/wiki-information/functions/GetCraftSpellFocus.md b/wiki-information/functions/GetCraftSpellFocus.md deleted file mode 100644 index 1e756f6a..00000000 --- a/wiki-information/functions/GetCraftSpellFocus.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetCraftSpellFocus - -**Content:** -`catalystName, number1 = GetCraftSpellFocus(index)` - -**Parameters:** -- `index` - - *number* - 1 to GetNumCrafts() - -**Returns:** -When called while the enchanting screen is open, this function returns which rod is required, if any. I don't know whether this function also applies to other types of crafts or spells. -Returns two values when a rod is required: a string that contains the name of the rod, and the number "1". I don't know what the "1" means. -Returns nil if no rods are required. \ No newline at end of file diff --git a/wiki-information/functions/GetCritChance.md b/wiki-information/functions/GetCritChance.md deleted file mode 100644 index 09cde630..00000000 --- a/wiki-information/functions/GetCritChance.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetCritChance - -**Content:** -Returns the melee critical hit chance percentage. -`critChance = GetCritChance()` - -**Returns:** -- `critChance` - - *number* - The player's melee critical hit chance, as a percentage; e.g. 5.3783211 corresponding to a ~5.38% crit chance. - -**Reference:** -- `GetBlockChance` -- `GetDodgeChance` -- `GetParryChance` -- `GetCombatRating` -- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyInfo.md b/wiki-information/functions/GetCurrencyInfo.md deleted file mode 100644 index ab9800ef..00000000 --- a/wiki-information/functions/GetCurrencyInfo.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetCurrencyInfo - -**Content:** -Retrieve Information about a currency at index including its amount. -`name, currentAmount, texture, earnedThisWeek, weeklyMax, totalMax, isDiscovered, rarity = GetCurrencyInfo(id or "currencyLink" or "currencyString")` - -**Parameters:** -One of the following three ways to specify which currency to query: -- `id` - - *Integer* - CurrencyID -- `currencyLink` - - *String* - The full currencyLink as found with `GetCurrencyLink()` or `GetCurrencyListLink()`. -- `currencyString` - - *String* - A fragment of the currencyLink string for the item, e.g. `"currency:396"` for Valor Points. - -**Returns:** -- `name` - - *String* - the name of the currency, localized to the language -- `amount` - - *Number* - Current amount of the currency at index -- `texture` - - *String* - The file name of the currency's icon. -- `earnedThisWeek` - - *Number* - The amount of the currency earned this week -- `weeklyMax` - - *Number* - Maximum amount of currency possible to be earned this week -- `totalMax` - - *Number* - Total maximum currency possible to stockpile -- `isDiscovered` - - *Boolean* - Whether the character has ever got some of this currency -- `rarity` - - *Integer* - Rarity indicator for this currency - -**External Resources:** -[Wowhead](https://www.wowhead.com) \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyLink.md b/wiki-information/functions/GetCurrencyLink.md deleted file mode 100644 index 9299f560..00000000 --- a/wiki-information/functions/GetCurrencyLink.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetCurrencyLink - -**Content:** -Get the currencyLink for the specified currencyID. -`currencyLink = GetCurrencyLink(currencyID, currencyAmount)` - -**Parameters:** -- `currencyID` - - *Integer* - currency index - see table at GetCurrencyInfo for a list -- `currencyAmount` - - *Integer* - currency amount - -**Returns:** -- `currencyLink` - - *String* - The currency link (similar to itemLink) for the specified index (e.g. `"|cffa335ee|Hcurrency:396:0|h|h|r"` for Valor Points) or nil if the index is for a header. - -**Reference:** -- `GetCurrencyListLink` (for currencies visible in the currency tab) \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyListInfo.md b/wiki-information/functions/GetCurrencyListInfo.md deleted file mode 100644 index 47e65c16..00000000 --- a/wiki-information/functions/GetCurrencyListInfo.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: GetCurrencyListInfo - -**Content:** -Returns information about an entry in the currency list. -`name, isHeader, isExpanded, isUnused, isWatched, count, icon, maximum, hasWeeklyLimit, currentWeeklyAmount, unknown, itemID = GetCurrencyListInfo(index)` - -**Parameters:** -- `id` - - *Number* - index, ascending from 1 to `GetCurrencyListSize()`. - -**Returns:** -- `name` - - *String* - localized currency (or currency header) name. -- `isHeader` - - *Boolean* - true if this entry is a header, false otherwise. -- `isExpanded` - - *Boolean* - true if this entry is an expanded header, false otherwise. -- `isUnused` - - *Boolean* - true if this entry is a currency marked as unused, false otherwise. -- `isWatched` - - *Boolean* - true if this entry is a currency currently displayed on the backpack, false otherwise. -- `count` - - *Number* - amount of this currency in the player's possession (0 for headers). -- `icon` - - *String* - path to the icon texture for item-based currencies, invalid for arena/honor points. -- `maximum` - - *Number* - 0 if this currency has no limit, otherwise integer value with 2 extra zeros (e.g. 400000 = 4000.00 as in Justice Points and Honor Points). -- `hasWeeklyLimit` - - *Number* - 1 if this currency has a weekly limit (Valor Points), nil otherwise. -- `currentWeeklyAmount` - - *Number* - amount of this currency obtained for the current week, nil otherwise. -- `unknown` - - *unknown* - possible deprecated slot for itemID? All known cases return nil. -- `itemID` - - *Number* - item ID corresponding to this item-based currency, invalid for arena/honor points. - -**Notes and Caveats:** -- Information about currencies under collapsed headers is available; it is up to the UI code to respect the `isExpanded` flag. -- Indices are generally based on localized alphabetic order. -- The headers "contain" all currencies with index greater than theirs until the next header. This is not a nested structure. -- Marking a currency as unused alters its index, as the currency is moved down the list to fit under an "Unused" header. \ No newline at end of file diff --git a/wiki-information/functions/GetCurrencyListSize.md b/wiki-information/functions/GetCurrencyListSize.md deleted file mode 100644 index ef332c46..00000000 --- a/wiki-information/functions/GetCurrencyListSize.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetCurrencyListSize - -**Content:** -Returns the number of entries in the currency list. -`listSize = GetCurrencyListSize();` - -**Returns:** -- `listSize` - - *Number* - number of entries in the player's currency list. - -**Reference:** -- `GetCurrencyListInfo` -- `GetCurrencyListLink` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentBindingSet.md b/wiki-information/functions/GetCurrentBindingSet.md deleted file mode 100644 index 58c1f29f..00000000 --- a/wiki-information/functions/GetCurrentBindingSet.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetCurrentBindingSet - -**Content:** -Returns if either account or character-specific bindings are active. -`which = GetCurrentBindingSet()` - -**Returns:** -- `which` - - *number* - One of the following values: - - `ACCOUNT_BINDINGS = 1` - - indicates that account-wide bindings are currently active. - - `CHARACTER_BINDINGS = 2` - - indicates that per-character bindings are currently active. - -**Description:** -The return value of this function depends on the last call to `SaveBindings`. \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentCombatTextEventInfo.md b/wiki-information/functions/GetCurrentCombatTextEventInfo.md deleted file mode 100644 index b7d3b531..00000000 --- a/wiki-information/functions/GetCurrentCombatTextEventInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetCurrentCombatTextEventInfo - -**Content:** -Returns the current COMBAT_TEXT_UPDATE payload. -`desc1, desc2 = GetCurrentCombatTextEventInfo()` - -**Returns:** -- `desc1` - - *any* - This field varies depending on the type of message. -- `desc2` - - *any* - This field varies depending on the type of message. \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentEventID.md b/wiki-information/functions/GetCurrentEventID.md deleted file mode 100644 index 076aa1dc..00000000 --- a/wiki-information/functions/GetCurrentEventID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetCurrentEventID - -**Content:** -Needs summary. -`eventID = GetCurrentEventID()` - -**Returns:** -- `eventID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentGraphicsAPI.md b/wiki-information/functions/GetCurrentGraphicsAPI.md deleted file mode 100644 index 7c266e8e..00000000 --- a/wiki-information/functions/GetCurrentGraphicsAPI.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetCurrentGraphicsAPI - -**Content:** -Returns the currently selected graphics API. -`gxAPI = GetCurrentGraphicsAPI()` - -**Returns:** -- `graphicsAPI` - - `gxAPI` - Can be any of; D3D12, D3D11, D3D11_LEGACY, gll or opengl - -**Reference:** -CVar `gxApi` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentRegion.md b/wiki-information/functions/GetCurrentRegion.md deleted file mode 100644 index 51f50951..00000000 --- a/wiki-information/functions/GetCurrentRegion.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: GetCurrentRegion - -**Content:** -Returns a numeric ID representing the region the player is currently logged into. -`regionID = GetCurrentRegion()` - -**Returns:** -The following region IDs are known: -- `ID` - - `Description` -- `1` - - US (includes Brazil and Oceania) -- `2` - - Korea -- `3` - - Europe (includes Russia) -- `4` - - Taiwan (see Details) -- `5` - - China - -**Description:** -The value returned is deduced from the portal console variable, which may be set by the game client at launch to match the selected account region in the Battle.net desktop application. It does not necessarily indicate the region of the realm that the player is logged into, but instead the region of the Battle.net portal used to contact the login servers and provide a realm list. -This function is mostly reliable except in the case where the user modifies the portal from the login screen after having launched the game client through the Battle.net desktop application. The game client will prefer to use the login server addresses specified by the desktop application over the portal, causing a mismatch between the logged in region and what this function will report. -Realms located in Taiwan use the Korean Battle.net portal, meaning this function will typically always report the current region as being Korea rather than Taiwan when connected to these realms. Other functions like `C_BattleNet.GetFriendAccountInfo` may however return region IDs that correctly identify Taiwanese realms. - -**Notes and Caveats:** -The following snippet demonstrates use of this API in conjunction with `C_BattleNet.GetGameAccountInfoByGUID` to more reliably obtain the current region ID of the player. -```lua -local function GetActualRegion() - local gameAccountInfo = C_BattleNet.GetGameAccountInfoByGUID(UnitGUID("player")) - return gameAccountInfo and gameAccountInfo.regionID or GetCurrentRegion() -end -print(GetActualRegion()) -``` - -**Reference:** -`GetCurrentRegionName` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentRegionName.md b/wiki-information/functions/GetCurrentRegionName.md deleted file mode 100644 index e1bbae1c..00000000 --- a/wiki-information/functions/GetCurrentRegionName.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetCurrentRegionName - -**Content:** -Returns the name of the current region. -`regionName = GetCurrentRegionName()` - -**Returns:** -- `regionName` - - *string* - -**Description:** -Refer to `GetCurrentRegion` for information on what region names this function can return, as well as details on quirks these two functions share. - -**Reference:** -- `GetCurrentRegion` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentResolution.md b/wiki-information/functions/GetCurrentResolution.md deleted file mode 100644 index bbc7b9a6..00000000 --- a/wiki-information/functions/GetCurrentResolution.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetCurrentResolution - -**Content:** -Returns the index of the current screen resolution. -`index = GetCurrentResolution()` - -**Parameters:** -- Nothing - -**Returns:** -- `index` - - *number* - This value will be the index of one of the values yielded by `GetScreenResolutions()` - -**Usage:** -```lua -message('The current screen resolution is ' .. ({GetScreenResolutions()})[GetCurrentResolution()]) -``` -Output: -``` -The current screen resolution is 1024x768 -``` \ No newline at end of file diff --git a/wiki-information/functions/GetCurrentTitle.md b/wiki-information/functions/GetCurrentTitle.md deleted file mode 100644 index 366808da..00000000 --- a/wiki-information/functions/GetCurrentTitle.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetCurrentTitle - -**Content:** -Returns the current title. -`currentTitle = GetCurrentTitle()` - -**Returns:** -- `currentTitle` - - *number* - TitleId; Returns -1 if not using any title. \ No newline at end of file diff --git a/wiki-information/functions/GetCursorDelta.md b/wiki-information/functions/GetCursorDelta.md deleted file mode 100644 index 134d4c47..00000000 --- a/wiki-information/functions/GetCursorDelta.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetCursorDelta - -**Content:** -Returns the distance that the cursor has moved since the last frame. -`x, y = GetCursorDelta()` - -**Returns:** -- `x` - - *number* - Distance along the X axis that the cursor has travelled. -- `y` - - *number* - Distance along the Y axis that the cursor has travelled. - -**Description:** -If the cursor hasn't moved between two frames, this function will return zeroes. -Values returned by this function are independent of UI scaling. The `GetScaledCursorDelta` utility function can be used to apply the effective scale of `UIParent` to the returned values. \ No newline at end of file diff --git a/wiki-information/functions/GetCursorInfo.md b/wiki-information/functions/GetCursorInfo.md deleted file mode 100644 index ff19b9bc..00000000 --- a/wiki-information/functions/GetCursorInfo.md +++ /dev/null @@ -1,49 +0,0 @@ -## Title: GetCursorInfo - -**Content:** -Returns what the mouse cursor is holding. -`infoType, ... = GetCursorInfo()` - -**Returns:** -The first return value is a string indicating the nature of an object on the cursor; additional return values provide detail. The following return value combinations have been observed: -- `"item"`, `itemID`, `itemLink` - - `itemID` : *number* - Item ID of the item on the cursor. - - `itemLink` : *string* - ItemLink of the item on the cursor. -- `"spell"`, `spellIndex`, `bookType`, `spellID` - - `spellIndex` : *number* - The index of the spell in the spell book. - - `bookType` : *string* - Always BOOKTYPE_SPELL (or else the type would have been "petaction"). - - `spellID` : *number* - Spell ID of the spell on the cursor. -- `"petaction"`, `spellID`, `spellIndex`, `retVal3` - - `spellID` : *number* - Spell ID of the pet action on the cursor, or unknown 0-4 number if the spell is a shared pet control spell (Follow, Stay, Assist, Defensive, etc...). - - `spellIndex` : *number* - The index of the spell in the pet spell book, or nil if the spell is a shared pet control spell (Follow, Stay, Assist, Defensive, etc...). - - `retVal3` : Needs summary. -- `"macro"`, `index` - - `index` : *number* - The index of the macro on the cursor. -- `"money"`, `amount` - - `amount` : *number* - The amount of money in copper. -- `"mount"`, `mountID`, `mountIndex` - - `mountID` : *number* - The ID of the mount. - - `mountIndex` : *number* - The index of the mount in the journal. -- `"merchant"`, `index` - - `index` : *number* - The index of the merchant item. -- `"battlepet"`, `petGUID` - - `petGUID` : *string* - GUID of a battle pet in your collection. - -**Description:** -Related Events: -- `CURSOR_UPDATE` -- `CURSOR_CHANGED` - -Related API: -- `GetCursorPosition` - -**Usage:** -The following snippet, if you're holding an item, prints out the amount of that item in your bags. -```lua -local infoType, itemID, itemLink = GetCursorInfo() -if infoType == "item" then - print("You have " .. GetItemCount(itemLink) .. "x" .. itemLink .. " in your bags.") -else - print("You're not holding an item on your cursor.") -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetCursorMoney.md b/wiki-information/functions/GetCursorMoney.md deleted file mode 100644 index 910f761d..00000000 --- a/wiki-information/functions/GetCursorMoney.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetCursorMoney - -**Content:** -Returns the amount of money held by the cursor. -`copper = GetCursorMoney()` - -**Returns:** -- `copper` - - *number* - Amount of money, in copper, currently held on the cursor. \ No newline at end of file diff --git a/wiki-information/functions/GetCursorPosition.md b/wiki-information/functions/GetCursorPosition.md deleted file mode 100644 index 5ca46265..00000000 --- a/wiki-information/functions/GetCursorPosition.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetCursorPosition - -**Content:** -Returns the cursor's position on the screen. -`x, y = GetCursorPosition()` - -**Returns:** -- `x` - - *number* - x coordinate unaffected by UI scale; 0 at the left edge of the screen. -- `y` - - *number* - y coordinate unaffected by UI scale; 0 at the bottom edge of the screen. - -**Description:** -Returns scale-independent coordinates similar to `Cursor:GetCenter()` if 'Cursor' was a valid frame not affected by scaling. -Assuming `UIParent` spans the entire screen, you can convert these coordinates to `UIParent` offsets by dividing by its effective scale. The following snippet positions a small texture at the cursor's location. - -```lua -local uiScale, x, y = UIParent:GetEffectiveScale(), GetCursorPosition() -local tex = UIParent:CreateTexture() -tex:SetTexture(1,1,1) -tex:SetSize(4,4) -tex:SetPoint("CENTER", nil, "BOTTOMLEFT", x / uiScale, y / uiScale) -``` - -**Example Usage:** -This function is often used in addons that need to track the cursor's position for custom UI elements or interactions. For instance, an addon that creates custom tooltips or context menus at the cursor's location would use `GetCursorPosition` to determine where to display these elements. - -**Addons Using This Function:** -Many large addons, such as ElvUI and WeakAuras, utilize `GetCursorPosition` to enhance user interaction by dynamically positioning UI elements relative to the cursor. For example, WeakAuras might use it to display configuration options or visual effects at the cursor's location during setup. \ No newline at end of file diff --git a/wiki-information/functions/GetDeathRecapLink.md b/wiki-information/functions/GetDeathRecapLink.md deleted file mode 100644 index 42616089..00000000 --- a/wiki-information/functions/GetDeathRecapLink.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetDeathRecapLink - -**Content:** -Returns a chat link for a specific death. -`recapLink = GetDeathRecapLink(recapID)` - -**Parameters:** -- `recapID` - - *number* - The specific death to view, from 1 to the most recent death. - -**Returns:** -- `events` - - *string* - deathLink - -**Reference:** -- `DeathRecap_HasEvents` -- `DeathRecap_GetEvents` \ No newline at end of file diff --git a/wiki-information/functions/GetDefaultLanguage.md b/wiki-information/functions/GetDefaultLanguage.md deleted file mode 100644 index 2ecef452..00000000 --- a/wiki-information/functions/GetDefaultLanguage.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetDefaultLanguage - -**Content:** -Returns the character's default language. -`language, languageID = GetDefaultLanguage()` - -**Returns:** -- `language` - - *string* - The player's default language, usually the faction's common language (i.e. "Common" and "Orcish"). -- `languageID` - - *number* - LanguageID - -**Usage:** -`/dump GetDefaultLanguage()` -> "Common", 7 \ No newline at end of file diff --git a/wiki-information/functions/GetDefaultScale.md b/wiki-information/functions/GetDefaultScale.md deleted file mode 100644 index 2a11e1cb..00000000 --- a/wiki-information/functions/GetDefaultScale.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetDefaultScale - -**Content:** -Returns the default UI scaling value for the current screen size. -`scale = GetDefaultScale()` - -**Returns:** -- `scale` - - *number* - The default scale for the UI as a floating point value. - -**Usage:** -The below example creates an unparented frame that will always render at a size of 300x300 pixels. The scale of the frame is managed through the inherited DefaultScaleFrame template, which internally uses this API to apply the correct scale to the frame if the screen size changes. -```lua -UnscaledFrame = CreateFrame("Frame", nil, nil, "BackdropTemplate, DefaultScaleFrame") -UnscaledFrame:SetPoint("CENTER") -UnscaledFrame:SetSize(300, 300) -UnscaledFrame:SetBackdrop({ bgFile = "" }) -``` \ No newline at end of file diff --git a/wiki-information/functions/GetDetailedItemLevelInfo.md b/wiki-information/functions/GetDetailedItemLevelInfo.md deleted file mode 100644 index 399af901..00000000 --- a/wiki-information/functions/GetDetailedItemLevelInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetDetailedItemLevelInfo - -**Content:** -Returns detailed item level info. -`effectiveILvl, isPreview, baseILvl = GetDetailedItemLevelInfo(itemID or itemString or itemName or itemLink)` - -**Parameters:** -One of the following four ways to specify which item to query: -- `itemId` - - *number* - Numeric ID of the item. e.g. 30234 for -- `itemName` - - *string* - Name of an item owned by the player at some point during this play session, e.g. "Nordrassil Wrath-Kilt". -- `itemString` - - *string* - A fragment of the itemString for the item, e.g. "item:30234:0:0:0:0:0:0:0" or "item:30234". -- `itemLink` - - *string* - The full itemLink. - -**Returns:** -- `effectiveILvl` - - *number* - same as in tooltip. -- `isPreview` - - *boolean* - True means it would have a + in the tooltip, a minimal level for item used in loot preview in encounter journal -- `baseILvl` - - *number* - base item level - -**Description:** -- `effectiveLevel`: - - matches all the upgrades (WF/TF) applied to item - - does not show scaling down in timewalking instances - i.e. matches number in parenthesis in tooltip - - does not show correct item level for artifact off-hand items - it always stays as 750 instead of matching main hand \ No newline at end of file diff --git a/wiki-information/functions/GetDifficultyInfo.md b/wiki-information/functions/GetDifficultyInfo.md deleted file mode 100644 index 9212d8ac..00000000 --- a/wiki-information/functions/GetDifficultyInfo.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetDifficultyInfo - -**Content:** -Returns information about a difficulty. -`name, groupType, isHeroic, isChallengeMode, displayHeroic, displayMythic, toggleDifficultyID, isLFR, minPlayers, maxPlayers = GetDifficultyInfo(id)` - -**Parameters:** -- `id` - - *number* - difficulty ID to query, ascending from 1. - -**Returns:** -- `name` - - *string* - Difficulty name, e.g. "10 Player (Heroic)" -- `groupType` - - *string* - Group type appropriate for this difficulty; "party" or "raid". -- `isHeroic` - - *boolean* - true if this is a heroic difficulty, false otherwise. -- `isChallengeMode` - - *boolean* - true if this is challenge mode difficulty, false otherwise. -- `displayHeroic` - - *boolean* - display the Heroic skull icon on the instance banner of the minimap -- `displayMythic` - - *boolean* - display the Mythic skull icon on the instance banner of the minimap -- `toggleDifficultyID` - - *number* - difficulty ID of the corresponding heroic/non-heroic difficulty for 10/25-man raids, if one exists. -- `isLFR` - - *boolean* - true if this is looking for raid difficulty, false otherwise. -- `minPlayers` - - *number* - minimum players needed. -- `maxPlayers` - - *number* - maximum players allowed. - -**Reference:** -- `DifficultyID` (a list of possible difficultyIDs) -- `SetDungeonDifficultyID` -- `GetInstanceInfo` -- `GetRaidDifficultyID` \ No newline at end of file diff --git a/wiki-information/functions/GetDodgeChance.md b/wiki-information/functions/GetDodgeChance.md deleted file mode 100644 index 6edd08d7..00000000 --- a/wiki-information/functions/GetDodgeChance.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetDodgeChance - -**Content:** -Returns the dodge chance percentage. -`dodgeChance = GetDodgeChance()` - -**Returns:** -- `dodgeChance` - - *number* - Player's dodge chance in percentage. - -**Reference:** -- `GetBlockChance` -- `GetCritChance` -- `GetParryChance` -- `GetCombatRating` -- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetDodgeChanceFromAttribute.md b/wiki-information/functions/GetDodgeChanceFromAttribute.md deleted file mode 100644 index 51c7eb20..00000000 --- a/wiki-information/functions/GetDodgeChanceFromAttribute.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetDodgeChanceFromAttribute - -**Content:** -Needs summary. -`dodgeChance = GetDodgeChanceFromAttribute()` - -**Returns:** -- `dodgeChance` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetDownloadedPercentage.md b/wiki-information/functions/GetDownloadedPercentage.md deleted file mode 100644 index 5fc98680..00000000 --- a/wiki-information/functions/GetDownloadedPercentage.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetDownloadedPercentage - -**Content:** -Needs summary. -`result = GetDownloadedPercentage()` - -**Returns:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetDungeonDifficultyID.md b/wiki-information/functions/GetDungeonDifficultyID.md deleted file mode 100644 index fdc0a195..00000000 --- a/wiki-information/functions/GetDungeonDifficultyID.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetDungeonDifficultyID - -**Content:** -Returns the selected dungeon difficulty. -`difficultyID = GetDungeonDifficultyID()` - -**Returns:** -- `difficultyID` - - *number* : The player's (or group leader's) current dungeon difficulty ID preference. - -**Reference:** -- [DifficultyID](https://wowpedia.fandom.com/wiki/DifficultyID) (a list of possible difficultyIDs) -- [GetDifficultyInfo](https://wowpedia.fandom.com/wiki/API_GetDifficultyInfo) -- [SetDungeonDifficultyID](https://wowpedia.fandom.com/wiki/API_SetDungeonDifficultyID) -- [GetRaidDifficultyID](https://wowpedia.fandom.com/wiki/API_GetRaidDifficultyID) \ No newline at end of file diff --git a/wiki-information/functions/GetEditBoxMetatable.md b/wiki-information/functions/GetEditBoxMetatable.md deleted file mode 100644 index bd8302b6..00000000 --- a/wiki-information/functions/GetEditBoxMetatable.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetEditBoxMetatable - -**Content:** -Returns the metatable used by EditBox objects. -`metatable = GetEditBoxMetatable()` - -**Returns:** -- `metatable` - - *table* - The metatable used by EditBox objects. - -**Description:** -The metatable returned by this function is shared between all non-forbidden EditBox object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetEventTime.md b/wiki-information/functions/GetEventTime.md deleted file mode 100644 index b458218d..00000000 --- a/wiki-information/functions/GetEventTime.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetEventTime - -**Content:** -Needs summary. -`totalElapsedTime, numExecutedHandlers, slowestHandlerName, slowestHandlerTime = GetEventTime(eventProfileIndex)` - -**Parameters:** -- `eventProfileIndex` - - *number* - -**Returns:** -- `totalElapsedTime` - - *number* -- `numExecutedHandlers` - - *number* -- `slowestHandlerName` - - *string* -- `slowestHandlerTime` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetExpansionDisplayInfo.md b/wiki-information/functions/GetExpansionDisplayInfo.md deleted file mode 100644 index db29755c..00000000 --- a/wiki-information/functions/GetExpansionDisplayInfo.md +++ /dev/null @@ -1,64 +0,0 @@ -## Title: GetExpansionDisplayInfo - -**Content:** -Returns the logo and banner textures for an expansion id. -`info = GetExpansionDisplayInfo(expansionLevel)` - -**Parameters:** -- `expansionLevel` - - *number* - - `NUM_LE_EXPANSION_LEVELS` - - **Value** - - **Enum** - - **Description** - - `LE_EXPANSION_LEVEL_CURRENT` - - 0 - - `LE_EXPANSION_CLASSIC` - - Vanilla / Classic Era - - `LE_EXPANSION_BURNING_CRUSADE` - - The Burning Crusade - - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` - - Wrath of the Lich King - - `LE_EXPANSION_CATACLYSM` - - Cataclysm - - `LE_EXPANSION_MISTS_OF_PANDARIA` - - Mists of Pandaria - - `LE_EXPANSION_WARLORDS_OF_DRAENOR` - - Warlords of Draenor - - `LE_EXPANSION_LEGION` - - Legion - - `LE_EXPANSION_BATTLE_FOR_AZEROTH` - - Battle for Azeroth - - `LE_EXPANSION_SHADOWLANDS` - - Shadowlands - - `LE_EXPANSION_DRAGONFLIGHT` - - Dragonflight - - `LE_EXPANSION_11_0` - -**Returns:** -- `info` - - *ExpansionDisplayInfo?* - - **Field** - - **Type** - - **Description** - - `logo` - - *number* - - `banner` - - *string* - - `features` - - *ExpansionDisplayInfoFeature* - - `highResBackgroundID` - - *number* - - Added in 10.0.0 - - `lowResBackgroundID` - - *number* - - Added in 10.0.0 - -**ExpansionDisplayInfoFeature:** -- **Field** -- **Type** -- **Description** -- `icon` - - *number* -- `text` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/GetExpansionLevel.md b/wiki-information/functions/GetExpansionLevel.md deleted file mode 100644 index 0d56e589..00000000 --- a/wiki-information/functions/GetExpansionLevel.md +++ /dev/null @@ -1,53 +0,0 @@ -## Title: GetExpansionLevel - -**Content:** -Returns the expansion level currently accessible by the player. -`expansionLevel = GetExpansionLevel()` - -**Returns:** -- `expansionLevel` - - *number* - The newest expansion currently accessible by the player. - - `NUM_LE_EXPANSION_LEVELS` - - `Value` - - `Enum` - - `Description` - - `LE_EXPANSION_LEVEL_CURRENT` - - 0 - - `LE_EXPANSION_CLASSIC` - - Vanilla / Classic Era - - `LE_EXPANSION_BURNING_CRUSADE` - - The Burning Crusade - - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` - - Wrath of the Lich King - - `LE_EXPANSION_CATACLYSM` - - Cataclysm - - `LE_EXPANSION_MISTS_OF_PANDARIA` - - Mists of Pandaria - - `LE_EXPANSION_WARLORDS_OF_DRAENOR` - - Warlords of Draenor - - `LE_EXPANSION_LEGION` - - Legion - - `LE_EXPANSION_BATTLE_FOR_AZEROTH` - - Battle for Azeroth - - `LE_EXPANSION_SHADOWLANDS` - - Shadowlands - - `LE_EXPANSION_DRAGONFLIGHT` - - Dragonflight - - `LE_EXPANSION_11_0` - - The War Within - -**Description:** -Trial/Starter accounts are automatically upgraded to the second to last expansion. -Updated after `UPDATE_EXPANSION_LEVEL` fires. - -**Usage:** -Before and after the Shadowlands global launch on November 23, 2020, at 3:00 p.m. PST. Requires the player to have pre-ordered/purchased the expansion. -```lua -/dump GetExpansionLevel() -- 7 -> 8 -/dump GetAccountExpansionLevel() -- 8 -/dump GetServerExpansionLevel() -- 7 -> 8 -``` -This API is equivalent to: -```lua -GetExpansionLevel() == min(GetAccountExpansionLevel(), GetServerExpansionLevel()) -``` \ No newline at end of file diff --git a/wiki-information/functions/GetExpansionTrialInfo.md b/wiki-information/functions/GetExpansionTrialInfo.md deleted file mode 100644 index 6b906c92..00000000 --- a/wiki-information/functions/GetExpansionTrialInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetExpansionTrialInfo - -**Content:** -Needs summary. -`isExpansionTrialAccount, expansionTrialRemainingSeconds = GetExpansionTrialInfo()` - -**Returns:** -- `isExpansionTrialAccount` - - *boolean* -- `expansionTrialRemainingSeconds` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetExpertise.md b/wiki-information/functions/GetExpertise.md deleted file mode 100644 index 4f6ab0b3..00000000 --- a/wiki-information/functions/GetExpertise.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetExpertise - -**Content:** -Returns the player's expertise percentage for main hand, offhand, and ranged attacks. -`mainhandExpertise, offhandExpertise, rangedExpertise = GetExpertise()` - -**Returns:** -- `mainhandExpertise` - - *number* - Expertise percentage for swings with your main hand weapon. -- `offhandExpertise` - - *number* - Expertise percentage for swings with your offhand weapon. -- `rangedExpertise` - - *number* - Expertise percentage for your ranged weapon. - -**Description:** -Expertise reduces the chance that the player's attacks are dodged or parried by an enemy. This function returns the amount of percentage points Expertise reduces the dodge/parry chance by (e.g. a return value of 3.5 means a 3.5% reduction to both dodge and parry probabilities). - -**Reference:** -`GetCombatRating(CR_EXPERTISE)` \ No newline at end of file diff --git a/wiki-information/functions/GetExpertisePercent.md b/wiki-information/functions/GetExpertisePercent.md deleted file mode 100644 index 9347c2f9..00000000 --- a/wiki-information/functions/GetExpertisePercent.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetExpertisePercent - -**Content:** -Returns your current expertise reduction to chance to be dodged or parried, in percent. -`expertisePercent, offhandExpertisePercent = GetExpertisePercent()` - -**Returns:** -- `expertisePercent` - - *number* - Percentage reduction in dodge and parry chances for swings with your main hand weapon. -- `offhandExpertisePercent` - - *number* - Percentage reduction in dodge and parry chances for swings with your offhand weapon. - -**Reference:** -- `GetExpertise()` \ No newline at end of file diff --git a/wiki-information/functions/GetFactionInfo.md b/wiki-information/functions/GetFactionInfo.md deleted file mode 100644 index abebb777..00000000 --- a/wiki-information/functions/GetFactionInfo.md +++ /dev/null @@ -1,104 +0,0 @@ -## Title: GetFactionInfo - -**Content:** -Returns info for a faction. -```lua -name, description, standingID, barMin, barMax, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus -= GetFactionInfo(factionIndex) -= GetFactionInfoByID(factionID) -``` - -**Parameters:** -- **GetFactionInfo:** - - `factionIndex` - - *number* - Index from the currently displayed row in the player's reputation pane, including headers but excluding factions that are hidden because their parent header is collapsed. - -- **GetFactionInfoByID:** - - `factionID` - - *number* - FactionID - -**Returns:** -1. `name` - - *string* - Name of the faction -2. `description` - - *string* - Description as shown in the detail pane that appears when you click on the faction row -3. `standingID` - - *number* - StandingId representing the current standing (e.g., 4 for Neutral, 5 for Friendly). -4. `barMin` - - *number* - Minimum reputation since beginning of Neutral to reach the current standing. -5. `barMax` - - *number* - Maximum reputation since the beginning of Neutral before graduating to the next standing. -6. `barValue` - - *number* - Total reputation earned with the faction versus 0 at the beginning of Neutral. -7. `atWarWith` - - *boolean* - True if the player is at war with the faction -8. `canToggleAtWar` - - *boolean* - True if the player can toggle the "At War" checkbox -9. `isHeader` - - *boolean* - True if the faction is a header (collapsible group title) -10. `isCollapsed` - - *boolean* - True if the faction is a header and is currently collapsed -11. `hasRep` - - *boolean* - True if the faction is a header and has its own reputation (e.g., The Tillers) -12. `isWatched` - - *boolean* - True if the "Show as Experience Bar" checkbox for the faction is currently checked -13. `isChild` - - *boolean* - True if the faction is a second-level header (e.g., Sholazar Basin) or is the child of a second-level header (e.g., The Oracles) -14. `factionID` - - *number* - Unique FactionID. -15. `hasBonusRepGain` - - *boolean* - True if the player has purchased a Grand Commendation to unlock bonus reputation gains with this faction -16. `canSetInactive` - - *boolean* - -**Description:** -- **Headers:** - - Top-level headers (e.g., Cataclysm or Classic) return values for standingID, barMin, and barMax as if the player were at 0/3000 Neutral with a faction (4, 0, and 3000 respectively) except for the Inactive header, which returns values of 0. - - Other headers that do not have their own reputation (e.g., Sholazar Basin or Steamwheedle Cartel) return values for their child faction with which the player has the highest reputation. For example, if the player is 999/1000 Exalted with Booty Bay, 2900/21000 Revered with Everlook, 5300/12000 Honored with Gadgetzan, and 10/6000 Friendly with Ratchet, querying the Steamwheedle Cartel header will return the standingId, barMin, and barMax values for Booty Bay. - -- **Total Reputation:** - - Within the game, reputation is shown as a formatted value of XXXX/YYYYY (e.g., 1234/12000) but outside of the reputation tab these values are not available directly. The game uses a flat value for reputation. - - The earnedValue returned by `GetFactionInfo()` is NOT the value on your reputation bars, but instead the distance your reputation has moved from 0 (1/3000 Neutral). All reputations given by the game are simply the number of reputation points from the 0 point, Neutral and above are positive reputations, anything below Neutral is a negative value and must be treated as such for any reputation calculations. - - - **Game Value Breakdown:** - - 1/3000 Neutral: Earned Value = 1 - - 1600/6000 Friendly: Earned Value = 4600 (3000 + 1600) - - 11000/12000 Honored: Earned Value = 20000 (3000 + 6000 + 11000) - - 1400/3000 Unfriendly: Earned Value = -1600 - - 2500/3000 Hostile: Earned Value = -3500 (-3000 + -500) - - - Notice that for negative reputation, the Earned value is how far below 0 your reputation is, not how far till Hated or Exalted. - -**Usage:** -Prints the name and total reputation earned for every faction currently displayed in the player's reputation pane: -```lua -for factionIndex = 1, GetNumFactions() do - local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, - isHeader, isCollapsed, hasRep, isWatched, isChild, factionID = GetFactionInfo(factionIndex) - if hasRep or not isHeader then - DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) - end -end -``` - -Prints the name and total reputation for all factions: -```lua -local numFactions = GetNumFactions() -local factionIndex = 1 -while (factionIndex <= numFactions) do - local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, - isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfo(factionIndex) - if isHeader and isCollapsed then - ExpandFactionHeader(factionIndex) - numFactions = GetNumFactions() - end - if hasRep or not isHeader then - DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) - end - factionIndex = factionIndex + 1 -end -``` - -**Reference:** -- `GetFriendshipReputation()` -- `GetFriendshipReputationRanks()` \ No newline at end of file diff --git a/wiki-information/functions/GetFactionInfoByID.md b/wiki-information/functions/GetFactionInfoByID.md deleted file mode 100644 index 1d80152f..00000000 --- a/wiki-information/functions/GetFactionInfoByID.md +++ /dev/null @@ -1,103 +0,0 @@ -## Title: GetFactionInfo - -**Content:** -Returns info for a faction. -```lua -name, description, standingID, barMin, barMax, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfo(factionIndex) -name, description, standingID, barMin, barMax, barValue, atWarWith, canToggleAtWar, isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfoByID(factionID) -``` - -**Parameters:** -- **GetFactionInfo:** - - `factionIndex` - - *number* - Index from the currently displayed row in the player's reputation pane, including headers but excluding factions that are hidden because their parent header is collapsed. - -- **GetFactionInfoByID:** - - `factionID` - - *number* - FactionID - -**Returns:** -1. `name` - - *string* - Name of the faction -2. `description` - - *string* - Description as shown in the detail pane that appears when you click on the faction row -3. `standingID` - - *number* - StandingId representing the current standing (e.g., 4 for Neutral, 5 for Friendly). -4. `barMin` - - *number* - Minimum reputation since beginning of Neutral to reach the current standing. -5. `barMax` - - *number* - Maximum reputation since the beginning of Neutral before graduating to the next standing. -6. `barValue` - - *number* - Total reputation earned with the faction versus 0 at the beginning of Neutral. -7. `atWarWith` - - *boolean* - True if the player is at war with the faction -8. `canToggleAtWar` - - *boolean* - True if the player can toggle the "At War" checkbox -9. `isHeader` - - *boolean* - True if the faction is a header (collapsible group title) -10. `isCollapsed` - - *boolean* - True if the faction is a header and is currently collapsed -11. `hasRep` - - *boolean* - True if the faction is a header and has its own reputation (e.g., The Tillers) -12. `isWatched` - - *boolean* - True if the "Show as Experience Bar" checkbox for the faction is currently checked -13. `isChild` - - *boolean* - True if the faction is a second-level header (e.g., Sholazar Basin) or is the child of a second-level header (e.g., The Oracles) -14. `factionID` - - *number* - Unique FactionID. -15. `hasBonusRepGain` - - *boolean* - True if the player has purchased a Grand Commendation to unlock bonus reputation gains with this faction -16. `canSetInactive` - - *boolean* - -**Description:** -- **Headers:** - - Top-level headers (e.g., Cataclysm or Classic) return values for standingID, barMin, and barMax as if the player were at 0/3000 Neutral with a faction (4, 0, and 3000 respectively) except for the Inactive header, which returns values of 0. - - Other headers that do not have their own reputation (e.g., Sholazar Basin or Steamwheedle Cartel) return values for their child faction with which the player has the highest reputation. For example, if the player is 999/1000 Exalted with Booty Bay, 2900/21000 Revered with Everlook, 5300/12000 Honored with Gadgetzan, and 10/6000 Friendly with Ratchet, querying the Steamwheedle Cartel header will return the standingId, barMin, and barMax values for Booty Bay. - -- **Total Reputation:** - - Within the game, reputation is shown as a formatted value of XXXX/YYYYY (e.g., 1234/12000) but outside of the reputation tab these values are not available directly. The game uses a flat value for reputation. - - The earnedValue returned by `GetFactionInfo()` is NOT the value on your reputation bars, but instead the distance your reputation has moved from 0 (1/3000 Neutral). All reputations given by the game are simply the number of reputation points from the 0 point, Neutral and above are positive reputations, anything below Neutral is a negative value and must be treated as such for any reputation calculations. - - - **Game Value Breakdown:** - - 1/3000 Neutral: 1 - - 1600/6000 Friendly: 4600 (3000 + 1600) - - 11000/12000 Honored: 20000 (3000 + 6000 + 11000) - - 1400/3000 Unfriendly: -1600 - - 2500/3000 Hostile: -3500 (3000 + -500) - - - Notice that for negative reputation, the Earned value is how far below 0 your reputation is, not how far till Hated or Exalted. - -**Usage:** -Prints the name and total reputation earned for every faction currently displayed in the player's reputation pane: -```lua -for factionIndex = 1, GetNumFactions() do - local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, - isHeader, isCollapsed, hasRep, isWatched, isChild, factionID = GetFactionInfo(factionIndex) - if hasRep or not isHeader then - DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) - end -end -``` - -Prints the name and total reputation for all factions: -```lua -local numFactions = GetNumFactions() -local factionIndex = 1 -while (factionIndex <= numFactions) do - local name, description, standingId, bottomValue, topValue, earnedValue, atWarWith, canToggleAtWar, - isHeader, isCollapsed, hasRep, isWatched, isChild, factionID, hasBonusRepGain, canBeLFGBonus = GetFactionInfo(factionIndex) - if isHeader and isCollapsed then - ExpandFactionHeader(factionIndex) - numFactions = GetNumFactions() - end - if hasRep or not isHeader then - DEFAULT_CHAT_FRAME:AddMessage("Faction: " .. name .. " - " .. earnedValue) - end - factionIndex = factionIndex + 1 -end -``` - -**Reference:** -- `GetFriendshipReputation()` -- `GetFriendshipReputationRanks()` \ No newline at end of file diff --git a/wiki-information/functions/GetFileIDFromPath.md b/wiki-information/functions/GetFileIDFromPath.md deleted file mode 100644 index 6b4933e7..00000000 --- a/wiki-information/functions/GetFileIDFromPath.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetFileIDFromPath - -**Content:** -Returns the FileID for an Interface file path. -`fileID = GetFileIDFromPath(filePath)` - -**Parameters:** -- `filePath` - - *string* - The path to a game file. For example `Interface/Icons/Temp.blp` - -**Returns:** -- `fileID` - - *number* : FileID - The internal ID corresponding to the file path. Negative integers are temporary IDs; these are not specified in the CASC root file and may change when the client is restarted. - -**Usage:** -- Interface/ path - ```lua - /dump GetFileIDFromPath("Interface/Icons/Temp") -- 136235 - ``` -- Custom file path - ```lua - /dump GetFileIDFromPath("Interface/testimg.jpg") -- -1163 - /dump GetFileIDFromPath("hello/test.jpg") -- -2 - ``` - -**Reference:** -- [#wowuidev 2019-04-23](https://infobot.rikers.org/%23wowuidev/20190423.html.gz) \ No newline at end of file diff --git a/wiki-information/functions/GetFileStreamingStatus.md b/wiki-information/functions/GetFileStreamingStatus.md deleted file mode 100644 index 8ff1b367..00000000 --- a/wiki-information/functions/GetFileStreamingStatus.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetFileStreamingStatus - -**Content:** -Needs summary. -`result = GetFileStreamingStatus()` - -**Returns:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetFirstBagBankSlotIndex.md b/wiki-information/functions/GetFirstBagBankSlotIndex.md deleted file mode 100644 index 7a2e4634..00000000 --- a/wiki-information/functions/GetFirstBagBankSlotIndex.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetFirstBagBankSlotIndex - -**Content:** -Returns the index of the first bag slot within the bank container. -`index = GetFirstBagBankSlotIndex()` - -**Returns:** -- `index` - - *number* - The slot index of the first bank bag. - -**Description:** -This function was added to resolve an inconsistency with the value of the `NUM_BANKGENERIC_SLOTS` constant and the actual slot index assigned to the first bank bag. On Classic Era, this constant is defined as 24 matching the number of displayed item slots in the bank frame, however, bag slots start at index 28 as they do on Burning Crusade Classic. \ No newline at end of file diff --git a/wiki-information/functions/GetFirstTradeSkill.md b/wiki-information/functions/GetFirstTradeSkill.md deleted file mode 100644 index e0154869..00000000 --- a/wiki-information/functions/GetFirstTradeSkill.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetFirstTradeSkill - -**Content:** -Returns the index of the first non-header trade skill entry. -`skillId = GetFirstTradeSkill()` - -**Parameters:** -- `()` - -**Returns:** -- `skillId` - - *number* - The ID of the first visible non-header trade skill entry. \ No newline at end of file diff --git a/wiki-information/functions/GetFontInfo.md b/wiki-information/functions/GetFontInfo.md deleted file mode 100644 index e6b1817b..00000000 --- a/wiki-information/functions/GetFontInfo.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: GetFontInfo - -**Content:** -Returns a structured table of information about the given font object. -`fontInfo = GetFontInfo(font)` - -**Parameters:** -- `font` - - *Font🔗|string* - Either a font object or the name of a global font object. - -**Returns:** -- `fontInfo` - - *FontInfo* - - `Field` - - `Type` - - `Description` - - `height` - - *number* - Height (size) of the font object - - `outline` - - *string* - Comma delimited list of font flags such as OUTLINE, THICKOUTLINE, and MONOCHROME - - `color` - - *ColorInfo* - Table of color values for the font object - - `shadow` - - *FontShadow?* - Optional table of shadow information for the font object - - `FontShadow` - - `Field` - - `Type` - - `Description` - - `x` - - *number* - Horizontal offset for the shadow - - `y` - - *number* - Vertical offset for the shadow - - `color` - - *ColorInfo* - Table of color values for the shadow - - `ColorInfo` - - `Field` - - `Type` - - `Description` - - `r` - - *number* - - `g` - - *number* - - `b` - - *number* - - `a` - - *number* - -**Description:** -If a font has no outline or monochrome flags applied, the outline field in the returned table will always be an empty string. - -**Reference:** -GetFonts \ No newline at end of file diff --git a/wiki-information/functions/GetFontStringMetatable.md b/wiki-information/functions/GetFontStringMetatable.md deleted file mode 100644 index 3fd922b4..00000000 --- a/wiki-information/functions/GetFontStringMetatable.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetFontStringMetatable - -**Content:** -Returns the metatable used by FontString objects. -`metatable = GetFontStringMetatable()` - -**Returns:** -- `metatable` - - *table* - The metatable used by FontString objects. - -**Description:** -The metatable returned by this function is shared between all non-forbidden FontString object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetFonts.md b/wiki-information/functions/GetFonts.md deleted file mode 100644 index b9b30ddb..00000000 --- a/wiki-information/functions/GetFonts.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetFonts - -**Content:** -Returns a list of available fonts. -`fonts = GetFonts()` - -**Returns:** -- `fonts` - - *string* - a table containing font object names. - -**Description:** -The names in the returned table may correspond to globally accessible font objects of the same name. -The names in the returned table can be used in conjunction with `GetFontInfo` to query font attributes such as sizing or coloring information. - -**Reference:** -- `GetFontInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetFrameCPUUsage.md b/wiki-information/functions/GetFrameCPUUsage.md deleted file mode 100644 index 7536159e..00000000 --- a/wiki-information/functions/GetFrameCPUUsage.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetFrameCPUUsage - -**Content:** -Returns the total time used by and number of calls of a frame's event handlers. -`time, count = GetFrameCPUUsage(frame)` - -**Parameters:** -- `frame` - - *Frame* - Specifies the frame. -- `includeChildren` - - *boolean* - If false, only event handlers of the specified frame are considered. If true or omitted, the values returned will include the handlers for all of the frame's children as well. - -**Returns:** -- `time` - - *number* - The total time used by the specified event handlers, in milliseconds. -- `count` - - *number* - The total number of times the event handlers were called. - -**Description:** -The values returned are just the sum of the values returned by `GetFunctionCPUUsage(handler)` for all current handlers. This means that it's not per-frame values, but per-function values. The difference is that if, for example, an `OnEvent` handler is used by two frames A and B, and, say, `B:OnEvent()` is called, both A and B get blamed for it. - -It also means that if a frame's handlers change, the CPU used by the previous handlers is ignored, because only the current handlers are considered. - -Note that `OnUpdate` CPU usage is NOT included at all (tested at 6.0.3). \ No newline at end of file diff --git a/wiki-information/functions/GetFrameMetatable.md b/wiki-information/functions/GetFrameMetatable.md deleted file mode 100644 index fb9ebcc1..00000000 --- a/wiki-information/functions/GetFrameMetatable.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetFrameMetatable - -**Content:** -Returns the metatable used by Frame objects. -`metatable = GetFrameMetatable()` - -**Returns:** -- `metatable` - - *table* - The metatable used by Frame objects. - -**Description:** -The metatable returned by this function is shared between all non-forbidden Frame object instances. \ No newline at end of file diff --git a/wiki-information/functions/GetFramerate.md b/wiki-information/functions/GetFramerate.md deleted file mode 100644 index ed0f2778..00000000 --- a/wiki-information/functions/GetFramerate.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetFramerate - -**Content:** -Returns the current framerate. -`framerate = GetFramerate()` - -**Returns:** -- `framerate` - - *number* - The current framerate in frames per second. - -**Usage:** -```lua -local framerate = GetFramerate() -print("Your current framerate is "..floor(framerate).." fps") -``` - -**Description:** -Notice the returned value adjusts slowly when the FPS quickly drops from 60 to 6, for example. If the FPS drops very fast, this function will be decreasing to 40, 20, 15, etc, for the next couple of seconds until it reaches 6. This delay means it is not as accurate as third-party FPS programs, but still functional. Alternatively, no delay is seen when the FPS is increased quickly. - -You can also toggle the Framerate Display with `ToggleFramerate` (normally the Ctrl-R hotkey). You can also see the same framerate in the tooltip of the GameMenu button on the main action bar. \ No newline at end of file diff --git a/wiki-information/functions/GetFramesRegisteredForEvent.md b/wiki-information/functions/GetFramesRegisteredForEvent.md deleted file mode 100644 index 514c6574..00000000 --- a/wiki-information/functions/GetFramesRegisteredForEvent.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetFramesRegisteredForEvent - -**Content:** -Returns all frames registered for the specified event, in dispatch order. -`frame1, frame2, ... = GetFramesRegisteredForEvent(event)` - -**Parameters:** -- `event` - - *string* - Event for which to return registered frames, e.g. "PLAYER_LOGOUT" - -**Returns:** -- `frame1, ...` - - *Widget* - widget registered for the specified event. - -**Description:** -The first frame returned will be the first to receive the given event, and likewise the last returned will receive the event last. A frame can be moved to the end of this event list order by unregistering and then reregistering for the event. -Currently, frames registered via `Frame:RegisterAllEvents` will be returned before all other frames, but they will actually receive events last (as they are used to profile the normal frames' handlers). This suggests that the above ordering is not always reliable. (Last checked 8.3.7) - -**Usage:** -The snippet below unregisters the PLAYER_LOGOUT events from every frame listening for it: -```lua -local function unregister(event, widget, ...) - if widget then - widget:UnregisterEvent(event) - return unregister(event, ...) - end -end -unregister("PLAYER_LOGOUT", GetFramesRegisteredForEvent("PLAYER_LOGOUT")) -``` - -**Example Use Case:** -This function can be used in debugging or addon development to understand which frames are listening for a specific event and in what order they will receive the event. This can be particularly useful when troubleshooting event handling issues or optimizing event dispatching. - -**Addon Usage:** -Large addons like ElvUI or WeakAuras might use this function to manage event handling more efficiently, ensuring that their frames are registered and unregistered for events in the correct order to avoid conflicts and ensure optimal performance. \ No newline at end of file diff --git a/wiki-information/functions/GetFunctionCPUUsage.md b/wiki-information/functions/GetFunctionCPUUsage.md deleted file mode 100644 index 8e0af95d..00000000 --- a/wiki-information/functions/GetFunctionCPUUsage.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetFunctionCPUUsage - -**Content:** -Returns information about CPU usage by a function. -`usage, calls = GetFunctionCPUUsage(func, includeSubroutines)` - -**Parameters:** -- `func` - - *function* - The function to query CPU usage for. -- `includeSubroutines` - - *boolean* - Whether to include subroutine calls in the CPU usage calculation. - -**Returns:** -- `usage` - - *number* - The amount of CPU time used by the function. -- `calls` - - *number* - The number of times the function has been called. - -**Description:** -Only returns valid data if the `scriptProfile` CVar is set to 1; returns 0 otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetGameTime.md b/wiki-information/functions/GetGameTime.md deleted file mode 100644 index 8b604df9..00000000 --- a/wiki-information/functions/GetGameTime.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: GetGameTime - -**Content:** -Returns the realm's current time in hours and minutes. -`hours, minutes = GetGameTime()` - -**Returns:** -- `hours` - - *number* - The current hour (0-23). -- `minutes` - - *number* - The minutes passed in the current hour (0-59). - -**Description:** -This function can unexpectedly return results inconsistent with actual realm server time. The value returned is from the physical instance server you are actually playing on, and not that of the world instance server (realm server) you log into. Servers for instances such as for raids and PvP are often shared between login world servers, and instance servers are not always running using the same timezone as the login realm server. This is particularly noticeable for Oceanic and other low population world servers. - -**Usage:** -```lua -/dump GetGameTime() -- 18, 41 -``` - -**Miscellaneous:** -When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. -```lua --- unix time -time() -- 1596157547 -GetServerTime() -- 1596157549 --- local time, same as `date(nil, time())` -date() -- "Fri Jul 31 03:05:47 2020" --- realm time -GetGameTime() -- 20, 4 -C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 -C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) -``` - -**Reference:** -- `time()` -- `GetTime()` - -### Example Usage -This function can be used in addons to display the current realm time, which can be useful for scheduling events or displaying time-sensitive information. - -### Addons Using This Function -- **DBM (Deadly Boss Mods):** Uses `GetGameTime` to synchronize raid timers with the realm time. -- **ElvUI:** Utilizes `GetGameTime` to display the current realm time on the user interface. \ No newline at end of file diff --git a/wiki-information/functions/GetGlyphLink.md b/wiki-information/functions/GetGlyphLink.md deleted file mode 100644 index 7095241b..00000000 --- a/wiki-information/functions/GetGlyphLink.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetGlyphLink - -**Content:** -Returns a link to a glyph specified by index and talent group. -`link = GetGlyphLink(index)` - -**Parameters:** -- `index` - - *number* - Ranging from 1 to 6, the glyph's index. See Notes for more information. -- `talentGroup` - - *number?* - Optional, ranging from 1 (primary) to 2 (secondary) the talent group to query. Defaults to the currently active talent group. - -**Returns:** -- `link` - - *string* - The link to the glyph if it's populated, otherwise empty string. - -**Notes and Caveats:** -The indices are not in a logical order, see table and gallery picture below for reference. - -**Glyph indices:** -| Index | Glyph type | Level to unlock | -|-------|-------------|-----------------| -| 1 | Major | 15 | -| 2 | Minor | 15 | -| 3 | Minor | 50 | -| 4 | Major | 30 | -| 5 | Minor | 70 | -| 6 | Major | 80 | - -**Miscellaneous:** -Indices for each glyph slot \ No newline at end of file diff --git a/wiki-information/functions/GetGlyphSocketInfo.md b/wiki-information/functions/GetGlyphSocketInfo.md deleted file mode 100644 index 924353a9..00000000 --- a/wiki-information/functions/GetGlyphSocketInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetGlyphSocketInfo - -**Content:** -Returns information on a glyph socket. -`enabled, glyphType, glyphSpellID, iconFile = GetGlyphSocketInfo(socketID)` - -**Parameters:** -- `socketID` - - *number* - The socket index to query, ranging from 1 through NUM_GLYPH_SLOTS. -- `talentGroup` - - *number?* - The talent specialization group to query. Defaults to 1. - -**Returns:** -- `enabled` - - *boolean* - True if the socket has a glyph inserted. -- `glyphType` - - *number* - The type of glyph accepted by this socket. Either 1 Major, 2 Minor, or 3 Prime. -- `glyphIndex` - - *number* - The socket's index for the glyph type. Either 0, 1, 2. -- `glyphSpellID` - - *number?* - The spell ID of the socketed glyph. -- `iconFile` - - *number?* - FileID - The file ID of the sigil icon associated with the socketed glyph. \ No newline at end of file diff --git a/wiki-information/functions/GetGossipActiveQuests.md b/wiki-information/functions/GetGossipActiveQuests.md deleted file mode 100644 index 2bca225d..00000000 --- a/wiki-information/functions/GetGossipActiveQuests.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetGossipActiveQuests - -**Content:** -Returns a list of active quests from a gossip NPC. For getting the number of active quests from a non-gossip NPC see `GetNumActiveQuests`. -```lua -title1, level1, isLowLevel1, isComplete1, isLegendary1, isIgnored1, title2, ... = GetGossipActiveQuests() -``` - -**Returns:** -The following six return values are provided for each active quest: -- `title` - - *string* - The name of the quest -- `level` - - *number* - The level of the quest -- `isLowLevel` - - *boolean* - true if the quest is low level, false otherwise -- `isComplete` - - *boolean* - true if the quest is complete, false otherwise -- `isLegendary` - - *boolean* - true if the quest is a legendary quest, false otherwise -- `isIgnored` - - *boolean* - true if the quest has been ignored, false otherwise - -**Description:** -The active quests for an NPC are available after `GOSSIP_SHOW` has fired. - -**Reference:** -- `GetGossipAvailableQuests` -- `GetNumAvailableQuests` -- `GetNumActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetGossipAvailableQuests.md b/wiki-information/functions/GetGossipAvailableQuests.md deleted file mode 100644 index e722e560..00000000 --- a/wiki-information/functions/GetGossipAvailableQuests.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: GetGossipAvailableQuests - -**Content:** -Returns a list of available quests from a gossip NPC. For getting the number of available quests from a non-gossip NPC see `GetNumAvailableQuests`. -```lua -title1, level1, isTrivial1, frequency1, isRepeatable1, isLegendary1, isIgnored1, title2, ... = GetGossipAvailableQuests() -``` - -**Returns:** -The following seven return values are provided for each quest offered by the NPC: -- `title` - - *string* - The name of the quest. -- `level` - - *number* - The level of the quest. -- `isTrivial` - - *boolean* - true if the quest is trivial (too low-level compared to the character), false otherwise. -- `frequency` - - *number* - 1 if the quest is a normal quest, `LE_QUEST_FREQUENCY_DAILY` (2) for daily quests, `LE_QUEST_FREQUENCY_WEEKLY` (3) for weekly quests. -- `isRepeatable` - - *boolean* - true if the quest is repeatable, false otherwise. -- `isLegendary` - - *boolean* - true if the quest is a legendary quest, false otherwise. -- `isIgnored` - - *boolean* - true if the quest has been ignored, false otherwise. - -**Description:** -Available quests are quests that the player does not yet have in their quest log. -This list is available after `GOSSIP_SHOW` has fired. - -**Reference:** -- `GetGossipActiveQuests` -- `GetNumAvailableQuests` -- `GetNumActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetGossipOptions.md b/wiki-information/functions/GetGossipOptions.md deleted file mode 100644 index 00d44ab3..00000000 --- a/wiki-information/functions/GetGossipOptions.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetGossipOptions - -**Content:** -Get the available gossip items on an NPC (possibly stuff like the BWL and MC orbs too). -`title1, gossip1, ... = GetGossipOptions()` - -**Returns:** -- `title` - - *string* - The title of the gossip item. -- `gossip` - - *string* - The gossip type: banker, battlemaster, binder, gossip, healer, petition, tabard, taxi, trainer, unlearn, vendor, workorder - -**Description:** -The gossip options are available after `GOSSIP_SHOW` has fired. \ No newline at end of file diff --git a/wiki-information/functions/GetGossipText.md b/wiki-information/functions/GetGossipText.md deleted file mode 100644 index d3103b8f..00000000 --- a/wiki-information/functions/GetGossipText.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetGossipText - -**Content:** -Get the gossip text. -`text = GetGossipText()` - -**Returns:** -- `text` - - *string* - The text of the gossip. - -**Reference:** -- `GOSSIP_SHOW` - -**Example Usage:** -This function can be used in an addon to retrieve the gossip text from an NPC when the gossip window is shown. For example, it can be used to automate responses or to log the gossip text for later review. - -**Addon Usage:** -Many questing and automation addons, such as "Questie" or "Zygor Guides," use this function to interact with NPCs and automate the questing process by reading and responding to gossip text. \ No newline at end of file diff --git a/wiki-information/functions/GetGraphicsAPIs.md b/wiki-information/functions/GetGraphicsAPIs.md deleted file mode 100644 index 7b47ed57..00000000 --- a/wiki-information/functions/GetGraphicsAPIs.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetGraphicsAPIs - -**Content:** -Returns the supported graphics APIs for the system, D3D11_LEGACY, D3D11, D3D12, etc. -`cvarValues, ... = GetGraphicsAPIs()` - -**Returns:** -- (variable returns: `cvarValue1`, `cvarValue2`, ...) - - `cvarValues` - - *string* - a value for CVar `gxApi`. - - `Value` - - `Description` - - `D3D11_LEGACY` - - Old single-threaded rendering backend using DirectX 11 - - `D3D11` - - New multi-threaded rendering backend using DirectX 11 - - `D3D12` - - Multi-threaded rendering backend using DirectX 12 - - `metal` - - `gll` - - `opengl` - -**Reference:** -Kaivax 2019-03-12. New Graphics APIs in 8.1.5. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankItemInfo.md b/wiki-information/functions/GetGuildBankItemInfo.md deleted file mode 100644 index 883171c8..00000000 --- a/wiki-information/functions/GetGuildBankItemInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetGuildBankItemInfo - -**Content:** -Returns item info for a guild bank slot. -`texture, itemCount, locked, isFiltered, quality = GetGuildBankItemInfo(tab, slot)` - -**Parameters:** -- `tab` - - *number* - The index of the tab in the guild bank -- `slot` - - *number* - The index of the slot in the chosen tab. - -**Returns:** -- `texture` - - *number* - The id of the texture to use for the item. Returns nil if there is no item. -- `itemCount` - - *number* - The size of the item stack at the chosen slot. Returns 0 if there is no item. -- `locked` - - *boolean* - Whether or not the slot is locked. Returns nil if it's not locked or the item doesn't exist, 1 otherwise. -- `isFiltered` - - *boolean* - Returns true if the slot should be hidden because of the user's filter, false otherwise. -- `quality` - - *number* - The quality of the item at the chosen slot. Returns nil if there is no item. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankItemLink.md b/wiki-information/functions/GetGuildBankItemLink.md deleted file mode 100644 index 6d419b0f..00000000 --- a/wiki-information/functions/GetGuildBankItemLink.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetGuildBankItemLink - -**Content:** -Returns the item link for a guild bank slot. -`itemLink = GetGuildBankItemLink(tab, slot)` - -**Parameters:** -- `tab` - - *number* - The index of the tab in the guild bank -- `slot` - - *number* - The index of the slot in the provided tab. - -**Returns:** -- `itemLink` - - *string* - The item link for the item. Returns nil if there is no item. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankMoney.md b/wiki-information/functions/GetGuildBankMoney.md deleted file mode 100644 index 3ba0c8b6..00000000 --- a/wiki-information/functions/GetGuildBankMoney.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetGuildBankMoney - -**Content:** -Returns the amount of money in the guild bank. -`retVal1 = GetGuildBankMoney()` - -**Returns:** -- `retVal1` - - *number* - money in copper - -**Usage:** -```lua -/script DEFAULT_CHAT_FRAME:AddMessage(GetGuildBankMoney()); -``` -**Result:** -``` -8900000 -``` - -**Description:** -Will return 0 (zero) if the guild bank frame was not opened, or a cached value from the last time the guild bank frame was opened on any character since the game client was started. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankTabInfo.md b/wiki-information/functions/GetGuildBankTabInfo.md deleted file mode 100644 index afe87cd5..00000000 --- a/wiki-information/functions/GetGuildBankTabInfo.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetGuildBankTabInfo - -**Content:** -Returns info for a guild bank tab. -`name, icon, isViewable, canDeposit, numWithdrawals, remainingWithdrawals, filtered = GetGuildBankTabInfo(tab)` - -**Parameters:** -- `tab` - - *number* - The index of the guild bank tab. (result of `GetCurrentGuildBankTab()`) - -**Returns:** -- `name` - - *string* - Title of the bank tab. -- `icon` - - *string* - Path to the bank tab icon texture. -- `isViewable` - - *boolean* - True if the player can click on the bank tab. -- `canDeposit` - - *boolean* - True if the player can deposit items. -- `numWithdrawals` - - *number* - Available withdrawals per day. -- `remainingWithdrawals` - - *number* - Remaining withdrawals for the day. -- `filtered` - - *boolean* - True if the requested tab is filtered out. - -**Description:** -As of 4.0.3, the `remainingWithdrawals` value seems to be bugged, in that it returns the value for the currently selected tab rather than the tab passed to the function. This bug can be demonstrated by entering `/dump GetGuildBankTabInfo(1)` while viewing different tabs of the bank; the value returned reflects the currently viewed tab, rather than the first tab. You can get around this by calling `QueryGuildBankTab(tabNum)` before calling this function. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankTabPermissions.md b/wiki-information/functions/GetGuildBankTabPermissions.md deleted file mode 100644 index 73aa785e..00000000 --- a/wiki-information/functions/GetGuildBankTabPermissions.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetGuildBankTabPermissions - -**Content:** -Gets display / player's access info. Limited data available without bank proximity. -`canView, canDeposit, canEdit, stacksPerDay = GetGuildBankTabPermissions(tab)` - -**Parameters:** -- `tab` - - *number* - guild bank tab number - -**Returns:** -- `canView` - - *boolean* - 1 if the selected rank can view this guild bank tab, nil otherwise. -- `canDeposit` - - *boolean* - 1 if the selected rank can deposit to this guild bank tab, nil otherwise. -- `canEdit` - - *boolean* - 1 if the selected rank can edit the bank tab text, nil otherwise. -- `stacksPerDay` - - *number* - Amount of withdrawable stacks per day or 0 if none. - -**Usage:** -```lua -local canView, canDeposit, canEdit, stacksPerDay = GetGuildBankTabPermissions(1); -if canDeposit then - DEFAULT_CHAT_FRAME:AddMessage("Can view, deposit and retrieve " .. stacksPerDay .. " stacks a day on tab 1."); -elseif canView then - DEFAULT_CHAT_FRAME:AddMessage("Can view and retrieve " .. stacksPerDay .. " stacks a day on tab 1."); -else - DEFAULT_CHAT_FRAME:AddMessage("Can not view tab 1."); -end -``` - -**Miscellaneous:** -- **Result:** - - If you are the guild master, this will return data for the rank you currently have selected in guild control. Else, it will return data for your own rank. - - Guild masters can always view, deposit and withdraw without limits; this function does not properly return that. Use `IsGuildLeader()` if you want to know if this is the case. - - Note that being able to deposit implies being able to view. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankTransaction.md b/wiki-information/functions/GetGuildBankTransaction.md deleted file mode 100644 index c2a06065..00000000 --- a/wiki-information/functions/GetGuildBankTransaction.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: GetGuildBankTransaction - -**Content:** -Returns info for an item transaction from the guild bank. -`type, name, itemLink, count, tab1, tab2, year, month, day, hour = GetGuildBankTransaction(tab, index)` - -**Parameters:** -- `tab` - - *number* - Tab number, ascending from 1 to `GetNumGuildBankTabs()`. -- `index` - - *number* - Transaction index, ascending from 1 to `GetNumGuildBankTransactions(tab)`. Higher indices correspond to more recent entries. - -**Returns:** -- `type` - - *string* - Transaction type. ("deposit", "withdraw" or "move") -- `name` - - *string* - Name of player who made the transaction. -- `itemLink` - - *string* - `itemLink` of transaction item. -- `count` - - *number* - Amount of items. -- `tab1` - - *number* - For `type=="move"`, this is the origin tab. -- `tab2` - - *number* - For `type=="move"`, this is the destination tab. -- `year` - - *number* - The number of years since this transaction took place. -- `month` - - *number* - The number of months since this transaction took place. -- `day` - - *number* - The number of days since this transaction took place. -- `hour` - - *number* - The number of hours since this transaction took place. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankWithdrawGoldLimit.md b/wiki-information/functions/GetGuildBankWithdrawGoldLimit.md deleted file mode 100644 index 4ae1929a..00000000 --- a/wiki-information/functions/GetGuildBankWithdrawGoldLimit.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: GetGuildBankWithdrawGoldLimit - -**Content:** -Returns withdraw limit for currently selected rank in guild control. -`dailyGoldWithdrawlLimit = GetGuildBankWithdrawGoldLimit()` - -**Parameters:** -- **Arguments** - - none - -**Returns:** -- `dailyGoldWithdrawlLimit` - - *number* - amount (in GOLD) the currently selected Guild Rank can withdraw per day - -**Description:** -In order for this to work properly, you need to have a rank set in the guildControl. - -Example of checking the daily limit for the currently logged on character: -```lua --- create somewhere to store the result and default it -local dailyGoldWithdrawlLimit = 0 - --- need to get the guildRankIndex for the currently logged on player -guildName, _, guildRankIndex = GetGuildInfo("player") - --- guildName is nil if the character isn't in a guild -if (guildName ~= nil) then - -- This character is in a guild, so set the current rank so the limit will work - GuildControlSetRank(guildRankIndex) - dailyGoldWithdrawlLimit = GetGuildBankWithdrawGoldLimit() -end -``` -**NOTE:** This return value is in GOLD unlike many other currency returns in WoW where they give you copper pieces. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildBankWithdrawMoney.md b/wiki-information/functions/GetGuildBankWithdrawMoney.md deleted file mode 100644 index 109efa4a..00000000 --- a/wiki-information/functions/GetGuildBankWithdrawMoney.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetGuildBankWithdrawMoney - -**Content:** -Returns the amount of money the player is allowed to withdraw from the guild bank. -`withdrawLimit = GetGuildBankWithdrawMoney()` - -**Returns:** -- `withdrawLimit` - - Amount of money the player is allowed to withdraw from the guild bank (in copper), or 2^64 if the player has unlimited withdrawal privileges (is Guild Master). - -**Description:** -Returns the amount remaining for the day; that is (Daily amount) - (amount already spent). \ No newline at end of file diff --git a/wiki-information/functions/GetGuildInfo.md b/wiki-information/functions/GetGuildInfo.md deleted file mode 100644 index e4a136f6..00000000 --- a/wiki-information/functions/GetGuildInfo.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: GetGuildInfo - -**Content:** -Returns guild info for a player unit. -`guildName, guildRankName, guildRankIndex, realm = GetGuildInfo(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit whose guild information you wish to query. - -**Returns:** -- `guildName` - - *string* - The name of the guild the unit is in (or nil?). -- `guildRankName` - - *string* - unit's rank in unit's guild. -- `guildRankIndex` - - *number* - unit's rank (index). - zero based index (0 is Guild Master, 1 and above are lower ranks) -- `realm` - - *string?* - The name of the realm the guild is in, or nil if the guild's realm is the same as your current one. - -**Description:** -This function only works in close proximity to the unit you are trying to get info from. It is the same distance that the character portrait loads if you are in party with them. It will abandon the data shortly after you leave the area, even if the portrait is remembered. - -If using with UnitId "player" on loading it happens that this value is nil even if the player is in a guild. Here's a little function which checks in the `GUILD_ROSTER_UPDATE` and `PLAYER_GUILD_UPDATE` events, if guild name is available. As long as it is not, no actions are fired by my guild event handling. - -```lua -local function IsPlayerInGuild() - return IsInGuild() and GetGuildInfo("player") -end -``` - -**Example Usage:** -This function can be used to display guild information for a player in a custom UI element or addon. For instance, you might use it to show the guild name and rank of party members in a custom party frame. - -**Addon Usage:** -Many large addons, such as ElvUI and PitBull Unit Frames, use `GetGuildInfo` to display guild information in their unit frames. This allows players to see at a glance which guild their party or raid members belong to and their rank within that guild. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterInfo.md b/wiki-information/functions/GetGuildRosterInfo.md deleted file mode 100644 index ab577d83..00000000 --- a/wiki-information/functions/GetGuildRosterInfo.md +++ /dev/null @@ -1,58 +0,0 @@ -## Title: GetGuildRosterInfo - -**Content:** -Returns info for a guild member. -`name, rankName, rankIndex, level, classDisplayName, zone, publicNote, officerNote, isOnline, status, class, achievementPoints, achievementRank, isMobile, canSoR, repStanding, guid = GetGuildRosterInfo(index)` - -**Parameters:** -- `index` - - *number* - Ranging from 1 to `GetNumGuildMembers()` - -**Returns:** -- `name` - - *string* - Name of character with realm (e.g. "Arthas-Silvermoon") -- `rankName` - - *string* - Name of character's guild rank (e.g. Guild Master, Officer, Member, ...) -- `rankIndex` - - *number* - Index of rank starting at 0 for GM (add 1 for `GuildControlGetRankName(index)`) -- `level` - - *number* - Character's level -- `classDisplayName` - - *string* - Localized class name (e.g. "Mage", "Warrior", "Guerrier", ...) -- `zone` - - *string* - Character's location (last location if offline) -- `publicNote` - - *string* - Character's public note, returns "" if you can't view notes or no note -- `officerNote` - - *string* - Character's officer note, returns "" if you can't view notes or no note -- `isOnline` - - *boolean* - true: online - false: offline -- `status` - - *number* - 0: none - 1: AFK - 2: Busy (Do Not Disturb) (changed in 4.3.2) -- `class` - - *string* - Localization-independent class name (e.g. "MAGE", "WARRIOR", "DEATHKNIGHT", ...) -- `achievementPoints` - - *number* - Character's achievement points -- `achievementRank` - - *number* - Where the character ranks in guild if sorted by achievement points -- `isMobile` - - *boolean* - true: player logged into app with this character -- `canSoR` - - *boolean* - true: can use Scroll of Resurrection on character (deprecated) -- `repStanding` - - *number* - Standing ID for character's guild reputation -- `guid` - - *string* - Character's GUID - -**Description:** -- **Related API:** - - `C_GuildInfo.GuildRoster` -- **Related Events:** - - `GUILD_ROSTER_UPDATE` - -**Example Usage:** -This function can be used to retrieve detailed information about each member of a guild, which can be useful for guild management addons. For example, an addon could use this function to display a list of all guild members along with their ranks, levels, and online status. - -**Addons Using This API:** -- **ElvUI:** A comprehensive UI replacement addon that uses `GetGuildRosterInfo` to display guild member information in its guild panel. -- **Guild Roster Manager (GRM):** An addon designed to help guild leaders manage their guilds more effectively, using this API to fetch and display detailed member information. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterLastOnline.md b/wiki-information/functions/GetGuildRosterLastOnline.md deleted file mode 100644 index c852fc23..00000000 --- a/wiki-information/functions/GetGuildRosterLastOnline.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: GetGuildRosterLastOnline - -**Content:** -Returns time since the guild member was last online. -`yearsOffline, monthsOffline, daysOffline, hoursOffline = GetGuildRosterLastOnline(index)` - -**Parameters:** -- `index` - - *number* - index of the guild roster entry you wish to query. - -**Returns:** -- `yearsOffline` - - *number* - number of years since the member was last online. May return nil. -- `monthsOffline` - - *number* - number of months since the member was last online. May return nil. -- `daysOffline` - - *number* - number of days since the member was last online. May return nil. -- `hoursOffline` - - *number* - number of hours since the member was last online. May return nil. - -**Usage:** -```lua -local i, tmax, tname, years, months, days, hours, toff = 1, 0, "placeholder"; -while (GetGuildRosterInfo(i) ~= nil) do - years, months, days, hours = GetGuildRosterLastOnline(i); - years, months, days, hours = years and years or 0, months and months or 0, days and days or 0, hours and hours or 0; - toff = (((years*12)+months)*30.5+days)*24+hours; - if (toff > tmax) then - tname = GetGuildRosterInfo(i); - tmax = toff; - end - i = i + 1; -end -message("Been offline the longest: " .. tname .. " (~" .. tmax .. " hours)"); -``` - -**Miscellaneous:** -Result: -Displays a message with the name of the person in your guild who has been offline the longest. Note that this requires an updated guild list showing offline members (open Social tab, click "Show offline members"). \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterMOTD.md b/wiki-information/functions/GetGuildRosterMOTD.md deleted file mode 100644 index d1d49829..00000000 --- a/wiki-information/functions/GetGuildRosterMOTD.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetGuildRosterMOTD - -**Content:** -Returns the guild message of the day. -`motd = GetGuildRosterMOTD()` - -**Returns:** -- `motd` - - *string* - Returns the guild MOTD, or an empty string if not set or not in a guild \ No newline at end of file diff --git a/wiki-information/functions/GetGuildRosterShowOffline.md b/wiki-information/functions/GetGuildRosterShowOffline.md deleted file mode 100644 index ad047bbf..00000000 --- a/wiki-information/functions/GetGuildRosterShowOffline.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetGuildRosterShowOffline - -**Content:** -Returns true if the guild roster is showing offline members. -`showoffline = GetGuildRosterShowOffline()` - -**Returns:** -- `showoffline` - - *Flag* - 1 if online members are shown, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetGuildTabardFiles.md b/wiki-information/functions/GetGuildTabardFiles.md deleted file mode 100644 index fc69930f..00000000 --- a/wiki-information/functions/GetGuildTabardFiles.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetGuildTabardFiles - -**Content:** -Returns File IDs of tabard textures used in guild bank logo. -`tabardBackgroundUpper, tabardBackgroundLower, tabardEmblemUpper, tabardEmblemLower, tabardBorderUpper, tabardBorderLower = GetGuildTabardFiles()` - -**Returns:** -- `tabardBackgroundUpper` - - *number* : FileID -- `tabardBackgroundLower` - - *number* : FileID -- `tabardEmblemUpper` - - *number* : FileID -- `tabardEmblemLower` - - *number* : FileID -- `tabardBorderUpper` - - *number* : FileID -- `tabardBorderLower` - - *number* : FileID \ No newline at end of file diff --git a/wiki-information/functions/GetHaste.md b/wiki-information/functions/GetHaste.md deleted file mode 100644 index a9f4f0d2..00000000 --- a/wiki-information/functions/GetHaste.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetHaste - -**Content:** -Returns the player's haste percentage. -`haste = GetHaste()` - -**Returns:** -- `haste` - - *number* - -**Description:** -Related API: -- `GetCombatRating(CR_HASTE_MELEE)` -- `GetCombatRatingBonus(CR_HASTE_MELEE)` - -**Usage:** -`/dump GetHaste()` \ No newline at end of file diff --git a/wiki-information/functions/GetHitModifier.md b/wiki-information/functions/GetHitModifier.md deleted file mode 100644 index 369b60ad..00000000 --- a/wiki-information/functions/GetHitModifier.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetHitModifier - -**Content:** -Returns the amount of Melee Hit %, not from Melee Hit Rating, that your character has. -`hitMod = GetHitModifier()` - -**Returns:** -- `hitMod` - - *number* - hit modifier (e.g. 16 for 16%) - -**Usage:** -Returns the Melee Hit Chance displayed in the paper doll. -```lua -/dump GetCombatRatingBonus(CR_HIT_MELEE) + GetHitModifier() -``` - -**Reference:** -API GetSpellHitModifier \ No newline at end of file diff --git a/wiki-information/functions/GetHomePartyInfo.md b/wiki-information/functions/GetHomePartyInfo.md deleted file mode 100644 index 8d95cbf6..00000000 --- a/wiki-information/functions/GetHomePartyInfo.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetHomePartyInfo - -**Content:** -Returns names of characters in your home (non-instance) party. -`homePlayers = GetHomePartyInfo()` - -**Parameters:** -- `homePlayers` - - *table* - table to populate and return; a new table is created if this argument is omitted. - -**Returns:** -- `homePlayers` - - *table* - array containing your (non-instance) party members' names, or nil if you're not in any non-instance party. \ No newline at end of file diff --git a/wiki-information/functions/GetInboxHeaderInfo.md b/wiki-information/functions/GetInboxHeaderInfo.md deleted file mode 100644 index a1146a78..00000000 --- a/wiki-information/functions/GetInboxHeaderInfo.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: GetInboxHeaderInfo - -**Content:** -Returns info for a message in the mailbox. -`packageIcon, stationeryIcon, sender, subject, money, CODAmount, daysLeft, hasItem, wasRead, wasReturned, textCreated, canReply, isGM = GetInboxHeaderInfo(index)` - -**Parameters:** -- `index` - - *number* - the index of the message (ascending from 1). - -**Returns:** -- `packageIcon` - - *string* - texture path for package icon if it contains a package (nil otherwise). -- `stationeryIcon` - - *string* - texture path for mail message icon. -- `sender` - - *string* - name of the player who sent the message. -- `subject` - - *string* - the message subject. -- `money` - - *number* - The amount of money attached. -- `CODAmount` - - *number* - The amount of COD payment required to receive the package. -- `daysLeft` - - *number* - The number of days (fractional) before the message expires. -- `hasItem` - - *number* - Either the number of attachments or nil if no items are present. Note that items that have been taken from the mailbox continue to occupy empty slots, but hasItem is the total number of items remaining in the mailbox. Use `ATTACHMENTS_MAX_RECEIVE` for the total number of attachments rather than this. -- `wasRead` - - *boolean* - 1 if the mail has been read, nil otherwise. Using `GetInboxText()` marks an item as read. -- `wasReturned` - - *boolean* - 1 if the mail was returned, nil otherwise. -- `textCreated` - - *boolean* - 1 if a letter object has been created from this mail, nil otherwise. -- `canReply` - - *boolean* - 1 if this letter can be replied to, nil otherwise. -- `isGM` - - *boolean* - 1 if this letter was sent by a GameMaster. - -**Description:** -This function may be called from anywhere in the world, but will only be current as of the last time `CheckInbox` was called. -Details of an Auction House message can be extracted with `GetInboxInvoiceInfo`. \ No newline at end of file diff --git a/wiki-information/functions/GetInboxInvoiceInfo.md b/wiki-information/functions/GetInboxInvoiceInfo.md deleted file mode 100644 index 93a6d928..00000000 --- a/wiki-information/functions/GetInboxInvoiceInfo.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetInboxInvoiceInfo - -**Content:** -Returns info for an auction house invoice. -`invoiceType, itemName, playerName, bid, buyout, deposit, consignment = GetInboxInvoiceInfo(index)` - -**Parameters:** -- `index` - - *number* - The index of the message, starting from 1. - -**Returns:** -- `invoiceType` - - *string?* - One of "buyer", "seller" or "seller_temp_invoice"; or nil if there is no invoice. -- `itemName` - - *string?* - The name of the item sold/bought, or nil if there is no invoice. -- `playerName` - - *string?* - The player that sold/bought the item, or nil if there were multiple buyers/sellers involved. Will also return nil if there is no invoice. -- `bid` - - *number* - The amount of money bid on the item. -- `buyout` - - *number* - The amount of money set as buyout for the auction. -- `deposit` - - *number* - The amount paid as deposit for the auction. -- `consignment` - - *number* - The fee charged by the auction house for selling your consignment. - -**Description:** -During the 1 hour delay on auction house payments, the message "Sale Pending: " may be queried with `GetInboxInvoiceInfo()` to determine the bid, buyout, deposit, and consignment fee amounts. This is useful, since `GetInboxHeaderInfo()` for that message (correctly) reports 0 money attached. \ No newline at end of file diff --git a/wiki-information/functions/GetInboxItem.md b/wiki-information/functions/GetInboxItem.md deleted file mode 100644 index 8390b110..00000000 --- a/wiki-information/functions/GetInboxItem.md +++ /dev/null @@ -1,54 +0,0 @@ -## Title: GetInboxItem - -**Content:** -Returns info for an item attached to a message in the mailbox. -`name, itemID, texture, count, quality, canUse = GetInboxItem(index, itemIndex)` - -**Parameters:** -- `index` - - *number* - The index of the message to query, in the range -- `itemIndex` - - *number* - The index of the item to query, in the range - -**Returns:** -- `name` - - *string* - The localized name of the item -- `itemID` - - *number* - Numeric ID of the item. -- `texture` - - *string* - The path to the icon texture for the item -- `count` - - *number* - The number of items in the stack -- `quality` - - *number* - The quality index of the item -- `canUse` - - *boolean* - 1 if the player can use the item, or nil otherwise - -**Usage:** -Loop over all messages currently in the player's mailbox, get information about the items attached to them, and print it to the chat frame: -```lua -for i = 1, GetInboxNumItems() do - -- An underscore is commonly used to name variables you aren't going to use in your code: - local _, _, sender, subject, _, _, _, hasItem = GetInboxHeaderInfo(i) - if hasItem then - print("Message", subject, "from", sender, "has attachments:") - for j = 1, ATTACHMENTS_MAX_RECEIVE do - local name, itemID, texture, count, quality, canUse = GetInboxItem(i, j) - if name then - -- Construct an icon string: - print("\128T"..texture..":0\128t", name, "x", count) - end - end - else - print("Message", subject, "from", sender, "has no attachments.") - end -end -``` - -**Description:** -As of 2.3.3 this function is bugged and the quality is always returned as -1. If you need to know the item's quality, get a link for the item using `GetInboxItemLink`, and pass the link to `GetItemInfo`. - -**Reference:** -- `GetInboxItemLink` -- `GetSendMailItem` -- `GetSendMailItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetInboxItemLink.md b/wiki-information/functions/GetInboxItemLink.md deleted file mode 100644 index 4fae86e5..00000000 --- a/wiki-information/functions/GetInboxItemLink.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: GetInboxItemLink - -**Content:** -Returns the item link of an item attached to a message in the mailbox. -`itemLink = GetInboxItemLink(message, attachment)` - -**Parameters:** -- `message` - - *number* - The index of the message to query, in the range of -- `attachment` - - *number* - The index of the attachment to query, in the range of - -**Returns:** -- `itemLink` - - *itemLink* - The itemLink for the specified item - -**Description:** -`ATTACHMENTS_MAX_RECEIVE` is defined in Constants.lua, and currently (Jan 2014) has a value of 16. Using this variable instead of a hardcoded 16 is recommended in case Blizzard changes the maximum number of items that may be attached to a received message. - -**Usage:** -To determine which messages are currently displayed in the mailbox frame, check the `pageNum` property set on the InboxFrame and do the math: -```lua -local maxIndex = GetInboxNumItems() -if maxIndex > 0 then - local firstIndex = ((InboxFrame.pageNum - 1) * INBOXITEMS_TO_DISPLAY) + 1 - local lastIndex = math.min(maxIndex, firstIndex + (INBOXITEMS_TO_DISPLAY - 1)) - print("Currently displaying messages", firstIndex, "though", lastIndex) -else - print("No messages to display") -end -``` - -**Reference:** -- `GetInboxItem` -- `GetSendMailItem` -- `GetSendMailItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetInboxNumItems.md b/wiki-information/functions/GetInboxNumItems.md deleted file mode 100644 index d17b7675..00000000 --- a/wiki-information/functions/GetInboxNumItems.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetInboxNumItems - -**Content:** -Returns the number of messages in the mailbox. -`numItems, totalItems = GetInboxNumItems()` - -**Returns:** -- `numItems` - - *number* - The number of items in the mailbox. -- `totalItems` - - *number* - The total number of items in the mailbox, including those that are not visible due to pagination. - -**Example Usage:** -This function can be used to check the number of messages in a player's mailbox, which can be useful for addons that manage mail or notify players of new mail. - -**Addons Using This Function:** -- **Postal**: A popular mailbox management addon that uses this function to display the number of messages and manage mail efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetInspectArenaData.md b/wiki-information/functions/GetInspectArenaData.md deleted file mode 100644 index fd01ad1b..00000000 --- a/wiki-information/functions/GetInspectArenaData.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetInspectArenaData - -**Content:** -Returns the inspected unit's rated PvP stats. -`rating, seasonPlayed, seasonWon, weeklyPlayed, weeklyWon = GetInspectArenaData(bracketId)` - -**Parameters:** -- `bracketId` - - *number* - rated PvP bracket to query, ascending from 1 for 2v2, 3v3, and 5v5 arenas, and Rated Battlegrounds respectively. - -**Returns:** -- `rating` - - *number* - inspected unit's current personal rating in the specified bracket. -- `seasonPlayed` - - *number* - number of games played in the bracket during the current season. -- `seasonWon` - - *number* - number of games won in the bracket during the current season. -- `weeklyPlayed` - - *number* - number of games played in the bracket during the current week. -- `weeklyWon` - - *number* - number of games won in the bracket during the current week. - -**Description:** -Information is available when the `INSPECT_HONOR_UPDATE` event fires, or when `HasInspectHonorData` returns true. -You must request information from the server by calling `RequestInspectHonorData`. \ No newline at end of file diff --git a/wiki-information/functions/GetInspectHonorData.md b/wiki-information/functions/GetInspectHonorData.md deleted file mode 100644 index a75cca75..00000000 --- a/wiki-information/functions/GetInspectHonorData.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GetInspectHonorData - -**Content:** -Returns honor info for the inspected player unit. -`todayHK, todayHonor, yesterdayHK, yesterdayHonor, lifetimeHK, lifetimeRank = GetInspectHonorData()` - -**Returns:** -- `todayHK` - - *number* - Honor kills made today. -- `todayHonor` - - *number* - Honor rewarded today. -- `yesterdayHK` - - *number* - Amount of honor kills made yesterday. -- `yesterdayHonor` - - *number* - The honor rewarded yesterday. -- `lifetimeHK` - - *number* - Total lifetime honor kills. -- `lifetimeRank` - - *number* - Highest PvP rank ever attained. - -**Description:** -Before this function can return any information, `NotifyInspect(unit)` must be called first, followed by a call to the `RequestInspectHonorData` function. \ No newline at end of file diff --git a/wiki-information/functions/GetInspectPVPRankProgress.md b/wiki-information/functions/GetInspectPVPRankProgress.md deleted file mode 100644 index dc1cfdc8..00000000 --- a/wiki-information/functions/GetInspectPVPRankProgress.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetInspectPVPRankProgress - -**Content:** -Gets the inspected unit's progress towards the next PvP rank. -`rankProgress = GetInspectPVPRankProgress()` - -**Returns:** -- `rankProgress` - - *number* - The progress made toward the next PVP rank normalized between 0 and 1 - -**Description:** -Requires you to be inspecting a unit and call `GetInspectHonorData()` first before this API returns updated information. -If not inspecting a unit, `NotifyInspect("unit")` must be called first. \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceBootTimeRemaining.md b/wiki-information/functions/GetInstanceBootTimeRemaining.md deleted file mode 100644 index 765ad198..00000000 --- a/wiki-information/functions/GetInstanceBootTimeRemaining.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetInstanceBootTimeRemaining - -**Content:** -Needs summary. -`result = GetInstanceBootTimeRemaining()` - -**Returns:** -- `result` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceInfo.md b/wiki-information/functions/GetInstanceInfo.md deleted file mode 100644 index 43cda826..00000000 --- a/wiki-information/functions/GetInstanceInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetInstanceInfo - -**Content:** -Returns info for the map instance the character is currently in. -`name, instanceType, difficultyID, difficultyName, maxPlayers, dynamicDifficulty, isDynamic, instanceID, instanceGroupSize, LfgDungeonID = GetInstanceInfo()` - -**Returns:** -1. `name` - - *string* - The localized name of the instance—otherwise, the continent name (e.g., Eastern Kingdoms, Kalimdor, Outland, Northrend, Pandaria). -2. `instanceType` - - *string* - "none" if the player is not in an instance, "scenario" for scenarios, "party" for dungeons, "raid" for raids, "arena" for arenas, and "pvp" for battlegrounds. Many of the following return values will be nil or otherwise useless in the case of "none". -3. `difficultyID` - - *number* - The DifficultyID of the instance. Will return 0 while not in an instance. -4. `difficultyName` - - *string* - The localized name for the instance's difficulty ("10 Player", "25 Player (Heroic)", etc.). -5. `maxPlayers` - - *number* - Maximum number of players permitted within the instance at the same time. -6. `dynamicDifficulty` - - *number* - The difficulty of dynamic enabled instances. This no longer appears to be used. -7. `isDynamic` - - *boolean* - If the instance difficulty can be changed while zoned in. This is true for most raids after and including Icecrown Citadel. -8. `instanceID` - - *number* - The InstanceID for the instance or continent. -9. `instanceGroupSize` - - *number* - The number of players within your instance group. -10. `LfgDungeonID` - - *number* - The LfgDungeonID for the current instance group, nil if not in a dungeon finder group. - -**Description:** -Related API: `C_Map.GetBestMapForUnit` \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceLockTimeRemaining.md b/wiki-information/functions/GetInstanceLockTimeRemaining.md deleted file mode 100644 index 76dd367b..00000000 --- a/wiki-information/functions/GetInstanceLockTimeRemaining.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetInstanceLockTimeRemaining - -**Content:** -Returns info for the instance lock timer for the current instance. -`lockTimeleft, isPreviousInstance, encountersTotal, encountersComplete = GetInstanceLockTimeRemaining()` - -**Returns:** -- `lockTimeLeft` - - *number* - Seconds until lock period ends. -- `isPreviousInstance` - - *boolean* - Whether this instance has yet to be entered since last lockout expired (allowing for lock extension options). -- `encountersTotal` - - *number* - Total number of bosses in the instance. -- `encountersComplete` - - *number* - Number of bosses already dead in the instance. - -**Description:** -On the continent of Pandaria, unlike other open world continents, `encountersTotal` is reported as 4. According to `GetInstanceLockTimeRemainingEncounter`, this corresponds with the first 4 Pandaria world bosses of the expansion - Galleon, Sha of Anger, Nalak, and Oondasta. -As of patch 5.4, the new world boss system isolates non-instance lockouts to `GetNumSavedWorldBosses` and `GetSavedWorldBossInfo`. It is likely that interacting with those bosses or their loot no longer has any effect on the old instance-based system represented by this function. - -**Reference:** -- `GetInstanceLockTimeRemainingEncounter(...)` - drills down to specific boss -- `GetSavedInstanceInfo(...)` - newer, expanded version of this function \ No newline at end of file diff --git a/wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md b/wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md deleted file mode 100644 index 6653f97a..00000000 --- a/wiki-information/functions/GetInstanceLockTimeRemainingEncounter.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetInstanceLockTimeRemainingEncounter - -**Content:** -Returns information about bosses in the instance the player is about to be saved to. -`bossName, texture, isKilled = GetInstanceLockTimeRemainingEncounter(id)` - -**Parameters:** -- `id` - - *number* - Index of the boss to query, ascending from 1 to encountersTotal return value from GetInstanceLockTimeRemaining. - -**Returns:** -- `bossName` - - *string* - Name of the boss. -- `texture` - - *string* - ? -- `isKilled` - - *boolean* - true if the boss has been killed. - -**Reference:** -- `GetInstanceLockTimeRemaining()` - zooms out to full instance's info -- `GetSavedWorldBossInfo(...)` - also provides boss info, but for world bosses \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryAlertStatus.md b/wiki-information/functions/GetInventoryAlertStatus.md deleted file mode 100644 index 972cfa90..00000000 --- a/wiki-information/functions/GetInventoryAlertStatus.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetInventoryAlertStatus - -**Content:** -Returns the durability status of an equipped item. -`alertStatus = GetInventoryAlertStatus(index)` - -**Parameters:** -- `index` - - *string* - one of the following: - - Head - - Shoulders - - Chest - - Waist - - Legs - - Feet - - Wrists - - Hands - - Weapon - - Shield - - Ranged - -**Returns:** -- `alertStatus` - - *number* - 0 for normal (6 or more durability points left), 1 for yellow (5 to 1 durability points left), 2 for broken (0 durability points left). - -**Description:** -Used primarily for DurabilityFrame, i.e., the armor man placed under the Minimap when your equipment is damaged or broken. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemBroken.md b/wiki-information/functions/GetInventoryItemBroken.md deleted file mode 100644 index 61d92a14..00000000 --- a/wiki-information/functions/GetInventoryItemBroken.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetInventoryItemBroken - -**Content:** -Returns true if an inventory item has zero durability. -`isBroken = GetInventoryItemBroken(unit, invSlotId)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit whose inventory is to be queried. -- `invSlotId` - - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. - -**Returns:** -- `isBroken` - - *Flag* - Returns nil if the specified item is not broken, or 1 if it is. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemCooldown.md b/wiki-information/functions/GetInventoryItemCooldown.md deleted file mode 100644 index 568c292c..00000000 --- a/wiki-information/functions/GetInventoryItemCooldown.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetInventoryItemCooldown - -**Content:** -Get cooldown information for an inventory item. -`start, duration, enable = GetInventoryItemCooldown(unit, invSlotId)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit whose inventory is to be queried. -- `invSlotId` - - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. - -**Returns:** -- `start` - - *number* - The start time of the cooldown period, or 0 if there is no cooldown (or no item in the slot) -- `duration` - - *number* - The duration of the cooldown period (NOT the remaining time). 0 if the item has no use/cooldown or the slot is empty. -- `enable` - - *number* - Returns 1 or 0. 1 if the inventory item is capable of having a cooldown, 0 if not. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemCount.md b/wiki-information/functions/GetInventoryItemCount.md deleted file mode 100644 index 1152ad8c..00000000 --- a/wiki-information/functions/GetInventoryItemCount.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetInventoryItemCount - -**Content:** -Determine the quantity of an item in an inventory slot. -`count = GetInventoryItemCount(unit, invSlotId)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit whose inventory is to be queried. -- `invSlotId` - - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. - -**Returns:** -- `count` - - *number* - Returns 1 on empty slots (Thus, on empty ammo slot, 1 is returned). For containers (Bags, etc.), this returns the number of items stored inside the container (Thus, empty containers return 0). Under all other conditions, this function returns the amount of items in the specified slot. - -**Usage:** -```lua -local ammoSlot = GetInventorySlotInfo("AmmoSlot"); -local ammoCount = GetInventoryItemCount("player", ammoSlot); -if ((ammoCount == 1) and (not GetInventoryItemTexture("player", ammoSlot))) then - ammoCount = 0; -end; -``` - -**Example Use Case:** -This function can be used to check the amount of ammunition a player has left in their ammo slot. This is particularly useful for classes that rely on ammunition, such as Hunters in earlier expansions of World of Warcraft. - -**Addon Usage:** -Large addons like WeakAuras might use this function to create custom alerts or notifications for players when their ammunition is running low. This helps players to manage their inventory more effectively during gameplay. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemDurability.md b/wiki-information/functions/GetInventoryItemDurability.md deleted file mode 100644 index 617573cb..00000000 --- a/wiki-information/functions/GetInventoryItemDurability.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetInventoryItemDurability - -**Content:** -Returns the durability of an equipped item. -`current, maximum = GetInventoryItemDurability(invSlotId)` - -**Parameters:** -- `invSlotId` - - *number* - InventorySlotId - -**Returns:** -- `current` - - *number* - current durability value. -- `maximum` - - *number* - maximum durability value. - -**Reference:** -- `GetInventorySlotInfo` -- `GetContainerItemDurability` \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemGems.md b/wiki-information/functions/GetInventoryItemGems.md deleted file mode 100644 index 66c49672..00000000 --- a/wiki-information/functions/GetInventoryItemGems.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetInventoryItemGems - -**Content:** -Returns item ids of the gems socketed in the item in the specified inventory slot. -`gem1, gem2, ... = GetInventoryItemGems(invSlot);` - -**Parameters:** -- `invSlot` - - *Number (InventorySlotId)* - Index of the inventory slot to query. - -**Returns:** -- `gem1, gem2, ...` - - *Number* - Item ID of the gem(s) socketed within the item in the queried slot. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemID.md b/wiki-information/functions/GetInventoryItemID.md deleted file mode 100644 index 3e6d9638..00000000 --- a/wiki-information/functions/GetInventoryItemID.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetInventoryItemID - -**Content:** -Returns the item ID for an equipped item. -`itemId, unknown = GetInventoryItemID(unit, invSlotId)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit whose inventory is to be queried. -- `invSlotId` - - *number* : InventorySlotId - to be queried, obtained via `GetInventorySlotInfo`. - -**Returns:** -- `itemId` - - *number* - item id of the item in the inventory slot; nil if there is no item. -- `unknown` - - *number* - ? - -**Example Usage:** -```lua -local unit = "player" -local invSlotId = GetInventorySlotInfo("HeadSlot") -local itemId = GetInventoryItemID(unit, invSlotId) -print("Item ID in Head Slot: ", itemId) -``` - -**Common Usage in Addons:** -- **WeakAuras**: This function is often used to check if a player has a specific item equipped, which can then trigger custom visual or audio alerts. -- **Pawn**: Utilizes this function to compare currently equipped items with potential upgrades, helping players make better gear choices. \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemLink.md b/wiki-information/functions/GetInventoryItemLink.md deleted file mode 100644 index 3d576b9c..00000000 --- a/wiki-information/functions/GetInventoryItemLink.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetInventoryItemLink - -**Content:** -Returns the item link for an equipped item. -`itemLink = GetInventoryItemLink(unit, invSlotId)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit whose inventory is to be queried. -- `invSlotId` - - *number* : InventorySlotId - The inventory slot to be queried. - -**Returns:** -- `itemLink` - - *string?* : ItemLink - The item link for the specified item. - -**Usage:** -```lua -local mainHandLink = GetInventoryItemLink("player", GetInventorySlotInfo("MainHandSlot")) -local _, _, _, _, _, _, itemType = GetItemInfo(mainHandLink) -DEFAULT_CHAT_FRAME:AddMessage(itemType) -``` -**Result:** -Prints the subtype of the mainhand weapon - for example "Mace" or "Sword". \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemQuality.md b/wiki-information/functions/GetInventoryItemQuality.md deleted file mode 100644 index 63f50255..00000000 --- a/wiki-information/functions/GetInventoryItemQuality.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetInventoryItemQuality - -**Content:** -Returns the quality of an equipped item. -`quality = GetInventoryItemQuality(unitId, invSlotId)` - -**Parameters:** -- `unitId` - - *string* : UnitId - The unit whose inventory is to be queried. -- `invSlotId` - - *number* : InventorySlotId - The slot ID to be queried, obtained via `GetInventorySlotInfo()`. - -**Returns:** -- `quality` - - *Enum.ItemQuality* \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemTexture.md b/wiki-information/functions/GetInventoryItemTexture.md deleted file mode 100644 index 1e9841ce..00000000 --- a/wiki-information/functions/GetInventoryItemTexture.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetInventoryItemTexture - -**Content:** -Returns the texture for an equipped item. -`texture = GetInventoryItemTexture(unit, invSlotId)` - -**Parameters:** -- `unit` - - *string* : UnitId -- `invSlotId` - - *number* : InventorySlotId - -**Returns:** -- `texture` - - *number* : FileDataID \ No newline at end of file diff --git a/wiki-information/functions/GetInventoryItemsForSlot.md b/wiki-information/functions/GetInventoryItemsForSlot.md deleted file mode 100644 index e7901061..00000000 --- a/wiki-information/functions/GetInventoryItemsForSlot.md +++ /dev/null @@ -1,72 +0,0 @@ -## Title: GetInventoryItemsForSlot - -**Content:** -Returns a list of items that can be equipped in a given inventory slot. -`returnTable = GetInventoryItemsForSlot(slot, returnTable)` - -**Parameters:** -- `slot` - - *number* : InvSlotId - The inventory slot ID. -- `returnTable` - - *table* - The table that will be populated with available items. -- `transmogrify` - - *boolean?* - -**Returns:** -- `returnTable` - - *table* - A key-value table ItemLocation bitfield -> ItemLink. - -**Usage:** -Prints all items that can go in the main hand slot, one is currently equipped, the other is in the backpack. -```lua -/dump GetInventoryItemsForSlot(INVSLOT_MAINHAND, {}) --- Output: --- { --- [bitfield1] = "ItemLink1", --- [bitfield2] = "ItemLink2" --- } -``` - -Prints the information in a more user-readable state. -```lua -local locations = { - "player", - "bank", - "bags", - "voidStorage", - "slot", - "bag", - "tab", - "voidSlot", -} - -function PrintInventoryItemsForSlot(slot) - local items = GetInventoryItemsForSlot(slot, {}) - for bitfield, link in pairs(items) do - print(link, string.format("0x%X", bitfield)) - local locs = {EquipmentManager_UnpackLocation(bitfield)} - local t = {} - for k, v in pairs(locs) do - t[k] = v or nil - end - DevTools_Dump(t) - end -end - --- /run PrintInventoryItemsForSlot(INVSLOT_MAINHAND) --- Example Output: --- "ItemLink1", 0x100010 --- player=true, --- slot=16 --- "ItemLink2", 0x30000A --- player=true, --- bags=true, --- bag=0, --- slot=10 -``` - -**Example Use Case:** -This function can be used to list all items that can be equipped in a specific slot, which is useful for creating custom equipment managers or transmogrification tools. - -**Addon Usage:** -Large addons like "Pawn" and "ItemRack" use this function to determine which items can be equipped in specific slots, helping players optimize their gear and manage equipment sets efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetInventorySlotInfo.md b/wiki-information/functions/GetInventorySlotInfo.md deleted file mode 100644 index 472cc766..00000000 --- a/wiki-information/functions/GetInventorySlotInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetInventorySlotInfo - -**Content:** -Returns info for an equipment slot. -`invSlotId, textureName, checkRelic = GetInventorySlotInfo(invSlotName)` - -**Parameters:** -- `invSlotName` - - *string* - InventorySlotName to query (e.g. "HEADSLOT"). - -**Returns:** -- `invSlotId` - - *number* - The ID to use to refer to that slot in the other GetInventory functions. -- `textureName` - - *string* - The texture to use for the empty slot on the paper doll display. -- `checkRelic` - - *boolean* - -**Example Usage:** -```lua -local invSlotId, textureName, checkRelic = GetInventorySlotInfo("HEADSLOT") -print("Slot ID:", invSlotId) -print("Texture Name:", textureName) -print("Check Relic:", checkRelic) -``` - -**Description:** -The `GetInventorySlotInfo` function is useful for addon developers who need to interact with specific equipment slots. For example, it can be used to get the slot ID for the head slot, which can then be used in other inventory-related functions to get or set items in that slot. - -**Usage in Addons:** -Large addons like "ElvUI" and "WeakAuras" use this function to manage and display equipment slots. For instance, ElvUI uses it to customize the appearance of the character frame, while WeakAuras might use it to trigger alerts based on the player's equipped items. \ No newline at end of file diff --git a/wiki-information/functions/GetInviteConfirmationInfo.md b/wiki-information/functions/GetInviteConfirmationInfo.md deleted file mode 100644 index 6e97dbba..00000000 --- a/wiki-information/functions/GetInviteConfirmationInfo.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: GetInviteConfirmationInfo - -**Content:** -Retrieves information about a player that could be invited. -`confirmationType, name, guid, rolesInvalid, willConvertToRaid, level, spec, itemLevel = GetInviteConfirmationInfo(invite)` - -**Parameters:** -- `invite` - - *unknown* - return value of function `GetNextPendingInviteConfirmation` - -**Returns:** -- `confirmationType` - - *number* - Integer value related to constants like `LE_INVITE_CONFIRMATION_REQUEST` -- `name` - - *string* - name of the player -- `guid` - - *string* - a string containing the hexadecimal representation of the player's GUID. Player-- (Example: "Player-976-0002FD64") -- `rolesInvalid` - - *boolean* - The player has no valid roles. -- `willConvertToRaid` - - *boolean* - Inviting this player or group will convert your party to a raid. -- `level` - - *number* - player level -- `spec` - - *number* - player specialization id. The player specialization name can be requested by `GetSpecializationInfoByID`. -- `itemLevel` - - *number* - player item level - -**Reference:** -- `GetNextPendingInviteConfirmation` - -**Related Constants:** -- `LE_INVITE_CONFIRMATION_QUEUE_WARNING = 3` -- `LE_INVITE_CONFIRMATION_RELATION_NONE = 0` -- `LE_INVITE_CONFIRMATION_RELATION_FRIEND = 1` -- `LE_INVITE_CONFIRMATION_RELATION_GUILD = 2` -- `LE_INVITE_CONFIRMATION_REQUEST = 1` -- `LE_INVITE_CONFIRMATION_SUGGEST = 2` \ No newline at end of file diff --git a/wiki-information/functions/GetInviteReferralInfo.md b/wiki-information/functions/GetInviteReferralInfo.md deleted file mode 100644 index 5975e00f..00000000 --- a/wiki-information/functions/GetInviteReferralInfo.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: C_PartyInfo.GetInviteReferralInfo - -**Content:** -Returns info for Quick join invites. -`outReferredByGuid, outReferredByName, outRelationType, outIsQuickJoin, outClubId = C_PartyInfo.GetInviteReferralInfo(inviteGUID)` - -**Parameters:** -- `inviteGUID` - - *string* - -**Returns:** -- `outReferredByGuid` - - *string* -- `outReferredByName` - - *string* -- `outRelationType` - - *Enum.PartyRequestJoinRelation* -- `outIsQuickJoin` - - *boolean* -- `outClubId` - - *string* - -**Enum.PartyRequestJoinRelation:** -- `Value` -- `Field` -- `Description` - - `0` - - `None` - - `1` - - `Friend` - - `2` - - `Guild` - - `3` - - `Club` - - `4` - - `NumPartyRequestJoinRelations` \ No newline at end of file diff --git a/wiki-information/functions/GetItemClassInfo.md b/wiki-information/functions/GetItemClassInfo.md deleted file mode 100644 index 0c6d9630..00000000 --- a/wiki-information/functions/GetItemClassInfo.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetItemClassInfo - -**Content:** -Returns the name of the item type. -`name = GetItemClassInfo(classID)` - -**Parameters:** -- `classID` - - *number* - ID of the ItemType - -**Returns:** -- `name` - - *string* - Name of the item type - -**Usage:** -```lua -for i = 0, Enum.ItemClassMeta.NumValues-1 do - print(i, GetItemClassInfo(i)) -end --- Output: --- 0, Consumable --- 1, Container --- 2, Weapon --- ... -``` - -**Reference:** -- `GetItemSubClassInfo` -- `GetItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetItemCooldown.md b/wiki-information/functions/GetItemCooldown.md deleted file mode 100644 index 45c8888d..00000000 --- a/wiki-information/functions/GetItemCooldown.md +++ /dev/null @@ -1,54 +0,0 @@ -## Title: GetItemCooldown - -**Content:** -Returns cooldown info for an item ID. -`startTime, duration, enable = GetItemCooldown(itemInfo)` - -**Parameters:** -- `itemInfo` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `startTime` - - *number* - The time when the cooldown started (as returned by GetTime()) or zero if no cooldown. -- `duration` - - *number* - The number of seconds the cooldown will last, or zero if no cooldown. -- `enable` - - *number* - 1 if the item is ready or on cooldown, 0 if the item is used, but the cooldown didn't start yet (e.g. potion in combat). - -**Description:** -As of patch 4.0.1, you can no longer use this function to return the Cooldown of an item link or name, you MUST pass in the itemID. -If you need the original behavior, here is a function that simulates that function... - -```lua -function GetItemCooldown_Orig(searchItemLink) - local bagID = 1; - local bagName = GetBagName(bagID); - local searchItemName = GetItemInfo(searchItemLink); - if (searchItemName == nil) then return nil end - while (bagName ~= nil) do - local slots = GetContainerNumSlots(bagID); - for slot = 1, slots, 1 do - local _, _, _, _, _, _, itemLink = GetContainerItemInfo(bagID, slot); - if (itemLink ~= nil) then - local startTime, duration, isEnabled = GetContainerItemCooldown(bagID, slot); - if (startTime ~= nil and startTime > 0 and itemLink ~= nil) then - if (searchItemName == itemName) then - return startTime, duration, isEnabled; - end - end - end - end - -- Restart While Loop - bagID = bagID + 1; - bagName = GetBagName(bagID); - end - return nil; -end -``` - -**Example Usage:** -This function can be used to check the cooldown of a specific item in your inventory, such as a health potion or a trinket, to determine if it is ready to be used again. - -**Addons:** -Many large addons, such as WeakAuras and OmniCC, use this function to track item cooldowns and display them to the player. WeakAuras, for example, can create custom visual and audio alerts when an item comes off cooldown, while OmniCC overlays cooldown numbers directly on item icons. \ No newline at end of file diff --git a/wiki-information/functions/GetItemCount.md b/wiki-information/functions/GetItemCount.md deleted file mode 100644 index ef95c162..00000000 --- a/wiki-information/functions/GetItemCount.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: GetItemCount - -**Content:** -Returns the number (or available charges) of an item in the inventory. -`count = GetItemCount(itemInfo)` - -**Parameters:** -- `itemInfo` - - *number|string* - Item ID, Link, or Name -- `includeBank` - - *boolean?* - If true, includes the bank -- `includeUses` - - *boolean?* - If true, includes each charge of an item similar to GetActionCount() -- `includeReagentBank` - - *boolean?* - If true, includes the reagent bank - -**Returns:** -- `count` - - *number* - The number of items in your possession, or charges if includeUses is true and the item has charges. - -**Usage:** -```lua -local count = GetItemCount(29434) -print("Badge of Justice:", count) - -local count = GetItemCount(33312, nil, true) -print("Mana Saphire Charges:", count) - -local clothInBags = GetItemCount("Netherweave Cloth") -local clothInTotal = GetItemCount("Netherweave Cloth", true) -print("Netherweave Cloth:", clothInBags, "(bags)", (clothInTotal - clothInBags), "(bank)") -``` - -**Reference:** -- Iriel 2007-08-27. Upcoming 2.3 Changes - Concise List. BlueTracker. Archived from the original -- slouken 2006-10-11. Re: 2.0.0 Changes - Concise List. Archived from the original \ No newline at end of file diff --git a/wiki-information/functions/GetItemFamily.md b/wiki-information/functions/GetItemFamily.md deleted file mode 100644 index 35329af6..00000000 --- a/wiki-information/functions/GetItemFamily.md +++ /dev/null @@ -1,90 +0,0 @@ -## Title: GetItemFamily - -**Content:** -Returns the bag type that an item can go into, or for bags the type of items that it can contain. -`bagType = GetItemFamily(item)` - -**Parameters:** -- `item` - - *number|string* : Item ID, Link or Name - -**Returns:** -- `bagType` - - *number* : ItemFamily - Bitfield of the type of bags an item can go into, or if the item is a container what it can contain. Will return nil for uncached items, like most item API. - -**Usage:** -```lua -local itemFamilyIDs = { - [0x1] = "Arrows", - [0x2] = "Bullets", - [0x4] = "Soul Shards", - [0x8] = "Leatherworking Supplies", - [0x10] = "Inscription Supplies", - [0x20] = "Herbs", - [0x40] = "Enchanting Supplies", - [0x80] = "Engineering Supplies", - [0x100] = "Keys", - [0x200] = "Gems", - [0x400] = "Mining Supplies", - [0x800] = "Soulbound Equipment", - [0x1000] = "Vanity Pets", - [0x2000] = "Currency Tokens", - [0x4000] = "Quest Items", - [0x8000] = "Fishing Supplies", - [0x10000] = "Cooking Supplies", - [0x20000] = "Toys", - [0x40000] = "Archaeology", - [0x80000] = "Alchemy", - [0x100000] = "Blacksmithing", - [0x200000] = "First Aid", - [0x400000] = "Jewelcrafting", - [0x800000] = "Skinning", - [0x1000000] = "Tailoring", -} -local itemFamilyFlags = {} -for k, v in pairs(itemFamilyIDs) do - itemFamilyFlags[k] = v -end -local function PrintItemFamily(item) - local bagType = GetItemFamily(item) - print(format("0x%X", bagType)) - for k, v in pairs(itemFamilyFlags) do - if bit.band(bagType, k) > 0 then - print(format("0x%X, %s", k, v)) - end - end -end -PrintItemFamily(22786) -- Dreaming Glory --- 0x200020 --- 0x20, Herbs --- 0x200000, Alchemy -PrintItemFamily(190395) -- Serevite Ore --- 0x1400480 --- 0x80, Engineering Supplies --- 0x400, Mining Supplies --- 0x400000, Blacksmithing --- 0x1000000, Jewelcrafting -PrintItemFamily(37700) -- Crystallized Air --- 0x4004C8 --- 0x8, Leatherworking Supplies --- 0x40, Enchanting Supplies --- 0x80, Engineering Supplies --- 0x400, Mining Supplies --- 0x400000, Blacksmithing -PrintItemFamily(38347) -- Mammoth Mining Bag --- 0x400 --- 0x400, Mining Supplies -``` - -**Description:** -To simply check if an item is a bag, with itemEquipLoc: -```lua -select(9, GetItemInfo(item)) == "INVTYPE_BAG" -``` -Checking if an item is a specific type of bag, with item subclassID: -```lua -select(13, GetItemInfo(item)) == 4 -- Engineering Bag -``` - -**Reference:** -- `C_Container.GetContainerNumFreeSlots` - Returns the number of free slots & the bagType that an equipped bag or backpack belongs to. \ No newline at end of file diff --git a/wiki-information/functions/GetItemGem.md b/wiki-information/functions/GetItemGem.md deleted file mode 100644 index b3cd71b2..00000000 --- a/wiki-information/functions/GetItemGem.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetItemGem - -**Content:** -Returns the gem for a socketed equipment item. -`itemName, itemLink = GetItemGem(item, index)` - -**Parameters:** -- `item` - - *string* - The name of the equipment item (the item must be equipped or in your inventory for this to work) or the ItemLink -- `index` - - *number* - The index of the desired gem: 1, 2, or 3 - -**Returns:** -- `itemName` - - *string* - The name of the gem at the specified index. -- `itemLink` - - *string* - ItemLink - -**Description:** -Using the name may be ambiguous if you have more than one of the named item. - -**Usage:** -Prints the 2nd gem socketed in this item. -```lua -local link = "|cff0070dd|Hitem:87451:::41438:::::53:257:::1:6658:2:9:35:28:1035:::|h|h|r" -print(GetItemGem(link, 2)) -- "Perfect Brilliant Bloodstone", "|cff1eff00|Hitem:41438::::::::53:257:::::::|h|h|r" -``` \ No newline at end of file diff --git a/wiki-information/functions/GetItemIcon.md b/wiki-information/functions/GetItemIcon.md deleted file mode 100644 index 754e0d01..00000000 --- a/wiki-information/functions/GetItemIcon.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetItemIcon - -**Content:** -Returns the icon texture for an item. -`icon = GetItemIcon(itemID)` - -**Parameters:** -- `itemID` - - *number* - The ID of the item to query e.g. 23405 for . - -**Returns:** -- `icon` - - *number* : FileID - Icon texture used by the item. - -**Description:** -Unlike `GetItemInfo()`, this function does not require the item to be readily available from the item cache. \ No newline at end of file diff --git a/wiki-information/functions/GetItemInfo.md b/wiki-information/functions/GetItemInfo.md deleted file mode 100644 index e49369ce..00000000 --- a/wiki-information/functions/GetItemInfo.md +++ /dev/null @@ -1,86 +0,0 @@ -## Title: C_Item.GetItemInfo - -**Content:** -Returns info for an item. -`itemName, itemLink, itemQuality, itemLevel, itemMinLevel, itemType, itemSubType, itemStackCount, itemEquipLoc, itemTexture, sellPrice, classID, subclassID, bindType, expansionID, setID, isCraftingReagent = C_Item.GetItemInfo(itemInfo)` - -**Parameters:** -- `item` - - *number|string* : Item ID, Link or Name - - Accepts any valid item ID but returns nil if the item is not cached yet. - - Accepts an item link, or minimally in item:%d format. - - Accepts a localized item name but this requires the item to be or have been in the player's inventory (bags/bank) for that session. - -**Returns:** -Returns nil if the item is not cached yet or does not exist. -1. `itemName` - - *string* - The localized name of the item. -2. `itemLink` - - *string : ItemLink* - The localized link of the item. -3. `itemQuality` - - *number : Enum.ItemQuality* - The quality of the item, e.g. 2 for Uncommon and 3 for Rare quality items. -4. `itemLevel` - - *number* - The base item level, not including upgrades. See GetDetailedItemLevelInfo() for getting the actual item level. -5. `itemMinLevel` - - *number* - The minimum level required to use the item, or 0 if there is no level requirement. -6. `itemType` - - *string : ItemType* - The localized type name of the item: Armor, Weapon, Quest, etc. -7. `itemSubType` - - *string : ItemType* - The localized sub-type name of the item: Bows, Guns, Staves, etc. -8. `itemStackCount` - - *number* - The max amount of an item per stack, e.g. 200 for Runecloth. -9. `itemEquipLoc` - - *string : ItemEquipLoc* - The inventory equipment location in which the item may be equipped e.g. "INVTYPE_HEAD", or an empty string if it cannot be equipped. -10. `itemTexture` - - *number : FileID* - The texture for the item icon. -11. `sellPrice` - - *number* - The vendor price in copper, or 0 for items that cannot be sold. -12. `classID` - - *number : ItemType* - The numeric ID of itemType -13. `subclassID` - - *number : ItemType* - The numeric ID of itemSubType -14. `bindType` - - *number : Enum.ItemBind* - When the item becomes soulbound, e.g. 1 for Bind on Pickup items. -15. `expansionID` - - *number : LE_EXPANSION* - The related Expansion, e.g. 8 for Shadowlands. On Classic this appears to be always 254. -16. `setID` - - *number? : ItemSetID* - For example 761 for (itemID 21524). -17. `isCraftingReagent` - - *boolean* - Whether the item can be used as a crafting reagent. - -**Usage:** -Prints item information for -```lua -/dump GetItemInfo(4306) --- Returns: --- "Silk Cloth", -- itemName --- "|cffffffff|Hitem:4306::::::::53:258:::::::|h|h|r", -- itemLink --- 1, -- itemQuality: Enum.ItemQuality.Common --- 13, -- itemLevel --- 0, -- itemMinLevel --- "Tradeskill", -- itemType --- "Cloth", -- itemSubType --- 200, -- itemStackCount --- "", -- itemEquipLoc --- 132905, -- itemTexture --- 150, -- sellPrice --- 7, -- classID: LE_ITEM_CLASS_TRADEGOODS --- 5, -- subclassID --- 0, -- bindType: Enum.ItemBind.None --- 0, -- expansionID: LE_EXPANSION_CLASSIC --- nil, -- setID --- true -- isCraftingReagent -``` - -Item information may not have been cached. You can use `ItemMixin:ContinueOnItemLoad()` to asynchronously query the data. -```lua -local item = Item:CreateFromItemID(21524) -item:ContinueOnItemLoad(function() - local name = item:GetItemName() - local icon = item:GetItemIcon() - print(name, icon) -- "Red Winter Hat", 133169 -end) -``` - -**Reference:** -- `GetItemInfoInstant()` \ No newline at end of file diff --git a/wiki-information/functions/GetItemInfoInstant.md b/wiki-information/functions/GetItemInfoInstant.md deleted file mode 100644 index 59cec82e..00000000 --- a/wiki-information/functions/GetItemInfoInstant.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: C_Item.GetItemInfoInstant - -**Content:** -Returns readily available info for an item. -`itemID, itemType, itemSubType, itemEquipLoc, icon, classID, subClassID = C_Item.GetItemInfoInstant(itemInfo)` - -**Parameters:** -- `item` - - *number|string* : Item ID, Link or Name - - Accepts any valid item ID. - - Accepts an item link, or minimally in item:%d format. - - Accepts a localized item name but this requires the item to be or have been in the player's inventory (bags/bank) for that session. - -**Returns:** -- `itemID` - - *number* - ID of the item. -- `itemType` - - *string* : ItemType - The localized type name of the item: Armor, Weapon, Quest, etc. -- `itemSubType` - - *string* : ItemType - The localized sub-type name of the item: Bows, Guns, Staves, etc. -- `itemEquipLoc` - - *string* : ItemEquipLoc - The inventory equipment location in which the item may be equipped e.g. "INVTYPE_HEAD", or an empty string if it cannot be equipped. -- `icon` - - *number* : fileID - The texture for the item icon. -- `classID` - - *number* : ItemType - The numeric ID of itemType -- `subClassID` - - *number* : ItemType - The numeric ID of itemSubType - -**Description:** -This function only returns info that doesn't require a query to the server. Which has the advantage over `GetItemInfo()` as it will always return data for valid items. - -**Usage:** -Prints item information for -```lua -/dump GetItemInfoInstant(4306) --- Output: --- 4306, -- itemID --- "Tradeskill", -- itemType --- "Cloth", -- itemSubType --- "", -- itemEquipLoc --- 132905, -- icon --- 7, -- classID --- 5 -- subclassID -``` \ No newline at end of file diff --git a/wiki-information/functions/GetItemQualityColor.md b/wiki-information/functions/GetItemQualityColor.md deleted file mode 100644 index 59ea3fe9..00000000 --- a/wiki-information/functions/GetItemQualityColor.md +++ /dev/null @@ -1,49 +0,0 @@ -## Title: GetItemQualityColor - -**Content:** -Returns the color for an item quality. -`r, g, b, hex = GetItemQualityColor(quality)` - -**Parameters:** -- `quality` - - *Enum.ItemQuality* - The quality of the item. - -**Returns:** -- `r` - - *number* - Red component of the color (0 to 1, inclusive). -- `g` - - *number* - Green component of the color (0 to 1, inclusive). -- `b` - - *number* - Blue component of the color (0 to 1, inclusive). -- `hex` - - *string* - UI escape sequence for this color, without the leading `|c`. - -**Description:** -It is recommended to use the global `ITEM_QUALITY_COLORS` table instead of repeatedly calling this function. -In particular, `ITEM_QUALITY_COLORS.hex` already includes the leading `|c` escape sequence whereas the fourth return value of this function does not. -If an invalid quality index is specified, `GetItemQualityColor()` returns white (same as index 1): -- `r = 1` -- `g = 1` -- `b = 1` -- `hex = |cffffffff` - -**Usage:** -```lua -for i = 0, 8 do - local r, g, b, hex = GetItemQualityColor(i) - print(i, '|c'..hex, _G, string.sub(hex, 3)) -end -``` - -**Miscellaneous:** -**Result:** -Will print all qualities, in their individual colors. -- 0 Poor 9d9d9d -- 1 Common ffffff -- 2 Uncommon 1eff00 -- 3 Rare 0070dd -- 4 Epic a335ee -- 5 Legendary ff8000 -- 6 Artifact e6cc80 -- 7 Heirloom 00ccff -- 8 WoW Token 00ccff \ No newline at end of file diff --git a/wiki-information/functions/GetItemSpecInfo.md b/wiki-information/functions/GetItemSpecInfo.md deleted file mode 100644 index 1592c78b..00000000 --- a/wiki-information/functions/GetItemSpecInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetItemSpecInfo - -**Content:** -Returns which specializations an item is useful for. -`specTable = GetItemSpecInfo(itemLink or itemID or itemName)` - -**Parameters:** -- `itemLink` or `itemID` or `itemName` - - *Mixed* - link, id, or name of the item to query. -- `specTable` - - *table* - if provided, this table will be populated with the results and returned; otherwise, a new table will be created. - -**Returns:** -- `specTable` - - *table* - if the item is flagged as being for specific specializations, an array containing the SpecializationIDs of specializations of the player's class for which the queried item is suitable; nil if information is unavailable. - -**Description:** -The supplied specTable is not wiped; only the array keys necessary to return the result are modified. -Spec information is only available for some items. -The returned specialization IDs are not sorted. You can use `table.sort` to bring them into the same order as the Specialization pane displays. - -**Reference:** -- `GetSpecializationInfoByID` \ No newline at end of file diff --git a/wiki-information/functions/GetItemSpell.md b/wiki-information/functions/GetItemSpell.md deleted file mode 100644 index 48369dcd..00000000 --- a/wiki-information/functions/GetItemSpell.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetItemSpell - -**Content:** -Returns the spell effect for an item. -`spellName, spellID = GetItemSpell(itemID or itemString or itemName or itemLink)` - -**Parameters:** -One of the following four ways to specify which item to query: -- `itemId` - - *number* - Numeric ID of the item. -- `itemName` - - *string* - Name of an item owned by the player at some point during this session. -- `itemString` - - *string* - A fragment of the itemString for the item, e.g. `"item:30234:0:0:0:0:0:0:0"` or `"item:30234"`. -- `itemLink` - - *string* - The full itemLink. - -**Returns:** -- `spellName` - - *string* - The name of the spell. -- `spellID` - - *number* - The spell's unique identifier. - -**Description:** -Useful for determining whether an item is usable. \ No newline at end of file diff --git a/wiki-information/functions/GetItemStats.md b/wiki-information/functions/GetItemStats.md deleted file mode 100644 index 88ac70c0..00000000 --- a/wiki-information/functions/GetItemStats.md +++ /dev/null @@ -1,43 +0,0 @@ -## Title: GetItemStats - -**Content:** -Returns a table of stats for an item. -`stats = GetItemStats(itemLink)` - -**Parameters:** -- `itemLink` - - *String* - An item link for which to get stats. -- `statTable` - - *Table* - An optional, empty table that will be filled with stats and returned. If this parameter is omitted, a new table is returned. - -**Returns:** -- `stats` - - *Table* - A table of item stats. If `statTable` was supplied, it will also be returned. - -**Usage:** -The key for each entry in the dictionary is the name of a constant in `Interface\\FrameXML\\GlobalStrings.lua`, and the value of that constant is the localized name for the stat. For example, an item that has 10 Stamina and no other stats would return `{ "ITEM_MOD_STAMINA_SHORT" = 10 }`. - -```lua -stats = GetItemStats(GetInventoryItemLink("player", 16)) -DEFAULT_CHAT_FRAME:AddMessage("Your main hand item has " .. tostring(stats or 0) .. " " .. ITEM_MOD_STAMINA_SHORT .. ".") -``` - -This would return something like: -``` -Your main hand item has 10 Stamina. -``` - -The stat table contains the stats for the "base" version of an item, without any enchantments or gems. There is no way to get the stats for the gemmed and enchanted version of an item. - -**Description:** -If `statTable` is supplied, it should be empty. `GetItemStats` will add the stats of the item to this table without clearing it first. Stats left over from a previous call to `GetItemStats` will be overwritten if present on the new item. For example, if the table already contains 10 Strength and 20 Stamina and `GetItemStats` is called on an item with 30 Intellect and 30 Stamina, the new table will contain 10 Strength, 30 Intellect, and 30 Stamina, not 50 Stamina. - -```lua -local stats = {} -GetItemStats("item:41002", stats) -table.wipe(stats) -GetItemStats("item:41003", stats) -``` - -**Example Use Case:** -This function can be used in addons that need to display or process item stats, such as gear comparison tools or inventory management addons. For instance, the popular addon Pawn uses similar functionality to evaluate and compare the stats of different items to help players choose the best gear. \ No newline at end of file diff --git a/wiki-information/functions/GetItemSubClassInfo.md b/wiki-information/functions/GetItemSubClassInfo.md deleted file mode 100644 index 2a10cd02..00000000 --- a/wiki-information/functions/GetItemSubClassInfo.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: GetItemSubClassInfo - -**Content:** -Returns the name of the item subtype. -`name, isArmorType = GetItemSubClassInfo(classID, subClassID)` - -**Parameters:** -- `classID` - - *number* - ID of the ItemType -- `subClassID` - - *number* - ID of the item subtype - -**Returns:** -- `name` - - *string* - Name of the item subtype -- `isArmorType` - - *boolean* - Seems to only return true for classID 4: Armor - subClassID 0 to 4 Miscellaneous, Cloth, Leather, Mail, Plate - -**Usage:** -Prints the Herbalism subtype for the Profession itemtype. -```lua -print(GetItemSubClassInfo(Enum.ItemClass.Profession, Enum.ItemProfessionSubclass.Herbalism)) --- "Herbalism", false -``` - -Prints the info of all Profession subtypes. -```lua -for i = Enum.ItemProfessionSubclassMeta.MinValue, Enum.ItemProfessionSubclassMeta.MaxValue do - print(i, GetItemSubClassInfo(Enum.ItemClass.Profession, i)) -end --- Output: --- 0, "Blacksmithing", false --- 1, "Leatherworking", false --- 2, "Alchemy", false --- 3, "Herbalism", false --- 4, "Cooking", false --- 5, "Mining", false --- 6, "Tailoring", false --- 7, "Engineering", false --- 8, "Enchanting", false --- 9, "Fishing", false --- 10, "Skinning", false --- 11, "Jewelcrafting", false --- 12, "Inscription", false --- 13, "Archaeology", false -``` - -**Reference:** -- `GetItemClassInfo` -- `GetItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetLFGBootProposal.md b/wiki-information/functions/GetLFGBootProposal.md deleted file mode 100644 index 24c13c77..00000000 --- a/wiki-information/functions/GetLFGBootProposal.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetLFGBootProposal - -**Content:** -Returns info for a LFG votekick in progress. -`inProgress, didVote, myVote, targetName, totalVotes, bootVotes, timeLeft, reason = GetLFGBootProposal()` - -**Returns:** -- `inProgress` - - *boolean* - true if a Kick vote is currently in progress, false otherwise. -- `didVote` - - *boolean* - true if you have already voted, false otherwise. -- `myVote` - - *boolean* - true if you've voted to kick the player, false otherwise. -- `targetName` - - *string* - name of the player being voted on. -- `totalVotes` - - *number* - total votes cast so far. -- `bootVotes` - - *number* - votes in favor of kicking the player cast so far. -- `timeLeft` - - *number* - amount of time left to vote. -- `reason` - - *string* - reason given for initiating a vote kick vote against a player. - -**Reference:** -- `LFG_BOOT_PROPOSAL_UPDATE` - -**Example Usage:** -This function can be used in addons that manage or monitor group activities, such as those that provide enhanced LFG (Looking For Group) functionalities. For instance, an addon could use this function to display a custom UI element showing the status of a votekick, including who is being voted on and how much time is left to vote. - -**Addons Using This Function:** -Large addons like Deadly Boss Mods (DBM) or ElvUI might use this function to provide additional context or alerts during group activities, ensuring that players are aware of ongoing votekicks and can participate in the decision-making process. \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDeserterExpiration.md b/wiki-information/functions/GetLFGDeserterExpiration.md deleted file mode 100644 index 76946a4e..00000000 --- a/wiki-information/functions/GetLFGDeserterExpiration.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetLFGDeserterExpiration - -**Content:** -Returns the time at which you may once again use the dungeon finder after prematurely leaving a group. -`expiryTime = GetLFGDeserterExpiration()` - -**Returns:** -- `expiryTime` - - *number?* - time (GetTime() value) at which you may once again use the dungeon finder; nil if you're not currently under the effects of the deserter penalty. - -**Reference:** -- `GetLFGRandomCooldownExpiration` -- `UnitHasLFGDeserter` - -**Example Usage:** -```lua -local expiryTime = GetLFGDeserterExpiration() -if expiryTime then - print("You can use the dungeon finder again at: " .. date("%Y-%m-%d %H:%M:%S", expiryTime)) -else - print("You are not currently under the deserter penalty.") -end -``` - -**Addons Using This Function:** -- **DBM (Deadly Boss Mods):** Utilizes this function to inform players about their deserter status and when they can rejoin the dungeon finder. -- **ElvUI:** Uses this function to display cooldown timers for various penalties, including the deserter debuff, in its user interface. \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonEncounterInfo.md b/wiki-information/functions/GetLFGDungeonEncounterInfo.md deleted file mode 100644 index 22fee11e..00000000 --- a/wiki-information/functions/GetLFGDungeonEncounterInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetLFGDungeonEncounterInfo - -**Content:** -Returns info about a specific encounter in an LFG/RF dungeon. -`bossName, texture, isKilled, unknown4 = GetLFGDungeonEncounterInfo(dungeonID, encounterIndex)` - -**Parameters:** -- `dungeonID` - - *number* - Ranging from 1 to around 2000 in patch 8.1.5 -- `encounterIndex` - - *number* - Index from 1 to `GetLFGDungeonNumEncounters()`. For multi-part raids, many bosses will never be accessible to players because they were in an earlier 'wing'. - -**Returns:** -- `bossName` - - *string* - The localized name of the encounter in question -- `texture` - - *string* - The file path for a texture associated with the encounter, usually an achievement icon. If Blizzard hasn't designated one for the encounter, expect this return to be nil. -- `isKilled` - - *boolean* - True if you have killed/looted the boss since the last reset period -- `unknown4` - - *boolean* - Unused by Blizzard, has an unknown purpose, and seems to always be false - -**Usage:** -```lua -/dump GetLFGDungeonEncounterInfo(610,1) --- => "Jin'rokh the Breaker", nil, true, false -``` - -**Reference:** -- `GetSavedInstanceEncounterInfo` - A moderately similar function to this one, except it works off of saved instance indexes instead of dungeon IDs. -- `GetLFGDungeonInfo` - A more generic function; it allows you to pull up information on the dungeon itself instead of the individual encounters. \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonInfo.md b/wiki-information/functions/GetLFGDungeonInfo.md deleted file mode 100644 index 51025945..00000000 --- a/wiki-information/functions/GetLFGDungeonInfo.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: GetLFGDungeonInfo - -**Content:** -Returns info for a LFG dungeon. -```lua -name, typeID, subtypeID, minLevel, maxLevel, recLevel, minRecLevel, maxRecLevel, expansionLevel, groupID, textureFilename, difficulty, maxPlayers, description, isHoliday, bonusRepAmount, minPlayers, isTimeWalker, name2, minGearLevel, isScalingDungeon, lfgMapID = GetLFGDungeonInfo(dungeonID) -``` - -**Parameters:** -- `dungeonID` - - *number* : LfgDungeonID - -**Returns:** -1. `name` - - *string* - The name of the dungeon/event -2. `typeID` - - *number* - 1=TYPEID_DUNGEON or LFR, 2=raid instance, 4=outdoor area, 6=TYPEID_RANDOM_DUNGEON -3. `subtypeID` - - *number* - 0=Unknown, 1=LFG_SUBTYPEID_DUNGEON, 2=LFG_SUBTYPEID_HEROIC, 3=LFG_SUBTYPEID_RAID, 4=LFG_SUBTYPEID_SCENARIO, 5=LFG_SUBTYPEID_FLEXRAID -4. `minLevel` - - *number* - Earliest level permitted to walk into the instance portal -5. `maxLevel` - - *number* - Highest level permitted to walk into the instance portal -6. `recLevel` - - *number* - Recommended level to queue for this dungeon -7. `minRecLevel` - - *number* - Earliest level to queue for this dungeon -8. `maxRecLevel` - - *number* - Highest level to queue for this dungeon -9. `expansionLevel` - - *number* - Refers to GetAccountExpansionLevel() values -10. `groupID` - - *number* - Unknown -11. `textureFilename` - - *string* - For example "Interface\\LFDFRAME\\LFGIcon-%s.blp" where %s is the textureFilename value -12. `difficulty` - - *number* : DifficultyID -13. `maxPlayers` - - *number* - Maximum players allowed -14. `description` - - *string* - Usually empty for most dungeons but events contain descriptions of the event, like Love is in the Air daily or Brewfest, e.g. (string) -15. `isHoliday` - - *boolean* - If true then this is a holiday event -16. `bonusRepAmount` - - *number* - Unknown -17. `minPlayers` - - *number* - Minimum number of players (before the group disbands?); usually nil -18. `isTimeWalker` - - *boolean* - If true then it's Timewalking Dungeon -19. `name2` - - *string* - Currently unknown. Note: seems to show the alternative name used by the Instance Lockout interface, as returned by GetSavedInstanceInfo(). -20. `minGearLevel` - - *number* - The minimum average item level to queue for this dungeon; may be 0 if item level is ignored. -21. `isScalingDungeon` - - *boolean* -22. `lfgMapID` - - *number* : InstanceID - -**Reference:** -- `GetSavedInstanceInfo` - A similar function to this, except for the player's saved dungeon/raid lockout data (does not include Raid Finder) -- `GetSavedWorldBossInfo` - A similar function to this, except for the player's saved world boss lockout data -- `GetRFDungeonInfo` - Almost completely identical; this function uses Raid Finder indexes instead of dungeon IDs -- `GetLFGDungeonEncounterInfo` - A more specific function; this lets you check up on the individual encounters within a given LFG Dungeon \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonNumEncounters.md b/wiki-information/functions/GetLFGDungeonNumEncounters.md deleted file mode 100644 index 4c070c8b..00000000 --- a/wiki-information/functions/GetLFGDungeonNumEncounters.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetLFGDungeonNumEncounters - -**Content:** -Returns the number of encounters and number of completed encounters for a specified dungeon ID. -`numEncounters, numCompleted = GetLFGDungeonNumEncounters(dungeonID)` - -**Parameters:** -- `dungeonID` - - *number* : LfgDungeonID - -**Returns:** -- `numEncounters` - - *number* - Number of encounters in the specified dungeon. -- `numCompleted` - - *number* - Number of completed encounters in the specified dungeon. - -**Reference:** -- `GetLFGDungeonInfo` -- `GetRFDungeonInfo` -- `GetLFGDungeonEncounterInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md b/wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md deleted file mode 100644 index 131215b8..00000000 --- a/wiki-information/functions/GetLFGDungeonRewardCapBarInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetLFGDungeonRewardCapBarInfo - -**Content:** -Returns the weekly limits reward for a currency (e.g. Valor Point Cap). -`VALOR_TIER1_LFG_ID = 301` -`currencyID, DungeonID, Quantity, Limit, overallQuantity, overallLimit, periodPurseQuantity, periodPurseLimit, purseQuantity, purseLimit = GetLFGDungeonRewardCapBarInfo(VALOR_TIER1_LFG_ID)` - -**Parameters:** -- `VALOR_TIER1_LFG_ID` - - *Number* - ID of the dungeon type for which information is being sought (currently 301) - -**Returns:** -- `currencyID` - - *number* - ID for the currency -- `DungeonID` - - *number* - ID for the dungeon type -- `Quantity` - - *number* - Quantity gained from basic dungeons -- `Limit` - - *number* - Limit gained from basic dungeons -- `overallQuantity` - - *number* - Quantity gained from high-end dungeons (Zandalari) -- `overallLimit` - - *number* - Limit gained from high-end dungeons (Zandalari) -- `periodPurseQuantity` - - *number* - Quantity gained from all sources (raids) -- `periodPurseLimit` - - *number* - Limit gained from all sources (raids) -- `purseQuantity` - - *number* - Currently possessed amount -- `purseLimit` - - *number* - Limit for possessed amount \ No newline at end of file diff --git a/wiki-information/functions/GetLFGRoles.md b/wiki-information/functions/GetLFGRoles.md deleted file mode 100644 index 8cd2241a..00000000 --- a/wiki-information/functions/GetLFGRoles.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetLFGRoles - -**Content:** -Returns the roles the player signed up for in the Dungeon Finder. -`isLeader, isTank, isHealer, isDPS = GetLFGRoles()` - -**Returns:** -- `isLeader` - - *boolean* - if you signed up as a candidate for group leader -- `isTank` - - *boolean* - if you signed up as a tank -- `isHealer` - - *boolean* - if you signed up as a healer -- `isDPS` - - *boolean* - if you signed up as DPS \ No newline at end of file diff --git a/wiki-information/functions/GetLanguageByIndex.md b/wiki-information/functions/GetLanguageByIndex.md deleted file mode 100644 index fcad727e..00000000 --- a/wiki-information/functions/GetLanguageByIndex.md +++ /dev/null @@ -1,74 +0,0 @@ -## Title: GetLanguageByIndex - -**Content:** -Returns the languages that the character can speak by index. -`language, languageID = GetLanguageByIndex(index)` - -**Parameters:** -- `index` - - *number* - Ranging from 1 up to `GetNumLanguages()` - -**Values:** -- `ID` -- `Name` -- `Patch` - - 1: Orcish - - 2: Darnassian - - 3: Taurahe - - 6: Dwarvish - - 7: Common - - 8: Demonic - - 9: Titan - - 10: Thalassian - - 11: Draconic - - 12: Kalimag - - 13: Gnomish - - 14: Zandali - - 33: Forsaken (1.0.0) - - 35: Draenei (2.0.0) - - 36: Zombie (2.4.3) - - 37: Gnomish Binary (2.4.3) - - 38: Goblin Binary (2.4.3) - - 39: Gilnean (4.0.1) - - 40: Goblin (4.0.1) - - 42: Pandaren (5.0.3) - - 43: Pandaren (5.0.3) - - 44: Pandaren (5.0.3) - - 168: Sprite (5.0.3) - - 178: Shath'Yar (6.x / 7.x) - - 179: Nerglish (6.x / 7.x) - - 180: Moonkin (6.x / 7.x) - - 181: Shalassian (7.3.5) - - 182: Thalassian (7.3.5) - - 285: Vulpera (8.3.0) - - 287: Complex Cipher (9.2.0) - - 288: Basic Cypher (9.2.0) - - 290: Metrial (9.2.0) - - 291: Altonian (9.2.0) - - 292: Sopranian (9.2.0) - - 293: Aealic (9.2.0) - - 294: Dealic (9.2.0) - - 295: Trebelim (9.2.0) - - 296: Bassalim (9.2.0) - - 297: Embedded Languages (9.2.0) - - 298: Unknowable (9.2.0) - - 303: Furbolg (10.0.7) - -**Returns:** -- `language` - - *string* -- `languageID` - - *number* - LanguageID - -**Usage:** -Prints the available languages for the player. -```lua -for i = 1, GetNumLanguages() do - print(GetLanguageByIndex(i)) -end -``` --- e.g. for Blood elf -```lua -> "Orcish", 1 -> "Thalassian", 10 -``` \ No newline at end of file diff --git a/wiki-information/functions/GetLatestThreeSenders.md b/wiki-information/functions/GetLatestThreeSenders.md deleted file mode 100644 index 532f35a4..00000000 --- a/wiki-information/functions/GetLatestThreeSenders.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetLatestThreeSenders - -**Content:** -Returns up to three senders of unread mail. -`sender1, sender2, sender3 = GetLatestThreeSenders()` - -**Returns:** -- `sender1, sender2, sender3` - - *String/nil* - Name of the sender ("Bob", "Alliance Auction House", ...), or nil if unavailable. \ No newline at end of file diff --git a/wiki-information/functions/GetLocale.md b/wiki-information/functions/GetLocale.md deleted file mode 100644 index 16c38f96..00000000 --- a/wiki-information/functions/GetLocale.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetLocale - -**Content:** -Returns the game client locale. -`locale = GetLocale()` - -**Returns:** -- `locale` - - *string* - -**Usage:** -```lua -if GetLocale() == "frFR" then - print("bonjour") -else - print("hello") -end -``` - -**Parameters:** -- `localeId` -- `localeName` - -**Description:** -1. `enUS` - English (United States) (enGB clients return enUS) -2. `koKR` - Korean (Korea) -3. `frFR` - French (France) -4. `deDE` - German (Germany) -5. `zhCN` - Chinese (Simplified, PRC) -6. `esES` - Spanish (Spain) -7. `zhTW` - Chinese (Traditional, Taiwan) -8. `esMX` - Spanish (Mexico) -9. `ruRU` - Russian (Russia) -10. `ptBR` - Portuguese (Brazil) -11. `itIT` - Italian (Italy) \ No newline at end of file diff --git a/wiki-information/functions/GetLootInfo.md b/wiki-information/functions/GetLootInfo.md deleted file mode 100644 index 70d9b47a..00000000 --- a/wiki-information/functions/GetLootInfo.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetLootInfo - -**Content:** -Returns a table with all of the loot info for the current loot window. -`info = GetLootInfo()` - -**Returns:** -- `info` - - *table* - - `Field` - - `Type` - - `Description` - - `isQuestItem` - - *boolean?* - - `item` - - *string* - Item Name, e.g. "Linen Cloth" or "65 Copper" - - `locked` - - *boolean* - Whether you are eligible to loot this item or not. Locked items are by default shown tinted red. - - `quality` - - *number* - Item Quality - - `quantity` - - *number* - The quantity of the item in a stack. The quantity for coin is always 0. - - `roll` - - *boolean* - - `texture` - - *number* - Texture FileID - -**Reference:** -- `GetLootSlotInfo` -- `LOOT_READY` - When this event fires, the function will have new data available. \ No newline at end of file diff --git a/wiki-information/functions/GetLootMethod.md b/wiki-information/functions/GetLootMethod.md deleted file mode 100644 index a6809241..00000000 --- a/wiki-information/functions/GetLootMethod.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetLootMethod - -**Content:** -Returns the current loot method. -`lootmethod, masterlooterPartyID, masterlooterRaidID = GetLootMethod()` - -**Returns:** -- `lootmethod` - - *string (LootMethod)* - One of 'freeforall', 'roundrobin', 'master', 'group', 'needbeforegreed', 'personalloot'. Appears to be 'freeforall' if you are not grouped. -- `masterlooterPartyID` - - *number* - Returns 0 if player is the master looter, 1-4 if party member is master looter (corresponding to party1-4) and nil if the master looter isn't in the player's party or master looting is not used. -- `masterlooterRaidID` - - *number* - Returns index of the master looter in the raid (corresponding to a raidX unit), or nil if the player is not in a raid or master looting is not used. \ No newline at end of file diff --git a/wiki-information/functions/GetLootRollItemInfo.md b/wiki-information/functions/GetLootRollItemInfo.md deleted file mode 100644 index aa6816f0..00000000 --- a/wiki-information/functions/GetLootRollItemInfo.md +++ /dev/null @@ -1,48 +0,0 @@ -## Title: GetLootRollItemInfo - -**Content:** -Returns information about the loot event with rollID. -`texture, name, count, quality, bindOnPickUp, canNeed, canGreed, canDisenchant, reasonNeed, reasonGreed, reasonDisenchant, deSkillRequired, canTransmog = GetLootRollItemInfo(rollID)` - -**Parameters:** -- `rollID` - - *number* - The number increments by 1 for each new roll. The count is not reset by reloading the UI. - -**Returns:** -- `texture` - - *string* - The path of the texture of the item icon. -- `name` - - *string* - The name of the item. -- `count` - - *number* - The quantity of the item. -- `quality` - - *number* - The quality of the item. Starting with 1 for common, going up to 5 for legendary. -- `bindOnPickUp` - - *boolean* - Returns 1 when the item is bind on pickup, nil otherwise. -- `canNeed` - - *boolean* - Returns 1 when you can roll need on the item, nil otherwise. -- `canGreed` - - *boolean* - Returns 1 when you can roll greed on the item, nil otherwise. -- `canDisenchant` - - *boolean* - Returns 1 when you can disenchant the item, nil otherwise. -- `reasonNeed` - - *number* - See details. -- `reasonGreed` - - *number* - See details. -- `reasonDisenchant` - - *number* - See details. -- `deSkillRequired` - - *number* - Required skill in enchanting to disenchant the item. -- `canTransmog` - - *boolean* - Returns 1 when you can transmogrify the item, nil otherwise. - -**Description:** -The return values `reasonNeed`/`reasonGreed`/`reasonDisenchant` can be numbers from 0 to 5. The following logic is used in FrameXML: -If the player cannot roll need/greed/disenchant, the respective loot button is disabled and gets a tooltip from one of the following global strings, where the number is determined by the return values `reasonNeed`/`reasonGreed`/`reasonDisenchant`: -- `LOOT_ROLL_INELIGIBLE_REASON1`: "Your class may not roll need on this item." -- `LOOT_ROLL_INELIGIBLE_REASON2`: "You already have the maximum amount of this item." -- `LOOT_ROLL_INELIGIBLE_REASON3`: "This item may not be disenchanted." -- `LOOT_ROLL_INELIGIBLE_REASON4`: "You do not have an Enchanter of skill %d in your group." -- `LOOT_ROLL_INELIGIBLE_REASON5`: "Need rolls are disabled for this item." - -For example, `NeedButton.reason = _G`. If the player can roll need/greed/disenchant, the respective value of `reasonNeed`/`reasonGreed`/`reasonDisenchant` returns 0. \ No newline at end of file diff --git a/wiki-information/functions/GetLootRollItemLink.md b/wiki-information/functions/GetLootRollItemLink.md deleted file mode 100644 index 6c513743..00000000 --- a/wiki-information/functions/GetLootRollItemLink.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetLootRollItemLink - -**Content:** -Retrieves the itemLink of an item being rolled on. -`itemLink = GetLootRollItemLink(id)` - -**Parameters:** -- `id` - - *number* - id is a number used by the server to keep track of items being rolled on. It is generated server side and transmitted to the client. - -**Returns:** -- `itemLink` - - *itemLink* - -**Example Usage:** -This function can be used in an addon to display the item link of an item currently being rolled on in a loot roll frame. For instance, an addon could use this to show detailed information about the item to help players decide whether to roll Need, Greed, or Pass. - -**Addons Using This Function:** -Many loot management addons, such as "LootRollManager" or "XLoot", use this function to enhance the default loot roll interface by providing additional item information and customization options. \ No newline at end of file diff --git a/wiki-information/functions/GetLootSlotInfo.md b/wiki-information/functions/GetLootSlotInfo.md deleted file mode 100644 index e95b0bbc..00000000 --- a/wiki-information/functions/GetLootSlotInfo.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: GetLootSlotInfo - -**Content:** -Returns info for a loot slot. -`lootIcon, lootName, lootQuantity, currencyID, lootQuality, locked, isQuestItem, questID, isActive = GetLootSlotInfo(slot)` - -**Parameters:** -- `slot` - - *number* - the index of the loot (1 is the first item, typically coin) - -**Returns:** -- `lootIcon` - - *string* - The path of the graphical icon for the item. -- `lootName` - - *string* - The name of the item. -- `lootQuantity` - - *number* - The quantity of the item in a stack. Note: Quantity for coin is always 0. -- `currencyID` - - *number* - The identifying number of the currency loot in slot, if applicable. Note: Returns nil for slots with coin and regular items. -- `lootQuality` - - *number* - The Enum.ItemQuality code for the item. -- `locked` - - *boolean* - Whether you are eligible to loot this item or not. Locked items are by default shown tinted red. -- `isQuestItem` - - *boolean* - Self-explanatory. -- `questID` - - *number* - The identifying number for the quest. -- `isActive` - - *boolean* - True if the item starts a quest that you are not currently on. - -**Description:** -When returning coin data, the 'quantity' is always 0 and the 'item' contains the amount and text. It also includes a line break after each type of coin. The linebreak can be removed by string substitution. -`print("coins: "..string.gsub(item,"\\n"," "))` - -**Reference:** -- `GetLootSourceInfo` -- `GetLootSlotLink` -- `GetLootSlotType` \ No newline at end of file diff --git a/wiki-information/functions/GetLootSlotLink.md b/wiki-information/functions/GetLootSlotLink.md deleted file mode 100644 index 5e5a802d..00000000 --- a/wiki-information/functions/GetLootSlotLink.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetLootSlotLink - -**Content:** -Returns the item link for a loot slot. -`itemLink = GetLootSlotLink(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the list to retrieve info from (1 to GetNumLootItems()) - -**Returns:** -- `itemLink` - - *string* - The itemLink for the specified item, or nil if index is invalid. - -**Usage:** -The example below will display the item links into your chat window. -```lua -local linkstext = "" -for index = 1, GetNumLootItems() do - if LootSlotHasItem(index) then - local itemLink = GetLootSlotLink(index) - linkstext = linkstext .. itemLink - end -end -print(linkstext) -``` - -**Example Use Case:** -This function can be used in addons that manage loot distribution or display loot information. For instance, an addon like "LootMaster" might use this function to retrieve and display item links for all items in a loot window, allowing raid leaders to distribute loot more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetLootSlotType.md b/wiki-information/functions/GetLootSlotType.md deleted file mode 100644 index e7c5ddae..00000000 --- a/wiki-information/functions/GetLootSlotType.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: GetLootSlotType - -**Content:** -Returns an integer loot type for a given loot slot. -`slotType = GetLootSlotType(slotIndex)` - -**Parameters:** -- `slotIndex` - - *number* - Position in loot window to query, from 1 - `GetNumLootItems()`. - -**Returns:** -- `slotType` - - *number* - Type ID indicating slot content type: - - `0`: `LOOT_SLOT_NONE` / `Enum.LootSlotType.None` - No contents - - `1`: `LOOT_SLOT_ITEM` / `Enum.LootSlotType.Item` - A regular item - - `2`: `LOOT_SLOT_MONEY` / `Enum.LootSlotType.Money` - Gold/silver/copper coin - - `3`: `LOOT_SLOT_CURRENCY` / `Enum.LootSlotType.Currency` - Other currency amount, such as - -As of 10.0.0.46455 the constants `LOOT_SLOT_NONE`, `LOOT_SLOT_ITEM`, `LOOT_SLOT_MONEY`, `LOOT_SLOT_CURRENCY` are no longer defined. A new enumerator table is defined (`Enum.LootSlotType`) with the same values. - -**Usage:** -The following snippet takes all items from the open loot window, leaving other loot types: -```lua -for slot = 1, GetNumLootItems() do - if GetLootSlotType(slot) == Enum.LootSlotType.Item then - LootSlot(slot); - end -end -``` - -**Reference:** -- `GetNumLootItems` -- `LootSlot` -- `LOOT_OPENED` \ No newline at end of file diff --git a/wiki-information/functions/GetLootSourceInfo.md b/wiki-information/functions/GetLootSourceInfo.md deleted file mode 100644 index bccf1463..00000000 --- a/wiki-information/functions/GetLootSourceInfo.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetLootSourceInfo - -**Content:** -Returns information about the source of the objects in a loot slot. -`guid, quantity, ... = GetLootSourceInfo(lootSlot)` - -**Parameters:** -- `lootSlot` - - *number* - index of the loot slot, ascending from 1 up to `GetNumLootItems()` - -**Returns:** -(Variable returns: `guid1, quantity1, guid2, quantity2, ...`) -- `guid` - - *string* - GUID of the source being looted. Can also return GameObject GUIDs for objects like ore veins and herbs, and Item GUIDs for containers like lockboxes. -- `quantity` - - *number* - Quantity of the object being looted from this source. - -**Usage:** -Prints out the source GUID and quantity of each loot source item individually. -```lua -local function OnEvent(self, event) - for i = 1, GetNumLootItems() do - local sources = {GetLootSourceInfo(i)} - local _, name = GetLootSlotInfo(i) - for j = 1, #sources, 2 do - print(i, name, j, sources[j], sources[j+1]) - end - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("LOOT_OPENED") -f:SetScript("OnEvent", OnEvent) -``` - -**Reference:** -- `GetLootSlotInfo()` \ No newline at end of file diff --git a/wiki-information/functions/GetLootThreshold.md b/wiki-information/functions/GetLootThreshold.md deleted file mode 100644 index 3499e09f..00000000 --- a/wiki-information/functions/GetLootThreshold.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetLootThreshold - -**Content:** -Returns the loot threshold quality for e.g. master loot. -`threshold = GetLootThreshold()` - -**Returns:** -- `threshold` - - *number* - The minimum quality of item which will be rolled for or assigned by the master looter. The value is 0 to 7, which represents Poor to Heirloom. - -**Example Usage:** -This function can be used to determine the current loot threshold in a group or raid setting. For instance, if you are developing an addon that needs to display or adjust loot settings, you can use `GetLootThreshold` to fetch the current threshold and make decisions based on it. - -**Addons Using This Function:** -Many raid management addons, such as "Deadly Boss Mods" (DBM) and "BigWigs", use this function to ensure that loot distribution settings are appropriate for the encounter difficulty and group composition. \ No newline at end of file diff --git a/wiki-information/functions/GetMacroBody.md b/wiki-information/functions/GetMacroBody.md deleted file mode 100644 index 14cd1404..00000000 --- a/wiki-information/functions/GetMacroBody.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetMacroBody - -**Content:** -Returns the body (macro text) of a macro. -`body = GetMacroBody(macro)` - -**Parameters:** -- `macro` - - *number|string* - Macro index or name. - -**Returns:** -- `body` - - *string?* - The macro body or nothing if the macro doesn't exist. - -**Usage:** -```lua -/dump GetMacroBody("Flash Heal") --- Output: "#showtooltip\n/cast Flash Heal\n" -``` - -**Example Use Case:** -This function can be used to retrieve the text of a macro for inspection or modification. For instance, an addon could use this to check if a specific macro exists and then update its content based on certain conditions. - -**Addons Using This Function:** -Many macro management addons, such as "GSE: Gnome Sequencer Enhanced", use this function to read and manipulate macro texts programmatically. This allows users to create complex sequences and automate their gameplay more effectively. \ No newline at end of file diff --git a/wiki-information/functions/GetMacroIndexByName.md b/wiki-information/functions/GetMacroIndexByName.md deleted file mode 100644 index 3511b269..00000000 --- a/wiki-information/functions/GetMacroIndexByName.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetMacroIndexByName - -**Content:** -Returns the index for a macro by name. -`macroSlot = GetMacroIndexByName(name)` - -**Parameters:** -- `name` - - *string* - Macro name to query. - -**Returns:** -- `macroSlot` - - *number* - Macro slot index containing a macro with the queried name, or 0 if no such slot exists. - -**Description:** -Slots 1-120 are used for general macros, and 121-138 for character-specific macros. - -**Reference:** -[GetMacroInfo](https://wowpedia.fandom.com/wiki/API_GetMacroInfo) \ No newline at end of file diff --git a/wiki-information/functions/GetMacroInfo.md b/wiki-information/functions/GetMacroInfo.md deleted file mode 100644 index bfb52a80..00000000 --- a/wiki-information/functions/GetMacroInfo.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetMacroInfo - -**Content:** -Returns info for a macro. -`name, icon, body = GetMacroInfo(macro)` - -**Parameters:** -- `macro` - - *number|string* - Macro slot index or the name of the macro. Slots 1 through 120 are general macros; 121 through 138 are per-character macros. - -**Returns:** -- `name` - - *string* - The name of the macro. -- `icon` - - *number : fileID* - Macro icon texture. -- `body` - - *string* - Macro contents. \ No newline at end of file diff --git a/wiki-information/functions/GetMacroSpell.md b/wiki-information/functions/GetMacroSpell.md deleted file mode 100644 index db8e4d02..00000000 --- a/wiki-information/functions/GetMacroSpell.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: GetMacroSpell - -**Content:** -Returns information about the spell a given macro is set to cast. -`id = GetMacroSpell(slot or macroName)` - -**Parameters:** -- `slot` - - *number* - The macro slot to query. -- `macroName` - - *string* - The name of the macro to query. - -**Returns:** -- `id` - - *number* - The ability's spellId. - -**Description:** -Action-bar addons use this function to display dynamic macro icons, tooltips, and glow effects. As a macro's cast sequence changes, this function indicates which will be cast next. - -**Usage:** -```lua -local macroName = "MyMacro" -local index = GetMacroIndexByName(macroName) -if index then - local spellId = GetMacroSpell(index) - if spellId then - print(macroName .. " will now cast " .. GetSpellLink(spellId)) - end -end -``` - -**Reference:** -- Aerythlea 2018-11-14. Battle for Azeroth Addon Changes. \ No newline at end of file diff --git a/wiki-information/functions/GetManaRegen.md b/wiki-information/functions/GetManaRegen.md deleted file mode 100644 index 01bdb4c4..00000000 --- a/wiki-information/functions/GetManaRegen.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetManaRegen - -**Content:** -Returns the mana regeneration per second. -`base, casting = GetManaRegen()` - -**Returns:** -- `base` - - *number* - Mana regeneration per second when not casting spells. -- `casting` - - *number* - Mana regeneration per second while casting spells. - -**Description:** -To get the same values as displayed in the PaperDoll, multiply the values by 5. \ No newline at end of file diff --git a/wiki-information/functions/GetMasterLootCandidate.md b/wiki-information/functions/GetMasterLootCandidate.md deleted file mode 100644 index c61594ca..00000000 --- a/wiki-information/functions/GetMasterLootCandidate.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GetMasterLootCandidate - -**Content:** -Returns the name of an eligible player for receiving master loot by index. -`candidate = GetMasterLootCandidate(slot, index)` - -**Parameters:** -- `slot` - - *number* - The loot slot number of the item you want to get information about -- `index` - - *number* - The number of the player whose name you wish to return. Typically between 1 and 40. - -**Returns:** -- `candidate` - - *string* - The name of the player. - -**Description:** -Only valid if the player is the master looter. - -**Reference:** -- `GetNumRaidMembers()` -- `GiveMasterLoot(slot, index)` \ No newline at end of file diff --git a/wiki-information/functions/GetMaxBattlefieldID.md b/wiki-information/functions/GetMaxBattlefieldID.md deleted file mode 100644 index b738300e..00000000 --- a/wiki-information/functions/GetMaxBattlefieldID.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetMaxBattlefieldID - -**Content:** -Returns the max number of battlefields you can queue for. -`maxBattlefieldID = GetMaxBattlefieldID()` - -**Returns:** -- `maxBattlefieldID` - - *number* - Max number of Battlefields - -**Description:** -Replaces `MAX_BATTLEFIELD_QUEUES`. \ No newline at end of file diff --git a/wiki-information/functions/GetMaxLevelForExpansionLevel.md b/wiki-information/functions/GetMaxLevelForExpansionLevel.md deleted file mode 100644 index b1c533ba..00000000 --- a/wiki-information/functions/GetMaxLevelForExpansionLevel.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: GetMaxLevelForExpansionLevel - -**Content:** -Maps an expansion level to a maximum character level for that expansion. -`maxLevel = GetMaxLevelForExpansionLevel(expansionLevel)` - -**Parameters:** -- `expansionLevel` - - *number* - - Values: - - `Value` - - `Enum` - - `MaxLevel` - - `0` - - `LE_EXPANSION_CLASSIC` - - `30` - - `1` - - `LE_EXPANSION_BURNING_CRUSADE` - - `30` - - `2` - - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` - - `30` - - `3` - - `LE_EXPANSION_CATACLYSM` - - `35` - - `4` - - `LE_EXPANSION_MISTS_OF_PANDARIA` - - `35` - - `5` - - `LE_EXPANSION_WARLORDS_OF_DRAENOR` - - `40` - - `6` - - `LE_EXPANSION_LEGION` - - `45` - - `7` - - `LE_EXPANSION_BATTLE_FOR_AZEROTH` - - `50` - - `8` - - `LE_EXPANSION_SHADOWLANDS` - - `60` - -**Returns:** -- `maxLevel` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetMaximumExpansionLevel.md b/wiki-information/functions/GetMaximumExpansionLevel.md deleted file mode 100644 index 8304c84a..00000000 --- a/wiki-information/functions/GetMaximumExpansionLevel.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetMaximumExpansionLevel - -**Content:** -Needs summary. -`expansionLevel = GetMaximumExpansionLevel()` - -**Returns:** -- `expansionLevel` - - *number* - - `NUM_LE_EXPANSION_LEVELS` - - **Value** - - **Enum** - - **Description** - - `LE_EXPANSION_LEVEL_CURRENT` - - *0* - Vanilla / Classic Era - - `LE_EXPANSION_BURNING_CRUSADE` - - *1* - The Burning Crusade - - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` - - *2* - Wrath of the Lich King - - `LE_EXPANSION_CATACLYSM` - - *3* - Cataclysm - - `LE_EXPANSION_MISTS_OF_PANDARIA` - - *4* - Mists of Pandaria - - `LE_EXPANSION_WARLORDS_OF_DRAENOR` - - *5* - Warlords of Draenor - - `LE_EXPANSION_LEGION` - - *6* - Legion - - `LE_EXPANSION_BATTLE_FOR_AZEROTH` - - *7* - Battle for Azeroth - - `LE_EXPANSION_SHADOWLANDS` - - *8* - Shadowlands - - `LE_EXPANSION_DRAGONFLIGHT` - - *9* - Dragonflight - - `LE_EXPANSION_11_0` - - *10* \ No newline at end of file diff --git a/wiki-information/functions/GetMeleeHaste.md b/wiki-information/functions/GetMeleeHaste.md deleted file mode 100644 index 21753ab8..00000000 --- a/wiki-information/functions/GetMeleeHaste.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetMeleeHaste - -**Content:** -Returns the player's melee haste percentage. -`meleeHaste = GetMeleeHaste()` - -**Returns:** -- `meleeHaste` - - *number* - -**Description:** -Related API: -- `GetCombatRating(CR_HASTE_MELEE)` -- `GetCombatRatingBonus(CR_HASTE_MELEE)` - -**Usage:** -`/dump GetMeleeHaste()` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemCostInfo.md b/wiki-information/functions/GetMerchantItemCostInfo.md deleted file mode 100644 index db226ed9..00000000 --- a/wiki-information/functions/GetMerchantItemCostInfo.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetMerchantItemCostInfo - -**Content:** -Returns "alternative currency" information about an item. -`itemCount = GetMerchantItemCostInfo(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the merchant's inventory - -**Returns:** -- `itemCount` - - *number* - The number of different types of items required to purchase the item. - -**Description:** -The `itemCount` is the number of different types of items required, not how many of those types. For example, the Scout's Tabard which requires 3 Arathi Basin Marks of Honor and 3 Warsong Gulch Marks of Honor would return a 2 for the item count. To find out how many of each item is required, use the `GetMerchantItemCostItem` function. - -**Reference:** -- `GetMerchantItemInfo` -- `GetMerchantItemCostItem` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemCostItem.md b/wiki-information/functions/GetMerchantItemCostItem.md deleted file mode 100644 index 80bfe657..00000000 --- a/wiki-information/functions/GetMerchantItemCostItem.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetMerchantItemCostItem - -**Content:** -Returns info for the currency cost for a merchant item. -`itemTexture, itemValue, itemLink, currencyName = GetMerchantItemCostItem(index, itemIndex)` - -**Parameters:** -- `index` - - *number* - Slot in the merchant's inventory to query. -- `itemIndex` - - *number* - The index for the required item cost type, ascending from 1 to itemCount returned by GetMerchantItemCostInfo. - -**Returns:** -- `itemTexture` - - *string* - The texture that represents the item's icon -- `itemValue` - - *number* - The number of that item required -- `itemLink` - - *string* - An itemLink for the cost item, nil if a currency. -- `currencyName` - - *string* - Name of the currency required, nil if an item. - -**Description:** -`itemIndex` counts into the number of different "alternate currency" tokens required to buy the item under consideration. For example, looking at the 25-player Tier 9 vendor, a chestpiece costs 75 Emblems of Triumph and 1 Trophy of the Crusade. This function would be called with arguments (N,1) to retrieve information about the Emblems and (N,2) to retrieve information about the Trophy, where N is the index of the chestpiece in the merchant window. \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemID.md b/wiki-information/functions/GetMerchantItemID.md deleted file mode 100644 index 8b01e530..00000000 --- a/wiki-information/functions/GetMerchantItemID.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetMerchantItemID - -**Content:** -Returns the itemID of an item of the current merchant window. -`itemID = GetMerchantItemID(Index)` - -**Parameters:** -- `Index` - - *number* - Index - -**Returns:** -- `itemID` - - *itemID* - itemID of Merchant Item at Index - -**Usage:** -To get the itemID of an item of the current merchant window: -```lua -/dump GetMerchantItemID(1) -- = 194298 -``` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemInfo.md b/wiki-information/functions/GetMerchantItemInfo.md deleted file mode 100644 index 608892e3..00000000 --- a/wiki-information/functions/GetMerchantItemInfo.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: GetMerchantItemInfo - -**Content:** -Returns info for a merchant item. -`name, texture, price, quantity, numAvailable, isPurchasable, isUsable, extendedCost = GetMerchantItemInfo(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the merchant's inventory - -**Returns:** -- `name` - - *string* - The name of the item -- `texture` - - *string* - The texture that represents the item's icon -- `price` - - *number* - The price of the item (in copper) -- `quantity` - - *number* - The quantity that will be purchased (the batch size, e.g. 5 for vials) -- `numAvailable` - - *number* - The number of this item that the merchant has in stock. -1 for unlimited stock. -- `isPurchasable` - - *boolean* - Is true if the item can be purchased, false otherwise -- `isUsable` - - *boolean* - Is true if the player can use this item, false otherwise -- `extendedCost` - - *boolean* - Is true if the item has extended (PvP) cost info, false otherwise - -**Usage:** -```lua -local name, texture, price, quantity, numAvailable, isUsable, extendedCost = GetMerchantItemInfo(4); -message(name .. " " .. price .. "c"); -``` - -**Miscellaneous:** -Result: -A message stating the name and price of the item in merchant slot 4 appears. - -**Reference:** -- `GetMerchantItemCostInfo` - -**Example Use Case:** -This function can be used in an addon to display detailed information about items sold by NPC merchants. For instance, an addon could use this function to create a custom merchant interface that shows additional information about each item, such as its price in a more readable format or whether the player can use the item. - -**Addons Using This Function:** -Many popular addons like Auctioneer and TradeSkillMaster use this function to gather information about items sold by merchants, which can then be used to help players make informed purchasing decisions or to automate buying processes. \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemLink.md b/wiki-information/functions/GetMerchantItemLink.md deleted file mode 100644 index ffcd41fb..00000000 --- a/wiki-information/functions/GetMerchantItemLink.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetMerchantItemLink - -**Content:** -Returns the item link for a merchant item. -`link = GetMerchantItemLink(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the merchant's inventory - -**Returns:** -- `itemLink` - - *string?* - returns a string that will show as a clickable link to the item - -**Usage:** -Show item link will appear in the default chat frame. -```lua -DEFAULT_CHAT_FRAME:AddMessage(GetMerchantItemLink(4)); -``` \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantItemMaxStack.md b/wiki-information/functions/GetMerchantItemMaxStack.md deleted file mode 100644 index 6881c984..00000000 --- a/wiki-information/functions/GetMerchantItemMaxStack.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetMerchantItemMaxStack - -**Content:** -Returns the maximum stack size for a merchant item. -`maxStack = GetMerchantItemMaxStack(index)` - -**Parameters:** -- `index` - - *number* - The index of the item in the merchant's inventory. - -**Returns:** -- `maxStack` - - *number* - The maximum stack size for the item. \ No newline at end of file diff --git a/wiki-information/functions/GetMerchantNumItems.md b/wiki-information/functions/GetMerchantNumItems.md deleted file mode 100644 index 556daad0..00000000 --- a/wiki-information/functions/GetMerchantNumItems.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetMerchantNumItems - -**Content:** -Returns the number of different items a merchant sells. -`numItems = GetMerchantNumItems()` - -**Returns:** -- `numItems` - - *number* - the number of items the merchant carries. - -**Description:** -If you are not currently interacting with a merchant, the last known value is returned. \ No newline at end of file diff --git a/wiki-information/functions/GetMinimapZoneText.md b/wiki-information/functions/GetMinimapZoneText.md deleted file mode 100644 index ac24ad2d..00000000 --- a/wiki-information/functions/GetMinimapZoneText.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetMinimapZoneText - -**Content:** -Returns the zone text that is displayed over the minimap. -`zone = GetMinimapZoneText()` - -**Returns:** -- `zone` - - *string* - name of the (sub-)zone currently shown above the minimap, e.g. "Trade District". - -**Description:** -The `MINIMAP_ZONE_CHANGED` event fires when the return value of this function changes. -The return value equals that of `GetSubZoneText()` or `GetZoneText()` depending on whether the player is currently in a named sub-zone or not. - -**Reference:** -- `GetRealZoneText()` \ No newline at end of file diff --git a/wiki-information/functions/GetMinimumExpansionLevel.md b/wiki-information/functions/GetMinimumExpansionLevel.md deleted file mode 100644 index 32981d8b..00000000 --- a/wiki-information/functions/GetMinimumExpansionLevel.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: GetMinimumExpansionLevel - -**Content:** -Needs summary. -`expansionLevel = GetMinimumExpansionLevel()` - -**Returns:** -- `expansionLevel` - - *number* - Corresponds to the expansion level constants: - - `Value` - - `Enum` - - `Description` - - `LE_EXPANSION_LEVEL_CURRENT` - - *0* - LE_EXPANSION_CLASSIC - - *Vanilla / Classic Era* - - `1` - - *LE_EXPANSION_BURNING_CRUSADE* - - *The Burning Crusade* - - `2` - - *LE_EXPANSION_WRATH_OF_THE_LICH_KING* - - *Wrath of the Lich King* - - `3` - - *LE_EXPANSION_CATACLYSM* - - *Cataclysm* - - `4` - - *LE_EXPANSION_MISTS_OF_PANDARIA* - - *Mists of Pandaria* - - `5` - - *LE_EXPANSION_WARLORDS_OF_DRAENOR* - - *Warlords of Draenor* - - `6` - - *LE_EXPANSION_LEGION* - - *Legion* - - `7` - - *LE_EXPANSION_BATTLE_FOR_AZEROTH* - - *Battle for Azeroth* - - `8` - - *LE_EXPANSION_SHADOWLANDS* - - *Shadowlands* - - `9` - - *LE_EXPANSION_DRAGONFLIGHT* - - *Dragonflight* - - `10` - - *LE_EXPANSION_11_0* - -**Example Usage:** -This function can be used to determine the minimum expansion level required for certain features or content in the game. For instance, if a developer wants to check if a player has access to content from a specific expansion, they can use this function to get the minimum expansion level and compare it with the required expansion level for that content. - -**Addons Usage:** -Large addons like "WeakAuras" might use this function to ensure compatibility with different expansions by checking the minimum expansion level and adjusting their features accordingly. This helps in providing a seamless experience for users across various expansions. \ No newline at end of file diff --git a/wiki-information/functions/GetMirrorTimerInfo.md b/wiki-information/functions/GetMirrorTimerInfo.md deleted file mode 100644 index ff02f592..00000000 --- a/wiki-information/functions/GetMirrorTimerInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetMirrorTimerInfo - -**Content:** -Returns info for the mirror timer, e.g. fatigue, breath, and feign death. -`timer, initial, maxvalue, scale, paused, label = GetMirrorTimerInfo(id)` - -**Parameters:** -- `id` - - *number* - timer index, from 1 to MIRRORTIMER_NUMTIMERS (3 as of 3.2). In general, the following correspondence holds: 1 = Fatigue, 2 = Breath, 3 = Feign Death. - -**Returns:** -- `timer` - - *string* - A string identifying timer type; "EXHAUSTION", "BREATH", and "FEIGNDEATH", or "UNKNOWN" indicating that the timer corresponding to that index is not currently active, and other return values are invalid. -- `initial` - - *number* - Value of the timer when it started. -- `maxvalue` - - *number* - Maximum value of the timer. -- `scale` - - *number* - Change in timer value per second. -- `paused` - - *boolean* - 0 if the timer is currently running, a value greater than zero if it is not. -- `label` - - *string* - Localized timer name. - -**Description:** -Calling the function with an out-of-range index results in an error. The syntax specification in the error text is invalid; this function may not be called with "BREATH", "EXHAUSTION" etc as arguments. -The current value of the timer may be retrieved using `GetMirrorTimerProgress("timer")`. Most timers tend to count down to zero, at which point something bad happens. - -**Reference:** -- `MIRROR_TIMER_START` is fired when a timer becomes active. -- `MIRROR_TIMER_STOP` is fired when a timer becomes inactive. -- `MIRROR_TIMER_PAUSE` is fired when a timer is paused. \ No newline at end of file diff --git a/wiki-information/functions/GetMirrorTimerProgress.md b/wiki-information/functions/GetMirrorTimerProgress.md deleted file mode 100644 index edbe3d38..00000000 --- a/wiki-information/functions/GetMirrorTimerProgress.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetMirrorTimerProgress - -**Content:** -Returns the current value of the mirror timer. -`value = GetMirrorTimerProgress(timer)` - -**Parameters:** -- `timer` - - *string* - the first return value from `GetMirrorTimerInfo`, identifying the timer queried. Valid values include "EXHAUSTION", "BREATH" and "FEIGNDEATH". - -**Returns:** -- `value` - - *number* - current value of the timer. If the timer is not active, 0 is returned. - -**Reference:** -- `GetMirrorTimerInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetModifiedClick.md b/wiki-information/functions/GetModifiedClick.md deleted file mode 100644 index fc1b7e84..00000000 --- a/wiki-information/functions/GetModifiedClick.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetModifiedClick - -**Content:** -Returns the modifier key assigned to the given action. -`key = GetModifiedClick(action)` - -**Parameters:** -- `action` - - *string* - The action to query. Actions defined by Blizzard: - - `AUTOLOOTTOGGLE` - - `CHATLINK` - - `COMPAREITEMS` - - `DRESSUP` - - `FOCUSCAST` - - `OPENALLBAGS` - - `PICKUPACTION` - - `QUESTWATCHTOGGLE` - - `SELFCAST` - - `SHOWITEMFLYOUT` - - `SOCKETITEM` - - `SPLITSTACK` - - `STICKYCAMERA` - - `TOKENWATCHTOGGLE` - -**Returns:** -- `key` - - *string* - The modifier key assigned to this action. May be one of: - - `ALT` - - `CTRL` - - `SHIFT` - - `NONE` - -**Reference:** -- `IsModifiedClick` -- `SetModifiedClick` \ No newline at end of file diff --git a/wiki-information/functions/GetMoney.md b/wiki-information/functions/GetMoney.md deleted file mode 100644 index 1cbe9118..00000000 --- a/wiki-information/functions/GetMoney.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: GetMoney - -**Content:** -Returns the amount of money the player character owns. -`money = GetMoney()` - -**Returns:** -- `money` - - *number* - The amount of money the player's character has, in copper. - -**Description:** -Related Events: -- `PLAYER_MONEY` - -Available after: -- `PLAYER_ENTERING_WORLD` (on login) - -**Usage:** -```lua -GetMoney() -local money = GetMoney() -local gold = floor(money / 1e4) -local silver = floor(money / 100 % 100) -local copper = money % 100 -print(("You have %dg %ds %dc"):format(gold, silver, copper)) --- You have 10851g 62s 40c - -GetCoinText(amount) -print(GetCoinText(GetMoney())) -- "10851 Gold, 62 Silver, 40 Copper" -print(GetCoinText(12345678, " ")) -- "1234 Gold 23 Silver 45 Copper" -print(GetCoinText(12345678, "X")) -- "1234 GoldX23 SilverX45 Copper" - -GetMoneyString(amount) -print(GetMoneyString(12345678)) -print(GetMoneyString(12345678, true)) --- 1234 56 78 --- 1,234 56 78 - -GetCoinTextureString(amount) -print(GetCoinTextureString(1234578)) -print(GetCoinTextureString(1234578, 24)) --- 1234 56 78 --- 1234 56 78 -``` - -**Example Use Case:** -The `GetMoney` function can be used in addons to display the player's current money in various formats. For instance, an addon that tracks and displays the player's wealth over time would use this function to get the current amount of money and then store or display it. - -**Addons Using This Function:** -Many popular addons, such as "Titan Panel" and "Bagnon," use the `GetMoney` function to display the player's current money on the screen or in the inventory interface. These addons provide a convenient way to keep track of your gold, silver, and copper without having to open the character's inventory. \ No newline at end of file diff --git a/wiki-information/functions/GetMouseButtonClicked.md b/wiki-information/functions/GetMouseButtonClicked.md deleted file mode 100644 index d3262bb8..00000000 --- a/wiki-information/functions/GetMouseButtonClicked.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetMouseButtonClicked - -**Content:** -Returns the mouse button responsible during an OnClick event (e.g. "RightButton"). -`buttonName = GetMouseButtonClicked()` - -**Returns:** -- `buttonName` - - *string* - name of the button responsible for the innermost OnClick event. For example, "LeftButton" - -**Description:** -The `buttonName` return value may be an arbitrary string (as the `Button:Click` method accepts arbitrary arguments). -If there are multiple OnClick handler dispatches on the call stack, information about the innermost one is returned. \ No newline at end of file diff --git a/wiki-information/functions/GetMouseFocus.md b/wiki-information/functions/GetMouseFocus.md deleted file mode 100644 index fde03081..00000000 --- a/wiki-information/functions/GetMouseFocus.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetMouseFocus - -**Content:** -Returns the frame that currently has mouse focus. -`frame = GetMouseFocus()` - -**Returns:** -- `frame` - - *Frame* - The frame that currently has the mouse focus. - -**Description:** -The frame must have `enableMouse="true"` - -**Usage:** -You can get the name of the mouse-enabled frame beneath the pointer with this: -```lua -/dump GetMouseFocus():GetName() -- WorldFrame -``` \ No newline at end of file diff --git a/wiki-information/functions/GetMultiCastTotemSpells.md b/wiki-information/functions/GetMultiCastTotemSpells.md deleted file mode 100644 index ac5bea73..00000000 --- a/wiki-information/functions/GetMultiCastTotemSpells.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: GetMultiCastTotemSpells - -**Content:** -Returns a list of valid spells for a totem bar slot. -`totem1, totem2, totem3, totem4, totem5, totem6, totem7 = GetMultiCastTotemSpells(slot)` - -**Parameters:** -- `slot` - - *number* - The totem bar slot number: - - Call of the Elements - - 133 - Fire - - 134 - Earth - - 135 - Water - - 136 - Air - - Call of the Ancestors - - 137 - Fire - - 138 - Earth - - 139 - Water - - 140 - Air - - Call of the Spirits - - 141 - Fire - - 142 - Earth - - 143 - Water - - 144 - Air - -**Returns:** -- `totem1` - - *number* - The spell Id of the first valid spell for the slot -- `totem2` - - *number* - The spell Id of the second valid spell for the slot -- `totem3` - - *number* - The spell Id of the third valid spell for the slot -- `totem4` - - *number* - The spell Id of the fourth valid spell for the slot -- `totem5` - - *number* - The spell Id of the fifth valid spell for the slot -- `totem6` - - *number* - The spell Id of the sixth valid spell for the slot -- `totem7` - - *number* - The spell Id of the seventh valid spell for the slot - -**Usage:** -```lua -totem1, totem2, totem3, totem4, totem5, totem6, totem7 = GetMultiCastTotemSpells(134) -totem1, totem2, totem3, totem4, totem5, totem6, totem7 = GetMultiCastTotemSpells(134) -``` - -**Miscellaneous:** -Result: -A list of spell ids that can go in totem bar slot number 134. Slot 134 is the Earth slot for the Call of the Elements spell. \ No newline at end of file diff --git a/wiki-information/functions/GetNetStats.md b/wiki-information/functions/GetNetStats.md deleted file mode 100644 index 96d76fd3..00000000 --- a/wiki-information/functions/GetNetStats.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: GetNetStats - -**Content:** -Returns bandwidth and latency network information. -`bandwidthIn, bandwidthOut, latencyHome, latencyWorld = GetNetStats()` - -**Returns:** -- `bandwidthIn` - - *number* - Current incoming bandwidth (download) usage, measured in KB/s. -- `bandwidthOut` - - *number* - Current outgoing bandwidth (upload) usage, measured in KB/s. -- `latencyHome` - - *number* - Average roundtrip latency to the home realm server (only updated every 30 seconds). -- `latencyWorld` - - *number* - Average roundtrip latency to the current world server (only updated every 30 seconds). - -**Description:** -Home/World latency (updated) - 4.0.6 | 2011-02-11 19:54 | Gelmkar - -In essence, Home refers to your connection to your realm server. This connection sends chat data, auction house stuff, guild chat and info, some addon data, and various other data. It is a pretty slim connection in terms of bandwidth requirements. - -World is a reference to the connection to our servers that transmits all the other data... combat, data from the people around you (specs, gear, enchants, etc.), NPCs, mobs, casting, professions, etc. Going into a highly populated zone (like a capital city) will drastically increase the amount of data being sent over this connection and will raise the reported latency. - -Prior to 4.0.6, the in-game latency monitor only showed 'World' latency, which caused a lot of confusion for people who had no lag while chatting, but couldn't cast or interact with NPCs and ended up getting kicked offline. We hoped that including the latency meters for both connections would assist in clarifying this for everyone. - -As is probably obvious based upon this information, the two connections are not used equally. There is a much larger amount of data being sent over the World connection, which is a good reason you may see disparities between the two times. If there is a large chunk of data 'queued' up on the server and waiting to be sent to your client, that 'ping' to the server is going to have to wait its turn in line, and the actual number returned will be much higher than the 'Home' connection. \ No newline at end of file diff --git a/wiki-information/functions/GetNextAchievement.md b/wiki-information/functions/GetNextAchievement.md deleted file mode 100644 index c59f1e6c..00000000 --- a/wiki-information/functions/GetNextAchievement.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetNextAchievement - -**Content:** -Returns the next achievement in a chain. -`nextAchievementID = GetNextAchievement(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - The ID of the Achievement - -**Returns:** -- `nextAchievementID` - - *number or nil* - The ID of the next Achievement in chain. \ No newline at end of file diff --git a/wiki-information/functions/GetNextStableSlotCost.md b/wiki-information/functions/GetNextStableSlotCost.md deleted file mode 100644 index a081d941..00000000 --- a/wiki-information/functions/GetNextStableSlotCost.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNextStableSlotCost - -**Content:** -Returns the next stable slot's cost in copper. -`nextSlotCost = GetNextStableSlotCost()` - -**Returns:** -- `nextSlotCost` - - *number* - The cost of the next stable slot in copper. \ No newline at end of file diff --git a/wiki-information/functions/GetNormalizedRealmName.md b/wiki-information/functions/GetNormalizedRealmName.md deleted file mode 100644 index 7ed2d5a9..00000000 --- a/wiki-information/functions/GetNormalizedRealmName.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetRealmName - -**Content:** -Returns the realm name. -```lua -realm = GetRealmName() -normalizedRealm = GetNormalizedRealmName() -``` - -**Returns:** -- `realm` - - *string* - The name of the realm. -- `normalizedRealm` - - *string?* - The name of the realm without spaces or hyphens. - -**Description:** -- **Related API:** - - `GetRealmID` -- The normalized realm name is used for addressing whispers and in-game mail. -- When logging in, `GetNormalizedRealmName()` only returns information starting from as early as the `PLAYER_LOGIN` event. -- When transitioning through a loading screen, `GetNormalizedRealmName()` may return nil between the `LOADING_SCREEN_ENABLED` and `LOADING_SCREEN_DISABLED` events. - -**Usage:** -A small list of realm IDs and names. -```lua --- /dump GetRealmID(), GetRealmName(), GetNormalizedRealmName() -503, "Azjol-Nerub", "AzjolNerub" -513, "Twilight's Hammer", "Twilight'sHammer" -635, "Defias Brotherhood", "DefiasBrotherhood" -1049, "愤怒使者", "愤怒使者" -1093, "Ahn'Qiraj", "Ahn'Qiraj" -1413, "Aggra (Português)", "Aggra(Português)" -1925, "Вечная Песня", "ВечнаяПесня" -``` - -**Reference:** -- `UnitName()` - Returns a character name and the server (if different from the player's current server) \ No newline at end of file diff --git a/wiki-information/functions/GetNumActiveQuests.md b/wiki-information/functions/GetNumActiveQuests.md deleted file mode 100644 index cbe91366..00000000 --- a/wiki-information/functions/GetNumActiveQuests.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetNumActiveQuests - -**Content:** -Returns the number of quests which can be turned in at a non-gossip quest giver. -`nbrActiveQuests = GetGossipActiveQuests()` - -**Returns:** -This returns the number of active quests from a non-gossip quest NPC. -- `nbrActiveQuests` - - *number* - The number of active quests. - -**Reference:** -- `GetNumAvailableQuests` -- `GetGossipAvailableQuests` -- `GetGossipActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetNumAddOns.md b/wiki-information/functions/GetNumAddOns.md deleted file mode 100644 index 62e765a1..00000000 --- a/wiki-information/functions/GetNumAddOns.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetNumAddOns - -**Content:** -Get the number of user-supplied AddOns. -`count = GetNumAddOns()` - -**Returns:** -- `count` - - *number* - The number of user-supplied AddOns installed. This is the maximum valid index to the other AddOn functions. This count does NOT include Blizzard-supplied UI component AddOns. - -**Example Usage:** -This function can be used to iterate over all installed user-supplied AddOns. For example, you can use it in combination with `GetAddOnInfo` to list all AddOns: - -```lua -local numAddOns = GetNumAddOns() -for i = 1, numAddOns do - local name, title, notes, loadable, reason, security = GetAddOnInfo(i) - print(name, title, notes, loadable, reason, security) -end -``` - -**AddOns Using This Function:** -Many large AddOns and AddOn managers, such as **ElvUI** and **WeakAuras**, use this function to manage and display information about other installed AddOns. For instance, AddOn managers might use it to provide a list of all installed AddOns, allowing users to enable or disable them as needed. \ No newline at end of file diff --git a/wiki-information/functions/GetNumAuctionItems.md b/wiki-information/functions/GetNumAuctionItems.md deleted file mode 100644 index 5f0a2147..00000000 --- a/wiki-information/functions/GetNumAuctionItems.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetNumAuctionItems - -**Content:** -Retrieves the number of auction items of a certain type. -`batch, count = GetNumAuctionItems(list)` - -**Parameters:** -- `(string type)` - - `type` - - One of the following: - - `"list"` - Items up for auction, the "Browse" tab in the dialog. - - `"bidder"` - Items the player has bid on, the "Bids" tab in the dialog. - - `"owner"` - Items the player has up for auction, the "Auctions" tab in the dialog. - -**Returns:** -- `batch` - - The size of the batch being viewed, 50 for a page view. -- `count` - - The total number of items in the query. - - For a GetAll query, the batch and count are the same. - - Bug seen in 4.0.1: If an AH has over 42554 items, batch will be returned as 42554, and count will be a seemingly random VERY HIGH number - ~1 billion has been seen. - -**Usage:** -```lua -numBatchAuctions, totalAuctions = GetNumAuctionItems("bidder"); -``` - -**Example Use Case:** -This function can be used in an addon that tracks auction house activity. For instance, an addon like Auctioneer might use this function to determine how many items a player has bid on or listed for sale, and then display this information in a user-friendly format. - -**Addons Using This Function:** -- **Auctioneer:** This popular addon uses `GetNumAuctionItems` to manage and display auction data, helping players to buy, sell, and bid on items more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetNumAvailableQuests.md b/wiki-information/functions/GetNumAvailableQuests.md deleted file mode 100644 index dfcb67df..00000000 --- a/wiki-information/functions/GetNumAvailableQuests.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetNumAvailableQuests - -**Content:** -Returns the number of available quests at a non-gossip quest giver. -`nbrAvailableQuests = GetGossipAvailableQuests()` - -**Returns:** -This returns the number of available quests from a non-gossip quest NPC. -- `nbrAvailableQuests` - - *number* - The number of available quests. - -**Reference:** -- `GetNumActiveQuests` -- `GetGossipAvailableQuests` -- `GetGossipActiveQuests` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBankSlots.md b/wiki-information/functions/GetNumBankSlots.md deleted file mode 100644 index 7bf9cd8e..00000000 --- a/wiki-information/functions/GetNumBankSlots.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetNumBankSlots - -**Content:** -Returns the number of purchased bank bag slots. -`numSlots, full = GetNumBankSlots()` - -**Returns:** -- `numSlots` - - *number* - Number of bag slots already purchased. -- `full` - - *boolean* - True if no further slots are available. - -**Reference:** -- `GetBankSlotCost` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBattlefieldStats.md b/wiki-information/functions/GetNumBattlefieldStats.md deleted file mode 100644 index 916583a2..00000000 --- a/wiki-information/functions/GetNumBattlefieldStats.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumBattlefieldStats - -**Content:** -Appears to return the number of columns in the battleground/field scoreboard, other than the common ones (Killing Blows, Kills, Deaths, Bonus Honour): -`local numStats = GetNumBattlefieldStats()` - -**Returns:** -- `numStats` - - *number* - Number of columns available for the battleground (2 for Warsong Gulch and Arathi Basin, 7 for Alterac Valley) \ No newline at end of file diff --git a/wiki-information/functions/GetNumBattlefields.md b/wiki-information/functions/GetNumBattlefields.md deleted file mode 100644 index 488ba6e9..00000000 --- a/wiki-information/functions/GetNumBattlefields.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetNumBattlefields - -**Content:** -Returns the number of available instances for the selected battleground at the battlemaster. -`numBattlefields = GetNumBattlefields()` - -**Returns:** -- `numBattlefields` - - *number* - -**Description:** -Battleground types are selected by `RequestBattlegroundInstanceInfo(index)`. - -**Reference:** -- `GetBattlefieldInstanceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBattlegroundTypes.md b/wiki-information/functions/GetNumBattlegroundTypes.md deleted file mode 100644 index 56842825..00000000 --- a/wiki-information/functions/GetNumBattlegroundTypes.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetNumBattlegroundTypes - -**Content:** -Returns the number of battleground types. -`numBattlegrounds = GetNumBattlegroundTypes()` - -**Returns:** -- `numBattlegrounds` - - *number* - the number of distinct battleground types offered by the server. The player may not be able to join all of those due to level restrictions. - -**Reference:** -- `GetBattlegroundInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumBindings.md b/wiki-information/functions/GetNumBindings.md deleted file mode 100644 index b2b0de55..00000000 --- a/wiki-information/functions/GetNumBindings.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumBindings - -**Content:** -Returns the number of bindings and headers in the key bindings window. -`numKeyBindings = GetNumBindings()` - -**Returns:** -- `numKeyBindings` - - The total number of key bindings (including headers) listed in the key bindings window. \ No newline at end of file diff --git a/wiki-information/functions/GetNumBuybackItems.md b/wiki-information/functions/GetNumBuybackItems.md deleted file mode 100644 index 2342eddc..00000000 --- a/wiki-information/functions/GetNumBuybackItems.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetNumBuybackItems - -**Content:** -Returns the number of items available for buyback. -`numItems = GetNumBuybackItems()` - -**Returns:** -- `numItems` - - *number* - the number of items available for buyback; the maximum index for `GetBuybackItemInfo()`. - -**Description:** -Returns 0 when not at a merchant. \ No newline at end of file diff --git a/wiki-information/functions/GetNumClasses.md b/wiki-information/functions/GetNumClasses.md deleted file mode 100644 index f097f9f9..00000000 --- a/wiki-information/functions/GetNumClasses.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetNumClasses - -**Content:** -Returns the number of player classes in the game. -`numClasses = GetNumClasses()` - -**Returns:** -- `numClasses` - - *number* - -**Description:** -This returns 11 (Druid) in Classic since it actually returns the highest class ID. \ No newline at end of file diff --git a/wiki-information/functions/GetNumCompanions.md b/wiki-information/functions/GetNumCompanions.md deleted file mode 100644 index f4b363b0..00000000 --- a/wiki-information/functions/GetNumCompanions.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetNumCompanions - -**Content:** -Returns the number of mounts. -`count = GetNumCompanions(type)` - -**Parameters:** -- `type` - - *string* - Type of companions to count: "CRITTER", or "MOUNT". - -**Returns:** -- `count` - - *number* - The number of companions of a specific type. - -**Usage:** -The following snippet prints how many mounts the player has collected. -```lua -local count = GetNumCompanions("MOUNT"); -print('Hello, I have collected a total of ' .. count .. ' mounts.'); -``` \ No newline at end of file diff --git a/wiki-information/functions/GetNumComparisonCompletedAchievements.md b/wiki-information/functions/GetNumComparisonCompletedAchievements.md deleted file mode 100644 index e5e03f37..00000000 --- a/wiki-information/functions/GetNumComparisonCompletedAchievements.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetNumComparisonCompletedAchievements - -**Content:** -Returns the number of completed achievements for the comparison player. -`total, completed = GetNumComparisonCompletedAchievements(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - ID of the achievement to retrieve information for. - -**Returns:** -- `total` - - *number* - Total number of achievements currently in the game. -- `completed` - - *number* - Number of achievements completed by the comparison unit. - -**Description:** -- Does not include Feats of Strength. -- Only accurate after the `SetAchievementComparisonUnit` is called and the `INSPECT_ACHIEVEMENT_READY` event has fired. -- Inaccurate after `ClearAchievementComparisonUnit` has been called. - -**Reference:** -- `SetAchievementComparisonUnit` - to select a target before using this function. -- `ClearAchievementComparisonUnit` - to clear the selection after using this function. -- `GetNumCompletedAchievements` - for details about the player's own progress. \ No newline at end of file diff --git a/wiki-information/functions/GetNumCompletedAchievements.md b/wiki-information/functions/GetNumCompletedAchievements.md deleted file mode 100644 index f2cb2cbe..00000000 --- a/wiki-information/functions/GetNumCompletedAchievements.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetNumCompletedAchievements - -**Content:** -Returns the total and completed number of achievements. -`total, completed = GetNumCompletedAchievements()` - -**Returns:** -- `total`, `completed` - - `total` - - *number* - total number of available achievements - - `completed` - - *number* - total number of completed achievements - -**Description:** -Unknown whether this takes Feats of Strength into account. - -**Reference:** -GetNumComparisonCompletedAchievements - To get information about another player's progress \ No newline at end of file diff --git a/wiki-information/functions/GetNumCrafts.md b/wiki-information/functions/GetNumCrafts.md deleted file mode 100644 index eb8fbbd7..00000000 --- a/wiki-information/functions/GetNumCrafts.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetNumCrafts - -**Content:** -Returns the number of crafts in the currently opened crafting window. Usually used to loop through all available crafts to perform API `GetCraftInfo` on them. -`numberOfCrafts = GetNumCrafts()` - -**Example Usage:** -```lua -local numberOfCrafts = GetNumCrafts() -for i = 1, numberOfCrafts do - local craftName, craftSubSpellName, craftType, numAvailable, isExpanded, trainingPointCost, requiredLevel = GetCraftInfo(i) - print("Craft Name: " .. craftName) -end -``` - -**Additional Information:** -- This function is often used in crafting-related addons to iterate through all available crafts and gather information about them. -- Addons like "TradeSkillMaster" use this function to manage and optimize crafting operations by retrieving detailed information about each craft available in the crafting window. \ No newline at end of file diff --git a/wiki-information/functions/GetNumDeclensionSets.md b/wiki-information/functions/GetNumDeclensionSets.md deleted file mode 100644 index ccc4aaac..00000000 --- a/wiki-information/functions/GetNumDeclensionSets.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetNumDeclensionSets - -**Content:** -Returns the number of suggested declension sets for a Russian name. -`numDeclensionSets = GetNumDeclensionSets(name, gender)` - -**Parameters:** -- `name` - - *string* -- `gender` - - *number* - -**Returns:** -- `numDeclensionSets` - - *number* - Used for `DeclineName()` - -**Description:** -Requires the ruRU client. -Declension sets are sets of additional names prompted during character creation in the ruRU client. -Static names for e.g NPCs are in `DeclinedWord.db2`, `DeclinedWordCases.db2`. \ No newline at end of file diff --git a/wiki-information/functions/GetNumExpansions.md b/wiki-information/functions/GetNumExpansions.md deleted file mode 100644 index 3c2a7a4a..00000000 --- a/wiki-information/functions/GetNumExpansions.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumExpansions - -**Content:** -Needs summary. -`numExpansions = GetNumExpansions()` - -**Returns:** -- `numExpansions` - - *number* - e.g. returned 9 during the Shadowlands pre-patch \ No newline at end of file diff --git a/wiki-information/functions/GetNumFactions.md b/wiki-information/functions/GetNumFactions.md deleted file mode 100644 index 8d16b848..00000000 --- a/wiki-information/functions/GetNumFactions.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumFactions - -**Content:** -Returns the number of lines in the faction display. -`numFactions = GetNumFactions()` - -**Returns:** -- `numFactions` - - *number* - The number of lines in your faction display (based on known factions and expanded/collapsed faction lines) \ No newline at end of file diff --git a/wiki-information/functions/GetNumFlexRaidDungeons.md b/wiki-information/functions/GetNumFlexRaidDungeons.md deleted file mode 100644 index 4e9f4457..00000000 --- a/wiki-information/functions/GetNumFlexRaidDungeons.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetNumFlexRaidDungeons - -**Content:** -Returns the number of available Flexible Raid instances. -`numInstances = GetNumFlexRaidDungeons()` - -**Returns:** -- `numInstances` - - *number* - number of instances available for flexible raid groups. - -**Description:** -The return value does not take your character or instance availability into account; it is simply the number of flexible raid instances the client is aware of. - -**Reference:** -- `GetFlexRaidDungeonInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumFrames.md b/wiki-information/functions/GetNumFrames.md deleted file mode 100644 index ae04f504..00000000 --- a/wiki-information/functions/GetNumFrames.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetNumFrames - -**Content:** -Get the current number of Frame (and derivative) objects. -`numFrames = GetNumFrames()` - -**Returns:** -- `numFrames` - - *number* - The current number of frames. - -**Description:** -There are around 7860 frames on a fresh login on patch 10.0.7. \ No newline at end of file diff --git a/wiki-information/functions/GetNumGlyphSockets.md b/wiki-information/functions/GetNumGlyphSockets.md deleted file mode 100644 index 897ab590..00000000 --- a/wiki-information/functions/GetNumGlyphSockets.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetNumGlyphSockets - -**Content:** -Returns the number of glyph sockets the player will have access to at max level. -`numGlyphSockets = GetNumGlyphSockets();` - -**Returns:** -- `numGlyphSockets` - - *Number* - Number of glyph sockets the player will have access to at max level. - -**Notes and Caveats:** -Sockets have individual level requirements; not every socket may be usable at the character's particular level. -Returns the same value as `NUM_GLYPH_SLOTS`. \ No newline at end of file diff --git a/wiki-information/functions/GetNumGossipActiveQuests.md b/wiki-information/functions/GetNumGossipActiveQuests.md deleted file mode 100644 index d26ef47e..00000000 --- a/wiki-information/functions/GetNumGossipActiveQuests.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetNumGossipActiveQuests - -**Content:** -Returns the number of active quests that you should eventually turn in to this NPC. -`numActiveQuests = GetNumGossipActiveQuests()` - -**Returns:** -- `numActiveQuests` - - *number* - Number of quests you're on that should be turned in to the NPC you're gossiping with. - -**Description:** -This information is available when the `GOSSIP_SHOW` event fires. - -**Reference:** -- `GetGossipActiveQuests` -- `SelectGossipActiveQuest` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGossipAvailableQuests.md b/wiki-information/functions/GetNumGossipAvailableQuests.md deleted file mode 100644 index 578e3ca7..00000000 --- a/wiki-information/functions/GetNumGossipAvailableQuests.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetNumGossipAvailableQuests - -**Content:** -Returns the number of quests (that you are not already on) offered by this NPC. -`numNewQuests = GetNumGossipAvailableQuests()` - -**Returns:** -- `numNewQuests` - - *number* - Number of quests you can pick up from this NPC. - -**Description:** -This information is available when the `GOSSIP_SHOW` event fires. - -**Reference:** -- `GetGossipAvailableQuests` -- `SelectGossipAvailableQuest` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGossipOptions.md b/wiki-information/functions/GetNumGossipOptions.md deleted file mode 100644 index a36f8b06..00000000 --- a/wiki-information/functions/GetNumGossipOptions.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetNumGossipOptions - -**Content:** -Returns the number of conversation options available with this NPC. -`numOptions = GetNumGossipOptions()` - -**Returns:** -- `numOptions` - - *number* - Number of conversation options you can select. - -**Description:** -This information is available when the `GOSSIP_SHOW` event fires. - -**Reference:** -- `GetGossipOptions` -- `SelectGossipOption` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGroupMembers.md b/wiki-information/functions/GetNumGroupMembers.md deleted file mode 100644 index 75d0f655..00000000 --- a/wiki-information/functions/GetNumGroupMembers.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: GetNumGroupMembers - -**Content:** -Returns the number of players in the group. -`numMembers = GetNumGroupMembers()` - -**Parameters:** -- `groupType` - - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. - - **Value** - - **Enum** - - **Description** - - `1` - - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. - - `2` - - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder - -**Returns:** -- `numGroupMembers` - - *number* - total number of players in the group (either party or raid), 0 if not in a group. - -**Description:** -- **Related API:** - - `GetNumSubgroupMembers` -- **Related Events:** - - `GROUP_ROSTER_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetNumGuildMembers.md b/wiki-information/functions/GetNumGuildMembers.md deleted file mode 100644 index fef9a795..00000000 --- a/wiki-information/functions/GetNumGuildMembers.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: GetNumGuildMembers - -**Content:** -Returns the number of total and online guild members. -`numTotalGuildMembers, numOnlineGuildMembers, numOnlineAndMobileMembers = GetNumGuildMembers()` - -**Returns:** -- `numTotalGuildMembers` - - *number* - Total number of players in the Guild, or 0 if not in a guild. -- `numOnlineGuildMembers` - - *number* - Number of players currently online in Guild, or 0 if not in a guild. -- `numOnlineAndMobileMembers` - - *number* - Number of players currently online in Guild (includes players online through the mobile application), or 0 if not in a guild. - -**Usage:** -```lua -local numTotal, numOnline, numOnlineAndMobile = GetNumGuildMembers(); -DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " offline, " .. (numOnlineAndMobile - numOnline) .. " on mobile."); -local numTotal, numOnline, numOnlineAndMobile = GetNumGuildMembers(); -DEFAULT_CHAT_FRAME:AddMessage(numTotal .. " guild members: " .. numOnline .. " online, " .. (numTotal - numOnline) .. " offline, " .. (numOnlineAndMobile - numOnline) .. " on mobile."); -``` - -**Miscellaneous:** -Result: -Displays the number of people online, offline, on mobile, and the total headcount of your guild in the default chat frame. - -**Description:** -You may need to call `C_GuildInfo.GuildRoster()` first in order to obtain correct data. May return wrong values immediately after quitting a guild. Maximum returned value is 500. -There is another problem with the return values as they depend on `SetGuildRosterShowOffline()` setting. A simple program like: -```lua -DEFAULT_CHAT_FRAME:AddMessage("Firing SetGuildRosterShowOffline(false)"); -SetGuildRosterShowOffline(false) -DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(): "..tostring(GetNumGuildMembers())); -DEFAULT_CHAT_FRAME:AddMessage("Firing SetGuildRosterShowOffline(true)"); -SetGuildRosterShowOffline(true) -DEFAULT_CHAT_FRAME:AddMessage("GetNumGuildMembers(): "..tostring(GetNumGuildMembers())); -``` -will show the difference. -Take care, if your function called by `GUILD_ROSTER_UPDATE` event handling wants to set the show offline status via `SetGuildRosterShowOffline()`. This may cause, due to guild roster updates, a loop, where a user that has opened the guild panel can't switch the status anymore, even if you reset the original status in your function. -This is because `SetGuildRosterShowOffline()` fires a `GUILD_ROSTER_UPDATE` event if changed. \ No newline at end of file diff --git a/wiki-information/functions/GetNumLanguages.md b/wiki-information/functions/GetNumLanguages.md deleted file mode 100644 index b1847d2e..00000000 --- a/wiki-information/functions/GetNumLanguages.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetNumLanguages - -**Content:** -Returns the number of languages your character can speak. -`numLanguages = GetNumLanguages()` - -**Returns:** -- `numLanguages` - - *number* - -**Usage:** -Prints the available languages for the player. -```lua -for i = 1, GetNumLanguages() do - print(GetLanguageByIndex(i)) -end --- e.g. for Blood elf --- > "Orcish", 1 --- > "Thalassian", 10 -``` \ No newline at end of file diff --git a/wiki-information/functions/GetNumLootItems.md b/wiki-information/functions/GetNumLootItems.md deleted file mode 100644 index b0767d97..00000000 --- a/wiki-information/functions/GetNumLootItems.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumLootItems - -**Content:** -Returns the number of items in the loot window. -`numLootItems = GetNumLootItems()` - -**Returns:** -- `numLootItems` - - *number* - The slot number of the last item in the loot window. \ No newline at end of file diff --git a/wiki-information/functions/GetNumMacros.md b/wiki-information/functions/GetNumMacros.md deleted file mode 100644 index f5f81eb6..00000000 --- a/wiki-information/functions/GetNumMacros.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetNumMacros - -**Content:** -Returns the number of account and character macros. -`global, perChar = GetNumMacros()` - -**Returns:** -- `global` - - *number* - Number of macros accessible to all characters. -- `perChar` - - *number* - Number of macros accessible to the current character only. \ No newline at end of file diff --git a/wiki-information/functions/GetNumPetitionNames.md b/wiki-information/functions/GetNumPetitionNames.md deleted file mode 100644 index 62adc276..00000000 --- a/wiki-information/functions/GetNumPetitionNames.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumPetitionNames - -**Content:** -Returns the number of signatures on the current petition. -`numNames = GetNumPetitionNames()` - -**Returns:** -- `numNames` - - *number* - The number of names that have signed the petition \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestChoices.md b/wiki-information/functions/GetNumQuestChoices.md deleted file mode 100644 index 3e850ab1..00000000 --- a/wiki-information/functions/GetNumQuestChoices.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetNumQuestChoices - -**Content:** -Returns the number of available rewards for the current quest. -`numChoices = GetNumQuestChoices()` - -**Returns:** -- `numChoices` - - *number* - number of rewards the player can choose between. - -**Reference:** -- `GetNumQuestRewards` -- `GetNumRewardCurrencies` -- `GetQuestItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestItems.md b/wiki-information/functions/GetNumQuestItems.md deleted file mode 100644 index 210e5460..00000000 --- a/wiki-information/functions/GetNumQuestItems.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumQuestItems - -**Content:** -Returns the number of required items to complete the current quest. -`numRequiredItems = GetNumQuestItems()` - -**Returns:** -- `numRequiredItems` - - *number* - The number of required items for the quest \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLeaderBoards.md b/wiki-information/functions/GetNumQuestLeaderBoards.md deleted file mode 100644 index 7a613ee3..00000000 --- a/wiki-information/functions/GetNumQuestLeaderBoards.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetNumQuestLeaderBoards - -**Content:** -Returns the number of objectives for a quest. -`numQuestLogLeaderBoards = GetNumQuestLeaderBoards()` - -**Parameters:** -- `questID` - - *number* - Identifier of the quest. If not provided, defaults to the currently selected Quest, via `SelectQuestLogEntry()`. - -**Returns:** -- `numQuestLogLeaderBoards` - - *number* - The number of objectives this quest possesses (Can be 0). - -**Description:** -Previous versions of this page stated that the function returns three values, but did not list what the other two values were. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLogChoices.md b/wiki-information/functions/GetNumQuestLogChoices.md deleted file mode 100644 index ae8b6056..00000000 --- a/wiki-information/functions/GetNumQuestLogChoices.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetNumQuestLogChoices - -**Content:** -Returns the number of options someone has when getting a quest item. -`numQuestChoices = GetNumQuestLogChoices(questID)` - -**Parameters:** -- `questID` - - *number* - Unique QuestID for the quest to be queried. -- `includeCurrencies` - - *boolean?* - Optional parameter to include currencies in the count. - -**Returns:** -- `numQuestChoices` - - *number* - The number of quest item options for this quest. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLogEntries.md b/wiki-information/functions/GetNumQuestLogEntries.md deleted file mode 100644 index 3a078c7c..00000000 --- a/wiki-information/functions/GetNumQuestLogEntries.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetNumQuestLogEntries - -**Content:** -Returns the number of entries in the quest log. -`numEntries, numQuests = GetNumQuestLogEntries()` - -**Returns:** -- `numEntries` - - *number* - Number of entries in the Quest Log, including collapsable zone headers. -- `numQuests` - - *number* - Number of actual quests in the Quest Log, not counting zone headers. - -**Usage:** -This snippet displays the number of visible entries (headers and non-collapsed quests) in the quest log and quest count total to the default chat frame. -```lua -local numEntries, numQuests = GetNumQuestLogEntries() -print(numEntries .. " entries containing " .. numQuests .. " quests in your quest log.") -``` - -**Example Use Case:** -This function can be used in addons that manage or display quest information. For instance, an addon that provides enhanced quest tracking or sorting might use this function to determine how many quests are currently in the player's quest log and display this information in a custom UI. - -**Addons Using This Function:** -- **Questie:** A popular addon that enhances the questing experience by showing available quests, objectives, and turn-ins on the map. It uses `GetNumQuestLogEntries` to keep track of the number of quests the player has and to update its interface accordingly. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestLogRewards.md b/wiki-information/functions/GetNumQuestLogRewards.md deleted file mode 100644 index f74bb09d..00000000 --- a/wiki-information/functions/GetNumQuestLogRewards.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetNumQuestLogRewards - -**Content:** -Returns the number of unconditional rewards for the current quest in the quest log. -`numQuestRewards = GetNumQuestLogRewards()` - -**Returns:** -- `numQuestRewards` - - *number* - The number of rewards for this quest - -**Description:** -This refers to items always awarded upon quest completion; for quests where the player is allowed to choose a reward, see `GetNumQuestLogChoices()`. \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestRewards.md b/wiki-information/functions/GetNumQuestRewards.md deleted file mode 100644 index 84fcf1e0..00000000 --- a/wiki-information/functions/GetNumQuestRewards.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetNumQuestRewards - -**Content:** -Returns the number of unconditional rewards at a quest giver. -`numRewards = GetNumQuestRewards()` - -**Returns:** -- `numRewards` - - *number* - number of unconditional item rewards. - -**Reference:** -- `GetNumQuestChoices` -- `GetNumRewardCurrencies` -- `GetQuestItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumQuestWatches.md b/wiki-information/functions/GetNumQuestWatches.md deleted file mode 100644 index a126bbee..00000000 --- a/wiki-information/functions/GetNumQuestWatches.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumQuestWatches - -**Content:** -Returns the number of tracked quests. -`numWatches = GetNumQuestWatches()` - -**Returns:** -- `numWatches` - - *number* - The number of quests currently being tracked. \ No newline at end of file diff --git a/wiki-information/functions/GetNumRewardCurrencies.md b/wiki-information/functions/GetNumRewardCurrencies.md deleted file mode 100644 index 87eea8b6..00000000 --- a/wiki-information/functions/GetNumRewardCurrencies.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetNumRewardCurrencies - -**Content:** -Returns the number of currency rewards for the quest currently being viewed in the quest log or quest info frame. -`numCurrencies = GetNumRewardCurrencies()` - -**Returns:** -- `numCurrencies` - - *number* - The number of currency rewards - -**Reference:** -- `GetNumQuestRewards` -- `GetNumQuestChoices` -- `GetQuestCurrencyInfo` -- `GetQuestLogRewardCurrencyInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetNumSavedInstances.md b/wiki-information/functions/GetNumSavedInstances.md deleted file mode 100644 index 951879f5..00000000 --- a/wiki-information/functions/GetNumSavedInstances.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetNumSavedInstances - -**Content:** -Returns the number of instances for which the character is locked out. -`numInstances = GetNumSavedInstances()` - -**Returns:** -- `numInstances` - - *number* - number of instances with available lockouts, 0 if none. - -**Description:** -Returns the number of records that can be queried via `GetSavedInstanceInfo(...)`. -The count returned includes not just locked instances, but expired and extended lockouts as well. -The count does not include world bosses, which use `GetNumSavedWorldBosses()`. - -**Reference:** -- `GetSavedInstanceInfo(...)` - drills down to a specific saved instance -- `GetNumSavedWorldBosses()` - same function as this, but for world bosses \ No newline at end of file diff --git a/wiki-information/functions/GetNumSkillLines.md b/wiki-information/functions/GetNumSkillLines.md deleted file mode 100644 index d7999d5c..00000000 --- a/wiki-information/functions/GetNumSkillLines.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetNumSkillLines - -**Content:** -Returns the number of skill lines in the skill window, including headers. -`numSkills = GetNumSkillLines()` - -**Returns:** -- `numSkills` - - *number* - -**Reference:** -- `GetSkillLineInfo()` - -**Example Usage:** -This function can be used to iterate through all skill lines in the skill window. For example, you might use it in a loop to gather information about each skill line: - -```lua -local numSkills = GetNumSkillLines() -for i = 1, numSkills do - local skillName, isHeader = GetSkillLineInfo(i) - if not isHeader then - print("Skill:", skillName) - end -end -``` - -**Addons:** -Many addons that manage or display profession and skill information, such as TradeSkillMaster, use this function to gather data about the player's skills. \ No newline at end of file diff --git a/wiki-information/functions/GetNumSockets.md b/wiki-information/functions/GetNumSockets.md deleted file mode 100644 index 3ba94be4..00000000 --- a/wiki-information/functions/GetNumSockets.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GetNumSockets - -**Content:** -Returns the number of sockets for an item in the socketing window. - -**Parameters:** -- None - -**Returns:** -- `Sockets` - - *Number* - The number of sockets in the item currently in the item socketing window. If the item socketing window is closed, 0. - -**Usage:** -```lua -local SocketCount = GetNumSockets() -for i = 1, SocketCount do - print(GetSocketInfo(i)) -end -``` - -**Description:** -This function is only useful if the item socketing window is currently visible. \ No newline at end of file diff --git a/wiki-information/functions/GetNumSpellTabs.md b/wiki-information/functions/GetNumSpellTabs.md deleted file mode 100644 index d9f96fc7..00000000 --- a/wiki-information/functions/GetNumSpellTabs.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetNumSpellTabs - -**Content:** -Returns the number of tabs in the spellbook. -`numTabs = GetNumSpellTabs()` - -**Returns:** -- `numTabs` - - *number* - number of ability tabs in the player's spellbook (e.g. 4 -- "General", "Arcane", "Fire", "Frost") - -**Description:** -Each of the player's professions also gets a spellbook tab, but these tabs are not included in the count returned by this function. \ No newline at end of file diff --git a/wiki-information/functions/GetNumStableSlots.md b/wiki-information/functions/GetNumStableSlots.md deleted file mode 100644 index 4889e314..00000000 --- a/wiki-information/functions/GetNumStableSlots.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumStableSlots - -**Content:** -Returns the amount of stable slots. -`numSlots = GetNumStableSlots()` - -**Returns:** -- `numSlots` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetNumSubgroupMembers.md b/wiki-information/functions/GetNumSubgroupMembers.md deleted file mode 100644 index 5ac51091..00000000 --- a/wiki-information/functions/GetNumSubgroupMembers.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: GetNumSubgroupMembers - -**Content:** -Returns the number of other players in the party or raid subgroup. -`numSubgroupMembers = GetNumSubgroupMembers()` - -**Parameters:** -- `groupType` - - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. - - **Value** - - **Enum** - - **Description** - - `1` - - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. - - `2` - - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder - -**Returns:** -- `numSubgroupMembers` - - *number* - number of players in the player's sub-group, excluding the player. - -**Description:** -- **Related API** - - `GetNumGroupMembers` -- **Related Events** - - `GROUP_ROSTER_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetNumTalentGroups.md b/wiki-information/functions/GetNumTalentGroups.md deleted file mode 100644 index 9a1913e7..00000000 --- a/wiki-information/functions/GetNumTalentGroups.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetNumTalentGroups - -**Content:** -Returns the total number of talent groups for the player. -`num = GetNumTalentGroups()` - -**Parameters:** -- `isInspect` - - *boolean?* = false - -**Returns:** -- `num` - - *number* - The number of talent groups. 1 by default, 2 if Dual Talent Specialization is purchased. - -**Description:** -Using `isInspect` requires calling `NotifyInspect()` and awaiting `INSPECT_READY`. If not done, it returns information for the player instead. - -**Related API:** -- `GetNumTalentTabs` \ No newline at end of file diff --git a/wiki-information/functions/GetNumTalentTabs.md b/wiki-information/functions/GetNumTalentTabs.md deleted file mode 100644 index 4e5c4650..00000000 --- a/wiki-information/functions/GetNumTalentTabs.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetNumTalentTabs - -**Content:** -Returns the total number of talent tabs for the player. -`numTabs = GetNumTalentTabs()` - -**Parameters:** -- `isInspect` - - *boolean* - Optional, will return the number of talent tabs for the current inspect target if true (see NotifyInspect). - -**Returns:** -- `numTabs` - - *number* - The number of talent tabs available (for example Elemental, Enhancement, and Restoration for Shamans). \ No newline at end of file diff --git a/wiki-information/functions/GetNumTalents.md b/wiki-information/functions/GetNumTalents.md deleted file mode 100644 index 8ed5bef1..00000000 --- a/wiki-information/functions/GetNumTalents.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetNumTalents - -**Content:** -Returns the amount of talents for a specialization. -`numTalents = GetNumTalents(tabIndex)` - -**Parameters:** -- `tabIndex` - - *number* - Ranging from 1 to `GetNumTalentTabs()` - -**Returns:** -- `numTalents` - - *number* - The amount of talents offered by a specialization. - -**Reference:** -- `UnitCharacterPoints` - returns the amount of unspent talent points -- `GetTalentInfo/Classic` \ No newline at end of file diff --git a/wiki-information/functions/GetNumTitles.md b/wiki-information/functions/GetNumTitles.md deleted file mode 100644 index f677c75b..00000000 --- a/wiki-information/functions/GetNumTitles.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetNumTitles - -**Content:** -Returns the number of titles, specifically the highest title ID. -`numTitles = GetNumTitles()` - -**Returns:** -- `numTitles` - - *number* - TitleId \ No newline at end of file diff --git a/wiki-information/functions/GetNumTrackedAchievements.md b/wiki-information/functions/GetNumTrackedAchievements.md deleted file mode 100644 index e15addfe..00000000 --- a/wiki-information/functions/GetNumTrackedAchievements.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetNumTrackedAchievements - -**Content:** -Returns the number of tracked achievements. -`numTracked = GetNumTrackedAchievements()` - -**Returns:** -- `numTracked` - - *number* - number of achievements you are currently tracking, up to 10. - -**Reference:** -- `AddTrackedAchievement` -- `GetTrackedAchievements` -- `RemoveTrackedAchievement` - -**Example Usage:** -This function can be used to determine how many achievements a player is currently tracking. For instance, an addon could use this to display a list of tracked achievements or to ensure that the player does not exceed the tracking limit. - -**Addon Usage:** -Large addons like "Overachiever" use this function to manage and display tracked achievements, providing players with enhanced achievement tracking and management features. \ No newline at end of file diff --git a/wiki-information/functions/GetNumTradeSkills.md b/wiki-information/functions/GetNumTradeSkills.md deleted file mode 100644 index 3d2da529..00000000 --- a/wiki-information/functions/GetNumTradeSkills.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetNumTradeSkills - -**Content:** -Get the number of trade skill entries (including headers) -`numSkills = GetNumTradeSkills()` - -**Returns:** -- `numSkills` - - *number* - The number of trade skills which are available (including headers) - -**Example Usage:** -This function can be used to determine the total number of trade skills a player has, including headers which are used to categorize the skills. This is useful for addons that need to display or manage the player's trade skills. - -**Addon Usage:** -Large addons like TradeSkillMaster (TSM) use this function to gather information about the player's trade skills. TSM uses this data to provide detailed management and automation of crafting, auctioning, and other trade skill-related activities. \ No newline at end of file diff --git a/wiki-information/functions/GetOSLocale.md b/wiki-information/functions/GetOSLocale.md deleted file mode 100644 index 489260ff..00000000 --- a/wiki-information/functions/GetOSLocale.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetOSLocale - -**Content:** -Returns the locale of the Operating System. -`locale = GetOSLocale()` - -**Returns:** -- `locale` - - *string* - Recognized values are: - - `LanguageRegions = {}` - - `LanguageRegions = 0` - - `LanguageRegions = 1` - - `LanguageRegions = 2` - - `LanguageRegions = 3` - - `LanguageRegions = 4` - - `LanguageRegions = 5` - - `LanguageRegions = 6` - - `LanguageRegions = 7` - - `LanguageRegions = 8` - - `LanguageRegions = 9` - - `LanguageRegions = 10` - - `LanguageRegions = 11` - - `LanguageRegions = 12` - - `LanguageRegions = 13` - - `LanguageRegions = 14` \ No newline at end of file diff --git a/wiki-information/functions/GetObjectIconTextureCoords.md b/wiki-information/functions/GetObjectIconTextureCoords.md deleted file mode 100644 index 9db373f5..00000000 --- a/wiki-information/functions/GetObjectIconTextureCoords.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GetObjectIconTextureCoords - -**Content:** -Returns texture coordinates of an object icon. -`left, right, top, bottom = GetObjectIconTextureCoords(objectIcon)` - -**Parameters:** -- `objectIcon` - - *number* - index of the object icon to retrieve texture coordinates for, ascending from -2. - -**Returns:** -- `left` - - *number* - left edge of the specified icon, 0 for the texture's left edge and 1 for the texture's right edge. -- `right` - - *number* - right edge of the specified icon, 0 for the texture's left edge and 1 for the texture's right edge. -- `top` - - *number* - top edge of the specified icon, 0 for the texture's top edge and 1 for the texture's bottom edge. -- `bottom` - - *number* - bottom edge of the specified icon, 0 for the texture's top edge and 1 for the texture's bottom edge. - -**Description:** -Returns texture coordinates into `Interface\\MINIMAP\\OBJECTICONS.blp`, the minimap blip texture. \ No newline at end of file diff --git a/wiki-information/functions/GetOptOutOfLoot.md b/wiki-information/functions/GetOptOutOfLoot.md deleted file mode 100644 index fba43803..00000000 --- a/wiki-information/functions/GetOptOutOfLoot.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetOptOutOfLoot - -**Content:** -Returns true if the player is automatically passing on all loot. -`optedOut = GetOptOutOfLoot()` - -**Returns:** -- `optedOut` - - *boolean* - 1 if the player is currently passing on all loot, nil otherwise. - -**Reference:** -- `SetOptOutOfLoot` \ No newline at end of file diff --git a/wiki-information/functions/GetOwnerAuctionItems.md b/wiki-information/functions/GetOwnerAuctionItems.md deleted file mode 100644 index e4d152ce..00000000 --- a/wiki-information/functions/GetOwnerAuctionItems.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetOwnerAuctionItems - -**Content:** -Updates owned auction list. -`GetOwnerAuctionItems()` - -**Usage:** -When selling multiple stacks of items (multisell) sometimes the last few stacks get posted without a subsequent list update. -Useful for when `AUCTION_OWNED_LIST_UPDATE` fires but the list isn't actually updated until you switch to the tab. - -**Description:** -Manually calling this function doesn't appear to do anything by itself. Having an event handler registered for the event, calling it shortly after an auction is posted or calling it in an `OnShow` handler can make it work. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPDesired.md b/wiki-information/functions/GetPVPDesired.md deleted file mode 100644 index 16ce3a56..00000000 --- a/wiki-information/functions/GetPVPDesired.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetPVPDesired - -**Content:** -Returns true if the player has enabled their PvP flag. -`desired = GetPVPDesired()` - -**Returns:** -- `desired` - - *boolean* - true if the player has enabled their PvP flag \ No newline at end of file diff --git a/wiki-information/functions/GetPVPLastWeekStats.md b/wiki-information/functions/GetPVPLastWeekStats.md deleted file mode 100644 index c7f12498..00000000 --- a/wiki-information/functions/GetPVPLastWeekStats.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetPVPLastWeekStats - -**Content:** -Gets the player's PVP contribution statistics for the previous week. -`hk, dk, contribution, rank = GetPVPLastWeekStats()` - -**Returns:** -- `hk` - - *number* - The number of honorable kills. -- `dk` - - *number* - The number of dishonorable kills. -- `contribution` - - *number* - The estimated number of honor contribution points. -- `rank` - - *number* - The honor rank the player had. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPLifetimeStats.md b/wiki-information/functions/GetPVPLifetimeStats.md deleted file mode 100644 index 7686bf43..00000000 --- a/wiki-information/functions/GetPVPLifetimeStats.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetPVPLifetimeStats - -**Content:** -Returns the character's lifetime PvP statistics. -`lifetimeHonorableKills, lifetimeMaxPVPRank = GetPVPLifetimeStats()` - -**Returns:** -- `lifetimeHonorableKills` - - *number* - The number of honorable kills you have made -- `lifetimeMaxPVPRank` - - *number* - The highest rank you have achieved (Use `GetPVPRankInfo(highestRank)` to get the name of the rank) - -**Usage:** -Prints the player's PVP rank name to the default chat frame. -```lua -local _, _, highestRank = GetPVPLifetimeStats() -local pvpRank = GetPVPRankInfo(highestRank) -print(pvpRank) -``` \ No newline at end of file diff --git a/wiki-information/functions/GetPVPRankInfo.md b/wiki-information/functions/GetPVPRankInfo.md deleted file mode 100644 index 73ba8a7d..00000000 --- a/wiki-information/functions/GetPVPRankInfo.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: GetPVPRankInfo - -**Content:** -Returns information about a specific PvP rank. -`rankName, rankNumber = GetPVPRankInfo(rankID)` - -**Parameters:** -- `rankID` - - *number* - The PvP rank ID as returned by `UnitPVPRank()` -- `faction` - - *number?* - 0 for Horde, 1 for Alliance. Defaults to the player's faction. Previously accepted a UnitId but now takes a faction ID. - -**Values:** -Dishonorable ranks like "Pariah" exist but were never used in Vanilla. - -| Rank ID | Alliance | Horde | Rank Number | -|---------|--------------------|-------------------|-------------| -| 0 | Pariah | Pariah | -4 | -| 1 | Outlaw | Outlaw | -3 | -| 2 | Exiled | Exiled | -2 | -| 3 | Dishonored | Dishonored | -1 | -| 4 | Private | Scout | 1 | -| 5 | Corporal | Grunt | 2 | -| 6 | Sergeant | Sergeant | 3 | -| 7 | Master Sergeant | Senior Sergeant | 4 | -| 8 | Sergeant Major | First Sergeant | 5 | -| 9 | Knight | Stone Guard | 6 | -| 10 | Knight-Lieutenant | Blood Guard | 7 | -| 11 | Knight-Captain | Legionnaire | 8 | -| 12 | Knight-Champion | Centurion | 9 | -| 13 | Lieutenant Commander | Champion | 10 | -| 14 | Commander | Lieutenant General| 11 | -| 15 | Marshal | General | 12 | -| 16 | Field Marshal | Warlord | 13 | -| 17 | Grand Marshal | High Warlord | 14 | - -**Returns:** -- `rankName` - - *string* - The localized name of the PvP rank. -- `rankNumber` - - *number* - The PvP rank number. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPRankProgress.md b/wiki-information/functions/GetPVPRankProgress.md deleted file mode 100644 index 6dd2cf35..00000000 --- a/wiki-information/functions/GetPVPRankProgress.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetPVPRankProgress - -**Content:** -Returns the player's progress to the next PvP rank. -`progress = GetPVPRankProgress()` - -**Returns:** -- `progress` - - *number* - Progress towards the next rank, value normalized between 0 and 1. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPRoles.md b/wiki-information/functions/GetPVPRoles.md deleted file mode 100644 index d8dd4f7a..00000000 --- a/wiki-information/functions/GetPVPRoles.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetPVPRoles - -**Content:** -Returns which roles the player is willing to perform in PvP battlegrounds. -`tank, healer, dps = GetPVPRoles()` - -**Returns:** -- `tank` - - *boolean* - true if the player is marked as willing to tank, false otherwise. -- `healer` - - *boolean* - true if the player is marked as willing to heal, false otherwise. -- `dps` - - *boolean* - true if the player is marked as willing to deal damage, false otherwise. - -**Reference:** -- `SetPVPRoles` -- `PVP_ROLE_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/GetPVPSessionStats.md b/wiki-information/functions/GetPVPSessionStats.md deleted file mode 100644 index dc2d2e0c..00000000 --- a/wiki-information/functions/GetPVPSessionStats.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetPVPSessionStats - -**Content:** -Returns the character's Honor statistics for this session. -`honorableKills, dishonorableKills = GetPVPSessionStats()` - -**Returns:** -- `honorableKills` - - *number* - Amount of honorable kills you have today, returns 0 if you haven't killed anybody today. -- `dishonorableKills` - - *number* - Note: Not sure if this is dishonorable kills or estimated honor points for today. - -**Description:** -Used for retrieving how many honorable kills and honor points you have for today, currently the honor points value is calculated using the estimated honor points from killing an enemy player, and does not take diminishing returns or bonus honor into effect. - -**Usage:** -Displays how many honorable kills and estimated honor points you have for today. -```lua -local hk, hp = GetPVPSessionStats(); -DEFAULT_CHAT_FRAME:AddMessage("You currently have " .. hk .. " honorable kills today, and an estimated " .. hp .. " honor points."); -``` \ No newline at end of file diff --git a/wiki-information/functions/GetPVPThisWeekStats.md b/wiki-information/functions/GetPVPThisWeekStats.md deleted file mode 100644 index 5bc770ad..00000000 --- a/wiki-information/functions/GetPVPThisWeekStats.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetPVPThisWeekStats - -**Content:** -Gets your PVP contribution statistics for the current week. -`hk, contribution = GetPVPThisWeekStats()` - -**Returns:** -- `hk` - - *number* - The number of honorable kills. -- `contribution` - - *number* - The estimated honor points made. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPTimer.md b/wiki-information/functions/GetPVPTimer.md deleted file mode 100644 index 83e84842..00000000 --- a/wiki-information/functions/GetPVPTimer.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetPVPTimer - -**Content:** -Returns the time left in milliseconds until the player is unflagged for PvP. -`timer = GetPVPTimer()` - -**Returns:** -- `timer` - - *number* - Amount of time (in milliseconds) until your PVP flag wears off. - -**Description:** -- If you are flagged for PVP permanently, the function returns 301000. -- If you are not flagged for PVP the function returns either 301000 or -1. - -**Usage:** -The following snippet displays your current PVP status: -```lua -local sec = math.floor(GetPVPTimer()/1000) -local msg = (not UnitIsPVP("player")) and "You are not flagged for PVP" or - (sec==301 and "You are perma-flagged for PVP" or - "Your PVP flag wears off in "..(sec>60 and math.floor(sec/60).." minutes " or "")..(sec%60).." seconds") -DEFAULT_CHAT_FRAME:AddMessage(msg) -``` - -**Example Use Case:** -This function can be used in addons that manage or display player status, particularly in PvP environments. For instance, an addon could use this function to show a countdown timer for when a player will be unflagged from PvP, helping players to manage their PvP status more effectively. - -**Addons Using This Function:** -- **PvPStatus**: An addon that tracks and displays the player's PvP flag status and the remaining time until the flag is removed. It uses `GetPVPTimer` to provide real-time updates to the player. \ No newline at end of file diff --git a/wiki-information/functions/GetPVPYesterdayStats.md b/wiki-information/functions/GetPVPYesterdayStats.md deleted file mode 100644 index 3779be90..00000000 --- a/wiki-information/functions/GetPVPYesterdayStats.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetPVPYesterdayStats - -**Content:** -Returns the character's Honor statistics for yesterday. -`honorableKills, dishonorableKills = GetPVPYesterdayStats()` - -**Returns:** -- `honorableKills` - - *number* - The number of honorable kills -- `dishonorableKills` - - *number* - The number of dishonorable kills \ No newline at end of file diff --git a/wiki-information/functions/GetParryChance.md b/wiki-information/functions/GetParryChance.md deleted file mode 100644 index 7fef5cf8..00000000 --- a/wiki-information/functions/GetParryChance.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetParryChance - -**Content:** -Returns the parry chance percentage. -`parryChance = GetParryChance()` - -**Returns:** -- `parryChance` - - *number* - Player's parry chance in percentage. - -**Reference:** -- `GetBlockChance` -- `GetDodgeChance` -- `GetCritChance` -- `GetCombatRating` -- `GetCombatRatingBonus` \ No newline at end of file diff --git a/wiki-information/functions/GetParryChanceFromAttribute.md b/wiki-information/functions/GetParryChanceFromAttribute.md deleted file mode 100644 index d9a2d8e3..00000000 --- a/wiki-information/functions/GetParryChanceFromAttribute.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetParryChanceFromAttribute - -**Content:** -Needs summary. -`parryChance = GetParryChanceFromAttribute()` - -**Returns:** -- `parryChance` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetPartyAssignment.md b/wiki-information/functions/GetPartyAssignment.md deleted file mode 100644 index 72ba112d..00000000 --- a/wiki-information/functions/GetPartyAssignment.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetPartyAssignment - -**Content:** -Returns true if a group member is assigned the main tank/assist role. -`isAssigned = GetPartyAssignment(assignment)` - -**Parameters:** -- `assignment` - - *string* - The role to search, either "MAINTANK" or "MAINASSIST" (not case-sensitive). -- `raidmember` - - *string* - UnitId -- `exactMatch` - - *boolean* - -**Returns:** -- `isAssigned` - - *boolean* - -**Example Usage:** -```lua -local isMainTank = GetPartyAssignment("MAINTANK", "player") -if isMainTank then - print("You are the main tank!") -else - print("You are not the main tank.") -end -``` - -**Addons Using This Function:** -- **Deadly Boss Mods (DBM):** Utilizes this function to determine and announce the roles of players during raid encounters. -- **Grid:** Uses this function to display role-specific indicators on the unit frames. \ No newline at end of file diff --git a/wiki-information/functions/GetPersonalRatedInfo.md b/wiki-information/functions/GetPersonalRatedInfo.md deleted file mode 100644 index 7961d116..00000000 --- a/wiki-information/functions/GetPersonalRatedInfo.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: GetPersonalRatedInfo - -**Content:** -Returns information about the player's personal PvP rating in a specific bracket. -`rating, seasonBest, weeklyBest, seasonPlayed, seasonWon, weeklyPlayed, weeklyWon, cap = GetPersonalRatedInfo(index)` - -**Parameters:** -- `index` - - *number* - PvP bracket index ascending from 1 for 2v2, 3v3, 5v5, and 10v10 rated battlegrounds. - -**Returns:** -- `rating` - - *number* - the player's current rating. -- `seasonBest` - - *number* - the player's season best rating. -- `weeklyBest` - - *number* - the player's weekly best rating. -- `seasonPlayed` - - *number* - number of games played in this bracket this season. -- `seasonWon` - - *number* - number of games won in this bracket this season. -- `weeklyPlayed` - - *number* - number of games played in this bracket this week. -- `weeklyWon` - - *number* - number of games won in this bracket this season. -- `cap` - - *number* - projected conquest cap in points. - -**Reference:** -`GetInspectArenaData` - -**Example Usage:** -This function can be used to display a player's current and historical performance in different PvP brackets. For instance, an addon that tracks and displays PvP statistics could use this function to show detailed information about a player's ratings and game history. - -**Addon Usage:** -Large PvP-focused addons like "GladiatorlosSA" or "REFlex - Arena/Battleground Historian" might use this function to provide players with insights into their performance, helping them to track their progress and improve their strategies in rated PvP matches. \ No newline at end of file diff --git a/wiki-information/functions/GetPetActionCooldown.md b/wiki-information/functions/GetPetActionCooldown.md deleted file mode 100644 index 9043968e..00000000 --- a/wiki-information/functions/GetPetActionCooldown.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetPetActionCooldown - -**Content:** -Returns cooldown info for an action on the pet action bar. -`startTime, duration, enable = GetPetActionCooldown(index)` - -**Parameters:** -- `index` - - *number* - The index of the pet action button you want to query for cooldown info. - -**Returns:** -- `startTime` - - *number* - The time when the cooldown started (as returned by GetTime()) or zero if no cooldown -- `duration` - - *number* - The number of seconds the cooldown will last, or zero if no cooldown -- `enable` - - *boolean* - 0 if no cooldown, 1 if cooldown is in effect (probably) - -**Example Usage:** -```lua -local index = 1 -- Example index for the first pet action button -local startTime, duration, enable = GetPetActionCooldown(index) -if enable == 1 then - print("Cooldown started at:", startTime) - print("Cooldown duration:", duration) -else - print("No cooldown in effect.") -end -``` - -**Additional Information:** -This function is commonly used in addons that manage pet abilities, such as those for hunters and warlocks. For example, the popular addon "PetTracker" might use this function to display cooldowns for pet abilities on the action bar. \ No newline at end of file diff --git a/wiki-information/functions/GetPetActionInfo.md b/wiki-information/functions/GetPetActionInfo.md deleted file mode 100644 index 8471add7..00000000 --- a/wiki-information/functions/GetPetActionInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetPetActionInfo - -**Content:** -Returns info for an action on the pet action bar. -`name, texture, isToken, isActive, autoCastAllowed, autoCastEnabled, spellID, checksRange, inRange = GetPetActionInfo(index)` - -**Parameters:** -- `index` - - *number* - The index of the pet action button you want to query. - -**Returns:** -- `name` - - *string* - The name of the action (or its global ID if isToken is true). -- `texture` - - *string* - The name (or its global ID, if isToken is true) of the texture for the action. -- `isToken` - - *boolean* - Indicates if the action is a reference to a global action, or not (guess). -- `isActive` - - *boolean* - Returns true if the ability is currently active. -- `autoCastAllowed` - - *boolean* - Returns true if this ability can use autocast. -- `autoCastEnabled` - - *boolean* - Returns true if autocast is currently enabled for this ability. -- `spellID` - - *number* - Returns the spell ID associated with this ability. -- `checksRange` - - *boolean* - Returns true if this ability has a numeric range requirement. -- `inRange` - - *boolean* - Returns true if this ability is currently in range. - -**Description:** -Information based on a post from Sarf plus some guesswork, so may not be 100% accurate. \ No newline at end of file diff --git a/wiki-information/functions/GetPetActionSlotUsable.md b/wiki-information/functions/GetPetActionSlotUsable.md deleted file mode 100644 index 6f89a3cc..00000000 --- a/wiki-information/functions/GetPetActionSlotUsable.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetPetActionSlotUsable - -**Content:** -Indicates if the current player's pet can currently use the specified pet action. -`isUsable = GetPetActionSlotUsable(index)` - -**Parameters:** -- `index` - - *number* - The index of the pet action button you want to query. - -**Returns:** -- `isUsable` - - *boolean* - Returns true if the pet action is currently usable, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetPetExperience.md b/wiki-information/functions/GetPetExperience.md deleted file mode 100644 index 7bb33ddd..00000000 --- a/wiki-information/functions/GetPetExperience.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetPetExperience - -**Content:** -Returns the pet's current and total XP required for the next level. -`currXP, nextXP = GetPetExperience()` - -**Returns:** -- `currXP` - - *number* - The current XP total -- `nextXP` - - *number* - The XP total required for the next level - -**Usage:** -```lua -local currXP, nextXP = GetPetExperience(); -DEFAULT_CHAT_FRAME:AddMessage("Pet experience: " .. currXP .. " / " .. nextXP); -``` - -**Miscellaneous:** -Result: -Pet experience is displayed in the default chat frame. \ No newline at end of file diff --git a/wiki-information/functions/GetPetFoodTypes.md b/wiki-information/functions/GetPetFoodTypes.md deleted file mode 100644 index 210aa033..00000000 --- a/wiki-information/functions/GetPetFoodTypes.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetPetFoodTypes - -**Content:** -Returns the food types the pet can eat. -`petFoodList = { GetPetFoodTypes() }` - -**Returns:** -- multiple Strings (not a table) - - Possible strings: - - Meat - - Fish - - Fruit - - Fungus - - Bread - - Cheese - -**Usage:** -To print every string from the list into the default chatframe. -```lua -local petFoodList = { GetPetFoodTypes() }; -if #petFoodList > 0 then - local index, foodType; - for index, foodType in pairs(petFoodList) do - DEFAULT_CHAT_FRAME:AddMessage(foodType); - end -else - DEFAULT_CHAT_FRAME:AddMessage("No pet food types available."); -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetPetHappiness.md b/wiki-information/functions/GetPetHappiness.md deleted file mode 100644 index 1e688fe3..00000000 --- a/wiki-information/functions/GetPetHappiness.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: GetPetHappiness - -**Content:** -Returns the pet's happiness, damage percentage, and loyalty gain rate. -`happiness, damagePercentage, loyaltyRate = GetPetHappiness()` - -**Returns:** -- `happiness` - - *number* - the numerical happiness value of the pet (1 = unhappy, 2 = content, 3 = happy) -- `damagePercentage` - - *number* - damage modifier, happiness affects this (unhappy = 75%, content = 100%, happy = 125%) -- `loyaltyRate` - - *number* - the rate at which your pet is currently gaining loyalty (< 0, losing loyalty, > 0, gaining loyalty) - -**Usage:** -```lua -local happiness, damagePercentage, loyaltyRate = GetPetHappiness() -if not happiness then - print("No Pet") -else - local happy = ({"Unhappy", "Content", "Happy"}) - local loyalty = loyaltyRate > 0 and "gaining" or "losing" - print("Pet is " .. happy[happiness]) - print("Pet is doing " .. damagePercentage .. "% damage") - print("Pet is " .. loyalty .. " loyalty") -end -``` - -**Example Use Case:** -This function can be used in a Hunter's pet management addon to display the pet's current happiness and loyalty status, which can affect the pet's performance in combat. - -**Addons Using This Function:** -- **PetTracker:** This addon uses `GetPetHappiness` to provide detailed information about the player's pet, including its happiness and loyalty status, which can be crucial for maintaining optimal pet performance. \ No newline at end of file diff --git a/wiki-information/functions/GetPetLoyalty.md b/wiki-information/functions/GetPetLoyalty.md deleted file mode 100644 index 0cf14982..00000000 --- a/wiki-information/functions/GetPetLoyalty.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetPetLoyalty - -**Content:** -Returns pet loyalty flavor text. -`petLoyaltyText = GetPetLoyalty()` - -**Returns:** -- `petLoyaltyText` - - *string* - The localized pet loyalty level, i.e. "(Loyalty Level 6) Best Friend". \ No newline at end of file diff --git a/wiki-information/functions/GetPetSpellBonusDamage.md b/wiki-information/functions/GetPetSpellBonusDamage.md deleted file mode 100644 index 9e8f518e..00000000 --- a/wiki-information/functions/GetPetSpellBonusDamage.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetPetSpellBonusDamage - -**Content:** -Needs summary. -`spellBonus = GetPetSpellBonusDamage()` - -**Returns:** -- `spellBonus` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetPetTrainingPoints.md b/wiki-information/functions/GetPetTrainingPoints.md deleted file mode 100644 index cee595bd..00000000 --- a/wiki-information/functions/GetPetTrainingPoints.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetPetTrainingPoints - -**Content:** -Gets the training point information about the current pet. -`totalPoints, spent = GetPetTrainingPoints()` - -**Returns:** -- `totalPoints` - - *number* - The total of points spent and points available. -- `spent` - - *number* - The number of points spent. \ No newline at end of file diff --git a/wiki-information/functions/GetPetitionInfo.md b/wiki-information/functions/GetPetitionInfo.md deleted file mode 100644 index d718b9fe..00000000 --- a/wiki-information/functions/GetPetitionInfo.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetPetitionInfo - -**Content:** -Returns info for the petition being viewed. -`petitionType, title, bodyText, maxSigs, originator, isOriginator, minSigs = GetPetitionInfo()` - -**Returns:** -- `petitionType` - - *string* - The type of petition (e.g., "guild" or "arena") -- `title` - - *string* - The title of the group being created -- `bodyText` - - *string* - The body text of the petition -- `maxSigs` - - *number* - The maximum number of signatures allowed on the petition -- `originator` - - *string* - The name of the person who started the petition -- `isOriginator` - - *boolean* - Whether the player is the originator of the petition -- `minSigs` - - *number* - The minimum number of signatures required for the petition - -**Reference:** -- `PETITION_SHOW` - Indicates information is available. \ No newline at end of file diff --git a/wiki-information/functions/GetPhysicalScreenSize.md b/wiki-information/functions/GetPhysicalScreenSize.md deleted file mode 100644 index fd40a785..00000000 --- a/wiki-information/functions/GetPhysicalScreenSize.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetPhysicalScreenSize - -**Content:** -Returns physical screen size of the game. -`width, height = GetPhysicalScreenSize()` - -**Returns:** -- `width` - - *number* - game physical screen width. -- `height` - - *number* - game physical screen height. \ No newline at end of file diff --git a/wiki-information/functions/GetPlayerFacing.md b/wiki-information/functions/GetPlayerFacing.md deleted file mode 100644 index 9713c047..00000000 --- a/wiki-information/functions/GetPlayerFacing.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetPlayerFacing - -**Content:** -Returns the direction the character is facing in radians. -`facing = GetPlayerFacing()` - -**Returns:** -- `facing` - - *number* - Direction the player is facing in radians, in the range, where 0 is North and values increase counterclockwise. - -**Description:** -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. \ No newline at end of file diff --git a/wiki-information/functions/GetPlayerInfoByGUID.md b/wiki-information/functions/GetPlayerInfoByGUID.md deleted file mode 100644 index 7e849abe..00000000 --- a/wiki-information/functions/GetPlayerInfoByGUID.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: GetPlayerInfoByGUID - -**Content:** -Returns character info for another player from their GUID. -`localizedClass, englishClass, localizedRace, englishRace, sex, name, realm = GetPlayerInfoByGUID(guid)` - -**Parameters:** -- `guid` - - *string* - The GUID of the player you're querying. - -**Returns:** -- `localizedClass` - - *string* - Localized class name. -- `englishClass` - - *string* - Localization-independent class name. -- `localizedRace` - - *string* - Localized race name. -- `englishRace` - - *string* - Localization-independent race name. -- `sex` - - *number* - Gender ID of the character. 2 for male, or 3 for female. -- `name` - - *string* - The name of the character. -- `realm` - - *string* - Normalized realm name of the character. Returns an empty string if the character is from the same realm as the player. - -**Usage:** -When used on yourself. -```lua -/dump UnitGUID("target"), GetPlayerInfoByGUID(UnitGUID("target")) -> "Player-1096-06DF65C1", "Priest", "PRIEST", "Human", "Human", 3, "Xiaohuli", "" -``` -When used on a player from another realm, in this case from the same connected realm. -```lua -> "Player-1096-0971D0BE", "Monk", "MONK", "Night Elf", "NightElf", 2, "Coldbits", "DarkmoonFaire" -``` \ No newline at end of file diff --git a/wiki-information/functions/GetPossessInfo.md b/wiki-information/functions/GetPossessInfo.md deleted file mode 100644 index f236b2da..00000000 --- a/wiki-information/functions/GetPossessInfo.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetPossessInfo - -**Content:** -Returns info for an action on the possession bar. -`texture, spellID, enabled = GetPossessInfo(index)` - -**Parameters:** -- `index` - - *number* - The slot of the possess bar to check, ascending from 1. - -**Returns:** -- `texture` - - *string* - The icon texture used for this slot, nil if the slot is empty -- `spellID` - - *number* - The name of the action in this slot, nil if the slot is empty. -- `enabled` - - *boolean* - true if there is an action in this slot, nil otherwise. - -**Description:** -The possession bar is shown by the default UI (like a stance bar) while the player is controlling another target, such as while channeling. -Typically, the first slot contains the spell used to control the other unit (which does nothing), while the second slot has a "Cancel" action that ends the effect. - -**Reference:** -- `IsPossessBarVisible` \ No newline at end of file diff --git a/wiki-information/functions/GetPreviousAchievement.md b/wiki-information/functions/GetPreviousAchievement.md deleted file mode 100644 index 8861c617..00000000 --- a/wiki-information/functions/GetPreviousAchievement.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetPreviousAchievement - -**Content:** -Returns the previous achievement in a chain. -`previousAchievementID = GetPreviousAchievement(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - The ID of the Achievement - -**Returns:** -- `previousAchievementID` - - *number or nil* - The ID of the previous Achievement in chain. \ No newline at end of file diff --git a/wiki-information/functions/GetProfessionInfo.md b/wiki-information/functions/GetProfessionInfo.md deleted file mode 100644 index 61580d37..00000000 --- a/wiki-information/functions/GetProfessionInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: GetProfessionInfo - -**Content:** -Gets details on a profession from its index including name, icon, and skill level. -`name, icon, skillLevel, maxSkillLevel, numAbilities, spelloffset, skillLine, skillModifier, specializationIndex, specializationOffset = GetProfessionInfo(index)` - -**Parameters:** -- `index` - - *number* - The skillLineIDs from GetProfessions - -**Returns:** -- `name` - - *string* - The localized skill name -- `icon` - - *string* - the location of the icon image -- `skillLevel` - - *number* - the current skill level -- `maxSkillLevel` - - *number* - the current skill cap (75 for apprentice, 150 for journeyman etc.) -- `numAbilities` - - *number* - The number of abilities/icons listed. These are the icons you put on your action bars. -- `spelloffset` - - *number* - The offset id of the first Spell of this profession. (you can `CastSpell(spelloffset + 1, "Spell")` to use the first spell of this profession) -- `skillLine` - - *number* - Reference to the profession. -- `skillModifier` - - *number* - Additional modifiers to your profession levels. IE: Lures for Fishing. -- `specializationIndex` - - *number* - A value indicating which specialization is known (ie. Transmute specialist for Alchemist) -- `specializationOffset` - - *number* - Haven't figured this one out yet - -**Description:** -This also seems to return some kind of data on the talent trees and guild perks. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestBackgroundMaterial.md b/wiki-information/functions/GetQuestBackgroundMaterial.md deleted file mode 100644 index 5770463b..00000000 --- a/wiki-information/functions/GetQuestBackgroundMaterial.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetQuestBackgroundMaterial - -**Content:** -Returns the background texture for the displayed quest. -`material = GetQuestBackgroundMaterial()` - -**Returns:** -- `material` - - *string?* - The material string for this quest, or nil if the default, "Parchment", is to be used. - -**Description:** -This texture is used to paint the background of the Blizzard Quest Frame. It does not appear in the Quest Log, but only when initially reading, accepting, or handing in the quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestCurrencyInfo.md b/wiki-information/functions/GetQuestCurrencyInfo.md deleted file mode 100644 index cc7deea3..00000000 --- a/wiki-information/functions/GetQuestCurrencyInfo.md +++ /dev/null @@ -1,48 +0,0 @@ -## Title: GetQuestCurrencyInfo - -**Content:** -Returns information about a currency token rewarded from the quest currently being viewed in the quest info frame. -`name, texture, numItems, quality = GetQuestCurrencyInfo(itemType, index)` - -**Parameters:** -- `itemType` - - *string* - The category of the currency to query. Currently "reward" is the only category in use for currencies. -- `index` - - *number* - The index of the currency to query, in the range. - -**Returns:** -- `name` - - *string* - The localized name of the currency. -- `texture` - - *string* - The path to the icon texture used for the currency. -- `numItems` - - *number* - The amount of the currency that will be rewarded. -- `quality` - - *number* - Indicates the rarity of the currency. - -**Description:** -This function does not work for quests being viewed from the player's quest log. Use `GetQuestLogRewardCurrencyInfo` instead. Check `QuestInfoFrame.questLog` to determine whether the quest info frame is currently displaying a quest log quest or not. - -**Usage:** -Print a list of currencies rewarded by the currently viewed quest to the chat frame: -```lua -local numRewardCurrencies = GetNumRewardCurrencies() -if numRewardCurrencies > 0 then - print("This quest rewards", numRewardCurrencies, "currencies:") - for i = 1, numRewardCurrencies do - local name, texture, numItems - if QuestInfoFrame.questLog then - name, texture, numItems = GetQuestLogRewardCurrencyInfo(i) - else - name, texture, numItems = GetQuestCurrencyInfo("reward", i) - end - print(format("|T%s:0|t %dx %s", texture, numItems, name)) - end -else - print("This quest does not reward any currencies.") -end -``` - -**Reference:** -- `GetNumRewardCurrencies` -- `GetQuestLogRewardCurrencyInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestFactionGroup.md b/wiki-information/functions/GetQuestFactionGroup.md deleted file mode 100644 index eac620ed..00000000 --- a/wiki-information/functions/GetQuestFactionGroup.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetQuestFactionGroup - -**Content:** -`factionGroup = GetQuestFactionGroup(questID)` - -**Parameters:** -- `questID` - - *number* - Unique QuestID. - -**Returns:** -- `factionGroup` - - *number* - - **Key** | **Value** | **Description** - - --- | --- | --- - - 0 | Neutral | LE_QUEST_FACTION_ALLIANCE - - 1 | Alliance | LE_QUEST_FACTION_HORDE - - 2 | Horde | - -**Reference:** -QuestMapFrame.lua, patch 6.0.2 \ No newline at end of file diff --git a/wiki-information/functions/GetQuestGreenRange.md b/wiki-information/functions/GetQuestGreenRange.md deleted file mode 100644 index 7e36bb4b..00000000 --- a/wiki-information/functions/GetQuestGreenRange.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetQuestGreenRange - -**Content:** -Return for how many levels below you quests and mobs remain "green" (i.e. yield XP) -`range = GetQuestGreenRange()` - -**Returns:** -- `range` - - *number* - an integer value, currently up to 12 (at level 60) - -**Usage:** -- At level 9, `GetQuestGreenRange()` returns 5 -- At level 50, `GetQuestGreenRange()` returns 10 \ No newline at end of file diff --git a/wiki-information/functions/GetQuestID.md b/wiki-information/functions/GetQuestID.md deleted file mode 100644 index 3917dd92..00000000 --- a/wiki-information/functions/GetQuestID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetQuestID - -**Content:** -Returns the ID of the displayed quest at a quest giver. -`questID = GetQuestID()` - -**Returns:** -- `questID` - - *number* - quest ID of the offered/discussed quest. - -**Description:** -Only returns proper (non-zero) values: -- after `QUEST_DETAIL` for offered quests and `QUEST_PROGRESS` / `QUEST_COMPLETE` for accepted quests. -- before `QUEST_FINISHED`. - -This function is not related to your quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestIndexForTimer.md b/wiki-information/functions/GetQuestIndexForTimer.md deleted file mode 100644 index 98c04770..00000000 --- a/wiki-information/functions/GetQuestIndexForTimer.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetQuestIndexForTimer - -**Content:** -Gets the quest log index of a quest being timed. -`questIndex = GetQuestIndexForTimer(timerId)` - -**Parameters:** -- `timerId` - - *number* - The ID of a quest timer. - -**Returns:** -- `questIndex` - - *number* - The quest log's index of the timed quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestIndexForWatch.md b/wiki-information/functions/GetQuestIndexForWatch.md deleted file mode 100644 index fee73980..00000000 --- a/wiki-information/functions/GetQuestIndexForWatch.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetQuestIndexForWatch - -**Content:** -Gets the quest log index of a watched quest. -`questIndex = GetQuestIndexForWatch(watchIndex)` - -**Parameters:** -- `watchIndex` - - *number* - The index of a quest watch; an integer between 1 and `GetNumQuestWatches()`. - -**Returns:** -- `questIndex` - - *number* - The quest log's index of the watched quest. - -**Notes and Caveats:** -This function can return nil for valid `watchIndex` values if the watched quest isn't yet in the client cache. This can happen when logging in after clearing the cache. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestItemInfo.md b/wiki-information/functions/GetQuestItemInfo.md deleted file mode 100644 index 0f937e87..00000000 --- a/wiki-information/functions/GetQuestItemInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: GetQuestItemInfo - -**Content:** -Returns info for a required/reward/choice quest item. -`name, texture, count, quality, isUsable, itemID = GetQuestItemInfo(type, index)` - -**Parameters:** -- `type` - - *string* - type of the item to query. One of the following values: - - `"required"`: Items the quest requires the player to gather. - - `"reward"`: Unconditional quest rewards. - - `"choice"`: One of the possible quest rewards. -- `index` - - *number* - index of the item of the specified type to return information about, ascending from 1. - -**Returns:** -- `name` - - *string* - The item's name. -- `texture` - - *number : FileID* - The item's icon texture. -- `count` - - *number* - Amount of the item required or awarded by the quest. -- `quality` - - *Enum.ItemQuality* - The item's quality. -- `isUsable` - - *boolean* - True if the quest item is usable by the current player. -- `itemID` - - *number* - The item's ID. - -**Description:** -This function returns information about the current quest: the one for which the QUEST_* family of events has fired most recently. Quests in the quest log use `GetQuestLogRewardInfo` and `GetQuestLogChoiceInfo`. - -**Reference:** -- `GetNumQuestChoices` -- `GetNumQuestRewards` - -**Example Usage:** -```lua -local name, texture, count, quality, isUsable, itemID = GetQuestItemInfo("reward", 1) -print("Reward Item Name: ", name) -``` - -**Addons Using This Function:** -- **Questie**: Uses `GetQuestItemInfo` to display detailed information about quest rewards and required items in the quest tracker and tooltips. -- **AllTheThings**: Utilizes this function to gather data on quest items for collection tracking and completionist purposes. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestItemLink.md b/wiki-information/functions/GetQuestItemLink.md deleted file mode 100644 index 966b15f0..00000000 --- a/wiki-information/functions/GetQuestItemLink.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetQuestItemLink - -**Content:** -Returns the item link for a required/reward/choice quest item. -`itemLink = GetQuestItemLink(type, index)` - -**Parameters:** -- `(String "type", Integer index)` - - `type` - - *string* - "required", "reward" or "choice" - - `index` - - *number* - Quest reward item index. - -**Returns:** -- `itemLink` - - *string* - The link to the quest item specified. - -**Usage:** -```lua -local link = GetQuestItemLink("choice", 1); -local link = GetQuestItemLink("choice", 1); -``` - -**Miscellaneous:** -Result: -``` -|cff9d9d9d|Hitem:7073:0:0:0:0:0:0:0|h|h|r -``` -Last updated: Patch 1.6.1 \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLink.md b/wiki-information/functions/GetQuestLink.md deleted file mode 100644 index f487cc87..00000000 --- a/wiki-information/functions/GetQuestLink.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: GetQuestLink - -**Content:** -Returns a QuestLink for a quest. -`questLink = GetQuestLink(questID)` - -**Parameters:** -- `questID` - - *number* - Unique identifier for a quest. - -**Returns:** -- `QuestLink` - - *string* - The link to the quest specified - - or `nil`, if the QuestID is invalid. `nil` is also returned if the specified QuestID is not currently in the player's quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogGroupNum.md b/wiki-information/functions/GetQuestLogGroupNum.md deleted file mode 100644 index 4cd52c6e..00000000 --- a/wiki-information/functions/GetQuestLogGroupNum.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetQuestLogGroupNum - -**Content:** -Returns the suggested number of players for a quest. -`suggestedGroup = GetQuestLogGroupNum(questID)` - -**Returns:** -- `suggestedGroup` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogIndexByID.md b/wiki-information/functions/GetQuestLogIndexByID.md deleted file mode 100644 index a5009093..00000000 --- a/wiki-information/functions/GetQuestLogIndexByID.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetQuestLogIndexByID - -**Content:** -Returns the current quest log index of a quest by its ID. -`questLogIndex = GetQuestLogIndexByID(questID)` - -**Parameters:** -- `questID` - - *number* - Unique identifier for each quest. Used as each quest's URL on database sites such as Wowhead. - -**Returns:** -- `questLogIndex` - - *number* - The index of the queried quest in the quest log. Returns "0" if a quest with this questID does not exist in the quest log. - -**Usage:** -This snippet gets the QuestID of the most recently displayed quest in a Gossip frame, then gets the index. Now that we have the index of the quest, we can utilize many of the functions that require a quest index. For example, `GetQuestLink()` requires a quest index. -```lua -local qID = GetQuestID(); -local qLink = GetQuestLink(GetQuestLogIndexByID(qID)); -print("Here's a link to the quest I'm currently viewing at a quest-giver: " .. qLink); -``` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogItemLink.md b/wiki-information/functions/GetQuestLogItemLink.md deleted file mode 100644 index 563fa73f..00000000 --- a/wiki-information/functions/GetQuestLogItemLink.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetQuestLogItemLink - -**Content:** -Returns item link for selected quest reward/choice/required item from quest log. -`itemLink = GetQuestLogItemLink(type, index)` - -**Parameters:** -- `type` - - *string* - "required", "reward" or "choice" -- `index` - - *table* - Integer - Quest reward item index (starts with 1). - -**Returns:** -- `itemLink` - - *string* - The link to the quest item specified - - or `nil`, if the type and/or index is invalid, there is no active quest at the moment or if the server did not transmit the item information until the timeout (which can happen, if the item is not in the local item cache yet) - -**Description:** -The active quest is being set when browsing the quest log. The quest log must not be open for this function to work, but a quest must be active. -The different types refer to the different item lists, a quest can contain. -- "reward" is the list of items which will be granted upon finishing the quest. -- "choice" is the list of items the player can choose from, once the quest is finished. -- "required" should be the list of items which have to be handed in for the quest to be finished (this has not been verified). \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogLeaderBoard.md b/wiki-information/functions/GetQuestLogLeaderBoard.md deleted file mode 100644 index 931dbdbf..00000000 --- a/wiki-information/functions/GetQuestLogLeaderBoard.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: GetQuestLogLeaderBoard - -**Content:** -Returns info for a quest objective in the quest log. -`description, objectiveType, isCompleted = GetQuestLogLeaderBoard(i, questIndex)` - -**Parameters:** -- `i` - - *number* - Index of the quest objective to query, ascending from 1 to GetNumQuestLeaderBoards(questIndex). -- `questIndex` - - *Optional Number* - Index of the quest log entry to query, ascending from 1 to GetNumQuestLogEntries. If not provided or invalid, defaults to the currently selected quest (via SelectQuestLogEntry). - -**Returns:** -- `description` - - *string* - Text description of the objective, e.g. "0/3 Monsters slain" -- `objectiveType` - - *string* - A token describing objective type, one of "item", "object", "monster", "reputation", "log", "event", "player", or "progressbar". -- `isCompleted` - - *boolean* - true if sub-objective is completed, false otherwise - -**Usage:** -The following function attempts to parse the description message to figure out exact progress towards the objective: -```lua -function GetLeaderBoardDetails(boardIndex, questIndex) - local description, objectiveType, isCompleted = GetQuestLogLeaderBoard(boardIndex, questIndex) - local itemName, numItems, numNeeded = description:match("(.*):%s*(%d+)%s*/%s*(%d+)") - return objectiveType, itemName, numItems, numNeeded, isCompleted -end --- returns eg. "monster", "Young Nightsaber slain", 1, 7, nil -``` - -**Description:** -- The type "player" was added in WotLK, which is used by No Mercy! and probably other quests. -- The type "log" was added sometime around patch 3.3.0, and seems to have replaced many instances of "event". -- Only ever found one quest, The Thandol Span that had an "object" objective. -- The description return value can be incomplete under some circumstances, with localized item or NPC names missing from the text. - -**Reference:** -- `GetQuestObjectiveInfo` - A function with identical returns, but takes a QuestID argument instead of QuestLogIndex. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogPushable.md b/wiki-information/functions/GetQuestLogPushable.md deleted file mode 100644 index da50c3a7..00000000 --- a/wiki-information/functions/GetQuestLogPushable.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetQuestLogPushable - -**Content:** -Returns true if the currently loaded quest in the quest window is able to be shared with other players. -`isPushable = GetQuestLogPushable()` - -**Returns:** -- `isPushable` - - *boolean* - 1 if the quest can be shared, nil otherwise. - -**Usage:** -```lua --- Determine whether the selected quest is pushable or not -if ( GetQuestLogPushable() and GetNumPartyMembers() > 0 ) then - QuestFramePushQuestButton:Enable(); -else - QuestFramePushQuestButton:Disable(); -end -``` - -**Miscellaneous:** -Result: -QuestFramePushQuestButton is enabled or disabled based on whether the currently active quest is sharable (and you being in a party!). - -**Description:** -Use `SelectQuestLogEntry(questID)` to set the currently active quest before calling `GetQuestLogPushable()`. To initiate pushing (sharing) of a quest, use `QuestLogPushQuest()`. - -**Example Use Case:** -This function can be used in an addon that manages quest sharing within a party. For instance, an addon could automatically enable or disable the quest sharing button based on whether the selected quest is shareable and if the player is in a party. - -**Addons Using This Function:** -Many quest management addons, such as Questie, use this function to determine if a quest can be shared with party members. This helps in automating the process of sharing quests, ensuring that all party members are on the same page. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogQuestText.md b/wiki-information/functions/GetQuestLogQuestText.md deleted file mode 100644 index aff4ddc7..00000000 --- a/wiki-information/functions/GetQuestLogQuestText.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetQuestLogQuestText - -**Content:** -Returns the description and objective text in the quest log. -`questDescription, questObjectives = GetQuestLogQuestText()` - -**Parameters:** -- `questLogIndex` - - *number?* - (Optional) The index of the quest in the quest log. - -**Returns:** -- `questDescription` - - *string* - The quest description -- `questObjectives` - - *string* - The quest objective \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRequiredMoney.md b/wiki-information/functions/GetQuestLogRequiredMoney.md deleted file mode 100644 index e7b6ca3d..00000000 --- a/wiki-information/functions/GetQuestLogRequiredMoney.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: C_QuestLog.GetRequiredMoney - -**Content:** -Returns the amount of money required for quest completion. -`requiredMoney = C_QuestLog.GetRequiredMoney()` - -**Parameters:** -- `questID` - - *number?* - Uses the selected quest if no questID is provided. - -**Returns:** -- `requiredMoney` - - *number* - -**Example Usage:** -This function can be used to determine if a player has enough money to complete a quest that requires a monetary payment. For instance, if a quest requires a donation or a fee to proceed, you can use this function to check the required amount and compare it with the player's current money. - -**Addon Usage:** -Large addons like Questie or WoW-Pro Guides might use this function to display additional information about quests, such as the required money for completion, directly in the quest log or quest tracker interface. This helps players manage their quests more effectively by providing all necessary information at a glance. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardCurrencyInfo.md b/wiki-information/functions/GetQuestLogRewardCurrencyInfo.md deleted file mode 100644 index df6e7688..00000000 --- a/wiki-information/functions/GetQuestLogRewardCurrencyInfo.md +++ /dev/null @@ -1,53 +0,0 @@ -## Title: GetQuestLogRewardCurrencyInfo - -**Content:** -Provides information about a currency reward for the quest currently being viewed in the quest log, or of the provided questId. -`name, texture, numItems, currencyId, quality = GetQuestLogRewardCurrencyInfo(index)` - -**Parameters:** -- `index` - - *number* - The index of the currency to query, in the range of -- `questId` - - *number* - The id of a quest - -**Returns:** -- `name` - - *string* - The localized name of the currency -- `texture` - - *string* - The path to the icon texture used for the currency -- `numItems` - - *number* - The amount of the currency that will be rewarded -- `currencyId` - - *number* - The id of the currency -- `quality` - - *number* - The quality of the currency - -**Description:** -When no questId is provided, this function only works for the quest currently viewed in the quest log. -When a questId is provided, the function will provide information only if the quest reward data is loaded (QUEST_LOG_UPDATE). -For quests being viewed from NPCs, use `GetQuestCurrencyInfo` instead. Check `QuestInfoFrame.questLog` to determine whether the quest info frame is currently displaying a quest log quest or not. - -**Usage:** -Print a list of currencies rewarded by the currently viewed quest to the chat frame: -```lua -local numRewardCurrencies = GetNumRewardCurrencies() -if numRewardCurrencies > 0 then - print("This quest rewards", numRewardCurrencies, "currencies:") - for i = 1, numRewardCurrencies do - local name, texture, numItems - if QuestInfoFrame.questLog then - name, texture, numItems = GetQuestLogRewardCurrencyInfo(i) - else - name, texture, numItems = GetQuestCurrencyInfo("reward", i) - end - print(format("|T%s:0|t %dx %s", texture, numItems, name)) - end -else - print("This quest does not reward any currencies.") -end -``` - -**Reference:** -- `GetNumQuestCurrencies` -- `GetNumRewardCurrencies` -- `GetQuestCurrencyInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardInfo.md b/wiki-information/functions/GetQuestLogRewardInfo.md deleted file mode 100644 index 83f765b9..00000000 --- a/wiki-information/functions/GetQuestLogRewardInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetQuestLogRewardInfo - -**Content:** -Returns info for an unconditional quest reward item in the quest log. -`itemName, itemTexture, numItems, quality, isUsable, itemID, itemLevel = GetQuestLogRewardInfo(itemIndex)` - -**Parameters:** -- `itemIndex` - - *number* - Index of the item reward to query, up to GetNumQuestLogRewards -- `questID` - - *number?* - Unique identifier for a quest. - -**Returns:** -- `itemName` - - *string* - The name of the quest item -- `itemTexture` - - *string* - The texture of the quest item -- `numItems` - - *number* - How many of the quest item -- `quality` - - *number* - Quality of the quest item -- `isUsable` - - *boolean* - If the quest item is usable by the current player -- `itemID` - - *number* - Unique identifier for the item -- `itemLevel` - - *number* - Scaled item level of the reward, based on the character's item level - -**Description:** -This function is used for quest reward items that are rewarded unconditionally (mandatory) upon completion of a quest. For information about reward items a player can choose from, use `GetQuestLogChoiceInfo` instead. -This function appears to get info for the currently viewed quest completion dialog if called without a questID. Otherwise, it returns information about the supplied questID. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardMoney.md b/wiki-information/functions/GetQuestLogRewardMoney.md deleted file mode 100644 index e3a90f7b..00000000 --- a/wiki-information/functions/GetQuestLogRewardMoney.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetQuestLogRewardMoney - -**Content:** -Returns the amount of money rewarded for a quest. -`money = GetQuestLogRewardMoney()` - -**Parameters:** -- `QuestID` - - *number?* - Unique identifier for a quest. - -**Returns:** -- `rewardMoney` - - *number?* - The amount of copper this quest gives as a reward. - -**Description:** -The `questID` argument is optional. When called without a `questID`, it returns the reward for the most recently viewed quest in the quest log window. -Returns 0 if the `questID` is not currently in the quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogRewardSpell.md b/wiki-information/functions/GetQuestLogRewardSpell.md deleted file mode 100644 index ac2a1d2e..00000000 --- a/wiki-information/functions/GetQuestLogRewardSpell.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: GetQuestLogRewardSpell - -**Content:** -Returns the spell reward for a quest. -`texture, name, isTradeskillSpell, isSpellLearned, hideSpellLearnText, isBoostSpell, garrFollowerID, genericUnlock, spellID = GetQuestLogRewardSpell(rewardIndex, questID)` - -**Parameters:** -- `rewardIndex` - - *number* - The index of the spell reward to get the details for, from 1 to GetNumRewardSpells -- `questID` - - *number* - Unique QuestID for the quest to be queried. - -**Returns:** -- `texture` - - *string* - The texture of the spell icon -- `name` - - *string* - The spell name -- `isTradeskillSpell` - - *boolean* - Whether the spell is a tradeskill spell -- `isSpellLearned` - - *boolean* - Whether the spell has been learned already -- `hideSpellLearnText` - - *unknown* -- `isBoostSpell` - - *boolean* - Unknown -- `garrFollowerID` - - *number* - If the spell grants a Garrison follower, it's ID. -- `genericUnlock` - - *unknown* -- `spellID` - - *number* - Unknown - -**Description:** -Returns information about the spell reward of the current selected quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogSpecialItemCooldown.md b/wiki-information/functions/GetQuestLogSpecialItemCooldown.md deleted file mode 100644 index 17989399..00000000 --- a/wiki-information/functions/GetQuestLogSpecialItemCooldown.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetQuestLogSpecialItemCooldown - -**Content:** -Returns cooldown information about a special quest item based on a given index. -`start, duration, enable = GetQuestLogSpecialItemCooldown(questLogIndex)` - -**Parameters:** -- `questLogIndex` - - *number* - The index of the quest to query. The number of quests can be retrieved with `GetNumQuestLogEntries()`. - -**Returns:** -- `start` - - *number* - The value of `GetTime()` when the quest item's cooldown began (or 0 if the item is off cooldown). -- `duration` - - *number* - The duration of the item's cooldown (is 0 if the item is ready). -- `enable` - - *number* - 1 if the item is enabled, otherwise 0 (needs verification). \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogSpecialItemInfo.md b/wiki-information/functions/GetQuestLogSpecialItemInfo.md deleted file mode 100644 index 23ff5786..00000000 --- a/wiki-information/functions/GetQuestLogSpecialItemInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetQuestLogSpecialItemInfo - -**Content:** -Returns information about a special quest item based on a given index. -`link, item, charges, showItemWhenComplete = GetQuestLogSpecialItemInfo(questLogIndex)` - -**Parameters:** -- `questLogIndex` - - *number* - The index of the quest to query. The number of quests can be retrieved with `GetNumQuestLogEntries()`. - -**Returns:** -- `link` - - *string?* - ItemLink -- `item` - - *number* - The icon ID -- `charges` - - *number* - The number of charges, or 0 if unlimited. If the item is consumed on use this seems to be -1 (e.g., Mana Remnants) -- `showItemWhenComplete` - - *boolean* - Whether the item remains visible when complete \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogTimeLeft.md b/wiki-information/functions/GetQuestLogTimeLeft.md deleted file mode 100644 index 107866ac..00000000 --- a/wiki-information/functions/GetQuestLogTimeLeft.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetQuestLogTimeLeft - -**Content:** -Returns the time left in seconds for the current quest. -`timeLeft = GetQuestLogTimeLeft()` - -**Returns:** -- `questTimer` - - *number* - The seconds remaining to finish the timed quest. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestLogTitle.md b/wiki-information/functions/GetQuestLogTitle.md deleted file mode 100644 index e4befd29..00000000 --- a/wiki-information/functions/GetQuestLogTitle.md +++ /dev/null @@ -1,61 +0,0 @@ -## Title: GetQuestLogTitle - -**Content:** -Returns information about a quest in your quest log. -`title, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isBounty, isStory, isHidden, isScaling = GetQuestLogTitle(questLogIndex)` - -**Parameters:** -- `questLogIndex` - - *number* - The index of the quest you wish to get information about, between 1 and `GetNumQuestLogEntries()`'s first return value. - -**Returns:** -- `title` - - *string* - The title of the quest, or nil if the index is out of range. -- `level` - - *number* - The level of the quest. -- `suggestedGroup` - - *number* - If the quest is designed for more than one player, it is the number of players suggested to complete the quest. Otherwise, it is 0. -- `isHeader` - - *boolean* - true if the entry is a header, false otherwise. -- `isCollapsed` - - *boolean* - true if the entry is a collapsed header, false otherwise. -- `isComplete` - - *number* - 1 if the quest is completed, -1 if the quest is failed, nil otherwise. -- `frequency` - - *number* - 1 if the quest is a normal quest, `LE_QUEST_FREQUENCY_DAILY` (2) for daily quests, `LE_QUEST_FREQUENCY_WEEKLY` (3) for weekly quests. -- `questID` - - *number* - The quest identification number. This is the number found in `GetQuestsCompleted()` after it has been completed. It is also the number used to identify quests on sites such as Wowhead.com (Example: Rest and Relaxation) -- `startEvent` - - *boolean* - ? -- `displayQuestID` - - *boolean* - true if the questID is displayed before the title, false otherwise. -- `isOnMap` - - *boolean* - ? -- `hasLocalPOI` - - *boolean* - ? -- `isTask` - - *boolean* - ? -- `isBounty` - - *boolean* - ? (true for Legion World Quests; is it true for other WQs?) -- `isStory` - - *boolean* - ? -- `isHidden` - - *boolean* - true if the quest is not visible inside the player's quest log. -- `isScaling` - - *boolean* - ? - -**Usage:** -```lua -local i = 1 -while GetQuestLogTitle(i) do - local title, level, suggestedGroup, isHeader, isCollapsed, isComplete, frequency, questID, startEvent, displayQuestID, isOnMap, hasLocalPOI, isTask, isBounty, isStory, isHidden, isScaling = GetQuestLogTitle(i) - if ( not isHeader ) then - DEFAULT_CHAT_FRAME:AddMessage(title .. " " .. questID) - end - i = i + 1 -end -``` - -**Miscellaneous:** -Result: -Prints the name, level, and Quest ID of all quests in your quest log. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestResetTime.md b/wiki-information/functions/GetQuestResetTime.md deleted file mode 100644 index 74ed35c3..00000000 --- a/wiki-information/functions/GetQuestResetTime.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetQuestResetTime - -**Content:** -Returns the number of seconds until daily quests reset. -`nextReset = GetQuestResetTime()` - -**Returns:** -- `nextReset` - - *number* - Number of seconds until the next daily quest reset. - -**Description:** -At the first UI load per login, this function returns the time since the Unix epoch instead. Appears to give the correct value as of the second `QUEST_LOG_UPDATE` event to occur after login. -In 6.x returned incorrect answers for players inside instances hosted on servers that use a different reset time (e.g., Oceanic and Brazilian players in US continental instance servers). Fixed in 7.x. - -A simple test case: -```lua -print("init", GetQuestResetTime()) -local frame = CreateFrame("Frame") -frame:RegisterEvent("PLAYER_LOGIN") -frame:RegisterEvent("QUEST_LOG_UPDATE") -frame:SetScript("OnEvent", function(self, event) - print(event, GetQuestResetTime()) -end) -``` - -**Example Use Case:** -This function can be used in addons that track daily quest progress and need to reset their data or provide notifications to the player when daily quests are about to reset. For example, an addon that helps players manage their daily quest routines could use this function to display a countdown timer until the next reset. - -**Addons Using This Function:** -Many quest tracking addons, such as "Questie" and "Daily Global Check," use this function to ensure they provide accurate information about daily quest availability and reset times. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestReward.md b/wiki-information/functions/GetQuestReward.md deleted file mode 100644 index a01491e1..00000000 --- a/wiki-information/functions/GetQuestReward.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetQuestReward - -**Content:** -Completes the quest and chooses a quest reward, if applicable. -`GetQuestReward(itemChoice)` - -**Parameters:** -- `itemChoice` - - *number* - The quest reward chosen - -**Usage:** -`GetQuestReward(QuestFrameRewardPanel.itemChoice);` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestSortIndex.md b/wiki-information/functions/GetQuestSortIndex.md deleted file mode 100644 index 739ee75c..00000000 --- a/wiki-information/functions/GetQuestSortIndex.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetQuestSortIndex - -**Content:** -Returns the index of the collapsible category the queried quest belongs to. -`sortIndex = GetQuestSortIndex(questLogIndex)` - -**Parameters:** -- `questLogIndex` - - *number* - The index of the quest to query. The number of quests can be retrieved with `GetNumQuestLogEntries()`. - -**Returns:** -- `sortIndex` - - *number* - The index of the category starting from 1. - -**Notes and Caveats:** -Quests are usually split per zone, so if for example there are quests from 5 zones present, `sortIndex` will range between 1-5. -Querying the category header itself will return the same `sortIndex` as the quests it lists. \ No newline at end of file diff --git a/wiki-information/functions/GetQuestTagInfo.md b/wiki-information/functions/GetQuestTagInfo.md deleted file mode 100644 index fdf51b07..00000000 --- a/wiki-information/functions/GetQuestTagInfo.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: GetQuestTagInfo - -**Content:** -Retrieves tag information about the quest. -`tagID, tagName, worldQuestType, rarity, isElite, tradeskillLineIndex, displayTimeLeft = GetQuestTagInfo(questID)` - -**Parameters:** -- `questID` - - *number* - The ID of the quest to retrieve the tag info for. - -**Returns:** -- `tagID` - - *number* - the tagID, nil if quest is not tagged -- `tagName` - - *string* - human readable representation of the tagID, nil if quest is not tagged -- `worldQuestType` - - *number* - type of world quest, or nil if not world quest -- `rarity` - - *number* - the rarity of the quest (used for world quests) -- `isElite` - - *boolean* - is this an elite quest? (used for world quests) -- `tradeskillLineIndex` - - *tradeskillID* if this is a profession quest (used to determine which profession icon to display for world quests) -- `displayTimeLeft` - - *?* - -**Description:** -- `tagID` -- `tagName` - - 1: Group - - 41: PvP - - 62: Raid - - 81: Dungeon - - 83: Legendary - - 85: Heroic - - 98: Scenario - - 102: Account - - 117: Leatherworking World Quest - -- `worldQuestTypes` - - `LE_QUEST_TAG_TYPE_PVP` - - `LE_QUEST_TAG_TYPE_PET_BATTLE` - - `LE_QUEST_TAG_TYPE_PROFESSION` - - `LE_QUEST_TAG_TYPE_DUNGEON` - -- `rarity` - - `LE_WORLD_QUEST_QUALITY_COMMON` - - `LE_WORLD_QUEST_QUALITY_RARE` - - `LE_WORLD_QUEST_QUALITY_EPIC` - -**Reference:** -`GetQuestLogTitle` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestTimers.md b/wiki-information/functions/GetQuestTimers.md deleted file mode 100644 index c3fb4f3f..00000000 --- a/wiki-information/functions/GetQuestTimers.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetQuestTimers - -**Content:** -Returns all of the quest timers currently in progress. -`questTimers = GetQuestTimers()` - -**Parameters:** -- None - -**Returns:** -- `questTimers` - - *Strings* - Values in seconds of all quest timers currently in progress - -**Usage:** -```lua -QuestTimerFrame_Update(GetQuestTimers()); - -function QuestTimerFrame_Update(...) - for i=1, arg.n, 1 do - SecondsToTime(arg); - end -end - -QuestTimerFrame_Update(GetQuestTimers()); - -function QuestTimerFrame_Update(...) - for i=1, arg.n, 1 do - SecondsToTime(arg); - end -end -``` - -**Miscellaneous:** -Result: -``` -"300", "240", "100" -``` \ No newline at end of file diff --git a/wiki-information/functions/GetQuestsCompleted.md b/wiki-information/functions/GetQuestsCompleted.md deleted file mode 100644 index cdfbdd1b..00000000 --- a/wiki-information/functions/GetQuestsCompleted.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: GetQuestsCompleted - -**Content:** -Returns a list of quests the character has completed in its lifetime. -`questsCompleted = GetQuestsCompleted()` - -**Parameters:** -- `table` - - *table* - If supplied, fills this table with quests. Any other keys will be unchanged. - -**Returns:** -- `questsCompleted` - - *table* - The list of completed quests, keyed by quest IDs. - -**Description:** -A quest appears in the list only after it has been completed and turned in, not while it is in your log. -Completing certain quests can cause other quests (alternate versions, etc.) to appear completed also. -Some quests are invisible. These quests are not offered to players but suddenly become "completed" due to some other in-game occurrence. -Daily quests appear completed only if they have been completed that day. -Pet Battle quests are account-wide and will be returned from this API across all characters. They can be discerned with `GetQuestTagInfo()` tagID 102. - -**Usage:** -Prints completed questIds and their names (quest data gets cached from the server after the first query) -```lua -for id in pairs(GetQuestsCompleted()) do - local name = C_QuestLog.GetQuestInfo(id) - print(id, name) -end -``` -For a fresh Human Priest who only completed two starter quests: Beating Them Back! (28763) and Lions for Lambs (28771) -```lua -/dump GetQuestsCompleted() -{ - [28763] = true, -- "Beating Them Back!" -- Mage - [28763] = true, -- "Beating Them Back!" -- Paladin - [28763] = true, -- "Beating Them Back!" -- Priest - [28763] = true, -- "Beating Them Back!" -- Rogue - [28763] = true, -- "Beating Them Back!" -- Warlock - [28763] = true, -- "Beating Them Back!" -- Warrior - [28763] = true, -- "Beating Them Back!" -- Hunter - [28763] = true, -- "Beating Them Back!" -- unknown - [28763] = true, -- "Beating Them Back!" -- Monk - [28771] = true, -- "Lions for Lambs" - [28771] = true, -- "Lions for Lambs" - [28771] = true, -- "Lions for Lambs" - [28771] = true, -- "Lions for Lambs" -- Priest - [28771] = true, -- "Lions for Lambs" - [28771] = true, -- "Lions for Lambs" - [28771] = true, -- "Lions for Lambs" - [28771] = true, -- "Lions for Lambs" - [28771] = true, -- "Lions for Lambs" -} -``` - -**Reference:** -- `IsQuestFlaggedCompleted()` -- `C_QuestLog.GetQuestInfo()` - -**Example Use Case:** -This function can be used to track a player's progress through questlines, especially useful for completionist players or for addons that provide quest tracking and management features. - -**Addons Using This API:** -- **Questie:** A popular addon that provides a comprehensive quest tracking system, showing available and completed quests on the map. It uses `GetQuestsCompleted` to determine which quests the player has already completed to avoid showing redundant information. \ No newline at end of file diff --git a/wiki-information/functions/GetRFDungeonInfo.md b/wiki-information/functions/GetRFDungeonInfo.md deleted file mode 100644 index 5798da49..00000000 --- a/wiki-information/functions/GetRFDungeonInfo.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: GetRFDungeonInfo - -**Content:** -Returns info about a Raid Finder dungeon by index. Limited by player level and other factors, so only Raid Finder dungeons listed in the LFG tool can be looked up. -`ID, name, typeID, subtypeID, minLevel, maxLevel, recLevel, minRecLevel, maxRecLevel, expansionLevel, groupID, textureFilename, difficulty, maxPlayers, description, isHoliday, bonusRepAmount, minPlayers, isTimewalking, name2, minGearLevel, isScaling, lfgMapID = GetRFDungeonInfo(index)` - -**Parameters:** -- `index` - - *number* - index of a Raid Finder dungeon, from 1 to GetNumRFDungeons() - -**Returns:** -- `ID` - - *number* - Dungeon ID -- `name` - - *string* - The name of the dungeon/event -- `typeID` - - *number* - 1=TYPEID_DUNGEON or LFR, 2=raid instance, 4=outdoor area, 6=TYPEID_RANDOM_DUNGEON -- `subtypeID` - - *number* - 0=Unknown, 1=LFG_SUBTYPEID_DUNGEON, 2=LFG_SUBTYPEID_HEROIC, 3=LFG_SUBTYPEID_RAID, 4=LFG_SUBTYPEID_SCENARIO, 5=LFG_SUBTYPEID_FLEXRAID -- `minLevel` - - *number* - Earliest level you can enter this dungeon (using the portal, not LFD) -- `maxLevel` - - *number* - Highest level you can enter this dungeon (using the portal, not LFD) -- `recLevel` - - *number* - Recommended level to queue up for this dungeon -- `minRecLevel` - - *number* - Earliest level you can queue up for the dungeon -- `maxRecLevel` - - *number* - Highest level you can queue up for the dungeon -- `expansionLevel` - - *number* - Referring to GetAccountExpansionLevel() values -- `groupID` - - *number* - Unknown -- `textureFilename` - - *string* - For example "Interface\\LFDFRAME\\LFGIcon-%s.blp" where %s is the textureFilename value -- `difficulty` - - *number* - 0 for Normal and 1 for Heroic -- `maxPlayers` - - *number* - Maximum players allowed -- `description` - - *string* - Usually empty for most dungeons but events contain descriptions of the event, like Love is in the Air daily or Brewfest, e.g. (string) -- `isHoliday` - - *boolean* - If true then this is a holiday event -- `bonusRepAmount` - - *number* - Unknown -- `minPlayers` - - *number* - Minimum number of players (before the group disbands?); usually nil -- `isTimeWalking` - - *boolean* - If true then it's Timewalking Dungeon -- `name2` - - *string* - Returns the name of the raid -- `minGearLevel` - - *number* - The minimum average item level to queue for this dungeon; may be 0 if item level is ignored. -- `isScaling` - - *boolean* -- `lfgMapID` - - *number* - InstanceID - -**Usage:** -- `/dump GetRFDungeonInfo(1)` - - `=> 417, "Fall of Deathwing", 1, 3, 85, 85, 85, 85, 85, 3, 0, "FALLOFDEATHWING", 1, 25, "Deathwing must be destroyed, or all is lost.", false, 0, nil, false, "Dragon Soul", 0, false, 967` -- `/dump GetRFDungeonInfo(2)` - - `=> 416, "The Siege of Wyrmrest Temple", 1, 3, 85, 85, 85, 85, 85, 3, 0, "SIEGEOFWYRMRESTTEMPLE", 1, 25, "Deathwing seeks to destroy Wyrmrest Temple and end the lives of the Dragon Aspects and Thrall.", false, 0, nil, false, "Dragon Soul", 0, false, 967` - -**Reference:** -- `GetNumRFDungeons` - Counts of the number of Raid Finder dungeons the player can query with this function -- `GetSavedInstanceInfo` - A similar function to this, except for the player's saved dungeon/raid lockout data (does not include Raid Finder) -- `GetSavedWorldBossInfo` - A similar function to this, except for the player's saved world boss lockout data -- `GetLFGDungeonInfo` - Almost completely identical; this function uses dungeon IDs instead of Raid Finder indexes -- `GetLFGDungeonEncounterInfo` - A more specific function; this lets you check up on the individual encounters within a given LFG Dungeon \ No newline at end of file diff --git a/wiki-information/functions/GetRaidDifficultyID.md b/wiki-information/functions/GetRaidDifficultyID.md deleted file mode 100644 index b17871d3..00000000 --- a/wiki-information/functions/GetRaidDifficultyID.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetRaidDifficultyID - -**Content:** -Returns the player's currently selected raid difficulty. -`difficultyID = GetRaidDifficultyID()` - -**Returns:** -- `difficultyID` - - *number* - The player's (or group leader's) current raid difficulty ID preference. See `GetDifficultyInfo` for a list of possible difficultyIDs. - -**Description:** -You may use `GetDifficultyInfo` to retrieve information about the returned ID value. - -**Reference:** -- `SetRaidDifficultyID` -- `GetDungeonDifficultyID` \ No newline at end of file diff --git a/wiki-information/functions/GetRaidRosterInfo.md b/wiki-information/functions/GetRaidRosterInfo.md deleted file mode 100644 index 0eaefcda..00000000 --- a/wiki-information/functions/GetRaidRosterInfo.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: GetRaidRosterInfo - -**Content:** -Returns info for a member of your raid. -`name, rank, subgroup, level, class, fileName, zone, online, isDead, role, isML, combatRole = GetRaidRosterInfo(raidIndex)` - -**Parameters:** -- `raidIndex` - - *number* - The index of a raid member between 1 and MAX_RAID_MEMBERS (40). It's discouraged to use GetNumGroupMembers() since there can be "holes" between raid1 to raid40. - -**Returns:** -- `name` - - *string* - raid member's name. Returns "Name-Server" for cross-realm players. -- `rank` - - *number* - Returns 2 if the raid member is the leader of the raid, 1 if the raid member is promoted to assistant, and 0 otherwise. -- `subgroup` - - *number* - The raid party this character is currently a member of. Raid subgroups are numbered as on the standard raid window. -- `level` - - *number* - The level of the character. If this character is offline, the level will show as 0 (not nil). -- `class` - - *string* - The character's class (localized), with the first letter capitalized (e.g. "Priest"). This function works as normal for offline characters. -- `fileName` - - *string* - The system representation of the character's class; always in English, always fully capitalized. -- `zone` - - *string?* - The name of the zone this character is currently in. This is the value returned by GetRealZoneText. It is the same value you see if you mouseover their portrait (if in group). If the character is offline, this value will be the string "Offline". -- `online` - - *boolean* - Returns 1 if raid member is online, nil otherwise. -- `isDead` - - *boolean* - Returns 1 if raid member is dead (hunters Feigning Death are considered alive), nil otherwise. -- `role` - - *string* - The player's role within the raid ("maintank" or "mainassist"). -- `isML` - - *boolean* - Returns 1 if the raid member is master looter, nil otherwise. -- `combatRole` - - *string* - Returns the combat role of the player if one is selected, i.e. "DAMAGER", "TANK" or "HEALER". Returns "NONE" otherwise. - -**Description:** -Do not make any assumptions about raidid (raid1, raid2, etc) to name mappings remaining the same or not. When the raid changes, people MAY retain it or not, depending on raid size and WoW patch. Yes, this behavior has changed with patches in the past and may do it again. -`zone` can return nil for oneself (unitId == "player") if one has not changed locations since last reloading the UI. After changing locations, this returns. Use `PlayerLocation:CreateFromUnit("player")` as a workaround. -When an out of bounds index is used (more than the players in a raid, or beyond MAX_RAID_MEMBERS), some non-nil return values are possible: =0, =1, =1, =false, ="NONE". \ No newline at end of file diff --git a/wiki-information/functions/GetRaidTargetIndex.md b/wiki-information/functions/GetRaidTargetIndex.md deleted file mode 100644 index 0080f79b..00000000 --- a/wiki-information/functions/GetRaidTargetIndex.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: GetRaidTargetIndex - -**Content:** -Returns the raid target of a unit. -`index = GetRaidTargetIndex(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `index` - - *number?* - - **Value** - **Icon** - - 1 - Yellow 4-point Star - - 2 - Orange Circle - - 3 - Purple Diamond - - 4 - Green Triangle - - 5 - White Crescent Moon - - 6 - Blue Square - - 7 - Red "X" Cross - - 8 - White Skull - -**Description:** -Raid target icons are typically displayed by unit frames, as well as above the marked entities in the 3D world. The targets can be assigned by raid leaders and assistants, party members, and the player while soloing, and are only visible to other players within the same group. -This function can return arbitrary values if the queried unit does not exist. Use `UnitExists()` to check whether a unit is valid. -For example: `"raid2target"` when `"raid2"` is offline and not targeting anything at all misbehaves. - -**Related API:** -- `SetRaidTarget` - -**Related Events:** -- `RAID_TARGET_UPDATE` - -**Usage:** -Prints the raid target index for your target. -```lua -/dump GetRaidTargetIndex("target") -``` - -**Reference:** -- `RaidFlag` \ No newline at end of file diff --git a/wiki-information/functions/GetRangedCritChance.md b/wiki-information/functions/GetRangedCritChance.md deleted file mode 100644 index a0ad6e8e..00000000 --- a/wiki-information/functions/GetRangedCritChance.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetRangedCritChance - -**Content:** -Returns the ranged critical hit chance. -`critChance = GetRangedCritChance()` - -**Returns:** -- `critChance` - - *number* - The player's ranged critical hit chance, as a percentage; e.g. 5.3783211 corresponding to a ~5.38% crit chance. - -**Description:** -If you are displaying this figure in a UI element and want it to update, hook to the `UNIT_INVENTORY_CHANGED` and `SPELLS_CHANGED` events as well as any other that affect equipment and buffs. \ No newline at end of file diff --git a/wiki-information/functions/GetRangedHaste.md b/wiki-information/functions/GetRangedHaste.md deleted file mode 100644 index fff5329b..00000000 --- a/wiki-information/functions/GetRangedHaste.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetRangedHaste - -**Content:** -Returns the player's ranged haste amount granted through buffs. -`haste = GetRangedHaste()` - -**Returns:** -- `haste` - - *number* - The player's ranged haste amount granted through buffs, as a percentage; e.g. 36.36363 corresponding to a ~36.36% increased attack speed. - -**Description:** -Reports only the ranged haste granted from buffs, such as and Quick Shots (from ) but excluding a hunter's quiver. - -**Related API:** -- `GetCombatRating(CR_HASTE_RANGED)` -- `GetCombatRatingBonus(CR_HASTE_RANGED)` \ No newline at end of file diff --git a/wiki-information/functions/GetRealZoneText.md b/wiki-information/functions/GetRealZoneText.md deleted file mode 100644 index 4223f3a3..00000000 --- a/wiki-information/functions/GetRealZoneText.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetRealZoneText - -**Content:** -Returns the map instance name. -`zone = GetRealZoneText()` - -**Parameters:** -- `instanceID` - - *number?* : InstanceID - When omitted, returns current instanceID name. - -**Returns:** -- `zone` - - *string* - The name of the map instance. - -**Description:** -Returns the name of the map instance which can be different from `GetZoneText()`. -The returned zone name is localized to the game client's language. - -**Usage:** -Returns the current zone. -```lua -/dump GetRealZoneText() -> "Stormwind City" -``` -Returns the name of a specific instanceID. -```lua -/dump GetRealZoneText(451) -> "Development Land" -``` \ No newline at end of file diff --git a/wiki-information/functions/GetRealmID.md b/wiki-information/functions/GetRealmID.md deleted file mode 100644 index 017052d5..00000000 --- a/wiki-information/functions/GetRealmID.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetRealmID - -**Content:** -Needs summary. -`realmID = GetRealmID()` - -**Returns:** -- `realmID` - - *number* - -**Usage:** -`/dump GetRealmID(), GetRealmName() -- 635, "Defias Brotherhood"` - -**Reference:** -LibRealmInfo \ No newline at end of file diff --git a/wiki-information/functions/GetRealmName.md b/wiki-information/functions/GetRealmName.md deleted file mode 100644 index d9098634..00000000 --- a/wiki-information/functions/GetRealmName.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetRealmName - -**Content:** -Returns the realm name. -```lua -realm = GetRealmName() -normalizedRealm = GetNormalizedRealmName() -``` - -**Returns:** -- `realm` - - *string* - The name of the realm. -- `normalizedRealm` - - *string?* - The name of the realm without spaces or hyphens. - -**Description:** -- **Related API:** - - `GetRealmID` -- The normalized realm name is used for addressing whispers and in-game mail. -- When logging in, `GetNormalizedRealmName()` only returns information starting from as early as the `PLAYER_LOGIN` event. -- When transitioning through a loading screen, `GetNormalizedRealmName()` may return nil between the `LOADING_SCREEN_ENABLED` and `LOADING_SCREEN_DISABLED` events. - -**Usage:** -A small list of realm IDs and names. -```lua --- /dump GetRealmID(), GetRealmName(), GetNormalizedRealmName() -503, "Azjol-Nerub", "AzjolNerub" -513, "Twilight's Hammer", "Twilight'sHammer" -635, "Defias Brotherhood", "DefiasBrotherhood" -1049, "愤怒使者", "愤怒使者" -1093, "Ahn'Qiraj", "Ahn'Qiraj" -1413, "Aggra (Português)", "Aggra(Português)" -1925, "Вечная Песня", "ВечнаяПесня" -``` - -**Reference:** -- `UnitName()` - Returns a character name and the server (if different from the player's current server). \ No newline at end of file diff --git a/wiki-information/functions/GetRepairAllCost.md b/wiki-information/functions/GetRepairAllCost.md deleted file mode 100644 index 80e2f1dd..00000000 --- a/wiki-information/functions/GetRepairAllCost.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetRepairAllCost - -**Content:** -`repairAllCost, canRepair = GetRepairAllCost()` - -**Parameters:** -- **Arguments:** none - -**Returns:** -- `repairAllCost` - - *number* - repair cost -- `canRepair` - - *boolean* - repairs needed? - -**Description:** -Used by MerchantFrame when the MerchantRepairAllButton button is clicked. Does NOT work without the proper type of merchant window open. \ No newline at end of file diff --git a/wiki-information/functions/GetRestState.md b/wiki-information/functions/GetRestState.md deleted file mode 100644 index bcaf2be9..00000000 --- a/wiki-information/functions/GetRestState.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetRestState - -**Content:** -Returns if the character is in a rested or normal state. -`exhaustionID, name, factor = GetRestState()` - -**Returns:** -- `exhaustionID` - - *number* - Rest state index; observed values are 1 if the player is "Rested", 2 if the player is in a normal state. -- `name` - - *string* - Name of the current rest state; observed: "Rested" or "Normal". -- `factor` - - *number* - XP multiplier applied to experience gain from killing monsters in the current rest state. - -**Usage:** -```lua -rested = GetRestState(); -if rested == 1 then - print("You're rested. Now's the time to maximize experience gain!"); -elseif rested == 2 then - print("You're not rested. Find an inn and camp for the night?"); -else - print("You've discovered a hitherto unknown rest state. Would you like some coffee?"); -end -``` - -**Example Use Case:** -This function can be used in addons that track player experience and suggest optimal times for leveling. For instance, an addon could notify players when they are in a rested state to maximize their experience gain from killing monsters. - -**Addons Using This Function:** -- **RestedXP**: This addon uses `GetRestState` to provide players with information on their rested state, helping them plan their leveling sessions more efficiently. \ No newline at end of file diff --git a/wiki-information/functions/GetRestrictedAccountData.md b/wiki-information/functions/GetRestrictedAccountData.md deleted file mode 100644 index 6d78dc06..00000000 --- a/wiki-information/functions/GetRestrictedAccountData.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetRestrictedAccountData - -**Content:** -Returns the cap on trial character level, money, and profession skill. -`rLevel, rMoney, profCap = GetRestrictedAccountData()` - -**Returns:** -- `rLevel` - - *number* - character level cap, currently 20 -- `rMoney` - - *number* - max amount of money in copper, currently 10000000 -- `profCap` - - *number* - profession level cap, currently 0 - -**Description:** -Only returns proper values while on a Starter Edition or inactive account. \ No newline at end of file diff --git a/wiki-information/functions/GetRewardSpell.md b/wiki-information/functions/GetRewardSpell.md deleted file mode 100644 index cdd11f11..00000000 --- a/wiki-information/functions/GetRewardSpell.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetRewardSpell - -**Content:** -Returns the spell reward for the quest in the gossip window. -`texture, name, isTradeskillSpell, isSpellLearned = GetRewardSpell()` - -**Returns:** -- `texture`, `name`, `isTradeskillSpell`, `isSpellLearned` - - *texture* - icon of spell. - - *name* - name of spell. - - *isTradeskillSpell* - if spell received is a tradeskill or not. This will be true, for example, for quests that upgrade your secondary professions, like fishing quest from Nat Pagle. - - *isSpellLearned* - if you actually learn a spell and it will appear in your spellbook (true) or if it will be just cast on you (false). - -**Description:** -Just as almost any other quest gossip function, `GetRewardSpell()` returns data that refreshes only when you see the corresponding gossip page. Any subsequent calls will return the same data until the next update. You can watch updates for data returned by `GetRewardSpell()` by registering for `QUEST_DETAIL` and `QUEST_COMPLETE` events. This means that if, for example, you talk to some NPC and check details of a quest that offers a spell reward and then talk to another NPC and check the progress gossip page of a quest you've accepted previously that offers a spell reward too, this function will still return data of the spell from the first quest because the progress page does not show rewards and their data is not updated. \ No newline at end of file diff --git a/wiki-information/functions/GetRewardXP.md b/wiki-information/functions/GetRewardXP.md deleted file mode 100644 index 5b151dca..00000000 --- a/wiki-information/functions/GetRewardXP.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetRewardXP - -**Content:** -Returns the experience reward for the quest in the gossip window. -`xp = GetRewardXP()` - -**Parameters:** -None - -**Returns:** -- `xp` - - *number* - Amount of experience points to be received upon completing the quest, including any bonuses to experience gain such as Rest and . - -**Description:** -This function is not related to your quest log. -The return values update when the `QUEST_DETAIL`, `QUEST_COMPLETE` events fire. \ No newline at end of file diff --git a/wiki-information/functions/GetRuneCooldown.md b/wiki-information/functions/GetRuneCooldown.md deleted file mode 100644 index 4b82d6e1..00000000 --- a/wiki-information/functions/GetRuneCooldown.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetRuneCooldown - -**Content:** -Returns the Death Knight's cooldown info for the specified rune. -`start, duration, runeReady = GetRuneCooldown(id)` - -**Parameters:** -- `id` - - *number* - The rune index, ranging between 1 and 6. - -**Returns:** -- `start` - - *number* - The value of `GetTime()` when the rune's cooldown began (or 0 if the rune is off cooldown). -- `duration` - - *number* - The duration of the rune's cooldown (regardless of whether or not it's on cooldown). -- `runeReady` - - *boolean* - Whether or not the rune is off cooldown. True if ready, false if not. - -**Usage:** -This will print the number of runes you have ready to cast. -```lua -local amount = 0 -for i = 1, 6 do - local start, duration, runeReady = GetRuneCooldown(i) - if runeReady then - amount = amount + 1 - end -end -print("Available Runes: " .. amount) -``` \ No newline at end of file diff --git a/wiki-information/functions/GetRuneType.md b/wiki-information/functions/GetRuneType.md deleted file mode 100644 index 82b3401d..00000000 --- a/wiki-information/functions/GetRuneType.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetRuneType - -**Content:** -Gets the type of rune for a given rune ID. -`runeType = GetRuneType(id)` - -**Parameters:** -- `id` - - The rune's id. A number between 1 and 6 denoting which rune to be queried. - -**Returns:** -- `runeType` - The type of rune that it is. - - `1` : RUNETYPE_BLOOD - - `2` : RUNETYPE_CHROMATIC - - `3` : RUNETYPE_FROST - - `4` : RUNETYPE_DEATH - -**Note:** -"CHROMATIC" refers to Unholy runes. \ No newline at end of file diff --git a/wiki-information/functions/GetSavedInstanceChatLink.md b/wiki-information/functions/GetSavedInstanceChatLink.md deleted file mode 100644 index 9e3e7675..00000000 --- a/wiki-information/functions/GetSavedInstanceChatLink.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: GetSavedInstanceChatLink - -**Content:** -Retrieves the SavedInstanceChatLink to a specific instance. -`link = GetSavedInstanceChatLink(index)` - -**Parameters:** -- `index` - - The index of the instance you want to query. - -**Returns:** -- `link` - - If instance at index is linkable. -- `nil` - - If instance is not linkable (none at index). - -**Usage:** -```lua -local link = GetSavedInstanceChatLink(1) -if link then - print(link) -else - print("Linking is not available for this instance!") -end -``` - -**Miscellaneous:** -Result: - -Displays a link to the first instance in your Raid Information tab in the chat window, unless there is none available. - -**Description:** -Added in 4.0.1 -See also `GetSpellLink()`, `SavedInstanceChatLink` \ No newline at end of file diff --git a/wiki-information/functions/GetSavedInstanceEncounterInfo.md b/wiki-information/functions/GetSavedInstanceEncounterInfo.md deleted file mode 100644 index fabcb04a..00000000 --- a/wiki-information/functions/GetSavedInstanceEncounterInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetSavedInstanceEncounterInfo - -**Content:** -Returns info about a specific encounter from a saved instance lockout. -`bossName, fileDataID, isKilled, unknown4 = GetSavedInstanceEncounterInfo(instanceIndex, encounterIndex)` - -**Parameters:** -- `instanceIndex` - - *number* - Index from 1 to `GetNumSavedInstances()` -- `encounterIndex` - - *number* - Index from 1 to the number of encounters in the instance. For multi-part raids, this includes bosses that are not in that raid section, so the first boss in the second wing of a Raid Finder raid could actually have an `encounterIndex` of '4'. - -**Returns:** -- `bossName` - - *string* - The localized name of the encounter in question -- `fileDataID` - - *number* - The ID number for a texture associated with the encounter, usually an achievement icon. If Blizzard hasn't designated one for the encounter, expect this return to be nil. -- `isKilled` - - *boolean* - True if you have killed/looted the boss since the last reset period -- `unknown4` - - *boolean* - Unused by Blizzard, has an unknown purpose, and seems to always be false - -**Usage:** -```lua -/dump GetSavedInstanceEncounterInfo(1,1) --- => "Vigilant Kaathar", nil, true, false -``` - -**Reference:** -- `GetNumSavedInstances` - Counts number of instances this function applies to -- `GetLFGDungeonEncounterInfo` - A moderately similar function to this one, except it works off of dungeon IDs instead of saved instance indexes -- `GetSavedInstanceInfo` - A more generic function; it allows you to pull up information on the dungeon itself instead of the individual encounters \ No newline at end of file diff --git a/wiki-information/functions/GetSavedInstanceInfo.md b/wiki-information/functions/GetSavedInstanceInfo.md deleted file mode 100644 index 0304c738..00000000 --- a/wiki-information/functions/GetSavedInstanceInfo.md +++ /dev/null @@ -1,47 +0,0 @@ -## Title: GetSavedInstanceInfo - -**Content:** -Returns instance lock info. -`name, lockoutId, reset, difficultyId, locked, extended, instanceIDMostSig, isRaid, maxPlayers, difficultyName, numEncounters, encounterProgress, extendDisabled, instanceId = GetSavedInstanceInfo(index)` - -**Parameters:** -- `index` - - *number* - index of the saved instance, from 1 to `GetNumSavedInstances()` - -**Returns:** -1. `name` - - *string* - the name of the instance -2. `lockoutId` - - *number* - the ID of the instance lockout -3. `reset` - - *number* - the number of seconds remaining until the instance resets -4. `difficultyId` - - *number* : DifficultyID -5. `locked` - - *boolean* - true if the instance is currently locked, false for a historic entry -6. `extended` - - *boolean* - shows true if the ID has been extended -7. `instanceIDMostSig` - - *number* - unknown -8. `isRaid` - - *boolean* - shows true if it is a raid -9. `maxPlayers` - - *number* - shows the max players -10. `difficultyName` - - *string* - shows a localized string i.e. 10 Player (Heroic) -11. `numEncounters` - - *number* - number of boss encounters in this instance -12. `encounterProgress` - - *number* - farthest boss encounter in this instance for player -13. `extendDisabled` - - *boolean* - returns whether this instance cannot be disabled -14. `instanceId` - - *number* : InstanceID - -**Reference:** -- `GetInstanceLockTimeRemaining` - Older, more limited version of this function -- `GetNumSavedInstances` - Counts number of instances this function applies to -- `GetSavedInstanceEncounterInfo` - A more specific function; this lets you check up on the individual encounters within a given saved instance -- `GetSavedWorldBossInfo` - A similar function to this, except for the player's saved world boss lockout data -- `GetLFGDungeonInfo` - A moderately similar function to this function, except it works off of dungeon IDs instead of saved instance indexes. It can also return Raid Finder instance info, unlike this function. -- `GetRFDungeonInfo` - Nearly identical to `GetLFGDungeonInfo`, except it uses Raid Finder indexes instead of dungeon IDs \ No newline at end of file diff --git a/wiki-information/functions/GetScenariosChoiceOrder.md b/wiki-information/functions/GetScenariosChoiceOrder.md deleted file mode 100644 index 75630e55..00000000 --- a/wiki-information/functions/GetScenariosChoiceOrder.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetScenariosChoiceOrder - -**Content:** -Returns an ordered list of all available scenario IDs. -`allScenarios = GetScenariosChoiceOrder()` - -**Parameters:** -- `allScenarios` - - *table* - If provided, this table will be wiped and populated with return values; otherwise, a new table will be created for the return value. - -**Returns:** -- `allScenarios` - - *table* - an array containing LFG dungeon IDs of specific scenarios. Not all of these may be level-appropriate. - -**Reference:** -- `GetLFGDungeonInfo` -- `GetRandomScenarioInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetSchoolString.md b/wiki-information/functions/GetSchoolString.md deleted file mode 100644 index 082b7198..00000000 --- a/wiki-information/functions/GetSchoolString.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetSchoolString - -**Content:** -Returns the name of the specified damage school mask. -`school = GetSchoolString(schoolMask)` - -**Parameters:** -- `schoolMask` - - *number* - bitfield mask of damage types. - -**Returns:** -- `school` - - *string* - localized school name (e.g. "Frostfire"), or "Unknown" if the school combination isn't named. \ No newline at end of file diff --git a/wiki-information/functions/GetScreenDPIScale.md b/wiki-information/functions/GetScreenDPIScale.md deleted file mode 100644 index e249abd3..00000000 --- a/wiki-information/functions/GetScreenDPIScale.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetScreenDPIScale - -**Content:** -Needs summary. -`scale = GetScreenDPIScale()` - -**Returns:** -- `scale` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetScreenHeight.md b/wiki-information/functions/GetScreenHeight.md deleted file mode 100644 index dd96e539..00000000 --- a/wiki-information/functions/GetScreenHeight.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetScreenHeight - -**Content:** -Returns the height of the window measured at UIParent scale (effectively the same as `UIParent:GetHeight()`). -`screenHeight = GetScreenHeight()` - -**Returns:** -- `screenHeight` - - *number* - Height of window at UIParent scale - -**Usage:** -```lua --- Note that the return value does not match the screen resolution set in the Video Options, but will instead represent a dimension with the same aspect ratio. -DEFAULT_CHAT_FRAME:AddMessage( ( GetScreenWidth() * UIParent:GetEffectiveScale() ).."x"..( GetScreenHeight() * UIParent:GetEffectiveScale() ) ) -``` - -**Example Use Case:** -This function can be used to dynamically adjust UI elements based on the screen height. For instance, if you are developing a custom UI addon and need to position elements relative to the screen height, you can use `GetScreenHeight()` to get the current height and adjust your elements accordingly. - -**Addons Using This Function:** -Many large addons, such as ElvUI and Bartender4, use this function to ensure their UI elements are correctly scaled and positioned according to the user's screen resolution and UI scale settings. This helps maintain a consistent and visually appealing interface across different screen sizes and resolutions. \ No newline at end of file diff --git a/wiki-information/functions/GetScreenResolutions.md b/wiki-information/functions/GetScreenResolutions.md deleted file mode 100644 index e92e0832..00000000 --- a/wiki-information/functions/GetScreenResolutions.md +++ /dev/null @@ -1,41 +0,0 @@ -## Title: GetScreenResolutions - -**Content:** -Returns a list of available preset windowed screen resolutions. -`resolution1, resolution2, resolution3, ... = GetScreenResolutions()` - -**Returns:** -- `resolutionN` - - *string* - An available screen resolution as ___x___ (width .. "x" .. height). - -**Description:** -Returns the list that appears in the resolution dropdown only while windowed mode is applied. -Unaffected by full screen or manually changing the window size. - -**Usage:** -Prints a list of preset windowed resolutions. -```lua -local resolutions = {GetScreenResolutions()} -for i, entry in ipairs(resolutions) do - print("Resolution" .. i .. ": " .. entry) -end ---[[ - Resolution 1: 800x600 - Resolution 2: 1024x760 - Resolution 3: 1280x1024 - ... ---]] -``` - -Gets the most-recently chosen preset as width and height. -```lua -local current = GetCurrentResolution() -if current then - local width, height = string.match(select(current, GetScreenResolutions()), "(%d+)x(%d+)") - print(width, height) -- 1920, 1080 -end -``` - -**Reference:** -- `GetCurrentResolution()` -- `gxWindowedResolution` \ No newline at end of file diff --git a/wiki-information/functions/GetScreenWidth.md b/wiki-information/functions/GetScreenWidth.md deleted file mode 100644 index 1b8c6688..00000000 --- a/wiki-information/functions/GetScreenWidth.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetScreenWidth - -**Content:** -Returns the width of the window measured at UIParent scale (effectively the same as `UIParent:GetWidth()`). -`screenWidth = GetScreenWidth()` - -**Returns:** -- `screenWidth` - - *number* - Width of window at UIParent scale - -**Usage:** -```lua --- Note that the return value does not match the screen resolution set in the Video Options, but will instead represent a dimension with the same aspect ratio. -DEFAULT_CHAT_FRAME:AddMessage( ( GetScreenWidth() * UIParent:GetEffectiveScale() ).."x"..( GetScreenHeight() * UIParent:GetEffectiveScale() ) ) -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSecondsUntilParentalControlsKick.md b/wiki-information/functions/GetSecondsUntilParentalControlsKick.md deleted file mode 100644 index 95cbd35b..00000000 --- a/wiki-information/functions/GetSecondsUntilParentalControlsKick.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetSecondsUntilParentalControlsKick - -**Content:** -Needs summary. -`remaining = GetSecondsUntilParentalControlsKick()` - -**Returns:** -- `remaining` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetSelectedBattlefield.md b/wiki-information/functions/GetSelectedBattlefield.md deleted file mode 100644 index b90d29f2..00000000 --- a/wiki-information/functions/GetSelectedBattlefield.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetSelectedBattlefield - -**Content:** -Returns the currently selected battlefield at the battlemaster. -`selectedIndex = GetSelectedBattlefield()` - -**Returns:** -- `selectedIndex` - - *number* - The selected battlefield instance index. The zeroth index is "First Available". \ No newline at end of file diff --git a/wiki-information/functions/GetSelectedSkill.md b/wiki-information/functions/GetSelectedSkill.md deleted file mode 100644 index 54a8f47d..00000000 --- a/wiki-information/functions/GetSelectedSkill.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetSelectedSkill - -**Content:** -Returns the currently selected skill line. -`skillIndex = GetSelectedSkill()` - -**Returns:** -- `skillIndex` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetSelectedStablePet.md b/wiki-information/functions/GetSelectedStablePet.md deleted file mode 100644 index d9ba480e..00000000 --- a/wiki-information/functions/GetSelectedStablePet.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetSelectedStablePet - -**Content:** -Gets the index of the currently selected pet in the stable. -`selectedPet = GetSelectedStablePet()` - -**Returns:** -- `selectedPet` - - *number* - The index of the currently selected pet slot, 0 being the current pet, 1 and 2 being the left and right slots, and -1 for when no pet is selected. \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailCOD.md b/wiki-information/functions/GetSendMailCOD.md deleted file mode 100644 index e725dbf9..00000000 --- a/wiki-information/functions/GetSendMailCOD.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetSendMailCOD - -**Content:** -Returns the Cash-On-Delivery cost of the outgoing message. -`amount = GetSendMailCOD()` - -**Returns:** -- `amount` - - *number* - COD cost in copper. - -**Reference:** -- `SEND_MAIL_COD_CHANGED` \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailItem.md b/wiki-information/functions/GetSendMailItem.md deleted file mode 100644 index 4f1f7561..00000000 --- a/wiki-information/functions/GetSendMailItem.md +++ /dev/null @@ -1,43 +0,0 @@ -## Title: GetSendMailItem - -**Content:** -Returns info for an item attached in the outgoing message. -`name, itemID, texture, count, quality = GetSendMailItem(index)` - -**Parameters:** -- `index` - - *number* - The index of the attachment to query, in the range of - -**Returns:** -- `name` - - *string* - The localized name of the item -- `itemID` - - *number* - Numeric ID of the item. -- `texture` - - *string* - The icon texture for the item -- `count` - - *number* - The number of items in the stack -- `quality` - - *number* - The quality index of the item (0-6) - -**Usage:** -The following code will loop over all the items currently attached to the send mail frame, and print information about them to the chat frame: -```lua -for i = 1, ATTACHMENTS_MAX_SEND do - local name, itemID, texture, count, quality = GetSendMailItem(i) - if name then - -- Construct an inline texture sequence: - print("You are sending", "|T"..texture..":0|t", name, "x", count) - end -end -``` - -**Description:** -Requires that the mailbox window is open. -ATTACHMENTS_MAX_SEND is defined in Constants.lua, and currently (Jan 2014) has a value of 12. Using this variable instead of a hardcoded 12 is recommended in case Blizzard changes the maximum number of items that may be attached to a single message. -As of 2.3.3 this function is bugged and the quality is always returned as -1. If you need to know the item's quality, get a link for the item using `GetSendMailItemLink`, and pass the link to `GetItemInfo`. - -**Reference:** -- `GetSendMailItemLink` -- `GetInboxItem` -- `GetInboxItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailItemLink.md b/wiki-information/functions/GetSendMailItemLink.md deleted file mode 100644 index 25747f79..00000000 --- a/wiki-information/functions/GetSendMailItemLink.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: GetSendMailItemLink - -**Content:** -Returns the item link of an item attached in the outgoing message. -`itemLink = GetSendMailItemLink(attachment)` - -**Parameters:** -- `attachment` - - *number* - The index of the attachment to query, in the range of - -**Returns:** -- `itemLink` - - *itemLink* - The item link for the specified item - -**Description:** -`ATTACHMENTS_MAX_SEND` is defined in `Constants.lua`, and currently (Jan 2014) has a value of 12. Using this variable instead of a hardcoded 12 is recommended in case Blizzard changes the maximum number of items that may be attached to a sent message. - -There is no API function to get the total number of items attached to a sent message. If your addon needs to know how many attachment slots are filled, you must loop over all the slots and count them yourself: -```lua -local total = 0 -for i = 1, ATTACHMENTS_MAX_SEND do - if GetSendMailItemLink(i) then - total = total + 1 - end -end -print("Attachment slots used:", total, "of", ATTACHMENTS_MAX_SEND) -``` - -**Reference:** -- `GetSendMailItem` -- `GetInboxItem` -- `GetInboxItemLink` \ No newline at end of file diff --git a/wiki-information/functions/GetSendMailPrice.md b/wiki-information/functions/GetSendMailPrice.md deleted file mode 100644 index 85964d6c..00000000 --- a/wiki-information/functions/GetSendMailPrice.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetSendMailPrice - -**Content:** -Gets the cost for sending mail. -`sendPrice = GetSendMailPrice()` - -**Returns:** -- `sendPrice` - - *number* - The price in copper. \ No newline at end of file diff --git a/wiki-information/functions/GetServerExpansionLevel.md b/wiki-information/functions/GetServerExpansionLevel.md deleted file mode 100644 index d69053d4..00000000 --- a/wiki-information/functions/GetServerExpansionLevel.md +++ /dev/null @@ -1,55 +0,0 @@ -## Title: GetServerExpansionLevel - -**Content:** -Returns the expansion level currently active on the server. -`serverExpansionLevel = GetServerExpansionLevel()` - -**Returns:** -- `serverExpansionLevel` - - *number* - - `NUM_LE_EXPANSION_LEVELS` - - **Value** - - **Enum** - - **Description** - - `LE_EXPANSION_LEVEL_CURRENT` - - 0 - - `LE_EXPANSION_CLASSIC` - - Vanilla / Classic Era - - 1 - - `LE_EXPANSION_BURNING_CRUSADE` - - The Burning Crusade - - 2 - - `LE_EXPANSION_WRATH_OF_THE_LICH_KING` - - Wrath of the Lich King - - 3 - - `LE_EXPANSION_CATACLYSM` - - Cataclysm - - 4 - - `LE_EXPANSION_MISTS_OF_PANDARIA` - - Mists of Pandaria - - 5 - - `LE_EXPANSION_WARLORDS_OF_DRAENOR` - - Warlords of Draenor - - 6 - - `LE_EXPANSION_LEGION` - - Legion - - 7 - - `LE_EXPANSION_BATTLE_FOR_AZEROTH` - - Battle for Azeroth - - 8 - - `LE_EXPANSION_SHADOWLANDS` - - Shadowlands - - 9 - - `LE_EXPANSION_DRAGONFLIGHT` - - Dragonflight - - 10 - - `LE_EXPANSION_11_0` - -**Description:** -This does not update on pre-patch and only when the expansion actually launches; requires a client restart to update, if still in-game. - -**Usage:** -Before and after the Shadowlands global launch on November 23, 2020, at 3:00 p.m. PST. -```lua -/dump GetServerExpansionLevel() -- 7 -> 8 -``` \ No newline at end of file diff --git a/wiki-information/functions/GetServerTime.md b/wiki-information/functions/GetServerTime.md deleted file mode 100644 index 644febe8..00000000 --- a/wiki-information/functions/GetServerTime.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetServerTime - -**Content:** -Returns the server's Unix time. -`timestamp = GetServerTime()` - -**Returns:** -- `timestamp` - - *number* - Time in seconds since the epoch. - -**Description:** -The server's Unix timestamp is more preferable over `time()` since it's guaranteed to be synchronized between clients. The local machine's clock could possibly have been manually changed and might also be off by a few seconds if not recently synced. -Adjustments to the local system clock while the client is open may result in this function returning incorrect timestamps. -Unix time is unrelated to your time zone, making it useful for tracking and sorting timestamps. - -**Miscellaneous:** -When in a EU time zone CEST (UTC+2) and playing on Moon Guard US, CDT (UTC-5). The examples were taken at the same time. Note that `time()` and `date()` are tied to your system's clock which can be manually changed. -```lua --- unix time -time() -- 1596157547 -GetServerTime() -- 1596157549 --- local time, same as `date(nil, time())` -date() -- "Fri Jul 31 03:05:47 2020" --- realm time -GetGameTime() -- 20, 4 -C_DateAndTime.GetCurrentCalendarTime() -- hour:20, minute:4 -C_DateAndTime.GetServerTimeLocal() -- 1596139440 unix time offset by the server's time zone (e.g. UTC minus 5 hours) -``` - -**Reference:** -- `GetTime()` - local machine uptime. \ No newline at end of file diff --git a/wiki-information/functions/GetSessionTime.md b/wiki-information/functions/GetSessionTime.md deleted file mode 100644 index 285d4430..00000000 --- a/wiki-information/functions/GetSessionTime.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetSessionTime - -**Content:** -Returns the time since you opened the game client. -`sessionTime = GetSessionTime()` - -**Returns:** -- `sessionTime` - - *number* - Time in seconds since you started the game client. - -**Description:** -Used on the Korean locale to warn against excessive gameplay time. - -**Reference:** -- `GetTime()` - local machine uptime. -- References: - - [GitHub Commit](https://github.com/Gethe/wow-ui-source/commit/3770c879e4a0db9f4f37e835a77d69eb0ec66efb#diff-54f1522769d9602c5cdd7b482d137f70R446) \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftForm.md b/wiki-information/functions/GetShapeshiftForm.md deleted file mode 100644 index ee920248..00000000 --- a/wiki-information/functions/GetShapeshiftForm.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: GetShapeshiftForm - -**Content:** -Returns the zero-based index of current form/stance. -`index = GetShapeshiftForm()` - -**Parameters:** -- `flag` - - *boolean?* - True if return value is to be compared to a macro's conditional statement. This makes it always return zero for Presences and Auras. False or nil returns an index based on which button to highlight on the shapeshift/stance bar left to right starting at 1. - -**Returns:** -- `index` - - *number* - one of the following: - - **All** - - `0` - humanoid form - - **Druid** - - `Bear Form` - - `Cat Form` - - `Travel Form / Aquatic Form / Flight Form` (all 3 location-dependent versions of Travel Form count as Form 3) - - The first known of: `Moonkin Form`, `Treant Form`, `Stag Form` (in order) - - The second known of: `Moonkin Form`, `Treant Form`, `Stag Form` (in order) - - The third known of: `Moonkin Form`, `Treant Form`, `Stag Form` (in order) - - *Note:* The last 3 are ordered. For example, if you know Stag Form only, it is form 4. If you know both Treant and Stag, Treant is 4 and Stag is 5. If you know all 3, Moonkin is 4, Treant 5, and Stag 6. - - **Priest** - - `Shadowform` - - **Rogue** - - `Stealth` - - `Vanish / Shadow Dance` (for Subtlety rogues, both Vanish and Shadow Dance return as Form 1) - - **Shaman** - - `Ghost Wolf` - - **Warrior** - - `Battle Stance` - - `Defensive Stance` - - `Berserker Stance` - -**Description:** -For some classes, the return value is nil during the loading process. You need to wait until `UPDATE_SHAPESHIFT_FORMS` fires to get correct return values. \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftFormCooldown.md b/wiki-information/functions/GetShapeshiftFormCooldown.md deleted file mode 100644 index 8fa2a25b..00000000 --- a/wiki-information/functions/GetShapeshiftFormCooldown.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetShapeshiftFormCooldown - -**Content:** -Returns cooldown information for a specified form. -`startTime, duration, isActive = GetShapeshiftFormCooldown(index)` - -**Parameters:** -- `index` - - *number* - Index of the desired form - -**Returns:** -- `startTime` - - *number* - Cooldown start time (per GetTime) in seconds. -- `duration` - - *number* - Cooldown duration in seconds. -- `isActive` - - *boolean* - Returns 1 if the cooldown is running, nil if it isn't - -**Usage:** -Displays the seconds remaining on the shapeshift form at index 1 or "Not Active" if there's no cooldown on that form. -```lua -local startTime, duration, isActive = GetShapeshiftFormCooldown(1) -if isActive then - print("Not Active") -else - print(string.format("Form 1 has %f seconds remaining", startTime + duration - GetTime())) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftFormID.md b/wiki-information/functions/GetShapeshiftFormID.md deleted file mode 100644 index 4a6e1eb4..00000000 --- a/wiki-information/functions/GetShapeshiftFormID.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: GetShapeshiftFormID - -**Content:** -Returns the ID of the form or stance the player is currently in. -`index = GetShapeshiftFormID()` - -**Returns:** -- `index` - - *number* - one of the following: - - **All** - - `nil` = humanoid form - - **Druid** - - Aquatic Form - 4 - - Bear Form - 5 (BEAR_FORM constant) - - Cat Form - 1 (CAT_FORM constant) - - Flight Form - 29 - - Moonkin Form - 31 - 35 (MOONKIN_FORM constant) (different races seem to have different numbers) - - Swift Flight Form - 27 - - Travel Form - 3 - - Tree of Life - 2 - - Treant Form - 36 - - **Monk** - - Stance of the Fierce Tiger - 24 - - Stance of the Sturdy Ox - 23 - - Stance of the Wise Serpent - 20 - - **Rogue** - - Stealth - 30 - - **Shaman** - - Ghost Wolf - 16 - - **Warlock** - - Metamorphosis - 22 - - **Warrior** - - Battle Stance - 17 - - Berserker Stance - 19 - - Defensive Stance - 18 - -**Description:** -Similar to the function `GetShapeshiftForm(flag)`, except the values returned are constant and not dependent on forms available to the unit or current class. \ No newline at end of file diff --git a/wiki-information/functions/GetShapeshiftFormInfo.md b/wiki-information/functions/GetShapeshiftFormInfo.md deleted file mode 100644 index 5395319a..00000000 --- a/wiki-information/functions/GetShapeshiftFormInfo.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GetShapeshiftFormInfo - -**Content:** -Returns info for an available form or stance. -`icon, active, castable, spellID = GetShapeshiftFormInfo(index)` - -**Parameters:** -- `index` - - *number* - index, ascending from 1 to `GetNumShapeshiftForms()` - -**Returns:** -- `icon` - - *string* - Path to icon texture -- `active` - - *boolean* - 1 if this shapeshift is currently active, nil otherwise -- `castable` - - *boolean* - 1 if this shapeshift form may be entered, nil otherwise -- `spellID` - - *number* - ID of the spell that activates this ability - -**Description:** -As well as druid shapeshifting, warrior stances, paladin auras, hunter aspects, death knight presences, and shadowform use this API. \ No newline at end of file diff --git a/wiki-information/functions/GetSheathState.md b/wiki-information/functions/GetSheathState.md deleted file mode 100644 index 692470bd..00000000 --- a/wiki-information/functions/GetSheathState.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetSheathState - -**Content:** -Returns which type of weapon the player currently has unsheathed. -`sheathState = GetSheathState()` - -**Returns:** -- `sheathState` - - *number* - Currently unsheathed weapon type: - - `Value` - - `Weapon` - - `1` - - None - - `2` - - Melee - - `3` - - Ranged - -**Reference:** -ToggleSheath \ No newline at end of file diff --git a/wiki-information/functions/GetShieldBlock.md b/wiki-information/functions/GetShieldBlock.md deleted file mode 100644 index 132c2e1e..00000000 --- a/wiki-information/functions/GetShieldBlock.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetShieldBlock - -**Content:** -Returns the percentage of damage blocked by your shield. -`shieldBlock = GetShieldBlock()` - -**Returns:** -- `shieldBlock` - - *number* - the percentage of damage reduced by your shield - -**Usage:** -```lua -/dump GetShieldBlock() -- 31 -``` -This means that your shield blocks 31% of damage. This matches the in-game tooltip: "Your block stops 31% of incoming damage." - -**Description:** -All blocked attacks are reduced by 30%. It can be increased to 31% by a +1% Shield Block Value meta-gem. - -**Reference:** -- `GetBlockChance` \ No newline at end of file diff --git a/wiki-information/functions/GetSkillLineInfo.md b/wiki-information/functions/GetSkillLineInfo.md deleted file mode 100644 index b06bc10d..00000000 --- a/wiki-information/functions/GetSkillLineInfo.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: GetSkillLineInfo - -**Content:** -Returns information on a skill line/header. -```lua -skillName, header, isExpanded, skillRank, numTempPoints, skillModifier, skillMaxRank, isAbandonable, stepCost, rankCost, minLevel, skillCostType, skillDescription = GetSkillLineInfo(index) -``` - -**Parameters:** -- `index` - - *number* - The index of a line in the skills window, can be a header or skill line. Indices can change depending on collapsed/expanded headers. - -**Returns:** -1. `skillName` - - *string* - Name of the skill line. -2. `header` - - *number* - Returns 1 if the line is a header, nil otherwise. -3. `isExpanded` - - *number* - Returns 1 if the line is a header and expanded, nil otherwise. -4. `skillRank` - - *number* - The current rank for the skill, 0 if not applicable. -5. `numTempPoints` - - *number* - Temporary points for the current skill. -6. `skillModifier` - - *number* - Skill modifier value for the current skill. -7. `skillMaxRank` - - *number* - The maximum rank for the current skill. If this is 1 the skill is a proficiency. -8. `isAbandonable` - - *number* - Returns 1 if this skill can be unlearned, nil otherwise. -9. `stepCost` - - *number* - Returns 1 if skill can be learned, nil otherwise. -10. `rankCost` - - *number* - Returns 1 if skill can be trained, nil otherwise. -11. `minLevel` - - *number* - Minimum level required to learn this skill. -12. `skillCostType` - - *number* -13. `skillDescription` - - *string* - Localized skill description text - -**Usage:** -Prints the player's skill lines. -```lua -/run for i = 1, GetNumSkillLines() do print(i, GetSkillLineInfo(i)) end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketItemBoundTradeable.md b/wiki-information/functions/GetSocketItemBoundTradeable.md deleted file mode 100644 index 23223a0f..00000000 --- a/wiki-information/functions/GetSocketItemBoundTradeable.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetSocketItemBoundTradeable - -**Content:** -Returns true if the item currently being socketed can be traded to other eligible players (BoP boss loot). -`isBoundTradeable = GetSocketItemBoundTradeable()` - -**Returns:** -- `isBoundTradeable` - - *boolean* - 1 if the item selected for socketing is BoP but can currently be traded to other eligible players, nil otherwise. - -**Description:** -Bind-on-pickup items looted in dungeon and raid instances can be traded with other players present during the encounter the items dropped from within a limited timeframe. -If you socket gems into a BoP item within its tradable period, the item will cease being tradable. - -**Reference:** -- `GetSocketItemRefundable` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketItemInfo.md b/wiki-information/functions/GetSocketItemInfo.md deleted file mode 100644 index 63143988..00000000 --- a/wiki-information/functions/GetSocketItemInfo.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetSocketItemInfo - -**Content:** -Returns info for the item currently being socketed. -`itemName, iconPathName, itemQuality = GetSocketItemInfo()` - -**Returns:** -- `itemName` - - *string* - Localized name of the item currently being socketed, or nil if the socketing UI is not open. -- `iconPathName` - - *string* - Virtual path name (i.e. `Interface\\Icons\\inv_belt_52`) for the icon displayed in the character window (PaperDollFrame) for this item, or nil if the socketing UI is not open. -- `itemQuality` - - *number* - 0) Socketing UI not currently open, 1) Common, 2) Uncommon, 3) Rare, 4) Epic, etc. (the colors correlate to the color of the font used by the game when it draws the item's name). - -**Usage:** -```lua --- from Blizzard_ItemSocketingUI.lua -local name, icon, quality = GetSocketItemInfo(); -local sname, sicon, squality = tostring(name), tostring(icon), tostring(quality) -print("name:" .. sname .. " icon:" .. sicon .. " quality:" .. squality) -``` - -**Miscellaneous:** -Result: - -Simple print statement displaying the values returned. In this example, I used Merlin's Robe (item id:47604): -``` -name:Merlin's Robe icon:Interface\\Icons\\INV_Chest_Cloth_64 quality:4 -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketItemRefundable.md b/wiki-information/functions/GetSocketItemRefundable.md deleted file mode 100644 index 0282ed17..00000000 --- a/wiki-information/functions/GetSocketItemRefundable.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetSocketItemRefundable - -**Content:** -Returns whether the item currently being socketed is refundable. -`isRefundable = GetSocketItemRefundable()` - -**Returns:** -- `isRefundable` - - *boolean* - 1 if the item selected for socketing can be returned to a merchant for a refund. - -**Description:** -Items purchased with non-gold currencies can sometimes be sold back to a merchant for a full refund within a limited time frame. -The item remains refundable if you socket gems into it; however, any socketed gems will not be refunded upon selling the item back to a vendor. - -**Reference:** -- `GetSocketItemBoundTradeable` \ No newline at end of file diff --git a/wiki-information/functions/GetSocketTypes.md b/wiki-information/functions/GetSocketTypes.md deleted file mode 100644 index 85dde39a..00000000 --- a/wiki-information/functions/GetSocketTypes.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetSocketTypes - -**Content:** -Returns the type (color) of a socket in the item. - -**Parameters:** -- `Index` - - *Number* - The 1-based index of the socket for which to get information. - -**Returns:** -- `SocketType` - - *String* - The type of the socket at position Index. The value could be any of these (apparently unlocalized) strings: - - `"Red"` - Red socket - - `"Yellow"` - Yellow socket - - `"Blue"` - Blue socket - - `"Meta"` - Meta socket - - `"Socket"` - Prismatic socket - -**Usage:** -```lua -local SocketCount = GetNumSockets() -for i = 1, SocketCount do - print(GetSocketInfo(i)) -end -``` - -**Description:** -This function is only useful if the item socketing window is currently visible. \ No newline at end of file diff --git a/wiki-information/functions/GetSoundEntryCount.md b/wiki-information/functions/GetSoundEntryCount.md deleted file mode 100644 index f7428718..00000000 --- a/wiki-information/functions/GetSoundEntryCount.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetSoundEntryCount - -**Content:** -Returns the number of sound entries a sound kit contains. -`entryCount = GetSoundEntryCount(soundKit)` - -**Parameters:** -- `soundKit` - - *number* - A sound kit ID. - -**Returns:** -- `entryCount` - - *number?* - The number of sound entries this sound kit contains. - -**Description:** -A sound entry typically refers to a distinct sound file that will be sampled when the sound kit is played. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellAutocast.md b/wiki-information/functions/GetSpellAutocast.md deleted file mode 100644 index a10e4207..00000000 --- a/wiki-information/functions/GetSpellAutocast.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: GetSpellAutocast - -**Content:** -Returns true if a (pet) spell is autocastable. -`autocastable, autostate = GetSpellAutocast("spellName" or spellId, bookType)` - -**Parameters:** -- `spellName` - - *string* - the name of the spell. -- `spellId` - - *number* - the offset (position) of the spell in the spellbook. SpellId can change when you learn new spells. -- `bookType` - - *string* - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet"). - -**Returns:** -- `autocastable` - - *number* - whether a spell is autocastable. - - Returns 1 if the spell is autocastable, nil otherwise. -- `autostate` - - *number* - whether a spell is currently set to autocast. - - Returns 1 if the spell is currently set for autocast, nil otherwise. - -**Description:** -As of patch 3.0.3, the only auto-castable spells exist in the pet spellbook (BOOKTYPE_PET). -Both return values will be nil in the following conditions: -- The spell is not autocastable -- The spell does not exist (or you don't know it) - -**Example Usage:** -This function can be used in macros or addons to check if a pet spell is set to autocast and to manage pet abilities more effectively. For instance, a hunter might use this to ensure their pet's Growl ability is set to autocast when tanking. - -**Addons:** -Large addons like PetTracker might use this function to display or manage pet abilities, ensuring that the pet's autocast settings are correctly configured for optimal performance in various situations. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBaseCooldown.md b/wiki-information/functions/GetSpellBaseCooldown.md deleted file mode 100644 index b1db1264..00000000 --- a/wiki-information/functions/GetSpellBaseCooldown.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetSpellBaseCooldown - -**Content:** -Gives the (unmodified) cooldown and global cooldown of an ability in milliseconds. -`cooldownMS, gcdMS = GetSpellBaseCooldown(spellid)` - -**Parameters:** -- `spellid` - - *number* - The spellid of your ability. - -**Returns:** -- `cooldownMS` - - *number* - Millisecond duration of the spell's cooldown (if any other than the global cooldown) -- `gcdMS` - - *number* - Millisecond duration of the spell's global cooldown (if any) - -**Notes and Caveats:** -Polling the second return value will discover if a particular spell is subject to GCD. - -**Reference:** -`GetSpellCooldown` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBonusDamage.md b/wiki-information/functions/GetSpellBonusDamage.md deleted file mode 100644 index cd2045d7..00000000 --- a/wiki-information/functions/GetSpellBonusDamage.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetSpellBonusDamage - -**Content:** -Returns the raw spell damage bonus for the specified spell tree. -`bonusDamage = GetSpellBonusDamage(school)` - -**Parameters:** -- `school` - - *number* - the spell tree: - - 1: Physical - - 2: Holy - - 3: Fire - - 4: Nature - - 5: Frost - - 6: Shadow - - 7: Arcane - -**Returns:** -- `bonusDamage` - - *number* - The raw spell damage bonus of the player for that spell tree \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBonusHealing.md b/wiki-information/functions/GetSpellBonusHealing.md deleted file mode 100644 index 51daf812..00000000 --- a/wiki-information/functions/GetSpellBonusHealing.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetSpellBonusHealing - -**Content:** -Returns the raw spell healing bonus. -`bonusHealing = GetSpellBonusHealing()` - -**Returns:** -- `bonusHealing` - - *number* - The healing spell power of the player \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBookItemInfo.md b/wiki-information/functions/GetSpellBookItemInfo.md deleted file mode 100644 index 8c406d03..00000000 --- a/wiki-information/functions/GetSpellBookItemInfo.md +++ /dev/null @@ -1,65 +0,0 @@ -## Title: GetSpellBookItemInfo - -**Content:** -Returns info for a spellbook item. -`spellType, id = GetSpellBookItemInfo(spellName)` -`spellType, id = GetSpellBookItemInfo(index, bookType)` - -**Parameters:** -- `spellName` - - *string* - Requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Returns:** -- `spellType` - - *string* - The type of the spell: -- `id` - - *number* - - For `SPELL` and `FUTURESPELL`, the SpellID used in `GetSpellInfo()` - - For `PETACTION`, the ActionID used in `C_ActionBar.HasPetActionButtons()`; furthermore, the SpellID can be obtained by applying the bitmask `0xFFFFFF`. - - For `FLYOUT`, the FlyoutID used in `GetFlyoutInfo()` - -**Description:** -Related API: `GetSpellBookItemName` - -**Usage:** -Prints all spells in the spellbook for the player, except the profession tab ones. -```lua -local spellFunc = { - SPELL = GetSpellInfo, - FUTURESPELL = GetSpellInfo, - FLYOUT = GetFlyoutInfo, -} -for i = 1, GetNumSpellTabs() do - local _, _, offset, numSlots = GetSpellTabInfo(i) - for j = offset+1, offset+numSlots do - local spellType, id = GetSpellBookItemInfo(j, BOOKTYPE_SPELL) - local spellName = spellFunc[id] - print(i, j, spellType, id, spellName) - end -end -``` - -Prints all pet spells. -```lua -for i = 1, HasPetSpells() do - local spellType, id = GetSpellBookItemInfo(i, BOOKTYPE_PET) - local spellID = bit.band(0xFFFFFF, id) - -- not sure what the non-spell IDs are - local spellName = spellID > 100 and GetSpellInfo(spellID) or GetSpellBookItemName(i, BOOKTYPE_PET) - local hasActionButton = C_ActionBar.HasPetActionButtons(id) - print(i, spellType, id, spellID, spellName, hasActionButton) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBookItemName.md b/wiki-information/functions/GetSpellBookItemName.md deleted file mode 100644 index f002e050..00000000 --- a/wiki-information/functions/GetSpellBookItemName.md +++ /dev/null @@ -1,85 +0,0 @@ -## Title: GetSpellBookItemName - -**Content:** -Returns the name of a spellbook item. -```lua -spellName, spellSubName, spellID = GetSpellBookItemName(spellName) -spellName, spellSubName, spellID = GetSpellBookItemName(index, bookType) -``` - -**Parameters:** -- `spellName` - - *string* - Requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Returns:** -- `spellName` - - *string* - Name of the spell as it appears in the spell book, e.g. "Lesser Heal" -- `spellSubName` - - *string* - The spell rank or sub type, e.g. "Grand Master", "Racial Passive". This can be an empty string. Note: for the Enchanting trade skill at rank Apprentice, the returned string contains a trailing space, i.e. "Apprentice ". This might be the case for other trade skills and ranks also. Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad()` -- `spellID` - - *number* - -**Description:** -- **Related API** - - `GetSpellBookItemInfo` -- This function will return nested flyout spells, but the names returned may not be functional (a hunter will see "Call " instead of "Call Pet 1" but "/cast Call " will not function in a macro or from the command line). Use care with the results returned. -- Spell book information is first available after the `SPELLS_CHANGED` event fires. - -**Usage:** -Prints all spells in the spellbook for the player, except the profession tab ones. -```lua -for i = 1, GetNumSpellTabs() do - local offset, numSlots = select(3, GetSpellTabInfo(i)) - for j = offset+1, offset+numSlots do - print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) - end -end -``` - -Prints the spells shown in the profession tab. -```lua -for _, i in pairs{GetProfessions()} do - local offset, numSlots = select(3, GetSpellTabInfo(i)) - for j = offset+1, offset+numSlots do - print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) - end -end --- Example output: --- 7, 126, "Tailoring", "", 3908 --- 8, 128, "Engineering", "", 4036 --- 6, 122, "Cooking", "", 2550 --- 6, 123, "Cooking Fire", "", 81 -``` - -Prints the spells shown in the pet tab. -```lua -local numSpells, petToken = HasPetSpells() -- nil if pet does not have spellbook, 'petToken' will usually be 'PET' -for i=1, numSpells do - local petSpellName, petSubType, unmaskedSpellId = GetSpellBookItemName(i, "pet") - print("petSpellName", petSpellName) -- like "Dash" - print("petSubType", petSubType) -- like "Basic Ability" or "Pet Stance" - print("unmaskedId", unmaskedSpellId) -- don't have to apply the 0xFFFFFF mask like you do for GetSpellBookItemInfo -end -``` - -Note that not all spells available from the API are shown in the spellbook. -```lua -local i = 1 -while GetSpellBookItemName(i, BOOKTYPE_SPELL) do - print(i, GetSpellBookItemName(i, BOOKTYPE_SPELL)) - i = i + 1 -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellBookItemTexture.md b/wiki-information/functions/GetSpellBookItemTexture.md deleted file mode 100644 index 4aa924d3..00000000 --- a/wiki-information/functions/GetSpellBookItemTexture.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetSpellBookItemTexture - -**Content:** -Returns the icon texture of a spellbook item. -```lua -icon = GetSpellBookItemTexture(spell) -icon = GetSpellBookItemTexture(index, bookType) -``` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant Values:** - - `BOOKTYPE_SPELL` - - *"spell"* - The General, Class, Specs, and Professions tabs - - `BOOKTYPE_PET` - - *"pet"* - The Pet tab - -**Returns:** -- `icon` - - *number : FileID* - Icon fileId for the queried entry, or nil if the queried item does not exist. - -**Reference:** -- `GetSpellBookItemInfo` -- `GetSpellBookItemName` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCharges.md b/wiki-information/functions/GetSpellCharges.md deleted file mode 100644 index d64ccb78..00000000 --- a/wiki-information/functions/GetSpellCharges.md +++ /dev/null @@ -1,44 +0,0 @@ -## Title: GetSpellCharges - -**Content:** -Returns information about the charges of a charge-accumulating player ability. -```lua -currentCharges, maxCharges, cooldownStart, cooldownDuration, chargeModRate = GetSpellCharges(spell) -currentCharges, maxCharges, cooldownStart, cooldownDuration, chargeModRate = GetSpellCharges(index, bookType) -``` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - `"spell"` - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - `"pet"` - The Pet tab - -**Returns:** -- `currentCharges` - - *number* - The number of charges of the ability currently available. -- `maxCharges` - - *number* - The maximum number of charges the ability may have available. -- `cooldownStart` - - *number* - Time (per GetTime) at which the last charge cooldown began, or 2^32 / 1000 - cooldownDuration if the spell is not currently recharging. -- `cooldownDuration` - - *number* - Time (in seconds) required to gain a charge. -- `chargeModRate` - - *number* - The rate at which the charge cooldown widget's animation should be updated. - -**Description:** -Abilities like can be used by the player rapidly, and then slowly accumulate charges over time. The `cooldownStart` and `cooldownDuration` return values indicate the cooldown timer for acquiring the next charge (when `currentCharges` is less than `maxCharges`). -If the queried spell does not accumulate charges over time (e.g. or ), this function does not return any values. -Targeted dispels like or hold one hidden charge which may be queried with `GetSpellCharges`. The spells will immediately—or after a few in-game ticks—regain their charge if cast on a friendly unit that could not be dispelled. This may cause sporadic behavior when tracking cooldowns, because upon raising `SPELL_UPDATE_COOLDOWN`, the function API `GetSpellCooldown` will momentarily return that the spell is on its full cooldown duration. - -**Reference:** -- `GetActionCharges(slot)` - Referring to a button on an action bar. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCooldown.md b/wiki-information/functions/GetSpellCooldown.md deleted file mode 100644 index e42f73ec..00000000 --- a/wiki-information/functions/GetSpellCooldown.md +++ /dev/null @@ -1,61 +0,0 @@ -## Title: GetSpellCooldown - -**Content:** -Returns the cooldown info of a spell. -`start, duration, enabled, modRate = GetSpellCooldown(spell)` -`= GetSpellCooldown(index, bookType)` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - `"spell"` - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - `"pet"` - The Pet tab - -**Returns:** -- `startTime` - - *number* - The time when the cooldown started (as returned by GetTime()); zero if no cooldown; current time if (enabled == 0). -- `duration` - - *number* - Cooldown duration in seconds, 0 if spell is ready to be cast. -- `enabled` - - *number* - 0 if the spell is active (Stealth, Shadowmeld, Presence of Mind, etc) and the cooldown will begin as soon as the spell is used/cancelled; 1 otherwise. -- `modRate` - - *number* - The rate at which the cooldown widget's animation should be updated. - -**Description:** -- **Related Events** - - `SPELL_UPDATE_COOLDOWN` -- **Details:** - - To check the Global Cooldown, you can use the spell ID 61304. This is a dummy spell specifically for the GCD. - - The enabled return value allows addons to easily check if the player has used a buff-providing spell (such as Presence of Mind or Nature's Swiftness) without searching through the player's buffs. - - Values returned by this function are not updated immediately when `UNIT_SPELLCAST_SUCCEEDED` event is raised. - -**Usage:** -The following snippet checks the state of cooldown. On English clients, you could also use "Presence of Mind" in place of 12043, which is the spell's ID. -```lua -local start, duration, enabled, modRate = GetSpellCooldown(12043) -if enabled == 0 then - print("Presence of Mind is currently active, use it and wait " .. duration .. " seconds for the next one.") -elseif (start > 0 and duration > 0) then - local cdLeft = start + duration - GetTime() - print("Presence of Mind is cooling down, wait " .. cdLeft .. " seconds for the next one.") -else - print("Presence of Mind is ready.") -end -``` - -**Example Use Case:** -- **Checking Spell Cooldowns:** This function is commonly used in addons to monitor the cooldown status of spells, allowing players to optimize their spell usage and rotations. - -**Addons Using This Function:** -- **WeakAuras:** This popular addon uses `GetSpellCooldown` to display cooldown timers for spells, helping players track their abilities more effectively. -- **ElvUI:** This comprehensive UI replacement addon uses `GetSpellCooldown` to manage and display cooldown information on action bars and other UI elements. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCount.md b/wiki-information/functions/GetSpellCount.md deleted file mode 100644 index 7703a547..00000000 --- a/wiki-information/functions/GetSpellCount.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetSpellCount - -**Content:** -Returns the number of times a spell can be cast. Generally used for spells limited by the number of available item reagents. -`numCasts = GetSpellCount(spell)` -`numCasts = GetSpellCount(index, bookType)` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Returns:** -- `numCasts` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetSpellCritChance.md b/wiki-information/functions/GetSpellCritChance.md deleted file mode 100644 index df34b793..00000000 --- a/wiki-information/functions/GetSpellCritChance.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: GetSpellCritChance - -**Content:** -Returns the critical hit chance for the specified spell school. -`critChance = GetSpellCritChance(school)` - -**Parameters:** -- `school` - - *number* - the spell school to retrieve the crit chance for. Note: does not seem to be in Blizzard API Documentation. - - 1 for Physical - - 2 for Holy - - 3 for Fire - - 4 for Nature - - 5 for Frost - - 6 for Shadow - - 7 for Arcane - -**Returns:** -- `critChance` - - *number* - An unformatted floating point figure representing the critical hit chance for the specified school. - -**Usage:** -The following function, called with no arguments, will return the same spell crit value as shown on the Character pane of the default UI. The figure returned is formatted as a floating-point figure out to two decimal places. -```lua -function GetRealSpellCrit() - local holySchool = 2; - local minCrit = GetSpellCritChance(holySchool); - local spellCrit; - this.spellCrit = {}; - this.spellCrit = minCrit; - for i = (holySchool + 1), 7 do - spellCrit = GetSpellCritChance(i); - minCrit = min(minCrit, spellCrit); - this.spellCrit = spellCrit; - end - minCrit = format("%.2f%%", minCrit); - return minCrit; -end -``` -The above function is essentially a straight copy of the function from the Paper Doll LUA file in the default UI. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellDescription.md b/wiki-information/functions/GetSpellDescription.md deleted file mode 100644 index e81eb4a8..00000000 --- a/wiki-information/functions/GetSpellDescription.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetSpellDescription - -**Content:** -Returns the spell description. -`desc = GetSpellDescription(spellID)` - -**Parameters:** -- `spellID` - - *number* - Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad`. - -**Returns:** -- `desc` - - *string* - -**Usage:** -```lua -GetSpellDescription(11366) --- > "Hurls an immense fiery boulder that causes 141 Fire damage." -``` - -**Example Use Case:** -This function can be used in addons that need to display or log spell descriptions. For instance, an addon that provides detailed tooltips for spells might use `GetSpellDescription` to fetch and display the spell's effect. - -**Addons Using This Function:** -- **WeakAuras**: This popular addon for creating custom visual alerts uses `GetSpellDescription` to provide detailed information about spells in its configuration options, allowing users to understand the effects of spells they are tracking. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellHitModifier.md b/wiki-information/functions/GetSpellHitModifier.md deleted file mode 100644 index ef484811..00000000 --- a/wiki-information/functions/GetSpellHitModifier.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetSpellHitModifier - -**Content:** -Returns the amount of Spell Hit %, not from Spell Hit Rating, that your character has. -`hitMod = GetSpellHitModifier()` - -**Returns:** -- `hitMod` - - *number* - hit modifier (e.g. 16 for 16%) - -**Usage:** -Returns the Spell Hit Chance displayed in the paperdoll. -`/dump GetCombatRatingBonus(CR_HIT_SPELL) + GetSpellHitModifier();` - -**Reference:** -GetHitModifier() \ No newline at end of file diff --git a/wiki-information/functions/GetSpellInfo.md b/wiki-information/functions/GetSpellInfo.md deleted file mode 100644 index 86be9938..00000000 --- a/wiki-information/functions/GetSpellInfo.md +++ /dev/null @@ -1,64 +0,0 @@ -## Title: GetSpellInfo - -**Content:** -Returns spell info. -```lua -name, rank, icon, castTime, minRange, maxRange, spellID, originalIcon = GetSpellInfo(spell) -name, rank, icon, castTime, minRange, maxRange, spellID, originalIcon = GetSpellInfo(index, bookType) -``` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Returns:** -- `name` - - *string* - The localized name of the spell. -- `rank` - - *string* - Always returns nil. Refer to GetSpellSubtext() for retrieving the rank of spells on Classic. -- `icon` - - *number : FileID* - The spell icon texture. -- `castTime` - - *number* - Cast time in milliseconds, or 0 for instant spells. -- `minRange` - - *number* - Minimum range of the spell, or 0 if not applicable. -- `maxRange` - - *number* - Maximum range of the spell, or 0 if not applicable. -- `spellID` - - *number* - The ID of the spell. -- `originalIcon` - - *number : FileID* - The original icon texture for this spell. - -**Description:** -The player's form or stance may affect return values on relevant spells, such as a warlock's Corruption spell transforming to Doom while Metamorphosis is active. -When dealing with base spells that have been overridden by another spell, the icon return will represent the icon of the overriding spell, and originalIcon the icon of the base spell. -For example, if a Rogue has learned Gloomblade, then any queries for Backstab will yield Gloomblade's icon as the icon return, and the original icon for Backstab would be exposed through the originalIcon return value. - -**Usage:** -```lua -/dump GetSpellInfo(2061) -- "Flash Heal", nil, 135907, 1352, 0, 40, 2061 -``` -Some spell data - such as subtext and description - are load on demand. You can use `SpellMixin:ContinueOnSpellLoad()` to asynchronously query the data. -```lua -local spell = Spell:CreateFromSpellID(139) -spell:ContinueOnSpellLoad(function() - local name = spell:GetSpellName() - local desc = spell:GetSpellDescription() - print(name, desc) -- "Renew", "Fill the target with faith in the light, healing for 295 over 15 sec." -end) -``` - -**Reference:** -Battle for Azeroth Addon Changes by Ythisens, 24 Apr 2018 \ No newline at end of file diff --git a/wiki-information/functions/GetSpellLink.md b/wiki-information/functions/GetSpellLink.md deleted file mode 100644 index 582abd5d..00000000 --- a/wiki-information/functions/GetSpellLink.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: GetSpellLink - -**Content:** -Returns the hyperlink for a spell. -`link, spellId = GetSpellLink(spell)` -`link, spellId = GetSpellLink(index, bookType)` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Returns:** -- `link` - - *string* : spellLink -- `spellID` - - *number* - -**Usage:** -- Prints a clickable spell link, for Flash Heal. - ```lua - /run print(GetSpellLink(2061)) - ``` -- Dumps an (escaped) spell link. - ```lua - /dump GetSpellLink(2061) - -- "|cff71d5ff|Hspell:2061:0|h|h|r", 2061 - ``` -- Dumps the first spell from your spell book. - ```lua - /dump GetSpellLink(1, BOOKTYPE_SPELL) - -- "|cff71d5ff|Hspell:6603:0|h|h|r", 6603 - ``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellLossOfControlCooldown.md b/wiki-information/functions/GetSpellLossOfControlCooldown.md deleted file mode 100644 index 50d950e1..00000000 --- a/wiki-information/functions/GetSpellLossOfControlCooldown.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetSpellLossOfControlCooldown - -**Content:** -Returns information about a loss-of-control cooldown affecting a spell. -`start, duration = GetSpellLossOfControlCooldown(spellSlot or spellName or spellID)` - -**Parameters:** -- `spellSlot` - - *number* - spell book slot index, ascending from 1. -- `bookType` - - *string* - spell book type token, e.g. "spell" from player's spell book. -- or -- `spellName` - - *string* - name of a spell in the player's spell book. -- or -- `spellID` - - *number* - spell ID of a spell accessible to the player. - -**Returns:** -- `start` - - *number* - time at which the loss-of-control cooldown began, per GetTime. -- `duration` - - *number* - duration of the loss-of-control cooldown in seconds; 0 if the spell is not currently affected by a loss-of-control cooldown. - -**Description:** -If the spell is not affected by a loss-of-control cooldown, this function returns 0, 0. - -**Reference:** -GetActionLossOfControlCooldown \ No newline at end of file diff --git a/wiki-information/functions/GetSpellPenetration.md b/wiki-information/functions/GetSpellPenetration.md deleted file mode 100644 index 8168110a..00000000 --- a/wiki-information/functions/GetSpellPenetration.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetSpellPenetration - -**Content:** -Returns your spell penetration rating. -`spellPen = GetSpellPenetration()` - -**Returns:** -- `spellPen` - - *number* - Your spell penetration rating. \ No newline at end of file diff --git a/wiki-information/functions/GetSpellPowerCost.md b/wiki-information/functions/GetSpellPowerCost.md deleted file mode 100644 index fc1c5fa1..00000000 --- a/wiki-information/functions/GetSpellPowerCost.md +++ /dev/null @@ -1,58 +0,0 @@ -## Title: GetSpellPowerCost - -**Content:** -Returns resource cost info for a spell. -`costs = GetSpellPowerCost(spell)` -`costs = GetSpellPowerCost(index, bookType)` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Returns:** -- `costs` - - *table* - - **Field** - - **Type** - - **Description** - - `minCost` - - *number* - minimum cost - - `cost` - - *number* - maximum cost - - `costPercent` - - *number* - percentual cost - - `costPerSec` - - *number* - The cost per second for channeled spells. - - `type` - - *Enum.PowerType* - Enum.PowerType - - `name` - - *string* - powerToken: "MANA", "RAGE", "FOCUS", "ENERGY", "HAPPINESS", "RUNES", "RUNIC_POWER", "SOUL_SHARDS", "HOLY_POWER", "STAGGER", "CHI", "FURY", "PAIN", "LUNAR_POWER", "INSANITY" - - `hasRequiredAura` - - *boolean* - - `requiredAuraID` - - *number* - -**Description:** -Returns an empty table if the spell has no resource cost. -Reflects resource discounts provided by auras. -`requiredAuraID` has a return value different than zero for 36 spells. Most are spellIDs associated with a hidden healing/damage modifier spec aura, one refers to , two seem to be connected to Helya; some are honor talents, and some don't refer to a valid aura spellID. This return value mostly exists for spells that change their cost depending on which spec the player is in. -Some spells may have costs composed of multiple resource types. In this case, the costs array contains multiple tables. For example, `GetSpellPowerCost("Rip")` returns: -```lua -{ - {type=3, name="ENERGY", cost=30, minCost=30, costPercent=0, costPerSec=0, hasRequiredAura=false, requiredAuraID=0}, - {type=4, name="COMBO_POINTS", cost=5, minCost=1, costPercent=0, costPerSec=0, hasRequiredAura=false, requiredAuraID=0} -} -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellTabInfo.md b/wiki-information/functions/GetSpellTabInfo.md deleted file mode 100644 index fec54e05..00000000 --- a/wiki-information/functions/GetSpellTabInfo.md +++ /dev/null @@ -1,74 +0,0 @@ -## Title: GetSpellTabInfo - -**Content:** -Returns info for the specified spellbook tab. -`name, texture, offset, numSlots, isGuild, offspecID = GetSpellTabInfo(tabIndex)` - -**Parameters:** -- `tabIndex` - - *number* - The index of the tab, ascending from 1. - -**Returns:** -- `name` - - *string* - The name of the spell line (General, Shadow, Fury, etc.) -- `texture` - - *string* - The texture path for the spell line's icon -- `offset` - - *number* - Number of spell book entries before this tab (one less than index of the first spell book item in this tab) -- `numSlots` - - *number* - The number of spell entries in this tab. -- `isGuild` - - *boolean* - true for Guild Perks, false otherwise -- `offspecID` - - *number* - 0 if the tab contains spells you can cast (general/specialization/trade skill/etc); or specialization ID of the specialization this tab is showing the spells of. - -**Description:** -GetNumSpellTabs returns the number of class-skill tabs available to your character. -Due to flyouts, more spellbook item indices may be used by a tab than suggested by the offset/numEntries values. -Professions are tabs, too: GetProfessions returns tab indices that contain profession spells, beyond the range specified by GetNumSpellTabs. - -**Usage:** -Prints all spells in the spellbook for the player, except the profession tab ones. -```lua -for i = 1, GetNumSpellTabs() do - local offset, numSlots = select(3, GetSpellTabInfo(i)) - for j = offset+1, offset+numSlots do - print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) - end -end -``` - -Prints the spells shown in the profession tab. -```lua -for _, i in pairs{GetProfessions()} do - local offset, numSlots = select(3, GetSpellTabInfo(i)) - for j = offset+1, offset+numSlots do - print(i, j, GetSpellBookItemName(j, BOOKTYPE_SPELL)) - end -end --- Example output: --- 7, 126, "Tailoring", "", 3908 --- 8, 128, "Engineering", "", 4036 --- 6, 122, "Cooking", "", 2550 --- 6, 123, "Cooking Fire", "", 81 -``` - -Prints the spells shown in the pet tab. -```lua -local numSpells, petToken = HasPetSpells() -- nil if pet does not have spellbook, 'petToken' will usually be 'PET' -for i=1, numSpells do - local petSpellName, petSubType, unmaskedSpellId = GetSpellBookItemName(i,"pet") - print("petSpellName", petSpellName) -- like "Dash" - print("petSubType", petSubType) -- like "Basic Ability" or "Pet Stance" - print("unmaskedId", unmaskedSpellId) -- don't have to apply the 0xFFFFFF mask like you do for GetSpellBookItemInfo -end -``` - -Note that not all spells available from the API are shown in the spellbook. -```lua -local i = 1 -while GetSpellBookItemName(i, BOOKTYPE_SPELL) do - print(i, GetSpellBookItemName(i, BOOKTYPE_SPELL)) - i = i + 1 -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSpellTexture.md b/wiki-information/functions/GetSpellTexture.md deleted file mode 100644 index 37a1611c..00000000 --- a/wiki-information/functions/GetSpellTexture.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetSpellTexture - -**Content:** -Returns the icon texture of a spell. -```lua -icon = GetSpellTexture(spell) -icon = GetSpellTexture(index, bookType) -``` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - `"spell"` - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - `"pet"` - The Pet tab - -**Returns:** -- `icon` - - *number (fileID)* - icon texture used by the spell. - -**Reference:** -- `GetSpellBookItemTexture` \ No newline at end of file diff --git a/wiki-information/functions/GetStablePetFoodTypes.md b/wiki-information/functions/GetStablePetFoodTypes.md deleted file mode 100644 index 9d949eff..00000000 --- a/wiki-information/functions/GetStablePetFoodTypes.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GetStablePetFoodTypes - -**Content:** -Returns the food types the specified stabled pet can eat. -```lua -local PetFoodList = { GetStablePetFoodTypes(index) } -``` - -**Parameters:** -- `index` - - *number* - The stable slot index of the pet: 0 for the current pet, 1 for the pet in the left slot, and 2 for the pet in the right slot. - -**Returns:** -A list of the pet food type names, see `GetPetFoodTypes()`. - -Possible Food Type Names: -- Meat -- Fish -- Fruit -- Fungus -- Bread -- Cheese \ No newline at end of file diff --git a/wiki-information/functions/GetStablePetInfo.md b/wiki-information/functions/GetStablePetInfo.md deleted file mode 100644 index 984af7b1..00000000 --- a/wiki-information/functions/GetStablePetInfo.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: GetStablePetInfo - -**Content:** -Returns info for a specific stabled pet. -`petIcon, petName, petLevel, petType, petTalents = GetStablePetInfo(index)` - -**Parameters:** -- `index` - - *number* - The index of the pet slot, 1 through 5 are the hunter's active pets, 6 through 25 are the hunter's stabled pets. - -**Returns:** -- `petIcon` - - *string* - The path to texture to use as the icon for the pet, see `GetPetIcon()`. -- `petName` - - *string* - The pet name, see `UnitName()`. -- `petLevel` - - *number* - The pet level, see `UnitLevel()`. -- `petType` - - *string* - The localized pet family, see `UnitCreatureFamily()`. -- `petTalents` - - *string* - The pet's talent group. \ No newline at end of file diff --git a/wiki-information/functions/GetStatistic.md b/wiki-information/functions/GetStatistic.md deleted file mode 100644 index 38f5724a..00000000 --- a/wiki-information/functions/GetStatistic.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: GetStatistic - -**Content:** -Returns a character statistic. -`value, skip, id = GetStatistic(category)` - -**Parameters:** -- `category` - - *number* - AchievementID of a statistic or statistic category. -- `index` - - *number* - Entry within a statistic category, if applicable. - -**Returns:** -- `value` - - *string* - Value of the statistic as displayed in-game. -- `skip` - - *boolean* - Prevents a statistic from being shown in the default UI. -- `id` - - *string* - Unknown. - -**Description:** -Using the achievementID's of actual Achievements, as opposed to statistics, generates strange results. More testing is needed. -Wrapping the returned value with `tonumber()` is necessary to do comparisons using math operators. - -**Usage:** -Here is a function that will take any statistic title (like Battlegrounds played) and will return the statistic ID for that statistic, so it can be used in other functions. -```lua -function GetStatisticId(StatisticTitle) - for _, CategoryId in pairs(GetStatisticsCategoryList()) do - for i = 1, GetCategoryNumAchievements(CategoryId) do - local IDNumber, Name = GetAchievementInfo(CategoryId, i) - if Name == StatisticTitle then - return IDNumber - end - end - end - return -1 -end -``` - -**Reference:** -- 2013-09-09, Blizzard_AchievementUI.lua, version 5.4.0.17359, near line 1957, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/GetStatisticsCategoryList.md b/wiki-information/functions/GetStatisticsCategoryList.md deleted file mode 100644 index db9c7d06..00000000 --- a/wiki-information/functions/GetStatisticsCategoryList.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetStatisticsCategoryList - -**Content:** -Returns the list of statistic categories. -`categories = GetStatisticsCategoryList()` - -**Returns:** -- `categories` - - *table* - list of all the categories - -**Usage:** -The snippet below prints info about the category IDs. -```lua -local categories = GetStatisticsCategoryList() -for i, id in next(categories) do - local key, parent = GetCategoryInfo(id) - print("The key %d has the parent %d", key, parent) -end -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSubZoneText.md b/wiki-information/functions/GetSubZoneText.md deleted file mode 100644 index 71bebfa2..00000000 --- a/wiki-information/functions/GetSubZoneText.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetSubZoneText - -**Content:** -Returns the subzone name. -`subzone = GetSubZoneText()` - -**Returns:** -- `subzone` - - *string* - Subzone name or an empty string (if not in a subzone). - -**Usage:** -Returns the subzone name where the player is currently located. If not in a subzone, it returns an empty string. -```lua -/run print("Current SubZone: " .. GetSubZoneText()) -``` - -**Description:** -Related Events -- `ZONE_CHANGED_INDOORS` \ No newline at end of file diff --git a/wiki-information/functions/GetSuggestedGroupNum.md b/wiki-information/functions/GetSuggestedGroupNum.md deleted file mode 100644 index 026443af..00000000 --- a/wiki-information/functions/GetSuggestedGroupNum.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_QuestLog.GetSuggestedGroupSize - -**Content:** -Returns the suggested number of players for a quest. -`suggestedGroupSize = C_QuestLog.GetSuggestedGroupSize(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `suggestedGroupSize` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetSummonFriendCooldown.md b/wiki-information/functions/GetSummonFriendCooldown.md deleted file mode 100644 index ab75b416..00000000 --- a/wiki-information/functions/GetSummonFriendCooldown.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetSummonFriendCooldown - -**Content:** -Returns the cooldown info of the RaF Summon Friend ability. -`start, duration = GetSummonFriendCooldown()` - -**Returns:** -- `start` - - *number* - The value of `GetTime()` at the moment the cooldown began, 0 if the ability is ready -- `duration` - - *number* - The length of the cooldown in seconds, 0 if the ability is ready - -**Usage:** -The snippet below prints the remaining time of the cooldown in seconds. -```lua -local start, duration = GetSummonFriendCooldown() -local timeleft = start + duration - GetTime() -print(timeleft) -``` \ No newline at end of file diff --git a/wiki-information/functions/GetSuperTrackedQuestID.md b/wiki-information/functions/GetSuperTrackedQuestID.md deleted file mode 100644 index 32946f55..00000000 --- a/wiki-information/functions/GetSuperTrackedQuestID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SuperTrack.GetSuperTrackedQuestID - -**Content:** -Returns the quest ID currently being tracked, if set. Replaces `GetSuperTrackedQuestID`. -`questID = C_SuperTrack.GetSuperTrackedQuestID()` - -**Returns:** -- `questID` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/GetTalentGroupRole.md b/wiki-information/functions/GetTalentGroupRole.md deleted file mode 100644 index 9afd3cfc..00000000 --- a/wiki-information/functions/GetTalentGroupRole.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetTalentGroupRole - -**Content:** -Returns the currently selected role for a player talent group (primary or secondary). -`role = GetTalentGroupRole(groupIndex)` - -**Parameters:** -- `groupIndex` - - *number* - Ranging from 1 to 2 (primary/secondary talent group). To get the current one use `GetActiveTalentGroup()` - -**Returns:** -- `role` - - *string* - Can be `DAMAGER`, `TANK`, or `HEALER` - -**Example Usage:** -This function can be used to determine the role of a player in a specific talent group, which can be useful for addons that manage group compositions or provide role-specific information. - -**Addons:** -Large addons like "ElvUI" and "DBM (Deadly Boss Mods)" use this function to adjust their settings and alerts based on the player's role in a specific talent group. For example, DBM might change its warnings and alerts depending on whether the player is a tank, healer, or damage dealer. \ No newline at end of file diff --git a/wiki-information/functions/GetTalentInfo.md b/wiki-information/functions/GetTalentInfo.md deleted file mode 100644 index 9ca739db..00000000 --- a/wiki-information/functions/GetTalentInfo.md +++ /dev/null @@ -1,72 +0,0 @@ -## Title: GetTalentInfo - -**Content:** -For the Dragonflight version, see Dragonflight Talent System. -For the Wrath version, see API GetTalentInfo/Wrath. -For the WoW Classic version, see API GetTalentInfo/Classic. -Returns info for the specified talent. -```lua -talentID, name, texture, selected, available, spellID, unknown, row, column, known, grantedByAura = GetTalentInfo(tier, column, specGroupIndex) -talentID, name, texture, selected, available, spellID, unknown, row, column, known, grantedByAura = GetTalentInfoByID(talentID, specGroupIndex) -talentID, name, texture, selected, available, spellID, unknown, row, column, known, grantedByAura = GetTalentInfoBySpecialization(specIndex, tier, column) -``` - -**Parameters:** - -*GetTalentInfo:* -- `tier` - - *number* - Talent tier from 1 to MAX_TALENT_TIERS -- `column` - - *number* - Talent column from 1 to NUM_TALENT_COLUMNS -- `specGroupIndex` - - *number* - Index of active specialization group (GetActiveSpecGroup) -- `isInspect` - - *boolean?* - If non-nil, returns information based on inspectedUnit/classId. -- `inspectUnit` - - *string? : UnitId* - Inspected unit; if nil, the selected/available return values will always be false. - -*GetTalentInfoByID:* -- `talentID` - - *number* - Talent ID. -- `specGroupIndex` - - *number* -- `isInspect` - - *boolean?* -- `inspectUnit` - - *string? : UnitId* - -*GetTalentInfoBySpecialization:* -- `specIndex` - - *number* - Index of the specialization, ascending from 1 to GetNumSpecializations(). -- `tier` - - *number* -- `column` - - *number* - -**Returns:** -1. `talentID` - - *number* - Talent ID. -2. `name` - - *string* - Talent name. -3. `texture` - - *number : FileID* -4. `selected` - - *boolean* - true if the talent is chosen, false otherwise. -5. `available` - - *boolean* - true if the talent tier is chosen, or if it is level-appropriate for the player and the player has no talents selected in that tier, false otherwise. -6. `spellID` - - *number* - Spell ID that is added to the spellbook. -7. `unknown` - - *any* -8. `row` - - *number* - The row the talent is from. This will be the same as the tier argument given. -9. `column` - - *number* - The column the talent is from. This will be the same as the column argument given. -10. `known` - - *boolean* - true if the talent is active, false otherwise. -11. `grantedByAura` - - *boolean* - true if the talent is granted by an aura (i.e., an effect on an item), false otherwise. Legion's Class Soul rings used this rather than selected. - -**Reference:** -- `IsPlayerSpell` -- `IsSpellKnown` \ No newline at end of file diff --git a/wiki-information/functions/GetTalentPrereqs.md b/wiki-information/functions/GetTalentPrereqs.md deleted file mode 100644 index 6663e199..00000000 --- a/wiki-information/functions/GetTalentPrereqs.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetTalentPrereqs - -**Content:** -Returns the tier and column of a talent's prerequisite, and if the talent is learnable. -`tier, column, isLearnable = GetTalentPrereqs(tabIndex, talentIndex [, isInspect, isPet, talentGroup])` - -**Parameters:** -- `tabIndex` - - *number* - Ranging from 1 to `GetNumTalentTabs()` -- `talentIndex` - - *number* - Ranging from 1 to `GetNumTalents(tabIndex)` -- `isInspect` - - *boolean?* - Whether the talent is for the currently inspected player. -- `isPet` - - *boolean?* -- `talentGroup` - - *number?* - Probably the dual spec group index. - -**Returns:** -- `tier` - - *number* - The row/tier that the prerequisite talent sits on. -- `column` - - *number* - The column that the prerequisite talent sits on. -- `isLearnable` - - *number* - Returns 1 if you have learned the prerequisite talents, nil otherwise. - -**Description:** -The `talentIndex` is counted as if it were a tree, meaning that the leftmost talent in the topmost row is number 1 followed by the one immediately to the right as number 2. If there are no more talents to the right, then it continues from the leftmost talent on the next row. -If you check a talent with no prerequisites, the function returns nil. \ No newline at end of file diff --git a/wiki-information/functions/GetTalentTabInfo.md b/wiki-information/functions/GetTalentTabInfo.md deleted file mode 100644 index a9a7daae..00000000 --- a/wiki-information/functions/GetTalentTabInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetTalentTabInfo - -**Content:** -Returns information for a talent tab (tree). -`name, texture, pointsSpent, fileName = GetTalentTabInfo(index)` - -**Parameters:** -- `index` - - *number* - Ranging from 1 to `GetNumTalentTabs()` -- `isInspect` - - *boolean?* - Optional, will return talent tab info for the current inspect target if true (see `NotifyInspect`). -- `isPet` - - *boolean?* - Optional, will return talent tab info for the players' pet if true. -- `talentGroup` - - *number?* - Optional talent group to query for Dual Talent Specialization. Defaults to 1 for the primary specialization. - -**Returns:** -- `name` - - *string* -- `texture` - - *string* - This is always nil on Classic. -- `pointsSpent` - - *number* - Number of points put into the tab. -- `fileName` - - *string* - File name of the background image. - -**Usage:** -An example of how to use the `fileName` return value would be: -```lua -string.format("Interface\\TalentFrame\\%s-TopLeft", fileName) -``` \ No newline at end of file diff --git a/wiki-information/functions/GetTaxiBenchmarkMode.md b/wiki-information/functions/GetTaxiBenchmarkMode.md deleted file mode 100644 index 4b757694..00000000 --- a/wiki-information/functions/GetTaxiBenchmarkMode.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetTaxiBenchmarkMode - -**Content:** -Needs summary. -`benchMode = GetTaxiBenchmarkMode()` - -**Returns:** -- `benchMode` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GetTaxiMapID.md b/wiki-information/functions/GetTaxiMapID.md deleted file mode 100644 index 01a765e2..00000000 --- a/wiki-information/functions/GetTaxiMapID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetTaxiMapID - -**Content:** -Returns the UIMapID for the current taxi map while the flight path window is open. -`local taxiMapID = GetTaxiMapID()` - -**Returns:** -- `taxiMapID` - - *number* - UiMapID for current taxi map. \ No newline at end of file diff --git a/wiki-information/functions/GetText.md b/wiki-information/functions/GetText.md deleted file mode 100644 index efa5b2f7..00000000 --- a/wiki-information/functions/GetText.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: GetText - -**Content:** -Returns localized text depending on the specified gender. -`text = GetText(token)` - -**Parameters:** -- `token` - - *string* - Reputation index -- `gender` - - *number* - Gender ID -- `ordinal` - - *unknown* - -**Returns:** -- `text` - - *string* - The localized text - -**Usage:** -- This should return `FACTION_STANDING_LABEL1` - ```lua - /dump GetText("FACTION_STANDING_LABEL1") -- "Hated" - ``` -- This should return `FACTION_STANDING_LABEL1_FEMALE` - ```lua - /dump GetText("FACTION_STANDING_LABEL1", 3) -- "Hated" - ``` - -**Reference:** -- `getglobal` \ No newline at end of file diff --git a/wiki-information/functions/GetThreatStatusColor.md b/wiki-information/functions/GetThreatStatusColor.md deleted file mode 100644 index 1b7bb819..00000000 --- a/wiki-information/functions/GetThreatStatusColor.md +++ /dev/null @@ -1,50 +0,0 @@ -## Title: GetThreatStatusColor - -**Content:** -Returns the color for a threat status. -`r, g, b = GetThreatStatusColor(status)` - -**Parameters:** -- `status` - - *number* - Usually the return of `UnitThreatSituation` - -**Returns:** -- `r` - - *number* - a value between 0 and 1 for the red content of the color -- `g` - - *number* - a value between 0 and 1 for the green content of the color -- `b` - - *number* - a value between 0 and 1 for the blue content of the color - -**Description:** -Usually returns one of the following: -- 1: 1.00, 1.00, 0.47 (yellow) -- 2: 1.00, 0.60, 0.00 (orange) -- 3: 1.00, 0.00, 0.00 (red) - -Other values observed in the wild, but these situations do not occur in the default UI: -- 0: 0.69, 0.69, 0.69 (grey) -- 4 to 4294967294: 1.00, 0.00, 1.00 (magenta) -- 4294967295: 1.00, 1.00, 1.00 (white) - -**Usage:** -Prints a description of the player's threat situation to the chat frame, colored appropriately. e.g. -```lua -local statustxts = { "low on threat", "overnuking", "losing threat", "tanking securely" } -local status = UnitThreatSituation("player", "target") -- returns nil, 0, 1, 2 or 3 -if (status) then - local r, g, b = GetThreatStatusColor(status) - print(status .. ": You are " .. statustxts[status + 1] .. ".", r, g, b) -else - print("nil: You are not on their threat table.") -end -``` -Results in one of the following: -- 0: You are low on threat. -- 1: You are overnuking. -- 2: You are losing threat. -- 3: You are tanking securely. -- nil: You are not on their threat table. - -**Reference:** -[API UnitDetailedThreatSituation](https://wowpedia.fandom.com/wiki/API_UnitDetailedThreatSituation) \ No newline at end of file diff --git a/wiki-information/functions/GetTickTime.md b/wiki-information/functions/GetTickTime.md deleted file mode 100644 index 11445bcf..00000000 --- a/wiki-information/functions/GetTickTime.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetTickTime - -**Content:** -Returns the time in seconds since the end of the previous frame and the start of the current frame. -`elapsed = GetTickTime()` - -**Returns:** -- `elapsed` - - *number* - The time in seconds since the last frame. - -**Description:** -Multiple calls to this function within the same frame will all return the same value. -The value returned from this function appears to be identical to the value passed to OnUpdate scripts executed at the end of the current frame as the elapsed parameter. \ No newline at end of file diff --git a/wiki-information/functions/GetTime.md b/wiki-information/functions/GetTime.md deleted file mode 100644 index 32d16ec9..00000000 --- a/wiki-information/functions/GetTime.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetTime - -**Content:** -Returns the system uptime of your computer in seconds, with millisecond precision. -`seconds = GetTime()` - -**Returns:** -- `seconds` - - *number* - The current system uptime in seconds, e.g. 60123.558 - -**Description:** -This value is only updated once per rendered frame. Finer-grained timers are available using `GetTimePreciseSec()` or `debugprofilestop()`. -It is possible for this function to return identical values across consecutive frames if a low-resolution timing method is in use while running at a high framerate. - -**Reference:** -- `time()`, `date()` -- `GetGameTime()` -- `GetTimePreciseSec()` -- `CVar timingMethod` \ No newline at end of file diff --git a/wiki-information/functions/GetTimePreciseSec.md b/wiki-information/functions/GetTimePreciseSec.md deleted file mode 100644 index 1c72aedc..00000000 --- a/wiki-information/functions/GetTimePreciseSec.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetTimePreciseSec - -**Content:** -Returns a monotonic timestamp in seconds, with millisecond precision. -`seconds = GetTimePreciseSec()` - -**Returns:** -- `seconds` - - *number* - The number of seconds that have elapsed since this timer was started. - -**Description:** -The first call to this function will always return zero. Subsequent calls will return the number of seconds that have elapsed since the first call until the client is restarted. -Unlike `GetTime()`, the value returned by this function is not cached once per frame and may change on each call. - -**Usage:** -```lua -print("Start time:", GetTimePreciseSec()); -for _ = 1, 2^26 do - -- Busy loop to make some time pass. -end -print("End time:", GetTimePreciseSec()); --- Output: --- "Start time:", 0 --- "End time:", 0.3624231 -``` - -**Reference:** -- `GetTime()` \ No newline at end of file diff --git a/wiki-information/functions/GetTitleName.md b/wiki-information/functions/GetTitleName.md deleted file mode 100644 index b5386126..00000000 --- a/wiki-information/functions/GetTitleName.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: GetTitleName - -**Content:** -Returns the name of a player title. -`name, playerTitle = GetTitleName(titleId)` - -**Parameters:** -- `titleId` - - *number* - Ranging from 1 to GetNumTitles. Not necessarily an index as there can be missing/skipped IDs in between. - -**Returns:** -- `name` - - *string* - Name of the title. -- `playerTitle` - - *boolean* - Seems to be true for all existing titles. - -**Description:** -If the name has a trailing space, then the title is prefixed, otherwise it's suffixed. -```lua -/dump GetTitleName(2) -- "Corporal " → "Corporal Bob" (prefix) -/dump GetTitleName(36) -- "Champion of the Naaru" → "Alice, Champion of the Naaru" (suffix) -``` - -**Reference:** -- `GetCurrentTitle` -- `IsTitleKnown` \ No newline at end of file diff --git a/wiki-information/functions/GetTitleText.md b/wiki-information/functions/GetTitleText.md deleted file mode 100644 index 66ca19e7..00000000 --- a/wiki-information/functions/GetTitleText.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetTitleText - -**Content:** -Returns the name of the quest at the quest giver. -`title = GetTitleText()` - -**Returns:** -- `title` - - *string* - name of the offered quest, e.g. "Inside the Frozen Citadel". - -**Description:** -Quest title is updated when the `QUEST_DETAIL` event fires. \ No newline at end of file diff --git a/wiki-information/functions/GetTotalAchievementPoints.md b/wiki-information/functions/GetTotalAchievementPoints.md deleted file mode 100644 index fb141551..00000000 --- a/wiki-information/functions/GetTotalAchievementPoints.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetTotalAchievementPoints - -**Content:** -Returns the total number of achievement points earned. -`points = GetTotalAchievementPoints()` - -**Returns:** -- `points` - - *number* - Total points earned \ No newline at end of file diff --git a/wiki-information/functions/GetTotemCannotDismiss.md b/wiki-information/functions/GetTotemCannotDismiss.md deleted file mode 100644 index 781db8bf..00000000 --- a/wiki-information/functions/GetTotemCannotDismiss.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetTotemCannotDismiss - -**Content:** -Needs summary. -`cannotDismiss = GetTotemCannotDismiss(slot)` - -**Parameters:** -- `slot` - - *number* - -**Returns:** -- `cannotDismiss` - - *boolean?* \ No newline at end of file diff --git a/wiki-information/functions/GetTotemTimeLeft.md b/wiki-information/functions/GetTotemTimeLeft.md deleted file mode 100644 index 4cc80e64..00000000 --- a/wiki-information/functions/GetTotemTimeLeft.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetTotemTimeLeft - -**Content:** -Returns active time remaining (in seconds) before a totem (or ghoul) disappears. -`seconds = GetTotemTimeLeft(slot)` - -**Parameters:** -- `slot` - - *number* - Which totem to query: - - 1 - Fire (or Death Knight's ghoul) - - 2 - Earth - - 3 - Water - - 4 - Air - -**Returns:** -- `seconds` - - *number* - Time remaining before the totem/ghoul is automatically destroyed - -**Description:** -Totem functions are also used for ghouls summoned by a Death Knight (if the ghoul is not made a controllable pet by Raise Dead rank 2). - -**Reference:** -- `GetTime` -- `GetTotemInfo` \ No newline at end of file diff --git a/wiki-information/functions/GetTrackedAchievements.md b/wiki-information/functions/GetTrackedAchievements.md deleted file mode 100644 index 5b03c78a..00000000 --- a/wiki-information/functions/GetTrackedAchievements.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetTrackedAchievements - -**Content:** -Returns the currently tracked achievements. -`id1, id2, ..., idn = GetTrackedAchievements()` - -**Returns:** -- `id1, id2, ..., idn` - - *number* - achievementId(s) of achievements you are currently tracking. - -**Description:** -Returns up to 10 tracked achievements. - -**Reference:** -- `AddTrackedAchievement` -- `GetNumTrackedAchievements` -- `RemoveTrackedAchievement` \ No newline at end of file diff --git a/wiki-information/functions/GetTrackingInfo.md b/wiki-information/functions/GetTrackingInfo.md deleted file mode 100644 index b7777c14..00000000 --- a/wiki-information/functions/GetTrackingInfo.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: GetTrackingInfo - -**Content:** -Returns tracking info by index. -`name, texture, active, category, nested = GetTrackingInfo(id)` - -**Parameters:** -- `id` - - *number* - tracking type index, ascending from 1 to `GetNumTrackingTypes()`. - -**Returns:** -- `name` - - *string* - Track name. -- `texture` - - *number* - fileID for the Track texture. -- `active` - - *boolean* - If the track is active, it will return 1 but otherwise nil. -- `category` - - *string* - Track category, returns "spell" if the tracking method is a spell in the spellbook or "other" if it's a static tracking method. -- `nested` - - *number* - Nesting level, returns -1 for items at the root level, TOWNSFOLK for items in the Townsfolk dropdown, and HUNTER_TRACKING for Hunter tracking spells. - -**Usage:** -Gathers information for the first option on the tracking list and lists it in the default chatframe: -```lua -local name, texture, active, category = GetTrackingInfo(1); -DEFAULT_CHAT_FRAME:AddMessage(name.." ("..category..")"); -``` - -Lists all tracking methods, name and category in the default chatframe: -```lua -local count = GetNumTrackingTypes(); -for i=1,count do - local name, texture, active, category = GetTrackingInfo(i); - DEFAULT_CHAT_FRAME:AddMessage(name.." ("..category..")"); -end -``` - -**Description:** -If the player has tracking spells, those will only be accessible to this function after the player's spellbook has been loaded from the server: consider waiting for `PLAYER_LOGIN` before querying. \ No newline at end of file diff --git a/wiki-information/functions/GetTrackingTexture.md b/wiki-information/functions/GetTrackingTexture.md deleted file mode 100644 index db949d44..00000000 --- a/wiki-information/functions/GetTrackingTexture.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetTrackingTexture - -**Content:** -Returns the texture of the active tracking buff. -`icon = GetTrackingTexture()` - -**Returns:** -- `icon` - - *number : FileID* - The texture of the active tracking buff, or nil if none. \ No newline at end of file diff --git a/wiki-information/functions/GetTradePlayerItemInfo.md b/wiki-information/functions/GetTradePlayerItemInfo.md deleted file mode 100644 index c86a8308..00000000 --- a/wiki-information/functions/GetTradePlayerItemInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: GetTradePlayerItemInfo - -**Content:** -Returns information about a trade item. -`name, texture, numItems, quality, enchantment, canLoseTransmog = GetTradePlayerItemInfo(id)` - -**Parameters:** -- `id` - - *number* - The trade slot index to query. - -**Returns:** -- `name` - - *string* - The name of the item. -- `texture` - - *number : FileDataID* - The icon associated with the item. -- `numItems` - - *number* - For stackable items, the number of items in the stack. -- `quality` - - *Enum.ItemQuality* - The quality of the item. -- `enchantment` - - *string* - The name of any applied enchantment. -- `canLoseTransmog` - - *boolean* - true if trading this item will cause the player to lose the ability to transmogrify its appearance. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillDescription.md b/wiki-information/functions/GetTradeSkillDescription.md deleted file mode 100644 index 20c7d710..00000000 --- a/wiki-information/functions/GetTradeSkillDescription.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetTradeSkillDescription - -**Content:** -Returns the description for a recipe. -`description = GetTradeSkillDescription(index)` - -**Parameters:** -- `recipeID` - - *number* - -**Returns:** -- `description` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillInfo.md b/wiki-information/functions/GetTradeSkillInfo.md deleted file mode 100644 index bd3206ad..00000000 --- a/wiki-information/functions/GetTradeSkillInfo.md +++ /dev/null @@ -1,49 +0,0 @@ -## Title: GetTradeSkillInfo - -**Content:** -Retrieves information about a specific trade skill. -`skillName, skillType, numAvailable, isExpanded, altVerb, numSkillUps, indentLevel, showProgressBar, currentRank, maxRank, startingRank = GetTradeSkillInfo(skillIndex)` - -**Parameters:** -- `skillIndex` - - *number* - The id of the skill you want to query. - -**Returns:** -- `skillName` - - *string* - The name of the skill, e.g. "Copper Breastplate" or "Daggers", if the skillIndex references a heading. -- `skillType` - - *string* - "header", if the skillIndex references a heading; "subheader", if the skillIndex references a subheader for things like the cooking specialties; or a string indicating the difficulty to craft the item ("trivial", "easy", "medium", "optimal", "difficult"). -- `numAvailable` - - *number* - The number of items the player can craft with their available trade goods. -- `isExpanded` - - *boolean* - Returns if the header of the skillIndex is expanded in the crafting window or not. -- `altVerb` - - *string* - If not nil, a verb other than "Create" which describes the trade skill action (i.e., for Enchanting, this returns "Enchant"). If nil, the expected verb is "Create." -- `numSkillUps` - - *number* - The number of skill ups that the player can receive by crafting this item. -- `indentLevel` - - *number* - 0 or 1, indicates whether this skill should be indented beneath its header. Used for specialty subheaders and their recipes. -- `showProgressBar` - - *boolean* - Indicates if a sub-progress bar must be displayed with the specialty current and max ranks. In the normal UI, those values are only shown when the mouse is over the sub-header. -- `currentRank` - - *number* - The current rank for the specialty if `showProgressBar` is true. -- `maxRank` - - *number* - The maximum rank for the specialty if `showProgressBar` is true. -- `startingRank` - - *number* - The starting rank where the specialty is available. It is used as the starting value of the progress bar. - -**Usage:** -```lua -local name, type; -for i = 1, GetNumTradeSkills() do - name, type, _, _, _, _ = GetTradeSkillInfo(i); - if (name and type ~= "header") then - DEFAULT_CHAT_FRAME:AddMessage("Found: " .. name); - end -end -``` - -**Miscellaneous:** -Result: - -Displays all items the player is able to craft in the chat windows. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillInvSlotFilter.md b/wiki-information/functions/GetTradeSkillInvSlotFilter.md deleted file mode 100644 index 8065b472..00000000 --- a/wiki-information/functions/GetTradeSkillInvSlotFilter.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetTradeSkillInvSlotFilter - -**Content:** -`isVisible = GetTradeSkillInvSlotFilter(slotIndex)` - -**Return values:** -- `isVisible` - - Whether the slot for `slotIndex` is visible (1) or not (nil). - -**Reference:** -- `SetTradeSkillInvSlotFilter` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillItemLink.md b/wiki-information/functions/GetTradeSkillItemLink.md deleted file mode 100644 index 91433475..00000000 --- a/wiki-information/functions/GetTradeSkillItemLink.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetTradeSkillItemLink - -**Content:** -Gets the link string for a trade skill item. -`link = GetTradeSkillItemLink(skillId)` - -**Parameters:** -- `skillId` - - *number* - The Id specifying which trade skill's link to get. Trade Skill window must be open for this to work. Indexes start at 1 which is the general category of the tradeskill, if you have selected a sub-group of trade skills then 1 will be the name of that sub-group. - -**Example:** -Trade Blacksmithing: (window is open, all categories shown) -- **Index** | **Name** -- 1 | Daggers -- 2 | Heatseeker -- 3 | One-handed Swords -- 4 | Frostguard - -Trade Blacksmithing: (window is open, only trade items are shown) -- **Index** | **Name** -- 1 | Trade Items -- 2 | Elemental Sharpening Stone -- 3 | Thorium Shield Spike - -**Returns:** -- `link` - - *string* - An item link string (color coded with href) which can be included in chat messages to represent the item which the trade skill creates. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillItemStats.md b/wiki-information/functions/GetTradeSkillItemStats.md deleted file mode 100644 index f840768b..00000000 --- a/wiki-information/functions/GetTradeSkillItemStats.md +++ /dev/null @@ -1,47 +0,0 @@ -## Title: GetTradeSkillItemStats - -**Content:** -Gets the link string for a trade skill item. -`itemStats = GetTradeSkillItemStats(skillId)` - -**Parameters:** -- `(index)` - - `index` - - *number* - The row of the tradeskill listbox containing the item. The indices include the category headers. The tradeskill window doesn't have to be open, but the tradeskill and indices reflect the last state of the tradeskill window. The indices change if you expand or collapse headings (i.e. they exactly reflect the line number of the item as it is currently displayed in the tradeskill window). - -**Example:** -Trade Blacksmithing: (window is open, all categories shown) -- `Index` | `Name` -- `1` | `- Daggers` -- `2` | `Deadly Bronze Poniard` -- `3` | `Pearl-handled Dagger` -- `4` | `Big Bronze Knife` -- `5` | `- One-Handed Axes` - -Trade Blacksmithing: (window is open, only trade items are shown) -- `Index` | `Name` -- `1` | `- Trade Items` -- `2` | `Elemental Sharpening Stone` -- `3` | `Thorium Shield Spike` - -**Returns:** -- `itemStats` - - *table of string* - -**Usage:** -```lua -itemStats = {GetTradeSkillItemStats(2)} -- Get item stats for Deadly Bronze Poniard (see above) -itemStats = {GetTradeSkillItemStats(2)} -- Get item stats for Deadly Bronze Poniard (see above) -``` - -**Miscellaneous:** -**Result:** -```lua -itemStats = { "Uncommon", "Binds when equipped", "One-Hand", "|cffff2020Dagger|r", "16 - 30 Damage", "Speed 18", "+4 Strength", "Level 25", "Requires Level 20" } -``` - -**Notes and Caveats:** -The curly braces around the function call are critical, if you forget those your result will be: -```lua -itemStats = "Uncommon" -``` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillLine.md b/wiki-information/functions/GetTradeSkillLine.md deleted file mode 100644 index 3a2d2ed3..00000000 --- a/wiki-information/functions/GetTradeSkillLine.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetTradeSkillLine - -**Content:** -Returns information about the current tradeskill. -`tradeskillName, currentLevel, maxLevel, skillLineModifier = GetTradeSkillLine()` - -**Returns:** -- `tradeskillName` - - *string* - Name of the current tradeskill -- `currentLevel` - - *number* - Current skill level in the current tradeskill -- `maxLevel` - - *number* - Current maximum skill level for the current tradeskill (based on Journeyman, Expert etc.) -- `skillLineModifier` - - *number* - Skill modifier from racial abilities etc. - -**Description:** -This function returns information about the current tradeskill, which is the one currently visible in the Trade Skill frame. If the Trade Skill frame isn't open then 'UNKNOWN' is returned for 'tradeSkillName' and zero for all other values. -Based on use of the function in Blizzard's code, 'tradeSkillName' appears to be a localized name for the tradeskill. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillListLink.md b/wiki-information/functions/GetTradeSkillListLink.md deleted file mode 100644 index a683525d..00000000 --- a/wiki-information/functions/GetTradeSkillListLink.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GetTradeSkillListLink - -**Content:** -Returns the hyperlink for the currently opened tradeskill. -`link = GetTradeSkillListLink()` - -**Returns:** -- `link` - - *string?* : tradeLink \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillNumMade.md b/wiki-information/functions/GetTradeSkillNumMade.md deleted file mode 100644 index e6fc66c5..00000000 --- a/wiki-information/functions/GetTradeSkillNumMade.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: GetTradeSkillNumMade - -**Content:** -Get the number of items made in each use of a tradeskill. -`minMade, maxMade = GetTradeSkillNumMade(skillId)` - -**Parameters:** -- `skillId` - - *number* - Which tradeskill to query. - -**Returns:** -- `minMade` - - *number* - The minimum number of items that will be made. -- `maxMade` - - *number* - The maximum number of items that will be made. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillNumReagents.md b/wiki-information/functions/GetTradeSkillNumReagents.md deleted file mode 100644 index 8dd67085..00000000 --- a/wiki-information/functions/GetTradeSkillNumReagents.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetTradeSkillNumReagents - -**Content:** -Returns the number of distinct reagents required by the specified recipe. -`numReagents = GetTradeSkillNumReagents(tradeSkillRecipeId)` - -**Parameters:** -- `tradeSkillRecipeId` - - *number* - The id of the trade skill recipe. - -**Returns:** -- `reagentCount` - - *number* - The number of distinct reagents required to create the item. - -**Usage:** -```lua -local numReagents = GetTradeSkillNumReagents(id); -local totalReagents = 0; -for i = 1, numReagents, 1 do - local reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(id, i); - totalReagents = totalReagents + reagentCount; -end; -``` - -**Miscellaneous:** -Result: -Calculates the total number of items required by the recipe. - -**Description:** -If a recipe calls for 2 copper tubes, 1 malachite, and 2 blasting powders, `GetTradeSkillNumReagents` would return 3. If it required 5 linen cloths, the result would be 1. -Once you know how many distinct reagents you need, you can use `GetTradeSkillReagentInfo` to find out how many of each one are required. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillReagentInfo.md b/wiki-information/functions/GetTradeSkillReagentInfo.md deleted file mode 100644 index 4e54d3d4..00000000 --- a/wiki-information/functions/GetTradeSkillReagentInfo.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: GetTradeSkillReagentInfo - -**Content:** -Returns information on reagents for the specified trade skill. -`reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(tradeSkillRecipeId, reagentId)` - -**Parameters:** -- `tradeSkillRecipeId` - - The Id of the tradeskill recipe -- `reagentId` - - The Id of the reagent (from 1 to x, where x is the result of calling GetTradeSkillNumReagents) - -**Returns:** -- `reagentName` - - *string* - The name of the reagent. -- `reagentTexture` - - *string* - The texture for the reagent's icon. -- `reagentCount` - - *number* - The quantity of this reagent required to make one of these items. -- `playerReagentCount` - - *number* - The quantity of this reagent in the player's inventory. - -**Usage:** -```lua -local numReagents = GetTradeSkillNumReagents(id); -local totalReagents = 0; -for i=1, numReagents, 1 do - local reagentName, reagentTexture, reagentCount, playerReagentCount = GetTradeSkillReagentInfo(id, i); - totalReagents = totalReagents + reagentCount; -end; -``` - -**Miscellaneous:** -- **Result:** - - Calculates the total number of items required by the recipe. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillReagentItemLink.md b/wiki-information/functions/GetTradeSkillReagentItemLink.md deleted file mode 100644 index 1ffe0bcb..00000000 --- a/wiki-information/functions/GetTradeSkillReagentItemLink.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: GetTradeSkillReagentItemLink - -**Content:** -Gets the link string for a trade skill reagent. -`link = GetTradeSkillReagentItemLink(skillId, reagentId)` - -**Parameters:** -- `skillId` - - *number* - The Id specifying which trade skill's reagent to link. -- `reagentId` - - *number* - The Id specifying which of the skill's reagents to link. - -**Returns:** -- `link` - - *string* - An item link string (color coded with href) which can be included in chat messages to represent the reagent required for the trade skill. - -**Description:** -This function is broken on 5.2.0 build 16650 and always returns nil. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillRecipeLink.md b/wiki-information/functions/GetTradeSkillRecipeLink.md deleted file mode 100644 index 9f5f16c8..00000000 --- a/wiki-information/functions/GetTradeSkillRecipeLink.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GetTradeSkillRecipeLink - -**Content:** -Returns the EnchantLink for a trade skill. -`link = GetTradeSkillRecipeLink(index)` - -**Parameters:** -- `index` - - *number* - The row of the tradeskill listbox containing the item. The indices include the category headers. The tradeskill window doesn't have to be open, but the tradeskill and indices reflect the last state of the tradeskill window. The indices change if you expand or collapse headings (i.e. they exactly reflect the line number of the item as it is currently displayed in the tradeskill window). - -**Returns:** -- `link` - - *string* - An EnchantLink (color coded with href) which can be included in chat messages to show the reagents and the items the trade skill creates. - -**Usage:** -Trade Blacksmithing: (window is open, all categories shown) -- **Index** | **Name** -- 1 | - Daggers -- 2 | Deadly Bronze Poniard -- 3 | Pearl-handled Dagger -- 4 | Big Bronze Knife -- 5 | - One-Handed Axes - -Trade Blacksmithing: (window is open, only trade items are shown) -- **Index** | **Name** -- 1 | - Trade Items -- 2 | Elemental Sharpening Stone -- 3 | Thorium Shield Spike \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillSelectionIndex.md b/wiki-information/functions/GetTradeSkillSelectionIndex.md deleted file mode 100644 index 2c9cf339..00000000 --- a/wiki-information/functions/GetTradeSkillSelectionIndex.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetTradeSkillSelectionIndex - -**Content:** -Returns the index of the currently selected trade skill. -`local tradeSkillIndex = GetTradeSkillSelectionIndex()` - -**Returns:** -- `tradeSkillIndex` - - *number* - The index of the currently selected trade skill, or 0 if none selected. - -**Usage:** -```lua -if ( GetTradeSkillSelectionIndex() > 1 ) then - TradeSkillFrame_SetSelection(GetTradeSkillSelectionIndex()); -else - if ( GetNumTradeSkills() > 0 ) then - TradeSkillFrame_SetSelection(GetFirstTradeSkill()); - end; -end; -``` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeSkillSubClassFilter.md b/wiki-information/functions/GetTradeSkillSubClassFilter.md deleted file mode 100644 index a895444d..00000000 --- a/wiki-information/functions/GetTradeSkillSubClassFilter.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: GetTradeSkillSubClassFilter - -**Content:** -`isVisible = GetTradeSkillSubClassFilter(filterIndex)` - -**Returns:** -- `isVisible` - - *boolean* - Whether items corresponding to `filterIndex` are visible (1) or not (nil). - -**Reference:** -- `SetTradeSkillSubClassFilter` \ No newline at end of file diff --git a/wiki-information/functions/GetTradeTargetItemInfo.md b/wiki-information/functions/GetTradeTargetItemInfo.md deleted file mode 100644 index b7579019..00000000 --- a/wiki-information/functions/GetTradeTargetItemInfo.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetTradeTargetItemInfo - -**Content:** -Returns item info for the other player in the trade window. -`name, texture, quantity, quality, isUsable, enchant = GetTradeTargetItemInfo(index)` - -**Parameters:** -- `index` - - *number* - the slot (1-7) to retrieve info from - -**Returns:** -- `name` - - *string* - Name of the item -- `texture` - - *string* - Name of the item's texture -- `quantity` - - *number* - Returns how many is in the stack -- `quality` - - *number* - The item's quality (0-6) -- `isUsable` - - *number* - True if the player can use this item -- `enchant` - - *string* - enchant being applied (no trade slot) - -**Example Usage:** -This function can be used to display information about the items the other player has placed in the trade window. For instance, an addon could use this to show detailed information about the items being traded, such as their quality and usability. - -**Addons:** -Large addons like TradeSkillMaster (TSM) use this function to manage and display trade information, ensuring that users have all the necessary details about the items being traded. \ No newline at end of file diff --git a/wiki-information/functions/GetTradeskillRepeatCount.md b/wiki-information/functions/GetTradeskillRepeatCount.md deleted file mode 100644 index 9b25b414..00000000 --- a/wiki-information/functions/GetTradeskillRepeatCount.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetTradeskillRepeatCount - -**Content:** -Returns the number of times the current item is being crafted. -`local repeatCount = GetTradeskillRepeatCount()` - -**Returns:** -- `repeatCount` - - *number* - The number of times the current tradeskill item is being crafted. - -**Description:** -The repeat count is initially set by the optional repeat parameter of `DoTradeSkill`. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceAbilityReq.md b/wiki-information/functions/GetTrainerServiceAbilityReq.md deleted file mode 100644 index 8959d7c7..00000000 --- a/wiki-information/functions/GetTrainerServiceAbilityReq.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GetTrainerServiceAbilityReq - -**Content:** -Returns the name of a requirement for training a skill and if the player meets the requirement. -`ability, hasReq = GetTrainerServiceAbilityReq(trainerIndex, reqIndex)` - -**Parameters:** -- `trainerIndex` - - *number* - Index of the trainer service to retrieve information about. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) -- `reqIndex` - - *number* - Index of the requirement to retrieve information about. - -**Returns:** -- `ability` - - *string* - The name of the required ability. Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad`. -- `hasReq` - - *boolean* - Flag for if the player meets the requirement. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceDescription.md b/wiki-information/functions/GetTrainerServiceDescription.md deleted file mode 100644 index 8999a934..00000000 --- a/wiki-information/functions/GetTrainerServiceDescription.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: GetTrainerServiceDescription - -**Content:** -Returns the description of a specific trainer service. -`serviceDescription = GetTrainerServiceDescription(index)` - -**Parameters:** -- `index` - - *number* - The index of the specific trainer service. - -**Returns:** -- `serviceDescription` - - *string* - The description of a specific trainer service. Not readily available on function call, see `SpellMixin:ContinueOnSpellLoad`. - -**Usage:** -Prints the description of the trainer service with index 3, in the chat window: -```lua -print(GetTrainerServiceDescription(3)) --- Output: "Permanently enchant a weapon to often deal 20 Nature damage to an enemy damaged by your spells or struck by your melee attacks. Cannot be applied to items higher than level 136." -``` \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceItemLink.md b/wiki-information/functions/GetTrainerServiceItemLink.md deleted file mode 100644 index 0ee82399..00000000 --- a/wiki-information/functions/GetTrainerServiceItemLink.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetTrainerServiceItemLink - -**Content:** -Returns an item link for a trainer service. -`link = GetTrainerServiceItemLink(index)` - -**Parameters:** -- `index` - - *number* - Index of the trainer service to get a link for. - -**Returns:** -- `link` - - *string* : ItemLink - The item link for the given trainer service. - -**Description:** -Indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceLevelReq.md b/wiki-information/functions/GetTrainerServiceLevelReq.md deleted file mode 100644 index f7d3ead7..00000000 --- a/wiki-information/functions/GetTrainerServiceLevelReq.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetTrainerServiceLevelReq - -**Content:** -Returns the required level to learn a skill from the trainer. -`reqLevel = GetTrainerServiceLevelReq(id)` - -**Parameters:** -- `id` - - *number* - Index of the trainer service to retrieve information about. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) - -**Returns:** -- `reqLevel` - - *number* - The required level (for pet or player) to learn the skill. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceSkillLine.md b/wiki-information/functions/GetTrainerServiceSkillLine.md deleted file mode 100644 index b5af00e8..00000000 --- a/wiki-information/functions/GetTrainerServiceSkillLine.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GetTrainerServiceSkillLine - -**Content:** -Gets the name of the skill at the specified line from the current trainer. -`local skillLine = GetTrainerServiceSkillLine(index)` - -**Parameters:** -- `index` - - *number* - Index of the trainer service to get the name of. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) - -**Returns:** -- `skillLine` - - *string* - The name of the skill on the specified line. \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceSkillReq.md b/wiki-information/functions/GetTrainerServiceSkillReq.md deleted file mode 100644 index 09ce9a37..00000000 --- a/wiki-information/functions/GetTrainerServiceSkillReq.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetTrainerServiceSkillReq - -**Content:** -Returns the name of the required skill and the amount needed in that skill. -`skillName, skillLevel, hasReq = GetTrainerServiceSkillReq(index)` - -**Parameters:** -- `index` - - the number of the selection in the trainer window - -**Returns:** -- `skillName` - - The name of the skill. -- `skillLevel` - - The required level needed for the skill. -- `hasReq` - - 1 or nil. Seems to be 1 for skills that you cannot learn, nil for skills you have learned already. - -**Usage:** -```lua -local selection = GetTrainerSelectionIndex() - -local skillName, skillAmt = GetTrainerServiceSkillReq(selection) -DEFAULT_CHAT_FRAME:AddMessage('Skill Name: ' .. skillName) -DEFAULT_CHAT_FRAME:AddMessage('Skill Amount Required: ' .. skillLevel) -``` -If you had an engineering trainer open, with a skill you knew already the output would be: -``` -Skill Name: Engineering -Skill Amount Required: 375 -``` \ No newline at end of file diff --git a/wiki-information/functions/GetTrainerServiceTypeFilter.md b/wiki-information/functions/GetTrainerServiceTypeFilter.md deleted file mode 100644 index 4f7d6ff1..00000000 --- a/wiki-information/functions/GetTrainerServiceTypeFilter.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GetTrainerServiceTypeFilter - -**Content:** -Returns the status of a skill filter in the trainer window. -`status = GetTrainerServiceTypeFilter(type)` - -**Parameters:** -- `type` - - *string* - Possible values: - - `"available"` - - `"unavailable"` - - `"used"` (already known) - -**Returns:** -- `status` - - *boolean* - true if currently displaying trainer services of the specified type, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/GetUICameraInfo.md b/wiki-information/functions/GetUICameraInfo.md deleted file mode 100644 index 12888ab7..00000000 --- a/wiki-information/functions/GetUICameraInfo.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: GetUICameraInfo - -**Content:** -Needs summary. -`posX, posY, posZ, lookAtX, lookAtY, lookAtZ, animID, animVariation, animFrame, useModelCenter = GetUICameraInfo(uiCameraID)` - -**Parameters:** -- `uiCameraID` - - *number* - -**Returns:** -- `posX` - - *number* -- `posY` - - *number* -- `posZ` - - *number* -- `lookAtX` - - *number* -- `lookAtY` - - *number* -- `lookAtZ` - - *number* -- `animID` - - *number* -- `animVariation` - - *number* -- `animFrame` - - *number* -- `useModelCenter` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/GetUnitHealthModifier.md b/wiki-information/functions/GetUnitHealthModifier.md deleted file mode 100644 index 71825c99..00000000 --- a/wiki-information/functions/GetUnitHealthModifier.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetUnitHealthModifier - -**Content:** -Needs summary. -`healthMod = GetUnitHealthModifier(unit)` - -**Parameters:** -- `unit` - - *string* - UnitToken - -**Returns:** -- `healthMod` - - *number* - -**Example Usage:** -This function can be used to retrieve the health modifier for a specific unit, which can be useful in calculating the effective health of a unit after considering various buffs, debuffs, and other modifiers. - -**Addons Usage:** -Large addons like "Recount" or "Details! Damage Meter" might use this function to accurately track and display the health of units during combat, taking into account any modifiers that affect health. \ No newline at end of file diff --git a/wiki-information/functions/GetUnitMaxHealthModifier.md b/wiki-information/functions/GetUnitMaxHealthModifier.md deleted file mode 100644 index 6ece2fc2..00000000 --- a/wiki-information/functions/GetUnitMaxHealthModifier.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: GetUnitMaxHealthModifier - -**Content:** -Needs summary. -`maxhealthMod = GetUnitMaxHealthModifier(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `maxhealthMod` - - *number* - -**Example Usage:** -This function can be used to determine the maximum health modifier for a specific unit, which can be useful in scenarios where you need to calculate or display the modified maximum health of a unit in your addon. - -**Example:** -```lua -local unit = "player" -local maxHealthModifier = GetUnitMaxHealthModifier(unit) -print("The max health modifier for the player is: " .. maxHealthModifier) -``` - -**Addons:** -Large addons like **WeakAuras** and **ElvUI** might use this function to dynamically adjust health displays or to trigger specific events based on changes in a unit's maximum health. \ No newline at end of file diff --git a/wiki-information/functions/GetUnitPowerModifier.md b/wiki-information/functions/GetUnitPowerModifier.md deleted file mode 100644 index 12eb77d4..00000000 --- a/wiki-information/functions/GetUnitPowerModifier.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetUnitPowerModifier - -**Content:** -Needs summary. -`powerMod = GetUnitPowerModifier(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `powerMod` - - *number* - -**Example Usage:** -This function can be used to retrieve the power modifier for a specific unit, which can be useful in scenarios where you need to calculate the effective power of a unit after considering any modifiers. - -**Addons Usage:** -Large addons like WeakAuras might use this function to display or calculate the effective power of units in custom auras or triggers. \ No newline at end of file diff --git a/wiki-information/functions/GetUnitSpeed.md b/wiki-information/functions/GetUnitSpeed.md deleted file mode 100644 index 763210f9..00000000 --- a/wiki-information/functions/GetUnitSpeed.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: GetUnitSpeed - -**Content:** -Returns the movement speed of the unit. -`currentSpeed, runSpeed, flightSpeed, swimSpeed = GetUnitSpeed(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit to query the speed of. - -**Returns:** -- `currentSpeed` - - *number* - current movement speed in yards per second (normal running: 7; an epic ground mount: 14) -- `runSpeed` - - *number* - the maximum speed on the ground, in yards per second (including talents such as Pursuit of Justice and ground mounts) -- `flightSpeed` - - *number* - the maximum speed while flying, in yards per second (the unit needs to be on a flying mount to get the flying speed) -- `swimSpeed` - - *number* - the maximum speed while swimming, in yards per second (not tested but it should be as the flying mount) - -**Usage:** -The following snippet prints your current movement speed in percent: -```lua -/script print(string.format("Current speed: %d%%", GetUnitSpeed("player") / 7 * 100)) -``` - -**Description:** -As of 4.2, `runSpeed`, `flightSpeed`, and `swimSpeed` returns were added. It seems you can also get the target unit's speed (not tested on the opposite faction). -A constant exists: `BASE_MOVEMENT_SPEED` which is equal to 7 (as of patch 4.2). \ No newline at end of file diff --git a/wiki-information/functions/GetUnspentTalentPoints.md b/wiki-information/functions/GetUnspentTalentPoints.md deleted file mode 100644 index 47ad64cb..00000000 --- a/wiki-information/functions/GetUnspentTalentPoints.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: GetUnspentTalentPoints - -**Content:** -Returns the number of unspent talent points the player, the player's pet, or an inspected unit. -`talentPoints = GetUnspentTalentPoints(isInspected, isPet, talentGroup)` - -**Parameters:** -- `isInspected` - - *Boolean* - If true, returns the information for the inspected unit instead of the player. -- `isPet` - - *Boolean* - If true, returns the information for the pet instead of the player (only valid for hunter with a pet active). -- `talentGroup` - - *Number* - The index of the talent group (1 for primary / 2 for secondary). - -**Returns:** -- `talentPoints` - - *Number* - number of unspent talent points. - -**Usage:** -```lua --- Get the unspent talent points for player's active spec -local talentGroup = GetActiveTalentGroup(false, false) -local talentPoints = GetUnspentTalentPoints(false, false, talentGroup) -``` - -**Notes and Caveats:** -This function returns 0 if an invalid combination of parameters is used (asking for pet talent for a non-hunter, asking for isInspect when no unit was inspected). \ No newline at end of file diff --git a/wiki-information/functions/GetVehicleUIIndicator.md b/wiki-information/functions/GetVehicleUIIndicator.md deleted file mode 100644 index 98e7ef4e..00000000 --- a/wiki-information/functions/GetVehicleUIIndicator.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: GetVehicleUIIndicator - -**Content:** -Needs summary. -`backgroundTextureID, numSeatIndicators = GetVehicleUIIndicator(vehicleIndicatorID)` - -**Parameters:** -- `vehicleIndicatorID` - - *number* - -**Returns:** -- `backgroundTextureID` - - *number* : fileID -- `numSeatIndicators` - - *number* - -**Description:** -This function is used to retrieve information about the UI indicators for a vehicle in World of Warcraft. The `backgroundTextureID` is the file ID of the background texture for the vehicle UI, and `numSeatIndicators` is the number of seat indicators available for the vehicle. - -**Example Usage:** -This function can be used in custom UI addons to display vehicle information. For example, an addon could use this function to get the background texture and seat indicators for a vehicle and then display them in a custom UI frame. - -**Addons:** -Large addons like **ElvUI** and **Bartender4** might use this function to customize the vehicle UI elements, providing a more integrated and visually appealing experience for players when they are using vehicles in the game. \ No newline at end of file diff --git a/wiki-information/functions/GetVehicleUIIndicatorSeat.md b/wiki-information/functions/GetVehicleUIIndicatorSeat.md deleted file mode 100644 index 672b98f2..00000000 --- a/wiki-information/functions/GetVehicleUIIndicatorSeat.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetVehicleUIIndicatorSeat - -**Content:** -Needs summary. -`virtualSeatIndex, xPos, yPos = GetVehicleUIIndicatorSeat(vehicleIndicatorID, indicatorSeatIndex)` - -**Parameters:** -- `vehicleIndicatorID` - - *number* -- `indicatorSeatIndex` - - *number* - -**Returns:** -- `virtualSeatIndex` - - *number* -- `xPos` - - *number* -- `yPos` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/GetWatchedFactionInfo.md b/wiki-information/functions/GetWatchedFactionInfo.md deleted file mode 100644 index 00e0c4c1..00000000 --- a/wiki-information/functions/GetWatchedFactionInfo.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: GetWatchedFactionInfo - -**Content:** -Returns info for the currently watched faction. -`name, standing, min, max, value, factionID = GetWatchedFactionInfo()` - -**Returns:** -- `name` - - *string* - The name of the faction currently being watched, nil if no faction is being watched. -- `standing` - - *number* - The StandingId with the faction. -- `min` - - *number* - The minimum bound for the current standing, for instance 21000 for Revered. -- `max` - - *number* - The maximum bound for the current standing, for instance 42000 for Revered. -- `value` - - *number* - The current faction level, within the bounds. -- `factionID` - - *number* (FactionID) - Unique numeric identifier for the faction. \ No newline at end of file diff --git a/wiki-information/functions/GetWeaponEnchantInfo.md b/wiki-information/functions/GetWeaponEnchantInfo.md deleted file mode 100644 index 96e827af..00000000 --- a/wiki-information/functions/GetWeaponEnchantInfo.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: GetWeaponEnchantInfo - -**Content:** -Returns info for temporary weapon enchantments (e.g. sharpening stones). -`hasMainHandEnchant, mainHandExpiration, mainHandCharges, mainHandEnchantID, hasOffHandEnchant, offHandExpiration, offHandCharges, offHandEnchantID, hasRangedEnchant, rangedExpiration, rangedCharges, rangedEnchantID = GetWeaponEnchantInfo()` - -**Returns:** -- `hasMainHandEnchant` - - *boolean* - true if the weapon in the main hand slot has a temporary enchant, false otherwise -- `mainHandExpiration` - - *number* - time remaining for the main hand enchant, as thousandths of seconds -- `mainHandCharges` - - *number* - the number of charges remaining on the main hand enchant -- `mainHandEnchantID` - - *number* - ID of the main hand enchant (new in 6.0) -- `hasOffHandEnchant` - - *boolean* - true if the weapon in the secondary (off) hand slot has a temporary enchant, false otherwise -- `offHandExpiration` - - *number* - time remaining for the off hand enchant, as thousandths of seconds -- `offHandCharges` - - *number* - the number of charges remaining on the off hand enchant -- `offHandEnchantID` - - *number* - ID of the off hand enchant (new in 6.0) -- `hasRangedEnchant` - - *boolean* - true if the weapon in the ranged hand slot has a temporary enchant, false otherwise (only on cataclysm/4.x) -- `rangedExpiration` - - *number* - time remaining for the ranged enchant, as thousandths of seconds (only on cataclysm/4.x) -- `rangedCharges` - - *number* - the number of charges remaining on the ranged enchant (only on cataclysm/4.x) -- `rangedEnchantID` - - *number* - ID of the ranged enchant (only on cataclysm/4.x) - -**Reference:** -`UNIT_INVENTORY_CHANGED` fires when (among other things) the player's temporary enchants, and thus the return values from this function, change. \ No newline at end of file diff --git a/wiki-information/functions/GetWebTicket.md b/wiki-information/functions/GetWebTicket.md deleted file mode 100644 index 554a47b5..00000000 --- a/wiki-information/functions/GetWebTicket.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: GetWebTicket - -**Content:** -Requests updated GM ticket status information. -`GetWebTicket()` - -**Reference:** -`UPDATE_WEB_TICKET` if a ticket exists; event arguments supply ticket information. \ No newline at end of file diff --git a/wiki-information/functions/GetXPExhaustion.md b/wiki-information/functions/GetXPExhaustion.md deleted file mode 100644 index 99b461f5..00000000 --- a/wiki-information/functions/GetXPExhaustion.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GetXPExhaustion - -**Content:** -Returns the amount of current rested XP for the character. -`exhaustion = GetXPExhaustion()` - -**Returns:** -- `exhaustion` - - *number* - The exhaustion threshold. Returns nil if player is not rested. - -**Description:** -This is the total and not the amount added. For example, if this says 5000 then the next 5000 XP gained from mobs will occur at double rate. The game actually gives double XP for mobs while rested as an add on. An example, a mob worth 98 XP is killed, XP gained is 98 + 98 rested XP bonus which reduces your 5000 by 196. If you take 1/2 the number then this is the XP bonus you are eligible for. i.e., you will get +2500 rested bonus for earning 2500 XP from mobs for a total XP gain of 5000 during that time. When you hit 0 the bonus is small, for example, say you have 20 left and you kill a mob worth 98 then you get 98 + 10 rested bonus and go to the 'normal' non-rested state. So if you rest in an inn and get this up to 2 then you will receive +1 bonus XP from your next mob and not double XP from the mob. \ No newline at end of file diff --git a/wiki-information/functions/GetZonePVPInfo.md b/wiki-information/functions/GetZonePVPInfo.md deleted file mode 100644 index d4814c28..00000000 --- a/wiki-information/functions/GetZonePVPInfo.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: GetZonePVPInfo - -**Content:** -Returns PVP info for the current zone. -`pvpType, isFFA, faction = GetZonePVPInfo()` - -**Returns:** -- `pvpType` - - *string* - One of the following values: - - `"arena"` if you are in an arena - - `"friendly"` if the zone is controlled by the faction the player belongs to. - - `"contested"` if the zone is contested (PvP server only) - - `"hostile"` if the zone is controlled by the opposing faction. - - `"sanctuary"` if the zone is a sanctuary and does not allow pvp combat (2.0.x). - - `"combat"` if it is a combat zone where players are automatically flagged for PvP combat (3.0.x). Currently applies only to the Wintergrasp zone. - - `nil`, if the zone is none of the above. Happens inside instances, including battlegrounds, and on PvE servers when the zone would otherwise be `"contested"`. -- `isFFA` - - *boolean* - true if in a free-for-all arena. -- `faction` - - *string* - the name of the faction controlling the zone if `pvpType` is `"friendly"` or `"hostile"`. - -**Usage:** -```lua -local zone = GetRealZoneText().." - "..tostring(GetSubZoneText()) -local pvpType, isFFA, faction = GetZonePVPInfo() -local str -if pvpType == "friendly" or pvpType == "hostile" then - str = " is controlled by "..faction.." ("..pvpType..")" -elseif pvpType == "sanctuary" then - str = " is a PvP-free sanctuary." -elseif isFFA then - str = " is a free-for-all arena." -else - str = " is a contested zone." -end -print(zone..str) --- Example output: Stormwind City - War Room is controlled by Alliance (friendly) --- Example output: Alterac Valley - Dun Baldar Pass is a contested zone. -``` \ No newline at end of file diff --git a/wiki-information/functions/GetZoneText.md b/wiki-information/functions/GetZoneText.md deleted file mode 100644 index 20fc611d..00000000 --- a/wiki-information/functions/GetZoneText.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: GetZoneText - -**Content:** -Returns the name of the zone the player is in. -`zoneName = GetZoneText()` - -**Returns:** -- `zoneName` - - *string* - Localized zone name. - -**Description:** -The `ZONE_CHANGED_NEW_AREA` event is triggered when the main area changes (such as exiting or leaving a major city). -If you want more detail, `ZONE_CHANGED` is also triggered every time you move between sub-sections of an area, (such as going from Shattrath's center to Lower City, etc). -There is `ZONE_CHANGED_INDOORS` for specialized cases. - -**Usage:** -Returns the name of the zone the player is currently in. -```lua -/run print("Current Zone: " .. GetZoneText()) -``` - -**Reference:** -- `GetSubZoneText()` -- `GetRealZoneText()` -- `GetMinimapZoneText()` \ No newline at end of file diff --git a/wiki-information/functions/GuildControlDelRank.md b/wiki-information/functions/GuildControlDelRank.md deleted file mode 100644 index 875d2f60..00000000 --- a/wiki-information/functions/GuildControlDelRank.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GuildControlDelRank - -**Content:** -Deletes a guild rank. -`GuildControlDelRank(index)` - -**Parameters:** -- `index` - - *number* - must be between 1 and the value returned by `GuildControlGetNumRanks()`. - -**Returns:** -- `nil` - - If the rank cannot be deleted, a message will be sent to the default chat window. - -**Description:** -The index rank must be unused - no guild members may currently have that rank or any lower rank (having a higher index value). \ No newline at end of file diff --git a/wiki-information/functions/GuildControlGetRankFlags.md b/wiki-information/functions/GuildControlGetRankFlags.md deleted file mode 100644 index 62dfa2c2..00000000 --- a/wiki-information/functions/GuildControlGetRankFlags.md +++ /dev/null @@ -1,59 +0,0 @@ -## Title: GuildControlGetRankFlags - -**Content:** -Returns information about the currently selected guild rank. -```lua -guildchat_listen, guildchat_speak, officerchat_listen, officerchat_speak, promote, demote, invite_member, remove_member, set_motd, edit_public_note, view_officer_note, edit_officer_note, modify_guild_info, _, withdraw_repair, withdraw_gold, create_guild_event, authenticator, modify_bank_tabs, remove_guild_event = GuildControlGetRankFlags() -``` - -**Returns:** -If no rank has been selected via `GuildControlSetRank`, the function will return false for all flags. -- `guildchat_listen` - - *Boolean* - true if players of the rank can listen to guild chat. -- `guildchat_speak` - - *Boolean* - true if players of the rank can speak in guild chat. -- `officerchat_listen` - - *Boolean* - true if players of the rank can listen to officer chat. -- `officerchat_speak` - - *Boolean* - true if players of the rank can speak in officer chat. -- `promote` - - *Boolean* - true if players of the rank promote lower ranked players. -- `demote` - - *Boolean* - true if players of the rank demote lower ranked players. -- `invite_member` - - *Boolean* - true if players of the rank invite new players to the guild. -- `remove_member` - - *Boolean* - true if players of the rank remove players from the guild. -- `set_motd` - - *Boolean* - true if players of the rank can edit guild message of the day. -- `edit_public_note` - - *Boolean* - true if players of the rank can edit public notes. -- `view_officer_note` - - *Boolean* - true if players of the rank can view officer notes. -- `edit_officer_note` - - *Boolean* - true if players of the rank can edit officer notes. -- `modify_guild_info` - - *Boolean* - true if players of the rank modify guild information. -- `withdraw_repair` - - *Boolean* - true if players of the rank are allowed to repair using guild bank. -- `withdraw_gold` - - *Boolean* - true if players of the rank are allowed to withdraw gold from the guild bank. -- `create_guild_event` - - *Boolean* - true if players of the rank can create guild events on the calendar. -- `authenticator` - - *Boolean* - true if players must have an authenticator attached to the account to be promoted to this rank. -- `modify_bank_tabs` - - *Boolean* - true if players of the rank can change bank tab labels. -- `remove_guild_event` - - *Boolean* - true if players of the rank can remove guild events on the calendar. - -**Usage:** -```lua -local _, _, playerrank = GetGuildInfo("player") -GuildControlSetRank(playerrank + 1) -local guildchat_listen, guildchat_speak, officerchat_listen, officerchat_speak, ... = GuildControlGetRankFlags() -``` - -**Notes and Caveats:** -- The 14th return value is obsolete and should be ignored. -- "modify_bank_tabs" and "remove_guild_event" were added in Patch 4.1. Another flag, "recruitment", exists as label text for the next flag in line, but is not yet returned by this function. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlGetRankName.md b/wiki-information/functions/GuildControlGetRankName.md deleted file mode 100644 index 0179e45e..00000000 --- a/wiki-information/functions/GuildControlGetRankName.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: GuildControlGetRankName - -**Content:** -Returns a guild rank name by index. -`GuildControlGetRankName(index)` - -**Parameters:** -- `index` - - *number* - the rank index - -**Returns:** -- `rankName` - - *string* - the name of the rank at index. - -**Description:** -`index` must be between 1 and `GuildControlGetNumRanks()`. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlSaveRank.md b/wiki-information/functions/GuildControlSaveRank.md deleted file mode 100644 index 488d5af6..00000000 --- a/wiki-information/functions/GuildControlSaveRank.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: GuildControlSaveRank - -**Content:** -Saves the current rank name. -`GuildControlSaveRank(name)` - -**Parameters:** -- `name` - - *string* - the name of this rank - -**Description:** -Saves the current flags, set using `GuildControlSetRankFlag()`, to the current rank. -Entering a name different from that of the rank set with `GuildControlSetRank()` will change the name of the current rank to the entered name. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlSetRank.md b/wiki-information/functions/GuildControlSetRank.md deleted file mode 100644 index 6994f6b1..00000000 --- a/wiki-information/functions/GuildControlSetRank.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GuildControlSetRank - -**Content:** -Selects a guild rank. -`GuildControlSetRank(rankOrder)` - -**Parameters:** -- `rankOrder` - - *number* - index of the rank to select, between 1 and `GuildControlGetNumRanks()`. - -**Description:** -Calling this API sets the rank to return/edit flags for using `GuildControlGetRankFlags()` and `GuildControlSetRankFlag()`. \ No newline at end of file diff --git a/wiki-information/functions/GuildControlSetRankFlag.md b/wiki-information/functions/GuildControlSetRankFlag.md deleted file mode 100644 index 36ca446c..00000000 --- a/wiki-information/functions/GuildControlSetRankFlag.md +++ /dev/null @@ -1,86 +0,0 @@ -## Title: GuildControlSetRankFlag - -**Content:** -Sets guild rank permissions. -`GuildControlSetRankFlag(index, enabled)` - -**Parameters:** -- `index` - - *number* - the flag index, between 1 and GuildControlGetNumRanks(). -- `enabled` - - *boolean* - whether the flag is enabled or disabled. - -**Description:** -Calling this API changes the value of the current rank flags. These changes are not saved until a call to `GuildControlSaveRank()` is made. - -**Flag indices:** -- **GUILDCONTROL_OPTION** - - **Index** - - **GlobalString** - - **Name** - - **Description** - - `1` - - `GUILDCONTROL_OPTION1` - - Guildchat Listen - - `2` - - `GUILDCONTROL_OPTION2` - - Guildchat Speak - - `3` - - `GUILDCONTROL_OPTION3` - - Officerchat Listen - - `4` - - `GUILDCONTROL_OPTION4` - - Officerchat Speak - - `5` - - `GUILDCONTROL_OPTION5` - - Promote - - `6` - - `GUILDCONTROL_OPTION6` - - Demote - - `7` - - `GUILDCONTROL_OPTION7` - - Invite Member - - `8` - - `GUILDCONTROL_OPTION8` - - Remove Member - - `9` - - `GUILDCONTROL_OPTION9` - - Set MOTD - - `10` - - `GUILDCONTROL_OPTION10` - - Edit Public Note - - `11` - - `GUILDCONTROL_OPTION11` - - View Officer Note - - `12` - - `GUILDCONTROL_OPTION12` - - Edit Officer Note - - `13` - - `GUILDCONTROL_OPTION13` - - Modify Guild Info - - `14` - - `GUILDCONTROL_OPTION14` - - Create Guild Event - - `15` - - `GUILDCONTROL_OPTION15` - - Guild Bank Repair - - Use guild funds for repairs - - `16` - - `GUILDCONTROL_OPTION16` - - Withdraw Gold - - Withdraw gold from the guild bank - - `17` - - `GUILDCONTROL_OPTION17` - - Create Guild Event - - `18` - - `GUILDCONTROL_OPTION18` - - Requires Authenticator - - `19` - - `GUILDCONTROL_OPTION19` - - Modify Bank Tabs - - `20` - - `GUILDCONTROL_OPTION20` - - Remove Guild Event - - `21` - - `GUILDCONTROL_OPTION21` - - Recruitment \ No newline at end of file diff --git a/wiki-information/functions/GuildDemote.md b/wiki-information/functions/GuildDemote.md deleted file mode 100644 index dc0b2502..00000000 --- a/wiki-information/functions/GuildDemote.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GuildDemote - -**Content:** -Demotes the specified player in the guild. -`GuildDemote(playername)` - -**Parameters:** -- `playername` - - *string* - The name of the player to demote \ No newline at end of file diff --git a/wiki-information/functions/GuildDisband.md b/wiki-information/functions/GuildDisband.md deleted file mode 100644 index 2f0eca30..00000000 --- a/wiki-information/functions/GuildDisband.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GuildDisband - -**Content:** -Disbands the guild; no warning is given. -`GuildDisband()` - -**Description:** -Triggers `PLAYER_GUILD_UPDATE` if successful. -Only available to the guild leader. \ No newline at end of file diff --git a/wiki-information/functions/GuildInvite.md b/wiki-information/functions/GuildInvite.md deleted file mode 100644 index ebadbb98..00000000 --- a/wiki-information/functions/GuildInvite.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GuildInvite - -**Content:** -Invites a player to the guild. -`GuildInvite(playername)` - -**Parameters:** -- `playername` - - *string* - The name of the player to invite \ No newline at end of file diff --git a/wiki-information/functions/GuildPromote.md b/wiki-information/functions/GuildPromote.md deleted file mode 100644 index df7c2424..00000000 --- a/wiki-information/functions/GuildPromote.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GuildPromote - -**Content:** -Promotes the specified player in the guild. -`GuildPromote(playername)` - -**Parameters:** -- `playername` - - *string* - The name of the player to promote. \ No newline at end of file diff --git a/wiki-information/functions/GuildRosterSetOfficerNote.md b/wiki-information/functions/GuildRosterSetOfficerNote.md deleted file mode 100644 index 42dcdb7b..00000000 --- a/wiki-information/functions/GuildRosterSetOfficerNote.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: GuildRosterSetOfficerNote - -**Content:** -Sets the officer note of a guild member. -`GuildRosterSetOfficerNote(index, Text)` - -**Parameters:** -- `(index, "Text")` - - `index` - - The position a member is in the guild roster. This can be found by counting from the top down to the member or by selecting the member and using the `GetGuildRosterSelection()` function. - - `Text` - - Text to be set to the officer note of the index. - -**Usage:** -```lua -GuildRosterSetOfficerNote(GetGuildRosterSelection(), "My Officer Note") -``` - -**Description:** -Color can be added to public notes, officer notes, guild info, and guild MOTD using UI Escape Sequences: -```lua -GuildRosterSetOfficerNote(GetGuildRosterSelection(), "|cFFFF0000This Looks Red!") -``` -or -```lua -/script GuildRosterSetOfficerNote(GetGuildRosterSelection(), "\\124cFFFF0000This Looks Red!") -``` -for in-game text editing. \ No newline at end of file diff --git a/wiki-information/functions/GuildRosterSetPublicNote.md b/wiki-information/functions/GuildRosterSetPublicNote.md deleted file mode 100644 index b9f7f893..00000000 --- a/wiki-information/functions/GuildRosterSetPublicNote.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: GuildRosterSetPublicNote - -**Content:** -Sets the public note of a guild member. -`GuildRosterSetPublicNote(index, Text)` - -**Parameters:** -- `index` - - The position a member is in the guild roster. This can be found by counting from the top down to the member or by selecting the member and using the `GetGuildRosterSelection()` function. -- `Text` - - Text to be set to the public note of the index. - -**Usage:** -```lua -GuildRosterSetPublicNote(GetGuildRosterSelection(), "My Public Note") -``` - -**Example Use Case:** -This function can be used by guild management addons to automate the process of setting public notes for guild members. For instance, an addon could update public notes to reflect members' roles or achievements within the guild. - -**Addons Using This Function:** -Large guild management addons like "Guild Roster Manager" (GRM) use this function to allow guild officers to set and update public notes for members directly from the addon interface. This helps in maintaining organized and informative guild rosters. \ No newline at end of file diff --git a/wiki-information/functions/GuildSetLeader.md b/wiki-information/functions/GuildSetLeader.md deleted file mode 100644 index 60f1d050..00000000 --- a/wiki-information/functions/GuildSetLeader.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: GuildSetLeader - -**Content:** -Transfers guild leadership to another player. -`GuildSetLeader(name)` - -**Parameters:** -- `name` - - *string* - name of the character you wish to promote to Guild Leader. - -**Description:** -Some restrictions apply: you must be the current guild leader, the character being promoted must be in your guild, and, possibly, online. \ No newline at end of file diff --git a/wiki-information/functions/GuildSetMOTD.md b/wiki-information/functions/GuildSetMOTD.md deleted file mode 100644 index e143f17e..00000000 --- a/wiki-information/functions/GuildSetMOTD.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: GuildSetMOTD - -**Content:** -Sets the guild message of the day. -`GuildSetMOTD(message)` - -**Parameters:** -- `message` : *String* - The message to set - the message is limited to 127 characters (English client - I did not test this on other clients). - -**Example Usage:** -```lua --- Set the guild message of the day to "Welcome to the guild!" -GuildSetMOTD("Welcome to the guild!") -``` - -**Additional Information:** -This function is commonly used in guild management addons to automate or simplify the process of updating the guild message of the day. For example, an addon might use this function to set a daily tip or announcement for guild members. \ No newline at end of file diff --git a/wiki-information/functions/GuildUninvite.md b/wiki-information/functions/GuildUninvite.md deleted file mode 100644 index a7f4be47..00000000 --- a/wiki-information/functions/GuildUninvite.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: GuildUninvite - -**Content:** -Removes a player from the guild. -`GuildUninvite(name)` - -**Parameters:** -- `name` - - *string* - The name of the guild member \ No newline at end of file diff --git a/wiki-information/functions/HasAction.md b/wiki-information/functions/HasAction.md deleted file mode 100644 index 15115ad1..00000000 --- a/wiki-information/functions/HasAction.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: HasAction - -**Content:** -Returns true if an action slot is occupied. -`hasAction = HasAction(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - ActionSlot: The tested action slot. - -**Returns:** -- `hasAction` - - *boolean* - Flag - - `true`, if the slot contains an action - - `false`, if the slot is empty \ No newline at end of file diff --git a/wiki-information/functions/HasDualWieldPenalty.md b/wiki-information/functions/HasDualWieldPenalty.md deleted file mode 100644 index a4f7c2ec..00000000 --- a/wiki-information/functions/HasDualWieldPenalty.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: HasDualWieldPenalty - -**Content:** -Needs summary. -`hasPenalty = HasDualWieldPenalty()` - -**Returns:** -- `hasPenalty` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/HasFullControl.md b/wiki-information/functions/HasFullControl.md deleted file mode 100644 index d38e34bc..00000000 --- a/wiki-information/functions/HasFullControl.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: HasFullControl - -**Content:** -Checks whether you have full control over your character (i.e. you are not feared, etc). -`hasControl = HasFullControl` - -**Returns:** -- `hasControl` - - *boolean* - Whether the player has full control \ No newline at end of file diff --git a/wiki-information/functions/HasIgnoreDualWieldWeapon.md b/wiki-information/functions/HasIgnoreDualWieldWeapon.md deleted file mode 100644 index 0143e276..00000000 --- a/wiki-information/functions/HasIgnoreDualWieldWeapon.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: HasIgnoreDualWieldWeapon - -**Content:** -Needs summary. -`result = HasIgnoreDualWieldWeapon()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/HasInspectHonorData.md b/wiki-information/functions/HasInspectHonorData.md deleted file mode 100644 index 84227d3d..00000000 --- a/wiki-information/functions/HasInspectHonorData.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: HasInspectHonorData - -**Content:** -Determine if the inspected unit's honor data has been loaded. -`hasData = HasInspectHonorData()` - -**Returns:** -- `hasData` - - *boolean* - whether the currently inspected unit's honor data has been loaded. \ No newline at end of file diff --git a/wiki-information/functions/HasKey.md b/wiki-information/functions/HasKey.md deleted file mode 100644 index 3f492c7b..00000000 --- a/wiki-information/functions/HasKey.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: HasKey - -**Content:** -Returns whether or not the player has a key ring. -`hasKeyring = HasKey()` - -**Returns:** -- `hasKeyring` - - *boolean* - true if the player has a key ring, nil otherwise \ No newline at end of file diff --git a/wiki-information/functions/HasLFGRestrictions.md b/wiki-information/functions/HasLFGRestrictions.md deleted file mode 100644 index 643e4123..00000000 --- a/wiki-information/functions/HasLFGRestrictions.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: HasLFGRestrictions - -**Content:** -Returns whether the player is in a random party formed by the dungeon finder system. -`isRestricted = HasLFGRestrictions()` - -**Returns:** -- `isRestricted` - - *boolean* - 1 if the current party is subject to LFG restrictions, nil otherwise. - -**Description:** -Parties formed by the dungeon finder are restricted unless all 5 party members joined the dungeon finder as a party. -The Party Leader of such parties is referred to as "Dungeon Guide" by the default UI, and may not alter the loot system or arbitrarily remove people from the party. \ No newline at end of file diff --git a/wiki-information/functions/HasNoReleaseAura.md b/wiki-information/functions/HasNoReleaseAura.md deleted file mode 100644 index a27bb960..00000000 --- a/wiki-information/functions/HasNoReleaseAura.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: HasNoReleaseAura - -**Content:** -Needs summary. -`hasCannotReleaseEffect, longestDuration, hasUntilCancelledDuration = HasNoReleaseAura()` - -**Returns:** -- `hasCannotReleaseEffect` - - *boolean* -- `longestDuration` - - *number* -- `hasUntilCancelledDuration` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/HasPetSpells.md b/wiki-information/functions/HasPetSpells.md deleted file mode 100644 index eeb9e3a2..00000000 --- a/wiki-information/functions/HasPetSpells.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: HasPetSpells - -**Content:** -Returns the number of available abilities for the player's combat pet. -`hasPetSpells, petToken = HasPetSpells()` - -**Returns:** -- `numSpells` - - *number* - The number of pet abilities available, or nil if you do not have a pet with a spell book. -- `petToken` - - *string* - Pet type, can be "DEMON" or "PET". - -**Description:** -This `numSpells` return value is not the number that are on the pet bar, but the number of entries in the pet's spell book. \ No newline at end of file diff --git a/wiki-information/functions/HasPetUI.md b/wiki-information/functions/HasPetUI.md deleted file mode 100644 index e5ac013f..00000000 --- a/wiki-information/functions/HasPetUI.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: HasPetUI - -**Content:** -Returns true if the player currently has an active (hunter) pet out. -`hasUI, isHunterPet = HasPetUI()` - -**Returns:** -- `hasUI` - - *boolean* - True if the player has a pet User Interface, False if he does not. -- `isHunterPet` - - *boolean* - True if the pet is a hunter pet, False if it is not. - -**Usage:** -```lua -local hasUI, isHunterPet = HasPetUI(); -if hasUI then - if isHunterPet then - DoHunterPetStuff(); -- For hunters - else - DoMinionStuff(); -- For Warlock minions - end -end -``` - -**Example Use Case:** -This function can be used to determine if a player has a pet UI active and whether the pet is a hunter pet or another type of minion. This is particularly useful for addons that need to differentiate between hunter pets and other types of pets, such as warlock minions, to execute specific code based on the type of pet. - -**Addon Usage:** -Large addons like **ElvUI** and **Bartender4** use this function to manage pet action bars and pet-related UI elements. For example, ElvUI uses it to show or hide pet action bars based on whether the player has a pet out and if it is a hunter pet. \ No newline at end of file diff --git a/wiki-information/functions/HasWandEquipped.md b/wiki-information/functions/HasWandEquipped.md deleted file mode 100644 index 60343a9a..00000000 --- a/wiki-information/functions/HasWandEquipped.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: HasWandEquipped - -**Content:** -Returns true if a wand is equipped. - -**Returns:** -- `HasWandEquipped` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/InActiveBattlefield.md b/wiki-information/functions/InActiveBattlefield.md deleted file mode 100644 index 078347d0..00000000 --- a/wiki-information/functions/InActiveBattlefield.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: InActiveBattlefield - -**Content:** -Returns whether you are currently in a battleground/battlefield. -`inBattlefield = InActiveBattlefield()` - -**Returns:** -- `inBattlefield` - - *boolean* - true if the player is in an active battlefield, false otherwise. - -**Reference:** -- `IsInInstance` -- `UnitInBattleground` \ No newline at end of file diff --git a/wiki-information/functions/InCinematic.md b/wiki-information/functions/InCinematic.md deleted file mode 100644 index e097cfdf..00000000 --- a/wiki-information/functions/InCinematic.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: InCinematic - -**Content:** -Returns true during simple in-game cinematics where only the camera moves, like the race intro cinematics. -`inCinematic = InCinematic()` - -**Returns:** -- `inCinematic` - - *boolean* - -**Usage:** -Prints what type of cinematic is playing on `CINEMATIC_START`. -```lua -local function OnEvent(self, event, ...) - if InCinematic() then - print("simple cinematic") - elseif IsInCinematicScene() then - print("fancy in-game cutscene") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("CINEMATIC_START") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/functions/InCombatLockdown.md b/wiki-information/functions/InCombatLockdown.md deleted file mode 100644 index 14c8020b..00000000 --- a/wiki-information/functions/InCombatLockdown.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: InCombatLockdown - -**Content:** -Returns true if the combat lockdown restrictions are active. -`inLockdown = InCombatLockdown()` - -**Returns:** -- `inLockdown` - - *boolean* - true if lockdown restrictions are currently in effect, false otherwise. - -**Description:** -Combat lockdown begins after the `PLAYER_REGEN_DISABLED` event fires, and ends before the `PLAYER_REGEN_ENABLED` event fires. - -**Restrictions:** -While in combat: -- Programmatic modification of macros or bindings is not allowed. -- Some actions can't be performed on "Protected" frames, their parents, or any frame they are anchored to. These include, but are not restricted to: - - Hiding the frame using the `Hide` widget method. - - Showing the frame using the `Show` widget method. - - Changing the frame's attributes (custom attributes are used by Blizzard secure templates to set up their behavior). - - Moving the frame by resetting the frame's points or anchors (movements initiated by the user are still allowed while in combat). - -**Example Usage:** -This function is often used in addons to check if the player is in combat before attempting to perform actions that are restricted during combat. For instance, an addon that modifies the user interface might use `InCombatLockdown` to ensure it doesn't try to change protected frames while the player is in combat. - -**Addons Using This Function:** -Many large addons, such as ElvUI and Bartender4, use `InCombatLockdown` to manage their behavior during combat. These addons often need to modify the user interface, and they use this function to avoid performing restricted actions while the player is in combat. \ No newline at end of file diff --git a/wiki-information/functions/InRepairMode.md b/wiki-information/functions/InRepairMode.md deleted file mode 100644 index 1d246eca..00000000 --- a/wiki-information/functions/InRepairMode.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: InRepairMode - -**Content:** -Returns true if the cursor is in repair mode. -`inRepairMode = InRepairMode()` - -**Returns:** -- `inRepairMode` - - *boolean* - Returns true if the cursor is in repair mode. \ No newline at end of file diff --git a/wiki-information/functions/InboxItemCanDelete.md b/wiki-information/functions/InboxItemCanDelete.md deleted file mode 100644 index c9f2c34d..00000000 --- a/wiki-information/functions/InboxItemCanDelete.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: InboxItemCanDelete - -**Content:** -Returns true if a message can be deleted, false if it can be returned to sender. -`canDelete = InboxItemCanDelete(index)` - -**Parameters:** -- `index` - - *number* - the index of the message (1 is the first message) - -**Returns:** -- `canDelete` - - *Flag* - false if a mailed item or money is returnable, true otherwise. - -**Description:** -InboxItemCanDelete() is used by Blizzard's MailFrame.lua to determine whether a mail message is returnable, and thus whether it should put a "Return" button on the message frame or a "Delete" button. This is true when the message has been sent by the Auction House or an NPC, or has been bounced back (returned) from a player character. It will be false when it is an original message from a player character. - -This function should not be confused with whether DeleteInboxItem will succeed or not; despite its name, InboxItemCanDelete is not checking for whether you are allowed to delete a message. For safety, assume that DeleteInboxItem will succeed whenever it is passed a valid index, regardless of whether the message contains any item or money. It is Blizzard's MailFrame.lua that provides confirmation boxes for deleting messages that still have an item or money attached. \ No newline at end of file diff --git a/wiki-information/functions/InitiateRolePoll.md b/wiki-information/functions/InitiateRolePoll.md deleted file mode 100644 index c0d70688..00000000 --- a/wiki-information/functions/InitiateRolePoll.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: InitiateRolePoll - -**Content:** -Starts a role check. -`result = InitiateRolePoll()` - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -```lua --- Initiates a role poll in a group or raid -local result = InitiateRolePoll() -if result then - print("Role poll initiated successfully.") -else - print("Failed to initiate role poll.") -end -``` - -**Description:** -The `InitiateRolePoll` function is used to start a role check in a group or raid. This is typically used in dungeons or raids to ensure that all members have selected their roles (tank, healer, or damage dealer) before proceeding. This function returns a boolean value indicating whether the role poll was successfully initiated. \ No newline at end of file diff --git a/wiki-information/functions/InitiateTrade.md b/wiki-information/functions/InitiateTrade.md deleted file mode 100644 index 0c7961cd..00000000 --- a/wiki-information/functions/InitiateTrade.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: InitiateTrade - -**Content:** -Opens a trade with the specified unit. -`InitiateTrade(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The player to trade with. - -**Reference:** -- `TRADE_ACCEPT_UPDATE` -- `TRADE_CLOSED` -- `TRADE_MONEY_CHANGED` -- `TRADE_PLAYER_ITEM_CHANGED` -- `TRADE_REPLACE_ENCHANT` -- `TRADE_REQUEST` -- `TRADE_REQUEST_CANCEL` - -**Example Usage:** -```lua --- Initiates a trade with the target player -local targetUnit = "target" -InitiateTrade(targetUnit) -``` - -**Additional Information:** -This function is commonly used in addons that facilitate trading between players, such as auction house addons or inventory management addons. For example, the popular addon "TradeSkillMaster" might use this function to automate trading processes. \ No newline at end of file diff --git a/wiki-information/functions/InviteUnit.md b/wiki-information/functions/InviteUnit.md deleted file mode 100644 index d4a90aeb..00000000 --- a/wiki-information/functions/InviteUnit.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: InviteUnit - -**Content:** -Invite a player to join your party. -`InviteUnit(playerName)` - -**Parameters:** -- `playerName` - - *string* - The name of the player you would like to invite to a group. - -**Description:** -Do not prehook this function in Classic Wrath as the LFG/Group Finder uses it directly. Only Secure Hook it. - -**Reference:** -- `UninviteUnit` -- `InviteToGroup` \ No newline at end of file diff --git a/wiki-information/functions/Is64BitClient.md b/wiki-information/functions/Is64BitClient.md deleted file mode 100644 index bdd7f1e5..00000000 --- a/wiki-information/functions/Is64BitClient.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: Is64BitClient - -**Content:** -Needs summary. -`is64Bit = Is64BitClient()` - -**Returns:** -- `is64Bit` - - *boolean* - -**Example Usage:** -This function can be used to determine if the World of Warcraft client is running in a 64-bit environment. This can be useful for addons that need to optimize performance or compatibility based on the architecture of the client. - -**Example:** -```lua -if Is64BitClient() then - print("Running on a 64-bit client.") -else - print("Running on a 32-bit client.") -end -``` - -**Addons:** -Many performance-intensive addons, such as WeakAuras, might use this function to adjust their behavior based on the client's architecture to ensure optimal performance. \ No newline at end of file diff --git a/wiki-information/functions/IsAccountSecured.md b/wiki-information/functions/IsAccountSecured.md deleted file mode 100644 index be7001ea..00000000 --- a/wiki-information/functions/IsAccountSecured.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: IsAccountSecured - -**Content:** -Returns if the account has been secured with Blizzard Mobile Authenticator. -`isSecured = IsAccountSecured()` - -**Returns:** -- `isSecured` - - *boolean* - -**Reference:** -- 2018-01-16, ContainerFrame.lua, version 7.3.5.25864, near line 692, archived at Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/IsAchievementEligible.md b/wiki-information/functions/IsAchievementEligible.md deleted file mode 100644 index 7d9de2a7..00000000 --- a/wiki-information/functions/IsAchievementEligible.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: IsAchievementEligible - -**Content:** -Indicates whether the specified achievement is eligible to be completed. -`eligible = IsAchievementEligible(achievementID)` - -**Parameters:** -- `achievementID` - - *number* - ID of the achievement to query. - -**Returns:** -- `eligible` - - *boolean* - -**Description:** -This function is used in the watch frame to determine whether a tracked achievement should be shown in red text (not eligible) or normal colors (eligible). \ No newline at end of file diff --git a/wiki-information/functions/IsActionInRange.md b/wiki-information/functions/IsActionInRange.md deleted file mode 100644 index 177a3e06..00000000 --- a/wiki-information/functions/IsActionInRange.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: IsActionInRange - -**Content:** -Returns true if the specified action is in range. -`inRange = IsActionInRange(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - The action slot to test. - -**Returns:** -- `inRange` - - *boolean* - `nil` if the slot has no action, or if the action cannot be used on the current target, or if range does not apply; `false` if the action is out of range, and `true` otherwise. - -**Reference:** -- `IsSpellInRange` -- `IsItemInRange` -- `CheckInteractDistance` -- `ActionHasRange` - -**Example Usage:** -This function can be used in macros or addons to determine if a specific action (like a spell or ability) can be used on the current target. For instance, an addon could use this to display a warning if the player is out of range for their primary attack. - -**Addons:** -Many combat-related addons, such as WeakAuras and Bartender4, use this function to provide feedback on action availability and range. For example, WeakAuras might use it to trigger visual alerts when an ability is out of range. \ No newline at end of file diff --git a/wiki-information/functions/IsActiveBattlefieldArena.md b/wiki-information/functions/IsActiveBattlefieldArena.md deleted file mode 100644 index f8b8b510..00000000 --- a/wiki-information/functions/IsActiveBattlefieldArena.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: IsActiveBattlefieldArena - -**Content:** -Returns true if the player is inside a (rated) arena. -`isArena, isRegistered = IsActiveBattlefieldArena()` - -**Returns:** -- `isArena` - - *boolean* - If the player is inside an arena. -- `isRegistered` - - *boolean* - If the player is playing a rated arena match. - -**Description:** -If you are in the waiting room and/or countdown is going on, it will return false. \ No newline at end of file diff --git a/wiki-information/functions/IsAddOnLoadOnDemand.md b/wiki-information/functions/IsAddOnLoadOnDemand.md deleted file mode 100644 index e34d6751..00000000 --- a/wiki-information/functions/IsAddOnLoadOnDemand.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: IsAddOnLoadOnDemand - -**Content:** -Returns true if the specified addon is load-on-demand. -`loadDemand = IsAddOnLoadOnDemand(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `loadDemand` - - *boolean* - True if the specified addon is loaded on demand. - -**Usage:** -Loads every LoD addon. -```lua -for i = 1, GetNumAddOns() do - if IsAddOnLoadOnDemand(i) then - LoadAddOn(i) - end -end -``` \ No newline at end of file diff --git a/wiki-information/functions/IsAddOnLoaded.md b/wiki-information/functions/IsAddOnLoaded.md deleted file mode 100644 index fbfc5be4..00000000 --- a/wiki-information/functions/IsAddOnLoaded.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsAddOnLoaded - -**Content:** -Returns true if the specified addon is loaded. -`loaded, finished = IsAddOnLoaded(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `loaded` - - *boolean* - True if the addon has been, or is being loaded. -- `finished` - - *boolean* - True if the addon has finished loading and ADDON_LOADED has been fired for this addon. \ No newline at end of file diff --git a/wiki-information/functions/IsAllowedToUserTeleport.md b/wiki-information/functions/IsAllowedToUserTeleport.md deleted file mode 100644 index 2d88e07e..00000000 --- a/wiki-information/functions/IsAllowedToUserTeleport.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsAllowedToUserTeleport - -**Content:** -Returns whether the player can teleport to/from an LFG instance. -`allowedToTeleport = IsAllowedToUserTeleport()` - -**Returns:** -- `allowedToTeleport` - - *boolean* - true if the player can teleport to/from an LFG instance, false otherwise. - -**Description:** -The player cannot teleport out of the solo scenarios introduced in Patch 5.2. - -**Reference:** -LFGTeleport \ No newline at end of file diff --git a/wiki-information/functions/IsAltKeyDown.md b/wiki-information/functions/IsAltKeyDown.md deleted file mode 100644 index e8c87cd7..00000000 --- a/wiki-information/functions/IsAltKeyDown.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/functions/IsAttackAction.md b/wiki-information/functions/IsAttackAction.md deleted file mode 100644 index 96cb425e..00000000 --- a/wiki-information/functions/IsAttackAction.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsAttackAction - -**Content:** -Returns true if an action is the "Auto Attack" action. -`isAttack = IsAttackAction(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - The action slot to test. - -**Returns:** -- `isAttack` - - *Flag* - `nil` if the specified slot is not an attack action, or is empty. `1` if the slot is an attack action and should flash red during combat. \ No newline at end of file diff --git a/wiki-information/functions/IsAttackSpell.md b/wiki-information/functions/IsAttackSpell.md deleted file mode 100644 index c9e78eb5..00000000 --- a/wiki-information/functions/IsAttackSpell.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsAttackSpell - -**Content:** -Returns true if a spellbook item is the "Auto Attack" spell. -`isAttack = IsAttackSpell(spellName)` - -**Parameters:** -- `spellName` - - *string* - The spell name to test. - -**Returns:** -- `isAttack` - - *Flag* - Returns 1 if the spell is the "Attack" spell, nil otherwise \ No newline at end of file diff --git a/wiki-information/functions/IsAutoRepeatAction.md b/wiki-information/functions/IsAutoRepeatAction.md deleted file mode 100644 index 400d30aa..00000000 --- a/wiki-information/functions/IsAutoRepeatAction.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: IsAutoRepeatAction - -**Content:** -Returns true if an action is currently auto-repeating (e.g. Shoot for wand and Auto Shot for Hunters). -`isRepeating = IsAutoRepeatAction(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - The action slot to query. - -**Returns:** -- `isRepeating` - - *boolean* - true if the action in the slot is currently auto-repeating, false if it is not auto-repeating or the slot is empty. - -**Reference:** -- `IsAutoRepeatSpell` - -**Example Usage:** -This function can be used to check if a Hunter's Auto Shot or a Mage's wand attack is currently active. For instance, an addon could use this to display an indicator when auto-repeating actions are active. - -**Addon Usage:** -Large addons like WeakAuras might use this function to create custom alerts or visual effects when auto-repeating actions are active, enhancing the player's awareness during combat. \ No newline at end of file diff --git a/wiki-information/functions/IsBattlePayItem.md b/wiki-information/functions/IsBattlePayItem.md deleted file mode 100644 index 1c117a69..00000000 --- a/wiki-information/functions/IsBattlePayItem.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsBattlePayItem - -**Content:** -Returns whether an item was purchased from the in-game store. -`isPayItem = IsBattlePayItem(bag, slot)` - -**Parameters:** -- `bag` - - *number (bagID)* - container ID, e.g. 0 for backpack. -- `slot` - - *number* - slot index within the container, ascending from 1. - -**Returns:** -- `isPayItem` - - *boolean* - true if the item was purchased from the in-game store, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsCemeterySelectionAvailable.md b/wiki-information/functions/IsCemeterySelectionAvailable.md deleted file mode 100644 index a5b4f80b..00000000 --- a/wiki-information/functions/IsCemeterySelectionAvailable.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsCemeterySelectionAvailable - -**Content:** -Needs summary. -`result = IsCemeterySelectionAvailable()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsConsumableAction.md b/wiki-information/functions/IsConsumableAction.md deleted file mode 100644 index 8bf83ecf..00000000 --- a/wiki-information/functions/IsConsumableAction.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: IsConsumableAction - -**Content:** -Returns true if an action is a consumable, i.e. it has a count. -`isTrue = IsConsumableAction(slotID)` - -**Parameters:** -- `slotID` - - *ActionSlot* - The tested action slot. - -**Returns:** -- `isTrue` - - *Boolean* - True if the action in the specified slot is linked to a consumable, e.g. a potion action. False if the action is not consumable or if the action is empty. - -**Description:** -Most consumable actions have a small number displayed in the bottom right corner of their action icon. -However, in Classic, spells requiring a reagent may return true to `IsConsumableAction()` but false to both `IsItemAction` and `IsStackableAction`; such spells do not display a number. - -**Details:** -Currently, thrown weapons show up with a count of 1. In WoW 2.0, throwing weapons have durability and can be repaired, so this is likely a bug. \ No newline at end of file diff --git a/wiki-information/functions/IsConsumableItem.md b/wiki-information/functions/IsConsumableItem.md deleted file mode 100644 index 01cedfcc..00000000 --- a/wiki-information/functions/IsConsumableItem.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsConsumableItem - -**Content:** -Returns whether an item is consumed when used. -`isConsumable = IsConsumableItem(itemID or itemLink or itemName)` - -**Parameters:** -- `item` - - *Mixed* - An item ID (number), item link, or item name (string) to query. - -**Returns:** -- `isConsumable` - - *boolean* - 1 if the item is consumed when used, nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsControlKeyDown.md b/wiki-information/functions/IsControlKeyDown.md deleted file mode 100644 index 67a6196b..00000000 --- a/wiki-information/functions/IsControlKeyDown.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -Related Events: -- `MODIFIER_STATE_CHANGED` - -Related API: -- `IsModifiedClick` -- `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/functions/IsCurrentAction.md b/wiki-information/functions/IsCurrentAction.md deleted file mode 100644 index 17cadce8..00000000 --- a/wiki-information/functions/IsCurrentAction.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: IsCurrentAction - -**Content:** -Returns true if the specified action is currently being used. -`isCurrent = IsCurrentAction(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - action slot ID to query. - -**Returns:** -- `isCurrent` - - *boolean* - 1 if the action in the slot is currently executing, nil otherwise. - -**Example Usage:** -This function can be used to check if a specific action (like a spell or ability) is currently being executed by the player. For instance, it can be useful in creating custom action bar addons to highlight or indicate the currently active action. - -**Addon Usage:** -Many action bar addons, such as Bartender4 and Dominos, use this function to manage and display the state of action buttons, ensuring that the user interface accurately reflects the player's current actions. \ No newline at end of file diff --git a/wiki-information/functions/IsCurrentSpell.md b/wiki-information/functions/IsCurrentSpell.md deleted file mode 100644 index b88fd558..00000000 --- a/wiki-information/functions/IsCurrentSpell.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: IsCurrentSpell - -**Content:** -Returns true if the specified spell ID is currently being casted or queued. -If the spell is current, then the action bar indicates its slot with a highlighted frame. -`isCurrent = IsCurrentSpell(spellID)` - -**Parameters:** -- `spellID` - - *number* - spell ID to query. - -**Returns:** -- `isCurrent` - - *boolean* - true if currently being casted or queued, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsDebugBuild.md b/wiki-information/functions/IsDebugBuild.md deleted file mode 100644 index f0d7d5d4..00000000 --- a/wiki-information/functions/IsDebugBuild.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsDebugBuild - -**Content:** -Needs summary. -`isDebugBuild = IsDebugBuild()` - -**Returns:** -- `isDebugBuild` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsDualWielding.md b/wiki-information/functions/IsDualWielding.md deleted file mode 100644 index 1960e94c..00000000 --- a/wiki-information/functions/IsDualWielding.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsDualWielding - -**Content:** -Returns if your character is Dual wielding. -`isDualWield = IsDualWielding()` - -**Returns:** -- `isDualWield` - - *boolean* - True if wielding more than 1 weapon (or whenever a weapon is equipped in Off-Hand), false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsEquippableItem.md b/wiki-information/functions/IsEquippableItem.md deleted file mode 100644 index 41c1cbed..00000000 --- a/wiki-information/functions/IsEquippableItem.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: IsEquippableItem - -**Content:** -Returns true if an item is equipable by the player. -`result = IsEquippableItem(itemId or itemName or itemLink)` - -**Parameters:** -- `(itemId or "itemName" or "itemLink")` - - `itemId` - - *number* - The numeric ID of the item. e.g., 12345 - - `itemName` - - *string* - The Name of the Item, e.g., "Heavy Silk Bandage" - - `itemLink` - - *string* - The itemLink, when Shift-Clicking items. - -**Returns:** -- `result` - - 1 if equip-able, nil otherwise. - -**Usage:** -On a Druid: -```lua -/dump IsEquippableItem("Heavy Silk Bandage") -1 -/dump IsEquippableItem("Moonkin Form") -1 -/dump IsEquippableItem("Some Non-Equipable Item") -nil -``` - -**Example Use Case:** -This function can be used in an addon to filter out items that the player cannot equip, which is useful for inventory management addons or loot distribution systems. - -**Addons Using This Function:** -- **Bagnon**: A popular inventory management addon that uses this function to determine which items can be equipped by the player, helping to organize the player's bags more efficiently. -- **Pawn**: An addon that helps players decide which gear is better for their character. It uses this function to ensure that only equippable items are considered in its calculations. \ No newline at end of file diff --git a/wiki-information/functions/IsEquippedAction.md b/wiki-information/functions/IsEquippedAction.md deleted file mode 100644 index 19ffa4e5..00000000 --- a/wiki-information/functions/IsEquippedAction.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsEquippedAction - -**Content:** -Returns true if the specified action slot is an equipped item. -`isEquipped = IsEquippedAction(slotID)` - -**Parameters:** -- `slotID` - - *number (actionSlot)* - Action slot to query. - -**Returns:** -- `isEquipped` - - *boolean* - true if the specified action slot contains a currently equipped item, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsEquippedItem.md b/wiki-information/functions/IsEquippedItem.md deleted file mode 100644 index 3efbc8b2..00000000 --- a/wiki-information/functions/IsEquippedItem.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsEquippedItem - -**Content:** -Determines if an item is equipped. -`isEquipped = IsEquippedItem(itemID or itemName)` - -**Parameters:** -- `itemId` - - *number* - identifier for each unique item -- `itemname` - - *string* - localized name of an item - -**Returns:** -- `isEquipped` - - *boolean* - is item equipped \ No newline at end of file diff --git a/wiki-information/functions/IsEquippedItemType.md b/wiki-information/functions/IsEquippedItemType.md deleted file mode 100644 index 0401daa4..00000000 --- a/wiki-information/functions/IsEquippedItemType.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: IsEquippedItemType - -**Content:** -Returns true if an item of a given type is equipped. -`isEquipped = IsEquippedItemType(type)` - -**Parameters:** -- `type` - - *string (ItemType)* - any valid inventory type, item class, or item subclass - -**Returns:** -- `isEquipped` - - *boolean* - is an item of the given type equipped - -**Usage:** -```lua -if IsEquippedItemType("Shields") then - DEFAULT_CHAT_FRAME:AddMessage("I have a shield") -end -``` -**Result:** -Outputs "I have a shield" to the default chat window if the player has a shield equipped. \ No newline at end of file diff --git a/wiki-information/functions/IsEuropeanNumbers.md b/wiki-information/functions/IsEuropeanNumbers.md deleted file mode 100644 index 3e2be4b9..00000000 --- a/wiki-information/functions/IsEuropeanNumbers.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsEuropeanNumbers - -**Content:** -Needs summary. -`enabled = IsEuropeanNumbers()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsExpansionTrial.md b/wiki-information/functions/IsExpansionTrial.md deleted file mode 100644 index 82f7157e..00000000 --- a/wiki-information/functions/IsExpansionTrial.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsExpansionTrial - -**Content:** -Needs summary. -`isExpansionTrialAccount = IsExpansionTrial()` - -**Returns:** -- `isExpansionTrialAccount` - - *boolean* - -**Example Usage:** -This function can be used to check if the current account is an expansion trial account. This might be useful for addons that need to adjust their functionality based on the type of account being used. - -**Addons:** -Many large addons, such as ElvUI or WeakAuras, might use this function to tailor their features or display certain messages based on whether the user is on an expansion trial account. \ No newline at end of file diff --git a/wiki-information/functions/IsFactionInactive.md b/wiki-information/functions/IsFactionInactive.md deleted file mode 100644 index bb77c1b6..00000000 --- a/wiki-information/functions/IsFactionInactive.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: IsFactionInactive - -**Content:** -Returns true if the specified faction is marked inactive. -`inactive = IsFactionInactive(index)` - -**Parameters:** -- `index` - - *number* - index of the faction within the faction list, ascending from 1. - -**Returns:** -- `inactive` - - *boolean* - 1 if the faction is flagged as inactive, nil otherwise. - -**Reference:** -- `SetFactionInactive` -- `SetFactionActive` \ No newline at end of file diff --git a/wiki-information/functions/IsFalling.md b/wiki-information/functions/IsFalling.md deleted file mode 100644 index 635f8952..00000000 --- a/wiki-information/functions/IsFalling.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsFalling - -**Content:** -Returns true if the specified unit is currently falling. -`falling = IsFalling()` - -**Parameters:** -- `unit` - - *string?* : UnitToken - A unitID to query. Defaults to player if omitted. - -**Returns:** -- `falling` - - *boolean* - true if the unit is currently falling, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsFishingLoot.md b/wiki-information/functions/IsFishingLoot.md deleted file mode 100644 index 3a41e812..00000000 --- a/wiki-information/functions/IsFishingLoot.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: IsFishingLoot - -**Content:** -This function is only for determining if the loot window is related to fishing. - -**Returns:** -- `isTrue` - - *boolean* - is it true - -**Usage:** -This will identify that the loot window should display the fish graphic, then play the sound and update the image. -```lua -if IsFishingLoot() then - PlaySound("FISHING REEL IN") - LootFramePortraitOverlay:SetTexture("Interface\\LootFrame\\FishingLoot-Icon") -end -``` - -**Example Use Case:** -- **Fishing Addons:** Many fishing-related addons, such as Fishing Buddy, use this function to customize the loot window when the player is fishing. This enhances the user experience by providing visual and audio feedback specific to fishing activities. \ No newline at end of file diff --git a/wiki-information/functions/IsFlyableArea.md b/wiki-information/functions/IsFlyableArea.md deleted file mode 100644 index 1a67e4ea..00000000 --- a/wiki-information/functions/IsFlyableArea.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: IsFlyableArea - -**Content:** -Returns true if the current zone is a flyable area. -`flyable = IsFlyableArea()` - -**Returns:** -- `flyable` - - *boolean* - -**Description:** -This function corresponds to the flyable macro conditional. -This function will return false if the player is located in an indoors area where mounts typically cannot be used. - -**Reference:** -- `IsAdvancedFlyableArea()` \ No newline at end of file diff --git a/wiki-information/functions/IsFlying.md b/wiki-information/functions/IsFlying.md deleted file mode 100644 index a16aa3e1..00000000 --- a/wiki-information/functions/IsFlying.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsFlying - -**Content:** -Returns true if the character is currently on a flying mount. -`flying = IsFlying()` - -**Parameters:** -- `unit` - - *string?* : UnitToken - -**Returns:** -- `flying` - - *boolean* - True if the character is currently flying, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsGMClient.md b/wiki-information/functions/IsGMClient.md deleted file mode 100644 index a2c96021..00000000 --- a/wiki-information/functions/IsGMClient.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsGMClient - -**Content:** -Returns true if the client downloaded has the GM MPQs attached, returns false otherwise. -`isGM = IsGMClient()` - -**Returns:** -- `isGM` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsGUIDInGroup.md b/wiki-information/functions/IsGUIDInGroup.md deleted file mode 100644 index 4787b853..00000000 --- a/wiki-information/functions/IsGUIDInGroup.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: IsGUIDInGroup - -**Content:** -Returns whether or not the unit with the given GUID is in your group. -`inGroup = IsGUIDInGroup(UnitGUID, )` - -**Parameters:** -- `guid` - - *string* : WOWGUID -- `groupType` - - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. - - **Value** - - **Enum** - - **Description** - - `1` - - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. - - `2` - - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder - -**Returns:** -- `inGroup` - - *bool* - True if the given GUID is in your group, considering groupType if provided, otherwise false. - -**Description:** -- **Related API** - - `UnitGUID` -- **Related Event** - - `GROUP_ROSTER_UPDATE` \ No newline at end of file diff --git a/wiki-information/functions/IsGuildLeader.md b/wiki-information/functions/IsGuildLeader.md deleted file mode 100644 index 4c3b2777..00000000 --- a/wiki-information/functions/IsGuildLeader.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsGuildLeader - -**Content:** -Returns true if the player is the guild master. -`isGuildLeader = IsGuildLeader()` - -**Returns:** -- `isGuildLeader` - - *boolean* - true if the player is the guild master, otherwise false. \ No newline at end of file diff --git a/wiki-information/functions/IsInCinematicScene.md b/wiki-information/functions/IsInCinematicScene.md deleted file mode 100644 index 84bab990..00000000 --- a/wiki-information/functions/IsInCinematicScene.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: IsInCinematicScene - -**Content:** -Returns true during in-game cinematics/cutscenes involving NPC actors and scenescripts. -`inCinematicScene = IsInCinematicScene()` - -**Returns:** -- `inCinematicScene` - - *boolean* - -**Usage:** -Prints what type of cinematic is playing on `CINEMATIC_START`. -```lua -local function OnEvent(self, event, ...) - if InCinematic() then - print("simple cinematic") - elseif IsInCinematicScene() then - print("fancy in-game cutscene") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("CINEMATIC_START") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/functions/IsInGroup.md b/wiki-information/functions/IsInGroup.md deleted file mode 100644 index c6f777f3..00000000 --- a/wiki-information/functions/IsInGroup.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: IsInGroup - -**Content:** -Returns true if the player is in a group. -`inGroup = IsInGroup()` - -**Parameters:** -- `groupType` - - *number?* - If omitted, checks if you're in any type of group. - - If omitted, defaults to INSTANCE if applicable, HOME otherwise. - - **Value** - - **Enum** - - **Description** - - `1` - - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. - - `2` - - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder - -**Returns:** -- `inGroup` - - *boolean* - Returns true if the player is in the `groupType` group if specified, or in any type of group. - -**Description:** -It is possible for a character to belong to a home group at the same time they are in an instance group (LFR or Flex). To distinguish between a party and a raid, use `IsInRaid()`. \ No newline at end of file diff --git a/wiki-information/functions/IsInGuild.md b/wiki-information/functions/IsInGuild.md deleted file mode 100644 index bebee865..00000000 --- a/wiki-information/functions/IsInGuild.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: IsInGuild - -**Content:** -Lets you know whether you are in a guild. -`inGuild = IsInGuild()` - -**Returns:** -- `inGuild` - - *boolean* - -**Usage:** -```lua -if IsInGuild() then - SendChatMessage("Hi Guild!", "GUILD") -end -``` - -**Example Use Case:** -This function can be used to check if the player is currently in a guild before performing guild-specific actions, such as sending a message to the guild chat. - -**Addons Using This Function:** -Many addons that provide guild management features or enhance guild communication, such as "Guild Roster Manager" or "GreenWall," use this function to ensure that the player is in a guild before executing guild-related functionalities. \ No newline at end of file diff --git a/wiki-information/functions/IsInGuildGroup.md b/wiki-information/functions/IsInGuildGroup.md deleted file mode 100644 index 3680c320..00000000 --- a/wiki-information/functions/IsInGuildGroup.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: IsInGuildGroup - -**Content:** -Returns whether or not you are in a guild party. -`inGuildGroup = IsInGuildGroup()` - -**Parameters:** -None - -**Returns:** -- `inGuildGroup` - - *boolean* - True if you are in a valid guild group, otherwise false. \ No newline at end of file diff --git a/wiki-information/functions/IsInInstance.md b/wiki-information/functions/IsInInstance.md deleted file mode 100644 index 099b0aa7..00000000 --- a/wiki-information/functions/IsInInstance.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: IsInInstance - -**Content:** -Returns true if the player is in an instance, and the type of instance. -`inInstance, instanceType = IsInInstance()` - -**Returns:** -- `inInstance` - - *boolean* - Whether the player is in an instance; nil otherwise. -- `instanceType` - - *string* - The instance type: - - `"none"` when outside an instance - - `"pvp"` when in a battleground - - `"arena"` when in an arena - - `"party"` when in a 5-man instance - - `"raid"` when in a raid instance - - `"scenario"` when in a scenario - -**Description:** -This function returns correct results immediately upon `PLAYER_ENTERING_WORLD`. \ No newline at end of file diff --git a/wiki-information/functions/IsInLFGDungeon.md b/wiki-information/functions/IsInLFGDungeon.md deleted file mode 100644 index 12f9ff4f..00000000 --- a/wiki-information/functions/IsInLFGDungeon.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsInLFGDungeon - -**Miscellaneous:** -Returns true if the player is in an LFD instance. -`isInLFDInstance = IsInLFGDungeon()` - -**Returns:** -- `isInLFDInstance` - - *boolean* - Whether the player is in a LFD instance; nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsInRaid.md b/wiki-information/functions/IsInRaid.md deleted file mode 100644 index bc78c52a..00000000 --- a/wiki-information/functions/IsInRaid.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: IsInRaid - -**Content:** -Returns true if the player is in a raid. -`isInRaid = IsInRaid()` - -**Parameters:** -- `groupType` - - *number?* - To check for a specific type of group, provide one of: - - `LE_PARTY_CATEGORY_HOME` : checks for home-realm parties. - - `LE_PARTY_CATEGORY_INSTANCE` : checks for instance-specific groups. - -**Returns:** -- `isInRaid` - - *boolean* - true if the player is currently in a `groupType` raid group (if `groupType` was not specified, true if in any type of raid), false otherwise. - -**Description:** -This returns true in arenas if `groupType` is `LE_PARTY_CATEGORY_INSTANCE` or is unspecified. \ No newline at end of file diff --git a/wiki-information/functions/IsIndoors.md b/wiki-information/functions/IsIndoors.md deleted file mode 100644 index 720310e5..00000000 --- a/wiki-information/functions/IsIndoors.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsIndoors - -**Content:** -Returns true if the character is currently indoors. -`indoors = IsIndoors()` - -**Returns:** -- `indoors` - - *boolean* - -**Description:** -This function corresponds to the indoors macro conditional. - -**Reference:** -- `IsOutdoors()` \ No newline at end of file diff --git a/wiki-information/functions/IsItemInRange.md b/wiki-information/functions/IsItemInRange.md deleted file mode 100644 index a27b75f4..00000000 --- a/wiki-information/functions/IsItemInRange.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: IsItemInRange - -**Content:** -Returns whether the item is in usable range of the unit. -`inRange = IsItemInRange(item)` - -**Parameters:** -- `item` - - *number|string* : Item ID, Link or Name - If using an item name, requires the item to be in your inventory. Item IDs and links don't have this requirement. -- `unit` - - *string?* : UnitId - Defaults to "target" - -**Returns:** -- `inRange` - - *boolean* - Whether the item is in range; Returns nil if there is no unit targeted or the item ID is invalid. - -**Usage:** -Prints if you are within 4 yards range of the target by checking the item range. -`/dump IsItemInRange(90175)` - -**Reference:** -- [DeadlyBossMods Usage](https://github.com/DeadlyBossMods/DeadlyBossMods/blob/9.0.21/DBM-Core/DBM-RangeCheck.lua#L57) \ No newline at end of file diff --git a/wiki-information/functions/IsLeftAltKeyDown.md b/wiki-information/functions/IsLeftAltKeyDown.md deleted file mode 100644 index 13bd91d9..00000000 --- a/wiki-information/functions/IsLeftAltKeyDown.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` - -**Example Use Case:** -This function can be used in macros or scripts where specific actions need to be performed only when certain modifier keys are held down. For instance, in a custom addon, you might want to trigger a special ability or open a specific interface panel only when the user holds down the control and shift keys simultaneously. - -**Addons Using This Function:** -Many large addons, such as **WeakAuras** and **ElvUI**, use this function to provide enhanced user interactions. For example, WeakAuras might use it to allow users to modify the behavior of their auras based on modifier keys, while ElvUI could use it to offer additional customization options when certain keys are pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsLeftControlKeyDown.md b/wiki-information/functions/IsLeftControlKeyDown.md deleted file mode 100644 index 5df1ce6d..00000000 --- a/wiki-information/functions/IsLeftControlKeyDown.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown()` -- `IsControlKeyDown()` -- `IsLeftControlKeyDown()` -- `IsRightControlKeyDown()` -- `IsShiftKeyDown()` -- `IsLeftShiftKeyDown()` -- `IsRightShiftKeyDown()` -- `IsAltKeyDown()` -- `IsLeftAltKeyDown()` -- `IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` - -**Example Use Case:** -This function can be used in macros or scripts to check if a modifier key (like Ctrl, Shift, or Alt) is being held down. This is useful for creating complex keybindings or conditional logic in addons. - -**Addons Using This Function:** -Many large addons, such as WeakAuras and Bartender4, use this function to provide advanced keybinding options and conditional displays based on modifier keys. For example, WeakAuras might use it to show or hide certain auras when a modifier key is pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsLeftShiftKeyDown.md b/wiki-information/functions/IsLeftShiftKeyDown.md deleted file mode 100644 index e8c87cd7..00000000 --- a/wiki-information/functions/IsLeftShiftKeyDown.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/functions/IsMacClient.md b/wiki-information/functions/IsMacClient.md deleted file mode 100644 index 14dd805a..00000000 --- a/wiki-information/functions/IsMacClient.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsMacClient - -**Content:** -Returns true if on a Mac client. -`isMac = IsMacClient()` - -**Returns:** -- `isMac` - - *boolean* - true (1?) if the game is running on a mac client, false (nil?) otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsMetaKeyDown.md b/wiki-information/functions/IsMetaKeyDown.md deleted file mode 100644 index 287dedd0..00000000 --- a/wiki-information/functions/IsMetaKeyDown.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsMetaKeyDown - -**Content:** -Needs summary. -`down = IsMetaKeyDown()` - -**Returns:** -- `down` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsModifiedClick.md b/wiki-information/functions/IsModifiedClick.md deleted file mode 100644 index e93847b8..00000000 --- a/wiki-information/functions/IsModifiedClick.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: IsModifiedClick - -**Content:** -Returns true if the modifier key needed for an action is pressed. -`isHeld = IsModifiedClick()` - -**Parameters:** -- `action` - - *string?* - The action to check for. Actions defined by Blizzard: - - `AUTOLOOTTOGGLE` - - `CHATLINK` - - `COMPAREITEMS` - - `DRESSUP` - - `FOCUSCAST` - - `OPENALLBAGS` - - `PICKUPACTION` - - `QUESTWATCHTOGGLE` - - `SELFCAST` - - `SHOWITEMFLYOUT` - - `SOCKETITEM` - - `SPLITSTACK` - - `STICKYCAMERA` - - `TOKENWATCHTOGGLE` - -**Returns:** -- `isHeld` - - *boolean* - true if the modifier is being held, false otherwise - -**Description:** -Despite the name, this function does not have anything to do with mouse buttons and can be used at any time to check the state of a modifier key; it is not limited to use in click-related scripts. -This function can be called with no argument to check whether *any* modifier key is pressed; in this case it behaves just like `IsModifierKeyDown`. - -**Reference:** -- `GetModifiedClick` -- `SetModifiedClick` -- `IsModifierKeyDown` \ No newline at end of file diff --git a/wiki-information/functions/IsModifierKeyDown.md b/wiki-information/functions/IsModifierKeyDown.md deleted file mode 100644 index fc735df0..00000000 --- a/wiki-information/functions/IsModifierKeyDown.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` - -**Example Use Case:** -This function can be used in scenarios where you need to check if a user is holding down a modifier key (like Ctrl, Shift, or Alt) to perform specific actions, such as multi-selecting items in an inventory or triggering special abilities in a game. - -**Addons Using This Function:** -Many large addons, such as ElvUI and WeakAuras, use this function to enhance user interactions. For example, ElvUI might use it to allow users to drag UI elements while holding down a modifier key, and WeakAuras could use it to display additional information or options when a modifier key is pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsMounted.md b/wiki-information/functions/IsMounted.md deleted file mode 100644 index bb193f35..00000000 --- a/wiki-information/functions/IsMounted.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsMounted - -**Content:** -Returns true if the character is currently mounted. -`mounted = IsMounted()` - -**Returns:** -- `mounted` - - *boolean* - true if the character is currently mounted \ No newline at end of file diff --git a/wiki-information/functions/IsMouseButtonDown.md b/wiki-information/functions/IsMouseButtonDown.md deleted file mode 100644 index d6f61431..00000000 --- a/wiki-information/functions/IsMouseButtonDown.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: IsMouseButtonDown - -**Content:** -Returns whether a mouse button is being held down. -`isDown = IsMouseButtonDown()` - -**Parameters:** -- `button` - - *string?* - Name of the button. If not passed, then it returns if any mouse button is pressed. - - Possible values: `LeftButton`, `RightButton`, `MiddleButton`, `Button4`, `Button5` - -**Returns:** -- `isDown` - - *boolean* - Returns whether the given mouse button is held down. \ No newline at end of file diff --git a/wiki-information/functions/IsMouselooking.md b/wiki-information/functions/IsMouselooking.md deleted file mode 100644 index 4171acae..00000000 --- a/wiki-information/functions/IsMouselooking.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: IsMouselooking - -**Content:** -Returns true if the player is currently in mouselook mode. -`IsMouselooking()` - -**Returns:** -- `isMouseLooking` - - *boolean* - -**Description:** -In 1.10, a Mouselook mode was added to the UI. \ No newline at end of file diff --git a/wiki-information/functions/IsMovieLocal.md b/wiki-information/functions/IsMovieLocal.md deleted file mode 100644 index 989a82df..00000000 --- a/wiki-information/functions/IsMovieLocal.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsMovieLocal - -**Content:** -Needs summary. -`isLocal = IsMovieLocal(movieId)` - -**Parameters:** -- `movieId` - - *number* - -**Returns:** -- `isLocal` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsMoviePlayable.md b/wiki-information/functions/IsMoviePlayable.md deleted file mode 100644 index 302512b7..00000000 --- a/wiki-information/functions/IsMoviePlayable.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: IsMoviePlayable - -**Content:** -Returns true if the specified movie exists and can be played. -`playable = IsMoviePlayable(movieID)` - -**Parameters:** -- `movieID` - - *number* - -**Returns:** -- `playable` - - *boolean* - -**Example Usage:** -```lua -local movieID = 1 -- Example movie ID -if IsMoviePlayable(movieID) then - print("The movie is playable.") -else - print("The movie is not playable.") -end -``` - -**Description:** -The `IsMoviePlayable` function is used to check if a specific in-game cinematic or movie can be played. This can be useful for addons that manage or display in-game cinematics, ensuring that the movie exists before attempting to play it. \ No newline at end of file diff --git a/wiki-information/functions/IsOnGlueScreen.md b/wiki-information/functions/IsOnGlueScreen.md deleted file mode 100644 index 0b75173a..00000000 --- a/wiki-information/functions/IsOnGlueScreen.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: IsOnGlueScreen - -**Content:** -Returns whether the game is currently showing a GlueXML screen (i.e. no character is logged in). -`isOnGlueScreen = IsOnGlueScreen()` - -**Returns:** -- `isOnGlueScreen` - - *boolean* - false if a character is logged in; true otherwise. - -**Description:** -This function will always return false if called by an AddOn -- addons only run when a character is logged in. \ No newline at end of file diff --git a/wiki-information/functions/IsOnTournamentRealm.md b/wiki-information/functions/IsOnTournamentRealm.md deleted file mode 100644 index 596ba7e0..00000000 --- a/wiki-information/functions/IsOnTournamentRealm.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsOnTournamentRealm - -**Content:** -Needs summary. -`result = IsOnTournamentRealm()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsOutOfBounds.md b/wiki-information/functions/IsOutOfBounds.md deleted file mode 100644 index 437877e8..00000000 --- a/wiki-information/functions/IsOutOfBounds.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: IsOutOfBounds - -**Content:** -Returns true if the player is currently outside of map boundaries. -`oob = IsOutOfBounds()` - -**Returns:** -- `oob` - - *boolean* - True if the player's character is currently outside of the map, false otherwise. - -**Description:** -Players may end up outside of a map's bounds (and therefore dead) both as a consequence of geometry errors and normal world design: for instance, falling off the Eye of the Storm, or being dropped off the top of Icecrown Citadel by the Lich King's val'kyrs. \ No newline at end of file diff --git a/wiki-information/functions/IsOutdoors.md b/wiki-information/functions/IsOutdoors.md deleted file mode 100644 index b4f84802..00000000 --- a/wiki-information/functions/IsOutdoors.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsOutdoors - -**Content:** -Returns true if the character is currently outdoors. -`outdoors = IsOutdoors()` - -**Returns:** -- `outdoors` - - *boolean* - -**Description:** -This function corresponds to the outdoors macro conditional. - -**Reference:** -- `IsIndoors()` \ No newline at end of file diff --git a/wiki-information/functions/IsPVPTimerRunning.md b/wiki-information/functions/IsPVPTimerRunning.md deleted file mode 100644 index 1c438a63..00000000 --- a/wiki-information/functions/IsPVPTimerRunning.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsPVPTimerRunning - -**Content:** -Needs summary. -`isRunning = IsPVPTimerRunning()` - -**Returns:** -- `isRunning` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPassiveSpell.md b/wiki-information/functions/IsPassiveSpell.md deleted file mode 100644 index bac15895..00000000 --- a/wiki-information/functions/IsPassiveSpell.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: IsPassiveSpell - -**Content:** -Returns true if the specified spell is a passive ability. -`isPassive = IsPassiveSpell(spellId or index, bookType)` - -**Parameters:** -- `spellId` - - *number* - spell ID to query. -- `index` - - *number* - spellbook slot index, ascending from 1. -- `bookType` - - *string* - Either BOOKTYPE_SPELL ("spell") or BOOKTYPE_PET ("pet"). "spell" is linked to your General Spellbook tab. - -**Returns:** -- `isPassive` - - *Flag* : 1 if the spell is passive, nil otherwise. - -**Description:** -With my Human Paladin, here are the "spells" I found to be Passive: -- Block (Passive) -- Diplomacy (Racial Passive) -- Dodge (Passive) -- Mace Specialization (Passive) -- Parry (Passive) -- Sword Specialization (Passive) -- The Human Spirit (Racial Passive) \ No newline at end of file diff --git a/wiki-information/functions/IsPetAttackActive.md b/wiki-information/functions/IsPetAttackActive.md deleted file mode 100644 index a3a88470..00000000 --- a/wiki-information/functions/IsPetAttackActive.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsPetAttackActive - -**Content:** -Returns true if the pet is currently auto attacking. -`isActive = IsPetAttackActive()` - -**Returns:** -- `isActive` - - *boolean* - true if the pet is currently auto attacking \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerAttacking.md b/wiki-information/functions/IsPlayerAttacking.md deleted file mode 100644 index 3e3edd2a..00000000 --- a/wiki-information/functions/IsPlayerAttacking.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: IsPlayerAttacking - -**Content:** -Returns if the player is melee attacking the specified unit. -`isAttacking = IsPlayerAttacking(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `isAttacking` - - *boolean* - -**Example Usage:** -This function can be used in a combat addon to check if the player is currently attacking a specific unit. For instance, it can be used to trigger certain abilities or actions only when the player is actively engaged in melee combat with a target. - -**Addon Usage:** -Large addons like "WeakAuras" might use this function to create custom triggers for auras or notifications based on whether the player is attacking a specific unit. This can help players optimize their combat performance by providing real-time feedback and alerts. \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerInGuildFromGUID.md b/wiki-information/functions/IsPlayerInGuildFromGUID.md deleted file mode 100644 index 35ef6a87..00000000 --- a/wiki-information/functions/IsPlayerInGuildFromGUID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsPlayerInGuildFromGUID - -**Content:** -Needs summary. -`IsInGuild = IsPlayerInGuildFromGUID(playerGUID)` - -**Parameters:** -- `playerGUID` - - *string* - -**Returns:** -- `IsInGuild` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerInWorld.md b/wiki-information/functions/IsPlayerInWorld.md deleted file mode 100644 index fc8e6642..00000000 --- a/wiki-information/functions/IsPlayerInWorld.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsPlayerInWorld - -**Content:** -Needs summary. -`result = IsPlayerInWorld()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerMoving.md b/wiki-information/functions/IsPlayerMoving.md deleted file mode 100644 index 5d8e3edd..00000000 --- a/wiki-information/functions/IsPlayerMoving.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsPlayerMoving - -**Content:** -Needs summary. -`result = IsPlayerMoving()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsPlayerSpell.md b/wiki-information/functions/IsPlayerSpell.md deleted file mode 100644 index bfd680f1..00000000 --- a/wiki-information/functions/IsPlayerSpell.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: IsPlayerSpell - -**Content:** -Returns whether the player has learned a particular spell. -`isKnown = IsPlayerSpell(spellID)` - -**Parameters:** -- `spellID` - - *number* - Spell ID of the spell to query, e.g. 1953 for Blink. - -**Returns:** -- `isKnown` - - *boolean* - true if the player can cast this spell (or a different spell that overrides this spell), false otherwise. - -**Description:** -Spells can be permanently or temporarily overridden by other spells as a result of procs, talents, or other spell mechanics, e.g. -- `Wrath` is overridden by `Starfire` while in Solar Eclipse. -- `Freezing Trap` replaces trap spells by ranged variants. -- `Metamorphosis` replaces a permanent base spell. -- `Demonbolt` replaces with different spells. - -Querying the base (replaced) spell will also return true if any of its overrides are currently active. -Querying an overriding spell may or may not return true even if that spell is currently known, depending on the particular spell. - -**Reference:** -- `GetSpellInfo` - -**Example Usage:** -This function can be used to check if a player has learned a specific spell before attempting to cast it or display it in a UI element. For instance, an addon could use `IsPlayerSpell` to determine if a player has learned a particular talent or ability and then update the UI accordingly. - -**Addon Usage:** -Large addons like WeakAuras use `IsPlayerSpell` to dynamically update auras and notifications based on the player's current abilities and talents. This ensures that the addon only shows relevant information and triggers for spells the player can actually use. \ No newline at end of file diff --git a/wiki-information/functions/IsPublicBuild.md b/wiki-information/functions/IsPublicBuild.md deleted file mode 100644 index 5f26830f..00000000 --- a/wiki-information/functions/IsPublicBuild.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsPublicBuild - -**Content:** -Needs summary. -`isPublicBuild = IsPublicBuild()` - -**Returns:** -- `isPublicBuild` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsQuestCompletable.md b/wiki-information/functions/IsQuestCompletable.md deleted file mode 100644 index 71314c4a..00000000 --- a/wiki-information/functions/IsQuestCompletable.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsQuestCompletable - -**Content:** -Returns true if the displayed quest at a quest giver can be completed. -`isQuestCompletable = IsQuestCompletable()` - -**Returns:** -- `isQuestCompletable` - - *boolean* - true if the quest can be completed, false otherwise. - -**Example Usage:** -This function can be used in an addon to check if the player has met all the requirements to complete a quest when interacting with a quest giver. For instance, an addon could automatically highlight the "Complete Quest" button when `IsQuestCompletable()` returns true. - -**Addons Using This Function:** -Many quest-related addons, such as Questie, use this function to determine if a quest can be completed and to provide visual cues or automated actions for the player. \ No newline at end of file diff --git a/wiki-information/functions/IsQuestComplete.md b/wiki-information/functions/IsQuestComplete.md deleted file mode 100644 index 3696aa03..00000000 --- a/wiki-information/functions/IsQuestComplete.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: IsQuestComplete - -**Content:** -Returns whether the supplied quest in the quest log is complete. -`isComplete = IsQuestComplete(questID)` - -**Parameters:** -- `questID` - - *number* - The ID of the quest. - -**Returns:** -- `isComplete` - - *boolean* - true if the quest is both in the quest log and is complete, false otherwise. - -**Description:** -This function will only return true if the questID corresponds to a quest in the player's log. If the player has already completed the quest, this will return false. -This can return true even when the "isComplete" return of `GetQuestLogTitle` returns false, if the quest in question has no objectives to complete. - -**Reference:** -- `GetQuestLogTitle` -- `IsQuestFlaggedCompleted` \ No newline at end of file diff --git a/wiki-information/functions/IsQuestHardWatched.md b/wiki-information/functions/IsQuestHardWatched.md deleted file mode 100644 index 35be80bf..00000000 --- a/wiki-information/functions/IsQuestHardWatched.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_QuestLog.GetQuestWatchType - -**Content:** -Returns the watchType associated with a given quest. -`watchType = C_QuestLog.GetQuestWatchType(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `watchType` - - *Enum.QuestWatchType?* - - `Value` - - `Field` - - `Description` - - `0` - - Automatic - - `1` - - Manual \ No newline at end of file diff --git a/wiki-information/functions/IsQuestWatched.md b/wiki-information/functions/IsQuestWatched.md deleted file mode 100644 index 35be80bf..00000000 --- a/wiki-information/functions/IsQuestWatched.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_QuestLog.GetQuestWatchType - -**Content:** -Returns the watchType associated with a given quest. -`watchType = C_QuestLog.GetQuestWatchType(questID)` - -**Parameters:** -- `questID` - - *number* - -**Returns:** -- `watchType` - - *Enum.QuestWatchType?* - - `Value` - - `Field` - - `Description` - - `0` - - Automatic - - `1` - - Manual \ No newline at end of file diff --git a/wiki-information/functions/IsRangedWeapon.md b/wiki-information/functions/IsRangedWeapon.md deleted file mode 100644 index 4c2e4bc6..00000000 --- a/wiki-information/functions/IsRangedWeapon.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsRangedWeapon - -**Content:** -Needs summary. -`isRanged = IsRangedWeapon()` - -**Returns:** -- `isRanged` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsRecognizedName.md b/wiki-information/functions/IsRecognizedName.md deleted file mode 100644 index b3cf904a..00000000 --- a/wiki-information/functions/IsRecognizedName.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title: IsRecognizedName - -**Content:** -Returns true if a given character name is recognized by the client. -`isRecognized = IsRecognizedName(text, includeBitfield, excludeBitfield)` - -**Parameters:** -- `text` - - *string* - Name of the character to test. -- `includeBitfield` - - *number* - Bitfield of filters that the name must match at least one of. -- `excludeBitfield` - - *number* - Bitfield of filters that the name must not match any of. - -**Returns:** -- `isRecognized` - - *boolean* - true if the character name is recognized by the client and passes the requested filters. - -**Miscellaneous:** -The filters used by this function are the same as the autocompletion flags used by `GetAutoCompleteResults()`. -- **AutocompleteFlag** - - **Global** - - **Value** - - **Description** - - `AUTOCOMPLETE_FLAG_NONE` - - `0x00000000` - Mask usable for including or excluding no results. - - `AUTOCOMPLETE_FLAG_IN_GROUP` - - `0x00000001` - Matches characters in your current party or raid. - - `AUTOCOMPLETE_FLAG_IN_GUILD` - - `0x00000002` - Matches characters in your current guild. - - `AUTOCOMPLETE_FLAG_FRIEND` - - `0x00000004` - Matches characters on your character-specific friends list. - - `AUTOCOMPLETE_FLAG_BNET` - - `0x00000008` - Matches characters on your Battle.net friends list. - - `AUTOCOMPLETE_FLAG_INTERACTED_WITH` - - `0x00000010` - Matches characters that the player has interacted with directly, such as exchanging whispers. - - `AUTOCOMPLETE_FLAG_ONLINE` - - `0x00000020` - Matches characters that are currently online. - - `AUTO_COMPLETE_IN_AOI` - - `0x00000040` - Matches characters in the local area of interest. - - `AUTO_COMPLETE_ACCOUNT_CHARACTER` - - `0x00000080` - Matches characters on any of the current players' Battle.net game accounts. - - `AUTOCOMPLETE_FLAG_ALL` - - `0xFFFFFFFF` - Mask usable for including or excluding all results. - -**Description:** -This function may return false for some filters if the player enters, exits, and re-enters the local area of interest of the tested character name. -When testing character names that are on the same Battle.net account, the character name must not include any realm identifier if the currently logged in character is on the same realm. - -**Reference:** -`GetAutoCompleteResults()` \ No newline at end of file diff --git a/wiki-information/functions/IsReferAFriendLinked.md b/wiki-information/functions/IsReferAFriendLinked.md deleted file mode 100644 index 27b9a0c2..00000000 --- a/wiki-information/functions/IsReferAFriendLinked.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: IsReferAFriendLinked - -**Content:** -Determines whether the given unit is linked to the player via the Recruit-A-Friend feature. -`isLinked = IsReferAFriendLinked(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `isLinked` - - *Flag* : 1 if the unit is RAF-linked to the player, nil otherwise. - -**Usage:** -```lua -function HasRecruitAFriendBonus() - local numPartyMembers = GetNumPartyMembers() - if numPartyMembers > 0 then - local memberID = 1 - while memberID <= numPartyMembers do - if GetPartyMember(memberID) == 1 then - local member = "party" .. memberID - if UnitIsVisible(member) and IsReferAFriendLinked(member) then - return true - end - end - memberID = memberID + 1 - end - end - return false -end -``` - -**Example Use Case:** -This function can be used to check if any party members are linked to the player via the Recruit-A-Friend feature, which can be useful for applying bonuses or special conditions in the game. - -**Addons:** -Large addons like "Zygor Guides" or "ElvUI" might use this function to provide additional features or bonuses to players who are linked via the Recruit-A-Friend system. For example, they might display special icons or provide additional information in the user interface to indicate the RAF status of party members. \ No newline at end of file diff --git a/wiki-information/functions/IsResting.md b/wiki-information/functions/IsResting.md deleted file mode 100644 index c4cb6129..00000000 --- a/wiki-information/functions/IsResting.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: IsResting - -**Content:** -Returns true if the character is currently resting. -`resting = IsResting()` - -**Returns:** -- `resting` - - *boolean* - Whether the player is resting. - -**Description:** -You are Resting if you are in an Inn or a Major City like Ironforge or Orgrimmar. -While resting, the player will gain XP Bonus. - -**Reference:** -- [Rested](https://wowpedia.fandom.com/wiki/Rested) -- [Resting at the Official site](https://worldofwarcraft.com) \ No newline at end of file diff --git a/wiki-information/functions/IsRestrictedAccount.md b/wiki-information/functions/IsRestrictedAccount.md deleted file mode 100644 index 8c314a90..00000000 --- a/wiki-information/functions/IsRestrictedAccount.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsRestrictedAccount - -**Content:** -Needs summary. -`result = IsRestrictedAccount()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsRightAltKeyDown.md b/wiki-information/functions/IsRightAltKeyDown.md deleted file mode 100644 index 7955181c..00000000 --- a/wiki-information/functions/IsRightAltKeyDown.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown()` -- `IsControlKeyDown()` -- `IsLeftControlKeyDown()` -- `IsRightControlKeyDown()` -- `IsShiftKeyDown()` -- `IsLeftShiftKeyDown()` -- `IsRightShiftKeyDown()` -- `IsAltKeyDown()` -- `IsLeftAltKeyDown()` -- `IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` - -**Example Use Case:** -This function can be used in addons to check if a user is holding down a specific modifier key combination, which can be useful for implementing custom keybindings or conditional behaviors based on user input. - -**Addons Using This Function:** -Many large addons, such as WeakAuras and Bartender4, use this function to provide advanced keybinding options and to allow users to create complex macros and conditional actions based on modifier keys. \ No newline at end of file diff --git a/wiki-information/functions/IsRightControlKeyDown.md b/wiki-information/functions/IsRightControlKeyDown.md deleted file mode 100644 index 4ba9da09..00000000 --- a/wiki-information/functions/IsRightControlKeyDown.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown()` -- `IsControlKeyDown()` -- `IsLeftControlKeyDown()` -- `IsRightControlKeyDown()` -- `IsShiftKeyDown()` -- `IsLeftShiftKeyDown()` -- `IsRightShiftKeyDown()` -- `IsAltKeyDown()` -- `IsLeftAltKeyDown()` -- `IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` \ No newline at end of file diff --git a/wiki-information/functions/IsRightMetaKeyDown.md b/wiki-information/functions/IsRightMetaKeyDown.md deleted file mode 100644 index 3d18b079..00000000 --- a/wiki-information/functions/IsRightMetaKeyDown.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsRightMetaKeyDown - -**Content:** -Needs summary. -`down = IsRightMetaKeyDown()` - -**Returns:** -- `down` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsRightShiftKeyDown.md b/wiki-information/functions/IsRightShiftKeyDown.md deleted file mode 100644 index 9afe55eb..00000000 --- a/wiki-information/functions/IsRightShiftKeyDown.md +++ /dev/null @@ -1,45 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown()` -- `IsControlKeyDown()` -- `IsLeftControlKeyDown()` -- `IsRightControlKeyDown()` -- `IsShiftKeyDown()` -- `IsLeftShiftKeyDown()` -- `IsRightShiftKeyDown()` -- `IsAltKeyDown()` -- `IsLeftAltKeyDown()` -- `IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -- **Related Events:** - - `MODIFIER_STATE_CHANGED` -- **Related API:** - - `IsModifiedClick` - - `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` - -**Example Use Case:** -This function can be used in addons to check if a user is holding down a specific modifier key combination, which can be useful for implementing custom keybindings or shortcuts. - -**Addons Using This Function:** -Many large addons, such as **ElvUI** and **WeakAuras**, use this function to provide enhanced user interactions and customizability by allowing users to set up actions that depend on modifier keys being pressed. \ No newline at end of file diff --git a/wiki-information/functions/IsShiftKeyDown.md b/wiki-information/functions/IsShiftKeyDown.md deleted file mode 100644 index 3dd98a9a..00000000 --- a/wiki-information/functions/IsShiftKeyDown.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: IsModifierKeyDown - -**Content:** -Returns true if a modifier key is currently pressed down. -`isDown = IsModifierKeyDown() <- IsControlKeyDown() <- IsLeftControlKeyDown() <- IsRightControlKeyDown() <- IsShiftKeyDown() <- IsLeftShiftKeyDown() <- IsRightShiftKeyDown() <- IsAltKeyDown() <- IsLeftAltKeyDown() <- IsRightAltKeyDown()` - -**Returns:** -- `isDown` - - *boolean* - True if the specified modifier key is pressed down. - -**Description:** -Related Events: -- `MODIFIER_STATE_CHANGED` - -Related API: -- `IsModifiedClick` -- `GetBindingByKey` - -**Usage:** -Prints if the left-ctrl and left-shift modifiers are pressed down. -```lua -local function OnEvent(self, event, ...) - if IsLeftControlKeyDown() and IsLeftShiftKeyDown() then - print("hello") - end -end - -local f = CreateFrame("Frame") -f:RegisterEvent("MODIFIER_STATE_CHANGED") -f:SetScript("OnEvent", OnEvent) -``` - -**Example Use Case:** -This function can be used in scenarios where you need to check if a user is holding down a modifier key (like Ctrl, Shift, or Alt) to perform specific actions, such as multi-selecting items in an inventory or triggering special abilities in a game. - -**Addons Using This Function:** -Many large addons, such as ElvUI and WeakAuras, use this function to enhance user interactions. For example, WeakAuras might use it to allow users to configure custom keybindings for displaying or hiding certain UI elements based on modifier keys. \ No newline at end of file diff --git a/wiki-information/functions/IsSpellInRange.md b/wiki-information/functions/IsSpellInRange.md deleted file mode 100644 index 96a80cc3..00000000 --- a/wiki-information/functions/IsSpellInRange.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: IsSpellInRange - -**Content:** -Returns 1 if the player is in range to use the specified spell on the target unit, 0 otherwise. -`inRange = IsSpellInRange(spellName, unit)` -`inRange = IsSpellInRange(index, bookType, unit)` - -**Parameters:** -- `spellName` - - *string* - The localized spell name. The player must know the spell. -- `unit` - - *string : UnitId* - The unit to use as a target for the spell. - -**Spellbook args:** -- `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. -- `bookType` - - *string* - BOOKTYPE_SPELL or BOOKTYPE_PET depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - -**Constant:** -- `BOOKTYPE_SPELL` - - *"spell"* - The General, Class, Specs and Professions tabs -- `BOOKTYPE_PET` - - *"pet"* - The Pet tab - -**Returns:** -- `inRange` - - *number?* - 1 if the target is in range of the spell, 0 if the target is not in range of the spell, nil if the provided arguments were invalid or inapplicable. - -**Description:** -This takes into account talents, and can be used to determine the approximate distance to your raid members. -The function returns nil if: -- The spell cannot be cast on the unit. i.e. on a friendly unit, or on a hostile unit (such as a mind-controlled raid member) -- If the unit is not 'visible' (per UnitIsVisible) or does not exist (per UnitExists) -- The current player does not know this spell (so you cannot use 'Heal' to test 40 yard range for anyone other than a priest) -- The spell can only be cast on the player (i.e. a self-buff such as or ) - -**Usage:** -```lua -if IsSpellInRange("Flash Heal", "target") == 1 then - print("target is in healing range") -else - print("cannot heal target") -end -``` \ No newline at end of file diff --git a/wiki-information/functions/IsSpellKnown.md b/wiki-information/functions/IsSpellKnown.md deleted file mode 100644 index 4c7981ea..00000000 --- a/wiki-information/functions/IsSpellKnown.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: IsSpellKnown - -**Content:** -Returns whether the player (or pet) knows the given spell. -`isKnown = IsSpellKnown(spellID)` - -**Parameters:** -- `spellID` - - *number* - the spell ID number -- `isPetSpell` - - *boolean?* - if true, will check if the currently active pet knows the spell; if false or omitted, will check if the player knows the spell - -**Returns:** -- `isKnown` - - *boolean* - whether the player (or pet) knows the given spell - -**Description:** -This function may return false when querying learned spells that are passive effects. Consider using `IsPlayerSpell` for these. -Returns false if querying a spell that has "replaced" a known spell, which returns true whether or not it's replaced (i.e. Retribution's Templar's Verdict (85256) will always be true and Final Verdict (336872) will be false whether or not you have the related legendary equipped). In these cases, use `IsSpellKnownOrOverridesKnown(spellID)` to check for spells like Final Verdict. - -**Reference:** -- `IsPlayerSpell` -- `IsSpellKnownOrOverridesKnown` \ No newline at end of file diff --git a/wiki-information/functions/IsStealthed.md b/wiki-information/functions/IsStealthed.md deleted file mode 100644 index 76b9af81..00000000 --- a/wiki-information/functions/IsStealthed.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: IsStealthed - -**Content:** -Returns true if the character is currently stealthed. -`stealthed = IsStealthed()` - -**Returns:** -- `stealthed` - - *boolean* - true if stealthed, otherwise false - -**Description:** -Stealth includes abilities like `Stealth`, `Prowl`, and `Shadowmeld`. - -**Reference:** -- `UPDATE_STEALTH` - Fires when a player enters or leaves stealth. -- Macro conditionals - `stealth` or `nostealth` may be used in macros or with a `SecureStateDriver`. \ No newline at end of file diff --git a/wiki-information/functions/IsSubmerged.md b/wiki-information/functions/IsSubmerged.md deleted file mode 100644 index 173e3165..00000000 --- a/wiki-information/functions/IsSubmerged.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: IsSubmerged - -**Content:** -Returns whether the player character is submerged in water. -`isSubmerged = IsSubmerged()` - -**Returns:** -- `isSwimming` - - *boolean* - 1 if the player is submerged, nil otherwise. - -**Description:** -This function is similar to `IsSwimming`, but also returns 1 when running at the bottom of a surface of water. -This function is available within the RestrictedEnvironment. - -**Reference:** -- `IsSwimming` -- `IsFlying` \ No newline at end of file diff --git a/wiki-information/functions/IsSwimming.md b/wiki-information/functions/IsSwimming.md deleted file mode 100644 index f28572b9..00000000 --- a/wiki-information/functions/IsSwimming.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: IsSwimming - -**Content:** -Returns true if the character is currently swimming. -`isSwimming = IsSwimming()` - -**Returns:** -- `isSwimming` - - *boolean* - 1 if the player is swimming, nil otherwise. - -**Description:** -A swimming character's movement speed is based on their swim speed (per `GetUnitSpeed`). -In some locations and when affected by certain effects, player characters can run at the bottom of the ocean/lake/etc. In those cases, the player is not considered swimming (but is still submerged per `IsSubmerged`). -This function is available within the RestrictedEnvironment. - -**Reference:** -- `IsSubmerged` -- `IsFlying` \ No newline at end of file diff --git a/wiki-information/functions/IsTargetLoose.md b/wiki-information/functions/IsTargetLoose.md deleted file mode 100644 index 79f61dae..00000000 --- a/wiki-information/functions/IsTargetLoose.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsTargetLoose - -**Content:** -Checks if the players' current target is a soft-targeted unit. -`isLoose = IsTargetLoose()` - -**Returns:** -- `isLoose` - - *boolean* - true if the current target unit is a soft-targeted unit. \ No newline at end of file diff --git a/wiki-information/functions/IsThreatWarningEnabled.md b/wiki-information/functions/IsThreatWarningEnabled.md deleted file mode 100644 index bea7523e..00000000 --- a/wiki-information/functions/IsThreatWarningEnabled.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsThreatWarningEnabled - -**Content:** -Returns true if threat warnings are currently enabled. -`enabled = IsThreatWarningEnabled()` - -**Returns:** -- `enabled` - - *boolean flag* - 1 if the warnings are enabled, nil if they are not. - -**Description:** -The warnings are controlled by the `threatWarning` CVar, which allows the player to specify in which situations the warnings should be active. This function takes into account the current situation. - -**Reference:** -ShowNumericThreat \ No newline at end of file diff --git a/wiki-information/functions/IsTitleKnown.md b/wiki-information/functions/IsTitleKnown.md deleted file mode 100644 index 491db0f1..00000000 --- a/wiki-information/functions/IsTitleKnown.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsTitleKnown - -**Content:** -Returns true if the character can use a player title. -`isKnown = IsTitleKnown(titleId)` - -**Parameters:** -- `titleId` - - *number* - Ranging from 1 to `GetNumTitles`. - -**Returns:** -- `isKnown` - - *boolean* - True if the character can use the specified player title. \ No newline at end of file diff --git a/wiki-information/functions/IsTrackedAchievement.md b/wiki-information/functions/IsTrackedAchievement.md deleted file mode 100644 index 48cc6ed3..00000000 --- a/wiki-information/functions/IsTrackedAchievement.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: IsTrackedAchievement - -**Content:** -Returns if an achievement is currently being tracked. -`tracked = GetAchievementNumCriteria(achievementID)` - -**Parameters:** -- `achievementID` - - Uniquely identifies each achievement - -**Returns:** -- `eligible` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsTradeskillTrainer.md b/wiki-information/functions/IsTradeskillTrainer.md deleted file mode 100644 index 83a61f13..00000000 --- a/wiki-information/functions/IsTradeskillTrainer.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: IsTradeskillTrainer - -**Content:** -Returns true if the training window is used for a profession trainer. -`isTradeskillTrainer = IsTradeskillTrainer()` - -**Returns:** -- `1` or `True` if the last open trainer skill list was for a trade skill (as opposed to class skills). - -**Usage:** -```lua -if (IsTradeskillTrainer()) then - message('This is a tradeskill trainer'); -end -``` - -**Example Use Case:** -This function can be used in an addon to determine if the player is interacting with a tradeskill trainer, allowing the addon to display relevant information or options specific to tradeskill training. - -**Addon Usage:** -Many large addons, such as TradeSkillMaster, use this function to enhance the user interface and provide additional functionality when interacting with tradeskill trainers. For example, TradeSkillMaster might use this function to automatically display crafting options or manage inventory related to tradeskills. \ No newline at end of file diff --git a/wiki-information/functions/IsTrainerServiceLearnSpell.md b/wiki-information/functions/IsTrainerServiceLearnSpell.md deleted file mode 100644 index 2f39d2e9..00000000 --- a/wiki-information/functions/IsTrainerServiceLearnSpell.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: IsTrainerServiceLearnSpell - -**Content:** -Returns the type of trainer spell in the trainer window. -`isLearnSpell, isPetLearnSpell = IsTrainerServiceLearnSpell(index)` - -**Parameters:** -- `index` - - *number* - The index of the spell in the trainer window. - -**Returns:** -- `isLearnSpell` - - *number* - Returns 1 if the spell is a class spell or a learnable profession spell, nil otherwise. -- `isPetLearnSpell` - - *number* - Returns 1 if a pet spell, nil otherwise. - -**Reference:** -- `GetTrainerServiceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/IsTrialAccount.md b/wiki-information/functions/IsTrialAccount.md deleted file mode 100644 index 9f2a0787..00000000 --- a/wiki-information/functions/IsTrialAccount.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsTrialAccount - -**Content:** -Returns whether the player is using a trial (free-to-play) account. -`isTrialAccount = IsTrialAccount()` - -**Returns:** -- `isTrialAccount` - - *boolean* - Returns true if on a free-to-play account \ No newline at end of file diff --git a/wiki-information/functions/IsUnitOnQuestByQuestID.md b/wiki-information/functions/IsUnitOnQuestByQuestID.md deleted file mode 100644 index a4d36587..00000000 --- a/wiki-information/functions/IsUnitOnQuestByQuestID.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: C_QuestLog.IsUnitOnQuest - -**Content:** -Returns true if the unit is on the specified quest. -`isOnQuest = C_QuestLog.IsUnitOnQuest(unit, questID)` - -**Parameters:** -- `unit` - - *string* : UnitId -- `questID` - - *number* - -**Returns:** -- `isOnQuest` - - *boolean* - -**Example Usage:** -This function can be used to check if a player or any other unit (like a party member) is currently on a specific quest. For instance, it can be useful in group questing scenarios to ensure all members are on the same quest before proceeding. - -**Addons:** -Large addons like Questie or World Quest Tracker might use this function to verify quest status for players and party members, ensuring accurate tracking and display of quest progress. \ No newline at end of file diff --git a/wiki-information/functions/IsUsableAction.md b/wiki-information/functions/IsUsableAction.md deleted file mode 100644 index a909d3dc..00000000 --- a/wiki-information/functions/IsUsableAction.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: IsUsableAction - -**Content:** -Returns true if the character can currently use the specified action (sufficient mana, reagents and not on cooldown). -`isUsable, notEnoughMana = IsUsableAction(slot)` - -**Parameters:** -- `slot` - - *number* - Action slot to query - -**Returns:** -- `isUsable` - - *boolean* - true if the action is currently usable (does not check cooldown or range), false otherwise. -- `notEnoughMana` - - *boolean* - true if the action is unusable because the player does not have enough mana, rage, etc.; false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsUsableSpell.md b/wiki-information/functions/IsUsableSpell.md deleted file mode 100644 index c8f0f613..00000000 --- a/wiki-information/functions/IsUsableSpell.md +++ /dev/null @@ -1,53 +0,0 @@ -## Title: IsUsableSpell - -**Content:** -Determines whether a spell can be used by the player character. -`usable, noMana = IsUsableSpell(spell)` -`usable, noMana = IsUsableSpell(index, bookType)` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant** - - **Value** - - **Description** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Returns:** -- `usable` - - *boolean* - True if the spell is usable, false otherwise. A spell might be un-usable for a variety of reasons, such as: - - The player hasn't learned the spell - - The player lacks required mana or reagents. - - Reactive conditions haven't been met. -- `noMana` - - *boolean* - True if the spell cannot be cast due to low mana, false otherwise. - -**Usage:** -The following code snippet will check if the spell 'Healing Touch' can be cast: -```lua -usable, nomana = IsUsableSpell("Curse of Elements"); -if (not usable) then - if (not nomana) then - message("The spell cannot be cast"); - else - message("You do not have enough mana to cast the spell"); - end -else - message("The spell may be cast"); -end -``` - -The following code snippet will check if the 20th spell in the player's spellbook is usable: -```lua -usable, nomana = IsUsableSpell(20, BOOKTYPE_SPELL); -print(GetSpellName(20, BOOKTYPE_SPELL) .. " is " .. (usable and "" or "not ") .. " usable."); -``` \ No newline at end of file diff --git a/wiki-information/functions/IsUsingFixedTimeStep.md b/wiki-information/functions/IsUsingFixedTimeStep.md deleted file mode 100644 index 6b656625..00000000 --- a/wiki-information/functions/IsUsingFixedTimeStep.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsUsingFixedTimeStep - -**Content:** -Needs summary. -`isUsingFixedTimeStep = IsUsingFixedTimeStep()` - -**Returns:** -- `isUsingFixedTimeStep` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsUsingGamepad.md b/wiki-information/functions/IsUsingGamepad.md deleted file mode 100644 index 85e7bdab..00000000 --- a/wiki-information/functions/IsUsingGamepad.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsUsingGamepad - -**Content:** -Needs summary. -`down = IsUsingGamepad()` - -**Returns:** -- `down` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsUsingMouse.md b/wiki-information/functions/IsUsingMouse.md deleted file mode 100644 index 042c0d97..00000000 --- a/wiki-information/functions/IsUsingMouse.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsUsingMouse - -**Content:** -Needs summary. -`down = IsUsingMouse()` - -**Returns:** -- `down` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsVeteranTrialAccount.md b/wiki-information/functions/IsVeteranTrialAccount.md deleted file mode 100644 index 17c99c50..00000000 --- a/wiki-information/functions/IsVeteranTrialAccount.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsVeteranTrialAccount - -**Content:** -Needs summary. -`isVeteranTrialAccount = IsVeteranTrialAccount()` - -**Returns:** -- `isVeteranTrialAccount` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/IsWargame.md b/wiki-information/functions/IsWargame.md deleted file mode 100644 index 038af7f3..00000000 --- a/wiki-information/functions/IsWargame.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsWargame - -**Content:** -Returns whether the player is currently in a War Game. -`isWargame = IsWargame()` - -**Returns:** -- `isWargame` - - *boolean* - true if the player is currently inside a war game instance, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/IsXPUserDisabled.md b/wiki-information/functions/IsXPUserDisabled.md deleted file mode 100644 index 8bcc6327..00000000 --- a/wiki-information/functions/IsXPUserDisabled.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: IsXPUserDisabled - -**Content:** -Needs summary. -`isDisabled = C_PlayerInfo.IsXPUserDisabled()` - -**Returns:** -- `isDisabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetCreator.md b/wiki-information/functions/ItemTextGetCreator.md deleted file mode 100644 index 2ee1f5bf..00000000 --- a/wiki-information/functions/ItemTextGetCreator.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ItemTextGetCreator - -**Content:** -Returns the name of the character who created the item text. -`creatorName = ItemTextGetCreator()` - -**Returns:** -- `creatorName` - - *string* - If this item text was created by a player (i.e. Saved mail message) then return their name, otherwise return nil. - -**Description:** -This is available once the `ITEM_TEXT_BEGIN` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetItem.md b/wiki-information/functions/ItemTextGetItem.md deleted file mode 100644 index a34bdb64..00000000 --- a/wiki-information/functions/ItemTextGetItem.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ItemTextGetItem - -**Content:** -Returns the item name that the item text belongs to. -`textName = ItemTextGetItem()` - -**Returns:** -- `textName` - - *string* - The name of the item text which is being viewed. - -**Description:** -This is available once the `ITEM_TEXT_BEGIN` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetMaterial.md b/wiki-information/functions/ItemTextGetMaterial.md deleted file mode 100644 index 471fe193..00000000 --- a/wiki-information/functions/ItemTextGetMaterial.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: ItemTextGetMaterial - -**Content:** -Returns the material texture for the item text. -`materialName = ItemTextGetMaterial()` - -**Returns:** -- `materialName` - - *string* - The name of the material to use for displaying the item text. If nil then the material is "Parchment". - -**Description:** -This is used once the `ITEM_TEXT_READY` event has been received for a page. -See `FrameXML/ItemTextFrame.lua` for examples of how the material is used to select a set of textures. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetPage.md b/wiki-information/functions/ItemTextGetPage.md deleted file mode 100644 index 502a7201..00000000 --- a/wiki-information/functions/ItemTextGetPage.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: ItemTextGetPage - -**Content:** -Returns the page number of the currently displayed page. -`pageNum = ItemTextGetPage()` - -**Returns:** -- `pageNum` - - *number* - The page number of the currently displayed page, starting at 1. - -**Description:** -This is used once the `ITEM_TEXT_READY` event has been received for a page. -Note that there is no function to return the total number of pages of the text, it must be found by iterating through until `ItemTextHasNextPage` returns nil. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextGetText.md b/wiki-information/functions/ItemTextGetText.md deleted file mode 100644 index 655d38af..00000000 --- a/wiki-information/functions/ItemTextGetText.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ItemTextGetText - -**Content:** -Returns the contents of the currently displayed page. -`pageBody = ItemTextGetText()` - -**Returns:** -- `pageBody` - - *string* - The body of the current page. - -**Description:** -This is available once the `ITEM_TEXT_READY` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextHasNextPage.md b/wiki-information/functions/ItemTextHasNextPage.md deleted file mode 100644 index 3498885b..00000000 --- a/wiki-information/functions/ItemTextHasNextPage.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ItemTextHasNextPage - -**Content:** -Returns true if there is a page after the current page. -`hasNext = ItemTextHasNextPage()` - -**Returns:** -- `hasNext` - - *Flag* - Returns 1 if there is a page following the currently displayed one, nil otherwise. - -**Description:** -This is available once the `ITEM_TEXT_READY` event has been received. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextNextPage.md b/wiki-information/functions/ItemTextNextPage.md deleted file mode 100644 index 7767c002..00000000 --- a/wiki-information/functions/ItemTextNextPage.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: ItemTextNextPage - -**Content:** -Moves to the next page of the item text. -`ItemTextNextPage()` - -**Description:** -This simply requests the next page, you will receive an `ITEM_TEXT_READY` event when the new page is ready. -Try only to call this after receiving an `ITEM_TEXT_READY` event for the current page, and don't call it IN the event handler for that event, things get a little odd (Looks like a synchronization issue in the client) and your page cache might get corrupted. -Does nothing if called while viewing the last page. \ No newline at end of file diff --git a/wiki-information/functions/ItemTextPrevPage.md b/wiki-information/functions/ItemTextPrevPage.md deleted file mode 100644 index 4fec2d0e..00000000 --- a/wiki-information/functions/ItemTextPrevPage.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: ItemTextPrevPage - -**Content:** -Moves to the previous page of the item text. -`ItemTextPrevPage()` - -**Description:** -This simply requests the previous page, you will receive an `ITEM_TEXT_READY` event when the new page is ready. -Try only to call this after receiving an `ITEM_TEXT_READY` event for the current page, and don't call it IN the event handler for that event, things get a little odd (Looks like a synchronization issue in the client) and your page cache might get corrupted. -Does nothing if called while viewing the first page. \ No newline at end of file diff --git a/wiki-information/functions/JoinBattlefield.md b/wiki-information/functions/JoinBattlefield.md deleted file mode 100644 index af6d89d7..00000000 --- a/wiki-information/functions/JoinBattlefield.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: JoinBattlefield - -**Content:** -Joins the battleground queue solo or as a group. -`JoinBattlefield(index)` - -**Parameters:** -- `index` - - *number* - Which battlefield instance to queue for (0 for first available), or which arena bracket to queue for. -- `asGroup` - - *boolean* - If true-equivalent, the player's group is queued for the battlefield, otherwise, only the player is queued. -- `isRated` - - *boolean* - If true-equivalent, and queueing for an arena bracket, the group is queued for a rated match as opposed to a skirmish. - -**Description:** -The function requests the player to be added to a queue for a particular instance of the currently selected battleground type, as set by `RequestBattlegroundInstanceInfo(index)`. You CANNOT queue immediately after a `RequestBattlegroundInstanceInfo` call, and must instead capture the event that indicates that the instance list is available. - -**Details:** -When the Arena Battlemaster window is open, index 1 is 2vs2, index 2 is 3vs3 and index 3 is 5vs5. - -**Usage:** -The following code creates a utility function, `JoinBattlegroundType`, which allows you to queue for the first available instance of a specific battleground type. -```lua -do - local f, aG, iR = CreateFrame("FRAME"); - f:SetScript("OnEvent", function(self, event) - JoinBattlefield(0, aG, iR); - self:UnregisterEvent("PVPQUEUE_ANYWHERE_SHOW"); - end); - function JoinBattlegroundType(index, asGroup, isRated) - if f:IsEventRegistered("PVPQUEUE_ANYWHERE_SHOW") then - error("A join battleground request is already being processed"); - end - f:RegisterEvent("PVPQUEUE_ANYWHERE_SHOW"); - aG, iR = asGroup, isRated; - RequestBattlegroundInstanceInfo(index); - end -end -``` - -**Reference:** -- `CanJoinBattlefieldAsGroup` \ No newline at end of file diff --git a/wiki-information/functions/JoinChannelByName.md b/wiki-information/functions/JoinChannelByName.md deleted file mode 100644 index bb772015..00000000 --- a/wiki-information/functions/JoinChannelByName.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: JoinChannelByName - -**Content:** -Joins the specified chat channel. -`type, name = JoinChannelByName(channelName)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel to join. You can't use the "-" character in `channelName`. -- `password` - - *string?* - The channel password, `nil` if none. -- `frameID` - - *number?* - The chat frame ID number to add the channel to. Use `Frame:GetID()` to retrieve it for chat frame objects. -- `hasVoice` - - *boolean* - Enable voice chat for this channel. - -**Returns:** -- `type` - - *number* - The type of channel. 0 for an undefined channel, 1 for the zone General channel, etc. -- `name` - - *string?* - The name of the channel. - -**Usage:** -```lua -local channel_type, channel_name = JoinChannelByName("Mammoth", "thesane", ChatFrame1:GetID(), 1); -``` - -**Example Use Case:** -This function can be used to programmatically join a custom chat channel in World of Warcraft. For instance, an addon could use this to automatically join a guild's custom chat channel upon login. - -**Addon Usage:** -Large addons like Prat or Chatter, which enhance the chat interface, might use this function to manage custom chat channels, ensuring users are automatically joined to specific channels for better communication and coordination. \ No newline at end of file diff --git a/wiki-information/functions/JoinPermanentChannel.md b/wiki-information/functions/JoinPermanentChannel.md deleted file mode 100644 index 551284b9..00000000 --- a/wiki-information/functions/JoinPermanentChannel.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: JoinPermanentChannel - -**Content:** -Joins the specified chat channel; the channel will be rejoined after relogging. -Joins the channel with the specified name. A player can be in a maximum of 10 chat channels. In contrast to `API_JoinTemporaryChannel`, the channel will be re-joined after relogging. -`type, name = JoinPermanentChannel(channelName)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel to join. You can't use the "-" character in `channelName` (patch 1.9). -- `password` - - *string?* - The channel password, nil if none. -- `frameID` - - *number?* - The chat frame ID number to add the channel to. Use `Frame:GetID()` to retrieve it for chat frame objects. -- `hasVoice` - - *number?* - (1/nil) Enable voice chat for this channel. - -**Returns:** -- `type` - - *number* - The type of channel. 0 for an undefined channel, 1 for the zone General channel, etc. -- `name` - - *string* - The name of the channel (seems to be nil for most channels). - -**Usage:** -```lua -JoinPermanentChannel("Mammoth", "thesane", ChatFrame1:GetID(), 1); -``` - -**Example Use Case:** -This function can be used to join a custom chat channel that you want to persist across game sessions. For instance, a guild might use a specific channel for officer communications that they want to automatically rejoin every time they log in. - -**Addons Using This API:** -Many chat-related addons, such as Prat and Chatter, use this API to manage custom chat channels and ensure users are automatically rejoined to important channels after relogging. \ No newline at end of file diff --git a/wiki-information/functions/JoinSkirmish.md b/wiki-information/functions/JoinSkirmish.md deleted file mode 100644 index ea05ab06..00000000 --- a/wiki-information/functions/JoinSkirmish.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: JoinSkirmish - -**Content:** -Queue for an arena either solo or as a group. -`JoinSkirmish(arenaID, joinAsGroup)` - -**Parameters:** -- `arenaID` - - *number* -- `joinAsGroup` - - *boolean?* - -**Description:** -Value arenaIDs: -- 4 = 2vs2 -- 5 = 3vs3 \ No newline at end of file diff --git a/wiki-information/functions/JoinTemporaryChannel.md b/wiki-information/functions/JoinTemporaryChannel.md deleted file mode 100644 index 95b7ab45..00000000 --- a/wiki-information/functions/JoinTemporaryChannel.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: JoinTemporaryChannel - -**Content:** -Joins the specified chat channel; the channel will be left on logout. -Joins the channel with the specified name. A player can be in a maximum of 10 chat channels. In contrast to `API_JoinPermanentChannel`, the channel will be left at logout. -`type, name = JoinTemporaryChannel(channelName)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel to join. You can't use the "-" character in `channelName` (patch 1.9). -- `password` - - *string?* - The channel password, `nil` if none. -- `frameID` - - *number?* - The chat frame ID number to add the channel to. Use `Frame:GetID()` to retrieve it for chat frame objects. -- `hasVoice` - - *number* - (1/nil) Enable voice chat for this channel. - -**Returns:** -- `type` - - *number* - The type of channel. 0 for an undefined channel, 1 for the zone General channel, etc. -- `name` - - *string* - The name of the channel (seems to be `nil` for most channels). - -**Usage:** -```lua -JoinTemporaryChannel("Mammoth", "thesane", ChatFrame1:GetID(), 1); -``` - -**Example Use Case:** -This function can be used in an addon to temporarily join a custom chat channel for event coordination or group activities. For instance, a raid leader might use this to create a temporary channel for organizing a raid without cluttering the permanent channel list. - -**Addons Using This API:** -Large addons like Deadly Boss Mods (DBM) might use this function to create temporary channels for sharing raid warnings and alerts among raid members. \ No newline at end of file diff --git a/wiki-information/functions/JumpOrAscendStart.md b/wiki-information/functions/JumpOrAscendStart.md deleted file mode 100644 index 31900b84..00000000 --- a/wiki-information/functions/JumpOrAscendStart.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: JumpOrAscendStart - -**Content:** -Makes the character jump or swim/fly upwards. -`JumpOrAscendStart()` - -**Description:** -This function is called when the jump key is pushed down. \ No newline at end of file diff --git a/wiki-information/functions/KBArticle_BeginLoading.md b/wiki-information/functions/KBArticle_BeginLoading.md deleted file mode 100644 index 58ce4813..00000000 --- a/wiki-information/functions/KBArticle_BeginLoading.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: KBArticle_BeginLoading - -**Content:** -Starts the article load process. -`KBArticle_BeginLoading(id, searchType)` - -**Parameters:** -- `(id, searchType)` - - `id` - - *number* - The article's ID - - `searchType` - - *number* - Search type for the loading process. - -**Returns:** -- `nil` - -**Description:** -The `searchType` can be either 1 or 2. 1 is used if the search text is empty, 2 otherwise. - -**Usage:** -```lua -function KnowledgeBaseArticleListItem_OnClick() - local searchText = KnowledgeBaseFrameEditBox:GetText(); - local searchType = 2; - if (searchText == KBASE_DEFAULT_SEARCH_TEXT or searchText == "") then - searchType = 1; - end - KBArticle_BeginLoading(this.articleId, searchType); -end -``` -From Blizzard's KnowledgeBaseFrame.lua (l. 529 ff.) \ No newline at end of file diff --git a/wiki-information/functions/KBArticle_GetData.md b/wiki-information/functions/KBArticle_GetData.md deleted file mode 100644 index 0742269f..00000000 --- a/wiki-information/functions/KBArticle_GetData.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: KBArticle_GetData - -**Content:** -Returns data for the current article. -`id, subject, subjectAlt, text, keywords, languageId, isHot = KBArticle_GetData()` - -**Parameters:** -- `()` - -**Returns:** -- `id` - - *number* - The article id -- `subject` - - *string* - The localized title. -- `subjectAlt` - - *string* - The English title. -- `text` - - *string* - The article itself -- `keywords` - - *string* - Some keywords for the article. May be nil. -- `languageId` - - *number* - The language ID for the article. -- `isHot` - - *boolean* - Flag for the "hot" status. - -**Description:** -Only works if `KBArticle_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBArticle_IsLoaded.md b/wiki-information/functions/KBArticle_IsLoaded.md deleted file mode 100644 index e50078c5..00000000 --- a/wiki-information/functions/KBArticle_IsLoaded.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: KBArticle_IsLoaded - -**Content:** -Determine if the article is loaded. -`loaded = KBArticle_IsLoaded()` - -**Returns:** -- `loaded` - - *boolean* - True if the article is loaded. - -**Description:** -Normally returns true after `KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS` fires. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_BeginLoading.md b/wiki-information/functions/KBSetup_BeginLoading.md deleted file mode 100644 index 6b69ed92..00000000 --- a/wiki-information/functions/KBSetup_BeginLoading.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: KBSetup_BeginLoading - -**Content:** -Starts the loading of articles. -`KBSetup_BeginLoading(articlesPerPage, currentPage)` - -**Parameters:** -- `articlesPerPage` - - *number* - Number of articles shown on one page. -- `currentPage` - - *number* - The current page (starts at 1). - -**Returns:** -- `nil` - -**Usage:** -In `KnowledgeBaseFrame_OnShow()`: -```lua -KBSetup_BeginLoading(KBASE_NUM_ARTICLES_PER_PAGE, KBASE_CURRENT_PAGE) -``` -From Blizzard's `KnowledgeBaseFrame.lua` (l. 51) - -**Description:** -This will start the article loading process and return immediately. -When all articles are loaded, the event `KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS` is fired. -If an error occurs in the loading process, the event `KNOWLEDGE_BASE_SETUP_LOAD_FAILURE` is fired. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetArticleHeaderCount.md b/wiki-information/functions/KBSetup_GetArticleHeaderCount.md deleted file mode 100644 index bd73fa87..00000000 --- a/wiki-information/functions/KBSetup_GetArticleHeaderCount.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: KBSetup_GetArticleHeaderCount - -**Content:** -Returns the number of articles for the current page. -`count = KBSetup_GetArticleHeaderCount()` - -**Parameters:** -- `()` - -**Returns:** -- `count` - - *number* - The number of articles for the current page. - -**Usage:** -```lua -local count = KBSetup_GetArticleHeaderCount() -for i = 1, count do - -- do something with the article -end -``` - -**Description:** -This will count the "most asked" articles, not the number of articles for the active query. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetArticleHeaderData.md b/wiki-information/functions/KBSetup_GetArticleHeaderData.md deleted file mode 100644 index 6eac1578..00000000 --- a/wiki-information/functions/KBSetup_GetArticleHeaderData.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: KBSetup_GetArticleHeaderData - -**Content:** -Returns header information about an article. -`id, title, isHot, isNew = KBSetup_GetArticleHeaderData(index)` - -**Parameters:** -- `index` - - *number* - The article's index for that page. - -**Returns:** -- `id` - - *number* - The article's id. -- `title` - - *string* - The article's title. -- `isHot` - - *boolean* - Show the "hot" symbol or not. -- `isNew` - - *boolean* - Show the "new" symbol or not. - -**Usage:** -```lua -local id, title, isHot, isNew = KBSetup_GetArticleHeaderData(1) -if isNew then - ChatFrame1:AddMessage("The article " .. id .. "(" .. title .. ") is new.", 1.0, 1.0, 1.0) -end -``` - -**Description:** -This will work on the "most asked" articles, not the articles of the active query. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetCategoryCount.md b/wiki-information/functions/KBSetup_GetCategoryCount.md deleted file mode 100644 index 43f396c9..00000000 --- a/wiki-information/functions/KBSetup_GetCategoryCount.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: KBSetup_GetCategoryCount - -**Content:** -Returns the number of categories. -`count = KBSetup_GetCategoryCount()` - -**Parameters:** -- `()` - -**Returns:** -- `count` - - *number* - Number of categories. - -**Description:** -This is only available when `KBSetup_IsLoaded()` is true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetCategoryData.md b/wiki-information/functions/KBSetup_GetCategoryData.md deleted file mode 100644 index 4886379a..00000000 --- a/wiki-information/functions/KBSetup_GetCategoryData.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: KBSetup_GetCategoryData - -**Content:** -Returns information about a category. -`id, caption = KBSetup_GetCategoryData(index)` - -**Parameters:** -- `index` - - *number* - Range from 1 to `KBSetup_GetCategoryCount()` - -**Returns:** -- `id` - - *number* - The category's id. -- `caption` - - *string* - The category caption. - -**Description:** -Seems to only work if `KBSetup_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetLanguageCount.md b/wiki-information/functions/KBSetup_GetLanguageCount.md deleted file mode 100644 index 45d71456..00000000 --- a/wiki-information/functions/KBSetup_GetLanguageCount.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: KBSetup_GetLanguageCount - -**Content:** -Returns the number of languages in the knowledge base. -`count = KBSetup_GetLanguageCount()` - -**Parameters:** -- `()` - -**Returns:** -- `count` - - *integer* - The number of the available languages. - -**Description:** -Seems to only work if `KBSetup_IsLoaded()` returns true. -On an EU client, this function returns 4 (enUS, deDE, frFR, esES). \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetLanguageData.md b/wiki-information/functions/KBSetup_GetLanguageData.md deleted file mode 100644 index 35f5a77e..00000000 --- a/wiki-information/functions/KBSetup_GetLanguageData.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: KBSetup_GetLanguageData - -**Content:** -Returns information about a language. -`id, caption = KBSetup_GetLanguageData(index)` - -**Parameters:** -- `index` - - *number* - Range from 1 to `KBSetup_GetLanguageCount()` - -**Returns:** -- `id` - - *number* - The internal language ID. -- `caption` - - *string* - The (localized?) name of the language. - -**Description:** -Seems to only work if `KBSetup_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetSubCategoryCount.md b/wiki-information/functions/KBSetup_GetSubCategoryCount.md deleted file mode 100644 index e6b4dde7..00000000 --- a/wiki-information/functions/KBSetup_GetSubCategoryCount.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: KBSetup_GetSubCategoryCount - -**Content:** -Returns the number of subcategories in a category. -`count = KBSetup_GetSubCategoryCount(category)` - -**Parameters:** -- `category` - - *number* - The category's index. - -**Returns:** -- `count` - - *number* - Number of subcategories. - -**Description:** -This is only available when `KBSetup_IsLoaded()` is true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetSubCategoryData.md b/wiki-information/functions/KBSetup_GetSubCategoryData.md deleted file mode 100644 index 54ed6b9d..00000000 --- a/wiki-information/functions/KBSetup_GetSubCategoryData.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: KBSetup_GetSubCategoryData - -**Content:** -Returns information about a subcategory. -`id, caption = KBSetup_GetSubCategoryData(category, index)` - -**Parameters:** -- `(category, index)` - - `category` - - *Integer* - The category's index. - - `index` - - *number* - Range from 1 to `KBSetup_GetSubCategoryCount(category)` - -**Returns:** -- `id, caption` - - `id` - - *number* - The category's id. - - `caption` - - *string* - The category caption. - -**Description:** -Only works if `KBSetup_IsLoaded()` returns true. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_GetTotalArticleCount.md b/wiki-information/functions/KBSetup_GetTotalArticleCount.md deleted file mode 100644 index 5abebb8d..00000000 --- a/wiki-information/functions/KBSetup_GetTotalArticleCount.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: KBSetup_GetTotalArticleCount - -**Content:** -Returns the number of articles. -`count = KBSetup_GetTotalArticleCount()` - -**Parameters:** -- `()` - -**Returns:** -- `count` - - *number* - The number of articles. - -**Usage:** -```lua -local count = KBSetup_GetTotalArticleCount() -for i = 1, count do - -- do something with the article -end -``` - -**Description:** -This will count the "most asked" articles, not the number of articles for the active query. \ No newline at end of file diff --git a/wiki-information/functions/KBSetup_IsLoaded.md b/wiki-information/functions/KBSetup_IsLoaded.md deleted file mode 100644 index 2d304112..00000000 --- a/wiki-information/functions/KBSetup_IsLoaded.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: KBSetup_IsLoaded - -**Content:** -Determine if the article list is loaded. -`loaded = KBSetup_IsLoaded()` - -**Parameters:** -- `()` - No parameters. - -**Returns:** -- `loaded` - - *boolean* - True if the article list is loaded. - -**Usage:** -```lua -function KnowledgeBaseFrame_Search(resetCurrentPage) - if ( not KBSetup_IsLoaded() ) then - return; - end - -- ... -end -``` -From Blizzard's KnowledgeBaseFrame.lua (l. 217 ff.) \ No newline at end of file diff --git a/wiki-information/functions/KBSystem_GetMOTD.md b/wiki-information/functions/KBSystem_GetMOTD.md deleted file mode 100644 index 7aa691cb..00000000 --- a/wiki-information/functions/KBSystem_GetMOTD.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: KBSystem_GetMOTD - -**Content:** -Returns the server message of the day. -`motd = KBSystem_GetMOTD()` - -**Parameters:** -- `()` - -**Returns:** -- `motd` - - *string* - The message of the day. \ No newline at end of file diff --git a/wiki-information/functions/KBSystem_GetServerNotice.md b/wiki-information/functions/KBSystem_GetServerNotice.md deleted file mode 100644 index 5f73ce43..00000000 --- a/wiki-information/functions/KBSystem_GetServerNotice.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: KBSystem_GetServerNotice - -**Content:** -Returns the current server notice. -`notice = KBSystem_GetServerNotice()` - -**Returns:** -- `notice` - - *string?* - The server notice if there is one; nil otherwise. - -**Reference:** -- `KNOWLEDGE_BASE_SERVER_MESSAGE` - Indicates the server notice has changed. \ No newline at end of file diff --git a/wiki-information/functions/KBSystem_GetServerStatus.md b/wiki-information/functions/KBSystem_GetServerStatus.md deleted file mode 100644 index c7d1264a..00000000 --- a/wiki-information/functions/KBSystem_GetServerStatus.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: KBSystem_GetServerStatus - -**Content:** -Returns the current server status. -`status = KBSystem_GetServerStatus()` - -**Parameters:** -- `()` - -**Returns:** -- `status` - - *string* - The server status message. May be nil. - -**Description:** -This function is not used in Blizzard's knowledge base. \ No newline at end of file diff --git a/wiki-information/functions/KeyRingButtonIDToInvSlotID.md b/wiki-information/functions/KeyRingButtonIDToInvSlotID.md deleted file mode 100644 index a73cc6a9..00000000 --- a/wiki-information/functions/KeyRingButtonIDToInvSlotID.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: KeyRingButtonIDToInvSlotID - -**Content:** -Map a keyring button to an inventory slot button for use in inventory functions. -`invSlot = KeyRingButtonIDToInvSlotID(buttonID)` - -**Parameters:** -- `buttonID` - - *number* - key ring button ID. - -**Returns:** -- `invSlot` - - *number* - an inventory slot ID. \ No newline at end of file diff --git a/wiki-information/functions/LFGTeleport.md b/wiki-information/functions/LFGTeleport.md deleted file mode 100644 index 6104f23b..00000000 --- a/wiki-information/functions/LFGTeleport.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: LFGTeleport - -**Content:** -Teleports the player to or from a LFG dungeon. -`LFGTeleport(toSafety)` - -**Parameters:** -- `toSafety` - - *boolean* - false to teleport to the dungeon, true to teleport to where you were before you were teleported to the dungeon. - -**Usage:** -`/run LFGTeleport(IsInLFGDungeon())` - -**Example Use Case:** -This function can be used to quickly teleport in and out of a dungeon when you are in a Looking For Group (LFG) instance. For example, if you need to quickly leave the dungeon to repair your gear or restock on supplies, you can use this function to teleport out and then back in. - -**Addons:** -Many popular addons like Deadly Boss Mods (DBM) and ElvUI use this function to provide quick access buttons for players to teleport in and out of LFG dungeons, enhancing the user experience by providing convenient shortcuts. \ No newline at end of file diff --git a/wiki-information/functions/LearnTalent.md b/wiki-information/functions/LearnTalent.md deleted file mode 100644 index 566d4a8e..00000000 --- a/wiki-information/functions/LearnTalent.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: LearnTalent - -**Content:** -Learns the specified talent. -`success = LearnTalent(talentID)` - -**Parameters:** -- `talentID` - - *number* - -**Returns:** -- `success` - - *boolean* - Returns false when e.g. in combat. - -**Usage:** -Learns holy priest's talent. -```lua -/run LearnTalent(19753) -``` - -**Reference:** -- `LearnPvpTalent()` \ No newline at end of file diff --git a/wiki-information/functions/LeaveChannelByName.md b/wiki-information/functions/LeaveChannelByName.md deleted file mode 100644 index 5f47f09e..00000000 --- a/wiki-information/functions/LeaveChannelByName.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: LeaveChannelByName - -**Content:** -Leaves the channel with the specified name. -`LeaveChannelByName(channelName)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel to leave. - -**Usage:** -```lua -LeaveChannelByName("Trade"); -``` - -**Example Use Case:** -This function can be used in an addon or script to programmatically leave a specific chat channel, such as the Trade channel, which can be useful for reducing chat spam or focusing on other channels. - -**Addons Using This Function:** -Many chat management addons, such as Prat or Chatter, may use this function to allow users to customize their chat experience by automatically leaving certain channels based on user preferences. \ No newline at end of file diff --git a/wiki-information/functions/ListChannelByName.md b/wiki-information/functions/ListChannelByName.md deleted file mode 100644 index 2d4caba1..00000000 --- a/wiki-information/functions/ListChannelByName.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ListChannelByName - -**Content:** -Prints the list of members in the specified channel. -`ListChannelByName(channel)` - -**Parameters:** -- `channel` - - *number|string* - Channel number or case-insensitive channel name from which to list the members, e.g. "trade - city". \ No newline at end of file diff --git a/wiki-information/functions/LoadAddOn.md b/wiki-information/functions/LoadAddOn.md deleted file mode 100644 index e7a1b315..00000000 --- a/wiki-information/functions/LoadAddOn.md +++ /dev/null @@ -1,81 +0,0 @@ -## Title: LoadAddOn - -**Content:** -Loads the specified LoadOnDemand addon. -`loaded, reason = LoadAddOn(name)` - -**Parameters:** -- `name` - - *string|number* - The name of the addon to be queried, or an index from 1 to GetNumAddOns. The state of Blizzard addons can only be queried by name. - -**Returns:** -- `loaded` - - *boolean* - If the AddOn is successfully loaded or was already loaded. -- `reason` - - *string?* - Locale-independent reason why the AddOn could not be loaded e.g. "DISABLED", otherwise returns nil if the addon was loaded. - -**Description:** -Requires the addon to have the LoadOnDemand TOC field specified. -``` -## LoadOnDemand: 1 -``` -LoadOnDemand addons are useful for reducing loading screen times by loading only when necessary, like with the different DeadlyBossMods addons/submodules. - -**Related Events:** -- `ADDON_LOADED` - -**Reasons:** -These have corresponding global strings when prefixed with "ADDON_": -- `ADDON_BANNED` = "Banned" -- Addon is banned by the client -- `ADDON_CORRUPT` = "Corrupt" -- The addon's file(s) are corrupt -- `ADDON_DEMAND_LOADED` = "Only loadable on demand" -- `ADDON_DISABLED` = "Disabled" -- Addon is disabled on the character select screen -- `ADDON_INCOMPATIBLE` = "Incompatible" -- The addon is not compatible with the current TOC version -- `ADDON_INSECURE` = "Insecure" -- `ADDON_INTERFACE_VERSION` = "Out of date" -- `ADDON_MISSING` = "Missing" -- The addon is physically not there -- `ADDON_NOT_AVAILABLE` = "Not Available" -- `ADDON_UNKNOWN_ERROR` = "Unknown load problem" -- `ADDON_DEP_BANNED` = "Dependency banned" -- Addon's dependency is banned by the client -- `ADDON_DEP_CORRUPT` = "Dependency corrupt" -- The addon's dependency cannot load because its file(s) are corrupt -- `ADDON_DEP_DEMAND_LOADED` = "Dependency only loadable on demand" -- `ADDON_DEP_DISABLED` = "Dependency disabled" -- The addon cannot load without its dependency enabled -- `ADDON_DEP_INCOMPATIBLE` = "Dependency incompatible" -- The addon cannot load if its dependency cannot load -- `ADDON_DEP_INSECURE` = "Dependency insecure" -- `ADDON_DEP_INTERFACE_VERSION` = "Dependency out of date" -- `ADDON_DEP_MISSING` = "Dependency missing" -- The addon's dependency is physically not there - -**Usage:** -Attempts to load a LoadOnDemand addon. If the addon is disabled, it will try to enable it first. -```lua -local function TryLoadAddOn(name) - local loaded, reason = LoadAddOn(name) - if not loaded then - if reason == "DISABLED" then - EnableAddOn(name, true) -- enable for all characters on the realm - LoadAddOn(name) - else - local failed_msg = format("%s - %s", reason, _G) - error(ADDON_LOAD_FAILED:format(name, failed_msg)) - end - end -end -TryLoadAddOn("SomeAddOn") --- Couldn't load SomeAddOn: MISSING - Missing -``` - -Manually loads and shows the Blizzard Achievement UI addon. -```lua -/run LoadAddOn("Blizzard_AchievementUI"); AchievementFrame_ToggleAchievementFrame(); -``` - -**Reference:** -- `IsAddOnLoaded()` -- `UIParentLoadAddOn()` - -**Example Use Case:** -This function can be used to dynamically load addons that are not required at the start of the game, thereby reducing initial load times. For example, DeadlyBossMods (DBM) uses LoadOnDemand to load specific boss modules only when the player enters the relevant dungeon or raid. - -**Large Addons Using This Function:** -- **DeadlyBossMods (DBM):** Uses LoadOnDemand to load specific boss encounter modules only when needed, reducing the overall memory footprint and load times. -- **Auctioneer:** Loads additional modules for advanced auction house functionalities only when the auction house interface is opened. \ No newline at end of file diff --git a/wiki-information/functions/LoadBindings.md b/wiki-information/functions/LoadBindings.md deleted file mode 100644 index 2ccd6c12..00000000 --- a/wiki-information/functions/LoadBindings.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: LoadBindings - -**Content:** -Loads default, account, or character-specific key bindings. -`LoadBindings(bindingSet)` - -**Parameters:** -- `bindingSet` - - *number* - Which binding set to load; one of the following three numeric constants: - - `DEFAULT_BINDINGS` (0) - - `ACCOUNT_BINDINGS` (1) - - `CHARACTER_BINDINGS` (2) - -**Reference:** -- `UPDATE_BINDINGS` when the binding set has been loaded. - -**Description:** -The file it reads from is `WTF\Account\ACCOUNTNAME\bindings-cache.wtf`. \ No newline at end of file diff --git a/wiki-information/functions/LoadURLIndex.md b/wiki-information/functions/LoadURLIndex.md deleted file mode 100644 index 91e38911..00000000 --- a/wiki-information/functions/LoadURLIndex.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: LoadURLIndex - -**Content:** -Needs summary. -`LoadURLIndex(index)` - -**Parameters:** -- `index` - - *number* -- `param` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/LoggingChat.md b/wiki-information/functions/LoggingChat.md deleted file mode 100644 index 21660b25..00000000 --- a/wiki-information/functions/LoggingChat.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: LoggingChat - -**Content:** -Gets or sets whether logging chat to `Logs\WoWChatLog.txt` is enabled. -`isLogging = LoggingChat()` - -**Parameters:** -- `newState` - - *boolean* - toggles chat logging - -**Returns:** -- `isLogging` - - *boolean* - current state of logging - -**Usage:** -```lua -if (LoggingChat()) then - print("Chat is already being logged") -else - print("Chat is not being logged - starting it!") - LoggingChat(1) - print("Chat is now being logged to Logs\\WOWChatLog.txt") -end -``` - -**Example Use Case:** -This function can be used in an addon to ensure that chat logs are being recorded for later review or debugging purposes. For instance, a guild management addon might use this to log all guild chat for administrative review. - -**Addons Using This Function:** -While specific large addons using this function are not well-documented, any addon that requires chat logging for analysis or record-keeping, such as raid logging tools or guild management addons, might utilize this function to ensure chat is being logged. \ No newline at end of file diff --git a/wiki-information/functions/LoggingCombat.md b/wiki-information/functions/LoggingCombat.md deleted file mode 100644 index c1f4323e..00000000 --- a/wiki-information/functions/LoggingCombat.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: LoggingCombat - -**Content:** -Gets or sets whether logging combat to `Logs\WoWCombatLog.txt` is enabled. -`isLogging = LoggingCombat()` - -**Parameters:** -- `newState` - - *boolean* - Toggles combat logging - -**Returns:** -- `isLogging` - - *false* - You are not logging - - *true* - You are logging - - When spammed, may return `nil` instead of `true` or `false`. - -**Usage:** -```lua -if (LoggingCombat()) then - DEFAULT_CHAT_FRAME:AddMessage("Combat is already being logged"); -else - DEFAULT_CHAT_FRAME:AddMessage("Combat is not being logged - starting it!"); - LoggingCombat(1); -end - -if (LoggingCombat()) then - DEFAULT_CHAT_FRAME:AddMessage("Combat is already being logged"); -else - DEFAULT_CHAT_FRAME:AddMessage("Combat is not being logged - starting it!"); - LoggingCombat(1); -end -``` - -**Example #2:** -Create a new macro and paste the following (one-line): -```lua -/script local a=LoggingCombat(LoggingCombat()==nil); UIErrorsFrame:AddMessage("CombatLogging is now "..tostring(a and "ON" or "OFF"),1,0,0); -``` -Drag the macro-button to an action bar or key bind it and you have a one-click/keypress toggle. - -**Description:** -If no parameter is passed in, `LoggingCombat` only returns the current state. \ No newline at end of file diff --git a/wiki-information/functions/Logout.md b/wiki-information/functions/Logout.md deleted file mode 100644 index 998ddeec..00000000 --- a/wiki-information/functions/Logout.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: Logout - -**Content:** -Logs the player out of the game. -`Logout()` - -**Reference:** -- `PLAYER_CAMPING` -- See also: - - `CancelLogout` \ No newline at end of file diff --git a/wiki-information/functions/LootSlot.md b/wiki-information/functions/LootSlot.md deleted file mode 100644 index a771c842..00000000 --- a/wiki-information/functions/LootSlot.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: LootSlot - -**Content:** -Loots the specified slot; can require confirmation with `ConfirmLootSlot`. -`LootSlot(slot)` - -**Parameters:** -- `slot` - - *number* - the loot slot. - -**Returns:** -- unknown - -**Usage:** -```lua -LootSlot(1) --- if slot 1 contains an item that must be confirmed, then -ConfirmLootSlot(1) --- must be called after. -``` - -**Miscellaneous:** -Result: - -This function is called whenever a LootButton is clicked (or auto looted). \ No newline at end of file diff --git a/wiki-information/functions/LootSlotHasItem.md b/wiki-information/functions/LootSlotHasItem.md deleted file mode 100644 index 5baea012..00000000 --- a/wiki-information/functions/LootSlotHasItem.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: LootSlotHasItem - -**Content:** -Returns whether a loot slot contains an item. -`isLootItem = LootSlotHasItem(lootSlot)` - -**Parameters:** -- `lootSlot` - - *number* - index of the loot slot, ascending from 1 to `GetNumLootItems()` - -**Returns:** -- `isLootItem` - - *boolean* - true if the loot slot contains an item rather than coin. - -**Usage:** -Iterate through the items in the currently opened loot window and display them in the chat frame, side by side. -```lua -local itemLinkText -for i = 1, GetNumLootItems() do - if (LootSlotHasItem(i)) then - local iteminfo = GetLootSlotLink(i) - if itemLinkText == nil then - itemLinkText = iteminfo - else - itemLinkText = itemLinkText .. ", " .. iteminfo - end - end -end -print(itemLinkText) -``` - -**Example Use Case:** -This function can be used in addons that manage loot distribution, such as auto-looting systems or loot tracking addons. For example, an addon could use this function to filter out coin slots and only process item slots for further actions like auto-looting specific items or displaying item links in the chat. - -**Addons Using This Function:** -- **LootMaster:** This addon uses `LootSlotHasItem` to determine which slots contain items and then processes those items for master looting purposes. -- **AutoLootPlus:** This addon uses the function to enhance the auto-looting experience by filtering out coin slots and focusing on item slots, allowing for more efficient looting. \ No newline at end of file diff --git a/wiki-information/functions/MouselookStart.md b/wiki-information/functions/MouselookStart.md deleted file mode 100644 index 1bb0da88..00000000 --- a/wiki-information/functions/MouselookStart.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: MouselookStart - -**Content:** -Enters mouse look mode; alters the character's movement/facing direction. -`MouselookStart()` - -**Reference:** -- `IsMouselooking` -- `MouselookStop` \ No newline at end of file diff --git a/wiki-information/functions/MouselookStop.md b/wiki-information/functions/MouselookStop.md deleted file mode 100644 index 94d2ef81..00000000 --- a/wiki-information/functions/MouselookStop.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: MouselookStop - -**Content:** -Exits mouse look mode. -`MouselookStop()` - -**Reference:** -- `IsMouselooking` -- `MouselookStart` \ No newline at end of file diff --git a/wiki-information/functions/MoveBackwardStart.md b/wiki-information/functions/MoveBackwardStart.md deleted file mode 100644 index aaeb08b3..00000000 --- a/wiki-information/functions/MoveBackwardStart.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: MoveBackwardStart - -**Content:** -The player begins moving backward at the specified time. -`MoveBackwardStart(startTime)` - -**Parameters:** -- `startTime` - - *number* - Begin moving backward at this time, per `GetTime * 1000`. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveBackwardStop.md b/wiki-information/functions/MoveBackwardStop.md deleted file mode 100644 index ef84a417..00000000 --- a/wiki-information/functions/MoveBackwardStop.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: MoveBackwardStop - -**Content:** -The player stops moving backward at the specified time. -`MoveBackwardStop(startTime)` - -**Parameters:** -- `stopTime` - - *number* - Stop moving backward at this time, per `GetTime * 1000`. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveForwardStart.md b/wiki-information/functions/MoveForwardStart.md deleted file mode 100644 index 581cb8b4..00000000 --- a/wiki-information/functions/MoveForwardStart.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: MoveForwardStart - -**Content:** -The player begins moving forward at the specified time. -`MoveForwardStart(startTime)` - -**Parameters:** -- `startTime` - - *number* - Begin moving forward at this time, per GetTime * 1000. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveForwardStop.md b/wiki-information/functions/MoveForwardStop.md deleted file mode 100644 index 516c87bd..00000000 --- a/wiki-information/functions/MoveForwardStop.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: MoveForwardStop - -**Content:** -The player stops moving forward at the specified time. -`MoveForwardStop(startTime)` - -**Parameters:** -- `stopTime` - - Stop moving forward at this time, per `GetTime * 1000`. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewDownStart.md b/wiki-information/functions/MoveViewDownStart.md deleted file mode 100644 index ecf797af..00000000 --- a/wiki-information/functions/MoveViewDownStart.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: MoveViewDownStart - -**Content:** -Starts rotating the camera downward. -`MoveViewDownStart(speed)` - -**Parameters:** -- `speed` - - *number* - Speed at which to begin rotating. - -**Returns:** -Nothing - -**Usage:** -```lua -MoveViewDownStart(25/tonumber(GetCVar("cameraPitchMoveSpeed"))) -- rotate camera down at 25 degrees/second -``` - -**Description:** -Speed is a multiplier on the CVar 'cameraPitchMoveSpeed', which is in degrees/second. -If speed is omitted, it is assumed to be 1.0. -Negative numbers go the opposite way, a speed of 0.0 will stop it. -This is not canceled by moving your character or interacting with the camera. -Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewDownStop.md b/wiki-information/functions/MoveViewDownStop.md deleted file mode 100644 index ed432a6f..00000000 --- a/wiki-information/functions/MoveViewDownStop.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: MoveViewDownStop - -**Content:** -Stops rotating the camera downward. -`MoveViewDownStop()` - -**Description:** -Equivalent to `MoveViewDownStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewInStart.md b/wiki-information/functions/MoveViewInStart.md deleted file mode 100644 index 9227bb00..00000000 --- a/wiki-information/functions/MoveViewInStart.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: MoveViewInStart - -**Content:** -Begins zooming the camera in. -`MoveViewInStart(speed)` - -**Parameters:** -- `speed` - - *number* - Speed at which to begin zooming. - -**Returns:** -Nothing - -**Usage:** -```lua -MoveViewInStart(5/tonumber(GetCVar("cameraZoomSpeed"))) -- zoom the camera in at 5 increments/second -``` - -**Description:** -Speed is a multiplier on the CVar 'cameraZoomSpeed', which is in increments/second. A zoom increment appears to be about a yard from the character. -If speed is omitted, it is assumed to be 1.0. -Negative numbers go the opposite way, a speed of 0.0 will stop it. -This is not canceled by moving your character, but is canceled by using the mousewheel to zoom. -Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you zoom both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewInStop.md b/wiki-information/functions/MoveViewInStop.md deleted file mode 100644 index 7b9302a7..00000000 --- a/wiki-information/functions/MoveViewInStop.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: MoveViewInStop - -**Content:** -Stops zooming the camera in. -`MoveViewInStop()` - -**Description:** -Equivalent to `MoveViewInStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewLeftStart.md b/wiki-information/functions/MoveViewLeftStart.md deleted file mode 100644 index 88445ba9..00000000 --- a/wiki-information/functions/MoveViewLeftStart.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: MoveViewLeftStart - -**Content:** -Starts rotating the camera to the left. -`MoveViewLeftStart(speed)` - -**Parameters:** -- `speed` - - *number* - Speed at which to begin rotating. - -**Returns:** -Nothing - -**Usage:** -```lua -MoveViewLeftStart(90/tonumber(GetCVar("cameraYawMoveSpeed"))) -- rotate camera to the left at 90 degrees/second -``` - -**Description:** -Speed is a multiplier on the CVar 'cameraYawMoveSpeed', which is in degrees/second. -If speed is omitted, it is assumed to be 1.0. -Negative numbers go the opposite way, a speed of 0.0 will stop it. -This is not canceled by moving your character or interacting with the camera. -Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewLeftStop.md b/wiki-information/functions/MoveViewLeftStop.md deleted file mode 100644 index f9b172cb..00000000 --- a/wiki-information/functions/MoveViewLeftStop.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: MoveViewLeftStop - -**Content:** -Stops rotating the camera to the left. -`MoveViewLeftStop()` - -**Description:** -Equivalent to `MoveViewLeftStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewOutStart.md b/wiki-information/functions/MoveViewOutStart.md deleted file mode 100644 index 6b83ed85..00000000 --- a/wiki-information/functions/MoveViewOutStart.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: MoveViewOutStart - -**Content:** -Begins zooming the camera out. -`MoveViewOutStart(speed)` - -**Parameters:** -- `speed` - - *number* - Speed at which to begin zooming. - -**Returns:** -Nothing - -**Usage:** -```lua -MoveViewOutStart(5/tonumber(GetCVar("cameraZoomSpeed"))) -- zoom the camera out at 5 increments/second -``` - -**Description:** -Speed is a multiplier on the CVar 'cameraZoomSpeed', which is in increments/second. A zoom increment appears to be about a yard from the character. -If speed is omitted, it is assumed to be 1.0. -Negative numbers go the opposite way, a speed of 0.0 will stop it. -This is not canceled by moving your character, but is canceled by using the mousewheel to zoom. -Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you zoom both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewOutStop.md b/wiki-information/functions/MoveViewOutStop.md deleted file mode 100644 index d1808680..00000000 --- a/wiki-information/functions/MoveViewOutStop.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: MoveViewOutStop - -**Content:** -Stops zooming the camera out. -`MoveViewOutStop()` - -**Description:** -Equivalent to `MoveViewOutStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewRightStart.md b/wiki-information/functions/MoveViewRightStart.md deleted file mode 100644 index 25be7dc6..00000000 --- a/wiki-information/functions/MoveViewRightStart.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: MoveViewRightStart - -**Content:** -Starts rotating the camera to the right. -`MoveViewRightStart(speed)` - -**Parameters:** -- `speed` - - *number* - Speed at which to begin rotating. - -**Returns:** -Nothing - -**Usage:** -```lua -MoveViewRightStart(90/tonumber(GetCVar("cameraYawMoveSpeed"))) -- rotate camera to the right at 90 degrees/second -``` - -**Description:** -Speed is a multiplier on the CVar 'cameraYawMoveSpeed', which is in degrees/second. -If speed is omitted, it is assumed to be 1.0. -Negative numbers go the opposite way, a speed of 0.0 will stop it. -This is not canceled by moving your character or interacting with the camera. -Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewRightStop.md b/wiki-information/functions/MoveViewRightStop.md deleted file mode 100644 index 200df198..00000000 --- a/wiki-information/functions/MoveViewRightStop.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: MoveViewRightStop - -**Content:** -Stops rotating the camera to the right. -`MoveViewRightStop()` - -**Parameters:** -- None - -**Returns:** -- Nothing - -**Description:** -Equivalent to `MoveViewRightStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewUpStart.md b/wiki-information/functions/MoveViewUpStart.md deleted file mode 100644 index c149480d..00000000 --- a/wiki-information/functions/MoveViewUpStart.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: MoveViewUpStart - -**Content:** -Starts rotating the camera upward. -`MoveViewUpStart(speed)` - -**Parameters:** -- `speed` - - *number* - Speed at which to begin rotating. - -**Returns:** -Nothing - -**Usage:** -```lua -MoveViewUpStart(25/tonumber(GetCVar("cameraPitchMoveSpeed"))) -- rotate camera up at 25 degrees/second -``` - -**Description:** -Speed is a multiplier on the CVar 'cameraPitchMoveSpeed', which is in degrees/second. -If speed is omitted, it is assumed to be 1.0. -Negative numbers go the opposite way, a speed of 0.0 will stop it. -This is not canceled by moving your character or interacting with the camera. -Applying a negative speed is not the same as using the other function to go the opposite way, both vectors are applied simultaneously. If you rotate both ways equally, it will appear to stop, but the rotations are still being applied, though canceling each other. \ No newline at end of file diff --git a/wiki-information/functions/MoveViewUpStop.md b/wiki-information/functions/MoveViewUpStop.md deleted file mode 100644 index ffadb179..00000000 --- a/wiki-information/functions/MoveViewUpStop.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: MoveViewUpStop - -**Content:** -Stops rotating the camera upward. -`MoveViewUpStop()` - -**Parameters:** -None - -**Returns:** -Nothing - -**Description:** -Equivalent to `MoveViewUpStart(0)`. \ No newline at end of file diff --git a/wiki-information/functions/MuteSoundFile.md b/wiki-information/functions/MuteSoundFile.md deleted file mode 100644 index 2b1ba65d..00000000 --- a/wiki-information/functions/MuteSoundFile.md +++ /dev/null @@ -1,53 +0,0 @@ -## Title: MuteSoundFile - -**Content:** -Mutes a sound file. -`MuteSoundFile(sound)` - -**Parameters:** -- `sound` - - *number|string* - FileID of a game sound or file path to an addon sound. - -**Usage:** -Plays the Sound/Spells/LevelUp.ogg sound -```lua -/run PlaySoundFile(569593) -``` -Mutes it, the sound won't play -```lua -/run MuteSoundFile(569593); PlaySoundFile(569593) -``` -Unmutes it and plays it -```lua -/run UnmuteSoundFile(569593); PlaySoundFile(569593) -``` -Addon example: -Mutes the fizzle sounds. -```lua -local sounds = { - 569772, -- sound/spells/fizzle/fizzleholya.ogg - 569773, -- sound/spells/fizzle/fizzlefirea.ogg - 569774, -- sound/spells/fizzle/fizzlenaturea.ogg - 569775, -- sound/spells/fizzle/fizzlefrosta.ogg - 569776, -- sound/spells/fizzle/fizzleshadowa.ogg -} -for _, fdid in pairs(sounds) do - MuteSoundFile(fdid) -end -``` - -**Description:** -Muted sound settings only persist through relogging and /reload. They have to be muted again after restarting the game client. -This works on all internal game sounds, addon sounds, and sounds played manually by `PlaySoundFile()`. -There is no API to replace sound files. - -**Miscellaneous:** -- **File Data IDs** - - By file name/path, e.g. `Spells/LevelUp,type:ogg` in [wow.tools](https://wow.tools) - - By SoundKitID, e.g. `skit:888` in [wow.tools](https://wow.tools) - - By sound kit name with [wow.tools](https://wow.tools/files/sounds.php) -- **Sound Kit Names/IDs** - - From the sounds tab for an NPC, for example [Waveblade Shaman](https://www.wowhead.com/npc=154304/waveblade-shaman#sounds) - - By sound kit name with [Wowhead Sounds](https://www.wowhead.com/sounds) and `SoundKitName.db2` - - IDs used by the FrameXML are defined in the `SOUNDKIT` table - - The full list of IDs can be found in `SoundKitEntry.db2` \ No newline at end of file diff --git a/wiki-information/functions/NoPlayTime.md b/wiki-information/functions/NoPlayTime.md deleted file mode 100644 index 44c75d61..00000000 --- a/wiki-information/functions/NoPlayTime.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: NoPlayTime - -**Content:** -Returns true if the account is considered "unhealthy" for players on Chinese realms. -`isUnhealthy = NoPlayTime()` - -**Returns:** -- `isUnhealthy` - - *boolean?* - 1 if the account is "unhealthy", nil if not. - -**Usage:** -```lua -if NoPlayTime() then - print(string.format(PLAYTIME_UNHEALTHY, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) -else - print("You are not limited by NoPlayTime.") -end -``` - -**Description:** -Only relevant on Chinese realms. -The time left is stored on your account, and will display the same amount on every character. - -**Reference:** -- `GetBillingTimeRested` - The remaining time until this restriction comes into effect -- `PartialPlayTime` - A form of limited restriction (-50% to xp and currency) that is presumably removed from the game \ No newline at end of file diff --git a/wiki-information/functions/NotWhileDeadError.md b/wiki-information/functions/NotWhileDeadError.md deleted file mode 100644 index c2514bfe..00000000 --- a/wiki-information/functions/NotWhileDeadError.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: NotWhileDeadError - -**Content:** -Generates an error message saying you cannot do that while dead. -`NotWhileDeadError()` - -**Reference:** -- `UI_ERROR_MESSAGE`: "You can't do that when you're dead." \ No newline at end of file diff --git a/wiki-information/functions/NotifyInspect.md b/wiki-information/functions/NotifyInspect.md deleted file mode 100644 index 79502a8c..00000000 --- a/wiki-information/functions/NotifyInspect.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: NotifyInspect - -**Content:** -Requests another player's inventory and talent info before inspecting. -`NotifyInspect(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to inspect. - -**Description:** -Triggers `INSPECT_READY` when information is asynchronously available. -Requires an eligible unit within range, confirmed with `CanInspect()` and `CheckInteractDistance()`. -The client continues checking equipment and talent changes until halted by `ClearInspectPlayer()`. - -**Reference:** -- `RequestInspectHonorData()` - Classic only function for PvP statistics. \ No newline at end of file diff --git a/wiki-information/functions/NumTaxiNodes.md b/wiki-information/functions/NumTaxiNodes.md deleted file mode 100644 index 0ba16792..00000000 --- a/wiki-information/functions/NumTaxiNodes.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: NumTaxiNodes - -**Content:** -Returns the number of flight paths on the taxi map. -`numNodes = NumTaxiNodes()` - -**Returns:** -- `numNodes` - - *number* - total number of flight points on the currently open taxi map; 0 if the taxi map is not open. - -**Description:** -Taxi information is only available while the taxi map is open -- between the `TAXIMAP_OPENED` and `TAXIMAP_CLOSED` events. - -**Reference:** -- `TaxiNodeName` -- `TaxiNodePosition` -- `TakeTaxiNode` \ No newline at end of file diff --git a/wiki-information/functions/OfferPetition.md b/wiki-information/functions/OfferPetition.md deleted file mode 100644 index 3ca59804..00000000 --- a/wiki-information/functions/OfferPetition.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: OfferPetition - -**Content:** -Offers a petition to your target. -`OfferPetition()` - -**Usage:** -You can efficiently ask for petition signatures with a macro like this one: -```lua -#showtooltip -/use item:5863 -/run local s,t={},UnitName("target")for i=1,GetNumPetitionNames()do s=1 end if GetPetitionInfo()and t and not sthen OfferPetition()end -``` - -**Example Use Case:** -This function can be used when you need to gather signatures for a guild charter or arena team charter. By using the provided macro, you can streamline the process of offering the petition to your target, making it easier to collect the necessary signatures. - -**Addons:** -While not commonly used in large addons, this function is particularly useful for players who are forming new guilds or arena teams and need to gather signatures quickly and efficiently. \ No newline at end of file diff --git a/wiki-information/functions/PartialPlayTime.md b/wiki-information/functions/PartialPlayTime.md deleted file mode 100644 index 9dadf8c9..00000000 --- a/wiki-information/functions/PartialPlayTime.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: PartialPlayTime - -**Content:** -Returns true if the account is considered "tired" for players on Chinese realms. -`isTired = NoPlayTime()` - -**Returns:** -- `isTired` - - *boolean?* - 1 if the account is "tired", nil if not. See details below for clarification. Returns nil for EU and US accounts. - -**Usage:** -Based on the official function, changed a bit to output the text in the chat rather than the tooltip on your avatar: -```lua -if PartialPlayTime() then - print(string.format(PLAYTIME_TIRED, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) -elseif NoPlayTime() then - print(string.format(PLAYTIME_UNHEALTHY, REQUIRED_REST_HOURS - math.floor(GetBillingTimeRested()/60))) -else - print("You are not limited by PartialPlayTime nor NoPlayTime.") -end -``` - -**Description:** -Only relevant on Chinese realms. -When you reach 3 hours remaining you will get "tired", reducing both the amount of money and experience that you receive by 50%. -If you play for 5 hours you will get "unhealthy", and won't be able to turn in quests, receive experience or loot. -The time left is stored on your account, and will display the same amount on every character. -The time will decay as you stay logged out. - -**Reference:** -- `GetBillingTimeRested` -- `NoPlayTime` \ No newline at end of file diff --git a/wiki-information/functions/PetAbandon.md b/wiki-information/functions/PetAbandon.md deleted file mode 100644 index 7691095b..00000000 --- a/wiki-information/functions/PetAbandon.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: PetAbandon - -**Content:** -Permanently abandons your pet. -`PetAbandon()` - -**Description:** -Opposed to abandoning via pet portrait menu, THERE IS NO CONFIRMATION before abandoning the pet. -Use with caution. \ No newline at end of file diff --git a/wiki-information/functions/PetAggressiveMode.md b/wiki-information/functions/PetAggressiveMode.md deleted file mode 100644 index 2d8828bc..00000000 --- a/wiki-information/functions/PetAggressiveMode.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: PetAggressiveMode - -**Content:** -Switches your pet to aggressive mode; does nothing. -`PetAggressiveMode()` - -**Description:** -Set your pet in aggressive mode. Requires a button press. - -**Reference:** -[PetAssistMode](#PetAssistMode) \ No newline at end of file diff --git a/wiki-information/functions/PetAttack.md b/wiki-information/functions/PetAttack.md deleted file mode 100644 index 36696f6e..00000000 --- a/wiki-information/functions/PetAttack.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: PetAttack - -**Content:** -Instruct your pet to attack your target. -`PetAttack()` \ No newline at end of file diff --git a/wiki-information/functions/PetCanBeAbandoned.md b/wiki-information/functions/PetCanBeAbandoned.md deleted file mode 100644 index 8d7ef080..00000000 --- a/wiki-information/functions/PetCanBeAbandoned.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: PetCanBeAbandoned - -**Content:** -Returns true if the pet can be abandoned. -`canAbandon = PetCanBeAbandoned()` - -**Returns:** -- `canAbandon` - - *boolean* - true if the player's pet can be abandoned. - -**Usage:** -```lua -if (PetCanBeAbandoned()) then - PetAbandon(); -end -``` - -**Example Use Case:** -This function can be used in a script or addon to check if a player's pet can be abandoned before attempting to abandon it. This is useful in scenarios where you want to ensure that the pet can be safely abandoned without causing errors or unexpected behavior. - -**Addon Example:** -In large addons like "PetTracker," this function might be used to manage pet collections, ensuring that pets can be abandoned when necessary to make room for new ones. \ No newline at end of file diff --git a/wiki-information/functions/PetCanBeRenamed.md b/wiki-information/functions/PetCanBeRenamed.md deleted file mode 100644 index 5fe29fcf..00000000 --- a/wiki-information/functions/PetCanBeRenamed.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: PetCanBeRenamed - -**Content:** -Returns true if the pet can be renamed. -`canRename = PetCanBeRenamed()` - -**Returns:** -- `canRename` - - *boolean* - true if the player's pet can be renamed. - -**Usage:** -```lua -if (PetCanBeRenamed()) then - PetRename("Fuzzy Wuzzy"); -end -``` \ No newline at end of file diff --git a/wiki-information/functions/PetDefensiveMode.md b/wiki-information/functions/PetDefensiveMode.md deleted file mode 100644 index f17d8f92..00000000 --- a/wiki-information/functions/PetDefensiveMode.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: PetDefensiveMode - -**Content:** -Set your pet in defensive mode. -`PetDefensiveMode()` - -**Example Usage:** -```lua --- Set the player's pet to defensive mode -PetDefensiveMode() -``` - -**Description:** -The `PetDefensiveMode` function is used to set the player's pet into defensive mode. In this mode, the pet will automatically attack any enemy that attacks the player or the pet itself. This is useful for ensuring that the pet actively participates in combat without requiring manual commands for each enemy. - -**Common Addons Using This Function:** -Many pet management addons, such as PetTracker and Z-Perl UnitFrames, utilize this function to provide enhanced control over pet behavior, allowing players to easily switch their pet's stance based on the situation. \ No newline at end of file diff --git a/wiki-information/functions/PetFollow.md b/wiki-information/functions/PetFollow.md deleted file mode 100644 index 82eb7142..00000000 --- a/wiki-information/functions/PetFollow.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: PetFollow - -**Content:** -Instruct your pet to follow you. -`PetFollow()` - -**Example Usage:** -This function can be used in macros or scripts to command your pet to follow you, which is particularly useful in combat situations where you need to reposition your pet quickly. - -**Addons:** -Many pet management addons, such as PetTracker, use this function to provide enhanced control over pet behavior, ensuring that pets follow the player when needed. \ No newline at end of file diff --git a/wiki-information/functions/PetPassiveMode.md b/wiki-information/functions/PetPassiveMode.md deleted file mode 100644 index 46a578d7..00000000 --- a/wiki-information/functions/PetPassiveMode.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: PetPassiveMode - -**Content:** -Set your pet into passive mode. -`PetPassiveMode()` - -**Example Usage:** -This function can be used in macros or scripts to ensure that your pet does not attack any targets unless explicitly commanded. For example, in a macro, you might use it to prevent your pet from attacking while you are setting up a strategy or positioning yourself in a PvP scenario. - -**Addons:** -Many pet management addons, such as PetTracker, might use this function to provide better control over pet behavior, ensuring that pets do not engage in combat when not desired. \ No newline at end of file diff --git a/wiki-information/functions/PetRename.md b/wiki-information/functions/PetRename.md deleted file mode 100644 index 87689324..00000000 --- a/wiki-information/functions/PetRename.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: PetRename - -**Content:** -Renames your pet. -`PetRename(name)` - -**Parameters:** -- `name` - - *string* - The new name of the pet - -**Description:** -Only hunters and frost mages can rename their pets. -Each pet can be renamed once. Using this function when the pet has already been renamed results in an error message. \ No newline at end of file diff --git a/wiki-information/functions/PetStopAttack.md b/wiki-information/functions/PetStopAttack.md deleted file mode 100644 index 8313bb40..00000000 --- a/wiki-information/functions/PetStopAttack.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: PetStopAttack - -**Content:** -Stops the pet from attacking. -`PetStopAttack()` - -**Description:** -This function is not called by FrameXML, and is only effective if called by addons while not in combat. - -**Reference:** -[PetAttack](#petattack) \ No newline at end of file diff --git a/wiki-information/functions/PetWait.md b/wiki-information/functions/PetWait.md deleted file mode 100644 index 04405c99..00000000 --- a/wiki-information/functions/PetWait.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: PetWait - -**Content:** -Instruct your pet to remain still. -`PetWait()` - -**Example Usage:** -The `PetWait` function can be used in macros or scripts to control your pet's behavior, particularly useful for hunters and warlocks who rely on their pets for combat and utility. - -**Example Macro:** -```lua -/cast [@pet,exists] PetWait -``` -This macro will instruct your pet to stay in its current position if it exists. \ No newline at end of file diff --git a/wiki-information/functions/PickupAction.md b/wiki-information/functions/PickupAction.md deleted file mode 100644 index 7da19755..00000000 --- a/wiki-information/functions/PickupAction.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: PickupAction - -**Content:** -Places an action onto the cursor. -`PickupAction(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - The action slot to pick the action up from. - -**Returns:** -- `nil` - -**Description:** -If the slot is empty, nothing happens, otherwise the action from the slot is placed on the cursor, and the slot is filled with whatever action was currently being drag-and-dropped (The slot is emptied if the cursor was empty). -If you wish to empty the cursor without putting the item into another slot, try `ClearCursor`. \ No newline at end of file diff --git a/wiki-information/functions/PickupBagFromSlot.md b/wiki-information/functions/PickupBagFromSlot.md deleted file mode 100644 index 01229596..00000000 --- a/wiki-information/functions/PickupBagFromSlot.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: PickupBagFromSlot - -**Content:** -Picks up the bag from the specified slot, placing it in the cursor. -`PickupBagFromSlot(slot)` - -**Parameters:** -- `slot` - - *InventorySlotID* - the slot containing the bag. - -**Description:** -Valid slot numbers are 20-23, numbered from left to right starting after the backpack. -`inventoryID`, the result of `ContainerIDtoInventoryID(BagID)`, can help to compute the slot number and bag numbers can be viewed in the InventorySlotID page. \ No newline at end of file diff --git a/wiki-information/functions/PickupCompanion.md b/wiki-information/functions/PickupCompanion.md deleted file mode 100644 index ae0e8823..00000000 --- a/wiki-information/functions/PickupCompanion.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: PickupCompanion - -**Content:** -Places a mount onto the cursor. -`PickupCompanion(type, index)` - -**Parameters:** -- `type` - - *string* - companion type, either "MOUNT" or "CRITTER". -- `index` - - *number* - index of the companion of the specified type to place on the cursor, ascending from 1. - -**Description:** -You should only use this function to pick up mounts; for critters, this function has been superseded by `C_PetJournal.PickupPet`, and instead places an unusable spell on the cursor. - -**Reference:** -- `GetCursorInfo` -- `GetCompanionInfo` -- `C_PetJournal.PickupPet` \ No newline at end of file diff --git a/wiki-information/functions/PickupContainerItem.md b/wiki-information/functions/PickupContainerItem.md deleted file mode 100644 index 1e785106..00000000 --- a/wiki-information/functions/PickupContainerItem.md +++ /dev/null @@ -1,67 +0,0 @@ -## Title: PickupContainerItem - -**Content:** -Wildcard function usually called when a player left clicks on a slot in their bags. Functionality includes picking up the item from a specific bag slot, putting the item into a specific bag slot, and applying enchants (including poisons and sharpening stones) to the item in a specific bag slot, except if one of the Modifier Keys is pressed. -`PickupContainerItem(bagID, slot)` - -**Parameters:** -- `bagID` - - *number* - id of the bag the slot is located in. -- `slot` - - *number* - slot inside the bag (top left slot is 1, slot to the right of it is 2). - -**Description:** -The function behaves differently depending on what is currently on the cursor: -- If the cursor currently has nothing, calling this will pick up an item from your backpack. -- If the cursor currently contains an item (check with `CursorHasItem()`), calling this will place the item currently on the cursor into the specified bag slot. If there is already an item in that bag slot, the two items will be exchanged. -- If the cursor is set to a spell (typically enchanting and poisons, check with `SpellIsTargeting()`), calling this specifies that you want to cast the spell on the item in that bag slot. - -Trying to pickup the same item twice in the same "time tick" does not work (client seems to flag the item as "locked" and waits for the server to sync). This is only a problem if you might move a single item multiple times (i.e., if you are changing your character's equipped armor, you are not likely to move a single piece of armor more than once). If you might move an object multiple times in rapid succession, you can check the item's 'locked' flag by calling `GetContainerItemInfo`. If you want to do this, you should leverage `OnUpdate` to help you. Avoid constantly checking the lock status inside a tight loop. If you do, you risk getting into a race condition. Once the repeat loop starts running, the client will not get any communication from the server until it finishes. However, it will not finish until the server tells it that the item is unlocked. Here is some sample code that illustrates the problem. - -```lua -function DangerousSwapItems(bag1, slot1, bag2, slot2) - ClearCursor() - repeat - local _, _, locked1 = GetContainerItemInfo(bag1, slot1) - local _, _, locked2 = GetContainerItemInfo(bag2, slot2) - --[[ DANGER! At this point, locked1 and locked2 will not change. They will not change - until the server tells us that the items in question have become unlocked, and that - will not happen until we finish this call stack (i.e. return from this function, - then his caller, then his caller, all the way up our lua code). ]] - until not (locked1 or locked2) - PickupContainerItem(bag1, slot1) - PickupContainerItem(bag2, slot2) -end - -DangerousSwapItems(1, 1, 1, 2) -DangerousSwapItems(1, 2, 1, 3) --DANGER! Item in (1, 2) is likely still locked, and this function will never return! -``` - -A potentially better way to do this is to use coroutines: - -```lua -function SaferSwapItems(bag1, slot1, bag2, slot2) - ClearCursor() - repeat - local _, _, locked1 = GetContainerItemInfo(bag1, slot1) - local _, _, locked2 = GetContainerItemInfo(bag2, slot2) - if locked1 or locked2 then - coroutine.yield() - end - until not (locked1 or locked2) - PickupContainerItem(bag1, slot1) - PickupContainerItem(bag2, slot2) -end - -co = coroutine.create(SaferSwapItems) - -function OnUpdate() - coroutine.resume(co) -- We should actually look at the return value from resume, because - -- it will be false when the coroutine is actually finished -end -``` - -You can also use the event `ITEM_LOCK_CHANGED` instead of `OnUpdate`. - -**Reference:** -- `GetContainerItemInfo` \ No newline at end of file diff --git a/wiki-information/functions/PickupCurrency.md b/wiki-information/functions/PickupCurrency.md deleted file mode 100644 index 20e2a54b..00000000 --- a/wiki-information/functions/PickupCurrency.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: PickupCurrency - -**Content:** -Picks up a currency to the cursor. -`PickupCurrency(type)` - -**Parameters:** -- `type` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/PickupInventoryItem.md b/wiki-information/functions/PickupInventoryItem.md deleted file mode 100644 index 18f399d2..00000000 --- a/wiki-information/functions/PickupInventoryItem.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: PickupInventoryItem - -**Content:** -Picks up / interacts with an equipment slot. -`PickupInventoryItem(slotId)` - -**Parameters:** -- `slotId` - - *number* : InventorySlotId - -**Description:** -If the cursor is empty, then it will attempt to pick up the item in the `slotId`. -If the cursor has an item, then it will attempt to equip the item to the `slotId` and place the previous `slotId` item (if any) where the item on cursor originated. -If the cursor is in repair or spell-casting mode, it will attempt the action on the `slotId`. -You can use `GetInventorySlotInfo` to get the `slotId`: - -**Usage:** -```lua -/script PickupInventoryItem(GetInventorySlotInfo("MainHandSlot")) -/script PickupInventoryItem(GetInventorySlotInfo("SecondaryHandSlot")) -``` -The above attempts a main hand/off-hand weapon swap. It will pick up the weapon from the main hand and then pick up the weapon from the off-hand, attempting to equip the main hand weapon to off-hand and sending the off-hand to main hand if possible. \ No newline at end of file diff --git a/wiki-information/functions/PickupItem.md b/wiki-information/functions/PickupItem.md deleted file mode 100644 index 92c9bddb..00000000 --- a/wiki-information/functions/PickupItem.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: PickupItem - -**Content:** -Place the item on the cursor. -`PickupItem(itemID or itemString or itemName or itemLink)` - -**Parameters:** -- `(itemId or "itemString" or "itemName" or "itemLink")` - - `itemId` - - *number* - The numeric ID of the item. i.e., 12345 - - `itemString` - - *string* - The full item ID in string format, e.g., `"item:12345:0:0:0:0:0:0:0"`. Also supports partial itemStrings, by filling up any missing `:x` value with `:0`, e.g., `"item:12345:0:0:0"` - - `itemName` - - *string* - The Name of the Item, e.g., `"Hearthstone"`. The item must have been equipped, in your bags, or in your bank once in this session for this to work. - - `itemLink` - - *string* - The itemLink, when Shift-Clicking items. - -**Usage:** -```lua -PickupItem(6948) -PickupItem("item:6948") -PickupItem("Hearthstone") -PickupItem(GetContainerItemLink(0, 1)) -``` -Common usage: -```lua -PickupItem(link) -``` - -**Miscellaneous:** -Result: -Picks up the Hearthstone. The 4th example picks up the item in backpack slot 1. \ No newline at end of file diff --git a/wiki-information/functions/PickupMacro.md b/wiki-information/functions/PickupMacro.md deleted file mode 100644 index e2aa8a6c..00000000 --- a/wiki-information/functions/PickupMacro.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: PickupMacro - -**Content:** -Places a macro onto the cursor. -`PickupMacro(index or name)` - -**Parameters:** -- `index` - - *number* - The position of the macro in the macro window, from left to right and top to bottom. Slots 1-120 are used for general macros, and 121-138 for character-specific macros. -- `name` - - *string* - The name of the macro, case insensitive. - -**Usage:** -- Picks up the first character macro. - ```lua - PickupMacro(121) - ``` -- The macro named "Reload" is placed on the cursor. If there is no such named macro then nothing happens. - ```lua - PickupMacro("Reload") - ``` \ No newline at end of file diff --git a/wiki-information/functions/PickupMerchantItem.md b/wiki-information/functions/PickupMerchantItem.md deleted file mode 100644 index a6dc2455..00000000 --- a/wiki-information/functions/PickupMerchantItem.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: PickupMerchantItem - -**Content:** -Places a merchant item onto the cursor. If the cursor already has an item, it will be sold. -`PickupMerchantItem(index)` - -Interesting thing is this function can be used to drop an item to the merchant as well. This will happen if the cursor already holds an item from the player's bag: -```lua -PickupContainerItem(bag, slot) -PickupMerchantItem(0) -``` - -As of patch 2.3, using this function to sell stacks of items does not work; instead, it fails silently. Selling unstacked items works, so unstacking and selling items one by one is an alternative. Blizzard is aware of this issue: [Blizzard Forum](http://forums.worldofwarcraft.com/thread.html?topicId=2855994059#12) - -**Parameters:** -- `index` - - *number* - The index of the item in the merchant's inventory. \ No newline at end of file diff --git a/wiki-information/functions/PickupPetAction.md b/wiki-information/functions/PickupPetAction.md deleted file mode 100644 index 530a7dc0..00000000 --- a/wiki-information/functions/PickupPetAction.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: PickupPetAction - -**Content:** -Places a pet action onto the cursor. -`PickupPetAction(petActionSlot)` - -**Parameters:** -- `petActionSlot` - - *number* - The pet action slot to pick the action up from (1-10). - -**Description:** -If the slot is empty, nothing happens, otherwise the action from the slot is placed on the cursor, and the slot is filled with whatever action was currently being drag-and-dropped (The slot is emptied if the cursor was empty). \ No newline at end of file diff --git a/wiki-information/functions/PickupPetSpell.md b/wiki-information/functions/PickupPetSpell.md deleted file mode 100644 index f4229ad3..00000000 --- a/wiki-information/functions/PickupPetSpell.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: PickupPetSpell - -**Content:** -Picks up a Combat Pet spell. -`PickupPetSpell(spellID)` - -**Parameters:** -- `spellID` - - *number* - Used in PlayerTalentFrame - -**Usage:** -For Cunning combat pet: Boar's Speed -```lua -/run PickupPetSpell(19596) -``` - -**Description:** -The usage error mentions a nonexisting function `Usage: PickupPetActionByID(spellID)` - -**Reference:** -`PickupSpell` \ No newline at end of file diff --git a/wiki-information/functions/PickupPlayerMoney.md b/wiki-information/functions/PickupPlayerMoney.md deleted file mode 100644 index 4360a274..00000000 --- a/wiki-information/functions/PickupPlayerMoney.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: PickupPlayerMoney - -**Content:** -Picks up an amount of money from the player onto the cursor. -`PickupPlayerMoney(copper)` - -**Parameters:** -- `copper` - - *number* - The amount of money, in copper, to place on the cursor. - -**Reference:** -- `PickupTradeMoney` -- `AddTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/PickupSpell.md b/wiki-information/functions/PickupSpell.md deleted file mode 100644 index ccb1df9d..00000000 --- a/wiki-information/functions/PickupSpell.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: PickupSpell - -**Content:** -Places a spell onto the cursor. -`PickupSpell(spellID)` - -**Parameters:** -- `spellID` - - *number* - spell ID of the spell to pick up. - -**Description:** -This function will put a spell on the mouse cursor. - -**Reference:** -- `PickupAction` -- `PickupPetAction` -- `PickupBagFromSlot` -- `PickupContainerItem` -- `PickupInventoryItem` -- `PickupItem` -- `PickupMacro` -- `PickupMerchantItem` -- `PickupPlayerMoney` -- `PickupStablePet` -- `PickupTradeMoney` -- `ClearCursor` - -**Example Usage:** -```lua --- Example of how to use PickupSpell -local spellID = 116 -- Frostbolt for Mages -PickupSpell(spellID) -``` - -**Common Addon Usage:** -Many addons that manage action bars or spell books, such as Bartender4 or Dominos, use `PickupSpell` to allow users to drag and drop spells onto their action bars. \ No newline at end of file diff --git a/wiki-information/functions/PickupSpellBookItem.md b/wiki-information/functions/PickupSpellBookItem.md deleted file mode 100644 index 0a174777..00000000 --- a/wiki-information/functions/PickupSpellBookItem.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: PickupSpellBookItem - -**Content:** -Picks up a skill from the spellbook so that it can subsequently be placed on an action bar. -```lua -PickupSpellBookItem(spell) -PickupSpellBookItem(index, bookType) -``` - -**Parameters:** -- `spell` - - *number|string* - Spell ID or Name. When passing a name requires the spell to be in your Spellbook. -- **Spellbook args** - - `index` - - *number* - Spellbook slot index, ranging from 1 through the total number of spells across all tabs and pages. - - `bookType` - - *string* - `BOOKTYPE_SPELL` or `BOOKTYPE_PET` depending on if you wish to query the player or pet spellbook. - - Internally the game only tests if this is equal to "pet" and treats any other string value as "spell". - - **Constant Values:** - - `BOOKTYPE_SPELL` - - "spell" - The General, Class, Specs, and Professions tabs - - `BOOKTYPE_PET` - - "pet" - The Pet tab - -**Usage:** -The following sequence of macro commands places the Cat Form ability into the current action bar's first slot. -```lua -/run PickupSpellBookItem("Cat Form") -/click ActionButton1 -/run ClearCursor() -``` - -**Example Use Case:** -This function is particularly useful for creating macros that automate the placement of spells and abilities on action bars. For instance, a player might use this function to quickly set up their action bars after resetting their UI or switching specializations. - -**Addons:** -Many popular addons, such as Bartender4 and Dominos, use this function to allow players to customize their action bars by dragging and dropping spells from the spellbook. These addons enhance the default UI by providing more flexible and user-friendly ways to manage action bars. \ No newline at end of file diff --git a/wiki-information/functions/PickupStablePet.md b/wiki-information/functions/PickupStablePet.md deleted file mode 100644 index 9e9a694d..00000000 --- a/wiki-information/functions/PickupStablePet.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: PickupStablePet - -**Content:** -Attaches a pet in your stable to your cursor. -`PickupStablePet(index)` - -**Parameters:** -- `index` - - *number* - 1 for the pet in the slot on the left, and 2 for the pet in the slot on the right. \ No newline at end of file diff --git a/wiki-information/functions/PickupTradeMoney.md b/wiki-information/functions/PickupTradeMoney.md deleted file mode 100644 index b535702e..00000000 --- a/wiki-information/functions/PickupTradeMoney.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: PickupTradeMoney - -**Content:** -Places an amount of money from the player's trade offer onto the cursor. -`PickupTradeMoney(copper)` - -**Parameters:** -- `copper` - - *number* - amount of money, in copper, to pick up. - -**Reference:** -- `PickupPlayerMoney` -- `AddTradeMoney` -- `SetTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/PlaceAction.md b/wiki-information/functions/PlaceAction.md deleted file mode 100644 index 61e8f764..00000000 --- a/wiki-information/functions/PlaceAction.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: PlaceAction - -**Content:** -Places an action onto into the specified action slot. -`PlaceAction(actionSlot)` - -**Parameters:** -- `actionSlot` - - *number* - The action slot to place the action into. - -**Description:** -If the cursor is empty, nothing happens, otherwise the action from the cursor is placed in the slot. If the slot was empty then the cursor becomes empty, otherwise the action from the slot is picked up and placed onto the cursor. -If an action is placed on the cursor use `API_PutItemInBackpack` to remove the action from the cursor without placing it in an action slot. - -**Important:** -You can crash your client if you send an invalid slot number. \ No newline at end of file diff --git a/wiki-information/functions/PlayMusic.md b/wiki-information/functions/PlayMusic.md deleted file mode 100644 index ec7fb8ec..00000000 --- a/wiki-information/functions/PlayMusic.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: PlayMusic - -**Content:** -Plays the specified sound file on loop to the "Music" sound channel. -`willPlay = PlayMusic(sound)` - -**Parameters:** -- `sound` - - *number|string* - FileDataID of a game sound or file path to an addon sound. - -**Returns:** -- `willPlay` - - *boolean* - Seems to always return true even for invalid file paths or FileDataIDs. - -**Usage:** -Plays Stormstout Brew from the Mists of Pandaria Soundtrack -```lua --- by file path (dropped in 8.2.0) -PlayMusic("sound/music/pandaria/mus_50_toast_b_03.mp3") --- by FileDataID 642878 (added support in 8.2.0) -PlayMusic(642878) -``` - -**Description:** -If any of the built-in music is playing when you call this function (e.g. Stormwind background music), it will fade out. -The playback loops until it is stopped with `StopMusic()`, when the user interface is reloaded, or upon logout. Playing a different sound file will also cause the current song to stop playing. It cannot be paused. -OggVorbis (.ogg) files are supported since World of Warcraft uses the FMOD sound engine. -You can find a full list here: [WoW Tools - Sound/Music](https://wow.tools/files/#search=sound/music) \ No newline at end of file diff --git a/wiki-information/functions/PlaySound.md b/wiki-information/functions/PlaySound.md deleted file mode 100644 index 126f14b4..00000000 --- a/wiki-information/functions/PlaySound.md +++ /dev/null @@ -1,76 +0,0 @@ -## Title: PlaySound - -**Content:** -Plays the specified sound by SoundKitID. -`willPlay, soundHandle = PlaySound(soundKitID)` - -**Parameters:** -- `soundKitID` - - *number* - Sound Kit ID in SoundKitEntry.db2. Sounds used in FrameXML are defined in the SOUNDKIT table. -- `channel` - - *string? = SFX* - The sound channel. - - **Channel** - - **Toggle CVar** - - **Volume CVar** - - **Master** - - `Sound_EnableAllSound` - Default: 1 - - `Sound_MasterVolume` - Default: 1.0 (master volume, 0.0 to 1.0) - - **Music** - - `Sound_EnableMusic` - Default: 1 (Enables music) - - `Sound_MusicVolume` - Default: 0.4 - - **SFX (Effects)** - - `Sound_EnableSFX` - Default: 1 - - `Sound_SFXVolume` - Default: 1.0 (sound volume, 0.0 to 1.0) - - **Ambience** - - `Sound_EnableAmbience` - Default: 1 (Enable Ambience) - - `Sound_AmbienceVolume` - Default: 0.6 - - **Dialog** - - `Sound_EnableDialog` - Default: 1 (all dialog) - - `Sound_DialogVolume` - Default: 1.0 (Dialog Volume, 0.0 to 1.0) - - **Talking Head** - - Volume sliders in the interface options -- `forceNoDuplicates` - - *boolean? = true* - Allows duplicate sounds if false. -- `runFinishCallback` - - *boolean? = false* - Fires SOUNDKIT_FINISHED when the sound has finished playing, arg1 will be soundHandle. - -**Returns:** -- `willPlay` - - *boolean* - true if the sound will be played, nil otherwise (prevented by a muted sound channel, for instance). -- `soundHandle` - - *number* - identifier for the queued playback. - -**Usage:** -Plays the ready check sound file (sound/interface/levelup2.ogg) -```lua -PlaySound(SOUNDKIT.READY_CHECK) -- by SOUNDKIT key -PlaySound(8960) -- by SoundKitID -PlaySoundFile(567478) -- by FileDataID -``` - -**Description:** -Sound Kit IDs are used to play a set of random sounds. For example, the human female NPC greeting sound kit refers to 5 different sounds. -```lua -/run PlaySound(5980) -- will play one of these sounds -/run PlaySoundFile(552133) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting01.ogg -/run PlaySoundFile(552141) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting02.ogg -/run PlaySoundFile(552137) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting03.ogg -/run PlaySoundFile(552142) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting04.ogg -/run PlaySoundFile(552144) -- sound/creature/humanfemalestandardnpc/humanfemalestandardnpcgreeting05.ogg -``` - -**Miscellaneous:** -Finding Sound IDs: -- **File Data IDs** - - By file name/path, e.g. Spells/LevelUp, type:ogg in wow.tools - - By SoundKitID, e.g. skit:888 in wow.tools - - By sound kit name with [wow.tools](https://wow.tools/files/sounds.php) -- **Sound Kit Names/IDs** - - From the sounds tab for an NPC, for example [Waveblade Shaman](https://www.wowhead.com/npc=154304/waveblade-shaman#sounds) - - By sound kit name with [Wowhead Sounds](https://www.wowhead.com/sounds) and SoundKitName.db2 - - IDs used by the FrameXML are defined in the SOUNDKIT table - - The full list of IDs can be found in SoundKitEntry.db2 - -**Reference:** -- `PlaySoundFile` - Accepts FileDataIDs and addon file paths. -- `StopSound` \ No newline at end of file diff --git a/wiki-information/functions/PlaySoundFile.md b/wiki-information/functions/PlaySoundFile.md deleted file mode 100644 index 521715dd..00000000 --- a/wiki-information/functions/PlaySoundFile.md +++ /dev/null @@ -1,72 +0,0 @@ -## Title: PlaySoundFile - -**Content:** -Plays the specified sound by FileDataID or addon file path. -`willPlay, soundHandle = PlaySoundFile(sound)` - -**Parameters:** -- `sound` - - *number|string* - Either a FileDataID, or the path to a sound file from an addon. - - The file must exist prior to logging in or reloading. Both .ogg and .mp3 formats are accepted. -- `channel` - - *string?* = SFX - The sound channel. - - **Channel** - - **Toggle CVar** - - **Volume CVar** - - **Master** - - `Sound_EnableAllSound` (Sound) Default: 1 - - `Sound_MasterVolume` (Sound) Default: 1.0 master volume (0.0 to 1.0) - - **Music** - - `Sound_EnableMusic` (Sound) Default: 1 Enables music - - `Sound_MusicVolume` Default: 0.4 - - **SFX (Effects)** - - `Sound_EnableSFX` (Sound) Default: 1 - - `Sound_SFXVolume` (Sound) Default: 1.0 sound volume (0.0 to 1.0) - - **Ambience** - - `Sound_EnableAmbience` (Sound) Default: 1 Enable Ambience - - `Sound_AmbienceVolume` Default: 0.6 - - **Dialog** - - `Sound_EnableDialog` (Sound) Default: 1 all dialog - - `Sound_DialogVolume` (Sound) Default: 1.0 Dialog Volume (0.0 to 1.0) - - **Talking Head** - - Volume sliders in the interface options - -**Returns:** -- `willPlay` - - *boolean* - true if the sound will be played, nil otherwise (prevented by a muted sound channel, for instance). -- `soundHandle` - - *number* - identifier for the queued playback. - -**Usage:** -- Plays a sound file included with your addon and ignores any sound setting except the master volume slider: - ```lua - -- Both slash / or escaped backslashes \\ can be used as file separators. - PlaySoundFile("Interface\\AddOns\\MyAddOn\\mysound.ogg", "Master") - ``` -- Plays the level up sound: - ```lua - -- by file path (dropped in 8.2.0) - PlaySoundFile("Sound/Spells/LevelUp.ogg") - -- by FileDataID 569593 (added support in 8.2.0) - PlaySoundFile(569593) - -- by SoundKitID 888 (SoundKitName LEVELUP) - PlaySound(888) - ``` - -**Miscellaneous:** -- **File Data IDs** - - By file name/path, e.g. `Spells/LevelUp,type:ogg` in wow.tools - - By SoundKitID, e.g. `skit:888` in wow.tools - - By sound kit name with [wow.tools](https://wow.tools/files/sounds.php) -- **Sound Kit Names/IDs** - - From the sounds tab for an NPC, for example [Waveblade Shaman](https://www.wowhead.com/npc=154304/waveblade-shaman#sounds) - - By sound kit name with [Wowhead Sounds](https://www.wowhead.com/sounds) and `SoundKitName.db2` - - IDs used by the FrameXML are defined in the `SOUNDKIT` table - - The full list of IDs can be found in `SoundKitEntry.db2` - -**Reference:** -- `PlaySound` - Plays a sound by SoundKitID -- `StopSound` -- `MuteSoundFile` - Mutes a sound -- `UnmuteSoundFile` -- `PlaySoundFile` macros - Listing of audio files shipped with the game \ No newline at end of file diff --git a/wiki-information/functions/PlayerCanTeleport.md b/wiki-information/functions/PlayerCanTeleport.md deleted file mode 100644 index 77741e41..00000000 --- a/wiki-information/functions/PlayerCanTeleport.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: PlayerCanTeleport - -**Content:** -Needs summary. -`canTeleport = PlayerCanTeleport()` - -**Returns:** -- `canTeleport` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/PlayerEffectiveAttackPower.md b/wiki-information/functions/PlayerEffectiveAttackPower.md deleted file mode 100644 index ee50ad0c..00000000 --- a/wiki-information/functions/PlayerEffectiveAttackPower.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: PlayerEffectiveAttackPower - -**Content:** -Needs summary. -`mainHandAttackPower, offHandAttackPower, rangedAttackPower = PlayerEffectiveAttackPower()` - -**Returns:** -- `mainHandAttackPower` - - *number* -- `offHandAttackPower` - - *number* -- `rangedAttackPower` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/PlayerHasToy.md b/wiki-information/functions/PlayerHasToy.md deleted file mode 100644 index f27a4f9a..00000000 --- a/wiki-information/functions/PlayerHasToy.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: PlayerHasToy - -**Content:** -Determines if player has a specific toy in their toybox. -`hasToy = PlayerHasToy(itemId)` - -**Parameters:** -- `itemId` - - *number* - itemId of a toy. - -**Returns:** -- `hasToy` - - *boolean* - True if player has itemId in their toybox, false if not. - -**Usage:** -```lua -if PlayerHasToy(92738) then - print('Remember to wear your Safari Hat!'); -end -``` - -**Example Use Case:** -This function can be used in addons or macros to check if a player has a specific toy before attempting to use it or reminding the player to use it. For instance, an addon could use this function to ensure that a player has a necessary toy for a particular event or activity. - -**Addons Using This Function:** -Many toy management addons, such as "ToyBoxEnhanced," use this function to manage and organize the player's toy collection, providing features like search, categorization, and usage tracking. \ No newline at end of file diff --git a/wiki-information/functions/PlayerIsPVPInactive.md b/wiki-information/functions/PlayerIsPVPInactive.md deleted file mode 100644 index 711afa15..00000000 --- a/wiki-information/functions/PlayerIsPVPInactive.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: PlayerIsPVPInactive - -**Content:** -Needs summary. -`result = PlayerIsPVPInactive(unit)` - -**Parameters:** -- `unit` - - *string* - UnitToken - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -This function can be used to determine if a player is currently inactive in PvP. For instance, it can be useful in addons that manage PvP status or track player activity in battlegrounds and arenas. - -**Addon Usage:** -Large addons like "Gladius" (an arena unit frame addon) might use this function to check if an opponent is inactive in PvP, allowing the addon to provide more accurate information about the status of enemy players. \ No newline at end of file diff --git a/wiki-information/functions/PostAuction.md b/wiki-information/functions/PostAuction.md deleted file mode 100644 index 3661af64..00000000 --- a/wiki-information/functions/PostAuction.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: PostAuction - -**Content:** -Starts the auction you have created in the Create Auction panel. -`PostAuction(minBid, buyoutPrice, runTime, stackSize, numStacks)` - -**Parameters:** -- `minBid` - - *number* - The minimum bid price for this auction in copper. -- `buyoutPrice` - - *number* - The buyout price for this auction in copper. -- `runTime` - - *number* - The duration for which the auction should be posted. See details for more information. -- `stackSize` - - *number* - The size of each stack to be posted. -- `numStacks` - - *number* - The number of stacks to post. - -**Description:** -Values that may be supplied for the `runTime` parameter can be found in the table below. - -| Value | Duration | -|-------|-----------| -| 1 | 2 hours | -| 2 | 8 hours | -| 3 | 24 hours | \ No newline at end of file diff --git a/wiki-information/functions/PreloadMovie.md b/wiki-information/functions/PreloadMovie.md deleted file mode 100644 index 99660c4f..00000000 --- a/wiki-information/functions/PreloadMovie.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: PreloadMovie - -**Content:** -Needs summary. -`PreloadMovie(movieId)` - -**Parameters:** -- `movieId` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/ProcessExceptionClient.md b/wiki-information/functions/ProcessExceptionClient.md deleted file mode 100644 index bf965be9..00000000 --- a/wiki-information/functions/ProcessExceptionClient.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: ProcessExceptionClient - -**Content:** -Generates textual error logs for any current Lua error. -`ProcessExceptionClient(description)` - -**Parameters:** -- `description` - - *string* - The description of the error being processed. - -**Description:** -This function is invoked by the default global error handler to trigger the generation of textual error logs when a Lua error occurs in a secure execution path. -The `luaErrorExceptions` console variable must be enabled for this function to have any effect. \ No newline at end of file diff --git a/wiki-information/functions/PromoteToLeader.md b/wiki-information/functions/PromoteToLeader.md deleted file mode 100644 index 8b0edb51..00000000 --- a/wiki-information/functions/PromoteToLeader.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: PromoteToLeader - -**Content:** -Promotes a unit to group leader. -`PromoteToLeader(unitId or playerName)` - -**Parameters:** -- `unitId` - - *UnitId* - The unit to promote. -- `playername` - - *PlayerName* - The full name of the player to promote. - -**Usage:** -If you have a character named "Character", to promote him to leader you can type in-game: -```lua -/script PromoteToLeader("Character"); -``` - -**Example Use Case:** -This function is particularly useful in raid or party management addons where leadership roles need to be dynamically assigned based on certain conditions or user inputs. For instance, an addon that automates raid management might use this function to promote a designated raid leader when the raid is formed. - -**Addons Using This Function:** -- **ElvUI**: A comprehensive UI replacement addon that includes raid management features. It might use `PromoteToLeader` to facilitate quick leadership changes during raids. -- **DBM (Deadly Boss Mods)**: A popular addon for raid encounters that could use this function to promote a player to leader for better coordination during boss fights. \ No newline at end of file diff --git a/wiki-information/functions/PutItemInBackpack.md b/wiki-information/functions/PutItemInBackpack.md deleted file mode 100644 index 7f9e7abf..00000000 --- a/wiki-information/functions/PutItemInBackpack.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: PutItemInBackpack - -**Content:** -Places the item on the cursor into the player's backpack. -`PutItemInBackpack()` - -**Description:** -If there is already a partial stack of the item in the backpack, it will attempt to stack them together. - -**Example Usage:** -This function can be used in macros or addons to automate the process of moving items from the cursor to the backpack. For instance, if a player is gathering items and wants to ensure they are always placed in the backpack, this function can be called after picking up each item. - -**Addon Usage:** -Many inventory management addons, such as Bagnon or ArkInventory, might use this function to streamline item organization and ensure that items are placed in the correct bags. \ No newline at end of file diff --git a/wiki-information/functions/PutItemInBag.md b/wiki-information/functions/PutItemInBag.md deleted file mode 100644 index ced98d10..00000000 --- a/wiki-information/functions/PutItemInBag.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: PutItemInBag - -**Content:** -Places the item on the cursor into the specified bag. -`hadItem = PutItemInBag(inventoryID)` - -**Parameters:** -- `inventoryID` - - *number?* : InventorySlotId - Values from `CONTAINER_BAG_OFFSET + 1` to `CONTAINER_BAG_OFFSET + NUM_TOTAL_EQUIPPED_BAG_SLOTS` correspond to the player's bag slots, right-to-left from the first bag after the backpack. - -**Returns:** -- `hadItem` - - *boolean?* - True if the cursor had an item. - -**Description:** -Puts the item on the cursor into the specified bag on the main bar, if it's a bag. Otherwise, attempts to place the item inside the bag in that slot. Note that to place an item in the backpack, you must use `PutItemInBackpack`. - -**Usage:** -The following puts the item on the cursor (if it's not a bag) into the first bag (not including the backpack) starting from the right. -```lua -PutItemInBag(CONTAINER_BAG_OFFSET + 1) -``` \ No newline at end of file diff --git a/wiki-information/functions/QueryAuctionItems.md b/wiki-information/functions/QueryAuctionItems.md deleted file mode 100644 index bddd1cd9..00000000 --- a/wiki-information/functions/QueryAuctionItems.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: QueryAuctionItems - -**Content:** -Queries the server for information about current auctions, only when `CanSendAuctionQuery()` is true. -`QueryAuctionItems(text, minLevel, maxLevel, page, usable, rarity, getAll, exactMatch, filterData)` - -**Parameters:** -- `text` - - *string* - A part of the item's name, or an empty string; limited to 63 bytes. -- `minLevel` - - *number?* - Minimum usable level requirement for items -- `maxLevel` - - *number?* - Maximum usable level requirement for items -- `page` - - *number* - What page in the auction house this shows up. Note that pages start at 0. -- `usable` - - *boolean* - Restricts items to those usable by the current character. -- `rarity` - - *Enum.ItemQuality?* - Restricts the quality of the items found. -- `getAll` - - *boolean* - Download the entire auction house as one single page; see other details below. -- `exactMatch` - - *boolean* - Will only items whose whole name is the same as searchString be found. -- `filterData` - - *table?* - - `Field` - - `Type` - - `Description` - - `classID` - - *number* - ItemType - - `subClassID` - - *number?* - Depends on the ItemType - - `inventoryType` - - *Enum.InventoryType?* - -**Description:** -Queries appear to be throttled at 0.3 seconds normally, or 15 minutes with getAll mode. The return values from `CanSendAuctionQuery()` indicate when each mode is permitted. -getAll mode might disconnect players with low bandwidth. Also see relevant details on client-to-server traffic in `GetAuctionItemInfo()`. -text longer than 63 bytes might disconnect the player. -If any of the entered arguments is of the wrong type, the search assumes a nil value. -No effect if the auction house window is not open. -In 4.0.1, getAll mode only fetches up to 42554 items. This is usually adequate, but high-population realms might have more. - -**Usage:** -Searches for rare items between levels 10 and 19: -```lua -QueryAuctionItems("", 10, 19, 0, nil, nil, false, false, nil) -``` -Searches for anything with the word "Nobles" in it, such as the Darkmoon card deck: -```lua -/script QueryAuctionItems("Nobles", nil, nil, 0, false, nil, false, false, nil) -``` \ No newline at end of file diff --git a/wiki-information/functions/QuestChooseRewardError.md b/wiki-information/functions/QuestChooseRewardError.md deleted file mode 100644 index df3ef8c4..00000000 --- a/wiki-information/functions/QuestChooseRewardError.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: QuestChooseRewardError - -**Content:** -Throws an error when the quest reward method doesn't work. -`QuestChooseRewardError()` - -**Description:** -Fires a `UI_ERROR_MESSAGE ERR_QUEST_MUST_CHOOSE` error. \ No newline at end of file diff --git a/wiki-information/functions/QuestIsDaily.md b/wiki-information/functions/QuestIsDaily.md deleted file mode 100644 index f80b3746..00000000 --- a/wiki-information/functions/QuestIsDaily.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: QuestIsDaily - -**Content:** -Returns true if the offered quest is a daily quest. -`isDaily = QuestIsDaily()` - -**Returns:** -- `isDaily` - - *boolean* - 1 if the offered quest is a daily, nil otherwise - -**Reference:** -- `QuestIsWeekly` - -**Example Usage:** -This function can be used to determine if a quest is a daily quest, which can be useful for addons that track daily quest completion or manage daily quest logs. - -**Addon Usage:** -Many quest tracking addons, such as "Questie" or "World Quest Tracker," may use this function to filter and display daily quests separately from other types of quests. \ No newline at end of file diff --git a/wiki-information/functions/QuestLogPushQuest.md b/wiki-information/functions/QuestLogPushQuest.md deleted file mode 100644 index 06b47efc..00000000 --- a/wiki-information/functions/QuestLogPushQuest.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: QuestLogPushQuest - -**Content:** -Shares the current quest in the quest log with other players. -`QuestLogPushQuest()` - -**Usage:** -```lua -local i = 0; -while (GetQuestLogTitle(i+1) ~= nil) do - i = i + 1; - local title, level, tag, header = GetQuestLogTitle(i); - if (not header) then - SelectQuestLogEntry(i); - if (GetQuestLogPushable()) then - QuestLogPushQuest(); - DEFAULT_CHAT_FRAME:AddMessage(string.format("Attempting to share %s with your group...", title, level)); - return; - end - end -end -local i = 0; -while (GetQuestLogTitle(i+1) ~= nil) do - i = i + 1; - local title, level, tag, header = GetQuestLogTitle(i); - if (not header) then - SelectQuestLogEntry(i); - if (GetQuestLogPushable()) then - QuestLogPushQuest(); - DEFAULT_CHAT_FRAME:AddMessage(string.format("Attempting to share %s with your group...", title, level)); - return; - end - end -end -``` - -**Miscellaneous:** -Result: -Finds and shares the first sharable quest in your quest log. - -**Description:** -The system only attempts to push the quest to grouped players and will fail if a recipient does not qualify for the quest (too low level or hasn't completed prior chain-quests), currently is on the quest or has already completed it. \ No newline at end of file diff --git a/wiki-information/functions/QuestPOIGetIconInfo.md b/wiki-information/functions/QuestPOIGetIconInfo.md deleted file mode 100644 index 33bd4ed9..00000000 --- a/wiki-information/functions/QuestPOIGetIconInfo.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: QuestPOIGetIconInfo - -**Content:** -Returns WorldMap POI icon information for the given quest. -`completed, posX, posY, objective = QuestPOIGetIconInfo(questId)` - -**Parameters:** -- `questId` - - *number* - you can get this from the quest link or from `GetQuestLogTitle(questLogIndex)`. - -**Returns:** -- `completed` - - *boolean* - is the quest completed (the icon is a question mark). -- `posX` - - *number* (between 0 and 1 inclusive) - the X position where the icon is shown on the map. -- `posY` - - *number* (between 0 and 1 inclusive) - the Y position where the icon is shown on the map. -- `objective` - - *number* - which is sometimes negative and doesn't appear to have anything to do with the quest's actual objectives. - -**Usage:** -```lua -local playerX, playerY = GetPlayerMapPosition("player") -local _, questX, questY = QuestPOIGetIconInfo(12345) -local diffX, diffY = abs(playerX - questX), abs(playerY - questY) -local distanceToTarget = math.sqrt(math.pow(diffX, 2) + math.pow(diffY, 2)) -print("You are ", floor(distanceToTarget * 100), " clicks from the target location.") -``` - -**Example Use Case:** -This function can be used to determine the distance between the player's current position and the quest objective on the map. This can be particularly useful for addons that provide navigation assistance or quest tracking features. - -**Addons Using This Function:** -- **TomTom**: A popular navigation addon that provides waypoints and directional arrows to guide players to their destinations. It uses functions like `QuestPOIGetIconInfo` to fetch quest objective locations and display them on the map. -- **QuestHelper**: An addon that helps players complete quests by showing the optimal path and locations of quest objectives. It utilizes this function to gather information about where to direct the player. \ No newline at end of file diff --git a/wiki-information/functions/Quit.md b/wiki-information/functions/Quit.md deleted file mode 100644 index cdadd0b0..00000000 --- a/wiki-information/functions/Quit.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: Quit - -**Content:** -Quits the game. -`Quit()` - -**Reference:** -- `PLAYER_QUITING` - -**See also:** -- `Logout` -- `CancelLogout` \ No newline at end of file diff --git a/wiki-information/functions/RandomRoll.md b/wiki-information/functions/RandomRoll.md deleted file mode 100644 index c83f9a6b..00000000 --- a/wiki-information/functions/RandomRoll.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: RandomRoll - -**Content:** -Performs a random roll between two values. -`RandomRoll(low, high)` - -**Parameters:** -- `low` - - *number* - lowest number (default 1) -- `high` - - *number* - highest number (default 100) - -**Usage:** -```lua -RandomRoll(1, 10) --- Yield: rolls. (1-10) -``` - -**Description:** -If only `low` is provided, it is taken as the highest number. -Does the same as `/random low high`. \ No newline at end of file diff --git a/wiki-information/functions/RejectProposal.md b/wiki-information/functions/RejectProposal.md deleted file mode 100644 index 80febb21..00000000 --- a/wiki-information/functions/RejectProposal.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: RejectProposal - -**Content:** -Declines a LFG invite and leaves the queue. -`RejectProposal()` - -**Reference:** -- `GetLFGProposal` -- `AcceptProposal` \ No newline at end of file diff --git a/wiki-information/functions/RemoveChatWindowChannel.md b/wiki-information/functions/RemoveChatWindowChannel.md deleted file mode 100644 index b59a76ad..00000000 --- a/wiki-information/functions/RemoveChatWindowChannel.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: RemoveChatWindowChannel - -**Content:** -Removes the specified chat channel from a chat window. -`RemoveChatWindowChannel(windowId, channelName)` - -**Parameters:** -- `windowId` - - *number* - index of the chat window/frame (ascending from 1) to remove the channel from. -- `channelName` - - *string* - name of the chat channel to remove from the frame. - -**Description:** -Chat output architecture has changed since release; calling this function alone is no longer sufficient to block a channel from a particular frame in the default UI. Use `ChatFrame_RemoveChannel(chatFrame, "channelName")` instead, like so: -```lua -ChatFrame_RemoveChannel(ChatWindow1, "Trade"); -- DEFAULT_CHAT_FRAME works well, too -``` - -**Reference:** -- `AddChatWindowChannel` \ No newline at end of file diff --git a/wiki-information/functions/RemoveChatWindowMessages.md b/wiki-information/functions/RemoveChatWindowMessages.md deleted file mode 100644 index 93873a47..00000000 --- a/wiki-information/functions/RemoveChatWindowMessages.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: RemoveChatWindowMessages - -**Content:** -Removes the specified chat message type from a chat window. -`RemoveChatWindowMessages(index, messageGroup)` - -**Parameters:** -- `index` - - *number* - chat window index, ascending from 1. -- `messageGroup` - - *string* - message type the chat window should no longer receive, e.g. "EMOTE", "SAY", "RAID". - -**Reference:** -- `AddChatWindowMessages` -- `GetChatWindowMessages` \ No newline at end of file diff --git a/wiki-information/functions/RemoveQuestWatch.md b/wiki-information/functions/RemoveQuestWatch.md deleted file mode 100644 index 26eb418d..00000000 --- a/wiki-information/functions/RemoveQuestWatch.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: RemoveQuestWatch - -**Content:** -Removes a quest from being watched. -`RemoveQuestWatch(questIndex)` - -**Parameters:** -- `questIndex` - - *number* - The index of the quest in the quest log. \ No newline at end of file diff --git a/wiki-information/functions/RemoveTrackedAchievement.md b/wiki-information/functions/RemoveTrackedAchievement.md deleted file mode 100644 index bcc96854..00000000 --- a/wiki-information/functions/RemoveTrackedAchievement.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: RemoveTrackedAchievement - -**Content:** -Untracks an achievement from the WatchFrame. -`RemoveTrackedAchievement(achievementId)` - -**Parameters:** -- `achievementID` - - *number* - ID of the achievement to add to tracking. - -**Reference:** -- `TRACKED_ACHIEVEMENT_UPDATE` -- See also: - - `AddTrackedAchievement` - - `GetTrackedAchievements` - - `GetNumTrackedAchievements` - -**Description:** -A maximum of `WATCHFRAME_MAXACHIEVEMENTS` (10 as of 5.4.8) tracked achievements can be displayed by the WatchFrame at a time. -You may need to manually update the AchievementUI and WatchFrame after calling this function. \ No newline at end of file diff --git a/wiki-information/functions/RenamePetition.md b/wiki-information/functions/RenamePetition.md deleted file mode 100644 index b0fc69fd..00000000 --- a/wiki-information/functions/RenamePetition.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: RenamePetition - -**Content:** -Renames the current petition. -`RenamePetition(name)` - -**Parameters:** -- `name` - - *string* - The new name of the group being created by the petition \ No newline at end of file diff --git a/wiki-information/functions/RepairAllItems.md b/wiki-information/functions/RepairAllItems.md deleted file mode 100644 index 9c71f787..00000000 --- a/wiki-information/functions/RepairAllItems.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: RepairAllItems - -**Content:** -Repairs all equipped and inventory items. -`RepairAllItems()` - -**Parameters:** -- `guildBankRepair` - - *boolean?* - true to use guild funds to repair, otherwise uses player funds. - -**Reference:** -- `CanGuildBankRepair` - -**Example Usage:** -```lua --- Check if the player can use guild funds to repair -if CanGuildBankRepair() then - -- Repair using guild funds - RepairAllItems(true) -else - -- Repair using player funds - RepairAllItems(false) -end -``` - -**Description:** -The `RepairAllItems` function is used to repair all equipped and inventory items of the player. It can optionally use guild funds if the player has the necessary permissions. This function is commonly used in addons that manage inventory and equipment, ensuring that the player's gear is always in top condition. - -**Addons Using This Function:** -- **ElvUI**: A comprehensive UI replacement addon that includes an auto-repair feature, which can automatically repair items using either player or guild funds based on user settings. -- **AutoRepair**: A lightweight addon specifically designed to automatically repair items when visiting a vendor capable of repairs. It can be configured to use guild funds if available. \ No newline at end of file diff --git a/wiki-information/functions/ReplaceEnchant.md b/wiki-information/functions/ReplaceEnchant.md deleted file mode 100644 index 379a7cb8..00000000 --- a/wiki-information/functions/ReplaceEnchant.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: ReplaceEnchant - -**Content:** -Confirms the "Replace Enchant" dialog. -`ReplaceEnchant()` - -**Description:** -When the player attempts to apply an enchant or weapon buff to an item which already has one, the game presents the "Replace Enchant" dialog. This method confirms that dialog allowing the application of the enchant/buff to continue. \ No newline at end of file diff --git a/wiki-information/functions/ReplaceGuildMaster.md b/wiki-information/functions/ReplaceGuildMaster.md deleted file mode 100644 index dbf76a87..00000000 --- a/wiki-information/functions/ReplaceGuildMaster.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ReplaceGuildMaster - -**Content:** -Impeaches the current Guild Master. -`ReplaceGuildMaster()` - -**Reference:** -`CanReplaceGuildMaster` -New in 4.3: Inactive Guild Leader Replacement \ No newline at end of file diff --git a/wiki-information/functions/ReplaceTradeEnchant.md b/wiki-information/functions/ReplaceTradeEnchant.md deleted file mode 100644 index f7f5870f..00000000 --- a/wiki-information/functions/ReplaceTradeEnchant.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: ReplaceTradeEnchant - -**Content:** -Confirms that an enchant applied to the trade frame should replace an existing enchant. -`ReplaceTradeEnchant()` - -**Example Usage:** -This function can be used in scenarios where a player is trading an item that already has an enchantment, and the player wants to replace the existing enchantment with a new one. For instance, if a player is trading a weapon that has a lower-level enchantment and wants to apply a higher-level enchantment before completing the trade, this function would confirm the replacement. - -**Addons:** -While there are no specific large addons that are known to use this function directly, it could be utilized in custom trading or enchanting addons where managing enchantments during trades is necessary. \ No newline at end of file diff --git a/wiki-information/functions/RepopMe.md b/wiki-information/functions/RepopMe.md deleted file mode 100644 index e6646f69..00000000 --- a/wiki-information/functions/RepopMe.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: RepopMe - -**Content:** -Releases your ghost to the graveyard when dead. -`RepopMe()` - -**Description:** -This is the "Release Spirit" button. \ No newline at end of file diff --git a/wiki-information/functions/ReportBug.md b/wiki-information/functions/ReportBug.md deleted file mode 100644 index d501cd12..00000000 --- a/wiki-information/functions/ReportBug.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ReportBug - -**Content:** -Needs summary. -`ReportBug(description)` - -**Parameters:** -- `description` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/ReportPlayerIsPVPAFK.md b/wiki-information/functions/ReportPlayerIsPVPAFK.md deleted file mode 100644 index 14037534..00000000 --- a/wiki-information/functions/ReportPlayerIsPVPAFK.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ReportPlayerIsPVPAFK - -**Content:** -Needs summary. -`ReportPlayerIsPVPAFK(unit)` - -**Parameters:** -- `unit` - - *string* - UnitToken \ No newline at end of file diff --git a/wiki-information/functions/ReportSuggestion.md b/wiki-information/functions/ReportSuggestion.md deleted file mode 100644 index 65be19ad..00000000 --- a/wiki-information/functions/ReportSuggestion.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ReportSuggestion - -**Content:** -Needs summary. -`ReportSuggestion(description)` - -**Parameters:** -- `description` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/RequestBattlefieldScoreData.md b/wiki-information/functions/RequestBattlefieldScoreData.md deleted file mode 100644 index 1d250c41..00000000 --- a/wiki-information/functions/RequestBattlefieldScoreData.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: RequestBattlefieldScoreData - -**Content:** -Requests the latest battlefield score data from the server. -`RequestBattlefieldScoreData()` - -**Reference:** -`UPDATE_BATTLEFIELD_SCORE` fires when updated (altered) data is available. \ No newline at end of file diff --git a/wiki-information/functions/RequestBattlegroundInstanceInfo.md b/wiki-information/functions/RequestBattlegroundInstanceInfo.md deleted file mode 100644 index b865a496..00000000 --- a/wiki-information/functions/RequestBattlegroundInstanceInfo.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: RequestBattlegroundInstanceInfo - -**Content:** -Requests the available instances of a battleground. -`RequestBattlegroundInstanceInfo(index)` - -**Parameters:** -- `index` - - *number* - Index of the battleground type to request instance information for; valid indices start from 1 and go up to `GetNumBattlegroundTypes()`. - -**Reference:** -- `PVPQUEUE_ANYWHERE_SHOW` is fired when the requested information becomes available. -- **See Also:** - - `GetNumBattlefields` - - `GetBattlefieldInfo` - -**Description:** -Calling `JoinBattlefield` after calling this function, but before `PVPQUEUE_ANYWHERE_SHOW`, will fail silently; you must wait for the instance list to become available before you can queue for an instance. \ No newline at end of file diff --git a/wiki-information/functions/RequestInspectHonorData.md b/wiki-information/functions/RequestInspectHonorData.md deleted file mode 100644 index 3ea10a90..00000000 --- a/wiki-information/functions/RequestInspectHonorData.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: RequestInspectHonorData - -**Content:** -Requests PvP participation information for the currently inspected target. -`RequestInspectHonorData()` - -**Reference:** -`INSPECT_HONOR_UPDATE` fires when the requested information is available. - -See also: -- `HasInspectHonorData` -- `GetInspectArenaData` - -**Example Usage:** -This function can be used in an addon to fetch and display the PvP participation details of another player when inspecting them. For instance, an addon could use this to show the honor points, battleground statistics, and other PvP-related data of the inspected player. - -**Addon Usage:** -Large addons like "Details! Damage Meter" or "ElvUI" might use this function to provide detailed PvP statistics and enhance the inspection features, allowing players to see comprehensive PvP data of others in their UI. \ No newline at end of file diff --git a/wiki-information/functions/RequestInviteFromUnit.md b/wiki-information/functions/RequestInviteFromUnit.md deleted file mode 100644 index 207f13dc..00000000 --- a/wiki-information/functions/RequestInviteFromUnit.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: RequestInviteFromUnit - -**Content:** -Attempt to request an invite into the target party. -`RequestInviteFromUnit(targetName)` - -**Parameters:** -- `targetName` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/RequestRaidInfo.md b/wiki-information/functions/RequestRaidInfo.md deleted file mode 100644 index d9128028..00000000 --- a/wiki-information/functions/RequestRaidInfo.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: RequestRaidInfo - -**Content:** -Requests which instances the player is saved to. -`RequestRaidInfo()` - -**Reference:** -- `UPDATE_INSTANCE_INFO` - - When your query has finished processing on the server and the raid info is available. - -**Example Usage:** -This function can be used in an addon to check which raid instances a player is currently saved to. For example, an addon could call `RequestRaidInfo()` and then listen for the `UPDATE_INSTANCE_INFO` event to update a UI element displaying the player's raid lockouts. - -**Addon Usage:** -Many raid management addons, such as "SavedInstances," use this function to track and display the raid lockout status of all characters on an account. This helps players manage their raid schedules and avoid missing out on loot opportunities. \ No newline at end of file diff --git a/wiki-information/functions/RequestRatedInfo.md b/wiki-information/functions/RequestRatedInfo.md deleted file mode 100644 index 54021732..00000000 --- a/wiki-information/functions/RequestRatedInfo.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: RequestRatedInfo - -**Content:** -Requests information about the player's rated PvP stats from the server. -`RequestRatedInfo()` - -**Description:** -Triggers `PVP_RATED_STATS_UPDATE` when the client receives a reply from the server. -FrameXML (counterintuitively) uses the event to update player's PvP currencies and random/holiday battleground rewards. \ No newline at end of file diff --git a/wiki-information/functions/RequestTimePlayed.md b/wiki-information/functions/RequestTimePlayed.md deleted file mode 100644 index a2818262..00000000 --- a/wiki-information/functions/RequestTimePlayed.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: RequestTimePlayed - -**Content:** -Requests a summary of time played. -`RequestTimePlayed()` - -**Reference:** -`TIME_PLAYED_MSG` event will be fired when the answer has arrived. \ No newline at end of file diff --git a/wiki-information/functions/ResetCursor.md b/wiki-information/functions/ResetCursor.md deleted file mode 100644 index 87df9c75..00000000 --- a/wiki-information/functions/ResetCursor.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: ResetCursor - -**Content:** -Resets mouse cursor. -`ResetCursor()` - -**Parameters:** -- None - -**Returns:** -- None - -**Description:** -Function resets mouse cursor into its default shape, if it has been previously altered by `SetCursor(cursor)`. Calling `ResetCursor()` is equivalent to calling `SetCursor(nil)`. \ No newline at end of file diff --git a/wiki-information/functions/ResetTutorials.md b/wiki-information/functions/ResetTutorials.md deleted file mode 100644 index 5f1cc4aa..00000000 --- a/wiki-information/functions/ResetTutorials.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: ResetTutorials - -**Content:** -Starts with the first tutorial again -`ResetTutorials()` - -**Parameters:** -- Nothing - -**Returns:** -- Nothing - -**Description:** -Using this function will immediately display the first tutorial, even if you don't have them enabled. \ No newline at end of file diff --git a/wiki-information/functions/ResistancePercent.md b/wiki-information/functions/ResistancePercent.md deleted file mode 100644 index c17a9cf7..00000000 --- a/wiki-information/functions/ResistancePercent.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: ResistancePercent - -**Content:** -Needs summary. -`resistance = ResistancePercent(resistance, casterLevel)` - -**Parameters:** -- `resistance` - - *number* -- `casterLevel` - - *number* - -**Returns:** -- `resistance` - - *number* - -**Example Usage:** -This function can be used to calculate the percentage of resistance a character has against a specific type of damage, taking into account the caster's level. This can be useful in determining how much damage will be mitigated in combat scenarios. - -**Usage in Addons:** -While specific large addons using this function are not documented, it is likely used in combat analysis and optimization addons to provide players with detailed information about their resistance stats and how they affect incoming damage. \ No newline at end of file diff --git a/wiki-information/functions/RespondInstanceLock.md b/wiki-information/functions/RespondInstanceLock.md deleted file mode 100644 index 130cacb0..00000000 --- a/wiki-information/functions/RespondInstanceLock.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: RespondInstanceLock - -**Content:** -Needs summary. -`RespondInstanceLock(acceptLock)` - -**Parameters:** -- `acceptLock` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ResurrectGetOfferer.md b/wiki-information/functions/ResurrectGetOfferer.md deleted file mode 100644 index c809afe6..00000000 --- a/wiki-information/functions/ResurrectGetOfferer.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ResurrectGetOfferer - -**Content:** -Needs summary. -`name = ResurrectGetOfferer()` - -**Returns:** -- `name` - - *string* \ No newline at end of file diff --git a/wiki-information/functions/ResurrectHasSickness.md b/wiki-information/functions/ResurrectHasSickness.md deleted file mode 100644 index bb7565be..00000000 --- a/wiki-information/functions/ResurrectHasSickness.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ResurrectHasSickness - -**Content:** -Needs summary. -`result = ResurrectHasSickness()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ResurrectHasTimer.md b/wiki-information/functions/ResurrectHasTimer.md deleted file mode 100644 index abdd14c9..00000000 --- a/wiki-information/functions/ResurrectHasTimer.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ResurrectHasTimer - -**Content:** -Needs summary. -`result = ResurrectHasTimer()` - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/RetrieveCorpse.md b/wiki-information/functions/RetrieveCorpse.md deleted file mode 100644 index f112fb26..00000000 --- a/wiki-information/functions/RetrieveCorpse.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: RetrieveCorpse - -**Content:** -Resurrects when the player is standing near its corpse. -`RetrieveCorpse()` - -**Description:** -This is the "Accept" button one sees after running back to their body. -Requires there to be no active resurrection timer penalty. \ No newline at end of file diff --git a/wiki-information/functions/RollOnLoot.md b/wiki-information/functions/RollOnLoot.md deleted file mode 100644 index d0321c3f..00000000 --- a/wiki-information/functions/RollOnLoot.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: RollOnLoot - -**Content:** -Rolls or passes on loot. -`RollOnLoot(rollID)` - -**Parameters:** -- `rollID` - - *number* - The number increases with every roll you have in a party. Maximum value is unknown. -- `rollType` - - *number?* - 0 or nil to pass, 1 to roll Need, 2 to roll Greed, or 3 to roll Disenchant. - -**Usage:** -The code snippet below will display a message when you roll or pass on a roll. This could easily be changed to record how many times you roll on loot. -```lua -hooksecurefunc("RollOnLoot", function(rollID, rollType) - if (rollType and rollType > 0) then - DEFAULT_CHAT_FRAME:AddMessage("You rolled on the item with id: " .. rollID ); - else - DEFAULT_CHAT_FRAME:AddMessage("You passed on the item with id: " .. rollID ); - end -end) -``` - -**Example Use Case:** -This function can be used in addons that manage loot distribution in parties or raids. For instance, an addon could track the number of times a player rolls Need, Greed, or Disenchant on items to provide statistics or enforce loot rules. - -**Addons Using This Function:** -- **LootMaster:** This addon uses `RollOnLoot` to manage and automate loot distribution in raids, ensuring fair distribution based on predefined rules. -- **EPGP Lootmaster:** Utilizes `RollOnLoot` to integrate with the EPGP (Effort Points/Gear Points) system, allowing players to roll on loot while keeping track of their points. \ No newline at end of file diff --git a/wiki-information/functions/RunBinding.md b/wiki-information/functions/RunBinding.md deleted file mode 100644 index d592ace3..00000000 --- a/wiki-information/functions/RunBinding.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: RunBinding - -**Content:** -Executes a key binding. -`RunBinding(command)` - -**Parameters:** -- `command` - - *string* - Name of the key binding to be executed -- `up` - - *string?* - If "up", the binding is run as if the key was released. - -**Usage:** -The call below toggles the display of the FPS counter, as if CTRL+R was pressed. -```lua -RunBinding("TOGGLEFPS"); -``` - -**Description:** -The `command` argument must match one of the (usually capitalized) binding names in a Bindings.xml file. This can be a name that appears in the Blizzard FrameXML Bindings.xml, or one that is specified in an AddOn. -`RunBinding` cannot be used to call a Protected Function from insecure execution paths. -By default, the key binding is executed as if the key was pressed down, in other words, the `keystate` variable will have value "down" during the binding's execution. By specifying the optional second argument (the actual string "up"), the binding is instead executed as if the key was released, in other words, the `keystate` variable will have value "up" during the binding's execution. \ No newline at end of file diff --git a/wiki-information/functions/RunMacro.md b/wiki-information/functions/RunMacro.md deleted file mode 100644 index 65e75614..00000000 --- a/wiki-information/functions/RunMacro.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: RunMacro - -**Content:** -Executes a macro. -`RunMacro(macroID or macroName)` - -**Parameters:** -- `macroID` - - *number* - the position of the macro in the macro frame. Starting at the top left macro with 1, counting from left to right and top to bottom. The IDs of the first page (all characters) range from 1-36, the second page 37-54. -- OR -- `macroName` - - *string* - the name of the macro as it is displayed in the macro frame \ No newline at end of file diff --git a/wiki-information/functions/RunMacroText.md b/wiki-information/functions/RunMacroText.md deleted file mode 100644 index bddac16f..00000000 --- a/wiki-information/functions/RunMacroText.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: RunMacroText - -**Content:** -Executes a string as if it was a macro. -`RunMacroText(macro)` - -**Parameters:** -- `macro` - - *string* - the string is interpreted as a macro and then executed - -**Usage:** -This creates an invisible button in the middle of the screen, that prints Hello World! every time it is clicked with the left button. -```lua --- Create the macro to use -local myMacro = [=[ -/run print("Hello") -/run print("World!") -]=] --- Create the secure frame to activate the macro -local frame = CreateFrame("Button", nil, UIParent, "SecureActionButtonTemplate"); -frame:SetPoint("CENTER") -frame:SetSize(100, 100); -frame:SetAttribute("type", "macro") -frame:SetAttribute("macrotext", myMacro); -frame:RegisterForClicks("LeftButtonUp"); -``` - -**Description:** -Macros are executed via the client repeatedly firing the EXECUTE_CHAT_LINE event. -The maximum macro length via this method is 1023 characters. \ No newline at end of file diff --git a/wiki-information/functions/RunScript.md b/wiki-information/functions/RunScript.md deleted file mode 100644 index 3cec46a5..00000000 --- a/wiki-information/functions/RunScript.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: RunScript - -**Content:** -Executes a string of Lua code. -`RunScript(script)` - -**Parameters:** -- `script` - - *string* - The code which is to be executed. - -**Usage:** -To define a function dynamically you could do: -```lua -local retExpr = '\"Hello \" .. UnitName(\"target\")'; -RunScript("function My_GetGreeting() return " .. retExpr .. ";end"); -``` - -**Miscellaneous:** -Result: - -The `My_GetGreeting()` function will be defined to return "Hello" followed by the name of your target. - -**Description:** -This function is NOT recommended for general use within addons for a number of reasons: -1. It'll do whatever you tell it, that includes calling functions, setting variables, whatever. -2. Errors in the script string produce the error popup (at least, they produce the `UI_ERROR_MESSAGE` event). - -On the other hand, it's invaluable if you need to run code that is input by the player at run-time, or do self-generating code. - -**Reference:** -The standard Lua function API `loadstring`, which can overcome all of the problems of `RunScript` described above. \ No newline at end of file diff --git a/wiki-information/functions/SaveBindings.md b/wiki-information/functions/SaveBindings.md deleted file mode 100644 index 28e889e3..00000000 --- a/wiki-information/functions/SaveBindings.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: SaveBindings - -**Content:** -Saves account or character specific key bindings. -`SaveBindings(which)` - -**Parameters:** -- `which` - - *number* - Whether the key bindings should be saved as account or character specific. - - `Value` - - `Constant` - - `Description` - - `0` - - `DEFAULT_BINDINGS` - - `1` - - `ACCOUNT_BINDINGS` - - `2` - - `CHARACTER_BINDINGS` - -**Description:** -Bindings are stored in `WTF\Account\ACCOUNTNAME\bindings-cache.wtf`. -Triggers `UPDATE_BINDINGS`. - -**Reference:** -- `GetCurrentBindingSet` - -**Example Usage:** -```lua --- Save current key bindings as character-specific -SaveBindings(2) -``` - -**Addons Using This Function:** -Many large addons that manage custom key bindings, such as Bartender4 and ElvUI, use this function to save user-defined key bindings either globally or per character. This allows users to have different key bindings for different characters or a consistent set across all characters. \ No newline at end of file diff --git a/wiki-information/functions/SaveView.md b/wiki-information/functions/SaveView.md deleted file mode 100644 index 703b6cde..00000000 --- a/wiki-information/functions/SaveView.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: SaveView - -**Content:** -Saves a camera angle. The last position loaded is stored in the CVar `cameraView`. -`SaveView(viewIndex)` - -**Parameters:** -- `viewIndex` - - *number* - The index (2-5) to save the camera angle to. (1 is reserved for first person view) - -**Description:** -Saved views are preserved across sessions. -Use `ResetView(viewIndex)` to reset a view to its default. -The last position loaded is stored in the CVar `cameraView`. -The game's camera following style is not applied while you are in a saved view. (See: [Camera Following Style Problem/Bug](https://us.forums.blizzard.com/en/wow/t/camera-following-style-problembug/442862/17)) - -**Miscellaneous:** -Fixed: A bug in 3.0-patches causes SaveView variables not to load the first time you load a character after entering the game. -Reloading the UI, or reloading the character from the character selection screen, will fix this bug. Source \ No newline at end of file diff --git a/wiki-information/functions/Screenshot.md b/wiki-information/functions/Screenshot.md deleted file mode 100644 index 423a5b11..00000000 --- a/wiki-information/functions/Screenshot.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: Screenshot - -**Content:** -Takes a screenshot. -`Screenshot()` - -**Description:** -- **Name:** Saves a file with the following format: `WoWScrnShot_MMDDYY_HHMMSS.jpg` -- **Path:** `"...\\World of Warcraft\\_retail_\\Screenshots"` -- **Format:** The format is controlled by CVar `screenshotFormat` which can be set to `"jpeg"` (default), `"png"` or `"tga"`. - -**Usage:** -`/run Screenshot()` - -### Example Use Case: -This function can be used to programmatically take a screenshot in-game, which can be useful for addons that need to capture the screen at specific moments, such as for automated documentation or bug reporting tools. - -### Addons: -Many large addons, such as WeakAuras, might use this function to capture screenshots when certain events occur, helping players to document their gameplay or share specific moments with others. \ No newline at end of file diff --git a/wiki-information/functions/SearchLFGGetNumResults.md b/wiki-information/functions/SearchLFGGetNumResults.md deleted file mode 100644 index 6faeef63..00000000 --- a/wiki-information/functions/SearchLFGGetNumResults.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: SearchLFGGetNumResults - -**Content:** -Returns how many players are listed in the raid browser for the selected LFG id. -`numResults, totalResults = SearchLFGGetNumResults()` - -**Returns:** -- `numResults` - - *number* - Amount of players listed in Raid Browser (displayed?) -- `totalResults` - - *number* - Total amount of players listed in Raid Browser - -**Reference:** -- `SearchLFGGetResults()` -- `SearchLFGGetPartyResults()` -- `SearchLFGJoin()` \ No newline at end of file diff --git a/wiki-information/functions/SearchLFGJoin.md b/wiki-information/functions/SearchLFGJoin.md deleted file mode 100644 index 1bb621fb..00000000 --- a/wiki-information/functions/SearchLFGJoin.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: SearchLFGJoin - -**Content:** -Allows a player to join Raid Browser list. -`SearchLFGJoin(typeID, lfgID)` - -**Parameters:** -- `typeID` - - *number* - LFG typeid -- `lfgID` - - *number* - ID of LFG dungeon - -**Reference:** -- `SearchLFGGetResults()` -- `SearchLFGGetPartyResults()` - -**Example Usage:** -This function can be used to programmatically add a player to the Raid Browser list for a specific dungeon or raid. For instance, an addon could use this function to automate the process of joining the LFG queue for a specific raid. - -**Addons:** -Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** might use this function to enhance their LFG functionalities, such as automatically joining specific raid queues based on user preferences or raid schedules. \ No newline at end of file diff --git a/wiki-information/functions/SecureCmdOptionParse.md b/wiki-information/functions/SecureCmdOptionParse.md deleted file mode 100644 index 67395806..00000000 --- a/wiki-information/functions/SecureCmdOptionParse.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: SecureCmdOptionParse - -**Content:** -Evaluates macro conditionals without the need of a macro. -`result, target = SecureCmdOptionParse(options)` - -**Parameters:** -- `options` - - *string* - a secure command options string to be parsed, e.g. "ALT is held down; CTRL is held down, but ALT is not; neither ALT nor CTRL is held down". - -**Returns:** -- `result` - - *string* - value of the first satisfied clause in options, or no return (nil) if none of the conditions in options are satisfied. -- `target` - - *string* - the target of the first satisfied clause in options (using either the target=... or @... conditional), nil if the clause does not explicitly specify a target, or no return (nil) if none of the conditions in options are satisfied. - -**Description:** -Note that item links cannot be part of options string as they contain square brackets, which get interpreted by the parser as conditions. -This function is available in the RestrictedEnvironment, and is used to evaluate the options for secure macro commands. - -**Reference:** -- Secure command options -- SecureStateDriver \ No newline at end of file diff --git a/wiki-information/functions/SelectGossipActiveQuest.md b/wiki-information/functions/SelectGossipActiveQuest.md deleted file mode 100644 index 9a120260..00000000 --- a/wiki-information/functions/SelectGossipActiveQuest.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SelectGossipActiveQuest - -**Content:** -Selects an active quest from a gossip list. -`SelectGossipActiveQuest(index)` - -**Parameters:** -- `index` - - *number* - Index of the active quest to select, from 1 to `GetNumGossipActiveQuests()`; order corresponds to the order of return values from `GetGossipActiveQuests()`. - -**Reference:** -`QUEST_PROGRESS` is fired when the details of the quest are available. \ No newline at end of file diff --git a/wiki-information/functions/SelectGossipAvailableQuest.md b/wiki-information/functions/SelectGossipAvailableQuest.md deleted file mode 100644 index 439584a8..00000000 --- a/wiki-information/functions/SelectGossipAvailableQuest.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SelectGossipAvailableQuest - -**Content:** -Selects an available quest from a gossip list. -`SelectGossipAvailableQuest(index)` - -**Parameters:** -- `index` - - *number* - Index of the available quest to select, from 1 to `GetNumGossipAvailableQuests()`; order corresponds to the order of return values from `GetGossipAvailableQuests()`. - -**Reference:** -`QUEST_PROGRESS` is fired when the details of the quest are available. \ No newline at end of file diff --git a/wiki-information/functions/SelectGossipOption.md b/wiki-information/functions/SelectGossipOption.md deleted file mode 100644 index 67f5763d..00000000 --- a/wiki-information/functions/SelectGossipOption.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SelectGossipOption - -**Content:** -Selects a gossip (conversation) option. -`SelectGossipOption(index)` - -**Parameters:** -- `index` - - *number* - Index of the gossip option to select, from 1 to `GetNumGossipOptions()`; order corresponds to the order of return values from `GetGossipOptions()`. \ No newline at end of file diff --git a/wiki-information/functions/SelectQuestLogEntry.md b/wiki-information/functions/SelectQuestLogEntry.md deleted file mode 100644 index 7d8a71fd..00000000 --- a/wiki-information/functions/SelectQuestLogEntry.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: SelectQuestLogEntry - -**Content:** -Makes a quest in the quest log the currently selected quest. -`SelectQuestLogEntry(questIndex)` - -**Parameters:** -- `questIndex` - - *number* - quest log entry index to select, ascending from 1. - -**Description:** -This function is called whenever the user clicks on a quest name in the quest log. -It is necessary to call this function to allow other API functions that do not take a questIndex argument to return information about specific quests. \ No newline at end of file diff --git a/wiki-information/functions/SelectTrainerService.md b/wiki-information/functions/SelectTrainerService.md deleted file mode 100644 index 941e810b..00000000 --- a/wiki-information/functions/SelectTrainerService.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SelectTrainerService - -**Content:** -Notifies the server that a trainer service has been selected. -`SelectTrainerService(index)` - -**Parameters:** -- `index` - - *number* - Index of the trainer service being selected. Note that indices are affected by the trainer filter. (See `GetTrainerServiceTypeFilter` and `SetTrainerServiceTypeFilter`.) - -**Returns:** -- `nil` \ No newline at end of file diff --git a/wiki-information/functions/SelectedRealmName.md b/wiki-information/functions/SelectedRealmName.md deleted file mode 100644 index 5cce17d9..00000000 --- a/wiki-information/functions/SelectedRealmName.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SelectedRealmName - -**Content:** -Returns the realm name that will be used in Recruit-a-Friend invitations. -`selectedRealmName = SelectedRealmName()` - -**Returns:** -- `selectedRealmName` - - *string* - realm name, e.g. "Die Aldor". - -**Description:** -Generally the player character's own realm. \ No newline at end of file diff --git a/wiki-information/functions/SendChatMessage.md b/wiki-information/functions/SendChatMessage.md deleted file mode 100644 index cd8ae223..00000000 --- a/wiki-information/functions/SendChatMessage.md +++ /dev/null @@ -1,102 +0,0 @@ -## Title: SendChatMessage - -**Content:** -Sends a chat message. -`SendChatMessage(msg)` - -**Parameters:** -- `msg` - - *string* - The message to be sent. Large messages are truncated to max 255 characters, and only valid chat message characters are permitted. -- `chatType` - - *string?* - The type of message to be sent, e.g. "PARTY". If omitted, this defaults to "SAY". -- `languageID` - - *number?* - The languageID used for the message. Only works with chatTypes "SAY" and "YELL", and only if not in a group. If omitted the default language will be used: Orcish for the Horde and Common for the Alliance, as returned by `GetDefaultLanguage()`. -- `target` - - *string|number?* - The player name or channel number receiving the message for "WHISPER" or "CHANNEL" chatTypes. - -**Miscellaneous:** -- HW - denotes if the chatType requires a hardware event when in the outdoor world, i.e. not in an instance/battleground. -- `chatType` - - `Command` - - `HW` - - `Description` - - `"SAY"` - - `/s, /say` - - ✔️ - - Chat message to nearby players - - `"EMOTE"` - - `/e, /emote` - - Custom text emote to nearby players (See `DoEmote` for normal emotes) - - `"YELL"` - - `/y, /yell` - - ✔️ - - Chat message to far away players - - `"PARTY"` - - `/p, /party` - - Chat message to party members - - `"RAID"` - - `/ra, /raid` - - Chat message to raid members - - `"RAID_WARNING"` - - `/rw` - - Audible warning message to raid members - - `"INSTANCE_CHAT"` - - `/i, /instance` - - Chat message to the instance group (Dungeon finder / Battlegrounds / Arena) - - `"GUILD"` - - `/g, /guild` - - Chat message to guild members - - `"OFFICER"` - - `/o, /officer` - - Chat message to guild officers - - `"WHISPER"` - - `/w, /whisper/t, /tell` - - Whisper to a specific other player, use player name as target argument - - `"CHANNEL"` - - `/1, /2, ...` - - ✔️ - - Chat message to a specific global/custom chat channel, use channel number as target argument - - `"AFK"` - - `/afk` - - Not a real channel; Sets your AFK message. Send an empty message to clear AFK status. - - `"DND"` - - `/dnd` - - Not a real channel; Sets your DND message. Send an empty message to clear DND status. - - `"VOICE_TEXT"` - - Sends text-to-speech to the in-game voice chat. - -**Description:** -Fires `CHAT_MSG_*` events, e.g. `CHAT_MSG_SAY` and `CHAT_MSG_CHANNEL`. -- `"RAID_WARNING"` is accessible to raid leaders/assistants, or to all members of a party (when not in a raid). -- `"WHISPER"` works across all realms in a region, it's not restricted to connected realms and you don't need to have interacted with the recipient before. - -**Usage:** -- Sends a message, defaults to "SAY". - ```lua - SendChatMessage("Hello world") - ``` -- Sends a /yell message. - ```lua - SendChatMessage("For the Horde!", "YELL") - DoEmote("FORTHEHORDE") - ``` -- Sends a message to General Chat which is usually on channel index 1. - ```lua - SendChatMessage("Hello friends", "CHANNEL", nil, 1) - ``` -- Whispers your target. - ```lua - SendChatMessage("My, you're a tall one!", "WHISPER", nil, UnitName("target")) - ``` -- Sets your /dnd message. - ```lua - SendChatMessage("Grabbing a beer", "DND") - ``` -- Speaks in Thalassian, provided your character knows the language. - ```lua - SendChatMessage("Ugh, I hate Thunder Bluff! You can't find a good burger anywhere.", "SAY", 10) - ``` -- Sends a message to an instance group, raid, or party. - ```lua - SendChatMessage("Hello there o/", IsInGroup(LE_PARTY_CATEGORY_INSTANCE) and "INSTANCE_CHAT" or IsInRaid() and "RAID" or "PARTY") - ``` \ No newline at end of file diff --git a/wiki-information/functions/SendMail.md b/wiki-information/functions/SendMail.md deleted file mode 100644 index 14641c2b..00000000 --- a/wiki-information/functions/SendMail.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: SendMail - -**Content:** -Sends in-game mail. -`SendMail(recipient, subject)` - -**Parameters:** -- `recipient` - - *string* - Intended recipient of the mail. -- `subject` - - *string* - Subject of the mail. Cannot be an empty string or nil, but may be whitespace, e.g. " ". -- `body` - - *string?* - Body of the mail. - -**Description:** -Triggers `MAIL_SEND_SUCCESS` if mail was sent to the recipient's inbox, or `MAIL_FAILED` otherwise. Repeated calls to `SendMail()` are ignored until one of these events fire. - -**Usage:** -Assuming a friendly player named Bob exists on your server: -```lua -SendMail("Bob", "Hey Bob", "Hows it going, Bob?") -``` \ No newline at end of file diff --git a/wiki-information/functions/SendSystemMessage.md b/wiki-information/functions/SendSystemMessage.md deleted file mode 100644 index 6405d400..00000000 --- a/wiki-information/functions/SendSystemMessage.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SendSystemMessage - -**Content:** -Prints a yellow `CHAT_MSG_SYSTEM` message. -`SendSystemMessage(msg)` - -**Parameters:** -- `msg` - - *string* - The message to be sent. Fires `CHAT_MSG_SYSTEM`. \ No newline at end of file diff --git a/wiki-information/functions/SetAbandonQuest.md b/wiki-information/functions/SetAbandonQuest.md deleted file mode 100644 index df833ad2..00000000 --- a/wiki-information/functions/SetAbandonQuest.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: SetAbandonQuest - -**Content:** -Selects the currently selected quest to be abandoned. -`SetAbandonQuest()` - -**Description:** -Quests are selected by calling `SelectQuestLogEntry()`. -After calling this function, you can abandon the quest by calling `AbandonQuest()`. - -**Reference:** -`GetAbandonQuestName()` - -**Example Usage:** -```lua --- Select the quest log entry for the quest you want to abandon -SelectQuestLogEntry(questIndex) - --- Set the quest to be abandoned -SetAbandonQuest() - --- Abandon the quest -AbandonQuest() -``` - -**Additional Information:** -This function is often used in addons that manage quest logs, such as Questie, to provide users with the ability to abandon quests directly from the addon interface. \ No newline at end of file diff --git a/wiki-information/functions/SetAchievementComparisonUnit.md b/wiki-information/functions/SetAchievementComparisonUnit.md deleted file mode 100644 index f1b9fe8b..00000000 --- a/wiki-information/functions/SetAchievementComparisonUnit.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: SetAchievementComparisonUnit - -**Content:** -Sets the unit to be compared to. -`success = SetAchievementComparisonUnit(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `success` - - *boolean* - Returns true/false depending on whether the unit is valid. - -**Reference:** -- `INSPECT_ACHIEVEMENT_READY`, when your query has finished processing on the server and new information is available - -**See also:** -- `ClearAchievementComparisonUnit` -- `GetAchievementComparisonInfo` -- `GetNumComparisonCompletedAchievements` \ No newline at end of file diff --git a/wiki-information/functions/SetActionBarToggles.md b/wiki-information/functions/SetActionBarToggles.md deleted file mode 100644 index 5bed68cf..00000000 --- a/wiki-information/functions/SetActionBarToggles.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: SetActionBarToggles - -**Content:** -Sets the visible state for each action bar. -`SetActionBarToggles(bottomLeftState, bottomRightState, sideRightState, sideRight2State, alwaysShow)` - -**Parameters:** -- `bottomLeftState` - - *Flag* - 1 if the left-hand bottom action bar is to be shown, 0 or nil otherwise. -- `bottomRightState` - - *Flag* - 1 if the right-hand bottom action bar is to be shown, 0 or nil otherwise. -- `sideRightState` - - *Flag* - 1 if the first (outer) right side action bar is to be shown, 0 or nil otherwise. -- `sideRight2State` - - *Flag* - 1 if the second (inner) right side action bar is to be shown, 0 or nil otherwise. -- `alwaysShow` - - *Flag* - 1 if the bars are always shown, 0 or nil otherwise. - -**Description:** -Note that this doesn't actually change the action bar states directly, it simply registers the desired states for the next time the game is loaded. The states during play are in the variables `SHOW_MULTI_ACTIONBAR_1`, `SHOW_MULTI_ACTIONBAR_2`, `SHOW_MULTI_ACTIONBAR_3`, `SHOW_MULTI_ACTIONBAR_4`, and reflected by calling `MultiActionBar_Update()`. \ No newline at end of file diff --git a/wiki-information/functions/SetActiveTalentGroup.md b/wiki-information/functions/SetActiveTalentGroup.md deleted file mode 100644 index 11aba72a..00000000 --- a/wiki-information/functions/SetActiveTalentGroup.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: SetActiveTalentGroup - -**Content:** -Sets the active talent group of the player. This is the 5-second cast that occurs when clicking the Activate These Talents button in the talent pane. -`SetActiveTalentGroup(groupIndex);` - -**Parameters:** -- `groupIndex` - - *number* - Ranging from 1 to 2 (primary/secondary talent group). To get the current one use `GetActiveTalentGroup()` - -**Notes and Caveats:** -Nothing will happen if the `groupIndex` is the currently active talent group. - -**Usage:** -The following line will toggle between the player's talent groups: -```lua -SetActiveTalentGroup(3 - GetActiveTalentGroup()) -``` - -**Example Use Case:** -This function can be used in macros or addons to allow players to quickly switch between their primary and secondary talent specializations without manually opening the talent pane. - -**Addon Usage:** -Large addons like "ElvUI" or "Bartender4" might use this function to provide users with an easy way to switch talent groups through their custom interfaces. For example, they could add a button to the UI that, when clicked, automatically switches the player's talent group. \ No newline at end of file diff --git a/wiki-information/functions/SetAllowDangerousScripts.md b/wiki-information/functions/SetAllowDangerousScripts.md deleted file mode 100644 index 7b1908b6..00000000 --- a/wiki-information/functions/SetAllowDangerousScripts.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetAllowDangerousScripts - -**Content:** -Needs summary. -`SetAllowDangerousScripts()` - -**Parameters:** -- `allowed` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/SetAllowLowLevelRaid.md b/wiki-information/functions/SetAllowLowLevelRaid.md deleted file mode 100644 index 8aabc99a..00000000 --- a/wiki-information/functions/SetAllowLowLevelRaid.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetAllowLowLevelRaid - -**Content:** -Needs summary. -`SetAllowLowLevelRaid()` - -**Parameters:** -- `allow` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/SetAutoDeclineGuildInvites.md b/wiki-information/functions/SetAutoDeclineGuildInvites.md deleted file mode 100644 index 1f086141..00000000 --- a/wiki-information/functions/SetAutoDeclineGuildInvites.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: SetAutoDeclineGuildInvites - -**Content:** -Sets whether guild invites should be automatically declined. -`SetAutoDeclineGuildInvites(decline)` - -**Parameters:** -- `decline` - - *boolean* - True if guild invitations should be automatically declined, false if invitations should be shown to the user. - -**Reference:** -- `DISABLE_DECLINE_GUILD_INVITE`, if guild invitations will now be shown to the user -- `ENABLE_DECLINE_GUILD_INVITE`, if guild invitations will now be declined automatically - -See also: -- `GetAutoDeclineGuildInvites` - -**Description:** -Blizzard's code always passes in a string value, but the function accepts both strings and numbers, just like `SetCVar`, and its counterpart `GetAutoDeclineGuildInvites` returns numeric values, just like `GetCVar`. \ No newline at end of file diff --git a/wiki-information/functions/SetBattlefieldScoreFaction.md b/wiki-information/functions/SetBattlefieldScoreFaction.md deleted file mode 100644 index ed4308b7..00000000 --- a/wiki-information/functions/SetBattlefieldScoreFaction.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetBattlefieldScoreFaction - -**Content:** -Sets the faction to show on the battlefield scoreboard. -`SetBattlefieldScoreFaction()` - -**Parameters:** -- `faction` - - *number* - `nil` = All, `0` = Horde, `1` = Alliance \ No newline at end of file diff --git a/wiki-information/functions/SetBinding.md b/wiki-information/functions/SetBinding.md deleted file mode 100644 index 18a1221e..00000000 --- a/wiki-information/functions/SetBinding.md +++ /dev/null @@ -1,46 +0,0 @@ -## Title: SetBinding - -**Content:** -Sets a key binding to an action. -`ok = SetBinding(key)` - -**Parameters:** -- `key` - - *string* - Any binding string accepted by World of Warcraft. For example: `"ALT-CTRL-F"`, `"SHIFT-T"`, `"W"`, `"BUTTON4"`. -- `command` - - *string?* - Any name attribute value of a Bindings.xml-defined binding, or an action command string, or nil to unbind all bindings from key. For example: - - `"SITORSTAND"`: a Bindings.xml-defined binding to toggle between sitting and standing - - `"CLICK PlayerFrame:LeftButton"`: Fire a left-click on the PlayerFrame. - - `"SPELL Bloodrage"`: Cast Bloodrage. - - `"ITEM Hearthstone"`: Use Hearthstone. - - `"MACRO Foo"`: Run a macro called "Foo". - - `"MACRO 1"`: Run a macro with index 1. -- `mode` - - *number?* - 1 if the binding should be saved to the currently loaded binding set (default), or 2 if to the alternative. - -**Returns:** -- `ok` - - *boolean* - 1 if the binding has been changed successfully, nil otherwise. - -**Usage:** -```lua --- Remove all bindings from the right mouse button. -SetBinding("BUTTON2"); - --- Restore the default binding for the right mouse button. -SetBinding("BUTTON2", "TURNORACTION"); -``` - -**Description:** -There are two binding sets: per-account and per-character bindings; of which one may be presently loaded (LoadBindings). You may look up which one is currently loaded using `GetCurrentBindingSet()`. -A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. -The Key Bindings UI will update immediately should this function succeed. However, bindings are not saved without an explicit `SaveBindings()` call. Unless saved, bindings will reset on next log-in / bindings load. -A list of default FrameXML bindings.xml-defined actions is available: `BindingID`. -The Addon API doesn't know what the default binding is for any single action. You can set them all to their defaults by calling `LoadBindings(DEFAULT_BINDINGS)`; this is an all-or-nothing action. -If you set bindings using this API, they will be permanently saved to the current set. If you want more control of what bindings are loaded, you may want to use `SetOverrideBindingClick` to enable them for each login session. - -**Reference:** -- `API SetBindingSpell` -- `API SetBindingItem` -- `API SetBindingMacro` -- `API SetBindingClick` \ No newline at end of file diff --git a/wiki-information/functions/SetBindingClick.md b/wiki-information/functions/SetBindingClick.md deleted file mode 100644 index 9d07fd1e..00000000 --- a/wiki-information/functions/SetBindingClick.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: SetBindingClick - -**Content:** -Sets a binding to click the specified Button widget. -`ok = SetBindingClick(key, buttonName)` - -**Parameters:** -- `key` - - *string* - Any binding string accepted by World of Warcraft. For example: "ALT-CTRL-F", "SHIFT-T", "W", "BUTTON4". -- `buttonName` - - *string* - Name of the button you wish to click. -- `button` - - *string* - Value of the button argument you wish to pass to the OnClick handler with the click; "LeftButton" by default. - -**Returns:** -- `ok` - - *boolean* - 1 if the binding has been changed successfully, nil otherwise. - -**Description:** -This function is functionally equivalent to the following statement. -`ok = SetBinding("key", "CLICK " .. buttonName .. (button and (":" .. button) or ""));` -A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. -You must use SetBinding to unbind a key. - -**Reference:** -`SetBinding` - -**Example Usage:** -```lua --- Bind the "F" key to click a button named "MyButton" -SetBindingClick("F", "MyButton") - --- Bind the "SHIFT-G" key to click a button named "AnotherButton" with the right mouse button -SetBindingClick("SHIFT-G", "AnotherButton", "RightButton") -``` - -**Addons Using This Function:** -Many large addons, such as Bartender4 and ElvUI, use `SetBindingClick` to allow users to customize their key bindings for various UI elements and actions. This function is essential for creating flexible and user-friendly interfaces where players can bind keys to specific buttons or actions dynamically. \ No newline at end of file diff --git a/wiki-information/functions/SetBindingItem.md b/wiki-information/functions/SetBindingItem.md deleted file mode 100644 index 408addf9..00000000 --- a/wiki-information/functions/SetBindingItem.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: SetBindingItem - -**Content:** -Sets a binding to use a specified item. -`ok = SetBindingItem(key, item)` - -**Parameters:** -- `key` - - *string* - Any binding string accepted by World of Warcraft. For example: `"ALT-CTRL-F"`, `"SHIFT-T"`, `"W"`, `"BUTTON4"`. -- `item` - - *string* - Item name (or item string) you want the binding to use. For example: `"Hearthstone"`, `"item:6948"` - -**Returns:** -- `ok` - - *boolean* - 1 if the binding has been changed successfully, nil otherwise. - -**Description:** -This function is functionally equivalent to the following statement. -`ok = SetBinding("key", "ITEM " .. item);` -A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. -You must use SetBinding to unbind a key. - -**Reference:** -[SetBinding](SetBinding) \ No newline at end of file diff --git a/wiki-information/functions/SetBindingMacro.md b/wiki-information/functions/SetBindingMacro.md deleted file mode 100644 index cffb00ed..00000000 --- a/wiki-information/functions/SetBindingMacro.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: SetBindingMacro - -**Content:** -Sets a binding to click the specified button object. -`ok = SetBindingMacro(key, macroName or macroId)` - -**Parameters:** -- `("key", "macroName")` or `("key", macroId)` - - `key` - - *string* - Any binding string accepted by World of Warcraft. For example: `"ALT-CTRL-F"`, `"SHIFT-T"`, `"W"`, `"BUTTON4"`. - - `macroName` - - *string* - Name of the macro you wish to execute. - - `macroId` - - *number* - Index of the macro you wish to execute. - -**Returns:** -- `ok` - - *boolean* - 1 if the binding has been changed successfully, nil otherwise. - -**Description:** -This function is functionally equivalent to the following statement. -`ok = SetBinding("key", "MACRO " .. macroName);` -A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. -You must use SetBinding to unbind a key. - -**Reference:** -- `SetBinding` - -**Example Usage:** -```lua --- Bind the "SHIFT-T" key to a macro named "MyMacro" -local success = SetBindingMacro("SHIFT-T", "MyMacro") -if success then - print("Binding set successfully!") -else - print("Failed to set binding.") -end -``` - -**Addons Using This Function:** -- **Bartender4**: A popular action bar replacement addon that allows users to customize their action bars and key bindings extensively. It uses `SetBindingMacro` to allow users to bind macros to specific keys directly through its interface. -- **ElvUI**: A comprehensive UI replacement addon that provides extensive customization options, including key bindings for macros. It leverages `SetBindingMacro` to manage these bindings efficiently. \ No newline at end of file diff --git a/wiki-information/functions/SetBindingSpell.md b/wiki-information/functions/SetBindingSpell.md deleted file mode 100644 index c0c4ecae..00000000 --- a/wiki-information/functions/SetBindingSpell.md +++ /dev/null @@ -1,39 +0,0 @@ -## Title: SetBindingSpell - -**Content:** -Sets a binding to cast the specified spell. -`ok = SetBindingSpell(key, spell)` - -**Parameters:** -- `key` - - *string* - Any binding string accepted by World of Warcraft. For example: "ALT-CTRL-F", "SHIFT-T", "W", "BUTTON4". -- `spell` - - *string* - Name of the spell you wish to cast when the binding is pressed. - -**Returns:** -- `ok` - - *boolean* - 1 if the binding has been changed successfully, nil otherwise. - -**Description:** -This function is functionally equivalent to the following statement. -`ok = SetBinding("key", "SPELL " .. spell);` -A single binding can only be bound to a single command at a time, although multiple bindings may be bound to the same command. The Key Bindings UI will only show the first two bindings, but there is no limit to the number of keys that can be used for the same command. -You must use SetBinding to unbind a key. - -**Reference:** -- `SetBinding` - -**Example Usage:** -```lua --- Bind the spell "Fireball" to the key "SHIFT-F" -local success = SetBindingSpell("SHIFT-F", "Fireball") -if success then - print("Binding set successfully!") -else - print("Failed to set binding.") -end -``` - -**Addons Using This Function:** -- **Bartender4**: A popular action bar replacement addon that allows users to customize their action bars and key bindings extensively. It uses `SetBindingSpell` to allow users to bind spells directly to keys through its configuration interface. -- **ElvUI**: A comprehensive UI replacement addon that includes features for key binding management. It uses `SetBindingSpell` to facilitate the binding of spells to keys as part of its key binding setup process. \ No newline at end of file diff --git a/wiki-information/functions/SetCemeteryPreference.md b/wiki-information/functions/SetCemeteryPreference.md deleted file mode 100644 index c92b0d10..00000000 --- a/wiki-information/functions/SetCemeteryPreference.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetCemeteryPreference - -**Content:** -Needs summary. -`SetCemeteryPreference(cemetaryID)` - -**Parameters:** -- `cemetaryID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/SetChannelPassword.md b/wiki-information/functions/SetChannelPassword.md deleted file mode 100644 index d71d6608..00000000 --- a/wiki-information/functions/SetChannelPassword.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: SetChannelPassword - -**Content:** -Changes the password of the current channel. -`SetChannelPassword(channelName, password)` - -**Parameters:** -- `channelName` - - *string* - The name of the channel. -- `password` - - *any* - The password to assign to the channel. - -**Usage:** -```lua -SetChannelPassword("Sembiance", "secretpassword"); -``` - -**Example Use Case:** -This function can be used in a scenario where you are managing a private chat channel and need to update its password for security reasons. For instance, if you are running a guild event and want to ensure only authorized members can join the channel, you can change the password periodically. - -**Addons:** -Large addons like "Prat" (a popular chat enhancement addon) might use this function to provide users with the ability to manage their chat channels more effectively, including setting and changing passwords for private channels. \ No newline at end of file diff --git a/wiki-information/functions/SetConsoleKey.md b/wiki-information/functions/SetConsoleKey.md deleted file mode 100644 index da30a8c0..00000000 --- a/wiki-information/functions/SetConsoleKey.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: SetConsoleKey - -**Content:** -Sets the console key (normally ~). -`SetConsoleKey(key)` - -**Parameters:** -- `key` - - *string* - The character to bind to opening the console overlay, or `nil` to disable the console binding. - -**Description:** -The console is only accessible when WoW is started with the `-console` parameter. This function does nothing if the parameter wasn't used. -The console key is not saved by the WoW client, and will revert to the default ` (backtick) key when WoW is restarted. -Unlike the `SetBinding` function, you can only provide the values of keys that represent standard ASCII characters; no modifiers are allowed. For instance, `SetConsoleKey("CTRL-F")` won't work, but `SetConsoleKey("F")` will. In addition, non-alphabetic keys that require modifiers to access, such as `!` using ⇧ Shift+1, cannot be used. -The console key overrides all other key bindings in WoW, regardless of context. This means that if you set it to `F`, you'll be unable to type the `F` character in chat until you restart WoW. \ No newline at end of file diff --git a/wiki-information/functions/SetCurrencyBackpack.md b/wiki-information/functions/SetCurrencyBackpack.md deleted file mode 100644 index 83dcd117..00000000 --- a/wiki-information/functions/SetCurrencyBackpack.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: SetCurrencyBackpack - -**Content:** -Alters the backpack tracking state of a currency. -`SetCurrencyBackpack(id, backpack)` - -**Parameters:** -- `id` - - *Number* - Index of the currency in the currency list to alter tracking of. -- `backpack` - - *Number* - 1 to track; 0 to clear tracking. - -**Notes and Caveats:** -This function affects the `isWatched` return value of `GetCurrencyListInfo`. -Information about watched currencies is accessible using `GetBackpackCurrencyListInfo`. \ No newline at end of file diff --git a/wiki-information/functions/SetCurrencyUnused.md b/wiki-information/functions/SetCurrencyUnused.md deleted file mode 100644 index 6a73673e..00000000 --- a/wiki-information/functions/SetCurrencyUnused.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: SetCurrencyUnused - -**Content:** -Marks/unmarks a currency as unused. -`SetCurrencyUnused(id, unused)` - -**Parameters:** -- `id` - - *Number* - Index of the currency in the currency list to alter unused status of. -- `unused` - - *Number* - 1 to mark the currency as unused; 0 to mark the currency as used. - -**Notes and Caveats:** -When a currency is marked as unused, it is placed under the "Unused" header in the currency list; this is always the last header in the list. This alters the currency's index in the currency list. -The `isUnused` return value of `GetCurrencyListInfo` can be used to get the current state. \ No newline at end of file diff --git a/wiki-information/functions/SetCurrentTitle.md b/wiki-information/functions/SetCurrentTitle.md deleted file mode 100644 index 36d7f181..00000000 --- a/wiki-information/functions/SetCurrentTitle.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: SetCurrentTitle - -**Content:** -Sets the player's displayed title. -`SetCurrentTitle(titleId)` - -**Parameters:** -- `titleId` - - *number* : TitleId - ID of the title you want to set. The identifiers are global and therefore do not depend on which titles you have learned. 0, invalid or unlearned IDs clear your title. - -**Description:** -The last indexed value (currently 143) returns nil and removes the player's name completely (not available to players). -`GetTitleName` can be used to find the name associated with the TitleId. - -**Usage:** -This sets the title "Elder" if your character had earned the title, otherwise it removes any active title. -```lua -SetCurrentTitle(43) -``` - -Sets a random title from the available ones. -```lua -/run local t = {} for i = 1, GetNumTitles() do if IsTitleKnown(i) then tinsert(t, i) end end SetCurrentTitle(t[math.random(#t)]) -``` \ No newline at end of file diff --git a/wiki-information/functions/SetCursor.md b/wiki-information/functions/SetCursor.md deleted file mode 100644 index cd89058b..00000000 --- a/wiki-information/functions/SetCursor.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: SetCursor - -**Content:** -Sets the current cursor texture. -`changed = SetCursor(cursor)` - -**Parameters:** -- `cursor` - - *string* - cursor to switch to; either a built-in cursor identifier (like "ATTACK_CURSOR"), path to a cursor texture (e.g. "Interface/Cursor/Taxi"), or `nil` to reset to a default cursor. - -**Returns:** -- `changed` - - *boolean* - always 1. - -**Description:** -If the cursor is hovering over WorldFrame, the SetCursor function will have no effect - cursor is locked to reflect what the player is currently pointing at. -Texture paths may be suffixed by ".crosshair" to offset the position of the texture such that it will be centered on the cursor. -If called with an invalid argument, the cursor is replaced by a black square. \ No newline at end of file diff --git a/wiki-information/functions/SetDungeonDifficultyID.md b/wiki-information/functions/SetDungeonDifficultyID.md deleted file mode 100644 index 3c4300c4..00000000 --- a/wiki-information/functions/SetDungeonDifficultyID.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: SetDungeonDifficultyID - -**Content:** -Sets the player's dungeon difficulty. -`SetDungeonDifficultyID(difficultyIndex)` - -**Parameters:** -- `difficultyIndex` - - *number* - - `1` → 5 Player - - `2` → 5 Player (Heroic) - - `8` → Challenge Mode - -**Description:** -When the change occurs, a message will be displayed in the default chat frame. -The above arguments are also returned from `GetDungeonDifficultyID()`. - -**Reference:** -- `GetDungeonDifficultyID` - - `difficultyIndex` \ No newline at end of file diff --git a/wiki-information/functions/SetFactionActive.md b/wiki-information/functions/SetFactionActive.md deleted file mode 100644 index 765461ac..00000000 --- a/wiki-information/functions/SetFactionActive.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: SetFactionActive - -**Content:** -Flags the specified faction as active in the reputation window. -`SetFactionActive(index)` - -**Parameters:** -- `index` - - *number* - The index of the faction to mark active, ascending from 1. - -**Reference:** -- `IsFactionInactive` -- `SetFactionInactive` \ No newline at end of file diff --git a/wiki-information/functions/SetFactionInactive.md b/wiki-information/functions/SetFactionInactive.md deleted file mode 100644 index 40e419b8..00000000 --- a/wiki-information/functions/SetFactionInactive.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: SetFactionInactive - -**Content:** -Flags the specified faction as inactive in the reputation window. -`SetFactionInactive(index)` - -**Parameters:** -- `index` - - *number* - The index of the faction to mark inactive, ascending from 1. - -**Reference:** -- `IsFactionInactive` -- `SetFactionActive` \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankTabInfo.md b/wiki-information/functions/SetGuildBankTabInfo.md deleted file mode 100644 index facd9695..00000000 --- a/wiki-information/functions/SetGuildBankTabInfo.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: SetGuildBankTabInfo - -**Content:** -Sets the name and icon of a guild bank tab. -`SetGuildBankTabInfo(tab, name, icon)` - -**Parameters:** -- `tab` - - *number* - Bank Tab to edit. -- `name` - - *string* - New tab name. -- `icon` - - *number* - FileID of the new icon texture. - -**Reference:** -- `GetGuildBankTabInfo()` \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankTabPermissions.md b/wiki-information/functions/SetGuildBankTabPermissions.md deleted file mode 100644 index 5f59cce0..00000000 --- a/wiki-information/functions/SetGuildBankTabPermissions.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: SetGuildBankTabPermissions - -**Content:** -Modifies the permissions for a guild bank tab. -`SetGuildBankTabPermissions(tab, index, enabled)` - -**Parameters:** -- `tab` - - *number* - Bank Tab to edit. -- `index` - - *number* - Index of Permission to edit. -- `enabled` - - *boolean* - true or false to Enable or Disable permission. - -**Description:** -Use `GuildControlSetRank()` to set what rank you are editing permissions for. Will not save until `GuildControlSaveRank()` is called. - -Current Known Index Values: -- 1 = View Tab -- 2 = Deposit Item \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankText.md b/wiki-information/functions/SetGuildBankText.md deleted file mode 100644 index ff3a00f4..00000000 --- a/wiki-information/functions/SetGuildBankText.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: SetGuildBankText - -**Content:** -Modifies info text for a tab. -`SetGuildBankText(tab, infoText)` - -**Parameters:** -- `tab` - - *number* - Bank Tab to edit. -- `infoText` - - *string* - Text to set, at most 2047 characters - -**Description:** -Although the function accepts up to 2047 characters, the standard interface displays only 500. - -**Reference:** -- `GetGuildBankText` - -**External Resources:** -- GitHub FrameXML -- GetheGlobe "wut?" Tool -- Townlong-Yak \ No newline at end of file diff --git a/wiki-information/functions/SetGuildBankWithdrawGoldLimit.md b/wiki-information/functions/SetGuildBankWithdrawGoldLimit.md deleted file mode 100644 index 9ac4564f..00000000 --- a/wiki-information/functions/SetGuildBankWithdrawGoldLimit.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SetGuildBankWithdrawGoldLimit - -**Content:** -Sets the gold withdraw limit for the guild bank. -`SetGuildBankWithdrawGoldLimit(amount)` - -**Parameters:** -- `amount` - - *number* - the amount of gold to withdraw per day - -**Description:** -Sets the value of the Gold Withdrawal field for the current rank (used for repairs and direct withdrawals). These changes are not saved until a call to `GuildControlSaveRank()` is made. In order to actually withdraw or use guild repairs, the flags for those actions must be set using `GuildControlSetRankFlag()`. \ No newline at end of file diff --git a/wiki-information/functions/SetGuildInfoText.md b/wiki-information/functions/SetGuildInfoText.md deleted file mode 100644 index 11343bb8..00000000 --- a/wiki-information/functions/SetGuildInfoText.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetGuildInfoText - -**Content:** -Sets the guild info text. -`SetGuildInfoText(text)` - -**Parameters:** -- `text` - - *string* - The text to set as the guild info. \ No newline at end of file diff --git a/wiki-information/functions/SetGuildRosterShowOffline.md b/wiki-information/functions/SetGuildRosterShowOffline.md deleted file mode 100644 index 47a6497f..00000000 --- a/wiki-information/functions/SetGuildRosterShowOffline.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: SetGuildRosterShowOffline - -**Content:** -Sets the show offline guild members flag. -`SetGuildRosterShowOffline(enabled)` - -**Parameters:** -- `enabled` - - *boolean* - True includes all guild members; false filters out offline guild members. - -**Description:** -Triggers `GUILD_ROSTER_UPDATE` if filtering mode has changed -- facilitating a customary call to `GuildRoster()` if this event is registered. - -**Usage:** -```lua --- Fetch updated info when required -local f = CreateFrame("Frame") -f:RegisterEvent("GUILD_ROSTER_UPDATE") -f:HookScript("OnEvent", function(event) - if (event == "GUILD_ROSTER_UPDATE") then - GuildRoster() - end -end) - --- At some point later in your code... -SetGuildRosterShowOffline(false) -``` - -**Example Use Case:** -This function can be used in an addon to manage the display of guild members, ensuring that only online members are shown in the guild roster. This can be particularly useful for guild management addons that need to provide a clean and relevant list of active members. - -**Addons Using This Function:** -Large guild management addons like "Guild Roster Manager" use this function to toggle the visibility of offline members, providing a more streamlined interface for guild officers and members. \ No newline at end of file diff --git a/wiki-information/functions/SetInWorldUIVisibility.md b/wiki-information/functions/SetInWorldUIVisibility.md deleted file mode 100644 index e1ed1766..00000000 --- a/wiki-information/functions/SetInWorldUIVisibility.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SetInWorldUIVisibility - -**Content:** -Allows nameplates to be shown even while the UI is hidden. -`SetInWorldUIVisibility(visible)` - -**Parameters:** -- `visible` - - *boolean* - -**Description:** -Requires hiding the UI first with Alt-Z and then calling `SetInWorldUIVisibility(true)` in order for nameplates to appear. \ No newline at end of file diff --git a/wiki-information/functions/SetLFGComment.md b/wiki-information/functions/SetLFGComment.md deleted file mode 100644 index 107e8880..00000000 --- a/wiki-information/functions/SetLFGComment.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SetLFGComment - -**Content:** -Sets the comment in the LFG browser. -`SetLFGComment(comment)` - -**Parameters:** -- `comment` - - *string* - The comment you want to use in the LFG interface. - -**Returns:** -- none \ No newline at end of file diff --git a/wiki-information/functions/SetLegacyRaidDifficultyID.md b/wiki-information/functions/SetLegacyRaidDifficultyID.md deleted file mode 100644 index 662f26f7..00000000 --- a/wiki-information/functions/SetLegacyRaidDifficultyID.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: SetLegacyRaidDifficultyID - -**Content:** -Needs summary. -`SetLegacyRaidDifficultyID(difficultyID)` - -**Parameters:** -- `difficultyID` - - *number* -- `force` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/SetLootThreshold.md b/wiki-information/functions/SetLootThreshold.md deleted file mode 100644 index c566954a..00000000 --- a/wiki-information/functions/SetLootThreshold.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: SetLootThreshold - -**Content:** -Sets the loot quality threshold for group/master loot. -`SetLootThreshold(threshold)` - -**Parameters:** -- `threshold` - - *number* - The loot quality to start using the current loot method with. - - **Value** - - **Description** - - `2` - - Uncommon - - `3` - - Rare - - `4` - - Epic - - `5` - - Legendary - - `6` - - Artifact - -**Description:** -This function throws an error with Poor (0) or Common (1) qualities, but it is possible to set these lower thresholds using `SetLootMethod()` with "master" as the first argument and 0 or 1 as the third. e.g. `SetLootMethod("master","player",1)` -Calling this while the loot method is changing will revert to the original loot method. To account for this, use `C_Timer.After()` to delay setting the threshold until a moment later. e.g. `C_Timer.After(1, function() SetLootMethod(2) end)` - -**Usage:** -If you are the party/raid leader, this script sets the loot threshold to Uncommon items or better and causes everyone to see a chat notice to this effect. -```lua -/run SetLootThreshold(2) -``` - -**Reference:** -`PARTY_LOOT_METHOD_CHANGED` \ No newline at end of file diff --git a/wiki-information/functions/SetMacroSpell.md b/wiki-information/functions/SetMacroSpell.md deleted file mode 100644 index fd11434f..00000000 --- a/wiki-information/functions/SetMacroSpell.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: SetMacroSpell - -**Content:** -Changes the spell used for dynamic feedback for a macro. -`SetMacroSpell(index, spell)` or `SetMacroSpell(name, spell)` - -**Parameters:** -- `index` - - *number* - Index of the macro, using the values 1-36 for the first page and 37-54 for the second. -- `name` - - *string* - Name of a macro. -- `spell` - - *string* - Localized name of a spell to assign. -- `target` - - *string* : UnitId - The unit to assign (for range indication). - -**Description:** -When assigned to an action button, macros can provide dynamic feedback such as range indication, cooldown, and charges/quantity remaining. -Normally, this dynamic feedback corresponds to the action that the macro will take; however, this function directs the macro to provide feedback based on a particular spell instead. -This only changes the visual cues appearing on the action buttons, but not the actual logic. Clicking an action button executes the macro as written. - -**Reference:** -`SetMacroItem` \ No newline at end of file diff --git a/wiki-information/functions/SetModifiedClick.md b/wiki-information/functions/SetModifiedClick.md deleted file mode 100644 index aaffec75..00000000 --- a/wiki-information/functions/SetModifiedClick.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: SetModifiedClick - -**Content:** -Assigns the given modifier key to the given action. -`SetModifiedClick(action, key)` - -**Parameters:** -- `action` - - *string* - The action to set a key for. Actions defined by Blizzard: - - `AUTOLOOTTOGGLE`, `CHATLINK`, `COMPAREITEMS`, `DRESSUP`, `FOCUSCAST`, `OPENALLBAGS`, `PICKUPACTION`, `QUESTWATCHTOGGLE`, `SELFCAST`, `SHOWITEMFLYOUT`, `SOCKETITEM`, `SPLITSTACK`, `STICKYCAMERA`, `TOKENWATCHTOGGLE` -- `key` - - *string* - The key to assign. Must be one of: - - `ALT`, `CTRL`, `SHIFT`, `NONE` - -**Description:** -The game only provides user options for changing the `AUTOLOOTTOGGLE`, `FOCUSCAST`, and `SELFCAST` modifiers. All other modifiers are set to "SHIFT" by default, except for `DRESSUP` and `SOCKETITEM`, which are set to "CTRL". -An additional modifier `SHOWMULTICASTFLYOUT` exists, but was only used in the shaman totem UI, which was removed from the game in Patch 4.0.1. - -**Reference:** -- `IsModifiedClick` -- `SetModifiedClick` \ No newline at end of file diff --git a/wiki-information/functions/SetMoveEnabled.md b/wiki-information/functions/SetMoveEnabled.md deleted file mode 100644 index 62213568..00000000 --- a/wiki-information/functions/SetMoveEnabled.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: SetMoveEnabled - -**Content:** -Needs summary. -`SetMoveEnabled()` \ No newline at end of file diff --git a/wiki-information/functions/SetMultiCastSpell.md b/wiki-information/functions/SetMultiCastSpell.md deleted file mode 100644 index 820b1463..00000000 --- a/wiki-information/functions/SetMultiCastSpell.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: SetMultiCastSpell - -**Content:** -Sets the totem spell for a specific totem bar slot. -`SetMultiCastSpell(actionID, spellID)` - -**Parameters:** -- `actionID` - - *number* - The totem bar slot number. - - Call of the... - - Totem slot - - Fire - - Earth - - Water - - Air - - Elements - - 133 - - 134 - - 135 - - 136 - - Ancestors - - 137 - - 138 - - 139 - - 140 - - Spirits - - 141 - - 142 - - 143 - - 144 -- `spellId` - - *number* - The global spell number, found on Wowhead or through COMBAT_LOG_EVENT. - -**Usage:** -`SetMultiCastSpell(134, 2484)` - -**Result:** -Sets on . \ No newline at end of file diff --git a/wiki-information/functions/SetOptOutOfLoot.md b/wiki-information/functions/SetOptOutOfLoot.md deleted file mode 100644 index b8518389..00000000 --- a/wiki-information/functions/SetOptOutOfLoot.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: SetOptOutOfLoot - -**Content:** -Sets whether to automatically pass on all loot. -`SetOptOutOfLoot(optOut)` - -**Parameters:** -- `optOut` - - *boolean* - 1 to make the player pass on all loot, nil otherwise. - -**Reference:** -- `GetOptOutOfLoot` - -**Example Usage:** -This function can be used in a scenario where a player wants to ensure they do not receive any loot, perhaps during a raid where they are not interested in the drops or to avoid conflicts over loot distribution. - -**Addon Usage:** -Large addons like "ElvUI" or "DBM" might use this function to provide users with an option to automatically pass on loot, streamlining the looting process during raids or dungeons. \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBinding.md b/wiki-information/functions/SetOverrideBinding.md deleted file mode 100644 index 207b341a..00000000 --- a/wiki-information/functions/SetOverrideBinding.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: SetOverrideBinding - -**Content:** -Sets an override key binding. -`SetOverrideBinding(owner, isPriority, key, command)` - -**Parameters:** -- `owner` - - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. -- `isPriority` - - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. -- `key` - - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" -- `command` - - *String/nil* - Any name attribute value of a Bindings.xml-defined binding, or an action command string; nil to remove an override binding. For example: - - `"SITORSTAND"` : a Bindings.xml-defined binding to toggle between sitting and standing - - `"CLICK PlayerFrame:LeftButton"` : Fire a left-click on the PlayerFrame. - - `"SPELL Bloodrage"` : Cast Bloodrage. - - `"ITEM Hearthstone"` : Use Hearthstone. - - `"MACRO Foo"` : Run a macro called "Foo" - - `"MACRO 1"` : Run a macro with index 1. -- `mode` - - *number* - 1 if the binding should be saved to the currently loaded binding set (default), or 2 if to the alternative. - -**Description:** -Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. -Override bindings are never saved, and will be wiped by an interface reload. - -**Reference:** -- `SetOverrideBindingSpell` -- `SetOverrideBindingItem` -- `SetOverrideBindingMacro` -- `SetOverrideBindingClick` -- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingClick.md b/wiki-information/functions/SetOverrideBindingClick.md deleted file mode 100644 index 9c602d1c..00000000 --- a/wiki-information/functions/SetOverrideBindingClick.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: SetOverrideBindingClick - -**Content:** -Sets an override binding that performs a button click. -`SetOverrideBindingClick(owner, isPriority, key, buttonName)` - -**Parameters:** -- `owner` - - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. -- `isPriority` - - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. -- `key` - - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" -- `buttonName` - - *string* - Name of the button widget this binding should fire a click event for. -- `mouseClick` - - *string* - Mouse button name argument passed to the OnClick handlers. - -**Description:** -Override bindings take precedence over the normal `SetBinding` bindings. Priority override bindings take precedence over non-priority override bindings. -Override bindings are never saved, and will be wiped by an interface reload. -You cannot use this function to clear an override binding; use `SetOverrideBinding` instead. - -**Reference:** -- `SetOverrideBinding` -- `SetOverrideBindingSpell` -- `SetOverrideBindingItem` -- `SetOverrideBindingMacro` -- `ClearOverrideBindings` - -**Example Usage:** -```lua --- Example of setting an override binding to click a button named "MyButton" when the "Q" key is pressed -SetOverrideBindingClick(MyFrame, true, "Q", "MyButton") -``` - -**Addons Using This Function:** -Many large addons, such as Bartender4 and ElvUI, use this function to provide custom key bindings for their action bars and other interactive elements. This allows users to have more flexible and dynamic control over their UI interactions. \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingItem.md b/wiki-information/functions/SetOverrideBindingItem.md deleted file mode 100644 index 0a4e4c0f..00000000 --- a/wiki-information/functions/SetOverrideBindingItem.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: SetOverrideBindingItem - -**Content:** -Creates an override binding that uses an item when triggered. -`SetOverrideBindingItem(owner, isPriority, key, item)` - -**Parameters:** -- `owner` - - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. -- `isPriority` - - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. -- `key` - - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" -- `item` - - *string* - Name or item link of the item to use when binding is triggered. - -**Description:** -Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. -Override bindings are never saved, and will be wiped by an interface reload. -You cannot use this function to clear an override binding; use SetOverrideBinding instead. - -**Reference:** -- `SetOverrideBinding` -- `SetOverrideBindingSpell` -- `SetOverrideBindingClick` -- `SetOverrideBindingMacro` -- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingMacro.md b/wiki-information/functions/SetOverrideBindingMacro.md deleted file mode 100644 index c109134a..00000000 --- a/wiki-information/functions/SetOverrideBindingMacro.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: SetOverrideBindingMacro - -**Content:** -Creates an override binding that runs a macro. -`SetOverrideBindingMacro(owner, isPriority, key, macro)` - -**Parameters:** -- `owner` - - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. -- `isPriority` - - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. -- `key` - - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5" -- `macro` - - *string* - Name or index of the macro to run. - -**Description:** -Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. -Override bindings are never saved, and will be wiped by an interface reload. -You cannot use this function to clear an override binding; use SetOverrideBinding instead. - -**Reference:** -- `SetOverrideBinding` -- `SetOverrideBindingSpell` -- `SetOverrideBindingItem` -- `SetOverrideBindingClick` -- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetOverrideBindingSpell.md b/wiki-information/functions/SetOverrideBindingSpell.md deleted file mode 100644 index ec84ecb6..00000000 --- a/wiki-information/functions/SetOverrideBindingSpell.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: SetOverrideBindingSpell - -**Content:** -Creates an override binding that casts a spell. -`SetOverrideBindingSpell(owner, isPriority, key, spell)` - -**Parameters:** -- `owner` - - *Frame* - The frame this binding "belongs" to; this can later be used to clear all override bindings belonging to a particular frame. -- `isPriority` - - *boolean* - true if this is a priority binding, false otherwise. Both types of override bindings take precedence over normal bindings. -- `key` - - *string* - Binding to bind the command to. For example, "Q", "ALT-Q", "ALT-CTRL-SHIFT-Q", "BUTTON5". -- `spell` - - *string* - Name of the spell you want to cast when this binding is triggered. - -**Description:** -Override bindings take precedence over the normal SetBinding bindings. Priority override bindings take precedence over non-priority override bindings. -Override bindings are never saved, and will be wiped by an interface reload. -You cannot use this function to clear an override binding; use SetOverrideBinding instead. - -**Reference:** -- `SetOverrideBinding` -- `SetOverrideBindingClick` -- `SetOverrideBindingItem` -- `SetOverrideBindingMacro` -- `ClearOverrideBindings` \ No newline at end of file diff --git a/wiki-information/functions/SetPVP.md b/wiki-information/functions/SetPVP.md deleted file mode 100644 index 8d006d8c..00000000 --- a/wiki-information/functions/SetPVP.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: SetPVP - -**Content:** -Sets the player's PvP flag. -`SetPVP(flag)` - -**Parameters:** -- `flag` - - *number* - -**Description:** -`TogglePVP()` is equivalent to `SetPVP(not GetPVPDesired())`. -This setting is different from war mode. \ No newline at end of file diff --git a/wiki-information/functions/SetPVPRoles.md b/wiki-information/functions/SetPVPRoles.md deleted file mode 100644 index d88e668b..00000000 --- a/wiki-information/functions/SetPVPRoles.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: SetPVPRoles - -**Content:** -Sets which roles the player is willing to perform in PvP battlegrounds. -`SetPVPRoles(tank, healer, dps)` - -**Parameters:** -- `tank` - - *boolean* - true if the player is willing to tank, false otherwise. -- `healer` - - *boolean* - true if the player is willing to heal, false otherwise. -- `dps` - - *boolean* - true if the player is willing to deal damage, false otherwise. - -**Reference:** -- `PVP_ROLE_UPDATE` -- See also: - - `GetPVPRoles` \ No newline at end of file diff --git a/wiki-information/functions/SetPendingReportPetTarget.md b/wiki-information/functions/SetPendingReportPetTarget.md deleted file mode 100644 index bd79334b..00000000 --- a/wiki-information/functions/SetPendingReportPetTarget.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: C_ReportSystem.SetPendingReportPetTarget - -**Content:** -Report a pet for an inappropriate name. -`set = C_ReportSystem.SetPendingReportPetTarget()` - -**Parameters:** -- `target` - - *string?* : UnitId - defaults to "target". - -**Returns:** -- `set` - - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/SetPendingReportTarget.md b/wiki-information/functions/SetPendingReportTarget.md deleted file mode 100644 index 0ce8043c..00000000 --- a/wiki-information/functions/SetPendingReportTarget.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: C_ReportSystem.SetPendingReportTarget - -**Content:** -Populates the reporting window with details about a target player. -`set = C_ReportSystem.SetPendingReportTarget()` -`set = C_ReportSystem.SetPendingReportTargetByGuid()` - -**Parameters:** - -*SetPendingReportTarget:* -- `target` - - *string?* : UnitId - defaults to "target" - -*SetPendingReportTargetByGuid:* -- `guid` - - *string?* : GUID - -**Returns:** -- `set` - - *boolean* - whether the report was successfully set. \ No newline at end of file diff --git a/wiki-information/functions/SetPetStablePaperdoll.md b/wiki-information/functions/SetPetStablePaperdoll.md deleted file mode 100644 index a1b097d7..00000000 --- a/wiki-information/functions/SetPetStablePaperdoll.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: SetPetStablePaperdoll - -**Content:** -Sets the paperdoll model in the pet stable to a new player model. -`SetPetStablePaperdoll(modelObject)` - -**Parameters:** -- `modelObject` - - *PlayerModel* - The model of the pet to display. - -**Returns:** -- None - -**Description:** -This method does not cause the model to be shown. The model still needs its `Show()` method called afterward. \ No newline at end of file diff --git a/wiki-information/functions/SetPortraitTexture.md b/wiki-information/functions/SetPortraitTexture.md deleted file mode 100644 index 371803d4..00000000 --- a/wiki-information/functions/SetPortraitTexture.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: SetPortraitTexture - -**Content:** -Sets a texture to a unit's 2D portrait. -`SetPortraitTexture(textureObject, unitToken)` - -**Parameters:** -- `textureObject` - - *Texture* - The texture object to set the portrait on. -- `unitToken` - - *string* - UnitToken representing the unit whose portrait is to be set. -- `disableMasking` - - *boolean?* - Optional parameter, defaults to `false`. - -**Usage:** -```lua -local f = CreateFrame("Frame") -f:SetPoint("CENTER") -f:SetSize(64, 64) -f.tex = f:CreateTexture() -f.tex:SetAllPoints(f) -SetPortraitTexture(f.tex, "player") -``` - -**Example Use Case:** -This function is commonly used in creating custom unit frames or UI elements that display character portraits. For instance, many unit frame addons like "Shadowed Unit Frames" or "PitBull Unit Frames" use this function to set the portrait textures for player, target, and party frames. \ No newline at end of file diff --git a/wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md b/wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md deleted file mode 100644 index 6ddeb377..00000000 --- a/wiki-information/functions/SetPortraitTextureFromCreatureDisplayID.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: SetPortraitTextureFromCreatureDisplayID - -**Content:** -Needs summary. -`SetPortraitTextureFromCreatureDisplayID(textureObject, creatureDisplayID)` - -**Parameters:** -- `textureObject` - - *widget* : Texture -- `creatureDisplayID` - - *number* : CreatureDisplayID \ No newline at end of file diff --git a/wiki-information/functions/SetPortraitToTexture.md b/wiki-information/functions/SetPortraitToTexture.md deleted file mode 100644 index 122707c5..00000000 --- a/wiki-information/functions/SetPortraitToTexture.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: SetPortraitToTexture - -**Content:** -Applies a circular mask to a texture, making it resemble a portrait. -`SetPortraitToTexture(texture, path)` - -**Parameters:** -- `texture` - - *Texture* -- `path` - - *string|number* : fileID - -**Description:** -This function only accepts texture assets that have dimensions of 64x64 or smaller. Larger textures will raise a "Texture is not 64x64 pixels" error. -For larger textures, consider instead using MaskTexture objects which do not suffer from this same limitation. - -**Usage:** -```lua -local f = CreateFrame("Frame") -f:SetPoint("CENTER") -f:SetSize(64, 64) -f.tex = f:CreateTexture() -f.tex:SetAllPoints(f) -SetPortraitToTexture(f.tex, "interface/icons/inv_mushroom_11") -``` - -**Reference:** -- MaskTexture \ No newline at end of file diff --git a/wiki-information/functions/SetRaidDifficultyID.md b/wiki-information/functions/SetRaidDifficultyID.md deleted file mode 100644 index 91ee4a33..00000000 --- a/wiki-information/functions/SetRaidDifficultyID.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: SetRaidDifficultyID - -**Content:** -Sets the raid difficulty. -`SetRaidDifficultyID(difficultyIndex)` - -**Parameters:** -- `difficultyIndex` - - *number* - - 3 → 10 Player - - 4 → 25 Player - - 5 → 10 Player (Heroic) - - 6 → 25 Player (Heroic) - - 14 → Normal - - 15 → Heroic - - 16 → Mythic - -**Description:** -When the change occurs, a message will be displayed in the default chat frame. -Example: `/script SetRaidDifficultyID(16);` sets the raid difficulty to Mythic - -**Reference:** -- `GetRaidDifficultyID` -- `difficultyIndex` \ No newline at end of file diff --git a/wiki-information/functions/SetRaidTarget.md b/wiki-information/functions/SetRaidTarget.md deleted file mode 100644 index 434fbfe0..00000000 --- a/wiki-information/functions/SetRaidTarget.md +++ /dev/null @@ -1,48 +0,0 @@ -## Title: SetRaidTarget - -**Content:** -Assigns a raid target icon to a unit. -`SetRaidTarget(unit, index)` - -**Parameters:** -- `unit` - - *string* : UnitId -- `index` - - *number* - Raid target index to assign to the specified unit: - - `Value` - - `Icon` - - `1` - Yellow 4-point Star - - `2` - Orange Circle - - `3` - Purple Diamond - - `4` - Green Triangle - - `5` - White Crescent Moon - - `6` - Blue Square - - `7` - Red "X" Cross - - `8` - White Skull - -**Description:** -The icons are only visible to your group. In a 5-man party, all party members may assign raid icons. In a raid, only the raid leader and the assistants may do so. -This API toggles the icon if it's already assigned to the unit. -Units can only be assigned one icon at a time; and each icon can only be assigned to one unit at a time. - -**Related API:** -- `GetRaidTargetIndex` - -**Related Events:** -- `RAID_TARGET_UPDATE` - -**Related FrameXML:** -- `SetRaidTargetIcon` - -**Usage:** -To set a skull over your current target: -```lua -/run SetRaidTarget("target", 8) -``` -Without toggling behavior: -```lua -/run if GetRaidTargetIndex("target") ~= 8 then SetRaidTarget("target", 8) end -``` - -**Reference:** -- `RaidFlag` \ No newline at end of file diff --git a/wiki-information/functions/SetScreenResolution.md b/wiki-information/functions/SetScreenResolution.md deleted file mode 100644 index c16496ff..00000000 --- a/wiki-information/functions/SetScreenResolution.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: SetScreenResolution - -**Content:** -Returns the index of the current resolution in effect -`SetScreenResolution()` - -**Parameters:** -- `index` - - *number?* - This value specifies the new screen resolution, it must be the index of one of the values yielded by `GetScreenResolutions()`. Passing `nil` will default this argument to 1, the lowest resolution available. - -**Usage:** -This sets the screen to 1024x768, if available: -```lua -local resolutions = {GetScreenResolutions()} -for i, entry in resolutions do - if entry == '1024x768' then - SetScreenResolution(i) - break - end -end -``` - -**Example Use Case:** -This function can be used in addons or scripts that need to change the screen resolution programmatically, such as during the initial setup of a game environment or when providing users with a custom settings interface. - -**Addons:** -While not commonly used in large addons due to the potential disruption of changing screen resolution, it might be found in configuration tools or setup wizards that aim to optimize the game settings for the user's hardware. \ No newline at end of file diff --git a/wiki-information/functions/SetSelectedBattlefield.md b/wiki-information/functions/SetSelectedBattlefield.md deleted file mode 100644 index 850160bf..00000000 --- a/wiki-information/functions/SetSelectedBattlefield.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetSelectedBattlefield - -**Content:** -Selects a battlefield instance at the battlemaster. -`SetSelectedBattlefield(index)` - -**Parameters:** -- `index` - - *number* - The index in the battlemaster listing. \ No newline at end of file diff --git a/wiki-information/functions/SetSelectedSkill.md b/wiki-information/functions/SetSelectedSkill.md deleted file mode 100644 index 80219119..00000000 --- a/wiki-information/functions/SetSelectedSkill.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetSelectedSkill - -**Content:** -Selects a skill line in the skill window. -`SetSelectedSkill(index)` - -**Parameters:** -- `index` - - *number* - The index of a line in the skills window. Does nothing when used on a header. \ No newline at end of file diff --git a/wiki-information/functions/SetSuperTrackedQuestID.md b/wiki-information/functions/SetSuperTrackedQuestID.md deleted file mode 100644 index aca9ceb6..00000000 --- a/wiki-information/functions/SetSuperTrackedQuestID.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: C_SuperTrack.SetSuperTrackedQuestID - -**Content:** -Changes the quest ID actively being tracked. Replaces `SetSuperTrackedQuestID`. -`C_SuperTrack.SetSuperTrackedQuestID(questID)` - -**Parameters:** -- `questID` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/SetTalentGroupRole.md b/wiki-information/functions/SetTalentGroupRole.md deleted file mode 100644 index 121bde5e..00000000 --- a/wiki-information/functions/SetTalentGroupRole.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: SetTalentGroupRole - -**Content:** -Sets the role for a player talent group (primary or secondary). -`SetTalentGroupRole(groupIndex, role)` - -**Parameters:** -- `groupIndex` - - *number* - Ranging from 1 to 2 (primary/secondary talent group). To get the current one use `GetActiveTalentGroup()` -- `role` - - *string* - Can be `DAMAGER`, `TANK`, or `HEALER`. If an invalid role is given, it defaults to `DAMAGER`. - -**Example Usage:** -```lua --- Set the primary talent group to the role of TANK -SetTalentGroupRole(1, "TANK") - --- Set the secondary talent group to the role of HEALER -SetTalentGroupRole(2, "HEALER") -``` - -**Additional Information:** -This function is particularly useful in addons that manage talent builds and roles, such as `Talent Set Manager` or `Action Bar Saver`. These addons often allow players to quickly switch between different talent setups and corresponding roles, optimizing their performance for different types of content (e.g., dungeons, raids, PvP). \ No newline at end of file diff --git a/wiki-information/functions/SetTaxiMap.md b/wiki-information/functions/SetTaxiMap.md deleted file mode 100644 index d7f771e1..00000000 --- a/wiki-information/functions/SetTaxiMap.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SetTaxiMap - -**Content:** -Sets the texture to use for the taxi map. -`SetTaxiMap(texture)` - -**Parameters:** -- `texture` - - *string* - The path to the texture to use for the taxi map. - -**Returns:** -- `nil` \ No newline at end of file diff --git a/wiki-information/functions/SetTracking.md b/wiki-information/functions/SetTracking.md deleted file mode 100644 index 62c58cd6..00000000 --- a/wiki-information/functions/SetTracking.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: SetTracking - -**Content:** -Sets a minimap tracking method. -`SetTracking(id, enabled)` - -**Parameters:** -- `id` - - The id of the tracking you would like to change. The id is assigned by the client, 1 is the first tracking method available on the tracking list, 2 is the next and so on. To get information about a specific id, use `GetTrackingInfo`. -- `enabled` - - *boolean* - flag if the specified tracking id is to be enabled or disabled. - -**Usage:** -Enables the first tracking method on the list: -```lua -SetTracking(1, true) -``` - -**Example Use Case:** -This function can be used in addons that manage or enhance the minimap tracking features. For instance, an addon that automatically switches tracking types based on the player's current activities (e.g., switching to herb tracking when the player is in a zone with many herbs). - -**Addons Using This Function:** -Many popular addons like "GatherMate2" use this function to help players track resources more efficiently by automatically enabling and disabling tracking types based on the player's needs. \ No newline at end of file diff --git a/wiki-information/functions/SetTradeMoney.md b/wiki-information/functions/SetTradeMoney.md deleted file mode 100644 index b54c38a3..00000000 --- a/wiki-information/functions/SetTradeMoney.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: SetTradeMoney - -**Content:** -Sets the amount of money offered as part of the player's trade offer. -`SetTradeMoney(copper)` - -**Parameters:** -- `copper` - - *number* - Amount of money, in copper, to offer for trade. - -**Usage:** -The following will put 1 gold into the trade window: -```lua -SetTradeMoney(1 * 100 * 100); -``` - -**Reference:** -- `PickupTradeMoney` -- `AddTradeMoney` \ No newline at end of file diff --git a/wiki-information/functions/SetTradeSkillItemLevelFilter.md b/wiki-information/functions/SetTradeSkillItemLevelFilter.md deleted file mode 100644 index 8da883b4..00000000 --- a/wiki-information/functions/SetTradeSkillItemLevelFilter.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: SetTradeSkillItemLevelFilter - -**Content:** -Sets a filter on the open recipe list window based on minimum level to use. -`nil = SetTradeSkillItemLevelFilter(minLevel, maxLevel)` - -**Parameters:** -- `minLevel` - - *number* - minimum level to pass filter -- `maxLevel` - - *number* - maximum level to pass filter - -**Usage:** -```lua -CloseTradeSkill(); -CastSpellByName("Alchemy"); -SetTradeSkillItemLevelFilter(35, 36); -minLevel, maxLevel = GetTradeSkillItemLevelFilter(); -print(type(minLevel), minLevel, type(maxLevel), maxLevel) --- Result --- number 35 number 36 --- And the recipe list window will be filtered thus: --- Elixir --- Elixir of Detect Undead --- Elixir of Greater Water Breathing --- Potion --- Dreamless Sleep Potion --- Superior Healing Potion --- Miscellaneous --- Philosopher's Stone --- Each of these items require level 35 to use except the Elixir of Detect Undead which requires level 36. -``` - -**Description:** -Opening a new tradeskill window resets the filter to 0, 0. Closing and re-opening the same tradeskill's window does not reset the filter. -- `minLevel` - - 0 removes the lower end of the filter. - - -1 seems to do nothing. - - 1 for Inscription filters out inks, and all First Aid skills. -- `maxLevel` - - 0 removes the higher end of the filter. - - -1 seems to filter everything out. \ No newline at end of file diff --git a/wiki-information/functions/SetTradeSkillSubClassFilter.md b/wiki-information/functions/SetTradeSkillSubClassFilter.md deleted file mode 100644 index 8e980ea5..00000000 --- a/wiki-information/functions/SetTradeSkillSubClassFilter.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: SetTradeSkillSubClassFilter - -**Content:** -Sets the subclass filter. -`SetTradeSkillSubClassFilter(slotIndex, onOff{, exclusive})` - -**Parameters:** -- `slotIndex` - - The index of the specific slot -- `onOff` - - On = 1, Off = 0 -- `exclusive` (Optional) - - Sets if the slot is the only slot to be selected. If not set it's handled as Off. On = 1, Off = 0 - -**Usage:** -Sets the filter to select slotIndex 3 and 5. First slotIndex have to be exclusive enabled. -```lua -SetTradeSkillSubClassFilter(3, 1, 1); -SetTradeSkillSubClassFilter(5, 1); -``` - -**Reference:** -- `GetTradeSkillSubClassFilter` \ No newline at end of file diff --git a/wiki-information/functions/SetTrainerServiceTypeFilter.md b/wiki-information/functions/SetTrainerServiceTypeFilter.md deleted file mode 100644 index d89fb3d4..00000000 --- a/wiki-information/functions/SetTrainerServiceTypeFilter.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: SetTrainerServiceTypeFilter - -**Content:** -Sets the status of a skill filter in the trainer window. -`SetTrainerServiceTypeFilter(type, status)` - -**Parameters:** -- `type` - - *string* - filter to set the status for: - - `"available"` (can learn) - - `"unavailable"` (can't learn) - - `"used"` (already known) -- `status` - - *Flag* - 1 to show, 0 to hide items matching the specified filter. (Note that this is likely a bug as GetTrainerServiceTypeFilter returns a boolean now.) -- `exclusive` - - *?* - ? - -**Example Usage:** -```lua --- Show only the skills that are available to learn -SetTrainerServiceTypeFilter("available", 1) --- Hide the skills that are already known -SetTrainerServiceTypeFilter("used", 0) -``` - -**Description:** -This function is used to control the visibility of different types of skills in the trainer window. It allows you to filter skills based on whether they are available to learn, unavailable, or already known. This can be particularly useful for customizing the trainer interface to show only relevant skills. - -**Usage in Addons:** -Large addons like TradeSkillMaster (TSM) may use this function to filter out skills that are not relevant to the user, thereby providing a cleaner and more focused interface. For example, TSM might hide skills that are already known to avoid cluttering the trainer window. \ No newline at end of file diff --git a/wiki-information/functions/SetTurnEnabled.md b/wiki-information/functions/SetTurnEnabled.md deleted file mode 100644 index ba614ec7..00000000 --- a/wiki-information/functions/SetTurnEnabled.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: SetTurnEnabled - -**Content:** -Needs summary. -`SetTurnEnabled()` \ No newline at end of file diff --git a/wiki-information/functions/SetUIVisibility.md b/wiki-information/functions/SetUIVisibility.md deleted file mode 100644 index c87e71f5..00000000 --- a/wiki-information/functions/SetUIVisibility.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetUIVisibility - -**Content:** -Needs summary. -`SetUIVisibility(visible)` - -**Parameters:** -- `visible` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/SetUnitCursorTexture.md b/wiki-information/functions/SetUnitCursorTexture.md deleted file mode 100644 index af83f6ea..00000000 --- a/wiki-information/functions/SetUnitCursorTexture.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: SetUnitCursorTexture - -**Content:** -Needs summary. -`hasCursor = SetUnitCursorTexture(textureObject, unit)` - -**Parameters:** -- `textureObject` - - *Unknown* -- `unit` - - *string* -- `style` - - *Enum.CursorStyle?* - - `Value` - - `Field` - - `Description` - - `0` - - Mouse - - `1` - - Crosshair -- `includeLowPriority` - - *boolean?* - -**Returns:** -- `hasCursor` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/SetView.md b/wiki-information/functions/SetView.md deleted file mode 100644 index 33bd406d..00000000 --- a/wiki-information/functions/SetView.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: SetView - -**Content:** -Sets the camera to a predefined camera position (1-5). -`SetView(viewIndex)` - -**Parameters:** -- `viewIndex` - - *number* - The view index (1-5) to return to (1 is always first person, and cannot be saved with SaveView) - -**Description:** -If SaveView has not previously been used on the view index, then your camera will be set to a preset position and angle. -The first view index defaults to first person. -The last position loaded is stored in the CVar `cameraView`. \ No newline at end of file diff --git a/wiki-information/functions/SetWatchedFactionIndex.md b/wiki-information/functions/SetWatchedFactionIndex.md deleted file mode 100644 index db43e1e9..00000000 --- a/wiki-information/functions/SetWatchedFactionIndex.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: SetWatchedFactionIndex - -**Content:** -Watches a faction in the reputation window. -`SetWatchedFactionIndex(index)` - -**Parameters:** -- `index` - - *number* - The index of the faction to watch, ascending from 1; out-of-range values will clear the watched faction. - -**Reference:** -- `GetWatchedFactionInfo` \ No newline at end of file diff --git a/wiki-information/functions/SetupFullscreenScale.md b/wiki-information/functions/SetupFullscreenScale.md deleted file mode 100644 index 07cd73fa..00000000 --- a/wiki-information/functions/SetupFullscreenScale.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SetupFullscreenScale - -**Content:** -Sizes a frame to take up the entire screen regardless of screen resolution. -`SetupFullscreenScale(frame)` - -**Parameters:** -- `frame` - - The frame to manipulate. \ No newline at end of file diff --git a/wiki-information/functions/ShiftQuestWatches.md b/wiki-information/functions/ShiftQuestWatches.md deleted file mode 100644 index 55f1aa9e..00000000 --- a/wiki-information/functions/ShiftQuestWatches.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: ShiftQuestWatches - -**Content:** -Exchanges the order of two watched quests. -`ShiftQuestWatches(id1, id2)` - -**Parameters:** -- `id1`, `id2` - - *Number* - Indices of the quest watches (ascending from 1 to the number of currently watched quests) to exchange positions of. - -**Description:** -Related API: `SortQuestWatches` \ No newline at end of file diff --git a/wiki-information/functions/ShowBossFrameWhenUninteractable.md b/wiki-information/functions/ShowBossFrameWhenUninteractable.md deleted file mode 100644 index c68e7eee..00000000 --- a/wiki-information/functions/ShowBossFrameWhenUninteractable.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: ShowBossFrameWhenUninteractable - -**Content:** -Needs summary. -`show = ShowBossFrameWhenUninteractable(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `show` - - *boolean* - -**Example Usage:** -This function can be used to determine whether the boss frame should be shown for a given unit when it is uninteractable. This can be useful in scenarios where you need to manage UI elements based on the interactability of boss units. - -**Addons:** -While specific large addons using this function are not well-documented, it is likely used in raid and boss encounter addons to manage the display of boss frames dynamically based on the unit's state. \ No newline at end of file diff --git a/wiki-information/functions/ShowCloak.md b/wiki-information/functions/ShowCloak.md deleted file mode 100644 index e0561b75..00000000 --- a/wiki-information/functions/ShowCloak.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: ShowCloak - -**Content:** -Enables or disables display of your cloak. -`ShowCloak(flag)` - -**Parameters:** -- `flag` - - *boolean* - whether the cloak should be shown - -**Usage:** -Toggles displaying your cloak. -```lua -/run ShowCloak(not ShowingCloak()) -``` - -**Reference:** -- `ShowingCloak()` \ No newline at end of file diff --git a/wiki-information/functions/ShowHelm.md b/wiki-information/functions/ShowHelm.md deleted file mode 100644 index bf7ee0f7..00000000 --- a/wiki-information/functions/ShowHelm.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: ShowHelm - -**Content:** -Enables or disables display of your helm. -`ShowHelm(flag)` - -**Parameters:** -- `flag` - - *boolean* - whether the helm should be shown - -**Usage:** -Toggles displaying your helm. -```lua -/run ShowHelm(not ShowingHelm()) -``` - -**Reference:** -- `ShowingHelm()` \ No newline at end of file diff --git a/wiki-information/functions/ShowQuestComplete.md b/wiki-information/functions/ShowQuestComplete.md deleted file mode 100644 index 5ee8831c..00000000 --- a/wiki-information/functions/ShowQuestComplete.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: ShowQuestComplete - -**Content:** -Shows the completion dialog for a complete, auto-completable quest. -`ShowQuestComplete(questID)` - -**Parameters:** -- `questID` - - *number* - id of the quest which is complete and auto-completable. - -**Reference:** -- `QUEST_COMPLETE`, when completion/reward information is available. - -**Description:** -Auto-completable quests can be turned in anywhere in the world, instead of requiring interaction with a specific NPC. \ No newline at end of file diff --git a/wiki-information/functions/ShowRepairCursor.md b/wiki-information/functions/ShowRepairCursor.md deleted file mode 100644 index cb610126..00000000 --- a/wiki-information/functions/ShowRepairCursor.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: ShowRepairCursor - -**Content:** -Puts the cursor in repair mode. -`ShowRepairCursor()` - -**Parameters:** -- None - -**Returns:** -- `nil` - -**Example Usage:** -This function can be used in an addon to change the cursor to repair mode when interacting with a repair vendor or when the player wants to repair items in their inventory. - -**Addons Using This Function:** -Many inventory management addons, such as Bagnon or ArkInventory, may use this function to facilitate the repair process directly from the inventory interface. \ No newline at end of file diff --git a/wiki-information/functions/ShowingCloak.md b/wiki-information/functions/ShowingCloak.md deleted file mode 100644 index 4b1a761d..00000000 --- a/wiki-information/functions/ShowingCloak.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: ShowingCloak - -**Content:** -Returns if the player is showing his cloak. -`isShowingCloak = ShowingCloak()` - -**Returns:** -- `isShowingCloak` - - *boolean* - -**Usage:** -Toggles displaying your cloak. -```lua -/run ShowCloak(not ShowingCloak()) -``` - -**Reference:** -- `ShowCloak()` \ No newline at end of file diff --git a/wiki-information/functions/ShowingHelm.md b/wiki-information/functions/ShowingHelm.md deleted file mode 100644 index 78cbce5a..00000000 --- a/wiki-information/functions/ShowingHelm.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: ShowingHelm - -**Content:** -Returns if the player is showing his helm. -`isShowingHelm = ShowingHelm()` - -**Returns:** -- `isShowingHelm` - - *boolean* - -**Usage:** -Toggles displaying your helm. -```lua -/run ShowHelm(not ShowingHelm()) -``` - -**Reference:** -`ShowHelm()` \ No newline at end of file diff --git a/wiki-information/functions/SitStandOrDescendStart.md b/wiki-information/functions/SitStandOrDescendStart.md deleted file mode 100644 index 4e461595..00000000 --- a/wiki-information/functions/SitStandOrDescendStart.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: SitStandOrDescendStart - -**Content:** -Makes the player sit, stand, or descend (while swimming or flying). -`SitStandOrDescendStart()` - -**Description:** -You can use `DoEmote("STAND")` / `DoEmote("SIT")` to accomplish what this API did prior to being protected. \ No newline at end of file diff --git a/wiki-information/functions/SortAuctionSetSort.md b/wiki-information/functions/SortAuctionSetSort.md deleted file mode 100644 index cdc3f7c8..00000000 --- a/wiki-information/functions/SortAuctionSetSort.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: SortAuctionSetSort - -**Content:** -Sets the column by which the auction house sorts query results. This applies after the next search query or call to `SortAuctionApplySort(type)` -`SortAuctionSetSort(type, column, reverse)` - -**Parameters:** -- `type` - - *string* - One of the following: - - `"list"` - For items up for purchase, the "Browse" tab. - - `"bidder"` - For items the player has bid on, the "Bids" tab. - - `"owner"` - For items the player has posted, the "Auctions" tab. -- `column` - - *string* - One of the following: - - `"quality"` - The rarity of the item. - - `"level"` - The minimum required level (if any). Only applies to "list" and "bidder" type views. - - `"status"` - When the type is "list" this is the seller's name. For the "owner" type it is the high bidder's name. - - `"duration"` - The amount of time left in the auction. - - `"bid"` - The current bid amount for an auction. - - `"name"` - The name of the item. This is a hidden column. - - `"buyout"` - Buyout for the auction. This is a hidden column. - - `"unitprice"` - Per-item (not per-stack) buyout price. This is a hidden and undocumented column. -- `reverse` - - *boolean* - Should the sort order be reversed. \ No newline at end of file diff --git a/wiki-information/functions/SortQuestWatches.md b/wiki-information/functions/SortQuestWatches.md deleted file mode 100644 index ac4283a2..00000000 --- a/wiki-information/functions/SortQuestWatches.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SortQuestWatches - -**Content:** -Sorts watched quests by proximity to the player character. -`changed = SortQuestWatches()` - -**Returns:** -- `changed` - - *boolean* - true if any change to the order of watched quests was made, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/SpellCanTargetUnit.md b/wiki-information/functions/SpellCanTargetUnit.md deleted file mode 100644 index 890c1512..00000000 --- a/wiki-information/functions/SpellCanTargetUnit.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: SpellCanTargetUnit - -**Content:** -Returns true if the spell awaiting target selection can be cast on the unit. -`canTarget = SpellCanTargetUnit(unitId)` - -**Parameters:** -- `unitId` - - *string (UnitId)* - The unit to check. - -**Returns:** -- `canTarget` - - *boolean* - Whether the spell can target the given unit. - -**Description:** -This will check for range, but not for LOS (Line of Sight). \ No newline at end of file diff --git a/wiki-information/functions/SpellGetVisibilityInfo.md b/wiki-information/functions/SpellGetVisibilityInfo.md deleted file mode 100644 index 1d2e6a2e..00000000 --- a/wiki-information/functions/SpellGetVisibilityInfo.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: SpellGetVisibilityInfo - -**Content:** -Checks if the spell should be visible, depending on spellId and raid combat status. -`hasCustom, alwaysShowMine, showForMySpec = SpellGetVisibilityInfo(spellId, visType)` - -**Parameters:** -- `spellId` - - *number* - The ID of the spell to check. -- `visType` - - *string* - either "RAID_INCOMBAT" if in combat, "RAID_OUTOFCOMBAT" otherwise. - -**Returns:** -- `hasCustom` - - *boolean* - whether the spell visibility should be customized, if false it means always display. -- `alwaysShowMine` - - *boolean* - whether to show the spell if cast by the player/player's pet/vehicle (e.g. the Paladin Forbearance debuff). -- `showForMySpec` - - *boolean* - whether to show the spell for the current specialization of the player. - -**Description:** -This is used by Blizzard's compact frame until 8.2.5, for whether it should be shown in the raid UI. \ No newline at end of file diff --git a/wiki-information/functions/SpellIsTargeting.md b/wiki-information/functions/SpellIsTargeting.md deleted file mode 100644 index 0548fec4..00000000 --- a/wiki-information/functions/SpellIsTargeting.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SpellIsTargeting - -**Content:** -Returns true if a spell is about to be cast and is waiting for the player to select a target. -`isTargeting = SpellIsTargeting()` - -**Returns:** -- `isTargeting` - - *boolean* - 1 if a spell is about to be cast, waiting for the player to select a target; nil otherwise. \ No newline at end of file diff --git a/wiki-information/functions/SpellStopCasting.md b/wiki-information/functions/SpellStopCasting.md deleted file mode 100644 index 51ad869c..00000000 --- a/wiki-information/functions/SpellStopCasting.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: SpellStopCasting - -**Content:** -Stops the current spellcast. -`stopped = SpellStopCasting()` - -**Returns:** -- `stopped` - - *boolean* - 1 if a spell was being cast, nil otherwise. - -**Example Usage:** -```lua --- Example of stopping a spell cast -local wasCasting = SpellStopCasting() -if wasCasting then - print("Spell casting was stopped.") -else - print("No spell was being cast.") -end -``` - -**Description:** -The `SpellStopCasting` function is useful in scenarios where you need to interrupt a spell cast, such as when a player needs to move or switch to a different action quickly. This function is often used in macros and addons to enhance gameplay efficiency. - -**Addons Using This Function:** -- **Quartz**: A popular casting bar addon that uses `SpellStopCasting` to manage and display the player's casting bar, ensuring accurate representation of spell interruptions. -- **WeakAuras**: A powerful and flexible framework for displaying highly customizable graphics on your screen to indicate buffs, debuffs, and other relevant information. It can use `SpellStopCasting` to trigger alerts or animations when a spell cast is interrupted. \ No newline at end of file diff --git a/wiki-information/functions/SpellStopTargeting.md b/wiki-information/functions/SpellStopTargeting.md deleted file mode 100644 index 5969a22e..00000000 --- a/wiki-information/functions/SpellStopTargeting.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: SpellStopTargeting - -**Content:** -Cancels the spell awaiting target selection. -`SpellStopTargeting()` - -**Description:** -Also cancels some types of weapon buffs when they ask for confirmation. For example, if you attempt to apply a poison to a weapon that already has a poison, the game will ask you to confirm the replacement. You can accept the replacement with `ReplaceEnchant()` or cancel the replacement with `SpellStopTargeting()`. \ No newline at end of file diff --git a/wiki-information/functions/SpellTargetUnit.md b/wiki-information/functions/SpellTargetUnit.md deleted file mode 100644 index 4e708996..00000000 --- a/wiki-information/functions/SpellTargetUnit.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: SpellTargetUnit - -**Content:** -Casts the spell awaiting target selection on the unit. -`SpellTargetUnit(unitId)` - -**Parameters:** -- `unitId` - - *string* : UnitId - The unit you wish to cast the spell on. - -**Example Usage:** -```lua --- Assuming you have a spell ready to be cast and you want to target the player -SpellTargetUnit("player") -``` - -**Description:** -The `SpellTargetUnit` function is used to cast a spell that is currently awaiting target selection on a specified unit. This is particularly useful in macros or scripts where you need to automate spell casting on specific units. - -**Usage in Addons:** -Many large addons, such as HealBot and Clique, use `SpellTargetUnit` to facilitate quick and efficient healing or buffing by allowing players to cast spells on units directly through their custom interfaces. This function helps streamline the process of targeting and casting spells, making gameplay smoother and more efficient. \ No newline at end of file diff --git a/wiki-information/functions/SplitContainerItem.md b/wiki-information/functions/SplitContainerItem.md deleted file mode 100644 index 63ce6c58..00000000 --- a/wiki-information/functions/SplitContainerItem.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: SplitContainerItem - -**Content:** -Places part of a stack of items from a container onto the cursor. -`SplitContainerItem(bagID, slot, count)` - -**Parameters:** -- `bagID` - - *number* - id of the bag the slot is located in. -- `slot` - - *number* - slot inside the bag (top left slot is 1, slot to the right of it is 2). -- `count` - - *number* - Quantity to pick up. - -**Description:** -This function always puts the requested item(s) on the cursor (unlike `PickupContainerItem()` which can pick up items, place items, or cast spells on items based on what's already on the cursor). -Passing a larger count than is in the requested bag and slot will pick up nothing. \ No newline at end of file diff --git a/wiki-information/functions/StablePet.md b/wiki-information/functions/StablePet.md deleted file mode 100644 index aebfa192..00000000 --- a/wiki-information/functions/StablePet.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: StablePet - -**Content:** -Puts your current pet in the stable if there is room. -`StablePet()` - -**Example Usage:** -This function can be used in macros or scripts to automate the process of stabling your current pet, which is particularly useful for hunters who frequently switch between pets. - -**Addons:** -Large addons like "PetTracker" might use this function to manage pet stabling automatically based on certain conditions or user preferences. \ No newline at end of file diff --git a/wiki-information/functions/StartAuction.md b/wiki-information/functions/StartAuction.md deleted file mode 100644 index b1644b0a..00000000 --- a/wiki-information/functions/StartAuction.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: StartAuction - -**Content:** -Starts the auction you have created in the Create Auction panel. -`StartAuction(minBid, buyoutPrice, runTime, stackSize, numStacks)` - -The item is that which has been put into the AuctionSellItemButton. That's the slot in the 'create auction' panel. -The minBid and buyoutPrice are in copper. However, I can't figure out how to go below 1 silver. So putting in '50' or '10' or '1' will always make the auction do '1 silver'. But '102' will make it do '1 silver 2 copper'. -runTime may be one of the following: 1, 2, 3 for 12, 24, and 48 hours. - -**Examples:** -- `StartAuction(1,1,1)` - Start at 1 silver, buyout 1 silver, time 12 hours -- `StartAuction(1,10,1)` - Start at 1 silver, buyout 1 silver, time 12 hours -- `StartAuction(1,100,1)` - Start at 1 silver, buyout 1 silver, time 12 hours -- `StartAuction(1,1000,1)` - Start at 1 silver, buyout 10 silver, time 12 hours -- `StartAuction(1,10000,2)` - Start at 1 silver, buyout 1 gold, time 24 hours -- `StartAuction(101,150,3)` - Start at 1 silver 1 copper, buyout at 1 silver 50 copper, time 48 hours - -**Usage Example:** -1. Go to the auction house. -2. Right-click on the auctioneer. -3. Click on the 'auction' tab. -4. Drag an item to the slot in the 'Create Auction' panel. -5. Type the following into the chat window: - - `/script StartAuction(1,150,1)` - -This should create an auction starting at 1 silver, buyout at 1 silver 50 copper, with an auction time of 12 hours. It should say 'Auction Created' in the chat window. Now if you go to browse the auctions, your items should show up. - -**Description:** -As of Patch 4.0, `StartAuction()` requires a hardware event. This change does not show up in any patch documentation. \ No newline at end of file diff --git a/wiki-information/functions/StartDuel.md b/wiki-information/functions/StartDuel.md deleted file mode 100644 index 301f6454..00000000 --- a/wiki-information/functions/StartDuel.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: StartDuel - -**Content:** -Challenges the specified player to a duel. -`StartDuel(unit)` -`StartDuel(name)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit id of the unit. -- `name` - - *string* - The name of the unit. -- `exactMatch` - - *boolean?* - true to check only units whose name exactly matches the name given; false to allow partial matches. - -**Description:** -`StartDuel("player")` is an apparent special case, creating a mouse cursor to select someone else to duel against. - -**Reference:** -- `AcceptDuel()` -- `CancelDuel()` \ No newline at end of file diff --git a/wiki-information/functions/StopMusic.md b/wiki-information/functions/StopMusic.md deleted file mode 100644 index fc3e166d..00000000 --- a/wiki-information/functions/StopMusic.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: StopMusic - -**Content:** -Stops the currently playing music. -`StopMusic()` - -**Description:** -This does not affect the built-in zone music, only music files that are played with `PlayMusic`. -Before Patch 2.2, this function would fade the currently playing music out. After Patch 2.2, it stops it immediately without a fade. \ No newline at end of file diff --git a/wiki-information/functions/StopSound.md b/wiki-information/functions/StopSound.md deleted file mode 100644 index f48a1d1f..00000000 --- a/wiki-information/functions/StopSound.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: StopSound - -**Content:** -Stops playing the specified sound. -`StopSound(soundHandle)` - -**Parameters:** -- `soundHandle` - - *number* - Playing sound handle, as returned by PlaySound or PlaySoundFile. -- `fadeoutTime` - - *number?* - In milliseconds. \ No newline at end of file diff --git a/wiki-information/functions/StopTradeSkillRepeat.md b/wiki-information/functions/StopTradeSkillRepeat.md deleted file mode 100644 index 74927d71..00000000 --- a/wiki-information/functions/StopTradeSkillRepeat.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: StopTradeSkillRepeat - -**Content:** -Stops the trade skill creation queue (e.g., when the user presses Create All or specifies a number of crafts in a profession tab). -`StopTradeSkillRepeat()` - -**Notes and Caveats:** -This function will not interrupt the current cast. It will stop the queue once the current cast finishes. \ No newline at end of file diff --git a/wiki-information/functions/StrafeLeftStart.md b/wiki-information/functions/StrafeLeftStart.md deleted file mode 100644 index 140c08a3..00000000 --- a/wiki-information/functions/StrafeLeftStart.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: StrafeLeftStart - -**Content:** -The player begins strafing left at the specified time. -`StrafeLeftStart(startTime)` - -**Parameters:** -- `startTime` - - Begin strafing left at this time. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StrafeLeftStop.md b/wiki-information/functions/StrafeLeftStop.md deleted file mode 100644 index 901caa83..00000000 --- a/wiki-information/functions/StrafeLeftStop.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: StrafeLeftStop - -**Content:** -The player stops strafing left at the specified time. -`StrafeLeftStop(startTime)` - -**Parameters:** -- `stopTime` - - Stop strafing left at this time, per GetTime * 1000. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StrafeRightStart.md b/wiki-information/functions/StrafeRightStart.md deleted file mode 100644 index 48bc15d6..00000000 --- a/wiki-information/functions/StrafeRightStart.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: StrafeRightStart - -**Content:** -The player begins strafing right at the specified time. -`StrafeRightStart(startTime)` - -**Parameters:** -- `startTime` - - *number* - Begin strafing right at this time, per GetTime * 1000. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StrafeRightStop.md b/wiki-information/functions/StrafeRightStop.md deleted file mode 100644 index 0400eea5..00000000 --- a/wiki-information/functions/StrafeRightStop.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: StrafeRightStop - -**Content:** -The player stops strafing right at the specified time. -`StrafeRightStop(startTime)` - -**Parameters:** -- `stopTime` - - Stop strafing right at this time, per GetTime * 1000. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/StripHyperlinks.md b/wiki-information/functions/StripHyperlinks.md deleted file mode 100644 index 773e8071..00000000 --- a/wiki-information/functions/StripHyperlinks.md +++ /dev/null @@ -1,24 +0,0 @@ -## Title: StripHyperlinks - -**Content:** -Strips text of UI escape sequence markup. -`stripped = StripHyperlinks(text)` - -**Parameters:** -- `text` - - *string* - The text to be stripped of markup. -- `maintainColor` - - *boolean?* - If true, preserve color escape sequences. -- `maintainBrackets` - - *boolean?* -- `stripNewlines` - - *boolean?* - If true, strip all line break sequences. -- `maintainAtlases` - - *boolean?* - If true, preserve atlas texture escape sequences. - -**Returns:** -- `stripped` - - *string* - The stripped text. - -**Description:** -This function is used by the Addon compartment to strip markup from addon titles prior to sorting. \ No newline at end of file diff --git a/wiki-information/functions/Stuck.md b/wiki-information/functions/Stuck.md deleted file mode 100644 index e5fb7597..00000000 --- a/wiki-information/functions/Stuck.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: Stuck - -**Content:** -Notifies the game engine that the player is stuck. -`Stuck()` - -**Description:** -Starts casting a 10-second spell that kills the player, allowing their ghost to teleport to a graveyard. -This function is accessible via the Customer Support panel, in the "Character Stuck!" section. \ No newline at end of file diff --git a/wiki-information/functions/SummonFriend.md b/wiki-information/functions/SummonFriend.md deleted file mode 100644 index 64595169..00000000 --- a/wiki-information/functions/SummonFriend.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: SummonFriend - -**Content:** -Summons a player using the RaF system. -`SummonFriend(guid, name)` - -**Parameters:** -- `guid` - - *string* : GUID - The guid of the player. -- `name` - - *string* - The name of the player. - -**Usage:** -Summons the current target if the target is a recruited friend. -`SummonFriend(UnitGUID("target"), UnitName("target"))` - -**Reference:** -- `CanSummonFriend` -- `GetSummonFriendCooldown` \ No newline at end of file diff --git a/wiki-information/functions/SupportsClipCursor.md b/wiki-information/functions/SupportsClipCursor.md deleted file mode 100644 index 080ab849..00000000 --- a/wiki-information/functions/SupportsClipCursor.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: SupportsClipCursor - -**Content:** -Needs summary. -`supportsClipCursor = SupportsClipCursor()` - -**Returns:** -- `supportsClipCursor` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/SwapRaidSubgroup.md b/wiki-information/functions/SwapRaidSubgroup.md deleted file mode 100644 index 4a405bba..00000000 --- a/wiki-information/functions/SwapRaidSubgroup.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: SwapRaidSubgroup - -**Content:** -Swaps two raid members into different groups. -`SwapRaidSubgroup(index1, index2)` - -**Parameters:** -- `index1` - - *number* - ID of first raid member (1 to MAX_RAID_MEMBERS) -- `index2` - - *number* - ID of second raid member (1 to MAX_RAID_MEMBERS) - -**Reference:** -- `SetRaidSubgroup` - -**Example Usage:** -This function can be used in a raid management addon to quickly reorganize raid groups. For instance, if a raid leader wants to swap a healer and a DPS between groups for better group composition, they can use this function to automate the process. - -**Addons Using This Function:** -- **ElvUI**: A popular UI overhaul addon that includes raid management features. It uses `SwapRaidSubgroup` to allow raid leaders to easily manage and swap raid members between groups. -- **oRA3**: A raid management addon that provides additional raid leader tools, including the ability to swap raid members between groups using this function. \ No newline at end of file diff --git a/wiki-information/functions/TakeInboxItem.md b/wiki-information/functions/TakeInboxItem.md deleted file mode 100644 index ee7488f6..00000000 --- a/wiki-information/functions/TakeInboxItem.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: TakeInboxItem - -**Content:** -Takes the attached item from the mailbox message. -`TakeInboxItem(index, itemIndex)` - -**Parameters:** -- `index` - - the index of the mailbox message you want to take the item attachment from. -- `itemIndex` - - The index of the item to take (1-ATTACHMENTS_MAX_RECEIVE(16)) - -**Returns:** -Always returns nil. (note: please confirm) As the request is done to the server asynchronously and might fail, then if knowing whether the action was successful is important, you will need to check afterward that it was. - -**Usage:** -`TakeInboxItem(1, 1)` - -**Description:** -Sends a request to the server to take an item attachment from a mail message. Note that this is only a request to the server, and the action might fail. Possible reasons for failure include that the user's bags are full, that they already have the maximum number of the item they are allowed to have (e.g., a unique item), or that a prior `TakeInboxItem()` request is still being processed by the server. There may be other reasons for failure. Would attempt to take the attachment from the first message in the Inbox and place it in the next available container slot. \ No newline at end of file diff --git a/wiki-information/functions/TakeInboxMoney.md b/wiki-information/functions/TakeInboxMoney.md deleted file mode 100644 index d7301c9e..00000000 --- a/wiki-information/functions/TakeInboxMoney.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: TakeInboxMoney - -**Content:** -Take the attached money from the mailbox message at index. -`TakeInboxMoney(index)` - -**Parameters:** -- `index` - - *number* - a number representing a message in the inbox - -**Usage:** -```lua -for i = GetInboxNumItems(), 1, -1 do - TakeInboxMoney(i); -- BUG IN CHINA GAME. if number > 1, takeInboxMoney(N) = InboxMoney(1); -end; -``` - -**Example Use Case:** -This function can be used in an addon that automates the process of collecting gold from mailbox messages, such as an auction house addon that retrieves earnings from sold items. - -**Addon Usage:** -Large addons like "TradeSkillMaster" use similar functions to automate mailbox operations, ensuring that users can efficiently manage their auction house transactions by quickly collecting gold and items from their mailbox. \ No newline at end of file diff --git a/wiki-information/functions/TakeTaxiNode.md b/wiki-information/functions/TakeTaxiNode.md deleted file mode 100644 index ab283992..00000000 --- a/wiki-information/functions/TakeTaxiNode.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TakeTaxiNode - -**Content:** -Travels to the specified flight path node. -`TakeTaxiNode(index)` - -**Parameters:** -- `index` - - *number* - Taxi node index to begin travelling to, ascending from 1 to `NumTaxiNodes()`. \ No newline at end of file diff --git a/wiki-information/functions/TargetDirectionEnemy.md b/wiki-information/functions/TargetDirectionEnemy.md deleted file mode 100644 index 4fce5416..00000000 --- a/wiki-information/functions/TargetDirectionEnemy.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: TargetDirectionEnemy - -**Content:** -Needs summary. -`TargetDirectionEnemy(facing)` - -**Parameters:** -- `facing` - - *number* -- `coneAngle` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/TargetDirectionFriend.md b/wiki-information/functions/TargetDirectionFriend.md deleted file mode 100644 index 2e131b53..00000000 --- a/wiki-information/functions/TargetDirectionFriend.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: TargetDirectionFriend - -**Content:** -Needs summary. -`TargetDirectionFriend(facing)` - -**Parameters:** -- `facing` - - *number* -- `coneAngle` - - *number?* \ No newline at end of file diff --git a/wiki-information/functions/TargetLastEnemy.md b/wiki-information/functions/TargetLastEnemy.md deleted file mode 100644 index 50c5c17b..00000000 --- a/wiki-information/functions/TargetLastEnemy.md +++ /dev/null @@ -1,5 +0,0 @@ -## Title: TargetLastEnemy - -**Content:** -Targets the previously targeted enemy. -`TargetLastEnemy()` \ No newline at end of file diff --git a/wiki-information/functions/TargetLastTarget.md b/wiki-information/functions/TargetLastTarget.md deleted file mode 100644 index fde27f28..00000000 --- a/wiki-information/functions/TargetLastTarget.md +++ /dev/null @@ -1,8 +0,0 @@ -## Title: TargetLastTarget - -**Content:** -Selects the last target as the current target. -`TargetLastTarget()` - -**Description:** -Targets the player's last target. It will select a dead character or mob's corpse if that was the last live character or mob targeted. Can distinguish between two mobs of the same name and level. \ No newline at end of file diff --git a/wiki-information/functions/TargetNearest.md b/wiki-information/functions/TargetNearest.md deleted file mode 100644 index ea6f16c5..00000000 --- a/wiki-information/functions/TargetNearest.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TargetNearest - -**Content:** -Needs summary. -`TargetNearest()` - -**Parameters:** -- `reverse` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestEnemy.md b/wiki-information/functions/TargetNearestEnemy.md deleted file mode 100644 index 9a307127..00000000 --- a/wiki-information/functions/TargetNearestEnemy.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: TargetNearestEnemy - -**Content:** -Selects the nearest enemy as the current target. -`TargetNearestEnemy()` - -**Parameters:** -- `reverse` - - *boolean* - true to cycle backwards; false to cycle forwards. - -**Description:** -This is bound to the tab key by default. -This function only works if initiated by a hardware event. \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestEnemyPlayer.md b/wiki-information/functions/TargetNearestEnemyPlayer.md deleted file mode 100644 index 171eedd4..00000000 --- a/wiki-information/functions/TargetNearestEnemyPlayer.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TargetNearestEnemyPlayer - -**Content:** -Needs summary. -`TargetNearestEnemyPlayer()` - -**Parameters:** -- `reverse` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestFriend.md b/wiki-information/functions/TargetNearestFriend.md deleted file mode 100644 index 39b60d19..00000000 --- a/wiki-information/functions/TargetNearestFriend.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: TargetNearestFriend - -**Content:** -Targets the nearest friendly unit. -`TargetNearestFriend()` - -**Parameters:** -- `reverse` - - *boolean* - if true, reverses the order of targeting units. - -**Example Usage:** -```lua --- Target the nearest friendly unit -TargetNearestFriend() - --- Target the nearest friendly unit in reverse order -TargetNearestFriend(true) -``` - -**Description:** -This function is useful in scenarios where you need to quickly target a friendly unit, such as in PvP or PvE situations where healing or buffing allies is critical. By using the `reverse` parameter, you can cycle through friendly units in the opposite order, which can be helpful in crowded environments. - -**Addons Using This Function:** -- **HealBot**: A popular healing addon that uses this function to quickly target friendly units for healing spells. -- **Clique**: An addon that allows for click-casting on unit frames, which may use this function to target friendly units efficiently. \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestFriendPlayer.md b/wiki-information/functions/TargetNearestFriendPlayer.md deleted file mode 100644 index 8e7362a3..00000000 --- a/wiki-information/functions/TargetNearestFriendPlayer.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TargetNearestFriendPlayer - -**Content:** -Needs summary. -`TargetNearestFriendPlayer()` - -**Parameters:** -- `reverse` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestPartyMember.md b/wiki-information/functions/TargetNearestPartyMember.md deleted file mode 100644 index 89bad2b9..00000000 --- a/wiki-information/functions/TargetNearestPartyMember.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TargetNearestPartyMember - -**Content:** -Needs summary. -`TargetNearestPartyMember()` - -**Parameters:** -- `reverse` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetNearestRaidMember.md b/wiki-information/functions/TargetNearestRaidMember.md deleted file mode 100644 index 57cb6290..00000000 --- a/wiki-information/functions/TargetNearestRaidMember.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TargetNearestRaidMember - -**Content:** -Needs summary. -`TargetNearestRaidMember()` - -**Parameters:** -- `reverse` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetPriorityHighlightStart.md b/wiki-information/functions/TargetPriorityHighlightStart.md deleted file mode 100644 index f48df35d..00000000 --- a/wiki-information/functions/TargetPriorityHighlightStart.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TargetPriorityHighlightStart - -**Content:** -Needs summary. -`TargetPriorityHighlightStart()` - -**Parameters:** -- `useStartDelay` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TargetTotem.md b/wiki-information/functions/TargetTotem.md deleted file mode 100644 index 01f615d6..00000000 --- a/wiki-information/functions/TargetTotem.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TargetTotem - -**Content:** -Needs summary. -`TargetTotem(slot)` - -**Parameters:** -- `slot` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/TargetUnit.md b/wiki-information/functions/TargetUnit.md deleted file mode 100644 index c02687c3..00000000 --- a/wiki-information/functions/TargetUnit.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: TargetUnit - -**Content:** -Targets the specified unit. -`TargetUnit()` - -**Parameters:** -- `name` - - *string?* -- `exactMatch` - - *boolean?* = false \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetDestX.md b/wiki-information/functions/TaxiGetDestX.md deleted file mode 100644 index 0d68e99f..00000000 --- a/wiki-information/functions/TaxiGetDestX.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: TaxiGetDestX - -**Content:** -Returns the horizontal position of the destination node of a given route to the destination. -`local dX = TaxiGetDestX(destinationIndex, routeIndex)` - -**Parameters:** -- `(destinationIndex, routeIndex)` - - `destinationIndex` - - *number* - The final destination taxi node. - - `routeIndex` - - *number* - The index of the route to get the source from. - -**Returns:** -- `dX` - - *number* - The horizontal position of the destination node for the route. \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetDestY.md b/wiki-information/functions/TaxiGetDestY.md deleted file mode 100644 index 18cf7634..00000000 --- a/wiki-information/functions/TaxiGetDestY.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: TaxiGetDestY - -**Content:** -Returns the vertical position of the destination node of a given route to the destination. -`local dY = TaxiGetDestY(destinationIndex, routeIndex)` - -**Parameters:** -- `destinationIndex` - - *number* - The final destination taxi node. -- `routeIndex` - - *number* - The index of the route to get the source from. - -**Returns:** -- `dY` - - *number* - The vertical position of the destination node for the route. \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetSrcX.md b/wiki-information/functions/TaxiGetSrcX.md deleted file mode 100644 index 37bbba20..00000000 --- a/wiki-information/functions/TaxiGetSrcX.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: TaxiGetSrcX - -**Content:** -Returns the horizontal position of the source node of a given route to the destination. -`local sX = TaxiGetSrcX(destinationIndex, routeIndex)` - -**Parameters:** -- `(destinationIndex, routeIndex)` - - `destinationIndex` - - *number* - The final destination taxi node. - - `routeIndex` - - *number* - The index of the route to get the source from. - -**Returns:** -- `sX` - - *number* - The horizontal position of the source node. \ No newline at end of file diff --git a/wiki-information/functions/TaxiGetSrcY.md b/wiki-information/functions/TaxiGetSrcY.md deleted file mode 100644 index 669f2144..00000000 --- a/wiki-information/functions/TaxiGetSrcY.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: TaxiGetSrcY - -**Content:** -Returns the vertical position of the source node of a given route to the destination. -`local sY = TaxiGetSrcY(destinationIndex, routeIndex)` - -**Parameters:** -- `(destinationIndex, routeIndex)` - - `destinationIndex` - - *number* - The final destination taxi node. - - `routeIndex` - - *number* - The index of the route to get the source from. - -**Returns:** -- `sY` - - *number* - The vertical position of the source node. \ No newline at end of file diff --git a/wiki-information/functions/TaxiNodeCost.md b/wiki-information/functions/TaxiNodeCost.md deleted file mode 100644 index 3ce2fbee..00000000 --- a/wiki-information/functions/TaxiNodeCost.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: TaxiNodeCost - -**Content:** -Returns the cost of the flight path in copper. -`cost = TaxiNodeCost(slot)` - -**Parameters:** -- `slot` - - *number* - 1 ascending to NumTaxiNodes(), out of bound numbers triggers lua error. - -**Returns:** -- `cost` - - *number* - returns the cost in copper, 0 if destination is undiscovered, free or current node. - -**Usage:** -The following example will print the name and cost for each flight point that is not free. -```lua -for i = 1, NumTaxiNodes() do - if (TaxiNodeCost(i) > 0) then - print(format("Flight to %s costs: %s", TaxiNodeName(i), GetCoinText(TaxiNodeCost(i), " "))) - end -end -``` - -**Description:** -Taxi information is only available while the taxi map is open -- between the TAXIMAP_OPENED and TAXIMAP_CLOSED events. -"invalid taxi node slot" is an error triggered by out-of-bound slot (0 or NumTaxiNodes() < slot) or if there is no taxi map open. -For some reason, this returns the original cost of the given slot, not taking into account any reductions you get due to faction. - -**Reference:** -- `NumTaxiNodes()` -- `TaxiNodeGetType(slot)` -- `TaxiNodeName(slot)` \ No newline at end of file diff --git a/wiki-information/functions/TaxiNodeGetType.md b/wiki-information/functions/TaxiNodeGetType.md deleted file mode 100644 index e96fbd55..00000000 --- a/wiki-information/functions/TaxiNodeGetType.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: TaxiNodeGetType - -**Content:** -Returns the type of a flight path node. -`type = TaxiNodeGetType(index)` - -**Parameters:** -- `index` - - *number* - Taxi map node index, ascending from 1 to NumTaxiNodes(). - -**Returns:** -- `type` - - *string* - "CURRENT" for the player's current position, "REACHABLE" for nodes that can be travelled to, "DISTANT" for nodes that can't be travelled to, and "NONE" if the index is out of bounds. - -**Description:** -Taxi information is only available while the taxi map is open -- between the TAXIMAP_OPENED and TAXIMAP_CLOSED events. - -**Reference:** -- `TaxiNodeName` \ No newline at end of file diff --git a/wiki-information/functions/TaxiNodeName.md b/wiki-information/functions/TaxiNodeName.md deleted file mode 100644 index e1102007..00000000 --- a/wiki-information/functions/TaxiNodeName.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: TaxiNodeName - -**Content:** -Returns the name of a flight path node. -`name = TaxiNodeName(index)` - -**Parameters:** -- `index` - - *number* - Index of the taxi map node, ascending from 1 to `NumTaxiNodes()` - -**Returns:** -- `name` - - *string* - name of the specified flight point, or "INVALID" if the index is out of bounds. - -**Description:** -Taxi information is only available while the taxi map is open -- between the `TAXIMAP_OPENED` and `TAXIMAP_CLOSED` events. \ No newline at end of file diff --git a/wiki-information/functions/TimeoutResurrect.md b/wiki-information/functions/TimeoutResurrect.md deleted file mode 100644 index 84920efd..00000000 --- a/wiki-information/functions/TimeoutResurrect.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: TimeoutResurrect - -**Content:** -Signals the client that an offer to resurrect the player has expired. -`TimeoutResurrect()` - -**Description:** -Called when the timeout timer on resurrection StaticPopups expires. Prior to patch 5.4.0, `DeclineResurrect` was used for both timed out and declined resurrection requests. - -**Reference:** -- `AcceptResurrect` -- `DeclineResurrect` \ No newline at end of file diff --git a/wiki-information/functions/ToggleAutoRun.md b/wiki-information/functions/ToggleAutoRun.md deleted file mode 100644 index 0159c607..00000000 --- a/wiki-information/functions/ToggleAutoRun.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: ToggleAutoRun - -**Content:** -Turns auto-run on or off. -`ToggleAutoRun()` - -**Example Usage:** -This function can be used in macros or scripts to toggle the auto-run feature in the game. For instance, you could create a macro to start or stop auto-running without needing to press the default keybind. - -**Addons:** -Many large addons, such as Bartender4, use similar functions to provide enhanced control over character movement and actions. While `ToggleAutoRun` itself might not be directly used, understanding how to control character movement programmatically is essential for creating comprehensive UI and control addons. \ No newline at end of file diff --git a/wiki-information/functions/TogglePVP.md b/wiki-information/functions/TogglePVP.md deleted file mode 100644 index 99d334b6..00000000 --- a/wiki-information/functions/TogglePVP.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: TogglePVP - -**Content:** -Toggles the player's PvP flag on or off. -`TogglePVP()` - -**Description:** -`TogglePVP()` is equivalent to `SetPVP(not GetPVPDesired())`. -This setting is different from war mode. \ No newline at end of file diff --git a/wiki-information/functions/ToggleRun.md b/wiki-information/functions/ToggleRun.md deleted file mode 100644 index 74bd6fd5..00000000 --- a/wiki-information/functions/ToggleRun.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ToggleRun - -**Content:** -Toggle between running and walking. -`ToggleRun(theTime)` - -**Parameters:** -- `theTime` - - Toggle between running and walking at the specified time, per GetTime * 1000. \ No newline at end of file diff --git a/wiki-information/functions/ToggleSelfHighlight.md b/wiki-information/functions/ToggleSelfHighlight.md deleted file mode 100644 index a0c23699..00000000 --- a/wiki-information/functions/ToggleSelfHighlight.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ToggleSelfHighlight - -**Content:** -Needs summary. -`enabled = ToggleSelfHighlight()` - -**Returns:** -- `enabled` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/ToggleSheath.md b/wiki-information/functions/ToggleSheath.md deleted file mode 100644 index 2350bb2b..00000000 --- a/wiki-information/functions/ToggleSheath.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: ToggleSheath - -**Content:** -Toggles sheathed or unsheathed weapons. -`ToggleSheath()` - -**Reference:** -- `UNIT_MODEL_CHANGED` → "unitTarget" -- See also: `GetSheathState` \ No newline at end of file diff --git a/wiki-information/functions/TurnLeftStart.md b/wiki-information/functions/TurnLeftStart.md deleted file mode 100644 index 7f8a33ef..00000000 --- a/wiki-information/functions/TurnLeftStart.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: TurnLeftStart - -**Content:** -Turns the player left at the specified time. -`TurnLeftStart(startTime)` - -**Parameters:** -- `startTime` - - *number* - Begin turning left at this time, per `GetTime * 1000`. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/TurnLeftStop.md b/wiki-information/functions/TurnLeftStop.md deleted file mode 100644 index a97b2063..00000000 --- a/wiki-information/functions/TurnLeftStop.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: TurnLeftStop - -**Content:** -The player stops turning left at the specified time. -`TurnLeftStop(stopTime)` - -**Parameters:** -- `stopTime` - - Stop turning left at this time, per GetTime * 1000. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/TurnOrActionStart.md b/wiki-information/functions/TurnOrActionStart.md deleted file mode 100644 index f5c2aa87..00000000 --- a/wiki-information/functions/TurnOrActionStart.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: TurnOrActionStart - -**Content:** -Starts a "right click" in the 3D game world. -`TurnOrActionStart()` - -**Description:** -This function is called when right-clicking in the 3D world. -Calling this function clears the "mouseover" unit. -When used alone, puts you into a "mouseturn" mode until `TurnOrActionStop` is called. -**IMPORTANT:** The normal restrictions regarding hardware event initiations still apply to anything this function might do. \ No newline at end of file diff --git a/wiki-information/functions/TurnOrActionStop.md b/wiki-information/functions/TurnOrActionStop.md deleted file mode 100644 index b192f8b4..00000000 --- a/wiki-information/functions/TurnOrActionStop.md +++ /dev/null @@ -1,10 +0,0 @@ -## Title: TurnOrActionStop - -**Content:** -Stops a "right click" in the 3D game world. -`TurnOrActionStop()` - -**Description:** -This function is called when right-clicking in the 3D world. Most useful, it can initiate an attack on the selected unit if no move occurs. When used alone, it can cancel a "mouseturn" started by a call to `TurnOrActionStart`. - -**IMPORTANT:** The normal restrictions regarding hardware event initiations still apply to anything this function might do. \ No newline at end of file diff --git a/wiki-information/functions/TurnRightStart.md b/wiki-information/functions/TurnRightStart.md deleted file mode 100644 index ad861652..00000000 --- a/wiki-information/functions/TurnRightStart.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: TurnRightStart - -**Content:** -Turns the player right at the specified time. -`TurnRightStart(startTime)` - -**Parameters:** -- `startTime` - - *number* - Begin turning right at this time, per GetTime * 1000 - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/TurnRightStop.md b/wiki-information/functions/TurnRightStop.md deleted file mode 100644 index 99008b35..00000000 --- a/wiki-information/functions/TurnRightStop.md +++ /dev/null @@ -1,12 +0,0 @@ -## Title: TurnRightStop - -**Content:** -The player stops turning right at the specified time. -`TurnRightStop(startTime)` - -**Parameters:** -- `stopTime` - - Stop turning right at this time, per `GetTime * 1000`. - -**Description:** -As of 1.6, the time parameter seems to be ignored, and this function needs to be called as the result of a button press. \ No newline at end of file diff --git a/wiki-information/functions/UninviteUnit.md b/wiki-information/functions/UninviteUnit.md deleted file mode 100644 index 947b12c7..00000000 --- a/wiki-information/functions/UninviteUnit.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: UninviteUnit - -**Content:** -Removes a player from the group if you're the leader, or initiates a vote to kick. -`UninviteUnit(name)` - -**Parameters:** -- `name` - - *string* - Name of the player to remove from the group. When removing cross-server players, it is important to include the server name: "Ygramul-Emerald Dream". -- `reason` - - *string?* - Used when initiating a kick vote against the player. - -**Description:** -If you're in a Dungeon Finder group and call `UninviteUnit` without providing a reason, the `VOTE_KICK_REASON_NEEDED` event will fire to notify you that a reason is required to initiate a kick vote. \ No newline at end of file diff --git a/wiki-information/functions/UnitAffectingCombat.md b/wiki-information/functions/UnitAffectingCombat.md deleted file mode 100644 index 884e73bd..00000000 --- a/wiki-information/functions/UnitAffectingCombat.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: UnitAffectingCombat - -**Content:** -Returns true if the unit is in combat. -`affectingCombat = UnitAffectingCombat(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit to check. - -**Returns:** -- `affectingCombat` - - *boolean* - Returns true if the unit is in combat or has aggro, false otherwise. - -**Description:** -- Returns true when initiating combat. -- Returns true if aggroed, even if the enemy doesn't land a blow. -- For hunters, it returns true shortly after the pet enters combat. -- If using a timed spell such as aimed shot, it returns true when the spell fires (not during charge up). -- Returns to false on death. -- Returns false if the unit being checked for aggro is out of range, or in another zone. -- Returns false if a unit is proximity-aggroed. It won't return true until it either attacks or is attacked. \ No newline at end of file diff --git a/wiki-information/functions/UnitArmor.md b/wiki-information/functions/UnitArmor.md deleted file mode 100644 index 1e1b1853..00000000 --- a/wiki-information/functions/UnitArmor.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: UnitArmor - -**Content:** -Returns the armor stats for the unit. -```lua -base, effectiveArmor, armor, bonusArmor = UnitArmor(unit) -- retail -base, effectiveArmor, armor, posBuff, negBuff = UnitArmor(unit) -- classic -``` - -**Parameters:** -- `unit` - - *string* : UnitToken - Only works for "player" and "pet". Works for "target" with Hunter's Beast Lore. - -**Returns:** -- `base` - - *number* - The unit's base armor. -- `effectiveArmor` - - *number* - The unit's effective armor. -- `armor` - - *number* -- `bonusArmor` (Retail) - - *number* -- `posBuff` (Classic) - - *number* - Amount of armor increase due to positive buffs -- `negBuff` (Classic) - - *number* - Amount of armor reduction due to negative buffs (a negative number) - -**Usage:** -```lua -local base, effectiveArmor = UnitArmor("player") -print(format("Your current armor is %d (%d base)", effectiveArmor, base)) -``` - -**Example Use Case:** -This function can be used to display a player's current armor stats in a custom UI or addon, helping players understand their defensive capabilities. - -**Addons Using This Function:** -- **Details! Damage Meter**: This popular addon uses `UnitArmor` to calculate and display detailed statistics about a player's defensive stats, helping players optimize their gear and buffs. \ No newline at end of file diff --git a/wiki-information/functions/UnitAttackBothHands.md b/wiki-information/functions/UnitAttackBothHands.md deleted file mode 100644 index 668036ba..00000000 --- a/wiki-information/functions/UnitAttackBothHands.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitAttackBothHands - -**Content:** -Returns information about the unit's melee attacks. -`mainBase, mainMod, offBase, offMod = UnitAttackBothHands(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - Tested with "player" and "target". - -**Returns:** -- `mainBase` - - *number* - The unit's base main hand weapon skill (not rating). -- `mainMod` - - *number* - Any modifier to the unit's main hand weapon skill (not rating). -- `offBase` - - *number* - The unit's base offhand weapon skill (not rating) (equal to unarmed weapon skill if unit doesn't dual wield). -- `offMod` - - *number* - Any modifier to the unit's offhand weapon skill (not rating). \ No newline at end of file diff --git a/wiki-information/functions/UnitAttackPower.md b/wiki-information/functions/UnitAttackPower.md deleted file mode 100644 index 833a53d7..00000000 --- a/wiki-information/functions/UnitAttackPower.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: UnitAttackPower - -**Content:** -Returns the unit's melee attack power and modifiers. -`base, posBuff, negBuff = UnitAttackPower(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit to get information from. (Does not work for "target" - Possibly only "player" and "pet") - -**Returns:** -- `base` - - *number* - The unit's base attack power -- `posBuff` - - *number* - The total effect of positive buffs to attack power. -- `negBuff` - - *number* - The total effect of negative buffs to the attack power (a negative number) - -**Usage:** -Displays the player's current attack power in the default chat window. -```lua -local base, posBuff, negBuff = UnitAttackPower("player") -local effective = base + posBuff + negBuff -print("Your current attack power: "..effective) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitAttackSpeed.md b/wiki-information/functions/UnitAttackSpeed.md deleted file mode 100644 index 2c5196f9..00000000 --- a/wiki-information/functions/UnitAttackSpeed.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: UnitAttackSpeed - -**Content:** -Returns the unit's melee attack speed for each hand. -`mainSpeed, offSpeed = UnitAttackSpeed(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit to get information from. (Verified for "player" and "target") - -**Returns:** -- `mainSpeed` - - *number* - The unit's base main hand attack speed (seconds) -- `offSpeed` - - *number* - The unit's offhand attack speed (seconds) - nil if the unit has no offhand weapon. \ No newline at end of file diff --git a/wiki-information/functions/UnitAura.md b/wiki-information/functions/UnitAura.md deleted file mode 100644 index 93435cde..00000000 --- a/wiki-information/functions/UnitAura.md +++ /dev/null @@ -1,184 +0,0 @@ -## Title: UnitAura - -**Content:** -Returns the buffs/debuffs for the unit. -```lua -name, icon, count, dispelType, duration, expirationTime, source, isStealable, nameplateShowPersonal, -spellId, canApplyAura, isBossDebuff, castByPlayer, nameplateShowAll, timeMod, ... - = UnitAura(unit, index) - = UnitBuff(unit, index) - = UnitDebuff(unit, index) -``` - -**Parameters:** -- `unit` - - *string* : UnitId -- `index` - - *number* - Index of an aura to query. -- `filter` - - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". - -**Miscellaneous:** -- `UnitBuff()` is an alias for `UnitAura(unit, index, "HELPFUL")`, returning only buffs. -- `UnitDebuff()` is an alias for `UnitAura(unit, index, "HARMFUL")`, returning only debuffs. - -**Filter Descriptions:** -- `"HELPFUL"`: Buffs -- `"HARMFUL"`: Debuffs -- `"PLAYER"`: Auras Debuffs applied by the player -- `"RAID"`: Buffs the player can apply and debuffs the player can dispel -- `"CANCELABLE"`: Buffs that can be cancelled with `/cancelaura` or `CancelUnitBuff()` -- `"NOT_CANCELABLE"`: Buffs that cannot be cancelled -- `"INCLUDE_NAME_PLATE_ONLY"`: Auras that should be shown on nameplates -- `"MAW"`: Torghast Anima Powers - -**Aura Util:** - -**ForEachAura:** -```lua -AuraUtil.ForEachAura(unit, filter, func) -``` -This is recommended for iterating over auras. For example, to print all buffs: -```lua -AuraUtil.ForEachAura("player", "HELPFUL", nil, function(name, icon, ...) - print(name, icon, ...) -end) -``` -The callback function should return true once it's fine to stop processing further auras. -```lua -local function foo(name, icon, _, _, _, _, _, _, _, spellId, ...) - if spellId == 21562 then -- Power Word: Fortitude - -- do stuff - return true - end -end -AuraUtil.ForEachAura("player", "HELPFUL", nil, foo) -``` - -**FindAuraByName:** -```lua -AuraUtil.FindAuraByName(name, unit) -``` -Finds the first aura that matches the name, but note that: -- Aura names are not unique, this will only find the first match. -- Aura names are localized, what works in one locale might not work in another. -```lua -/dump AuraUtil.FindAuraByName("Power Word: Fortitude", "player") -``` -Remember to specify the "HARMFUL" filter for debuffs. -```lua -/dump AuraUtil.FindAuraByName("Weakened Soul", "player", "HARMFUL") -``` - -**Returns:** -Returns nil when there is no aura for that index or when the aura doesn't pass the filter. -1. `name` - - *string* - The localized name of the aura, otherwise nil if there is no aura for the index. -2. `icon` - - *number* : FileID - The icon texture. -3. `count` - - *number* - The amount of stacks, otherwise 0. -4. `dispelType` - - *string?* - The locale-independent magic type of the aura: Curse, Disease, Magic, Poison, otherwise nil. -5. `duration` - - *number* - The full duration of the aura in seconds. -6. `expirationTime` - - *number* - Time the aura expires compared to `GetTime()`, e.g. to get the remaining duration: `expirationTime - GetTime()` -7. `source` - - *string* : UnitId - The unit that applied the aura. -8. `isStealable` - - *boolean* - If the aura may be stolen. -9. `nameplateShowPersonal` - - *boolean* - If the aura should be shown on the player/pet/vehicle nameplate. -10. `spellId` - - *number* - The spell ID for e.g. `GetSpellInfo()` -11. `canApplyAura` - - *boolean* - If the player can apply the aura. -12. `isBossDebuff` - - *boolean* - If the aura was cast by a boss. -13. `castByPlayer` - - *boolean* - If the aura was applied by a player. -14. `nameplateShowAll` - - *boolean* - If the aura should be shown on nameplates. -15. `timeMod` - - *number* - The scaling factor used for displaying time left. -16. `shouldConsolidate` - - *boolean* - Whether to consolidate auras, only exists in Classic Era/Wrath. -17. `...` - - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - -**Description:** -- `UnitBuff()` will ignore any "HARMFUL" filter, and vice versa `UnitDebuff()` will ignore any "HELPFUL" filter. -- Filters can be mutually exclusive, e.g. "HELPFUL|HARMFUL" will always return nothing. -- On retail, a unit can have an unlimited amount of buffs/debuffs. -- The debuff limit is at 16 for Classic Era and 40 for BCC. - -**Related Events:** -- `UNIT_AURA` - -**World Buffs:** -If the unit has the buff, then the world buffs can be selected from the return values. For example: -```lua -select(20, UnitBuff("player", index)) -``` - -**Buff Types and Descriptions:** -- `Fengus' Ferocity` - - *number* - Duration -- `Mol'dar's Moxie` - - *number* - Duration -- `Slip'kik's Savvy` - - *number* - Duration -- `Rallying Cry of the Dragonslayer` - - *number* - Duration -- `Warchief's Blessing` - - *number* - Duration -- `Spirit of Zandalar` - - *number* - Duration -- `Songflower Serenade` - - *number* - Duration -- `Sayge's Fortune` - - *number* - Duration of the chosen buff -- `Sayge's Fortune` - - *number* - spellID of the chosen buff -- `Boon of Blackfathom` - - *number* - Duration -- `Spark of Inspiration` - - *number* - Duration -- `Fervor of the Temple Explorer` - - *number* - Duration - -**Usage:** -Prints the third aura on the target. -```lua -/dump UnitAura("target", 3) -``` -Returns: -- `"Power Word: Fortitude"` -- name -- `135987` -- icon -- `0` -- count -- `"Magic"` -- dispelType -- `3600` -- duration -- `112994.871` -- expirationTime -- `"player"` -- source -- `false` -- isStealable -- `false` -- nameplateShowPersonal -- `21562` -- spellID -- `true` -- canApplyAura -- `false` -- isBossDebuff -- `true` -- castByPlayer -- `false` -- nameplateShowAll -- `1` -- timeMod -- `5` -- attribute1: Stamina increased by 5% -- `0` -- attribute2: Magic damage taken reduced by 0% (Thorghast Enchanted Shroud power) - -The following are equivalent. Prints the first debuff applied by the player on the target. -```lua -/dump UnitAura("target", 1, "PLAYER|HARMFUL") -/dump UnitDebuff("target", 1, "PLAYER") -``` - -`GetPlayerAuraBySpellID()` is useful for checking only a specific aura on the player character. -```lua -/dump GetPlayerAuraBySpellID(21562) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitBuff.md b/wiki-information/functions/UnitBuff.md deleted file mode 100644 index 50ddb602..00000000 --- a/wiki-information/functions/UnitBuff.md +++ /dev/null @@ -1,185 +0,0 @@ -## Title: UnitAura - -**Content:** -Returns the buffs/debuffs for the unit. -```lua -name, icon, count, dispelType, duration, expirationTime, source, isStealable, nameplateShowPersonal, -spellId, canApplyAura, isBossDebuff, castByPlayer, nameplateShowAll, timeMod, ... - = UnitAura(unit, index) - = UnitBuff(unit, index) - = UnitDebuff(unit, index) -``` - -**Parameters:** -- `unit` - - *string* : UnitId -- `index` - - *number* - Index of an aura to query. -- `filter` - - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". - -**Miscellaneous:** -- `UnitBuff()` is an alias for `UnitAura(unit, index, "HELPFUL")`, returning only buffs. -- `UnitDebuff()` is an alias for `UnitAura(unit, index, "HARMFUL")`, returning only debuffs. - -**Filter Descriptions:** -- `"HELPFUL"`: Buffs -- `"HARMFUL"`: Debuffs -- `"PLAYER"`: Auras/Debuffs applied by the player -- `"RAID"`: Buffs the player can apply and debuffs the player can dispel -- `"CANCELABLE"`: Buffs that can be cancelled with `/cancelaura` or `CancelUnitBuff()` -- `"NOT_CANCELABLE"`: Buffs that cannot be cancelled -- `"INCLUDE_NAME_PLATE_ONLY"`: Auras that should be shown on nameplates -- `"MAW"`: Torghast Anima Powers - -**Aura Util:** - -- **ForEachAura:** - ```lua - AuraUtil.ForEachAura(unit, filter, func) - ``` - This is recommended for iterating over auras. For example, to print all buffs: - ```lua - AuraUtil.ForEachAura("player", "HELPFUL", nil, function(name, icon, ...) - print(name, icon, ...) - end) - ``` - The callback function should return true once it's fine to stop processing further auras. - ```lua - local function foo(name, icon, _, _, _, _, _, _, _, spellId, ...) - if spellId == 21562 then -- Power Word: Fortitude - -- do stuff - return true - end - end - AuraUtil.ForEachAura("player", "HELPFUL", nil, foo) - ``` - -- **FindAuraByName:** - ```lua - AuraUtil.FindAuraByName(name, unit) - ``` - Finds the first aura that matches the name, but note that: - - Aura names are not unique, this will only find the first match. - - Aura names are localized, what works in one locale might not work in another. - ```lua - /dump AuraUtil.FindAuraByName("Power Word: Fortitude", "player") - ``` - Remember to specify the "HARMFUL" filter for debuffs. - ```lua - /dump AuraUtil.FindAuraByName("Weakened Soul", "player", "HARMFUL") - ``` - -**Returns:** -Returns nil when there is no aura for that index or when the aura doesn't pass the filter. -1. `name` - - *string* - The localized name of the aura, otherwise nil if there is no aura for the index. -2. `icon` - - *number* : FileID - The icon texture. -3. `count` - - *number* - The amount of stacks, otherwise 0. -4. `dispelType` - - *string?* - The locale-independent magic type of the aura: Curse, Disease, Magic, Poison, otherwise nil. -5. `duration` - - *number* - The full duration of the aura in seconds. -6. `expirationTime` - - *number* - Time the aura expires compared to `GetTime()`, e.g. to get the remaining duration: `expirationTime - GetTime()` -7. `source` - - *string* : UnitId - The unit that applied the aura. -8. `isStealable` - - *boolean* - If the aura may be stolen. -9. `nameplateShowPersonal` - - *boolean* - If the aura should be shown on the player/pet/vehicle nameplate. -10. `spellId` - - *number* - The spell ID for e.g. `GetSpellInfo()` -11. `canApplyAura` - - *boolean* - If the player can apply the aura. -12. `isBossDebuff` - - *boolean* - If the aura was cast by a boss. -13. `castByPlayer` - - *boolean* - If the aura was applied by a player. -14. `nameplateShowAll` - - *boolean* - If the aura should be shown on nameplates. -15. `timeMod` - - *number* - The scaling factor used for displaying time left. -16. `shouldConsolidate` - - *boolean* - Whether to consolidate auras, only exists in Classic Era/Wrath. -17. `...` - - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - -**Description:** -- `UnitBuff()` will ignore any "HARMFUL" filter, and vice versa `UnitDebuff()` will ignore any "HELPFUL" filter. -- Filters can be mutually exclusive, e.g. "HELPFUL|HARMFUL" will always return nothing. -- On retail, a unit can have an unlimited amount of buffs/debuffs. -- The debuff limit is at 16 for Classic Era and 40 for BCC. - -**Related Events:** -- `UNIT_AURA` - -**World Buffs:** -If the unit has the buff, then the world buffs can be selected from the return values. For example: -```lua -select(20, UnitBuff("player", index)) -``` -- `Buff` -- `Type` -- `Description` - - `Fengus' Ferocity` - - *number* - Duration - - `Mol'dar's Moxie` - - *number* - Duration - - `Slip'kik's Savvy` - - *number* - Duration - - `Rallying Cry of the Dragonslayer` - - *number* - Duration - - `Warchief's Blessing` - - *number* - Duration - - `Spirit of Zandalar` - - *number* - Duration - - `Songflower Serenade` - - *number* - Duration - - `Sayge's Fortune` - - *number* - Duration of the chosen buff - - `Sayge's Fortune` - - *number* - spellID of the chosen buff - - `Boon of Blackfathom` - - *number* - Duration - - `Spark of Inspiration` - - *number* - Duration - - `Fervor of the Temple Explorer` - - *number* - Duration - -**Usage:** -Prints the third aura on the target. -```lua -/dump UnitAura("target", 3) -``` -Returns: -```lua -"Power Word: Fortitude", -- name -135987, -- icon -0, -- count -"Magic", -- dispelType -3600, -- duration -112994.871, -- expirationTime -"player", -- source -false, -- isStealable -false, -- nameplateShowPersonal -21562, -- spellID -true, -- canApplyAura -false, -- isBossDebuff -true, -- castByPlayer -false, -- nameplateShowAll -1, -- timeMod -5, -- attribute1: Stamina increased by 5% -0 -- attribute2: Magic damage taken reduced by 0% (Thorghast Enchanted Shroud power) -``` -The following are equivalent. Prints the first debuff applied by the player on the target. -```lua -/dump UnitAura("target", 1, "PLAYER|HARMFUL") -/dump UnitDebuff("target", 1, "PLAYER") -``` -`GetPlayerAuraBySpellID()` is useful for checking only a specific aura on the player character. -```lua -/dump GetPlayerAuraBySpellID(21562) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitCanAssist.md b/wiki-information/functions/UnitCanAssist.md deleted file mode 100644 index 8c09273a..00000000 --- a/wiki-information/functions/UnitCanAssist.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: UnitCanAssist - -**Content:** -Indicates whether the first unit can assist the second unit. -`canAssist = UnitCanAssist(unitToAssist, unitToBeAssisted)` - -**Parameters:** -- `unitToAssist` - - *UnitId* - the unit that would assist (e.g., "player" or "target") -- `unitToBeAssisted` - - *UnitId* - the unit that would be assisted (e.g., "player" or "target") - -**Returns:** -- `canAssist` - - *boolean* - 1 if the unitToAssist can assist the unitToBeAssisted, nil otherwise. - -**Usage:** -```lua -if (UnitCanAssist("player", "target")) then - DEFAULT_CHAT_FRAME:AddMessage("You can assist the target.") -else - DEFAULT_CHAT_FRAME:AddMessage("You cannot assist the target.") -end -``` - -**Miscellaneous:** -Result: -A message indicating whether the player can assist the current target is displayed in the default chat frame. - -**Reference:** -- `UnitCanCooperate` \ No newline at end of file diff --git a/wiki-information/functions/UnitCanAttack.md b/wiki-information/functions/UnitCanAttack.md deleted file mode 100644 index 44b2c403..00000000 --- a/wiki-information/functions/UnitCanAttack.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: UnitCanAttack - -**Content:** -Returns true if the first unit can attack the second. -`canAttack = UnitCanAttack(unit1, unit2)` - -**Parameters:** -- `unit1` - - *string* : UnitId -- `unit2` - - *string* : UnitId - The unit to compare with the first unit. - -**Returns:** -- `canAttack` - - *boolean* - -**Example Usage:** -```lua -local playerCanAttackTarget = UnitCanAttack("player", "target") -if playerCanAttackTarget then - print("You can attack the target!") -else - print("You cannot attack the target.") -end -``` - -**Description:** -This function is commonly used in combat-related addons to determine if a player can engage a specific target. For example, PvP addons might use this to check if a player can attack an enemy player, while PvE addons might use it to determine if a player can attack a specific NPC. - -**Addons Using This Function:** -- **Gladius**: A popular PvP addon that uses this function to determine if arena opponents can be attacked. -- **TidyPlates**: A nameplate addon that uses this function to change the appearance of nameplates based on whether the unit can be attacked. \ No newline at end of file diff --git a/wiki-information/functions/UnitCanCooperate.md b/wiki-information/functions/UnitCanCooperate.md deleted file mode 100644 index bd6f53c2..00000000 --- a/wiki-information/functions/UnitCanCooperate.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: UnitCanCooperate - -**Content:** -Returns true if the first unit can cooperate with the second. -`cancooperate = UnitCanCooperate(unit1, unit2)` - -**Parameters:** -- `unit1` - - *string* : UnitId -- `unit2` - - *string* : UnitId - The unit to compare with the first unit. - -**Returns:** -- `cancooperate` - - *boolean* - True if the first unit can cooperate with the second. \ No newline at end of file diff --git a/wiki-information/functions/UnitCastingInfo.md b/wiki-information/functions/UnitCastingInfo.md deleted file mode 100644 index 8ca8c10e..00000000 --- a/wiki-information/functions/UnitCastingInfo.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title: UnitCastingInfo - -**Content:** -Returns information about the spell currently being cast by the specified unit. -`name, text, texture, startTimeMS, endTimeMS, isTradeSkill, castID, notInterruptible, spellId = UnitCastingInfo(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `name` - - *string* - The name of the spell, or nil if no spell is being cast. -- `text` - - *string* - The name to be displayed. -- `texture` - - *string* - The texture path associated with the spell icon. -- `startTimeMS` - - *number* - Specifies when casting began in milliseconds (corresponds to GetTime()*1000). -- `endTimeMS` - - *number* - Specifies when casting will end in milliseconds (corresponds to GetTime()*1000). -- `isTradeSkill` - - *boolean* - Specifies if the cast is a tradeskill. -- `castID` - - *string* : GUID - The unique identifier for this spell cast, for example Cast-3-3890-1159-21205-8936-00014B7E7F. -- `notInterruptible` - - *boolean* - if true, indicates that this cast cannot be interrupted with abilities like or . In default UI those spells have shield frame around their icons on enemy cast bars. Always returns nil in Classic. -- `spellId` - - *number* - The spell's unique identifier. (Added in 7.2.5) - -**Description:** -For channeled spells, `displayName` is "Channeling". So far `displayName` is observed to be the same as `name` in any other contexts. -This function may not return anything when the target is channeling spell post its warm-up period, you should use `UnitChannelInfo` in that case. It takes the same arguments and returns similar values specific to channeling spells. -In Classic, the alternative `CastingInfo()` is similar to `UnitCastingInfo("player")`. - -**Related Events:** -- `UNIT_SPELLCAST_START` -- `UNIT_SPELLCAST_STOP` - -**Related API:** -- `CastingInfo (Classic)` - -**Usage:** -The following snippet prints the amount of time remaining before the player's current spell finishes casting. -```lua -local spell, _, _, _, endTime = UnitCastingInfo("player") -if spell then - local finish = endTimeMS/1000 - GetTime() - print(spell .. " will be finished casting in " .. finish .. " seconds.") -end -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitChannelInfo.md b/wiki-information/functions/UnitChannelInfo.md deleted file mode 100644 index 1dca5e19..00000000 --- a/wiki-information/functions/UnitChannelInfo.md +++ /dev/null @@ -1,52 +0,0 @@ -## Title: UnitChannelInfo - -**Content:** -Returns information about the spell currently being channeled by the specified unit. -`name, displayName, textureID, startTimeMs, endTimeMs, isTradeskill, notInterruptible, spellID, isEmpowered, numEmpowerStages = UnitChannelInfo(unitToken)` - -**Parameters:** -- `unitToken` - - *string* : UnitId - -**Returns:** -- `name` - - *string* - The name of the spell, or nil if no spell is being channeled. -- `displayName` - - *string* - The name to be displayed. -- `textureID` - - *string* - The texture path associated with the spell icon. -- `startTimeMs` - - *number* - Specifies when channeling began, in milliseconds (corresponds to GetTime()*1000). -- `endTimeMs` - - *number* - Specifies when channeling will end, in milliseconds (corresponds to GetTime()*1000). -- `isTradeskill` - - *boolean* - Specifies if the cast is a tradeskill. -- `notInterruptible` - - *boolean* - if true, indicates that this channeling cannot be interrupted with abilities like or . In default UI those spells have shield frame around their icons on enemy channeling bars. Always returns nil in Classic. -- `spellID` - - *number* - The spell's unique identifier. -- `isEmpowered` - - *boolean* -- `numEmpowerStages` - - *number* - -**Description:** -Related Events: -- `UNIT_SPELLCAST_CHANNEL_START` -- `UNIT_SPELLCAST_CHANNEL_STOP` - -Related API: -- `ChannelInfo` (Classic) - -**Usage:** -The following snippet prints the amount of time remaining before the player's current spell finishes channeling. -```lua -local spell, _, _, _, endTimeMS = UnitChannelInfo("player") -if spell then - local finish = endTimeMS/1000 - GetTime() - print(spell .. ' will be finished channeling in ' .. finish .. ' seconds.') -end -``` - -**Reference:** -- slouken 2006-10-06. Re: Expansion Changes - Concise List. Archived from the original \ No newline at end of file diff --git a/wiki-information/functions/UnitCharacterPoints.md b/wiki-information/functions/UnitCharacterPoints.md deleted file mode 100644 index 3168b2e3..00000000 --- a/wiki-information/functions/UnitCharacterPoints.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitCharacterPoints - -**Content:** -Returns the number of unspent talent points of the player. -`talentPoints = UnitCharacterPoints(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - Only works on the player unit. - -**Returns:** -- `talentPoints` - - *number* - The quantity of unspent talent points the unit has available. \ No newline at end of file diff --git a/wiki-information/functions/UnitClass.md b/wiki-information/functions/UnitClass.md deleted file mode 100644 index 9769d927..00000000 --- a/wiki-information/functions/UnitClass.md +++ /dev/null @@ -1,43 +0,0 @@ -## Title: UnitClass - -**Content:** -Returns the class of the unit. -```lua -className, classFilename, classId = UnitClass(unit) -classFilename, classId = UnitClassBase(unit) -``` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Values:** -| ID | className (enUS) | classFile | Description | -|-----|------------------|--------------|----------------------| -| 1 | Warrior | WARRIOR | | -| 2 | Paladin | PALADIN | | -| 3 | Hunter | HUNTER | | -| 4 | Rogue | ROGUE | | -| 5 | Priest | PRIEST | | -| 6 | Death Knight | DEATHKNIGHT | Added in 3.0.2 | -| 7 | Shaman | SHAMAN | | -| 8 | Mage | MAGE | | -| 9 | Warlock | WARLOCK | | -| 10 | Monk | MONK | Added in 5.0.4 | -| 11 | Druid | DRUID | | -| 12 | Demon Hunter | DEMONHUNTER | Added in 7.0.3 | -| 13 | Evoker | EVOKER | Added in 10.0.0 | - -**Returns:** -- `className` - - *string* - Localized name, e.g. "Warrior" or "Guerrier". -- `classFilename` - - *string* - Locale-independent name, e.g. "WARRIOR". -- `classId` - - *number* : ClassId - -**Usage:** -```lua -/dump UnitClass("target") -- "Mage", "MAGE", 8 -/dump UnitClassBase("target") -- "MAGE", 8 -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitClassBase.md b/wiki-information/functions/UnitClassBase.md deleted file mode 100644 index e7989a70..00000000 --- a/wiki-information/functions/UnitClassBase.md +++ /dev/null @@ -1,43 +0,0 @@ -## Title: UnitClass - -**Content:** -Returns the class of the unit. -```lua -className, classFilename, classId = UnitClass(unit) -classFilename, classId = UnitClassBase(unit) -``` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Values:** -| ID | className (enUS) | classFile | Description | -|-----|------------------|--------------|---------------| -| 1 | Warrior | WARRIOR | | -| 2 | Paladin | PALADIN | | -| 3 | Hunter | HUNTER | | -| 4 | Rogue | ROGUE | | -| 5 | Priest | PRIEST | | -| 6 | Death Knight | DEATHKNIGHT | Added in 3.0.2| -| 7 | Shaman | SHAMAN | | -| 8 | Mage | MAGE | | -| 9 | Warlock | WARLOCK | | -| 10 | Monk | MONK | Added in 5.0.4| -| 11 | Druid | DRUID | | -| 12 | Demon Hunter | DEMONHUNTER | Added in 7.0.3| -| 13 | Evoker | EVOKER | Added in 10.0.0| - -**Returns:** -- `className` - - *string* - Localized name, e.g. "Warrior" or "Guerrier". -- `classFilename` - - *string* - Locale-independent name, e.g. "WARRIOR". -- `classId` - - *number* : ClassId - -**Usage:** -```lua -/dump UnitClass("target") -- "Mage", "MAGE", 8 -/dump UnitClassBase("target") -- "MAGE", 8 -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitClassification.md b/wiki-information/functions/UnitClassification.md deleted file mode 100644 index cd48afe1..00000000 --- a/wiki-information/functions/UnitClassification.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: UnitClassification - -**Content:** -Returns the classification of the specified unit (e.g., "elite" or "worldboss"). -`classification = UnitClassification(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `classification` - - *string* - the unit's classification: "worldboss", "rareelite", "elite", "rare", "normal", "trivial", or "minus" - - Note that "trivial" is for low-level targets that would not reward experience or honor (UnitIsTrivial() would return '1'), whereas "minus" is for mobs that show a miniature version of the v-key health plates. - -**Usage:** -```lua -if ( UnitClassification("target") == "worldboss" ) then - -- If unit is a world boss show skull regardless of level - TargetLevelText:Hide(); - TargetHighLevelTexture:Show(); -end -``` - -**Result:** -If the target is a world boss, then the level isn't shown in the target frame, instead a special high level texture is shown. \ No newline at end of file diff --git a/wiki-information/functions/UnitControllingVehicle.md b/wiki-information/functions/UnitControllingVehicle.md deleted file mode 100644 index b334a4c5..00000000 --- a/wiki-information/functions/UnitControllingVehicle.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitControllingVehicle - -**Content:** -Needs summary. -`controllingVehicle = UnitControllingVehicle(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `controllingVehicle` - - *boolean* - -**Example Usage:** -This function can be used to determine if a specific unit is currently controlling a vehicle. This is particularly useful in scenarios where vehicle mechanics are involved, such as certain battlegrounds or quests. - -**Addons:** -Large addons like Deadly Boss Mods (DBM) might use this function to provide alerts or warnings when a player is controlling a vehicle during a boss encounter or specific event. \ No newline at end of file diff --git a/wiki-information/functions/UnitCreatureFamily.md b/wiki-information/functions/UnitCreatureFamily.md deleted file mode 100644 index d310e286..00000000 --- a/wiki-information/functions/UnitCreatureFamily.md +++ /dev/null @@ -1,111 +0,0 @@ -## Title: UnitCreatureFamily - -**Content:** -Returns the creature type of the unit (e.g. Crab). -`creatureFamily = UnitCreatureFamily(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - unit you wish to query. - -**Returns:** -- `creatureFamily` - - *string* - localized name of the creature family (e.g., "Crab" or "Wolf"). Known return values include: - - **enUS** - - **deDE** - - **Creature Type** - - Aqiri - - Aqir - - Beast - - Basilisk - - Bat - - Bear - - Beetle - - Bird of Prey - - Blood Beast - - Boar - - Camel - - Carapid - - Carrion Bird - - Cat - - Chimaera - - Clefthoof - - Core Hound - - Courser - - Crab - - Crocolisk - - Devilsaur - - Direhorn - - Dragonhawk - - Feathermane - - Fox - - Gorilla - - Gruffhorn - - Hound - - Hydra - - Hyena - - Lesser Dragonkin - - Lizard - - Mammoth - - Mechanical - - Monkey - - Moth - - Oxen - - Pterrordax - - Raptor - - Ravager - - Ray - - Riverbeast - - Rodent - - Scalehide - - Scorpid - - Serpent - - Shale Beast - - Spider - - Spirit Beast - - Sporebat - - Stag - - Stone Hound - - Tallstrider - - Toad - - Turtle - - Warp Stalker - - Wasp - - Water Strider - - Waterfowl - - Wind Serpent - - Wolf - - Worm - - Demon - - Fel Imp - - Felguard - - Felhunter - - Imp - - Incubus - - Observer - - Shivarra - - Succubus - - Void Lord - - Voidwalker - - Wrathguard - - Elemental - - Fire Elemental - - Storm Elemental - - Water Elemental - - Undead - - Abomination - - Ghoul - - Mechanical - - Remote Control - -**Description:** -Does not work on all creatures, since the family's primary function is to determine what abilities the unit will have if a player is able to control it. However, it does work on almost all Beasts, even if they are not tameable by Hunters. -Returns nil if the creature doesn't belong to a family that includes a tameable creature. - -**Usage:** -Displays a message if the target is a type of bear. -```lua -if ( UnitCreatureFamily("target") == "Bear" ) then - message("It's a godless killing machine! Run for your lives!"); -end -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitCreatureType.md b/wiki-information/functions/UnitCreatureType.md deleted file mode 100644 index aac19ac1..00000000 --- a/wiki-information/functions/UnitCreatureType.md +++ /dev/null @@ -1,49 +0,0 @@ -## Title: UnitCreatureType - -**Content:** -Returns the creature classification type of the unit (e.g. Beast). -`creatureType = UnitCreatureType(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit to query creature type of. - -**Returns:** -- `creatureType` - - *string* - the localized creature type of the unit, or nil if the unit does not exist, or if the unit's creature type isn't available. - -**Description:** -The default Blizzard UI displays an empty string instead of "Not specified" for units with that creature type. Warcraft Wiki refers to these units as "Uncategorized". - -Known return values include: -- enUS -- deDE -- esES -- esMX -- frFR -- itIT -- ptBR -- ruRU -- koKR -- zhCN -- zhTW - -| enUS | deDE | esES | esMX | frFR | itIT | ptBR | ruRU | koKR | zhCN | zhTW | -|--------------|-----------------|--------------|--------------|----------------|--------------|--------------|---------------------|------------|------------|------------| -| Aberration | Wildtier | Bestia | Bestia | Bête | Bestia | Fera | Животное | 야수 | 野兽 | 野兽 | -| Critter | Kleintier | Alma | Alma | Bestiole | Animale | Bicho | Существо | 동물 | 小动物 | 小动物 | -| Demon | Dämon | Demonio | Demonio | Démon | Demone | Demônio | Демон | 악마 | 恶魔 | 恶魔 | -| Dragonkin | Drachkin | Dragon | Dragón | Draconien | Dragoide | Dracônico | Дракон | 용족 | 龙类 | 龙类 | -| Elemental | Elementar | Elemental | Elemental | Élémentaire | Elementale | Elemental | Элементаль | 정령 | 元素生物 | 元素生物 | -| Gas Cloud | Gaswolke | Nube de Gas | Nube de Gas | Nuage de gaz | Nube di Gas | Gasoso | Газовое облако | 가스 | 气体云 | 气体云 | -| Giant | Riese | Gigante | Gigante | Géant | Gigante | Gigante | Великан | 거인 | 巨人 | 巨人 | -| Humanoid | Humanoid | Humanoide | Humanoide | Humanoïde | Umanoide | Humanoide | Гуманоид | 인간형 | 人型生物 | 人型生物 | -| Mechanical | Mechanisch | Mecánico | Mecánico | Machine | Meccanico | Mecânico | Механизм | 기계 | 机械 | 机械 | -| Non-combat Pet | Haustier | Mascota no combatiente | Mascota mansa | Familier pacifique | Animale Non combattente | Mascote não-combatente | Спутник | 애완동물 | 非战斗宠物 | 非战斗宠物 | -| Not specified | Nicht spezifiziert | No especificado | Sin especificar | Non spécifié | Non Specificato | Não especificado | Не указано | 기타 | 未指定 | 不明 | -| Totem | Totem | Tótem | Totém | Totem | Totem | Totem | Тотем | 토템 | 图腾 | 图腾 | -| Undead | Untoter | No-muerto | No-muerto | Mort-vivant | Non Morto | Renegado | Нежить | 언데드 | 亡灵 | 不死族 | -| Wild Pet | Ungezähmtes Tier | Mascotte sauvage | | | | | | | | | - -**Reference:** -[LibBabble-CreatureType-3.0](https://www.wowace.com/projects/libbabble-creaturetype-3-0) \ No newline at end of file diff --git a/wiki-information/functions/UnitDamage.md b/wiki-information/functions/UnitDamage.md deleted file mode 100644 index 6b9d1688..00000000 --- a/wiki-information/functions/UnitDamage.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: UnitDamage - -**Content:** -Returns the damage stats for the unit. -`minDamage, maxDamage, offhandMinDamage, offhandMaxDamage, posBuff, negBuff, percent = UnitDamage(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - Likely only works for "player" and "pet". Possibly for "target". - -**Returns:** -- `minDamage` - - *number* - The unit's minimum melee damage. -- `maxDamage` - - *number* - The unit's maximum melee damage. -- `offhandMinDamage` - - *number* - The unit's minimum offhand melee damage. -- `offhandMaxDamage` - - *number* - The unit's maximum offhand melee damage. -- `posBuff` - - *number* - positive physical Bonus (should be >= 0) -- `negBuff` - - *number* - negative physical Bonus (should be <= 0) -- `percent` - - *number* - percentage modifier (usually 1; 0.9 for warriors in defensive stance) - -**Description:** -Doesn't seem to return usable values for mobs, NPCs. The method returns 7 values, only some of which appear to be useful. \ No newline at end of file diff --git a/wiki-information/functions/UnitDebuff.md b/wiki-information/functions/UnitDebuff.md deleted file mode 100644 index df1d1071..00000000 --- a/wiki-information/functions/UnitDebuff.md +++ /dev/null @@ -1,184 +0,0 @@ -## Title: UnitAura - -**Content:** -Returns the buffs/debuffs for the unit. -```lua -name, icon, count, dispelType, duration, expirationTime, source, isStealable, nameplateShowPersonal, -spellId, canApplyAura, isBossDebuff, castByPlayer, nameplateShowAll, timeMod, ... - = UnitAura(unit, index) - = UnitBuff(unit, index) - = UnitDebuff(unit, index) -``` - -**Parameters:** -- `unit` - - *string* : UnitId -- `index` - - *number* - Index of an aura to query. -- `filter` - - *string?* - A list of filters, separated by pipe chars or spaces. Otherwise defaults to "HELPFUL". - -**Miscellaneous:** -- `UnitBuff()` is an alias for `UnitAura(unit, index, "HELPFUL")`, returning only buffs. -- `UnitDebuff()` is an alias for `UnitAura(unit, index, "HARMFUL")`, returning only debuffs. - -**Filter Descriptions:** -- `"HELPFUL"`: Buffs -- `"HARMFUL"`: Debuffs -- `"PLAYER"`: Auras/Debuffs applied by the player -- `"RAID"`: Buffs the player can apply and debuffs the player can dispel -- `"CANCELABLE"`: Buffs that can be cancelled with `/cancelaura` or `CancelUnitBuff()` -- `"NOT_CANCELABLE"`: Buffs that cannot be cancelled -- `"INCLUDE_NAME_PLATE_ONLY"`: Auras that should be shown on nameplates -- `"MAW"`: Torghast Anima Powers - -**Aura Util:** - -**ForEachAura:** -```lua -AuraUtil.ForEachAura(unit, filter, func) -``` -This is recommended for iterating over auras. For example, to print all buffs: -```lua -AuraUtil.ForEachAura("player", "HELPFUL", nil, function(name, icon, ...) - print(name, icon, ...) -end) -``` -The callback function should return true once it's fine to stop processing further auras. -```lua -local function foo(name, icon, _, _, _, _, _, _, _, spellId, ...) - if spellId == 21562 then -- Power Word: Fortitude - -- do stuff - return true - end -end -AuraUtil.ForEachAura("player", "HELPFUL", nil, foo) -``` - -**FindAuraByName:** -```lua -AuraUtil.FindAuraByName(name, unit) -``` -Finds the first aura that matches the name, but note that: -- Aura names are not unique, this will only find the first match. -- Aura names are localized, what works in one locale might not work in another. -```lua -/dump AuraUtil.FindAuraByName("Power Word: Fortitude", "player") -``` -Remember to specify the "HARMFUL" filter for debuffs. -```lua -/dump AuraUtil.FindAuraByName("Weakened Soul", "player", "HARMFUL") -``` - -**Returns:** -Returns nil when there is no aura for that index or when the aura doesn't pass the filter. -1. `name` - - *string* - The localized name of the aura, otherwise nil if there is no aura for the index. -2. `icon` - - *number* : FileID - The icon texture. -3. `count` - - *number* - The amount of stacks, otherwise 0. -4. `dispelType` - - *string?* - The locale-independent magic type of the aura: Curse, Disease, Magic, Poison, otherwise nil. -5. `duration` - - *number* - The full duration of the aura in seconds. -6. `expirationTime` - - *number* - Time the aura expires compared to `GetTime()`, e.g. to get the remaining duration: `expirationTime - GetTime()` -7. `source` - - *string* : UnitId - The unit that applied the aura. -8. `isStealable` - - *boolean* - If the aura may be stolen. -9. `nameplateShowPersonal` - - *boolean* - If the aura should be shown on the player/pet/vehicle nameplate. -10. `spellId` - - *number* - The spell ID for e.g. `GetSpellInfo()` -11. `canApplyAura` - - *boolean* - If the player can apply the aura. -12. `isBossDebuff` - - *boolean* - If the aura was cast by a boss. -13. `castByPlayer` - - *boolean* - If the aura was applied by a player. -14. `nameplateShowAll` - - *boolean* - If the aura should be shown on nameplates. -15. `timeMod` - - *number* - The scaling factor used for displaying time left. -16. `shouldConsolidate` - - *boolean* - Whether to consolidate auras, only exists in Classic Era/Wrath. -17. `...` - - Variable returns - Some auras return additional values that typically correspond to something shown in the tooltip, such as the remaining strength of an absorption effect. - -**Description:** -- `UnitBuff()` will ignore any HARMFUL filter, and vice versa `UnitDebuff()` will ignore any HELPFUL filter. -- Filters can be mutually exclusive, e.g. "HELPFUL|HARMFUL" will always return nothing. -- On retail, a unit can have an unlimited amount of buffs/debuffs. -- The debuff limit is at 16 for Classic Era and 40 for BCC. - -**Related Events:** -- `UNIT_AURA` - -**World Buffs:** -If the unit has the buff, then the world buffs can be selected from the return values. For example: -```lua -select(20, UnitBuff("player", index)) -``` - -**Buff Types and Descriptions:** -- `Fengus' Ferocity` - - *number* - Duration -- `Mol'dar's Moxie` - - *number* - Duration -- `Slip'kik's Savvy` - - *number* - Duration -- `Rallying Cry of the Dragonslayer` - - *number* - Duration -- `Warchief's Blessing` - - *number* - Duration -- `Spirit of Zandalar` - - *number* - Duration -- `Songflower Serenade` - - *number* - Duration -- `Sayge's Fortune` - - *number* - Duration of the chosen buff -- `Sayge's Fortune` - - *number* - spellID of the chosen buff -- `Boon of Blackfathom` - - *number* - Duration -- `Spark of Inspiration` - - *number* - Duration -- `Fervor of the Temple Explorer` - - *number* - Duration - -**Usage:** -Prints the third aura on the target. -```lua -/dump UnitAura("target", 3) -``` -Returns: -- `"Power Word: Fortitude"` -- name -- `135987` -- icon -- `0` -- count -- `"Magic"` -- dispelType -- `3600` -- duration -- `112994.871` -- expirationTime -- `"player"` -- source -- `false` -- isStealable -- `false` -- nameplateShowPersonal -- `21562` -- spellID -- `true` -- canApplyAura -- `false` -- isBossDebuff -- `true` -- castByPlayer -- `false` -- nameplateShowAll -- `1` -- timeMod -- `5` -- attribute1: Stamina increased by 5% -- `0` -- attribute2: Magic damage taken reduced by 0% (Thorghast Enchanted Shroud power) - -The following are equivalent. Prints the first debuff applied by the player on the target. -```lua -/dump UnitAura("target", 1, "PLAYER|HARMFUL") -/dump UnitDebuff("target", 1, "PLAYER") -``` - -`GetPlayerAuraBySpellID()` is useful for checking only a specific aura on the player character. -```lua -/dump GetPlayerAuraBySpellID(21562) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitDetailedThreatSituation.md b/wiki-information/functions/UnitDetailedThreatSituation.md deleted file mode 100644 index ee21931b..00000000 --- a/wiki-information/functions/UnitDetailedThreatSituation.md +++ /dev/null @@ -1,75 +0,0 @@ -## Title: UnitDetailedThreatSituation - -**Content:** -Returns detailed info for the threat status of one unit against another. -`isTanking, status, scaledPercentage, rawPercentage, rawThreat = UnitDetailedThreatSituation(unit, mobGUID)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The player or pet whose threat to request. -- `mobGUID` - - *string* : UnitToken - The NPC whose threat table to query. - -**Returns:** -- `isTanking` - - *boolean* - Returns true if the unit is the primary threat target of the mobUnit, returns false otherwise. -- `status` - - *number* - Threat status of the unit on the mobUnit. -- `scaledPercentage` - - *number* - The unit's threat percentage against mobUnit. At 100% the unit will become the primary target. This value is also scaled the closer the unit is to the mobUnit. -- `rawPercentage` - - *number* - The unit's threat percentage against mobUnit relative to the threat of mobUnit's primary target. Can be greater than 100, up to 255. Stops updating when you become the primary target. -- `threatValue` - - *number* - The unit's total threat value on the mobUnit. - -**Status Values:** -- `status` - - `Value` - - `High Threat` - - `Primary Target` - - `Description` - - `nil` - - Unit is not on (any) mobUnit's threat table. - - `0` - - ❌ - - ❌ - - Unit has less than 100% threat for mobUnit. The default UI shows no indicator. - - `1` - - ✔️ - - ❌ - - Unit has higher than 100% threat for mobUnit, but isn't the primary target. The default UI shows a yellow indicator. - - `2` - - ❌ - - ✔️ - - Unit is the primary target for mobUnit, but another unit has higher than 100% threat. The default UI shows an orange indicator. - - `3` - - ✔️ - - ✔️ - - Unit is the primary target for mobUnit and no other unit has higher than 100% threat. The default UI shows a red indicator. - -**Description:** -From wowprogramming.com's API reference: -"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 self-buff, a priest's 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 unit and mobUnit is only returned if the unit has threat against the mobUnit in question. In addition, no threat data is provided if a unit's pet is attacking an NPC but the unit himself has taken no action, even though the pet has threat against the NPC.)" -When mobs are socially pulled (i.e. they aggro indirectly, as a result of another nearby mob being pulled), 'status' often sets to 0 instead of 3, despite the player having aggro. - -**Usage:** -- `/dump UnitDetailedThreatSituation("player", "target")` - - You have 100% threat on the targeted NPC. - - `true, 3, 100, 100, 15` - - You have partial threat on the targeted NPC: 66% threat on the mobUnit, 73% threat relative to the primary target, threat value amount of 25. - - `false, 0, 66.363632202148, 73, 25` - -**Reference:** -- `UnitThreatSituation()` -- `GetThreatStatusColor()` -- `UNIT_THREAT_SITUATION_UPDATE` -- `UNIT_THREAT_LIST_UPDATE` -- `threatShowNumeric` - -**External Resources:** -- [Wowhead Classic WoW Threat Guide by Ragorism](https://classic.wowhead.com/guides/classic-wow-threat-guide) \ No newline at end of file diff --git a/wiki-information/functions/UnitDistanceSquared.md b/wiki-information/functions/UnitDistanceSquared.md deleted file mode 100644 index 41714910..00000000 --- a/wiki-information/functions/UnitDistanceSquared.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: UnitDistanceSquared - -**Content:** -Returns the squared distance to a unit in your group. -`distanceSquared, checkedDistance = UnitDistanceSquared(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit id of a player in your group. - -**Returns:** -- `distanceSquared` - - *number* - the squared distance to that unit -- `checkedDistance` - - *boolean* - true if the distance result is valid, false otherwise (e.g., unit not found or not in your group) - -**Example Usage:** -This function can be used in scenarios where you need to determine the distance between players in a group, such as in raid addons to check if players are within a certain range for buffs or abilities. - -**Addons Using This Function:** -- **Deadly Boss Mods (DBM):** Uses this function to determine if players are within range of each other for certain boss mechanics. -- **WeakAuras:** Can use this function to create custom auras that trigger based on the distance between group members. \ No newline at end of file diff --git a/wiki-information/functions/UnitEffectiveLevel.md b/wiki-information/functions/UnitEffectiveLevel.md deleted file mode 100644 index af7e64b6..00000000 --- a/wiki-information/functions/UnitEffectiveLevel.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitEffectiveLevel - -**Content:** -Returns the unit's effective (scaled) level. -`level = UnitEffectiveLevel(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `level` - - *number* - -**Description:** -When inebriated, the apparent level of hostile units is lowered by up to 5. - -**Reference:** -[UnitLevel](#) \ No newline at end of file diff --git a/wiki-information/functions/UnitExists.md b/wiki-information/functions/UnitExists.md deleted file mode 100644 index bb147a68..00000000 --- a/wiki-information/functions/UnitExists.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: UnitExists - -**Content:** -Returns true if the unit exists. -`exists = UnitExists(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `exists` - - *boolean* - true if the unit exists and is in the current zone, or false if not - -**Usage:** -The snippet below prints a message describing what the player is targeting. -```lua -if UnitExists("target") then - print("You're targeting a " .. UnitName("target")) -else - print("You have no target") -end -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitFactionGroup.md b/wiki-information/functions/UnitFactionGroup.md deleted file mode 100644 index 4097bd92..00000000 --- a/wiki-information/functions/UnitFactionGroup.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: UnitFactionGroup - -**Content:** -Returns the faction (Horde/Alliance) a unit belongs to. -`englishFaction, localizedFaction = UnitFactionGroup(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `englishFaction` - - *string* - Unit's faction name in English, i.e. "Alliance", "Horde", "Neutral" or nil. -- `localizedFaction` - - *string* - Unit's faction name in the client's locale or nil. - -**Description:** -The function may not return correct results until after the `PLAYER_ENTERING_WORLD` event for units other than "player". -Note that for NPCs, the function will only return Alliance/Horde for factions closely allied with either side. Goblins, for instance, return nil,nil. -Pandaren player characters on the Wandering Isle return "Neutral", "". - -**Example Usage:** -```lua -local englishFaction, localizedFaction = UnitFactionGroup("player") -print("Faction in English: ", englishFaction) -print("Faction in Localized: ", localizedFaction) -``` - -**Addons Using This Function:** -- **Recount**: Uses `UnitFactionGroup` to differentiate between factions when displaying damage and healing statistics. -- **Details! Damage Meter**: Utilizes this function to provide faction-specific data breakdowns in battlegrounds and world PvP scenarios. \ No newline at end of file diff --git a/wiki-information/functions/UnitFullName.md b/wiki-information/functions/UnitFullName.md deleted file mode 100644 index aaffbbc1..00000000 --- a/wiki-information/functions/UnitFullName.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: UnitName - -**Content:** -Returns the name and realm of the unit. -```lua -name, realm = UnitName(unit) -name, realm = UnitFullName(unit) -name, realm = UnitNameUnmodified(unit) -``` - -**Parameters:** -- `unit` - - *string* : UnitId - For example "player" or "target" - -**Returns:** -- `name` - - *string?* - The name of the unit. Returns nil if the unit doesn't exist, e.g. the player has no target selected. -- `realm` - - *string?* - The normalized realm the unit is from, e.g. "DarkmoonFaire". Returns nil if the unit is from the same realm. - -**Description:** -Will return globalstring `UNKNOWNOBJECT` "Unknown Entity" if called before the unit in question has been fully loaded into the world. -The unit name will change if the unit is under the effects of or a similar effect, but `UnitNameUnmodified()` is unaffected by this. - -**Usage:** -Prints your character's name. -```lua -/dump UnitName("player") -- "Leeroy", nil -``` -Prints the name and realm of your target (if different). -```lua -/dump UnitName("target") -- "Thegnome", "DarkmoonFaire" -``` -`UnitFullName()` is equivalent with `UnitName()` except it will always return realm if used with the "player" UnitId. -```lua -/dump UnitFullName("player") -- "Leeroy", "MoonGuard" -/dump UnitFullName("target") -- "Leeroy", nil -``` - -**Miscellaneous:** -`GetUnitName(unit, showServerName)` can return the combined unit and realm name. -- If `showServerName` is true and the queried unit is from a different server, then the return value will include the unit's name appended by a dash and the normalized realm name. -- If `showServerName` is false, then `FOREIGN_SERVER_LABEL` " (*)" will be appended to units from coalesced realms. Units from the player's own realm or Connected Realms get no additional suffix. - -Examples: -- Unit is from the same realm. - ```lua - /dump GetUnitName("target", true) -- "Nephertiri" - /dump GetUnitName("target", false) -- "Nephertiri" - ``` -- Unit is from a different realm but the same Connected Realm (`LE_REALM_RELATION_VIRTUAL`). - ```lua - /dump GetUnitName("target", true) -- "Standron-EarthenRing" - /dump GetUnitName("target", false) -- "Standron" - ``` -- Unit is from a different, non-connected realm (`LE_REALM_RELATION_COALESCED`). - ```lua - /dump GetUnitName("target", true) -- "Celturio-Quel'Thalas" - /dump GetUnitName("target", false) -- "Celturio (*)" - ``` - -**Reference:** -- `Ambiguate()` \ No newline at end of file diff --git a/wiki-information/functions/UnitGUID.md b/wiki-information/functions/UnitGUID.md deleted file mode 100644 index b27da71f..00000000 --- a/wiki-information/functions/UnitGUID.md +++ /dev/null @@ -1,42 +0,0 @@ -## Title: UnitGUID - -**Content:** -Returns the GUID of the unit. -`guid = UnitGUID(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - For example "player" or "target" - -**Returns:** -- `guid` - - *string?* : GUID - A string containing (hexadecimal) values, delimited with hyphens. Returns nil if the unit does not exist. - -**Usage:** -Prints the target's GUID, in this case a creature. -```lua -/dump UnitName("target"), UnitGUID("target") -> "Hogger", "Creature-0-1465-0-2105-448-000043F59F" -``` -Prints the npc/player ID of a unit, if applicable. -```lua -local unitLink = "|cffffff00|Hunit:%s|h|h|r" -local function ParseGUID(unit) - local guid = UnitGUID(unit) - local name = UnitName(unit) - if guid then - local link = unitLink:format(guid, name) -- clickable link - local unit_type = strsplit("-", guid) - if unit_type == "Creature" or unit_type == "Vehicle" then - local _, _, server_id, instance_id, zone_uid, npc_id, spawn_uid = strsplit("-", guid) - print(format("%s is a creature with NPC ID %d", link, npc_id)) - elseif unit_type == "Player" then - local _, server_id, player_id = strsplit("-", guid) - print(format("%s is a player with ID %s", link, player_id)) - end - end -end -``` - -**Reference:** -- `GetPlayerInfoByGUID()` \ No newline at end of file diff --git a/wiki-information/functions/UnitGetAvailableRoles.md b/wiki-information/functions/UnitGetAvailableRoles.md deleted file mode 100644 index b6af4e08..00000000 --- a/wiki-information/functions/UnitGetAvailableRoles.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: UnitGetAvailableRoles - -**Content:** -Returns the recommended roles for a specified unit. -`tank, heal, dps = UnitGetAvailableRoles(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `tank` - - *boolean* - Whether the unit can perform as a tank -- `heal` - - *boolean* - Whether the unit can perform as a healer -- `dps` - - *boolean* - Whether the unit can perform as a dps - -**Notes and Caveats:** -Although the Group Finder allows every class to pick any role, for some there is a warning that it is not recommended (e.g., healer as a Warrior). This function returns results based on the same logic. \ No newline at end of file diff --git a/wiki-information/functions/UnitGetIncomingHeals.md b/wiki-information/functions/UnitGetIncomingHeals.md deleted file mode 100644 index 7aa737ee..00000000 --- a/wiki-information/functions/UnitGetIncomingHeals.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: UnitGetIncomingHeals - -**Content:** -Returns the predicted heals cast on the specified unit. -`heal = UnitGetIncomingHeals(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken -- `healerGUID` - - *string?* : UnitToken - Only predict incoming heals from a single UnitId. - -**Returns:** -- `heal` - - *number* - Predicted increase in health from incoming heals. - -**Description:** -For Classic, this function is only partially functional. The returned value only predicts healing from direct spell casts; heal-over-time effects and channeled casts are not factored into any predictions. - -**Reference:** -- `UnitHealth` -- `UnitHealthMax` -- `UnitGetTotalAbsorbs` - -**References:** -- [WoWUIBugs Issue #163](https://github.com/Stanzilla/WoWUIBugs/issues/163) \ No newline at end of file diff --git a/wiki-information/functions/UnitGroupRolesAssigned.md b/wiki-information/functions/UnitGroupRolesAssigned.md deleted file mode 100644 index af4ca70c..00000000 --- a/wiki-information/functions/UnitGroupRolesAssigned.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitGroupRolesAssigned - -**Content:** -Returns the assigned role in a group formed via the Dungeon Finder Tool. -`role = UnitGroupRolesAssigned(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `role` - - *string* - TANK, HEALER, DAMAGER, NONE \ No newline at end of file diff --git a/wiki-information/functions/UnitHPPerStamina.md b/wiki-information/functions/UnitHPPerStamina.md deleted file mode 100644 index 55c57f2f..00000000 --- a/wiki-information/functions/UnitHPPerStamina.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitHPPerStamina - -**Content:** -Needs summary. -`hp = UnitHPPerStamina(unit)` - -**Parameters:** -- `unit` - - *string* - UnitToken - -**Returns:** -- `hp` - - *number* - -**Example Usage:** -This function can be used to determine the amount of health points (HP) a unit gains per point of stamina. This can be useful for addons that need to calculate or display health-related statistics. - -**Addons:** -While specific large addons using this function are not documented, it is likely used in various unit frame and combat-related addons to provide detailed health metrics. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasIncomingResurrection.md b/wiki-information/functions/UnitHasIncomingResurrection.md deleted file mode 100644 index 664fc9c7..00000000 --- a/wiki-information/functions/UnitHasIncomingResurrection.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: UnitHasIncomingResurrection - -**Content:** -Returns true if the unit is currently being resurrected. -`isBeingResurrected = UnitHasIncomingResurrection(unitID or UnitName)` - -**Parameters:** -- `unitID` - - *string* - either the unitID ("player", "target", "party3", etc) or unit's name ("Bob" or "Bob-Llane") - -**Returns:** -- `isBeingResurrected` - - *boolean* - Returns true if the unit is being resurrected by any means, be it spell, item, or some other method. Returns nil/false otherwise. - -**Description:** -This returns nil/false if the cast is completed and the unit has not yet accepted the resurrection. It is only true if the cast is in progress and the cast is some method of resurrection. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasLFGDeserter.md b/wiki-information/functions/UnitHasLFGDeserter.md deleted file mode 100644 index f39e768b..00000000 --- a/wiki-information/functions/UnitHasLFGDeserter.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitHasLFGDeserter - -**Content:** -Returns whether the unit is currently unable to use the dungeon finder due to leaving a group prematurely. -`isDeserter = UnitHasLFGDeserter(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - the unit that would assist (e.g., "player" or "target") - -**Returns:** -- `isDeserter` - - *boolean* - true if the unit is currently an LFG deserter (and hence unable to use the dungeon finder), false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasLFGRandomCooldown.md b/wiki-information/functions/UnitHasLFGRandomCooldown.md deleted file mode 100644 index ae20b810..00000000 --- a/wiki-information/functions/UnitHasLFGRandomCooldown.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: UnitHasLFGRandomCooldown - -**Content:** -Returns whether the unit is currently under the effects of the random dungeon cooldown. -`hasRandomCooldown = UnitHasLFGRandomCooldown(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - the unit that would assist (e.g., "player" or "target") - -**Returns:** -- `hasRandomCooldown` - - *boolean* - true if the unit is currently unable to queue for random dungeons due to the random cooldown, false otherwise. - -**Description:** -Players may also be prevented from using the dungeon finder entirely, as part of the dungeon finder deserter effect. Use `UnitHasLFGDeserter("unit")` to query that. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasRelicSlot.md b/wiki-information/functions/UnitHasRelicSlot.md deleted file mode 100644 index eaf4f931..00000000 --- a/wiki-information/functions/UnitHasRelicSlot.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitHasRelicSlot - -**Content:** -Needs summary. -`hasRelicSlot = UnitHasRelicSlot(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `hasRelicSlot` - - *boolean* - -**Example Usage:** -This function can be used to determine if a specific unit has a relic slot. This is particularly useful for addons that manage or display information about equipment slots. - -**Addons Using This Function:** -- **Pawn**: An addon that helps players find upgrades for their gear. It uses this function to check if a unit has a relic slot to provide accurate gear suggestions. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasVehiclePlayerFrameUI.md b/wiki-information/functions/UnitHasVehiclePlayerFrameUI.md deleted file mode 100644 index 818d4c96..00000000 --- a/wiki-information/functions/UnitHasVehiclePlayerFrameUI.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: UnitHasVehiclePlayerFrameUI - -**Content:** -Needs summary. -`hasVehicleUI = UnitHasVehiclePlayerFrameUI()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `hasVehicleUI` - - *boolean* - -**Example Usage:** -This function can be used to determine if a unit (such as a player) currently has a vehicle UI. This is useful in scenarios where the UI needs to adapt based on whether the player is controlling a vehicle. - -**Example:** -```lua -local unit = "player" -if UnitHasVehiclePlayerFrameUI(unit) then - print("Player is in a vehicle.") -else - print("Player is not in a vehicle.") -end -``` - -**Addons:** -Large addons like **ElvUI** and **Bartender4** use this function to adjust the user interface when the player enters or exits a vehicle, ensuring that the vehicle's abilities and controls are properly displayed. \ No newline at end of file diff --git a/wiki-information/functions/UnitHasVehicleUI.md b/wiki-information/functions/UnitHasVehicleUI.md deleted file mode 100644 index e0e6eb90..00000000 --- a/wiki-information/functions/UnitHasVehicleUI.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitHasVehicleUI - -**Content:** -Needs summary. -`hasVehicleUI = UnitHasVehicleUI()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `hasVehicleUI` - - *boolean* - -**Example Usage:** -This function can be used to determine if a unit is currently using a vehicle UI. This is particularly useful in scenarios where the player's interface changes due to vehicle control, such as in certain quests or battlegrounds. - -**Addons Usage:** -Large addons like **DBM (Deadly Boss Mods)** and **ElvUI** may use this function to adjust the UI dynamically when the player enters or exits a vehicle, ensuring that the interface remains functional and informative. \ No newline at end of file diff --git a/wiki-information/functions/UnitHealth.md b/wiki-information/functions/UnitHealth.md deleted file mode 100644 index 724bd2f7..00000000 --- a/wiki-information/functions/UnitHealth.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: UnitHealth - -**Content:** -Returns the current health of the unit. -`health = UnitHealth(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken -- `usePredicted` - - *boolean?* = true - -**Returns:** -- `health` - - *number* - Returns 0 if the unit is dead or does not exist. - -**Description:** -Related Events: -- `UNIT_HEALTH` - -Available after: -- `PLAYER_ENTERING_WORLD` (on login) - -**Reference:** -- Kaivax 2020-02-18. UI API Change for UnitHealth. \ No newline at end of file diff --git a/wiki-information/functions/UnitHealthMax.md b/wiki-information/functions/UnitHealthMax.md deleted file mode 100644 index 922b9246..00000000 --- a/wiki-information/functions/UnitHealthMax.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: UnitHealthMax - -**Content:** -Returns the maximum health of the unit. -`maxHealth = UnitHealthMax(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `maxHealth` - - *number* - Returns 0 if the unit does not exist. - -**Description:** -- **Related Events:** - - `UNIT_MAXHEALTH` -- **Available after:** - - `PLAYER_ENTERING_WORLD` (on login) - -**Example Usage:** -```lua -local unit = "player" -local maxHealth = UnitHealthMax(unit) -print("Maximum Health of the player: ", maxHealth) -``` - -**Common Addon Usage:** -- **Deadly Boss Mods (DBM):** Uses `UnitHealthMax` to determine the maximum health of bosses and players to provide accurate health percentage displays during encounters. -- **Recount:** Utilizes `UnitHealthMax` to track and display the maximum health of units for detailed combat analysis and reporting. \ No newline at end of file diff --git a/wiki-information/functions/UnitInAnyGroup.md b/wiki-information/functions/UnitInAnyGroup.md deleted file mode 100644 index 0b6199e9..00000000 --- a/wiki-information/functions/UnitInAnyGroup.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitInAnyGroup - -**Content:** -Returns whether or not the targeted unit is in a Group of any type. Instance, raid, party, etc. -`inGroup = UnitInAnyGroup(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit token of the unit to check group status for. Always returns false if no unit is provided. - -**Returns:** -- `inGroup` - - *boolean* - True if the target is in a group, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitInBattleground.md b/wiki-information/functions/UnitInBattleground.md deleted file mode 100644 index 081fe401..00000000 --- a/wiki-information/functions/UnitInBattleground.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: UnitInBattleground - -**Content:** -Returns the unit index if the unit is in your battleground. -`position = UnitInBattleground(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `position` - - *number* - The position in the battleground raid of the specified unit, `nil` if outside of the battleground, and 0 if `unit` is `player` and player is the last person left standing inside of a finished battleground. - -**Usage:** -```lua -local position = UnitInBattleground("player"); -ChatFrame1:AddMessage('Position in battleground raid: ' .. (position or "(?)")); -``` - -**Miscellaneous:** -Result: - -Prints the player's position number in the battleground raid. e.g. (depending on number left in battleground raid when call is made) -- Position in battleground raid: (?) -- Position in battleground raid: 0 -- Position in battleground raid: 12 - -**Description:** -- Returns `nil` if outside of a battleground. -- Returns `0` if you are the last person inside of a battleground after the match is over, and everybody else has left. -- Returns 1-#, where # is the maximum number of players allowed in the battleground raid. \ No newline at end of file diff --git a/wiki-information/functions/UnitInParty.md b/wiki-information/functions/UnitInParty.md deleted file mode 100644 index d9444b71..00000000 --- a/wiki-information/functions/UnitInParty.md +++ /dev/null @@ -1,33 +0,0 @@ -## Title: UnitInParty - -**Content:** -Returns true if the unit is a member of your party. -`inParty = UnitInParty(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `inParty` - - *boolean* - if the unit is in your party - -**Usage:** -```lua -if UnitInParty("target") then - print("Your target is in your party.") -else - print("Your target is not in your party.") -end -``` - -**Description:** -- Pets are not considered to be part of your party (but see `UnitPlayerOrPetInParty`). -- Battleground raid/party members are also not considered to be part of your party. -- `UnitInParty("player")` returns nil when you are not in a party. -- As of 2.0.3, `UnitInParty("player")` always returns 1, even when you are not in a party. -- `UnitInParty("player")` should return nil. (since patch 1.11.2, always returned 1 before) -- Use `GetNumPartyMembers` and `GetNumRaidMembers` to determine if you are in a party or raid. - -**Reference:** -- `UnitInRaid` \ No newline at end of file diff --git a/wiki-information/functions/UnitInPartyIsAI.md b/wiki-information/functions/UnitInPartyIsAI.md deleted file mode 100644 index a671ebde..00000000 --- a/wiki-information/functions/UnitInPartyIsAI.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitInPartyIsAI - -**Content:** -Needs summary. -`result = UnitInPartyIsAI()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -This function can be used to determine if a unit in the party is controlled by AI. This is particularly useful in scenarios where you need to differentiate between player-controlled characters and AI-controlled characters, such as in certain PvE or PvP contexts. - -**Addons:** -Large addons like Deadly Boss Mods (DBM) might use this function to adjust strategies or warnings based on whether party members are AI-controlled, ensuring more accurate and relevant alerts during encounters. \ No newline at end of file diff --git a/wiki-information/functions/UnitInPhase.md b/wiki-information/functions/UnitInPhase.md deleted file mode 100644 index 7602b464..00000000 --- a/wiki-information/functions/UnitInPhase.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: UnitInPhase - -**Content:** -Returns if a unit is in the same phase. -`inPhase = UnitInPhase(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `inPhase` - - *boolean* - -**Reference:** -- `UNIT_PHASE` \ No newline at end of file diff --git a/wiki-information/functions/UnitInRaid.md b/wiki-information/functions/UnitInRaid.md deleted file mode 100644 index 459db124..00000000 --- a/wiki-information/functions/UnitInRaid.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: UnitInRaid - -**Content:** -Returns the index if the unit is in your raid group. -`index = UnitInRaid(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `index` - - *number* - same number in the raid UnitId, feed into `GetRaidRosterInfo` - -**Description:** -Pets are not considered to be part of your raid group. - -**Reference:** -- `UnitInParty()` - -**Example Usage:** -```lua -local unit = "player" -local raidIndex = UnitInRaid(unit) -if raidIndex then - print("Player is in the raid at index:", raidIndex) -else - print("Player is not in the raid.") -end -``` - -**Usage in Addons:** -- **DBM (Deadly Boss Mods):** This function is used to determine if a player is in a raid group to enable or disable raid-specific features and warnings. -- **ElvUI:** Utilizes this function to adjust UI elements based on whether the player is in a raid group, such as displaying raid frames. \ No newline at end of file diff --git a/wiki-information/functions/UnitInRange.md b/wiki-information/functions/UnitInRange.md deleted file mode 100644 index b9bd47bf..00000000 --- a/wiki-information/functions/UnitInRange.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: UnitInRange - -**Content:** -Returns true if the unit is within 40 yards range (25 yards for Evokers). -`inRange, checkedRange = UnitInRange(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `inRange` - - *boolean* - true if the unit is within 40 (25 for Evokers) yards of the player -- `checkedRange` - - *boolean* - true if a range check was actually performed; false if the information about distance to the queried unit is unavailable. - -**Note:** -UnitInRange("player") will return false, false outside of a group. \ No newline at end of file diff --git a/wiki-information/functions/UnitInSubgroup.md b/wiki-information/functions/UnitInSubgroup.md deleted file mode 100644 index be6ebf54..00000000 --- a/wiki-information/functions/UnitInSubgroup.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: UnitInSubgroup - -**Content:** -Needs summary. -`inSubgroup = UnitInSubgroup()` - -**Parameters:** -- `unit` - - *string?* : UnitId -- `overridePartyType` - - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. - - `Value` - - `Enum` - - `Description` - - `1` - - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. - - `2` - - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder - -**Returns:** -- `inSubgroup` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitInVehicle.md b/wiki-information/functions/UnitInVehicle.md deleted file mode 100644 index a8bdbfd0..00000000 --- a/wiki-information/functions/UnitInVehicle.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitInVehicle - -**Content:** -Checks whether a specified unit is within a vehicle. -`inVehicle = UnitInVehicle(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `inVehicle` - - *boolean* - -**Example Usage:** -This function can be used to determine if a player or NPC is currently in a vehicle. This is particularly useful in scenarios where vehicle mechanics are involved, such as certain quests or battlegrounds. - -**Addons:** -Many large addons, such as Deadly Boss Mods (DBM), use this function to track player status during encounters that involve vehicles. This helps in providing accurate alerts and timers based on whether players are in or out of vehicles. \ No newline at end of file diff --git a/wiki-information/functions/UnitInVehicleControlSeat.md b/wiki-information/functions/UnitInVehicleControlSeat.md deleted file mode 100644 index 848aba3d..00000000 --- a/wiki-information/functions/UnitInVehicleControlSeat.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: UnitInVehicleControlSeat - -**Content:** -Needs summary. -`inVehicle = UnitInVehicleControlSeat()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `inVehicle` - - *boolean* - -**Description:** -The `UnitInVehicleControlSeat` function checks if a specified unit is in the control seat of a vehicle. This can be useful in scenarios where you need to determine if a player or NPC is controlling a vehicle, such as in vehicle-based quests or battlegrounds. - -**Example Usage:** -```lua -local unit = "player" -if UnitInVehicleControlSeat(unit) then - print(unit .. " is in the control seat of a vehicle.") -else - print(unit .. " is not in the control seat of a vehicle.") -end -``` - -**Addons Using This Function:** -- **DBM (Deadly Boss Mods):** This addon may use `UnitInVehicleControlSeat` to track player status in vehicle-based encounters to provide accurate alerts and timers. -- **WeakAuras:** This powerful and flexible framework for displaying customizable graphics on your screen may use this function to create auras that trigger based on vehicle control status. \ No newline at end of file diff --git a/wiki-information/functions/UnitInVehicleHidesPetFrame.md b/wiki-information/functions/UnitInVehicleHidesPetFrame.md deleted file mode 100644 index d7223de6..00000000 --- a/wiki-information/functions/UnitInVehicleHidesPetFrame.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitInVehicleHidesPetFrame - -**Content:** -Needs summary. -`hidesPet = UnitInVehicleHidesPetFrame()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `hidesPet` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsAFK.md b/wiki-information/functions/UnitIsAFK.md deleted file mode 100644 index 38651733..00000000 --- a/wiki-information/functions/UnitIsAFK.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: UnitIsAFK - -**Content:** -Returns true if a friendly unit is AFK (Away from keyboard). -`isAFK = UnitIsAFK(unit)` - -**Parameters:** -- `unit` - - The UnitId to return AFK status of. A nil value throws an error. - -**Returns:** -- `isAFK` - - *boolean* - true if unit is AFK, false otherwise. An invalid or nonexistent unit value also returns false. - -**Usage:** -If the player is AFK, the following script outputs "You are AFK" to the default chat window. -```lua -if UnitIsAFK("player") then - DEFAULT_CHAT_FRAME:AddMessage("You are AFK"); -end -``` - -If the player is AFK, the following script outputs "You are AFK" to the default chat window. -```lua -if UnitIsAFK("player") then - DEFAULT_CHAT_FRAME:AddMessage("You are AFK"); -end -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsCharmed.md b/wiki-information/functions/UnitIsCharmed.md deleted file mode 100644 index 081776fb..00000000 --- a/wiki-information/functions/UnitIsCharmed.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitIsCharmed - -**Content:** -Returns true if the unit is charmed. -`isTrue = UnitIsCharmed(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `isTrue` - - *boolean* - true if the unit is charmed, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsCivilian.md b/wiki-information/functions/UnitIsCivilian.md deleted file mode 100644 index 69fc3476..00000000 --- a/wiki-information/functions/UnitIsCivilian.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitIsCivilian - -**Content:** -Determine whether a unit is a civilian (low-level enemy faction NPC that counts as a dishonorable kill). -`isCivilian = UnitIsCivilian(unit)` - -**Parameters:** -- `unit` - - *string* - Only works on enemy faction NPCs. - -**Returns:** -- `isCivilian` - - *boolean* - Returns true if the unit is a civilian, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsConnected.md b/wiki-information/functions/UnitIsConnected.md deleted file mode 100644 index 519f1891..00000000 --- a/wiki-information/functions/UnitIsConnected.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitIsConnected - -**Content:** -Returns true if the unit is connected to the game (i.e. not offline). -`isOnline = UnitIsConnected(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `isConnected` - - *boolean* - -**Example Usage:** -This function can be used to check if a player in your party or raid is currently online. For instance, in a raid management addon, you might use this to determine which players are available for an encounter. - -**Addons Using This Function:** -Many raid management and unit frame addons, such as ElvUI and Grid, use `UnitIsConnected` to display the online/offline status of players. This helps raid leaders and players to quickly identify who is available and who is not. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsControlling.md b/wiki-information/functions/UnitIsControlling.md deleted file mode 100644 index df46709b..00000000 --- a/wiki-information/functions/UnitIsControlling.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitIsControlling - -**Content:** -Needs summary. -`isControlling = UnitIsControlling(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `isControlling` - - *boolean* - -**Example Usage:** -This function can be used to determine if a unit is currently controlling another unit, which can be useful in scenarios where you need to check if a player or NPC is controlling a pet or a vehicle. - -**Addons:** -Large addons like **ElvUI** and **WeakAuras** might use this function to track and display control status of units for better UI customization and alerting players about control changes. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsCorpse.md b/wiki-information/functions/UnitIsCorpse.md deleted file mode 100644 index ec01a388..00000000 --- a/wiki-information/functions/UnitIsCorpse.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitIsCorpse - -**Content:** -Needs summary. -`result = UnitIsCorpse()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -This function can be used to determine if a specific unit is a corpse. For instance, in an addon that manages resurrection spells, you could use `UnitIsCorpse` to check if a player unit is a corpse before attempting to cast a resurrection spell. - -**Addons Using This Function:** -Many raid and party management addons, such as Deadly Boss Mods (DBM) and HealBot, use this function to manage player states and automate certain actions based on whether a unit is dead or alive. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsDND.md b/wiki-information/functions/UnitIsDND.md deleted file mode 100644 index c7412cde..00000000 --- a/wiki-information/functions/UnitIsDND.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: UnitIsDND - -**Content:** -Returns true if a unit is DND (Do not disturb). -`isDND = UnitIsDND(unit)` - -**Parameters:** -- `unit` - - The UnitId to return DND status of. - -**Returns:** -- `isDND` - - 1 if unit is DND, nil otherwise. - -**Usage:** -If the player is DND, the following script outputs "You are DND" to the default chat window. -```lua -if UnitIsDND("player") then - DEFAULT_CHAT_FRAME:AddMessage("You are DND"); -end -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsDead.md b/wiki-information/functions/UnitIsDead.md deleted file mode 100644 index 8e9f734d..00000000 --- a/wiki-information/functions/UnitIsDead.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: UnitIsDead - -**Content:** -Returns true if the unit is dead. -`isDead = UnitIsDead(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `isDead` - - *boolean* - -**Description:** -See `UnitIsDeadOrGhost` for details. - -**Reference:** -- `UnitIsDeadOrGhost` -- `UnitIsGhost` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsDeadOrGhost.md b/wiki-information/functions/UnitIsDeadOrGhost.md deleted file mode 100644 index cc8cd91e..00000000 --- a/wiki-information/functions/UnitIsDeadOrGhost.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: UnitIsDeadOrGhost - -**Content:** -Returns true if the unit is dead or in ghost form. -`isDeadOrGhost = UnitIsDeadOrGhost(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `isDeadOrGhost` - - *boolean* - -**Description:** -Effectively combines UnitIsDead and UnitIsGhost, returning true if either of those functions would return true. -Does not work for despawned pet units. (A pet is "despawned" once its corpse is no longer targetable in the game world, or its action bar is no longer visible on its owner's screen.) -Returns false for priests who are currently in form, having died once and are about to die again. - -**Reference:** -- `UnitIsDead` -- `UnitIsGhost` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsEnemy.md b/wiki-information/functions/UnitIsEnemy.md deleted file mode 100644 index a06dc08d..00000000 --- a/wiki-information/functions/UnitIsEnemy.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: UnitIsEnemy - -**Content:** -Returns true if the specified units are hostile to each other. -`isEnemy = UnitIsEnemy(unit1, unit2)` - -**Parameters:** -- `unit1` - - *string* : UnitId -- `unit2` - - *string* : UnitId - The unit to compare with the first unit. - -**Returns:** -- `isEnemy` - - *boolean* - -**Example Usage:** -This function can be used in a PvP addon to determine if a player is targeting an enemy unit. For instance, an addon could use `UnitIsEnemy("player", "target")` to check if the player's current target is an enemy and then display a warning or change the UI accordingly. - -**Addons Using This Function:** -Many PvP-oriented addons, such as Gladius, use `UnitIsEnemy` to determine if the units in the arena are enemies and to update the UI elements to reflect the status of the opponents. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsFeignDeath.md b/wiki-information/functions/UnitIsFeignDeath.md deleted file mode 100644 index ee5a8e73..00000000 --- a/wiki-information/functions/UnitIsFeignDeath.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: UnitIsFeignDeath - -**Content:** -Returns true if the unit (must be a group member) is feigning death. -`isFeign = UnitIsFeignDeath(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `isFeign` - - *boolean* - Returns true if the checked unit is feigning death, false otherwise. - -**Description:** -Only provides valid data for friendly units. -Does not work for the player character. Use `UnitAura` instead: -`isFeign = UnitAura("player", "Feign Death") ~= nil` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsFriend.md b/wiki-information/functions/UnitIsFriend.md deleted file mode 100644 index 10c36d47..00000000 --- a/wiki-information/functions/UnitIsFriend.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: UnitIsFriend - -**Content:** -Returns true if the specified units are friendly to each other. -`isFriend = UnitIsFriend(unit1, unit2)` - -**Parameters:** -- `unit1` - - *string* : UnitId -- `unit2` - - *string* : UnitId - The unit to compare with the first unit. - -**Returns:** -- `isFriend` - - *boolean* - -**Example Usage:** -This function can be used in a variety of scenarios, such as determining if a player can cast beneficial spells on another unit or if two units are part of the same faction. - -**Addons:** -Many large addons, such as HealBot and Grid, use `UnitIsFriend` to determine if a unit is friendly and thus eligible for healing or other beneficial actions. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGameObject.md b/wiki-information/functions/UnitIsGameObject.md deleted file mode 100644 index 3def6281..00000000 --- a/wiki-information/functions/UnitIsGameObject.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitIsGameObject - -**Content:** -Needs summary. -`result = UnitIsGameObject()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -This function can be used to determine if a given unit is a game object. For instance, in a custom addon, you might want to check if a target is a game object before performing certain actions. - -**Additional Information:** -This function is often used in addons that interact with the game world objects, such as gathering nodes, chests, or other interactable objects. Large addons like GatherMate2 might use this function to differentiate between units and game objects when tracking resource nodes on the map. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGhost.md b/wiki-information/functions/UnitIsGhost.md deleted file mode 100644 index 266f1cbe..00000000 --- a/wiki-information/functions/UnitIsGhost.md +++ /dev/null @@ -1,20 +0,0 @@ -## Title: UnitIsGhost - -**Content:** -Returns true if the unit is in ghost form. -`isGhost = UnitIsGhost(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `isGhost` - - *boolean* - -**Description:** -See `UnitIsDeadOrGhost` for details. - -**Reference:** -- `UnitIsDeadOrGhost` -- `UnitIsDead` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGroupAssistant.md b/wiki-information/functions/UnitIsGroupAssistant.md deleted file mode 100644 index e22fdaa4..00000000 --- a/wiki-information/functions/UnitIsGroupAssistant.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: UnitIsGroupAssistant - -**Content:** -Returns whether the unit is an assistant in your current group. -`isAssistant = UnitIsGroupAssistant(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `isAssistant` - - *boolean* - true if the unit is a raid assistant in your current group, false otherwise. - -**Description:** -Group leaders and assistants can invite players to the group, set main tanks, world markers, etc. -This function returns true only for players promoted to group assistants, either explicitly or via the "make everyone an assistant" option. It'll return false for the group leader. - -**Reference:** -- `UnitIsGroupLeader` -- `IsEveryoneAssistant` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsGroupLeader.md b/wiki-information/functions/UnitIsGroupLeader.md deleted file mode 100644 index f886bc1d..00000000 --- a/wiki-information/functions/UnitIsGroupLeader.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: UnitIsGroupLeader - -**Content:** -Returns whether the unit is the leader of a party or raid. -`isLeader = UnitIsGroupLeader(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId -- `partyCategory` - - *number?* - If omitted, defaults to INSTANCE if applicable, HOME otherwise. - - **Value** - - **Enum** - - **Description** - - `1` - - `LE_PARTY_CATEGORY_HOME` - Home-realm group, i.e. a manually created group. - - `2` - - `LE_PARTY_CATEGORY_INSTANCE` - Instance-specific temporary group, e.g. Battlegrounds, Dungeon Finder - -**Returns:** -- `isLeader` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsInMyGuild.md b/wiki-information/functions/UnitIsInMyGuild.md deleted file mode 100644 index af650163..00000000 --- a/wiki-information/functions/UnitIsInMyGuild.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitIsInMyGuild - -**Content:** -Needs summary. -`result = UnitIsInMyGuild(unit)` - -**Parameters:** -- `unit` - - *string* - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsInteractable.md b/wiki-information/functions/UnitIsInteractable.md deleted file mode 100644 index 1452992f..00000000 --- a/wiki-information/functions/UnitIsInteractable.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitIsInteractable - -**Content:** -Needs summary. -`result = UnitIsInteractable()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -This function can be used to determine if a unit (such as an NPC or another player) is interactable. For instance, it can be useful in scenarios where you need to check if a quest giver or vendor is available for interaction. - -**Addons Usage:** -Large addons like "ElvUI" and "Questie" might use this function to enhance user interaction with NPCs, ensuring that the UI elements are only shown when the NPCs are interactable. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsOtherPlayersPet.md b/wiki-information/functions/UnitIsOtherPlayersPet.md deleted file mode 100644 index 5c47d71e..00000000 --- a/wiki-information/functions/UnitIsOtherPlayersPet.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: UnitIsOtherPlayersPet - -**Content:** -Needs summary. -`result = UnitIsOtherPlayersPet()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `result` - - *boolean* - -**Example Usage:** -This function can be used to determine if a given unit is a pet controlled by another player. This can be useful in addons that need to differentiate between player-controlled pets and other types of units. - -**Example:** -```lua -local unit = "target" -if UnitIsOtherPlayersPet(unit) then - print(unit .. " is another player's pet.") -else - print(unit .. " is not another player's pet.") -end -``` - -**Addons:** -Large addons like "Recount" or "Details! Damage Meter" might use this function to filter out pets controlled by other players when calculating damage statistics. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md b/wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md deleted file mode 100644 index 77deeabc..00000000 --- a/wiki-information/functions/UnitIsOwnerOrControllerOfUnit.md +++ /dev/null @@ -1,15 +0,0 @@ -## Title: UnitIsOwnerOrControllerOfUnit - -**Content:** -Needs summary. -`unitIsOwnerOrControllerOfUnit = UnitIsOwnerOrControllerOfUnit(controllingUnit, controlledUnit)` - -**Parameters:** -- `controllingUnit` - - *string* -- `controlledUnit` - - *string* - -**Returns:** -- `unitIsOwnerOrControllerOfUnit` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPVPFreeForAll.md b/wiki-information/functions/UnitIsPVPFreeForAll.md deleted file mode 100644 index 7a0332c8..00000000 --- a/wiki-information/functions/UnitIsPVPFreeForAll.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitIsPVPFreeForAll - -**Content:** -Returns true if the unit is flagged for free-for-all PVP (e.g. in a world arena). -`isFreeForAll = UnitIsPVPFreeForAll(unit)` - -**Parameters:** -- `unitId` - - *string* : UnitId - The unit to check - -**Returns:** -- `isFreeForAll` - - *boolean* - Whether the unit is flagged for free-for-all PVP \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPVPSanctuary.md b/wiki-information/functions/UnitIsPVPSanctuary.md deleted file mode 100644 index 929b290d..00000000 --- a/wiki-information/functions/UnitIsPVPSanctuary.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitIsPVPSanctuary - -**Content:** -Needs summary. -`result = UnitIsPVPSanctuary()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `result` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPlayer.md b/wiki-information/functions/UnitIsPlayer.md deleted file mode 100644 index 18865335..00000000 --- a/wiki-information/functions/UnitIsPlayer.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitIsPlayer - -**Content:** -Returns true if the unit is a player character. -`isPlayer = UnitIsPlayer(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `isPlayer` - - *boolean* - true if the unit is a player, false otherwise. - -**Example Usage:** -This function can be used in addons to check if a target or focus is a player. For instance, in a PvP addon, you might want to display different information if the target is a player versus an NPC. - -**Addons Using This Function:** -Many large addons, such as "Recount" and "Details! Damage Meter," use this function to differentiate between player and NPC units when tracking combat statistics. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsPossessed.md b/wiki-information/functions/UnitIsPossessed.md deleted file mode 100644 index b6a56e12..00000000 --- a/wiki-information/functions/UnitIsPossessed.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitIsPossessed - -**Content:** -Returns true if the unit is currently under control of another (e.g. Mind Control). -`isTrue = UnitIsPossessed(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `isTrue` - - *boolean* - true if the unit is possessed, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsRaidOfficer.md b/wiki-information/functions/UnitIsRaidOfficer.md deleted file mode 100644 index 5992f6cc..00000000 --- a/wiki-information/functions/UnitIsRaidOfficer.md +++ /dev/null @@ -1,29 +0,0 @@ -## Title: UnitIsRaidOfficer - -**Content:** -Needs summary. -`result = UnitIsRaidOfficer()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `result` - - *boolean* - -**Description:** -The `UnitIsRaidOfficer` function checks if a specified unit is a raid officer. This can be useful in scenarios where you need to determine if a player has raid officer privileges, such as managing raid groups or accessing certain raid functionalities. - -**Example Usage:** -```lua -local unit = "player" -if UnitIsRaidOfficer(unit) then - print(unit .. " is a raid officer.") -else - print(unit .. " is not a raid officer.") -end -``` - -**Addons Using This Function:** -Many raid management addons, such as "Deadly Boss Mods" (DBM) and "BigWigs", may use this function to check for raid officer status to enable or disable certain features or commands that are restricted to raid officers. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsSameServer.md b/wiki-information/functions/UnitIsSameServer.md deleted file mode 100644 index a98829a7..00000000 --- a/wiki-information/functions/UnitIsSameServer.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: UnitIsSameServer - -**Content:** -Returns true if the unit is from the same (connected) realm. -`sameServer = UnitIsSameServer(unit)` - -**Parameters:** -- `unit` - - *string* - UnitId - -**Returns:** -- `sameServer` - - *boolean* - 1 if the specified unit is from the player's realm (or a Connected Realm linked to the player's own realm), nil otherwise. - -**Reference:** -- `UnitRealmRelationship` \ No newline at end of file diff --git a/wiki-information/functions/UnitIsTapDenied.md b/wiki-information/functions/UnitIsTapDenied.md deleted file mode 100644 index ff3fe147..00000000 --- a/wiki-information/functions/UnitIsTapDenied.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: UnitIsTapDenied - -**Content:** -Indicates a mob is no longer eligible for tap. -`unitIsTapDenied = UnitIsTapDenied(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `unitIsTapDenied` - - *boolean* - -**Usage:** -The following code in FrameXML grays out the target frame when the target is tap denied: -```lua -function TargetFrame_CheckFaction (self) - if ( not UnitPlayerControlled(self.unit) and UnitIsTapDenied(self.unit) ) then - self.nameBackground:SetVertexColor(0.5, 0.5, 0.5); - if ( self.portrait ) then - self.portrait:SetVertexColor(0.5, 0.5, 0.5); - end - else - self.nameBackground:SetVertexColor(UnitSelectionColor(self.unit)); - if ( self.portrait ) then - self.portrait:SetVertexColor(1.0, 1.0, 1.0); - end - end - -- the function continues with activities not relevant to this example -end -``` - -**Example Use Case:** -This function is particularly useful in scenarios where you need to visually indicate to the player that a mob is no longer eligible for them to gain credit for a kill. For instance, in a custom UI addon, you might want to change the appearance of the target frame to show that the mob is tap denied, similar to how the default UI does it. - -**Addons Using This Function:** -Many popular addons that modify the unit frames, such as ElvUI and Shadowed Unit Frames, use this function to provide visual feedback to the player about the tap status of their target. This helps players quickly identify whether they can gain credit for attacking a mob or not. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsTrivial.md b/wiki-information/functions/UnitIsTrivial.md deleted file mode 100644 index 54df1efd..00000000 --- a/wiki-information/functions/UnitIsTrivial.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: UnitIsTrivial - -**Content:** -Returns true if the unit is trivial (i.e. "grey" to the player). -`isTrivial = UnitIsTrivial(unit)` - -**Parameters:** -- `unit` - - *string* - UnitToken - -**Returns:** -- `isTrivial` - - *boolean* - True if the unit is comparatively too low level to provide experience or honor; otherwise false. - -**Description:** -At level 60, units level 47 and under are trivial. -Trivial units continue to give loot, quest credit, and (reduced) faction rep. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsUnconscious.md b/wiki-information/functions/UnitIsUnconscious.md deleted file mode 100644 index c16aae29..00000000 --- a/wiki-information/functions/UnitIsUnconscious.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitIsUnconscious - -**Content:** -Needs summary. -`isUnconscious = UnitIsUnconscious(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `isUnconscious` - - *boolean* - -**Example Usage:** -This function can be used to check if a specific unit (player, NPC, etc.) is unconscious. This can be particularly useful in scenarios where you need to handle unconscious states differently, such as in custom UI elements or combat scripts. - -**Addons:** -While there are no specific large addons known to use this function extensively, it can be a useful utility in various custom scripts and smaller addons that need to manage unit states. \ No newline at end of file diff --git a/wiki-information/functions/UnitIsUnit.md b/wiki-information/functions/UnitIsUnit.md deleted file mode 100644 index 81df0468..00000000 --- a/wiki-information/functions/UnitIsUnit.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: UnitIsUnit - -**Content:** -Returns true if the specified units are the same unit. -`isSame = UnitIsUnit(unit1, unit2)` - -**Parameters:** -- `unit1` - - *string* : UnitId - The first unit to query (e.g. "party1", "pet", "player") -- `unit2` - - *string* : UnitId - The second unit to compare it to (e.g. "target") - -**Returns:** -- `isSame` - - *boolean* - 1 if the two units are the same entity, nil otherwise. - -**Usage:** -```lua -if ( UnitIsUnit("targettarget", "player") ) then - message("Look at me, I have aggro from " .. UnitName("target") .. "!"); -end; -``` - -**Miscellaneous:** -Result: -Displays a message if your target is targeting you. \ No newline at end of file diff --git a/wiki-information/functions/UnitLevel.md b/wiki-information/functions/UnitLevel.md deleted file mode 100644 index 7726ddf1..00000000 --- a/wiki-information/functions/UnitLevel.md +++ /dev/null @@ -1,34 +0,0 @@ -## Title: UnitLevel - -**Content:** -Returns the level of the unit. -`level = UnitLevel(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - For example "player" or "target" - -**Returns:** -- `level` - - *number* - The unit level. Returns -1 for boss units or hostile units 10 levels above the player (Level ??). - -**Description:** -- When calling `UnitLevel("player")` on `PLAYER_LEVEL_UP` it might be incorrect, check the payload instead to be sure. -- When inebriated, the apparent level of hostile units is lowered by up to 5. - -**Related API:** -- `UnitEffectiveLevel` - -**Related Events:** -- `PLAYER_LEVEL_UP` -- `PLAYER_LEVEL_CHANGED` - -**Example Usage:** -```lua -local playerLevel = UnitLevel("player") -print("Player level is: " .. playerLevel) -``` - -**Usage in Addons:** -- **Recount**: Uses `UnitLevel` to determine the level of units for accurate damage and healing statistics. -- **Details! Damage Meter**: Utilizes `UnitLevel` to provide detailed combat logs and performance metrics based on the level of units involved in combat. \ No newline at end of file diff --git a/wiki-information/functions/UnitName.md b/wiki-information/functions/UnitName.md deleted file mode 100644 index aaffbbc1..00000000 --- a/wiki-information/functions/UnitName.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: UnitName - -**Content:** -Returns the name and realm of the unit. -```lua -name, realm = UnitName(unit) -name, realm = UnitFullName(unit) -name, realm = UnitNameUnmodified(unit) -``` - -**Parameters:** -- `unit` - - *string* : UnitId - For example "player" or "target" - -**Returns:** -- `name` - - *string?* - The name of the unit. Returns nil if the unit doesn't exist, e.g. the player has no target selected. -- `realm` - - *string?* - The normalized realm the unit is from, e.g. "DarkmoonFaire". Returns nil if the unit is from the same realm. - -**Description:** -Will return globalstring `UNKNOWNOBJECT` "Unknown Entity" if called before the unit in question has been fully loaded into the world. -The unit name will change if the unit is under the effects of or a similar effect, but `UnitNameUnmodified()` is unaffected by this. - -**Usage:** -Prints your character's name. -```lua -/dump UnitName("player") -- "Leeroy", nil -``` -Prints the name and realm of your target (if different). -```lua -/dump UnitName("target") -- "Thegnome", "DarkmoonFaire" -``` -`UnitFullName()` is equivalent with `UnitName()` except it will always return realm if used with the "player" UnitId. -```lua -/dump UnitFullName("player") -- "Leeroy", "MoonGuard" -/dump UnitFullName("target") -- "Leeroy", nil -``` - -**Miscellaneous:** -`GetUnitName(unit, showServerName)` can return the combined unit and realm name. -- If `showServerName` is true and the queried unit is from a different server, then the return value will include the unit's name appended by a dash and the normalized realm name. -- If `showServerName` is false, then `FOREIGN_SERVER_LABEL` " (*)" will be appended to units from coalesced realms. Units from the player's own realm or Connected Realms get no additional suffix. - -Examples: -- Unit is from the same realm. - ```lua - /dump GetUnitName("target", true) -- "Nephertiri" - /dump GetUnitName("target", false) -- "Nephertiri" - ``` -- Unit is from a different realm but the same Connected Realm (`LE_REALM_RELATION_VIRTUAL`). - ```lua - /dump GetUnitName("target", true) -- "Standron-EarthenRing" - /dump GetUnitName("target", false) -- "Standron" - ``` -- Unit is from a different, non-connected realm (`LE_REALM_RELATION_COALESCED`). - ```lua - /dump GetUnitName("target", true) -- "Celturio-Quel'Thalas" - /dump GetUnitName("target", false) -- "Celturio (*)" - ``` - -**Reference:** -- `Ambiguate()` \ No newline at end of file diff --git a/wiki-information/functions/UnitNameUnmodified.md b/wiki-information/functions/UnitNameUnmodified.md deleted file mode 100644 index aaffbbc1..00000000 --- a/wiki-information/functions/UnitNameUnmodified.md +++ /dev/null @@ -1,63 +0,0 @@ -## Title: UnitName - -**Content:** -Returns the name and realm of the unit. -```lua -name, realm = UnitName(unit) -name, realm = UnitFullName(unit) -name, realm = UnitNameUnmodified(unit) -``` - -**Parameters:** -- `unit` - - *string* : UnitId - For example "player" or "target" - -**Returns:** -- `name` - - *string?* - The name of the unit. Returns nil if the unit doesn't exist, e.g. the player has no target selected. -- `realm` - - *string?* - The normalized realm the unit is from, e.g. "DarkmoonFaire". Returns nil if the unit is from the same realm. - -**Description:** -Will return globalstring `UNKNOWNOBJECT` "Unknown Entity" if called before the unit in question has been fully loaded into the world. -The unit name will change if the unit is under the effects of or a similar effect, but `UnitNameUnmodified()` is unaffected by this. - -**Usage:** -Prints your character's name. -```lua -/dump UnitName("player") -- "Leeroy", nil -``` -Prints the name and realm of your target (if different). -```lua -/dump UnitName("target") -- "Thegnome", "DarkmoonFaire" -``` -`UnitFullName()` is equivalent with `UnitName()` except it will always return realm if used with the "player" UnitId. -```lua -/dump UnitFullName("player") -- "Leeroy", "MoonGuard" -/dump UnitFullName("target") -- "Leeroy", nil -``` - -**Miscellaneous:** -`GetUnitName(unit, showServerName)` can return the combined unit and realm name. -- If `showServerName` is true and the queried unit is from a different server, then the return value will include the unit's name appended by a dash and the normalized realm name. -- If `showServerName` is false, then `FOREIGN_SERVER_LABEL` " (*)" will be appended to units from coalesced realms. Units from the player's own realm or Connected Realms get no additional suffix. - -Examples: -- Unit is from the same realm. - ```lua - /dump GetUnitName("target", true) -- "Nephertiri" - /dump GetUnitName("target", false) -- "Nephertiri" - ``` -- Unit is from a different realm but the same Connected Realm (`LE_REALM_RELATION_VIRTUAL`). - ```lua - /dump GetUnitName("target", true) -- "Standron-EarthenRing" - /dump GetUnitName("target", false) -- "Standron" - ``` -- Unit is from a different, non-connected realm (`LE_REALM_RELATION_COALESCED`). - ```lua - /dump GetUnitName("target", true) -- "Celturio-Quel'Thalas" - /dump GetUnitName("target", false) -- "Celturio (*)" - ``` - -**Reference:** -- `Ambiguate()` \ No newline at end of file diff --git a/wiki-information/functions/UnitOnTaxi.md b/wiki-information/functions/UnitOnTaxi.md deleted file mode 100644 index 9818c43a..00000000 --- a/wiki-information/functions/UnitOnTaxi.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitOnTaxi - -**Content:** -Returns true if the unit is on a flight path. -`onTaxi = UnitOnTaxi(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `onTaxi` - - *boolean* - Whether the unit is on a taxi. \ No newline at end of file diff --git a/wiki-information/functions/UnitPVPName.md b/wiki-information/functions/UnitPVPName.md deleted file mode 100644 index 711928a0..00000000 --- a/wiki-information/functions/UnitPVPName.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: UnitPVPName - -**Content:** -Returns the unit's name with title (e.g. "Bob the Explorer"). -`titleName = UnitPVPName(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit to retrieve the name and title of. - -**Returns:** -- `titleName` - - *string* - The unit's combined title and name, e.g. "Playername, the Insane", or nil if the unit is out of range. - -**Description:** -This function retrieves information about all titles; at the time it was added, titles were exclusively gained through PvP rankings. -Note that `titleName` can be nil if the unit is not currently visible to the client. \ No newline at end of file diff --git a/wiki-information/functions/UnitPVPRank.md b/wiki-information/functions/UnitPVPRank.md deleted file mode 100644 index 95958caa..00000000 --- a/wiki-information/functions/UnitPVPRank.md +++ /dev/null @@ -1,48 +0,0 @@ -## Title: UnitPVPRank - -**Content:** -Returns the specified unit's PvP rank ID. -`rankID = UnitPVPRank(unit)` - -**Parameters:** -- `unit` - - *string* - -**Values:** -Dishonorable ranks like "Pariah" exist but were never used in Vanilla. - -**Rank ID:** -- **Alliance / Horde / Rank Number** - - 0 / 0 / 1 - - Pariah / Pariah / -4 - - Outlaw / Outlaw / -3 - - Exiled / Exiled / -2 - - Dishonored / Dishonored / -1 - - Private / Scout / 1 - - Corporal / Grunt / 2 - - Sergeant / Sergeant / 3 - - Master Sergeant / Senior Sergeant / 4 - - Sergeant Major / First Sergeant / 5 - - Knight / Stone Guard / 6 - - Knight-Lieutenant / Blood Guard / 7 - - Knight-Captain / Legionnaire / 8 - - Knight-Champion / Centurion / 9 - - Lieutenant Commander / Champion / 10 - - Commander / Lieutenant General / 11 - - Marshal / General / 12 - - Field Marshal / Warlord / 13 - - Grand Marshal / High Warlord / 14 - -**Returns:** -- `rankID` - - *number* - Starts at 5 (not at 1) for the first rank. Returns 0 if the unit has no rank. Can be used in `GetPVPRankInfo()` for rank information. - -**Usage:** -```lua -local rankID = UnitPVPRank("target") -local rankName, rankNumber = GetPVPRankInfo(rankID) -if rankName then - print(format("%s is rank ID %d, rank number %d (%s)", UnitName("target"), rankID, rankNumber, rankName)) -end --- Output example: Koribli is rank ID 12, rank number 8 (Knight-Captain) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitPlayerControlled.md b/wiki-information/functions/UnitPlayerControlled.md deleted file mode 100644 index e6bacc8d..00000000 --- a/wiki-information/functions/UnitPlayerControlled.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: UnitPlayerControlled - -**Content:** -Returns true if the unit is controlled by a player. -`UnitIsPlayerControlled = UnitPlayerControlled(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `UnitIsPlayerControlled` - - *boolean* - Returns true if the "unit" is controlled by a player. Returns false if the "unit" is an NPC. - -**Usage:** -```lua -if (UnitPlayerControlled("target")) then - DEFAULT_CHAT_FRAME:AddMessage("Your selected target is a player.", 1, 1, 0) -else - DEFAULT_CHAT_FRAME:AddMessage("Your selected target is an NPC.", 1, 1, 0) -end -``` - -**Example Use Case:** -This function can be used in addons to determine if the player's current target is another player or an NPC. For instance, in PvP-focused addons, this check can be used to apply specific logic or display different information based on whether the target is a player or an NPC. - -**Addons Using This Function:** -Many large addons, such as "Recount" and "Details! Damage Meter," use this function to differentiate between player-controlled units and NPCs when tracking combat statistics and displaying detailed combat logs. \ No newline at end of file diff --git a/wiki-information/functions/UnitPlayerOrPetInParty.md b/wiki-information/functions/UnitPlayerOrPetInParty.md deleted file mode 100644 index 9d35ca46..00000000 --- a/wiki-information/functions/UnitPlayerOrPetInParty.md +++ /dev/null @@ -1,16 +0,0 @@ -## Title: UnitPlayerOrPetInParty - -**Content:** -Returns true if a different unit or pet is a member of the party. -`inMyParty = UnitPlayerOrPetInParty(unit)` - -**Parameters:** -- `unit` - - *string* - The unit to check for party membership. - -**Returns:** -- `inMyParty` - - *boolean* - 1 if the unit is another player or another player's pet in your party, nil otherwise. - -**Description:** -This function returns nil if the unit is the player, or the player's pet. \ No newline at end of file diff --git a/wiki-information/functions/UnitPlayerOrPetInRaid.md b/wiki-information/functions/UnitPlayerOrPetInRaid.md deleted file mode 100644 index fec1722f..00000000 --- a/wiki-information/functions/UnitPlayerOrPetInRaid.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: UnitPlayerOrPetInRaid - -**Content:** -Returns true if a different unit or pet is a member of the raid. -`inRaid = UnitPlayerOrPetInRaid(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `inRaid` - - *boolean* - -**Description:** -Returns nil for player and pet as of 3.0.2 - -**Usage:** -```lua -local TargetInRaid = UnitPlayerOrPetInRaid("target") -local TargetInRaid = UnitPlayerOrPetInRaid("target") -``` - -**Miscellaneous:** -Result: -- `TargetInRaid = 1` - If your target is in your raid group. -- `TargetInRaid = nil` - If your target is not in raid group. \ No newline at end of file diff --git a/wiki-information/functions/UnitPosition.md b/wiki-information/functions/UnitPosition.md deleted file mode 100644 index 88ac12d2..00000000 --- a/wiki-information/functions/UnitPosition.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: UnitPosition - -**Content:** -Returns the position of a unit in the current world area. -`positionX, positionY, positionZ, mapID = UnitPosition(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit for which the position is returned. Does not work with all unit types. Works with "player", "partyN" or "raidN" as unit type. In particular, it does not work on pets or any unit not in your group. - -**Returns:** -- `positionX` - - *number* - Y value of the unit's position in yards, relative to the instance -- `positionY` - - *number* - X value of the unit's position in yards, relative to the instance -- `positionZ` - - *number* - Always 0. A placeholder for the Z coordinate -- `mapID` - - *number* : InstanceID - -**Usage:** -Returns the distance in yards between 2 units in the same raid, or nil if they're not in the same instance or are in a raid/dungeon/competitive instance. -```lua -function ComputeDistance(unit1, unit2) - local y1, x1, _, instance1 = UnitPosition(unit1) - local y2, x2, _, instance2 = UnitPosition(unit2) - return instance1 == instance2 and ((x2 - x1) ^ 2 + (y2 - y1) ^ 2) ^ 0.5 -end -``` -It's important to note that since this number is being measured from the center of the two units, and spell ranges are calculated from the edge of their hitbox, you will need to subtract 3 yards if you're using this function for measuring spell distance between players. \ No newline at end of file diff --git a/wiki-information/functions/UnitPower.md b/wiki-information/functions/UnitPower.md deleted file mode 100644 index 56013c1e..00000000 --- a/wiki-information/functions/UnitPower.md +++ /dev/null @@ -1,69 +0,0 @@ -## Title: UnitPower - -**Content:** -Returns the current power resource of the unit. -`power = UnitPower(unitToken)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `powerType` - - *Enum.PowerType?* - Type of resource (mana/rage/energy/etc) to query -- `unmodified` - - *boolean?* - Return the higher precision internal value (for graphical use only) - -**Values:** -### Enum.PowerType -| Value | Field | Description | -|-------|-------|-------------| -| -2 | HealthCost | | -| -1 | None | | -| 0 | Mana | Mana will range from 0 to the maximum mana a unit has. Player mana pools are of a fixed size for all specializations except Arcane Mages, whose mastery increases their maximum mana. Players naturally regenerate mana at a constant rate dependent on their specialization, both in and out of combat, and some abilities and effects can directly generate mana. This is the default power type for most non-player units, although there are exceptions. | -| 1 | Rage | Rage is used by Warriors and Druids in bear form. Rage ranges from 0 to 100, but may be increased via player talents. Rage is generated by abilities and, for some specializations, taking damage or dealing damage with auto-attacks. Rage will decay to 0 while out of combat. | -| 2 | Focus | Focus is used by Hunters and their pets. Focus ranges from 0 to 100, though this can be increased by spec passives. It has a relatively slow passive regeneration rate, but certain abilities will generate focus directly. | -| 3 | Energy | Energy is used by Rogues, Monks, and Druids in cat form. Energy ranges from 0 to 100, but may be increased via player talents and spec passives. Energy regenerates rapidly. | -| 4 | ComboPoints | Combo Points are used by Rogues and Druids in cat form. Combo Points range from 0 to 5, but can be increased up to 6 by the Rogue talent or to 10 by the Rogue talent. Combo Points are generated by abilities, talents, and passives, and are consumed by Finishing Moves to increase their potency. Combo Points will decay to 0 while out of combat. This value was previously used for hunter pets' happiness, which was deprecated in Cataclysm. | -| 5 | Runes | Runes are used as a power type for Death Knights. Deathknights have 6 runes available. As of , Deathknights no longer have different types of runes, and instead all 6 runes can be used for any ability which consumes them. Up to 3 runes can be regenerating at a time, with the other 3, if depleted, effectively having a recharge time of up to twice the normal rune recharge time. Rune recharge rate can be accelerated through , or runes can be instantly activated by or , as well as a number of talents and set bonuses. | -| 6 | RunicPower | Runic Power is used by Death Knights. Runic Power ranges from 0 to 100, though it can be increased by talents and set bonuses. It is gained by spending runes on abilities, or directly by certain abilities, talents, and passive effects. Runic Power is spent on a limited set of damaging abilities, many of which help regenerate additional runes. Runic Power will decay to 0 while out of combat. | -| 7 | SoulShards | are collected by Warlocks, and range from 0 to 5, represented the number of filled Soul Shards. As of , this resources is now used by all 3 Warlock specializations. Soul Shards will naturally regenerate or decay as needed while out of combat until they reach 3 out of 5 filled. As of Patch 7.2.5, if the "unmodified" boolean argument to UnitPower is provided, the values returned for Soul Shards will range instead from 0 to 50, with each 10 representing a filled Soul Shard. This is to account for the ability of Warlock_talents#Destruction warlocks to generate fractional Soul Shards in increments of 1/10th, similar to how Burning Embers functioned in prior expansions. | -| 8 | LunarPower | Astral Power is used by Druids in moonkin form. Astral power goes from 0 to 100. Astral power will decay to 0 while out of combat. | -| 9 | HolyPower | Holy Power is used by Retribution Paladins. Holy Power ranges from 0 to 5, and will decay to 0 while out of combat. | -| 10 | Alternate | New power type since Cataclysm. Known uses: sound level on Atramedes, corruption level on Cho'gall, consumption level while in Iso'rath. | -| 11 | Maelstrom | The new Shaman resource in Legion, used by both Enhancement and Elemental shamans. Maelstrom ranges from 0 to 100 for Elemental and 0 to 150 for Enhancement, though it can be increased by talents and artifact traits. Maelstrom will decay to 0 while out of combat. | -| 12 | Chi | Chi is used by Windwalker Monks. Chi ranges from 0 to 5, and will decay to 0 while out of combat. | -| 13 | Insanity | Insanity is used by Shadow Priests. Insanity is generated by most Shadow Priest abilities, and will be consumed at an ever-increasing rate while the priest is in , until it reaches 0 and the priest leaves Voidform (or dies horribly if is active). Insanity will decay to 0 while out of combat even if the priests is not in . | -| 14 | Obsolete | Burning Embers were used by Destruction Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 1 to 3 (4 with , representing number of completely filled Burning Embers. If a third argument "true" is included with UnitPower or UnitPowerMax, the value would instead range from 0 to 30 (40 with ), representing the individual segments in each Ember. Each Ember had 10 segments, and most effects that generate Embers generate 1 segment per effect (for example, a cast of Incinerate generates one segment, so 10 casts generates a full Ember). As of , this power type is now obsolete. | -| 15 | Obsolete2 | was used by Demonology Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 0 to 1000. As of , this power type is now obsolete. | -| 16 | ArcaneCharges | Arcane Mage resource. Arcane Charges range from 0 to 5. They are generated by casting and , and consumed by , though a number of abilities benefit from having charges without consuming them. Arcane Charges will decay to 0 while out of combat. | -| 17 | Fury | Havoc Demon Hunter. Fury is generated by , as well as a number of talents, and consumed by most Havoc abilities. Fury ranges from 0 to 100, though artifact traits can increase this to up to 170. Fury will decay to 0 while out of combat. | -| 18 | Pain | Vengeance Demon Hunter. Pain is generated by several Vengeance abilities (ex. , ), and consumed by several others (ex. , ), predominantly for defensive purposes. A small amount of Pain is also generated when the Demon Hunter takes damage. Pain ranges from 0 to 100, and will decay to 0 while out of combat. | -| 19 | Essence | Essence is used by Evokers. It ranges from 0 to 6, and will regenerate passively over time. | -| 20 | RuneBlood | Added in 10.0.0 | -| 21 | RuneFrost | Added in 10.0.0 | -| 22 | RuneUnholy | Added in 10.0.0 | -| 23 | AlternateQuest | Added in 10.1.0 | -| 24 | AlternateEncounter | Added in 10.1.0 | -| 25 | AlternateMount | is used for Dragonriding. It ranges from 0 to a variable maximum of 3-6, depending on dragon traits, and regenerates slowly while grounded, or from effects while flying. | -| 26 | NumPowerTypes | | - -**Returns:** -- `power` - - *number* - the unit's current power level - -**Description:** -If no type is specified, UnitPower returns the current primary type, e.g., energy for a druid in cat form. -You can determine the current primary power type via `UnitPowerType()` - -**Related Events:** -- `UNIT_POWER_UPDATE` -- `UNIT_POWER_FREQUENT` - -**Related API:** -- `UnitPowerType` -- `UnitPowerMax` - -**Usage:** -Prints the current amount of mana for the player. -```lua -/dump UnitPower("player", Enum.PowerType.Mana) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitPowerDisplayMod.md b/wiki-information/functions/UnitPowerDisplayMod.md deleted file mode 100644 index 72bcd3ec..00000000 --- a/wiki-information/functions/UnitPowerDisplayMod.md +++ /dev/null @@ -1,100 +0,0 @@ -## Title: UnitPowerDisplayMod - -**Content:** -Needs summary. -`displayMod = UnitPowerDisplayMod(powerType)` - -**Parameters:** -- `powerType` - - *Enum.PowerType* - - **Value** - - **Field** - - **Description** - - `-2` - - *HealthCost* - - `-1` - - *None* - - `0` - - *Mana* - - Mana will range from 0 to the maximum mana a unit has. Player mana pools are of a fixed size for all specializations except Arcane Mages, whose mastery increases their maximum mana. Players naturally regenerate mana at a constant rate dependent on their specialization, both in and out of combat, and some abilities and effects can directly generate mana. This is the default power type for most non-player units, although there are exceptions. - - `1` - - *Rage* - - Rage is used by Warriors and Druids in bear form. Rage ranges from 0 to 100, but may be increased via player talents. Rage is generated by abilities and, for some specializations, taking damage or dealing damage with auto-attacks. Rage will decay to 0 while out of combat. - - `2` - - *Focus* - - Focus is used by Hunters and their pets. Focus ranges from 0 to 100, though this can be increased by spec passives. It has a relatively slow passive regeneration rate, but certain abilities will generate focus directly. - - `3` - - *Energy* - - Energy is used by Rogues, Monks, and Druids in cat form. Energy ranges from 0 to 100, but may be increased via player talents and spec passives. Energy regenerates rapidly. - - `4` - - *ComboPoints* - - Combo Points are used by Rogues and Druids in cat form. Combo Points range from 0 to 5, but can be increased up to 6 by the Rogue talent or to 10 by the Rogue talent. Combo Points are generated by abilities, talents, and passives, and are consumed by Finishing Moves to increase their potency. Combo Points will decay to 0 while out of combat. This value was previously used for hunter pets' happiness, which was deprecated in Cataclysm. - - `5` - - *Runes* - - Runes are used as a power type for Death Knights. Deathknights have 6 runes available. As of , Deathknights no longer have different types of runes, and instead all 6 runes can be used for any ability which consumes them. Up to 3 runes can be regenerating at a time, with the other 3, if depleted, effectively having a recharge time of up to twice the normal rune recharge time. Rune recharge rate can be accelerated through , or runes can be instantly activated by or , as well as a number of talents and set bonuses. - - `6` - - *RunicPower* - - Runic Power is used by Death Knights. Runic Power ranges from 0 to 100, though it can be increased by talents and set bonuses. It is gained by spending runes on abilities, or directly by certain abilities, talents, and passive effects. Runic Power is spent on a limited set of damaging abilities, many of which help regenerate additional runes. Runic Power will decay to 0 while out of combat. - - `7` - - *SoulShards* - - are collected by Warlocks, and range from 0 to 5, represented the number of filled Soul Shards. As of , this resources is now used by all 3 Warlock specializations. Soul Shards will naturally regenerate or decay as needed while out of combat until they reach 3 out of 5 filled. As of Patch 7.2.5, if the "unmodified" boolean argument to UnitPower is provided, the values returned for Soul Shards will range instead from 0 to 50, with each 10 representing a filled Soul Shard. This is to account for the ability of Warlock_talents#Destruction warlocks to generate fractional Soul Shards in increments of 1/10th, similar to how Burning Embers functioned in prior expansions. - - `8` - - *LunarPower* - - Astral Power is used by Druids in moonkin form. Astral power goes from 0 to 100. Astral power will decay to 0 while out of combat. - - `9` - - *HolyPower* - - Holy Power is used by Retribution Paladins. Holy Power ranges from 0 to 5, and will decay to 0 while out of combat. - - `10` - - *Alternate* - - New power type since Cataclysm. Known uses: sound level on Atramedes, corruption level on Cho'gall, consumption level while in Iso'rath. - - `11` - - *Maelstrom* - - The new Shaman resource in Legion, used by both Enhancement and Elemental shamans. Maelstrom ranges from 0 to 100 for Elemental and 0 to 150 for Enhancement, though it can be increased by talents and artifact traits. Maelstrom will decay to 0 while out of combat. - - `12` - - *Chi* - - Chi is used by Windwalker Monks. Chi ranges from 0 to 5, and will decay to 0 while out of combat. - - `13` - - *Insanity* - - Insanity is used by Shadow Priests. Insanity is generated by most Shadow Priest abilities, and will be consumed at an ever-increasing rate while the priest is in , until it reaches 0 and the priest leaves Voidform (or dies horribly if is active). Insanity will decay to 0 while out of combat even if the priests is not in . - - `14` - - *Obsolete* - - Burning Embers were used by Destruction Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 1 to 3 (4 with , representing number of completely filled Burning Embers. If a third argument "true" is included with UnitPower or UnitPowerMax, the value would instead range from 0 to 30 (40 with ), representing the individual segments in each Ember. Each Ember had 10 segments, and most effects that generate Embers generate 1 segment per effect (for example, a cast of Incinerate generates one segment, so 10 casts generates a full Ember). As of , this power type is now obsolete. - - `15` - - *Obsolete2* - - was used by Demonology Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 0 to 1000. As of , this power type is now obsolete. - - `16` - - *ArcaneCharges* - - Arcane Mage resource. Arcane Charges range from 0 to 5. They are generated by casting and , and consumed by , though a number of abilities benefit from having charges without consuming them. Arcane Charges will decay to 0 while out of combat. - - `17` - - *Fury* - - Havoc Demon Hunter. Fury is generated by , as well as a number of talents, and consumed by most Havoc abilities. Fury ranges from 0 to 100, though artifact traits can increase this to up to 170. Fury will decay to 0 while out of combat. - - `18` - - *Pain* - - Vengeance Demon Hunter. Pain is generated by several Vengeance abilities (ex. , ), and consumed by several others (ex. , ), predominantly for defensive purposes. A small amount of Pain is also generated when the Demon Hunter takes damage. Pain ranges from 0 to 100, and will decay to 0 while out of combat. - - `19` - - *Essence* - - Essence is used by Evokers. It ranges from 0 to 6, and will regenerate passively over time. - - `20` - - *RuneBlood* - - Added in 10.0.0 - - `21` - - *RuneFrost* - - Added in 10.0.0 - - `22` - - *RuneUnholy* - - Added in 10.0.0 - - `23` - - *AlternateQuest* - - Added in 10.1.0 - - `24` - - *AlternateEncounter* - - Added in 10.1.0 - - `25` - - *AlternateMount* - - is used for Dragonriding. It ranges from 0 to a variable maximum of 3-6, depending on dragon traits, and regenerates slowly while grounded, or from effects while flying. - - `26` - - *NumPowerTypes* - -**Returns:** -- `displayMod` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/UnitPowerMax.md b/wiki-information/functions/UnitPowerMax.md deleted file mode 100644 index b054281c..00000000 --- a/wiki-information/functions/UnitPowerMax.md +++ /dev/null @@ -1,116 +0,0 @@ -## Title: UnitPowerMax - -**Content:** -Returns the maximum power resource of the unit. -`maxPower = UnitPowerMax(unitToken)` - -**Parameters:** -- `unitToken` - - *string* : UnitId -- `powerType` - - *Enum.PowerType?* - Type of resource (mana/rage/energy/etc) to query -- `unmodified` - - *boolean?* - Return the higher precision internal value (for graphical use only) - -**Enum.PowerType:** -- `Value` -- `Field` -- `Description` - - `-2` - - HealthCost - - `-1` - - None - - `0` - - Mana - - Mana will range from 0 to the maximum mana a unit has. Player mana pools are of a fixed size for all specializations except Arcane Mages, whose mastery increases their maximum mana. Players naturally regenerate mana at a constant rate dependent on their specialization, both in and out of combat, and some abilities and effects can directly generate mana. This is the default power type for most non-player units, although there are exceptions. - - `1` - - Rage - - Rage is used by Warriors and Druids in bear form. Rage ranges from 0 to 100, but may be increased via player talents. Rage is generated by abilities and, for some specializations, taking damage or dealing damage with auto-attacks. Rage will decay to 0 while out of combat. - - `2` - - Focus - - Focus is used by Hunters and their pets. Focus ranges from 0 to 100, though this can be increased by spec passives. It has a relatively slow passive regeneration rate, but certain abilities will generate focus directly. - - `3` - - Energy - - Energy is used by Rogues, Monks, and Druids in cat form. Energy ranges from 0 to 100, but may be increased via player talents and spec passives. Energy regenerates rapidly. - - `4` - - ComboPoints - - Combo Points are used by Rogues and Druids in cat form. Combo Points range from 0 to 5, but can be increased up to 6 by the Rogue talent or to 10 by the Rogue talent. Combo Points are generated by abilities, talents, and passives, and are consumed by Finishing Moves to increase their potency. Combo Points will decay to 0 while out of combat. This value was previously used for hunter pets' happiness, which was deprecated in Cataclysm. - - `5` - - Runes - - Runes are used as a power type for Death Knights. Deathknights have 6 runes available. As of , Deathknights no longer have different types of runes, and instead all 6 runes can be used for any ability which consumes them. Up to 3 runes can be regenerating at a time, with the other 3, if depleted, effectively having a recharge time of up to twice the normal rune recharge time. Rune recharge rate can be accelerated through , or runes can be instantly activated by or , as well as a number of talents and set bonuses. - - `6` - - RunicPower - - Runic Power is used by Death Knights. Runic Power ranges from 0 to 100, though it can be increased by talents and set bonuses. It is gained by spending runes on abilities, or directly by certain abilities, talents, and passive effects. Runic Power is spent on a limited set of damaging abilities, many of which help regenerate additional runes. Runic Power will decay to 0 while out of combat. - - `7` - - SoulShards - - are collected by Warlocks, and range from 0 to 5, represented the number of filled Soul Shards. As of , this resources is now used by all 3 Warlock specializations. Soul Shards will naturally regenerate or decay as needed while out of combat until they reach 3 out of 5 filled. As of Patch 7.2.5, if the "unmodified" boolean argument to UnitPower is provided, the values returned for Soul Shards will range instead from 0 to 50, with each 10 representing a filled Soul Shard. This is to account for the ability of Warlock_talents#Destruction warlocks to generate fractional Soul Shards in increments of 1/10th, similar to how Burning Embers functioned in prior expansions. - - `8` - - LunarPower - - Astral Power is used by Druids in moonkin form. Astral power goes from 0 to 100. Astral power will decay to 0 while out of combat. - - `9` - - HolyPower - - Holy Power is used by Retribution Paladins. Holy Power ranges from 0 to 5, and will decay to 0 while out of combat. - - `10` - - Alternate - - New power type since Cataclysm. Known uses: sound level on Atramedes, corruption level on Cho'gall, consumption level while in Iso'rath. - - `11` - - Maelstrom - - The new Shaman resource in Legion, used by both Enhancement and Elemental shamans. Maelstrom ranges from 0 to 100 for Elemental and 0 to 150 for Enhancement, though it can be increased by talents and artifact traits. Maelstrom will decay to 0 while out of combat. - - `12` - - Chi - - Chi is used by Windwalker Monks. Chi ranges from 0 to 5, and will decay to 0 while out of combat. - - `13` - - Insanity - - Insanity is used by Shadow Priests. Insanity is generated by most Shadow Priest abilities, and will be consumed at an ever-increasing rate while the priest is in , until it reaches 0 and the priest leaves Voidform (or dies horribly if is active). Insanity will decay to 0 while out of combat even if the priests is not in . - - `14` - - Obsolete - - Burning Embers were used by Destruction Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 1 to 3 (4 with , representing number of completely filled Burning Embers. If a third argument "true" is included with UnitPower or UnitPowerMax, the value would instead range from 0 to 30 (40 with ), representing the individual segments in each Ember. Each Ember had 10 segments, and most effects that generate Embers generate 1 segment per effect (for example, a cast of Incinerate generates one segment, so 10 casts generates a full Ember). As of , this power type is now obsolete. - - `15` - - Obsolete2 - - was used by Demonology Warlocks prior to , which consolidated all warlock specs to use . Value returned would range from 0 to 1000. As of , this power type is now obsolete. - - `16` - - ArcaneCharges - - Arcane Mage resource. Arcane Charges range from 0 to 5. They are generated by casting and , and consumed by , though a number of abilities benefit from having charges without consuming them. Arcane Charges will decay to 0 while out of combat. - - `17` - - Fury - - Havoc Demon Hunter. Fury is generated by , as well as a number of talents, and consumed by most Havoc abilities. Fury ranges from 0 to 100, though artifact traits can increase this to up to 170. Fury will decay to 0 while out of combat. - - `18` - - Pain - - Vengeance Demon Hunter. Pain is generated by several Vengeance abilities (ex. , ), and consumed by several others (ex. , ), predominantly for defensive purposes. A small amount of Pain is also generated when the Demon Hunter takes damage. Pain ranges from 0 to 100, and will decay to 0 while out of combat. - - `19` - - Essence - - Essence is used by Evokers. It ranges from 0 to 6, and will regenerate passively over time. - - `20` - - RuneBlood - - Added in 10.0.0 - - `21` - - RuneFrost - - Added in 10.0.0 - - `22` - - RuneUnholy - - Added in 10.0.0 - - `23` - - AlternateQuest - - Added in 10.1.0 - - `24` - - AlternateEncounter - - Added in 10.1.0 - - `25` - - AlternateMount - - is used for Dragonriding. It ranges from 0 to a variable maximum of 3-6, depending on dragon traits, and regenerates slowly while grounded, or from effects while flying. - - `26` - - NumPowerTypes - -**Returns:** -- `maxPower` - - *number* - The unit's maximum amount of the queried resource. - -**Description:** -If no type is specified, UnitPowerMax returns the current primary type, e.g., energy for a druid in cat form. -You can determine the current primary power type via UnitPowerType() - -**Usage:** -Prints the maximum amount of mana for the player. -```lua -/dump UnitPowerMax("player", Enum.PowerType.Mana) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitPowerType.md b/wiki-information/functions/UnitPowerType.md deleted file mode 100644 index 3b7be531..00000000 --- a/wiki-information/functions/UnitPowerType.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: UnitPowerType - -**Content:** -Returns a number corresponding to the power type (e.g., mana, rage, or energy) of the specified unit. -`powerType, powerTypeToken, rgbX, rgbY, rgbZ = UnitPowerType(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit whose power type to query. -- `index` - - *number?* = 0 - Optional value for classes with multiple powerTypes. If not specified, information about the first (currently active) power type will be returned. - -**Returns:** -- `powerType` - - *Enum.PowerType* - the ID corresponding to the unit's queried power type. -- `powerToken` - - *string* - also the power type: - - "MANA" - - "RAGE" - - "FOCUS" - - "ENERGY" - - "HAPPINESS" - - "RUNES" - - "RUNIC_POWER" - - "SOUL_SHARDS" - - "ECLIPSE" - - "HOLY_POWER" - - "AMMOSLOT" (vehicles, 3.1) - - "FUEL" (vehicles, 3.1) - - "STAGGER" (vehicles, 5.1) - - "CHI" - - "INSANITY" - - "ARCANE_CHARGES" - - "FURY" - - "PAIN" -- `rgbX` - - *number* - Alternative red component for this power type, see details. Nil for most of the standard power types. -- `rgbY` - - *number* - Alternative green component for this power type, see details. Nil for most of the standard power types. -- `rgbZ` - - *number* - Alternative blue component for this power type, see details. Nil for most of the standard power types. - -**Usage:** -The following snippet displays the player's current mana/rage/energy/etc in the default chat frame. -```lua -local t = { [0] = "mana", [1] = "rage", [2] = "focus", [3] = "energy", [4] = "happiness", [5] = "runes", [6] = "runic power", [7] = "soul shards", [8] = "eclipse", [9] = "holy power"} -print(UnitName("player") .. "'s " .. t[UnitPowerType("player")] .. ": " .. UnitPower("player")) -``` - -**Description:** -Colors of all typical power types are stored in the `PowerBarColor` global table. Some special types may implement their own color as returned by the 3rd to 5th return values of `UnitPowerType`. For most of the standard power types, they return nil however. FrameXML implements it the following way (with a fallback to "MANA"): -```lua -local powerType, powerToken, altR, altG, altB = UnitPowerType(UnitId); -local info = PowerBarColor[powerToken]; - -if ( info ) then - -- The PowerBarColor takes priority - r, g, b = info.r, info.g, info.b; -elseif ( not altR ) then - -- Couldn't find a power token entry. Default to indexing by power type or just mana if we don't have that either. - info = PowerBarColor[powerType] or PowerBarColor["MANA"]; - r, g, b = info.r, info.g, info.b; -else - r, g, b = altR, altG, altB; -end -``` - -**Reference:** -- `UnitPower` -- `UnitPowerMax` \ No newline at end of file diff --git a/wiki-information/functions/UnitRace.md b/wiki-information/functions/UnitRace.md deleted file mode 100644 index 1a1f323e..00000000 --- a/wiki-information/functions/UnitRace.md +++ /dev/null @@ -1,73 +0,0 @@ -## Title: UnitRace - -**Content:** -Returns the race of the unit. -`localizedRaceName, englishRaceName, raceID = UnitRace(name)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Values:** -The table below lists observed race IDs alongside the race name and the locale-independent string identifier for the race ("clientFileString"). -Note: This list is up to date as of patch 9.0.1 - -| ID | Race.raceName (enUS) | Race.clientFileString | Faction.name (enUS) | Faction.groupTag | -|-----|-----------------------|-----------------------|---------------------|------------------| -| 1 | Human | Human | Alliance | Alliance | -| 2 | Orc | Orc | Horde | Horde | -| 3 | Dwarf | Dwarf | Alliance | Alliance | -| 4 | Night Elf | NightElf | Alliance | Alliance | -| 5 | Undead | Scourge | Horde | Horde | -| 6 | Tauren | Tauren | Horde | Horde | -| 7 | Gnome | Gnome | Alliance | Alliance | -| 8 | Troll | Troll | Horde | Horde | -| 9 | Goblin | Goblin | Horde | Horde | -| 10 | Blood Elf | BloodElf | Horde | Horde | -| 11 | Draenei | Draenei | Alliance | Alliance | -| 12 | Fel Orc | FelOrc | Alliance | Alliance | -| 13 | Naga | Naga_ | Alliance | Alliance | -| 14 | Broken | Broken | Alliance | Alliance | -| 15 | Skeleton | Skeleton | Alliance | Alliance | -| 16 | Vrykul | Vrykul | Alliance | Alliance | -| 17 | Tuskarr | Tuskarr | Alliance | Alliance | -| 18 | Forest Troll | ForestTroll | Alliance | Alliance | -| 19 | Taunka | Taunka | Alliance | Alliance | -| 20 | Northrend Skeleton | NorthrendSkeleton | Alliance | Alliance | -| 21 | Ice Troll | IceTroll | Alliance | Alliance | -| 22 | Worgen | Worgen | Alliance | Alliance | -| 23 | Gilnean | Human | Alliance | Alliance | -| 24 | Pandaren | Pandaren | Neutral | | -| 25 | Pandaren | Pandaren | Alliance | Alliance | -| 26 | Pandaren | Pandaren | Horde | Horde | -| 27 | Nightborne | Nightborne | Horde | Horde | -| 28 | Highmountain Tauren | HighmountainTauren | Horde | Horde | -| 29 | Void Elf | VoidElf | Alliance | Alliance | -| 30 | Lightforged Draenei | LightforgedDraenei | Alliance | Alliance | -| 31 | Zandalari Troll | ZandalariTroll | Horde | Horde | -| 32 | Kul Tiran | KulTiran | Alliance | Alliance | -| 33 | Human | ThinHuman | Alliance | Alliance | -| 34 | Dark Iron Dwarf | DarkIronDwarf | Alliance | Alliance | -| 35 | Vulpera | Vulpera | Horde | Horde | -| 36 | Mag'har Orc | MagharOrc | Horde | Horde | -| 37 | Mechagnome | Mechagnome | Alliance | Alliance | -| 52 | Dracthyr | Dracthyr | Alliance | Alliance | -| 70 | Dracthyr | Dracthyr | Horde | Horde | - -**Returns:** -- `localizedRaceName` - - *string* - Localized race name, suitable for use in user interfaces. -- `englishRaceName` - - *string* - Localization-independent race name, suitable for use as table keys. -- `raceID` - - *number* - RaceId. Localization-independent raceID. - -**Usage:** -The following command prints your character's name and race to chat: -```lua -/run print(UnitName("player").." is a "..UnitRace("player")) -``` - -**Reference:** -- `UnitClass()` -- `C_CreatureInfo.GetRaceInfo()` \ No newline at end of file diff --git a/wiki-information/functions/UnitRangedAttack.md b/wiki-information/functions/UnitRangedAttack.md deleted file mode 100644 index d22c94e1..00000000 --- a/wiki-information/functions/UnitRangedAttack.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: UnitRangedAttack - -**Content:** -Returns the unit's ranged attack and modifier. -`base, modifier = UnitRangedAttack(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - Likely only works for "player" and "pet" - -**Returns:** -- `base` - - *number* - The unit's base ranged attack number (0 if no ranged weapon is equipped) -- `modifier` - - *number* - The total effect of all modifiers (positive and negative) to ranged attack. - -**Usage:** -```lua -local base, modifier = UnitRangedAttack("player"); -local effective = base + modifier; -message(effective); -``` - -**Miscellaneous:** -Result: -Displays a message containing your effective ranged attack skill (Weapon Skill). \ No newline at end of file diff --git a/wiki-information/functions/UnitRangedAttackPower.md b/wiki-information/functions/UnitRangedAttackPower.md deleted file mode 100644 index f2c1482a..00000000 --- a/wiki-information/functions/UnitRangedAttackPower.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: UnitRangedAttackPower - -**Content:** -Returns the ranged attack power of the unit. -`attackPower, posBuff, negBuff = UnitRangedAttackPower(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - Likely only works for "player" and "pet" - -**Returns:** -- `attackPower` - - *number* - The unit's base ranged attack power (seems to give a positive number even if no ranged weapon equipped) -- `posBuff` - - *number* - The total effect of positive buffs to ranged attack power. -- `negBuff` - - *number* - The total effect of negative buffs to the ranged attack power (a negative number) - -**Usage:** -Shows your current ranged attack power. -```lua -local base, posBuff, negBuff = UnitRangedAttackPower("player"); -local effective = base + posBuff + negBuff; -print("Your current ranged attack power: " .. effective); -``` \ No newline at end of file diff --git a/wiki-information/functions/UnitRangedDamage.md b/wiki-information/functions/UnitRangedDamage.md deleted file mode 100644 index ba345bae..00000000 --- a/wiki-information/functions/UnitRangedDamage.md +++ /dev/null @@ -1,37 +0,0 @@ -## Title: UnitRangedDamage - -**Content:** -Returns the ranged attack speed and damage of the unit. -`speed, minDamage, maxDamage, posBuff, negBuff, percent = UnitRangedDamage(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit to get information from. (Likely only works for "player" and "pet" -- unconfirmed) - -**Returns:** -- `speed` - - *number* - The unit's ranged weapon speed (0 if no ranged weapon equipped). -- `minDamage` - - *number* - The unit's minimum ranged damage. -- `maxDamage` - - *number* - The unit's maximum ranged damage. -- `posBuff` - - *number* - The unit's positive Bonus on ranged attacks (includes Spelldamage increases) -- `negBuff` - - *number* - The unit's negative Bonus on ranged attacks -- `percent` - - *number* - percentage modifier (usually 1) - -**Usage:** -Calculates your average damage per second. -```lua -local speed, lowDmg, hiDmg = UnitRangedDamage("player"); -local avgDmg = (lowDmg + hiDmg) / 2; -local avgDps = avgDmg / speed; -``` - -**Example Use Case:** -This function can be used to calculate the average damage per second (DPS) for a player's ranged weapon. This is particularly useful for hunters or any class that relies on ranged attacks to optimize their damage output. - -**Addons:** -Large addons like Recount or Details! Damage Meter might use this function to provide detailed statistics on a player's ranged damage output, helping players to analyze and improve their performance in combat. \ No newline at end of file diff --git a/wiki-information/functions/UnitReaction.md b/wiki-information/functions/UnitReaction.md deleted file mode 100644 index bdc197c7..00000000 --- a/wiki-information/functions/UnitReaction.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: UnitReaction - -**Content:** -Returns the reaction of the specified unit to another unit. -`reaction = UnitReaction(unit, otherUnit)` - -**Parameters:** -- `unit` - - *string* : UnitId -- `otherUnit` - - *string* : UnitId - The unit to compare with the first unit. - -**Returns:** -- `reaction` - - *number* - the level of the reaction of unit towards otherUnit - this is a number between 1 and 8. - - Hated - - Hostile - - Unfriendly - - Neutral - - Friendly - - Honored - - Revered - - Exalted - - Values other than 2, 4, or 5 are only returned when the first unit is an NPC in a reputation faction and the second is you or your pet. - -**Description:** -This works even with factions that aren't listed in the reputation tab of your character window or Armory profile. -When you're Horde, the reaction of Alliance reputation-faction NPCs to you and your pet is 1. The same is true of Horde NPCs if you're Alliance. -Reaction of and to a pet is the same as for its owner. -This doesn't change when a mob becomes aggressive towards a player. I had to use the negative result of API UnitIsFriend. -Does not work across continents (or zones?)! If you query UnitReaction for a raid (or party)-member across continents, it won't return the correct value (I guess it returns nil, but I have yet to confirm that). I think it only returns correct values for units that are in 'inspect-range'. -In Blizzard Code, UnitReaction is only used between the player and a Non Player Controlled target. \ No newline at end of file diff --git a/wiki-information/functions/UnitRealmRelationship.md b/wiki-information/functions/UnitRealmRelationship.md deleted file mode 100644 index dd3c1298..00000000 --- a/wiki-information/functions/UnitRealmRelationship.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitRealmRelationship - -**Content:** -Returns information about the player's relation to the specified unit's realm. -`realmRelationship = UnitRealmRelationship(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `realmRelationship` - - *number* - if the specified unit is a player, one of: - - `LE_REALM_RELATION_SAME = 1` - unit and player are from the same realm. - - `LE_REALM_RELATION_COALESCED = 2` - unit and player are coalesced from unconnected realms. - - `LE_REALM_RELATION_VIRTUAL = 3` - unit and player are from Connected Realms. - -**Reference:** -`UnitName` \ No newline at end of file diff --git a/wiki-information/functions/UnitResistance.md b/wiki-information/functions/UnitResistance.md deleted file mode 100644 index e0f8fed9..00000000 --- a/wiki-information/functions/UnitResistance.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: UnitResistance - -**Content:** -Gets information about a unit's resistance. -`base, total, bonus, minus = UnitResistance(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - The unit to check -- `resistanceIndex` - - *number* - The index of the resistance type to check - - `0` - (Physical) - Armor rating - - `1` - (Holy) - - `2` - (Fire) - - `3` - (Nature) - - `4` - (Frost) - - `5` - (Shadow) - - `6` - (Arcane) - -**Returns:** -- `base` - - *number* - The base resistance -- `total` - - *number* - The current total value after all modifiers -- `bonus` - - *number* - The bonus resistance modifier total from gear and buffs -- `minus` - - *number* - The negative resistance modifier total from gear and buffs - -**Usage:** -```lua -/script SendChatMessage("My base armor is " .. UnitResistance("player", 0)); -/script _, total, _, _ = UnitResistance("player", 0); SendChatMessage("My total armor is " .. total); -``` - -**Example Use Case:** -This function can be used to display a player's resistance values in the chat, which can be useful for debugging or sharing information with other players. - -**Addons:** -Many large addons, such as ElvUI and WeakAuras, use this function to display or track resistance values for various purposes, including creating custom UI elements or triggering alerts based on resistance thresholds. \ No newline at end of file diff --git a/wiki-information/functions/UnitSelectionColor.md b/wiki-information/functions/UnitSelectionColor.md deleted file mode 100644 index 8a1a7812..00000000 --- a/wiki-information/functions/UnitSelectionColor.md +++ /dev/null @@ -1,30 +0,0 @@ -## Title: UnitSelectionColor - -**Content:** -Returns the color of the outline and circle underneath the unit. -`red, green, blue, alpha = UnitSelectionColor(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The unit whose selection color should be returned. -- `useExtendedColors` - - *boolean? = false* - If true, a more appropriate color of the unit's selection will be returned. For instance, if used on a dead hostile target, the default return will be red (hostile), but the extended return will be grey (dead). - -**Returns:** -- `red` - - *number* - A number between 0 and 1. -- `green` - - *number* - A number between 0 and 1. -- `blue` - - *number* - A number between 0 and 1. -- `alpha` - - *number* - A number between 0 and 1. - -**Usage:** -```lua -0, 0, 0.99999779462814, 0.99999779462814 = UnitSelectionColor("player") -0, 0.99999779462814, 0, 0.99999779462814 = UnitSelectionColor("target") -- a friendly npc in target -``` - -**Reference:** -API UnitSelectionType \ No newline at end of file diff --git a/wiki-information/functions/UnitSetRole.md b/wiki-information/functions/UnitSetRole.md deleted file mode 100644 index cac87409..00000000 --- a/wiki-information/functions/UnitSetRole.md +++ /dev/null @@ -1,18 +0,0 @@ -## Title: UnitSetRole - -**Content:** -Sets a unit's role in the group. -`result = UnitSetRole(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken -- `roleStr` - - *string?* : - -**Returns:** -- `result` - - *boolean* - -**Description:** -It's not possible to assign roles to classes that are not capable of fulfilling that role. \ No newline at end of file diff --git a/wiki-information/functions/UnitSex.md b/wiki-information/functions/UnitSex.md deleted file mode 100644 index 9d7cbf02..00000000 --- a/wiki-information/functions/UnitSex.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: UnitSex - -**Content:** -Returns the gender of the unit. -`gender = UnitSex(unit)` - -**Parameters:** -- `unit` - - *string* : UnitId - -**Returns:** -- `sex` - - *number?* - - **ID** - **Gender** - - 1 - Neutrum / Unknown - - 2 - Male - - 3 - Female - -**Usage:** -```lua -local genders = {"unknown", "male", "female"} -if UnitExists("target") then - print("The target is " .. genders[UnitSex("target")]) -end -``` - -**Description:** -Most non-humanoid mobs/creatures will appear as Neutrum/Unknown. -Player characters currently appear as either Male or Female. - -**Reference:** -- `C_PlayerInfo.GetSex()` \ No newline at end of file diff --git a/wiki-information/functions/UnitShouldDisplayName.md b/wiki-information/functions/UnitShouldDisplayName.md deleted file mode 100644 index 43ca46f9..00000000 --- a/wiki-information/functions/UnitShouldDisplayName.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitShouldDisplayName - -**Content:** -Needs summary. -`shouldDisplay = UnitShouldDisplayName(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `shouldDisplay` - - *boolean* - -**Example Usage:** -This function can be used to determine if a unit's name should be displayed in the game. For instance, it can be useful in custom nameplate addons to decide whether to show or hide the name of a unit based on certain conditions. - -**Addons:** -Many nameplate addons, such as "TidyPlates" and "Plater", might use this function to enhance the customization of nameplate displays based on user settings or specific in-game conditions. \ No newline at end of file diff --git a/wiki-information/functions/UnitStat.md b/wiki-information/functions/UnitStat.md deleted file mode 100644 index b0d5b097..00000000 --- a/wiki-information/functions/UnitStat.md +++ /dev/null @@ -1,40 +0,0 @@ -## Title: UnitStat - -**Content:** -Returns the basic attributes for a unit (strength, agility, stamina, intellect). -`currentStat, effectiveStat, statPositiveBuff, statNegativeBuff = UnitStat(unit, statID)` - -**Parameters:** -- `unit` - - *string* : UnitToken - Only works for "player" and "pet". Will work on "target" as long as it is equal to "player". -- `statID` - - *number* - An internal id corresponding to one of the stats. - - 1: `LE_UNIT_STAT_STRENGTH` - - 2: `LE_UNIT_STAT_AGILITY` - - 3: `LE_UNIT_STAT_STAMINA` - - 4: `LE_UNIT_STAT_INTELLECT` - - 5: `LE_UNIT_STAT_SPIRIT` (not available anymore in 9.0.5) - -**Returns:** -- `currentStat` - - *number* - The unit's stat. Seems to always return the same as effectiveStat, regardless of values of pos/negBuff. -- `effectiveStat` - - *number* - The unit's current stat, as displayed in the paper doll frame. -- `statPositiveBuff` - - *number* - Any positive buffs applied to the stat, including gear. -- `statNegativeBuff` - - *number* - Any negative buffs applied to the stat. - -**Usage:** -Shows your current strength. -```lua -local stat, effectiveStat, posBuff, negBuff = UnitStat("player", 1); -DEFAULT_CHAT_FRAME:AddMessage("Your current Strength is " .. stat); -``` - -**Example Use Case:** -This function can be used in addons that need to display or manipulate the player's stats. For example, an addon that provides detailed character statistics or a custom UI element showing the player's current attributes. - -**Addons Using This Function:** -- **ElvUI**: A popular UI overhaul addon that uses `UnitStat` to display character stats in its custom character frame. -- **Details! Damage Meter**: Uses `UnitStat` to provide detailed breakdowns of player performance, including how stats affect damage output. \ No newline at end of file diff --git a/wiki-information/functions/UnitSwitchToVehicleSeat.md b/wiki-information/functions/UnitSwitchToVehicleSeat.md deleted file mode 100644 index 8177ea45..00000000 --- a/wiki-information/functions/UnitSwitchToVehicleSeat.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: UnitSwitchToVehicleSeat - -**Content:** -Needs summary. -`UnitSwitchToVehicleSeat(unit, virtualSeatIndex)` - -**Parameters:** -- `unit` - - *string* : UnitToken -- `virtualSeatIndex` - - *number* - -**Example Usage:** -This function can be used to switch a unit to a different seat in a multi-passenger vehicle. For instance, in a battleground or raid scenario where players are using a vehicle with multiple seats, this function can be called to move a player from one seat to another. - -**Addons:** -Large addons like Deadly Boss Mods (DBM) or ElvUI might use this function to manage vehicle seats during encounters or to provide better UI management for vehicle-based mechanics. \ No newline at end of file diff --git a/wiki-information/functions/UnitTargetsVehicleInRaidUI.md b/wiki-information/functions/UnitTargetsVehicleInRaidUI.md deleted file mode 100644 index fec9fda9..00000000 --- a/wiki-information/functions/UnitTargetsVehicleInRaidUI.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitTargetsVehicleInRaidUI - -**Content:** -Needs summary. -`targetsVehicle = UnitTargetsVehicleInRaidUI()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `targetsVehicle` - - *boolean* - -**Example Usage:** -This function can be used to determine if a specific unit is targeting a vehicle in the raid UI. This can be particularly useful in raid encounters where managing vehicle control is crucial. - -**Addon Usage:** -Large addons like Deadly Boss Mods (DBM) might use this function to track vehicle targeting during complex raid encounters to provide timely alerts and warnings to players. \ No newline at end of file diff --git a/wiki-information/functions/UnitThreatPercentageOfLead.md b/wiki-information/functions/UnitThreatPercentageOfLead.md deleted file mode 100644 index 27250c6c..00000000 --- a/wiki-information/functions/UnitThreatPercentageOfLead.md +++ /dev/null @@ -1,25 +0,0 @@ -## Title: UnitThreatPercentageOfLead - -**Content:** -Needs summary. -`percentage = UnitThreatPercentageOfLead(unit, mobGUID)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The player or pet whose threat to request. -- `mobGUID` - - *string* : UnitToken - The NPC whose threat table to query. - -**Returns:** -- `percentage` - - *number* - -**Reference:** -- `UnitDetailedThreatSituation()` -- `threatShowNumeric` - -**Example Usage:** -This function can be used to determine the threat percentage of a player or pet relative to the lead threat holder on a specific NPC. This is particularly useful in raid and dungeon scenarios to manage aggro and ensure that tanks maintain threat over DPS players. - -**Addon Usage:** -Large addons like **ThreatClassic2** use this function to provide detailed threat meters for players, helping them manage their threat levels during encounters. This is crucial for maintaining proper aggro distribution and preventing DPS players from pulling threat off the tank. \ No newline at end of file diff --git a/wiki-information/functions/UnitThreatSituation.md b/wiki-information/functions/UnitThreatSituation.md deleted file mode 100644 index e3d1b523..00000000 --- a/wiki-information/functions/UnitThreatSituation.md +++ /dev/null @@ -1,70 +0,0 @@ -## Title: UnitThreatSituation - -**Content:** -Returns the threat status of the specified unit to another unit. -`status = UnitThreatSituation(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - The player or pet whose threat to request. -- `mobGUID` - - *string?* : UnitToken - The NPC whose threat table to query. - - If omitted, returned values reflect whichever NPC unit the player unit has the highest threat against. - -**Returns:** -- `status` - - *number?* - The threat status of the unit on the mobUnit. "High threat" means a unit has 100% threat or higher, "Primary Target" means the unit is the current target of the mob. - - `Value` - - `High Threat` - - `Primary Target` - - `Description` - - `nil` - - Unit is not on (any) mobUnit's threat table. - - `0` - - ❌ - - ❌ - - Unit has less than 100% threat for mobUnit. The default UI shows no indicator. - - `1` - - ✅ - - ❌ - - Unit has higher than 100% threat for mobUnit, but isn't the primary target. The default UI shows a yellow indicator. - - `2` - - ❌ - - ✅ - - Unit is the primary target for mobUnit, but another unit has higher than 100% threat. The default UI shows an orange indicator. - - `3` - - ✅ - - ✅ - - Unit is the primary target for mobUnit and no other unit has higher than 100% threat. The default UI shows a red indicator. - -**Description:** -Threat information for a pair of unit and mobUnit is only returned if the unit has threat against the mobUnit in question. In addition, no threat data is provided if a unit's pet is attacking an NPC but the unit himself has taken no action, even though the pet has threat against the NPC. - -**Usage:** -Prints your threat status for your target if it exists. If the target does not exist or the player is not on the target's threat table, prints your threat status for any other units. -```lua -local statusText = { - [0] = "(0) low on threat", - [1] = "(1) high threat", - [2] = "(2) primary target but not on high threat", - [3] = "(3) primary target and high threat", -} -local statusTarget = UnitThreatSituation("player", "target") -if UnitExists("target") then - local msg = statusText[statusTarget] or "not on the target's threat table" - print("Your threat situation for target unit: "..msg) -end -if not statusTarget then - -- not in any target unit's threat table, look if on other threat tables - local statusAny = UnitThreatSituation("player") - local msg = statusText[statusAny] or "not on any threat table" - print("Your threat situation for any unit: "..msg) -end -``` -> "Your threat situation for target unit: (3) primary target and high threat" - -**Reference:** -- `UnitDetailedThreatSituation()` -- `GetThreatStatusColor()` -- [WoW Programming API Reference](http://wowprogramming.com/docs/api/UnitThreatSituation.html) -- Kaivax 2020-06-12. PTR Patch Notes - WoW Classic Version 1.13.5. \ No newline at end of file diff --git a/wiki-information/functions/UnitTrialBankedLevels.md b/wiki-information/functions/UnitTrialBankedLevels.md deleted file mode 100644 index 03dbd3a7..00000000 --- a/wiki-information/functions/UnitTrialBankedLevels.md +++ /dev/null @@ -1,17 +0,0 @@ -## Title: UnitTrialBankedLevels - -**Content:** -Needs summary. -`bankedLevels, xpIntoCurrentLevel, xpForNextLevel = UnitTrialBankedLevels(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `bankedLevels` - - *number* -- `xpIntoCurrentLevel` - - *number* -- `xpForNextLevel` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/UnitTrialXP.md b/wiki-information/functions/UnitTrialXP.md deleted file mode 100644 index 661a99d7..00000000 --- a/wiki-information/functions/UnitTrialXP.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: UnitTrialXP - -**Content:** -Needs summary. -`xp = UnitTrialXP(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `xp` - - *number* - -**Example Usage:** -This function can be used to retrieve the experience points (XP) of a trial character. For instance, if you want to display the current XP of a trial character in your addon, you can use this function. - -**Example Code:** -```lua -local unit = "player" -- or any other unit token -local xp = UnitTrialXP(unit) -print("Current XP for unit:", xp) -``` - -**Addons Using This Function:** -While specific large addons using this function are not well-documented, it is likely used in addons that manage or display character statistics, especially those that cater to trial characters. \ No newline at end of file diff --git a/wiki-information/functions/UnitUsingVehicle.md b/wiki-information/functions/UnitUsingVehicle.md deleted file mode 100644 index 63c9bafa..00000000 --- a/wiki-information/functions/UnitUsingVehicle.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitUsingVehicle - -**Content:** -Returns true if the unit is currently in a vehicle. -`inVehicle = UnitUsingVehicle(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `inVehicle` - - *boolean* - true if the unit is using a vehicle, false otherwise. \ No newline at end of file diff --git a/wiki-information/functions/UnitVehicleSeatCount.md b/wiki-information/functions/UnitVehicleSeatCount.md deleted file mode 100644 index 1234acfe..00000000 --- a/wiki-information/functions/UnitVehicleSeatCount.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UnitVehicleSeatCount - -**Content:** -Needs summary. -`count = UnitVehicleSeatCount(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `count` - - *number* - -**Example Usage:** -This function can be used to determine the number of seats available in a vehicle unit. For instance, in a battleground or raid scenario where players might use multi-passenger mounts or vehicles, this function can help manage and allocate seats to team members. - -**Addons:** -Large addons like Deadly Boss Mods (DBM) or ElvUI might use this function to provide information about vehicle seats during encounters or to enhance the user interface with vehicle-related data. \ No newline at end of file diff --git a/wiki-information/functions/UnitVehicleSeatInfo.md b/wiki-information/functions/UnitVehicleSeatInfo.md deleted file mode 100644 index 9ef0038f..00000000 --- a/wiki-information/functions/UnitVehicleSeatInfo.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: UnitVehicleSeatInfo - -**Content:** -Needs summary. -`controlType, occupantName, serverName, ejectable, canSwitchSeats = UnitVehicleSeatInfo(unit, virtualSeatIndex)` - -**Parameters:** -- `unit` - - *string* : UnitToken -- `virtualSeatIndex` - - *number* - -**Returns:** -- `controlType` - - *string* -- `occupantName` - - *string* -- `serverName` - - *string* -- `ejectable` - - *boolean* -- `canSwitchSeats` - - *boolean* \ No newline at end of file diff --git a/wiki-information/functions/UnitVehicleSkin.md b/wiki-information/functions/UnitVehicleSkin.md deleted file mode 100644 index 10b01581..00000000 --- a/wiki-information/functions/UnitVehicleSkin.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: UnitVehicleSkin - -**Content:** -Needs summary. -`skin = UnitVehicleSkin()` - -**Parameters:** -- `unit` - - *string?* : UnitToken = WOWGUID_NULL - -**Returns:** -- `skin` - - *number* : fileID \ No newline at end of file diff --git a/wiki-information/functions/UnitXP.md b/wiki-information/functions/UnitXP.md deleted file mode 100644 index 91f84d12..00000000 --- a/wiki-information/functions/UnitXP.md +++ /dev/null @@ -1,35 +0,0 @@ -## Title: UnitXP - -**Content:** -Returns the current XP of the unit; only works on the player. -`xp = UnitXP(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `xp` - - *number* - Returns the current XP points of the unit. - -**Description:** -This does not work for hunter pets, use `GetPetExperience()` for that. - -**Related Events:** -- `PLAYER_XP_UPDATE` - -**Related API:** -- `UnitXPMax` - -**Usage:** -```lua -local xp = UnitXP("player") -local nextXP = UnitXPMax("player") -print(string.format("Your XP is currently at %.1f%%", xp / nextXP * 100)) -``` - -**Example Use Case:** -This function can be used in an addon to track the player's experience points and display progress towards the next level. For instance, an addon could use this to create a custom XP bar or to notify the player when they are close to leveling up. - -**Addons Using This API:** -Many leveling and UI enhancement addons, such as "ElvUI" and "Titan Panel," use `UnitXP` to display the player's current experience points and progress towards the next level. \ No newline at end of file diff --git a/wiki-information/functions/UnitXPMax.md b/wiki-information/functions/UnitXPMax.md deleted file mode 100644 index 5ad657c5..00000000 --- a/wiki-information/functions/UnitXPMax.md +++ /dev/null @@ -1,26 +0,0 @@ -## Title: UnitXPMax - -**Content:** -Returns the maximum XP of the unit; only works on the player. -`nextXP = UnitXPMax(unit)` - -**Parameters:** -- `unit` - - *string* : UnitToken - -**Returns:** -- `nextXP` - - *number* - Returns the max XP points of the "unit". - -**Usage:** -```lua -local xp = UnitXP("player") -local nextXP = UnitXPMax("player") -print(string.format("Your XP is currently at %.1f%%", xp / nextXP * 100)) -``` - -**Example Use Case:** -This function can be used to create an experience bar for the player in a custom UI addon. By knowing the current XP and the maximum XP, you can calculate the percentage of XP the player has gained towards the next level. - -**Addons Using This Function:** -Many popular addons like "ElvUI" and "Bartender4" use this function to display the player's experience bar, showing progress towards the next level. \ No newline at end of file diff --git a/wiki-information/functions/UnmuteSoundFile.md b/wiki-information/functions/UnmuteSoundFile.md deleted file mode 100644 index ba806c5a..00000000 --- a/wiki-information/functions/UnmuteSoundFile.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: UnmuteSoundFile - -**Content:** -Unmutes a sound file. -`UnmuteSoundFile(sound)` - -**Parameters:** -- `sound` - - *number|string* - FileID of a game sound or file path to an addon sound. - -**Usage:** -Plays the Sound/Spells/LevelUp.ogg sound -```lua -/run PlaySoundFile(569593) -``` -Mutes it, the sound won't play -```lua -/run MuteSoundFile(569593); PlaySoundFile(569593) -``` -Unmutes it and plays it -```lua -/run UnmuteSoundFile(569593); PlaySoundFile(569593) -``` \ No newline at end of file diff --git a/wiki-information/functions/UnstablePet.md b/wiki-information/functions/UnstablePet.md deleted file mode 100644 index cd5d4dfa..00000000 --- a/wiki-information/functions/UnstablePet.md +++ /dev/null @@ -1,9 +0,0 @@ -## Title: UnstablePet - -**Content:** -Unstables a pet. -`UnstablePet(index)` - -**Parameters:** -- `index` - - *number* \ No newline at end of file diff --git a/wiki-information/functions/UpdateWindow.md b/wiki-information/functions/UpdateWindow.md deleted file mode 100644 index 592d38b3..00000000 --- a/wiki-information/functions/UpdateWindow.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: UpdateWindow - -**Content:** -When in windowed mode, updates the window. This also aligns it to the top of the screen and increases the size to max windowed size. -`UpdateWindow()` - -**Example Usage:** -This function can be used in scenarios where the game needs to be programmatically switched to windowed mode and aligned properly. For instance, an addon might call `UpdateWindow()` after changing the display settings to ensure the window is correctly positioned and sized. - -**Addons:** -While there are no specific large addons known to use this function directly, it could be useful in custom scripts or smaller addons that manage display settings or provide custom UI adjustments. \ No newline at end of file diff --git a/wiki-information/functions/UseAction.md b/wiki-information/functions/UseAction.md deleted file mode 100644 index bb42f684..00000000 --- a/wiki-information/functions/UseAction.md +++ /dev/null @@ -1,31 +0,0 @@ -## Title: UseAction - -**Content:** -Perform the action in the specified action slot. -`UseAction(slot)` - -**Parameters:** -- `slot` - - *number* - The action slot to use. -- `checkCursor` - - *Flag (optional)* - Can be 0, 1, or nil. Appears to indicate whether the action button was clicked (1) or used via hotkey (0); probably involved in placing skills/items in the action bar after they've been picked up. If you pass 0 for checkCursor, it will use the action regardless of whether another item/skill is on the cursor. If you pass 1 for checkCursor, it will replace the spell/action on the slot with the new one. -- `onSelf` - - *Flag (optional)* - Can be 0, 1, or nil. If present and 1, then the action is performed on the player, not the target. If "true" is passed instead of 1, Blizzard produces a Lua error. - -**Reference:** -- `GetActionInfo` - -**Example Usage:** -```lua --- Use the action in slot 1 -UseAction(1) - --- Use the action in slot 1, ensuring it replaces the current action if something is on the cursor -UseAction(1, 1) - --- Use the action in slot 1 on the player -UseAction(1, nil, 1) -``` - -**Addons:** -Many large addons, such as Bartender4 and Dominos, use `UseAction` to manage and execute actions from custom action bars. These addons provide enhanced customization and functionality for action bars, allowing players to configure their UI to better suit their playstyle. \ No newline at end of file diff --git a/wiki-information/functions/UseContainerItem.md b/wiki-information/functions/UseContainerItem.md deleted file mode 100644 index 41a6a4d5..00000000 --- a/wiki-information/functions/UseContainerItem.md +++ /dev/null @@ -1,36 +0,0 @@ -## Title: UseContainerItem - -**Content:** -Uses an item from a container depending on the situation. -`UseContainerItem(bagID, slot)` - -**Parameters:** -- `bagID` - - *number* - The bag id, where the item to use is located -- `slot` - - *number* - The slot in the bag, where the item to use is located -- `target` - - *string? : UnitId* - The unit the item should be used on. If omitted, defaults to "target" if the item must target someone. -- `reagentBankAccessible` - - *boolean?* - This indicates, for cases where no target is given, if the item reagent bank is accessible (so bank frame is shown and switched to the reagent bank tab). - -**Description:** -Slots in the bags are listed from left to right, top to bottom. A 16 slot bag has the following slot numbers: -1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 - -A 6 slot bag has the following slot numbers: -1, 2, 3, 4, 5, 6 - -This function is protected, though may still be called in the following situations: -- When the (Guild/Reagent) Bank is open: Move the item to/from the (Guild/Reagent) Bank. -- When the Merchant frame is open: Sell the item. -- When the Mail frame is open and on the "Send Mail" tab: Add the item to the attachments. -- When the item is equippable: Equip the item. -- When the slot is empty: Do nothing. -- When the item is a locked Lockbox: Show an error message that says it's locked. -- When the item is a container (Clam Shell, Unlocked Lockbox, etc.): Open the Loot frame and show the contents. -- When the item is a book: Open the book's Gossip frame for reading. -- When the item is not a usable item: Do nothing. -- When the item starts a quest: Open the quest Gossip frame for reading. -- When the Trade frame is open: Add the item to the list of items to be traded. -- When the Auctions tab is open: Add item for auction pricing and submission. \ No newline at end of file diff --git a/wiki-information/functions/UseInventoryItem.md b/wiki-information/functions/UseInventoryItem.md deleted file mode 100644 index 00e2301a..00000000 --- a/wiki-information/functions/UseInventoryItem.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: UseInventoryItem - -**Content:** -Use an item in a specific inventory slot. - -**Miscellaneous:** -Syntax: -`UseInventoryItem(slotID)` - -**Parameters:** -- `slotID` - - The inventory slot ID - - You can get the slot ID by using `GetInventorySlotInfo(slot)` - -**Returns:** -Always nil. - -**Usage:** -```lua -/script UseInventoryItem(GetInventorySlotInfo("Trinket0Slot")); -``` -After patch 1.6, you can't auto-use items anymore. Addons can no longer activate items without the press of a button. In order to use `UseInventoryItem(GetInventorySlotInfo("Trinket0Slot"))`, you will have to call it from a button, keypress, or icon as you do with spells. \ No newline at end of file diff --git a/wiki-information/functions/UseItemByName.md b/wiki-information/functions/UseItemByName.md deleted file mode 100644 index 9ba5d15b..00000000 --- a/wiki-information/functions/UseItemByName.md +++ /dev/null @@ -1,27 +0,0 @@ -## Title: UseItemByName - -**Content:** -Uses the specified item. -`UseItemByName(name)` - -**Parameters:** -- `name` - - *string* - name of the item to use. -- `target` - - *string? : UnitId* - The unit to use the item on, defaults to "target" for items that can be used on others. - -**Reference:** -- `UseContainerItem` -- `UseInventoryItem` - -**Example Usage:** -```lua --- Use a health potion on the player -UseItemByName("Health Potion") - --- Use a bandage on the target -UseItemByName("Heavy Runecloth Bandage", "target") -``` - -**Addons:** -Many large addons, such as **WeakAuras** and **ElvUI**, use `UseItemByName` to automate item usage based on specific conditions or user actions. For example, WeakAuras can trigger the use of a specific item when certain conditions are met, such as low health or a specific buff/debuff being present. \ No newline at end of file diff --git a/wiki-information/functions/UseToy.md b/wiki-information/functions/UseToy.md deleted file mode 100644 index 9df81663..00000000 --- a/wiki-information/functions/UseToy.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UseToy - -**Content:** -Use a toy in the player's toybox. -`UseToy(itemId)` - -**Parameters:** -- `itemId` - - *number* - itemId of a toy. - -**Usage:** -```lua -if PlayerHasToy(92738) then - UseToy(92738); -end -``` - -**Reference:** -- `UseToyByName()` \ No newline at end of file diff --git a/wiki-information/functions/UseToyByName.md b/wiki-information/functions/UseToyByName.md deleted file mode 100644 index a33194d8..00000000 --- a/wiki-information/functions/UseToyByName.md +++ /dev/null @@ -1,19 +0,0 @@ -## Title: UseToyByName - -**Content:** -Use a toy in the player's toybox. -`UseToyByName(name)` - -**Parameters:** -- `name` - - *string* - (localized?) name of a toy. - -**Usage:** -```lua -if PlayerHasToy(92738) then - UseToyByName('Safari Hat'); -end -``` - -**Reference:** -- `UseToy()` \ No newline at end of file diff --git a/wiki-information/functions/addframetext.md b/wiki-information/functions/addframetext.md deleted file mode 100644 index 0c6386d5..00000000 --- a/wiki-information/functions/addframetext.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: addframetext - -**Content:** -Appends a string to the debug frame text buffer for crash reporting. -`addframetext(text)` - -**Parameters:** -- `text` - - *string* - A string to log in the frame text buffer. - -**Description:** -The frame text buffer is included as part of crash dumps generated by the client. -The frame text buffer is not cleared every frame. Instead, the client will keep accumulating strings into the buffer across multiple frames until it reaches a fixed capacity, at which point the buffer is then cleared. \ No newline at end of file diff --git a/wiki-information/functions/debuglocals.md b/wiki-information/functions/debuglocals.md deleted file mode 100644 index 81487b8c..00000000 --- a/wiki-information/functions/debuglocals.md +++ /dev/null @@ -1,62 +0,0 @@ -## Title: debuglocals - -**Content:** -Returns a string dump of all local variables and upvalues at a given stack level. -`locals = debuglocals()` - -**Parameters:** -- `level` - - *number* - The stack level to inspect. Defaults to 1 (the calling function). - -**Returns:** -- `locals` - - *string?* - A string dump of all local variables, temporaries, and upvalues. - -**Description:** -This function will return no values if called outside of the execution of the global error handler function. - -**Usage:** -The following snippet demonstrates example output for a variety of values. Note that this snippet may not work as-is if you have an error handling addon installed, as these typically hijack and replace the ability to change the global error handler. -```lua -local Upvalue = "banana" -seterrorhandler(function() - local Number = 1.23456 - local String = "foo" - local NamedFrame = { = ChatFrame1 } - local Table = { - 1, - 2, - foo = "bar", - { - "debuglocals should only inspect at-most one level of tables; this shouldn't be printed", - }, - } - local Thread = coroutine.create(function() end) - local Boolean = true - local Nil = nil - local Temp = Upvalue - print(debuglocals()) -end) -error("") -``` -Example output: -``` -Number = 1.234560 -String = "foo" -NamedFrame = ChatFrame1 { - 0 = -} -Table =
{ - 1 = 1 - 2 = 2 - 3 =
{ - } - foo = "bar" -} -Thread = -Boolean = true -Nil = nil -Temp = "banana" -(*temporary) = defined @Interface\FrameXML\UIParent.lua:5234 -Upvalue = "banana" -``` \ No newline at end of file diff --git a/wiki-information/functions/debugprofilestart.md b/wiki-information/functions/debugprofilestart.md deleted file mode 100644 index de48fb68..00000000 --- a/wiki-information/functions/debugprofilestart.md +++ /dev/null @@ -1,11 +0,0 @@ -## Title: debugprofilestart - -**Content:** -Starts a timer for profiling during debugging. -`debugprofilestart()` - -Note that the timer does not actually need to be started. This is more of a global "reset" of the timer. -Since it is global, it is probably best to never call this function. Rather just call `debugprofilestop()` 2 times and compare the difference. - -**Reference:** -- `debugprofilestop` \ No newline at end of file diff --git a/wiki-information/functions/debugprofilestop.md b/wiki-information/functions/debugprofilestop.md deleted file mode 100644 index f7624b87..00000000 --- a/wiki-information/functions/debugprofilestop.md +++ /dev/null @@ -1,32 +0,0 @@ -## Title: debugprofilestop - -**Content:** -Returns the time in milliseconds since the last call to `debugprofilestart()`. -`elapsedMilliseconds = debugprofilestop()` - -**Returns:** -- `elapsedMilliseconds` - - *number* - Time since profiling was started in milliseconds. - -**Description:** -Debug profiling provides a high-precision timer that can be used to profile code. -Calling this function, despite its name, does NOT stop the timer. It simply returns the time since the previous `debugprofilestart()` call! - -Note that if you are simply using this to profile your own code, it is preferable to NOT keep re-starting the timer since it will interfere with other addons doing the same. Instead, do this: -```lua -local beginTime = debugprofilestop() --- do lots of stuff --- that takes lots of time - -local timeUsed = debugprofilestop() - beginTime -print("I used " .. timeUsed .. " milliseconds!") -``` - -**Reference:** -- `debugprofilestart` - -**Example Use Case:** -This function is particularly useful for addon developers who need to measure the performance of their code. For instance, if you are developing an addon that processes a large amount of data, you can use `debugprofilestop()` to measure how long the processing takes and optimize accordingly. - -**Addons Using This Function:** -Many performance monitoring addons, such as "Details! Damage Meter" and "WeakAuras," use `debugprofilestop()` to measure the execution time of various functions and scripts to ensure they run efficiently. \ No newline at end of file diff --git a/wiki-information/functions/debugstack.md b/wiki-information/functions/debugstack.md deleted file mode 100644 index 16990489..00000000 --- a/wiki-information/functions/debugstack.md +++ /dev/null @@ -1,76 +0,0 @@ -## Title: debugstack - -**Content:** -Returns a string representation of the current calling stack. -`description = debugstack( ]])` - -**Parameters:** -- `coroutine` - - *Thread* - The thread with the stack to examine (default - the calling thread) -- `start` - - *number* - the stack depth at which to start the stack trace (default 1 - the function calling debugstack, or the top of coroutine's stack) -- `count1` - - *number* - the number of functions to output at the top of the stack (default 12) -- `count2` - - *number* - the number of functions to output at the bottom of the stack (default 10) - -**Returns:** -- `description` - - *string* - a multi-line string showing what the current call stack looks like - - If there are more than count1+count2 calls in the stack, they are separated by a "..." line. - - Long lines may become truncated. - - The string ends with an extra newline character. - -**Usage:** -Assume the following example file, "file.lua": -```lua -1: function a() -2: error("Boom!"); -3: end -4: -5: function b() a(); end -6: -7: function c() b(); end -8: -9: function d() c(); end -10: -11: function e() d(); end -12: -13: function f() e(); end -14: -15: function errhandler(msg) -16: print (msg .. "\nCall stack: \n" .. debugstack(2, 3, 2)); -17: end -18: -19: xpcall(f, errhandler); -``` -This would output something along the following: -``` -file.lua:2: Boom! -Call stack: -file.lua:2: in function a -file.lua:5: in function b -file.lua:7: in function c -... -file.lua:13: in function f -file.lua:19 -``` - -Example 2: -Combining debugstack with a strmatch can enable you to get the current line of a function call. -```lua -1: function debugprint(msg) -2: local line = strmatch(debugstack(2),":(%d):"); -3: print("Debug Print on Line "..line.." with message: "..msg); -4: end -5: -6: function doSomething() -7: debugprint("We tried to do something."); -8: end -``` -This would return the following output from print: -``` -Debug Print on Line 7 with message: We tried to do something. -``` - -This is a WoW API modified version of Lua's `debug.traceback()` function. \ No newline at end of file diff --git a/wiki-information/functions/forceinsecure.md b/wiki-information/functions/forceinsecure.md deleted file mode 100644 index 2d1b15be..00000000 --- a/wiki-information/functions/forceinsecure.md +++ /dev/null @@ -1,14 +0,0 @@ -## Title: forceinsecure - -**Content:** -Taints the current execution path. -`forceinsecure()` - -**Description:** -The `forceinsecure` function is used to mark the current execution path as insecure. This is typically used in the context of World of Warcraft's secure execution environment to indicate that certain actions or code paths should not be trusted or allowed to perform secure operations. - -**Example Usage:** -This function is often used in the development of addons to ensure that certain code paths are marked as insecure, preventing them from performing actions that require a secure environment. For example, an addon might use `forceinsecure` to mark a function that handles user input as insecure to prevent it from being used to perform secure actions like casting spells or using items. - -**Addons:** -Large addons like **ElvUI** and **WeakAuras** may use `forceinsecure` to manage secure and insecure code paths, ensuring that user interactions and custom scripts do not interfere with secure operations within the game. This helps maintain the integrity and security of the game's execution environment while allowing for extensive customization and functionality. \ No newline at end of file diff --git a/wiki-information/functions/geterrorhandler.md b/wiki-information/functions/geterrorhandler.md deleted file mode 100644 index 50b1ee21..00000000 --- a/wiki-information/functions/geterrorhandler.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: geterrorhandler - -**Content:** -Returns the currently set error handler. -`handler = geterrorhandler()` - -**Returns:** -- `handler` - - *function* - The current error handler. Receives a message as an argument, normally a string that is the second return value from `pcall()`. - -**Usage:** -```lua -local myError = "Something went horribly wrong!" -geterrorhandler()(myError) -``` - -**Example Use Case:** -The `geterrorhandler` function can be used to retrieve the current error handler function, which can then be invoked with a custom error message. This is useful for debugging or logging errors in a controlled manner. - -**Addons Using This Function:** -Many large addons, such as WeakAuras and ElvUI, use custom error handlers to manage and log errors gracefully without disrupting the user experience. They might use `geterrorhandler` to ensure that their custom error handling logic is in place or to temporarily replace the default error handler during critical operations. \ No newline at end of file diff --git a/wiki-information/functions/hooksecurefunc.md b/wiki-information/functions/hooksecurefunc.md deleted file mode 100644 index 31899cd9..00000000 --- a/wiki-information/functions/hooksecurefunc.md +++ /dev/null @@ -1,38 +0,0 @@ -## Title: hooksecurefunc - -**Content:** -Securely posthooks the specified function. The hook will be called with the same arguments after the original call is performed. -`hooksecurefunc(functionName, hookfunc)` - -**Parameters:** -- `table` - - *Optional Table* - Table to hook the `functionName` key in; if omitted, defaults to the global table (`_G`). -- `functionName` - - *string* - name of the function being hooked. -- `hookfunc` - - *function* - your hook function. - -**Usage:** -The following calls hook `CastSpellByName` and `GameTooltip:SetUnitBuff` without compromising their secure status. When those functions are called, the hook prints their argument list into the default chat frame. -```lua -hooksecurefunc("CastSpellByName", print); -- Hooks the global CastSpellByName -hooksecurefunc(GameTooltip, "SetUnitBuff", print); -- Hooks GameTooltip.SetUnitBuff -``` - -**Description:** -This is the only safe way to hook functions that execute protected functionality. -`hookfunc` is invoked after the original function, and receives the same parameters; return values from `hookfunc` are discarded. -After this function is used on a function, `setfenv()` throws an error when attempted on that function. -You cannot "unhook" a function that is hooked with this function except by a UI reload. Calling `hooksecurefunc()` multiple times only adds more hooks to be called. -Also note that using `hooksecurefunc()` may not always produce the expected result. Keep in mind that it actually replaces the original function with a new one (the function reference changes). For example, if you try to hook the global function `MacroFrame_OnHide` (after the macro frame has been displayed), your function will not be called when the macro frame is closed. It's simply because in `Blizzard_MacroUI.xml` the `OnHide` function call is registered like this: -```xml - -``` -The function ID called when the frame is hidden is the former one, before you hooked `MacroFrame_OnHide`. The workaround is to hook a function called by `MacroFrame_OnHide`: -```lua -hooksecurefunc(MacroPopupFrame, "Hide", MyFunction) -``` -If you want to securely hook a frame's script handler, use `Frame:HookScript`: -```lua -MacroPopupFrame:HookScript("OnHide", MyFunction) -``` \ No newline at end of file diff --git a/wiki-information/functions/issecure.md b/wiki-information/functions/issecure.md deleted file mode 100644 index 66b8db6b..00000000 --- a/wiki-information/functions/issecure.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: issecure - -**Content:** -Returns true if the current execution path is secure. -`secure = issecure()` - -**Returns:** -- `secure` - - *boolean* - true if the current path is secure (and able to call protected functions), false otherwise. - -**Description:** -This function will return false if called from any (insecure) addon code. -Certain API functions (and FrameXML functions that check this function's return value) cannot be called from tainted execution paths. \ No newline at end of file diff --git a/wiki-information/functions/issecurevariable.md b/wiki-information/functions/issecurevariable.md deleted file mode 100644 index 55a6a3a4..00000000 --- a/wiki-information/functions/issecurevariable.md +++ /dev/null @@ -1,22 +0,0 @@ -## Title: issecurevariable - -**Content:** -Returns true if the specified variable is secure. -`isSecure, taint = issecurevariable(variable)` - -**Parameters:** -- `table` - - *table?* - table to check the key in; if omitted, defaults to the globals table (_G). -- `variable` - - *string* - string key to check the taint of. Numbers will be converted to a string; other types will throw an error. - -**Returns:** -- `isSecure` - - *boolean* - true if the table key is secure, false if it is tainted. -- `taint` - - *string?* - name of the addon that tainted the table field; an empty string if tainted by a macro; nil if secure. - -**Description:** -Also returns true, nil for keys that have never been used/defined, because nothing has tainted them yet. -If `table == nil`, and table has a metatable with `__index`, this function will return whether the metatable's `__index` is tainted. You must remove the metatable to check whether the table itself is tainted. -Cannot be used to check the taint of local variables, or non-string table keys. \ No newline at end of file diff --git a/wiki-information/functions/pcallwithenv.md b/wiki-information/functions/pcallwithenv.md deleted file mode 100644 index c31a682f..00000000 --- a/wiki-information/functions/pcallwithenv.md +++ /dev/null @@ -1,28 +0,0 @@ -## Title: pcallwithenv - -**Content:** -Calls a function in protected mode with a temporarily replaced function environment. -`ok, ... = pcallwithenv(func, env, ...)` - -**Parameters:** -- `func` - - *string* - The function to be called. -- `env` - - *table* - A custom environment table to apply to the function prior to calling. -- `...` - - *Variable* - Arguments to supply to the function. - -**Returns:** -- `ok` - - *boolean* - True if the function was called without error. -- `...` - - *Variable* - Either a singular error value or all of the return values of the called function. - -**Description:** -This function will temporarily replace the existing environment on the supplied function before the call, and will restore the original environment after the call has completed. -This function will raise an error if the function to be called has an existing environment whose metatable has an `__environment` field set. -If this function is called insecurely and the supplied function is a Lua function, the supplied function will be irrevocably tainted. This will result in all future calls to the function tainting execution. - -**Reference:** -- `pcall` -- `setfenv` \ No newline at end of file diff --git a/wiki-information/functions/scrub.md b/wiki-information/functions/scrub.md deleted file mode 100644 index b64779a3..00000000 --- a/wiki-information/functions/scrub.md +++ /dev/null @@ -1,13 +0,0 @@ -## Title: scrub - -**Content:** -Returns the argument list with non-number/boolean/string values changed to nil. -`... = scrub(...)` - -**Parameters:** -- `...` - - *any* - The values to be scrubbed. - -**Returns:** -- `...` - - *boolean|number|string|nil* - The scrubbed list of arguments. \ No newline at end of file diff --git a/wiki-information/functions/securecall.md b/wiki-information/functions/securecall.md deleted file mode 100644 index ce929a67..00000000 --- a/wiki-information/functions/securecall.md +++ /dev/null @@ -1,23 +0,0 @@ -## Title: securecall - -**Content:** -Calls the specified function without propagating taint to the caller. -```lua -... = securecall(func or functionName, ...) -... = securecallfunction(func, ...) -``` - -**Parameters:** -- `func` - - *function|string* - A direct reference of the function to be called, or for `securecall` a string name of a function to be resolved through a global lookup. -- `...` - - Additional arguments to supply to the function. - -**Returns:** -- `...` - - The return values of the called function. - -**Description:** -If `securecall` is called from a secure execution path, the execution path will remain secure when `securecall` returns, even if the called function is tainted, or accesses tainted variables. -Errors that occur within the called function are not propagated to the caller; if an error occurs, `securecall` triggers the default error handler, and then returns control to the caller with no return values. -For `securecallfunction`, no attempt is made to perform a global lookup based on the supplied function argument. \ No newline at end of file diff --git a/wiki-information/functions/securecallfunction.md b/wiki-information/functions/securecallfunction.md deleted file mode 100644 index f3e2237e..00000000 --- a/wiki-information/functions/securecallfunction.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: securecall - -**Content:** -Calls the specified function without propagating taint to the caller. -`... = securecall(func or functionName, ...)` -`... = securecallfunction(func, ...)` - -**Parameters:** -- `func` - - *function|string* - A direct reference of the function to be called, or for securecall a string name of a function to be resolved through a global lookup. -- `...` - - Additional arguments to supply to the function. - -**Returns:** -- `...` - - The return values of the called function. - -**Description:** -If `securecall` is called from a secure execution path, the execution path will remain secure when `securecall` returns, even if the called function is tainted, or accesses tainted variables. -Errors that occur within the called function are not propagated to the caller; if an error occurs, `securecall` triggers the default error handler, and then returns control to the caller with no return values. -For `securecallfunction`, no attempt is made to perform a global lookup based on the supplied function argument. \ No newline at end of file diff --git a/wiki-information/functions/secureexecuterange.md b/wiki-information/functions/secureexecuterange.md deleted file mode 100644 index d84a643c..00000000 --- a/wiki-information/functions/secureexecuterange.md +++ /dev/null @@ -1,51 +0,0 @@ -## Title: secureexecuterange - -**Content:** -Calls a function for each pair within a table without propagating taint to the caller. -`secureexecuterange(tbl, func, ...)` - -**Parameters:** -- `tbl` - - *table* - The table to be traversed. -- `func` - - *function* - The function to be called for each pair. -- `...` - - Additional arguments to supply to the invoked function. - -**Description:** -The supplied function will be called with the key and value of each pair within the table as the first two arguments, followed by any additional user-supplied arguments. - -Execution of the supplied function will be tainted in the following scenarios: -- If the initial state of execution was insecure. -- If the table pair currently being processed was insecurely inserted. -- If the supplied function was created by insecure code. - -If execution is tainted during the processing of a single pair, the taint does not propagate to the processing of any remaining pairs within the supplied table. - -Errors that occur during the execution of the supplied function are discarded, and do not propagate to the caller. Additionally, errors do not prevent the function from being called for all remaining pairs within the supplied table so as to prevent insecure code from potentially changing the flow of execution. - -**Example Implementation:** -The implementation of this function would, if not provided natively by the client, be effectively similar to the snippet below. This example aims to demonstrate how error handling and taint is processed with regards to individual pairs within the table. - -```lua -local function secureexecutenext(tbl, prev, func, ...) - local key, value = next(tbl, prev) - if key ~= nil then - pcall(func, key, value, ...) -- Errors are silently discarded! - end - return key -end - -function secureexecuterange(tbl, func, ...) - local key = nil - repeat - key = securecallfunction(secureexecutenext, tbl, key, func, ...) - until key == nil -end -``` - -**Example Usage:** -This function can be used in scenarios where you need to iterate over a table and perform operations on each key-value pair without risking taint propagation or error interruption. For instance, it can be used in secure environment setups where maintaining the integrity of the execution state is crucial. - -**Addons Usage:** -Large addons that handle secure execution of code, such as those managing UI elements or secure templates, might use this function to ensure that their operations do not inadvertently taint the global execution environment. For example, addons like ElvUI or Bartender4, which deal with secure handling of action bars and UI elements, could leverage this function to safely iterate over configuration tables. \ No newline at end of file diff --git a/wiki-information/functions/seterrorhandler.md b/wiki-information/functions/seterrorhandler.md deleted file mode 100644 index 5972e096..00000000 --- a/wiki-information/functions/seterrorhandler.md +++ /dev/null @@ -1,21 +0,0 @@ -## Title: seterrorhandler - -**Content:** -Sets the error handler to the given function. -`seterrorhandler(errFunc)` - -**Parameters:** -- `errFunc` - - *function* - The function to call when an error occurs. The function is passed a single argument containing the error message. - -**Usage:** -If you wanted to print all errors to your chat frame, you could do: -```lua -seterrorhandler(print); -``` -Alternatively, the following would also perform the same task: -```lua -seterrorhandler(function(msg) - print(msg); -end); -``` \ No newline at end of file From 830fd620c6627312cc4b15ad298137ec8f4167ca Mon Sep 17 00:00:00 2001 From: Logon Date: Thu, 26 Sep 2024 13:18:09 +0200 Subject: [PATCH 11/18] Root code --- .../generate_translation_trie_root.lua | 303 ++++++++++++++++++ 1 file changed, 303 insertions(+) create mode 100644 .generate_database_lua/generate_translation_trie_root.lua diff --git a/.generate_database_lua/generate_translation_trie_root.lua b/.generate_database_lua/generate_translation_trie_root.lua new file mode 100644 index 00000000..3dc54ca8 --- /dev/null +++ b/.generate_database_lua/generate_translation_trie_root.lua @@ -0,0 +1,303 @@ +require("cli.dump") + +---@alias trie table +---@alias filepath string + +-- The root folder +local root_folder = "translations" + +-- Variable to disable the writing of html +local write_html = true + +-- Double Dagger +local splitCharacter = "‡" + +-- Define the maximum number of translations per file +local MAX_TRANSLATIONS_PER_FILE = 50 +local SEGMENT_SIZE = 4000 +local REDUCE_SEGMENT_SIZE = math.max(math.min(SEGMENT_SIZE * 0.05, 100), 10) +print("Max translations per file: " .. MAX_TRANSLATIONS_PER_FILE) +print("Segment size: " .. SEGMENT_SIZE, "Reduced segment size: " .. SEGMENT_SIZE - REDUCE_SEGMENT_SIZE) + +--- Function to sanitize translation strings by replacing special characters with HTML entities +---@param str string +---@return string +local function sanitize_translation(str) + str = string.gsub(str, "&", "&") + str = string.gsub(str, "<", "<") + str = string.gsub(str, ">", ">") + -- str = string.gsub(str, "\n", "
") + -- str = string.gsub(str, '"', '\\"') + return str +end + +--- Function to create directories recursively using os.execute +---@param path filepath +local function mkdir(path) + os.execute("mkdir -p " .. path) +end + +--- Function to split a string into segments based on maximum characters per segment +---@param str string +---@param max_chars number +---@return string[] +local function split_into_segments(str, max_chars) + local segments = {} + local total_segments = math.ceil(#str / max_chars) + + -- Loop through the string and create segments + for i = 1, total_segments do + local start_pos = (i - 1) * max_chars + 1 + local end_pos = math.min(i * max_chars, #str) + local segment = string.sub(str, start_pos, end_pos) + -- Add segment number prefix for all segments except the first one + if i > 1 then + segment = tostring(i) .. segment + end + table.insert(segments, segment) + end + + -- Add total segments count to the first segment + segments[1] = total_segments .. segments[1] + + return segments +end + +--- Function to write translations to an HTML file with segmentation +---@param key_path string The path for the translation e.g. translations/u/s/e/t/h/e +---@param translations string[] +---@param translation_func fun(string):string[] A function that takes the english string and returns all translations +local function write_html_file(key_path, translations, translation_func) + -- ? This stops the function from writing in subfolders but instead writes in the root folder + -- ? Remember to activate the folder creation function in the create_trie_folders function if disabled + -- "%-" Always escape + local replaceChar = "" + key_path = key_path:gsub("/", replaceChar) + key_path = key_path:gsub(root_folder .. replaceChar, root_folder .. "/", 1) -- We also removed the root folder from the key_path, add back the / + + -- Define the file path + local filename = key_path .. ".html" + + -- print(filename) + + -- Open the file for writing + if write_html then + local file, err = io.open(filename, "w") + if not file then + print("Error opening file " .. filename .. ": " .. err) + return + end + + -- Write the HTML structure + file:write("\n") + for _, translation in ipairs(translations) do + local fullTranslationTable = translation_func(translation) + + + + -- Check if the translation needs to be segmented + if #table.concat(fullTranslationTable, splitCharacter) > SEGMENT_SIZE - REDUCE_SEGMENT_SIZE then + print("Splitting translation into segments", translation, filename) + -- Split the translation into segments + local segments = split_into_segments(table.concat(fullTranslationTable, splitCharacter), SEGMENT_SIZE - REDUCE_SEGMENT_SIZE) + -- Write each segment as a separate paragraph + for _, segment in ipairs(segments) do + file:write("

" .. sanitize_translation(segment) .. "

\n") + end + else + -- Write the translation as a single paragraph + file:write("

" .. sanitize_translation(table.concat(fullTranslationTable, splitCharacter)) .. "

\n") + end + end + file:write("\n") + file:close() + end +end + +-- Function to create trie folders and write translations to HTML files +---comment +---@param trie trie +---@param current_path filepath +---@param translation_func fun(translation:string):string[] A function that takes the english string and returns all translations +local function write_trie_structure(trie, current_path, translation_func) + -- print("Current path: " .. current_path) + for trieKey, translations in pairs(trie) do + local new_path = current_path .. "/" .. trieKey + if type(translations) == "table" then + -- If the number of translations is greater than the maximum or there are no translations + if #translations > MAX_TRANSLATIONS_PER_FILE or #translations == 0 then + -- ? This line activates the function to create folders for the current path, disabled due to easier to just have it flat. + -- * mkdir(new_path) + + -- print("Continuing recursion for: " .. new_path) + write_trie_structure(translations, new_path, translation_func) + else + -- print("Writing HTML file for: " .. new_path) + write_html_file(new_path, translations, translation_func) + end + end + end +end + +--- Function to create a branch in the trie structure +---@param strings string[] +---@param stringIndex number @ The index of the current character in the string +---@return trie +local function create_trie(strings, stringIndex) + local branch = {} + -- Process each string in the input array + for i = 1, #strings do + local string = strings[i] + local cleanedString = string.gsub(string, "%s", "") + -- Remove all numbers from the string + -- cleanedString = string.gsub(cleanedString, "%d+", "") + cleanedString = string.gsub(cleanedString, "%p", "") + cleanedString = string.gsub(cleanedString, "%c", "") + + -- Get the character at the current index + -- local char = string.sub(string.lower(cleanedString), stringIndex, stringIndex) + local char = string.sub(cleanedString, stringIndex, stringIndex) + + if char == "" then + -- error(string.format("%s: %d out of range, increase MAX_TRANSLATIONS_PER_FILE", string, stringIndex)) + print(string.format("%s: %d out of range", string, stringIndex)) + char = "." + -- table.insert(parent[char], string) + -- else + end + -- Create a new branch for the character if it doesn't exist + if not branch[char] then + branch[char] = {} + end + table.insert(branch[char], string) + end + + -- Recursively create branches for child nodes if needed + for char, child in pairs(branch) do + if #child > MAX_TRANSLATIONS_PER_FILE then + branch[char] = create_trie(child, stringIndex + 1) + end + end + + return branch +end + +-- Function to check if a table is an array of strings +local function isStringArray(t) + if type(t) ~= "table" then + return false + end + -- Check if the table is a sequence (array) with consecutive integer keys starting at 1 + local index = 1 + for k, v in pairs(t) do + if type(k) ~= "number" or k ~= index then + return false + end + if type(v) ~= "string" then + return false + end + index = index + 1 + end + return true +end + +-- Recursive function to traverse and modify the trie table +local function replaceArrays(t, filepath) + for key, value in pairs(t) do + if type(value) == "table" then + if isStringArray(value) then + -- Replace the array of strings with the filepath + t[key] = filepath .. key .. ".html" + else + -- Recursively process nested tables + replaceArrays(value, filepath .. key) + end + end + end +end + +local localeOrder = { + 'enUS', + 'esES', + 'esMX', + 'ptBR', + 'frFR', + 'deDE', + 'ruRU', + 'zhCN', + 'zhTW', + 'koKR', +} + +-- Main function to compile translations to HTML +---comment +---@param strings string[] +---@param translation_func fun(string):table A function that takes the english string and returns all translations +function Compile_translations_to_html(strings, translation_func) + -- Initialize the trie + local success, trie + repeat + success, trie = pcall(create_trie, strings, 1) + if not success then + MAX_TRANSLATIONS_PER_FILE = MAX_TRANSLATIONS_PER_FILE + 1 + print(trie) + print("Shortest word does not fit! - increasing MAX_TRANSLATIONS_PER_FILE to: " .. MAX_TRANSLATIONS_PER_FILE) + end + until success + + mkdir(root_folder) + + ---@param enUStext string + ---@return string[]? + ---@return error? + local function getTranslation(enUStext) + local allTranslations, err = translation_func(enUStext) + if err then + return nil, err + end + local combinedTranslations = { "enUS" .. "[" .. enUStext .. "]", } + for _, locale in ipairs(localeOrder) do + local text = allTranslations[locale] + if type(text) == "string" and locale ~= "enUS" then + table.insert(combinedTranslations, locale .. "[" .. text .. "]") + elseif locale ~= "enUS" then + table.insert(combinedTranslations, "") + end + end + return combinedTranslations --table.concat(combinedTranslations, "‡") + end + + -- Create trie folders and write translations + write_trie_structure(trie, root_folder, getTranslation) + + -- Replace the actual string arrays with the template xml name + replaceArrays(trie, "") + + -- Function to print the table for verification (optional) + local function printTable(t, indent) + local lines = {} + indent = indent or "" + for k, v in pairs(t) do + if type(v) == "table" then + table.insert(lines, indent .. "[\"" .. tostring(k) .. "\"] = {") + table.insert(lines, printTable(v, indent .. " ")) + table.insert(lines, indent .. "},") + else + -- if html in v use " otherwise it will be wrapped in [[]] + if string.find(v, ".html") then + table.insert(lines, indent .. "[\"" .. tostring(k) .. "\"] = \"" .. tostring(v) .. "\",") + else + table.insert(lines, indent .. "[\"" .. tostring(k) .. "\"] = [[" .. tostring(v) .. "]],") + end + end + end + return table.concat(lines, "\n") + end + + local lua_file = io.open(root_folder .. "/trie.lua", "w") + if lua_file ~= nil then + local dump_str = printTable(trie, "") --dump_trie(point_to_html(trie), 1) + lua_file:write("local trie = {\n" .. dump_str .. "\n}") + lua_file:close() + end +end From 48a581b76a60ce01c31956b26a22908693c38343 Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 4 Oct 2024 17:38:01 +0200 Subject: [PATCH 12/18] feat: add .gitignore files for generated translation files This change adds .gitignore files for the generated translation files and directories: - `.generate_database/.gitignore` - Ignores the `Translations` directory generated by the translation generation script - `translations/.gitignore` - Ignores the `translationsLookup.lua`, `translationsFiles.xml`, and `data/` files generated by the translation generation script These changes help keep the repository clean by excluding the generated translation files from being tracked by Git. --- .generate_database/.gitignore | 3 ++- translations/.gitignore | 3 +++ 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 translations/.gitignore diff --git a/.generate_database/.gitignore b/.generate_database/.gitignore index 87b5aa52..46131a86 100644 --- a/.generate_database/.gitignore +++ b/.generate_database/.gitignore @@ -1,4 +1,5 @@ __pycache__ _data *.lua-table -*.log \ No newline at end of file +*.log +Translations \ No newline at end of file diff --git a/translations/.gitignore b/translations/.gitignore new file mode 100644 index 00000000..2c24b400 --- /dev/null +++ b/translations/.gitignore @@ -0,0 +1,3 @@ +translationsLookup.lua +translationsFiles.xml +data/ \ No newline at end of file From cde239eed9fc21b6a6a0fa1b895a53ffb8e194a0 Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 4 Oct 2024 17:39:38 +0200 Subject: [PATCH 13/18] Moved it to the main gitignore, added a gitkeep to the data dir --- .gitignore | 7 ++++++- translations/.gitignore | 3 --- translations/data/.gitkeep | 0 3 files changed, 6 insertions(+), 4 deletions(-) delete mode 100644 translations/.gitignore create mode 100644 translations/data/.gitkeep diff --git a/.gitignore b/.gitignore index 991aacd7..77c21532 100644 --- a/.gitignore +++ b/.gitignore @@ -4,6 +4,10 @@ Database/*/**/*.html Database/*/*/*Data*.xml Database/*/*/*Data*.html +translations/*Lookup.lua +translations/*Files.xml +translations/data/*.html + .shit .translator @@ -54,4 +58,5 @@ Perfy .build -.llm-output \ No newline at end of file +.llm-output +..wiki-information \ No newline at end of file diff --git a/translations/.gitignore b/translations/.gitignore deleted file mode 100644 index 2c24b400..00000000 --- a/translations/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -translationsLookup.lua -translationsFiles.xml -data/ \ No newline at end of file diff --git a/translations/data/.gitkeep b/translations/data/.gitkeep new file mode 100644 index 00000000..e69de29b From 749679376fb0107cbcee5c8d34ac0548a24bd65b Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 4 Oct 2024 18:09:16 +0200 Subject: [PATCH 14/18] moved directory --- .gitignore | 2 +- translations/{data => _data}/.gitkeep | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename translations/{data => _data}/.gitkeep (100%) diff --git a/.gitignore b/.gitignore index 77c21532..99e740c9 100644 --- a/.gitignore +++ b/.gitignore @@ -6,7 +6,7 @@ Database/*/*/*Data*.html translations/*Lookup.lua translations/*Files.xml -translations/data/*.html +translations/_data/*.html .shit .translator diff --git a/translations/data/.gitkeep b/translations/_data/.gitkeep similarity index 100% rename from translations/data/.gitkeep rename to translations/_data/.gitkeep From cea0ab3eb7bcf3b56f382793495c0dfc501056aa Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 4 Oct 2024 18:14:33 +0200 Subject: [PATCH 15/18] Remove this --- translations/_data/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 translations/_data/.gitkeep diff --git a/translations/_data/.gitkeep b/translations/_data/.gitkeep deleted file mode 100644 index e69de29b..00000000 From 18953abef3f6ddf878a0abae6c2089d14e251571 Mon Sep 17 00:00:00 2001 From: Logon Date: Fri, 4 Oct 2024 18:15:04 +0200 Subject: [PATCH 16/18] Add back the translation xml and gitkeep --- Translations/_data/.gitkeepp | 0 Translations/translations.xml | 4 ++++ 2 files changed, 4 insertions(+) create mode 100644 Translations/_data/.gitkeepp create mode 100644 Translations/translations.xml diff --git a/Translations/_data/.gitkeepp b/Translations/_data/.gitkeepp new file mode 100644 index 00000000..e69de29b diff --git a/Translations/translations.xml b/Translations/translations.xml new file mode 100644 index 00000000..34658e10 --- /dev/null +++ b/Translations/translations.xml @@ -0,0 +1,4 @@ + +